Add Customer Settings per Channel endpoints (#181)

Author: jswift

src/BigCommerce/Api/Customers/CustomerSettingsApi.php

@@ -29,4 +29,9 @@ public function update(CustomerSettings $settings): CustomerSettingsResponse
     {
         return new CustomerSettingsResponse($this->updateResource($settings));
     }
+
+    public function channel(int $channelId): CustomerSettingsPerChannelApi
+    {
+        return new CustomerSettingsPerChannelApi($this->getClient(), $channelId);
+    }
 }

src/BigCommerce/Api/Customers/CustomerSettingsPerChannelApi.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace BigCommerce\ApiV3\Api\Customers;
+
+use BigCommerce\ApiV3\Api\Generic\GetResource;
+use BigCommerce\ApiV3\Api\Generic\ResourceApi;
+use BigCommerce\ApiV3\Api\Generic\UpdateResource;
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerChannelSettings;
+use BigCommerce\ApiV3\ResponseModels\Customer\CustomerChannelSettingsResponse;
+use BigCommerce\ApiV3\ResponseModels\PaginatedResponse;
+
+class CustomerSettingsPerChannelApi extends ResourceApi
+{
+    use GetResource;
+    use UpdateResource;
+
+    private const SETTINGS_PER_CHANNEL_ENDPOINT = 'customers/settings/channels/%d';
+
+
+    protected function singleResourceEndpoint(): string
+    {
+        return self::SETTINGS_PER_CHANNEL_ENDPOINT;
+    }
+
+    protected function multipleResourcesEndpoint(): string
+    {
+        return self::SETTINGS_PER_CHANNEL_ENDPOINT;
+    }
+
+    protected function resourceName(): string
+    {
+        return 'settings';
+    }
+
+    public function get(): CustomerChannelSettingsResponse
+    {
+        return new CustomerChannelSettingsResponse($this->getResource());
+    }
+
+    public function update(CustomerChannelSettings $channelSettings): CustomerChannelSettingsResponse
+    {
+        return new CustomerChannelSettingsResponse($this->updateResource($channelSettings));
+    }
+
+    public function getAll(array $filters = [], int $page = 1, int $limit = 250): PaginatedResponse
+    {
+        throw new \UnexpectedValueException("Unable to get all Customer Settings Per Channel");
+    }
+}

src/BigCommerce/ResourceModels/Customer/CustomerChannelSettings.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResourceModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerSettings\CustomerGroupSettings;
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerSettings\PrivacySettings;
+use BigCommerce\ApiV3\ResourceModels\ResourceModel;
+
+class CustomerChannelSettings extends ResourceModel
+{
+    public PrivacySettings $privacy_settings;
+    public CustomerGroupSettings $customer_group_settings;
+
+    /**
+     * Determines if a channel allows global customer to login
+     * Determines if customers created on this channel will get global access/login
+     */
+    public ?bool $allow_global_logins;
+
+    protected function beforeBuildObject(): void
+    {
+        $this->buildPropertyObject('privacy_settings', PrivacySettings::class);
+        $this->buildPropertyObject('customer_group_settings', CustomerGroupSettings::class);
+
+        parent::beforeBuildObject();
+    }
+}

src/BigCommerce/ResourceModels/Customer/CustomerSettings/CustomerGroupSettings.php

@@ -6,6 +6,6 @@
 
 class CustomerGroupSettings extends ResourceModel
 {
-    public int $guest_customer_group_id;
-    public int $default_customer_group_id;
+    public ?int $guest_customer_group_id;
+    public ?int $default_customer_group_id;
 }

src/BigCommerce/ResourceModels/Customer/CustomerSettings/PrivacySettings.php

@@ -9,13 +9,13 @@ class PrivacySettings extends ResourceModel
     /**
      * Determines if a customer requires consent for tracking privacy.
      */
-    public bool $ask_shopper_for_tracking_consent;
+    public ?bool $ask_shopper_for_tracking_consent;
 
     /**
      * The URL for a website's privacy policy.
      * Example: https://bigcommmerce.com/policy
      */
-    public string $policy_url;
+    public ?string $policy_url;
 
-    public bool $ask_shopper_for_tracking_consent_on_checkout;
+    public ?bool $ask_shopper_for_tracking_consent_on_checkout;
 }

src/BigCommerce/ResponseModels/Customer/CustomerChannelSettingsResponse.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResponseModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerChannelSettings;
+use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse;
+use stdClass;
+
+class CustomerChannelSettingsResponse extends SingleResourceResponse
+{
+    private CustomerChannelSettings $channelSettings;
+
+    public function getChannelSettings(): CustomerChannelSettings
+    {
+        return $this->channelSettings;
+    }
+
+    protected function addData(stdClass $rawData): void
+    {
+        $this->channelSettings = new CustomerChannelSettings($rawData);
+    }
+}

tests/BigCommerce/Api/Customers/CustomerSettingsApiTest.php

@@ -14,4 +14,12 @@ public function testCanGetCustomerSettings()
 
         $this->assertEquals('https://bigcommmerce.com/policy', $settings->privacy_settings->policy_url);
     }
+
+    public function testCanGetCustomerSettingsPerChannel()
+    {
+        $this->setReturnData('customers__settings__by_channel.json');
+        $settings = $this->getApi()->customers()->settings()->channel(1)->get()->getChannelSettings();
+
+        $this->assertEquals('https://aligent.com.au/takeflight', $settings->privacy_settings->policy_url);
+    }
 }

tests/BigCommerce/responses/customers__settings__by_channel.json

@@ -0,0 +1,14 @@
+{
+  "data": {
+    "privacy_settings": {
+      "ask_shopper_for_tracking_consent": null,
+      "policy_url": "https://aligent.com.au/takeflight",
+      "ask_shopper_for_tracking_consent_on_checkout": null
+    },
+    "customer_group_settings": {
+      "guest_customer_group_id": null,
+      "default_customer_group_id": null
+    },
+    "allow_global_logins": true
+  }
+}