Skip to content

Commit 4f52473

Browse files
jswiftjswift
authored
Merge pull request #78 from aligent/release/v1.5.3
Release/v1.5.3
2 parents 5e3403a + 181906e commit 4f52473

7 files changed

+218
-15
lines changed

‎RELEASE_NOTES.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1+
### New Features
2+
3+
- Add `Redirect::toProduct()` and `toCategory()` methods. See
4+
[documentation](https://aligent.github.io/bigcommerce-v3-api-php-client/classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html)
5+
for details.
6+
7+
- Add ability for batch update to auto-retry chunks
8+
19
### Fixes
210

3-
- Fixes `The request payload is too large. The maximum items allowed in the array is 50`
4-
error on upsert redirects endpoint
11+
- Fixes bug in creating/updating Customer Addresses (thanks @davidnathanael)
512

‎docs/classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html‎

Lines changed: 121 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,24 @@ <h2 class="phpdocumentor-content__title">
9898
<aside class="phpdocumentor-element-found-in">
9999
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
100100
:
101-
<span class="phpdocumentor-element-found-in__line">8</span>
101+
<span class="phpdocumentor-element-found-in__line">27</span>
102102

103103
</aside>
104104

105-
106-
<section class="phpdocumentor-description"></section>
105+
<p class="phpdocumentor-summary">Redirect Resource</p>
106+
107+
<section class="phpdocumentor-description"><p>Represents the request object for redirect objects.</p>
108+
<p>Contains a convenience method for simply redirecting to a product or category</p>
109+
<pre class="prettyprint"><code class="language-php">$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
110+
111+
$productRedirect = new Redirect();
112+
$productRedirect-&gt;site_id = 1000;
113+
$productRedirect-&gt;from_path = '/cool-product.html';
114+
$productRedirect-&gt;toProduct(123);
115+
116+
$api-&gt;redirects()-&gt;upsert([$productRedirect]);
117+
</code></pre>
118+
</section>
107119

108120

109121

@@ -151,6 +163,20 @@ <h3 id="toc">
151163
<span>
152164
&nbsp;: array&lt;string|int, mixed&gt; </span>
153165
</dt>
166+
<dd></dd>
167+
168+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
169+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toCategory">toCategory()</a>
170+
<span>
171+
&nbsp;: void </span>
172+
</dt>
173+
<dd></dd>
174+
175+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
176+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toProduct">toProduct()</a>
177+
<span>
178+
&nbsp;: void </span>
179+
</dt>
154180
<dd></dd>
155181

156182
</dl>
@@ -181,7 +207,7 @@ <h4 class="phpdocumentor-element__name" id="property_from_path">
181207
<aside class="phpdocumentor-element-found-in">
182208
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
183209
:
184-
<span class="phpdocumentor-element-found-in__line">10</span>
210+
<span class="phpdocumentor-element-found-in__line">29</span>
185211

186212
</aside>
187213

@@ -215,7 +241,7 @@ <h4 class="phpdocumentor-element__name" id="property_site_id">
215241
<aside class="phpdocumentor-element-found-in">
216242
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
217243
:
218-
<span class="phpdocumentor-element-found-in__line">11</span>
244+
<span class="phpdocumentor-element-found-in__line">30</span>
219245

220246
</aside>
221247

@@ -249,7 +275,7 @@ <h4 class="phpdocumentor-element__name" id="property_to">
249275
<aside class="phpdocumentor-element-found-in">
250276
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
251277
:
252-
<span class="phpdocumentor-element-found-in__line">12</span>
278+
<span class="phpdocumentor-element-found-in__line">31</span>
253279

254280
</aside>
255281

@@ -287,7 +313,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
287313
<aside class="phpdocumentor-element-found-in">
288314
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
289315
:
290-
<span class="phpdocumentor-element-found-in__line">14</span>
316+
<span class="phpdocumentor-element-found-in__line">33</span>
291317

292318
</aside>
293319

@@ -350,6 +376,94 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
350376
&mdash;
351377

352378

379+
</article>
380+
<article
381+
class="phpdocumentor-element
382+
-method
383+
-public
384+
"
385+
>
386+
<h4 class="phpdocumentor-element__name" id="method_toCategory">
387+
toCategory()
388+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toCategory" class="headerlink"><i class="fas fa-link"></i></a>
389+
</h4>
390+
<aside class="phpdocumentor-element-found-in">
391+
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
392+
:
393+
<span class="phpdocumentor-element-found-in__line">48</span>
394+
395+
</aside>
396+
397+
398+
<code class="phpdocumentor-code phpdocumentor-signature ">
399+
<span class="phpdocumentor-signature__visibility">public</span>
400+
<span class="phpdocumentor-signature__name">toCategory</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$categoryId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
401+
402+
<section class="phpdocumentor-description"></section>
403+
404+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
405+
<dl class="phpdocumentor-argument-list">
406+
<dt class="phpdocumentor-argument-list__entry">
407+
<span class="phpdocumentor-signature__argument__name">$categoryId</span>
408+
: <span class="phpdocumentor-signature__argument__return-type">int</span>
409+
</dt>
410+
<dd class="phpdocumentor-argument-list__definition">
411+
<section class="phpdocumentor-description"></section>
412+
413+
</dd>
414+
</dl>
415+
416+
417+
418+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
419+
<span class="phpdocumentor-signature__response_type">void</span>
420+
&mdash;
421+
422+
423+
</article>
424+
<article
425+
class="phpdocumentor-element
426+
-method
427+
-public
428+
"
429+
>
430+
<h4 class="phpdocumentor-element__name" id="method_toProduct">
431+
toProduct()
432+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toProduct" class="headerlink"><i class="fas fa-link"></i></a>
433+
</h4>
434+
<aside class="phpdocumentor-element-found-in">
435+
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/Redirect.php"><a href="files/bigcommerce-resourcemodels-redirect-redirect.html"><abbr title="BigCommerce/ResourceModels/Redirect/Redirect.php">Redirect.php</abbr></a></abbr>
436+
:
437+
<span class="phpdocumentor-element-found-in__line">43</span>
438+
439+
</aside>
440+
441+
442+
<code class="phpdocumentor-code phpdocumentor-signature ">
443+
<span class="phpdocumentor-signature__visibility">public</span>
444+
<span class="phpdocumentor-signature__name">toProduct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$productId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
445+
446+
<section class="phpdocumentor-description"></section>
447+
448+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
449+
<dl class="phpdocumentor-argument-list">
450+
<dt class="phpdocumentor-argument-list__entry">
451+
<span class="phpdocumentor-signature__argument__name">$productId</span>
452+
: <span class="phpdocumentor-signature__argument__return-type">int</span>
453+
</dt>
454+
<dd class="phpdocumentor-argument-list__definition">
455+
<section class="phpdocumentor-description"></section>
456+
457+
</dd>
458+
</dl>
459+
460+
461+
462+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
463+
<span class="phpdocumentor-signature__response_type">void</span>
464+
&mdash;
465+
466+
353467
</article>
354468
</section>
355469

‎docs/classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html‎

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h3 id="toc">
177177
<dt class="phpdocumentor-table-of-contents__entry -property -public">
178178
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html#property_url">$url</a>
179179
<span>
180-
&nbsp;: string </span>
180+
&nbsp;: string|null </span>
181181
</dt>
182182
<dd></dd>
183183

@@ -186,6 +186,13 @@ <h3 id="toc">
186186
<span>
187187
&nbsp;: mixed </span>
188188
</dt>
189+
<dd></dd>
190+
191+
<dt class="phpdocumentor-table-of-contents__entry -method -public">
192+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html#method_buildRedirectTo">buildRedirectTo()</a>
193+
<span>
194+
&nbsp;: <a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo">RedirectTo</abbr></a> </span>
195+
</dt>
189196
<dd></dd>
190197

191198
<dt class="phpdocumentor-table-of-contents__entry -method -public">
@@ -478,7 +485,7 @@ <h4 class="phpdocumentor-element__name" id="property_url">
478485

479486
<code class="phpdocumentor-code phpdocumentor-signature ">
480487
<span class="phpdocumentor-signature__visibility">public</span>
481-
<span class="phpdocumentor-signature__type">string</span>
488+
<span class="phpdocumentor-signature__type">string|null</span>
482489
<span class="phpdocumentor-signature__name">$url</span>
483490
</code>
484491

@@ -539,6 +546,66 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
539546
&mdash;
540547

541548

549+
</article>
550+
<article
551+
class="phpdocumentor-element
552+
-method
553+
-public
554+
-static "
555+
>
556+
<h4 class="phpdocumentor-element__name" id="method_buildRedirectTo">
557+
buildRedirectTo()
558+
<a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html#method_buildRedirectTo" class="headerlink"><i class="fas fa-link"></i></a>
559+
</h4>
560+
<aside class="phpdocumentor-element-found-in">
561+
<abbr class="phpdocumentor-element-found-in__file" title="BigCommerce/ResourceModels/Redirect/RedirectTo.php"><a href="files/bigcommerce-resourcemodels-redirect-redirectto.html"><abbr title="BigCommerce/ResourceModels/Redirect/RedirectTo.php">RedirectTo.php</abbr></a></abbr>
562+
:
563+
<span class="phpdocumentor-element-found-in__line">20</span>
564+
565+
</aside>
566+
567+
568+
<code class="phpdocumentor-code phpdocumentor-signature ">
569+
<span class="phpdocumentor-signature__visibility">public</span>
570+
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">buildRedirectTo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$entityId</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$url</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"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo">RedirectTo</abbr></a></span></code>
571+
572+
<section class="phpdocumentor-description"></section>
573+
574+
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
575+
<dl class="phpdocumentor-argument-list">
576+
<dt class="phpdocumentor-argument-list__entry">
577+
<span class="phpdocumentor-signature__argument__name">$type</span>
578+
: <span class="phpdocumentor-signature__argument__return-type">string</span>
579+
</dt>
580+
<dd class="phpdocumentor-argument-list__definition">
581+
<section class="phpdocumentor-description"></section>
582+
583+
</dd>
584+
<dt class="phpdocumentor-argument-list__entry">
585+
<span class="phpdocumentor-signature__argument__name">$entityId</span>
586+
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
587+
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
588+
<dd class="phpdocumentor-argument-list__definition">
589+
<section class="phpdocumentor-description"></section>
590+
591+
</dd>
592+
<dt class="phpdocumentor-argument-list__entry">
593+
<span class="phpdocumentor-signature__argument__name">$url</span>
594+
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
595+
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
596+
<dd class="phpdocumentor-argument-list__definition">
597+
<section class="phpdocumentor-description"></section>
598+
599+
</dd>
600+
</dl>
601+
602+
603+
604+
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
605+
<span class="phpdocumentor-signature__response_type"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo">RedirectTo</abbr></a></span>
606+
&mdash;
607+
608+
542609
</article>
543610
<article
544611
class="phpdocumentor-element

‎docs/files/bigcommerce-resourcemodels-redirect-redirect.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h3 id="interfaces_class_traits">
9898
<dl class="phpdocumentor-table-of-contents">
9999

100100
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\Redirect">Redirect</abbr></a></dt>
101-
<dd></dd>
101+
<dd>Redirect Resource</dd>
102102

103103
</dl>
104104

‎docs/js/searchIndex.js‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6938,13 +6938,23 @@ Search.appendIndex(
69386938
}, {
69396939
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\Redirect",
69406940
"name": "Redirect",
6941-
"summary": "",
6941+
"summary": "Redirect\u0020Resource",
69426942
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html"
69436943
}, {
69446944
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\Redirect\u003A\u003A__construct\u0028\u0029",
69456945
"name": "__construct",
69466946
"summary": "",
69476947
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method___construct"
6948+
}, {
6949+
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\Redirect\u003A\u003AtoProduct\u0028\u0029",
6950+
"name": "toProduct",
6951+
"summary": "",
6952+
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toProduct"
6953+
}, {
6954+
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\Redirect\u003A\u003AtoCategory\u0028\u0029",
6955+
"name": "toCategory",
6956+
"summary": "",
6957+
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html#method_toCategory"
69486958
}, {
69496959
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\Redirect\u003A\u003A\u0024from_path",
69506960
"name": "from_path",
@@ -6965,6 +6975,11 @@ Search.appendIndex(
69656975
"name": "RedirectTo",
69666976
"summary": "",
69676977
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"
6978+
}, {
6979+
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\RedirectTo\u003A\u003AbuildRedirectTo\u0028\u0029",
6980+
"name": "buildRedirectTo",
6981+
"summary": "",
6982+
"url": "classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html#method_buildRedirectTo"
69686983
}, {
69696984
"fqsen": "\\BigCommerce\\ApiV3\\ResourceModels\\Redirect\\RedirectTo\u003A\u003ATYPE__PRODUCT",
69706985
"name": "TYPE__PRODUCT",

‎docs/namespaces/bigcommerce-apiv3-resourcemodels-redirect.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3 id="interfaces_class_traits">
9595
<dl class="phpdocumentor-table-of-contents">
9696

9797
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\Redirect">Redirect</abbr></a></dt>
98-
<dd></dd>
98+
<dd>Redirect Resource</dd>
9999
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo">RedirectTo</abbr></a></dt>
100100
<dd></dd>
101101

‎docs/packages/BigCommerce.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ <h3 id="interfaces_class_traits">
545545
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-Api-Redirects-RedirectsApi.html"><abbr title="\BigCommerce\ApiV3\Api\Redirects\RedirectsApi">RedirectsApi</abbr></a></dt>
546546
<dd>Redirects API</dd>
547547
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-Redirect.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\Redirect">Redirect</abbr></a></dt>
548-
<dd></dd>
548+
<dd>Redirect Resource</dd>
549549
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResourceModels-Redirect-RedirectTo.html"><abbr title="\BigCommerce\ApiV3\ResourceModels\Redirect\RedirectTo">RedirectTo</abbr></a></dt>
550550
<dd></dd>
551551
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/BigCommerce-ApiV3-ResponseModels-Redirect-RedirectsResponse.html"><abbr title="\BigCommerce\ApiV3\ResponseModels\Redirect\RedirectsResponse">RedirectsResponse</abbr></a></dt>

0 commit comments

Comments
 (0)