Skip to content

Commit 2c67766

Browse files
jswiftjswift
committed
Update docs for 1.7.0 release
1 parent 06d265b commit 2c67766

24 files changed

+5868
-35
lines changed

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

Lines changed: 176 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,17 +99,36 @@ <h2 class="phpdocumentor-content__title">
9999
<aside class="phpdocumentor-element-found-in">
100100
<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>
101101
:
102-
<span class="phpdocumentor-element-found-in__line">30</span>
102+
<span class="phpdocumentor-element-found-in__line">48</span>
103103

104104
</aside>
105105

106106
<p class="phpdocumentor-summary">Orders v2 API</p>
107107

108-
<section class="phpdocumentor-description"><p>Currently only implements <em>create</em>.</p>
108+
<section class="phpdocumentor-description"><p>Some functionality for Orders is not available in V3, so this V2 API class has been implemented.</p>
109+
</section>
110+
111+
112+
<h5 class="phpdocumentor-tag-list__heading" id="tags">
113+
Tags
114+
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
115+
</h5>
116+
<dl class="phpdocumentor-tag-list">
117+
<dt class="phpdocumentor-tag-list__entry">
118+
<span class="phpdocumentor-tag__name">see</span>
119+
</dt>
120+
<dd class="phpdocumentor-tag-list__definition">
121+
<span class="phpdocumentor-tag-link"><a href="classes/BigCommerce-ApiV3-Api-Orders-OrdersApi.html"><abbr title="\BigCommerce\ApiV3\Api\Orders\OrdersApi">OrdersApi</abbr></a></span>
122+
123+
<section class="phpdocumentor-description"><p>for the V3 API</p>
109124
<h3>Example</h3>
125+
<h4>Create an Order</h4>
110126
<pre class="prettyprint"><code class="language-php">$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
111127

112128
$order = new BigCommerce\ApiV2\ResourceModels\Order\Order();
129+
$order-&gt;products = [
130+
OrderProduct::build('test', 1, 12, 10),
131+
];
113132
// set order details...
114133

115134
try {
@@ -119,9 +138,14 @@ <h3>Example</h3>
119138
echo &quot;Unable to update product: {$exception-&gt;getMessage()}&quot;;
120139
}
121140
</code></pre>
141+
<h4>Get Order Counts</h4>
142+
<pre class="prettyprint"><code class="language-php">$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
143+
$ordersAwaitingFulfillmentCount = $api-&gt;orders()-&gt;count()-&gt;statuses['Awaiting Fulfillment'];
144+
</code></pre>
122145
</section>
123146

124-
147+
</dd>
148+
</dl>
125149

126150

127151

@@ -139,13 +163,34 @@ <h3 id="toc">
139163
<span>
140164
&nbsp;: mixed </span>
141165
</dt>
166+
<dd></dd>
167+
168+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
169+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_count">count()</a>
170+
<span>
171+
&nbsp;: <a href="classes/BigCommerce-ApiV2-ResponseModels-Order-OrderCount.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\OrderCount">OrderCount</abbr></a> </span>
172+
</dt>
142173
<dd></dd>
143174

144175
<dt class="phpdocumentor-table-of-contents__entry -method -public">
145176
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_create">create()</a>
146177
<span>
147178
&nbsp;: object </span>
148179
</dt>
180+
<dd></dd>
181+
182+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
183+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_get">get()</a>
184+
<span>
185+
&nbsp;: <a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>|null </span>
186+
</dt>
187+
<dd></dd>
188+
189+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
190+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_getAll">getAll()</a>
191+
<span>
192+
&nbsp;: array&lt;string|int, <a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>&gt; </span>
193+
</dt>
149194
<dd></dd>
150195

151196
<dt class="phpdocumentor-table-of-contents__entry -method -public">
@@ -255,6 +300,39 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
255300
&mdash;
256301

257302

