Skip to content

Commit

Permalink
Update docs for 1.9 release
Browse files Browse the repository at this point in the history
  • Loading branch information
@jswift
jswift committed Aug 15, 2022
1 parent 20dcf60 commit 8858872
Show file tree
Hide file tree
Showing 629 changed files with 98,177 additions and 22,706 deletions.
181 changes: 120 additions & 61 deletions docs/classes/BigCommerce-ApiV2-Api-Generic-V2Api.html
View file

Large diffs are not rendered by default.

194 changes: 130 additions & 64 deletions docs/classes/BigCommerce-ApiV2-Api-Generic-V2ApiBase.html
View file

Large diffs are not rendered by default.

234 changes: 163 additions & 71 deletions docs/classes/BigCommerce-ApiV2-Api-Orders-OrderProductsApi.html
View file

Large diffs are not rendered by default.

234 changes: 163 additions & 71 deletions docs/classes/BigCommerce-ApiV2-Api-Orders-OrderShippingAddressesApi.html
View file

Large diffs are not rendered by default.

290 changes: 206 additions & 84 deletions docs/classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html
View file

Large diffs are not rendered by default.

203 changes: 134 additions & 69 deletions docs/classes/BigCommerce-ApiV2-Api-StoreInformation-StoreInformationApi.html
View file

Large diffs are not rendered by default.

679 changes: 555 additions & 124 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html
View file

Large diffs are not rendered by default.

267 changes: 196 additions & 71 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderAddress.html
View file

Large diffs are not rendered by default.

285 changes: 211 additions & 74 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderBillingAddress.html
View file

Large diffs are not rendered by default.

229 changes: 162 additions & 67 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderProduct.html
View file

Large diffs are not rendered by default.

275 changes: 203 additions & 72 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-Order-OrderShippingAddress.html
View file

Large diffs are not rendered by default.

187 changes: 126 additions & 61 deletions docs/classes/BigCommerce-ApiV2-ResourceModels-ResourceReference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>



Expand All @@ -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>

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>

Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down
Loading

0 comments on commit 8858872

Please sign in to comment.