Skip to content

Commit ff0efc9

Browse files
wjhsfwjhsf
committed
Update docs for v1.4.0
1 parent cfd7845 commit ff0efc9

33 files changed

+5210
-2863
lines changed

‎CHANGELOG.md‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,77 @@
11
# CHANGELOG
22

3+
## v1.4.0
4+
5+
#### New Features
6+
7+
* TypeScript type definitions are now exported! :tada:
8+
* Any parameter for any method can now be specified in the client configuration.
9+
* Parameters not used by an endpoint will now be ignored, rather than included.
10+
* A custom user agent is now sent with requests (node.js only)
11+
12+
#### API Changes
13+
14+
*Shopper Baskets*
15+
16+
* New endpoints
17+
18+
| **Endpoint Name** | **Description** |
19+
| ------------- |-------------|
20+
| transferBasket | Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. |
21+
| mergeBasket | Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions. |
22+
| updatePaymentInstrumentInBasket | Success, the response body contains the basket with the updated payment instrument. |
23+
24+
*Shopper Login*
25+
26+
* New endpoints
27+
28+
| **Endpoint Name** | **Description** |
29+
| ------------- |-------------|
30+
| retrieveCredQualityUserInfo | Retrieve credential quality statistics for a user. |
31+
332
## v1.3.0
33+
434
#### New APIs
35+
536
* *Shopper Discovery Search* has been added to the SDK.
637

738
#### API Changes
39+
840
*Shopper Login*
41+
942
* New operation: `getTrustedSystemAccessToken`
1043

1144
## v1.2.0
1245

1346
#### API Changes
47+
1448
*Shopper Customers*
49+
1550
* New operations
1651
* registerExternalProfile
1752
* getExternalProfile
1853

1954
## v1.1.2
55+
2056
* Fixed issue causing endpoints that accept array values to not properly set `Content-Type` header to `application/json`.
2157

2258
## v1.1.1
59+
2360
* Fixed issue causing `shortCode` to not be properly set
2461

2562
## v1.1.0
63+
2664
#### **API Changes**
65+
2766
*Shopper Baskets API*
28-
* Endpoint Added
29-
* organizations/{organizationId}/baskets/{basketId}/price-books
67+
68+
* Endpoint Added
69+
* organizations/{organizationId}/baskets/{basketId}/price-books
3070

3171
*Shopper Login API*
72+
3273
* Endpoint Added
33-
* organizations/{organizationId}/oauth2/logout
74+
* organizations/{organizationId}/oauth2/logout
3475
* customer_id and enc_user_id were added to the TokenResponse type
3576
* LoginRequest type was added
3677
* Query param uuid for /organizations/{organizationId}/oauth2/authorize was renamed to usid

