-
Notifications
You must be signed in to change notification settings - Fork 51
Expand file tree
/
Copy pathshoppercontext.shoppercontexts-2.html
More file actions
678 lines (675 loc) · 72.8 KB
/
shoppercontext.shoppercontexts-2.html
File metadata and controls
678 lines (675 loc) · 72.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ShopperContexts | commerce-sdk</title>
<meta name="description" content="Documentation for commerce-sdk">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">commerce-sdk</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/shoppercontext.html">shopperContext</a>
</li>
<li>
<a href="shoppercontext.shoppercontexts-2.html">ShopperContexts</a>
</li>
</ul>
<h1>Class ShopperContexts</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<a href="#shopper-context" id="shopper-context" style="color: inherit; text-decoration: none;">
<h1><a href="https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-context:Summary">Shopper Context</a></h1>
</a>
</div>
<p>*# API Overview</p>
<p>With the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.</p>
<p>You can also get personalized API responses triggered by shopper context from the <a href="https://documentation.b2c.commercecloud.salesforce.com/DOC1/topic/com.demandware.dochelp/OCAPI/current/usage/OpenCommerceAPI.html">Open Commerce API</a> (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.</p>
<p><em>Warning*</em>
Access tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.</p>
<p>Make Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed.</p>
<p>As part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.</p>
<p><em>Note*</em>:</p>
<p>Shopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.</p>
<p>With B2C Commerce release 24.5, all new implementations of Shopper Context require the <code>siteId</code> query parameter to be passed. Existing customers with Shopper Context implementations should start including <code>siteId</code> going forward. Starting July 31 2024, <code>siteId</code> is required for all customers, and a bad request response code is returned for requests without a <code>siteId</code>.</p>
<a href="#authentication-amp-authorization" id="authentication-amp-authorization" style="color: inherit; text-decoration: none;">
<h2>Authentication & Authorization</h2>
</a>
<p>The Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).</p>
<p>For details on how to request a shopper access token from SLAS, see the guest user flows for <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html">public clients</a> and <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html">private clients</a> in the SLAS guides.</p>
<p>Add <code>sfcc.shopper-context.rw</code> to the scopes configuration for the SLAS API client.</p>
<p>For more information, see <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html">Authorization for Shopper APIs</a> in the Get Started guides.</p>
<p><em>Warning*</em>: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.</p>
<a href="#use-cases" id="use-cases" style="color: inherit; text-decoration: none;">
<h2>Use Cases</h2>
</a>
<p>For detailed usage information, see the <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html">Shopper Context guides</a>.* <br /></p>
<p>For instructions on how to retrieve access token for admin APIs: <a><a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html">https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html</a></a> <br /> <br />
Example with admin auth</p>
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> { ShopperContexts, ClientConfig } <span class="hljs-keyword">from</span> <span class="hljs-string">"commerce-sdk"</span>;
<span class="hljs-comment">// or</span>
<span class="hljs-keyword">const</span> { ShopperContexts, ClientConfig } = <span class="hljs-built_in">require</span>(<span class="hljs-string">"commerce-sdk"</span>);
<span class="hljs-keyword">const</span> clientConfig: ClientConfig = {
<span class="hljs-attr">parameters</span>: {
<span class="hljs-attr">clientId</span>: <span class="hljs-string">"XXXXXX"</span>,
<span class="hljs-attr">organizationId</span>: <span class="hljs-string">"XXXX"</span>,
<span class="hljs-attr">shortCode</span>: <span class="hljs-string">"XXX"</span>,
<span class="hljs-attr">siteId</span>: <span class="hljs-string">"XX"</span>
}
};
token = { <span class="hljs-attr">access_token</span>: <span class="hljs-string">'INSERT_ACCESS_TOKEN_HERE'</span> };
clientConfig.headers[<span class="hljs-string">'authorization'</span>] = <span class="hljs-string">`Bearer <span class="hljs-subst">${token.access_token}</span>`</span>;
<span class="hljs-keyword">const</span> shopperContextClient = <span class="hljs-keyword">new</span> ShopperContexts(clientConfig);</code></pre>
<span style="font-size:.7em; display:block; text-align: right">
API Version: 1.4.4<br />
Last Updated: <br />
</span>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">BaseClient</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ShopperContexts</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="shoppercontext.shoppercontexts-2.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="shoppercontext.shoppercontexts-2.html#clientconfig" class="tsd-kind-icon">client<wbr>Config</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shoppercontext.shoppercontexts-2.html#createshoppercontext" class="tsd-kind-icon">create<wbr>Shopper<wbr>Context</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shoppercontext.shoppercontexts-2.html#deleteshoppercontext" class="tsd-kind-icon">delete<wbr>Shopper<wbr>Context</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shoppercontext.shoppercontexts-2.html#getshoppercontext" class="tsd-kind-icon">get<wbr>Shopper<wbr>Context</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shoppercontext.shoppercontexts-2.html#updateshoppercontext" class="tsd-kind-icon">update<wbr>Shopper<wbr>Context</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Shopper<wbr>Contexts<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ClientConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="shoppercontext.shoppercontexts-2.html" class="tsd-signature-type">ShopperContexts</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides BaseClient.__constructor</p>
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:99</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>config: <span class="tsd-signature-type">ClientConfig</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="shoppercontext.shoppercontexts-2.html" class="tsd-signature-type">ShopperContexts</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="clientconfig" class="tsd-anchor"></a>
<h3>client<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ClientConfig</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="assignments.assignments-3.html">Assignments</a>.<a href="assignments.assignments-3.html#clientconfig">clientConfig</a></p>
<ul>
<li>Defined in node_modules/@commerce-apps/core/dist/base/client.d.ts:28</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="createshoppercontext" class="tsd-anchor"></a>
<h3>create<wbr>Shopper<wbr>Context</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">create<wbr>Shopper<wbr>Context<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-signature tsd-kind-icon">create<wbr>Shopper<wbr>Context<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, rawResponse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:134</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If you would like to get a raw Response object use the other createShopperContext function.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type void.</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:172</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rawResponse: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to true to return entire Response object instead of DTO.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type Response if rawResponse is true, a promise of type void otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="deleteshoppercontext" class="tsd-anchor"></a>
<h3>delete<wbr>Shopper<wbr>Context</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">delete<wbr>Shopper<wbr>Context<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
<li class="tsd-signature tsd-kind-icon">delete<wbr>Shopper<wbr>Context<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, rawResponse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:306</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a shopper's context based on the shopperJWT.</p>
</div>
<p>With B2C Commerce release 24.5, all endpoints in the Shopper context API require the <code>siteId</code> parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.</p>
<p>If you would like to get a raw Response object use the other deleteShopperContext function.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type void.</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:336</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a shopper's context based on the shopperJWT.</p>
</div>
<p>With B2C Commerce release 24.5, all endpoints in the Shopper context API require the <code>siteId</code> parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.</p>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rawResponse: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to true to return entire Response object instead of DTO.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type Response if rawResponse is true, a promise of type void otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="getshoppercontext" class="tsd-anchor"></a>
<h3>get<wbr>Shopper<wbr>Context</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">get<wbr>Shopper<wbr>Context<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-signature tsd-kind-icon">get<wbr>Shopper<wbr>Context<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, rawResponse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">ShopperContext</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:451</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If you would like to get a raw Response object use the other getShopperContext function.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type ShopperContext.</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:479</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rawResponse: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to true to return entire Response object instead of DTO.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">ShopperContext</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="updateshoppercontext" class="tsd-anchor"></a>
<h3>update<wbr>Shopper<wbr>Context</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">update<wbr>Shopper<wbr>Context<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">></span></li>
<li class="tsd-signature tsd-kind-icon">update<wbr>Shopper<wbr>Context<T><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, rawResponse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">ShopperContext</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:632</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the shopper context exists, it's updated with the patch body.</p>
<ul>
<li>If a new attribute that does not exist in the existing shopper context is present, it is added to the context.</li>
<li>If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:</li>
<li><code>custom qualifiers</code> or <code>assignment qualifiers</code>:</li>
</ul>
</div>
<p>If the individual qualifier key exists, it is overwritten with the new value.</p>
<p>If the value of the key is set to null, it is deleted from the existing shopper context.</p>
<p>If an empty <code>custom qualifiers</code> or <code>assignment qualifiers</code> object <code>{}</code> is passed, the entire qualifier object is deleted.</p>
<ul>
<li><code>effectiveDateTime</code> or <code>sourceCode</code> or <code>clientIp</code>:</li>
</ul>
<p>If the new value is set to an empty string (""), it is deleted from the existing shopper context.</p>
<p>If the new value is set to null, it is ignored.</p>
<p>If the new value is not empty or null, it overwrites the existing value.</p>
<ul>
<li><code>customerGroupIds</code>:</li>
</ul>
<p>If a list of <code>customerGroupIds</code> exists, it is replaced by the new list of customer group IDs from the request.</p>
<p>If <code>customerGroupIds</code> is set to an empty array [], the existing list in the shopper context is deleted.</p>
<ul>
<li><code>geoLocation</code>:</li>
</ul>
<p>If it exists, the entire <code>geoLocation</code> object is replaced with the new value.</p>
<p>If the new value is set to null, it is ignored.</p>
<p>If an empty <code>geoLocation</code> object <code>{}</code> is passed, it is deleted.</p>
<p>With B2C Commerce release 24.5, all endpoints in the Shopper context API require the <code>siteId</code> parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.</p>
<p>If you would like to get a raw Response object use the other updateShopperContext function.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type ShopperContext.</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/shopperContext/apis/DefaultApi.ts:702</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the shopper context exists, it's updated with the patch body.</p>
<ul>
<li>If a new attribute that does not exist in the existing shopper context is present, it is added to the context.</li>
<li>If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:</li>
<li><code>custom qualifiers</code> or <code>assignment qualifiers</code>:</li>
</ul>
</div>
<p>If the individual qualifier key exists, it is overwritten with the new value.</p>
<p>If the value of the key is set to null, it is deleted from the existing shopper context.</p>
<p>If an empty <code>custom qualifiers</code> or <code>assignment qualifiers</code> object <code>{}</code> is passed, the entire qualifier object is deleted.</p>
<ul>
<li><code>effectiveDateTime</code> or <code>sourceCode</code> or <code>clientIp</code>:</li>
</ul>
<p>If the new value is set to an empty string (""), it is deleted from the existing shopper context.</p>
<p>If the new value is set to null, it is ignored.</p>
<p>If the new value is not empty or null, it overwrites the existing value.</p>
<ul>
<li><code>customerGroupIds</code>:</li>
</ul>
<p>If a list of <code>customerGroupIds</code> exists, it is replaced by the new list of customer group IDs from the request.</p>
<p>If <code>customerGroupIds</code> is set to an empty array [], the existing list in the shopper context is deleted.</p>
<ul>
<li><code>geoLocation</code>:</li>
</ul>
<p>If it exists, the entire <code>geoLocation</code> object is replaced with the new value.</p>
<p>If the new value is set to null, it is ignored.</p>
<p>If an empty <code>geoLocation</code> object <code>{}</code> is passed, it is deleted.</p>
<p>With B2C Commerce release 24.5, all endpoints in the Shopper context API require the <code>siteId</code> parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.</p>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>options: <a href="../modules/_types_.html#requireparametersunlessallareoptional" class="tsd-signature-type">RequireParametersUnlessAllAreOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-signature-type">ShopperContext</a><span class="tsd-signature-symbol">; </span>fetchOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">; </span>headers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">; </span>parameters<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#compositeparameters" class="tsd-signature-type">CompositeParameters</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>evaluateContextWithClientIp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>organizationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>siteId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><a href="../interfaces/_types_.queryparameters.html" class="tsd-signature-type">QueryParameters</a><span class="tsd-signature-symbol">, </span><a href="../modules/_index_.html#commonparameters" class="tsd-signature-type">CommonParameters</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>retrySettings<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OperationOptions</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object containing the options for this method.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rawResponse: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to true to return entire Response object instead of DTO.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">ShopperContext</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/shoppercontext.html">shopper<wbr>Context</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/shoppercontext.shoppercontextstypes.html">Shopper<wbr>Contexts<wbr>Types</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#errorresponse" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#errorresponse-1" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontext-1" class="tsd-kind-icon">Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontext-2" class="tsd-kind-icon">Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontextgeolocation" class="tsd-kind-icon">Shopper<wbr>Context<wbr>Geo<wbr>Location</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontextgeolocation-1" class="tsd-kind-icon">Shopper<wbr>Context<wbr>Geo<wbr>Location</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontexts" class="tsd-kind-icon">Shopper<wbr>Contexts</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontexts-1" class="tsd-kind-icon">Shopper<wbr>Contexts</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#defaultbaseuri" class="tsd-kind-icon">default<wbr>Base<wbr>Uri</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="shoppercontext.shoppercontexts-2.html" class="tsd-kind-icon">Shopper<wbr>Contexts</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="shoppercontext.shoppercontexts-2.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="shoppercontext.shoppercontexts-2.html#clientconfig" class="tsd-kind-icon">client<wbr>Config</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="shoppercontext.shoppercontexts-2.html#createshoppercontext" class="tsd-kind-icon">create<wbr>Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="shoppercontext.shoppercontexts-2.html#deleteshoppercontext" class="tsd-kind-icon">delete<wbr>Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="shoppercontext.shoppercontexts-2.html#getshoppercontext" class="tsd-kind-icon">get<wbr>Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="shoppercontext.shoppercontexts-2.html#updateshoppercontext" class="tsd-kind-icon">update<wbr>Shopper<wbr>Context</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#errorresponse-2" class="tsd-kind-icon">Error<wbr>Response</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontext-3" class="tsd-kind-icon">Shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#shoppercontextgeolocation-2" class="tsd-kind-icon">Shopper<wbr>Context<wbr>Geo<wbr>Location</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/shoppercontext.html#defaultbaseuri-1" class="tsd-kind-icon">default<wbr>Base<wbr>Uri</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>