@commercengine/storefront-sdk 0.13.3 → 0.14.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/MIGRATION.md +170 -0
- package/README.md +129 -53
- package/dist/index.d.mts +1763 -1382
- package/dist/index.iife.js +1598 -1359
- package/dist/index.iife.js.map +1 -1
- package/dist/index.mjs +1590 -1356
- package/dist/index.mjs.map +1 -1
- package/package.json +6 -5
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,747 @@
|
|
|
1
1
|
import createClient, { Middleware } from "openapi-fetch";
|
|
2
2
|
|
|
3
|
+
//#region src/lib/storage/token-storage.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* Token storage interface for the auth middleware
|
|
6
|
+
*/
|
|
7
|
+
interface TokenStorage {
|
|
8
|
+
getAccessToken(): Promise<string | null>;
|
|
9
|
+
setAccessToken(token: string): Promise<void>;
|
|
10
|
+
getRefreshToken(): Promise<string | null>;
|
|
11
|
+
setRefreshToken(token: string): Promise<void>;
|
|
12
|
+
clearTokens(): Promise<void>;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Simple in-memory token storage implementation
|
|
16
|
+
*/
|
|
17
|
+
declare class MemoryTokenStorage implements TokenStorage {
|
|
18
|
+
private accessToken;
|
|
19
|
+
private refreshToken;
|
|
20
|
+
getAccessToken(): Promise<string | null>;
|
|
21
|
+
setAccessToken(token: string): Promise<void>;
|
|
22
|
+
getRefreshToken(): Promise<string | null>;
|
|
23
|
+
setRefreshToken(token: string): Promise<void>;
|
|
24
|
+
clearTokens(): Promise<void>;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Browser localStorage token storage implementation
|
|
28
|
+
*/
|
|
29
|
+
declare class BrowserTokenStorage implements TokenStorage {
|
|
30
|
+
private accessTokenKey;
|
|
31
|
+
private refreshTokenKey;
|
|
32
|
+
constructor(prefix?: string);
|
|
33
|
+
getAccessToken(): Promise<string | null>;
|
|
34
|
+
setAccessToken(token: string): Promise<void>;
|
|
35
|
+
getRefreshToken(): Promise<string | null>;
|
|
36
|
+
setRefreshToken(token: string): Promise<void>;
|
|
37
|
+
clearTokens(): Promise<void>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Cookie-based token storage implementation
|
|
41
|
+
*/
|
|
42
|
+
declare class CookieTokenStorage implements TokenStorage {
|
|
43
|
+
private accessTokenKey;
|
|
44
|
+
private refreshTokenKey;
|
|
45
|
+
private options;
|
|
46
|
+
constructor(options?: CookieTokenStorageOptions);
|
|
47
|
+
getAccessToken(): Promise<string | null>;
|
|
48
|
+
setAccessToken(token: string): Promise<void>;
|
|
49
|
+
getRefreshToken(): Promise<string | null>;
|
|
50
|
+
setRefreshToken(token: string): Promise<void>;
|
|
51
|
+
clearTokens(): Promise<void>;
|
|
52
|
+
private getCookie;
|
|
53
|
+
private setCookie;
|
|
54
|
+
private deleteCookie;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Configuration options for CookieTokenStorage
|
|
58
|
+
*/
|
|
59
|
+
interface CookieTokenStorageOptions {
|
|
60
|
+
/**
|
|
61
|
+
* Prefix for cookie names (default: "storefront_")
|
|
62
|
+
*/
|
|
63
|
+
prefix?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Maximum age of cookies in seconds (default: 7 days)
|
|
66
|
+
*/
|
|
67
|
+
maxAge?: number;
|
|
68
|
+
/**
|
|
69
|
+
* Cookie path (default: "/")
|
|
70
|
+
*/
|
|
71
|
+
path?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Cookie domain (default: current domain)
|
|
74
|
+
*/
|
|
75
|
+
domain?: string;
|
|
76
|
+
/**
|
|
77
|
+
* Whether cookies should be secure (default: auto-detect based on protocol)
|
|
78
|
+
*/
|
|
79
|
+
secure?: boolean;
|
|
80
|
+
/**
|
|
81
|
+
* SameSite cookie attribute (default: "Lax")
|
|
82
|
+
*/
|
|
83
|
+
sameSite?: "Strict" | "Lax" | "None";
|
|
84
|
+
}
|
|
85
|
+
//#endregion
|
|
86
|
+
//#region src/lib/session/jwt-utils.d.ts
|
|
87
|
+
/**
|
|
88
|
+
* Channel information from JWT token
|
|
89
|
+
*/
|
|
90
|
+
interface Channel {
|
|
91
|
+
id: string;
|
|
92
|
+
name: string;
|
|
93
|
+
type: string;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* User information extracted from JWT token
|
|
97
|
+
*/
|
|
98
|
+
interface UserInfo {
|
|
99
|
+
id: string;
|
|
100
|
+
email: string | null;
|
|
101
|
+
phone: string | null;
|
|
102
|
+
username: string;
|
|
103
|
+
firstName: string | null;
|
|
104
|
+
lastName: string | null;
|
|
105
|
+
storeId: string;
|
|
106
|
+
isLoggedIn: boolean;
|
|
107
|
+
isAnonymous: boolean;
|
|
108
|
+
customerId: string | null;
|
|
109
|
+
customerGroupId: string | null;
|
|
110
|
+
anonymousId: string;
|
|
111
|
+
channel: Channel;
|
|
112
|
+
tokenExpiry: Date;
|
|
113
|
+
tokenIssuedAt: Date;
|
|
114
|
+
}
|
|
115
|
+
//#endregion
|
|
116
|
+
//#region src/lib/session/manager.d.ts
|
|
117
|
+
/**
|
|
118
|
+
* Public session helpers exposed as `sdk.session`.
|
|
119
|
+
*
|
|
120
|
+
* These methods are split into two groups:
|
|
121
|
+
* - `peek*`: passive lookups that never create or refresh tokens
|
|
122
|
+
* - `ensure*`: active helpers that may create or refresh tokens when automatic
|
|
123
|
+
* token management is enabled. They throw when no session can be established.
|
|
124
|
+
*/
|
|
125
|
+
interface StorefrontSession {
|
|
126
|
+
/**
|
|
127
|
+
* Read the current access token without creating a new session.
|
|
128
|
+
*
|
|
129
|
+
* @returns The current access token, or `null` when no token is available
|
|
130
|
+
*/
|
|
131
|
+
peekAccessToken(): Promise<string | null>;
|
|
132
|
+
/**
|
|
133
|
+
* Read the current refresh token without creating a new session.
|
|
134
|
+
*
|
|
135
|
+
* @returns The current refresh token, or `null` when no token is available
|
|
136
|
+
*/
|
|
137
|
+
peekRefreshToken(): Promise<string | null>;
|
|
138
|
+
/**
|
|
139
|
+
* Read user information from the current token without creating a new session.
|
|
140
|
+
*
|
|
141
|
+
* @returns Decoded user information, or `null` when no token is available
|
|
142
|
+
*/
|
|
143
|
+
peekUserInfo(): Promise<UserInfo | null>;
|
|
144
|
+
/**
|
|
145
|
+
* Read the current user ID without creating a new session.
|
|
146
|
+
*
|
|
147
|
+
* @returns The current user ID, or `null` when no token is available
|
|
148
|
+
*/
|
|
149
|
+
peekUserId(): Promise<string | null>;
|
|
150
|
+
/**
|
|
151
|
+
* Read the current customer ID without creating a new session.
|
|
152
|
+
*
|
|
153
|
+
* @returns The current customer ID, or `null` when no token is available
|
|
154
|
+
*/
|
|
155
|
+
peekCustomerId(): Promise<string | null>;
|
|
156
|
+
/**
|
|
157
|
+
* Read the current customer group ID without creating a new session.
|
|
158
|
+
*
|
|
159
|
+
* @returns The current customer group ID, or `null` when no token is available
|
|
160
|
+
*/
|
|
161
|
+
peekCustomerGroupId(): Promise<string | null>;
|
|
162
|
+
/**
|
|
163
|
+
* Ensure an access token is available for the current session.
|
|
164
|
+
*
|
|
165
|
+
* In managed mode, this may create an anonymous session or refresh an expired
|
|
166
|
+
* token. In manual mode, it only returns the currently configured token.
|
|
167
|
+
*
|
|
168
|
+
* @returns A usable access token
|
|
169
|
+
* @throws When no session can be established
|
|
170
|
+
*/
|
|
171
|
+
ensureAccessToken(): Promise<string>;
|
|
172
|
+
/**
|
|
173
|
+
* Ensure user information is available for the current session.
|
|
174
|
+
*
|
|
175
|
+
* @returns Decoded user information
|
|
176
|
+
* @throws When no session can be established
|
|
177
|
+
*/
|
|
178
|
+
ensureUserInfo(): Promise<UserInfo>;
|
|
179
|
+
/**
|
|
180
|
+
* Ensure a user ID is available for the current session.
|
|
181
|
+
*
|
|
182
|
+
* @returns The current user ID
|
|
183
|
+
* @throws When no session can be established
|
|
184
|
+
*/
|
|
185
|
+
ensureUserId(): Promise<string>;
|
|
186
|
+
/**
|
|
187
|
+
* Ensure a customer ID is available for the current session.
|
|
188
|
+
*
|
|
189
|
+
* @returns The current customer ID
|
|
190
|
+
* @throws When the user is anonymous or no session can be established
|
|
191
|
+
*/
|
|
192
|
+
ensureCustomerId(): Promise<string>;
|
|
193
|
+
/**
|
|
194
|
+
* Clear all known session tokens.
|
|
195
|
+
*/
|
|
196
|
+
clear(): Promise<void>;
|
|
197
|
+
}
|
|
198
|
+
interface SessionManagerOptions {
|
|
199
|
+
accessToken?: string;
|
|
200
|
+
apiKey?: string;
|
|
201
|
+
baseUrl: string;
|
|
202
|
+
onTokensCleared?: () => void;
|
|
203
|
+
onTokensUpdated?: (accessToken: string, refreshToken: string) => void;
|
|
204
|
+
refreshToken?: string;
|
|
205
|
+
tokenStorage?: TokenStorage;
|
|
206
|
+
/**
|
|
207
|
+
* Custom function to refresh tokens.
|
|
208
|
+
* When provided, this is used instead of the default fetch to `/auth/refresh-token`.
|
|
209
|
+
*/
|
|
210
|
+
refreshTokenFn?: (refreshToken: string) => Promise<{
|
|
211
|
+
access_token: string;
|
|
212
|
+
refresh_token: string;
|
|
213
|
+
}>;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Internal per-SDK session controller.
|
|
217
|
+
*
|
|
218
|
+
* A single instance is shared by all API clients created from the same
|
|
219
|
+
* `SessionStorefrontSDK`. This keeps refresh locks, token assessment, and session
|
|
220
|
+
* bootstrap logic coordinated in one place while preserving optional manual
|
|
221
|
+
* token management when `tokenStorage` is not provided.
|
|
222
|
+
*/
|
|
223
|
+
declare class StorefrontSessionManager implements StorefrontSession {
|
|
224
|
+
private readonly tokenStorage?;
|
|
225
|
+
private readonly onTokensUpdated?;
|
|
226
|
+
private readonly onTokensCleared?;
|
|
227
|
+
private readonly baseUrl;
|
|
228
|
+
private readonly refreshTokenFn?;
|
|
229
|
+
private apiKey?;
|
|
230
|
+
private accessToken;
|
|
231
|
+
private refreshToken;
|
|
232
|
+
private initializationPromise;
|
|
233
|
+
private refreshPromise;
|
|
234
|
+
private bootstrapPromise;
|
|
235
|
+
private hasAssessedTokens;
|
|
236
|
+
constructor(options: SessionManagerOptions);
|
|
237
|
+
/**
|
|
238
|
+
* Update the API key used by session bootstrap and refresh flows.
|
|
239
|
+
*/
|
|
240
|
+
setApiKey(apiKey: string): void;
|
|
241
|
+
/**
|
|
242
|
+
* Remove the API key used by session bootstrap and refresh flows.
|
|
243
|
+
*/
|
|
244
|
+
clearApiKey(): void;
|
|
245
|
+
/**
|
|
246
|
+
* Create the auth middleware used by each API client.
|
|
247
|
+
*
|
|
248
|
+
* The returned middleware shares the same session state and refresh locking
|
|
249
|
+
* across all clients attached to a single `SessionStorefrontSDK` instance.
|
|
250
|
+
*/
|
|
251
|
+
createAuthMiddleware(): Middleware;
|
|
252
|
+
/**
|
|
253
|
+
* Read the current authorization header without creating a new session.
|
|
254
|
+
*
|
|
255
|
+
* @returns A `Bearer` header value, or an empty string when no token exists
|
|
256
|
+
*/
|
|
257
|
+
getAuthorizationHeader(): Promise<string>;
|
|
258
|
+
/**
|
|
259
|
+
* Persist new session tokens.
|
|
260
|
+
*
|
|
261
|
+
* In managed mode, tokens are written to the configured token storage. In
|
|
262
|
+
* manual mode, they are stored in memory for header injection and session
|
|
263
|
+
* inspection.
|
|
264
|
+
*/
|
|
265
|
+
setTokens(accessToken: string, refreshToken?: string): Promise<void>;
|
|
266
|
+
/**
|
|
267
|
+
* Clear all session tokens managed by this controller.
|
|
268
|
+
*/
|
|
269
|
+
clearTokens(): Promise<void>;
|
|
270
|
+
/**
|
|
271
|
+
* Clear all session tokens through the public session interface.
|
|
272
|
+
*/
|
|
273
|
+
clear(): Promise<void>;
|
|
274
|
+
peekAccessToken(): Promise<string | null>;
|
|
275
|
+
peekRefreshToken(): Promise<string | null>;
|
|
276
|
+
peekUserInfo(): Promise<UserInfo | null>;
|
|
277
|
+
peekUserId(): Promise<string | null>;
|
|
278
|
+
peekCustomerId(): Promise<string | null>;
|
|
279
|
+
peekCustomerGroupId(): Promise<string | null>;
|
|
280
|
+
ensureAccessToken(): Promise<string>;
|
|
281
|
+
ensureUserInfo(): Promise<UserInfo>;
|
|
282
|
+
ensureUserId(): Promise<string>;
|
|
283
|
+
ensureCustomerId(): Promise<string>;
|
|
284
|
+
private handleRequest;
|
|
285
|
+
private handleResponse;
|
|
286
|
+
private prepareAnonymousAuthRequest;
|
|
287
|
+
private applyApiKeyHeader;
|
|
288
|
+
/**
|
|
289
|
+
* Snapshot the effective token pair from storage (managed mode) or
|
|
290
|
+
* in-memory fields (manual mode). Used before and after `setTokens()` to
|
|
291
|
+
* detect whether the tokens actually changed.
|
|
292
|
+
*/
|
|
293
|
+
private getCurrentTokenState;
|
|
294
|
+
/**
|
|
295
|
+
* Fire `onTokensUpdated` only when the effective token pair differs from
|
|
296
|
+
* the previous snapshot. This prevents duplicate notifications when
|
|
297
|
+
* `setTokens()` is called with the same values already in storage.
|
|
298
|
+
*/
|
|
299
|
+
private notifyTokensUpdatedIfChanged;
|
|
300
|
+
/**
|
|
301
|
+
* Internal token acquisition — returns null on failure instead of throwing.
|
|
302
|
+
* Used by middleware so requests degrade gracefully.
|
|
303
|
+
*/
|
|
304
|
+
private getOrCreateAccessToken;
|
|
305
|
+
private initializeManagedTokens;
|
|
306
|
+
private awaitInitialization;
|
|
307
|
+
private assessTokenStateOnce;
|
|
308
|
+
private bootstrapAnonymousSession;
|
|
309
|
+
private refreshTokens;
|
|
310
|
+
private captureTokensFromResponse;
|
|
311
|
+
private storeManagedTokens;
|
|
312
|
+
}
|
|
313
|
+
//#endregion
|
|
314
|
+
//#region ../sdk-core/dist/index.d.mts
|
|
315
|
+
//#region src/types/api.d.ts
|
|
316
|
+
/**
|
|
317
|
+
* Core API response types shared across Commerce Engine SDKs
|
|
318
|
+
*/
|
|
319
|
+
/**
|
|
320
|
+
* Standard API error response structure
|
|
321
|
+
*/
|
|
322
|
+
interface ApiErrorResponse {
|
|
323
|
+
success?: boolean;
|
|
324
|
+
error?: any;
|
|
325
|
+
code?: string;
|
|
326
|
+
message?: string;
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* Generic API result type that wraps all SDK responses
|
|
330
|
+
* Provides consistent error handling and response structure
|
|
331
|
+
*/
|
|
332
|
+
type ApiResult<T> = {
|
|
333
|
+
data: T;
|
|
334
|
+
error: null;
|
|
335
|
+
response: Response;
|
|
336
|
+
} | {
|
|
337
|
+
data: null;
|
|
338
|
+
error: ApiErrorResponse;
|
|
339
|
+
response: Response;
|
|
340
|
+
}; //#endregion
|
|
341
|
+
//#region src/types/logger.d.ts
|
|
342
|
+
/**
|
|
343
|
+
* Logger-related types for Commerce Engine SDKs
|
|
344
|
+
*/
|
|
345
|
+
/**
|
|
346
|
+
* Debug logger function interface
|
|
347
|
+
*/
|
|
348
|
+
interface DebugLoggerFn {
|
|
349
|
+
(level: "info" | "warn" | "error", message: string, data?: any): void;
|
|
350
|
+
} //#endregion
|
|
351
|
+
//#region src/types/config.d.ts
|
|
352
|
+
/**
|
|
353
|
+
* Base SDK configuration options for any OpenAPI-based SDK
|
|
354
|
+
* Completely generic - no assumptions about the underlying API
|
|
355
|
+
*/
|
|
356
|
+
interface BaseSDKOptions<TDefaultHeaders extends Record<string, any> = Record<string, any>> {
|
|
357
|
+
/**
|
|
358
|
+
* Base URL for the API
|
|
359
|
+
*/
|
|
360
|
+
baseUrl?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Optional timeout in milliseconds
|
|
363
|
+
*/
|
|
364
|
+
timeout?: number;
|
|
365
|
+
/**
|
|
366
|
+
* Default headers to include with API requests
|
|
367
|
+
* These can be overridden at the method level
|
|
368
|
+
* Generic type allows each SDK to define its supported headers
|
|
369
|
+
*/
|
|
370
|
+
defaultHeaders?: TDefaultHeaders;
|
|
371
|
+
/**
|
|
372
|
+
* Enable debug mode for detailed request/response logging
|
|
373
|
+
*/
|
|
374
|
+
debug?: boolean;
|
|
375
|
+
/**
|
|
376
|
+
* Custom logger function for debug information
|
|
377
|
+
*/
|
|
378
|
+
logger?: DebugLoggerFn;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Header configuration for SDK clients
|
|
382
|
+
* Defines supported headers and optional transformations
|
|
383
|
+
*/
|
|
384
|
+
interface HeaderConfig<T extends Record<string, any>> {
|
|
385
|
+
/**
|
|
386
|
+
* Default headers from SDK configuration
|
|
387
|
+
*/
|
|
388
|
+
defaultHeaders?: T;
|
|
389
|
+
/**
|
|
390
|
+
* Optional transformations to apply to header names
|
|
391
|
+
* Maps SDK parameter names to HTTP header names
|
|
392
|
+
*/
|
|
393
|
+
transformations?: Record<keyof T, string>;
|
|
394
|
+
} //#endregion
|
|
395
|
+
//#region src/base-client.d.ts
|
|
396
|
+
/**
|
|
397
|
+
* Generic base API client that all Commerce Engine SDKs can extend
|
|
398
|
+
* Handles common functionality like middleware setup, request execution, and header management
|
|
399
|
+
* Does NOT include token management - that's SDK-specific
|
|
400
|
+
*
|
|
401
|
+
* @template TPaths - OpenAPI paths type
|
|
402
|
+
* @template THeaders - Supported default headers type
|
|
403
|
+
*/
|
|
404
|
+
declare class BaseAPIClient<TPaths extends Record<string, any>, THeaders extends Record<string, any> = Record<string, any>> {
|
|
405
|
+
protected client: ReturnType<typeof createClient<TPaths>>;
|
|
406
|
+
protected config: BaseSDKOptions<THeaders>;
|
|
407
|
+
protected readonly baseUrl: string;
|
|
408
|
+
private readonly headerTransformations;
|
|
409
|
+
/**
|
|
410
|
+
* Create a new BaseAPIClient
|
|
411
|
+
*
|
|
412
|
+
* @param config - Configuration for the API client
|
|
413
|
+
* @param baseUrl - The base URL for the API (must be provided by subclass)
|
|
414
|
+
* @param headerTransformations - Header name transformations for this SDK
|
|
415
|
+
*/
|
|
416
|
+
constructor(config: BaseSDKOptions<THeaders>, baseUrl: string, headerTransformations?: Record<keyof THeaders, string>);
|
|
417
|
+
/**
|
|
418
|
+
* Set up all middleware for the client
|
|
419
|
+
*/
|
|
420
|
+
private setupMiddleware;
|
|
421
|
+
/**
|
|
422
|
+
* Get the base URL of the API
|
|
423
|
+
*
|
|
424
|
+
* @returns The base URL of the API
|
|
425
|
+
*/
|
|
426
|
+
getBaseUrl(): string;
|
|
427
|
+
/**
|
|
428
|
+
* Execute a request and handle the response consistently
|
|
429
|
+
* This provides unified error handling and response processing
|
|
430
|
+
*
|
|
431
|
+
* @param apiCall - Function that executes the API request
|
|
432
|
+
* @returns Promise with the API response in standardized format
|
|
433
|
+
*/
|
|
434
|
+
protected executeRequest<T, M = string, S = boolean>(apiCall: () => Promise<{
|
|
435
|
+
data?: {
|
|
436
|
+
message?: M;
|
|
437
|
+
success?: S;
|
|
438
|
+
content?: T;
|
|
439
|
+
};
|
|
440
|
+
error?: any;
|
|
441
|
+
response: Response;
|
|
442
|
+
}>): Promise<ApiResult<T>>;
|
|
443
|
+
/**
|
|
444
|
+
* Merge default headers with method-level headers
|
|
445
|
+
* Method-level headers take precedence over default headers
|
|
446
|
+
* Automatically applies SDK-specific header transformations
|
|
447
|
+
*
|
|
448
|
+
* @param methodHeaders - Headers passed to the specific method call
|
|
449
|
+
* @returns Merged headers object with proper HTTP header names
|
|
450
|
+
*/
|
|
451
|
+
protected mergeHeaders<T extends Record<string, any> = Record<string, any>>(methodHeaders?: T): T;
|
|
452
|
+
/**
|
|
453
|
+
* Set default headers for the client
|
|
454
|
+
*
|
|
455
|
+
* @param headers - Default headers to set
|
|
456
|
+
*/
|
|
457
|
+
setDefaultHeaders(headers: THeaders): void;
|
|
458
|
+
/**
|
|
459
|
+
* Get current default headers
|
|
460
|
+
*
|
|
461
|
+
* @returns Current default headers
|
|
462
|
+
*/
|
|
463
|
+
getDefaultHeaders(): THeaders | undefined;
|
|
464
|
+
} //#endregion
|
|
465
|
+
//#region src/utils/url.d.ts
|
|
466
|
+
/**
|
|
467
|
+
* Generic URL utility functions for any SDK
|
|
468
|
+
*/
|
|
469
|
+
/**
|
|
470
|
+
* Extract pathname from URL
|
|
471
|
+
* Useful for middleware that needs to inspect request paths
|
|
472
|
+
*/
|
|
473
|
+
declare function getPathnameFromUrl(url: string): string; //#endregion
|
|
474
|
+
//#region src/utils/response.d.ts
|
|
475
|
+
/**
|
|
476
|
+
* Execute a request and handle the response consistently
|
|
477
|
+
* This provides unified error handling and response processing across all SDKs
|
|
478
|
+
*
|
|
479
|
+
* @param apiCall - Function that executes the API request
|
|
480
|
+
* @returns Promise with the API response in standardized format
|
|
481
|
+
*/
|
|
482
|
+
declare function executeRequest<T, M = string, S = boolean>(apiCall: () => Promise<{
|
|
483
|
+
data?: {
|
|
484
|
+
message?: M;
|
|
485
|
+
success?: S;
|
|
486
|
+
content?: T;
|
|
487
|
+
};
|
|
488
|
+
error?: ApiErrorResponse;
|
|
489
|
+
response: Response;
|
|
490
|
+
}>): Promise<ApiResult<T>>; //#endregion
|
|
491
|
+
//#region src/middleware/debug.d.ts
|
|
492
|
+
/**
|
|
493
|
+
* Response utilities for debugging and working with Response objects
|
|
494
|
+
*/
|
|
495
|
+
declare class ResponseUtils {
|
|
496
|
+
/**
|
|
497
|
+
* Get response headers as a plain object
|
|
498
|
+
*/
|
|
499
|
+
static getHeaders(response: Response): Record<string, string>;
|
|
500
|
+
/**
|
|
501
|
+
* Get specific header value
|
|
502
|
+
*/
|
|
503
|
+
static getHeader(response: Response, name: string): string | null;
|
|
504
|
+
/**
|
|
505
|
+
* Check if response was successful
|
|
506
|
+
*/
|
|
507
|
+
static isSuccess(response: Response): boolean;
|
|
508
|
+
/**
|
|
509
|
+
* Get response metadata
|
|
510
|
+
*/
|
|
511
|
+
static getMetadata(response: Response): {
|
|
512
|
+
status: number;
|
|
513
|
+
statusText: string;
|
|
514
|
+
ok: boolean;
|
|
515
|
+
url: string;
|
|
516
|
+
redirected: boolean;
|
|
517
|
+
type: ResponseType;
|
|
518
|
+
headers: {
|
|
519
|
+
[k: string]: string;
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
/**
|
|
523
|
+
* Clone and read response as text (useful for debugging)
|
|
524
|
+
* Note: This can only be called once per response
|
|
525
|
+
*/
|
|
526
|
+
static getText(response: Response): Promise<string>;
|
|
527
|
+
/**
|
|
528
|
+
* Clone and read response as JSON (useful for debugging)
|
|
529
|
+
* Note: This can only be called once per response
|
|
530
|
+
*/
|
|
531
|
+
static getJSON(response: Response): Promise<any>;
|
|
532
|
+
/**
|
|
533
|
+
* Format response information for debugging
|
|
534
|
+
*/
|
|
535
|
+
static format(response: Response): string;
|
|
536
|
+
/**
|
|
537
|
+
* Format response for logging purposes (enhanced version)
|
|
538
|
+
*/
|
|
539
|
+
static formatResponse(response: Response): Record<string, any>;
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* Debug logging utilities
|
|
543
|
+
*/
|
|
544
|
+
declare class DebugLogger {
|
|
545
|
+
private logger;
|
|
546
|
+
constructor(logger?: DebugLoggerFn);
|
|
547
|
+
/**
|
|
548
|
+
* Log debug information about API request
|
|
549
|
+
*/
|
|
550
|
+
logRequest(request: Request, requestBody?: any): void;
|
|
551
|
+
/**
|
|
552
|
+
* Log debug information about API response
|
|
553
|
+
*/
|
|
554
|
+
logResponse(response: Response, responseBody?: any): Promise<void>;
|
|
555
|
+
/**
|
|
556
|
+
* Log error information
|
|
557
|
+
*/
|
|
558
|
+
logError(message: string, error: any): void;
|
|
559
|
+
/**
|
|
560
|
+
* Compatibility shim retained for older internal callers.
|
|
561
|
+
* Response bodies are no longer cached by the debug logger.
|
|
562
|
+
*/
|
|
563
|
+
getCachedResponseText(_url: string): string | null;
|
|
564
|
+
/**
|
|
565
|
+
* Compatibility shim retained for older internal callers.
|
|
566
|
+
* Response bodies are no longer cached by the debug logger.
|
|
567
|
+
*/
|
|
568
|
+
clearCache(): void;
|
|
569
|
+
info(message: string, data?: any): void;
|
|
570
|
+
warn(message: string, data?: any): void;
|
|
571
|
+
error(message: string, data?: any): void;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* Extract request body for logging
|
|
575
|
+
*/
|
|
576
|
+
declare function extractRequestBody(request: Request): Promise<any>;
|
|
577
|
+
/**
|
|
578
|
+
* Create debug middleware for openapi-fetch (internal use)
|
|
579
|
+
* Enhanced version that combines original functionality with duration tracking
|
|
580
|
+
*/
|
|
581
|
+
declare function createDebugMiddleware(logger?: DebugLoggerFn): Middleware; //#endregion
|
|
582
|
+
//#region src/middleware/timeout.d.ts
|
|
583
|
+
/**
|
|
584
|
+
* Timeout middleware for Commerce Engine SDKs
|
|
585
|
+
*/
|
|
586
|
+
/**
|
|
587
|
+
* Create timeout middleware for openapi-fetch
|
|
588
|
+
* Adds configurable request timeout functionality
|
|
589
|
+
*
|
|
590
|
+
* @param timeoutMs - Timeout duration in milliseconds
|
|
591
|
+
* @returns Middleware object with onRequest handler
|
|
592
|
+
*/
|
|
593
|
+
declare function createTimeoutMiddleware(timeoutMs: number): {
|
|
594
|
+
onRequest: ({
|
|
595
|
+
request
|
|
596
|
+
}: {
|
|
597
|
+
request: Request;
|
|
598
|
+
}) => Promise<Request>;
|
|
599
|
+
onResponse: ({
|
|
600
|
+
request,
|
|
601
|
+
response
|
|
602
|
+
}: {
|
|
603
|
+
request: Request;
|
|
604
|
+
response: Response;
|
|
605
|
+
}) => Promise<Response>;
|
|
606
|
+
onError: ({
|
|
607
|
+
request,
|
|
608
|
+
error
|
|
609
|
+
}: {
|
|
610
|
+
request: Request;
|
|
611
|
+
error: unknown;
|
|
612
|
+
}) => Promise<never>;
|
|
613
|
+
}; //#endregion
|
|
614
|
+
//#region src/middleware/headers.d.ts
|
|
615
|
+
/**
|
|
616
|
+
* Header transformation and merging utilities for Commerce Engine SDKs
|
|
617
|
+
*/
|
|
618
|
+
/**
|
|
619
|
+
* Merge two header objects
|
|
620
|
+
* Method-level headers take precedence over default headers
|
|
621
|
+
*
|
|
622
|
+
* @param defaultHeaders - Default headers from SDK configuration
|
|
623
|
+
* @param methodHeaders - Headers passed to the specific method call
|
|
624
|
+
* @returns Merged headers object
|
|
625
|
+
*/
|
|
626
|
+
declare function mergeHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: Record<string, any>, methodHeaders?: T): T;
|
|
627
|
+
/**
|
|
628
|
+
* Transform headers using a transformation mapping
|
|
629
|
+
* Headers not in the transformation map are passed through unchanged
|
|
630
|
+
*
|
|
631
|
+
* @param headers - Headers object with original names
|
|
632
|
+
* @param transformations - Mapping of original names to transformed names
|
|
633
|
+
* @returns Headers object with transformed names
|
|
634
|
+
*/
|
|
635
|
+
declare function transformHeaders(headers: Record<string, any>, transformations: Record<string, string>): Record<string, string>;
|
|
636
|
+
/**
|
|
637
|
+
* Merge headers with transformation support
|
|
638
|
+
* Transforms default headers, then merges with method headers
|
|
639
|
+
*
|
|
640
|
+
* @param defaultHeaders - Default headers from SDK configuration
|
|
641
|
+
* @param methodHeaders - Headers passed to the specific method call
|
|
642
|
+
* @param transformations - Mapping for header name transformations
|
|
643
|
+
* @returns Merged headers object with transformations applied
|
|
644
|
+
*/
|
|
645
|
+
declare function mergeAndTransformHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: Record<string, any>, methodHeaders?: T, transformations?: Record<string, string>): T; //#endregion
|
|
646
|
+
//#endregion
|
|
647
|
+
//#region src/lib/shared/url-utils.d.ts
|
|
648
|
+
/**
|
|
649
|
+
* URL utility functions for the Storefront SDK
|
|
650
|
+
*/
|
|
651
|
+
/**
|
|
652
|
+
* Available API environments for Commerce Engine
|
|
653
|
+
*/
|
|
654
|
+
declare enum Environment {
|
|
655
|
+
/**
|
|
656
|
+
* Staging environment
|
|
657
|
+
*/
|
|
658
|
+
Staging = "staging",
|
|
659
|
+
/**
|
|
660
|
+
* Production environment
|
|
661
|
+
*/
|
|
662
|
+
Production = "production"
|
|
663
|
+
}
|
|
664
|
+
//#endregion
|
|
665
|
+
//#region src/lib/shared/sdk-types.d.ts
|
|
666
|
+
/**
|
|
667
|
+
* Supported default headers that can be set at the SDK level
|
|
668
|
+
* Only includes headers that are actually supported by API endpoints
|
|
669
|
+
*/
|
|
670
|
+
interface SupportedDefaultHeaders {
|
|
671
|
+
/**
|
|
672
|
+
* Customer group ID used for pricing, promotions, and subscription rates
|
|
673
|
+
* If not provided, the API will use default pricing
|
|
674
|
+
*/
|
|
675
|
+
customer_group_id?: string;
|
|
676
|
+
/**
|
|
677
|
+
* Debug mode header
|
|
678
|
+
*/
|
|
679
|
+
debug_mode?: boolean;
|
|
680
|
+
}
|
|
681
|
+
/**
|
|
682
|
+
* SDK initialization options for the public Storefront API surface
|
|
683
|
+
* Extends the generic BaseSDKOptions with Commerce Engine configuration
|
|
684
|
+
*/
|
|
685
|
+
interface PublicStorefrontSDKOptions extends BaseSDKOptions<SupportedDefaultHeaders> {
|
|
686
|
+
/**
|
|
687
|
+
* Store ID for the API requests
|
|
688
|
+
*/
|
|
689
|
+
storeId: string;
|
|
690
|
+
/**
|
|
691
|
+
* Environment to use (defaults to Production)
|
|
692
|
+
* Overrides baseUrl if provided
|
|
693
|
+
*/
|
|
694
|
+
environment?: Environment;
|
|
695
|
+
/**
|
|
696
|
+
* Custom base URL (overrides environment if provided)
|
|
697
|
+
* If not provided, will be built from storeId and environment
|
|
698
|
+
*/
|
|
699
|
+
baseUrl?: string;
|
|
700
|
+
/**
|
|
701
|
+
* X-Api-Key used for public storefront requests
|
|
702
|
+
*/
|
|
703
|
+
apiKey?: string;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* SDK initialization options for the session-aware Storefront API
|
|
707
|
+
* Extends the generic BaseSDKOptions with Commerce Engine and auth-specific features
|
|
708
|
+
*/
|
|
709
|
+
interface SessionStorefrontSDKOptions extends PublicStorefrontSDKOptions {
|
|
710
|
+
/**
|
|
711
|
+
* Optional initial access token
|
|
712
|
+
* - If tokenStorage is provided: Used as initial token value, then managed automatically
|
|
713
|
+
* - If tokenStorage is not provided: Used for manual token management
|
|
714
|
+
*/
|
|
715
|
+
accessToken?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Optional initial refresh token
|
|
718
|
+
* - Only used when tokenStorage is provided
|
|
719
|
+
* - Allows initialization with both access and refresh tokens
|
|
720
|
+
*/
|
|
721
|
+
refreshToken?: string;
|
|
722
|
+
/**
|
|
723
|
+
* Optional token storage for automatic token management
|
|
724
|
+
* If provided, enables automatic token refresh and management
|
|
725
|
+
*/
|
|
726
|
+
tokenStorage?: TokenStorage;
|
|
727
|
+
/**
|
|
728
|
+
* Callback when tokens are updated (login/refresh)
|
|
729
|
+
*/
|
|
730
|
+
onTokensUpdated?: (accessToken: string, refreshToken: string) => void;
|
|
731
|
+
/**
|
|
732
|
+
* Callback when tokens are cleared (logout/error)
|
|
733
|
+
*/
|
|
734
|
+
onTokensCleared?: () => void;
|
|
735
|
+
/**
|
|
736
|
+
* Custom function to refresh tokens.
|
|
737
|
+
* When provided, this is used instead of the default fetch to `/auth/refresh-token`.
|
|
738
|
+
*/
|
|
739
|
+
refreshTokenFn?: (refreshToken: string) => Promise<{
|
|
740
|
+
access_token: string;
|
|
741
|
+
refresh_token: string;
|
|
742
|
+
}>;
|
|
743
|
+
}
|
|
744
|
+
//#endregion
|
|
3
745
|
//#region src/types/storefront.d.ts
|
|
4
746
|
/**
|
|
5
747
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -382,34 +1124,6 @@ interface paths {
|
|
|
382
1124
|
patch?: never;
|
|
383
1125
|
trace?: never;
|
|
384
1126
|
};
|
|
385
|
-
"/auth/user/{id}/notification-preferences": {
|
|
386
|
-
parameters: {
|
|
387
|
-
query?: never;
|
|
388
|
-
header?: never;
|
|
389
|
-
path?: never;
|
|
390
|
-
cookie?: never;
|
|
391
|
-
};
|
|
392
|
-
/**
|
|
393
|
-
* Retrieve user notification preferences
|
|
394
|
-
* @description Retrieves the notification preferences for a user.
|
|
395
|
-
*/
|
|
396
|
-
get: operations["get-notification-preferences"];
|
|
397
|
-
/**
|
|
398
|
-
* Update user notification preferences
|
|
399
|
-
* @description Updates notification preferences for a user.
|
|
400
|
-
*/
|
|
401
|
-
put: operations["update-notification-preferences"];
|
|
402
|
-
/**
|
|
403
|
-
* Create user notification preferences
|
|
404
|
-
* @description Creates notification preferences for a user.
|
|
405
|
-
*/
|
|
406
|
-
post: operations["create-notification-preferences"];
|
|
407
|
-
delete?: never;
|
|
408
|
-
options?: never;
|
|
409
|
-
head?: never;
|
|
410
|
-
patch?: never;
|
|
411
|
-
trace?: never;
|
|
412
|
-
};
|
|
413
1127
|
"/auth/user/{id}/profile-image": {
|
|
414
1128
|
parameters: {
|
|
415
1129
|
query?: never;
|
|
@@ -962,7 +1676,7 @@ interface paths {
|
|
|
962
1676
|
patch?: never;
|
|
963
1677
|
trace?: never;
|
|
964
1678
|
};
|
|
965
|
-
"/catalog/marketplace/products/{
|
|
1679
|
+
"/catalog/marketplace/products/{product_id}": {
|
|
966
1680
|
parameters: {
|
|
967
1681
|
query?: never;
|
|
968
1682
|
header?: never;
|
|
@@ -971,7 +1685,7 @@ interface paths {
|
|
|
971
1685
|
};
|
|
972
1686
|
/**
|
|
973
1687
|
* Retrieve a product detail
|
|
974
|
-
* @description Retrieves the details of an existing product.
|
|
1688
|
+
* @description Retrieves the details of an existing marketplace product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product information.
|
|
975
1689
|
*/
|
|
976
1690
|
get: operations["get-marketplace-product-detail"];
|
|
977
1691
|
put?: never;
|
|
@@ -1015,7 +1729,7 @@ interface paths {
|
|
|
1015
1729
|
};
|
|
1016
1730
|
/**
|
|
1017
1731
|
* Retrieve product variants
|
|
1018
|
-
* @description Retrieves the variants of an existing product.
|
|
1732
|
+
* @description Retrieves the variants of an existing marketplace product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product variants information.
|
|
1019
1733
|
*/
|
|
1020
1734
|
get: operations["list-marketplace-product-variants"];
|
|
1021
1735
|
put?: never;
|
|
@@ -1035,7 +1749,7 @@ interface paths {
|
|
|
1035
1749
|
};
|
|
1036
1750
|
/**
|
|
1037
1751
|
* Retrieve variant detail
|
|
1038
|
-
* @description Retrieves the details of a particular variant.
|
|
1752
|
+
* @description Retrieves the details of a particular marketplace variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
|
|
1039
1753
|
*/
|
|
1040
1754
|
get: operations["get-marketplace-variant-detail"];
|
|
1041
1755
|
put?: never;
|
|
@@ -1075,7 +1789,7 @@ interface paths {
|
|
|
1075
1789
|
};
|
|
1076
1790
|
/**
|
|
1077
1791
|
* List all products
|
|
1078
|
-
* @description Returns a list of
|
|
1792
|
+
* @description Returns a paginated list of `Product` objects sorted by creation date (newest first). Pass `x-customer-group-id` header to retrieve group-specific pricing.
|
|
1079
1793
|
*/
|
|
1080
1794
|
get: operations["list-products"];
|
|
1081
1795
|
put?: never;
|
|
@@ -1166,7 +1880,7 @@ interface paths {
|
|
|
1166
1880
|
patch?: never;
|
|
1167
1881
|
trace?: never;
|
|
1168
1882
|
};
|
|
1169
|
-
"/catalog/products/{
|
|
1883
|
+
"/catalog/products/{product_id}": {
|
|
1170
1884
|
parameters: {
|
|
1171
1885
|
query?: never;
|
|
1172
1886
|
header?: never;
|
|
@@ -1175,7 +1889,7 @@ interface paths {
|
|
|
1175
1889
|
};
|
|
1176
1890
|
/**
|
|
1177
1891
|
* Retrieve a product detail
|
|
1178
|
-
* @description Retrieves
|
|
1892
|
+
* @description Retrieves a single `ProductDetail` object by product ID or slug. Product slug is supported in place of product ID in the path. Includes full pricing, variants, images, attributes, and promotion data.
|
|
1179
1893
|
*/
|
|
1180
1894
|
get: operations["get-product-detail"];
|
|
1181
1895
|
put?: never;
|
|
@@ -1219,7 +1933,7 @@ interface paths {
|
|
|
1219
1933
|
};
|
|
1220
1934
|
/**
|
|
1221
1935
|
* Retrieve product variants
|
|
1222
|
-
* @description Retrieves the variants of an existing product.
|
|
1936
|
+
* @description Retrieves the variants of an existing product. Returns the corresponding variant list. Product slug is supported in place of product ID in the path.
|
|
1223
1937
|
*/
|
|
1224
1938
|
get: operations["list-product-variants"];
|
|
1225
1939
|
put?: never;
|
|
@@ -1239,7 +1953,7 @@ interface paths {
|
|
|
1239
1953
|
};
|
|
1240
1954
|
/**
|
|
1241
1955
|
* Retrieve variant detail
|
|
1242
|
-
* @description Retrieves the details of a particular variant.
|
|
1956
|
+
* @description Retrieves the details of a particular variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
|
|
1243
1957
|
*/
|
|
1244
1958
|
get: operations["get-variant-detail"];
|
|
1245
1959
|
put?: never;
|
|
@@ -1330,50 +2044,72 @@ interface paths {
|
|
|
1330
2044
|
patch?: never;
|
|
1331
2045
|
trace?: never;
|
|
1332
2046
|
};
|
|
1333
|
-
"/customers/{customer_id}/
|
|
2047
|
+
"/customers/{customer_id}/addresses": {
|
|
1334
2048
|
parameters: {
|
|
1335
2049
|
query?: never;
|
|
1336
2050
|
header?: never;
|
|
1337
|
-
path
|
|
1338
|
-
/** @description Customer Id */customer_id: string;
|
|
1339
|
-
};
|
|
2051
|
+
path?: never;
|
|
1340
2052
|
cookie?: never;
|
|
1341
2053
|
};
|
|
1342
2054
|
/**
|
|
1343
|
-
*
|
|
1344
|
-
* @description Retrieve
|
|
2055
|
+
* Retrieve all addresses
|
|
2056
|
+
* @description Retrieve billing and shipping address of particular customer
|
|
1345
2057
|
*/
|
|
1346
|
-
get: operations["list-
|
|
2058
|
+
get: operations["list-addresses"];
|
|
1347
2059
|
put?: never;
|
|
1348
|
-
|
|
2060
|
+
/**
|
|
2061
|
+
* Create address
|
|
2062
|
+
* @description Add new address
|
|
2063
|
+
*/
|
|
2064
|
+
post: operations["create-address"];
|
|
1349
2065
|
delete?: never;
|
|
1350
2066
|
options?: never;
|
|
1351
2067
|
head?: never;
|
|
1352
2068
|
patch?: never;
|
|
1353
2069
|
trace?: never;
|
|
1354
2070
|
};
|
|
1355
|
-
"/customers/{customer_id}/
|
|
2071
|
+
"/customers/{customer_id}/addresses/{address_id}": {
|
|
1356
2072
|
parameters: {
|
|
1357
2073
|
query?: never;
|
|
1358
2074
|
header?: never;
|
|
1359
|
-
path
|
|
1360
|
-
/** @description Customer Id */customer_id: string;
|
|
1361
|
-
};
|
|
2075
|
+
path?: never;
|
|
1362
2076
|
cookie?: never;
|
|
1363
2077
|
};
|
|
1364
2078
|
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @description
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
2079
|
+
* Retrieve particular address
|
|
2080
|
+
* @description Retrieve address
|
|
2081
|
+
*/
|
|
2082
|
+
get: operations["get-address-detail"];
|
|
2083
|
+
/**
|
|
2084
|
+
* Update particular address
|
|
2085
|
+
* @description Update address
|
|
2086
|
+
*/
|
|
2087
|
+
put: operations["update-address-detail"];
|
|
2088
|
+
post?: never;
|
|
2089
|
+
/**
|
|
2090
|
+
* Remove particular address
|
|
2091
|
+
* @description Delete address
|
|
2092
|
+
*/
|
|
2093
|
+
delete: operations["delete-address"];
|
|
2094
|
+
options?: never;
|
|
2095
|
+
head?: never;
|
|
2096
|
+
patch?: never;
|
|
2097
|
+
trace?: never;
|
|
2098
|
+
};
|
|
2099
|
+
"/customers/{customer_id}/cards": {
|
|
2100
|
+
parameters: {
|
|
2101
|
+
query?: never;
|
|
2102
|
+
header?: never;
|
|
2103
|
+
path: {
|
|
2104
|
+
/** @description Customer Id */customer_id: string;
|
|
2105
|
+
};
|
|
2106
|
+
cookie?: never;
|
|
2107
|
+
};
|
|
2108
|
+
/**
|
|
2109
|
+
* List all saved cards
|
|
2110
|
+
* @description Retrieve a list of saved payment cards for a given customer.
|
|
1375
2111
|
*/
|
|
1376
|
-
get: operations["list-
|
|
2112
|
+
get: operations["list-customer-cards"];
|
|
1377
2113
|
put?: never;
|
|
1378
2114
|
post?: never;
|
|
1379
2115
|
delete?: never;
|
|
@@ -1382,12 +2118,12 @@ interface paths {
|
|
|
1382
2118
|
patch?: never;
|
|
1383
2119
|
trace?: never;
|
|
1384
2120
|
};
|
|
1385
|
-
"/customers/{
|
|
2121
|
+
"/customers/{customer_id}/documents": {
|
|
1386
2122
|
parameters: {
|
|
1387
2123
|
query?: never;
|
|
1388
2124
|
header?: never;
|
|
1389
2125
|
path: {
|
|
1390
|
-
/** @description customer id */
|
|
2126
|
+
/** @description customer id */customer_id: string;
|
|
1391
2127
|
};
|
|
1392
2128
|
cookie?: never;
|
|
1393
2129
|
};
|
|
@@ -1408,12 +2144,12 @@ interface paths {
|
|
|
1408
2144
|
patch?: never;
|
|
1409
2145
|
trace?: never;
|
|
1410
2146
|
};
|
|
1411
|
-
"/customers/{
|
|
2147
|
+
"/customers/{customer_id}/documents/verify": {
|
|
1412
2148
|
parameters: {
|
|
1413
2149
|
query?: never;
|
|
1414
2150
|
header?: never;
|
|
1415
2151
|
path: {
|
|
1416
|
-
/** @description customer id */
|
|
2152
|
+
/** @description customer id */customer_id: string;
|
|
1417
2153
|
};
|
|
1418
2154
|
cookie?: never;
|
|
1419
2155
|
};
|
|
@@ -1430,13 +2166,13 @@ interface paths {
|
|
|
1430
2166
|
patch?: never;
|
|
1431
2167
|
trace?: never;
|
|
1432
2168
|
};
|
|
1433
|
-
"/customers/{
|
|
2169
|
+
"/customers/{customer_id}/documents/{document_id}": {
|
|
1434
2170
|
parameters: {
|
|
1435
2171
|
query?: never;
|
|
1436
2172
|
header?: never;
|
|
1437
2173
|
path: {
|
|
1438
|
-
/** @description
|
|
1439
|
-
|
|
2174
|
+
/** @description customer id */customer_id: string; /** @description document id */
|
|
2175
|
+
document_id: string;
|
|
1440
2176
|
};
|
|
1441
2177
|
cookie?: never;
|
|
1442
2178
|
};
|
|
@@ -1461,7 +2197,7 @@ interface paths {
|
|
|
1461
2197
|
patch?: never;
|
|
1462
2198
|
trace?: never;
|
|
1463
2199
|
};
|
|
1464
|
-
"/customers/{
|
|
2200
|
+
"/customers/{customer_id}/loyalty": {
|
|
1465
2201
|
parameters: {
|
|
1466
2202
|
query?: never;
|
|
1467
2203
|
header?: never;
|
|
@@ -1469,51 +2205,19 @@ interface paths {
|
|
|
1469
2205
|
cookie?: never;
|
|
1470
2206
|
};
|
|
1471
2207
|
/**
|
|
1472
|
-
* Retrieve
|
|
1473
|
-
* @description Retrieve
|
|
2208
|
+
* Retrieve loyalty details
|
|
2209
|
+
* @description Retrieve loyalty details
|
|
1474
2210
|
*/
|
|
1475
|
-
get: operations["
|
|
2211
|
+
get: operations["get-loyalty-details"];
|
|
1476
2212
|
put?: never;
|
|
1477
|
-
/**
|
|
1478
|
-
* Create address
|
|
1479
|
-
* @description Add new address
|
|
1480
|
-
*/
|
|
1481
|
-
post: operations["create-address"];
|
|
1482
|
-
delete?: never;
|
|
1483
|
-
options?: never;
|
|
1484
|
-
head?: never;
|
|
1485
|
-
patch?: never;
|
|
1486
|
-
trace?: never;
|
|
1487
|
-
};
|
|
1488
|
-
"/customers/{user_id}/addresses/{address_id}": {
|
|
1489
|
-
parameters: {
|
|
1490
|
-
query?: never;
|
|
1491
|
-
header?: never;
|
|
1492
|
-
path?: never;
|
|
1493
|
-
cookie?: never;
|
|
1494
|
-
};
|
|
1495
|
-
/**
|
|
1496
|
-
* Retrieve particular address
|
|
1497
|
-
* @description Retrieve address
|
|
1498
|
-
*/
|
|
1499
|
-
get: operations["get-address-detail"];
|
|
1500
|
-
/**
|
|
1501
|
-
* Update particular address
|
|
1502
|
-
* @description Update address
|
|
1503
|
-
*/
|
|
1504
|
-
put: operations["update-address-detail"];
|
|
1505
2213
|
post?: never;
|
|
1506
|
-
|
|
1507
|
-
* Remove particular address
|
|
1508
|
-
* @description Delete address
|
|
1509
|
-
*/
|
|
1510
|
-
delete: operations["delete-address"];
|
|
2214
|
+
delete?: never;
|
|
1511
2215
|
options?: never;
|
|
1512
2216
|
head?: never;
|
|
1513
2217
|
patch?: never;
|
|
1514
2218
|
trace?: never;
|
|
1515
2219
|
};
|
|
1516
|
-
"/customers/{
|
|
2220
|
+
"/customers/{customer_id}/loyalty-points-activity": {
|
|
1517
2221
|
parameters: {
|
|
1518
2222
|
query?: never;
|
|
1519
2223
|
header?: never;
|
|
@@ -1521,10 +2225,10 @@ interface paths {
|
|
|
1521
2225
|
cookie?: never;
|
|
1522
2226
|
};
|
|
1523
2227
|
/**
|
|
1524
|
-
*
|
|
1525
|
-
* @description
|
|
2228
|
+
* List all loyalty points activity
|
|
2229
|
+
* @description List all loyalty points activity
|
|
1526
2230
|
*/
|
|
1527
|
-
get: operations["
|
|
2231
|
+
get: operations["list-loyalty-activities"];
|
|
1528
2232
|
put?: never;
|
|
1529
2233
|
post?: never;
|
|
1530
2234
|
delete?: never;
|
|
@@ -1533,18 +2237,28 @@ interface paths {
|
|
|
1533
2237
|
patch?: never;
|
|
1534
2238
|
trace?: never;
|
|
1535
2239
|
};
|
|
1536
|
-
"/customers/{
|
|
2240
|
+
"/customers/{customer_id}/payment-methods": {
|
|
1537
2241
|
parameters: {
|
|
1538
2242
|
query?: never;
|
|
1539
2243
|
header?: never;
|
|
1540
|
-
path
|
|
2244
|
+
path: {
|
|
2245
|
+
/** @description Customer Id */customer_id: string;
|
|
2246
|
+
};
|
|
1541
2247
|
cookie?: never;
|
|
1542
2248
|
};
|
|
1543
2249
|
/**
|
|
1544
|
-
* List all
|
|
1545
|
-
* @description
|
|
2250
|
+
* List all saved payment methods
|
|
2251
|
+
* @description This endpoint acts as a proxy for JusPay's Fetch Saved Payment Methods API. It enables to securely retrieve a list of payment methods (such as saved cards, UPI handles, wallets) that have been previously stored for a given customer.
|
|
2252
|
+
*
|
|
2253
|
+
* The operation helps streamline the checkout flow by allowing users to quickly select from existing payment methods, reducing input friction and improving conversion.
|
|
2254
|
+
*
|
|
2255
|
+
* You can filter the results by payment method type using the payment_method query parameter. Multiple payment methods can be specified by separating them with commas (e.g., payment_method=upi_collect,card,wallet).
|
|
2256
|
+
*
|
|
2257
|
+
* API documentation of JusPay can be found at below link:
|
|
2258
|
+
*
|
|
2259
|
+
* https://juspay.io/in/docs/api-reference/docs/express-checkout/fetch-saved-payment-methods
|
|
1546
2260
|
*/
|
|
1547
|
-
get: operations["list-
|
|
2261
|
+
get: operations["list-saved-payment-methods"];
|
|
1548
2262
|
put?: never;
|
|
1549
2263
|
post?: never;
|
|
1550
2264
|
delete?: never;
|
|
@@ -1553,7 +2267,7 @@ interface paths {
|
|
|
1553
2267
|
patch?: never;
|
|
1554
2268
|
trace?: never;
|
|
1555
2269
|
};
|
|
1556
|
-
"/customers/{
|
|
2270
|
+
"/customers/{customer_id}/reviews": {
|
|
1557
2271
|
parameters: {
|
|
1558
2272
|
query?: never;
|
|
1559
2273
|
header?: never;
|
|
@@ -1564,7 +2278,7 @@ interface paths {
|
|
|
1564
2278
|
* Retrieve all reviews
|
|
1565
2279
|
* @description Retrieve all reviews
|
|
1566
2280
|
*/
|
|
1567
|
-
get: operations["list-
|
|
2281
|
+
get: operations["list-customer-reviews"];
|
|
1568
2282
|
put?: never;
|
|
1569
2283
|
post?: never;
|
|
1570
2284
|
delete?: never;
|
|
@@ -2575,7 +3289,7 @@ interface paths {
|
|
|
2575
3289
|
patch?: never;
|
|
2576
3290
|
trace?: never;
|
|
2577
3291
|
};
|
|
2578
|
-
"/pos/catalog/products/{
|
|
3292
|
+
"/pos/catalog/products/{product_id}": {
|
|
2579
3293
|
parameters: {
|
|
2580
3294
|
query?: never;
|
|
2581
3295
|
header?: never;
|
|
@@ -2584,7 +3298,7 @@ interface paths {
|
|
|
2584
3298
|
};
|
|
2585
3299
|
/**
|
|
2586
3300
|
* Retrieve a product detail
|
|
2587
|
-
* @description Retrieves the details of an existing product.
|
|
3301
|
+
* @description Retrieves the details of an existing product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product information.
|
|
2588
3302
|
*/
|
|
2589
3303
|
get: operations["pos-get-product-detail"];
|
|
2590
3304
|
put?: never;
|
|
@@ -2624,7 +3338,7 @@ interface paths {
|
|
|
2624
3338
|
};
|
|
2625
3339
|
/**
|
|
2626
3340
|
* Retrieve product variants
|
|
2627
|
-
* @description Retrieves the variants of an existing product.
|
|
3341
|
+
* @description Retrieves the variants of an existing product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product variants information.
|
|
2628
3342
|
*/
|
|
2629
3343
|
get: operations["pos-list-product-variants"];
|
|
2630
3344
|
put?: never;
|
|
@@ -2644,7 +3358,7 @@ interface paths {
|
|
|
2644
3358
|
};
|
|
2645
3359
|
/**
|
|
2646
3360
|
* Retrieve variant detail
|
|
2647
|
-
* @description Retrieves the details of a particular variant.
|
|
3361
|
+
* @description Retrieves the details of a particular variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
|
|
2648
3362
|
*/
|
|
2649
3363
|
get: operations["pos-get-variant-detail"];
|
|
2650
3364
|
put?: never;
|
|
@@ -2883,8 +3597,8 @@ interface paths {
|
|
|
2883
3597
|
cookie?: never;
|
|
2884
3598
|
};
|
|
2885
3599
|
/**
|
|
2886
|
-
* List
|
|
2887
|
-
* @description
|
|
3600
|
+
* List KYC documents
|
|
3601
|
+
* @description Retrieves the list of KYC document types required for the store. Returns an array of `Kyc Document` objects defining document types, mandatory flags, and verification settings.
|
|
2888
3602
|
*/
|
|
2889
3603
|
get: operations["list-kyc-document"];
|
|
2890
3604
|
put?: never;
|
|
@@ -4065,7 +4779,8 @@ interface components {
|
|
|
4065
4779
|
product_id: string;
|
|
4066
4780
|
variant_id: string | null;
|
|
4067
4781
|
sku: string;
|
|
4068
|
-
|
|
4782
|
+
product_slug: string;
|
|
4783
|
+
variant_slug: string;
|
|
4069
4784
|
product_name: string;
|
|
4070
4785
|
variant_name: string | null;
|
|
4071
4786
|
/**
|
|
@@ -4443,16 +5158,6 @@ interface components {
|
|
|
4443
5158
|
pm_response_description: string;
|
|
4444
5159
|
supported_reference_ids: string[];
|
|
4445
5160
|
wallet_direct_debit_support?: boolean;
|
|
4446
|
-
}; /** KycDocument */
|
|
4447
|
-
KycDocument: {
|
|
4448
|
-
id?: $Read<string>; /** @enum {unknown} */
|
|
4449
|
-
document_type?: "gst" | "pan" | "tin" | "cin" | "other";
|
|
4450
|
-
title?: string;
|
|
4451
|
-
description?: string | null; /** @default true */
|
|
4452
|
-
active: boolean;
|
|
4453
|
-
is_mandatory?: boolean;
|
|
4454
|
-
is_attachment_required?: boolean; /** @enum {unknown} */
|
|
4455
|
-
verification_type?: "auto" | "manual";
|
|
4456
5161
|
}; /** KycDocumentConfig */
|
|
4457
5162
|
KycDocumentConfig: {
|
|
4458
5163
|
id: $Read<string>; /** @enum {unknown} */
|
|
@@ -4510,11 +5215,7 @@ interface components {
|
|
|
4510
5215
|
seller_id: string;
|
|
4511
5216
|
seller_detail: components["schemas"]["SellerInfo"];
|
|
4512
5217
|
}; /** MarketplaceProductDetail */
|
|
4513
|
-
MarketplaceProductDetail: components["schemas"]["Product"] & components["schemas"]["AdditionalProductDetails"];
|
|
4514
|
-
MeasurementUnit: {
|
|
4515
|
-
/** @enum {unknown} */weight?: "gm"; /** @enum {unknown} */
|
|
4516
|
-
dimension?: "cm";
|
|
4517
|
-
};
|
|
5218
|
+
MarketplaceProductDetail: components["schemas"]["Product"] & components["schemas"]["AdditionalProductDetails"];
|
|
4518
5219
|
/**
|
|
4519
5220
|
* MultiSelectAttribute
|
|
4520
5221
|
* @description Attribute for multi-select values
|
|
@@ -4840,6 +5541,10 @@ interface components {
|
|
|
4840
5541
|
modified_at?: string; /** @description Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
4841
5542
|
seller_id?: string | null; /** @description Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores. */
|
|
4842
5543
|
seller_detail?: components["schemas"]["SellerInfo"] | null;
|
|
5544
|
+
}; /** OtpContent */
|
|
5545
|
+
OtpContent: {
|
|
5546
|
+
/** @description Token to pass to the verify-otp endpoint along with the OTP. */otp_token: string; /** @description Action type to pass to the verify-otp endpoint. */
|
|
5547
|
+
otp_action: string;
|
|
4843
5548
|
};
|
|
4844
5549
|
/**
|
|
4845
5550
|
* @description pagination metadata structure
|
|
@@ -5471,9 +6176,15 @@ interface components {
|
|
|
5471
6176
|
SellerReviewStats: {
|
|
5472
6177
|
rating_sum?: number;
|
|
5473
6178
|
count?: number;
|
|
6179
|
+
}; /** SendOtpWithEmail */
|
|
6180
|
+
SendOtpWithEmail: {
|
|
6181
|
+
email: string;
|
|
6182
|
+
}; /** SendOtpWithPhone */
|
|
6183
|
+
SendOtpWithPhone: {
|
|
6184
|
+
/** @description 10 digit phone number without country code. */phone: string; /** @description Two-letter code with plus sign prefix (e.g. +91). Defaults to +91 if omitted. Use with `phone` only. */
|
|
6185
|
+
country_code?: string;
|
|
5474
6186
|
}; /** Seo */
|
|
5475
6187
|
Seo: {
|
|
5476
|
-
slug: string;
|
|
5477
6188
|
title: string | null;
|
|
5478
6189
|
description: string | null;
|
|
5479
6190
|
keywords: string[] | null;
|
|
@@ -5535,7 +6246,6 @@ interface components {
|
|
|
5535
6246
|
kyc_documents: $Read<components["schemas"]["KycDocumentConfig"][]>;
|
|
5536
6247
|
analytics_providers: $Read<components["schemas"]["AnalyticsProvider"][]>;
|
|
5537
6248
|
payment_providers: $Read<components["schemas"]["PaymentProvider"][]>;
|
|
5538
|
-
measurement: components["schemas"]["MeasurementUnit"];
|
|
5539
6249
|
terms_of_service: components["schemas"]["StoreTemplate"];
|
|
5540
6250
|
refund_policy: components["schemas"]["StoreTemplate"];
|
|
5541
6251
|
}; /** StoreTemplate */
|
|
@@ -6063,21 +6773,15 @@ interface operations {
|
|
|
6063
6773
|
"forgot-password": {
|
|
6064
6774
|
parameters: {
|
|
6065
6775
|
query?: never;
|
|
6066
|
-
header?:
|
|
6776
|
+
header?: {
|
|
6777
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
6778
|
+
};
|
|
6067
6779
|
path?: never;
|
|
6068
6780
|
cookie?: never;
|
|
6069
6781
|
};
|
|
6070
6782
|
requestBody: {
|
|
6071
6783
|
content: {
|
|
6072
|
-
"application/json":
|
|
6073
|
-
/** @description A string representing the email address. */email: string; /** @description 10 digit phone number without country code. */
|
|
6074
|
-
phone: string;
|
|
6075
|
-
/**
|
|
6076
|
-
* @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
|
|
6077
|
-
* Use this key along with phone. Not necessary for email.
|
|
6078
|
-
*/
|
|
6079
|
-
country_code: string;
|
|
6080
|
-
};
|
|
6784
|
+
"application/json": components["schemas"]["SendOtpWithEmail"] | components["schemas"]["SendOtpWithPhone"];
|
|
6081
6785
|
};
|
|
6082
6786
|
};
|
|
6083
6787
|
responses: {
|
|
@@ -6088,10 +6792,8 @@ interface operations {
|
|
|
6088
6792
|
content: {
|
|
6089
6793
|
"application/json": {
|
|
6090
6794
|
/** @description A descriptive message confirming the success or failure of the operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6091
|
-
success: boolean;
|
|
6092
|
-
content:
|
|
6093
|
-
/** @description A string representing the OTP token which facilitas the resetting of user’s account password. */otp_token: string;
|
|
6094
|
-
};
|
|
6795
|
+
success: boolean;
|
|
6796
|
+
content: components["schemas"]["OtpContent"];
|
|
6095
6797
|
};
|
|
6096
6798
|
};
|
|
6097
6799
|
};
|
|
@@ -6168,11 +6870,8 @@ interface operations {
|
|
|
6168
6870
|
content: {
|
|
6169
6871
|
"application/json": {
|
|
6170
6872
|
/** @description A descriptive message confirming the success or failure of the Login process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6171
|
-
success: boolean;
|
|
6172
|
-
content:
|
|
6173
|
-
/** @description The otp token is a unique code that is used for authentication during the Login process. */otp_token: string; /** @description It is used for verifying OTP and using subsequent API call. */
|
|
6174
|
-
otp_action: string;
|
|
6175
|
-
};
|
|
6873
|
+
success: boolean;
|
|
6874
|
+
content: components["schemas"]["OtpContent"];
|
|
6176
6875
|
};
|
|
6177
6876
|
};
|
|
6178
6877
|
};
|
|
@@ -6259,10 +6958,7 @@ interface operations {
|
|
|
6259
6958
|
"application/json": {
|
|
6260
6959
|
message: string;
|
|
6261
6960
|
success: boolean;
|
|
6262
|
-
content:
|
|
6263
|
-
/** @description Token to pass to the verify-otp endpoint along with the OTP. */otp_token: string; /** @description Action type to pass to the verify-otp endpoint. */
|
|
6264
|
-
otp_action: string;
|
|
6265
|
-
};
|
|
6961
|
+
content: components["schemas"]["OtpContent"];
|
|
6266
6962
|
};
|
|
6267
6963
|
};
|
|
6268
6964
|
};
|
|
@@ -6301,11 +6997,8 @@ interface operations {
|
|
|
6301
6997
|
content: {
|
|
6302
6998
|
"application/json": {
|
|
6303
6999
|
/** @description A descriptive message confirming the success or failure of the Login process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6304
|
-
success: boolean;
|
|
6305
|
-
content:
|
|
6306
|
-
/** @description The otp token is a unique code that is used for authentication during the Login process. */otp_token: string; /** @description It is used for verifying OTP and using subsequent API call. */
|
|
6307
|
-
otp_action: string;
|
|
6308
|
-
};
|
|
7000
|
+
success: boolean;
|
|
7001
|
+
content: components["schemas"]["OtpContent"];
|
|
6309
7002
|
};
|
|
6310
7003
|
};
|
|
6311
7004
|
};
|
|
@@ -6380,7 +7073,9 @@ interface operations {
|
|
|
6380
7073
|
"register-with-email": {
|
|
6381
7074
|
parameters: {
|
|
6382
7075
|
query?: never;
|
|
6383
|
-
header?:
|
|
7076
|
+
header?: {
|
|
7077
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
7078
|
+
};
|
|
6384
7079
|
path?: never;
|
|
6385
7080
|
cookie?: never;
|
|
6386
7081
|
};
|
|
@@ -6401,13 +7096,9 @@ interface operations {
|
|
|
6401
7096
|
};
|
|
6402
7097
|
content: {
|
|
6403
7098
|
"application/json": {
|
|
6404
|
-
|
|
6405
|
-
success: boolean;
|
|
6406
|
-
content:
|
|
6407
|
-
/** @description An object representing user details. */user: components["schemas"]["User"]; /** @description It is a string-based token utilized for authentication and authorization. */
|
|
6408
|
-
access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
6409
|
-
refresh_token: string;
|
|
6410
|
-
};
|
|
7099
|
+
message: string;
|
|
7100
|
+
success: boolean;
|
|
7101
|
+
content: components["schemas"]["OtpContent"];
|
|
6411
7102
|
};
|
|
6412
7103
|
};
|
|
6413
7104
|
};
|
|
@@ -6418,7 +7109,9 @@ interface operations {
|
|
|
6418
7109
|
"register-with-password": {
|
|
6419
7110
|
parameters: {
|
|
6420
7111
|
query?: never;
|
|
6421
|
-
header?:
|
|
7112
|
+
header?: {
|
|
7113
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
7114
|
+
};
|
|
6422
7115
|
path?: never;
|
|
6423
7116
|
cookie?: never;
|
|
6424
7117
|
};
|
|
@@ -6434,13 +7127,9 @@ interface operations {
|
|
|
6434
7127
|
};
|
|
6435
7128
|
content: {
|
|
6436
7129
|
"application/json": {
|
|
6437
|
-
|
|
6438
|
-
success: boolean;
|
|
6439
|
-
content:
|
|
6440
|
-
/** @description An object representing user details. */user: components["schemas"]["User"]; /** @description It is a string-based token utilized for authentication and authorization. */
|
|
6441
|
-
access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
6442
|
-
refresh_token: string;
|
|
6443
|
-
};
|
|
7130
|
+
message: string;
|
|
7131
|
+
success: boolean;
|
|
7132
|
+
content: components["schemas"]["OtpContent"];
|
|
6444
7133
|
};
|
|
6445
7134
|
};
|
|
6446
7135
|
};
|
|
@@ -6451,7 +7140,9 @@ interface operations {
|
|
|
6451
7140
|
"register-with-phone": {
|
|
6452
7141
|
parameters: {
|
|
6453
7142
|
query?: never;
|
|
6454
|
-
header?:
|
|
7143
|
+
header?: {
|
|
7144
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
7145
|
+
};
|
|
6455
7146
|
path?: never;
|
|
6456
7147
|
cookie?: never;
|
|
6457
7148
|
};
|
|
@@ -6477,13 +7168,9 @@ interface operations {
|
|
|
6477
7168
|
};
|
|
6478
7169
|
content: {
|
|
6479
7170
|
"application/json": {
|
|
6480
|
-
message: string;
|
|
6481
|
-
success: boolean;
|
|
6482
|
-
content:
|
|
6483
|
-
/** @description An object representing user details. */user: components["schemas"]["User"]; /** @description It is a string-based token utilized for authentication and authorization. */
|
|
6484
|
-
access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
6485
|
-
refresh_token: string;
|
|
6486
|
-
};
|
|
7171
|
+
message: string;
|
|
7172
|
+
success: boolean;
|
|
7173
|
+
content: components["schemas"]["OtpContent"];
|
|
6487
7174
|
};
|
|
6488
7175
|
};
|
|
6489
7176
|
};
|
|
@@ -6494,7 +7181,9 @@ interface operations {
|
|
|
6494
7181
|
"register-with-whatsapp": {
|
|
6495
7182
|
parameters: {
|
|
6496
7183
|
query?: never;
|
|
6497
|
-
header?:
|
|
7184
|
+
header?: {
|
|
7185
|
+
/** @description This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes. */"x-debug-mode"?: components["parameters"]["DebugMode"];
|
|
7186
|
+
};
|
|
6498
7187
|
path?: never;
|
|
6499
7188
|
cookie?: never;
|
|
6500
7189
|
};
|
|
@@ -6517,114 +7206,12 @@ interface operations {
|
|
|
6517
7206
|
/** @description OK */200: {
|
|
6518
7207
|
headers: {
|
|
6519
7208
|
[name: string]: unknown;
|
|
6520
|
-
};
|
|
6521
|
-
content: {
|
|
6522
|
-
"application/json": {
|
|
6523
|
-
|
|
6524
|
-
success: boolean;
|
|
6525
|
-
content:
|
|
6526
|
-
/** @description An object representing user details. */user: components["schemas"]["User"]; /** @description It is a string-based token utilized for authentication and authorization. */
|
|
6527
|
-
access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
6528
|
-
refresh_token: string;
|
|
6529
|
-
};
|
|
6530
|
-
};
|
|
6531
|
-
};
|
|
6532
|
-
};
|
|
6533
|
-
400: components["responses"]["BadRequest"];
|
|
6534
|
-
401: components["responses"]["Unauthorized"];
|
|
6535
|
-
};
|
|
6536
|
-
};
|
|
6537
|
-
"reset-password": {
|
|
6538
|
-
parameters: {
|
|
6539
|
-
query?: never;
|
|
6540
|
-
header?: never;
|
|
6541
|
-
path?: never;
|
|
6542
|
-
cookie?: never;
|
|
6543
|
-
};
|
|
6544
|
-
requestBody: {
|
|
6545
|
-
content: {
|
|
6546
|
-
"application/json": {
|
|
6547
|
-
/** @description The new password that the user wants to set for their account. */new_password: string; /** @description A confirmation of the new password. */
|
|
6548
|
-
confirm_password: string; /** @description A string representing the OTP token which facilitas the resetting of user’s account password. */
|
|
6549
|
-
otp_token: string;
|
|
6550
|
-
};
|
|
6551
|
-
};
|
|
6552
|
-
};
|
|
6553
|
-
responses: {
|
|
6554
|
-
/** @description OK */200: {
|
|
6555
|
-
headers: {
|
|
6556
|
-
[name: string]: unknown;
|
|
6557
|
-
};
|
|
6558
|
-
content: {
|
|
6559
|
-
"application/json": {
|
|
6560
|
-
/** @description A descriptive message confirming the success or failure of the reset password operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6561
|
-
success: boolean; /** @description An object containing the response content. */
|
|
6562
|
-
content: {
|
|
6563
|
-
/** @description It is a string-based token utilized for authentication and authorization. */access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
6564
|
-
refresh_token: string;
|
|
6565
|
-
};
|
|
6566
|
-
};
|
|
6567
|
-
};
|
|
6568
|
-
};
|
|
6569
|
-
400: components["responses"]["BadRequest"];
|
|
6570
|
-
};
|
|
6571
|
-
};
|
|
6572
|
-
"get-user-detail": {
|
|
6573
|
-
parameters: {
|
|
6574
|
-
query?: never;
|
|
6575
|
-
header?: never;
|
|
6576
|
-
path: {
|
|
6577
|
-
/** @description user ID */id: string;
|
|
6578
|
-
};
|
|
6579
|
-
cookie?: never;
|
|
6580
|
-
};
|
|
6581
|
-
requestBody?: never;
|
|
6582
|
-
responses: {
|
|
6583
|
-
/** @description OK */200: {
|
|
6584
|
-
headers: {
|
|
6585
|
-
[name: string]: unknown;
|
|
6586
|
-
};
|
|
6587
|
-
content: {
|
|
6588
|
-
"application/json": {
|
|
6589
|
-
/** @description A descriptive message confirming the success or failure of the Registration process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6590
|
-
success: boolean; /** @description An object containing the response content. */
|
|
6591
|
-
content: {
|
|
6592
|
-
/** @description An object containing the response content. */user: components["schemas"]["User"];
|
|
6593
|
-
};
|
|
6594
|
-
};
|
|
6595
|
-
};
|
|
6596
|
-
};
|
|
6597
|
-
400: components["responses"]["BadRequest"];
|
|
6598
|
-
401: components["responses"]["Unauthorized"];
|
|
6599
|
-
404: components["responses"]["NotFound"];
|
|
6600
|
-
};
|
|
6601
|
-
};
|
|
6602
|
-
"update-user": {
|
|
6603
|
-
parameters: {
|
|
6604
|
-
query?: never;
|
|
6605
|
-
header?: never;
|
|
6606
|
-
path: {
|
|
6607
|
-
/** @description user ID */id: string;
|
|
6608
|
-
};
|
|
6609
|
-
cookie?: never;
|
|
6610
|
-
};
|
|
6611
|
-
requestBody: {
|
|
6612
|
-
content: {
|
|
6613
|
-
"application/json": components["schemas"]["User"];
|
|
6614
|
-
};
|
|
6615
|
-
};
|
|
6616
|
-
responses: {
|
|
6617
|
-
/** @description OK */200: {
|
|
6618
|
-
headers: {
|
|
6619
|
-
[name: string]: unknown;
|
|
6620
|
-
};
|
|
6621
|
-
content: {
|
|
6622
|
-
"application/json": {
|
|
6623
|
-
/** @description A descriptive message confirming the success or failure of the Registration process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6624
|
-
success: boolean; /** @description An object containing the response content. */
|
|
6625
|
-
content: {
|
|
6626
|
-
/** @description An object containing the response content. */user: components["schemas"]["User"];
|
|
6627
|
-
};
|
|
7209
|
+
};
|
|
7210
|
+
content: {
|
|
7211
|
+
"application/json": {
|
|
7212
|
+
message: string;
|
|
7213
|
+
success: boolean;
|
|
7214
|
+
content: components["schemas"]["OtpContent"];
|
|
6628
7215
|
};
|
|
6629
7216
|
};
|
|
6630
7217
|
};
|
|
@@ -6632,16 +7219,23 @@ interface operations {
|
|
|
6632
7219
|
401: components["responses"]["Unauthorized"];
|
|
6633
7220
|
};
|
|
6634
7221
|
};
|
|
6635
|
-
"
|
|
7222
|
+
"reset-password": {
|
|
6636
7223
|
parameters: {
|
|
6637
7224
|
query?: never;
|
|
6638
7225
|
header?: never;
|
|
6639
|
-
path
|
|
6640
|
-
/** @description user ID */id: string;
|
|
6641
|
-
};
|
|
7226
|
+
path?: never;
|
|
6642
7227
|
cookie?: never;
|
|
6643
7228
|
};
|
|
6644
|
-
requestBody
|
|
7229
|
+
requestBody: {
|
|
7230
|
+
content: {
|
|
7231
|
+
"application/json": {
|
|
7232
|
+
/** @description The new password that the user wants to set for their account. */new_password: string; /** @description A confirmation of the new password. */
|
|
7233
|
+
confirm_password: string; /** @description A string representing the OTP token which facilitas the resetting of user’s account password. */
|
|
7234
|
+
otp_token: string; /** @description A string representing the one-time password. */
|
|
7235
|
+
otp: string;
|
|
7236
|
+
};
|
|
7237
|
+
};
|
|
7238
|
+
};
|
|
6645
7239
|
responses: {
|
|
6646
7240
|
/** @description OK */200: {
|
|
6647
7241
|
headers: {
|
|
@@ -6649,17 +7243,20 @@ interface operations {
|
|
|
6649
7243
|
};
|
|
6650
7244
|
content: {
|
|
6651
7245
|
"application/json": {
|
|
6652
|
-
/** @description A descriptive message confirming the success or failure of the
|
|
6653
|
-
success: boolean;
|
|
7246
|
+
/** @description A descriptive message confirming the success or failure of the reset password operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
7247
|
+
success: boolean; /** @description An object containing the response content. */
|
|
7248
|
+
content: {
|
|
7249
|
+
/** @description It is a string-based token utilized for authentication and authorization. */access_token: string; /** @description It is a string-based token designed for refreshing the user's access token. */
|
|
7250
|
+
refresh_token: string; /** @description An object representing user details. */
|
|
7251
|
+
user: components["schemas"]["User"];
|
|
7252
|
+
};
|
|
6654
7253
|
};
|
|
6655
7254
|
};
|
|
6656
7255
|
};
|
|
6657
7256
|
400: components["responses"]["BadRequest"];
|
|
6658
|
-
401: components["responses"]["Unauthorized"];
|
|
6659
|
-
404: components["responses"]["NotFound"];
|
|
6660
7257
|
};
|
|
6661
7258
|
};
|
|
6662
|
-
"
|
|
7259
|
+
"get-user-detail": {
|
|
6663
7260
|
parameters: {
|
|
6664
7261
|
query?: never;
|
|
6665
7262
|
header?: never;
|
|
@@ -6676,8 +7273,11 @@ interface operations {
|
|
|
6676
7273
|
};
|
|
6677
7274
|
content: {
|
|
6678
7275
|
"application/json": {
|
|
6679
|
-
/** @description A descriptive message confirming the success or failure of the
|
|
6680
|
-
success: boolean;
|
|
7276
|
+
/** @description A descriptive message confirming the success or failure of the Registration process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
7277
|
+
success: boolean; /** @description An object containing the response content. */
|
|
7278
|
+
content: {
|
|
7279
|
+
/** @description An object containing the response content. */user: components["schemas"]["User"];
|
|
7280
|
+
};
|
|
6681
7281
|
};
|
|
6682
7282
|
};
|
|
6683
7283
|
};
|
|
@@ -6686,16 +7286,20 @@ interface operations {
|
|
|
6686
7286
|
404: components["responses"]["NotFound"];
|
|
6687
7287
|
};
|
|
6688
7288
|
};
|
|
6689
|
-
"
|
|
7289
|
+
"update-user": {
|
|
6690
7290
|
parameters: {
|
|
6691
7291
|
query?: never;
|
|
6692
7292
|
header?: never;
|
|
6693
7293
|
path: {
|
|
6694
|
-
/** @description user
|
|
7294
|
+
/** @description user ID */id: string;
|
|
6695
7295
|
};
|
|
6696
7296
|
cookie?: never;
|
|
6697
7297
|
};
|
|
6698
|
-
requestBody
|
|
7298
|
+
requestBody: {
|
|
7299
|
+
content: {
|
|
7300
|
+
"application/json": components["schemas"]["User"];
|
|
7301
|
+
};
|
|
7302
|
+
};
|
|
6699
7303
|
responses: {
|
|
6700
7304
|
/** @description OK */200: {
|
|
6701
7305
|
headers: {
|
|
@@ -6703,35 +7307,28 @@ interface operations {
|
|
|
6703
7307
|
};
|
|
6704
7308
|
content: {
|
|
6705
7309
|
"application/json": {
|
|
6706
|
-
/** @description A descriptive message confirming the success or failure of the
|
|
7310
|
+
/** @description A descriptive message confirming the success or failure of the Registration process. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6707
7311
|
success: boolean; /** @description An object containing the response content. */
|
|
6708
7312
|
content: {
|
|
6709
|
-
/** @description An object containing the
|
|
7313
|
+
/** @description An object containing the response content. */user: components["schemas"]["User"];
|
|
6710
7314
|
};
|
|
6711
7315
|
};
|
|
6712
7316
|
};
|
|
6713
7317
|
};
|
|
6714
7318
|
400: components["responses"]["BadRequest"];
|
|
6715
7319
|
401: components["responses"]["Unauthorized"];
|
|
6716
|
-
404: components["responses"]["NotFound"];
|
|
6717
7320
|
};
|
|
6718
7321
|
};
|
|
6719
|
-
"
|
|
7322
|
+
"delete-user": {
|
|
6720
7323
|
parameters: {
|
|
6721
7324
|
query?: never;
|
|
6722
7325
|
header?: never;
|
|
6723
7326
|
path: {
|
|
6724
|
-
/** @description user
|
|
7327
|
+
/** @description user ID */id: string;
|
|
6725
7328
|
};
|
|
6726
7329
|
cookie?: never;
|
|
6727
7330
|
};
|
|
6728
|
-
requestBody
|
|
6729
|
-
content: {
|
|
6730
|
-
"application/json": {
|
|
6731
|
-
/** @description An object containing the user's notification preferences. */notification_preferences?: components["schemas"]["NotificationPreferences"];
|
|
6732
|
-
};
|
|
6733
|
-
};
|
|
6734
|
-
};
|
|
7331
|
+
requestBody?: never;
|
|
6735
7332
|
responses: {
|
|
6736
7333
|
/** @description OK */200: {
|
|
6737
7334
|
headers: {
|
|
@@ -6739,11 +7336,8 @@ interface operations {
|
|
|
6739
7336
|
};
|
|
6740
7337
|
content: {
|
|
6741
7338
|
"application/json": {
|
|
6742
|
-
/** @description A descriptive message confirming the success or failure of the operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6743
|
-
success: boolean;
|
|
6744
|
-
content: {
|
|
6745
|
-
/** @description An object containing the user's notification preferences. */notification_preferences: components["schemas"]["NotificationPreferences"];
|
|
6746
|
-
};
|
|
7339
|
+
/** @description A descriptive message confirming the success or failure of the delete account operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
7340
|
+
success: boolean;
|
|
6747
7341
|
};
|
|
6748
7342
|
};
|
|
6749
7343
|
};
|
|
@@ -6752,22 +7346,16 @@ interface operations {
|
|
|
6752
7346
|
404: components["responses"]["NotFound"];
|
|
6753
7347
|
};
|
|
6754
7348
|
};
|
|
6755
|
-
"
|
|
7349
|
+
"deactivate-user": {
|
|
6756
7350
|
parameters: {
|
|
6757
7351
|
query?: never;
|
|
6758
7352
|
header?: never;
|
|
6759
7353
|
path: {
|
|
6760
|
-
/** @description user
|
|
7354
|
+
/** @description user ID */id: string;
|
|
6761
7355
|
};
|
|
6762
7356
|
cookie?: never;
|
|
6763
7357
|
};
|
|
6764
|
-
requestBody
|
|
6765
|
-
content: {
|
|
6766
|
-
"application/json": {
|
|
6767
|
-
/** @description An object containing the user's notification preferences. */notification_preferences: components["schemas"]["NotificationPreferences"];
|
|
6768
|
-
};
|
|
6769
|
-
};
|
|
6770
|
-
};
|
|
7358
|
+
requestBody?: never;
|
|
6771
7359
|
responses: {
|
|
6772
7360
|
/** @description OK */200: {
|
|
6773
7361
|
headers: {
|
|
@@ -6775,11 +7363,8 @@ interface operations {
|
|
|
6775
7363
|
};
|
|
6776
7364
|
content: {
|
|
6777
7365
|
"application/json": {
|
|
6778
|
-
/** @description A descriptive message confirming the success or failure of the operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
6779
|
-
success: boolean;
|
|
6780
|
-
content: {
|
|
6781
|
-
/** @description An object containing the user's notification preferences. */notification_preferences: components["schemas"]["NotificationPreferences"];
|
|
6782
|
-
};
|
|
7366
|
+
/** @description A descriptive message confirming the success or failure of the deactivate account operation. */message: string; /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
|
|
7367
|
+
success: boolean;
|
|
6783
7368
|
};
|
|
6784
7369
|
};
|
|
6785
7370
|
};
|
|
@@ -7915,7 +8500,7 @@ interface operations {
|
|
|
7915
8500
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
7916
8501
|
};
|
|
7917
8502
|
path: {
|
|
7918
|
-
/** @description
|
|
8503
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
7919
8504
|
};
|
|
7920
8505
|
cookie?: never;
|
|
7921
8506
|
};
|
|
@@ -8016,7 +8601,7 @@ interface operations {
|
|
|
8016
8601
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
8017
8602
|
};
|
|
8018
8603
|
path: {
|
|
8019
|
-
/** @description ID
|
|
8604
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
8020
8605
|
};
|
|
8021
8606
|
cookie?: never;
|
|
8022
8607
|
};
|
|
@@ -8049,7 +8634,7 @@ interface operations {
|
|
|
8049
8634
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
8050
8635
|
};
|
|
8051
8636
|
path: {
|
|
8052
|
-
/** @description product
|
|
8637
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string; /** @description Variant ID or variant slug. Either is accepted in the path. */
|
|
8053
8638
|
variant_id: string;
|
|
8054
8639
|
};
|
|
8055
8640
|
cookie?: never;
|
|
@@ -8119,7 +8704,7 @@ interface operations {
|
|
|
8119
8704
|
limit?: components["parameters"]["pageLimitParam"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
8120
8705
|
sort_by?: components["parameters"]["sortingParam"]; /** @description filter products by categories ids */
|
|
8121
8706
|
category_id?: string[]; /** @description filter products by categories slugs */
|
|
8122
|
-
category_slug?: string[]; /** @description Determines whether to include or
|
|
8707
|
+
category_slug?: string[]; /** @description Determines whether to include or exclude inventory details in response json */
|
|
8123
8708
|
inventory?: boolean;
|
|
8124
8709
|
};
|
|
8125
8710
|
header?: {
|
|
@@ -8285,7 +8870,7 @@ interface operations {
|
|
|
8285
8870
|
};
|
|
8286
8871
|
content: {
|
|
8287
8872
|
"application/json": {
|
|
8288
|
-
/** @description
|
|
8873
|
+
/** @description Message */message: string;
|
|
8289
8874
|
success: boolean;
|
|
8290
8875
|
content: {
|
|
8291
8876
|
products: components["schemas"]["Item"][];
|
|
@@ -8301,13 +8886,13 @@ interface operations {
|
|
|
8301
8886
|
"get-product-detail": {
|
|
8302
8887
|
parameters: {
|
|
8303
8888
|
query?: {
|
|
8304
|
-
/** @description Determines whether to include or
|
|
8889
|
+
/** @description Determines whether to include or exclude inventory details in response json */inventory?: boolean;
|
|
8305
8890
|
};
|
|
8306
8891
|
header?: {
|
|
8307
8892
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
8308
8893
|
};
|
|
8309
8894
|
path: {
|
|
8310
|
-
/** @description
|
|
8895
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
8311
8896
|
};
|
|
8312
8897
|
cookie?: never;
|
|
8313
8898
|
};
|
|
@@ -8402,13 +8987,13 @@ interface operations {
|
|
|
8402
8987
|
"list-product-variants": {
|
|
8403
8988
|
parameters: {
|
|
8404
8989
|
query?: {
|
|
8405
|
-
/** @description Determines whether to include or
|
|
8990
|
+
/** @description Determines whether to include or exclude inventory details in response json */inventory?: boolean;
|
|
8406
8991
|
};
|
|
8407
8992
|
header?: {
|
|
8408
8993
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
8409
8994
|
};
|
|
8410
8995
|
path: {
|
|
8411
|
-
/** @description ID
|
|
8996
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
8412
8997
|
};
|
|
8413
8998
|
cookie?: never;
|
|
8414
8999
|
};
|
|
@@ -8435,13 +9020,13 @@ interface operations {
|
|
|
8435
9020
|
"get-variant-detail": {
|
|
8436
9021
|
parameters: {
|
|
8437
9022
|
query?: {
|
|
8438
|
-
/** @description Determines whether to include or
|
|
9023
|
+
/** @description Determines whether to include or exclude inventory details in response json */inventory?: boolean;
|
|
8439
9024
|
};
|
|
8440
9025
|
header?: {
|
|
8441
9026
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
8442
9027
|
};
|
|
8443
9028
|
path: {
|
|
8444
|
-
/** @description product
|
|
9029
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string; /** @description Variant ID or variant slug. Either is accepted in the path. */
|
|
8445
9030
|
variant_id: string;
|
|
8446
9031
|
};
|
|
8447
9032
|
cookie?: never;
|
|
@@ -8472,7 +9057,7 @@ interface operations {
|
|
|
8472
9057
|
/** @description page number of pagination list */page?: components["parameters"]["pageParam"]; /** @description Number of results per page. */
|
|
8473
9058
|
limit?: components["parameters"]["pageLimitParam"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
8474
9059
|
sort_by?: components["parameters"]["sortingParam"]; /** @description filter sku by categories */
|
|
8475
|
-
category_id?: string[]; /** @description Determines whether to include or
|
|
9060
|
+
category_id?: string[]; /** @description Determines whether to include or exclude inventory details in response json */
|
|
8476
9061
|
inventory?: boolean; /** @description array of sku */
|
|
8477
9062
|
sku?: string[];
|
|
8478
9063
|
};
|
|
@@ -8595,12 +9180,15 @@ interface operations {
|
|
|
8595
9180
|
404: components["responses"]["NotFound"];
|
|
8596
9181
|
};
|
|
8597
9182
|
};
|
|
8598
|
-
"list-
|
|
9183
|
+
"list-addresses": {
|
|
8599
9184
|
parameters: {
|
|
8600
|
-
query?:
|
|
9185
|
+
query?: {
|
|
9186
|
+
/** @description page number of pagination list */page?: components["parameters"]["pageParam"]; /** @description Number of results per page. */
|
|
9187
|
+
limit?: components["parameters"]["pageLimitParam"];
|
|
9188
|
+
};
|
|
8601
9189
|
header?: never;
|
|
8602
9190
|
path: {
|
|
8603
|
-
/** @description Customer
|
|
9191
|
+
/** @description Customer id */customer_id: string;
|
|
8604
9192
|
};
|
|
8605
9193
|
cookie?: never;
|
|
8606
9194
|
};
|
|
@@ -8612,30 +9200,34 @@ interface operations {
|
|
|
8612
9200
|
};
|
|
8613
9201
|
content: {
|
|
8614
9202
|
"application/json": {
|
|
8615
|
-
message
|
|
8616
|
-
success
|
|
8617
|
-
content
|
|
8618
|
-
|
|
9203
|
+
message?: string;
|
|
9204
|
+
success?: boolean;
|
|
9205
|
+
content?: {
|
|
9206
|
+
addresses?: components["schemas"]["CustomerAddress"][];
|
|
9207
|
+
pagination?: components["schemas"]["Pagination"];
|
|
8619
9208
|
};
|
|
8620
9209
|
};
|
|
8621
9210
|
};
|
|
8622
9211
|
};
|
|
9212
|
+
400: components["responses"]["BadRequest"];
|
|
8623
9213
|
401: components["responses"]["Unauthorized"];
|
|
8624
9214
|
404: components["responses"]["NotFound"];
|
|
8625
9215
|
};
|
|
8626
9216
|
};
|
|
8627
|
-
"
|
|
9217
|
+
"create-address": {
|
|
8628
9218
|
parameters: {
|
|
8629
|
-
query?:
|
|
8630
|
-
/** @description Filter payment methods by type. Accepts multiple payment method types separated by commas. Example: payment_method=upi_collect,card,wallet. Available payment method types include: upi_collect, card, wallet. */payment_methods?: string;
|
|
8631
|
-
};
|
|
9219
|
+
query?: never;
|
|
8632
9220
|
header?: never;
|
|
8633
9221
|
path: {
|
|
8634
|
-
/** @description Customer
|
|
9222
|
+
/** @description Customer id */customer_id: string;
|
|
8635
9223
|
};
|
|
8636
9224
|
cookie?: never;
|
|
9225
|
+
}; /** @description payload for new address */
|
|
9226
|
+
requestBody: {
|
|
9227
|
+
content: {
|
|
9228
|
+
"application/json": components["schemas"]["CustomerAddress"];
|
|
9229
|
+
};
|
|
8637
9230
|
};
|
|
8638
|
-
requestBody?: never;
|
|
8639
9231
|
responses: {
|
|
8640
9232
|
/** @description OK */200: {
|
|
8641
9233
|
headers: {
|
|
@@ -8646,21 +9238,22 @@ interface operations {
|
|
|
8646
9238
|
message?: string;
|
|
8647
9239
|
success?: boolean;
|
|
8648
9240
|
content?: {
|
|
8649
|
-
|
|
9241
|
+
address?: components["schemas"]["CustomerAddress"];
|
|
8650
9242
|
};
|
|
8651
9243
|
};
|
|
8652
9244
|
};
|
|
8653
9245
|
};
|
|
9246
|
+
400: components["responses"]["BadRequest"];
|
|
8654
9247
|
401: components["responses"]["Unauthorized"];
|
|
8655
|
-
404: components["responses"]["NotFound"];
|
|
8656
9248
|
};
|
|
8657
9249
|
};
|
|
8658
|
-
"
|
|
9250
|
+
"get-address-detail": {
|
|
8659
9251
|
parameters: {
|
|
8660
9252
|
query?: never;
|
|
8661
9253
|
header?: never;
|
|
8662
9254
|
path: {
|
|
8663
|
-
/** @description
|
|
9255
|
+
/** @description address id */address_id: string; /** @description customer id */
|
|
9256
|
+
customer_id: string;
|
|
8664
9257
|
};
|
|
8665
9258
|
cookie?: never;
|
|
8666
9259
|
};
|
|
@@ -8675,28 +9268,28 @@ interface operations {
|
|
|
8675
9268
|
message?: string;
|
|
8676
9269
|
success?: boolean;
|
|
8677
9270
|
content?: {
|
|
8678
|
-
|
|
9271
|
+
address?: components["schemas"]["CustomerAddress"];
|
|
8679
9272
|
};
|
|
8680
9273
|
};
|
|
8681
9274
|
};
|
|
8682
9275
|
};
|
|
8683
|
-
400: components["responses"]["BadRequest"];
|
|
8684
9276
|
401: components["responses"]["Unauthorized"];
|
|
8685
9277
|
404: components["responses"]["NotFound"];
|
|
8686
9278
|
};
|
|
8687
9279
|
};
|
|
8688
|
-
"
|
|
9280
|
+
"update-address-detail": {
|
|
8689
9281
|
parameters: {
|
|
8690
9282
|
query?: never;
|
|
8691
9283
|
header?: never;
|
|
8692
9284
|
path: {
|
|
8693
|
-
/** @description
|
|
9285
|
+
/** @description address id */address_id: string; /** @description customer id */
|
|
9286
|
+
customer_id: string;
|
|
8694
9287
|
};
|
|
8695
9288
|
cookie?: never;
|
|
8696
|
-
};
|
|
9289
|
+
}; /** @description payload for address update */
|
|
8697
9290
|
requestBody: {
|
|
8698
9291
|
content: {
|
|
8699
|
-
"
|
|
9292
|
+
"application/json": components["schemas"]["CustomerAddress"];
|
|
8700
9293
|
};
|
|
8701
9294
|
};
|
|
8702
9295
|
responses: {
|
|
@@ -8709,7 +9302,7 @@ interface operations {
|
|
|
8709
9302
|
message?: string;
|
|
8710
9303
|
success?: boolean;
|
|
8711
9304
|
content?: {
|
|
8712
|
-
|
|
9305
|
+
address?: components["schemas"]["CustomerAddress"];
|
|
8713
9306
|
};
|
|
8714
9307
|
};
|
|
8715
9308
|
};
|
|
@@ -8719,23 +9312,17 @@ interface operations {
|
|
|
8719
9312
|
404: components["responses"]["NotFound"];
|
|
8720
9313
|
};
|
|
8721
9314
|
};
|
|
8722
|
-
"
|
|
9315
|
+
"delete-address": {
|
|
8723
9316
|
parameters: {
|
|
8724
9317
|
query?: never;
|
|
8725
9318
|
header?: never;
|
|
8726
9319
|
path: {
|
|
8727
|
-
/** @description
|
|
9320
|
+
/** @description address id */address_id: string; /** @description customer id */
|
|
9321
|
+
customer_id: string;
|
|
8728
9322
|
};
|
|
8729
9323
|
cookie?: never;
|
|
8730
9324
|
};
|
|
8731
|
-
requestBody
|
|
8732
|
-
content: {
|
|
8733
|
-
"application/json": {
|
|
8734
|
-
document_number: string;
|
|
8735
|
-
document_type_id: string;
|
|
8736
|
-
};
|
|
8737
|
-
};
|
|
8738
|
-
};
|
|
9325
|
+
requestBody?: never;
|
|
8739
9326
|
responses: {
|
|
8740
9327
|
/** @description OK */200: {
|
|
8741
9328
|
headers: {
|
|
@@ -8743,36 +9330,21 @@ interface operations {
|
|
|
8743
9330
|
};
|
|
8744
9331
|
content: {
|
|
8745
9332
|
"application/json": {
|
|
8746
|
-
message?: string;
|
|
9333
|
+
/** @example address removed successfully */message?: string;
|
|
8747
9334
|
success?: boolean;
|
|
8748
|
-
content?: {
|
|
8749
|
-
document?: components["schemas"]["GstinDetail"] | components["schemas"]["PanDetail"];
|
|
8750
|
-
};
|
|
8751
9335
|
};
|
|
8752
9336
|
};
|
|
8753
9337
|
};
|
|
8754
|
-
|
|
8755
|
-
|
|
8756
|
-
headers: {
|
|
8757
|
-
[name: string]: unknown;
|
|
8758
|
-
};
|
|
8759
|
-
content?: never;
|
|
8760
|
-
}; /** @description Not Found */
|
|
8761
|
-
404: {
|
|
8762
|
-
headers: {
|
|
8763
|
-
[name: string]: unknown;
|
|
8764
|
-
};
|
|
8765
|
-
content?: never;
|
|
8766
|
-
};
|
|
9338
|
+
401: components["responses"]["Unauthorized"];
|
|
9339
|
+
404: components["responses"]["NotFound"];
|
|
8767
9340
|
};
|
|
8768
9341
|
};
|
|
8769
|
-
"
|
|
9342
|
+
"list-customer-cards": {
|
|
8770
9343
|
parameters: {
|
|
8771
9344
|
query?: never;
|
|
8772
9345
|
header?: never;
|
|
8773
9346
|
path: {
|
|
8774
|
-
/** @description
|
|
8775
|
-
id: string;
|
|
9347
|
+
/** @description Customer Id */customer_id: string;
|
|
8776
9348
|
};
|
|
8777
9349
|
cookie?: never;
|
|
8778
9350
|
};
|
|
@@ -8784,34 +9356,28 @@ interface operations {
|
|
|
8784
9356
|
};
|
|
8785
9357
|
content: {
|
|
8786
9358
|
"application/json": {
|
|
8787
|
-
message
|
|
8788
|
-
success
|
|
8789
|
-
content
|
|
8790
|
-
|
|
9359
|
+
message: string;
|
|
9360
|
+
success: boolean;
|
|
9361
|
+
content: {
|
|
9362
|
+
cards: components["schemas"]["JuspayCardDetail"][];
|
|
8791
9363
|
};
|
|
8792
9364
|
};
|
|
8793
9365
|
};
|
|
8794
9366
|
};
|
|
8795
|
-
400: components["responses"]["BadRequest"];
|
|
8796
9367
|
401: components["responses"]["Unauthorized"];
|
|
8797
9368
|
404: components["responses"]["NotFound"];
|
|
8798
9369
|
};
|
|
8799
9370
|
};
|
|
8800
|
-
"
|
|
9371
|
+
"list-documents": {
|
|
8801
9372
|
parameters: {
|
|
8802
9373
|
query?: never;
|
|
8803
9374
|
header?: never;
|
|
8804
9375
|
path: {
|
|
8805
|
-
/** @description
|
|
8806
|
-
id: string;
|
|
9376
|
+
/** @description customer id */customer_id: string;
|
|
8807
9377
|
};
|
|
8808
9378
|
cookie?: never;
|
|
8809
9379
|
};
|
|
8810
|
-
requestBody
|
|
8811
|
-
content: {
|
|
8812
|
-
"multipart/form-data": components["schemas"]["UpdateDocument"];
|
|
8813
|
-
};
|
|
8814
|
-
};
|
|
9380
|
+
requestBody?: never;
|
|
8815
9381
|
responses: {
|
|
8816
9382
|
/** @description OK */200: {
|
|
8817
9383
|
headers: {
|
|
@@ -8822,7 +9388,7 @@ interface operations {
|
|
|
8822
9388
|
message?: string;
|
|
8823
9389
|
success?: boolean;
|
|
8824
9390
|
content?: {
|
|
8825
|
-
|
|
9391
|
+
documents?: components["schemas"]["Document"][];
|
|
8826
9392
|
};
|
|
8827
9393
|
};
|
|
8828
9394
|
};
|
|
@@ -8832,17 +9398,20 @@ interface operations {
|
|
|
8832
9398
|
404: components["responses"]["NotFound"];
|
|
8833
9399
|
};
|
|
8834
9400
|
};
|
|
8835
|
-
"
|
|
9401
|
+
"create-document": {
|
|
8836
9402
|
parameters: {
|
|
8837
9403
|
query?: never;
|
|
8838
9404
|
header?: never;
|
|
8839
9405
|
path: {
|
|
8840
|
-
/** @description
|
|
8841
|
-
id: string;
|
|
9406
|
+
/** @description customer id */customer_id: string;
|
|
8842
9407
|
};
|
|
8843
9408
|
cookie?: never;
|
|
8844
9409
|
};
|
|
8845
|
-
requestBody
|
|
9410
|
+
requestBody: {
|
|
9411
|
+
content: {
|
|
9412
|
+
"multipart/form-data": components["schemas"]["Document"];
|
|
9413
|
+
};
|
|
9414
|
+
};
|
|
8846
9415
|
responses: {
|
|
8847
9416
|
/** @description OK */200: {
|
|
8848
9417
|
headers: {
|
|
@@ -8852,6 +9421,9 @@ interface operations {
|
|
|
8852
9421
|
"application/json": {
|
|
8853
9422
|
message?: string;
|
|
8854
9423
|
success?: boolean;
|
|
9424
|
+
content?: {
|
|
9425
|
+
document?: components["schemas"]["Document"];
|
|
9426
|
+
};
|
|
8855
9427
|
};
|
|
8856
9428
|
};
|
|
8857
9429
|
};
|
|
@@ -8860,19 +9432,23 @@ interface operations {
|
|
|
8860
9432
|
404: components["responses"]["NotFound"];
|
|
8861
9433
|
};
|
|
8862
9434
|
};
|
|
8863
|
-
"
|
|
9435
|
+
"verify-document": {
|
|
8864
9436
|
parameters: {
|
|
8865
|
-
query?:
|
|
8866
|
-
/** @description page number of pagination list */page?: components["parameters"]["pageParam"]; /** @description Number of results per page. */
|
|
8867
|
-
limit?: components["parameters"]["pageLimitParam"];
|
|
8868
|
-
};
|
|
9437
|
+
query?: never;
|
|
8869
9438
|
header?: never;
|
|
8870
9439
|
path: {
|
|
8871
|
-
/** @description
|
|
9440
|
+
/** @description customer id */customer_id: string;
|
|
8872
9441
|
};
|
|
8873
9442
|
cookie?: never;
|
|
8874
9443
|
};
|
|
8875
|
-
requestBody
|
|
9444
|
+
requestBody: {
|
|
9445
|
+
content: {
|
|
9446
|
+
"application/json": {
|
|
9447
|
+
document_number: string;
|
|
9448
|
+
document_type_id: string;
|
|
9449
|
+
};
|
|
9450
|
+
};
|
|
9451
|
+
};
|
|
8876
9452
|
responses: {
|
|
8877
9453
|
/** @description OK */200: {
|
|
8878
9454
|
headers: {
|
|
@@ -8883,8 +9459,7 @@ interface operations {
|
|
|
8883
9459
|
message?: string;
|
|
8884
9460
|
success?: boolean;
|
|
8885
9461
|
content?: {
|
|
8886
|
-
|
|
8887
|
-
pagination?: components["schemas"]["Pagination"];
|
|
9462
|
+
document?: components["schemas"]["GstinDetail"] | components["schemas"]["PanDetail"];
|
|
8888
9463
|
};
|
|
8889
9464
|
};
|
|
8890
9465
|
};
|
|
@@ -8894,20 +9469,17 @@ interface operations {
|
|
|
8894
9469
|
404: components["responses"]["NotFound"];
|
|
8895
9470
|
};
|
|
8896
9471
|
};
|
|
8897
|
-
"
|
|
9472
|
+
"get-document": {
|
|
8898
9473
|
parameters: {
|
|
8899
9474
|
query?: never;
|
|
8900
9475
|
header?: never;
|
|
8901
9476
|
path: {
|
|
8902
|
-
/** @description
|
|
9477
|
+
/** @description customer id */customer_id: string; /** @description document id */
|
|
9478
|
+
document_id: string;
|
|
8903
9479
|
};
|
|
8904
9480
|
cookie?: never;
|
|
8905
|
-
}; /** @description payload for new address */
|
|
8906
|
-
requestBody: {
|
|
8907
|
-
content: {
|
|
8908
|
-
"application/json": components["schemas"]["CustomerAddress"];
|
|
8909
|
-
};
|
|
8910
9481
|
};
|
|
9482
|
+
requestBody?: never;
|
|
8911
9483
|
responses: {
|
|
8912
9484
|
/** @description OK */200: {
|
|
8913
9485
|
headers: {
|
|
@@ -8918,26 +9490,31 @@ interface operations {
|
|
|
8918
9490
|
message?: string;
|
|
8919
9491
|
success?: boolean;
|
|
8920
9492
|
content?: {
|
|
8921
|
-
|
|
9493
|
+
document?: components["schemas"]["Document"];
|
|
8922
9494
|
};
|
|
8923
9495
|
};
|
|
8924
9496
|
};
|
|
8925
9497
|
};
|
|
8926
9498
|
400: components["responses"]["BadRequest"];
|
|
8927
9499
|
401: components["responses"]["Unauthorized"];
|
|
9500
|
+
404: components["responses"]["NotFound"];
|
|
8928
9501
|
};
|
|
8929
9502
|
};
|
|
8930
|
-
"
|
|
9503
|
+
"update-document": {
|
|
8931
9504
|
parameters: {
|
|
8932
9505
|
query?: never;
|
|
8933
9506
|
header?: never;
|
|
8934
9507
|
path: {
|
|
8935
|
-
/** @description
|
|
8936
|
-
|
|
9508
|
+
/** @description customer id */customer_id: string; /** @description document id */
|
|
9509
|
+
document_id: string;
|
|
8937
9510
|
};
|
|
8938
9511
|
cookie?: never;
|
|
8939
9512
|
};
|
|
8940
|
-
requestBody
|
|
9513
|
+
requestBody: {
|
|
9514
|
+
content: {
|
|
9515
|
+
"multipart/form-data": components["schemas"]["UpdateDocument"];
|
|
9516
|
+
};
|
|
9517
|
+
};
|
|
8941
9518
|
responses: {
|
|
8942
9519
|
/** @description OK */200: {
|
|
8943
9520
|
headers: {
|
|
@@ -8948,30 +9525,27 @@ interface operations {
|
|
|
8948
9525
|
message?: string;
|
|
8949
9526
|
success?: boolean;
|
|
8950
9527
|
content?: {
|
|
8951
|
-
|
|
9528
|
+
document?: components["schemas"]["Document"];
|
|
8952
9529
|
};
|
|
8953
9530
|
};
|
|
8954
9531
|
};
|
|
8955
9532
|
};
|
|
9533
|
+
400: components["responses"]["BadRequest"];
|
|
8956
9534
|
401: components["responses"]["Unauthorized"];
|
|
8957
9535
|
404: components["responses"]["NotFound"];
|
|
8958
9536
|
};
|
|
8959
9537
|
};
|
|
8960
|
-
"
|
|
9538
|
+
"delete-document": {
|
|
8961
9539
|
parameters: {
|
|
8962
9540
|
query?: never;
|
|
8963
9541
|
header?: never;
|
|
8964
9542
|
path: {
|
|
8965
|
-
/** @description
|
|
8966
|
-
|
|
9543
|
+
/** @description customer id */customer_id: string; /** @description document id */
|
|
9544
|
+
document_id: string;
|
|
8967
9545
|
};
|
|
8968
9546
|
cookie?: never;
|
|
8969
|
-
}; /** @description payload for address update */
|
|
8970
|
-
requestBody: {
|
|
8971
|
-
content: {
|
|
8972
|
-
"application/json": components["schemas"]["CustomerAddress"];
|
|
8973
|
-
};
|
|
8974
9547
|
};
|
|
9548
|
+
requestBody?: never;
|
|
8975
9549
|
responses: {
|
|
8976
9550
|
/** @description OK */200: {
|
|
8977
9551
|
headers: {
|
|
@@ -8981,9 +9555,6 @@ interface operations {
|
|
|
8981
9555
|
"application/json": {
|
|
8982
9556
|
message?: string;
|
|
8983
9557
|
success?: boolean;
|
|
8984
|
-
content?: {
|
|
8985
|
-
address?: components["schemas"]["CustomerAddress"];
|
|
8986
|
-
};
|
|
8987
9558
|
};
|
|
8988
9559
|
};
|
|
8989
9560
|
};
|
|
@@ -8992,13 +9563,12 @@ interface operations {
|
|
|
8992
9563
|
404: components["responses"]["NotFound"];
|
|
8993
9564
|
};
|
|
8994
9565
|
};
|
|
8995
|
-
"
|
|
9566
|
+
"get-loyalty-details": {
|
|
8996
9567
|
parameters: {
|
|
8997
9568
|
query?: never;
|
|
8998
9569
|
header?: never;
|
|
8999
9570
|
path: {
|
|
9000
|
-
/** @description
|
|
9001
|
-
user_id: string;
|
|
9571
|
+
/** @description customer id */customer_id: string;
|
|
9002
9572
|
};
|
|
9003
9573
|
cookie?: never;
|
|
9004
9574
|
};
|
|
@@ -9010,8 +9580,11 @@ interface operations {
|
|
|
9010
9580
|
};
|
|
9011
9581
|
content: {
|
|
9012
9582
|
"application/json": {
|
|
9013
|
-
|
|
9583
|
+
message?: string;
|
|
9014
9584
|
success?: boolean;
|
|
9585
|
+
content?: {
|
|
9586
|
+
loyalty?: components["schemas"]["CustomerLoyalty"];
|
|
9587
|
+
};
|
|
9015
9588
|
};
|
|
9016
9589
|
};
|
|
9017
9590
|
};
|
|
@@ -9019,12 +9592,16 @@ interface operations {
|
|
|
9019
9592
|
404: components["responses"]["NotFound"];
|
|
9020
9593
|
};
|
|
9021
9594
|
};
|
|
9022
|
-
"
|
|
9595
|
+
"list-loyalty-activities": {
|
|
9023
9596
|
parameters: {
|
|
9024
|
-
query?:
|
|
9597
|
+
query?: {
|
|
9598
|
+
/** @description Number of results per page. */limit?: components["parameters"]["pageLimitParam"]; /** @description page number of pagination list */
|
|
9599
|
+
page?: components["parameters"]["pageParam"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
9600
|
+
sort_by?: components["parameters"]["sortingParam"];
|
|
9601
|
+
};
|
|
9025
9602
|
header?: never;
|
|
9026
9603
|
path: {
|
|
9027
|
-
/** @description
|
|
9604
|
+
/** @description customer id */customer_id: string;
|
|
9028
9605
|
};
|
|
9029
9606
|
cookie?: never;
|
|
9030
9607
|
};
|
|
@@ -9039,7 +9616,7 @@ interface operations {
|
|
|
9039
9616
|
message?: string;
|
|
9040
9617
|
success?: boolean;
|
|
9041
9618
|
content?: {
|
|
9042
|
-
|
|
9619
|
+
loyalty_points_activity?: components["schemas"]["LoyaltyPointActivity"][];
|
|
9043
9620
|
};
|
|
9044
9621
|
};
|
|
9045
9622
|
};
|
|
@@ -9048,16 +9625,14 @@ interface operations {
|
|
|
9048
9625
|
404: components["responses"]["NotFound"];
|
|
9049
9626
|
};
|
|
9050
9627
|
};
|
|
9051
|
-
"list-
|
|
9628
|
+
"list-saved-payment-methods": {
|
|
9052
9629
|
parameters: {
|
|
9053
9630
|
query?: {
|
|
9054
|
-
/** @description
|
|
9055
|
-
page?: components["parameters"]["pageParam"]; /** @description JSON string format: {"field1":"asc", "field2":"desc"} */
|
|
9056
|
-
sort_by?: components["parameters"]["sortingParam"];
|
|
9631
|
+
/** @description Filter payment methods by type. Accepts multiple payment method types separated by commas. Example: payment_method=upi_collect,card,wallet. Available payment method types include: upi_collect, card, wallet. */payment_methods?: string;
|
|
9057
9632
|
};
|
|
9058
9633
|
header?: never;
|
|
9059
9634
|
path: {
|
|
9060
|
-
/** @description
|
|
9635
|
+
/** @description Customer Id */customer_id: string;
|
|
9061
9636
|
};
|
|
9062
9637
|
cookie?: never;
|
|
9063
9638
|
};
|
|
@@ -9072,7 +9647,7 @@ interface operations {
|
|
|
9072
9647
|
message?: string;
|
|
9073
9648
|
success?: boolean;
|
|
9074
9649
|
content?: {
|
|
9075
|
-
|
|
9650
|
+
saved_payment_methods?: components["schemas"]["SavedPaymentMethod"];
|
|
9076
9651
|
};
|
|
9077
9652
|
};
|
|
9078
9653
|
};
|
|
@@ -9081,12 +9656,12 @@ interface operations {
|
|
|
9081
9656
|
404: components["responses"]["NotFound"];
|
|
9082
9657
|
};
|
|
9083
9658
|
};
|
|
9084
|
-
"list-
|
|
9659
|
+
"list-customer-reviews": {
|
|
9085
9660
|
parameters: {
|
|
9086
9661
|
query?: never;
|
|
9087
9662
|
header?: never;
|
|
9088
9663
|
path: {
|
|
9089
|
-
/** @description
|
|
9664
|
+
/** @description customer id */customer_id: string;
|
|
9090
9665
|
};
|
|
9091
9666
|
cookie?: never;
|
|
9092
9667
|
};
|
|
@@ -10929,7 +11504,7 @@ interface operations {
|
|
|
10929
11504
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
10930
11505
|
};
|
|
10931
11506
|
path: {
|
|
10932
|
-
/** @description
|
|
11507
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
10933
11508
|
};
|
|
10934
11509
|
cookie?: never;
|
|
10935
11510
|
};
|
|
@@ -10999,7 +11574,7 @@ interface operations {
|
|
|
10999
11574
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
11000
11575
|
};
|
|
11001
11576
|
path: {
|
|
11002
|
-
/** @description ID
|
|
11577
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string;
|
|
11003
11578
|
};
|
|
11004
11579
|
cookie?: never;
|
|
11005
11580
|
};
|
|
@@ -11032,7 +11607,7 @@ interface operations {
|
|
|
11032
11607
|
/** @description This param is used to determine product pricing, promotions, and subscription rates. If a valid customer group id is provided, pricing details will be retrieved accordingly. If no matching data is found for the specified customer group id, the system will fall back to the default customer group id. If no data is found for the default group either, the highest applicable price will be returned. */"x-customer-group-id"?: components["parameters"]["CustomerGroupId"];
|
|
11033
11608
|
};
|
|
11034
11609
|
path: {
|
|
11035
|
-
/** @description product
|
|
11610
|
+
/** @description Product ID or product slug. Either is accepted in the path. */product_id: string; /** @description Variant ID or variant slug. Either is accepted in the path. */
|
|
11036
11611
|
variant_id: string;
|
|
11037
11612
|
};
|
|
11038
11613
|
cookie?: never;
|
|
@@ -11408,13 +11983,12 @@ interface operations {
|
|
|
11408
11983
|
message?: string;
|
|
11409
11984
|
success?: boolean;
|
|
11410
11985
|
content?: {
|
|
11411
|
-
kyc_documents?: components["schemas"]["
|
|
11986
|
+
kyc_documents?: components["schemas"]["KycDocumentConfig"][]; /** @default false */
|
|
11412
11987
|
is_kyc_enabled: $Read<boolean>;
|
|
11413
11988
|
};
|
|
11414
11989
|
};
|
|
11415
11990
|
};
|
|
11416
11991
|
};
|
|
11417
|
-
400: components["responses"]["BadRequest"];
|
|
11418
11992
|
401: components["responses"]["Unauthorized"];
|
|
11419
11993
|
404: components["responses"]["NotFound"];
|
|
11420
11994
|
};
|
|
@@ -11892,447 +12466,152 @@ interface operations {
|
|
|
11892
12466
|
};
|
|
11893
12467
|
};
|
|
11894
12468
|
"shipment-cancelled": {
|
|
11895
|
-
parameters: {
|
|
11896
|
-
query?: never;
|
|
11897
|
-
header?: never;
|
|
11898
|
-
path?: never;
|
|
11899
|
-
cookie?: never;
|
|
11900
|
-
};
|
|
11901
|
-
requestBody: {
|
|
11902
|
-
content: {
|
|
11903
|
-
"application/json": components["schemas"]["OrderShipment"];
|
|
11904
|
-
};
|
|
11905
|
-
};
|
|
11906
|
-
responses: {
|
|
11907
|
-
400: components["responses"]["BadRequest"];
|
|
11908
|
-
401: components["responses"]["Unauthorized"];
|
|
11909
|
-
410: components["responses"]["WebhookGone"];
|
|
11910
|
-
"2XX": components["responses"]["WebhookAccepted"];
|
|
11911
|
-
"5XX": components["responses"]["WebhookServerError"];
|
|
11912
|
-
};
|
|
11913
|
-
};
|
|
11914
|
-
"shipment-delivered": {
|
|
11915
|
-
parameters: {
|
|
11916
|
-
query?: never;
|
|
11917
|
-
header?: never;
|
|
11918
|
-
path?: never;
|
|
11919
|
-
cookie?: never;
|
|
11920
|
-
};
|
|
11921
|
-
requestBody: {
|
|
11922
|
-
content: {
|
|
11923
|
-
"application/json": components["schemas"]["OrderShipment"];
|
|
11924
|
-
};
|
|
11925
|
-
};
|
|
11926
|
-
responses: {
|
|
11927
|
-
400: components["responses"]["BadRequest"];
|
|
11928
|
-
401: components["responses"]["Unauthorized"];
|
|
11929
|
-
410: components["responses"]["WebhookGone"];
|
|
11930
|
-
"2XX": components["responses"]["WebhookAccepted"];
|
|
11931
|
-
"5XX": components["responses"]["WebhookServerError"];
|
|
11932
|
-
};
|
|
11933
|
-
};
|
|
11934
|
-
"payment-refund-created": {
|
|
11935
|
-
parameters: {
|
|
11936
|
-
query?: never;
|
|
11937
|
-
header?: never;
|
|
11938
|
-
path?: never;
|
|
11939
|
-
cookie?: never;
|
|
11940
|
-
};
|
|
11941
|
-
requestBody: {
|
|
11942
|
-
content: {
|
|
11943
|
-
"application/json": components["schemas"]["OrderRefund"];
|
|
11944
|
-
};
|
|
11945
|
-
};
|
|
11946
|
-
responses: {
|
|
11947
|
-
400: components["responses"]["BadRequest"];
|
|
11948
|
-
401: components["responses"]["Unauthorized"];
|
|
11949
|
-
410: components["responses"]["WebhookGone"];
|
|
11950
|
-
"2XX": components["responses"]["WebhookAccepted"];
|
|
11951
|
-
"5XX": components["responses"]["WebhookServerError"];
|
|
11952
|
-
};
|
|
11953
|
-
};
|
|
11954
|
-
"payment-refund-success": {
|
|
11955
|
-
parameters: {
|
|
11956
|
-
query?: never;
|
|
11957
|
-
header?: never;
|
|
11958
|
-
path?: never;
|
|
11959
|
-
cookie?: never;
|
|
11960
|
-
};
|
|
11961
|
-
requestBody: {
|
|
11962
|
-
content: {
|
|
11963
|
-
"application/json": components["schemas"]["OrderRefund"];
|
|
11964
|
-
};
|
|
11965
|
-
};
|
|
11966
|
-
responses: {
|
|
11967
|
-
400: components["responses"]["BadRequest"];
|
|
11968
|
-
401: components["responses"]["Unauthorized"];
|
|
11969
|
-
410: components["responses"]["WebhookGone"];
|
|
11970
|
-
"2XX": components["responses"]["WebhookAccepted"];
|
|
11971
|
-
"5XX": components["responses"]["WebhookServerError"];
|
|
11972
|
-
};
|
|
11973
|
-
};
|
|
11974
|
-
"payment-refund-failed": {
|
|
11975
|
-
parameters: {
|
|
11976
|
-
query?: never;
|
|
11977
|
-
header?: never;
|
|
11978
|
-
path?: never;
|
|
11979
|
-
cookie?: never;
|
|
11980
|
-
};
|
|
11981
|
-
requestBody: {
|
|
11982
|
-
content: {
|
|
11983
|
-
"application/json": components["schemas"]["OrderRefund"];
|
|
11984
|
-
};
|
|
11985
|
-
};
|
|
11986
|
-
responses: {
|
|
11987
|
-
400: components["responses"]["BadRequest"];
|
|
11988
|
-
401: components["responses"]["Unauthorized"];
|
|
11989
|
-
410: components["responses"]["WebhookGone"];
|
|
11990
|
-
"2XX": components["responses"]["WebhookAccepted"];
|
|
11991
|
-
"5XX": components["responses"]["WebhookServerError"];
|
|
11992
|
-
};
|
|
11993
|
-
};
|
|
11994
|
-
}
|
|
11995
|
-
//#endregion
|
|
11996
|
-
//#region ../sdk-core/dist/index.d.mts
|
|
11997
|
-
//#region src/types/api.d.ts
|
|
11998
|
-
/**
|
|
11999
|
-
* Core API response types shared across Commerce Engine SDKs
|
|
12000
|
-
*/
|
|
12001
|
-
/**
|
|
12002
|
-
* Standard API error response structure
|
|
12003
|
-
*/
|
|
12004
|
-
interface ApiErrorResponse {
|
|
12005
|
-
success?: boolean;
|
|
12006
|
-
error?: any;
|
|
12007
|
-
code?: string;
|
|
12008
|
-
message?: string;
|
|
12009
|
-
}
|
|
12010
|
-
/**
|
|
12011
|
-
* Generic API result type that wraps all SDK responses
|
|
12012
|
-
* Provides consistent error handling and response structure
|
|
12013
|
-
*/
|
|
12014
|
-
type ApiResult<T> = {
|
|
12015
|
-
data: T;
|
|
12016
|
-
error: null;
|
|
12017
|
-
response: Response;
|
|
12018
|
-
} | {
|
|
12019
|
-
data: null;
|
|
12020
|
-
error: ApiErrorResponse;
|
|
12021
|
-
response: Response;
|
|
12022
|
-
}; //#endregion
|
|
12023
|
-
//#region src/types/logger.d.ts
|
|
12024
|
-
/**
|
|
12025
|
-
* Logger-related types for Commerce Engine SDKs
|
|
12026
|
-
*/
|
|
12027
|
-
/**
|
|
12028
|
-
* Debug logger function interface
|
|
12029
|
-
*/
|
|
12030
|
-
interface DebugLoggerFn {
|
|
12031
|
-
(level: "info" | "warn" | "error", message: string, data?: any): void;
|
|
12032
|
-
} //#endregion
|
|
12033
|
-
//#region src/types/config.d.ts
|
|
12034
|
-
/**
|
|
12035
|
-
* Base SDK configuration options for any OpenAPI-based SDK
|
|
12036
|
-
* Completely generic - no assumptions about the underlying API
|
|
12037
|
-
*/
|
|
12038
|
-
interface BaseSDKOptions<TDefaultHeaders extends Record<string, any> = Record<string, any>> {
|
|
12039
|
-
/**
|
|
12040
|
-
* Base URL for the API
|
|
12041
|
-
*/
|
|
12042
|
-
baseUrl?: string;
|
|
12043
|
-
/**
|
|
12044
|
-
* Optional timeout in milliseconds
|
|
12045
|
-
*/
|
|
12046
|
-
timeout?: number;
|
|
12047
|
-
/**
|
|
12048
|
-
* Default headers to include with API requests
|
|
12049
|
-
* These can be overridden at the method level
|
|
12050
|
-
* Generic type allows each SDK to define its supported headers
|
|
12051
|
-
*/
|
|
12052
|
-
defaultHeaders?: TDefaultHeaders;
|
|
12053
|
-
/**
|
|
12054
|
-
* Enable debug mode for detailed request/response logging
|
|
12055
|
-
*/
|
|
12056
|
-
debug?: boolean;
|
|
12057
|
-
/**
|
|
12058
|
-
* Custom logger function for debug information
|
|
12059
|
-
*/
|
|
12060
|
-
logger?: DebugLoggerFn;
|
|
12061
|
-
}
|
|
12062
|
-
/**
|
|
12063
|
-
* Header configuration for SDK clients
|
|
12064
|
-
* Defines supported headers and optional transformations
|
|
12065
|
-
*/
|
|
12066
|
-
interface HeaderConfig<T extends Record<string, any>> {
|
|
12067
|
-
/**
|
|
12068
|
-
* Default headers from SDK configuration
|
|
12069
|
-
*/
|
|
12070
|
-
defaultHeaders?: T;
|
|
12071
|
-
/**
|
|
12072
|
-
* Optional transformations to apply to header names
|
|
12073
|
-
* Maps SDK parameter names to HTTP header names
|
|
12074
|
-
*/
|
|
12075
|
-
transformations?: Record<keyof T, string>;
|
|
12076
|
-
} //#endregion
|
|
12077
|
-
//#region src/base-client.d.ts
|
|
12078
|
-
/**
|
|
12079
|
-
* Generic base API client that all Commerce Engine SDKs can extend
|
|
12080
|
-
* Handles common functionality like middleware setup, request execution, and header management
|
|
12081
|
-
* Does NOT include token management - that's SDK-specific
|
|
12082
|
-
*
|
|
12083
|
-
* @template TPaths - OpenAPI paths type
|
|
12084
|
-
* @template THeaders - Supported default headers type
|
|
12085
|
-
*/
|
|
12086
|
-
declare class BaseAPIClient<TPaths extends Record<string, any>, THeaders extends Record<string, any> = Record<string, any>> {
|
|
12087
|
-
protected client: ReturnType<typeof createClient<TPaths>>;
|
|
12088
|
-
protected config: BaseSDKOptions<THeaders>;
|
|
12089
|
-
protected readonly baseUrl: string;
|
|
12090
|
-
private readonly headerTransformations;
|
|
12091
|
-
/**
|
|
12092
|
-
* Create a new BaseAPIClient
|
|
12093
|
-
*
|
|
12094
|
-
* @param config - Configuration for the API client
|
|
12095
|
-
* @param baseUrl - The base URL for the API (must be provided by subclass)
|
|
12096
|
-
* @param headerTransformations - Header name transformations for this SDK
|
|
12097
|
-
*/
|
|
12098
|
-
constructor(config: BaseSDKOptions<THeaders>, baseUrl: string, headerTransformations?: Record<keyof THeaders, string>);
|
|
12099
|
-
/**
|
|
12100
|
-
* Set up all middleware for the client
|
|
12101
|
-
*/
|
|
12102
|
-
private setupMiddleware;
|
|
12103
|
-
/**
|
|
12104
|
-
* Get the base URL of the API
|
|
12105
|
-
*
|
|
12106
|
-
* @returns The base URL of the API
|
|
12107
|
-
*/
|
|
12108
|
-
getBaseUrl(): string;
|
|
12109
|
-
/**
|
|
12110
|
-
* Execute a request and handle the response consistently
|
|
12111
|
-
* This provides unified error handling and response processing
|
|
12112
|
-
*
|
|
12113
|
-
* @param apiCall - Function that executes the API request
|
|
12114
|
-
* @returns Promise with the API response in standardized format
|
|
12115
|
-
*/
|
|
12116
|
-
protected executeRequest<T, M = string, S = boolean>(apiCall: () => Promise<{
|
|
12117
|
-
data?: {
|
|
12118
|
-
message?: M;
|
|
12119
|
-
success?: S;
|
|
12120
|
-
content?: T;
|
|
12469
|
+
parameters: {
|
|
12470
|
+
query?: never;
|
|
12471
|
+
header?: never;
|
|
12472
|
+
path?: never;
|
|
12473
|
+
cookie?: never;
|
|
12474
|
+
};
|
|
12475
|
+
requestBody: {
|
|
12476
|
+
content: {
|
|
12477
|
+
"application/json": components["schemas"]["OrderShipment"];
|
|
12478
|
+
};
|
|
12479
|
+
};
|
|
12480
|
+
responses: {
|
|
12481
|
+
400: components["responses"]["BadRequest"];
|
|
12482
|
+
401: components["responses"]["Unauthorized"];
|
|
12483
|
+
410: components["responses"]["WebhookGone"];
|
|
12484
|
+
"2XX": components["responses"]["WebhookAccepted"];
|
|
12485
|
+
"5XX": components["responses"]["WebhookServerError"];
|
|
12121
12486
|
};
|
|
12122
|
-
error?: any;
|
|
12123
|
-
response: Response;
|
|
12124
|
-
}>): Promise<ApiResult<T>>;
|
|
12125
|
-
/**
|
|
12126
|
-
* Merge default headers with method-level headers
|
|
12127
|
-
* Method-level headers take precedence over default headers
|
|
12128
|
-
* Automatically applies SDK-specific header transformations
|
|
12129
|
-
*
|
|
12130
|
-
* @param methodHeaders - Headers passed to the specific method call
|
|
12131
|
-
* @returns Merged headers object with proper HTTP header names
|
|
12132
|
-
*/
|
|
12133
|
-
protected mergeHeaders<T extends Record<string, any> = Record<string, any>>(methodHeaders?: T): T;
|
|
12134
|
-
/**
|
|
12135
|
-
* Set default headers for the client
|
|
12136
|
-
*
|
|
12137
|
-
* @param headers - Default headers to set
|
|
12138
|
-
*/
|
|
12139
|
-
setDefaultHeaders(headers: THeaders): void;
|
|
12140
|
-
/**
|
|
12141
|
-
* Get current default headers
|
|
12142
|
-
*
|
|
12143
|
-
* @returns Current default headers
|
|
12144
|
-
*/
|
|
12145
|
-
getDefaultHeaders(): THeaders | undefined;
|
|
12146
|
-
} //#endregion
|
|
12147
|
-
//#region src/utils/url.d.ts
|
|
12148
|
-
/**
|
|
12149
|
-
* Generic URL utility functions for any SDK
|
|
12150
|
-
*/
|
|
12151
|
-
/**
|
|
12152
|
-
* Extract pathname from URL
|
|
12153
|
-
* Useful for middleware that needs to inspect request paths
|
|
12154
|
-
*/
|
|
12155
|
-
declare function getPathnameFromUrl(url: string): string; //#endregion
|
|
12156
|
-
//#region src/utils/response.d.ts
|
|
12157
|
-
/**
|
|
12158
|
-
* Execute a request and handle the response consistently
|
|
12159
|
-
* This provides unified error handling and response processing across all SDKs
|
|
12160
|
-
*
|
|
12161
|
-
* @param apiCall - Function that executes the API request
|
|
12162
|
-
* @returns Promise with the API response in standardized format
|
|
12163
|
-
*/
|
|
12164
|
-
declare function executeRequest<T, M = string, S = boolean>(apiCall: () => Promise<{
|
|
12165
|
-
data?: {
|
|
12166
|
-
message?: M;
|
|
12167
|
-
success?: S;
|
|
12168
|
-
content?: T;
|
|
12169
12487
|
};
|
|
12170
|
-
|
|
12171
|
-
|
|
12172
|
-
|
|
12173
|
-
|
|
12174
|
-
|
|
12175
|
-
|
|
12176
|
-
|
|
12177
|
-
|
|
12178
|
-
|
|
12179
|
-
|
|
12180
|
-
|
|
12181
|
-
|
|
12182
|
-
|
|
12183
|
-
|
|
12184
|
-
|
|
12185
|
-
|
|
12186
|
-
|
|
12187
|
-
|
|
12188
|
-
*/
|
|
12189
|
-
static isSuccess(response: Response): boolean;
|
|
12190
|
-
/**
|
|
12191
|
-
* Get response metadata
|
|
12192
|
-
*/
|
|
12193
|
-
static getMetadata(response: Response): {
|
|
12194
|
-
status: number;
|
|
12195
|
-
statusText: string;
|
|
12196
|
-
ok: boolean;
|
|
12197
|
-
url: string;
|
|
12198
|
-
redirected: boolean;
|
|
12199
|
-
type: ResponseType;
|
|
12200
|
-
headers: {
|
|
12201
|
-
[k: string]: string;
|
|
12488
|
+
"shipment-delivered": {
|
|
12489
|
+
parameters: {
|
|
12490
|
+
query?: never;
|
|
12491
|
+
header?: never;
|
|
12492
|
+
path?: never;
|
|
12493
|
+
cookie?: never;
|
|
12494
|
+
};
|
|
12495
|
+
requestBody: {
|
|
12496
|
+
content: {
|
|
12497
|
+
"application/json": components["schemas"]["OrderShipment"];
|
|
12498
|
+
};
|
|
12499
|
+
};
|
|
12500
|
+
responses: {
|
|
12501
|
+
400: components["responses"]["BadRequest"];
|
|
12502
|
+
401: components["responses"]["Unauthorized"];
|
|
12503
|
+
410: components["responses"]["WebhookGone"];
|
|
12504
|
+
"2XX": components["responses"]["WebhookAccepted"];
|
|
12505
|
+
"5XX": components["responses"]["WebhookServerError"];
|
|
12202
12506
|
};
|
|
12203
12507
|
};
|
|
12204
|
-
|
|
12205
|
-
|
|
12206
|
-
|
|
12207
|
-
|
|
12208
|
-
|
|
12209
|
-
|
|
12210
|
-
|
|
12211
|
-
|
|
12212
|
-
|
|
12213
|
-
|
|
12214
|
-
|
|
12215
|
-
|
|
12216
|
-
|
|
12217
|
-
|
|
12218
|
-
|
|
12219
|
-
|
|
12220
|
-
|
|
12221
|
-
|
|
12222
|
-
}
|
|
12223
|
-
|
|
12224
|
-
|
|
12225
|
-
|
|
12226
|
-
|
|
12227
|
-
|
|
12228
|
-
|
|
12229
|
-
|
|
12230
|
-
|
|
12231
|
-
|
|
12232
|
-
|
|
12233
|
-
|
|
12234
|
-
|
|
12235
|
-
|
|
12236
|
-
|
|
12237
|
-
|
|
12238
|
-
|
|
12239
|
-
|
|
12240
|
-
|
|
12241
|
-
|
|
12242
|
-
|
|
12243
|
-
|
|
12244
|
-
|
|
12245
|
-
|
|
12246
|
-
|
|
12247
|
-
|
|
12248
|
-
|
|
12249
|
-
|
|
12250
|
-
|
|
12251
|
-
|
|
12252
|
-
|
|
12253
|
-
|
|
12254
|
-
|
|
12255
|
-
|
|
12256
|
-
|
|
12257
|
-
|
|
12258
|
-
|
|
12259
|
-
|
|
12260
|
-
|
|
12261
|
-
|
|
12262
|
-
|
|
12263
|
-
|
|
12264
|
-
|
|
12265
|
-
|
|
12266
|
-
|
|
12267
|
-
|
|
12268
|
-
|
|
12269
|
-
|
|
12270
|
-
|
|
12271
|
-
|
|
12272
|
-
|
|
12273
|
-
*/
|
|
12274
|
-
declare function createTimeoutMiddleware(timeoutMs: number): {
|
|
12275
|
-
onRequest: ({
|
|
12276
|
-
request
|
|
12277
|
-
}: {
|
|
12278
|
-
request: Request;
|
|
12279
|
-
}) => Promise<Request>;
|
|
12280
|
-
}; //#endregion
|
|
12281
|
-
//#region src/middleware/headers.d.ts
|
|
12282
|
-
/**
|
|
12283
|
-
* Header transformation and merging utilities for Commerce Engine SDKs
|
|
12284
|
-
*/
|
|
12285
|
-
/**
|
|
12286
|
-
* Merge two header objects
|
|
12287
|
-
* Method-level headers take precedence over default headers
|
|
12288
|
-
*
|
|
12289
|
-
* @param defaultHeaders - Default headers from SDK configuration
|
|
12290
|
-
* @param methodHeaders - Headers passed to the specific method call
|
|
12291
|
-
* @returns Merged headers object
|
|
12292
|
-
*/
|
|
12293
|
-
declare function mergeHeaders<T extends Record<string, any> = Record<string, any>>(defaultHeaders?: Record<string, any>, methodHeaders?: T): T;
|
|
12294
|
-
/**
|
|
12295
|
-
* Transform headers using a transformation mapping
|
|
12296
|
-
* Headers not in the transformation map are passed through unchanged
|
|
12297
|
-
*
|
|
12298
|
-
* @param headers - Headers object with original names
|
|
12299
|
-
* @param transformations - Mapping of original names to transformed names
|
|
12300
|
-
* @returns Headers object with transformed names
|
|
12301
|
-
*/
|
|
12302
|
-
declare function transformHeaders(headers: Record<string, any>, transformations: Record<string, string>): Record<string, string>;
|
|
12508
|
+
"payment-refund-created": {
|
|
12509
|
+
parameters: {
|
|
12510
|
+
query?: never;
|
|
12511
|
+
header?: never;
|
|
12512
|
+
path?: never;
|
|
12513
|
+
cookie?: never;
|
|
12514
|
+
};
|
|
12515
|
+
requestBody: {
|
|
12516
|
+
content: {
|
|
12517
|
+
"application/json": components["schemas"]["OrderRefund"];
|
|
12518
|
+
};
|
|
12519
|
+
};
|
|
12520
|
+
responses: {
|
|
12521
|
+
400: components["responses"]["BadRequest"];
|
|
12522
|
+
401: components["responses"]["Unauthorized"];
|
|
12523
|
+
410: components["responses"]["WebhookGone"];
|
|
12524
|
+
"2XX": components["responses"]["WebhookAccepted"];
|
|
12525
|
+
"5XX": components["responses"]["WebhookServerError"];
|
|
12526
|
+
};
|
|
12527
|
+
};
|
|
12528
|
+
"payment-refund-success": {
|
|
12529
|
+
parameters: {
|
|
12530
|
+
query?: never;
|
|
12531
|
+
header?: never;
|
|
12532
|
+
path?: never;
|
|
12533
|
+
cookie?: never;
|
|
12534
|
+
};
|
|
12535
|
+
requestBody: {
|
|
12536
|
+
content: {
|
|
12537
|
+
"application/json": components["schemas"]["OrderRefund"];
|
|
12538
|
+
};
|
|
12539
|
+
};
|
|
12540
|
+
responses: {
|
|
12541
|
+
400: components["responses"]["BadRequest"];
|
|
12542
|
+
401: components["responses"]["Unauthorized"];
|
|
12543
|
+
410: components["responses"]["WebhookGone"];
|
|
12544
|
+
"2XX": components["responses"]["WebhookAccepted"];
|
|
12545
|
+
"5XX": components["responses"]["WebhookServerError"];
|
|
12546
|
+
};
|
|
12547
|
+
};
|
|
12548
|
+
"payment-refund-failed": {
|
|
12549
|
+
parameters: {
|
|
12550
|
+
query?: never;
|
|
12551
|
+
header?: never;
|
|
12552
|
+
path?: never;
|
|
12553
|
+
cookie?: never;
|
|
12554
|
+
};
|
|
12555
|
+
requestBody: {
|
|
12556
|
+
content: {
|
|
12557
|
+
"application/json": components["schemas"]["OrderRefund"];
|
|
12558
|
+
};
|
|
12559
|
+
};
|
|
12560
|
+
responses: {
|
|
12561
|
+
400: components["responses"]["BadRequest"];
|
|
12562
|
+
401: components["responses"]["Unauthorized"];
|
|
12563
|
+
410: components["responses"]["WebhookGone"];
|
|
12564
|
+
"2XX": components["responses"]["WebhookAccepted"];
|
|
12565
|
+
"5XX": components["responses"]["WebhookServerError"];
|
|
12566
|
+
};
|
|
12567
|
+
};
|
|
12568
|
+
}
|
|
12569
|
+
//#endregion
|
|
12570
|
+
//#region src/lib/shared/client.d.ts
|
|
12571
|
+
type StorefrontClientBaseConfig = BaseSDKOptions<SupportedDefaultHeaders> & {
|
|
12572
|
+
storeId: string;
|
|
12573
|
+
environment?: PublicStorefrontSDKOptions["environment"];
|
|
12574
|
+
baseUrl?: string;
|
|
12575
|
+
apiKey?: string;
|
|
12576
|
+
};
|
|
12303
12577
|
/**
|
|
12304
|
-
*
|
|
12305
|
-
* Transforms default headers, then merges with method headers
|
|
12578
|
+
* Shared base class for Storefront API clients.
|
|
12306
12579
|
*
|
|
12307
|
-
*
|
|
12308
|
-
*
|
|
12309
|
-
*
|
|
12310
|
-
* @returns Merged headers object with transformations applied
|
|
12580
|
+
* This centralizes Storefront-specific URL construction, default header
|
|
12581
|
+
* transformations, and shared API key state while leaving auth middleware
|
|
12582
|
+
* decisions to the public and session-specific subclasses.
|
|
12311
12583
|
*/
|
|
12312
|
-
declare
|
|
12584
|
+
declare class StorefrontAPIClientBase extends BaseAPIClient<paths, SupportedDefaultHeaders> {
|
|
12585
|
+
protected apiKey?: string;
|
|
12586
|
+
constructor(config: StorefrontClientBaseConfig);
|
|
12587
|
+
setApiKey(apiKey: string): void;
|
|
12588
|
+
clearApiKey(): void;
|
|
12589
|
+
useMiddleware(middleware: Parameters<typeof this.client.use>[0]): void;
|
|
12590
|
+
}
|
|
12313
12591
|
//#endregion
|
|
12314
|
-
//#region src/lib/client.d.ts
|
|
12592
|
+
//#region src/lib/session/client.d.ts
|
|
12593
|
+
type SessionStorefrontClientConfig = StorefrontClientBaseConfig & SessionStorefrontSDKOptions & {
|
|
12594
|
+
sessionManager: StorefrontSessionManager;
|
|
12595
|
+
};
|
|
12315
12596
|
/**
|
|
12316
12597
|
* Storefront API client that extends the generic BaseAPIClient
|
|
12317
12598
|
* Adds Commerce Engine specific authentication and token management
|
|
12318
12599
|
*/
|
|
12319
|
-
declare class
|
|
12320
|
-
protected config:
|
|
12321
|
-
private initializationPromise;
|
|
12600
|
+
declare class SessionStorefrontAPIClient extends StorefrontAPIClientBase {
|
|
12601
|
+
protected config: SessionStorefrontClientConfig;
|
|
12322
12602
|
/**
|
|
12323
|
-
* Create a new
|
|
12603
|
+
* Create a new SessionStorefrontAPIClient
|
|
12324
12604
|
*
|
|
12325
12605
|
* @param config - Configuration for the API client
|
|
12326
12606
|
*/
|
|
12327
|
-
constructor(config:
|
|
12607
|
+
constructor(config: SessionStorefrontClientConfig);
|
|
12328
12608
|
/**
|
|
12329
12609
|
* Set up Storefront-specific authentication middleware
|
|
12330
12610
|
*/
|
|
12331
12611
|
private setupStorefrontAuth;
|
|
12332
12612
|
/**
|
|
12333
12613
|
* Get the authorization header value
|
|
12334
|
-
*
|
|
12335
|
-
* Otherwise returns the manual token
|
|
12614
|
+
* without creating a new session.
|
|
12336
12615
|
*
|
|
12337
12616
|
* @returns The Authorization header value or empty string if no token is set
|
|
12338
12617
|
*/
|
|
@@ -12367,27 +12646,47 @@ declare class StorefrontAPIClient extends BaseAPIClient<paths, SupportedDefaultH
|
|
|
12367
12646
|
*/
|
|
12368
12647
|
clearApiKey(): void;
|
|
12369
12648
|
/**
|
|
12370
|
-
*
|
|
12649
|
+
* Resolve the current user ID from explicit parameters or the active session.
|
|
12650
|
+
*
|
|
12651
|
+
* @param explicitUserId - Optional user ID supplied by the caller
|
|
12652
|
+
* @returns The resolved user ID
|
|
12653
|
+
* @throws When no user ID is available
|
|
12654
|
+
*/
|
|
12655
|
+
protected resolveCurrentUserId(explicitUserId?: string): Promise<string>;
|
|
12656
|
+
/**
|
|
12657
|
+
* Resolve path parameters that require `user_id`.
|
|
12658
|
+
*
|
|
12659
|
+
* @param pathParams - Path parameters with an optional `user_id`
|
|
12660
|
+
* @returns Path parameters with a guaranteed `user_id`
|
|
12371
12661
|
*/
|
|
12372
|
-
|
|
12373
|
-
|
|
12374
|
-
|
|
12375
|
-
|
|
12376
|
-
|
|
12377
|
-
* URL utility functions for the Storefront SDK
|
|
12378
|
-
*/
|
|
12379
|
-
/**
|
|
12380
|
-
* Available API environments for Commerce Engine
|
|
12381
|
-
*/
|
|
12382
|
-
declare enum Environment {
|
|
12662
|
+
protected resolveUserPathParams<T extends {
|
|
12663
|
+
user_id: string;
|
|
12664
|
+
}>(pathParams: Omit<T, "user_id"> & {
|
|
12665
|
+
user_id?: string;
|
|
12666
|
+
}): Promise<T>;
|
|
12383
12667
|
/**
|
|
12384
|
-
*
|
|
12668
|
+
* Resolve query parameters that require `user_id`.
|
|
12669
|
+
*
|
|
12670
|
+
* @param queryParams - Query parameters with an optional `user_id`
|
|
12671
|
+
* @returns Query parameters with a guaranteed `user_id`
|
|
12385
12672
|
*/
|
|
12386
|
-
|
|
12673
|
+
protected resolveUserQueryParams<T extends {
|
|
12674
|
+
user_id: string;
|
|
12675
|
+
}>(queryParams: Omit<T, "user_id"> & {
|
|
12676
|
+
user_id?: string;
|
|
12677
|
+
}): Promise<T>;
|
|
12387
12678
|
/**
|
|
12388
|
-
*
|
|
12679
|
+
* Resolve path parameters that require `customer_id`.
|
|
12680
|
+
*
|
|
12681
|
+
* @param pathParams - Path parameters with an optional `customer_id`
|
|
12682
|
+
* @returns Path parameters with a guaranteed `customer_id`
|
|
12683
|
+
* @throws When the user is anonymous or no session can be established
|
|
12389
12684
|
*/
|
|
12390
|
-
|
|
12685
|
+
protected resolveCustomerPathParams<T extends {
|
|
12686
|
+
customer_id: string;
|
|
12687
|
+
}>(pathParams: Omit<T, "customer_id"> & {
|
|
12688
|
+
customer_id?: string;
|
|
12689
|
+
}): Promise<T>;
|
|
12391
12690
|
}
|
|
12392
12691
|
//#endregion
|
|
12393
12692
|
//#region src/types/storefront-api-types.d.ts
|
|
@@ -12498,7 +12797,6 @@ type JuspayUpiCollectInput = Writable<components['schemas']['JuspayUpiCollect']>
|
|
|
12498
12797
|
type JuspayUpiIntentInput = Writable<components['schemas']['JuspayUpiIntent']>;
|
|
12499
12798
|
type JuspayUpiPaymentMethod = Readable<components['schemas']['JuspayUpiPaymentMethod']>;
|
|
12500
12799
|
type JuspayWalletPaymentMethod = Readable<components['schemas']['JuspayWalletPaymentMethod']>;
|
|
12501
|
-
type KycDocument = Readable<components['schemas']['KycDocument']>;
|
|
12502
12800
|
type KycDocumentConfig = Readable<components['schemas']['KycDocumentConfig']>;
|
|
12503
12801
|
type LotBatchDetail = Readable<components['schemas']['LotBatchDetail']>;
|
|
12504
12802
|
type LoyaltyPointActivity = Readable<components['schemas']['LoyaltyPointActivity']>;
|
|
@@ -12506,7 +12804,6 @@ type ManualPaymentMethod = Readable<components['schemas']['ManualPaymentMethod']
|
|
|
12506
12804
|
type MarketplaceItem = Readable<components['schemas']['MarketplaceItem']>;
|
|
12507
12805
|
type MarketplaceProduct = Readable<components['schemas']['MarketplaceProduct']>;
|
|
12508
12806
|
type MarketplaceProductDetail = Readable<components['schemas']['MarketplaceProductDetail']>;
|
|
12509
|
-
type MeasurementUnit = Readable<components['schemas']['MeasurementUnit']>;
|
|
12510
12807
|
type MultiSelectAttribute = Readable<components['schemas']['MultiSelectAttribute']>;
|
|
12511
12808
|
type NetbankingPayment = Readable<components['schemas']['NetbankingPayment']>;
|
|
12512
12809
|
type NotificationChannelPreferences = Readable<components['schemas']['NotificationChannelPreferences']>;
|
|
@@ -12524,6 +12821,7 @@ type OrderReturn = Readable<components['schemas']['OrderReturn']>;
|
|
|
12524
12821
|
type OrderReturnItem = Readable<components['schemas']['OrderReturnItem']>;
|
|
12525
12822
|
type OrderReturnItemInput = Writable<components['schemas']['OrderReturnItem']>;
|
|
12526
12823
|
type OrderShipment = Readable<components['schemas']['OrderShipment']>;
|
|
12824
|
+
type OtpContent = Readable<components['schemas']['OtpContent']>;
|
|
12527
12825
|
type Pagination = Readable<components['schemas']['Pagination']>;
|
|
12528
12826
|
type PanDetail = Readable<components['schemas']['PanDetail']>;
|
|
12529
12827
|
type PartialCollectAndDelivery = Readable<components['schemas']['PartialCollectAndDelivery']>;
|
|
@@ -12569,6 +12867,8 @@ type SellerDetail = Readable<components['schemas']['SellerDetail']>;
|
|
|
12569
12867
|
type SellerInfo = Readable<components['schemas']['SellerInfo']>;
|
|
12570
12868
|
type SellerReview = Readable<components['schemas']['SellerReview']>;
|
|
12571
12869
|
type SellerReviewStats = Readable<components['schemas']['SellerReviewStats']>;
|
|
12870
|
+
type SendOtpWithEmailInput = Writable<components['schemas']['SendOtpWithEmail']>;
|
|
12871
|
+
type SendOtpWithPhoneInput = Writable<components['schemas']['SendOtpWithPhone']>;
|
|
12572
12872
|
type Seo = Readable<components['schemas']['Seo']>;
|
|
12573
12873
|
type ServiceProviderBasicDetail = Readable<components['schemas']['ServiceProviderBasicDetail']>;
|
|
12574
12874
|
type ShipmentItem = Readable<components['schemas']['ShipmentItem']>;
|
|
@@ -12607,6 +12907,7 @@ type ChangePasswordContent = ChangePasswordResponse['content'];
|
|
|
12607
12907
|
type ChangePasswordBody = Writable<NonNullable<paths['/auth/change-password']['post']['requestBody']>['content']['application/json']>;
|
|
12608
12908
|
type ForgotPasswordResponse = Readable<paths['/auth/forgot-password']['post']['responses'][200]['content']['application/json']>;
|
|
12609
12909
|
type ForgotPasswordContent = ForgotPasswordResponse['content'];
|
|
12910
|
+
type ForgotPasswordHeaderParams = paths['/auth/forgot-password']['post']['parameters']['header'];
|
|
12610
12911
|
type ForgotPasswordBody = Writable<NonNullable<paths['/auth/forgot-password']['post']['requestBody']>['content']['application/json']>;
|
|
12611
12912
|
type GenerateOtpResponse = Readable<paths['/auth/generate-otp']['post']['responses'][200]['content']['application/json']>;
|
|
12612
12913
|
type GenerateOtpContent = GenerateOtpResponse['content'];
|
|
@@ -12634,15 +12935,19 @@ type RefreshTokenContent = RefreshTokenResponse['content'];
|
|
|
12634
12935
|
type RefreshTokenBody = Writable<NonNullable<paths['/auth/refresh-token']['post']['requestBody']>['content']['application/json']>;
|
|
12635
12936
|
type RegisterWithEmailResponse = Readable<paths['/auth/register/email']['post']['responses'][200]['content']['application/json']>;
|
|
12636
12937
|
type RegisterWithEmailContent = RegisterWithEmailResponse['content'];
|
|
12938
|
+
type RegisterWithEmailHeaderParams = paths['/auth/register/email']['post']['parameters']['header'];
|
|
12637
12939
|
type RegisterWithEmailBody = Writable<NonNullable<paths['/auth/register/email']['post']['requestBody']>['content']['application/json']>;
|
|
12638
12940
|
type RegisterWithPasswordResponse = Readable<paths['/auth/register/password']['post']['responses'][200]['content']['application/json']>;
|
|
12639
12941
|
type RegisterWithPasswordContent = RegisterWithPasswordResponse['content'];
|
|
12942
|
+
type RegisterWithPasswordHeaderParams = paths['/auth/register/password']['post']['parameters']['header'];
|
|
12640
12943
|
type RegisterWithPasswordBody = Writable<NonNullable<paths['/auth/register/password']['post']['requestBody']>['content']['application/json']>;
|
|
12641
12944
|
type RegisterWithPhoneResponse = Readable<paths['/auth/register/phone']['post']['responses'][200]['content']['application/json']>;
|
|
12642
12945
|
type RegisterWithPhoneContent = RegisterWithPhoneResponse['content'];
|
|
12946
|
+
type RegisterWithPhoneHeaderParams = paths['/auth/register/phone']['post']['parameters']['header'];
|
|
12643
12947
|
type RegisterWithPhoneBody = Writable<NonNullable<paths['/auth/register/phone']['post']['requestBody']>['content']['application/json']>;
|
|
12644
12948
|
type RegisterWithWhatsappResponse = Readable<paths['/auth/register/whatsapp']['post']['responses'][200]['content']['application/json']>;
|
|
12645
12949
|
type RegisterWithWhatsappContent = RegisterWithWhatsappResponse['content'];
|
|
12950
|
+
type RegisterWithWhatsappHeaderParams = paths['/auth/register/whatsapp']['post']['parameters']['header'];
|
|
12646
12951
|
type RegisterWithWhatsappBody = Writable<NonNullable<paths['/auth/register/whatsapp']['post']['requestBody']>['content']['application/json']>;
|
|
12647
12952
|
type ResetPasswordResponse = Readable<paths['/auth/reset-password']['post']['responses'][200]['content']['application/json']>;
|
|
12648
12953
|
type ResetPasswordContent = ResetPasswordResponse['content'];
|
|
@@ -12658,17 +12963,6 @@ type DeleteUserResponse = Readable<paths['/auth/user/{id}']['delete']['responses
|
|
|
12658
12963
|
type DeleteUserPathParams = paths['/auth/user/{id}']['delete']['parameters']['path'];
|
|
12659
12964
|
type DeactivateUserResponse = Readable<paths['/auth/user/{id}/deactivate']['put']['responses'][200]['content']['application/json']>;
|
|
12660
12965
|
type DeactivateUserPathParams = paths['/auth/user/{id}/deactivate']['put']['parameters']['path'];
|
|
12661
|
-
type GetNotificationPreferencesResponse = Readable<paths['/auth/user/{id}/notification-preferences']['get']['responses'][200]['content']['application/json']>;
|
|
12662
|
-
type GetNotificationPreferencesContent = GetNotificationPreferencesResponse['content'];
|
|
12663
|
-
type GetNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['get']['parameters']['path'];
|
|
12664
|
-
type CreateNotificationPreferencesResponse = Readable<paths['/auth/user/{id}/notification-preferences']['post']['responses'][200]['content']['application/json']>;
|
|
12665
|
-
type CreateNotificationPreferencesContent = CreateNotificationPreferencesResponse['content'];
|
|
12666
|
-
type CreateNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['post']['parameters']['path'];
|
|
12667
|
-
type CreateNotificationPreferencesBody = Writable<NonNullable<paths['/auth/user/{id}/notification-preferences']['post']['requestBody']>['content']['application/json']>;
|
|
12668
|
-
type UpdateNotificationPreferencesResponse = Readable<paths['/auth/user/{id}/notification-preferences']['put']['responses'][200]['content']['application/json']>;
|
|
12669
|
-
type UpdateNotificationPreferencesContent = UpdateNotificationPreferencesResponse['content'];
|
|
12670
|
-
type UpdateNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['put']['parameters']['path'];
|
|
12671
|
-
type UpdateNotificationPreferencesBody = Writable<NonNullable<paths['/auth/user/{id}/notification-preferences']['put']['requestBody']>['content']['application/json']>;
|
|
12672
12966
|
type AddProfileImageResponse = Readable<paths['/auth/user/{id}/profile-image']['post']['responses'][200]['content']['application/json']>;
|
|
12673
12967
|
type AddProfileImageContent = AddProfileImageResponse['content'];
|
|
12674
12968
|
type AddProfileImagePathParams = paths['/auth/user/{id}/profile-image']['post']['parameters']['path'];
|
|
@@ -12777,11 +13071,11 @@ type ListMarketplaceUpsellProductsResponse = Readable<paths['/catalog/marketplac
|
|
|
12777
13071
|
type ListMarketplaceUpsellProductsContent = ListMarketplaceUpsellProductsResponse['content'];
|
|
12778
13072
|
type ListMarketplaceUpsellProductsQuery = paths['/catalog/marketplace/products/up-sell']['get']['parameters']['query'];
|
|
12779
13073
|
type ListMarketplaceUpsellProductsHeaderParams = paths['/catalog/marketplace/products/up-sell']['get']['parameters']['header'];
|
|
12780
|
-
type GetMarketplaceProductDetailResponse = Readable<paths['/catalog/marketplace/products/{
|
|
13074
|
+
type GetMarketplaceProductDetailResponse = Readable<paths['/catalog/marketplace/products/{product_id}']['get']['responses'][200]['content']['application/json']>;
|
|
12781
13075
|
type GetMarketplaceProductDetailContent = GetMarketplaceProductDetailResponse['content'];
|
|
12782
|
-
type GetMarketplaceProductDetailQuery = paths['/catalog/marketplace/products/{
|
|
12783
|
-
type GetMarketplaceProductDetailPathParams = paths['/catalog/marketplace/products/{
|
|
12784
|
-
type GetMarketplaceProductDetailHeaderParams = paths['/catalog/marketplace/products/{
|
|
13076
|
+
type GetMarketplaceProductDetailQuery = paths['/catalog/marketplace/products/{product_id}']['get']['parameters']['query'];
|
|
13077
|
+
type GetMarketplaceProductDetailPathParams = paths['/catalog/marketplace/products/{product_id}']['get']['parameters']['path'];
|
|
13078
|
+
type GetMarketplaceProductDetailHeaderParams = paths['/catalog/marketplace/products/{product_id}']['get']['parameters']['header'];
|
|
12785
13079
|
type ListMarketplaceProductReviewsResponse = Readable<paths['/catalog/marketplace/products/{product_id}/reviews']['get']['responses'][200]['content']['application/json']>;
|
|
12786
13080
|
type ListMarketplaceProductReviewsContent = ListMarketplaceProductReviewsResponse['content'];
|
|
12787
13081
|
type ListMarketplaceProductReviewsQuery = paths['/catalog/marketplace/products/{product_id}/reviews']['get']['parameters']['query'];
|
|
@@ -12823,11 +13117,11 @@ type ListUpsellProductsResponse = Readable<paths['/catalog/products/up-sell']['g
|
|
|
12823
13117
|
type ListUpsellProductsContent = ListUpsellProductsResponse['content'];
|
|
12824
13118
|
type ListUpsellProductsQuery = paths['/catalog/products/up-sell']['get']['parameters']['query'];
|
|
12825
13119
|
type ListUpsellProductsHeaderParams = paths['/catalog/products/up-sell']['get']['parameters']['header'];
|
|
12826
|
-
type GetProductDetailResponse = Readable<paths['/catalog/products/{
|
|
13120
|
+
type GetProductDetailResponse = Readable<paths['/catalog/products/{product_id}']['get']['responses'][200]['content']['application/json']>;
|
|
12827
13121
|
type GetProductDetailContent = GetProductDetailResponse['content'];
|
|
12828
|
-
type GetProductDetailQuery = paths['/catalog/products/{
|
|
12829
|
-
type GetProductDetailPathParams = paths['/catalog/products/{
|
|
12830
|
-
type GetProductDetailHeaderParams = paths['/catalog/products/{
|
|
13122
|
+
type GetProductDetailQuery = paths['/catalog/products/{product_id}']['get']['parameters']['query'];
|
|
13123
|
+
type GetProductDetailPathParams = paths['/catalog/products/{product_id}']['get']['parameters']['path'];
|
|
13124
|
+
type GetProductDetailHeaderParams = paths['/catalog/products/{product_id}']['get']['parameters']['header'];
|
|
12831
13125
|
type ListProductReviewsResponse = Readable<paths['/catalog/products/{product_id}/reviews']['get']['responses'][200]['content']['application/json']>;
|
|
12832
13126
|
type ListProductReviewsContent = ListProductReviewsResponse['content'];
|
|
12833
13127
|
type ListProductReviewsQuery = paths['/catalog/products/{product_id}/reviews']['get']['parameters']['query'];
|
|
@@ -12858,60 +13152,60 @@ type ListCountryPincodesPathParams = paths['/common/countries/{country_iso_code}
|
|
|
12858
13152
|
type ListCountryStatesResponse = Readable<paths['/common/countries/{country_iso_code}/states']['get']['responses'][200]['content']['application/json']>;
|
|
12859
13153
|
type ListCountryStatesContent = ListCountryStatesResponse['content'];
|
|
12860
13154
|
type ListCountryStatesPathParams = paths['/common/countries/{country_iso_code}/states']['get']['parameters']['path'];
|
|
13155
|
+
type ListAddressesResponse = Readable<paths['/customers/{customer_id}/addresses']['get']['responses'][200]['content']['application/json']>;
|
|
13156
|
+
type ListAddressesContent = ListAddressesResponse['content'];
|
|
13157
|
+
type ListAddressesQuery = paths['/customers/{customer_id}/addresses']['get']['parameters']['query'];
|
|
13158
|
+
type ListAddressesPathParams = paths['/customers/{customer_id}/addresses']['get']['parameters']['path'];
|
|
13159
|
+
type CreateAddressResponse = Readable<paths['/customers/{customer_id}/addresses']['post']['responses'][200]['content']['application/json']>;
|
|
13160
|
+
type CreateAddressContent = CreateAddressResponse['content'];
|
|
13161
|
+
type CreateAddressPathParams = paths['/customers/{customer_id}/addresses']['post']['parameters']['path'];
|
|
13162
|
+
type CreateAddressBody = Writable<NonNullable<paths['/customers/{customer_id}/addresses']['post']['requestBody']>['content']['application/json']>;
|
|
13163
|
+
type GetAddressDetailResponse = Readable<paths['/customers/{customer_id}/addresses/{address_id}']['get']['responses'][200]['content']['application/json']>;
|
|
13164
|
+
type GetAddressDetailContent = GetAddressDetailResponse['content'];
|
|
13165
|
+
type GetAddressDetailPathParams = paths['/customers/{customer_id}/addresses/{address_id}']['get']['parameters']['path'];
|
|
13166
|
+
type UpdateAddressDetailResponse = Readable<paths['/customers/{customer_id}/addresses/{address_id}']['put']['responses'][200]['content']['application/json']>;
|
|
13167
|
+
type UpdateAddressDetailContent = UpdateAddressDetailResponse['content'];
|
|
13168
|
+
type UpdateAddressDetailPathParams = paths['/customers/{customer_id}/addresses/{address_id}']['put']['parameters']['path'];
|
|
13169
|
+
type UpdateAddressDetailBody = Writable<NonNullable<paths['/customers/{customer_id}/addresses/{address_id}']['put']['requestBody']>['content']['application/json']>;
|
|
13170
|
+
type DeleteAddressResponse = Readable<paths['/customers/{customer_id}/addresses/{address_id}']['delete']['responses'][200]['content']['application/json']>;
|
|
13171
|
+
type DeleteAddressPathParams = paths['/customers/{customer_id}/addresses/{address_id}']['delete']['parameters']['path'];
|
|
12861
13172
|
type ListCustomerCardsResponse = Readable<paths['/customers/{customer_id}/cards']['get']['responses'][200]['content']['application/json']>;
|
|
12862
13173
|
type ListCustomerCardsContent = ListCustomerCardsResponse['content'];
|
|
12863
13174
|
type ListCustomerCardsPathParams = paths['/customers/{customer_id}/cards']['get']['parameters']['path'];
|
|
12864
|
-
type
|
|
12865
|
-
type ListSavedPaymentMethodsContent = ListSavedPaymentMethodsResponse['content'];
|
|
12866
|
-
type ListSavedPaymentMethodsQuery = paths['/customers/{customer_id}/payment-methods']['get']['parameters']['query'];
|
|
12867
|
-
type ListSavedPaymentMethodsPathParams = paths['/customers/{customer_id}/payment-methods']['get']['parameters']['path'];
|
|
12868
|
-
type ListDocumentsResponse = Readable<paths['/customers/{id}/documents']['get']['responses'][200]['content']['application/json']>;
|
|
13175
|
+
type ListDocumentsResponse = Readable<paths['/customers/{customer_id}/documents']['get']['responses'][200]['content']['application/json']>;
|
|
12869
13176
|
type ListDocumentsContent = ListDocumentsResponse['content'];
|
|
12870
|
-
type ListDocumentsPathParams = paths['/customers/{
|
|
12871
|
-
type CreateDocumentResponse = Readable<paths['/customers/{
|
|
13177
|
+
type ListDocumentsPathParams = paths['/customers/{customer_id}/documents']['get']['parameters']['path'];
|
|
13178
|
+
type CreateDocumentResponse = Readable<paths['/customers/{customer_id}/documents']['post']['responses'][200]['content']['application/json']>;
|
|
12872
13179
|
type CreateDocumentContent = CreateDocumentResponse['content'];
|
|
12873
|
-
type CreateDocumentPathParams = paths['/customers/{
|
|
12874
|
-
type CreateDocumentFormData = Writable<NonNullable<paths['/customers/{
|
|
12875
|
-
type VerifyDocumentResponse = Readable<paths['/customers/{
|
|
13180
|
+
type CreateDocumentPathParams = paths['/customers/{customer_id}/documents']['post']['parameters']['path'];
|
|
13181
|
+
type CreateDocumentFormData = Writable<NonNullable<paths['/customers/{customer_id}/documents']['post']['requestBody']>['content']['multipart/form-data']>;
|
|
13182
|
+
type VerifyDocumentResponse = Readable<paths['/customers/{customer_id}/documents/verify']['post']['responses'][200]['content']['application/json']>;
|
|
12876
13183
|
type VerifyDocumentContent = VerifyDocumentResponse['content'];
|
|
12877
|
-
type VerifyDocumentPathParams = paths['/customers/{
|
|
12878
|
-
type VerifyDocumentBody = Writable<NonNullable<paths['/customers/{
|
|
12879
|
-
type GetDocumentResponse = Readable<paths['/customers/{
|
|
13184
|
+
type VerifyDocumentPathParams = paths['/customers/{customer_id}/documents/verify']['post']['parameters']['path'];
|
|
13185
|
+
type VerifyDocumentBody = Writable<NonNullable<paths['/customers/{customer_id}/documents/verify']['post']['requestBody']>['content']['application/json']>;
|
|
13186
|
+
type GetDocumentResponse = Readable<paths['/customers/{customer_id}/documents/{document_id}']['get']['responses'][200]['content']['application/json']>;
|
|
12880
13187
|
type GetDocumentContent = GetDocumentResponse['content'];
|
|
12881
|
-
type GetDocumentPathParams = paths['/customers/{
|
|
12882
|
-
type UpdateDocumentResponse = Readable<paths['/customers/{
|
|
13188
|
+
type GetDocumentPathParams = paths['/customers/{customer_id}/documents/{document_id}']['get']['parameters']['path'];
|
|
13189
|
+
type UpdateDocumentResponse = Readable<paths['/customers/{customer_id}/documents/{document_id}']['put']['responses'][200]['content']['application/json']>;
|
|
12883
13190
|
type UpdateDocumentContent = UpdateDocumentResponse['content'];
|
|
12884
|
-
type UpdateDocumentPathParams = paths['/customers/{
|
|
12885
|
-
type UpdateDocumentFormData = Writable<NonNullable<paths['/customers/{
|
|
12886
|
-
type DeleteDocumentResponse = Readable<paths['/customers/{
|
|
12887
|
-
type DeleteDocumentPathParams = paths['/customers/{
|
|
12888
|
-
type
|
|
12889
|
-
type ListAddressesContent = ListAddressesResponse['content'];
|
|
12890
|
-
type ListAddressesQuery = paths['/customers/{user_id}/addresses']['get']['parameters']['query'];
|
|
12891
|
-
type ListAddressesPathParams = paths['/customers/{user_id}/addresses']['get']['parameters']['path'];
|
|
12892
|
-
type CreateAddressResponse = Readable<paths['/customers/{user_id}/addresses']['post']['responses'][200]['content']['application/json']>;
|
|
12893
|
-
type CreateAddressContent = CreateAddressResponse['content'];
|
|
12894
|
-
type CreateAddressPathParams = paths['/customers/{user_id}/addresses']['post']['parameters']['path'];
|
|
12895
|
-
type CreateAddressBody = Writable<NonNullable<paths['/customers/{user_id}/addresses']['post']['requestBody']>['content']['application/json']>;
|
|
12896
|
-
type GetAddressDetailResponse = Readable<paths['/customers/{user_id}/addresses/{address_id}']['get']['responses'][200]['content']['application/json']>;
|
|
12897
|
-
type GetAddressDetailContent = GetAddressDetailResponse['content'];
|
|
12898
|
-
type GetAddressDetailPathParams = paths['/customers/{user_id}/addresses/{address_id}']['get']['parameters']['path'];
|
|
12899
|
-
type UpdateAddressDetailResponse = Readable<paths['/customers/{user_id}/addresses/{address_id}']['put']['responses'][200]['content']['application/json']>;
|
|
12900
|
-
type UpdateAddressDetailContent = UpdateAddressDetailResponse['content'];
|
|
12901
|
-
type UpdateAddressDetailPathParams = paths['/customers/{user_id}/addresses/{address_id}']['put']['parameters']['path'];
|
|
12902
|
-
type UpdateAddressDetailBody = Writable<NonNullable<paths['/customers/{user_id}/addresses/{address_id}']['put']['requestBody']>['content']['application/json']>;
|
|
12903
|
-
type DeleteAddressResponse = Readable<paths['/customers/{user_id}/addresses/{address_id}']['delete']['responses'][200]['content']['application/json']>;
|
|
12904
|
-
type DeleteAddressPathParams = paths['/customers/{user_id}/addresses/{address_id}']['delete']['parameters']['path'];
|
|
12905
|
-
type GetLoyaltyDetailsResponse = Readable<paths['/customers/{user_id}/loyalty']['get']['responses'][200]['content']['application/json']>;
|
|
13191
|
+
type UpdateDocumentPathParams = paths['/customers/{customer_id}/documents/{document_id}']['put']['parameters']['path'];
|
|
13192
|
+
type UpdateDocumentFormData = Writable<NonNullable<paths['/customers/{customer_id}/documents/{document_id}']['put']['requestBody']>['content']['multipart/form-data']>;
|
|
13193
|
+
type DeleteDocumentResponse = Readable<paths['/customers/{customer_id}/documents/{document_id}']['delete']['responses'][200]['content']['application/json']>;
|
|
13194
|
+
type DeleteDocumentPathParams = paths['/customers/{customer_id}/documents/{document_id}']['delete']['parameters']['path'];
|
|
13195
|
+
type GetLoyaltyDetailsResponse = Readable<paths['/customers/{customer_id}/loyalty']['get']['responses'][200]['content']['application/json']>;
|
|
12906
13196
|
type GetLoyaltyDetailsContent = GetLoyaltyDetailsResponse['content'];
|
|
12907
|
-
type GetLoyaltyDetailsPathParams = paths['/customers/{
|
|
12908
|
-
type ListLoyaltyActivitiesResponse = Readable<paths['/customers/{
|
|
13197
|
+
type GetLoyaltyDetailsPathParams = paths['/customers/{customer_id}/loyalty']['get']['parameters']['path'];
|
|
13198
|
+
type ListLoyaltyActivitiesResponse = Readable<paths['/customers/{customer_id}/loyalty-points-activity']['get']['responses'][200]['content']['application/json']>;
|
|
12909
13199
|
type ListLoyaltyActivitiesContent = ListLoyaltyActivitiesResponse['content'];
|
|
12910
|
-
type ListLoyaltyActivitiesQuery = paths['/customers/{
|
|
12911
|
-
type ListLoyaltyActivitiesPathParams = paths['/customers/{
|
|
12912
|
-
type
|
|
12913
|
-
type
|
|
12914
|
-
type
|
|
13200
|
+
type ListLoyaltyActivitiesQuery = paths['/customers/{customer_id}/loyalty-points-activity']['get']['parameters']['query'];
|
|
13201
|
+
type ListLoyaltyActivitiesPathParams = paths['/customers/{customer_id}/loyalty-points-activity']['get']['parameters']['path'];
|
|
13202
|
+
type ListSavedPaymentMethodsResponse = Readable<paths['/customers/{customer_id}/payment-methods']['get']['responses'][200]['content']['application/json']>;
|
|
13203
|
+
type ListSavedPaymentMethodsContent = ListSavedPaymentMethodsResponse['content'];
|
|
13204
|
+
type ListSavedPaymentMethodsQuery = paths['/customers/{customer_id}/payment-methods']['get']['parameters']['query'];
|
|
13205
|
+
type ListSavedPaymentMethodsPathParams = paths['/customers/{customer_id}/payment-methods']['get']['parameters']['path'];
|
|
13206
|
+
type ListCustomerReviewsResponse = Readable<paths['/customers/{customer_id}/reviews']['get']['responses'][200]['content']['application/json']>;
|
|
13207
|
+
type ListCustomerReviewsContent = ListCustomerReviewsResponse['content'];
|
|
13208
|
+
type ListCustomerReviewsPathParams = paths['/customers/{customer_id}/reviews']['get']['parameters']['path'];
|
|
12915
13209
|
type CheckFulfillmentResponse = Readable<paths['/fulfillment/serviceability']['post']['responses'][200]['content']['application/json']>;
|
|
12916
13210
|
type CheckFulfillmentContent = CheckFulfillmentResponse['content'];
|
|
12917
13211
|
type CheckFulfillmentBody = Writable<NonNullable<paths['/fulfillment/serviceability']['post']['requestBody']>['content']['application/json']>;
|
|
@@ -13086,11 +13380,11 @@ type PosListUpsellProductsResponse = Readable<paths['/pos/catalog/products/up-se
|
|
|
13086
13380
|
type PosListUpsellProductsContent = PosListUpsellProductsResponse['content'];
|
|
13087
13381
|
type PosListUpsellProductsQuery = paths['/pos/catalog/products/up-sell']['get']['parameters']['query'];
|
|
13088
13382
|
type PosListUpsellProductsHeaderParams = paths['/pos/catalog/products/up-sell']['get']['parameters']['header'];
|
|
13089
|
-
type PosGetProductDetailResponse = Readable<paths['/pos/catalog/products/{
|
|
13383
|
+
type PosGetProductDetailResponse = Readable<paths['/pos/catalog/products/{product_id}']['get']['responses'][200]['content']['application/json']>;
|
|
13090
13384
|
type PosGetProductDetailContent = PosGetProductDetailResponse['content'];
|
|
13091
|
-
type PosGetProductDetailQuery = paths['/pos/catalog/products/{
|
|
13092
|
-
type PosGetProductDetailPathParams = paths['/pos/catalog/products/{
|
|
13093
|
-
type PosGetProductDetailHeaderParams = paths['/pos/catalog/products/{
|
|
13385
|
+
type PosGetProductDetailQuery = paths['/pos/catalog/products/{product_id}']['get']['parameters']['query'];
|
|
13386
|
+
type PosGetProductDetailPathParams = paths['/pos/catalog/products/{product_id}']['get']['parameters']['path'];
|
|
13387
|
+
type PosGetProductDetailHeaderParams = paths['/pos/catalog/products/{product_id}']['get']['parameters']['header'];
|
|
13094
13388
|
type PosListProductReviewsResponse = Readable<paths['/pos/catalog/products/{product_id}/reviews']['get']['responses'][200]['content']['application/json']>;
|
|
13095
13389
|
type PosListProductReviewsContent = PosListProductReviewsResponse['content'];
|
|
13096
13390
|
type PosListProductReviewsQuery = paths['/pos/catalog/products/{product_id}/reviews']['get']['parameters']['query'];
|
|
@@ -13167,11 +13461,11 @@ type DeleteFromWishlistContent = DeleteFromWishlistResponse['content'];
|
|
|
13167
13461
|
type DeleteFromWishlistPathParams = paths['/wishlist/{user_id}']['delete']['parameters']['path'];
|
|
13168
13462
|
type DeleteFromWishlistBody = Writable<NonNullable<paths['/wishlist/{user_id}']['delete']['requestBody']>['content']['application/json']>;
|
|
13169
13463
|
//#endregion
|
|
13170
|
-
//#region src/lib/catalog.d.ts
|
|
13464
|
+
//#region src/lib/shared/catalog.d.ts
|
|
13171
13465
|
/**
|
|
13172
13466
|
* Client for interacting with catalog endpoints
|
|
13173
13467
|
*/
|
|
13174
|
-
declare class
|
|
13468
|
+
declare class BaseCatalogClient extends StorefrontAPIClientBase {
|
|
13175
13469
|
/**
|
|
13176
13470
|
* List all products
|
|
13177
13471
|
*
|
|
@@ -13275,7 +13569,7 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13275
13569
|
/**
|
|
13276
13570
|
* Get details for a specific product
|
|
13277
13571
|
*
|
|
13278
|
-
* @param pathParams - The path parameters
|
|
13572
|
+
* @param pathParams - The path parameters. Accepts product ID or product slug.
|
|
13279
13573
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
13280
13574
|
* @returns Promise with product details
|
|
13281
13575
|
*
|
|
@@ -13283,7 +13577,7 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13283
13577
|
* ```typescript
|
|
13284
13578
|
* // Get product by ID
|
|
13285
13579
|
* const { data, error } = await sdk.catalog.getProductDetail(
|
|
13286
|
-
* {
|
|
13580
|
+
* { product_id: "prod_123" }
|
|
13287
13581
|
* );
|
|
13288
13582
|
*
|
|
13289
13583
|
* if (error) {
|
|
@@ -13295,14 +13589,15 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13295
13589
|
* console.log("Price:", data.product.pricing?.selling_price);
|
|
13296
13590
|
* console.log("Description:", data.product.short_description);
|
|
13297
13591
|
*
|
|
13298
|
-
* // Get product by slug
|
|
13592
|
+
* // Get product by slug (also accepted in place of product_id)
|
|
13299
13593
|
* const { data: slugData, error: slugError } = await sdk.catalog.getProductDetail({
|
|
13300
|
-
*
|
|
13594
|
+
* product_id: "detox-candy"
|
|
13301
13595
|
* });
|
|
13302
13596
|
*
|
|
13303
13597
|
* // Override customer group ID for this specific request
|
|
13304
13598
|
* const { data: overrideData, error: overrideError } = await sdk.catalog.getProductDetail(
|
|
13305
|
-
* {
|
|
13599
|
+
* { product_id: "detox-candy" },
|
|
13600
|
+
* undefined,
|
|
13306
13601
|
* {
|
|
13307
13602
|
* "x-customer-group-id": "premium_customers" // Override default SDK config
|
|
13308
13603
|
* }
|
|
@@ -13320,12 +13615,13 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13320
13615
|
/**
|
|
13321
13616
|
* List all variants for a specific product
|
|
13322
13617
|
*
|
|
13323
|
-
* @param pathParams - The path parameters
|
|
13618
|
+
* @param pathParams - The path parameters. Accepts product ID or product slug.
|
|
13324
13619
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
13325
13620
|
* @returns Promise with product variants and pagination info
|
|
13326
13621
|
*
|
|
13327
13622
|
* @example
|
|
13328
13623
|
* ```typescript
|
|
13624
|
+
* // By product ID
|
|
13329
13625
|
* const { data, error } = await sdk.catalog.listProductVariants(
|
|
13330
13626
|
* { product_id: "prod_123" }
|
|
13331
13627
|
* );
|
|
@@ -13341,9 +13637,15 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13341
13637
|
* console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.pricing?.selling_price}`);
|
|
13342
13638
|
* });
|
|
13343
13639
|
*
|
|
13640
|
+
* // By product slug (also accepted in place of product_id)
|
|
13641
|
+
* const { data: slugData, error: slugError } = await sdk.catalog.listProductVariants(
|
|
13642
|
+
* { product_id: "detox-candy" }
|
|
13643
|
+
* );
|
|
13644
|
+
*
|
|
13344
13645
|
* // Override customer group ID for this specific request
|
|
13345
13646
|
* const { data: overrideData, error: overrideError } = await sdk.catalog.listProductVariants(
|
|
13346
13647
|
* { product_id: "prod_123" },
|
|
13648
|
+
* undefined,
|
|
13347
13649
|
* {
|
|
13348
13650
|
* "x-customer-group-id": "wholesale_customers" // Override default SDK config
|
|
13349
13651
|
* }
|
|
@@ -13354,12 +13656,13 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13354
13656
|
/**
|
|
13355
13657
|
* Get details for a specific product variant
|
|
13356
13658
|
*
|
|
13357
|
-
* @param pathParams - The path parameters
|
|
13659
|
+
* @param pathParams - The path parameters. Accepts product ID or slug for product_id, and variant ID or slug for variant_id.
|
|
13358
13660
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
13359
13661
|
* @returns Promise with variant details
|
|
13360
13662
|
*
|
|
13361
13663
|
* @example
|
|
13362
13664
|
* ```typescript
|
|
13665
|
+
* // By product ID and variant ID
|
|
13363
13666
|
* const { data, error } = await sdk.catalog.getVariantDetail(
|
|
13364
13667
|
* {
|
|
13365
13668
|
* product_id: "prod_123",
|
|
@@ -13376,6 +13679,14 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13376
13679
|
* console.log("SKU:", data.variant.sku);
|
|
13377
13680
|
* console.log("Price:", data.variant.pricing?.selling_price);
|
|
13378
13681
|
* console.log("Stock available:", data.variant.stock_available);
|
|
13682
|
+
*
|
|
13683
|
+
* // By product slug and variant slug (also accepted in place of IDs)
|
|
13684
|
+
* const { data: slugData, error: slugError } = await sdk.catalog.getVariantDetail(
|
|
13685
|
+
* {
|
|
13686
|
+
* product_id: "detox-candy",
|
|
13687
|
+
* variant_id: "detox-candy-100g"
|
|
13688
|
+
* }
|
|
13689
|
+
* );
|
|
13379
13690
|
* ```
|
|
13380
13691
|
*/
|
|
13381
13692
|
getVariantDetail(pathParams: GetVariantDetailPathParams, options?: GetVariantDetailQuery, headers?: GetVariantDetailHeaderParams): Promise<ApiResult<GetVariantDetailContent>>;
|
|
@@ -13445,38 +13756,6 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13445
13756
|
* ```
|
|
13446
13757
|
*/
|
|
13447
13758
|
listProductReviews(pathParams: ListProductReviewsPathParams, queryParams?: ListProductReviewsQuery): Promise<ApiResult<ListProductReviewsContent>>;
|
|
13448
|
-
/**
|
|
13449
|
-
* Create a product review
|
|
13450
|
-
*
|
|
13451
|
-
* @param pathParams - The path parameters (product ID)
|
|
13452
|
-
* @param formData - The review data including rating, comment, and optional images
|
|
13453
|
-
* @returns Promise with review creation response
|
|
13454
|
-
*
|
|
13455
|
-
* @example
|
|
13456
|
-
* ```typescript
|
|
13457
|
-
* const { data, error } = await sdk.catalog.createProductReview(
|
|
13458
|
-
* { product_id: "prod_123" },
|
|
13459
|
-
* {
|
|
13460
|
-
* user_id: "user_123",
|
|
13461
|
-
* order_number: "ORD-001",
|
|
13462
|
-
* rating: 5,
|
|
13463
|
-
* review_text: "Excellent product! Highly recommended.",
|
|
13464
|
-
* images: [
|
|
13465
|
-
* new File(["image data"], "review1.jpg", { type: "image/jpeg" }),
|
|
13466
|
-
* new File(["image data"], "review2.jpg", { type: "image/jpeg" })
|
|
13467
|
-
* ]
|
|
13468
|
-
* }
|
|
13469
|
-
* );
|
|
13470
|
-
*
|
|
13471
|
-
* if (error) {
|
|
13472
|
-
* console.error("Failed to create review:", error);
|
|
13473
|
-
* return;
|
|
13474
|
-
* }
|
|
13475
|
-
*
|
|
13476
|
-
* console.log("Review created successfully:", data.message);
|
|
13477
|
-
* ```
|
|
13478
|
-
*/
|
|
13479
|
-
createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
|
|
13480
13759
|
/**
|
|
13481
13760
|
* Search for products
|
|
13482
13761
|
*
|
|
@@ -13693,11 +13972,57 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
13693
13972
|
listSimilarProducts(options?: ListSimilarProductsQuery, headers?: ListSimilarProductsHeaderParams): Promise<ApiResult<ListSimilarProductsContent>>;
|
|
13694
13973
|
}
|
|
13695
13974
|
//#endregion
|
|
13975
|
+
//#region src/lib/public/catalog.d.ts
|
|
13976
|
+
/**
|
|
13977
|
+
* Client for interacting with catalog endpoints
|
|
13978
|
+
*/
|
|
13979
|
+
declare class PublicCatalogClient extends BaseCatalogClient {}
|
|
13980
|
+
//#endregion
|
|
13981
|
+
//#region src/lib/catalog.d.ts
|
|
13982
|
+
/**
|
|
13983
|
+
* Client for interacting with catalog endpoints
|
|
13984
|
+
*/
|
|
13985
|
+
declare class CatalogClient extends BaseCatalogClient {
|
|
13986
|
+
constructor(config: ConstructorParameters<typeof SessionStorefrontAPIClient>[0]);
|
|
13987
|
+
/**
|
|
13988
|
+
* Create a product review
|
|
13989
|
+
*
|
|
13990
|
+
* @param pathParams - The path parameters (product ID)
|
|
13991
|
+
* @param formData - The review data including rating, comment, and optional images
|
|
13992
|
+
* @returns Promise with review creation response
|
|
13993
|
+
*
|
|
13994
|
+
* @example
|
|
13995
|
+
* ```typescript
|
|
13996
|
+
* const { data, error } = await sdk.catalog.createProductReview(
|
|
13997
|
+
* { product_id: "prod_123" },
|
|
13998
|
+
* {
|
|
13999
|
+
* user_id: "user_123",
|
|
14000
|
+
* order_number: "ORD-001",
|
|
14001
|
+
* rating: 5,
|
|
14002
|
+
* review_text: "Excellent product! Highly recommended.",
|
|
14003
|
+
* images: [
|
|
14004
|
+
* new File(["image data"], "review1.jpg", { type: "image/jpeg" }),
|
|
14005
|
+
* new File(["image data"], "review2.jpg", { type: "image/jpeg" })
|
|
14006
|
+
* ]
|
|
14007
|
+
* }
|
|
14008
|
+
* );
|
|
14009
|
+
*
|
|
14010
|
+
* if (error) {
|
|
14011
|
+
* console.error("Failed to create review:", error);
|
|
14012
|
+
* return;
|
|
14013
|
+
* }
|
|
14014
|
+
*
|
|
14015
|
+
* console.log("Review created successfully:", data.message);
|
|
14016
|
+
* ```
|
|
14017
|
+
*/
|
|
14018
|
+
createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
|
|
14019
|
+
}
|
|
14020
|
+
//#endregion
|
|
13696
14021
|
//#region src/lib/cart.d.ts
|
|
13697
14022
|
/**
|
|
13698
14023
|
* Client for interacting with cart endpoints
|
|
13699
14024
|
*/
|
|
13700
|
-
declare class CartClient extends
|
|
14025
|
+
declare class CartClient extends SessionStorefrontAPIClient {
|
|
13701
14026
|
/**
|
|
13702
14027
|
* Create a new cart
|
|
13703
14028
|
*
|
|
@@ -13811,12 +14136,15 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
13811
14136
|
/**
|
|
13812
14137
|
* Get cart details by user ID
|
|
13813
14138
|
*
|
|
13814
|
-
* @param
|
|
14139
|
+
* @param pathParams - Optional path parameters. When `user_id` is omitted, the SDK resolves it from the active session.
|
|
13815
14140
|
* @returns Promise with cart details
|
|
13816
14141
|
* @example
|
|
13817
14142
|
* ```typescript
|
|
13818
|
-
* const { data, error } = await sdk.cart.getUserCart(
|
|
13819
|
-
*
|
|
14143
|
+
* const { data, error } = await sdk.cart.getUserCart();
|
|
14144
|
+
*
|
|
14145
|
+
* // You can still pass an explicit user_id when needed
|
|
14146
|
+
* const { data: asUser } = await sdk.cart.getUserCart({
|
|
14147
|
+
* user_id: "01H9USER12345ABCDE",
|
|
13820
14148
|
* });
|
|
13821
14149
|
*
|
|
13822
14150
|
* if (error) {
|
|
@@ -13827,16 +14155,22 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
13827
14155
|
* }
|
|
13828
14156
|
* ```
|
|
13829
14157
|
*/
|
|
13830
|
-
getUserCart(
|
|
14158
|
+
getUserCart(): Promise<ApiResult<GetUserCartContent>>;
|
|
14159
|
+
getUserCart(pathParams: {
|
|
14160
|
+
user_id: string;
|
|
14161
|
+
}): Promise<ApiResult<GetUserCartContent>>;
|
|
13831
14162
|
/**
|
|
13832
14163
|
* Delete a cart by user ID
|
|
13833
14164
|
*
|
|
13834
|
-
* @param
|
|
14165
|
+
* @param pathParams - Optional path parameters. When `user_id` is omitted, the SDK resolves it from the active session.
|
|
13835
14166
|
* @returns Promise that resolves when the cart is deleted
|
|
13836
14167
|
* @example
|
|
13837
14168
|
* ```typescript
|
|
13838
|
-
* const { data, error } = await sdk.cart.deleteUserCart(
|
|
13839
|
-
*
|
|
14169
|
+
* const { data, error } = await sdk.cart.deleteUserCart();
|
|
14170
|
+
*
|
|
14171
|
+
* // You can still pass an explicit user_id when needed
|
|
14172
|
+
* const { data: asUser } = await sdk.cart.deleteUserCart({
|
|
14173
|
+
* user_id: "01H9USER12345ABCDE",
|
|
13840
14174
|
* });
|
|
13841
14175
|
*
|
|
13842
14176
|
* if (error) {
|
|
@@ -13846,7 +14180,10 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
13846
14180
|
* }
|
|
13847
14181
|
* ```
|
|
13848
14182
|
*/
|
|
13849
|
-
deleteUserCart(
|
|
14183
|
+
deleteUserCart(): Promise<ApiResult<DeleteUserCartResponse>>;
|
|
14184
|
+
deleteUserCart(pathParams: {
|
|
14185
|
+
user_id: string;
|
|
14186
|
+
}): Promise<ApiResult<DeleteUserCartResponse>>;
|
|
13850
14187
|
/**
|
|
13851
14188
|
* Update cart addresses
|
|
13852
14189
|
*
|
|
@@ -14285,13 +14622,21 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
14285
14622
|
/**
|
|
14286
14623
|
* Get wishlist items
|
|
14287
14624
|
*
|
|
14288
|
-
* @param
|
|
14625
|
+
* @param pathParamsOrQuery - Optional path parameters or query parameters.
|
|
14289
14626
|
* @param options - Optional query parameters for filtering by seller_id (only for multi-seller marketplace stores)
|
|
14290
14627
|
* @returns Promise with wishlist items
|
|
14291
14628
|
* @example
|
|
14292
14629
|
* ```typescript
|
|
14293
|
-
* const { data, error } = await sdk.cart.getWishlist(
|
|
14294
|
-
*
|
|
14630
|
+
* const { data, error } = await sdk.cart.getWishlist();
|
|
14631
|
+
*
|
|
14632
|
+
* // With query parameters
|
|
14633
|
+
* const { data: filtered } = await sdk.cart.getWishlist({
|
|
14634
|
+
* seller_id: "seller_123",
|
|
14635
|
+
* });
|
|
14636
|
+
*
|
|
14637
|
+
* // You can still pass an explicit user_id when needed
|
|
14638
|
+
* const { data: asUser } = await sdk.cart.getWishlist({
|
|
14639
|
+
* user_id: "01H9USER12345ABCDE",
|
|
14295
14640
|
* });
|
|
14296
14641
|
*
|
|
14297
14642
|
* if (error) {
|
|
@@ -14305,20 +14650,30 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
14305
14650
|
* }
|
|
14306
14651
|
* ```
|
|
14307
14652
|
*/
|
|
14308
|
-
getWishlist(
|
|
14653
|
+
getWishlist(): Promise<ApiResult<GetWishlistContent>>;
|
|
14654
|
+
getWishlist(queryParams: GetWishlistQuery): Promise<ApiResult<GetWishlistContent>>;
|
|
14655
|
+
getWishlist(pathParams: {
|
|
14656
|
+
user_id: string;
|
|
14657
|
+
}, queryParams?: GetWishlistQuery): Promise<ApiResult<GetWishlistContent>>;
|
|
14309
14658
|
/**
|
|
14310
14659
|
* Add item to wishlist
|
|
14311
14660
|
*
|
|
14312
|
-
* @param
|
|
14313
|
-
* @param
|
|
14661
|
+
* @param pathParamsOrBody - Optional path parameters or the wishlist body.
|
|
14662
|
+
* @param maybeBody - The wishlist body when path parameters are provided.
|
|
14314
14663
|
* @returns Promise with updated wishlist
|
|
14315
14664
|
* @example
|
|
14316
14665
|
* ```typescript
|
|
14317
|
-
* const { data, error } = await sdk.cart.addToWishlist(
|
|
14666
|
+
* const { data, error } = await sdk.cart.addToWishlist({
|
|
14667
|
+
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
14668
|
+
* variant_id: null,
|
|
14669
|
+
* });
|
|
14670
|
+
*
|
|
14671
|
+
* // You can still pass an explicit user_id when needed
|
|
14672
|
+
* const { data: asUser } = await sdk.cart.addToWishlist(
|
|
14318
14673
|
* { user_id: "01H9USER12345ABCDE" },
|
|
14319
14674
|
* {
|
|
14320
14675
|
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
14321
|
-
* variant_id: null
|
|
14676
|
+
* variant_id: null,
|
|
14322
14677
|
* }
|
|
14323
14678
|
* );
|
|
14324
14679
|
*
|
|
@@ -14330,20 +14685,29 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
14330
14685
|
* }
|
|
14331
14686
|
* ```
|
|
14332
14687
|
*/
|
|
14333
|
-
addToWishlist(
|
|
14688
|
+
addToWishlist(body: AddToWishlistBody): Promise<ApiResult<AddToWishlistContent>>;
|
|
14689
|
+
addToWishlist(pathParams: {
|
|
14690
|
+
user_id: string;
|
|
14691
|
+
}, body: AddToWishlistBody): Promise<ApiResult<AddToWishlistContent>>;
|
|
14334
14692
|
/**
|
|
14335
14693
|
* Remove item from wishlist
|
|
14336
14694
|
*
|
|
14337
|
-
* @param
|
|
14338
|
-
* @param
|
|
14695
|
+
* @param pathParamsOrBody - Optional path parameters or the wishlist body.
|
|
14696
|
+
* @param maybeBody - The wishlist body when path parameters are provided.
|
|
14339
14697
|
* @returns Promise with updated wishlist
|
|
14340
14698
|
* @example
|
|
14341
14699
|
* ```typescript
|
|
14342
|
-
* const { data, error } = await sdk.cart.removeFromWishlist(
|
|
14700
|
+
* const { data, error } = await sdk.cart.removeFromWishlist({
|
|
14701
|
+
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
14702
|
+
* variant_id: null,
|
|
14703
|
+
* });
|
|
14704
|
+
*
|
|
14705
|
+
* // You can still pass an explicit user_id when needed
|
|
14706
|
+
* const { data: asUser } = await sdk.cart.removeFromWishlist(
|
|
14343
14707
|
* { user_id: "01H9USER12345ABCDE" },
|
|
14344
14708
|
* {
|
|
14345
14709
|
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
14346
|
-
* variant_id: null
|
|
14710
|
+
* variant_id: null,
|
|
14347
14711
|
* }
|
|
14348
14712
|
* );
|
|
14349
14713
|
*
|
|
@@ -14355,14 +14719,17 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
14355
14719
|
* }
|
|
14356
14720
|
* ```
|
|
14357
14721
|
*/
|
|
14358
|
-
removeFromWishlist(
|
|
14722
|
+
removeFromWishlist(body: DeleteFromWishlistBody): Promise<ApiResult<DeleteFromWishlistContent>>;
|
|
14723
|
+
removeFromWishlist(pathParams: {
|
|
14724
|
+
user_id: string;
|
|
14725
|
+
}, body: DeleteFromWishlistBody): Promise<ApiResult<DeleteFromWishlistContent>>;
|
|
14359
14726
|
}
|
|
14360
14727
|
//#endregion
|
|
14361
14728
|
//#region src/lib/auth.d.ts
|
|
14362
14729
|
/**
|
|
14363
14730
|
* Client for interacting with authentication endpoints
|
|
14364
14731
|
*/
|
|
14365
|
-
declare class AuthClient extends
|
|
14732
|
+
declare class AuthClient extends SessionStorefrontAPIClient {
|
|
14366
14733
|
/**
|
|
14367
14734
|
* Get anonymous token for guest users
|
|
14368
14735
|
*
|
|
@@ -14473,13 +14840,14 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14473
14840
|
*/
|
|
14474
14841
|
loginWithPassword(body: LoginWithPasswordBody): Promise<ApiResult<LoginWithPasswordContent>>;
|
|
14475
14842
|
/**
|
|
14476
|
-
*
|
|
14843
|
+
* Start forgot-password OTP flow
|
|
14477
14844
|
*
|
|
14478
|
-
* @param body - Request body containing email
|
|
14479
|
-
* @
|
|
14845
|
+
* @param body - Request body containing email or phone details
|
|
14846
|
+
* @param headers - Optional header parameters (for example `x-debug-mode`)
|
|
14847
|
+
* @returns Promise with OTP token and action for the reset flow
|
|
14480
14848
|
* @example
|
|
14481
14849
|
* ```typescript
|
|
14482
|
-
* // Send password reset
|
|
14850
|
+
* // Send password reset OTP
|
|
14483
14851
|
* const { data, error } = await sdk.auth.forgotPassword({
|
|
14484
14852
|
* email: "customer@example.com"
|
|
14485
14853
|
* });
|
|
@@ -14487,12 +14855,12 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14487
14855
|
* if (error) {
|
|
14488
14856
|
* console.error("Password reset failed:", error.message);
|
|
14489
14857
|
* } else {
|
|
14490
|
-
* console.log("
|
|
14491
|
-
*
|
|
14858
|
+
* console.log("OTP token:", data.otp_token);
|
|
14859
|
+
* console.log("Action:", data.otp_action);
|
|
14492
14860
|
* }
|
|
14493
14861
|
* ```
|
|
14494
14862
|
*/
|
|
14495
|
-
forgotPassword(body: ForgotPasswordBody): Promise<ApiResult<ForgotPasswordContent>>;
|
|
14863
|
+
forgotPassword(body: ForgotPasswordBody, headers?: ForgotPasswordHeaderParams): Promise<ApiResult<ForgotPasswordContent>>;
|
|
14496
14864
|
/**
|
|
14497
14865
|
* Reset password
|
|
14498
14866
|
*
|
|
@@ -14567,7 +14935,8 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14567
14935
|
* Register with phone
|
|
14568
14936
|
*
|
|
14569
14937
|
* @param body - Registration details including phone number and user information
|
|
14570
|
-
* @
|
|
14938
|
+
* @param headers - Optional header parameters (for example `x-debug-mode`)
|
|
14939
|
+
* @returns Promise with OTP token and action for completing registration
|
|
14571
14940
|
* @example
|
|
14572
14941
|
* ```typescript
|
|
14573
14942
|
* // Register a new user with phone number
|
|
@@ -14582,18 +14951,18 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14582
14951
|
* if (error) {
|
|
14583
14952
|
* console.error("Phone registration failed:", error.message);
|
|
14584
14953
|
* } else {
|
|
14585
|
-
* console.log("
|
|
14586
|
-
* console.log("
|
|
14587
|
-
* console.log("Access token:", data.access_token);
|
|
14954
|
+
* console.log("OTP token:", data.otp_token);
|
|
14955
|
+
* console.log("Action:", data.otp_action);
|
|
14588
14956
|
* }
|
|
14589
14957
|
* ```
|
|
14590
14958
|
*/
|
|
14591
|
-
registerWithPhone(body: RegisterWithPhoneBody): Promise<ApiResult<RegisterWithPhoneContent>>;
|
|
14959
|
+
registerWithPhone(body: RegisterWithPhoneBody, headers?: RegisterWithPhoneHeaderParams): Promise<ApiResult<RegisterWithPhoneContent>>;
|
|
14592
14960
|
/**
|
|
14593
14961
|
* Register with email
|
|
14594
14962
|
*
|
|
14595
14963
|
* @param body - Registration details including email and user information
|
|
14596
|
-
* @
|
|
14964
|
+
* @param headers - Optional header parameters (for example `x-debug-mode`)
|
|
14965
|
+
* @returns Promise with OTP token and action for completing registration
|
|
14597
14966
|
* @example
|
|
14598
14967
|
* ```typescript
|
|
14599
14968
|
* // Register a new user with email address
|
|
@@ -14607,13 +14976,61 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14607
14976
|
* if (error) {
|
|
14608
14977
|
* console.error("Email registration failed:", error.message);
|
|
14609
14978
|
* } else {
|
|
14610
|
-
* console.log("
|
|
14611
|
-
* console.log("
|
|
14612
|
-
*
|
|
14979
|
+
* console.log("OTP token:", data.otp_token);
|
|
14980
|
+
* console.log("Action:", data.otp_action);
|
|
14981
|
+
* }
|
|
14982
|
+
* ```
|
|
14983
|
+
*/
|
|
14984
|
+
registerWithEmail(body: RegisterWithEmailBody, headers?: RegisterWithEmailHeaderParams): Promise<ApiResult<RegisterWithEmailContent>>;
|
|
14985
|
+
/**
|
|
14986
|
+
* Register with WhatsApp
|
|
14987
|
+
*
|
|
14988
|
+
* @param body - Registration details including WhatsApp number and user information
|
|
14989
|
+
* @param headers - Optional header parameters (for example `x-debug-mode`)
|
|
14990
|
+
* @returns Promise with OTP token and action for completing registration
|
|
14991
|
+
* @example
|
|
14992
|
+
* ```typescript
|
|
14993
|
+
* // Register a new user with WhatsApp number
|
|
14994
|
+
* const { data, error } = await sdk.auth.registerWithWhatsapp({
|
|
14995
|
+
* phone: "9876543210",
|
|
14996
|
+
* country_code: "+91",
|
|
14997
|
+
* first_name: "John",
|
|
14998
|
+
* last_name: "Doe",
|
|
14999
|
+
* email: "john.doe@example.com"
|
|
15000
|
+
* });
|
|
15001
|
+
*
|
|
15002
|
+
* if (error) {
|
|
15003
|
+
* console.error("WhatsApp registration failed:", error.message);
|
|
15004
|
+
* } else {
|
|
15005
|
+
* console.log("OTP token:", data.otp_token);
|
|
15006
|
+
* console.log("Action:", data.otp_action);
|
|
15007
|
+
* }
|
|
15008
|
+
* ```
|
|
15009
|
+
*/
|
|
15010
|
+
registerWithWhatsapp(body: RegisterWithWhatsappBody, headers?: RegisterWithWhatsappHeaderParams): Promise<ApiResult<RegisterWithWhatsappContent>>;
|
|
15011
|
+
/**
|
|
15012
|
+
* Register with password
|
|
15013
|
+
*
|
|
15014
|
+
* @param body - Registration details including email or phone and password
|
|
15015
|
+
* @param headers - Optional header parameters (for example `x-debug-mode`)
|
|
15016
|
+
* @returns Promise with OTP token and action for completing registration
|
|
15017
|
+
* @example
|
|
15018
|
+
* ```typescript
|
|
15019
|
+
* const { data, error } = await sdk.auth.registerWithPassword({
|
|
15020
|
+
* email: "jane.smith@example.com",
|
|
15021
|
+
* password: "securePassword123",
|
|
15022
|
+
* confirm_password: "securePassword123",
|
|
15023
|
+
* });
|
|
15024
|
+
*
|
|
15025
|
+
* if (error) {
|
|
15026
|
+
* console.error("Password registration failed:", error.message);
|
|
15027
|
+
* } else {
|
|
15028
|
+
* console.log("OTP token:", data.otp_token);
|
|
15029
|
+
* console.log("Action:", data.otp_action);
|
|
14613
15030
|
* }
|
|
14614
15031
|
* ```
|
|
14615
15032
|
*/
|
|
14616
|
-
|
|
15033
|
+
registerWithPassword(body: RegisterWithPasswordBody, headers?: RegisterWithPasswordHeaderParams): Promise<ApiResult<RegisterWithPasswordContent>>;
|
|
14617
15034
|
/**
|
|
14618
15035
|
* Refresh the access token using a refresh token
|
|
14619
15036
|
* @param body - Request body containing the refresh token
|
|
@@ -14807,112 +15224,40 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14807
15224
|
* @returns Promise with profile image URL
|
|
14808
15225
|
* @example
|
|
14809
15226
|
* ```typescript
|
|
14810
|
-
* // Get user's profile image URL
|
|
14811
|
-
* const { data, error } = await sdk.auth.getProfileImage({
|
|
14812
|
-
* id: "01H9XYZ12345USERID"
|
|
14813
|
-
* });
|
|
14814
|
-
*
|
|
14815
|
-
* if (error) {
|
|
14816
|
-
* console.error("Failed to get profile image:", error.message);
|
|
14817
|
-
* } else {
|
|
14818
|
-
* console.log("Profile image URL:", data.profile_image_url);
|
|
14819
|
-
* }
|
|
14820
|
-
* ```
|
|
14821
|
-
*/
|
|
14822
|
-
getProfileImage(pathParams: GetProfileImagePathParams): Promise<ApiResult<GetProfileImageContent>>;
|
|
14823
|
-
/**
|
|
14824
|
-
* Deactivate user account
|
|
14825
|
-
*
|
|
14826
|
-
* @param pathParams - Path parameters containing user ID
|
|
14827
|
-
* @returns Promise with deactivation confirmation
|
|
14828
|
-
* @example
|
|
14829
|
-
* ```typescript
|
|
14830
|
-
* // Deactivate a user account
|
|
14831
|
-
* const { data, error } = await sdk.auth.deactivateUserAccount({
|
|
14832
|
-
* id: "01H9XYZ12345USERID"
|
|
14833
|
-
* });
|
|
14834
|
-
*
|
|
14835
|
-
* if (error) {
|
|
14836
|
-
* console.error("Failed to deactivate account:", error.message);
|
|
14837
|
-
* } else {
|
|
14838
|
-
* console.log("Account deactivated successfully");
|
|
14839
|
-
* console.log("Success:", data.success);
|
|
14840
|
-
* }
|
|
14841
|
-
* ```
|
|
14842
|
-
*/
|
|
14843
|
-
deactivateUserAccount(pathParams: DeactivateUserPathParams): Promise<ApiResult<DeactivateUserResponse>>;
|
|
14844
|
-
/**
|
|
14845
|
-
* Get user notification preferences
|
|
14846
|
-
*
|
|
14847
|
-
* @param pathParams - Path parameters containing user ID
|
|
14848
|
-
* @returns Promise with user's notification preferences
|
|
14849
|
-
* @example
|
|
14850
|
-
* ```typescript
|
|
14851
|
-
* // Get user's notification preferences
|
|
14852
|
-
* const { data, error } = await sdk.auth.getUserNotificationPreferences({
|
|
14853
|
-
* id: "01H9XYZ12345USERID"
|
|
14854
|
-
* });
|
|
14855
|
-
*
|
|
14856
|
-
* if (error) {
|
|
14857
|
-
* console.error("Failed to get preferences:", error.message);
|
|
14858
|
-
* } else {
|
|
14859
|
-
* console.log("Notification preferences:", data.notification_preferences);
|
|
14860
|
-
* }
|
|
14861
|
-
* ```
|
|
14862
|
-
*/
|
|
14863
|
-
getUserNotificationPreferences(pathParams: GetNotificationPreferencesPathParams): Promise<ApiResult<GetNotificationPreferencesContent>>;
|
|
14864
|
-
/**
|
|
14865
|
-
* Update user notification preferences
|
|
14866
|
-
*
|
|
14867
|
-
* @param pathParams - Path parameters containing user ID
|
|
14868
|
-
* @param body - Updated notification preferences
|
|
14869
|
-
* @returns Promise with updated notification preferences
|
|
14870
|
-
* @example
|
|
14871
|
-
* ```typescript
|
|
14872
|
-
* // Update user's notification preferences
|
|
14873
|
-
* const { data, error } = await sdk.auth.updateUserNotificationPreferences(
|
|
14874
|
-
* { id: "01H9XYZ12345USERID" },
|
|
14875
|
-
* {
|
|
14876
|
-
* email_notifications: true,
|
|
14877
|
-
* sms_notifications: false,
|
|
14878
|
-
* push_notifications: true
|
|
14879
|
-
* }
|
|
14880
|
-
* );
|
|
15227
|
+
* // Get user's profile image URL
|
|
15228
|
+
* const { data, error } = await sdk.auth.getProfileImage({
|
|
15229
|
+
* id: "01H9XYZ12345USERID"
|
|
15230
|
+
* });
|
|
14881
15231
|
*
|
|
14882
15232
|
* if (error) {
|
|
14883
|
-
* console.error("Failed to
|
|
15233
|
+
* console.error("Failed to get profile image:", error.message);
|
|
14884
15234
|
* } else {
|
|
14885
|
-
* console.log("
|
|
15235
|
+
* console.log("Profile image URL:", data.profile_image_url);
|
|
14886
15236
|
* }
|
|
14887
15237
|
* ```
|
|
14888
15238
|
*/
|
|
14889
|
-
|
|
15239
|
+
getProfileImage(pathParams: GetProfileImagePathParams): Promise<ApiResult<GetProfileImageContent>>;
|
|
14890
15240
|
/**
|
|
14891
|
-
*
|
|
15241
|
+
* Deactivate user account
|
|
14892
15242
|
*
|
|
14893
15243
|
* @param pathParams - Path parameters containing user ID
|
|
14894
|
-
* @
|
|
14895
|
-
* @returns Promise with created notification preferences
|
|
15244
|
+
* @returns Promise with deactivation confirmation
|
|
14896
15245
|
* @example
|
|
14897
15246
|
* ```typescript
|
|
14898
|
-
* //
|
|
14899
|
-
* const { data, error } = await sdk.auth.
|
|
14900
|
-
*
|
|
14901
|
-
*
|
|
14902
|
-
* email_notifications: true,
|
|
14903
|
-
* sms_notifications: true,
|
|
14904
|
-
* push_notifications: false
|
|
14905
|
-
* }
|
|
14906
|
-
* );
|
|
15247
|
+
* // Deactivate a user account
|
|
15248
|
+
* const { data, error } = await sdk.auth.deactivateUserAccount({
|
|
15249
|
+
* id: "01H9XYZ12345USERID"
|
|
15250
|
+
* });
|
|
14907
15251
|
*
|
|
14908
15252
|
* if (error) {
|
|
14909
|
-
* console.error("Failed to
|
|
15253
|
+
* console.error("Failed to deactivate account:", error.message);
|
|
14910
15254
|
* } else {
|
|
14911
|
-
* console.log("
|
|
15255
|
+
* console.log("Account deactivated successfully");
|
|
15256
|
+
* console.log("Success:", data.success);
|
|
14912
15257
|
* }
|
|
14913
15258
|
* ```
|
|
14914
15259
|
*/
|
|
14915
|
-
|
|
15260
|
+
deactivateUserAccount(pathParams: DeactivateUserPathParams): Promise<ApiResult<DeactivateUserResponse>>;
|
|
14916
15261
|
/**
|
|
14917
15262
|
* Generate OTP
|
|
14918
15263
|
*
|
|
@@ -14964,7 +15309,7 @@ declare class AuthClient extends StorefrontAPIClient {
|
|
|
14964
15309
|
/**
|
|
14965
15310
|
* Client for interacting with order endpoints
|
|
14966
15311
|
*/
|
|
14967
|
-
declare class OrderClient extends
|
|
15312
|
+
declare class OrderClient extends SessionStorefrontAPIClient {
|
|
14968
15313
|
/**
|
|
14969
15314
|
* Get order details
|
|
14970
15315
|
*
|
|
@@ -15094,18 +15439,15 @@ declare class OrderClient extends StorefrontAPIClient {
|
|
|
15094
15439
|
/**
|
|
15095
15440
|
* List all orders
|
|
15096
15441
|
*
|
|
15097
|
-
* @param queryParams -
|
|
15442
|
+
* @param queryParams - Optional query parameters for filtering and pagination. When `user_id` is omitted, the SDK resolves it from the active session.
|
|
15098
15443
|
* @returns Promise with order list
|
|
15099
15444
|
* @example
|
|
15100
15445
|
* ```typescript
|
|
15101
|
-
* // Basic usage
|
|
15102
|
-
* const { data, error } = await sdk.order.listOrders(
|
|
15103
|
-
* user_id: "user_01H9XYZ12345ABCDE"
|
|
15104
|
-
* });
|
|
15446
|
+
* // Basic usage
|
|
15447
|
+
* const { data, error } = await sdk.order.listOrders();
|
|
15105
15448
|
*
|
|
15106
15449
|
* // Advanced usage with optional parameters
|
|
15107
15450
|
* const { data, error } = await sdk.order.listOrders({
|
|
15108
|
-
* user_id: "user_01H9XYZ12345ABCDE",
|
|
15109
15451
|
* page: 1,
|
|
15110
15452
|
* limit: 20,
|
|
15111
15453
|
* sort_by: '{"created_at":"desc"}',
|
|
@@ -15124,7 +15466,8 @@ declare class OrderClient extends StorefrontAPIClient {
|
|
|
15124
15466
|
* }
|
|
15125
15467
|
* ```
|
|
15126
15468
|
*/
|
|
15127
|
-
listOrders(
|
|
15469
|
+
listOrders(): Promise<ApiResult<ListOrdersContent>>;
|
|
15470
|
+
listOrders(queryParams: Partial<ListOrdersQuery>): Promise<ApiResult<ListOrdersContent>>;
|
|
15128
15471
|
/**
|
|
15129
15472
|
* Get payment status for an order
|
|
15130
15473
|
*
|
|
@@ -15333,7 +15676,7 @@ declare class OrderClient extends StorefrontAPIClient {
|
|
|
15333
15676
|
/**
|
|
15334
15677
|
* Client for interacting with payment endpoints
|
|
15335
15678
|
*/
|
|
15336
|
-
declare class PaymentsClient extends
|
|
15679
|
+
declare class PaymentsClient extends SessionStorefrontAPIClient {
|
|
15337
15680
|
/**
|
|
15338
15681
|
* List all available payment methods
|
|
15339
15682
|
*
|
|
@@ -15465,11 +15808,11 @@ declare class PaymentsClient extends StorefrontAPIClient {
|
|
|
15465
15808
|
resendDirectOtp(body: ResendDirectOtpBody): Promise<ApiResult<ResendDirectOtpContent>>;
|
|
15466
15809
|
}
|
|
15467
15810
|
//#endregion
|
|
15468
|
-
//#region src/lib/helper.d.ts
|
|
15811
|
+
//#region src/lib/shared/helper.d.ts
|
|
15469
15812
|
/**
|
|
15470
15813
|
* Client for interacting with helper endpoints
|
|
15471
15814
|
*/
|
|
15472
|
-
declare class
|
|
15815
|
+
declare class BaseHelpersClient extends StorefrontAPIClientBase {
|
|
15473
15816
|
/**
|
|
15474
15817
|
* Get a list of countries
|
|
15475
15818
|
*
|
|
@@ -15569,22 +15912,35 @@ declare class HelpersClient extends StorefrontAPIClient {
|
|
|
15569
15912
|
listCountryPincodes(pathParams: ListCountryPincodesPathParams, queryParams?: ListCountryPincodesQuery): Promise<ApiResult<ListCountryPincodesContent>>;
|
|
15570
15913
|
}
|
|
15571
15914
|
//#endregion
|
|
15915
|
+
//#region src/lib/public/helper.d.ts
|
|
15916
|
+
/**
|
|
15917
|
+
* Client for interacting with helper endpoints
|
|
15918
|
+
*/
|
|
15919
|
+
declare class PublicHelpersClient extends BaseHelpersClient {}
|
|
15920
|
+
//#endregion
|
|
15921
|
+
//#region src/lib/helper.d.ts
|
|
15922
|
+
/**
|
|
15923
|
+
* Client for interacting with helper endpoints
|
|
15924
|
+
*/
|
|
15925
|
+
declare class HelpersClient extends BaseHelpersClient {
|
|
15926
|
+
constructor(config: ConstructorParameters<typeof SessionStorefrontAPIClient>[0]);
|
|
15927
|
+
}
|
|
15928
|
+
//#endregion
|
|
15572
15929
|
//#region src/lib/customer.d.ts
|
|
15573
15930
|
/**
|
|
15574
15931
|
* Client for interacting with customer endpoints
|
|
15575
15932
|
*/
|
|
15576
|
-
declare class CustomerClient extends
|
|
15933
|
+
declare class CustomerClient extends SessionStorefrontAPIClient {
|
|
15577
15934
|
/**
|
|
15578
15935
|
* Get all saved addresses for a customer
|
|
15579
15936
|
*
|
|
15580
|
-
* @param
|
|
15937
|
+
* @param pathParamsOrQuery - Optional path parameters or query parameters.
|
|
15938
|
+
* @param queryParams - Optional query parameters when path params are provided.
|
|
15581
15939
|
* @returns Promise with addresses
|
|
15582
15940
|
*
|
|
15583
15941
|
* @example
|
|
15584
15942
|
* ```typescript
|
|
15585
|
-
* const { data, error } = await sdk.customer.listAddresses(
|
|
15586
|
-
* user_id: "user_456"
|
|
15587
|
-
* });
|
|
15943
|
+
* const { data, error } = await sdk.customer.listAddresses();
|
|
15588
15944
|
*
|
|
15589
15945
|
* if (error) {
|
|
15590
15946
|
* console.error("Failed to list addresses:", error);
|
|
@@ -15596,35 +15952,35 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15596
15952
|
*
|
|
15597
15953
|
* // With pagination
|
|
15598
15954
|
* const { data: page2, error: page2Error } = await sdk.customer.listAddresses({
|
|
15599
|
-
* user_id: "user_456",
|
|
15600
15955
|
* page: 2,
|
|
15601
15956
|
* limit: 10
|
|
15602
15957
|
* });
|
|
15603
15958
|
* ```
|
|
15604
15959
|
*/
|
|
15605
|
-
listAddresses(
|
|
15960
|
+
listAddresses(): Promise<ApiResult<ListAddressesContent>>;
|
|
15961
|
+
listAddresses(queryParams: ListAddressesQuery): Promise<ApiResult<ListAddressesContent>>;
|
|
15962
|
+
listAddresses(pathParams: {
|
|
15963
|
+
customer_id: string;
|
|
15964
|
+
}, queryParams?: ListAddressesQuery): Promise<ApiResult<ListAddressesContent>>;
|
|
15606
15965
|
/**
|
|
15607
15966
|
* Create a new address for a customer
|
|
15608
15967
|
*
|
|
15609
|
-
* @param
|
|
15610
|
-
* @param
|
|
15968
|
+
* @param pathParamsOrBody - Optional path parameters or the address body.
|
|
15969
|
+
* @param maybeBody - Address body when path params are provided.
|
|
15611
15970
|
* @returns Promise with address details
|
|
15612
15971
|
*
|
|
15613
15972
|
* @example
|
|
15614
15973
|
* ```typescript
|
|
15615
|
-
* const { data, error } = await sdk.customer.createAddress(
|
|
15616
|
-
*
|
|
15617
|
-
*
|
|
15618
|
-
*
|
|
15619
|
-
*
|
|
15620
|
-
*
|
|
15621
|
-
*
|
|
15622
|
-
*
|
|
15623
|
-
*
|
|
15624
|
-
*
|
|
15625
|
-
* is_default_shipping: false
|
|
15626
|
-
* }
|
|
15627
|
-
* );
|
|
15974
|
+
* const { data, error } = await sdk.customer.createAddress({
|
|
15975
|
+
* address_line1: "123 Main Street",
|
|
15976
|
+
* address_line2: "Apt 4B",
|
|
15977
|
+
* city: "New York",
|
|
15978
|
+
* state: "NY",
|
|
15979
|
+
* country: "US",
|
|
15980
|
+
* pincode: "10001",
|
|
15981
|
+
* is_default_billing: true,
|
|
15982
|
+
* is_default_shipping: false
|
|
15983
|
+
* });
|
|
15628
15984
|
*
|
|
15629
15985
|
* if (error) {
|
|
15630
15986
|
* console.error("Failed to create address:", error);
|
|
@@ -15634,17 +15990,20 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15634
15990
|
* console.log("Address created:", data.address);
|
|
15635
15991
|
* ```
|
|
15636
15992
|
*/
|
|
15637
|
-
createAddress(
|
|
15993
|
+
createAddress(body: CreateAddressBody): Promise<ApiResult<CreateAddressContent>>;
|
|
15994
|
+
createAddress(pathParams: {
|
|
15995
|
+
customer_id: string;
|
|
15996
|
+
}, body: CreateAddressBody): Promise<ApiResult<CreateAddressContent>>;
|
|
15638
15997
|
/**
|
|
15639
15998
|
* Get an address for a customer
|
|
15640
15999
|
*
|
|
15641
|
-
* @param pathParams - Path parameters
|
|
16000
|
+
* @param pathParams - Path parameters. `customer_id` is optional and resolved from the active session when omitted.
|
|
15642
16001
|
* @returns Promise with address details
|
|
15643
16002
|
*
|
|
15644
16003
|
* @example
|
|
15645
16004
|
* ```typescript
|
|
15646
16005
|
* const { data, error } = await sdk.customer.getAddress({
|
|
15647
|
-
*
|
|
16006
|
+
* customer_id: "customer_456",
|
|
15648
16007
|
* address_id: "addr_789"
|
|
15649
16008
|
* });
|
|
15650
16009
|
*
|
|
@@ -15656,11 +16015,17 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15656
16015
|
* console.log("Address details:", data.address);
|
|
15657
16016
|
* ```
|
|
15658
16017
|
*/
|
|
15659
|
-
getAddress(pathParams:
|
|
16018
|
+
getAddress(pathParams: {
|
|
16019
|
+
address_id: string;
|
|
16020
|
+
}): Promise<ApiResult<GetAddressDetailContent>>;
|
|
16021
|
+
getAddress(pathParams: {
|
|
16022
|
+
address_id: string;
|
|
16023
|
+
customer_id: string;
|
|
16024
|
+
}): Promise<ApiResult<GetAddressDetailContent>>;
|
|
15660
16025
|
/**
|
|
15661
16026
|
* Update an address for a customer
|
|
15662
16027
|
*
|
|
15663
|
-
* @param pathParams - Path parameters
|
|
16028
|
+
* @param pathParams - Path parameters. `customer_id` is optional and resolved from the active session when omitted.
|
|
15664
16029
|
* @param body - Address update body
|
|
15665
16030
|
* @returns Promise with address details
|
|
15666
16031
|
*
|
|
@@ -15668,7 +16033,7 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15668
16033
|
* ```typescript
|
|
15669
16034
|
* const { data, error } = await sdk.customer.updateAddress(
|
|
15670
16035
|
* {
|
|
15671
|
-
*
|
|
16036
|
+
* customer_id: "customer_456",
|
|
15672
16037
|
* address_id: "addr_789"
|
|
15673
16038
|
* },
|
|
15674
16039
|
* {
|
|
@@ -15687,17 +16052,23 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15687
16052
|
* console.log("Address updated:", data.address);
|
|
15688
16053
|
* ```
|
|
15689
16054
|
*/
|
|
15690
|
-
updateAddress(pathParams:
|
|
16055
|
+
updateAddress(pathParams: {
|
|
16056
|
+
address_id: string;
|
|
16057
|
+
}, body: UpdateAddressDetailBody): Promise<ApiResult<UpdateAddressDetailContent>>;
|
|
16058
|
+
updateAddress(pathParams: {
|
|
16059
|
+
address_id: string;
|
|
16060
|
+
customer_id: string;
|
|
16061
|
+
}, body: UpdateAddressDetailBody): Promise<ApiResult<UpdateAddressDetailContent>>;
|
|
15691
16062
|
/**
|
|
15692
16063
|
* Delete an address for a customer
|
|
15693
16064
|
*
|
|
15694
|
-
* @param pathParams - Path parameters
|
|
16065
|
+
* @param pathParams - Path parameters. `customer_id` is optional and resolved from the active session when omitted.
|
|
15695
16066
|
* @returns Promise with deletion response
|
|
15696
16067
|
*
|
|
15697
16068
|
* @example
|
|
15698
16069
|
* ```typescript
|
|
15699
16070
|
* const { data, error } = await sdk.customer.deleteAddress({
|
|
15700
|
-
*
|
|
16071
|
+
* customer_id: "customer_456",
|
|
15701
16072
|
* address_id: "addr_789"
|
|
15702
16073
|
* });
|
|
15703
16074
|
*
|
|
@@ -15709,18 +16080,22 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15709
16080
|
* console.log("Address deleted:", data.message);
|
|
15710
16081
|
* ```
|
|
15711
16082
|
*/
|
|
15712
|
-
deleteAddress(pathParams:
|
|
16083
|
+
deleteAddress(pathParams: {
|
|
16084
|
+
address_id: string;
|
|
16085
|
+
}): Promise<ApiResult<DeleteAddressResponse>>;
|
|
16086
|
+
deleteAddress(pathParams: {
|
|
16087
|
+
address_id: string;
|
|
16088
|
+
customer_id: string;
|
|
16089
|
+
}): Promise<ApiResult<DeleteAddressResponse>>;
|
|
15713
16090
|
/**
|
|
15714
16091
|
* Get customer loyalty details
|
|
15715
16092
|
*
|
|
15716
|
-
* @param pathParams -
|
|
16093
|
+
* @param pathParams - Optional path parameters. When `customer_id` is omitted, the SDK resolves it from the active session.
|
|
15717
16094
|
* @returns Promise with loyalty details
|
|
15718
16095
|
*
|
|
15719
16096
|
* @example
|
|
15720
16097
|
* ```typescript
|
|
15721
|
-
* const { data, error } = await sdk.customer.getLoyaltyDetails(
|
|
15722
|
-
* user_id: "user_456"
|
|
15723
|
-
* });
|
|
16098
|
+
* const { data, error } = await sdk.customer.getLoyaltyDetails();
|
|
15724
16099
|
*
|
|
15725
16100
|
* if (error) {
|
|
15726
16101
|
* console.error("Failed to get loyalty details:", error);
|
|
@@ -15731,18 +16106,20 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15731
16106
|
* console.log("Points balance:", data.loyalty_point_balance);
|
|
15732
16107
|
* ```
|
|
15733
16108
|
*/
|
|
15734
|
-
getLoyaltyDetails(
|
|
16109
|
+
getLoyaltyDetails(): Promise<ApiResult<GetLoyaltyDetailsContent>>;
|
|
16110
|
+
getLoyaltyDetails(pathParams: {
|
|
16111
|
+
customer_id: string;
|
|
16112
|
+
}): Promise<ApiResult<GetLoyaltyDetailsContent>>;
|
|
15735
16113
|
/**
|
|
15736
16114
|
* List all loyalty points activity for a customer
|
|
15737
16115
|
*
|
|
15738
|
-
* @param
|
|
16116
|
+
* @param pathParamsOrQuery - Optional path parameters or query parameters.
|
|
16117
|
+
* @param queryParams - Optional query parameters when path params are provided.
|
|
15739
16118
|
* @returns Promise with loyalty points activity
|
|
15740
16119
|
*
|
|
15741
16120
|
* @example
|
|
15742
16121
|
* ```typescript
|
|
15743
|
-
* const { data, error } = await sdk.customer.listLoyaltyPointsActivity(
|
|
15744
|
-
* user_id: "user_456"
|
|
15745
|
-
* });
|
|
16122
|
+
* const { data, error } = await sdk.customer.listLoyaltyPointsActivity();
|
|
15746
16123
|
*
|
|
15747
16124
|
* if (error) {
|
|
15748
16125
|
* console.error("Failed to get loyalty activity:", error);
|
|
@@ -15753,25 +16130,26 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15753
16130
|
*
|
|
15754
16131
|
* // With pagination and sorting
|
|
15755
16132
|
* const { data: sortedData, error: sortedError } = await sdk.customer.listLoyaltyPointsActivity({
|
|
15756
|
-
* user_id: "user_456",
|
|
15757
16133
|
* page: 1,
|
|
15758
16134
|
* limit: 20,
|
|
15759
16135
|
* sort_by: JSON.stringify({ "created_at": "desc" })
|
|
15760
16136
|
* });
|
|
15761
16137
|
* ```
|
|
15762
16138
|
*/
|
|
15763
|
-
listLoyaltyPointsActivity(
|
|
16139
|
+
listLoyaltyPointsActivity(): Promise<ApiResult<ListLoyaltyActivitiesContent>>;
|
|
16140
|
+
listLoyaltyPointsActivity(queryParams: ListLoyaltyActivitiesQuery): Promise<ApiResult<ListLoyaltyActivitiesContent>>;
|
|
16141
|
+
listLoyaltyPointsActivity(pathParams: {
|
|
16142
|
+
customer_id: string;
|
|
16143
|
+
}, queryParams?: ListLoyaltyActivitiesQuery): Promise<ApiResult<ListLoyaltyActivitiesContent>>;
|
|
15764
16144
|
/**
|
|
15765
16145
|
* List all reviews left by a customer
|
|
15766
16146
|
*
|
|
15767
|
-
* @param pathParams -
|
|
16147
|
+
* @param pathParams - Optional path parameters. When `customer_id` is omitted, the SDK resolves it from the active session.
|
|
15768
16148
|
* @returns Promise with reviews
|
|
15769
16149
|
*
|
|
15770
16150
|
* @example
|
|
15771
16151
|
* ```typescript
|
|
15772
|
-
* const { data, error } = await sdk.customer.listCustomerReviews(
|
|
15773
|
-
* user_id: "user_456"
|
|
15774
|
-
* });
|
|
16152
|
+
* const { data, error } = await sdk.customer.listCustomerReviews();
|
|
15775
16153
|
*
|
|
15776
16154
|
* if (error) {
|
|
15777
16155
|
* console.error("Failed to get customer reviews:", error);
|
|
@@ -15782,16 +16160,24 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15782
16160
|
* console.log("Ready for review:", data.ready_for_review);
|
|
15783
16161
|
* ```
|
|
15784
16162
|
*/
|
|
15785
|
-
listCustomerReviews(
|
|
16163
|
+
listCustomerReviews(): Promise<ApiResult<ListCustomerReviewsContent>>;
|
|
16164
|
+
listCustomerReviews(pathParams: {
|
|
16165
|
+
customer_id: string;
|
|
16166
|
+
}): Promise<ApiResult<ListCustomerReviewsContent>>;
|
|
15786
16167
|
/**
|
|
15787
16168
|
* List all saved payment methods for a customer
|
|
15788
16169
|
*
|
|
15789
|
-
* @param pathParams -
|
|
16170
|
+
* @param pathParams - Optional path parameters. When `customer_id` is omitted, the SDK resolves it from the active session.
|
|
16171
|
+
* @param queryParams - Optional query parameters for filtering.
|
|
15790
16172
|
* @returns Promise with payment methods
|
|
15791
16173
|
*
|
|
15792
16174
|
* @example
|
|
15793
16175
|
* ```typescript
|
|
15794
|
-
*
|
|
16176
|
+
* // Uses customer_id from active session
|
|
16177
|
+
* const { data, error } = await sdk.customer.listSavedPaymentMethods();
|
|
16178
|
+
*
|
|
16179
|
+
* // With explicit customer_id
|
|
16180
|
+
* const { data: explicit } = await sdk.customer.listSavedPaymentMethods({
|
|
15795
16181
|
* customer_id: "customer_123"
|
|
15796
16182
|
* });
|
|
15797
16183
|
*
|
|
@@ -15803,16 +16189,23 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15803
16189
|
* console.log("Saved payment methods:", data.saved_payment_methods);
|
|
15804
16190
|
* ```
|
|
15805
16191
|
*/
|
|
15806
|
-
listSavedPaymentMethods(
|
|
16192
|
+
listSavedPaymentMethods(): Promise<ApiResult<ListSavedPaymentMethodsContent>>;
|
|
16193
|
+
listSavedPaymentMethods(pathParams: {
|
|
16194
|
+
customer_id: string;
|
|
16195
|
+
}, queryParams?: ListSavedPaymentMethodsQuery): Promise<ApiResult<ListSavedPaymentMethodsContent>>;
|
|
15807
16196
|
/**
|
|
15808
16197
|
* List all saved cards for a customer
|
|
15809
16198
|
*
|
|
15810
|
-
* @param pathParams -
|
|
16199
|
+
* @param pathParams - Optional path parameters. When `customer_id` is omitted, the SDK resolves it from the active session.
|
|
15811
16200
|
* @returns Promise with cards
|
|
15812
16201
|
*
|
|
15813
16202
|
* @example
|
|
15814
16203
|
* ```typescript
|
|
15815
|
-
*
|
|
16204
|
+
* // Uses customer_id from active session
|
|
16205
|
+
* const { data, error } = await sdk.customer.listCustomerCards();
|
|
16206
|
+
*
|
|
16207
|
+
* // With explicit customer_id
|
|
16208
|
+
* const { data: explicit } = await sdk.customer.listCustomerCards({
|
|
15816
16209
|
* customer_id: "customer_123"
|
|
15817
16210
|
* });
|
|
15818
16211
|
*
|
|
@@ -15824,14 +16217,17 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
15824
16217
|
* console.log("Customer cards:", data.cards);
|
|
15825
16218
|
* ```
|
|
15826
16219
|
*/
|
|
15827
|
-
listCustomerCards(
|
|
16220
|
+
listCustomerCards(): Promise<ApiResult<ListCustomerCardsContent>>;
|
|
16221
|
+
listCustomerCards(pathParams: {
|
|
16222
|
+
customer_id: string;
|
|
16223
|
+
}): Promise<ApiResult<ListCustomerCardsContent>>;
|
|
15828
16224
|
}
|
|
15829
16225
|
//#endregion
|
|
15830
|
-
//#region src/lib/store-config.d.ts
|
|
16226
|
+
//#region src/lib/shared/store-config.d.ts
|
|
15831
16227
|
/**
|
|
15832
16228
|
* Client for interacting with store config endpoints
|
|
15833
16229
|
*/
|
|
15834
|
-
declare class
|
|
16230
|
+
declare class BaseStoreConfigClient extends StorefrontAPIClientBase {
|
|
15835
16231
|
/**
|
|
15836
16232
|
* Check store existence
|
|
15837
16233
|
*
|
|
@@ -15841,7 +16237,7 @@ declare class StoreConfigClient extends StorefrontAPIClient {
|
|
|
15841
16237
|
* @returns Promise with store existence check result
|
|
15842
16238
|
* @example
|
|
15843
16239
|
* ```typescript
|
|
15844
|
-
* const { data, error } = await sdk.
|
|
16240
|
+
* const { data, error } = await sdk.store.checkStore();
|
|
15845
16241
|
*
|
|
15846
16242
|
* if (error) {
|
|
15847
16243
|
* console.error("Failed to check store:", error.message);
|
|
@@ -15858,7 +16254,7 @@ declare class StoreConfigClient extends StorefrontAPIClient {
|
|
|
15858
16254
|
*
|
|
15859
16255
|
* @example
|
|
15860
16256
|
* ```typescript
|
|
15861
|
-
* const { data, error } = await sdk.
|
|
16257
|
+
* const { data, error } = await sdk.store.getStoreConfig();
|
|
15862
16258
|
*
|
|
15863
16259
|
* if (error) {
|
|
15864
16260
|
* console.error('Failed to get store config:', error.message);
|
|
@@ -15876,189 +16272,84 @@ declare class StoreConfigClient extends StorefrontAPIClient {
|
|
|
15876
16272
|
getStoreConfig(): Promise<ApiResult<GetConfigContent>>;
|
|
15877
16273
|
}
|
|
15878
16274
|
//#endregion
|
|
15879
|
-
//#region src/lib/
|
|
15880
|
-
/**
|
|
15881
|
-
* Token storage interface for the auth middleware
|
|
15882
|
-
*/
|
|
15883
|
-
interface TokenStorage {
|
|
15884
|
-
getAccessToken(): Promise<string | null>;
|
|
15885
|
-
setAccessToken(token: string): Promise<void>;
|
|
15886
|
-
getRefreshToken(): Promise<string | null>;
|
|
15887
|
-
setRefreshToken(token: string): Promise<void>;
|
|
15888
|
-
clearTokens(): Promise<void>;
|
|
15889
|
-
}
|
|
15890
|
-
/**
|
|
15891
|
-
* Simple in-memory token storage implementation
|
|
15892
|
-
*/
|
|
15893
|
-
declare class MemoryTokenStorage implements TokenStorage {
|
|
15894
|
-
private accessToken;
|
|
15895
|
-
private refreshToken;
|
|
15896
|
-
getAccessToken(): Promise<string | null>;
|
|
15897
|
-
setAccessToken(token: string): Promise<void>;
|
|
15898
|
-
getRefreshToken(): Promise<string | null>;
|
|
15899
|
-
setRefreshToken(token: string): Promise<void>;
|
|
15900
|
-
clearTokens(): Promise<void>;
|
|
15901
|
-
}
|
|
15902
|
-
/**
|
|
15903
|
-
* Browser localStorage token storage implementation
|
|
15904
|
-
*/
|
|
15905
|
-
declare class BrowserTokenStorage implements TokenStorage {
|
|
15906
|
-
private accessTokenKey;
|
|
15907
|
-
private refreshTokenKey;
|
|
15908
|
-
constructor(prefix?: string);
|
|
15909
|
-
getAccessToken(): Promise<string | null>;
|
|
15910
|
-
setAccessToken(token: string): Promise<void>;
|
|
15911
|
-
getRefreshToken(): Promise<string | null>;
|
|
15912
|
-
setRefreshToken(token: string): Promise<void>;
|
|
15913
|
-
clearTokens(): Promise<void>;
|
|
15914
|
-
}
|
|
15915
|
-
/**
|
|
15916
|
-
* Cookie-based token storage implementation
|
|
15917
|
-
*/
|
|
15918
|
-
declare class CookieTokenStorage implements TokenStorage {
|
|
15919
|
-
private accessTokenKey;
|
|
15920
|
-
private refreshTokenKey;
|
|
15921
|
-
private options;
|
|
15922
|
-
constructor(options?: CookieTokenStorageOptions);
|
|
15923
|
-
getAccessToken(): Promise<string | null>;
|
|
15924
|
-
setAccessToken(token: string): Promise<void>;
|
|
15925
|
-
getRefreshToken(): Promise<string | null>;
|
|
15926
|
-
setRefreshToken(token: string): Promise<void>;
|
|
15927
|
-
clearTokens(): Promise<void>;
|
|
15928
|
-
private getCookie;
|
|
15929
|
-
private setCookie;
|
|
15930
|
-
private deleteCookie;
|
|
15931
|
-
}
|
|
16275
|
+
//#region src/lib/public/store-config.d.ts
|
|
15932
16276
|
/**
|
|
15933
|
-
*
|
|
16277
|
+
* Client for interacting with store config endpoints
|
|
15934
16278
|
*/
|
|
15935
|
-
|
|
15936
|
-
/**
|
|
15937
|
-
* Prefix for cookie names (default: "storefront_")
|
|
15938
|
-
*/
|
|
15939
|
-
prefix?: string;
|
|
15940
|
-
/**
|
|
15941
|
-
* Maximum age of cookies in seconds (default: 7 days)
|
|
15942
|
-
*/
|
|
15943
|
-
maxAge?: number;
|
|
15944
|
-
/**
|
|
15945
|
-
* Cookie path (default: "/")
|
|
15946
|
-
*/
|
|
15947
|
-
path?: string;
|
|
15948
|
-
/**
|
|
15949
|
-
* Cookie domain (default: current domain)
|
|
15950
|
-
*/
|
|
15951
|
-
domain?: string;
|
|
15952
|
-
/**
|
|
15953
|
-
* Whether cookies should be secure (default: auto-detect based on protocol)
|
|
15954
|
-
*/
|
|
15955
|
-
secure?: boolean;
|
|
15956
|
-
/**
|
|
15957
|
-
* SameSite cookie attribute (default: "Lax")
|
|
15958
|
-
*/
|
|
15959
|
-
sameSite?: "Strict" | "Lax" | "None";
|
|
15960
|
-
}
|
|
16279
|
+
declare class PublicStoreConfigClient extends BaseStoreConfigClient {}
|
|
15961
16280
|
//#endregion
|
|
15962
|
-
//#region src/lib/
|
|
16281
|
+
//#region src/lib/store-config.d.ts
|
|
15963
16282
|
/**
|
|
15964
|
-
*
|
|
16283
|
+
* Client for interacting with store config endpoints
|
|
15965
16284
|
*/
|
|
15966
|
-
|
|
15967
|
-
|
|
15968
|
-
name: string;
|
|
15969
|
-
type: string;
|
|
16285
|
+
declare class StoreConfigClient extends BaseStoreConfigClient {
|
|
16286
|
+
constructor(config: ConstructorParameters<typeof SessionStorefrontAPIClient>[0]);
|
|
15970
16287
|
}
|
|
16288
|
+
//#endregion
|
|
16289
|
+
//#region src/lib/public/client.d.ts
|
|
15971
16290
|
/**
|
|
15972
|
-
*
|
|
16291
|
+
* Storefront API client that always authenticates with `X-Api-Key`.
|
|
16292
|
+
*
|
|
16293
|
+
* This client is used by the public storefront surface where no session or
|
|
16294
|
+
* token lifecycle should be involved.
|
|
15973
16295
|
*/
|
|
15974
|
-
|
|
15975
|
-
|
|
15976
|
-
|
|
15977
|
-
phone: string | null;
|
|
15978
|
-
username: string;
|
|
15979
|
-
firstName: string | null;
|
|
15980
|
-
lastName: string | null;
|
|
15981
|
-
storeId: string;
|
|
15982
|
-
isLoggedIn: boolean;
|
|
15983
|
-
isAnonymous: boolean;
|
|
15984
|
-
customerId: string | null;
|
|
15985
|
-
customerGroupId: string | null;
|
|
15986
|
-
anonymousId: string;
|
|
15987
|
-
channel: Channel;
|
|
15988
|
-
tokenExpiry: Date;
|
|
15989
|
-
tokenIssuedAt: Date;
|
|
16296
|
+
declare class PublicStorefrontAPIClient extends StorefrontAPIClientBase {
|
|
16297
|
+
constructor(config: StorefrontClientBaseConfig);
|
|
16298
|
+
private setupPublicAuth;
|
|
15990
16299
|
}
|
|
15991
16300
|
//#endregion
|
|
15992
16301
|
//#region src/index.d.ts
|
|
15993
16302
|
/**
|
|
15994
|
-
*
|
|
15995
|
-
*
|
|
15996
|
-
|
|
15997
|
-
|
|
15998
|
-
/**
|
|
15999
|
-
* Customer group ID used for pricing, promotions, and subscription rates
|
|
16000
|
-
* If not provided, the API will use default pricing
|
|
16001
|
-
*/
|
|
16002
|
-
customer_group_id?: string;
|
|
16003
|
-
/**
|
|
16004
|
-
* Debug mode header
|
|
16005
|
-
*/
|
|
16006
|
-
debug_mode?: boolean;
|
|
16007
|
-
}
|
|
16008
|
-
/**
|
|
16009
|
-
* SDK initialization options for the Storefront API
|
|
16010
|
-
* Extends the generic BaseSDKOptions with Commerce Engine and auth-specific features
|
|
16303
|
+
* Public SDK class for the Storefront API.
|
|
16304
|
+
*
|
|
16305
|
+
* This surface is intentionally limited to API-key-backed, public read
|
|
16306
|
+
* operations so it can be used safely during build and prerender flows.
|
|
16011
16307
|
*/
|
|
16012
|
-
|
|
16013
|
-
/**
|
|
16014
|
-
* Store ID for the API requests
|
|
16015
|
-
*/
|
|
16016
|
-
storeId: string;
|
|
16308
|
+
declare class PublicStorefrontSDK {
|
|
16017
16309
|
/**
|
|
16018
|
-
*
|
|
16019
|
-
* Overrides baseUrl if provided
|
|
16310
|
+
* Client for catalog-related read-only endpoints
|
|
16020
16311
|
*/
|
|
16021
|
-
|
|
16312
|
+
readonly catalog: PublicCatalogClient;
|
|
16022
16313
|
/**
|
|
16023
|
-
*
|
|
16024
|
-
* If not provided, will be built from storeId and environment
|
|
16314
|
+
* Client for helper-related endpoints
|
|
16025
16315
|
*/
|
|
16026
|
-
|
|
16316
|
+
readonly helpers: PublicHelpersClient;
|
|
16027
16317
|
/**
|
|
16028
|
-
*
|
|
16029
|
-
* Required for initial authentication
|
|
16318
|
+
* Client for store config-related endpoints
|
|
16030
16319
|
*/
|
|
16031
|
-
|
|
16320
|
+
readonly store: PublicStoreConfigClient;
|
|
16032
16321
|
/**
|
|
16033
|
-
*
|
|
16034
|
-
* - If tokenStorage is provided: Used as initial token value, then managed automatically
|
|
16035
|
-
* - If tokenStorage is not provided: Used for manual token management
|
|
16322
|
+
* Centrally stored default headers for consistency
|
|
16036
16323
|
*/
|
|
16037
|
-
|
|
16324
|
+
private defaultHeaders?;
|
|
16325
|
+
constructor(options: PublicStorefrontSDKOptions);
|
|
16038
16326
|
/**
|
|
16039
|
-
*
|
|
16040
|
-
*
|
|
16041
|
-
*
|
|
16327
|
+
* Set the API key for all public clients
|
|
16328
|
+
*
|
|
16329
|
+
* @param apiKey - The API key to set
|
|
16042
16330
|
*/
|
|
16043
|
-
|
|
16331
|
+
setApiKey(apiKey: string): void;
|
|
16044
16332
|
/**
|
|
16045
|
-
*
|
|
16046
|
-
* If provided, enables automatic token refresh and management
|
|
16333
|
+
* Clear the API key from all public clients
|
|
16047
16334
|
*/
|
|
16048
|
-
|
|
16335
|
+
clearApiKey(): void;
|
|
16049
16336
|
/**
|
|
16050
|
-
*
|
|
16337
|
+
* Set default headers for all public clients
|
|
16338
|
+
*
|
|
16339
|
+
* @param headers - Default headers to set (only supported headers allowed)
|
|
16051
16340
|
*/
|
|
16052
|
-
|
|
16341
|
+
setDefaultHeaders(headers: SupportedDefaultHeaders): void;
|
|
16053
16342
|
/**
|
|
16054
|
-
*
|
|
16343
|
+
* Get current default headers
|
|
16344
|
+
*
|
|
16345
|
+
* @returns Current default headers from central storage (always consistent)
|
|
16055
16346
|
*/
|
|
16056
|
-
|
|
16347
|
+
getDefaultHeaders(): SupportedDefaultHeaders | undefined;
|
|
16057
16348
|
}
|
|
16058
16349
|
/**
|
|
16059
|
-
* Main SDK class for the Storefront API
|
|
16350
|
+
* Main session-aware SDK class for the Storefront API
|
|
16060
16351
|
*/
|
|
16061
|
-
declare class
|
|
16352
|
+
declare class SessionStorefrontSDK {
|
|
16062
16353
|
/**
|
|
16063
16354
|
* Client for catalog-related endpoints (products, categories, etc.)
|
|
16064
16355
|
*/
|
|
@@ -16096,11 +16387,16 @@ declare class StorefrontSDK {
|
|
|
16096
16387
|
*/
|
|
16097
16388
|
private defaultHeaders?;
|
|
16098
16389
|
/**
|
|
16099
|
-
*
|
|
16390
|
+
* Shared session helper and coordinator for all API clients in this SDK instance.
|
|
16391
|
+
*/
|
|
16392
|
+
readonly session: StorefrontSession;
|
|
16393
|
+
private readonly sessionManager;
|
|
16394
|
+
/**
|
|
16395
|
+
* Create a new SessionStorefrontSDK instance
|
|
16100
16396
|
*
|
|
16101
16397
|
* @param options - Configuration options for the SDK
|
|
16102
16398
|
*/
|
|
16103
|
-
constructor(options:
|
|
16399
|
+
constructor(options: SessionStorefrontSDKOptions);
|
|
16104
16400
|
/**
|
|
16105
16401
|
* Set authentication tokens for all clients
|
|
16106
16402
|
*
|
|
@@ -16132,41 +16428,64 @@ declare class StorefrontSDK {
|
|
|
16132
16428
|
clearApiKey(): void;
|
|
16133
16429
|
/**
|
|
16134
16430
|
* Get the current access token if using token storage
|
|
16431
|
+
*
|
|
16432
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16135
16433
|
*/
|
|
16136
16434
|
getAccessToken(): Promise<string | null>;
|
|
16435
|
+
/**
|
|
16436
|
+
* Ensure an access token is available for the current session.
|
|
16437
|
+
*
|
|
16438
|
+
* This may create or refresh a managed session when automatic token
|
|
16439
|
+
* management is configured.
|
|
16440
|
+
*
|
|
16441
|
+
* @returns A usable access token
|
|
16442
|
+
*/
|
|
16443
|
+
ensureAccessToken(): Promise<string>;
|
|
16137
16444
|
/**
|
|
16138
16445
|
* Get user information from the current access token
|
|
16139
16446
|
*
|
|
16447
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16448
|
+
*
|
|
16140
16449
|
* @returns User information extracted from JWT token, or null if no token or invalid token
|
|
16141
16450
|
*/
|
|
16142
16451
|
getUserInfo(): Promise<UserInfo | null>;
|
|
16143
16452
|
/**
|
|
16144
16453
|
* Get the current user ID from the access token
|
|
16145
16454
|
*
|
|
16455
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16456
|
+
*
|
|
16146
16457
|
* @returns User ID (ulid) or null if no token or invalid token
|
|
16147
16458
|
*/
|
|
16148
16459
|
getUserId(): Promise<string | null>;
|
|
16149
16460
|
/**
|
|
16150
16461
|
* Check if the current user is logged in (not anonymous)
|
|
16151
16462
|
*
|
|
16463
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16464
|
+
*
|
|
16152
16465
|
* @returns True if user is logged in, false if anonymous or no token
|
|
16153
16466
|
*/
|
|
16154
16467
|
isLoggedIn(): Promise<boolean>;
|
|
16155
16468
|
/**
|
|
16156
16469
|
* Check if the current user is anonymous
|
|
16157
16470
|
*
|
|
16471
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16472
|
+
*
|
|
16158
16473
|
* @returns True if user is anonymous or no token, false if logged in
|
|
16159
16474
|
*/
|
|
16160
16475
|
isAnonymous(): Promise<boolean>;
|
|
16161
16476
|
/**
|
|
16162
16477
|
* Get the customer ID from the current access token
|
|
16163
16478
|
*
|
|
16479
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16480
|
+
*
|
|
16164
16481
|
* @returns Customer ID or null if no token, invalid token, or user has no customer ID
|
|
16165
16482
|
*/
|
|
16166
16483
|
getCustomerId(): Promise<string | null>;
|
|
16167
16484
|
/**
|
|
16168
16485
|
* Get the customer group ID from the current access token
|
|
16169
16486
|
*
|
|
16487
|
+
* This is a passive lookup. It will not create or refresh a session.
|
|
16488
|
+
*
|
|
16170
16489
|
* @returns Customer group ID or null if no token, invalid token, or user has no customer group
|
|
16171
16490
|
*/
|
|
16172
16491
|
getCustomerGroupId(): Promise<string | null>;
|
|
@@ -16183,6 +16502,68 @@ declare class StorefrontSDK {
|
|
|
16183
16502
|
*/
|
|
16184
16503
|
getDefaultHeaders(): SupportedDefaultHeaders | undefined;
|
|
16185
16504
|
}
|
|
16505
|
+
type SessionStorefrontConfig = Omit<SessionStorefrontSDKOptions, keyof PublicStorefrontSDKOptions>;
|
|
16506
|
+
interface CreateStorefrontOptions extends PublicStorefrontSDKOptions {
|
|
16507
|
+
/**
|
|
16508
|
+
* Optional default configuration for the cached session-aware SDK returned by
|
|
16509
|
+
* `storefront.session()`.
|
|
16510
|
+
*/
|
|
16511
|
+
session?: SessionStorefrontConfig;
|
|
16512
|
+
}
|
|
16513
|
+
interface StorefrontFactory {
|
|
16514
|
+
/**
|
|
16515
|
+
* Get the cached public storefront SDK.
|
|
16516
|
+
*
|
|
16517
|
+
* This instance is safe for public reads and never participates in session
|
|
16518
|
+
* bootstrap, refresh, or token persistence.
|
|
16519
|
+
*/
|
|
16520
|
+
public(): PublicStorefrontSDK;
|
|
16521
|
+
/**
|
|
16522
|
+
* Get the cached default session-aware SDK.
|
|
16523
|
+
*
|
|
16524
|
+
* Use this when your app should operate with a stable managed or manual
|
|
16525
|
+
* session configuration.
|
|
16526
|
+
*/
|
|
16527
|
+
session(): SessionStorefrontSDK;
|
|
16528
|
+
/**
|
|
16529
|
+
* Create a one-off session-aware SDK with per-call overrides.
|
|
16530
|
+
*
|
|
16531
|
+
* This is useful for stateless/token-seeded requests that should not reuse
|
|
16532
|
+
* the cached session client from `storefront.session()`.
|
|
16533
|
+
*
|
|
16534
|
+
* @param overrides - Per-instance session configuration overrides
|
|
16535
|
+
*/
|
|
16536
|
+
session(overrides: Partial<SessionStorefrontConfig>): SessionStorefrontSDK;
|
|
16537
|
+
}
|
|
16538
|
+
/**
|
|
16539
|
+
* Create a configured storefront factory with explicit public and session
|
|
16540
|
+
* access patterns.
|
|
16541
|
+
*
|
|
16542
|
+
* @example
|
|
16543
|
+
* ```typescript
|
|
16544
|
+
* import {
|
|
16545
|
+
* BrowserTokenStorage,
|
|
16546
|
+
* createStorefront,
|
|
16547
|
+
* Environment,
|
|
16548
|
+
* } from "@commercengine/storefront-sdk";
|
|
16549
|
+
*
|
|
16550
|
+
* export const storefront = createStorefront({
|
|
16551
|
+
* storeId: "your-store-id",
|
|
16552
|
+
* apiKey: "your-api-key",
|
|
16553
|
+
* environment: Environment.Staging,
|
|
16554
|
+
* session: {
|
|
16555
|
+
* tokenStorage: new BrowserTokenStorage("myapp_"),
|
|
16556
|
+
* },
|
|
16557
|
+
* });
|
|
16558
|
+
*
|
|
16559
|
+
* const { data: products } = await storefront.public().catalog.listProducts();
|
|
16560
|
+
* const { data: cart } = await storefront.session().cart.getCart();
|
|
16561
|
+
* ```
|
|
16562
|
+
*
|
|
16563
|
+
* @param options - Shared public config plus optional default session config
|
|
16564
|
+
* @returns A storefront factory with explicit `public()` and `session()` accessors
|
|
16565
|
+
*/
|
|
16566
|
+
declare function createStorefront(options: CreateStorefrontOptions): StorefrontFactory;
|
|
16186
16567
|
//#endregion
|
|
16187
|
-
export { AcceleratedRewardCouponPromotion, AcceleratedRewardRule, AddProfileImageContent, AddProfileImageFormData, AddProfileImagePathParams, AddProfileImageResponse, AddToWishlistBody, AddToWishlistContent, AddToWishlistPathParams, AddToWishlistResponse, AdditionalProductDetails, AnalyticsEventInput, AnalyticsProvider, AnonymousUser, ApiErrorResponse, ApiResult, ApplicableCoupon, ApplicablePromotion, AppliedCoupon, AppliedPromotion, ApplyCouponBody, ApplyCouponContent, ApplyCouponPathParams, ApplyCouponResponse, AssociatedOption, AuthClient, AuthenticateDirectOtpBody, AuthenticateDirectOtpResponse, AutoScaleBasedOnAmount, AutoScaleBasedOnQuantity, BankTransfer, BaseAPIClient, BaseSDKOptions, BooleanAttribute, Brand, BrowserTokenStorage, Business, BusinessInput, BuyXGetYCouponPromotion, BuyXGetYRule, BuyXGetYRuleBasedOnAmount, BuyXGetYRuleBasedOnQuantity, CancelOrderBody, CancelOrderContent, CancelOrderPathParams, CancelOrderResponse, CancelPaymentRequestPathParams, CancelPaymentRequestResponse, CardPayment, CardbinInfo, Cart, CartBasedFulfillmentCheckInput, CartBasedFulfillmentOptionInput, CartClient, CartItem, CartShipment, CatalogClient, Category, ChangePasswordBody, ChangePasswordContent, ChangePasswordResponse, type Channel, CheckFulfillmentBody, CheckFulfillmentContent, CheckFulfillmentResponse, CheckStoreResponse, CheckVerificationStatusBody, CheckVerificationStatusContent, CheckVerificationStatusResponse, ClaimPosDeviceContent, ClaimPosDevicePathParams, ClaimPosDeviceResponse, CollectInStore, CollectInStoreAddress, CollectInStoreFulfillment, CollectInStoreFulfillmentInput, ColorAttribute, ColorOption, CookieTokenStorage, type CookieTokenStorageOptions, Country, CountryState, Coupon, CouponPromotionCommonDetail, CouponType, CreateAddressBody, CreateAddressContent, CreateAddressPathParams, CreateAddressResponse, CreateCartAddressBody, CreateCartAddressContent, CreateCartAddressPathParams, CreateCartAddressResponse, CreateCartBody, CreateCartContent, CreateCartResponse, CreateCustomSubscriptionInput, CreateDocumentContent, CreateDocumentFormData, CreateDocumentPathParams, CreateDocumentResponse, CreateJuspayCustomerBody, CreateJuspayCustomerContent, CreateJuspayCustomerResponse, CreateJuspayOrderBody, CreateJuspayOrderContent, CreateJuspayOrderResponse, CreateMarketplaceProductReviewFormData, CreateMarketplaceProductReviewPathParams, CreateMarketplaceProductReviewResponse, CreateNotificationPreferencesBody, CreateNotificationPreferencesContent, CreateNotificationPreferencesPathParams, CreateNotificationPreferencesResponse, CreateOrderBody, CreateOrderContent, CreateOrderResponse, CreateOrderReturnBody, CreateOrderReturnContent, CreateOrderReturnInput, CreateOrderReturnPathParams, CreateOrderReturnResponse, CreatePosOrderBody, CreatePosOrderContent, CreatePosOrderResponse, CreateProductReviewFormData, CreateProductReviewPathParams, CreateProductReviewResponse, CreateReviewInput, CreateStandardSubscriptionInput, CreateSubscriptionBody, CreateSubscriptionContent, CreateSubscriptionInput, CreateSubscriptionResponse, Currency, CustomSlabsBasedOnAmount, CustomSlabsBasedOnQuantity, CustomerAddress, CustomerAddressInput, CustomerClient, CustomerGroup, CustomerGroupInput, CustomerLoyalty, CustomerReadyForReview, CustomerReview, DateAttribute, DeactivateUserPathParams, DeactivateUserResponse, DebugLogger, DebugLoggerFn, DeleteAddressPathParams, DeleteAddressResponse, DeleteCartPathParams, DeleteCartResponse, DeleteDocumentPathParams, DeleteDocumentResponse, DeleteFromWishlistBody, DeleteFromWishlistContent, DeleteFromWishlistPathParams, DeleteFromWishlistResponse, DeleteUserCartPathParams, DeleteUserCartResponse, DeleteUserPathParams, DeleteUserResponse, DeliveryFulfillment, DeliveryFulfillmentInput, DeliveryOption, DiscountBasedPromotion, DiscountCouponPromotion, DiscountRule, Document, DocumentInput, Environment, EvaluateCouponsContent, EvaluateCouponsPathParams, EvaluateCouponsResponse, EvaluatePromotionsContent, EvaluatePromotionsPathParams, EvaluatePromotionsResponse, FixedAmountDiscountRule, FixedPriceCouponPromotion, FixedPricePromotion, FixedPriceRule, FixedPriceRuleBasedAmount, FixedPriceRuleBasedQuantity, ForgotPasswordBody, ForgotPasswordContent, ForgotPasswordResponse, FreeGoodCouponPromotion, FreeGoodsPromotion, FreeGoodsRule, FreeShipingCouponPromotion, FulfillmentItem, FulfillmentItemInput, FulfillmentPreference, FulfillmentPreferenceInput, GenerateHashBody, GenerateHashContent, GenerateHashResponse, GenerateOtpBody, GenerateOtpContent, GenerateOtpHeaderParams, GenerateOtpResponse, GenerateOtpWithEmailInput, GenerateOtpWithPhoneInput, GetAddressDetailContent, GetAddressDetailPathParams, GetAddressDetailResponse, GetAnonymousTokenContent, GetAnonymousTokenResponse, GetCardInfoContent, GetCardInfoQuery, GetCardInfoResponse, GetCartContent, GetCartPathParams, GetCartResponse, GetConfigContent, GetConfigResponse, GetDocumentContent, GetDocumentPathParams, GetDocumentResponse, GetFulfillmentOptionsBody, GetFulfillmentOptionsContent, GetFulfillmentOptionsResponse, GetJuspayCustomerContent, GetJuspayCustomerPathParams, GetJuspayCustomerResponse, GetLoyaltyDetailsContent, GetLoyaltyDetailsPathParams, GetLoyaltyDetailsResponse, GetMarketplaceProductDetailContent, GetMarketplaceProductDetailHeaderParams, GetMarketplaceProductDetailPathParams, GetMarketplaceProductDetailQuery, GetMarketplaceProductDetailResponse, GetMarketplaceVariantDetailContent, GetMarketplaceVariantDetailHeaderParams, GetMarketplaceVariantDetailPathParams, GetMarketplaceVariantDetailQuery, GetMarketplaceVariantDetailResponse, GetNotificationPreferencesContent, GetNotificationPreferencesPathParams, GetNotificationPreferencesResponse, GetOrderDetailContent, GetOrderDetailPathParams, GetOrderDetailResponse, GetOrderReturnDetailContent, GetOrderReturnDetailPathParams, GetOrderReturnDetailResponse, GetPaymentStatusContent, GetPaymentStatusPathParams, GetPaymentStatusResponse, GetPosFulfillmentOptionsBody, GetPosFulfillmentOptionsContent, GetPosFulfillmentOptionsResponse, GetPosUserContent, GetPosUserPathParams, GetPosUserResponse, GetProductDetailContent, GetProductDetailHeaderParams, GetProductDetailPathParams, GetProductDetailQuery, GetProductDetailResponse, GetProfileImageContent, GetProfileImagePathParams, GetProfileImageResponse, GetSellerDetailContent, GetSellerDetailPathParams, GetSellerDetailResponse, GetSubscriptionContent, GetSubscriptionPathParams, GetSubscriptionResponse, GetUserCartContent, GetUserCartPathParams, GetUserCartResponse, GetUserDetailContent, GetUserDetailPathParams, GetUserDetailResponse, GetVariantDetailContent, GetVariantDetailHeaderParams, GetVariantDetailPathParams, GetVariantDetailQuery, GetVariantDetailResponse, GetWishlistContent, GetWishlistPathParams, GetWishlistQuery, GetWishlistResponse, GstinDetail, HeaderConfig, HelpersClient, InapplicableCoupon, InapplicablePromotion, Item, ItemsBasedFulfillmentCheckInput, JusPayExpressCheckoutCommonFieldInput, JusPayExpressCheckoutInput, JusPayExpressCheckoutResponse, JusPayHyperCheckoutInput, JusPayHyperCheckoutResponse, JusPayNewCardInput, JusPaySavedCardTokenInput, JuspayCardDetail, JuspayCardPaymentMethod, JuspayCreateCustomerPayloadInput, JuspayCreateOrderPayloadInput, JuspayCustomer, JuspayNetBankingInput, JuspayNetbankingPaymentMethod, JuspayOrder, JuspayPaymentMethod, JuspayPaymentMethodDetail, JuspayUpiCollectInput, JuspayUpiIntentInput, JuspayUpiPaymentMethod, JuspayWalletPaymentMethod, KycDocument, KycDocumentConfig, ListAddressesContent, ListAddressesPathParams, ListAddressesQuery, ListAddressesResponse, ListCategoriesContent, ListCategoriesQuery, ListCategoriesResponse, ListCountriesContent, ListCountriesResponse, ListCountryPincodesContent, ListCountryPincodesPathParams, ListCountryPincodesQuery, ListCountryPincodesResponse, ListCountryStatesContent, ListCountryStatesPathParams, ListCountryStatesResponse, ListCouponsContent, ListCouponsHeaderParams, ListCouponsResponse, ListCrosssellProductsContent, ListCrosssellProductsHeaderParams, ListCrosssellProductsQuery, ListCrosssellProductsResponse, ListCustomerCardsContent, ListCustomerCardsPathParams, ListCustomerCardsResponse, ListDocumentsContent, ListDocumentsPathParams, ListDocumentsResponse, ListKycDocumentContent, ListKycDocumentResponse, ListLoyaltyActivitiesContent, ListLoyaltyActivitiesPathParams, ListLoyaltyActivitiesQuery, ListLoyaltyActivitiesResponse, ListMarketplaceCategoriesContent, ListMarketplaceCategoriesQuery, ListMarketplaceCategoriesResponse, ListMarketplaceCrosssellProductsContent, ListMarketplaceCrosssellProductsHeaderParams, ListMarketplaceCrosssellProductsQuery, ListMarketplaceCrosssellProductsResponse, ListMarketplaceProductReviewsContent, ListMarketplaceProductReviewsPathParams, ListMarketplaceProductReviewsQuery, ListMarketplaceProductReviewsResponse, ListMarketplaceProductVariantsContent, ListMarketplaceProductVariantsHeaderParams, ListMarketplaceProductVariantsPathParams, ListMarketplaceProductVariantsQuery, ListMarketplaceProductVariantsResponse, ListMarketplaceProductsContent, ListMarketplaceProductsHeaderParams, ListMarketplaceProductsQuery, ListMarketplaceProductsResponse, ListMarketplaceSimilarProductsContent, ListMarketplaceSimilarProductsHeaderParams, ListMarketplaceSimilarProductsQuery, ListMarketplaceSimilarProductsResponse, ListMarketplaceSkusContent, ListMarketplaceSkusHeaderParams, ListMarketplaceSkusQuery, ListMarketplaceSkusResponse, ListMarketplaceUpsellProductsContent, ListMarketplaceUpsellProductsHeaderParams, ListMarketplaceUpsellProductsQuery, ListMarketplaceUpsellProductsResponse, ListOrderPaymentsContent, ListOrderPaymentsPathParams, ListOrderPaymentsResponse, ListOrderRefundsContent, ListOrderRefundsPathParams, ListOrderRefundsResponse, ListOrderShipmentsContent, ListOrderShipmentsPathParams, ListOrderShipmentsResponse, ListOrdersContent, ListOrdersQuery, ListOrdersResponse, ListPaymentMethodsContent, ListPaymentMethodsQuery, ListPaymentMethodsResponse, ListPosDevicesContent, ListPosDevicesResponse, ListPosLocationsContent, ListPosLocationsResponse, ListProductReviewsContent, ListProductReviewsPathParams, ListProductReviewsQuery, ListProductReviewsResponse, ListProductVariantsContent, ListProductVariantsHeaderParams, ListProductVariantsPathParams, ListProductVariantsQuery, ListProductVariantsResponse, ListProductsContent, ListProductsHeaderParams, ListProductsQuery, ListProductsResponse, ListPromotionsContent, ListPromotionsHeaderParams, ListPromotionsResponse, ListReturnsContent, ListReturnsResponse, ListSavedPaymentMethodsContent, ListSavedPaymentMethodsPathParams, ListSavedPaymentMethodsQuery, ListSavedPaymentMethodsResponse, ListSellerReviewsContent, ListSellerReviewsPathParams, ListSellerReviewsResponse, ListSimilarProductsContent, ListSimilarProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsResponse, ListSkusContent, ListSkusHeaderParams, ListSkusQuery, ListSkusResponse, ListSubscriptionsContent, ListSubscriptionsResponse, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsResponse, ListUserReviewsContent, ListUserReviewsPathParams, ListUserReviewsResponse, LoginPosDeviceWithEmailBody, LoginPosDeviceWithEmailContent, LoginPosDeviceWithEmailHeaderParams, LoginPosDeviceWithEmailResponse, LoginPosDeviceWithPhoneBody, LoginPosDeviceWithPhoneContent, LoginPosDeviceWithPhoneHeaderParams, LoginPosDeviceWithPhoneResponse, LoginPosDeviceWithWhatsappBody, LoginPosDeviceWithWhatsappContent, LoginPosDeviceWithWhatsappHeaderParams, LoginPosDeviceWithWhatsappResponse, LoginWithEmailBody, LoginWithEmailContent, LoginWithEmailHeaderParams, LoginWithEmailResponse, LoginWithPasswordBody, LoginWithPasswordContent, LoginWithPasswordResponse, LoginWithPhoneBody, LoginWithPhoneContent, LoginWithPhoneHeaderParams, LoginWithPhoneResponse, LoginWithWhatsappBody, LoginWithWhatsappContent, LoginWithWhatsappHeaderParams, LoginWithWhatsappResponse, LogoutContent, LogoutFromPosDeviceResponse, LogoutResponse, LotBatchDetail, LoyaltyPointActivity, ManualPaymentMethod, MarketplaceItem, MarketplaceProduct, MarketplaceProductDetail, MeasurementUnit, MemoryTokenStorage, MultiSelectAttribute, NetbankingPayment, NotificationChannelPreferences, NotificationChannelPreferencesInput, NotificationPreferences, NotificationPreferencesInput, NumberAttribute, Order, OrderClient, OrderDetail, OrderItem, OrderList, OrderPayment, OrderRefund, OrderReturn, OrderReturnItem, OrderReturnItemInput, OrderShipment, Pagination, PairPosDeviceBody, PairPosDeviceContent, PairPosDeviceResponse, PanDetail, PartialCollectAndDelivery, PartialCollectAndDeliveryInput, PauseSubscriptionInput, PayWithCardInput, PayWithCashInput, PayWithUpiInput, PaymentInfo, PaymentMethodPayloadInput, PaymentProvider, PaymentsClient, PayuPaymentInfo, PayuPaymentMethod, PercentageDiscountRule, Pincode, PosApplyCouponBody, PosApplyCouponContent, PosApplyCouponPathParams, PosApplyCouponResponse, PosCreateCartAddressBody, PosCreateCartAddressContent, PosCreateCartAddressPathParams, PosCreateCartAddressResponse, PosCreateCartBody, PosCreateCartContent, PosCreateCartResponse, PosDeleteCartPathParams, PosDeleteCartResponse, PosDevice, PosDeviceClaimedUser, PosEvaluateCouponsContent, PosEvaluateCouponsPathParams, PosEvaluateCouponsResponse, PosEvaluatePromotionsContent, PosEvaluatePromotionsPathParams, PosEvaluatePromotionsResponse, PosGetCartContent, PosGetCartPathParams, PosGetCartResponse, PosGetPaymentStatusContent, PosGetPaymentStatusPathParams, PosGetPaymentStatusResponse, PosGetProductDetailContent, PosGetProductDetailHeaderParams, PosGetProductDetailPathParams, PosGetProductDetailQuery, PosGetProductDetailResponse, PosGetUserCartContent, PosGetUserCartPathParams, PosGetUserCartResponse, PosGetVariantDetailContent, PosGetVariantDetailHeaderParams, PosGetVariantDetailPathParams, PosGetVariantDetailQuery, PosGetVariantDetailResponse, PosListCategoriesContent, PosListCategoriesQuery, PosListCategoriesResponse, PosListCouponsContent, PosListCouponsHeaderParams, PosListCouponsResponse, PosListCrosssellProductsContent, PosListCrosssellProductsHeaderParams, PosListCrosssellProductsQuery, PosListCrosssellProductsResponse, PosListProductReviewsContent, PosListProductReviewsPathParams, PosListProductReviewsQuery, PosListProductReviewsResponse, PosListProductVariantsContent, PosListProductVariantsHeaderParams, PosListProductVariantsPathParams, PosListProductVariantsQuery, PosListProductVariantsResponse, PosListProductsContent, PosListProductsHeaderParams, PosListProductsQuery, PosListProductsResponse, PosListPromotionsContent, PosListPromotionsHeaderParams, PosListPromotionsResponse, PosListSimilarProductsContent, PosListSimilarProductsHeaderParams, PosListSimilarProductsQuery, PosListSimilarProductsResponse, PosListSkusContent, PosListSkusHeaderParams, PosListSkusQuery, PosListSkusResponse, PosListUpsellProductsContent, PosListUpsellProductsHeaderParams, PosListUpsellProductsQuery, PosListUpsellProductsResponse, PosLocation, PosRedeemCreditBalanceBody, PosRedeemCreditBalanceContent, PosRedeemCreditBalancePathParams, PosRedeemCreditBalanceResponse, PosRedeemLoyaltyPointsBody, PosRedeemLoyaltyPointsContent, PosRedeemLoyaltyPointsPathParams, PosRedeemLoyaltyPointsResponse, PosRemoveCouponContent, PosRemoveCouponPathParams, PosRemoveCouponResponse, PosRemoveCreditBalanceContent, PosRemoveCreditBalancePathParams, PosRemoveCreditBalanceResponse, PosRemoveLoyaltyPointsContent, PosRemoveLoyaltyPointsPathParams, PosRemoveLoyaltyPointsResponse, PosSearchProductsBody, PosSearchProductsContent, PosSearchProductsHeaderParams, PosSearchProductsResponse, PosUpdateCartBody, PosUpdateCartContent, PosUpdateCartPathParams, PosUpdateCartResponse, PosUpdateCustomerWithEmailInput, PosUpdateCustomerWithIdInput, PosUpdateCustomerWithPhoneInput, PosUpdateFulfillmentPreferenceBody, PosUpdateFulfillmentPreferenceContent, PosUpdateFulfillmentPreferencePathParams, PosUpdateFulfillmentPreferenceResponse, PosUser, Product, ProductAttribute, ProductBundleItem, ProductCategory, ProductDetail, ProductImage, ProductPricing, ProductPromotion, ProductReview, ProductShipping, ProductSubscription, ProductVideo, Promotion, PromotionType, type Readable, RedeemCreditBalanceBody, RedeemCreditBalanceContent, RedeemCreditBalancePathParams, RedeemCreditBalanceResponse, RedeemLoyaltyPointsBody, RedeemLoyaltyPointsContent, RedeemLoyaltyPointsPathParams, RedeemLoyaltyPointsResponse, RefreshPosAccessTokenBody, RefreshPosAccessTokenContent, RefreshPosAccessTokenResponse, RefreshTokenBody, RefreshTokenContent, RefreshTokenResponse, RegisterWithEmailBody, RegisterWithEmailContent, RegisterWithEmailPasswordInput, RegisterWithEmailResponse, RegisterWithPasswordBody, RegisterWithPasswordContent, RegisterWithPasswordResponse, RegisterWithPhoneBody, RegisterWithPhoneContent, RegisterWithPhonePasswordInput, RegisterWithPhoneResponse, RegisterWithWhatsappBody, RegisterWithWhatsappContent, RegisterWithWhatsappResponse, RemoveCouponContent, RemoveCouponPathParams, RemoveCouponResponse, RemoveCreditBalanceContent, RemoveCreditBalancePathParams, RemoveCreditBalanceResponse, RemoveLoyaltyPointsContent, RemoveLoyaltyPointsPathParams, RemoveLoyaltyPointsResponse, RemoveProfileImagePathParams, RemoveProfileImageResponse, ResendDirectOtpBody, ResendDirectOtpContent, ResendDirectOtpResponse, ResetPasswordBody, ResetPasswordContent, ResetPasswordResponse, ResponseUtils, RetryOrderPaymentBody, RetryOrderPaymentContent, RetryOrderPaymentPathParams, RetryOrderPaymentResponse, RevokeSubscriptionInput, SavedPaymentMethod, SearchMarketplaceProductsBody, SearchMarketplaceProductsContent, SearchMarketplaceProductsHeaderParams, SearchMarketplaceProductsResponse, SearchProductInput, SearchProductsBody, SearchProductsContent, SearchProductsHeaderParams, SearchProductsResponse, SellerDetail, SellerInfo, SellerReview, SellerReviewStats, Seo, ServiceProviderBasicDetail, ShipmentItem, ShipmentStatus, SingleSelectAttribute, SingleSelectOption, StoreConfig, StoreConfigClient, StoreTemplate, StorefrontAPIClient, StorefrontSDK, StorefrontSDK as default, StorefrontSDKOptions, SubscribeNewsletterBody, SubscribeNewsletterResponse, Subscription, SubscriptionBehaviourInput, SubscriptionDetail, SubscriptionInvoiceItem, SubscriptionInvoiceItemInput, SupportedDefaultHeaders, TextAttribute, type TokenStorage, TrackAnalyticsEventBody, TrackAnalyticsEventResponse, UnclaimPosDeviceContent, UnclaimPosDevicePathParams, UnclaimPosDeviceResponse, UnserviceableItem, UpdateAddressDetailBody, UpdateAddressDetailContent, UpdateAddressDetailPathParams, UpdateAddressDetailResponse, UpdateCartBody, UpdateCartContent, UpdateCartItemInput, UpdateCartPathParams, UpdateCartResponse, UpdateDigitalProductSubscriptionInput, UpdateDocumentContent, UpdateDocumentFormData, UpdateDocumentInput, UpdateDocumentPathParams, UpdateDocumentResponse, UpdateFulfillmentPreferenceBody, UpdateFulfillmentPreferenceContent, UpdateFulfillmentPreferencePathParams, UpdateFulfillmentPreferenceResponse, UpdateNotificationPreferencesBody, UpdateNotificationPreferencesContent, UpdateNotificationPreferencesPathParams, UpdateNotificationPreferencesResponse, UpdatePhysicalProductSubscriptionInput, UpdatePosCartCustomerBody, UpdatePosCartCustomerContent, UpdatePosCartCustomerPathParams, UpdatePosCartCustomerResponse, UpdateProfileImageContent, UpdateProfileImageFormData, UpdateProfileImagePathParams, UpdateProfileImageResponse, UpdateSubscriptionBody, UpdateSubscriptionContent, UpdateSubscriptionPathParams, UpdateSubscriptionResponse, UpdateUserBody, UpdateUserContent, UpdateUserPathParams, UpdateUserResponse, UpiPayment, User, type UserInfo, UserInput, Variant, VariantDetail, VariantOption, VerifyDocumentBody, VerifyDocumentContent, VerifyDocumentPathParams, VerifyDocumentResponse, VerifyOtpBody, VerifyOtpContent, VerifyOtpResponse, VerifyPosLoginOtpBody, VerifyPosLoginOtpContent, VerifyPosLoginOtpResponse, VerifyVpaContent, VerifyVpaQuery, VerifyVpaResponse, VolumeBasedCouponPromotion, VolumeBasedPromotion, VolumeBasedRule, WalletPayment, type Writable, type components, createDebugMiddleware, createTimeoutMiddleware, executeRequest, extractRequestBody, getPathnameFromUrl, mergeAndTransformHeaders, mergeHeaders, type operations, type paths, transformHeaders };
|
|
16568
|
+
export { AcceleratedRewardCouponPromotion, AcceleratedRewardRule, AddProfileImageContent, AddProfileImageFormData, AddProfileImagePathParams, AddProfileImageResponse, AddToWishlistBody, AddToWishlistContent, AddToWishlistPathParams, AddToWishlistResponse, AdditionalProductDetails, AnalyticsEventInput, AnalyticsProvider, AnonymousUser, ApiErrorResponse, ApiResult, ApplicableCoupon, ApplicablePromotion, AppliedCoupon, AppliedPromotion, ApplyCouponBody, ApplyCouponContent, ApplyCouponPathParams, ApplyCouponResponse, AssociatedOption, AuthClient, AuthenticateDirectOtpBody, AuthenticateDirectOtpResponse, AutoScaleBasedOnAmount, AutoScaleBasedOnQuantity, BankTransfer, BaseAPIClient, BaseSDKOptions, BooleanAttribute, Brand, BrowserTokenStorage, Business, BusinessInput, BuyXGetYCouponPromotion, BuyXGetYRule, BuyXGetYRuleBasedOnAmount, BuyXGetYRuleBasedOnQuantity, CancelOrderBody, CancelOrderContent, CancelOrderPathParams, CancelOrderResponse, CancelPaymentRequestPathParams, CancelPaymentRequestResponse, CardPayment, CardbinInfo, Cart, CartBasedFulfillmentCheckInput, CartBasedFulfillmentOptionInput, CartClient, CartItem, CartShipment, CatalogClient, Category, ChangePasswordBody, ChangePasswordContent, ChangePasswordResponse, type Channel, CheckFulfillmentBody, CheckFulfillmentContent, CheckFulfillmentResponse, CheckStoreResponse, CheckVerificationStatusBody, CheckVerificationStatusContent, CheckVerificationStatusResponse, ClaimPosDeviceContent, ClaimPosDevicePathParams, ClaimPosDeviceResponse, CollectInStore, CollectInStoreAddress, CollectInStoreFulfillment, CollectInStoreFulfillmentInput, ColorAttribute, ColorOption, CookieTokenStorage, type CookieTokenStorageOptions, Country, CountryState, Coupon, CouponPromotionCommonDetail, CouponType, CreateAddressBody, CreateAddressContent, CreateAddressPathParams, CreateAddressResponse, CreateCartAddressBody, CreateCartAddressContent, CreateCartAddressPathParams, CreateCartAddressResponse, CreateCartBody, CreateCartContent, CreateCartResponse, CreateCustomSubscriptionInput, CreateDocumentContent, CreateDocumentFormData, CreateDocumentPathParams, CreateDocumentResponse, CreateJuspayCustomerBody, CreateJuspayCustomerContent, CreateJuspayCustomerResponse, CreateJuspayOrderBody, CreateJuspayOrderContent, CreateJuspayOrderResponse, CreateMarketplaceProductReviewFormData, CreateMarketplaceProductReviewPathParams, CreateMarketplaceProductReviewResponse, CreateOrderBody, CreateOrderContent, CreateOrderResponse, CreateOrderReturnBody, CreateOrderReturnContent, CreateOrderReturnInput, CreateOrderReturnPathParams, CreateOrderReturnResponse, CreatePosOrderBody, CreatePosOrderContent, CreatePosOrderResponse, CreateProductReviewFormData, CreateProductReviewPathParams, CreateProductReviewResponse, CreateReviewInput, CreateStandardSubscriptionInput, CreateStorefrontOptions, CreateSubscriptionBody, CreateSubscriptionContent, CreateSubscriptionInput, CreateSubscriptionResponse, Currency, CustomSlabsBasedOnAmount, CustomSlabsBasedOnQuantity, CustomerAddress, CustomerAddressInput, CustomerClient, CustomerGroup, CustomerGroupInput, CustomerLoyalty, CustomerReadyForReview, CustomerReview, DateAttribute, DeactivateUserPathParams, DeactivateUserResponse, DebugLogger, DebugLoggerFn, DeleteAddressPathParams, DeleteAddressResponse, DeleteCartPathParams, DeleteCartResponse, DeleteDocumentPathParams, DeleteDocumentResponse, DeleteFromWishlistBody, DeleteFromWishlistContent, DeleteFromWishlistPathParams, DeleteFromWishlistResponse, DeleteUserCartPathParams, DeleteUserCartResponse, DeleteUserPathParams, DeleteUserResponse, DeliveryFulfillment, DeliveryFulfillmentInput, DeliveryOption, DiscountBasedPromotion, DiscountCouponPromotion, DiscountRule, Document, DocumentInput, Environment, EvaluateCouponsContent, EvaluateCouponsPathParams, EvaluateCouponsResponse, EvaluatePromotionsContent, EvaluatePromotionsPathParams, EvaluatePromotionsResponse, FixedAmountDiscountRule, FixedPriceCouponPromotion, FixedPricePromotion, FixedPriceRule, FixedPriceRuleBasedAmount, FixedPriceRuleBasedQuantity, ForgotPasswordBody, ForgotPasswordContent, ForgotPasswordHeaderParams, ForgotPasswordResponse, FreeGoodCouponPromotion, FreeGoodsPromotion, FreeGoodsRule, FreeShipingCouponPromotion, FulfillmentItem, FulfillmentItemInput, FulfillmentPreference, FulfillmentPreferenceInput, GenerateHashBody, GenerateHashContent, GenerateHashResponse, GenerateOtpBody, GenerateOtpContent, GenerateOtpHeaderParams, GenerateOtpResponse, GenerateOtpWithEmailInput, GenerateOtpWithPhoneInput, GetAddressDetailContent, GetAddressDetailPathParams, GetAddressDetailResponse, GetAnonymousTokenContent, GetAnonymousTokenResponse, GetCardInfoContent, GetCardInfoQuery, GetCardInfoResponse, GetCartContent, GetCartPathParams, GetCartResponse, GetConfigContent, GetConfigResponse, GetDocumentContent, GetDocumentPathParams, GetDocumentResponse, GetFulfillmentOptionsBody, GetFulfillmentOptionsContent, GetFulfillmentOptionsResponse, GetJuspayCustomerContent, GetJuspayCustomerPathParams, GetJuspayCustomerResponse, GetLoyaltyDetailsContent, GetLoyaltyDetailsPathParams, GetLoyaltyDetailsResponse, GetMarketplaceProductDetailContent, GetMarketplaceProductDetailHeaderParams, GetMarketplaceProductDetailPathParams, GetMarketplaceProductDetailQuery, GetMarketplaceProductDetailResponse, GetMarketplaceVariantDetailContent, GetMarketplaceVariantDetailHeaderParams, GetMarketplaceVariantDetailPathParams, GetMarketplaceVariantDetailQuery, GetMarketplaceVariantDetailResponse, GetOrderDetailContent, GetOrderDetailPathParams, GetOrderDetailResponse, GetOrderReturnDetailContent, GetOrderReturnDetailPathParams, GetOrderReturnDetailResponse, GetPaymentStatusContent, GetPaymentStatusPathParams, GetPaymentStatusResponse, GetPosFulfillmentOptionsBody, GetPosFulfillmentOptionsContent, GetPosFulfillmentOptionsResponse, GetPosUserContent, GetPosUserPathParams, GetPosUserResponse, GetProductDetailContent, GetProductDetailHeaderParams, GetProductDetailPathParams, GetProductDetailQuery, GetProductDetailResponse, GetProfileImageContent, GetProfileImagePathParams, GetProfileImageResponse, GetSellerDetailContent, GetSellerDetailPathParams, GetSellerDetailResponse, GetSubscriptionContent, GetSubscriptionPathParams, GetSubscriptionResponse, GetUserCartContent, GetUserCartPathParams, GetUserCartResponse, GetUserDetailContent, GetUserDetailPathParams, GetUserDetailResponse, GetVariantDetailContent, GetVariantDetailHeaderParams, GetVariantDetailPathParams, GetVariantDetailQuery, GetVariantDetailResponse, GetWishlistContent, GetWishlistPathParams, GetWishlistQuery, GetWishlistResponse, GstinDetail, HeaderConfig, HelpersClient, InapplicableCoupon, InapplicablePromotion, Item, ItemsBasedFulfillmentCheckInput, JusPayExpressCheckoutCommonFieldInput, JusPayExpressCheckoutInput, JusPayExpressCheckoutResponse, JusPayHyperCheckoutInput, JusPayHyperCheckoutResponse, JusPayNewCardInput, JusPaySavedCardTokenInput, JuspayCardDetail, JuspayCardPaymentMethod, JuspayCreateCustomerPayloadInput, JuspayCreateOrderPayloadInput, JuspayCustomer, JuspayNetBankingInput, JuspayNetbankingPaymentMethod, JuspayOrder, JuspayPaymentMethod, JuspayPaymentMethodDetail, JuspayUpiCollectInput, JuspayUpiIntentInput, JuspayUpiPaymentMethod, JuspayWalletPaymentMethod, KycDocumentConfig, ListAddressesContent, ListAddressesPathParams, ListAddressesQuery, ListAddressesResponse, ListCategoriesContent, ListCategoriesQuery, ListCategoriesResponse, ListCountriesContent, ListCountriesResponse, ListCountryPincodesContent, ListCountryPincodesPathParams, ListCountryPincodesQuery, ListCountryPincodesResponse, ListCountryStatesContent, ListCountryStatesPathParams, ListCountryStatesResponse, ListCouponsContent, ListCouponsHeaderParams, ListCouponsResponse, ListCrosssellProductsContent, ListCrosssellProductsHeaderParams, ListCrosssellProductsQuery, ListCrosssellProductsResponse, ListCustomerCardsContent, ListCustomerCardsPathParams, ListCustomerCardsResponse, ListCustomerReviewsContent, ListCustomerReviewsPathParams, ListCustomerReviewsResponse, ListDocumentsContent, ListDocumentsPathParams, ListDocumentsResponse, ListKycDocumentContent, ListKycDocumentResponse, ListLoyaltyActivitiesContent, ListLoyaltyActivitiesPathParams, ListLoyaltyActivitiesQuery, ListLoyaltyActivitiesResponse, ListMarketplaceCategoriesContent, ListMarketplaceCategoriesQuery, ListMarketplaceCategoriesResponse, ListMarketplaceCrosssellProductsContent, ListMarketplaceCrosssellProductsHeaderParams, ListMarketplaceCrosssellProductsQuery, ListMarketplaceCrosssellProductsResponse, ListMarketplaceProductReviewsContent, ListMarketplaceProductReviewsPathParams, ListMarketplaceProductReviewsQuery, ListMarketplaceProductReviewsResponse, ListMarketplaceProductVariantsContent, ListMarketplaceProductVariantsHeaderParams, ListMarketplaceProductVariantsPathParams, ListMarketplaceProductVariantsQuery, ListMarketplaceProductVariantsResponse, ListMarketplaceProductsContent, ListMarketplaceProductsHeaderParams, ListMarketplaceProductsQuery, ListMarketplaceProductsResponse, ListMarketplaceSimilarProductsContent, ListMarketplaceSimilarProductsHeaderParams, ListMarketplaceSimilarProductsQuery, ListMarketplaceSimilarProductsResponse, ListMarketplaceSkusContent, ListMarketplaceSkusHeaderParams, ListMarketplaceSkusQuery, ListMarketplaceSkusResponse, ListMarketplaceUpsellProductsContent, ListMarketplaceUpsellProductsHeaderParams, ListMarketplaceUpsellProductsQuery, ListMarketplaceUpsellProductsResponse, ListOrderPaymentsContent, ListOrderPaymentsPathParams, ListOrderPaymentsResponse, ListOrderRefundsContent, ListOrderRefundsPathParams, ListOrderRefundsResponse, ListOrderShipmentsContent, ListOrderShipmentsPathParams, ListOrderShipmentsResponse, ListOrdersContent, ListOrdersQuery, ListOrdersResponse, ListPaymentMethodsContent, ListPaymentMethodsQuery, ListPaymentMethodsResponse, ListPosDevicesContent, ListPosDevicesResponse, ListPosLocationsContent, ListPosLocationsResponse, ListProductReviewsContent, ListProductReviewsPathParams, ListProductReviewsQuery, ListProductReviewsResponse, ListProductVariantsContent, ListProductVariantsHeaderParams, ListProductVariantsPathParams, ListProductVariantsQuery, ListProductVariantsResponse, ListProductsContent, ListProductsHeaderParams, ListProductsQuery, ListProductsResponse, ListPromotionsContent, ListPromotionsHeaderParams, ListPromotionsResponse, ListReturnsContent, ListReturnsResponse, ListSavedPaymentMethodsContent, ListSavedPaymentMethodsPathParams, ListSavedPaymentMethodsQuery, ListSavedPaymentMethodsResponse, ListSellerReviewsContent, ListSellerReviewsPathParams, ListSellerReviewsResponse, ListSimilarProductsContent, ListSimilarProductsHeaderParams, ListSimilarProductsQuery, ListSimilarProductsResponse, ListSkusContent, ListSkusHeaderParams, ListSkusQuery, ListSkusResponse, ListSubscriptionsContent, ListSubscriptionsResponse, ListUpsellProductsContent, ListUpsellProductsHeaderParams, ListUpsellProductsQuery, ListUpsellProductsResponse, LoginPosDeviceWithEmailBody, LoginPosDeviceWithEmailContent, LoginPosDeviceWithEmailHeaderParams, LoginPosDeviceWithEmailResponse, LoginPosDeviceWithPhoneBody, LoginPosDeviceWithPhoneContent, LoginPosDeviceWithPhoneHeaderParams, LoginPosDeviceWithPhoneResponse, LoginPosDeviceWithWhatsappBody, LoginPosDeviceWithWhatsappContent, LoginPosDeviceWithWhatsappHeaderParams, LoginPosDeviceWithWhatsappResponse, LoginWithEmailBody, LoginWithEmailContent, LoginWithEmailHeaderParams, LoginWithEmailResponse, LoginWithPasswordBody, LoginWithPasswordContent, LoginWithPasswordResponse, LoginWithPhoneBody, LoginWithPhoneContent, LoginWithPhoneHeaderParams, LoginWithPhoneResponse, LoginWithWhatsappBody, LoginWithWhatsappContent, LoginWithWhatsappHeaderParams, LoginWithWhatsappResponse, LogoutContent, LogoutFromPosDeviceResponse, LogoutResponse, LotBatchDetail, LoyaltyPointActivity, ManualPaymentMethod, MarketplaceItem, MarketplaceProduct, MarketplaceProductDetail, MemoryTokenStorage, MultiSelectAttribute, NetbankingPayment, NotificationChannelPreferences, NotificationChannelPreferencesInput, NotificationPreferences, NotificationPreferencesInput, NumberAttribute, Order, OrderClient, OrderDetail, OrderItem, OrderList, OrderPayment, OrderRefund, OrderReturn, OrderReturnItem, OrderReturnItemInput, OrderShipment, OtpContent, Pagination, PairPosDeviceBody, PairPosDeviceContent, PairPosDeviceResponse, PanDetail, PartialCollectAndDelivery, PartialCollectAndDeliveryInput, PauseSubscriptionInput, PayWithCardInput, PayWithCashInput, PayWithUpiInput, PaymentInfo, PaymentMethodPayloadInput, PaymentProvider, PaymentsClient, PayuPaymentInfo, PayuPaymentMethod, PercentageDiscountRule, Pincode, PosApplyCouponBody, PosApplyCouponContent, PosApplyCouponPathParams, PosApplyCouponResponse, PosCreateCartAddressBody, PosCreateCartAddressContent, PosCreateCartAddressPathParams, PosCreateCartAddressResponse, PosCreateCartBody, PosCreateCartContent, PosCreateCartResponse, PosDeleteCartPathParams, PosDeleteCartResponse, PosDevice, PosDeviceClaimedUser, PosEvaluateCouponsContent, PosEvaluateCouponsPathParams, PosEvaluateCouponsResponse, PosEvaluatePromotionsContent, PosEvaluatePromotionsPathParams, PosEvaluatePromotionsResponse, PosGetCartContent, PosGetCartPathParams, PosGetCartResponse, PosGetPaymentStatusContent, PosGetPaymentStatusPathParams, PosGetPaymentStatusResponse, PosGetProductDetailContent, PosGetProductDetailHeaderParams, PosGetProductDetailPathParams, PosGetProductDetailQuery, PosGetProductDetailResponse, PosGetUserCartContent, PosGetUserCartPathParams, PosGetUserCartResponse, PosGetVariantDetailContent, PosGetVariantDetailHeaderParams, PosGetVariantDetailPathParams, PosGetVariantDetailQuery, PosGetVariantDetailResponse, PosListCategoriesContent, PosListCategoriesQuery, PosListCategoriesResponse, PosListCouponsContent, PosListCouponsHeaderParams, PosListCouponsResponse, PosListCrosssellProductsContent, PosListCrosssellProductsHeaderParams, PosListCrosssellProductsQuery, PosListCrosssellProductsResponse, PosListProductReviewsContent, PosListProductReviewsPathParams, PosListProductReviewsQuery, PosListProductReviewsResponse, PosListProductVariantsContent, PosListProductVariantsHeaderParams, PosListProductVariantsPathParams, PosListProductVariantsQuery, PosListProductVariantsResponse, PosListProductsContent, PosListProductsHeaderParams, PosListProductsQuery, PosListProductsResponse, PosListPromotionsContent, PosListPromotionsHeaderParams, PosListPromotionsResponse, PosListSimilarProductsContent, PosListSimilarProductsHeaderParams, PosListSimilarProductsQuery, PosListSimilarProductsResponse, PosListSkusContent, PosListSkusHeaderParams, PosListSkusQuery, PosListSkusResponse, PosListUpsellProductsContent, PosListUpsellProductsHeaderParams, PosListUpsellProductsQuery, PosListUpsellProductsResponse, PosLocation, PosRedeemCreditBalanceBody, PosRedeemCreditBalanceContent, PosRedeemCreditBalancePathParams, PosRedeemCreditBalanceResponse, PosRedeemLoyaltyPointsBody, PosRedeemLoyaltyPointsContent, PosRedeemLoyaltyPointsPathParams, PosRedeemLoyaltyPointsResponse, PosRemoveCouponContent, PosRemoveCouponPathParams, PosRemoveCouponResponse, PosRemoveCreditBalanceContent, PosRemoveCreditBalancePathParams, PosRemoveCreditBalanceResponse, PosRemoveLoyaltyPointsContent, PosRemoveLoyaltyPointsPathParams, PosRemoveLoyaltyPointsResponse, PosSearchProductsBody, PosSearchProductsContent, PosSearchProductsHeaderParams, PosSearchProductsResponse, PosUpdateCartBody, PosUpdateCartContent, PosUpdateCartPathParams, PosUpdateCartResponse, PosUpdateCustomerWithEmailInput, PosUpdateCustomerWithIdInput, PosUpdateCustomerWithPhoneInput, PosUpdateFulfillmentPreferenceBody, PosUpdateFulfillmentPreferenceContent, PosUpdateFulfillmentPreferencePathParams, PosUpdateFulfillmentPreferenceResponse, PosUser, Product, ProductAttribute, ProductBundleItem, ProductCategory, ProductDetail, ProductImage, ProductPricing, ProductPromotion, ProductReview, ProductShipping, ProductSubscription, ProductVideo, Promotion, PromotionType, PublicCatalogClient, PublicHelpersClient, PublicStoreConfigClient, PublicStorefrontAPIClient, PublicStorefrontSDK, type PublicStorefrontSDKOptions, type Readable, RedeemCreditBalanceBody, RedeemCreditBalanceContent, RedeemCreditBalancePathParams, RedeemCreditBalanceResponse, RedeemLoyaltyPointsBody, RedeemLoyaltyPointsContent, RedeemLoyaltyPointsPathParams, RedeemLoyaltyPointsResponse, RefreshPosAccessTokenBody, RefreshPosAccessTokenContent, RefreshPosAccessTokenResponse, RefreshTokenBody, RefreshTokenContent, RefreshTokenResponse, RegisterWithEmailBody, RegisterWithEmailContent, RegisterWithEmailHeaderParams, RegisterWithEmailPasswordInput, RegisterWithEmailResponse, RegisterWithPasswordBody, RegisterWithPasswordContent, RegisterWithPasswordHeaderParams, RegisterWithPasswordResponse, RegisterWithPhoneBody, RegisterWithPhoneContent, RegisterWithPhoneHeaderParams, RegisterWithPhonePasswordInput, RegisterWithPhoneResponse, RegisterWithWhatsappBody, RegisterWithWhatsappContent, RegisterWithWhatsappHeaderParams, RegisterWithWhatsappResponse, RemoveCouponContent, RemoveCouponPathParams, RemoveCouponResponse, RemoveCreditBalanceContent, RemoveCreditBalancePathParams, RemoveCreditBalanceResponse, RemoveLoyaltyPointsContent, RemoveLoyaltyPointsPathParams, RemoveLoyaltyPointsResponse, RemoveProfileImagePathParams, RemoveProfileImageResponse, ResendDirectOtpBody, ResendDirectOtpContent, ResendDirectOtpResponse, ResetPasswordBody, ResetPasswordContent, ResetPasswordResponse, ResponseUtils, RetryOrderPaymentBody, RetryOrderPaymentContent, RetryOrderPaymentPathParams, RetryOrderPaymentResponse, RevokeSubscriptionInput, SavedPaymentMethod, SearchMarketplaceProductsBody, SearchMarketplaceProductsContent, SearchMarketplaceProductsHeaderParams, SearchMarketplaceProductsResponse, SearchProductInput, SearchProductsBody, SearchProductsContent, SearchProductsHeaderParams, SearchProductsResponse, SellerDetail, SellerInfo, SellerReview, SellerReviewStats, SendOtpWithEmailInput, SendOtpWithPhoneInput, Seo, ServiceProviderBasicDetail, SessionStorefrontAPIClient, SessionStorefrontConfig, SessionStorefrontSDK, type SessionStorefrontSDKOptions, ShipmentItem, ShipmentStatus, SingleSelectAttribute, SingleSelectOption, StoreConfig, StoreConfigClient, StoreTemplate, StorefrontFactory, type StorefrontSession, SubscribeNewsletterBody, SubscribeNewsletterResponse, Subscription, SubscriptionBehaviourInput, SubscriptionDetail, SubscriptionInvoiceItem, SubscriptionInvoiceItemInput, type SupportedDefaultHeaders, TextAttribute, type TokenStorage, TrackAnalyticsEventBody, TrackAnalyticsEventResponse, UnclaimPosDeviceContent, UnclaimPosDevicePathParams, UnclaimPosDeviceResponse, UnserviceableItem, UpdateAddressDetailBody, UpdateAddressDetailContent, UpdateAddressDetailPathParams, UpdateAddressDetailResponse, UpdateCartBody, UpdateCartContent, UpdateCartItemInput, UpdateCartPathParams, UpdateCartResponse, UpdateDigitalProductSubscriptionInput, UpdateDocumentContent, UpdateDocumentFormData, UpdateDocumentInput, UpdateDocumentPathParams, UpdateDocumentResponse, UpdateFulfillmentPreferenceBody, UpdateFulfillmentPreferenceContent, UpdateFulfillmentPreferencePathParams, UpdateFulfillmentPreferenceResponse, UpdatePhysicalProductSubscriptionInput, UpdatePosCartCustomerBody, UpdatePosCartCustomerContent, UpdatePosCartCustomerPathParams, UpdatePosCartCustomerResponse, UpdateProfileImageContent, UpdateProfileImageFormData, UpdateProfileImagePathParams, UpdateProfileImageResponse, UpdateSubscriptionBody, UpdateSubscriptionContent, UpdateSubscriptionPathParams, UpdateSubscriptionResponse, UpdateUserBody, UpdateUserContent, UpdateUserPathParams, UpdateUserResponse, UpiPayment, User, type UserInfo, UserInput, Variant, VariantDetail, VariantOption, VerifyDocumentBody, VerifyDocumentContent, VerifyDocumentPathParams, VerifyDocumentResponse, VerifyOtpBody, VerifyOtpContent, VerifyOtpResponse, VerifyPosLoginOtpBody, VerifyPosLoginOtpContent, VerifyPosLoginOtpResponse, VerifyVpaContent, VerifyVpaQuery, VerifyVpaResponse, VolumeBasedCouponPromotion, VolumeBasedPromotion, VolumeBasedRule, WalletPayment, type Writable, type components, createDebugMiddleware, createStorefront, createTimeoutMiddleware, executeRequest, extractRequestBody, getPathnameFromUrl, mergeAndTransformHeaders, mergeHeaders, type operations, type paths, transformHeaders };
|
|
16188
16569
|
//# sourceMappingURL=index.d.mts.map
|