303+
</article>
304+
<article
305+
class="phpdocumentor-element
306+
-method
307+
-public
308+
"
309+
>
310+
<h4 class="phpdocumentor-element__name" id="method_count">
311+
count()
312+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_count" class="headerlink"><i class="fas fa-link"></i></a>
313+
</h4>
314+
<aside class="phpdocumentor-element-found-in">
315+
<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>
316+
:
317+
<span class="phpdocumentor-element-found-in__line">92</span>
318+
319+
</aside>
320+
321+
322+
<code class="phpdocumentor-code phpdocumentor-signature ">
323+
<span class="phpdocumentor-signature__visibility">public</span>
324+
<span class="phpdocumentor-signature__name">count</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResponseModels-Order-OrderCount.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\OrderCount">OrderCount</abbr></a></span></code>
325+
326+
<section class="phpdocumentor-description"></section>
327+
328+
329+
330+
331+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
332+
<span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResponseModels-Order-OrderCount.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\OrderCount">OrderCount</abbr></a></span>
333+
&mdash;
334+
335+
258336
</article>
259337
<article
260338
class="phpdocumentor-element
@@ -269,7 +347,7 @@ <h4 class="phpdocumentor-element__name" id="method_create">
269347
<aside class="phpdocumentor-element-found-in">
270348
<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>
271349
:
272-
<span class="phpdocumentor-element-found-in__line">47</span>
350+
<span class="phpdocumentor-element-found-in__line">68</span>
273351

274352
</aside>
275353

@@ -299,6 +377,98 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
299377
&mdash;
300378

301379

380+
</article>
381+
<article
382+
class="phpdocumentor-element
383+
-method
384+
-public
385+
"
386+
>
387+
<h4 class="phpdocumentor-element__name" id="method_get">
388+
get()
389+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
390+
</h4>
391+
<aside class="phpdocumentor-element-found-in">
392+
<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>
393+
:
394+
<span class="phpdocumentor-element-found-in__line">75</span>
395+
396+
</aside>
397+
398+
399+
<code class="phpdocumentor-code phpdocumentor-signature ">
400+
<span class="phpdocumentor-signature__visibility">public</span>
401+
<span class="phpdocumentor-signature__name">get</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>|null</span></code>
402+
403+
<section class="phpdocumentor-description"></section>
404+
405+
406+
407+
408+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
409+
<span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>|null</span>
410+
&mdash;
411+
412+
413+
</article>
414+
<article
415+
class="phpdocumentor-element
416+
-method
417+
-public
418+
"
419+
>
420+
<h4 class="phpdocumentor-element__name" id="method_getAll">
421+
getAll()
422+
<a href="classes/BigCommerce-ApiV2-Api-Orders-OrdersApi.html#method_getAll" class="headerlink"><i class="fas fa-link"></i></a>
423+
</h4>
424+
<aside class="phpdocumentor-element-found-in">
425+
<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>
426+
:
427+
<span class="phpdocumentor-element-found-in__line">85</span>
428+
429+
</aside>
430+
431+
432+
<code class="phpdocumentor-code phpdocumentor-signature ">
433+
<span class="phpdocumentor-signature__visibility">public</span>
434+
<span class="phpdocumentor-signature__name">getAll</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$filters</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$page</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">250</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>&gt;</span></code>
435+
436+
437+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
438+
<dl class="phpdocumentor-argument-list">
439+
<dt class="phpdocumentor-argument-list__entry">
440+
<span class="phpdocumentor-signature__argument__name">$filters</span>
441+
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
442+
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
443+
<dd class="phpdocumentor-argument-list__definition">
444+
<section class="phpdocumentor-description"></section>
445+
446+
</dd>
447+
<dt class="phpdocumentor-argument-list__entry">
448+
<span class="phpdocumentor-signature__argument__name">$page</span>
449+
: <span class="phpdocumentor-signature__argument__return-type">int</span>
450+
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
451+
<dd class="phpdocumentor-argument-list__definition">
452+
<section class="phpdocumentor-description"></section>
453+
454+
</dd>
455+
<dt class="phpdocumentor-argument-list__entry">
456+
<span class="phpdocumentor-signature__argument__name">$limit</span>
457+
: <span class="phpdocumentor-signature__argument__return-type">int</span>
458+
= <span class="phpdocumentor-signature__argument__default-value">250</span> </dt>
459+
<dd class="phpdocumentor-argument-list__definition">
460+
<section class="phpdocumentor-description"></section>
461+
462+
</dd>
463+
</dl>
464+
465+
466+
467+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
468+
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BigCommerce-ApiV2-ResponseModels-Order-Order.html"><abbr title="\BigCommerce\ApiV2\ResponseModels\Order\Order">Order</abbr></a>&gt;</span>
469+
&mdash;
470+
471+
302472
</article>
303473
<article
304474
class="phpdocumentor-element
@@ -412,7 +582,7 @@ <h4 class="phpdocumentor-element__name" id="method_multipleResourceUrl">
412582
<aside class="phpdocumentor-element-found-in">
413583
<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>
414584
:
415-
<span class="phpdocumentor-element-found-in__line">42</span>
585+
<span class="phpdocumentor-element-found-in__line">63</span>
416586

