commerce-sdk-isomorphic 1.5.2 → 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 +35 -0
- package/README.md +4 -0
- package/lib/index.cjs.d.ts +468 -175
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +468 -175
- package/lib/index.esm.js +1 -1
- package/package.json +1 -1
package/lib/index.cjs.d.ts
CHANGED
|
@@ -47,14 +47,6 @@ type LoginRequest = {
|
|
|
47
47
|
} & {
|
|
48
48
|
[key: string]: any;
|
|
49
49
|
};
|
|
50
|
-
type PasswordLessTokenRequest = {
|
|
51
|
-
grant_type: string;
|
|
52
|
-
hint: string;
|
|
53
|
-
pwdless_token: string;
|
|
54
|
-
usid?: string;
|
|
55
|
-
} & {
|
|
56
|
-
[key: string]: any;
|
|
57
|
-
};
|
|
58
50
|
type CredQualityUserResponse = {
|
|
59
51
|
tenantId: string;
|
|
60
52
|
username: string;
|
|
@@ -69,6 +61,24 @@ type CredQualityUserResponse = {
|
|
|
69
61
|
} & {
|
|
70
62
|
[key: string]: any;
|
|
71
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
|
+
};
|
|
72
82
|
type TrustedSystemTokenRequest = {
|
|
73
83
|
usid?: string;
|
|
74
84
|
grant_type: string;
|
|
@@ -77,6 +87,19 @@ type TrustedSystemTokenRequest = {
|
|
|
77
87
|
idp_origin: string;
|
|
78
88
|
client_id: string;
|
|
79
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;
|
|
80
103
|
} & {
|
|
81
104
|
[key: string]: any;
|
|
82
105
|
};
|
|
@@ -103,21 +126,17 @@ type TokenRequest = {
|
|
|
103
126
|
} & {
|
|
104
127
|
[key: string]: any;
|
|
105
128
|
};
|
|
106
|
-
type PasswordLessAuthRequest = {
|
|
107
|
-
user_id: string;
|
|
108
|
-
mode: string;
|
|
109
|
-
channel_id: string;
|
|
110
|
-
} & {
|
|
111
|
-
[key: string]: any;
|
|
112
|
-
};
|
|
113
129
|
type TokenActionRequest = {
|
|
114
130
|
token: string;
|
|
115
131
|
token_type_hint?: string;
|
|
116
132
|
} & {
|
|
117
133
|
[key: string]: any;
|
|
118
134
|
};
|
|
135
|
+
type RangeFilter = {
|
|
136
|
+
[key: string]: any;
|
|
137
|
+
};
|
|
119
138
|
type BoolFilter = {
|
|
120
|
-
filters?:
|
|
139
|
+
filters?: Filter;
|
|
121
140
|
operator: string;
|
|
122
141
|
} & {
|
|
123
142
|
[key: string]: any;
|
|
@@ -126,13 +145,23 @@ type MatchAllQuery = {} & {
|
|
|
126
145
|
[key: string]: any;
|
|
127
146
|
};
|
|
128
147
|
type FilteredQuery = {
|
|
129
|
-
filter:
|
|
130
|
-
query:
|
|
148
|
+
filter: Filter;
|
|
149
|
+
query: Query;
|
|
131
150
|
} & {
|
|
132
151
|
[key: string]: any;
|
|
133
152
|
};
|
|
134
153
|
type QueryFilter = {
|
|
135
|
-
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;
|
|
136
165
|
} & {
|
|
137
166
|
[key: string]: any;
|
|
138
167
|
};
|
|
@@ -168,31 +197,31 @@ type Range2Filter = {
|
|
|
168
197
|
[key: string]: any;
|
|
169
198
|
};
|
|
170
199
|
type BoolQuery = {
|
|
171
|
-
must?: Array<
|
|
172
|
-
mustNot?: Array<
|
|
173
|
-
should?: Array<
|
|
200
|
+
must?: Array<Query>;
|
|
201
|
+
mustNot?: Array<Query>;
|
|
202
|
+
should?: Array<Query>;
|
|
174
203
|
} & {
|
|
175
204
|
[key: string]: any;
|
|
176
205
|
};
|
|
177
206
|
type NestedQuery = {
|
|
178
207
|
path: string;
|
|
179
|
-
query:
|
|
208
|
+
query: Query;
|
|
180
209
|
scoreMode?: string;
|
|
181
210
|
} & {
|
|
182
211
|
[key: string]: any;
|
|
183
212
|
};
|
|
184
|
-
type
|
|
185
|
-
|
|
186
|
-
|
|
213
|
+
type Filter = {
|
|
214
|
+
boolFilter?: BoolFilter;
|
|
215
|
+
queryFilter?: QueryFilter;
|
|
216
|
+
range2Filter?: Range2Filter;
|
|
217
|
+
rangeFilter?: RangeFilter;
|
|
218
|
+
termFilter?: TermFilter;
|
|
187
219
|
} & {
|
|
188
220
|
[key: string]: any;
|
|
189
221
|
};
|
|
190
|
-
type
|
|
222
|
+
type Sort = {
|
|
191
223
|
field: string;
|
|
192
|
-
|
|
193
|
-
fromInclusive?: boolean;
|
|
194
|
-
to?: any;
|
|
195
|
-
toInclusive?: boolean;
|
|
224
|
+
sortOrder?: string;
|
|
196
225
|
} & {
|
|
197
226
|
[key: string]: any;
|
|
198
227
|
};
|
|
@@ -220,12 +249,12 @@ type ShopperLoginQueryParameters = {
|
|
|
220
249
|
client_id?: string;
|
|
221
250
|
refresh_token?: string;
|
|
222
251
|
channel_id?: string;
|
|
252
|
+
hint?: string;
|
|
223
253
|
redirect_uri?: string;
|
|
224
254
|
response_type?: string;
|
|
225
255
|
scope?: string;
|
|
226
256
|
state?: string;
|
|
227
257
|
usid?: string;
|
|
228
|
-
hint?: string;
|
|
229
258
|
code_challenge?: string;
|
|
230
259
|
};
|
|
231
260
|
/**
|
|
@@ -255,7 +284,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
255
284
|
* ```
|
|
256
285
|
*
|
|
257
286
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
258
|
-
* API Version: 1.
|
|
287
|
+
* API Version: 1.32.0<br />
|
|
259
288
|
* Last Updated: <br />
|
|
260
289
|
* </span>
|
|
261
290
|
|
|
@@ -270,14 +299,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
270
299
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
271
300
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
272
301
|
/**
|
|
273
|
-
*
|
|
302
|
+
* Get credential quality statistics for a user.
|
|
274
303
|
*
|
|
275
304
|
* If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
|
|
276
305
|
*
|
|
277
306
|
* @param options - An object containing the options for this method.
|
|
278
307
|
* @param parameters - An object containing the parameters for this method.
|
|
279
308
|
* @param organizationId -
|
|
280
|
-
* @param username - User's login
|
|
309
|
+
* @param username - User's login ID or email address.
|
|
281
310
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
282
311
|
* sent with this request.
|
|
283
312
|
*
|
|
@@ -294,12 +323,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
294
323
|
};
|
|
295
324
|
}>): Promise<CredQualityUserResponse>;
|
|
296
325
|
/**
|
|
297
|
-
*
|
|
326
|
+
* Get credential quality statistics for a user.
|
|
298
327
|
*
|
|
299
328
|
* @param options - An object containing the options for this method.
|
|
300
329
|
* @param parameters - An object containing the parameters for this method.
|
|
301
330
|
* @param organizationId -
|
|
302
|
-
* @param username - User's login
|
|
331
|
+
* @param username - User's login ID or email address.
|
|
303
332
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
304
333
|
* sent with this request.
|
|
305
334
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -383,7 +412,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
383
412
|
headers?: {
|
|
384
413
|
[key: string]: string;
|
|
385
414
|
};
|
|
386
|
-
body:
|
|
415
|
+
body: PasswordActionRequest;
|
|
387
416
|
}>): Promise<Object>;
|
|
388
417
|
/**
|
|
389
418
|
* Allows the customer to authenticate when their identity provider is down.
|
|
@@ -405,10 +434,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
405
434
|
headers?: {
|
|
406
435
|
[key: string]: string;
|
|
407
436
|
};
|
|
408
|
-
body:
|
|
437
|
+
body: PasswordActionRequest;
|
|
409
438
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
410
439
|
/**
|
|
411
|
-
* Log a shopper
|
|
440
|
+
* Log out a shopper.
|
|
412
441
|
*
|
|
413
442
|
* If you would like to get a raw Response object use the other logoutCustomer function.
|
|
414
443
|
*
|
|
@@ -417,7 +446,8 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
417
446
|
* @param organizationId -
|
|
418
447
|
* @param client_id - The SLAS client ID.
|
|
419
448
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
420
|
-
* @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.
|
|
421
451
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
422
452
|
* sent with this request.
|
|
423
453
|
*
|
|
@@ -430,20 +460,22 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
430
460
|
client_id: string;
|
|
431
461
|
refresh_token: string;
|
|
432
462
|
channel_id?: string;
|
|
463
|
+
hint?: string;
|
|
433
464
|
}, ConfigParameters>;
|
|
434
465
|
headers?: {
|
|
435
466
|
[key: string]: string;
|
|
436
467
|
};
|
|
437
468
|
}>): Promise<TokenResponse>;
|
|
438
469
|
/**
|
|
439
|
-
* Log a shopper
|
|
470
|
+
* Log out a shopper.
|
|
440
471
|
*
|
|
441
472
|
* @param options - An object containing the options for this method.
|
|
442
473
|
* @param parameters - An object containing the parameters for this method.
|
|
443
474
|
* @param organizationId -
|
|
444
475
|
* @param client_id - The SLAS client ID.
|
|
445
476
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
446
|
-
* @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.
|
|
447
479
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
448
480
|
* sent with this request.
|
|
449
481
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -456,13 +488,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
456
488
|
client_id: string;
|
|
457
489
|
refresh_token: string;
|
|
458
490
|
channel_id?: string;
|
|
491
|
+
hint?: string;
|
|
459
492
|
}, ConfigParameters>;
|
|
460
493
|
headers?: {
|
|
461
494
|
[key: string]: string;
|
|
462
495
|
};
|
|
463
496
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
464
497
|
/**
|
|
465
|
-
* 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).
|
|
466
499
|
*
|
|
467
500
|
* If you would like to get a raw Response object use the other authorizeCustomer function.
|
|
468
501
|
*
|
|
@@ -470,14 +503,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
470
503
|
* @param parameters - An object containing the parameters for this method.
|
|
471
504
|
* @param organizationId -
|
|
472
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.
|
|
473
|
-
* @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).
|
|
474
507
|
* @param client_id - The client ID obtained during application registration.
|
|
475
508
|
* @param scope - (Not Supported)
|
|
476
|
-
* @param state - Value to
|
|
477
|
-
* @param usid -
|
|
478
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
479
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
480
|
-
* @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.
|
|
481
514
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
482
515
|
* sent with this request.
|
|
483
516
|
*
|
|
@@ -502,20 +535,20 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
502
535
|
};
|
|
503
536
|
}>): Promise<void>;
|
|
504
537
|
/**
|
|
505
|
-
* 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).
|
|
506
539
|
*
|
|
507
540
|
* @param options - An object containing the options for this method.
|
|
508
541
|
* @param parameters - An object containing the parameters for this method.
|
|
509
542
|
* @param organizationId -
|
|
510
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.
|
|
511
|
-
* @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).
|
|
512
545
|
* @param client_id - The client ID obtained during application registration.
|
|
513
546
|
* @param scope - (Not Supported)
|
|
514
|
-
* @param state - Value to
|
|
515
|
-
* @param usid -
|
|
516
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
517
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
518
|
-
* @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.
|
|
519
552
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
520
553
|
* sent with this request.
|
|
521
554
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -540,7 +573,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
540
573
|
};
|
|
541
574
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
542
575
|
/**
|
|
543
|
-
* 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`.
|
|
544
577
|
*
|
|
545
578
|
* If you would like to get a raw Response object use the other getAccessToken function.
|
|
546
579
|
*
|
|
@@ -564,7 +597,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
564
597
|
body: TokenRequest;
|
|
565
598
|
}>): Promise<TokenResponse>;
|
|
566
599
|
/**
|
|
567
|
-
* 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`.
|
|
568
601
|
*
|
|
569
602
|
* @param options - An object containing the options for this method.
|
|
570
603
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -586,7 +619,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
586
619
|
body: TokenRequest;
|
|
587
620
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
588
621
|
/**
|
|
589
|
-
* 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.
|
|
590
623
|
*
|
|
591
624
|
* If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
|
|
592
625
|
*
|
|
@@ -610,7 +643,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
610
643
|
body: TrustedSystemTokenRequest;
|
|
611
644
|
}>): Promise<TokenResponse>;
|
|
612
645
|
/**
|
|
613
|
-
* 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.
|
|
614
647
|
*
|
|
615
648
|
* @param options - An object containing the options for this method.
|
|
616
649
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -631,6 +664,98 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
631
664
|
};
|
|
632
665
|
body: TrustedSystemTokenRequest;
|
|
633
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>;
|
|
634
759
|
/**
|
|
635
760
|
* Issue a shopper token (JWT).
|
|
636
761
|
*
|
|
@@ -653,7 +778,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
653
778
|
headers?: {
|
|
654
779
|
[key: string]: string;
|
|
655
780
|
};
|
|
656
|
-
body:
|
|
781
|
+
body: PasswordLessLoginTokenRequest;
|
|
657
782
|
}>): Promise<TokenResponse>;
|
|
658
783
|
/**
|
|
659
784
|
* Issue a shopper token (JWT).
|
|
@@ -675,10 +800,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
675
800
|
headers?: {
|
|
676
801
|
[key: string]: string;
|
|
677
802
|
};
|
|
678
|
-
body:
|
|
803
|
+
body: PasswordLessLoginTokenRequest;
|
|
679
804
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
680
805
|
/**
|
|
681
|
-
* 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.
|
|
682
807
|
*
|
|
683
808
|
* If you would like to get a raw Response object use the other revokeToken function.
|
|
684
809
|
*
|
|
@@ -702,7 +827,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
702
827
|
body: TokenActionRequest;
|
|
703
828
|
}>): Promise<TokenResponse>;
|
|
704
829
|
/**
|
|
705
|
-
* 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.
|
|
706
831
|
*
|
|
707
832
|
* @param options - An object containing the options for this method.
|
|
708
833
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -724,7 +849,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
724
849
|
body: TokenActionRequest;
|
|
725
850
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
726
851
|
/**
|
|
727
|
-
* 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.
|
|
728
853
|
*
|
|
729
854
|
* If you would like to get a raw Response object use the other introspectToken function.
|
|
730
855
|
*
|
|
@@ -748,7 +873,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
748
873
|
body: TokenActionRequest;
|
|
749
874
|
}>): Promise<Object>;
|
|
750
875
|
/**
|
|
751
|
-
* 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.
|
|
752
877
|
*
|
|
753
878
|
* @param options - An object containing the options for this method.
|
|
754
879
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -770,14 +895,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
770
895
|
body: TokenActionRequest;
|
|
771
896
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
772
897
|
/**
|
|
773
|
-
* Returns a JSON
|
|
898
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
774
899
|
*
|
|
775
900
|
* If you would like to get a raw Response object use the other getUserInfo function.
|
|
776
901
|
*
|
|
777
902
|
* @param options - An object containing the options for this method.
|
|
778
903
|
* @param parameters - An object containing the parameters for this method.
|
|
779
904
|
* @param organizationId -
|
|
780
|
-
* @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.
|
|
781
906
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
782
907
|
* sent with this request.
|
|
783
908
|
*
|
|
@@ -794,12 +919,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
794
919
|
};
|
|
795
920
|
}>): Promise<Object>;
|
|
796
921
|
/**
|
|
797
|
-
* Returns a JSON
|
|
922
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
798
923
|
*
|
|
799
924
|
* @param options - An object containing the options for this method.
|
|
800
925
|
* @param parameters - An object containing the parameters for this method.
|
|
801
926
|
* @param organizationId -
|
|
802
|
-
* @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.
|
|
803
928
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
804
929
|
* sent with this request.
|
|
805
930
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -858,7 +983,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
858
983
|
};
|
|
859
984
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
860
985
|
/**
|
|
861
|
-
* 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.
|
|
862
987
|
*
|
|
863
988
|
* If you would like to get a raw Response object use the other getJwksUri function.
|
|
864
989
|
*
|
|
@@ -880,7 +1005,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
|
|
|
880
1005
|
};
|
|
881
1006
|
}>): Promise<Object>;
|
|
882
1007
|
/**
|
|
883
|
-
* 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.
|
|
884
1009
|
*
|
|
885
1010
|
* @param options - An object containing the options for this method.
|
|
886
1011
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -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;
|
|
@@ -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.
|
|
@@ -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
|
|
|
@@ -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
|
|
|
@@ -9034,14 +9197,6 @@ declare namespace helpers {
|
|
|
9034
9197
|
} & {
|
|
9035
9198
|
[key: string]: any;
|
|
9036
9199
|
};
|
|
9037
|
-
type PasswordLessTokenRequest = {
|
|
9038
|
-
grant_type: string;
|
|
9039
|
-
hint: string;
|
|
9040
|
-
pwdless_token: string;
|
|
9041
|
-
usid?: string;
|
|
9042
|
-
} & {
|
|
9043
|
-
[key: string]: any;
|
|
9044
|
-
};
|
|
9045
9200
|
type IntrospectResponse = {
|
|
9046
9201
|
active: boolean;
|
|
9047
9202
|
scope: string;
|
|
@@ -9067,6 +9222,15 @@ declare namespace helpers {
|
|
|
9067
9222
|
} & {
|
|
9068
9223
|
[key: string]: any;
|
|
9069
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
|
+
};
|
|
9070
9234
|
type Oauth2ErrorResponse = {
|
|
9071
9235
|
error: string;
|
|
9072
9236
|
error_uri?: string;
|
|
@@ -9074,11 +9238,12 @@ declare namespace helpers {
|
|
|
9074
9238
|
} & {
|
|
9075
9239
|
[key: string]: any;
|
|
9076
9240
|
};
|
|
9077
|
-
type
|
|
9078
|
-
|
|
9079
|
-
|
|
9080
|
-
|
|
9081
|
-
|
|
9241
|
+
type PasswordActionVerifyRequest = {
|
|
9242
|
+
client_id: string;
|
|
9243
|
+
pwd_action_token: string;
|
|
9244
|
+
code_verifier: string;
|
|
9245
|
+
new_password: string;
|
|
9246
|
+
channel_id: string;
|
|
9082
9247
|
} & {
|
|
9083
9248
|
[key: string]: any;
|
|
9084
9249
|
};
|
|
@@ -9090,6 +9255,19 @@ declare namespace helpers {
|
|
|
9090
9255
|
idp_origin: string;
|
|
9091
9256
|
client_id: string;
|
|
9092
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;
|
|
9093
9271
|
} & {
|
|
9094
9272
|
[key: string]: any;
|
|
9095
9273
|
};
|
|
@@ -9116,19 +9294,47 @@ declare namespace helpers {
|
|
|
9116
9294
|
} & {
|
|
9117
9295
|
[key: string]: any;
|
|
9118
9296
|
};
|
|
9119
|
-
type PasswordLessAuthRequest = {
|
|
9120
|
-
user_id: string;
|
|
9121
|
-
mode: string;
|
|
9122
|
-
channel_id: string;
|
|
9123
|
-
} & {
|
|
9124
|
-
[key: string]: any;
|
|
9125
|
-
};
|
|
9126
9297
|
type TokenActionRequest = {
|
|
9127
9298
|
token: string;
|
|
9128
9299
|
token_type_hint?: string;
|
|
9129
9300
|
} & {
|
|
9130
9301
|
[key: string]: any;
|
|
9131
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
|
+
};
|
|
9132
9338
|
type Money = {
|
|
9133
9339
|
currencyMnemonic?: string;
|
|
9134
9340
|
value?: number;
|
|
@@ -9145,7 +9351,7 @@ declare namespace helpers {
|
|
|
9145
9351
|
};
|
|
9146
9352
|
type SearchRequest = {
|
|
9147
9353
|
limit?: number;
|
|
9148
|
-
query:
|
|
9354
|
+
query: Query;
|
|
9149
9355
|
sorts?: Array<Sort>;
|
|
9150
9356
|
offset?: any;
|
|
9151
9357
|
} & {
|
|
@@ -9179,7 +9385,7 @@ declare namespace helpers {
|
|
|
9179
9385
|
[key: string]: any;
|
|
9180
9386
|
};
|
|
9181
9387
|
type PaginatedSearchResult = {
|
|
9182
|
-
query:
|
|
9388
|
+
query: Query;
|
|
9183
9389
|
sorts?: Array<Sort>;
|
|
9184
9390
|
limit: number;
|
|
9185
9391
|
hits?: Array<object>;
|
|
@@ -9199,13 +9405,13 @@ declare namespace helpers {
|
|
|
9199
9405
|
[key: string]: any;
|
|
9200
9406
|
};
|
|
9201
9407
|
type BoolFilter = {
|
|
9202
|
-
filters?:
|
|
9408
|
+
filters?: Filter;
|
|
9203
9409
|
operator: string;
|
|
9204
9410
|
} & {
|
|
9205
9411
|
[key: string]: any;
|
|
9206
9412
|
};
|
|
9207
9413
|
type PaginatedSearchResultBase = {
|
|
9208
|
-
query:
|
|
9414
|
+
query: Query;
|
|
9209
9415
|
sorts?: Array<Sort>;
|
|
9210
9416
|
limit: number;
|
|
9211
9417
|
hits?: Array<object>;
|
|
@@ -9218,13 +9424,13 @@ declare namespace helpers {
|
|
|
9218
9424
|
[key: string]: any;
|
|
9219
9425
|
};
|
|
9220
9426
|
type FilteredQuery = {
|
|
9221
|
-
filter:
|
|
9222
|
-
query:
|
|
9427
|
+
filter: Filter;
|
|
9428
|
+
query: Query;
|
|
9223
9429
|
} & {
|
|
9224
9430
|
[key: string]: any;
|
|
9225
9431
|
};
|
|
9226
9432
|
type QueryFilter = {
|
|
9227
|
-
query:
|
|
9433
|
+
query: Query;
|
|
9228
9434
|
} & {
|
|
9229
9435
|
[key: string]: any;
|
|
9230
9436
|
};
|
|
@@ -9270,9 +9476,9 @@ declare namespace helpers {
|
|
|
9270
9476
|
[key: string]: any;
|
|
9271
9477
|
};
|
|
9272
9478
|
type BoolQuery = {
|
|
9273
|
-
must?: Array<
|
|
9274
|
-
mustNot?: Array<
|
|
9275
|
-
should?: Array<
|
|
9479
|
+
must?: Array<Query>;
|
|
9480
|
+
mustNot?: Array<Query>;
|
|
9481
|
+
should?: Array<Query>;
|
|
9276
9482
|
} & {
|
|
9277
9483
|
[key: string]: any;
|
|
9278
9484
|
};
|
|
@@ -9286,7 +9492,7 @@ declare namespace helpers {
|
|
|
9286
9492
|
};
|
|
9287
9493
|
type NestedQuery = {
|
|
9288
9494
|
path: string;
|
|
9289
|
-
query:
|
|
9495
|
+
query: Query;
|
|
9290
9496
|
scoreMode?: string;
|
|
9291
9497
|
} & {
|
|
9292
9498
|
[key: string]: any;
|
|
@@ -9306,18 +9512,9 @@ declare namespace helpers {
|
|
|
9306
9512
|
} & {
|
|
9307
9513
|
[key: string]: any;
|
|
9308
9514
|
};
|
|
9309
|
-
type RangeFilter = {
|
|
9310
|
-
field: string;
|
|
9311
|
-
from?: any;
|
|
9312
|
-
fromInclusive?: boolean;
|
|
9313
|
-
to?: any;
|
|
9314
|
-
toInclusive?: boolean;
|
|
9315
|
-
} & {
|
|
9316
|
-
[key: string]: any;
|
|
9317
|
-
};
|
|
9318
9515
|
type SearchRequestBase = {
|
|
9319
9516
|
limit?: number;
|
|
9320
|
-
query:
|
|
9517
|
+
query: Query;
|
|
9321
9518
|
sorts?: Array<Sort>;
|
|
9322
9519
|
offset?: any;
|
|
9323
9520
|
} & {
|
|
@@ -9375,12 +9572,12 @@ declare namespace helpers {
|
|
|
9375
9572
|
client_id?: string;
|
|
9376
9573
|
refresh_token?: string;
|
|
9377
9574
|
channel_id?: string;
|
|
9575
|
+
hint?: string;
|
|
9378
9576
|
redirect_uri?: string;
|
|
9379
9577
|
response_type?: string;
|
|
9380
9578
|
scope?: string;
|
|
9381
9579
|
state?: string;
|
|
9382
9580
|
usid?: string;
|
|
9383
|
-
hint?: string;
|
|
9384
9581
|
code_challenge?: string;
|
|
9385
9582
|
};
|
|
9386
9583
|
/**
|
|
@@ -9410,7 +9607,7 @@ declare namespace helpers {
|
|
|
9410
9607
|
* ```
|
|
9411
9608
|
*
|
|
9412
9609
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
9413
|
-
* API Version: 1.
|
|
9610
|
+
* API Version: 1.32.0<br />
|
|
9414
9611
|
* Last Updated: <br />
|
|
9415
9612
|
* </span>
|
|
9416
9613
|
|
|
@@ -9425,14 +9622,14 @@ declare namespace helpers {
|
|
|
9425
9622
|
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
|
|
9426
9623
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
9427
9624
|
/**
|
|
9428
|
-
*
|
|
9625
|
+
* Get credential quality statistics for a user.
|
|
9429
9626
|
*
|
|
9430
9627
|
* If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
|
|
9431
9628
|
*
|
|
9432
9629
|
* @param options - An object containing the options for this method.
|
|
9433
9630
|
* @param parameters - An object containing the parameters for this method.
|
|
9434
9631
|
* @param organizationId -
|
|
9435
|
-
* @param username - User's login
|
|
9632
|
+
* @param username - User's login ID or email address.
|
|
9436
9633
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9437
9634
|
* sent with this request.
|
|
9438
9635
|
*
|
|
@@ -9449,12 +9646,12 @@ declare namespace helpers {
|
|
|
9449
9646
|
};
|
|
9450
9647
|
}>): Promise<CredQualityUserResponse>;
|
|
9451
9648
|
/**
|
|
9452
|
-
*
|
|
9649
|
+
* Get credential quality statistics for a user.
|
|
9453
9650
|
*
|
|
9454
9651
|
* @param options - An object containing the options for this method.
|
|
9455
9652
|
* @param parameters - An object containing the parameters for this method.
|
|
9456
9653
|
* @param organizationId -
|
|
9457
|
-
* @param username - User's login
|
|
9654
|
+
* @param username - User's login ID or email address.
|
|
9458
9655
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9459
9656
|
* sent with this request.
|
|
9460
9657
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9538,7 +9735,7 @@ declare namespace helpers {
|
|
|
9538
9735
|
headers?: {
|
|
9539
9736
|
[key: string]: string;
|
|
9540
9737
|
};
|
|
9541
|
-
body:
|
|
9738
|
+
body: PasswordActionRequest;
|
|
9542
9739
|
}>): Promise<Object>;
|
|
9543
9740
|
/**
|
|
9544
9741
|
* Allows the customer to authenticate when their identity provider is down.
|
|
@@ -9560,10 +9757,10 @@ declare namespace helpers {
|
|
|
9560
9757
|
headers?: {
|
|
9561
9758
|
[key: string]: string;
|
|
9562
9759
|
};
|
|
9563
|
-
body:
|
|
9760
|
+
body: PasswordActionRequest;
|
|
9564
9761
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
9565
9762
|
/**
|
|
9566
|
-
* Log a shopper
|
|
9763
|
+
* Log out a shopper.
|
|
9567
9764
|
*
|
|
9568
9765
|
* If you would like to get a raw Response object use the other logoutCustomer function.
|
|
9569
9766
|
*
|
|
@@ -9572,7 +9769,8 @@ declare namespace helpers {
|
|
|
9572
9769
|
* @param organizationId -
|
|
9573
9770
|
* @param client_id - The SLAS client ID.
|
|
9574
9771
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
9575
|
-
* @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.
|
|
9576
9774
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9577
9775
|
* sent with this request.
|
|
9578
9776
|
*
|
|
@@ -9585,20 +9783,22 @@ declare namespace helpers {
|
|
|
9585
9783
|
client_id: string;
|
|
9586
9784
|
refresh_token: string;
|
|
9587
9785
|
channel_id?: string;
|
|
9786
|
+
hint?: string;
|
|
9588
9787
|
}, ConfigParameters>;
|
|
9589
9788
|
headers?: {
|
|
9590
9789
|
[key: string]: string;
|
|
9591
9790
|
};
|
|
9592
9791
|
}>): Promise<TokenResponse>;
|
|
9593
9792
|
/**
|
|
9594
|
-
* Log a shopper
|
|
9793
|
+
* Log out a shopper.
|
|
9595
9794
|
*
|
|
9596
9795
|
* @param options - An object containing the options for this method.
|
|
9597
9796
|
* @param parameters - An object containing the parameters for this method.
|
|
9598
9797
|
* @param organizationId -
|
|
9599
9798
|
* @param client_id - The SLAS client ID.
|
|
9600
9799
|
* @param refresh_token - Refresh token that was given during the access token request.
|
|
9601
|
-
* @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.
|
|
9602
9802
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9603
9803
|
* sent with this request.
|
|
9604
9804
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9611,13 +9811,14 @@ declare namespace helpers {
|
|
|
9611
9811
|
client_id: string;
|
|
9612
9812
|
refresh_token: string;
|
|
9613
9813
|
channel_id?: string;
|
|
9814
|
+
hint?: string;
|
|
9614
9815
|
}, ConfigParameters>;
|
|
9615
9816
|
headers?: {
|
|
9616
9817
|
[key: string]: string;
|
|
9617
9818
|
};
|
|
9618
9819
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9619
9820
|
/**
|
|
9620
|
-
* 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).
|
|
9621
9822
|
*
|
|
9622
9823
|
* If you would like to get a raw Response object use the other authorizeCustomer function.
|
|
9623
9824
|
*
|
|
@@ -9625,14 +9826,14 @@ declare namespace helpers {
|
|
|
9625
9826
|
* @param parameters - An object containing the parameters for this method.
|
|
9626
9827
|
* @param organizationId -
|
|
9627
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.
|
|
9628
|
-
* @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).
|
|
9629
9830
|
* @param client_id - The client ID obtained during application registration.
|
|
9630
9831
|
* @param scope - (Not Supported)
|
|
9631
|
-
* @param state - Value to
|
|
9632
|
-
* @param usid -
|
|
9633
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
9634
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
9635
|
-
* @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.
|
|
9636
9837
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9637
9838
|
* sent with this request.
|
|
9638
9839
|
*
|
|
@@ -9657,20 +9858,20 @@ declare namespace helpers {
|
|
|
9657
9858
|
};
|
|
9658
9859
|
}>): Promise<void>;
|
|
9659
9860
|
/**
|
|
9660
|
-
* 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).
|
|
9661
9862
|
*
|
|
9662
9863
|
* @param options - An object containing the options for this method.
|
|
9663
9864
|
* @param parameters - An object containing the parameters for this method.
|
|
9664
9865
|
* @param organizationId -
|
|
9665
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.
|
|
9666
|
-
* @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).
|
|
9667
9868
|
* @param client_id - The client ID obtained during application registration.
|
|
9668
9869
|
* @param scope - (Not Supported)
|
|
9669
|
-
* @param state - Value to
|
|
9670
|
-
* @param usid -
|
|
9671
|
-
* @param hint - IDP name that can be optionally added to redirect
|
|
9672
|
-
* @param channel_id - The channel this request is for. For an ECOM request this is angalous to the site ID.
|
|
9673
|
-
* @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.
|
|
9674
9875
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9675
9876
|
* sent with this request.
|
|
9676
9877
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -9695,7 +9896,7 @@ declare namespace helpers {
|
|
|
9695
9896
|
};
|
|
9696
9897
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
9697
9898
|
/**
|
|
9698
|
-
* 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`.
|
|
9699
9900
|
*
|
|
9700
9901
|
* If you would like to get a raw Response object use the other getAccessToken function.
|
|
9701
9902
|
*
|
|
@@ -9719,7 +9920,7 @@ declare namespace helpers {
|
|
|
9719
9920
|
body: TokenRequest;
|
|
9720
9921
|
}>): Promise<TokenResponse>;
|
|
9721
9922
|
/**
|
|
9722
|
-
* 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`.
|
|
9723
9924
|
*
|
|
9724
9925
|
* @param options - An object containing the options for this method.
|
|
9725
9926
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9741,7 +9942,7 @@ declare namespace helpers {
|
|
|
9741
9942
|
body: TokenRequest;
|
|
9742
9943
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9743
9944
|
/**
|
|
9744
|
-
* 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.
|
|
9745
9946
|
*
|
|
9746
9947
|
* If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
|
|
9747
9948
|
*
|
|
@@ -9765,7 +9966,7 @@ declare namespace helpers {
|
|
|
9765
9966
|
body: TrustedSystemTokenRequest;
|
|
9766
9967
|
}>): Promise<TokenResponse>;
|
|
9767
9968
|
/**
|
|
9768
|
-
* 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.
|
|
9769
9970
|
*
|
|
9770
9971
|
* @param options - An object containing the options for this method.
|
|
9771
9972
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9786,6 +9987,98 @@ declare namespace helpers {
|
|
|
9786
9987
|
};
|
|
9787
9988
|
body: TrustedSystemTokenRequest;
|
|
9788
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>;
|
|
9789
10082
|
/**
|
|
9790
10083
|
* Issue a shopper token (JWT).
|
|
9791
10084
|
*
|
|
@@ -9808,7 +10101,7 @@ declare namespace helpers {
|
|
|
9808
10101
|
headers?: {
|
|
9809
10102
|
[key: string]: string;
|
|
9810
10103
|
};
|
|
9811
|
-
body:
|
|
10104
|
+
body: PasswordLessLoginTokenRequest;
|
|
9812
10105
|
}>): Promise<TokenResponse>;
|
|
9813
10106
|
/**
|
|
9814
10107
|
* Issue a shopper token (JWT).
|
|
@@ -9830,10 +10123,10 @@ declare namespace helpers {
|
|
|
9830
10123
|
headers?: {
|
|
9831
10124
|
[key: string]: string;
|
|
9832
10125
|
};
|
|
9833
|
-
body:
|
|
10126
|
+
body: PasswordLessLoginTokenRequest;
|
|
9834
10127
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9835
10128
|
/**
|
|
9836
|
-
* 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.
|
|
9837
10130
|
*
|
|
9838
10131
|
* If you would like to get a raw Response object use the other revokeToken function.
|
|
9839
10132
|
*
|
|
@@ -9857,7 +10150,7 @@ declare namespace helpers {
|
|
|
9857
10150
|
body: TokenActionRequest;
|
|
9858
10151
|
}>): Promise<TokenResponse>;
|
|
9859
10152
|
/**
|
|
9860
|
-
* 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.
|
|
9861
10154
|
*
|
|
9862
10155
|
* @param options - An object containing the options for this method.
|
|
9863
10156
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9879,7 +10172,7 @@ declare namespace helpers {
|
|
|
9879
10172
|
body: TokenActionRequest;
|
|
9880
10173
|
}>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
|
|
9881
10174
|
/**
|
|
9882
|
-
* 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.
|
|
9883
10176
|
*
|
|
9884
10177
|
* If you would like to get a raw Response object use the other introspectToken function.
|
|
9885
10178
|
*
|
|
@@ -9903,7 +10196,7 @@ declare namespace helpers {
|
|
|
9903
10196
|
body: TokenActionRequest;
|
|
9904
10197
|
}>): Promise<Object>;
|
|
9905
10198
|
/**
|
|
9906
|
-
* 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.
|
|
9907
10200
|
*
|
|
9908
10201
|
* @param options - An object containing the options for this method.
|
|
9909
10202
|
* @param parameters - An object containing the parameters for this method.
|
|
@@ -9925,14 +10218,14 @@ declare namespace helpers {
|
|
|
9925
10218
|
body: TokenActionRequest;
|
|
9926
10219
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
9927
10220
|
/**
|
|
9928
|
-
* Returns a JSON
|
|
10221
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
9929
10222
|
*
|
|
9930
10223
|
* If you would like to get a raw Response object use the other getUserInfo function.
|
|
9931
10224
|
*
|
|
9932
10225
|
* @param options - An object containing the options for this method.
|
|
9933
10226
|
* @param parameters - An object containing the parameters for this method.
|
|
9934
10227
|
* @param organizationId -
|
|
9935
|
-
* @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.
|
|
9936
10229
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9937
10230
|
* sent with this request.
|
|
9938
10231
|
*
|
|
@@ -9949,12 +10242,12 @@ declare namespace helpers {
|
|
|
9949
10242
|
};
|
|
9950
10243
|
}>): Promise<Object>;
|
|
9951
10244
|
/**
|
|
9952
|
-
* Returns a JSON
|
|
10245
|
+
* Returns a JSON listing of claims about the currently authenticated user.
|
|
9953
10246
|
*
|
|
9954
10247
|
* @param options - An object containing the options for this method.
|
|
9955
10248
|
* @param parameters - An object containing the parameters for this method.
|
|
9956
10249
|
* @param organizationId -
|
|
9957
|
-
* @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.
|
|
9958
10251
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
9959
10252
|
* sent with this request.
|
|
9960
10253
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -10013,7 +10306,7 @@ declare namespace helpers {
|
|
|
10013
10306
|
};
|
|
10014
10307
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
10015
10308
|
/**
|
|
10016
|
-
* 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.
|
|
10017
10310
|
*
|
|
10018
10311
|
* If you would like to get a raw Response object use the other getJwksUri function.
|
|
10019
10312
|
*
|
|
@@ -10035,7 +10328,7 @@ declare namespace helpers {
|
|
|
10035
10328
|
};
|
|
10036
10329
|
}>): Promise<Object>;
|
|
10037
10330
|
/**
|
|
10038
|
-
* 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.
|
|
10039
10332
|
*
|
|
10040
10333
|
* @param options - An object containing the options for this method.
|
|
10041
10334
|
* @param parameters - An object containing the parameters for this method.
|