Add ContactSubscriptions, SubscriptionTypes and LoyaltyTokens to Regi…

…ster resources (#28) * Add ContactSubscriptions, SubscriptionTypes and LoyaltyTokens to Register resources * Remove ununsed getId()
Piggy-Loyalty · Jul 3, 2024 · a6cd576 · a6cd576
1 parent 5db95f4
commit a6cd576
Show file tree

Hide file tree

Showing 10 changed files with 184 additions and 74 deletions.
diff --git a/src/Http/Traits/SetsRegisterResources.php b/src/Http/Traits/SetsRegisterResources.php
@@ -3,8 +3,10 @@
 namespace Piggy\Api\Http\Traits;
 
 use Piggy\Api\Http\BaseClient;
+use Piggy\Api\Resources\Register\Loyalty\Tokens\LoyaltyTokensResource;
 use Piggy\Api\Resources\Register\ContactIdentifiersResource;
 use Piggy\Api\Resources\Register\Contacts\ContactsResource;
+use Piggy\Api\Resources\Register\ContactSubscriptionsResource;
 use Piggy\Api\Resources\Register\Giftcards\GiftcardsResource;
 use Piggy\Api\Resources\Register\Giftcards\GiftcardTransactionsResource;
 use Piggy\Api\Resources\Register\Loyalty\Program\LoyaltyProgramResource;
@@ -13,6 +15,7 @@
 use Piggy\Api\Resources\Register\Loyalty\Rewards\RewardsResource;
 use Piggy\Api\Resources\Register\PrepaidTransactionResource;
 use Piggy\Api\Resources\Register\Registers\RegisterResource;
+use Piggy\Api\Resources\Register\SubscriptionTypesResource;
 
 /**
  * Trait SetsRegisterResources
@@ -39,11 +42,21 @@ trait SetsRegisterResources
      */
     public $rewards;
 
+    /**
+     * @var LoyaltyTokensResource
+     */
+    public $loyaltyToken;
+
     /**
      * @var ContactIdentifiersResource
      */
     public $contactIdentifiers;
 
+    /**
+     * @var ContactSubscriptionsResource
+     */
+    public $contactSubscriptions;
+
     /**
      * @var GiftcardTransactionsResource
      */
@@ -64,20 +77,30 @@ trait SetsRegisterResources
      */
     public $creditReceptions;
 
-    /** @var LoyaltyProgramResource */
+    /**
+     * @var LoyaltyProgramResource
+     */
     public $loyaltyProgram;
 
+    /**
+     * @var SubscriptionTypesResource
+     */
+    public $subscriptionTypes;
+
     protected function setResources(BaseClient $client): void
     {
         $this->registers = new RegisterResource($client);
         $this->contacts = new ContactsResource($client);
         $this->giftcards = new GiftcardsResource($client);
         $this->rewards = new RewardsResource($client);
+        $this->loyaltyToken = new LoyaltyTokensResource($client);
         $this->contactIdentifiers = new ContactIdentifiersResource($client);
+        $this->contactSubscriptions = new ContactSubscriptionsResource($client);
         $this->giftcardTransactions = new GiftcardTransactionsResource($client);
         $this->prepaidTransactions = new PrepaidTransactionResource($client);
         $this->rewardReceptions = new RewardReceptionsResource($client);
         $this->creditReceptions = new CreditReceptionsResource($client);
         $this->loyaltyProgram = new LoyaltyProgramResource($client);
+        $this->subscriptionTypes = new SubscriptionTypesResource($client);
     }
 }
diff --git a/src/Models/Contacts/SubscriptionType.php b/src/Models/Contacts/SubscriptionType.php
@@ -31,7 +31,7 @@ class SubscriptionType
     protected $active;
 
     /**
-     * @var string
+     * @var string|null
      */
     protected $strategy;
 
@@ -84,12 +84,12 @@ public function setActive(bool $active): void
         $this->active = $active;
     }
 
-    public function getStrategy(): string
+    public function getStrategy(): ?string
     {
         return $this->strategy;
     }
 
-    public function setStrategy(string $strategy): void
+    public function setStrategy(?string $strategy): void
     {
         $this->strategy = $strategy;
     }

diff --git a/src/Resources/BaseResource.php b/src/Resources/BaseResource.php
@@ -6,6 +6,11 @@
 
 abstract class BaseResource
 {
+    /**
+     * @var string
+     */
+    protected $resourceUri;
+
     /**
      * @var BaseClient
      */
@@ -17,6 +22,5 @@ abstract class BaseResource
     public function __construct(BaseClient $client)
     {
         $this->client = $client;
-
     }
 }
