Merge pull request #152 from aligent/release/1.9.0

Release/1.9.0
aligent · Aug 16, 2022 · 3262c85 · 3262c85
2 parents e081255 + 8858872
commit 3262c85
Show file tree

Hide file tree

Showing 658 changed files with 98,794 additions and 22,771 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,7 +1,10 @@
 ### Fixes
 
-- Fixes #135 - `ProductModiferConfig` was not correctly defined
-
-
+- CartsApi Missing Optional Include Parameter #145 (Thanks @jracek-chl)
+- ProductModifierValues was missing value data #150. This is a small breaking change 
+  to the [ProductModifierValue](./blob/main/src/BigCommerce/ResourceModels/Catalog/Product/ProductModifierValue.php)
+  constructor.
 
+### New Features
 
+- Implement [Site Routes API](https://developer.bigcommerce.com/api-reference/264af6ae04399-get-a-site-s-routes) #144
diff --git a/docs/classes/BigCommerce-ApiV2-Api-Generic-V2Api.html b/docs/classes/BigCommerce-ApiV2-Api-Generic-V2Api.html
diff --git a/docs/classes/BigCommerce-ApiV2-Api-Generic-V2ApiBase.html b/docs/classes/BigCommerce-ApiV2-Api-Generic-V2ApiBase.html
diff --git a/docs/classes/BigCommerce-ApiV2-Api-Orders-OrderProductsApi.html b/docs/classes/BigCommerce-ApiV2-Api-Orders-OrderProductsApi.html
diff --git a/docs/classes/BigCommerce-ApiV2-Api-Orders-OrderShippingAddressesApi.html b/docs/classes/BigCommerce-ApiV2-Api-Orders-OrderShippingAddressesApi.html
diff --git a/docs/classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html b/docs/classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html
diff --git a/docs/classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html b/docs/classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderAddress.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderAddress.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderBillingAddress.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderBillingAddress.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderProduct.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderProduct.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderShippingAddress.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderShippingAddress.html
diff --git a/docs/classes/BigCommerce-ApiV2-ResourceModels-ResourceReference.html b/docs/classes/BigCommerce-ApiV2-ResourceModels-ResourceReference.html
@@ -2,7 +2,8 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>Documentation</title>
+            <title>Documentation</title>
+
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <base href="../">
     <link rel="icon" href="images/favicon.ico"/>
@@ -54,25 +55,29 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Doc
 <aside class="phpdocumentor-column -four phpdocumentor-sidebar">
                     <section class="phpdocumentor-sidebar__category">
             <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
-                                    <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/bigcommerce.html">BigCommerce</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/bigcommerce.html" class="">BigCommerce</a>
+</h4>
     <ul class="phpdocumentor-list">
                     <li>
-                <a href="namespaces/bigcommerce-apiv3.html">ApiV3</a>
+                <a href="namespaces/bigcommerce-apiv3.html" class="">ApiV3</a>
 
             </li>
                     <li>
-                <a href="namespaces/bigcommerce-apiv2.html">ApiV2</a>
+                <a href="namespaces/bigcommerce-apiv2.html" class="">ApiV2</a>
 
             </li>
             </ul>
 
                         </section>
                 <section class="phpdocumentor-sidebar__category">
             <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
-                                    <h4 class="phpdocumentor-sidebar__root-namespace"><a href="packages/BigCommerce.html">BigCommerce</a></h4>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/BigCommerce.html" class="">BigCommerce</a>
+</h4>
     <ul class="phpdocumentor-list">
                     <li>
-                <a href="packages/BigCommerce-ApiV3.html">ApiV3</a>
+                <a href="packages/BigCommerce-ApiV3.html" class="">ApiV3</a>
 
             </li>
             </ul>
@@ -128,6 +133,12 @@ <h2 class="phpdocumentor-content__title">
     <section class="phpdocumentor-description"></section>
 
 
+    <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">
+                                </dl>
 
 
 
@@ -140,31 +151,31 @@ <h3 id="toc">
 </h3>
 
 <dl class="phpdocumentor-table-of-contents">
-                <dt class="phpdocumentor-table-of-contents__entry -property -public">
+                    <dt class="phpdocumentor-table-of-contents__entry -property -public">
     <a href="classes/BigCommerce-ApiV2-ResourceModels-ResourceReference.html#property_resource">$resource</a>
     <span>
-                &nbsp;: string            </span>
+                        &nbsp;: string            </span>
 </dt>
 <dd></dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -public">
     <a href="classes/BigCommerce-ApiV2-ResourceModels-ResourceReference.html#property_url">$url</a>
     <span>
-                &nbsp;: string            </span>
+                        &nbsp;: string            </span>
 </dt>
 <dd></dd>
 
                 <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/BigCommerce-ApiV3-ResourceModels-ResourceModel.html#method___construct">__construct()</a>
     <span>
-                        &nbsp;: mixed    </span>
+                                &nbsp;: mixed    </span>
 </dt>
 <dd></dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/BigCommerce-ApiV3-ResourceModels-ResourceModel.html#method_jsonSerialize">jsonSerialize()</a>
     <span>
-                        &nbsp;: array&lt;string|int, mixed&gt;    </span>
+                                &nbsp;: array&lt;string|int, mixed&gt;    </span>
 </dt>
 <dd></dd>
 
@@ -212,6 +223,12 @@ <h4 class="phpdocumentor-element__name" id="property_resource">
         <section class="phpdocumentor-description"></section>
 
 
+    <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">
+                                </dl>
 
 </article>
                     <article
@@ -246,6 +263,12 @@ <h4 class="phpdocumentor-element__name" id="property_url">
         <section class="phpdocumentor-description"></section>
 
 
+    <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">
+                                </dl>
 
 </article>
             </section>
@@ -275,7 +298,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\stdClass">stdClass</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$optionObject</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
+                    <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\stdClass">stdClass</abbr>|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$optionObject</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
 
         <section class="phpdocumentor-description"></section>
 
@@ -292,6 +315,12 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
             </dl>
 
 
+    <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">
+                                </dl>
 
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type">mixed</span>
@@ -319,12 +348,18 @@ <h4 class="phpdocumentor-element__name" id="method_jsonSerialize">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                <span class="phpdocumentor-signature__name">jsonSerialize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
+                    <span class="phpdocumentor-signature__name">jsonSerialize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
 
         <section class="phpdocumentor-description"></section>
 
 
 
+    <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">
+                                </dl>
 
         <h5 class="phpdocumentor-return-value__heading">Return values</h5>
     <span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
@@ -334,66 +369,96 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
 </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);
