commerce-sdk-isomorphic 1.5.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -0
- package/README.md +6 -2
- package/lib/index.cjs.d.ts +519 -222
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +519 -222
- package/lib/index.esm.js +1 -1
- package/package.json +2 -2
package/lib/index.esm.d.ts
CHANGED
|
@@ -5,6 +5,36 @@
|
|
|
5
5
|
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
6
6
|
*/
|
|
7
7
|
import { RequestInit as NodeRequestInit } from "node-fetch";
|
|
8
|
+
/*
|
|
9
|
+
* Copyright (c) 2021, salesforce.com, inc.
|
|
10
|
+
* All rights reserved.
|
|
11
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
12
|
+
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
13
|
+
*/
|
|
14
|
+
type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>;
|
|
15
|
+
type RequireParametersUnlessAllAreOptional<T extends {
|
|
16
|
+
parameters?: Record<string, unknown>;
|
|
17
|
+
}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : T & Required<Pick<T, "parameters">>;
|
|
18
|
+
/**
|
|
19
|
+
* Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
|
|
20
|
+
* if not specified.
|
|
21
|
+
*/
|
|
22
|
+
interface BaseUriParameters {
|
|
23
|
+
shortCode: string;
|
|
24
|
+
version?: string; // Optional, will default to "v1" if not provided.
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Generic interface for path parameters.
|
|
28
|
+
*/
|
|
29
|
+
interface PathParameters {
|
|
30
|
+
[key: string]: string | number | boolean;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Generic interface for query parameters.
|
|
34
|
+
*/
|
|
35
|
+
interface QueryParameters {
|
|
36
|
+
[key: string]: string | number | boolean | string[] | number[];
|
|
37
|
+
}
|
|
8
38
|
type LoginRequest = {
|
|
9
39
|
client_id?: string;
|
|
10
40
|
response_type?: string;
|
|
@@ -17,14 +47,6 @@ type LoginRequest = {
|
|
|
17
47
|
} & {
|
|
18
48
|
[key: string]: any;
|
|
19
49
|
};
|
|
20
|
-
type PasswordLessTokenRequest = {
|
|
21
|
-
grant_type: string;
|
|
22
|
-
hint: string;
|
|
23
|
-
pwdless_token: string;
|
|
24
|
-
usid?: string;
|
|
25
|
-
} & {
|
|
26
|
-
[key: string]: any;
|
|
27
|
-
};
|
|
28
50
|
type CredQualityUserResponse = {
|
|
29
51
|
tenantId: string;
|
|
30
52
|
username: string;
|
|
@@ -39,6 +61,24 @@ type CredQualityUserResponse = {
|
|
|
39
61
|
} & {
|
|
40
62
|
[key: string]: any;
|
|
41
63
|
};
|
|
64
|
+
type PasswordLessLoginTokenRequest = {
|
|
65
|
+
grant_type: string;
|
|
66
|
+
hint: string;
|
|
67
|
+
pwdless_login_token: string;
|
|
68
|
+
client_id?: string;
|
|
69
|
+
code_verifier?: string;
|
|
70
|
+
} & {
|
|
71
|
+
[key: string]: any;
|
|
72
|
+
};
|
|
73
|
+
type PasswordActionVerifyRequest = {
|
|
74
|
+
client_id: string;
|
|
75
|
+
pwd_action_token: string;
|
|
76
|
+
code_verifier: string;
|
|
77
|
+
new_password: string;
|
|
78
|
+
channel_id: string;
|
|
79
|
+
} & {
|
|
80
|
+
[key: string]: any;
|
|
81
|
+
};
|
|
42
82
|
type TrustedSystemTokenRequest = {
|
|
43
83
|
usid?: string;
|
|
44
84
|
grant_type: string;
|
|
@@ -47,6 +87,19 @@ type TrustedSystemTokenRequest = {
|
|
|
47
87
|
idp_origin: string;
|
|
48
88
|
client_id: string;
|
|
49
89
|
channel_id: string;
|
|
90
|
+
email_id?: string;
|
|
91
|
+
} & {
|
|
92
|
+
[key: string]: any;
|
|
93
|
+
};
|
|
94
|
+
type PasswordActionRequest = {
|
|
95
|
+
user_id: string;
|
|
96
|
+
mode: string;
|
|
97
|
+
channel_id: string;
|
|
98
|
+
locale?: string;
|
|
99
|
+
client_id?: string;
|
|
100
|
+
code_challenge?: string;
|
|
101
|
+
redirect_uri?: string;
|
|
102
|
+
idp_name?: string;
|
|
50
103
|
} & {
|
|
51
104
|
[key: string]: any;
|
|
52
105
|
};
|
|
@@ -73,21 +126,17 @@ type TokenRequest = {
|
|
|
73
126
|
} & {
|
|
74
127
|
[key: string]: any;
|
|
75
128
|
};
|
|
76
|
-
type PasswordLessAuthRequest = {
|
|
77
|
-
user_id: string;
|
|
78
|
-
mode: string;
|
|
79
|
-
channel_id: string;
|
|
80
|
-
} & {
|
|
81
|
-
[key: string]: any;
|
|
82
|
-
};
|
|
83
129
|
type TokenActionRequest = {
|
|
84
130
|
token: string;
|
|
85
131
|
token_type_hint?: string;
|
|
86
132
|
} & {
|
|
87
133
|
[key: string]: any;
|
|
88
134
|
};
|
|
135
|
+
type RangeFilter = {
|
|
136
|
+
[key: string]: any;
|
|
137
|
+
};
|
|
89
138
|
type BoolFilter = {
|
|
90
|
-
filters?:
|
|
139
|
+
filters?: Filter;
|
|
91
140
|
operator: string;
|
|
92
141
|
} & {
|
|
93
142
|
[key: string]: any;
|
|
@@ -96,13 +145,23 @@ type MatchAllQuery = {} & {
|
|
|
96
145
|
[key: string]: any;
|
|
97
146
|
};
|
|
98
147
|
type FilteredQuery = {
|
|
99
|
-
filter:
|
|
100
|
-
query:
|
|
148
|
+
filter: Filter;
|
|
149
|
+
query: Query;
|
|
101
150
|
} & {
|
|
102
151
|
[key: string]: any;
|
|
103
152
|
};
|
|
104
153
|
type QueryFilter = {
|
|
105
|
-
query:
|
|
154
|
+
query: Query;
|
|
155
|
+
} & {
|
|
156
|
+
[key: string]: any;
|
|
157
|
+
};
|
|
158
|
+
type Query = {
|
|
159
|
+
boolQuery?: BoolQuery;
|
|
160
|
+
filteredQuery?: FilteredQuery;
|
|
161
|
+
matchAllQuery?: MatchAllQuery;
|
|
162
|
+
nestedQuery?: NestedQuery;
|
|
163
|
+
termQuery?: TermQuery;
|
|
164
|
+
textQuery?: TextQuery;
|
|
106
165
|
} & {
|
|
107
166
|
[key: string]: any;
|
|
108
167
|
};
|
|
@@ -138,31 +197,31 @@ type Range2Filter = {
|
|
|
138
197
|
[key: string]: any;
|
|
139
198
|
};
|
|
140
199
|
type BoolQuery = {
|
|
141
|
-
must?: Array<
|
|
142
|
-
mustNot?: Array<
|
|
143
|
-
should?: Array<
|
|
200
|
+
must?: Array<Query>;
|
|
201
|
+
mustNot?: Array<Query>;
|
|
202
|
+
should?: Array<Query>;
|
|
144
203
|
} & {
|
|
145
204
|
[key: string]: any;
|
|
146
205
|
};
|
|
147
206
|
type NestedQuery = {
|
|
148
207
|
path: string;
|
|
149
|
-
query:
|
|
208
|
+
query: Query;
|
|
150
209
|
scoreMode?: string;
|
|
151
210
|
} & {
|
|
152
211
|
[key: string]: any;
|
|
153
212
|
};
|
|
154
|
-
type
|
|
155
|
-
|
|
156
|
-
|
|
213
|
+
type Filter = {
|
|
214
|
+
boolFilter?: BoolFilter;
|
|
215
|
+
queryFilter?: QueryFilter;
|
|
216
|
+
range2Filter?: Range2Filter;
|
|
217
|
+
rangeFilter?: RangeFilter;
|
|
218
|
+
termFilter?: TermFilter;
|
|
157
219
|
} & {
|
|
158
220
|
[key: string]: any;
|
|
159
221
|
};
|
|
160
|
-
type
|
|
222
|
+
type Sort = {
|
|
161
223
|
field: string;
|
|
162
|
-
|
|
163
|
-
fromInclusive?: boolean;
|
|
164
|
-
to?: any;
|
|
165
|
-
toInclusive?: boolean;
|
|
224
|
+
sortOrder?: string;
|
|
166
225
|
} & {
|
|
167
226
|
[key: string]: any;
|
|
168
227
|
};
|
|
@@ -190,12 +249,12 @@ type ShopperLoginQueryParameters = {
|
|
|
190
249
|
client_id?: string;
|
|
191
250
|
refresh_token?: string;
|
|
192
251
|
channel_id?: string;
|
|
252
|
+
hint?: string;
|
|
193
253
|
redirect_uri?: string;
|
|
194
254
|
response_type?: string;
|
|
195
255
|
scope?: string;
|
|
196
256
|
state?: string;
|
|
197
257
|
usid?: string;
|
|
198
|
-
hint?: string;
|
|
199
258
|
code_challenge?: string;
|
|
200
259
|
};
|
|
201
260
|
/**
|
|
@@ -203,7 +262,7 @@ type ShopperLoginQueryParameters = {
|
|
|
203
262
|
*/
|
|
204
263
|
type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & ShopperLoginQueryParameters;
|
|
205
264
|
/**
|
|
206
|
-
* [Shopper Login and API Access Service](https://developer.
|
|
265
|
+
* [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary)
|
|
207
266
|
* ==================================
|
|
208
267
|
*
|
|
209
268
|
* *Enable shoppers to log in more easily, stay logged in for longer, and get a more fluid and personalized shopping experience powered by Shopper APIs.*<br />
|
|
@@ -225,7 +284,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
225
284
|
* ```
|
|
226
285
|
*
|
|
227
286
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
228
|
-
* API Version: 1.
|
|
287
|
+
* API Version: 1.32.0<br />
|
|
229
288
|
* Last Updated: <br />
|
|
230
289
|
* </span>
|
|
231
290
|
|
|
@@ -240,14 +299,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
240
299
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
241
300
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
242
301
|
/**
|
|
243
|
-
*
|
|
302
|
+
* Get credential quality statistics for a user.
|
|
244
303
|
*
|
|
245
304
|
* If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
|
|
246
305
|
*
|
|
247
306
|
* @param options - An object containing the options for this method.
|
|
248
307
|
* @param parameters - An object containing the parameters for this method.
|
|
249
308
|
* @param organizationId -
|
|
250
|
-
* @param username - User's login
|
|
309
|
+
* @param username - User's login ID or email address.
|
|
251
310
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
252
311
|
* sent with this request.
|
|
253
312
|
*
|
|
@@ -264,12 +323,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
264
323
|
};
|
|
265
324
|
}>): Promise<CredQualityUserResponse>;
|
|
266
325
|
/**
|
|
267
|
-
*
|
|
326
|
+
* Get credential quality statistics for a user.
|
|
268
327
|
*
|
|
269
328
|
* @param options - An object containing the options for this method.
|
|
270
329
|
* @param parameters - An object containing the parameters for this method.
|
|
271
330
|
* @param organizationId -
|
|
272
|
-
* @param username - User's login
|
|
331
|
+
* @param username - User's login ID or email address.
|
|
273
332
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
274
333
|
* sent with this request.
|
|
275
334
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -353,7 +412,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
353
412
|
headers?: {
|
|
354
413
|
[key: string]: string;
|
|
355
414
|
};
|
|
356
|
-
body:
|
|
415
|
+
body: PasswordActionRequest;
|
|
357
416
|
}>): Promise<Object>;
|
|
358
417
|
/**
|
|
359
418
|
* Allows the customer to authenticate when their identity provider is down.
|
|
@@ -375,10 +434,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
375
434
|
headers?: {
|
|
376
435
|
[key: string]: string;
|
|
377
436
|
};
|
|
378
|
-
body:
|
|
437
|
+
body: PasswordActionRequest;
|
|
379
438
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
380
439
|
/**
|
|
381
|
-
* Log a shopper
|
|
440
|
+
* Log out a shopper.
|
|
382
441
|
*
|
|
383
442
|
* If you would like to get a raw Response object use the other logoutCustomer function.
|
|
384
443
|
*
|
|
@@ -387,7 +446,8 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
387
446
|
* @param organizationId -
|
|
388
447
|
* @param client_id - The SLAS client ID.
|
|
389
448
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
390
|
-
* @param channel_id - The channel_id parameter
|
|
449
|
+
* @param channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with ECOM.
|
|
450
|
+
* @param hint - Optional parameter for logging out user sessions. Use `all-sessions` to log out all user sessions. If `hint` is not used, only the current user session will be logged out.
|
|
391
451
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
392
452
|
* sent with this request.
|
|
393
453
|
*
|
|
@@ -400,20 +460,22 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
400
460
|
client_id: string;
|
|
401
461
|
refresh_token: string;
|
|
402
462
|
channel_id?: string;
|
|
463
|
+
hint?: string;
|
|
403
464
|
}, ConfigParameters>;
|
|
404
465
|
headers?: {
|
|
405
466
|
[key: string]: string;
|
|
406
467
|
};
|
|
407
468
|
}>): Promise<TokenResponse>;
|
|
408
469
|
/**
|
|
409
|
-
* Log a shopper
|
|
470
|
+
* Log out a shopper.
|
|
410
471
|
*
|
|
411
472
|
* @param options - An object containing the options for this method.
|
|
412
473
|
* @param parameters - An object containing the parameters for this method.
|
|
413
474
|
* @param organizationId -
|
|
414
475
|
* @param client_id - The SLAS client ID.
|
|
415
476
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
416
|
-
* @param channel_id - The channel_id parameter
|
|
477
|
+
* @param channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with ECOM.
|
|
478
|
+
* @param hint - Optional parameter for logging out user sessions. Use `all-sessions` to log out all user sessions. If `hint` is not used, only the current user session will be logged out.
|
|
417
479
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
418
480
|
* sent with this request.
|
|
419
481
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -426,13 +488,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
426
488
|
client_id: string;
|
|
427
489
|
refresh_token: string;
|
|
428
490
|
channel_id?: string;
|
|
491
|
+
hint?: string;
|
|
429
492
|
}, ConfigParameters>;
|
|
430
493
|
headers?: {
|
|
431
494
|
[key: string]: string;
|
|
432
495
|
};
|
|
433
496
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
434
497
|
/**
|
|
435
|
-
* Get authorization code after authenticating a user against an IDP. This is the first step of the
|
|
498
|
+
* Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
|
|
436
499
|
*
|
|
437
500
|
* If you would like to get a raw Response object use the other authorizeCustomer function.
|
|
438
501
|
*
|
|
@@ -440,14 +503,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
440
503
|
* @param parameters - An object containing the parameters for this method.
|
|
441
504
|
* @param organizationId -
|
|
442
505
|
* @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
|
|
443
|
-
* @param response_type - Must be
|
|
506
|
+
* @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
|
|
444
507
|
* @param client_id - The client ID obtained during application registration.
|
|
445
508
|
* @param scope - (Not Supported)
|
|
446
|
-
* @param state - Value to
|
|
447
|
-
* @param usid -
|
|
448
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
449
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
450
|
-
* @param code_challenge - Created by the client calling the login endpoint.<br
|
|
509
|
+
* @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
|
|
510
|
+
* @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
|
|
511
|
+
* @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
|
|
512
|
+
* @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
|
|
513
|
+
* @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
|
|
451
514
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
452
515
|
* sent with this request.
|
|
453
516
|
*
|
|
@@ -472,20 +535,20 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
472
535
|
};
|
|
473
536
|
}>): Promise<void>;
|
|
474
537
|
/**
|
|
475
|
-
* Get authorization code after authenticating a user against an IDP. This is the first step of the
|
|
538
|
+
* Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
|
|
476
539
|
*
|
|
477
540
|
* @param options - An object containing the options for this method.
|
|
478
541
|
* @param parameters - An object containing the parameters for this method.
|
|
479
542
|
* @param organizationId -
|
|
480
543
|
* @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
|
|
481
|
-
* @param response_type - Must be
|
|
544
|
+
* @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
|
|
482
545
|
* @param client_id - The client ID obtained during application registration.
|
|
483
546
|
* @param scope - (Not Supported)
|
|
484
|
-
* @param state - Value to
|
|
485
|
-
* @param usid -
|
|
486
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
487
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
488
|
-
* @param code_challenge - Created by the client calling the login endpoint.<br
|
|
547
|
+
* @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
|
|
548
|
+
* @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
|
|
549
|
+
* @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
|
|
550
|
+
* @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
|
|
551
|
+
* @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
|
|
489
552
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
490
553
|
* sent with this request.
|
|
491
554
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -510,7 +573,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
510
573
|
};
|
|
511
574
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
512
575
|
/**
|
|
513
|
-
* Get the shopper or guest JWT
|
|
576
|
+
* Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.\<br /\>\<br /\>When refreshing the access token with a private client ID and client secret the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
|
|
514
577
|
*
|
|
515
578
|
* If you would like to get a raw Response object use the other getAccessToken function.
|
|
516
579
|
*
|
|
@@ -534,7 +597,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
534
597
|
body: TokenRequest;
|
|
535
598
|
}>): Promise<TokenResponse>;
|
|
536
599
|
/**
|
|
537
|
-
* Get the shopper or guest JWT
|
|
600
|
+
* Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.\<br /\>\<br /\>When refreshing the access token with a private client ID and client secret the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
|
|
538
601
|
*
|
|
539
602
|
* @param options - An object containing the options for this method.
|
|
540
603
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -556,7 +619,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
556
619
|
body: TokenRequest;
|
|
557
620
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
558
621
|
/**
|
|
559
|
-
* Get a shopper JWT
|
|
622
|
+
* Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
|
|
560
623
|
*
|
|
561
624
|
* If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
|
|
562
625
|
*
|
|
@@ -580,7 +643,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
580
643
|
body: TrustedSystemTokenRequest;
|
|
581
644
|
}>): Promise<TokenResponse>;
|
|
582
645
|
/**
|
|
583
|
-
* Get a shopper JWT
|
|
646
|
+
* Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
|
|
584
647
|
*
|
|
585
648
|
* @param options - An object containing the options for this method.
|
|
586
649
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -601,6 +664,98 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
601
664
|
};
|
|
602
665
|
body: TrustedSystemTokenRequest;
|
|
603
666
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
667
|
+
/**
|
|
668
|
+
* Request a reset password token
|
|
669
|
+
*
|
|
670
|
+
* If you would like to get a raw Response object use the other getPasswordResetToken function.
|
|
671
|
+
*
|
|
672
|
+
* @param options - An object containing the options for this method.
|
|
673
|
+
* @param parameters - An object containing the parameters for this method.
|
|
674
|
+
* @param organizationId -
|
|
675
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
676
|
+
* sent with this request.
|
|
677
|
+
* @param body - The data to send as the request body.
|
|
678
|
+
*
|
|
679
|
+
* @returns A promise of type void.
|
|
680
|
+
*
|
|
681
|
+
*/
|
|
682
|
+
getPasswordResetToken(options: RequireParametersUnlessAllAreOptional<{
|
|
683
|
+
parameters?: CompositeParameters<{
|
|
684
|
+
organizationId: string;
|
|
685
|
+
}, ConfigParameters>;
|
|
686
|
+
headers?: {
|
|
687
|
+
[key: string]: string;
|
|
688
|
+
};
|
|
689
|
+
body: PasswordActionRequest;
|
|
690
|
+
}>): Promise<void>;
|
|
691
|
+
/**
|
|
692
|
+
* Request a reset password token
|
|
693
|
+
*
|
|
694
|
+
* @param options - An object containing the options for this method.
|
|
695
|
+
* @param parameters - An object containing the parameters for this method.
|
|
696
|
+
* @param organizationId -
|
|
697
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
698
|
+
* sent with this request.
|
|
699
|
+
* @param body - The data to send as the request body.
|
|
700
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
701
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
getPasswordResetToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
705
|
+
parameters?: CompositeParameters<{
|
|
706
|
+
organizationId: string;
|
|
707
|
+
}, ConfigParameters>;
|
|
708
|
+
headers?: {
|
|
709
|
+
[key: string]: string;
|
|
710
|
+
};
|
|
711
|
+
body: PasswordActionRequest;
|
|
712
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
713
|
+
/**
|
|
714
|
+
* Creates a new password
|
|
715
|
+
*
|
|
716
|
+
* If you would like to get a raw Response object use the other resetPassword function.
|
|
717
|
+
*
|
|
718
|
+
* @param options - An object containing the options for this method.
|
|
719
|
+
* @param parameters - An object containing the parameters for this method.
|
|
720
|
+
* @param organizationId -
|
|
721
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
722
|
+
* sent with this request.
|
|
723
|
+
* @param body - The data to send as the request body.
|
|
724
|
+
*
|
|
725
|
+
* @returns A promise of type void.
|
|
726
|
+
*
|
|
727
|
+
*/
|
|
728
|
+
resetPassword(options: RequireParametersUnlessAllAreOptional<{
|
|
729
|
+
parameters?: CompositeParameters<{
|
|
730
|
+
organizationId: string;
|
|
731
|
+
}, ConfigParameters>;
|
|
732
|
+
headers?: {
|
|
733
|
+
[key: string]: string;
|
|
734
|
+
};
|
|
735
|
+
body: PasswordActionVerifyRequest;
|
|
736
|
+
}>): Promise<void>;
|
|
737
|
+
/**
|
|
738
|
+
* Creates a new password
|
|
739
|
+
*
|
|
740
|
+
* @param options - An object containing the options for this method.
|
|
741
|
+
* @param parameters - An object containing the parameters for this method.
|
|
742
|
+
* @param organizationId -
|
|
743
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
744
|
+
* sent with this request.
|
|
745
|
+
* @param body - The data to send as the request body.
|
|
746
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
747
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
|
|
748
|
+
*
|
|
749
|
+
*/
|
|
750
|
+
resetPassword<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
751
|
+
parameters?: CompositeParameters<{
|
|
752
|
+
organizationId: string;
|
|
753
|
+
}, ConfigParameters>;
|
|
754
|
+
headers?: {
|
|
755
|
+
[key: string]: string;
|
|
756
|
+
};
|
|
757
|
+
body: PasswordActionVerifyRequest;
|
|
758
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
604
759
|
/**
|
|
605
760
|
* Issue a shopper token (JWT).
|
|
606
761
|
*
|
|
@@ -623,7 +778,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
623
778
|
headers?: {
|
|
624
779
|
[key: string]: string;
|
|
625
780
|
};
|
|
626
|
-
body:
|
|
781
|
+
body: PasswordLessLoginTokenRequest;
|
|
627
782
|
}>): Promise<TokenResponse>;
|
|
628
783
|
/**
|
|
629
784
|
* Issue a shopper token (JWT).
|
|
@@ -645,10 +800,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
645
800
|
headers?: {
|
|
646
801
|
[key: string]: string;
|
|
647
802
|
};
|
|
648
|
-
body:
|
|
803
|
+
body: PasswordLessLoginTokenRequest;
|
|
649
804
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
650
805
|
/**
|
|
651
|
-
* Invalidate the refresh token. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
806
|
+
* Invalidate the refresh token. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
652
807
|
*
|
|
653
808
|
* If you would like to get a raw Response object use the other revokeToken function.
|
|
654
809
|
*
|
|
@@ -672,7 +827,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
672
827
|
body: TokenActionRequest;
|
|
673
828
|
}>): Promise<TokenResponse>;
|
|
674
829
|
/**
|
|
675
|
-
* Invalidate the refresh token. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
830
|
+
* Invalidate the refresh token. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
676
831
|
*
|
|
677
832
|
* @param options - An object containing the options for this method.
|
|
678
833
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -694,7 +849,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
694
849
|
body: TokenActionRequest;
|
|
695
850
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
696
851
|
/**
|
|
697
|
-
* Returns the token properties. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.
|
|
852
|
+
* Returns the token properties. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
|
|
698
853
|
*
|
|
699
854
|
* If you would like to get a raw Response object use the other introspectToken function.
|
|
700
855
|
*
|
|
@@ -718,7 +873,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
718
873
|
body: TokenActionRequest;
|
|
719
874
|
}>): Promise<Object>;
|
|
720
875
|
/**
|
|
721
|
-
* Returns the token properties. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.
|
|
876
|
+
* Returns the token properties. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
|
|
722
877
|
*
|
|
723
878
|
* @param options - An object containing the options for this method.
|
|
724
879
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -740,14 +895,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
740
895
|
body: TokenActionRequest;
|
|
741
896
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
742
897
|
/**
|
|
743
|
-
* Returns a JSON
|
|
898
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
744
899
|
*
|
|
745
900
|
* If you would like to get a raw Response object use the other getUserInfo function.
|
|
746
901
|
*
|
|
747
902
|
* @param options - An object containing the options for this method.
|
|
748
903
|
* @param parameters - An object containing the parameters for this method.
|
|
749
904
|
* @param organizationId -
|
|
750
|
-
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer this is angalous to the site ID.
|
|
905
|
+
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer, this is angalous to the site ID. Required when getting user information for an ECOM customer.
|
|
751
906
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
752
907
|
* sent with this request.
|
|
753
908
|
*
|
|
@@ -764,12 +919,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
764
919
|
};
|
|
765
920
|
}>): Promise<Object>;
|
|
766
921
|
/**
|
|
767
|
-
* Returns a JSON
|
|
922
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
768
923
|
*
|
|
769
924
|
* @param options - An object containing the options for this method.
|
|
770
925
|
* @param parameters - An object containing the parameters for this method.
|
|
771
926
|
* @param organizationId -
|
|
772
|
-
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer this is angalous to the site ID.
|
|
927
|
+
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer, this is angalous to the site ID. Required when getting user information for an ECOM customer.
|
|
773
928
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
774
929
|
* sent with this request.
|
|
775
930
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -828,7 +983,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
828
983
|
};
|
|
829
984
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
830
985
|
/**
|
|
831
|
-
* Returns a JWKS containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
986
|
+
* Returns a JSON Web Key Set (JWKS) containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
832
987
|
*
|
|
833
988
|
* If you would like to get a raw Response object use the other getJwksUri function.
|
|
834
989
|
*
|
|
@@ -850,7 +1005,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
850
1005
|
};
|
|
851
1006
|
}>): Promise<Object>;
|
|
852
1007
|
/**
|
|
853
|
-
* Returns a JWKS containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
1008
|
+
* Returns a JSON Web Key Set (JWKS) containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
854
1009
|
*
|
|
855
1010
|
* @param options - An object containing the options for this method.
|
|
856
1011
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -870,36 +1025,6 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
870
1025
|
};
|
|
871
1026
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
872
1027
|
}
|
|
873
|
-
/*
|
|
874
|
-
* Copyright (c) 2021, salesforce.com, inc.
|
|
875
|
-
* All rights reserved.
|
|
876
|
-
* SPDX-License-Identifier: BSD-3-Clause
|
|
877
|
-
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
878
|
-
*/
|
|
879
|
-
type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>;
|
|
880
|
-
type RequireParametersUnlessAllAreOptional<T extends {
|
|
881
|
-
parameters?: Record<string, unknown>;
|
|
882
|
-
}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : T & Required<Pick<T, "parameters">>;
|
|
883
|
-
/**
|
|
884
|
-
* Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
|
|
885
|
-
* if not specified.
|
|
886
|
-
*/
|
|
887
|
-
interface BaseUriParameters {
|
|
888
|
-
shortCode: string;
|
|
889
|
-
version?: string; // Optional, will default to "v1" if not provided.
|
|
890
|
-
}
|
|
891
|
-
/**
|
|
892
|
-
* Generic interface for path parameters.
|
|
893
|
-
*/
|
|
894
|
-
interface PathParameters {
|
|
895
|
-
[key: string]: string | number | boolean;
|
|
896
|
-
}
|
|
897
|
-
/**
|
|
898
|
-
* Generic interface for query parameters.
|
|
899
|
-
*/
|
|
900
|
-
interface QueryParameters {
|
|
901
|
-
[key: string]: string | number | boolean | string[] | number[];
|
|
902
|
-
}
|
|
903
1028
|
/**
|
|
904
1029
|
* Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
|
|
905
1030
|
* it from the `RequestInit` provided by node-fetch.
|
|
@@ -1369,7 +1494,7 @@ type ShopperBasketsQueryParameters = {
|
|
|
1369
1494
|
*/
|
|
1370
1495
|
type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters & ShopperBasketsQueryParameters;
|
|
1371
1496
|
/**
|
|
1372
|
-
* [Shopper Baskets](https://developer.
|
|
1497
|
+
* [Shopper Baskets](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-baskets:Summary)
|
|
1373
1498
|
* ==================================
|
|
1374
1499
|
*
|
|
1375
1500
|
* *Build a checkout experience.*<br />
|
|
@@ -3740,7 +3865,7 @@ type ShopperContextsQueryParameters = {};
|
|
|
3740
3865
|
*/
|
|
3741
3866
|
type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParameters & ShopperContextsQueryParameters;
|
|
3742
3867
|
/**
|
|
3743
|
-
* [Shopper Context (Beta)](https://developer.
|
|
3868
|
+
* [Shopper Context (Beta)](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-context:Summary)
|
|
3744
3869
|
* ==================================
|
|
3745
3870
|
*
|
|
3746
3871
|
* *The Shopper Context API enables developers to build highly contextualized shopping experiences for shoppers.*<br />
|
|
@@ -3762,7 +3887,7 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
|
|
|
3762
3887
|
* ```
|
|
3763
3888
|
*
|
|
3764
3889
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
3765
|
-
* API Version: 0.0.
|
|
3890
|
+
* API Version: 0.0.7<br />
|
|
3766
3891
|
* Last Updated: <br />
|
|
3767
3892
|
* </span>
|
|
3768
3893
|
* @beta
|
|
@@ -3778,7 +3903,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
3778
3903
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/{version}";
|
|
3779
3904
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
3780
3905
|
/**
|
|
3781
|
-
* Gets the shopper's context based on the shopperJWT.
|
|
3906
|
+
* Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
|
|
3782
3907
|
*
|
|
3783
3908
|
* If you would like to get a raw Response object use the other getShopperContext function.
|
|
3784
3909
|
*
|
|
@@ -3804,7 +3929,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
3804
3929
|
};
|
|
3805
3930
|
}>): Promise<ShopperContext>;
|
|
3806
3931
|
/**
|
|
3807
|
-
* Gets the shopper's context based on the shopperJWT.
|
|
3932
|
+
* Gets the shopper's context based on the shopperJWT. ******** This API is currently a work in progress, and not available to use yet. ********
|
|
3808
3933
|
*
|
|
3809
3934
|
* @param options - An object containing the options for this method.
|
|
3810
3935
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -3932,7 +4057,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
3932
4057
|
};
|
|
3933
4058
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
3934
4059
|
/**
|
|
3935
|
-
* Updates the shopper's context based on the
|
|
4060
|
+
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a customer qualifier or an `effectiveDateTime` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a customer qualifers' value is set to `null` it's deleted from existing shopper context. If `effectiveDateTime` value is set to set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` value is set to `null` it's ignored. If an `effectiveDateTime` or customer qualifiiers' value is new, it's added to the existing Shopper context.
|
|
3936
4061
|
*
|
|
3937
4062
|
* If you would like to get a raw Response object use the other updateShopperContext function.
|
|
3938
4063
|
*
|
|
@@ -3960,7 +4085,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
|
|
|
3960
4085
|
body: ShopperContext;
|
|
3961
4086
|
}>): Promise<ShopperContext>;
|
|
3962
4087
|
/**
|
|
3963
|
-
* Updates the shopper's context based on the
|
|
4088
|
+
* Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a customer qualifier or an `effectiveDateTime` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a customer qualifers' value is set to `null` it's deleted from existing shopper context. If `effectiveDateTime` value is set to set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` value is set to `null` it's ignored. If an `effectiveDateTime` or customer qualifiiers' value is new, it's added to the existing Shopper context.
|
|
3964
4089
|
*
|
|
3965
4090
|
* @param options - An object containing the options for this method.
|
|
3966
4091
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -4046,7 +4171,7 @@ type PublicProductListResult = {
|
|
|
4046
4171
|
[key: string]: any;
|
|
4047
4172
|
};
|
|
4048
4173
|
type BasketsResult$0 = {
|
|
4049
|
-
baskets
|
|
4174
|
+
baskets?: Array<Basket>;
|
|
4050
4175
|
total: number;
|
|
4051
4176
|
} & {
|
|
4052
4177
|
[key: string]: any;
|
|
@@ -4704,7 +4829,7 @@ type ShopperCustomersQueryParameters = {
|
|
|
4704
4829
|
*/
|
|
4705
4830
|
type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParameters & ShopperCustomersQueryParameters;
|
|
4706
4831
|
/**
|
|
4707
|
-
* [Shopper Customers](https://developer.
|
|
4832
|
+
* [Shopper Customers](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-customers:Summary)
|
|
4708
4833
|
* ==================================
|
|
4709
4834
|
*
|
|
4710
4835
|
* *Allow customers to manage their own profiles and product lists.*<br />
|
|
@@ -4726,7 +4851,7 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
|
|
|
4726
4851
|
* ```
|
|
4727
4852
|
*
|
|
4728
4853
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
4729
|
-
* API Version: 0.0.
|
|
4854
|
+
* API Version: 0.0.39<br />
|
|
4730
4855
|
* Last Updated: <br />
|
|
4731
4856
|
* </span>
|
|
4732
4857
|
|
|
@@ -4791,7 +4916,13 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4791
4916
|
body: CustomerRegistration;
|
|
4792
4917
|
}>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
|
|
4793
4918
|
/**
|
|
4794
|
-
*
|
|
4919
|
+
* **DEPRECATION NOTICE**
|
|
4920
|
+
|
|
4921
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
4922
|
+
|
|
4923
|
+
---
|
|
4924
|
+
|
|
4925
|
+
Log the user out.
|
|
4795
4926
|
*
|
|
4796
4927
|
* If you would like to get a raw Response object use the other invalidateCustomerAuth function.
|
|
4797
4928
|
*
|
|
@@ -4815,7 +4946,13 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4815
4946
|
};
|
|
4816
4947
|
}>): Promise<void>;
|
|
4817
4948
|
/**
|
|
4818
|
-
*
|
|
4949
|
+
* **DEPRECATION NOTICE**
|
|
4950
|
+
|
|
4951
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
4952
|
+
|
|
4953
|
+
---
|
|
4954
|
+
|
|
4955
|
+
Log the user out.
|
|
4819
4956
|
*
|
|
4820
4957
|
* @param options - An object containing the options for this method.
|
|
4821
4958
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -4837,7 +4974,13 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4837
4974
|
};
|
|
4838
4975
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
4839
4976
|
/**
|
|
4840
|
-
*
|
|
4977
|
+
* **DEPRECATION NOTICE**
|
|
4978
|
+
|
|
4979
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
4980
|
+
|
|
4981
|
+
---
|
|
4982
|
+
|
|
4983
|
+
Obtains a new JSON Web Token (JWT)for a guest or registered
|
|
4841
4984
|
customer. Tokens are returned as an HTTP Authorization:Bearer response
|
|
4842
4985
|
header entry. These kinds of request are supported, as specified by the
|
|
4843
4986
|
type:
|
|
@@ -4909,7 +5052,13 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4909
5052
|
body: AuthRequest;
|
|
4910
5053
|
}>): Promise<Customer>;
|
|
4911
5054
|
/**
|
|
4912
|
-
*
|
|
5055
|
+
* **DEPRECATION NOTICE**
|
|
5056
|
+
|
|
5057
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
5058
|
+
|
|
5059
|
+
---
|
|
5060
|
+
|
|
5061
|
+
Obtains a new JSON Web Token (JWT)for a guest or registered
|
|
4913
5062
|
customer. Tokens are returned as an HTTP Authorization:Bearer response
|
|
4914
5063
|
header entry. These kinds of request are supported, as specified by the
|
|
4915
5064
|
type:
|
|
@@ -4979,7 +5128,14 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4979
5128
|
body: AuthRequest;
|
|
4980
5129
|
}>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
|
|
4981
5130
|
/**
|
|
4982
|
-
*
|
|
5131
|
+
* **DEPRECATION NOTICE**
|
|
5132
|
+
|
|
5133
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
5134
|
+
|
|
5135
|
+
---
|
|
5136
|
+
|
|
5137
|
+
Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts loginId and
|
|
5138
|
+
clientId, returns a customer object in the response body and the JWT generated against the clientId in the response header.
|
|
4983
5139
|
*
|
|
4984
5140
|
* If you would like to get a raw Response object use the other authorizeTrustedSystem function.
|
|
4985
5141
|
*
|
|
@@ -5005,7 +5161,14 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
5005
5161
|
body: TrustedSystemAuthRequest;
|
|
5006
5162
|
}>): Promise<Customer>;
|
|
5007
5163
|
/**
|
|
5008
|
-
*
|
|
5164
|
+
* **DEPRECATION NOTICE**
|
|
5165
|
+
|
|
5166
|
+
To enhance the security and availability of Salesforce services, this endpoint is now _**deprecated**_, and _**we plan to remove it in mid-2022**_. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.commercecloud.com/s/api-details/a003k00000VWfNDAA1/commerce-cloud-developer-centershopperloginandapiaccessservice) (SLAS) because they meet our rigorous standards for security and availability.
|
|
5167
|
+
|
|
5168
|
+
---
|
|
5169
|
+
|
|
5170
|
+
Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts loginId and
|
|
5171
|
+
clientId, returns a customer object in the response body and the JWT generated against the clientId in the response header.
|
|
5009
5172
|
*
|
|
5010
5173
|
* @param options - An object containing the options for this method.
|
|
5011
5174
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -5029,7 +5192,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
5029
5192
|
body: TrustedSystemAuthRequest;
|
|
5030
5193
|
}>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
|
|
5031
5194
|
/**
|
|
5032
|
-
* Reset customer password.
|
|
5195
|
+
* Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
|
|
5033
5196
|
*
|
|
5034
5197
|
* If you would like to get a raw Response object use the other resetPassword function.
|
|
5035
5198
|
*
|
|
@@ -5055,7 +5218,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
5055
5218
|
body: ResetPasswordRequest;
|
|
5056
5219
|
}>): Promise<void>;
|
|
5057
5220
|
/**
|
|
5058
|
-
* Reset customer password.
|
|
5221
|
+
* Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
|
|
5059
5222
|
*
|
|
5060
5223
|
* @param options - An object containing the options for this method.
|
|
5061
5224
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -5079,7 +5242,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
5079
5242
|
body: ResetPasswordRequest;
|
|
5080
5243
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
5081
5244
|
/**
|
|
5082
|
-
* Get reset password token.
|
|
5245
|
+
* Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
|
|
5083
5246
|
*
|
|
5084
5247
|
* If you would like to get a raw Response object use the other getResetPasswordToken function.
|
|
5085
5248
|
*
|
|
@@ -5105,7 +5268,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
5105
5268
|
body: ResetPasswordTokenRequest;
|
|
5106
5269
|
}>): Promise<ResetPasswordToken>;
|
|
5107
5270
|
/**
|
|
5108
|
-
* Get reset password token.
|
|
5271
|
+
* Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
|
|
5109
5272
|
*
|
|
5110
5273
|
* @param options - An object containing the options for this method.
|
|
5111
5274
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -6749,7 +6912,7 @@ type ShopperDiscoverySearchQueryParameters = {
|
|
|
6749
6912
|
*/
|
|
6750
6913
|
type ShopperDiscoverySearchParameters = ShopperDiscoverySearchPathParameters & BaseUriParameters & ShopperDiscoverySearchQueryParameters;
|
|
6751
6914
|
/**
|
|
6752
|
-
* [Shopper Discovery Search](https://developer.
|
|
6915
|
+
* [Shopper Discovery Search](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-discovery-search:Summary)
|
|
6753
6916
|
* ==================================
|
|
6754
6917
|
*
|
|
6755
6918
|
* *Einstein-powered product search and search suggestions.*<br />
|
|
@@ -6952,7 +7115,7 @@ type ShopperGiftCertificatesQueryParameters = {
|
|
|
6952
7115
|
*/
|
|
6953
7116
|
type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters & BaseUriParameters & ShopperGiftCertificatesQueryParameters;
|
|
6954
7117
|
/**
|
|
6955
|
-
* [Shopper Gift Certificates](https://developer.
|
|
7118
|
+
* [Shopper Gift Certificates](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-gift-certificates:Summary)
|
|
6956
7119
|
* ==================================
|
|
6957
7120
|
*
|
|
6958
7121
|
* *Obtain details about a gift certificate.*<br />
|
|
@@ -6974,7 +7137,7 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
|
|
|
6974
7137
|
* ```
|
|
6975
7138
|
*
|
|
6976
7139
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
6977
|
-
* API Version: 1.0.
|
|
7140
|
+
* API Version: 1.0.12<br />
|
|
6978
7141
|
* Last Updated: <br />
|
|
6979
7142
|
* </span>
|
|
6980
7143
|
|
|
@@ -7328,7 +7491,7 @@ type ShopperOrdersQueryParameters = {
|
|
|
7328
7491
|
*/
|
|
7329
7492
|
type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters & ShopperOrdersQueryParameters;
|
|
7330
7493
|
/**
|
|
7331
|
-
* [Shopper Orders](https://developer.
|
|
7494
|
+
* [Shopper Orders](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-orders:Summary)
|
|
7332
7495
|
* ==================================
|
|
7333
7496
|
*
|
|
7334
7497
|
* *Finish the shopper checkout experience resulting in an order.*<br />
|
|
@@ -8034,7 +8197,7 @@ type ShopperProductsQueryParameters = {
|
|
|
8034
8197
|
*/
|
|
8035
8198
|
type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
|
|
8036
8199
|
/**
|
|
8037
|
-
* [Shopper Products](https://developer.
|
|
8200
|
+
* [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
|
|
8038
8201
|
* ==================================
|
|
8039
8202
|
*
|
|
8040
8203
|
* *Display product details across your storefront.*<br />
|
|
@@ -8373,7 +8536,7 @@ type ShopperPromotionsQueryParameters = {
|
|
|
8373
8536
|
*/
|
|
8374
8537
|
type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriParameters & ShopperPromotionsQueryParameters;
|
|
8375
8538
|
/**
|
|
8376
|
-
* [Shopper Promotions](https://developer.
|
|
8539
|
+
* [Shopper Promotions](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-promotions:Summary)
|
|
8377
8540
|
* ==================================
|
|
8378
8541
|
*
|
|
8379
8542
|
* *View details for active promotions.*<br />
|
|
@@ -8395,7 +8558,7 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
|
|
|
8395
8558
|
* ```
|
|
8396
8559
|
*
|
|
8397
8560
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
8398
|
-
* API Version: 1.0.
|
|
8561
|
+
* API Version: 1.0.21<br />
|
|
8399
8562
|
* Last Updated: <br />
|
|
8400
8563
|
* </span>
|
|
8401
8564
|
|
|
@@ -8708,7 +8871,7 @@ type ShopperSearchQueryParameters = {
|
|
|
8708
8871
|
*/
|
|
8709
8872
|
type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters & ShopperSearchQueryParameters;
|
|
8710
8873
|
/**
|
|
8711
|
-
* [Shopper Search](https://developer.
|
|
8874
|
+
* [Shopper Search](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-search:Summary)
|
|
8712
8875
|
* ==================================
|
|
8713
8876
|
*
|
|
8714
8877
|
* *product search and helpful search suggestions.*<br />
|
|
@@ -8938,6 +9101,14 @@ declare class TemplateURL extends URL {
|
|
|
8938
9101
|
static renderTemplateUri(template: string, parameters?: PathParameters): string;
|
|
8939
9102
|
}
|
|
8940
9103
|
declare namespace helpers {
|
|
9104
|
+
/*
|
|
9105
|
+
* Copyright (c) 2022, Salesforce, Inc.
|
|
9106
|
+
* All rights reserved.
|
|
9107
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
9108
|
+
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
9109
|
+
*/
|
|
9110
|
+
const isBrowser: boolean;
|
|
9111
|
+
const isNode: boolean;
|
|
8941
9112
|
/*
|
|
8942
9113
|
* Copyright (c) 2021, salesforce.com, inc.
|
|
8943
9114
|
* All rights reserved.
|
|
@@ -9026,14 +9197,6 @@ declare namespace helpers {
|
|
|
9026
9197
|
} & {
|
|
9027
9198
|
[key: string]: any;
|
|
9028
9199
|
};
|
|
9029
|
-
type PasswordLessTokenRequest = {
|
|
9030
|
-
grant_type: string;
|
|
9031
|
-
hint: string;
|
|
9032
|
-
pwdless_token: string;
|
|
9033
|
-
usid?: string;
|
|
9034
|
-
} & {
|
|
9035
|
-
[key: string]: any;
|
|
9036
|
-
};
|
|
9037
9200
|
type IntrospectResponse = {
|
|
9038
9201
|
active: boolean;
|
|
9039
9202
|
scope: string;
|
|
@@ -9059,6 +9222,15 @@ declare namespace helpers {
|
|
|
9059
9222
|
} & {
|
|
9060
9223
|
[key: string]: any;
|
|
9061
9224
|
};
|
|
9225
|
+
type PasswordLessLoginTokenRequest = {
|
|
9226
|
+
grant_type: string;
|
|
9227
|
+
hint: string;
|
|
9228
|
+
pwdless_login_token: string;
|
|
9229
|
+
client_id?: string;
|
|
9230
|
+
code_verifier?: string;
|
|
9231
|
+
} & {
|
|
9232
|
+
[key: string]: any;
|
|
9233
|
+
};
|
|
9062
9234
|
type Oauth2ErrorResponse = {
|
|
9063
9235
|
error: string;
|
|
9064
9236
|
error_uri?: string;
|
|
@@ -9066,11 +9238,12 @@ declare namespace helpers {
|
|
|
9066
9238
|
} & {
|
|
9067
9239
|
[key: string]: any;
|
|
9068
9240
|
};
|
|
9069
|
-
type
|
|
9070
|
-
|
|
9071
|
-
|
|
9072
|
-
|
|
9073
|
-
|
|
9241
|
+
type PasswordActionVerifyRequest = {
|
|
9242
|
+
client_id: string;
|
|
9243
|
+
pwd_action_token: string;
|
|
9244
|
+
code_verifier: string;
|
|
9245
|
+
new_password: string;
|
|
9246
|
+
channel_id: string;
|
|
9074
9247
|
} & {
|
|
9075
9248
|
[key: string]: any;
|
|
9076
9249
|
};
|
|
@@ -9082,6 +9255,19 @@ declare namespace helpers {
|
|
|
9082
9255
|
idp_origin: string;
|
|
9083
9256
|
client_id: string;
|
|
9084
9257
|
channel_id: string;
|
|
9258
|
+
email_id?: string;
|
|
9259
|
+
} & {
|
|
9260
|
+
[key: string]: any;
|
|
9261
|
+
};
|
|
9262
|
+
type PasswordActionRequest = {
|
|
9263
|
+
user_id: string;
|
|
9264
|
+
mode: string;
|
|
9265
|
+
channel_id: string;
|
|
9266
|
+
locale?: string;
|
|
9267
|
+
client_id?: string;
|
|
9268
|
+
code_challenge?: string;
|
|
9269
|
+
redirect_uri?: string;
|
|
9270
|
+
idp_name?: string;
|
|
9085
9271
|
} & {
|
|
9086
9272
|
[key: string]: any;
|
|
9087
9273
|
};
|
|
@@ -9108,19 +9294,47 @@ declare namespace helpers {
|
|
|
9108
9294
|
} & {
|
|
9109
9295
|
[key: string]: any;
|
|
9110
9296
|
};
|
|
9111
|
-
type PasswordLessAuthRequest = {
|
|
9112
|
-
user_id: string;
|
|
9113
|
-
mode: string;
|
|
9114
|
-
channel_id: string;
|
|
9115
|
-
} & {
|
|
9116
|
-
[key: string]: any;
|
|
9117
|
-
};
|
|
9118
9297
|
type TokenActionRequest = {
|
|
9119
9298
|
token: string;
|
|
9120
9299
|
token_type_hint?: string;
|
|
9121
9300
|
} & {
|
|
9122
9301
|
[key: string]: any;
|
|
9123
9302
|
};
|
|
9303
|
+
type ErrorResponse = {
|
|
9304
|
+
type: string;
|
|
9305
|
+
title?: string;
|
|
9306
|
+
detail?: string;
|
|
9307
|
+
instance?: string;
|
|
9308
|
+
} & {
|
|
9309
|
+
[key: string]: any;
|
|
9310
|
+
};
|
|
9311
|
+
type ChangeControlled = {
|
|
9312
|
+
creationDate?: any;
|
|
9313
|
+
modificationDate?: any;
|
|
9314
|
+
createdBy?: string;
|
|
9315
|
+
lastModifiedBy?: string;
|
|
9316
|
+
} & {
|
|
9317
|
+
[key: string]: any;
|
|
9318
|
+
};
|
|
9319
|
+
type RangeFilter = {
|
|
9320
|
+
[key: string]: any;
|
|
9321
|
+
};
|
|
9322
|
+
type ChangeControlledDataType = {
|
|
9323
|
+
creationDate?: any;
|
|
9324
|
+
modificationDate?: any;
|
|
9325
|
+
createdBy?: string;
|
|
9326
|
+
lastModifiedBy?: string;
|
|
9327
|
+
} & {
|
|
9328
|
+
[key: string]: any;
|
|
9329
|
+
};
|
|
9330
|
+
type Error = {
|
|
9331
|
+
type: string;
|
|
9332
|
+
title?: string;
|
|
9333
|
+
detail?: string;
|
|
9334
|
+
instance?: string;
|
|
9335
|
+
} & {
|
|
9336
|
+
[key: string]: any;
|
|
9337
|
+
};
|
|
9124
9338
|
type Money = {
|
|
9125
9339
|
currencyMnemonic?: string;
|
|
9126
9340
|
value?: number;
|
|
@@ -9137,7 +9351,7 @@ declare namespace helpers {
|
|
|
9137
9351
|
};
|
|
9138
9352
|
type SearchRequest = {
|
|
9139
9353
|
limit?: number;
|
|
9140
|
-
query:
|
|
9354
|
+
query: Query;
|
|
9141
9355
|
sorts?: Array<Sort>;
|
|
9142
9356
|
offset?: any;
|
|
9143
9357
|
} & {
|
|
@@ -9171,7 +9385,7 @@ declare namespace helpers {
|
|
|
9171
9385
|
[key: string]: any;
|
|
9172
9386
|
};
|
|
9173
9387
|
type PaginatedSearchResult = {
|
|
9174
|
-
query:
|
|
9388
|
+
query: Query;
|
|
9175
9389
|
sorts?: Array<Sort>;
|
|
9176
9390
|
limit: number;
|
|
9177
9391
|
hits?: Array<object>;
|
|
@@ -9191,13 +9405,13 @@ declare namespace helpers {
|
|
|
9191
9405
|
[key: string]: any;
|
|
9192
9406
|
};
|
|
9193
9407
|
type BoolFilter = {
|
|
9194
|
-
filters?:
|
|
9408
|
+
filters?: Filter;
|
|
9195
9409
|
operator: string;
|
|
9196
9410
|
} & {
|
|
9197
9411
|
[key: string]: any;
|
|
9198
9412
|
};
|
|
9199
9413
|
type PaginatedSearchResultBase = {
|
|
9200
|
-
query:
|
|
9414
|
+
query: Query;
|
|
9201
9415
|
sorts?: Array<Sort>;
|
|
9202
9416
|
limit: number;
|
|
9203
9417
|
hits?: Array<object>;
|
|
@@ -9210,13 +9424,13 @@ declare namespace helpers {
|
|
|
9210
9424
|
[key: string]: any;
|
|
9211
9425
|
};
|
|
9212
9426
|
type FilteredQuery = {
|
|
9213
|
-
filter:
|
|
9214
|
-
query:
|
|
9427
|
+
filter: Filter;
|
|
9428
|
+
query: Query;
|
|
9215
9429
|
} & {
|
|
9216
9430
|
[key: string]: any;
|
|
9217
9431
|
};
|
|
9218
9432
|
type QueryFilter = {
|
|
9219
|
-
query:
|
|
9433
|
+
query: Query;
|
|
9220
9434
|
} & {
|
|
9221
9435
|
[key: string]: any;
|
|
9222
9436
|
};
|
|
@@ -9262,9 +9476,9 @@ declare namespace helpers {
|
|
|
9262
9476
|
[key: string]: any;
|
|
9263
9477
|
};
|
|
9264
9478
|
type BoolQuery = {
|
|
9265
|
-
must?: Array<
|
|
9266
|
-
mustNot?: Array<
|
|
9267
|
-
should?: Array<
|
|
9479
|
+
must?: Array<Query>;
|
|
9480
|
+
mustNot?: Array<Query>;
|
|
9481
|
+
should?: Array<Query>;
|
|
9268
9482
|
} & {
|
|
9269
9483
|
[key: string]: any;
|
|
9270
9484
|
};
|
|
@@ -9278,7 +9492,7 @@ declare namespace helpers {
|
|
|
9278
9492
|
};
|
|
9279
9493
|
type NestedQuery = {
|
|
9280
9494
|
path: string;
|
|
9281
|
-
query:
|
|
9495
|
+
query: Query;
|
|
9282
9496
|
scoreMode?: string;
|
|
9283
9497
|
} & {
|
|
9284
9498
|
[key: string]: any;
|
|
@@ -9298,18 +9512,9 @@ declare namespace helpers {
|
|
|
9298
9512
|
} & {
|
|
9299
9513
|
[key: string]: any;
|
|
9300
9514
|
};
|
|
9301
|
-
type RangeFilter = {
|
|
9302
|
-
field: string;
|
|
9303
|
-
from?: any;
|
|
9304
|
-
fromInclusive?: boolean;
|
|
9305
|
-
to?: any;
|
|
9306
|
-
toInclusive?: boolean;
|
|
9307
|
-
} & {
|
|
9308
|
-
[key: string]: any;
|
|
9309
|
-
};
|
|
9310
9515
|
type SearchRequestBase = {
|
|
9311
9516
|
limit?: number;
|
|
9312
|
-
query:
|
|
9517
|
+
query: Query;
|
|
9313
9518
|
sorts?: Array<Sort>;
|
|
9314
9519
|
offset?: any;
|
|
9315
9520
|
} & {
|
|
@@ -9367,12 +9572,12 @@ declare namespace helpers {
|
|
|
9367
9572
|
client_id?: string;
|
|
9368
9573
|
refresh_token?: string;
|
|
9369
9574
|
channel_id?: string;
|
|
9575
|
+
hint?: string;
|
|
9370
9576
|
redirect_uri?: string;
|
|
9371
9577
|
response_type?: string;
|
|
9372
9578
|
scope?: string;
|
|
9373
9579
|
state?: string;
|
|
9374
9580
|
usid?: string;
|
|
9375
|
-
hint?: string;
|
|
9376
9581
|
code_challenge?: string;
|
|
9377
9582
|
};
|
|
9378
9583
|
/**
|
|
@@ -9380,7 +9585,7 @@ declare namespace helpers {
|
|
|
9380
9585
|
*/
|
|
9381
9586
|
type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & ShopperLoginQueryParameters;
|
|
9382
9587
|
/**
|
|
9383
|
-
* [Shopper Login and API Access Service](https://developer.
|
|
9588
|
+
* [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary)
|
|
9384
9589
|
* ==================================
|
|
9385
9590
|
*
|
|
9386
9591
|
* *Enable shoppers to log in more easily, stay logged in for longer, and get a more fluid and personalized shopping experience powered by Shopper APIs.*<br />
|
|
@@ -9402,7 +9607,7 @@ declare namespace helpers {
|
|
|
9402
9607
|
* ```
|
|
9403
9608
|
*
|
|
9404
9609
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
9405
|
-
* API Version: 1.
|
|
9610
|
+
* API Version: 1.32.0<br />
|
|
9406
9611
|
* Last Updated: <br />
|
|
9407
9612
|
* </span>
|
|
9408
9613
|
|
|
@@ -9417,14 +9622,14 @@ declare namespace helpers {
|
|
|
9417
9622
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
9418
9623
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
9419
9624
|
/**
|
|
9420
|
-
*
|
|
9625
|
+
* Get credential quality statistics for a user.
|
|
9421
9626
|
*
|
|
9422
9627
|
* If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
|
|
9423
9628
|
*
|
|
9424
9629
|
* @param options - An object containing the options for this method.
|
|
9425
9630
|
* @param parameters - An object containing the parameters for this method.
|
|
9426
9631
|
* @param organizationId -
|
|
9427
|
-
* @param username - User's login
|
|
9632
|
+
* @param username - User's login ID or email address.
|
|
9428
9633
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9429
9634
|
* sent with this request.
|
|
9430
9635
|
*
|
|
@@ -9441,12 +9646,12 @@ declare namespace helpers {
|
|
|
9441
9646
|
};
|
|
9442
9647
|
}>): Promise<CredQualityUserResponse>;
|
|
9443
9648
|
/**
|
|
9444
|
-
*
|
|
9649
|
+
* Get credential quality statistics for a user.
|
|
9445
9650
|
*
|
|
9446
9651
|
* @param options - An object containing the options for this method.
|
|
9447
9652
|
* @param parameters - An object containing the parameters for this method.
|
|
9448
9653
|
* @param organizationId -
|
|
9449
|
-
* @param username - User's login
|
|
9654
|
+
* @param username - User's login ID or email address.
|
|
9450
9655
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9451
9656
|
* sent with this request.
|
|
9452
9657
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9530,7 +9735,7 @@ declare namespace helpers {
|
|
|
9530
9735
|
headers?: {
|
|
9531
9736
|
[key: string]: string;
|
|
9532
9737
|
};
|
|
9533
|
-
body:
|
|
9738
|
+
body: PasswordActionRequest;
|
|
9534
9739
|
}>): Promise<Object>;
|
|
9535
9740
|
/**
|
|
9536
9741
|
* Allows the customer to authenticate when their identity provider is down.
|
|
@@ -9552,10 +9757,10 @@ declare namespace helpers {
|
|
|
9552
9757
|
headers?: {
|
|
9553
9758
|
[key: string]: string;
|
|
9554
9759
|
};
|
|
9555
|
-
body:
|
|
9760
|
+
body: PasswordActionRequest;
|
|
9556
9761
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
9557
9762
|
/**
|
|
9558
|
-
* Log a shopper
|
|
9763
|
+
* Log out a shopper.
|
|
9559
9764
|
*
|
|
9560
9765
|
* If you would like to get a raw Response object use the other logoutCustomer function.
|
|
9561
9766
|
*
|
|
@@ -9564,7 +9769,8 @@ declare namespace helpers {
|
|
|
9564
9769
|
* @param organizationId -
|
|
9565
9770
|
* @param client_id - The SLAS client ID.
|
|
9566
9771
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
9567
|
-
* @param channel_id - The channel_id parameter
|
|
9772
|
+
* @param channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with ECOM.
|
|
9773
|
+
* @param hint - Optional parameter for logging out user sessions. Use `all-sessions` to log out all user sessions. If `hint` is not used, only the current user session will be logged out.
|
|
9568
9774
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9569
9775
|
* sent with this request.
|
|
9570
9776
|
*
|
|
@@ -9577,20 +9783,22 @@ declare namespace helpers {
|
|
|
9577
9783
|
client_id: string;
|
|
9578
9784
|
refresh_token: string;
|
|
9579
9785
|
channel_id?: string;
|
|
9786
|
+
hint?: string;
|
|
9580
9787
|
}, ConfigParameters>;
|
|
9581
9788
|
headers?: {
|
|
9582
9789
|
[key: string]: string;
|
|
9583
9790
|
};
|
|
9584
9791
|
}>): Promise<TokenResponse>;
|
|
9585
9792
|
/**
|
|
9586
|
-
* Log a shopper
|
|
9793
|
+
* Log out a shopper.
|
|
9587
9794
|
*
|
|
9588
9795
|
* @param options - An object containing the options for this method.
|
|
9589
9796
|
* @param parameters - An object containing the parameters for this method.
|
|
9590
9797
|
* @param organizationId -
|
|
9591
9798
|
* @param client_id - The SLAS client ID.
|
|
9592
9799
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
9593
|
-
* @param channel_id - The channel_id parameter
|
|
9800
|
+
* @param channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with ECOM.
|
|
9801
|
+
* @param hint - Optional parameter for logging out user sessions. Use `all-sessions` to log out all user sessions. If `hint` is not used, only the current user session will be logged out.
|
|
9594
9802
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9595
9803
|
* sent with this request.
|
|
9596
9804
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9603,13 +9811,14 @@ declare namespace helpers {
|
|
|
9603
9811
|
client_id: string;
|
|
9604
9812
|
refresh_token: string;
|
|
9605
9813
|
channel_id?: string;
|
|
9814
|
+
hint?: string;
|
|
9606
9815
|
}, ConfigParameters>;
|
|
9607
9816
|
headers?: {
|
|
9608
9817
|
[key: string]: string;
|
|
9609
9818
|
};
|
|
9610
9819
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9611
9820
|
/**
|
|
9612
|
-
* Get authorization code after authenticating a user against an IDP. This is the first step of the
|
|
9821
|
+
* Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
|
|
9613
9822
|
*
|
|
9614
9823
|
* If you would like to get a raw Response object use the other authorizeCustomer function.
|
|
9615
9824
|
*
|
|
@@ -9617,14 +9826,14 @@ declare namespace helpers {
|
|
|
9617
9826
|
* @param parameters - An object containing the parameters for this method.
|
|
9618
9827
|
* @param organizationId -
|
|
9619
9828
|
* @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
|
|
9620
|
-
* @param response_type - Must be
|
|
9829
|
+
* @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
|
|
9621
9830
|
* @param client_id - The client ID obtained during application registration.
|
|
9622
9831
|
* @param scope - (Not Supported)
|
|
9623
|
-
* @param state - Value to
|
|
9624
|
-
* @param usid -
|
|
9625
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
9626
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
9627
|
-
* @param code_challenge - Created by the client calling the login endpoint.<br
|
|
9832
|
+
* @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
|
|
9833
|
+
* @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
|
|
9834
|
+
* @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
|
|
9835
|
+
* @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
|
|
9836
|
+
* @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
|
|
9628
9837
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9629
9838
|
* sent with this request.
|
|
9630
9839
|
*
|
|
@@ -9649,20 +9858,20 @@ declare namespace helpers {
|
|
|
9649
9858
|
};
|
|
9650
9859
|
}>): Promise<void>;
|
|
9651
9860
|
/**
|
|
9652
|
-
* Get authorization code after authenticating a user against an IDP. This is the first step of the
|
|
9861
|
+
* Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
|
|
9653
9862
|
*
|
|
9654
9863
|
* @param options - An object containing the options for this method.
|
|
9655
9864
|
* @param parameters - An object containing the parameters for this method.
|
|
9656
9865
|
* @param organizationId -
|
|
9657
9866
|
* @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
|
|
9658
|
-
* @param response_type - Must be
|
|
9867
|
+
* @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
|
|
9659
9868
|
* @param client_id - The client ID obtained during application registration.
|
|
9660
9869
|
* @param scope - (Not Supported)
|
|
9661
|
-
* @param state - Value to
|
|
9662
|
-
* @param usid -
|
|
9663
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
9664
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
9665
|
-
* @param code_challenge - Created by the client calling the login endpoint.<br
|
|
9870
|
+
* @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
|
|
9871
|
+
* @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
|
|
9872
|
+
* @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
|
|
9873
|
+
* @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
|
|
9874
|
+
* @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
|
|
9666
9875
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9667
9876
|
* sent with this request.
|
|
9668
9877
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9687,7 +9896,7 @@ declare namespace helpers {
|
|
|
9687
9896
|
};
|
|
9688
9897
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
9689
9898
|
/**
|
|
9690
|
-
* Get the shopper or guest JWT
|
|
9899
|
+
* Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.\<br /\>\<br /\>When refreshing the access token with a private client ID and client secret the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
|
|
9691
9900
|
*
|
|
9692
9901
|
* If you would like to get a raw Response object use the other getAccessToken function.
|
|
9693
9902
|
*
|
|
@@ -9711,7 +9920,7 @@ declare namespace helpers {
|
|
|
9711
9920
|
body: TokenRequest;
|
|
9712
9921
|
}>): Promise<TokenResponse>;
|
|
9713
9922
|
/**
|
|
9714
|
-
* Get the shopper or guest JWT
|
|
9923
|
+
* Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.\<br /\>\<br /\>When refreshing the access token with a private client ID and client secret the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
|
|
9715
9924
|
*
|
|
9716
9925
|
* @param options - An object containing the options for this method.
|
|
9717
9926
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9733,7 +9942,7 @@ declare namespace helpers {
|
|
|
9733
9942
|
body: TokenRequest;
|
|
9734
9943
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9735
9944
|
/**
|
|
9736
|
-
* Get a shopper JWT
|
|
9945
|
+
* Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
|
|
9737
9946
|
*
|
|
9738
9947
|
* If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
|
|
9739
9948
|
*
|
|
@@ -9757,7 +9966,7 @@ declare namespace helpers {
|
|
|
9757
9966
|
body: TrustedSystemTokenRequest;
|
|
9758
9967
|
}>): Promise<TokenResponse>;
|
|
9759
9968
|
/**
|
|
9760
|
-
* Get a shopper JWT
|
|
9969
|
+
* Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
|
|
9761
9970
|
*
|
|
9762
9971
|
* @param options - An object containing the options for this method.
|
|
9763
9972
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9778,6 +9987,98 @@ declare namespace helpers {
|
|
|
9778
9987
|
};
|
|
9779
9988
|
body: TrustedSystemTokenRequest;
|
|
9780
9989
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9990
|
+
/**
|
|
9991
|
+
* Request a reset password token
|
|
9992
|
+
*
|
|
9993
|
+
* If you would like to get a raw Response object use the other getPasswordResetToken function.
|
|
9994
|
+
*
|
|
9995
|
+
* @param options - An object containing the options for this method.
|
|
9996
|
+
* @param parameters - An object containing the parameters for this method.
|
|
9997
|
+
* @param organizationId -
|
|
9998
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
9999
|
+
* sent with this request.
|
|
10000
|
+
* @param body - The data to send as the request body.
|
|
10001
|
+
*
|
|
10002
|
+
* @returns A promise of type void.
|
|
10003
|
+
*
|
|
10004
|
+
*/
|
|
10005
|
+
getPasswordResetToken(options: RequireParametersUnlessAllAreOptional<{
|
|
10006
|
+
parameters?: CompositeParameters<{
|
|
10007
|
+
organizationId: string;
|
|
10008
|
+
}, ConfigParameters>;
|
|
10009
|
+
headers?: {
|
|
10010
|
+
[key: string]: string;
|
|
10011
|
+
};
|
|
10012
|
+
body: PasswordActionRequest;
|
|
10013
|
+
}>): Promise<void>;
|
|
10014
|
+
/**
|
|
10015
|
+
* Request a reset password token
|
|
10016
|
+
*
|
|
10017
|
+
* @param options - An object containing the options for this method.
|
|
10018
|
+
* @param parameters - An object containing the parameters for this method.
|
|
10019
|
+
* @param organizationId -
|
|
10020
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
10021
|
+
* sent with this request.
|
|
10022
|
+
* @param body - The data to send as the request body.
|
|
10023
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
10024
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
|
|
10025
|
+
*
|
|
10026
|
+
*/
|
|
10027
|
+
getPasswordResetToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
10028
|
+
parameters?: CompositeParameters<{
|
|
10029
|
+
organizationId: string;
|
|
10030
|
+
}, ConfigParameters>;
|
|
10031
|
+
headers?: {
|
|
10032
|
+
[key: string]: string;
|
|
10033
|
+
};
|
|
10034
|
+
body: PasswordActionRequest;
|
|
10035
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
10036
|
+
/**
|
|
10037
|
+
* Creates a new password
|
|
10038
|
+
*
|
|
10039
|
+
* If you would like to get a raw Response object use the other resetPassword function.
|
|
10040
|
+
*
|
|
10041
|
+
* @param options - An object containing the options for this method.
|
|
10042
|
+
* @param parameters - An object containing the parameters for this method.
|
|
10043
|
+
* @param organizationId -
|
|
10044
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
10045
|
+
* sent with this request.
|
|
10046
|
+
* @param body - The data to send as the request body.
|
|
10047
|
+
*
|
|
10048
|
+
* @returns A promise of type void.
|
|
10049
|
+
*
|
|
10050
|
+
*/
|
|
10051
|
+
resetPassword(options: RequireParametersUnlessAllAreOptional<{
|
|
10052
|
+
parameters?: CompositeParameters<{
|
|
10053
|
+
organizationId: string;
|
|
10054
|
+
}, ConfigParameters>;
|
|
10055
|
+
headers?: {
|
|
10056
|
+
[key: string]: string;
|
|
10057
|
+
};
|
|
10058
|
+
body: PasswordActionVerifyRequest;
|
|
10059
|
+
}>): Promise<void>;
|
|
10060
|
+
/**
|
|
10061
|
+
* Creates a new password
|
|
10062
|
+
*
|
|
10063
|
+
* @param options - An object containing the options for this method.
|
|
10064
|
+
* @param parameters - An object containing the parameters for this method.
|
|
10065
|
+
* @param organizationId -
|
|
10066
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
10067
|
+
* sent with this request.
|
|
10068
|
+
* @param body - The data to send as the request body.
|
|
10069
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
10070
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
|
|
10071
|
+
*
|
|
10072
|
+
*/
|
|
10073
|
+
resetPassword<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
10074
|
+
parameters?: CompositeParameters<{
|
|
10075
|
+
organizationId: string;
|
|
10076
|
+
}, ConfigParameters>;
|
|
10077
|
+
headers?: {
|
|
10078
|
+
[key: string]: string;
|
|
10079
|
+
};
|
|
10080
|
+
body: PasswordActionVerifyRequest;
|
|
10081
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
9781
10082
|
/**
|
|
9782
10083
|
* Issue a shopper token (JWT).
|
|
9783
10084
|
*
|
|
@@ -9800,7 +10101,7 @@ declare namespace helpers {
|
|
|
9800
10101
|
headers?: {
|
|
9801
10102
|
[key: string]: string;
|
|
9802
10103
|
};
|
|
9803
|
-
body:
|
|
10104
|
+
body: PasswordLessLoginTokenRequest;
|
|
9804
10105
|
}>): Promise<TokenResponse>;
|
|
9805
10106
|
/**
|
|
9806
10107
|
* Issue a shopper token (JWT).
|
|
@@ -9822,10 +10123,10 @@ declare namespace helpers {
|
|
|
9822
10123
|
headers?: {
|
|
9823
10124
|
[key: string]: string;
|
|
9824
10125
|
};
|
|
9825
|
-
body:
|
|
10126
|
+
body: PasswordLessLoginTokenRequest;
|
|
9826
10127
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9827
10128
|
/**
|
|
9828
|
-
* Invalidate the refresh token. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
10129
|
+
* Invalidate the refresh token. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
9829
10130
|
*
|
|
9830
10131
|
* If you would like to get a raw Response object use the other revokeToken function.
|
|
9831
10132
|
*
|
|
@@ -9849,7 +10150,7 @@ declare namespace helpers {
|
|
|
9849
10150
|
body: TokenActionRequest;
|
|
9850
10151
|
}>): Promise<TokenResponse>;
|
|
9851
10152
|
/**
|
|
9852
|
-
* Invalidate the refresh token. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
10153
|
+
* Invalidate the refresh token. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, and the refresh token to be revoked is required in the body.
|
|
9853
10154
|
*
|
|
9854
10155
|
* @param options - An object containing the options for this method.
|
|
9855
10156
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9871,7 +10172,7 @@ declare namespace helpers {
|
|
|
9871
10172
|
body: TokenActionRequest;
|
|
9872
10173
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9873
10174
|
/**
|
|
9874
|
-
* Returns the token properties. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.
|
|
10175
|
+
* Returns the token properties. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
|
|
9875
10176
|
*
|
|
9876
10177
|
* If you would like to get a raw Response object use the other introspectToken function.
|
|
9877
10178
|
*
|
|
@@ -9895,7 +10196,7 @@ declare namespace helpers {
|
|
|
9895
10196
|
body: TokenActionRequest;
|
|
9896
10197
|
}>): Promise<Object>;
|
|
9897
10198
|
/**
|
|
9898
|
-
* Returns the token properties. A basic auth header with base64 encoded clientId:secret is required in the Authorization header, as well as an access token or refresh token. Use token_type_hint to help identify the token.
|
|
10199
|
+
* Returns the token properties. A basic auth header with base64 encoded `clientId:secret` is required in the Authorization header, as well as an access token or refresh token. Use `token_type_hint` to help identify the token.
|
|
9899
10200
|
*
|
|
9900
10201
|
* @param options - An object containing the options for this method.
|
|
9901
10202
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9917,14 +10218,14 @@ declare namespace helpers {
|
|
|
9917
10218
|
body: TokenActionRequest;
|
|
9918
10219
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
9919
10220
|
/**
|
|
9920
|
-
* Returns a JSON
|
|
10221
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
9921
10222
|
*
|
|
9922
10223
|
* If you would like to get a raw Response object use the other getUserInfo function.
|
|
9923
10224
|
*
|
|
9924
10225
|
* @param options - An object containing the options for this method.
|
|
9925
10226
|
* @param parameters - An object containing the parameters for this method.
|
|
9926
10227
|
* @param organizationId -
|
|
9927
|
-
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer this is angalous to the site ID.
|
|
10228
|
+
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer, this is angalous to the site ID. Required when getting user information for an ECOM customer.
|
|
9928
10229
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9929
10230
|
* sent with this request.
|
|
9930
10231
|
*
|
|
@@ -9941,12 +10242,12 @@ declare namespace helpers {
|
|
|
9941
10242
|
};
|
|
9942
10243
|
}>): Promise<Object>;
|
|
9943
10244
|
/**
|
|
9944
|
-
* Returns a JSON
|
|
10245
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
9945
10246
|
*
|
|
9946
10247
|
* @param options - An object containing the options for this method.
|
|
9947
10248
|
* @param parameters - An object containing the parameters for this method.
|
|
9948
10249
|
* @param organizationId -
|
|
9949
|
-
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer this is angalous to the site ID.
|
|
10250
|
+
* @param channel_id - Used when getting user information for a SFCC login. For an ECOM customer, this is angalous to the site ID. Required when getting user information for an ECOM customer.
|
|
9950
10251
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9951
10252
|
* sent with this request.
|
|
9952
10253
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -10005,7 +10306,7 @@ declare namespace helpers {
|
|
|
10005
10306
|
};
|
|
10006
10307
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
10007
10308
|
/**
|
|
10008
|
-
* Returns a JWKS containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
10309
|
+
* Returns a JSON Web Key Set (JWKS) containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
10009
10310
|
*
|
|
10010
10311
|
* If you would like to get a raw Response object use the other getJwksUri function.
|
|
10011
10312
|
*
|
|
@@ -10027,7 +10328,7 @@ declare namespace helpers {
|
|
|
10027
10328
|
};
|
|
10028
10329
|
}>): Promise<Object>;
|
|
10029
10330
|
/**
|
|
10030
|
-
* Returns a JWKS containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
10331
|
+
* Returns a JSON Web Key Set (JWKS) containing public keys that enable clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
|
|
10031
10332
|
*
|
|
10032
10333
|
* @param options - An object containing the options for this method.
|
|
10033
10334
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -10047,10 +10348,6 @@ declare namespace helpers {
|
|
|
10047
10348
|
};
|
|
10048
10349
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
10049
10350
|
}
|
|
10050
|
-
/**
|
|
10051
|
-
* Determine if execution is client or server side
|
|
10052
|
-
*/
|
|
10053
|
-
const onClient: boolean;
|
|
10054
10351
|
const stringToBase64: typeof btoa;
|
|
10055
10352
|
/**
|
|
10056
10353
|
* Parse out the code and usid from a redirect url
|
|
@@ -10096,7 +10393,7 @@ declare namespace helpers {
|
|
|
10096
10393
|
usid: string;
|
|
10097
10394
|
}>;
|
|
10098
10395
|
/**
|
|
10099
|
-
* A single function to execute the ShopperLogin Public Client Guest Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references
|
|
10396
|
+
* A single function to execute the ShopperLogin Public Client Guest Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
|
|
10100
10397
|
* @param slasClient a configured instance of the ShopperLogin SDK client.
|
|
10101
10398
|
* @param parameters - parameters to pass in the API calls.
|
|
10102
10399
|
* @param parameters.redirectURI - Per OAuth standard, a valid app route. Must be listed in your SLAS configuration. On server, this will not be actually called. On browser, this will be called, but ignored.
|
|
@@ -10112,7 +10409,7 @@ declare namespace helpers {
|
|
|
10112
10409
|
usid?: string;
|
|
10113
10410
|
}): Promise<TokenResponse>;
|
|
10114
10411
|
/**
|
|
10115
|
-
* A single function to execute the ShopperLogin Public Client Registered User B2C Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references
|
|
10412
|
+
* A single function to execute the ShopperLogin Public Client Registered User B2C Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
|
|
10116
10413
|
* @param slasClient a configured instance of the ShopperLogin SDK client.
|
|
10117
10414
|
* @param credentials - the id and password to login with.
|
|
10118
10415
|
* @param credentials.username - the id of the user to login with.
|