417587
</aside>
418588

@@ -445,7 +615,7 @@ <h4 class="phpdocumentor-element__name" id="method_singleResourceUrl">
445615
<aside class="phpdocumentor-element-found-in">
446616
<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>
447617
:
448-
<span class="phpdocumentor-element-found-in__line">37</span>
618+
<span class="phpdocumentor-element-found-in__line">58</span>
449619

450620
</aside>
451621

‎docs/classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ <h3 id="toc">
150150
<dt class="phpdocumentor-table-of-contents__entry -property -public">
151151
<a href="classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html#property_cart_id">$cart_id</a>
152152
<span>
153-
&nbsp;: string </span>
153+
&nbsp;: string|null </span>
154154
</dt>
155155
<dd></dd>
156156

@@ -213,7 +213,7 @@ <h3 id="toc">
213213
<dt class="phpdocumentor-table-of-contents__entry -property -public">
214214
<a href="classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html#property_customer_message">$customer_message</a>
215215
<span>
216-
&nbsp;: string </span>
216+
&nbsp;: string|null </span>
217217
</dt>
218218
<dd></dd>
219219

@@ -395,7 +395,7 @@ <h3 id="toc">
395395
<dt class="phpdocumentor-table-of-contents__entry -property -public">
396396
<a href="classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html#property_payment_provider_id">$payment_provider_id</a>
397397
<span>
398-
&nbsp;: string </span>
398+
&nbsp;: string|null </span>
399399
</dt>
400400
<dd></dd>
401401

@@ -465,7 +465,7 @@ <h3 id="toc">
465465
<dt class="phpdocumentor-table-of-contents__entry -property -public">
466466
<a href="classes/BigCommerce-ApiV2-ResourceModels-Order-Order.html#property_staff_notes">$staff_notes</a>
467467
<span>
468-
&nbsp;: string </span>
468+
&nbsp;: string|null </span>
469469
</dt>
470470
<dd></dd>
471471

@@ -745,7 +745,7 @@ <h4 class="phpdocumentor-element__name" id="property_cart_id">
745745

746746
<code class="phpdocumentor-code phpdocumentor-signature ">
747747
<span class="phpdocumentor-signature__visibility">public</span>
748-
<span class="phpdocumentor-signature__type">string</span>
748+
<span class="phpdocumentor-signature__type">string|null</span>
749749
<span class="phpdocumentor-signature__name">$cart_id</span>
750750
</code>
751751

@@ -1051,7 +1051,7 @@ <h4 class="phpdocumentor-element__name" id="property_customer_message">
10511051

10521052
<code class="phpdocumentor-code phpdocumentor-signature ">
10531053
<span class="phpdocumentor-signature__visibility">public</span>
1054-
<span class="phpdocumentor-signature__type">string</span>
1054+
<span class="phpdocumentor-signature__type">string|null</span>
10551055
<span class="phpdocumentor-signature__name">$customer_message</span>
10561056
</code>
10571057

@@ -1935,7 +1935,7 @@ <h4 class="phpdocumentor-element__name" id="property_payment_provider_id">
19351935

19361936
<code class="phpdocumentor-code phpdocumentor-signature ">
19371937
<span class="phpdocumentor-signature__visibility">public</span>
1938-
<span class="phpdocumentor-signature__type">string</span>
1938+
<span class="phpdocumentor-signature__type">string|null</span>
19391939
<span class="phpdocumentor-signature__name">$payment_provider_id</span>
19401940
</code>
19411941

@@ -2271,7 +2271,7 @@ <h4 class="phpdocumentor-element__name" id="property_staff_notes">
22712271

22722272
<code class="phpdocumentor-code phpdocumentor-signature ">
22732273
<span class="phpdocumentor-signature__visibility">public</span>
2274-
<span class="phpdocumentor-signature__type">string</span>
2274+
<span class="phpdocumentor-signature__type">string|null</span>
22752275
<span class="phpdocumentor-signature__name">$staff_notes</span>
22762276
</code>
22772277

0 commit comments

Comments
 (0)