+        <div class="phpdocumentor-modal" id="source-view">
+    <div class="phpdocumentor-modal-bg" data-exit-button></div>
+    <div class="phpdocumentor-modal-container">
+        <div class="phpdocumentor-modal-content">
+            <pre style="max-height: 500px; overflow-y: scroll" data-src="files/BigCommerceLegacyApi/ResourceModels/ResourceReference.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
+        </div>
+        <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
+    </div>
+</div>
 
-                xhr.onreadystatechange = function () {
-                    if (xhr.readyState == 4) {
+    <script type="text/javascript">
+        (function () {
+            function loadExternalCodeSnippet(el, url, line) {
+                Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
+                    const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
+                    const language = 'php';
+
+                    const 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) {
+                            return;
+                        }
 
                         if (xhr.status < 400 && xhr.responseText) {
                             code.textContent = xhr.responseText;
-
                             Prism.highlightElement(code);
+                            return;
                         }
-                        else if (xhr.status >= 400) {
-                            code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
+
+                        if (xhr.status === 404) {
+                            code.textContent = '✖ Error: File could not be found';
+                            return;
                         }
-                        else {
-                            code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
+
+                        if (xhr.status >= 400) {
+                            code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
+                            return;
                         }
-                    }
-                };
 
-                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");
+                        code.textContent = '✖ Error: An unknown error occurred';
+                    };
+
+                    xhr.send(null);
+                });
+            }
+
+            const modalButtons = document.querySelectorAll("[data-modal]");
+            const openedAsLocalFile = window.location.protocol === 'file:';
+            if (modalButtons.length > 0 && openedAsLocalFile) {
+                console.warn(
+                    'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
+                    'browsers block XHR requests when a page is opened this way'
+                );
+            }
+
+            modalButtons.forEach(function (trigger) {
+                if (openedAsLocalFile) {
+                    trigger.setAttribute("hidden", "hidden");
+                }
+
+                trigger.addEventListener("click", function (event) {
+                    event.preventDefault();
+                    const modal = document.getElementById(trigger.dataset.modal);
+                    if (!modal) {
+                        console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
+                        return;
+                    }
+                    modal.classList.add("phpdocumentor-modal__open");
+
+                    loadExternalCodeSnippet(modal, trigger.dataset.src || null, 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>