RetailCRM-Mirror/api-client-php
1
0
Fork 0
mirror of synced 2024-11-24 06:16:27 +03:00
Code Issues Projects Releases Wiki Activity

Customer subscriptions support

Browse Source
This commit is contained in:
Pavel 2024-06-20 18:05:04 +03:00 committed by GitHub
commit bc5d044282
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 200 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/Model/Entity/Customers/Subscription.php Normal file
View File

@ -0,0 +1,53 @@
<?php
/**
* PHP version 7.3
*
* @category Subscription
* @package RetailCrm\Api\Model\Entity\Customers
*/
namespace RetailCrm\Api\Model\Entity\Customers;
use RetailCrm\Api\Component\Serializer\Annotation as JMS;
/**
* Class Subscription
*
* @category Subscription
* @package RetailCrm\Api\Model\Entity\Customers
*/
class Subscription
{
/**
* @var string
*
* @JMS\Type("string")
* @JMS\SerializedName("channel")
*/
public $channel;
/**
* @var string
*
* @JMS\Type("string")
* @JMS\SerializedName("subscription")
*/
public $subscription;
/**
* @var bool
*
* @JMS\Type("bool")
* @JMS\SerializedName("active")
*/
public $active;
/**
* @var int
*
* @JMS\Type("int")
* @JMS\SerializedName("messageId")
*/
public $messageId;
}

47
src/Model/Request/Customers/CustomersSubscriptionsRequest.php Normal file
View File

@ -0,0 +1,47 @@
<?php
/**
* PHP version 7.3
*
* @category CustomersSubscriptionsRequest
* @package RetailCrm\Api\Model\Request\Customers
*/
namespace RetailCrm\Api\Model\Request\Customers;
use RetailCrm\Api\Component\FormData\Mapping as Form;
use RetailCrm\Api\Interfaces\RequestInterface;
/**
* Class CustomersSubscriptionsRequest
*
* @category CustomersSubscriptionsRequest
* @package RetailCrm\Api\Model\Request\Customers
*/
class CustomersSubscriptionsRequest implements RequestInterface
{
/**
* @var string
*
* @Form\Type("string")
* @Form\SerializedName("by")
*/
public $by;
/**
* @var string
*
* @Form\Type("string")
* @Form\SerializedName("site")
*/
public $site;
/**
* @var \RetailCrm\Api\Model\Entity\Customers\Subscription[]
*
* @Form\Type("RetailCrm\Api\Model\Entity\Customers\Subscription[]")
* @Form\SerializedName("subscriptions")
* @Form\JsonField()
*/
public $subscriptions;
}

67
src/ResourceGroup/Customers.php
View File

@ -19,6 +19,7 @@ use RetailCrm\Api\Model\Request\Customers\CustomersHistoryRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersNotesCreateRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersNotesRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersSubscriptionsRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersUploadRequest;
use RetailCrm\Api\Model\Response\Customers\CustomerNotesResponse;
use RetailCrm\Api\Model\Response\Customers\CustomersEditResponse;
@ -782,4 +783,70 @@ class Customers extends AbstractApiResourceGroup
);
return $response;
}
/**
* Makes POST "/api/v5/customers/{externalId}/subscriptions" request.
*
* Example:
* ```php
* use RetailCrm\Api\Enum\ByIdentifier;
* use RetailCrm\Api\Factory\SimpleClientFactory;
* use RetailCrm\Api\Interfaces\ApiExceptionInterface;
* use RetailCrm\Api\Model\Entity\Customers\Subscription;
* use RetailCrm\Api\Model\Request\Customers\CustomersSubscriptionsRequest;
*
* $client = SimpleClientFactory::createClient('https://test.retailcrm.pro', 'apiKey');
*
* $subscription = new Subscription();
* $subscription->channel = 'waba';
* $subscription->subscription = 'category';
* $subscription->active = false;
* $subscription->messageId = 123;
* $request = new CustomersSubscriptionsRequest();
* $request->by = ByIdentifier::ID;
* $request->site = 'aliexpress';
* $request->subscriptions = [$subscription];
*
* try {
* $response = $client->customers->subscriptions(4770, $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;
* }
* ```
*
* @param int|string $identifier
* @param \RetailCrm\Api\Model\Request\Customers\CustomersSubscriptionsRequest $request
*
* @return \RetailCrm\Api\Model\Response\SuccessResponse
* @throws \RetailCrm\Api\Interfaces\ApiExceptionInterface
* @throws \RetailCrm\Api\Interfaces\ClientExceptionInterface
* @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
*/
public function subscriptions($identifier, CustomersSubscriptionsRequest $request): SuccessResponse
{
/** @var SuccessResponse $response */
$response = $this->sendRequest(
RequestMethod::POST,
'customers/' . $identifier . '/subscriptions',
$request,
SuccessResponse::class
);
return $response;
}
}

33
tests/src/ResourceGroup/CustomersTest.php
View File

@ -22,6 +22,7 @@ use RetailCrm\Api\Model\Entity\Customers\CustomerNote;
use RetailCrm\Api\Model\Entity\Customers\CustomerPhone;
use RetailCrm\Api\Model\Entity\Customers\CustomerTag;
use RetailCrm\Api\Model\Entity\Customers\SerializedCustomerReference;
use RetailCrm\Api\Model\Entity\Customers\Subscription;
use RetailCrm\Api\Model\Entity\FixExternalRow;
use RetailCrm\Api\Model\Filter\Customers\CustomerFilter;
use RetailCrm\Api\Model\Filter\Customers\CustomerHistoryFilter;
@ -35,6 +36,7 @@ use RetailCrm\Api\Model\Request\Customers\CustomersHistoryRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersNotesCreateRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersNotesRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersSubscriptionsRequest;
use RetailCrm\Api\Model\Request\Customers\CustomersUploadRequest;
use RetailCrm\TestUtils\Factory\TestClientFactory;
use RetailCrm\TestUtils\TestCase\AbstractApiResourceGroupTestCase;
@ -2773,4 +2775,35 @@ EOF;
self::assertModelEqualsToResponse($json, $response);
}
public function testCustomersSubscriptions(): void
{
$json = <<<'EOF'
{
"success": true
}
EOF;
$subscription = new Subscription();
$subscription->channel = 'waba';
$subscription->subscription = 'category';
$subscription->active = false;
$subscription->messageId = 123;
$request = new CustomersSubscriptionsRequest();
$request->by = ByIdentifier::ID;
$request->site = 'aliexpress';
$request->subscriptions = [$subscription];
$mock = static::createApiMockBuilder('customers/4770/subscriptions');
$mock->matchMethod(RequestMethod::POST)
->matchBody(static::encodeForm($request))
->reply(200)
->withBody($json);
$client = TestClientFactory::createClient($mock->getClient());
$response = $client->customers->subscriptions(4770, $request);
self::assertModelEqualsToResponse($json, $response);
}
}