diff --git a/src/Resources/OAuth/ContactSubscriptionsResource.php b/src/Resources/OAuth/ContactSubscriptionsResource.php
@@ -2,60 +2,12 @@
 
 namespace Piggy\Api\Resources\OAuth;
 
-use Piggy\Api\Exceptions\PiggyRequestException;
-use Piggy\Api\Mappers\Contacts\SubscriptionMapper;
-use Piggy\Api\Mappers\Contacts\SubscriptionsMapper;
-use Piggy\Api\Models\Contacts\Subscription;
-use Piggy\Api\Resources\BaseResource;
+use Piggy\Api\Resources\Shared\BaseContactSubscriptionsResource;
 
-class ContactSubscriptionsResource extends BaseResource
+class ContactSubscriptionsResource extends BaseContactSubscriptionsResource
 {
     /**
      * @var string
      */
     protected $resourceUri = '/api/v3/oauth/clients/contact-subscriptions';
-
-    /**
-     * @return Subscription[]
-     *
-     * @throws PiggyRequestException
-     */
-    public function list(string $contactUuid): array
-    {
-        $response = $this->client->get("$this->resourceUri/$contactUuid", [
-            'contact_uuid' => $contactUuid,
-        ]);
-
-        $mapper = new SubscriptionsMapper();
-
-        return $mapper->map($response->getData());
-    }
-
-    /**
-     * @throws PiggyRequestException
-     */
-    public function subscribe(string $contactUuid, string $subscriptionTypeUuid): Subscription
-    {
-        $response = $this->client->put("$this->resourceUri/$contactUuid/subscribe", [
-            'subscription_type_uuid' => $subscriptionTypeUuid,
-        ]);
-
-        $mapper = new SubscriptionMapper();
-
-        return $mapper->map($response->getData());
-    }
-
-    /**
-     * @throws PiggyRequestException
-     */
-    public function unsubscribe(string $contactUuid, string $subscriptionTypeUuid): Subscription
-    {
-        $response = $this->client->put("$this->resourceUri/$contactUuid/unsubscribe", [
-            'subscription_type_uuid' => $subscriptionTypeUuid,
-        ]);
-
-        $mapper = new SubscriptionMapper();
-
-        return $mapper->map($response->getData());
-    }
 }
diff --git a/src/Resources/OAuth/SubscriptionTypesResource.php b/src/Resources/OAuth/SubscriptionTypesResource.php
@@ -2,29 +2,12 @@
 
 namespace Piggy\Api\Resources\OAuth;
 
-use Piggy\Api\Exceptions\PiggyRequestException;
-use Piggy\Api\Mappers\Contacts\SubscriptionTypesMapper;
-use Piggy\Api\Models\Contacts\SubscriptionType;
-use Piggy\Api\Resources\BaseResource;
+use Piggy\Api\Resources\Shared\BaseSubscriptionTypesResource;
 
-class SubscriptionTypesResource extends BaseResource
+class SubscriptionTypesResource extends BaseSubscriptionTypesResource
 {
     /**
      * @var string
      */
     protected $resourceUri = '/api/v3/oauth/clients/subscription-types';
-
-    /**
-     * @return SubscriptionType[]
-     *
-     * @throws PiggyRequestException
-     */
-    public function list(): array
-    {
-        $response = $this->client->get($this->resourceUri);
-
-        $mapper = new SubscriptionTypesMapper();
-
-        return $mapper->map($response->getData());
-    }
 }
