Merge pull request #197 from aligent/release/1.11.0

Release/1.11.0

Author: jswift

README.md

@@ -4,7 +4,7 @@
 [![Packagist Latest](https://img.shields.io/packagist/v/aligent/bigcommerce-api-client)](https://packagist.org/packages/aligent/bigcommerce-api-client)
 ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/aligent/bigcommerce-api-client/dev-main)
 [![License](https://img.shields.io/github/license/aligent/bigcommerce-v3-api-php-client)](https://github.com/aligent/bigcommerce-v3-api-php-client/blob/main/LICENSE.md)
-[![Build Status](https://img.shields.io/github/workflow/status/aligent/bigcommerce-v3-api-php-client/Validate%20PHP%20dependancies%20and%20test)](https://github.com/aligent/bigcommerce-v3-api-php-client/actions/workflows/php.yml)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/aligent/bigcommerce-v3-api-php-client/php.yml?branch=main)](https://github.com/aligent/bigcommerce-v3-api-php-client/actions/workflows/php.yml)
 [![Documentation](https://img.shields.io/badge/docs-generated-success)](https://aligent.github.io/bigcommerce-v3-api-php-client/)
 ## Introduction
 

RELEASE_NOTES.md

@@ -1,13 +1,16 @@
-### Fixes
+This release adds support for a number of new and extended BigCommerce V3 API endpoints.
 
-- Fix incorrect endpoint and method for Create Redirect Urls (thanks @Mosnar)
-- Updated storeinformation controller to match others (thanks @joelreeds)
-- Fixed incorrect endpoint on OrdersApi (thanks @simpleapps-io)
-- Handle the case of no orders returned in the V2 api causing error. (Issue #161)
-- Fix `preorder_release_date` property type (Issue #162)
-- Add `page_title` to Brand (Issue #171)
+### New Features
 
+- Implement the [System Logs](https://developer.bigcommerce.com/api-reference/6908d02370409-get-system-logs) 
+  endpoint (#185)
+- Implement the [Pages](https://developer.bigcommerce.com/api-reference/d74089ee212a2-delete-pages) API (#184)
+- Implement extra Customer V3 endpoints (#181):
+  - [Get stored instruments](https://developer.bigcommerce.com/api-reference/b735a25b3a0b8-get-stored-instruments)
+  - [Customer Settings](https://developer.bigcommerce.com/api-reference/0c31a6d25e5ea-get-customer-settings)
+  - [Customer Settings per Channel](https://developer.bigcommerce.com/api-reference/d5e66c45b0415-get-customer-settings-per-channel)
+  - [Validate credentials](https://developer.bigcommerce.com/api-reference/3d731215a3dcb-validate-a-customer-credentials)
+- Add the ability to send and receive Images via the Product API, not just the Product Images api (#175)
+- Implement the [Wishlists](https://developer.bigcommerce.com/api-reference/03d6065d6f6e5-wishlist) API (#186)
 
-### New Features
 
-- Allow overriding of most Guzzle Client defaults, and also set a timeout

docs/classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html

@@ -388,7 +388,7 @@ <h4 class="phpdocumentor-element__name" id="method_count">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php"><a href="files/bigcommercelegacyapi-api-orders-ordersapi.html"><abbr title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php">OrdersApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">92</span>
+    <span class="phpdocumentor-element-found-in__line">96</span>
 
     </aside>
 
@@ -737,7 +737,7 @@ <h4 class="phpdocumentor-element__name" id="method_product">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php"><a href="files/bigcommercelegacyapi-api-orders-ordersapi.html"><abbr title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php">OrdersApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">106</span>
+    <span class="phpdocumentor-element-found-in__line">110</span>
 
     </aside>
 
@@ -787,7 +787,7 @@ <h4 class="phpdocumentor-element__name" id="method_products">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php"><a href="files/bigcommercelegacyapi-api-orders-ordersapi.html"><abbr title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php">OrdersApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">101</span>
+    <span class="phpdocumentor-element-found-in__line">105</span>
 
     </aside>
 
@@ -826,7 +826,7 @@ <h4 class="phpdocumentor-element__name" id="method_shippingAddress">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php"><a href="files/bigcommercelegacyapi-api-orders-ordersapi.html"><abbr title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php">OrdersApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">116</span>
+    <span class="phpdocumentor-element-found-in__line">120</span>
 
     </aside>
 
@@ -876,7 +876,7 @@ <h4 class="phpdocumentor-element__name" id="method_shippingAddresses">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php"><a href="files/bigcommercelegacyapi-api-orders-ordersapi.html"><abbr title="BigCommerceLegacyApi/Api/Orders/OrdersApi.php">OrdersApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">111</span>
+    <span class="phpdocumentor-element-found-in__line">115</span>
 
     </aside>
 

docs/classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html

@@ -159,6 +159,13 @@ <h3 id="toc">
 </dt>
 <dd></dd>
 
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html#method_get">get()</a>
+    <span>
+                                &nbsp;: <a href="classes/BigCommerce-ApiV2-ResourceModels-StoreInformation-StoreInformation.html"><abbr title="\BigCommerce\ApiV2\ResourceModels\StoreInformation\StoreInformation">StoreInformation</abbr></a>    </span>
+</dt>
+<dd>Returns metadata about a store.</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/BigCommerce-ApiV2-Api-Generic-V2ApiBase.html#method_getClient">getClient()</a>
     <span>
@@ -272,6 +279,53 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
             &mdash;
 
 
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
+>
+    <h4 class="phpdocumentor-element__name" id="method_get">
+        get()
+        <a href="classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php"><a href="files/bigcommercelegacyapi-api-storeinformation-storeinformationapi.html"><abbr title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php">StoreInformationApi.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">31</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Returns metadata about a store.</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">get</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResourceModels-StoreInformation-StoreInformation.html"><abbr title="\BigCommerce\ApiV2\ResourceModels\StoreInformation\StoreInformation">StoreInformation</abbr></a></span></code>
+
+    
+    
+    
+    <h5 class="phpdocumentor-tag-list__heading" id="tags">
+        Tags
+        <a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
+    </h5>
+    <dl class="phpdocumentor-tag-list">
+                                    <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">throws</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                <span class="phpdocumentor-tag-link"><abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>
+                                                            
+                                             
+                                    </dd>
+                                            </dl>
+
+        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
+    <span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResourceModels-StoreInformation-StoreInformation.html"><abbr title="\BigCommerce\ApiV2\ResourceModels\StoreInformation\StoreInformation">StoreInformation</abbr></a></span>
+            &mdash;
+        
+    
 </article>
                     <article
         class="phpdocumentor-element
@@ -394,7 +448,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
         class="phpdocumentor-element
             -method
             -public
-                                                        "
+            -deprecated                                            "
 >
     <h4 class="phpdocumentor-element__name" id="method_storeInformation">
         storeInformation()
@@ -403,13 +457,13 @@ <h4 class="phpdocumentor-element__name" id="method_storeInformation">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php"><a href="files/bigcommercelegacyapi-api-storeinformation-storeinformationapi.html"><abbr title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php">StoreInformationApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">19</span>
+    <span class="phpdocumentor-element-found-in__line">20</span>
 
     </aside>
 
         <p class="phpdocumentor-summary">Returns metadata about a store.</p>
 
-    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <code class="phpdocumentor-code phpdocumentor-signature -deprecated">
     <span class="phpdocumentor-signature__visibility">public</span>
                     <span class="phpdocumentor-signature__name">storeInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResourceModels-StoreInformation-StoreInformation.html"><abbr title="\BigCommerce\ApiV2\ResourceModels\StoreInformation\StoreInformation">StoreInformation</abbr></a></span></code>
 
@@ -428,6 +482,15 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
                                                                 <span class="phpdocumentor-tag-link"><abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>
 
 
+                                    </dd>
+                                                <dt class="phpdocumentor-tag-list__entry">
+                    <span class="phpdocumentor-tag__name">deprecated</span>
+                </dt>
+                <dd class="phpdocumentor-tag-list__definition">
+                                                                                
+                                                 <section class="phpdocumentor-description"><p>Replaced by <code class="prettyprint">get()</code> function.</p>
+</section>
+
                                     </dd>
                                             </dl>
 
@@ -450,7 +513,7 @@ <h4 class="phpdocumentor-element__name" id="method_time">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php"><a href="files/bigcommercelegacyapi-api-storeinformation-storeinformationapi.html"><abbr title="BigCommerceLegacyApi/Api/StoreInformation/StoreInformationApi.php">StoreInformationApi.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">36</span>
+    <span class="phpdocumentor-element-found-in__line">48</span>
 
     </aside>