Skip to content

Commit 55b1b52

Browse files
committed
Update docs for 1.11.0 release
1 parent 7b1c938 commit 55b1b52

20 files changed

+5270
-26
lines changed

docs/classes/BigCommerce-ApiV3-Api-Wishlists-WishlistsApi.html

+924
Large diffs are not rendered by default.

docs/classes/BigCommerce-ApiV3-Client.html

+129-26
Large diffs are not rendered by default.

docs/classes/BigCommerce-ApiV3-ResourceModels-Wishlist-Wishlist.html

+681
Large diffs are not rendered by default.

docs/classes/BigCommerce-ApiV3-ResourceModels-Wishlist-WishlistItem.html

+538
Large diffs are not rendered by default.

docs/classes/BigCommerce-ApiV3-ResponseModels-Wishlist-WishlistResponse.html

+391
Large diffs are not rendered by default.

docs/classes/BigCommerce-ApiV3-ResponseModels-Wishlist-WishlistsResponse.html

+436
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,253 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Documentation</title>
6+
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
<base href="../">
9+
<link rel="icon" href="images/favicon.ico"/>
10+
<link rel="stylesheet" href="css/normalize.css">
11+
<link rel="stylesheet" href="css/base.css">
12+
<link rel="preconnect" href="https://fonts.gstatic.com">
13+
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
14+
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
15+
<link rel="stylesheet" href="css/template.css">
16+
<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" />
17+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-okaidia.css">
18+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.css">
19+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.css">
20+
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
21+
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
22+
<script src="js/search.js"></script>
23+
<script defer src="js/searchIndex.js"></script>
24+
</head>
25+
<body id="top">
26+
<header class="phpdocumentor-header phpdocumentor-section">
27+
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
28+
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
29+
<label class="phpdocumentor-header__menu-icon" for="menu-button">
30+
<i class="fas fa-bars"></i>
31+
</label>
32+
<section data-search-form class="phpdocumentor-search">
33+
<label>
34+
<span class="visually-hidden">Search for</span>
35+
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
36+
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
37+
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
38+
</svg>
39+
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
40+
</label>
41+
</section>
42+
43+
<nav class="phpdocumentor-topnav">
44+
<ul class="phpdocumentor-topnav__menu">
45+
</ul>
46+
</nav>
47+
</header>
48+
49+
<main class="phpdocumentor">
50+
<div class="phpdocumentor-section">
51+
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
52+
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
53+
Menu
54+
</label>
55+
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
56+
<section class="phpdocumentor-sidebar__category">
57+
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
58+
<h4 class="phpdocumentor-sidebar__root-namespace">
59+
<a href="namespaces/bigcommerce.html" class="">BigCommerce</a>
60+
</h4>
61+
<ul class="phpdocumentor-list">
62+
<li>
63+
<a href="namespaces/bigcommerce-apiv3.html" class="">ApiV3</a>
64+
65+
</li>
66+
<li>
67+
<a href="namespaces/bigcommerce-apiv2.html" class="">ApiV2</a>
68+
69+
</li>
70+
</ul>
71+
72+
</section>
73+
<section class="phpdocumentor-sidebar__category">
74+
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
75+
<h4 class="phpdocumentor-sidebar__root-namespace">
76+
<a href="packages/BigCommerce.html" class="">BigCommerce</a>
77+
</h4>
78+
<ul class="phpdocumentor-list">
79+
<li>
80+
<a href="packages/BigCommerce-ApiV3.html" class="">ApiV3</a>
81+
82+
</li>
83+
</ul>
84+
85+
</section>
86+
87+
<section class="phpdocumentor-sidebar__category">
88+
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
89+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
90+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
91+
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
92+
</section>
93+
94+
<section class="phpdocumentor-sidebar__category">
95+
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
96+
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
97+
</section>
98+
</aside>
99+
100+
<div class="phpdocumentor-column -eight phpdocumentor-content">
101+
<ul class="phpdocumentor-breadcrumbs">
102+
</ul>
103+
104+
<article class="phpdocumentor-element -file">
105+
<h2 class="phpdocumentor-content__title">WishlistsApi.php</h2>
106+
107+
108+
<section class="phpdocumentor-description"></section>
109+
110+
111+
112+
113+
114+
115+
<h3 id="interfaces_class_traits">
116+
Interfaces, Classes, Traits and Enums
117+
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
118+
</h3>
119+
120+
<dl class="phpdocumentor-table-of-contents">
121+
122+
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-Api-Wishlists-WishlistsApi.html"><abbr title="\BigCommerce\ApiV3\Api\Wishlists\WishlistsApi">WishlistsApi</abbr></a></dt>
123+
<dd>V3ApiBase</dd>
124+
125+
126+
</dl>
127+
128+
129+
130+
131+
132+
133+
134+
135+
<div class="phpdocumentor-modal" id="source-view">
136+
<div class="phpdocumentor-modal-bg" data-exit-button></div>
137+
<div class="phpdocumentor-modal-container">
138+
<div class="phpdocumentor-modal-content">
139+
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/BigCommerce/Api/Wishlists/WishlistsApi.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
140+
</div>
141+
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
142+
</div>
143+
</div>
144+
145+
<script type="text/javascript">
146+
(function () {
147+
function loadExternalCodeSnippet(el, url, line) {
148+
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
149+
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
150+
const language = 'php';
151+
152+
const code = document.createElement('code');
153+
code.className = 'language-' + language;
154+
pre.textContent = '';
155+
pre.setAttribute('data-line', line)
156+
code.textContent = 'Loading…';
157+
pre.appendChild(code);
158+
159+
var xhr = new XMLHttpRequest();
160+
161+
xhr.open('GET', src, true);
162+
163+
xhr.onreadystatechange = function () {
164+
if (xhr.readyState !== 4) {
165+
return;
166+
}
167+
168+
if (xhr.status < 400 && xhr.responseText) {
169+
code.textContent = xhr.responseText;
170+
Prism.highlightElement(code);
171+
return;
172+
}
173+
174+
if (xhr.status === 404) {
175+
code.textContent = '✖ Error: File could not be found';
176+
return;
177+
}
178+
179+
if (xhr.status >= 400) {
180+
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
181+
return;
182+
}
183+
184+
code.textContent = '✖ Error: An unknown error occurred';
185+
};
186+
187+
xhr.send(null);
188+
});
189+
}
190+
191+
const modalButtons = document.querySelectorAll("[data-modal]");
192+
const openedAsLocalFile = window.location.protocol === 'file:';
193+
if (modalButtons.length > 0 && openedAsLocalFile) {
194+
console.warn(
195+
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
196+
'browsers block XHR requests when a page is opened this way'
197+
);
198+
}
199+
200+
modalButtons.forEach(function (trigger) {
201+
if (openedAsLocalFile) {
202+
trigger.setAttribute("hidden", "hidden");
203+
}
204+
205+
trigger.addEventListener("click", function (event) {
206+
event.preventDefault();
207+
const modal = document.getElementById(trigger.dataset.modal);
208+
if (!modal) {
209+
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
210+
return;
211+
}
212+
modal.classList.add("phpdocumentor-modal__open");
213+
214+
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
215+
const exits = modal.querySelectorAll("[data-exit-button]");
216+
exits.forEach(function (exit) {
217+
exit.addEventListener("click", function (event) {
218+
event.preventDefault();
219+
modal.classList.remove("phpdocumentor-modal__open");
220+
});
221+
});
222+
});
223+
});
224+
})();
225+
</script>
226+
227+
</article>
228+
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
229+
<section class="phpdocumentor-search-results__dialog">
230+
<header class="phpdocumentor-search-results__header">
231+
<h2 class="phpdocumentor-search-results__title">Search results</h2>
232+
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
233+
</header>
234+
<section class="phpdocumentor-search-results__body">
235+
<ul class="phpdocumentor-search-results__entries"></ul>
236+
</section>
237+
</section>
238+
</section>
239+
</div>
240+
</div>
241+
<a href="files/bigcommerce-api-wishlists-wishlistsapi.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
242+
243+
</main>
244+
245+
<script>
246+
cssVars({});
247+
</script>
248+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/prism.min.js"></script>
249+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/autoloader/prism-autoloader.min.js"></script>
250+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.js"></script>
251+
<script src="https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-highlight/prism-line-highlight.min.js"></script>
252+
</body>
253+
</html>

0 commit comments

Comments
 (0)