diff --git a/src/Resources/Register/ContactSubscriptionsResource.php b/src/Resources/Register/ContactSubscriptionsResource.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Piggy\Api\Resources\Register;
+
+use Piggy\Api\Resources\Shared\BaseContactSubscriptionsResource;
+
+class ContactSubscriptionsResource extends BaseContactSubscriptionsResource
+{
+    /**
+     * @var string
+     */
+    protected $resourceUri = '/api/v3/register/contact-subscriptions';
+}
diff --git a/src/Resources/Register/Loyalty/Tokens/LoyaltyTokensResource.php b/src/Resources/Register/Loyalty/Tokens/LoyaltyTokensResource.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Piggy\Api\Resources\Register\Loyalty\Tokens;
+
+use Piggy\Api\Exceptions\PiggyRequestException;
+use Piggy\Api\Mappers\Loyalty\Receptions\CreditReceptionMapper;
+use Piggy\Api\Models\Loyalty\Receptions\CreditReception;
+use Piggy\Api\Resources\BaseResource;
+
+class LoyaltyTokensResource extends BaseResource
+{
+    /**
+     * @var string
+     */
+    protected $resourceUri = '/api/v3/register/loyalty-tokens';
+
+    /**
+     * @throws PiggyRequestException
+     */
+    public function claim(string $version, string $uniqueId, int $timestamp, string $hash, string $contactUuid, ?int $credits = null, ?string $unitName = null, ?float $unitValue = null, ?int $shopId = null, ?string $shopUuid = null): CreditReception
+    {
+        $inputValues = [
+            'version' => $version,
+            'shop_id' => $shopId,
+            'shop_uuid' => $shopUuid,
+            'unique_id' => $uniqueId,
+            'timestamp' => $timestamp,
+            'hash' => $hash,
+            'contact_uuid' => $contactUuid,
+            'credits' => $credits,
+            'unit_name' => $unitName,
+            'unit_value' => $unitValue,
+        ];
+
+        $response = $this->client->post($this->resourceUri, $inputValues);
+
+        $mapper = new CreditReceptionMapper();
+
+        return $mapper->map($response->getData());
+    }
+}
diff --git a/src/Resources/Register/SubscriptionTypesResource.php b/src/Resources/Register/SubscriptionTypesResource.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Piggy\Api\Resources\Register;
+
+use Piggy\Api\Resources\Shared\BaseSubscriptionTypesResource;
+
+class SubscriptionTypesResource extends BaseSubscriptionTypesResource
+{
+    /**
+     * @var string
+     */
+    protected $resourceUri = '/api/v3/register/subscription-types';
+}
diff --git a/src/Resources/Shared/BaseContactSubscriptionsResource.php b/src/Resources/Shared/BaseContactSubscriptionsResource.php
@@ -0,0 +1,56 @@
+<?php
+
+namespace Piggy\Api\Resources\Shared;
+
+use Piggy\Api\Exceptions\PiggyRequestException;
+use Piggy\Api\Mappers\Contacts\SubscriptionMapper;
+use Piggy\Api\Mappers\Contacts\SubscriptionsMapper;
+use Piggy\Api\Models\Contacts\Subscription;
+use Piggy\Api\Resources\BaseResource;
+
+abstract class BaseContactSubscriptionsResource extends BaseResource
+{
+    /**
+     * @return Subscription[]
+     *
+     * @throws PiggyRequestException
+     */
+    public function list(string $contactUuid): array
+    {
+        $response = $this->client->get("$this->resourceUri/$contactUuid", [
+            'contact_uuid' => $contactUuid,
+        ]);
+
+        $mapper = new SubscriptionsMapper();
+
+        return $mapper->map($response->getData());
+    }
+
+    /**
+     * @throws PiggyRequestException
+     */
+    public function subscribe(string $contactUuid, string $subscriptionTypeUuid): Subscription
+    {
+        $response = $this->client->put("$this->resourceUri/$contactUuid/subscribe", [
+            'subscription_type_uuid' => $subscriptionTypeUuid,
+        ]);
+
+        $mapper = new SubscriptionMapper();
+
+        return $mapper->map($response->getData());
+    }
+
+    /**
+     * @throws PiggyRequestException
+     */
+    public function unsubscribe(string $contactUuid, string $subscriptionTypeUuid): Subscription
+    {
+        $response = $this->client->put("$this->resourceUri/$contactUuid/unsubscribe", [
+            'subscription_type_uuid' => $subscriptionTypeUuid,
+        ]);
+
+        $mapper = new SubscriptionMapper();
+
+        return $mapper->map($response->getData());
+    }
+}
diff --git a/src/Resources/Shared/BaseSubscriptionTypesResource.php b/src/Resources/Shared/BaseSubscriptionTypesResource.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Piggy\Api\Resources\Shared;
+
+use Piggy\Api\Exceptions\PiggyRequestException;
+use Piggy\Api\Mappers\Contacts\SubscriptionTypesMapper;
+use Piggy\Api\Models\Contacts\SubscriptionType;
+use Piggy\Api\Resources\BaseResource;
+
+abstract class BaseSubscriptionTypesResource extends BaseResource
+{
+    /**
+     * @return SubscriptionType[]
+     *
+     * @throws PiggyRequestException
+     */
+    public function list(): array
+    {
+        $response = $this->client->get($this->resourceUri);
+
+        $mapper = new SubscriptionTypesMapper();
+
+        return $mapper->map($response->getData());
+    }
+}