‎docs/assets/js/search.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/classes/clientconfig.clientconfig-1.html‎

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<a href="clientconfig.clientconfig-1.html">ClientConfig</a>
6363
</li>
6464
</ul>
65-
<h1>Class ClientConfig</h1>
65+
<h1>Class ClientConfig&lt;Params&gt;</h1>
6666
</div>
6767
</div>
6868
</header>
@@ -76,6 +76,14 @@ <h1>Class ClientConfig</h1>
7676
</div>
7777
</div>
7878
</section>
79+
<section class="tsd-panel tsd-type-parameters">
80+
<h3>Type parameters</h3>
81+
<ul class="tsd-type-parameters">
82+
<li>
83+
<h4>Params<span class="tsd-signature-symbol">: </span><a href="../interfaces/helpers.baseuriparameters.html" class="tsd-signature-type">BaseUriParameters</a></h4>
84+
</li>
85+
</ul>
86+
</section>
7987
<section class="tsd-panel tsd-hierarchy">
8088
<h3>Hierarchy</h3>
8189
<ul class="tsd-hierarchy">
@@ -87,7 +95,7 @@ <h3>Hierarchy</h3>
8795
<section class="tsd-panel">
8896
<h3>Implements</h3>
8997
<ul class="tsd-hierarchy">
90-
<li><a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a></li>
98+
<li><a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Params</span><span class="tsd-signature-symbol">&gt;</span></li>
9199
</ul>
92100
</section>
93101
<section class="tsd-panel-group tsd-index-group">
@@ -126,19 +134,19 @@ <h2>Constructors</h2>
126134
<a name="constructor" class="tsd-anchor"></a>
127135
<h3>constructor</h3>
128136
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
129-
<li class="tsd-signature tsd-kind-icon">new <wbr>Client<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">?: </span><a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="clientconfig.clientconfig-1.html" class="tsd-signature-type">ClientConfig</a></li>
137+
<li class="tsd-signature tsd-kind-icon">new <wbr>Client<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Params</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="clientconfig.clientconfig-1.html" class="tsd-signature-type">ClientConfig</a></li>
130138
</ul>
131139
<ul class="tsd-descriptions">
132140
<li class="tsd-description">
133141
<aside class="tsd-sources">
134142
<ul>
135-
<li>Defined in src/lib/clientConfig.ts:37</li>
143+
<li>Defined in src/lib/clientConfig.ts:53</li>
136144
</ul>
137145
</aside>
138146
<h4 class="tsd-parameters-title">Parameters</h4>
139147
<ul class="tsd-parameters">
140148
<li>
141-
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> config: <a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a><span class="tsd-signature-symbol"> = ClientConfig.defaults</span></h5>
149+
<h5>config: <a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-signature-type">ClientConfigInit</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Params</span><span class="tsd-signature-symbol">&gt;</span></h5>
142150
</li>
143151
</ul>
144152
<h4 class="tsd-returns-title">Returns <a href="clientconfig.clientconfig-1.html" class="tsd-signature-type">ClientConfig</a></h4>
@@ -155,7 +163,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Uri</h3>
155163
<aside class="tsd-sources">
156164
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#baseuri">baseUri</a></p>
157165
<ul>
158-
<li>Defined in src/lib/clientConfig.ts:27</li>
166+
<li>Defined in src/lib/clientConfig.ts:43</li>
159167
</ul>
160168
</aside>
161169
</section>
@@ -166,7 +174,7 @@ <h3>fetch<wbr>Options</h3>
166174
<aside class="tsd-sources">
167175
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#fetchoptions">fetchOptions</a></p>
168176
<ul>
169-
<li>Defined in src/lib/clientConfig.ts:35</li>
177+
<li>Defined in src/lib/clientConfig.ts:51</li>
170178
</ul>
171179
</aside>
172180
</section>
@@ -177,7 +185,7 @@ <h3>headers</h3>
177185
<aside class="tsd-sources">
178186
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#headers">headers</a></p>
179187
<ul>
180-
<li>Defined in src/lib/clientConfig.ts:31</li>
188+
<li>Defined in src/lib/clientConfig.ts:47</li>
181189
</ul>
182190
</aside>
183191
<div class="tsd-type-declaration">
@@ -192,11 +200,11 @@ <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-t
192200
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
193201
<a name="parameters" class="tsd-anchor"></a>
194202
<h3>parameters</h3>
195-
<div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="../modules/commonparameters.html#urlparameters" class="tsd-signature-type">UrlParameters</a></div>
203+
<div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Params</span></div>
196204
<aside class="tsd-sources">
197205
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#parameters">parameters</a></p>
198206
<ul>
199-
<li>Defined in src/lib/clientConfig.ts:33</li>
207+
<li>Defined in src/lib/clientConfig.ts:49</li>
200208
</ul>
201209
</aside>
202210
</section>
@@ -207,18 +215,18 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy</h3>
207215
<aside class="tsd-sources">
208216
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#proxy">proxy</a></p>
209217
<ul>
210-
<li>Defined in src/lib/clientConfig.ts:29</li>
218+
<li>Defined in src/lib/clientConfig.ts:45</li>
211219
</ul>
212220
</aside>
213221
</section>
214222
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
215223
<a name="transformrequest" class="tsd-anchor"></a>
216224
<h3>transform<wbr>Request</h3>
217-
<div class="tsd-signature tsd-kind-icon">transform<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ClientConfigInit</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"transformRequest"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></div>
225+
<div class="tsd-signature tsd-kind-icon">transform<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ClientConfigInit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Params</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"transformRequest"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></div>
218226
<aside class="tsd-sources">
219227
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#transformrequest">transformRequest</a></p>
220228
<ul>
221-
<li>Defined in src/lib/clientConfig.ts:37</li>
229+
<li>Defined in src/lib/clientConfig.ts:53</li>
222230
</ul>
223231
</aside>
224232
</section>
@@ -231,7 +239,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
231239
<div class="tsd-signature tsd-kind-icon">defaults<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
232240
<aside class="tsd-sources">
233241
<ul>
234-
<li>Defined in src/lib/clientConfig.ts:54</li>
242+
<li>Defined in src/lib/clientConfig.ts:73</li>
235243
</ul>
236244
</aside>
237245
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal tsd-has-type-parameter">
@@ -244,7 +252,7 @@ <h3>transform<wbr>Request</h3>
244252
<li class="tsd-description">
245253
<aside class="tsd-sources">
246254
<ul>
247-
<li>Defined in src/lib/clientConfig.ts:61</li>
255+
<li>Defined in src/lib/clientConfig.ts:80</li>
248256
</ul>
249257
</aside>
250258
<div class="tsd-comment tsd-typography">
@@ -294,7 +302,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
294302
<a href="../modules/clientconfig.html">client<wbr>Config</a>
295303
</li>
296304
<li class=" tsd-kind-module">
297-
<a href="../modules/commonparameters.html">common<wbr>Parameters</a>
305+
<a href="../modules/helpers.html">helpers</a>
298306
</li>
299307
<li class=" tsd-kind-module">
300308
<a href="../modules/shopperbaskets.html">shopper<wbr>Baskets</a>
@@ -326,13 +334,16 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
326334
<li class=" tsd-kind-module">
327335
<a href="../modules/templateurl.html">template<wbr>Url</a>
328336
</li>
337+
<li class=" tsd-kind-module">
338+
<a href="../modules/version.html">version</a>
339+
</li>
329340
</ul>
330341
</nav>
331342
<nav class="tsd-navigation secondary menu-sticky">
332343
<ul class="before-current">
333344
</ul>
334345
<ul class="current">
335-
<li class="current tsd-kind-class tsd-parent-kind-module">
346+
<li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
336347
<a href="clientconfig.clientconfig-1.html" class="tsd-kind-icon">Client<wbr>Config</a>
337348
<ul>
338349
<li class=" tsd-kind-constructor tsd-parent-kind-class">
@@ -363,9 +374,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><
363374
</li>
364375
</ul>
365376
<ul class="after-current">
366-
<li class=" tsd-kind-interface tsd-parent-kind-module">
377+
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
367378
<a href="../interfaces/clientconfig.clientconfiginit.html" class="tsd-kind-icon">Client<wbr>Config<wbr>Init</a>
368379
</li>
380+
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
381+
<a href="../modules/clientconfig.html#browserrequestinit" class="tsd-kind-icon">Browser<wbr>Request<wbr>Init</a>
382+
</li>
369383
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
370384
<a href="../modules/clientconfig.html#fetchoptions" class="tsd-kind-icon">Fetch<wbr>Options</a>
371385
</li>
@@ -380,15 +394,18 @@ <h2>Legend</h2>
380394
<div class="tsd-legend-group">
381395
<ul class="tsd-legend">
382396
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
397+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
383398
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
384399
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
385400
</ul>
386401
<ul class="tsd-legend">
387-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
402+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
388403
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
404+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
389405
</ul>
390406
<ul class="tsd-legend">
391407
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
408+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
392409
</ul>
393410
</div>
394411
</div>

0 commit comments

Comments
 (0)