Add Credential Validation endpoint (#181)

Author: jswift

src/BigCommerce/Api/Customers/CustomersApi.php

@@ -6,6 +6,8 @@
 use BigCommerce\ApiV3\Api\Subscribers\SubscribersApi;
 use BigCommerce\ApiV3\ResponseModels\Customer\CustomersResponse;
 use BigCommerce\ApiV3\ResourceModels\Customer\Customer;
+use BigCommerce\ApiV3\ResponseModels\Customer\ValidateCredentialsResponse;
+use GuzzleHttp\RequestOptions;
 use UnexpectedValueException;
 
 class CustomersApi extends CustomerApiBase
@@ -59,6 +61,23 @@ public function update(array $customers): CustomersResponse
         return new CustomersResponse($this->updateResources($customers));
     }
 
+    public function validateCredentials(string $email, string $password, ?int $channel_id = null): ValidateCredentialsResponse
+    {
+        $credentials = ['email' => $email, 'password' => $password];
+        if (!is_null($channel_id)) {
+            $credentials['channel_id'] = $channel_id;
+        }
+
+        $response = $this->getClient()->getRestClient()->post(
+            'customers/validate-credentials',
+            [
+                RequestOptions::JSON => $credentials,
+            ]
+        );
+
+        return new ValidateCredentialsResponse($response);
+    }
+
     protected function resourceName(): string
     {
         return self::RESOURCE_NAME;

src/BigCommerce/ResourceModels/Customer/CustomerCredentialsValidation.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResourceModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\ResourceModel;
+
+class CustomerCredentialsValidation extends ResourceModel
+{
+    public ?int $customer_id;
+    public bool $is_valid;
+}

src/BigCommerce/ResponseModels/Customer/ValidateCredentialsResponse.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResponseModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\Customer\CustomerCredentialsValidation;
+use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse;
+use Psr\Http\Message\ResponseInterface;
+use stdClass;
+
+class ValidateCredentialsResponse extends SingleResourceResponse
+{
+    private CustomerCredentialsValidation $credentialsValidation;
+
+    protected function decodeResponseBody(object $responseBody): object
+    {
+        return $responseBody;
+    }
+
+    public function getCredentialsValidation(): CustomerCredentialsValidation
+    {
+        return $this->credentialsValidation;
+    }
+
+    protected function addData(stdClass $rawData): void
+    {
+        $this->credentialsValidation = new CustomerCredentialsValidation($rawData);
+    }
+}

src/BigCommerce/ResponseModels/SingleResourceResponse.php

@@ -9,7 +9,12 @@ abstract class SingleResourceResponse
 {
     public function __construct(ResponseInterface $response)
     {
-        $this->addData(json_decode($response->getBody())->data);
+        $this->addData($this->decodeResponseBody(json_decode($response->getBody())));
+    }
+
+    protected function decodeResponseBody(object $responseBody): object
+    {
+        return $responseBody->data;
     }
 
     abstract protected function addData(stdClass $rawData): void;

tests/BigCommerce/Api/Customers/CustomersApiTest.php

@@ -81,4 +81,13 @@ public function testCanDeleteCustomersIn()
 
         $this->assertTrue($this->getApi()->customers()->delete([1, 2]));
     }
+
+    public function testCanValidateCredentials()
+    {
+        $this->setReturnData('customers__validate-credentials.json');
+
+        $validation = $this->getApi()->customers()->validateCredentials('[email protected]', 'Password123');
+
+        $this->assertFalse($validation->getCredentialsValidation()->is_valid);
+    }
 }

tests/BigCommerce/responses/customers__validate-credentials.json

@@ -0,0 +1,3 @@
+{
+  "is_valid": false
+}