Feature/add custom url helper

RELEASE_NOTES.md

@@ -1,9 +1,4 @@
 
 ### New Features
 
- - Add the ability to specify attributes, addresses, form_fields, and authentication when creating customers (#67)
-
-### Fixes
-
- - Add missing Customer properties (`notes`, `tax_exempt_category`, `accepts_product_review_abandoned_cart_emails`, 
-   `store_credit_amounts`, `origin_channel_id`, and `channel_ids`)
+ - Add `setCustomUrl()` to **Category**, **Brand**, and **Product** for simpler custom url setup

docs/classes/BigCommerce-ApiV3-Api-Generic-BatchCreateResource.html

@@ -15,6 +15,7 @@
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
                 <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
         <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
         <script src="js/search.js"></script>
@@ -91,9 +92,11 @@ <h2 class="phpdocumentor-content__title">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchCreateResource.php"><a href="files/bigcommerce-api-generic-batchcreateresource.html"><abbr title="BigCommerce/Api/Generic/BatchCreateResource.php">BatchCreateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">10</span>
-</aside>
+
+    </aside>
 
 
+    <section class="phpdocumentor-description"></section>
 
 
 
@@ -147,22 +150,25 @@ <h4 class="phpdocumentor-element__name" id="method_batchCreate">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchCreateResource.php"><a href="files/bigcommerce-api-generic-batchcreateresource.html"><abbr title="BigCommerce/Api/Generic/BatchCreateResource.php">BatchCreateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">12</span>
-</aside>
+
+    </aside>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
     <span class="phpdocumentor-signature__abstract">abstract</span>            <span class="phpdocumentor-signature__name">batchCreate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resources</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-ResponseModels-PaginatedResponse.html"><abbr title="\BigCommerce\ApiV3\ResponseModels\PaginatedResponse">PaginatedResponse</abbr></a></span></code>
 
-
+        <section class="phpdocumentor-description"></section>
+
         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$resources</span>
                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"></section>
+
             </dd>
             </dl>
 
@@ -171,8 +177,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-ResponseModels-PaginatedResponse.html"><abbr title="\BigCommerce\ApiV3\ResponseModels\PaginatedResponse">PaginatedResponse</abbr></a></span>
             &mdash;
-            <section class="phpdocumentor-description"></section>
-
+
 
 </article>
                     <article
@@ -189,26 +194,89 @@ <h4 class="phpdocumentor-element__name" id="method_getClient">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchCreateResource.php"><a href="files/bigcommerce-api-generic-batchcreateresource.html"><abbr title="BigCommerce/Api/Generic/BatchCreateResource.php">BatchCreateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">14</span>
-</aside>
+
+    </aside>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
     <span class="phpdocumentor-signature__abstract">abstract</span>            <span class="phpdocumentor-signature__name">getClient</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-Client.html"><abbr title="\BigCommerce\ApiV3\Client">Client</abbr></a></span></code>
 
-
+        <section class="phpdocumentor-description"></section>
+
 
 
 
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-Client.html"><abbr title="\BigCommerce\ApiV3\Client">Client</abbr></a></span>
             &mdash;
-            <section class="phpdocumentor-description"></section>
-
+
 
 </article>
             </section>
 
+
+    <script type="text/javascript">
+        function loadExternalCodeSnippets(line) {
+            Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
+                var src = pre.getAttribute('data-src').replace( /\\/g, '/');
+                var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
+                var language = 'php';
+
+                var code = document.createElement('code');
+                code.className = 'language-' + language;
+
+                pre.textContent = '';
+
+                pre.setAttribute('data-line', line)
+                code.textContent = 'Loading…';
+
+                pre.appendChild(code);
+
+                var xhr = new XMLHttpRequest();
+
+                xhr.open('GET', src, true);
+
+                xhr.onreadystatechange = function () {
+                    if (xhr.readyState == 4) {
+
+                        if (xhr.status < 400 && xhr.responseText) {
+                            code.textContent = xhr.responseText;
+
+                            Prism.highlightElement(code);
+                        }
+                        else if (xhr.status >= 400) {
+                            code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
+                        }
+                        else {
+                            code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
+                        }
+                    }
+                };
+
+                xhr.send(null);
+            });
+        }
+
+        var modals = document.querySelectorAll("[data-modal]");
+
+        modals.forEach(function (trigger) {
+            trigger.addEventListener("click", function (event) {
+                //event.preventDefault();
+                const modal = document.getElementById(trigger.dataset.modal);
+                modal.classList.add("phpdocumentor-modal__open");
+                loadExternalCodeSnippets(trigger.dataset.line)
+                const exits = modal.querySelectorAll("[data-exit-button]");
+                exits.forEach(function (exit) {
+                    exit.addEventListener("click", function (event) {
+                        event.preventDefault();
+                        modal.classList.remove("phpdocumentor-modal__open");
+                    });
+                });
+            });
+        });
+    </script>
+
     </article>
                 <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
     <section class="phpdocumentor-search-results__dialog">
