From 3aa3e65bbe873f388c5f0df655ebffe3a96f21d0 Mon Sep 17 00:00:00 2001 From: Neur0toxine Date: Tue, 9 Aug 2022 14:32:45 +0300 Subject: [PATCH 1/2] `/api/v5/loyalty/bonus/operations` method --- src/Model/Entity/CursorPagination.php | 29 ++ src/Model/Entity/Loyalty/Operation.php | 16 + .../LoyaltyBonusOperationsApiFilterType.php | 37 ++ .../Loyalty/AllBonusOperationsRequest.php | 47 +++ .../AbstractCursorPaginatedResponse.php | 29 ++ .../Loyalty/AllBonusOperationsResponse.php | 30 ++ src/ResourceGroup/Loyalty.php | 63 ++++ tests/src/ResourceGroup/LoyaltyTest.php | 351 +++++++++++++++++- 8 files changed, 598 insertions(+), 4 deletions(-) create mode 100644 src/Model/Entity/CursorPagination.php create mode 100644 src/Model/Filter/Loyalty/LoyaltyBonusOperationsApiFilterType.php create mode 100644 src/Model/Request/Loyalty/AllBonusOperationsRequest.php create mode 100644 src/Model/Response/AbstractCursorPaginatedResponse.php create mode 100644 src/Model/Response/Loyalty/AllBonusOperationsResponse.php diff --git a/src/Model/Entity/CursorPagination.php b/src/Model/Entity/CursorPagination.php new file mode 100644 index 0000000..00d9eba --- /dev/null +++ b/src/Model/Entity/CursorPagination.php @@ -0,0 +1,29 @@ +loyalties = $loyalties; + } +} diff --git a/src/Model/Request/Loyalty/AllBonusOperationsRequest.php b/src/Model/Request/Loyalty/AllBonusOperationsRequest.php new file mode 100644 index 0000000..46f1447 --- /dev/null +++ b/src/Model/Request/Loyalty/AllBonusOperationsRequest.php @@ -0,0 +1,47 @@ +") + * @JMS\SerializedName("bonusOperations") + */ + public $bonusOperations; +} diff --git a/src/ResourceGroup/Loyalty.php b/src/ResourceGroup/Loyalty.php index a502ef6..96377c5 100644 --- a/src/ResourceGroup/Loyalty.php +++ b/src/ResourceGroup/Loyalty.php @@ -10,6 +10,7 @@ namespace RetailCrm\Api\ResourceGroup; use RetailCrm\Api\Enum\RequestMethod; +use RetailCrm\Api\Model\Request\Loyalty\AllBonusOperationsRequest; use RetailCrm\Api\Model\Request\Loyalty\BonusAccountDetailsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltiesRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyAccountCreateRequest; @@ -18,6 +19,7 @@ use RetailCrm\Api\Model\Request\Loyalty\LoyaltyAccountsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusCreditRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusOperationsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyCalculateRequest; +use RetailCrm\Api\Model\Response\Loyalty\AllBonusOperationsResponse; use RetailCrm\Api\Model\Response\Loyalty\BonusAccountDetailsResponse; use RetailCrm\Api\Model\Response\Loyalty\LoyaltiesResponse; use RetailCrm\Api\Model\Response\Loyalty\LoyaltyAccountActivateResponse; @@ -464,6 +466,67 @@ class Loyalty extends AbstractApiResourceGroup return $response; } + /** + * Makes GET "/api/v5/loyalty/bonus/operations" request. + * + * Example: + * ```php + * use RetailCrm\Api\Factory\SimpleClientFactory; + * use RetailCrm\Api\Interfaces\ApiExceptionInterface; + * use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyAccountBonusOperationsApiFilterType; + * use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusOperationsRequest; + * + * $client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey'); + * + * $request = new AllBonusOperationsRequest(); + * $request->limit = 10; + * $request->cursor = '12345'; + * $request->filter = new LoyaltyBonusOperationsApiFilterType([1, 2, 3]); + * + * try { + * $response = $client->loyalty->bonusOperations($request); + * } catch (ApiExceptionInterface $exception) { + * echo sprintf( + * 'Error from RetailCRM API (status code: %d): %s', + * $exception->getStatusCode(), + * $exception->getMessage() + * ); + * + * if (count($exception->getErrorResponse()->errors) > 0) { + * echo PHP_EOL . 'Errors: ' . implode(', ', $exception->getErrorResponse()->errors); + * } + * + * return; + * } + * + * echo 'All bonus operations: ' . print_r($response->bonusOperations, true); + * ``` + * + * @param \RetailCrm\Api\Model\Request\Loyalty\AllBonusOperationsRequest|null $request + * + * @return \RetailCrm\Api\Model\Response\Loyalty\AllBonusOperationsResponse + * @throws \RetailCrm\Api\Exception\Api\AccountDoesNotExistException + * @throws \RetailCrm\Api\Exception\Api\ApiErrorException + * @throws \RetailCrm\Api\Exception\Api\MissingCredentialsException + * @throws \RetailCrm\Api\Exception\Api\MissingParameterException + * @throws \RetailCrm\Api\Exception\Api\ValidationException + * @throws \RetailCrm\Api\Exception\Client\HandlerException + * @throws \RetailCrm\Api\Exception\Client\HttpClientException + * @throws \RetailCrm\Api\Interfaces\ApiExceptionInterface + * @throws \RetailCrm\Api\Interfaces\ClientExceptionInterface + */ + public function bonusOperations(?AllBonusOperationsRequest $request = null): AllBonusOperationsResponse + { + /** @var AllBonusOperationsResponse $response */ + $response = $this->sendRequest( + RequestMethod::GET, + 'loyalty/bonus/operations', + $request, + AllBonusOperationsResponse::class + ); + return $response; + } + /** * Makes POST "/api/v5/loyalty/calculate" request. * diff --git a/tests/src/ResourceGroup/LoyaltyTest.php b/tests/src/ResourceGroup/LoyaltyTest.php index 57723b8..a99343c 100644 --- a/tests/src/ResourceGroup/LoyaltyTest.php +++ b/tests/src/ResourceGroup/LoyaltyTest.php @@ -17,21 +17,22 @@ use RetailCrm\Api\Component\Transformer\DateTimeTransformer; use RetailCrm\Api\Enum\Loyalty\AccountStatus; use RetailCrm\Api\Enum\Loyalty\PrivilegeType; use RetailCrm\Api\Enum\NumericBoolean; +use RetailCrm\Api\Enum\PaginationLimit; use RetailCrm\Api\Enum\RequestMethod; use RetailCrm\Api\Model\Entity\CustomersCorporate\SerializedEntityCustomer; use RetailCrm\Api\Model\Entity\CustomersCorporate\SerializedRelationAbstractCustomer; -use RetailCrm\Api\Model\Entity\Loyalty\BonusDetail; use RetailCrm\Api\Model\Entity\Loyalty\LoyaltyAccount; use RetailCrm\Api\Model\Entity\Loyalty\SerializedCreateLoyaltyAccount; use RetailCrm\Api\Model\Entity\Loyalty\SerializedOrder; use RetailCrm\Api\Model\Entity\Loyalty\SerializedOrderDelivery; use RetailCrm\Api\Model\Entity\Loyalty\SerializedOrderProduct; use RetailCrm\Api\Model\Entity\Loyalty\SerializedOrderProductOffer; -use RetailCrm\Api\Model\Entity\Pagination; use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyAccountApiFilterType; use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyAccountBonusApiFilterType; use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyAccountBonusOperationsApiFilterType; use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyApiFilterType; +use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyBonusOperationsApiFilterType; +use RetailCrm\Api\Model\Request\Loyalty\AllBonusOperationsRequest; use RetailCrm\Api\Model\Request\Loyalty\BonusAccountDetailsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltiesRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyAccountCreateRequest; @@ -40,8 +41,6 @@ use RetailCrm\Api\Model\Request\Loyalty\LoyaltyAccountsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusCreditRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusOperationsRequest; use RetailCrm\Api\Model\Request\Loyalty\LoyaltyCalculateRequest; -use RetailCrm\Api\Model\Response\Loyalty\BonusAccountDetailsResponse; -use RetailCrm\Api\Model\Response\Loyalty\LoyaltyBonusStatisticResponse; use RetailCrm\TestUtils\Factory\TestClientFactory; use RetailCrm\TestUtils\TestCase\AbstractApiResourceGroupTestCase; @@ -659,6 +658,350 @@ EOF; self::assertModelEqualsToResponse($json, $response); } + public function testBonusOperations(): void + { + $json = <<<'EOF' +{ + "success": true, + "pagination": { + "nextCursor": "WzI0OSwiMjAyMi0wMS0xOCAxNjoxMzoxNiswMzowMCJd" + }, + "bonusOperations": [ + { + "type": "credit_for_order", + "createdAt": "2020-11-27 13:42:37", + "amount": 347.8, + "order": { + "id": 6472, + "externalId": "9" + }, + "bonus": { + "activationDate": "2020-11-27" + }, + "loyaltyAccount": { + "id": 147 + }, + "loyalty": { + "id": 3 + } + }, + { + "type": "charge_for_order", + "createdAt": "2020-11-27 13:45:39", + "amount": -247, + "order": { + "id": 6473, + "externalId": "10" + }, + "loyaltyAccount": { + "id": 147 + }, + "loyalty": { + "id": 3 + } + }, + { + "type": "credit_for_order", + "createdAt": "2020-11-27 13:47:57", + "amount": 215.1, + "order": { + "id": 6473, + "externalId": "10" + }, + "bonus": { + "activationDate": "2020-11-27" + }, + "loyaltyAccount": { + "id": 147 + }, + "loyalty": { + "id": 3 + } + }, + { + "type": "credit_for_order", + "createdAt": "2020-11-27 16:33:32", + "amount": 655.7, + "order": { + "id": 6474, + "externalId": "11" + }, + "bonus": { + "activationDate": "2020-11-27" + }, + "loyaltyAccount": { + "id": 149 + }, + "loyalty": { + "id": 3 + } + }, + { + "type": "credit_manual", + "createdAt": "2021-11-02 12:52:53", + "amount": 1000, + "bonus": { + "activationDate": "2021-11-02" + }, + "loyaltyAccount": { + "id": 201 + }, + "loyalty": { + "id": 6 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-11-02 12:54:52", + "amount": -10, + "order": { + "id": 8181, + "externalId": "7" + }, + "loyaltyAccount": { + "id": 201 + }, + "loyalty": { + "id": 6 + } + }, + { + "type": "credit_manual", + "createdAt": "2021-11-03 10:31:57", + "amount": 1000, + "bonus": { + "activationDate": "2021-11-03" + }, + "loyaltyAccount": { + "id": 202 + }, + "loyalty": { + "id": 6 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-11-03 18:10:23", + "amount": -70, + "order": { + "id": 8184, + "externalId": "8" + }, + "loyaltyAccount": { + "id": 202 + }, + "loyalty": { + "id": 6 + } + }, + { + "type": "credit_manual", + "createdAt": "2021-11-09 15:50:09", + "amount": 1234, + "bonus": { + "activationDate": "2021-11-09" + }, + "loyaltyAccount": { + "id": 205 + }, + "loyalty": { + "id": 4 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-11-09 15:50:43", + "amount": -1234, + "order": { + "id": 8203, + "externalId": "6" + }, + "loyaltyAccount": { + "id": 205 + }, + "loyalty": { + "id": 4 + } + }, + { + "type": "credit_for_order", + "createdAt": "2021-11-10 17:50:47", + "amount": 1029.2, + "order": { + "id": 8205, + "externalId": "11" + }, + "bonus": { + "activationDate": "2021-11-10" + }, + "loyaltyAccount": { + "id": 206 + }, + "loyalty": { + "id": 6 + } + }, + { + "type": "credit_manual", + "createdAt": "2021-12-29 12:37:47", + "amount": 1000, + "bonus": { + "activationDate": "2021-12-29" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-29 14:55:42", + "amount": -300, + "order": { + "id": 8412, + "externalId": "6" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 10:56:10", + "amount": -2, + "order": { + "id": 8414, + "externalId": "7" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 11:01:19", + "amount": -4, + "order": { + "id": 8415, + "externalId": "8" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 11:06:39", + "amount": -4, + "order": { + "id": 8416, + "externalId": "9" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 11:09:18", + "amount": -2, + "order": { + "id": 8032, + "externalId": "10" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 11:32:35", + "amount": -2, + "order": { + "id": 8033, + "externalId": "11" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2021-12-30 11:37:13", + "amount": -2.4, + "order": { + "id": 8034, + "externalId": "12" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + }, + { + "type": "charge_for_order", + "createdAt": "2022-01-18 15:28:19", + "amount": -22.4, + "order": { + "id": 8035, + "externalId": "13" + }, + "loyaltyAccount": { + "id": 167 + }, + "loyalty": { + "id": 1 + } + } + ] +} +EOF; + + $request = new AllBonusOperationsRequest(); + $request->limit = PaginationLimit::LIMIT_20; + $request->cursor = 'dJCMwozMwsiNxozMxojNxACOx0SMw0iMyAjMiwSO0IzW'; + $request->filter = new LoyaltyBonusOperationsApiFilterType([1, 2, 3, 4, 5, 6, 7, 8]); + + $mock = static::createApiMockBuilder('loyalty/bonus/operations'); + $mock->matchMethod(RequestMethod::GET) + ->matchQuery([ + 'limit' => (string) PaginationLimit::LIMIT_20, + 'cursor' => 'dJCMwozMwsiNxozMxojNxACOx0SMw0iMyAjMiwSO0IzW', + 'filter' => [ + 'loyalties' => ['1', '2', '3', '4', '5', '6', '7', '8'] + ] + ]) + ->reply(200) + ->withBody($json); + + $client = TestClientFactory::createClient($mock->getClient()); + $response = $client->loyalty->bonusOperations($request); + + self::assertModelEqualsToResponse($json, $response); + } + public function testCalculate(): void { $json = <<<'EOF' From df9d1b6e6f388fab34d55a4230d122f9c83f9846 Mon Sep 17 00:00:00 2001 From: Neur0toxine Date: Tue, 9 Aug 2022 14:38:03 +0300 Subject: [PATCH 2/2] update method docblock --- src/ResourceGroup/Loyalty.php | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/ResourceGroup/Loyalty.php b/src/ResourceGroup/Loyalty.php index 96377c5..5d1c7c3 100644 --- a/src/ResourceGroup/Loyalty.php +++ b/src/ResourceGroup/Loyalty.php @@ -471,15 +471,16 @@ class Loyalty extends AbstractApiResourceGroup * * Example: * ```php + * use RetailCrm\Api\Enum\PaginationLimit; * use RetailCrm\Api\Factory\SimpleClientFactory; * use RetailCrm\Api\Interfaces\ApiExceptionInterface; - * use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyAccountBonusOperationsApiFilterType; - * use RetailCrm\Api\Model\Request\Loyalty\LoyaltyBonusOperationsRequest; + * use RetailCrm\Api\Model\Filter\Loyalty\LoyaltyBonusOperationsApiFilterType; + * use RetailCrm\Api\Model\Request\Loyalty\AllBonusOperationsRequest; * * $client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey'); * * $request = new AllBonusOperationsRequest(); - * $request->limit = 10; + * $request->limit = PaginationLimit::LIMIT_20; * $request->cursor = '12345'; * $request->filter = new LoyaltyBonusOperationsApiFilterType([1, 2, 3]); *