Add global Customer Settings to API (#181)

Author: jswift

src/BigCommerce/Api/Customers/CustomerSettingsApi.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace BigCommerce\ApiV3\Api\Customers;
+
+use BigCommerce\ApiV3\Api\Generic\GetResource;
+use BigCommerce\ApiV3\Api\Generic\UpdateResource;
+use BigCommerce\ApiV3\Api\Generic\V3ApiBase;
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerSettings;
+use BigCommerce\ApiV3\ResponseModels\Customer\CustomerSettingsResponse;
+
+class CustomerSettingsApi extends V3ApiBase
+{
+    use GetResource;
+    use UpdateResource;
+
+    public const CUSTOMER_SETTINGS_ENDPOINT = 'customers/settings';
+
+    public function get(): CustomerSettingsResponse
+    {
+        return new CustomerSettingsResponse($this->getResource());
+    }
+
+    public function singleResourceUrl(): string
+    {
+        return self::CUSTOMER_SETTINGS_ENDPOINT;
+    }
+
+    public function update(CustomerSettings $settings): CustomerSettingsResponse
+    {
+        return new CustomerSettingsResponse($this->updateResource($settings));
+    }
+}

src/BigCommerce/Api/Customers/CustomersApi.php

@@ -93,6 +93,11 @@ public function consent(): CustomerConsentApi
         return new CustomerConsentApi($this->getClient(), null, $this->getResourceId());
     }
 
+    public function settings(): CustomerSettingsApi
+    {
+        return new CustomerSettingsApi($this->getClient());
+    }
+
     public function subscriber(int $id): SubscribersApi
     {
         return new SubscribersApi($this->getClient(), $id, $this->getParentResourceId());

src/BigCommerce/ResourceModels/Customer/CustomerSettings.php

@@ -0,0 +1,21 @@
+<?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 CustomerSettings extends ResourceModel
+{
+    public PrivacySettings $privacy_settings;
+    public CustomerGroupSettings $customer_group_settings;
+
+    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

@@ -0,0 +1,11 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResourceModels\Customer\CustomerSettings;
+
+use BigCommerce\ApiV3\ResourceModels\ResourceModel;
+
+class CustomerGroupSettings extends ResourceModel
+{
+    public int $guest_customer_group_id;
+    public int $default_customer_group_id;
+}

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

@@ -0,0 +1,21 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResourceModels\Customer\CustomerSettings;
+
+use BigCommerce\ApiV3\ResourceModels\ResourceModel;
+
+class PrivacySettings extends ResourceModel
+{
+    /**
+     * Determines if a customer requires consent for tracking privacy.
+     */
+    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 bool $ask_shopper_for_tracking_consent_on_checkout;
+}

src/BigCommerce/ResponseModels/Customer/CustomerSettingsResponse.php

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

tests/BigCommerce/Api/Customers/CustomerSettingsApiTest.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace BigCommerce\Tests\Api\Customers;
+
+use BigCommerce\Tests\BigCommerceApiTest;
+
+class CustomerSettingsApiTest extends BigCommerceApiTest
+{
+    public function testCanGetCustomerSettings()
+    {
+        $this->setReturnData('customers__settings__get.json');
+
+        $settings = $this->getApi()->customers()->settings()->get()->getCustomerSettings();
+
+        $this->assertEquals('https://bigcommmerce.com/policy', $settings->privacy_settings->policy_url);
+    }
+}

tests/BigCommerce/responses/customers__settings__get.json

@@ -0,0 +1,13 @@
+{
+  "data": {
+    "privacy_settings": {
+      "ask_shopper_for_tracking_consent": false,
+      "policy_url": "https://bigcommmerce.com/policy",
+      "ask_shopper_for_tracking_consent_on_checkout": false
+    },
+    "customer_group_settings": {
+      "guest_customer_group_id": 0,
+      "default_customer_group_id": 0
+    }
+  }
+}