@@ -233,5 +301,6 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
 </body>
 </html>

docs/classes/BigCommerce-ApiV3-Api-Generic-BatchUpdateResource.html

@@ -15,6 +15,7 @@
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
         <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
                 <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
         <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
         <script src="js/search.js"></script>
@@ -91,9 +92,11 @@ <h2 class="phpdocumentor-content__title">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchUpdateResource.php"><a href="files/bigcommerce-api-generic-batchupdateresource.html"><abbr title="BigCommerce/Api/Generic/BatchUpdateResource.php">BatchUpdateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">10</span>
-</aside>
+
+    </aside>
 
 
+    <section class="phpdocumentor-description"></section>
 
 
 
@@ -147,22 +150,25 @@ <h4 class="phpdocumentor-element__name" id="method_batchUpdate">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchUpdateResource.php"><a href="files/bigcommerce-api-generic-batchupdateresource.html"><abbr title="BigCommerce/Api/Generic/BatchUpdateResource.php">BatchUpdateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">12</span>
-</aside>
+
+    </aside>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
     <span class="phpdocumentor-signature__abstract">abstract</span>            <span class="phpdocumentor-signature__name">batchUpdate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$resources</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-ResponseModels-PaginatedResponse.html"><abbr title="\BigCommerce\ApiV3\ResponseModels\PaginatedResponse">PaginatedResponse</abbr></a></span></code>
 
-
+        <section class="phpdocumentor-description"></section>
+
         <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$resources</span>
                 : <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"></section>
+
             </dd>
             </dl>
 
@@ -171,8 +177,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-ResponseModels-PaginatedResponse.html"><abbr title="\BigCommerce\ApiV3\ResponseModels\PaginatedResponse">PaginatedResponse</abbr></a></span>
             &mdash;
-            <section class="phpdocumentor-description"></section>
-
+
 
 </article>
                     <article
@@ -189,26 +194,89 @@ <h4 class="phpdocumentor-element__name" id="method_getClient">
     <abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/Api/Generic/BatchUpdateResource.php"><a href="files/bigcommerce-api-generic-batchupdateresource.html"><abbr title="BigCommerce/Api/Generic/BatchUpdateResource.php">BatchUpdateResource.php</abbr></a></abbr>
     :
     <span class="phpdocumentor-element-found-in__line">14</span>
-</aside>
+
+    </aside>
 
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
     <span class="phpdocumentor-signature__abstract">abstract</span>            <span class="phpdocumentor-signature__name">getClient</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-Client.html"><abbr title="\BigCommerce\ApiV3\Client">Client</abbr></a></span></code>
 
-
+        <section class="phpdocumentor-description"></section>
+
 
 
 
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-Client.html"><abbr title="\BigCommerce\ApiV3\Client">Client</abbr></a></span>
             &mdash;
-            <section class="phpdocumentor-description"></section>
-
+
 
 </article>
             </section>
 
+
+    <script type="text/javascript">
+        function loadExternalCodeSnippets(line) {
+            Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
+                var src = pre.getAttribute('data-src').replace( /\\/g, '/');
+                var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
+                var language = 'php';
+
+                var code = document.createElement('code');
+                code.className = 'language-' + language;
+
+                pre.textContent = '';
+
+                pre.setAttribute('data-line', line)
+                code.textContent = 'Loading…';
+
+                pre.appendChild(code);
+
+                var xhr = new XMLHttpRequest();
+
+                xhr.open('GET', src, true);
+
+                xhr.onreadystatechange = function () {
+                    if (xhr.readyState == 4) {
+
+                        if (xhr.status < 400 && xhr.responseText) {
+                            code.textContent = xhr.responseText;
+
+                            Prism.highlightElement(code);
+                        }
+                        else if (xhr.status >= 400) {
+                            code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
+                        }
+                        else {
+                            code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
+                        }
+                    }
+                };
+
+                xhr.send(null);
+            });
+        }
+
+        var modals = document.querySelectorAll("[data-modal]");
+
+        modals.forEach(function (trigger) {
+            trigger.addEventListener("click", function (event) {
+                //event.preventDefault();
+                const modal = document.getElementById(trigger.dataset.modal);
+                modal.classList.add("phpdocumentor-modal__open");
+                loadExternalCodeSnippets(trigger.dataset.line)
+                const exits = modal.querySelectorAll("[data-exit-button]");
+                exits.forEach(function (exit) {
+                    exit.addEventListener("click", function (event) {
+                        event.preventDefault();
+                        modal.classList.remove("phpdocumentor-modal__open");
+                    });
+                });
+            });
+        });
+    </script>
+
     </article>
                 <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
     <section class="phpdocumentor-search-results__dialog">
@@ -233,5 +301,6 @@ <h2 class="phpdocumentor-search-results__title">Search results</h2>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
 </body>
 </html>