linxcommerce-webapi-sdk 1.0.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/README.md +116 -0
- package/dist/index.d.ts +2908 -0
- package/dist/index.js +4634 -0
- package/dist/index.mjs +4586 -0
- package/package.json +44 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,2908 @@
|
|
|
1
|
+
import { ZodType, z } from 'zod';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Available API environments with their base URLs.
|
|
5
|
+
* Use these constants to configure the SDK for different environments (production, staging, etc.).
|
|
6
|
+
*/
|
|
7
|
+
declare enum Environment {
|
|
8
|
+
/** DEFAULT environment base URL */
|
|
9
|
+
DEFAULT = "https://{{apiLinxcommerce}}",
|
|
10
|
+
/** APILINXCOMMERCE environment base URL */
|
|
11
|
+
APILINXCOMMERCE = "https://{{apiLinxcommerce}}",
|
|
12
|
+
/** STOREURL environment base URL */
|
|
13
|
+
STOREURL = "https://{{storeUrl}}",
|
|
14
|
+
/** URLSTORE environment base URL */
|
|
15
|
+
URLSTORE = "https://{{urlStore}}",
|
|
16
|
+
/** URLSTORESHOPPING environment base URL */
|
|
17
|
+
URLSTORESHOPPING = "https://{{urlStore}}Shopping",
|
|
18
|
+
/** URLLINX environment base URL */
|
|
19
|
+
URLLINX = "https://{{urlLinx}}",
|
|
20
|
+
/** VIACEP environment base URL */
|
|
21
|
+
VIACEP = "https://viacep.com.br"
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Standard HTTP methods supported by the SDK.
|
|
26
|
+
*/
|
|
27
|
+
type HttpMethod$1 = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
|
|
28
|
+
/**
|
|
29
|
+
* Represents an HTTP request with all its components.
|
|
30
|
+
*/
|
|
31
|
+
interface HttpRequest {
|
|
32
|
+
/** Base URL of the API endpoint */
|
|
33
|
+
baseUrl: string;
|
|
34
|
+
/** HTTP method for the request */
|
|
35
|
+
method: HttpMethod$1;
|
|
36
|
+
/** Request path (relative to base URL) */
|
|
37
|
+
path: string;
|
|
38
|
+
/** Request headers as key-value pairs */
|
|
39
|
+
headers: Map<string, unknown>;
|
|
40
|
+
/** Request body payload (optional) */
|
|
41
|
+
body?: BodyInit;
|
|
42
|
+
/** Signal to abort the request (optional) */
|
|
43
|
+
abortSignal?: AbortSignal;
|
|
44
|
+
/** Query string parameters */
|
|
45
|
+
queryParams: Map<string, unknown>;
|
|
46
|
+
/** Path parameters for URL templating */
|
|
47
|
+
pathParams: Map<string, unknown>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Metadata about an HTTP response.
|
|
51
|
+
*/
|
|
52
|
+
interface HttpMetadata$1 {
|
|
53
|
+
/** HTTP status code */
|
|
54
|
+
status: number;
|
|
55
|
+
/** HTTP status text message */
|
|
56
|
+
statusText: string;
|
|
57
|
+
/** Response headers as key-value pairs */
|
|
58
|
+
headers: Record<string, string>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Represents an HTTP response with typed data.
|
|
62
|
+
* @template T - The type of the response data
|
|
63
|
+
*/
|
|
64
|
+
interface HttpResponse$1<T> {
|
|
65
|
+
/** Parsed response data (optional) */
|
|
66
|
+
data?: T;
|
|
67
|
+
/** Response metadata (status, headers, etc.) */
|
|
68
|
+
metadata: HttpMetadata$1;
|
|
69
|
+
/** Raw response object from the HTTP client */
|
|
70
|
+
raw: ArrayBuffer;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Represents an HTTP error response.
|
|
74
|
+
*/
|
|
75
|
+
interface HttpError$1 {
|
|
76
|
+
/** Error message or description */
|
|
77
|
+
error: string;
|
|
78
|
+
/** Response metadata (status, headers, etc.) */
|
|
79
|
+
metadata: HttpMetadata$1;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Hook interface for intercepting and modifying HTTP requests and responses.
|
|
83
|
+
* Allows custom logic to be executed at different stages of the request lifecycle.
|
|
84
|
+
*/
|
|
85
|
+
interface Hook {
|
|
86
|
+
/**
|
|
87
|
+
* Called before an HTTP request is sent.
|
|
88
|
+
* Allows modification of the request before execution.
|
|
89
|
+
* @param request - The HTTP request to be sent
|
|
90
|
+
* @param params - Additional custom parameters
|
|
91
|
+
* @returns A promise that resolves to the potentially modified request
|
|
92
|
+
*/
|
|
93
|
+
beforeRequest(request: HttpRequest, params: Map<string, string>): Promise<HttpRequest>;
|
|
94
|
+
/**
|
|
95
|
+
* Called after a successful HTTP response is received.
|
|
96
|
+
* Allows processing or modification of the response.
|
|
97
|
+
* @param request - The original HTTP request
|
|
98
|
+
* @param response - The HTTP response received
|
|
99
|
+
* @param params - Additional custom parameters
|
|
100
|
+
* @returns A promise that resolves to the potentially modified response
|
|
101
|
+
*/
|
|
102
|
+
afterResponse(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpResponse$1<any>>;
|
|
103
|
+
/**
|
|
104
|
+
* Called when an HTTP request results in an error.
|
|
105
|
+
* Allows custom error handling and transformation.
|
|
106
|
+
* @param request - The original HTTP request
|
|
107
|
+
* @param response - The error response received
|
|
108
|
+
* @param params - Additional custom parameters
|
|
109
|
+
* @returns A promise that resolves to an error object
|
|
110
|
+
*/
|
|
111
|
+
onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError$1>;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* OpenAPI parameter serialization styles.
|
|
116
|
+
* Defines how parameters should be formatted in the request.
|
|
117
|
+
*/
|
|
118
|
+
declare enum SerializationStyle {
|
|
119
|
+
/** Simple comma-separated values (e.g., "3,4,5") */
|
|
120
|
+
SIMPLE = "simple",
|
|
121
|
+
/** Label prefix with dot notation (e.g., ".3.4.5") */
|
|
122
|
+
LABEL = "label",
|
|
123
|
+
/** Matrix semicolon-prefixed (e.g., ";id=3;id=4") */
|
|
124
|
+
MATRIX = "matrix",
|
|
125
|
+
/** Form-style ampersand-separated (e.g., "id=3&id=4") */
|
|
126
|
+
FORM = "form",
|
|
127
|
+
/** Space-delimited values (e.g., "id=3 4 5") */
|
|
128
|
+
SPACE_DELIMITED = "space_delimited",
|
|
129
|
+
/** Pipe-delimited values (e.g., "id=3|4|5") */
|
|
130
|
+
PIPE_DELIMITED = "pipe_delimited",
|
|
131
|
+
/** Deep object notation (e.g., "id[role]=admin") */
|
|
132
|
+
DEEP_OBJECT = "deep_object",
|
|
133
|
+
/** No specific style applied */
|
|
134
|
+
NONE = "none"
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Error class that can be thrown explicitly via a throw() method.
|
|
139
|
+
* Extends the built-in Error class with a convenience method for throwing.
|
|
140
|
+
*/
|
|
141
|
+
declare class ThrowableError extends Error {
|
|
142
|
+
message: string;
|
|
143
|
+
protected response?: unknown;
|
|
144
|
+
/**
|
|
145
|
+
* Optional metadata about the HTTP response that triggered this error.
|
|
146
|
+
*/
|
|
147
|
+
metadata?: HttpMetadata;
|
|
148
|
+
/**
|
|
149
|
+
* Creates a new throwable error.
|
|
150
|
+
* @param message - The error message
|
|
151
|
+
* @param response - Optional response data associated with the error
|
|
152
|
+
*/
|
|
153
|
+
constructor(message: string, response?: unknown);
|
|
154
|
+
/**
|
|
155
|
+
* Throws this error instance.
|
|
156
|
+
* Convenience method for explicitly throwing the error.
|
|
157
|
+
* @throws This error instance
|
|
158
|
+
*/
|
|
159
|
+
throw(): void;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Defines an expected response format with schema validation.
|
|
164
|
+
* Used to match and validate responses based on content type and status code.
|
|
165
|
+
*/
|
|
166
|
+
interface ResponseDefinition {
|
|
167
|
+
/** Zod schema for validating the response body */
|
|
168
|
+
schema: ZodType;
|
|
169
|
+
/** The content type of this response (e.g., 'application/json') */
|
|
170
|
+
contentType: ContentType;
|
|
171
|
+
/** The HTTP status code this definition applies to */
|
|
172
|
+
status: number;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Defines an error response format with custom error class.
|
|
176
|
+
* Used to throw typed errors based on content type and status code.
|
|
177
|
+
*/
|
|
178
|
+
interface ErrorDefinition {
|
|
179
|
+
/** Constructor for the error class to instantiate */
|
|
180
|
+
error: new (...args: any[]) => ThrowableError;
|
|
181
|
+
/** The content type of this error response */
|
|
182
|
+
contentType: ContentType;
|
|
183
|
+
/** The HTTP status code this error applies to */
|
|
184
|
+
status: number;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Parameters required to create a Request instance.
|
|
188
|
+
* Contains all configuration needed for HTTP execution, validation, and error handling.
|
|
189
|
+
*
|
|
190
|
+
* @template Page - The type of paginated data items
|
|
191
|
+
*/
|
|
192
|
+
interface CreateRequestParameters<Page = unknown[]> {
|
|
193
|
+
baseUrl: string;
|
|
194
|
+
method: HttpMethod;
|
|
195
|
+
body?: any;
|
|
196
|
+
headers: Map<string, RequestParameter>;
|
|
197
|
+
queryParams: Map<string, RequestParameter>;
|
|
198
|
+
pathParams: Map<string, RequestParameter>;
|
|
199
|
+
cookies: Map<string, RequestParameter>;
|
|
200
|
+
path: string;
|
|
201
|
+
config: SdkConfig;
|
|
202
|
+
responses: ResponseDefinition[];
|
|
203
|
+
errors: ErrorDefinition[];
|
|
204
|
+
requestSchema: ZodType;
|
|
205
|
+
requestContentType: ContentType;
|
|
206
|
+
pagination?: RequestPagination<Page> | RequestCursorPagination<Page>;
|
|
207
|
+
filename?: string;
|
|
208
|
+
filenames?: string[];
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Represents a request parameter with serialization metadata.
|
|
212
|
+
* Wraps a value with OpenAPI serialization instructions for proper encoding.
|
|
213
|
+
*/
|
|
214
|
+
interface RequestParameter {
|
|
215
|
+
/** The parameter name (may be undefined for path substitution) */
|
|
216
|
+
key: string | undefined;
|
|
217
|
+
/** The actual parameter value */
|
|
218
|
+
value: unknown;
|
|
219
|
+
/** Whether to explode arrays/objects into multiple parameters */
|
|
220
|
+
explode: boolean;
|
|
221
|
+
/** Whether to URL-encode the value */
|
|
222
|
+
encode: boolean;
|
|
223
|
+
/** The OpenAPI serialization style (e.g., SIMPLE, FORM, MATRIX) */
|
|
224
|
+
style: SerializationStyle;
|
|
225
|
+
/** Whether this parameter is a pagination limit */
|
|
226
|
+
isLimit: boolean;
|
|
227
|
+
/** Whether this parameter is a pagination offset */
|
|
228
|
+
isOffset: boolean;
|
|
229
|
+
/** Whether this parameter is a pagination cursor */
|
|
230
|
+
isCursor: boolean;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Configuration for limit-offset pagination.
|
|
234
|
+
* Used for traditional page-based pagination with size and offset.
|
|
235
|
+
*
|
|
236
|
+
* @template Page - The type of page data
|
|
237
|
+
*/
|
|
238
|
+
interface RequestPagination<Page> {
|
|
239
|
+
/** The number of items per page */
|
|
240
|
+
pageSize?: number;
|
|
241
|
+
/** JSON path to extract page data from response */
|
|
242
|
+
pagePath: string[];
|
|
243
|
+
/** Zod schema for validating page data */
|
|
244
|
+
pageSchema?: ZodType<Page, any, any>;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Configuration for cursor-based pagination.
|
|
248
|
+
* Used for stateless pagination with cursor tokens.
|
|
249
|
+
*
|
|
250
|
+
* @template Page - The type of page data
|
|
251
|
+
*/
|
|
252
|
+
interface RequestCursorPagination<Page> {
|
|
253
|
+
/** JSON path to extract page data from response */
|
|
254
|
+
pagePath: string[];
|
|
255
|
+
/** Zod schema for validating page data */
|
|
256
|
+
pageSchema?: ZodType<Page, any, any>;
|
|
257
|
+
/** JSON path to extract next cursor from response */
|
|
258
|
+
cursorPath: string[];
|
|
259
|
+
/** Zod schema for validating cursor value */
|
|
260
|
+
cursorSchema?: ZodType<string | null | undefined>;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Represents an HTTP request with all necessary configuration and parameters.
|
|
265
|
+
* Handles path/query/header/cookie serialization, pagination, validation, and retry logic.
|
|
266
|
+
* This is the core request object passed through the handler chain for execution.
|
|
267
|
+
*
|
|
268
|
+
* @template PageSchema - The type of paginated data returned by this request
|
|
269
|
+
*/
|
|
270
|
+
declare class Request<PageSchema = unknown[]> {
|
|
271
|
+
baseUrl: string;
|
|
272
|
+
headers: Map<string, RequestParameter>;
|
|
273
|
+
queryParams: Map<string, RequestParameter>;
|
|
274
|
+
pathParams: Map<string, RequestParameter>;
|
|
275
|
+
cookies: Map<string, RequestParameter>;
|
|
276
|
+
body?: any;
|
|
277
|
+
method: HttpMethod;
|
|
278
|
+
path: string;
|
|
279
|
+
config: SdkConfig;
|
|
280
|
+
responses: ResponseDefinition[];
|
|
281
|
+
errors: ErrorDefinition[];
|
|
282
|
+
requestSchema: ZodType;
|
|
283
|
+
requestContentType: ContentType;
|
|
284
|
+
pagination?: RequestPagination<PageSchema> | RequestCursorPagination<PageSchema>;
|
|
285
|
+
filename?: string;
|
|
286
|
+
filenames?: string[];
|
|
287
|
+
private readonly pathPattern;
|
|
288
|
+
constructor(params: CreateRequestParameters<PageSchema>);
|
|
289
|
+
/**
|
|
290
|
+
* Adds a header parameter to the request with OpenAPI serialization rules.
|
|
291
|
+
*
|
|
292
|
+
* @param key - The header name
|
|
293
|
+
* @param param - The parameter configuration including value, style, and encoding options
|
|
294
|
+
*/
|
|
295
|
+
addHeaderParam(key: string, param: RequestParameter): void;
|
|
296
|
+
/**
|
|
297
|
+
* Adds a query parameter to the request with OpenAPI serialization rules.
|
|
298
|
+
*
|
|
299
|
+
* @param key - The query parameter name
|
|
300
|
+
* @param param - The parameter configuration including value, style, and encoding options
|
|
301
|
+
*/
|
|
302
|
+
addQueryParam(key: string, param: RequestParameter): void;
|
|
303
|
+
/**
|
|
304
|
+
* Adds a path parameter to the request with OpenAPI serialization rules.
|
|
305
|
+
*
|
|
306
|
+
* @param key - The path parameter name (matches template variable in path pattern)
|
|
307
|
+
* @param param - The parameter configuration including value, style, and encoding options
|
|
308
|
+
*/
|
|
309
|
+
addPathParam(key: string, param: RequestParameter): void;
|
|
310
|
+
/**
|
|
311
|
+
* Sets the request body if the value is defined.
|
|
312
|
+
*
|
|
313
|
+
* @param body - The request body to send
|
|
314
|
+
*/
|
|
315
|
+
addBody(body: any): void;
|
|
316
|
+
/**
|
|
317
|
+
* Updates this request from a modified hook request.
|
|
318
|
+
* Used after hooks modify the request to sync changes back to the internal Request object.
|
|
319
|
+
*
|
|
320
|
+
* @param hookRequest - The modified request from hook processing
|
|
321
|
+
*/
|
|
322
|
+
updateFromHookRequest(hookRequest: HttpRequest): void;
|
|
323
|
+
/**
|
|
324
|
+
* Constructs the complete URL by combining base URL, path with substituted parameters,
|
|
325
|
+
* and serialized query string.
|
|
326
|
+
*
|
|
327
|
+
* @returns The fully constructed URL ready for HTTP execution
|
|
328
|
+
*/
|
|
329
|
+
constructFullUrl(): string;
|
|
330
|
+
/**
|
|
331
|
+
* Creates a copy of this request with optional parameter overrides.
|
|
332
|
+
* Useful for pagination where you need to modify parameters while keeping the rest intact.
|
|
333
|
+
*
|
|
334
|
+
* @param overrides - Optional parameters to override in the copied request
|
|
335
|
+
* @returns A new Request instance with the specified overrides
|
|
336
|
+
*/
|
|
337
|
+
copy(overrides?: Partial<CreateRequestParameters>): Request<unknown[]>;
|
|
338
|
+
/**
|
|
339
|
+
* Serializes headers to a format suitable for HTTP execution.
|
|
340
|
+
*
|
|
341
|
+
* @returns Serialized headers as HeadersInit, or undefined if no headers
|
|
342
|
+
*/
|
|
343
|
+
getHeaders(): HeadersInit | undefined;
|
|
344
|
+
/**
|
|
345
|
+
* Serializes cookies to a format suitable for HTTP execution.
|
|
346
|
+
*
|
|
347
|
+
* @returns Serialized cookies as a record, or undefined if no cookies
|
|
348
|
+
*/
|
|
349
|
+
getCookies(): Record<string, string> | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* Advances pagination parameters to fetch the next page.
|
|
352
|
+
* Handles both cursor-based and limit-offset pagination strategies.
|
|
353
|
+
*
|
|
354
|
+
* @param cursor - The cursor value for cursor-based pagination (optional for limit-offset)
|
|
355
|
+
*/
|
|
356
|
+
nextPage(cursor?: string): void;
|
|
357
|
+
private constructPath;
|
|
358
|
+
private getOffsetParam;
|
|
359
|
+
private getCursorParam;
|
|
360
|
+
private getAllParams;
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Standard HTTP methods supported by the SDK.
|
|
365
|
+
*/
|
|
366
|
+
type HttpMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
|
|
367
|
+
/**
|
|
368
|
+
* SDK configuration interface.
|
|
369
|
+
* Contains all settings required to initialize and configure the SDK.
|
|
370
|
+
*/
|
|
371
|
+
interface SdkConfig {
|
|
372
|
+
baseUrl?: string;
|
|
373
|
+
environment?: Environment;
|
|
374
|
+
timeoutMs?: number;
|
|
375
|
+
username?: string;
|
|
376
|
+
password?: string;
|
|
377
|
+
retry?: RetryOptions;
|
|
378
|
+
validation?: ValidationOptions;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Metadata about an HTTP response.
|
|
382
|
+
* Contains status information and headers from the server response.
|
|
383
|
+
*/
|
|
384
|
+
interface HttpMetadata {
|
|
385
|
+
/** HTTP status code (e.g., 200, 404, 500) */
|
|
386
|
+
status: number;
|
|
387
|
+
/** HTTP status text message (e.g., "OK", "Not Found") */
|
|
388
|
+
statusText: string;
|
|
389
|
+
/** Response headers as key-value pairs */
|
|
390
|
+
headers: Record<string, string>;
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* Standard HTTP response with typed data.
|
|
394
|
+
* @template T - The type of the response data
|
|
395
|
+
*/
|
|
396
|
+
interface HttpResponse<T = unknown> {
|
|
397
|
+
/** Parsed response data (optional) */
|
|
398
|
+
data?: T;
|
|
399
|
+
/** Response metadata (status, headers, etc.) */
|
|
400
|
+
metadata: HttpMetadata;
|
|
401
|
+
/** Raw response object from the HTTP client */
|
|
402
|
+
raw: ArrayBuffer;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* HTTP response for paginated API endpoints.
|
|
406
|
+
* Marker interface extending HttpResponse for type safety with pagination.
|
|
407
|
+
* @template T - The type of a single page of data
|
|
408
|
+
*/
|
|
409
|
+
interface PaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* HTTP response for cursor-paginated API endpoints.
|
|
413
|
+
* Includes a cursor for fetching the next page of results.
|
|
414
|
+
* @template T - The type of a single page of data
|
|
415
|
+
*/
|
|
416
|
+
interface CursorPaginatedHttpResponse<T = unknown> extends HttpResponse<T> {
|
|
417
|
+
/** Cursor string for fetching the next page, null if no more pages, undefined if not applicable */
|
|
418
|
+
nextCursor?: string | null;
|
|
419
|
+
}
|
|
420
|
+
/**
|
|
421
|
+
* Supported content types for HTTP requests and responses.
|
|
422
|
+
* Determines how the SDK serializes requests and parses responses.
|
|
423
|
+
*/
|
|
424
|
+
declare enum ContentType {
|
|
425
|
+
/** JSON format (application/json) */
|
|
426
|
+
Json = "json",
|
|
427
|
+
/** XML format (application/xml, text/xml) */
|
|
428
|
+
Xml = "xml",
|
|
429
|
+
/** PDF document (application/pdf) */
|
|
430
|
+
Pdf = "pdf",
|
|
431
|
+
/** Image file (image/*) */
|
|
432
|
+
Image = "image",
|
|
433
|
+
/** Generic file */
|
|
434
|
+
File = "file",
|
|
435
|
+
/** Binary data (application/octet-stream) */
|
|
436
|
+
Binary = "binary",
|
|
437
|
+
/** URL-encoded form data (application/x-www-form-urlencoded) */
|
|
438
|
+
FormUrlEncoded = "form",
|
|
439
|
+
/** Plain text (text/plain) */
|
|
440
|
+
Text = "text",
|
|
441
|
+
/** Multipart form data for file uploads (multipart/form-data) */
|
|
442
|
+
MultipartFormData = "multipartFormData",
|
|
443
|
+
/** Server-sent events stream (text/event-stream) */
|
|
444
|
+
EventStream = "eventStream",
|
|
445
|
+
/** No content (HTTP 204) */
|
|
446
|
+
NoContent = "noContent"
|
|
447
|
+
}
|
|
448
|
+
interface RetryOptions {
|
|
449
|
+
attempts: number;
|
|
450
|
+
delayMs?: number;
|
|
451
|
+
maxDelayMs?: number;
|
|
452
|
+
backoffFactor?: number;
|
|
453
|
+
jitterMs?: number;
|
|
454
|
+
statusCodesToRetry?: number[];
|
|
455
|
+
httpMethodsToRetry?: HttpMethod[];
|
|
456
|
+
}
|
|
457
|
+
interface ValidationOptions {
|
|
458
|
+
responseValidation?: boolean;
|
|
459
|
+
}
|
|
460
|
+
|
|
461
|
+
/**
|
|
462
|
+
* Error class for HTTP request failures.
|
|
463
|
+
* Captures error details including status, metadata, and the raw response.
|
|
464
|
+
*/
|
|
465
|
+
declare class HttpError extends Error {
|
|
466
|
+
/** Error message or status text */
|
|
467
|
+
readonly error: string;
|
|
468
|
+
/** HTTP response metadata (status, headers, etc.) */
|
|
469
|
+
readonly metadata: HttpMetadata;
|
|
470
|
+
/** Raw response object from the HTTP client */
|
|
471
|
+
readonly raw?: ArrayBuffer;
|
|
472
|
+
/**
|
|
473
|
+
* Creates a new HTTP error.
|
|
474
|
+
* @param metadata - HTTP response metadata
|
|
475
|
+
* @param raw - Raw response object (optional)
|
|
476
|
+
* @param error - Custom error message (optional, defaults to status text)
|
|
477
|
+
*/
|
|
478
|
+
constructor(metadata: HttpMetadata, raw?: ArrayBuffer, error?: string);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Default implementation of the Hook interface that provides pass-through behavior.
|
|
483
|
+
* This hook can be extended to add custom logic for request/response interception.
|
|
484
|
+
*/
|
|
485
|
+
declare class CustomHook implements Hook {
|
|
486
|
+
/**
|
|
487
|
+
* Called before an HTTP request is sent.
|
|
488
|
+
* Default implementation returns the request unchanged.
|
|
489
|
+
* @param request - The HTTP request to be sent
|
|
490
|
+
* @param params - Additional custom parameters
|
|
491
|
+
* @returns A promise that resolves to the unmodified request
|
|
492
|
+
*/
|
|
493
|
+
beforeRequest(request: HttpRequest, params: Map<string, string>): Promise<HttpRequest>;
|
|
494
|
+
/**
|
|
495
|
+
* Called after a successful HTTP response is received.
|
|
496
|
+
* Default implementation returns the response unchanged.
|
|
497
|
+
* @param request - The original HTTP request
|
|
498
|
+
* @param response - The HTTP response received
|
|
499
|
+
* @param params - Additional custom parameters
|
|
500
|
+
* @returns A promise that resolves to the unmodified response
|
|
501
|
+
*/
|
|
502
|
+
afterResponse(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpResponse$1<any>>;
|
|
503
|
+
/**
|
|
504
|
+
* Called when an HTTP request results in an error.
|
|
505
|
+
* Default implementation wraps the error response in an HttpError object.
|
|
506
|
+
* @param request - The original HTTP request
|
|
507
|
+
* @param response - The error response received
|
|
508
|
+
* @param params - Additional custom parameters
|
|
509
|
+
* @returns A promise that resolves to an HttpError object
|
|
510
|
+
*/
|
|
511
|
+
onError(request: HttpRequest, response: HttpResponse$1<any>, params: Map<string, string>): Promise<HttpError>;
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Core HTTP client for making API requests.
|
|
516
|
+
* Manages request/response handling through a chain of handlers for validation, retry, hooks, and more.
|
|
517
|
+
*/
|
|
518
|
+
declare class HttpClient {
|
|
519
|
+
private config;
|
|
520
|
+
/** Chain of request handlers that process requests in sequence */
|
|
521
|
+
private readonly requestHandlerChain;
|
|
522
|
+
/**
|
|
523
|
+
* Creates a new HTTP client with configured request handlers.
|
|
524
|
+
* @param config - SDK configuration including base URL and authentication
|
|
525
|
+
* @param hook - Optional custom hook for request/response interception
|
|
526
|
+
*/
|
|
527
|
+
constructor(config: SdkConfig, hook?: CustomHook);
|
|
528
|
+
/**
|
|
529
|
+
* Executes a standard HTTP request.
|
|
530
|
+
* @template T - The expected response data type
|
|
531
|
+
* @param request - The HTTP request to execute
|
|
532
|
+
* @returns A promise that resolves to the HTTP response
|
|
533
|
+
*/
|
|
534
|
+
call<T>(request: Request): Promise<HttpResponse<T>>;
|
|
535
|
+
/**
|
|
536
|
+
* Executes a standard HTTP request and returns only the data directly.
|
|
537
|
+
* @template T - The expected response data type
|
|
538
|
+
* @param request - The HTTP request to execute
|
|
539
|
+
* @returns A promise that resolves to the response data
|
|
540
|
+
*/
|
|
541
|
+
callDirect<T>(request: Request): Promise<T>;
|
|
542
|
+
/**
|
|
543
|
+
* Executes a streaming HTTP request that yields responses incrementally.
|
|
544
|
+
* @template T - The expected response data type for each chunk
|
|
545
|
+
* @param request - The HTTP request to execute
|
|
546
|
+
* @returns An async generator that yields HTTP responses
|
|
547
|
+
*/
|
|
548
|
+
stream<T>(request: Request): AsyncGenerator<HttpResponse<T>>;
|
|
549
|
+
/**
|
|
550
|
+
* Executes a paginated HTTP request and extracts the page data from the response.
|
|
551
|
+
* @template FullResponse - The complete response type from the API
|
|
552
|
+
* @template Page - The type of a single page of data
|
|
553
|
+
* @param request - The paginated HTTP request to execute
|
|
554
|
+
* @returns A promise that resolves to the paginated HTTP response
|
|
555
|
+
* @throws Error if the response contains no data to paginate through
|
|
556
|
+
*/
|
|
557
|
+
callPaginated<FullResponse, Page>(request: Request<Page>): Promise<PaginatedHttpResponse<Page>>;
|
|
558
|
+
/**
|
|
559
|
+
* Executes a cursor-paginated HTTP request and extracts both page data and the next cursor.
|
|
560
|
+
* @template FullResponse - The complete response type from the API
|
|
561
|
+
* @template Page - The type of a single page of data
|
|
562
|
+
* @param request - The cursor-paginated HTTP request to execute
|
|
563
|
+
* @returns A promise that resolves to the cursor-paginated HTTP response with next cursor
|
|
564
|
+
* @throws Error if the response contains no data to paginate through
|
|
565
|
+
*/
|
|
566
|
+
callCursorPaginated<FullResponse, Page>(request: Request<Page>): Promise<CursorPaginatedHttpResponse<Page>>;
|
|
567
|
+
/**
|
|
568
|
+
* Updates the base URL for all subsequent requests.
|
|
569
|
+
* @param url - The new base URL to use
|
|
570
|
+
*/
|
|
571
|
+
setBaseUrl(url: string): void;
|
|
572
|
+
/**
|
|
573
|
+
* Updates the SDK configuration.
|
|
574
|
+
* @param config - The new SDK configuration
|
|
575
|
+
*/
|
|
576
|
+
setConfig(config: SdkConfig): void;
|
|
577
|
+
/**
|
|
578
|
+
* Extracts page data from a full API response using the configured pagination path.
|
|
579
|
+
* @template FullResponse - The complete response type from the API
|
|
580
|
+
* @template Page - The type of a single page of data
|
|
581
|
+
* @param request - The request containing pagination configuration
|
|
582
|
+
* @param data - The full response data to extract the page from
|
|
583
|
+
* @returns The extracted and parsed page data
|
|
584
|
+
* @throws Error if pagination is not configured or page extraction fails
|
|
585
|
+
*/
|
|
586
|
+
private getPage;
|
|
587
|
+
/**
|
|
588
|
+
* Extracts the next cursor from a full API response for cursor-based pagination.
|
|
589
|
+
* @template FullResponse - The complete response type from the API
|
|
590
|
+
* @template Page - The type of a single page of data
|
|
591
|
+
* @param request - The request containing cursor pagination configuration
|
|
592
|
+
* @param data - The full response data to extract the cursor from
|
|
593
|
+
* @returns The next cursor string, null if no more pages, or undefined if not cursor pagination
|
|
594
|
+
*/
|
|
595
|
+
private getNextCursor;
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* Base service class that all API service classes extend.
|
|
600
|
+
* Provides common functionality including HTTP client management and configuration.
|
|
601
|
+
*/
|
|
602
|
+
declare class BaseService {
|
|
603
|
+
config: SdkConfig;
|
|
604
|
+
/** The HTTP client instance used to make API requests */
|
|
605
|
+
client: HttpClient;
|
|
606
|
+
/** Service-level configuration overrides */
|
|
607
|
+
protected serviceConfig?: Partial<SdkConfig>;
|
|
608
|
+
constructor(config: SdkConfig);
|
|
609
|
+
/**
|
|
610
|
+
* Sets service-level configuration that applies to all methods in this service.
|
|
611
|
+
* @param config - Partial configuration to override SDK-level defaults
|
|
612
|
+
* @returns This service instance for method chaining
|
|
613
|
+
*/
|
|
614
|
+
setConfig(config: Partial<SdkConfig>): this;
|
|
615
|
+
/**
|
|
616
|
+
* Resolves configuration from the hierarchy: requestConfig > methodConfig > serviceConfig > sdkConfig
|
|
617
|
+
* Merges all config levels into a single resolved config object.
|
|
618
|
+
* @param methodConfig - Method-level configuration override
|
|
619
|
+
* @param requestConfig - Request-level configuration override
|
|
620
|
+
* @returns Merged configuration with all overrides applied
|
|
621
|
+
*/
|
|
622
|
+
protected getResolvedConfig(methodConfig?: Partial<SdkConfig>, requestConfig?: Partial<SdkConfig>): SdkConfig;
|
|
623
|
+
set baseUrl(baseUrl: string);
|
|
624
|
+
set environment(environment: Environment);
|
|
625
|
+
set timeoutMs(timeoutMs: number);
|
|
626
|
+
set username(username: string);
|
|
627
|
+
set password(password: string);
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
/**
|
|
631
|
+
* Zod schema for the CreateConsumerRequest model.
|
|
632
|
+
* Defines the structure and validation rules for this data type.
|
|
633
|
+
* This is the shape used in application code - what developers interact with.
|
|
634
|
+
*/
|
|
635
|
+
declare const createConsumerRequest: z.ZodLazy<z.ZodObject<{
|
|
636
|
+
customer: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
637
|
+
customerType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
638
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
639
|
+
password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
640
|
+
passwordCheck: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
641
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
642
|
+
surname: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
643
|
+
birthDate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
644
|
+
gender: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
645
|
+
cpf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
646
|
+
contact: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
647
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
648
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
649
|
+
}, "strip", z.ZodTypeAny, {
|
|
650
|
+
phone?: string | null | undefined;
|
|
651
|
+
cellPhone?: string | null | undefined;
|
|
652
|
+
}, {
|
|
653
|
+
phone?: string | null | undefined;
|
|
654
|
+
cellPhone?: string | null | undefined;
|
|
655
|
+
}>>>>;
|
|
656
|
+
}, "strip", z.ZodTypeAny, {
|
|
657
|
+
customerType?: string | null | undefined;
|
|
658
|
+
email?: string | null | undefined;
|
|
659
|
+
password?: string | null | undefined;
|
|
660
|
+
passwordCheck?: string | null | undefined;
|
|
661
|
+
name?: string | null | undefined;
|
|
662
|
+
surname?: string | null | undefined;
|
|
663
|
+
birthDate?: string | null | undefined;
|
|
664
|
+
gender?: string | null | undefined;
|
|
665
|
+
cpf?: string | null | undefined;
|
|
666
|
+
contact?: {
|
|
667
|
+
phone?: string | null | undefined;
|
|
668
|
+
cellPhone?: string | null | undefined;
|
|
669
|
+
} | null | undefined;
|
|
670
|
+
}, {
|
|
671
|
+
customerType?: string | null | undefined;
|
|
672
|
+
email?: string | null | undefined;
|
|
673
|
+
password?: string | null | undefined;
|
|
674
|
+
passwordCheck?: string | null | undefined;
|
|
675
|
+
name?: string | null | undefined;
|
|
676
|
+
surname?: string | null | undefined;
|
|
677
|
+
birthDate?: string | null | undefined;
|
|
678
|
+
gender?: string | null | undefined;
|
|
679
|
+
cpf?: string | null | undefined;
|
|
680
|
+
contact?: {
|
|
681
|
+
phone?: string | null | undefined;
|
|
682
|
+
cellPhone?: string | null | undefined;
|
|
683
|
+
} | null | undefined;
|
|
684
|
+
}>>>>;
|
|
685
|
+
basketId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
686
|
+
}, "strip", z.ZodTypeAny, {
|
|
687
|
+
customer?: {
|
|
688
|
+
customerType?: string | null | undefined;
|
|
689
|
+
email?: string | null | undefined;
|
|
690
|
+
password?: string | null | undefined;
|
|
691
|
+
passwordCheck?: string | null | undefined;
|
|
692
|
+
name?: string | null | undefined;
|
|
693
|
+
surname?: string | null | undefined;
|
|
694
|
+
birthDate?: string | null | undefined;
|
|
695
|
+
gender?: string | null | undefined;
|
|
696
|
+
cpf?: string | null | undefined;
|
|
697
|
+
contact?: {
|
|
698
|
+
phone?: string | null | undefined;
|
|
699
|
+
cellPhone?: string | null | undefined;
|
|
700
|
+
} | null | undefined;
|
|
701
|
+
} | null | undefined;
|
|
702
|
+
basketId?: number | null | undefined;
|
|
703
|
+
}, {
|
|
704
|
+
customer?: {
|
|
705
|
+
customerType?: string | null | undefined;
|
|
706
|
+
email?: string | null | undefined;
|
|
707
|
+
password?: string | null | undefined;
|
|
708
|
+
passwordCheck?: string | null | undefined;
|
|
709
|
+
name?: string | null | undefined;
|
|
710
|
+
surname?: string | null | undefined;
|
|
711
|
+
birthDate?: string | null | undefined;
|
|
712
|
+
gender?: string | null | undefined;
|
|
713
|
+
cpf?: string | null | undefined;
|
|
714
|
+
contact?: {
|
|
715
|
+
phone?: string | null | undefined;
|
|
716
|
+
cellPhone?: string | null | undefined;
|
|
717
|
+
} | null | undefined;
|
|
718
|
+
} | null | undefined;
|
|
719
|
+
basketId?: number | null | undefined;
|
|
720
|
+
}>>;
|
|
721
|
+
/**
|
|
722
|
+
*
|
|
723
|
+
* @typedef {CreateConsumerRequest} createConsumerRequest
|
|
724
|
+
* @property {CreateConsumerRequestCustomer}
|
|
725
|
+
* @property {number}
|
|
726
|
+
*/
|
|
727
|
+
type CreateConsumerRequest = z.infer<typeof createConsumerRequest>;
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* Zod schema for the CreateBusinessAccountRequest model.
|
|
731
|
+
* Defines the structure and validation rules for this data type.
|
|
732
|
+
* This is the shape used in application code - what developers interact with.
|
|
733
|
+
*/
|
|
734
|
+
declare const createBusinessAccountRequest: z.ZodLazy<z.ZodObject<{
|
|
735
|
+
customer: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
736
|
+
customerType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
737
|
+
sourceEnvironment: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
738
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
739
|
+
password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
740
|
+
passwordCheck: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
741
|
+
passwordCurrent: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
742
|
+
currentPassword: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
743
|
+
generatePassword: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
744
|
+
generateAndDefinePassword: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
745
|
+
recoveryPasswordActionUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
746
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
747
|
+
surname: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
748
|
+
birthDate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
749
|
+
gender: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
750
|
+
cpf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
751
|
+
rg: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
752
|
+
tradingName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
753
|
+
cnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
754
|
+
contact: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
755
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
756
|
+
phone2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
757
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
758
|
+
fax: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
759
|
+
}, "strip", z.ZodTypeAny, {
|
|
760
|
+
phone?: string | null | undefined;
|
|
761
|
+
phone2?: string | null | undefined;
|
|
762
|
+
cellPhone?: string | null | undefined;
|
|
763
|
+
fax?: string | null | undefined;
|
|
764
|
+
}, {
|
|
765
|
+
phone?: string | null | undefined;
|
|
766
|
+
phone2?: string | null | undefined;
|
|
767
|
+
cellPhone?: string | null | undefined;
|
|
768
|
+
fax?: string | null | undefined;
|
|
769
|
+
}>>>>;
|
|
770
|
+
extendedProperties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
771
|
+
currentUserIPs: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
772
|
+
provider: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
773
|
+
isCustomerRelation: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
774
|
+
reCaptchaToken: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
775
|
+
isFromGuestSession: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
776
|
+
prefixFormat: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
777
|
+
}, "strip", z.ZodTypeAny, {
|
|
778
|
+
customerType?: string | null | undefined;
|
|
779
|
+
sourceEnvironment?: string | null | undefined;
|
|
780
|
+
email?: string | null | undefined;
|
|
781
|
+
password?: string | null | undefined;
|
|
782
|
+
passwordCheck?: string | null | undefined;
|
|
783
|
+
passwordCurrent?: string | null | undefined;
|
|
784
|
+
currentPassword?: string | null | undefined;
|
|
785
|
+
generatePassword?: boolean | null | undefined;
|
|
786
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
787
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
788
|
+
name?: string | null | undefined;
|
|
789
|
+
surname?: string | null | undefined;
|
|
790
|
+
birthDate?: string | null | undefined;
|
|
791
|
+
gender?: string | null | undefined;
|
|
792
|
+
cpf?: string | null | undefined;
|
|
793
|
+
rg?: string | null | undefined;
|
|
794
|
+
tradingName?: string | null | undefined;
|
|
795
|
+
cnpj?: string | null | undefined;
|
|
796
|
+
contact?: {
|
|
797
|
+
phone?: string | null | undefined;
|
|
798
|
+
phone2?: string | null | undefined;
|
|
799
|
+
cellPhone?: string | null | undefined;
|
|
800
|
+
fax?: string | null | undefined;
|
|
801
|
+
} | null | undefined;
|
|
802
|
+
extendedProperties?: string[] | null | undefined;
|
|
803
|
+
currentUserIPs?: string | null | undefined;
|
|
804
|
+
provider?: string | null | undefined;
|
|
805
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
806
|
+
reCaptchaToken?: string | null | undefined;
|
|
807
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
808
|
+
prefixFormat?: string | null | undefined;
|
|
809
|
+
}, {
|
|
810
|
+
customerType?: string | null | undefined;
|
|
811
|
+
sourceEnvironment?: string | null | undefined;
|
|
812
|
+
email?: string | null | undefined;
|
|
813
|
+
password?: string | null | undefined;
|
|
814
|
+
passwordCheck?: string | null | undefined;
|
|
815
|
+
passwordCurrent?: string | null | undefined;
|
|
816
|
+
currentPassword?: string | null | undefined;
|
|
817
|
+
generatePassword?: boolean | null | undefined;
|
|
818
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
819
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
820
|
+
name?: string | null | undefined;
|
|
821
|
+
surname?: string | null | undefined;
|
|
822
|
+
birthDate?: string | null | undefined;
|
|
823
|
+
gender?: string | null | undefined;
|
|
824
|
+
cpf?: string | null | undefined;
|
|
825
|
+
rg?: string | null | undefined;
|
|
826
|
+
tradingName?: string | null | undefined;
|
|
827
|
+
cnpj?: string | null | undefined;
|
|
828
|
+
contact?: {
|
|
829
|
+
phone?: string | null | undefined;
|
|
830
|
+
phone2?: string | null | undefined;
|
|
831
|
+
cellPhone?: string | null | undefined;
|
|
832
|
+
fax?: string | null | undefined;
|
|
833
|
+
} | null | undefined;
|
|
834
|
+
extendedProperties?: string[] | null | undefined;
|
|
835
|
+
currentUserIPs?: string | null | undefined;
|
|
836
|
+
provider?: string | null | undefined;
|
|
837
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
838
|
+
reCaptchaToken?: string | null | undefined;
|
|
839
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
840
|
+
prefixFormat?: string | null | undefined;
|
|
841
|
+
}>>>>;
|
|
842
|
+
addresses: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
|
|
843
|
+
id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
844
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
845
|
+
contactName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
846
|
+
addressLine: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
847
|
+
city: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
848
|
+
neighbourhood: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
849
|
+
number: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
850
|
+
state: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
851
|
+
postalCode: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
852
|
+
addressNotes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
853
|
+
landmark: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
854
|
+
isMainAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
855
|
+
setAsShippingAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
856
|
+
setAsBillingAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
857
|
+
latitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
858
|
+
longitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
859
|
+
extendedProperties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
|
|
860
|
+
prefix: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
861
|
+
htmlAttributes: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
862
|
+
additionalProp1: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
863
|
+
additionalProp2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
864
|
+
additionalProp3: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
865
|
+
}, "strip", z.ZodTypeAny, {
|
|
866
|
+
additionalProp1?: string | null | undefined;
|
|
867
|
+
additionalProp2?: string | null | undefined;
|
|
868
|
+
additionalProp3?: string | null | undefined;
|
|
869
|
+
}, {
|
|
870
|
+
additionalProp1?: string | null | undefined;
|
|
871
|
+
additionalProp2?: string | null | undefined;
|
|
872
|
+
additionalProp3?: string | null | undefined;
|
|
873
|
+
}>>>>;
|
|
874
|
+
inputType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
875
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
876
|
+
fieldName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
877
|
+
bindType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
878
|
+
entityMetadataId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
879
|
+
value: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
880
|
+
values: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
881
|
+
isNew: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
882
|
+
isRequired: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
883
|
+
displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
884
|
+
optionName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
885
|
+
}, "strip", z.ZodTypeAny, {
|
|
886
|
+
prefix?: string | null | undefined;
|
|
887
|
+
htmlAttributes?: {
|
|
888
|
+
additionalProp1?: string | null | undefined;
|
|
889
|
+
additionalProp2?: string | null | undefined;
|
|
890
|
+
additionalProp3?: string | null | undefined;
|
|
891
|
+
} | null | undefined;
|
|
892
|
+
inputType?: string | null | undefined;
|
|
893
|
+
name?: string | null | undefined;
|
|
894
|
+
fieldName?: string | null | undefined;
|
|
895
|
+
bindType?: string | null | undefined;
|
|
896
|
+
entityMetadataId?: number | null | undefined;
|
|
897
|
+
value?: string | null | undefined;
|
|
898
|
+
values?: string[] | null | undefined;
|
|
899
|
+
isNew?: boolean | null | undefined;
|
|
900
|
+
isRequired?: boolean | null | undefined;
|
|
901
|
+
displayName?: string | null | undefined;
|
|
902
|
+
optionName?: string | null | undefined;
|
|
903
|
+
}, {
|
|
904
|
+
prefix?: string | null | undefined;
|
|
905
|
+
htmlAttributes?: {
|
|
906
|
+
additionalProp1?: string | null | undefined;
|
|
907
|
+
additionalProp2?: string | null | undefined;
|
|
908
|
+
additionalProp3?: string | null | undefined;
|
|
909
|
+
} | null | undefined;
|
|
910
|
+
inputType?: string | null | undefined;
|
|
911
|
+
name?: string | null | undefined;
|
|
912
|
+
fieldName?: string | null | undefined;
|
|
913
|
+
bindType?: string | null | undefined;
|
|
914
|
+
entityMetadataId?: number | null | undefined;
|
|
915
|
+
value?: string | null | undefined;
|
|
916
|
+
values?: string[] | null | undefined;
|
|
917
|
+
isNew?: boolean | null | undefined;
|
|
918
|
+
isRequired?: boolean | null | undefined;
|
|
919
|
+
displayName?: string | null | undefined;
|
|
920
|
+
optionName?: string | null | undefined;
|
|
921
|
+
}>>, "many">>>;
|
|
922
|
+
currentUserIPs: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
923
|
+
prefixFormat: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
924
|
+
}, "strip", z.ZodTypeAny, {
|
|
925
|
+
id?: number | null | undefined;
|
|
926
|
+
name?: string | null | undefined;
|
|
927
|
+
contactName?: string | null | undefined;
|
|
928
|
+
addressLine?: string | null | undefined;
|
|
929
|
+
city?: string | null | undefined;
|
|
930
|
+
neighbourhood?: string | null | undefined;
|
|
931
|
+
number?: string | null | undefined;
|
|
932
|
+
state?: string | null | undefined;
|
|
933
|
+
postalCode?: string | null | undefined;
|
|
934
|
+
addressNotes?: string | null | undefined;
|
|
935
|
+
landmark?: string | null | undefined;
|
|
936
|
+
isMainAddress?: boolean | null | undefined;
|
|
937
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
938
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
939
|
+
latitude?: string | null | undefined;
|
|
940
|
+
longitude?: string | null | undefined;
|
|
941
|
+
extendedProperties?: {
|
|
942
|
+
prefix?: string | null | undefined;
|
|
943
|
+
htmlAttributes?: {
|
|
944
|
+
additionalProp1?: string | null | undefined;
|
|
945
|
+
additionalProp2?: string | null | undefined;
|
|
946
|
+
additionalProp3?: string | null | undefined;
|
|
947
|
+
} | null | undefined;
|
|
948
|
+
inputType?: string | null | undefined;
|
|
949
|
+
name?: string | null | undefined;
|
|
950
|
+
fieldName?: string | null | undefined;
|
|
951
|
+
bindType?: string | null | undefined;
|
|
952
|
+
entityMetadataId?: number | null | undefined;
|
|
953
|
+
value?: string | null | undefined;
|
|
954
|
+
values?: string[] | null | undefined;
|
|
955
|
+
isNew?: boolean | null | undefined;
|
|
956
|
+
isRequired?: boolean | null | undefined;
|
|
957
|
+
displayName?: string | null | undefined;
|
|
958
|
+
optionName?: string | null | undefined;
|
|
959
|
+
}[] | null | undefined;
|
|
960
|
+
currentUserIPs?: string | null | undefined;
|
|
961
|
+
prefixFormat?: string | null | undefined;
|
|
962
|
+
}, {
|
|
963
|
+
id?: number | null | undefined;
|
|
964
|
+
name?: string | null | undefined;
|
|
965
|
+
contactName?: string | null | undefined;
|
|
966
|
+
addressLine?: string | null | undefined;
|
|
967
|
+
city?: string | null | undefined;
|
|
968
|
+
neighbourhood?: string | null | undefined;
|
|
969
|
+
number?: string | null | undefined;
|
|
970
|
+
state?: string | null | undefined;
|
|
971
|
+
postalCode?: string | null | undefined;
|
|
972
|
+
addressNotes?: string | null | undefined;
|
|
973
|
+
landmark?: string | null | undefined;
|
|
974
|
+
isMainAddress?: boolean | null | undefined;
|
|
975
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
976
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
977
|
+
latitude?: string | null | undefined;
|
|
978
|
+
longitude?: string | null | undefined;
|
|
979
|
+
extendedProperties?: {
|
|
980
|
+
prefix?: string | null | undefined;
|
|
981
|
+
htmlAttributes?: {
|
|
982
|
+
additionalProp1?: string | null | undefined;
|
|
983
|
+
additionalProp2?: string | null | undefined;
|
|
984
|
+
additionalProp3?: string | null | undefined;
|
|
985
|
+
} | null | undefined;
|
|
986
|
+
inputType?: string | null | undefined;
|
|
987
|
+
name?: string | null | undefined;
|
|
988
|
+
fieldName?: string | null | undefined;
|
|
989
|
+
bindType?: string | null | undefined;
|
|
990
|
+
entityMetadataId?: number | null | undefined;
|
|
991
|
+
value?: string | null | undefined;
|
|
992
|
+
values?: string[] | null | undefined;
|
|
993
|
+
isNew?: boolean | null | undefined;
|
|
994
|
+
isRequired?: boolean | null | undefined;
|
|
995
|
+
displayName?: string | null | undefined;
|
|
996
|
+
optionName?: string | null | undefined;
|
|
997
|
+
}[] | null | undefined;
|
|
998
|
+
currentUserIPs?: string | null | undefined;
|
|
999
|
+
prefixFormat?: string | null | undefined;
|
|
1000
|
+
}>>, "many">>>;
|
|
1001
|
+
shopperTicketId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1002
|
+
basketId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1003
|
+
customerId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1004
|
+
sessionId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1005
|
+
}, "strip", z.ZodTypeAny, {
|
|
1006
|
+
customer?: {
|
|
1007
|
+
customerType?: string | null | undefined;
|
|
1008
|
+
sourceEnvironment?: string | null | undefined;
|
|
1009
|
+
email?: string | null | undefined;
|
|
1010
|
+
password?: string | null | undefined;
|
|
1011
|
+
passwordCheck?: string | null | undefined;
|
|
1012
|
+
passwordCurrent?: string | null | undefined;
|
|
1013
|
+
currentPassword?: string | null | undefined;
|
|
1014
|
+
generatePassword?: boolean | null | undefined;
|
|
1015
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
1016
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
1017
|
+
name?: string | null | undefined;
|
|
1018
|
+
surname?: string | null | undefined;
|
|
1019
|
+
birthDate?: string | null | undefined;
|
|
1020
|
+
gender?: string | null | undefined;
|
|
1021
|
+
cpf?: string | null | undefined;
|
|
1022
|
+
rg?: string | null | undefined;
|
|
1023
|
+
tradingName?: string | null | undefined;
|
|
1024
|
+
cnpj?: string | null | undefined;
|
|
1025
|
+
contact?: {
|
|
1026
|
+
phone?: string | null | undefined;
|
|
1027
|
+
phone2?: string | null | undefined;
|
|
1028
|
+
cellPhone?: string | null | undefined;
|
|
1029
|
+
fax?: string | null | undefined;
|
|
1030
|
+
} | null | undefined;
|
|
1031
|
+
extendedProperties?: string[] | null | undefined;
|
|
1032
|
+
currentUserIPs?: string | null | undefined;
|
|
1033
|
+
provider?: string | null | undefined;
|
|
1034
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
1035
|
+
reCaptchaToken?: string | null | undefined;
|
|
1036
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
1037
|
+
prefixFormat?: string | null | undefined;
|
|
1038
|
+
} | null | undefined;
|
|
1039
|
+
addresses?: {
|
|
1040
|
+
id?: number | null | undefined;
|
|
1041
|
+
name?: string | null | undefined;
|
|
1042
|
+
contactName?: string | null | undefined;
|
|
1043
|
+
addressLine?: string | null | undefined;
|
|
1044
|
+
city?: string | null | undefined;
|
|
1045
|
+
neighbourhood?: string | null | undefined;
|
|
1046
|
+
number?: string | null | undefined;
|
|
1047
|
+
state?: string | null | undefined;
|
|
1048
|
+
postalCode?: string | null | undefined;
|
|
1049
|
+
addressNotes?: string | null | undefined;
|
|
1050
|
+
landmark?: string | null | undefined;
|
|
1051
|
+
isMainAddress?: boolean | null | undefined;
|
|
1052
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
1053
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
1054
|
+
latitude?: string | null | undefined;
|
|
1055
|
+
longitude?: string | null | undefined;
|
|
1056
|
+
extendedProperties?: {
|
|
1057
|
+
prefix?: string | null | undefined;
|
|
1058
|
+
htmlAttributes?: {
|
|
1059
|
+
additionalProp1?: string | null | undefined;
|
|
1060
|
+
additionalProp2?: string | null | undefined;
|
|
1061
|
+
additionalProp3?: string | null | undefined;
|
|
1062
|
+
} | null | undefined;
|
|
1063
|
+
inputType?: string | null | undefined;
|
|
1064
|
+
name?: string | null | undefined;
|
|
1065
|
+
fieldName?: string | null | undefined;
|
|
1066
|
+
bindType?: string | null | undefined;
|
|
1067
|
+
entityMetadataId?: number | null | undefined;
|
|
1068
|
+
value?: string | null | undefined;
|
|
1069
|
+
values?: string[] | null | undefined;
|
|
1070
|
+
isNew?: boolean | null | undefined;
|
|
1071
|
+
isRequired?: boolean | null | undefined;
|
|
1072
|
+
displayName?: string | null | undefined;
|
|
1073
|
+
optionName?: string | null | undefined;
|
|
1074
|
+
}[] | null | undefined;
|
|
1075
|
+
currentUserIPs?: string | null | undefined;
|
|
1076
|
+
prefixFormat?: string | null | undefined;
|
|
1077
|
+
}[] | null | undefined;
|
|
1078
|
+
shopperTicketId?: string | null | undefined;
|
|
1079
|
+
basketId?: number | null | undefined;
|
|
1080
|
+
customerId?: number | null | undefined;
|
|
1081
|
+
sessionId?: string | null | undefined;
|
|
1082
|
+
}, {
|
|
1083
|
+
customer?: {
|
|
1084
|
+
customerType?: string | null | undefined;
|
|
1085
|
+
sourceEnvironment?: string | null | undefined;
|
|
1086
|
+
email?: string | null | undefined;
|
|
1087
|
+
password?: string | null | undefined;
|
|
1088
|
+
passwordCheck?: string | null | undefined;
|
|
1089
|
+
passwordCurrent?: string | null | undefined;
|
|
1090
|
+
currentPassword?: string | null | undefined;
|
|
1091
|
+
generatePassword?: boolean | null | undefined;
|
|
1092
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
1093
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
1094
|
+
name?: string | null | undefined;
|
|
1095
|
+
surname?: string | null | undefined;
|
|
1096
|
+
birthDate?: string | null | undefined;
|
|
1097
|
+
gender?: string | null | undefined;
|
|
1098
|
+
cpf?: string | null | undefined;
|
|
1099
|
+
rg?: string | null | undefined;
|
|
1100
|
+
tradingName?: string | null | undefined;
|
|
1101
|
+
cnpj?: string | null | undefined;
|
|
1102
|
+
contact?: {
|
|
1103
|
+
phone?: string | null | undefined;
|
|
1104
|
+
phone2?: string | null | undefined;
|
|
1105
|
+
cellPhone?: string | null | undefined;
|
|
1106
|
+
fax?: string | null | undefined;
|
|
1107
|
+
} | null | undefined;
|
|
1108
|
+
extendedProperties?: string[] | null | undefined;
|
|
1109
|
+
currentUserIPs?: string | null | undefined;
|
|
1110
|
+
provider?: string | null | undefined;
|
|
1111
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
1112
|
+
reCaptchaToken?: string | null | undefined;
|
|
1113
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
1114
|
+
prefixFormat?: string | null | undefined;
|
|
1115
|
+
} | null | undefined;
|
|
1116
|
+
addresses?: {
|
|
1117
|
+
id?: number | null | undefined;
|
|
1118
|
+
name?: string | null | undefined;
|
|
1119
|
+
contactName?: string | null | undefined;
|
|
1120
|
+
addressLine?: string | null | undefined;
|
|
1121
|
+
city?: string | null | undefined;
|
|
1122
|
+
neighbourhood?: string | null | undefined;
|
|
1123
|
+
number?: string | null | undefined;
|
|
1124
|
+
state?: string | null | undefined;
|
|
1125
|
+
postalCode?: string | null | undefined;
|
|
1126
|
+
addressNotes?: string | null | undefined;
|
|
1127
|
+
landmark?: string | null | undefined;
|
|
1128
|
+
isMainAddress?: boolean | null | undefined;
|
|
1129
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
1130
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
1131
|
+
latitude?: string | null | undefined;
|
|
1132
|
+
longitude?: string | null | undefined;
|
|
1133
|
+
extendedProperties?: {
|
|
1134
|
+
prefix?: string | null | undefined;
|
|
1135
|
+
htmlAttributes?: {
|
|
1136
|
+
additionalProp1?: string | null | undefined;
|
|
1137
|
+
additionalProp2?: string | null | undefined;
|
|
1138
|
+
additionalProp3?: string | null | undefined;
|
|
1139
|
+
} | null | undefined;
|
|
1140
|
+
inputType?: string | null | undefined;
|
|
1141
|
+
name?: string | null | undefined;
|
|
1142
|
+
fieldName?: string | null | undefined;
|
|
1143
|
+
bindType?: string | null | undefined;
|
|
1144
|
+
entityMetadataId?: number | null | undefined;
|
|
1145
|
+
value?: string | null | undefined;
|
|
1146
|
+
values?: string[] | null | undefined;
|
|
1147
|
+
isNew?: boolean | null | undefined;
|
|
1148
|
+
isRequired?: boolean | null | undefined;
|
|
1149
|
+
displayName?: string | null | undefined;
|
|
1150
|
+
optionName?: string | null | undefined;
|
|
1151
|
+
}[] | null | undefined;
|
|
1152
|
+
currentUserIPs?: string | null | undefined;
|
|
1153
|
+
prefixFormat?: string | null | undefined;
|
|
1154
|
+
}[] | null | undefined;
|
|
1155
|
+
shopperTicketId?: string | null | undefined;
|
|
1156
|
+
basketId?: number | null | undefined;
|
|
1157
|
+
customerId?: number | null | undefined;
|
|
1158
|
+
sessionId?: string | null | undefined;
|
|
1159
|
+
}>>;
|
|
1160
|
+
/**
|
|
1161
|
+
*
|
|
1162
|
+
* @typedef {CreateBusinessAccountRequest} createBusinessAccountRequest
|
|
1163
|
+
* @property {CreateBusinessAccountRequestCustomer}
|
|
1164
|
+
* @property {Addresses[]}
|
|
1165
|
+
* @property {string}
|
|
1166
|
+
* @property {number}
|
|
1167
|
+
* @property {number}
|
|
1168
|
+
* @property {string}
|
|
1169
|
+
*/
|
|
1170
|
+
type CreateBusinessAccountRequest = z.infer<typeof createBusinessAccountRequest>;
|
|
1171
|
+
|
|
1172
|
+
interface CreateBusinessAccountParams {
|
|
1173
|
+
accept: string;
|
|
1174
|
+
}
|
|
1175
|
+
interface ConsumerDetailParams {
|
|
1176
|
+
customerId?: string;
|
|
1177
|
+
sessionId?: string;
|
|
1178
|
+
}
|
|
1179
|
+
interface UpdateConsumerParams {
|
|
1180
|
+
accept: string;
|
|
1181
|
+
}
|
|
1182
|
+
interface RecoverPasswordParams {
|
|
1183
|
+
accept: string;
|
|
1184
|
+
cacheControl: string;
|
|
1185
|
+
}
|
|
1186
|
+
interface LogoutParams {
|
|
1187
|
+
authorization: string;
|
|
1188
|
+
accept: string;
|
|
1189
|
+
}
|
|
1190
|
+
interface SendPinParams {
|
|
1191
|
+
authorization: string;
|
|
1192
|
+
accept: string;
|
|
1193
|
+
}
|
|
1194
|
+
interface SendConfirmationEmailParams {
|
|
1195
|
+
authorization: string;
|
|
1196
|
+
accept: string;
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
/**
|
|
1200
|
+
* Zod schema for the LoginRequest model.
|
|
1201
|
+
* Defines the structure and validation rules for this data type.
|
|
1202
|
+
* This is the shape used in application code - what developers interact with.
|
|
1203
|
+
*/
|
|
1204
|
+
declare const loginRequest: z.ZodLazy<z.ZodObject<{
|
|
1205
|
+
key: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1206
|
+
password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1207
|
+
}, "strip", z.ZodTypeAny, {
|
|
1208
|
+
key?: string | null | undefined;
|
|
1209
|
+
password?: string | null | undefined;
|
|
1210
|
+
}, {
|
|
1211
|
+
key?: string | null | undefined;
|
|
1212
|
+
password?: string | null | undefined;
|
|
1213
|
+
}>>;
|
|
1214
|
+
/**
|
|
1215
|
+
*
|
|
1216
|
+
* @typedef {LoginRequest} loginRequest
|
|
1217
|
+
* @property {string}
|
|
1218
|
+
* @property {string}
|
|
1219
|
+
*/
|
|
1220
|
+
type LoginRequest = z.infer<typeof loginRequest>;
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* Zod schema for the RecoverPasswordRequest model.
|
|
1224
|
+
* Defines the structure and validation rules for this data type.
|
|
1225
|
+
* This is the shape used in application code - what developers interact with.
|
|
1226
|
+
*/
|
|
1227
|
+
declare const recoverPasswordRequest: z.ZodLazy<z.ZodObject<{
|
|
1228
|
+
key: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1229
|
+
}, "strip", z.ZodTypeAny, {
|
|
1230
|
+
key?: string | null | undefined;
|
|
1231
|
+
}, {
|
|
1232
|
+
key?: string | null | undefined;
|
|
1233
|
+
}>>;
|
|
1234
|
+
/**
|
|
1235
|
+
*
|
|
1236
|
+
* @typedef {RecoverPasswordRequest} recoverPasswordRequest
|
|
1237
|
+
* @property {string}
|
|
1238
|
+
*/
|
|
1239
|
+
type RecoverPasswordRequest = z.infer<typeof recoverPasswordRequest>;
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
* Service class for CustomersService operations.
|
|
1243
|
+
* Provides methods to interact with CustomersService-related API endpoints.
|
|
1244
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
1245
|
+
*/
|
|
1246
|
+
declare class CustomersService extends BaseService {
|
|
1247
|
+
protected createConsumerConfig: Partial<SdkConfig>;
|
|
1248
|
+
protected createBusinessAccountConfig: Partial<SdkConfig>;
|
|
1249
|
+
protected loginConfig: Partial<SdkConfig>;
|
|
1250
|
+
protected refreshLoginConfig: Partial<SdkConfig>;
|
|
1251
|
+
protected keepSessionActiveConfig: Partial<SdkConfig>;
|
|
1252
|
+
protected consumerDetailConfig: Partial<SdkConfig>;
|
|
1253
|
+
protected updateConsumerConfig: Partial<SdkConfig>;
|
|
1254
|
+
protected recoverPasswordConfig: Partial<SdkConfig>;
|
|
1255
|
+
protected logoutConfig: Partial<SdkConfig>;
|
|
1256
|
+
protected sendPinConfig: Partial<SdkConfig>;
|
|
1257
|
+
protected sendConfirmationEmailConfig: Partial<SdkConfig>;
|
|
1258
|
+
/**
|
|
1259
|
+
* Sets method-level configuration for createConsumer.
|
|
1260
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1261
|
+
* @returns This service instance for method chaining
|
|
1262
|
+
*/
|
|
1263
|
+
setCreateConsumerConfig(config: Partial<SdkConfig>): this;
|
|
1264
|
+
/**
|
|
1265
|
+
* Sets method-level configuration for createBusinessAccount.
|
|
1266
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1267
|
+
* @returns This service instance for method chaining
|
|
1268
|
+
*/
|
|
1269
|
+
setCreateBusinessAccountConfig(config: Partial<SdkConfig>): this;
|
|
1270
|
+
/**
|
|
1271
|
+
* Sets method-level configuration for login.
|
|
1272
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1273
|
+
* @returns This service instance for method chaining
|
|
1274
|
+
*/
|
|
1275
|
+
setLoginConfig(config: Partial<SdkConfig>): this;
|
|
1276
|
+
/**
|
|
1277
|
+
* Sets method-level configuration for refreshLogin.
|
|
1278
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1279
|
+
* @returns This service instance for method chaining
|
|
1280
|
+
*/
|
|
1281
|
+
setRefreshLoginConfig(config: Partial<SdkConfig>): this;
|
|
1282
|
+
/**
|
|
1283
|
+
* Sets method-level configuration for keepSessionActive.
|
|
1284
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1285
|
+
* @returns This service instance for method chaining
|
|
1286
|
+
*/
|
|
1287
|
+
setKeepSessionActiveConfig(config: Partial<SdkConfig>): this;
|
|
1288
|
+
/**
|
|
1289
|
+
* Sets method-level configuration for consumerDetail.
|
|
1290
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1291
|
+
* @returns This service instance for method chaining
|
|
1292
|
+
*/
|
|
1293
|
+
setConsumerDetailConfig(config: Partial<SdkConfig>): this;
|
|
1294
|
+
/**
|
|
1295
|
+
* Sets method-level configuration for updateConsumer.
|
|
1296
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1297
|
+
* @returns This service instance for method chaining
|
|
1298
|
+
*/
|
|
1299
|
+
setUpdateConsumerConfig(config: Partial<SdkConfig>): this;
|
|
1300
|
+
/**
|
|
1301
|
+
* Sets method-level configuration for recoverPassword.
|
|
1302
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1303
|
+
* @returns This service instance for method chaining
|
|
1304
|
+
*/
|
|
1305
|
+
setRecoverPasswordConfig(config: Partial<SdkConfig>): this;
|
|
1306
|
+
/**
|
|
1307
|
+
* Sets method-level configuration for logout.
|
|
1308
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1309
|
+
* @returns This service instance for method chaining
|
|
1310
|
+
*/
|
|
1311
|
+
setLogoutConfig(config: Partial<SdkConfig>): this;
|
|
1312
|
+
/**
|
|
1313
|
+
* Sets method-level configuration for sendPin.
|
|
1314
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1315
|
+
* @returns This service instance for method chaining
|
|
1316
|
+
*/
|
|
1317
|
+
setSendPinConfig(config: Partial<SdkConfig>): this;
|
|
1318
|
+
/**
|
|
1319
|
+
* Sets method-level configuration for sendConfirmationEmail.
|
|
1320
|
+
* @param config - Partial configuration to override service-level defaults
|
|
1321
|
+
* @returns This service instance for method chaining
|
|
1322
|
+
*/
|
|
1323
|
+
setSendConfirmationEmailConfig(config: Partial<SdkConfig>): this;
|
|
1324
|
+
/**
|
|
1325
|
+
*
|
|
1326
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1327
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1328
|
+
*/
|
|
1329
|
+
createConsumer(body: CreateConsumerRequest, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1330
|
+
/**
|
|
1331
|
+
*
|
|
1332
|
+
* @param {string} params.accept -
|
|
1333
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1334
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1335
|
+
*/
|
|
1336
|
+
createBusinessAccount(body: CreateBusinessAccountRequest, params: CreateBusinessAccountParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1337
|
+
/**
|
|
1338
|
+
*
|
|
1339
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1340
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1341
|
+
*/
|
|
1342
|
+
login(body: LoginRequest, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1343
|
+
/**
|
|
1344
|
+
*
|
|
1345
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1346
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1347
|
+
*/
|
|
1348
|
+
refreshLogin(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1349
|
+
/**
|
|
1350
|
+
*
|
|
1351
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1352
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1353
|
+
*/
|
|
1354
|
+
keepSessionActive(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1355
|
+
/**
|
|
1356
|
+
*
|
|
1357
|
+
* @param {string} [params.customerId] -
|
|
1358
|
+
* @param {string} [params.sessionId] -
|
|
1359
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1360
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1361
|
+
*/
|
|
1362
|
+
consumerDetail(params?: ConsumerDetailParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1363
|
+
/**
|
|
1364
|
+
*
|
|
1365
|
+
* @param {string} params.accept -
|
|
1366
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1367
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1368
|
+
*/
|
|
1369
|
+
updateConsumer(body: any, params: UpdateConsumerParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @param {string} params.accept -
|
|
1373
|
+
* @param {string} params.cacheControl -
|
|
1374
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1375
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1376
|
+
*/
|
|
1377
|
+
recoverPassword(body: RecoverPasswordRequest, params: RecoverPasswordParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1378
|
+
/**
|
|
1379
|
+
*
|
|
1380
|
+
* @param {string} params.authorization -
|
|
1381
|
+
* @param {string} params.accept -
|
|
1382
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1383
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1384
|
+
*/
|
|
1385
|
+
logout(body: any, params: LogoutParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
* @param {string} params.authorization -
|
|
1389
|
+
* @param {string} params.accept -
|
|
1390
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1391
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1392
|
+
*/
|
|
1393
|
+
sendPin(body: any, params: SendPinParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @param {string} params.authorization -
|
|
1397
|
+
* @param {string} params.accept -
|
|
1398
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
1399
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
1400
|
+
*/
|
|
1401
|
+
sendConfirmationEmail(body: any, params: SendConfirmationEmailParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Zod schema for the CreateConsumerRequestCustomer model.
|
|
1406
|
+
* Defines the structure and validation rules for this data type.
|
|
1407
|
+
* This is the shape used in application code - what developers interact with.
|
|
1408
|
+
*/
|
|
1409
|
+
declare const createConsumerRequestCustomer: z.ZodLazy<z.ZodObject<{
|
|
1410
|
+
customerType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1411
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1412
|
+
password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1413
|
+
passwordCheck: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1414
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1415
|
+
surname: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1416
|
+
birthDate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1417
|
+
gender: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1418
|
+
cpf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1419
|
+
contact: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1420
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1421
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1422
|
+
}, "strip", z.ZodTypeAny, {
|
|
1423
|
+
phone?: string | null | undefined;
|
|
1424
|
+
cellPhone?: string | null | undefined;
|
|
1425
|
+
}, {
|
|
1426
|
+
phone?: string | null | undefined;
|
|
1427
|
+
cellPhone?: string | null | undefined;
|
|
1428
|
+
}>>>>;
|
|
1429
|
+
}, "strip", z.ZodTypeAny, {
|
|
1430
|
+
customerType?: string | null | undefined;
|
|
1431
|
+
email?: string | null | undefined;
|
|
1432
|
+
password?: string | null | undefined;
|
|
1433
|
+
passwordCheck?: string | null | undefined;
|
|
1434
|
+
name?: string | null | undefined;
|
|
1435
|
+
surname?: string | null | undefined;
|
|
1436
|
+
birthDate?: string | null | undefined;
|
|
1437
|
+
gender?: string | null | undefined;
|
|
1438
|
+
cpf?: string | null | undefined;
|
|
1439
|
+
contact?: {
|
|
1440
|
+
phone?: string | null | undefined;
|
|
1441
|
+
cellPhone?: string | null | undefined;
|
|
1442
|
+
} | null | undefined;
|
|
1443
|
+
}, {
|
|
1444
|
+
customerType?: string | null | undefined;
|
|
1445
|
+
email?: string | null | undefined;
|
|
1446
|
+
password?: string | null | undefined;
|
|
1447
|
+
passwordCheck?: string | null | undefined;
|
|
1448
|
+
name?: string | null | undefined;
|
|
1449
|
+
surname?: string | null | undefined;
|
|
1450
|
+
birthDate?: string | null | undefined;
|
|
1451
|
+
gender?: string | null | undefined;
|
|
1452
|
+
cpf?: string | null | undefined;
|
|
1453
|
+
contact?: {
|
|
1454
|
+
phone?: string | null | undefined;
|
|
1455
|
+
cellPhone?: string | null | undefined;
|
|
1456
|
+
} | null | undefined;
|
|
1457
|
+
}>>;
|
|
1458
|
+
/**
|
|
1459
|
+
*
|
|
1460
|
+
* @typedef {CreateConsumerRequestCustomer} createConsumerRequestCustomer
|
|
1461
|
+
* @property {string}
|
|
1462
|
+
* @property {string}
|
|
1463
|
+
* @property {string}
|
|
1464
|
+
* @property {string}
|
|
1465
|
+
* @property {string}
|
|
1466
|
+
* @property {string}
|
|
1467
|
+
* @property {string}
|
|
1468
|
+
* @property {string}
|
|
1469
|
+
* @property {string}
|
|
1470
|
+
* @property {CustomerContact1}
|
|
1471
|
+
*/
|
|
1472
|
+
type CreateConsumerRequestCustomer = z.infer<typeof createConsumerRequestCustomer>;
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* Zod schema for the CustomerContact1 model.
|
|
1476
|
+
* Defines the structure and validation rules for this data type.
|
|
1477
|
+
* This is the shape used in application code - what developers interact with.
|
|
1478
|
+
*/
|
|
1479
|
+
declare const customerContact1: z.ZodLazy<z.ZodObject<{
|
|
1480
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1481
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1482
|
+
}, "strip", z.ZodTypeAny, {
|
|
1483
|
+
phone?: string | null | undefined;
|
|
1484
|
+
cellPhone?: string | null | undefined;
|
|
1485
|
+
}, {
|
|
1486
|
+
phone?: string | null | undefined;
|
|
1487
|
+
cellPhone?: string | null | undefined;
|
|
1488
|
+
}>>;
|
|
1489
|
+
/**
|
|
1490
|
+
*
|
|
1491
|
+
* @typedef {CustomerContact1} customerContact1
|
|
1492
|
+
* @property {string}
|
|
1493
|
+
* @property {string}
|
|
1494
|
+
*/
|
|
1495
|
+
type CustomerContact1 = z.infer<typeof customerContact1>;
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* Zod schema for the CreateBusinessAccountRequestCustomer model.
|
|
1499
|
+
* Defines the structure and validation rules for this data type.
|
|
1500
|
+
* This is the shape used in application code - what developers interact with.
|
|
1501
|
+
*/
|
|
1502
|
+
declare const createBusinessAccountRequestCustomer: z.ZodLazy<z.ZodObject<{
|
|
1503
|
+
customerType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1504
|
+
sourceEnvironment: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1505
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1506
|
+
password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1507
|
+
passwordCheck: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1508
|
+
passwordCurrent: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1509
|
+
currentPassword: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1510
|
+
generatePassword: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1511
|
+
generateAndDefinePassword: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1512
|
+
recoveryPasswordActionUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1513
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1514
|
+
surname: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1515
|
+
birthDate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1516
|
+
gender: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1517
|
+
cpf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1518
|
+
rg: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1519
|
+
tradingName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1520
|
+
cnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1521
|
+
contact: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1522
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1523
|
+
phone2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1524
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1525
|
+
fax: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1526
|
+
}, "strip", z.ZodTypeAny, {
|
|
1527
|
+
phone?: string | null | undefined;
|
|
1528
|
+
phone2?: string | null | undefined;
|
|
1529
|
+
cellPhone?: string | null | undefined;
|
|
1530
|
+
fax?: string | null | undefined;
|
|
1531
|
+
}, {
|
|
1532
|
+
phone?: string | null | undefined;
|
|
1533
|
+
phone2?: string | null | undefined;
|
|
1534
|
+
cellPhone?: string | null | undefined;
|
|
1535
|
+
fax?: string | null | undefined;
|
|
1536
|
+
}>>>>;
|
|
1537
|
+
extendedProperties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1538
|
+
currentUserIPs: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1539
|
+
provider: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1540
|
+
isCustomerRelation: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1541
|
+
reCaptchaToken: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1542
|
+
isFromGuestSession: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1543
|
+
prefixFormat: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1544
|
+
}, "strip", z.ZodTypeAny, {
|
|
1545
|
+
customerType?: string | null | undefined;
|
|
1546
|
+
sourceEnvironment?: string | null | undefined;
|
|
1547
|
+
email?: string | null | undefined;
|
|
1548
|
+
password?: string | null | undefined;
|
|
1549
|
+
passwordCheck?: string | null | undefined;
|
|
1550
|
+
passwordCurrent?: string | null | undefined;
|
|
1551
|
+
currentPassword?: string | null | undefined;
|
|
1552
|
+
generatePassword?: boolean | null | undefined;
|
|
1553
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
1554
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
1555
|
+
name?: string | null | undefined;
|
|
1556
|
+
surname?: string | null | undefined;
|
|
1557
|
+
birthDate?: string | null | undefined;
|
|
1558
|
+
gender?: string | null | undefined;
|
|
1559
|
+
cpf?: string | null | undefined;
|
|
1560
|
+
rg?: string | null | undefined;
|
|
1561
|
+
tradingName?: string | null | undefined;
|
|
1562
|
+
cnpj?: string | null | undefined;
|
|
1563
|
+
contact?: {
|
|
1564
|
+
phone?: string | null | undefined;
|
|
1565
|
+
phone2?: string | null | undefined;
|
|
1566
|
+
cellPhone?: string | null | undefined;
|
|
1567
|
+
fax?: string | null | undefined;
|
|
1568
|
+
} | null | undefined;
|
|
1569
|
+
extendedProperties?: string[] | null | undefined;
|
|
1570
|
+
currentUserIPs?: string | null | undefined;
|
|
1571
|
+
provider?: string | null | undefined;
|
|
1572
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
1573
|
+
reCaptchaToken?: string | null | undefined;
|
|
1574
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
1575
|
+
prefixFormat?: string | null | undefined;
|
|
1576
|
+
}, {
|
|
1577
|
+
customerType?: string | null | undefined;
|
|
1578
|
+
sourceEnvironment?: string | null | undefined;
|
|
1579
|
+
email?: string | null | undefined;
|
|
1580
|
+
password?: string | null | undefined;
|
|
1581
|
+
passwordCheck?: string | null | undefined;
|
|
1582
|
+
passwordCurrent?: string | null | undefined;
|
|
1583
|
+
currentPassword?: string | null | undefined;
|
|
1584
|
+
generatePassword?: boolean | null | undefined;
|
|
1585
|
+
generateAndDefinePassword?: boolean | null | undefined;
|
|
1586
|
+
recoveryPasswordActionUrl?: string | null | undefined;
|
|
1587
|
+
name?: string | null | undefined;
|
|
1588
|
+
surname?: string | null | undefined;
|
|
1589
|
+
birthDate?: string | null | undefined;
|
|
1590
|
+
gender?: string | null | undefined;
|
|
1591
|
+
cpf?: string | null | undefined;
|
|
1592
|
+
rg?: string | null | undefined;
|
|
1593
|
+
tradingName?: string | null | undefined;
|
|
1594
|
+
cnpj?: string | null | undefined;
|
|
1595
|
+
contact?: {
|
|
1596
|
+
phone?: string | null | undefined;
|
|
1597
|
+
phone2?: string | null | undefined;
|
|
1598
|
+
cellPhone?: string | null | undefined;
|
|
1599
|
+
fax?: string | null | undefined;
|
|
1600
|
+
} | null | undefined;
|
|
1601
|
+
extendedProperties?: string[] | null | undefined;
|
|
1602
|
+
currentUserIPs?: string | null | undefined;
|
|
1603
|
+
provider?: string | null | undefined;
|
|
1604
|
+
isCustomerRelation?: boolean | null | undefined;
|
|
1605
|
+
reCaptchaToken?: string | null | undefined;
|
|
1606
|
+
isFromGuestSession?: boolean | null | undefined;
|
|
1607
|
+
prefixFormat?: string | null | undefined;
|
|
1608
|
+
}>>;
|
|
1609
|
+
/**
|
|
1610
|
+
*
|
|
1611
|
+
* @typedef {CreateBusinessAccountRequestCustomer} createBusinessAccountRequestCustomer
|
|
1612
|
+
* @property {string}
|
|
1613
|
+
* @property {string}
|
|
1614
|
+
* @property {string}
|
|
1615
|
+
* @property {string}
|
|
1616
|
+
* @property {string}
|
|
1617
|
+
* @property {string}
|
|
1618
|
+
* @property {string}
|
|
1619
|
+
* @property {boolean}
|
|
1620
|
+
* @property {boolean}
|
|
1621
|
+
* @property {string}
|
|
1622
|
+
* @property {string}
|
|
1623
|
+
* @property {string}
|
|
1624
|
+
* @property {string}
|
|
1625
|
+
* @property {string}
|
|
1626
|
+
* @property {string}
|
|
1627
|
+
* @property {string}
|
|
1628
|
+
* @property {string}
|
|
1629
|
+
* @property {string}
|
|
1630
|
+
* @property {CustomerContact2}
|
|
1631
|
+
* @property {string[]}
|
|
1632
|
+
* @property {string}
|
|
1633
|
+
* @property {string}
|
|
1634
|
+
* @property {boolean}
|
|
1635
|
+
* @property {string}
|
|
1636
|
+
* @property {boolean}
|
|
1637
|
+
* @property {string}
|
|
1638
|
+
*/
|
|
1639
|
+
type CreateBusinessAccountRequestCustomer = z.infer<typeof createBusinessAccountRequestCustomer>;
|
|
1640
|
+
|
|
1641
|
+
/**
|
|
1642
|
+
* Zod schema for the CustomerContact2 model.
|
|
1643
|
+
* Defines the structure and validation rules for this data type.
|
|
1644
|
+
* This is the shape used in application code - what developers interact with.
|
|
1645
|
+
*/
|
|
1646
|
+
declare const customerContact2: z.ZodLazy<z.ZodObject<{
|
|
1647
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1648
|
+
phone2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1649
|
+
cellPhone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1650
|
+
fax: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1651
|
+
}, "strip", z.ZodTypeAny, {
|
|
1652
|
+
phone?: string | null | undefined;
|
|
1653
|
+
phone2?: string | null | undefined;
|
|
1654
|
+
cellPhone?: string | null | undefined;
|
|
1655
|
+
fax?: string | null | undefined;
|
|
1656
|
+
}, {
|
|
1657
|
+
phone?: string | null | undefined;
|
|
1658
|
+
phone2?: string | null | undefined;
|
|
1659
|
+
cellPhone?: string | null | undefined;
|
|
1660
|
+
fax?: string | null | undefined;
|
|
1661
|
+
}>>;
|
|
1662
|
+
/**
|
|
1663
|
+
*
|
|
1664
|
+
* @typedef {CustomerContact2} customerContact2
|
|
1665
|
+
* @property {string}
|
|
1666
|
+
* @property {string}
|
|
1667
|
+
* @property {string}
|
|
1668
|
+
* @property {string}
|
|
1669
|
+
*/
|
|
1670
|
+
type CustomerContact2 = z.infer<typeof customerContact2>;
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
* Zod schema for the Addresses model.
|
|
1674
|
+
* Defines the structure and validation rules for this data type.
|
|
1675
|
+
* This is the shape used in application code - what developers interact with.
|
|
1676
|
+
*/
|
|
1677
|
+
declare const addresses: z.ZodLazy<z.ZodObject<{
|
|
1678
|
+
id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1679
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1680
|
+
contactName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1681
|
+
addressLine: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1682
|
+
city: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1683
|
+
neighbourhood: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1684
|
+
number: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1685
|
+
state: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1686
|
+
postalCode: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1687
|
+
addressNotes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1688
|
+
landmark: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1689
|
+
isMainAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1690
|
+
setAsShippingAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1691
|
+
setAsBillingAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1692
|
+
latitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1693
|
+
longitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1694
|
+
extendedProperties: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
|
|
1695
|
+
prefix: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1696
|
+
htmlAttributes: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1697
|
+
additionalProp1: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1698
|
+
additionalProp2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1699
|
+
additionalProp3: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1700
|
+
}, "strip", z.ZodTypeAny, {
|
|
1701
|
+
additionalProp1?: string | null | undefined;
|
|
1702
|
+
additionalProp2?: string | null | undefined;
|
|
1703
|
+
additionalProp3?: string | null | undefined;
|
|
1704
|
+
}, {
|
|
1705
|
+
additionalProp1?: string | null | undefined;
|
|
1706
|
+
additionalProp2?: string | null | undefined;
|
|
1707
|
+
additionalProp3?: string | null | undefined;
|
|
1708
|
+
}>>>>;
|
|
1709
|
+
inputType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1710
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1711
|
+
fieldName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1712
|
+
bindType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1713
|
+
entityMetadataId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1714
|
+
value: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1715
|
+
values: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1716
|
+
isNew: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1717
|
+
isRequired: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1718
|
+
displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1719
|
+
optionName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1720
|
+
}, "strip", z.ZodTypeAny, {
|
|
1721
|
+
prefix?: string | null | undefined;
|
|
1722
|
+
htmlAttributes?: {
|
|
1723
|
+
additionalProp1?: string | null | undefined;
|
|
1724
|
+
additionalProp2?: string | null | undefined;
|
|
1725
|
+
additionalProp3?: string | null | undefined;
|
|
1726
|
+
} | null | undefined;
|
|
1727
|
+
inputType?: string | null | undefined;
|
|
1728
|
+
name?: string | null | undefined;
|
|
1729
|
+
fieldName?: string | null | undefined;
|
|
1730
|
+
bindType?: string | null | undefined;
|
|
1731
|
+
entityMetadataId?: number | null | undefined;
|
|
1732
|
+
value?: string | null | undefined;
|
|
1733
|
+
values?: string[] | null | undefined;
|
|
1734
|
+
isNew?: boolean | null | undefined;
|
|
1735
|
+
isRequired?: boolean | null | undefined;
|
|
1736
|
+
displayName?: string | null | undefined;
|
|
1737
|
+
optionName?: string | null | undefined;
|
|
1738
|
+
}, {
|
|
1739
|
+
prefix?: string | null | undefined;
|
|
1740
|
+
htmlAttributes?: {
|
|
1741
|
+
additionalProp1?: string | null | undefined;
|
|
1742
|
+
additionalProp2?: string | null | undefined;
|
|
1743
|
+
additionalProp3?: string | null | undefined;
|
|
1744
|
+
} | null | undefined;
|
|
1745
|
+
inputType?: string | null | undefined;
|
|
1746
|
+
name?: string | null | undefined;
|
|
1747
|
+
fieldName?: string | null | undefined;
|
|
1748
|
+
bindType?: string | null | undefined;
|
|
1749
|
+
entityMetadataId?: number | null | undefined;
|
|
1750
|
+
value?: string | null | undefined;
|
|
1751
|
+
values?: string[] | null | undefined;
|
|
1752
|
+
isNew?: boolean | null | undefined;
|
|
1753
|
+
isRequired?: boolean | null | undefined;
|
|
1754
|
+
displayName?: string | null | undefined;
|
|
1755
|
+
optionName?: string | null | undefined;
|
|
1756
|
+
}>>, "many">>>;
|
|
1757
|
+
currentUserIPs: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1758
|
+
prefixFormat: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1759
|
+
}, "strip", z.ZodTypeAny, {
|
|
1760
|
+
id?: number | null | undefined;
|
|
1761
|
+
name?: string | null | undefined;
|
|
1762
|
+
contactName?: string | null | undefined;
|
|
1763
|
+
addressLine?: string | null | undefined;
|
|
1764
|
+
city?: string | null | undefined;
|
|
1765
|
+
neighbourhood?: string | null | undefined;
|
|
1766
|
+
number?: string | null | undefined;
|
|
1767
|
+
state?: string | null | undefined;
|
|
1768
|
+
postalCode?: string | null | undefined;
|
|
1769
|
+
addressNotes?: string | null | undefined;
|
|
1770
|
+
landmark?: string | null | undefined;
|
|
1771
|
+
isMainAddress?: boolean | null | undefined;
|
|
1772
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
1773
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
1774
|
+
latitude?: string | null | undefined;
|
|
1775
|
+
longitude?: string | null | undefined;
|
|
1776
|
+
extendedProperties?: {
|
|
1777
|
+
prefix?: string | null | undefined;
|
|
1778
|
+
htmlAttributes?: {
|
|
1779
|
+
additionalProp1?: string | null | undefined;
|
|
1780
|
+
additionalProp2?: string | null | undefined;
|
|
1781
|
+
additionalProp3?: string | null | undefined;
|
|
1782
|
+
} | null | undefined;
|
|
1783
|
+
inputType?: string | null | undefined;
|
|
1784
|
+
name?: string | null | undefined;
|
|
1785
|
+
fieldName?: string | null | undefined;
|
|
1786
|
+
bindType?: string | null | undefined;
|
|
1787
|
+
entityMetadataId?: number | null | undefined;
|
|
1788
|
+
value?: string | null | undefined;
|
|
1789
|
+
values?: string[] | null | undefined;
|
|
1790
|
+
isNew?: boolean | null | undefined;
|
|
1791
|
+
isRequired?: boolean | null | undefined;
|
|
1792
|
+
displayName?: string | null | undefined;
|
|
1793
|
+
optionName?: string | null | undefined;
|
|
1794
|
+
}[] | null | undefined;
|
|
1795
|
+
currentUserIPs?: string | null | undefined;
|
|
1796
|
+
prefixFormat?: string | null | undefined;
|
|
1797
|
+
}, {
|
|
1798
|
+
id?: number | null | undefined;
|
|
1799
|
+
name?: string | null | undefined;
|
|
1800
|
+
contactName?: string | null | undefined;
|
|
1801
|
+
addressLine?: string | null | undefined;
|
|
1802
|
+
city?: string | null | undefined;
|
|
1803
|
+
neighbourhood?: string | null | undefined;
|
|
1804
|
+
number?: string | null | undefined;
|
|
1805
|
+
state?: string | null | undefined;
|
|
1806
|
+
postalCode?: string | null | undefined;
|
|
1807
|
+
addressNotes?: string | null | undefined;
|
|
1808
|
+
landmark?: string | null | undefined;
|
|
1809
|
+
isMainAddress?: boolean | null | undefined;
|
|
1810
|
+
setAsShippingAddress?: boolean | null | undefined;
|
|
1811
|
+
setAsBillingAddress?: boolean | null | undefined;
|
|
1812
|
+
latitude?: string | null | undefined;
|
|
1813
|
+
longitude?: string | null | undefined;
|
|
1814
|
+
extendedProperties?: {
|
|
1815
|
+
prefix?: string | null | undefined;
|
|
1816
|
+
htmlAttributes?: {
|
|
1817
|
+
additionalProp1?: string | null | undefined;
|
|
1818
|
+
additionalProp2?: string | null | undefined;
|
|
1819
|
+
additionalProp3?: string | null | undefined;
|
|
1820
|
+
} | null | undefined;
|
|
1821
|
+
inputType?: string | null | undefined;
|
|
1822
|
+
name?: string | null | undefined;
|
|
1823
|
+
fieldName?: string | null | undefined;
|
|
1824
|
+
bindType?: string | null | undefined;
|
|
1825
|
+
entityMetadataId?: number | null | undefined;
|
|
1826
|
+
value?: string | null | undefined;
|
|
1827
|
+
values?: string[] | null | undefined;
|
|
1828
|
+
isNew?: boolean | null | undefined;
|
|
1829
|
+
isRequired?: boolean | null | undefined;
|
|
1830
|
+
displayName?: string | null | undefined;
|
|
1831
|
+
optionName?: string | null | undefined;
|
|
1832
|
+
}[] | null | undefined;
|
|
1833
|
+
currentUserIPs?: string | null | undefined;
|
|
1834
|
+
prefixFormat?: string | null | undefined;
|
|
1835
|
+
}>>;
|
|
1836
|
+
/**
|
|
1837
|
+
*
|
|
1838
|
+
* @typedef {Addresses} addresses
|
|
1839
|
+
* @property {number}
|
|
1840
|
+
* @property {string}
|
|
1841
|
+
* @property {string}
|
|
1842
|
+
* @property {string}
|
|
1843
|
+
* @property {string}
|
|
1844
|
+
* @property {string}
|
|
1845
|
+
* @property {string}
|
|
1846
|
+
* @property {string}
|
|
1847
|
+
* @property {string}
|
|
1848
|
+
* @property {string}
|
|
1849
|
+
* @property {string}
|
|
1850
|
+
* @property {boolean}
|
|
1851
|
+
* @property {boolean}
|
|
1852
|
+
* @property {boolean}
|
|
1853
|
+
* @property {string}
|
|
1854
|
+
* @property {string}
|
|
1855
|
+
* @property {ExtendedProperties[]}
|
|
1856
|
+
* @property {string}
|
|
1857
|
+
* @property {string}
|
|
1858
|
+
*/
|
|
1859
|
+
type Addresses = z.infer<typeof addresses>;
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* Zod schema for the ExtendedProperties model.
|
|
1863
|
+
* Defines the structure and validation rules for this data type.
|
|
1864
|
+
* This is the shape used in application code - what developers interact with.
|
|
1865
|
+
*/
|
|
1866
|
+
declare const extendedProperties: z.ZodLazy<z.ZodObject<{
|
|
1867
|
+
prefix: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1868
|
+
htmlAttributes: z.ZodNullable<z.ZodOptional<z.ZodLazy<z.ZodObject<{
|
|
1869
|
+
additionalProp1: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1870
|
+
additionalProp2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1871
|
+
additionalProp3: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1872
|
+
}, "strip", z.ZodTypeAny, {
|
|
1873
|
+
additionalProp1?: string | null | undefined;
|
|
1874
|
+
additionalProp2?: string | null | undefined;
|
|
1875
|
+
additionalProp3?: string | null | undefined;
|
|
1876
|
+
}, {
|
|
1877
|
+
additionalProp1?: string | null | undefined;
|
|
1878
|
+
additionalProp2?: string | null | undefined;
|
|
1879
|
+
additionalProp3?: string | null | undefined;
|
|
1880
|
+
}>>>>;
|
|
1881
|
+
inputType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1882
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1883
|
+
fieldName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1884
|
+
bindType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1885
|
+
entityMetadataId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
1886
|
+
value: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1887
|
+
values: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
1888
|
+
isNew: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1889
|
+
isRequired: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
1890
|
+
displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1891
|
+
optionName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1892
|
+
}, "strip", z.ZodTypeAny, {
|
|
1893
|
+
prefix?: string | null | undefined;
|
|
1894
|
+
htmlAttributes?: {
|
|
1895
|
+
additionalProp1?: string | null | undefined;
|
|
1896
|
+
additionalProp2?: string | null | undefined;
|
|
1897
|
+
additionalProp3?: string | null | undefined;
|
|
1898
|
+
} | null | undefined;
|
|
1899
|
+
inputType?: string | null | undefined;
|
|
1900
|
+
name?: string | null | undefined;
|
|
1901
|
+
fieldName?: string | null | undefined;
|
|
1902
|
+
bindType?: string | null | undefined;
|
|
1903
|
+
entityMetadataId?: number | null | undefined;
|
|
1904
|
+
value?: string | null | undefined;
|
|
1905
|
+
values?: string[] | null | undefined;
|
|
1906
|
+
isNew?: boolean | null | undefined;
|
|
1907
|
+
isRequired?: boolean | null | undefined;
|
|
1908
|
+
displayName?: string | null | undefined;
|
|
1909
|
+
optionName?: string | null | undefined;
|
|
1910
|
+
}, {
|
|
1911
|
+
prefix?: string | null | undefined;
|
|
1912
|
+
htmlAttributes?: {
|
|
1913
|
+
additionalProp1?: string | null | undefined;
|
|
1914
|
+
additionalProp2?: string | null | undefined;
|
|
1915
|
+
additionalProp3?: string | null | undefined;
|
|
1916
|
+
} | null | undefined;
|
|
1917
|
+
inputType?: string | null | undefined;
|
|
1918
|
+
name?: string | null | undefined;
|
|
1919
|
+
fieldName?: string | null | undefined;
|
|
1920
|
+
bindType?: string | null | undefined;
|
|
1921
|
+
entityMetadataId?: number | null | undefined;
|
|
1922
|
+
value?: string | null | undefined;
|
|
1923
|
+
values?: string[] | null | undefined;
|
|
1924
|
+
isNew?: boolean | null | undefined;
|
|
1925
|
+
isRequired?: boolean | null | undefined;
|
|
1926
|
+
displayName?: string | null | undefined;
|
|
1927
|
+
optionName?: string | null | undefined;
|
|
1928
|
+
}>>;
|
|
1929
|
+
/**
|
|
1930
|
+
*
|
|
1931
|
+
* @typedef {ExtendedProperties} extendedProperties
|
|
1932
|
+
* @property {string}
|
|
1933
|
+
* @property {HtmlAttributes}
|
|
1934
|
+
* @property {string}
|
|
1935
|
+
* @property {string}
|
|
1936
|
+
* @property {string}
|
|
1937
|
+
* @property {string}
|
|
1938
|
+
* @property {number}
|
|
1939
|
+
* @property {string}
|
|
1940
|
+
* @property {string[]}
|
|
1941
|
+
* @property {boolean}
|
|
1942
|
+
* @property {boolean}
|
|
1943
|
+
* @property {string}
|
|
1944
|
+
* @property {string}
|
|
1945
|
+
*/
|
|
1946
|
+
type ExtendedProperties = z.infer<typeof extendedProperties>;
|
|
1947
|
+
|
|
1948
|
+
/**
|
|
1949
|
+
* Zod schema for the HtmlAttributes model.
|
|
1950
|
+
* Defines the structure and validation rules for this data type.
|
|
1951
|
+
* This is the shape used in application code - what developers interact with.
|
|
1952
|
+
*/
|
|
1953
|
+
declare const htmlAttributes: z.ZodLazy<z.ZodObject<{
|
|
1954
|
+
additionalProp1: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1955
|
+
additionalProp2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1956
|
+
additionalProp3: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
1957
|
+
}, "strip", z.ZodTypeAny, {
|
|
1958
|
+
additionalProp1?: string | null | undefined;
|
|
1959
|
+
additionalProp2?: string | null | undefined;
|
|
1960
|
+
additionalProp3?: string | null | undefined;
|
|
1961
|
+
}, {
|
|
1962
|
+
additionalProp1?: string | null | undefined;
|
|
1963
|
+
additionalProp2?: string | null | undefined;
|
|
1964
|
+
additionalProp3?: string | null | undefined;
|
|
1965
|
+
}>>;
|
|
1966
|
+
/**
|
|
1967
|
+
*
|
|
1968
|
+
* @typedef {HtmlAttributes} htmlAttributes
|
|
1969
|
+
* @property {string}
|
|
1970
|
+
* @property {string}
|
|
1971
|
+
* @property {string}
|
|
1972
|
+
*/
|
|
1973
|
+
type HtmlAttributes = z.infer<typeof htmlAttributes>;
|
|
1974
|
+
|
|
1975
|
+
interface ProductSearchParams {
|
|
1976
|
+
id?: string;
|
|
1977
|
+
}
|
|
1978
|
+
interface ProductDetailsParams {
|
|
1979
|
+
id?: string;
|
|
1980
|
+
}
|
|
1981
|
+
interface ProductsDatasourceParams {
|
|
1982
|
+
authorization: string;
|
|
1983
|
+
accept: string;
|
|
1984
|
+
userAgent: string;
|
|
1985
|
+
pageIndex?: string;
|
|
1986
|
+
pageSize?: string;
|
|
1987
|
+
id?: string;
|
|
1988
|
+
}
|
|
1989
|
+
interface SearchCategoriesParams {
|
|
1990
|
+
accept: string;
|
|
1991
|
+
userAgent: string;
|
|
1992
|
+
id?: string;
|
|
1993
|
+
catalogId?: string;
|
|
1994
|
+
}
|
|
1995
|
+
interface BrandsParams {
|
|
1996
|
+
accept: string;
|
|
1997
|
+
userAgent: string;
|
|
1998
|
+
id?: string;
|
|
1999
|
+
}
|
|
2000
|
+
interface ListCategoriesParams {
|
|
2001
|
+
userAgent: string;
|
|
2002
|
+
vary: string;
|
|
2003
|
+
accept: string;
|
|
2004
|
+
template?: string;
|
|
2005
|
+
}
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
* Zod schema for the ProductsDatasourceRequest model.
|
|
2009
|
+
* Defines the structure and validation rules for this data type.
|
|
2010
|
+
* This is the shape used in application code - what developers interact with.
|
|
2011
|
+
*/
|
|
2012
|
+
declare const productsDatasourceRequest: z.ZodLazy<z.ZodObject<{
|
|
2013
|
+
pageNumber: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2014
|
+
pageIndex: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2015
|
+
pageSize: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2016
|
+
}, "strip", z.ZodTypeAny, {
|
|
2017
|
+
pageNumber?: number | null | undefined;
|
|
2018
|
+
pageIndex?: number | null | undefined;
|
|
2019
|
+
pageSize?: number | null | undefined;
|
|
2020
|
+
}, {
|
|
2021
|
+
pageNumber?: number | null | undefined;
|
|
2022
|
+
pageIndex?: number | null | undefined;
|
|
2023
|
+
pageSize?: number | null | undefined;
|
|
2024
|
+
}>>;
|
|
2025
|
+
/**
|
|
2026
|
+
*
|
|
2027
|
+
* @typedef {ProductsDatasourceRequest} productsDatasourceRequest
|
|
2028
|
+
* @property {number}
|
|
2029
|
+
* @property {number}
|
|
2030
|
+
* @property {number}
|
|
2031
|
+
*/
|
|
2032
|
+
type ProductsDatasourceRequest = z.infer<typeof productsDatasourceRequest>;
|
|
2033
|
+
|
|
2034
|
+
/**
|
|
2035
|
+
* Zod schema for the BrandsRequest model.
|
|
2036
|
+
* Defines the structure and validation rules for this data type.
|
|
2037
|
+
* This is the shape used in application code - what developers interact with.
|
|
2038
|
+
*/
|
|
2039
|
+
declare const brandsRequest: z.ZodLazy<z.ZodObject<{
|
|
2040
|
+
id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2041
|
+
}, "strip", z.ZodTypeAny, {
|
|
2042
|
+
id?: number | null | undefined;
|
|
2043
|
+
}, {
|
|
2044
|
+
id?: number | null | undefined;
|
|
2045
|
+
}>>;
|
|
2046
|
+
/**
|
|
2047
|
+
*
|
|
2048
|
+
* @typedef {BrandsRequest} brandsRequest
|
|
2049
|
+
* @property {number}
|
|
2050
|
+
*/
|
|
2051
|
+
type BrandsRequest = z.infer<typeof brandsRequest>;
|
|
2052
|
+
|
|
2053
|
+
/**
|
|
2054
|
+
* Service class for ProductsService operations.
|
|
2055
|
+
* Provides methods to interact with ProductsService-related API endpoints.
|
|
2056
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2057
|
+
*/
|
|
2058
|
+
declare class ProductsService extends BaseService {
|
|
2059
|
+
protected productSearchConfig: Partial<SdkConfig>;
|
|
2060
|
+
protected productDetailsConfig: Partial<SdkConfig>;
|
|
2061
|
+
protected productsDatasourceConfig: Partial<SdkConfig>;
|
|
2062
|
+
protected searchCategoriesConfig: Partial<SdkConfig>;
|
|
2063
|
+
protected brandsConfig: Partial<SdkConfig>;
|
|
2064
|
+
protected listCategoriesConfig: Partial<SdkConfig>;
|
|
2065
|
+
/**
|
|
2066
|
+
* Sets method-level configuration for productSearch.
|
|
2067
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2068
|
+
* @returns This service instance for method chaining
|
|
2069
|
+
*/
|
|
2070
|
+
setProductSearchConfig(config: Partial<SdkConfig>): this;
|
|
2071
|
+
/**
|
|
2072
|
+
* Sets method-level configuration for productDetails.
|
|
2073
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2074
|
+
* @returns This service instance for method chaining
|
|
2075
|
+
*/
|
|
2076
|
+
setProductDetailsConfig(config: Partial<SdkConfig>): this;
|
|
2077
|
+
/**
|
|
2078
|
+
* Sets method-level configuration for productsDatasource.
|
|
2079
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2080
|
+
* @returns This service instance for method chaining
|
|
2081
|
+
*/
|
|
2082
|
+
setProductsDatasourceConfig(config: Partial<SdkConfig>): this;
|
|
2083
|
+
/**
|
|
2084
|
+
* Sets method-level configuration for searchCategories.
|
|
2085
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2086
|
+
* @returns This service instance for method chaining
|
|
2087
|
+
*/
|
|
2088
|
+
setSearchCategoriesConfig(config: Partial<SdkConfig>): this;
|
|
2089
|
+
/**
|
|
2090
|
+
* Sets method-level configuration for brands.
|
|
2091
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2092
|
+
* @returns This service instance for method chaining
|
|
2093
|
+
*/
|
|
2094
|
+
setBrandsConfig(config: Partial<SdkConfig>): this;
|
|
2095
|
+
/**
|
|
2096
|
+
* Sets method-level configuration for listCategories.
|
|
2097
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2098
|
+
* @returns This service instance for method chaining
|
|
2099
|
+
*/
|
|
2100
|
+
setListCategoriesConfig(config: Partial<SdkConfig>): this;
|
|
2101
|
+
/**
|
|
2102
|
+
*
|
|
2103
|
+
* @param {string} [params.id] -
|
|
2104
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2105
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2106
|
+
*/
|
|
2107
|
+
productSearch(params?: ProductSearchParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2108
|
+
/**
|
|
2109
|
+
*
|
|
2110
|
+
* @param {string} [params.id] -
|
|
2111
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2112
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2113
|
+
*/
|
|
2114
|
+
productDetails(params?: ProductDetailsParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2115
|
+
/**
|
|
2116
|
+
*
|
|
2117
|
+
* @param {string} params.authorization -
|
|
2118
|
+
* @param {string} params.accept -
|
|
2119
|
+
* @param {string} params.userAgent -
|
|
2120
|
+
* @param {string} [params.pageIndex] -
|
|
2121
|
+
* @param {string} [params.pageSize] -
|
|
2122
|
+
* @param {string} [params.id] -
|
|
2123
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2124
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2125
|
+
*/
|
|
2126
|
+
productsDatasource(body: ProductsDatasourceRequest, params: ProductsDatasourceParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2127
|
+
/**
|
|
2128
|
+
*
|
|
2129
|
+
* @param {string} params.accept -
|
|
2130
|
+
* @param {string} params.userAgent -
|
|
2131
|
+
* @param {string} [params.id] -
|
|
2132
|
+
* @param {string} [params.catalogId] -
|
|
2133
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2134
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2135
|
+
*/
|
|
2136
|
+
searchCategories(params: SearchCategoriesParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2137
|
+
/**
|
|
2138
|
+
*
|
|
2139
|
+
* @param {string} params.accept -
|
|
2140
|
+
* @param {string} params.userAgent -
|
|
2141
|
+
* @param {string} [params.id] -
|
|
2142
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2143
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2144
|
+
*/
|
|
2145
|
+
brands(body: BrandsRequest, params: BrandsParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2146
|
+
/**
|
|
2147
|
+
*
|
|
2148
|
+
* @param {string} params.userAgent -
|
|
2149
|
+
* @param {string} params.vary -
|
|
2150
|
+
* @param {string} params.accept -
|
|
2151
|
+
* @param {string} [params.template] -
|
|
2152
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2153
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2154
|
+
*/
|
|
2155
|
+
listCategories(params: ListCategoriesParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
/**
|
|
2159
|
+
* Service class for AddressService operations.
|
|
2160
|
+
* Provides methods to interact with AddressService-related API endpoints.
|
|
2161
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2162
|
+
*/
|
|
2163
|
+
declare class AddressService extends BaseService {
|
|
2164
|
+
protected addressListConfig: Partial<SdkConfig>;
|
|
2165
|
+
protected registerAddressConfig: Partial<SdkConfig>;
|
|
2166
|
+
protected removeAddressConfig: Partial<SdkConfig>;
|
|
2167
|
+
protected getAShippingQuote_Config: Partial<SdkConfig>;
|
|
2168
|
+
/**
|
|
2169
|
+
* Sets method-level configuration for addressList.
|
|
2170
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2171
|
+
* @returns This service instance for method chaining
|
|
2172
|
+
*/
|
|
2173
|
+
setAddressListConfig(config: Partial<SdkConfig>): this;
|
|
2174
|
+
/**
|
|
2175
|
+
* Sets method-level configuration for registerAddress.
|
|
2176
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2177
|
+
* @returns This service instance for method chaining
|
|
2178
|
+
*/
|
|
2179
|
+
setRegisterAddressConfig(config: Partial<SdkConfig>): this;
|
|
2180
|
+
/**
|
|
2181
|
+
* Sets method-level configuration for removeAddress.
|
|
2182
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2183
|
+
* @returns This service instance for method chaining
|
|
2184
|
+
*/
|
|
2185
|
+
setRemoveAddressConfig(config: Partial<SdkConfig>): this;
|
|
2186
|
+
/**
|
|
2187
|
+
* Sets method-level configuration for getAShippingQuote_.
|
|
2188
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2189
|
+
* @returns This service instance for method chaining
|
|
2190
|
+
*/
|
|
2191
|
+
setGetAShippingQuote_Config(config: Partial<SdkConfig>): this;
|
|
2192
|
+
/**
|
|
2193
|
+
*
|
|
2194
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2195
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2196
|
+
*/
|
|
2197
|
+
addressList(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2198
|
+
/**
|
|
2199
|
+
*
|
|
2200
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2201
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2202
|
+
*/
|
|
2203
|
+
registerAddress(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2204
|
+
/**
|
|
2205
|
+
*
|
|
2206
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2207
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2208
|
+
*/
|
|
2209
|
+
removeAddress(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2210
|
+
/**
|
|
2211
|
+
*
|
|
2212
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2213
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2214
|
+
*/
|
|
2215
|
+
getAShippingQuote_(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2216
|
+
}
|
|
2217
|
+
|
|
2218
|
+
interface DefineDeliveryOptionParams {
|
|
2219
|
+
accept: string;
|
|
2220
|
+
}
|
|
2221
|
+
interface LoadPointsOfSaleParams {
|
|
2222
|
+
authorization: string;
|
|
2223
|
+
accept: string;
|
|
2224
|
+
}
|
|
2225
|
+
interface CarregarSellersParams {
|
|
2226
|
+
accept: string;
|
|
2227
|
+
}
|
|
2228
|
+
interface QuoteViaTemplateParams {
|
|
2229
|
+
userAgent: string;
|
|
2230
|
+
accept: string;
|
|
2231
|
+
productId?: string;
|
|
2232
|
+
skuId?: string;
|
|
2233
|
+
postalCode?: string;
|
|
2234
|
+
template?: string;
|
|
2235
|
+
}
|
|
2236
|
+
interface ReturnLocationIdParams {
|
|
2237
|
+
userAgent: string;
|
|
2238
|
+
accept: string;
|
|
2239
|
+
}
|
|
2240
|
+
|
|
2241
|
+
/**
|
|
2242
|
+
* Service class for DeliveryService operations.
|
|
2243
|
+
* Provides methods to interact with DeliveryService-related API endpoints.
|
|
2244
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2245
|
+
*/
|
|
2246
|
+
declare class DeliveryService extends BaseService {
|
|
2247
|
+
protected defineDeliveryOptionConfig: Partial<SdkConfig>;
|
|
2248
|
+
protected loadPointsOfSaleConfig: Partial<SdkConfig>;
|
|
2249
|
+
protected carregarSellersConfig: Partial<SdkConfig>;
|
|
2250
|
+
protected quoteViaTemplateConfig: Partial<SdkConfig>;
|
|
2251
|
+
protected returnLocationIdConfig: Partial<SdkConfig>;
|
|
2252
|
+
/**
|
|
2253
|
+
* Sets method-level configuration for defineDeliveryOption.
|
|
2254
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2255
|
+
* @returns This service instance for method chaining
|
|
2256
|
+
*/
|
|
2257
|
+
setDefineDeliveryOptionConfig(config: Partial<SdkConfig>): this;
|
|
2258
|
+
/**
|
|
2259
|
+
* Sets method-level configuration for loadPointsOfSale.
|
|
2260
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2261
|
+
* @returns This service instance for method chaining
|
|
2262
|
+
*/
|
|
2263
|
+
setLoadPointsOfSaleConfig(config: Partial<SdkConfig>): this;
|
|
2264
|
+
/**
|
|
2265
|
+
* Sets method-level configuration for carregarSellers.
|
|
2266
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2267
|
+
* @returns This service instance for method chaining
|
|
2268
|
+
*/
|
|
2269
|
+
setCarregarSellersConfig(config: Partial<SdkConfig>): this;
|
|
2270
|
+
/**
|
|
2271
|
+
* Sets method-level configuration for quoteViaTemplate.
|
|
2272
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2273
|
+
* @returns This service instance for method chaining
|
|
2274
|
+
*/
|
|
2275
|
+
setQuoteViaTemplateConfig(config: Partial<SdkConfig>): this;
|
|
2276
|
+
/**
|
|
2277
|
+
* Sets method-level configuration for returnLocationId.
|
|
2278
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2279
|
+
* @returns This service instance for method chaining
|
|
2280
|
+
*/
|
|
2281
|
+
setReturnLocationIdConfig(config: Partial<SdkConfig>): this;
|
|
2282
|
+
/**
|
|
2283
|
+
*
|
|
2284
|
+
* @param {string} params.accept -
|
|
2285
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2286
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2287
|
+
*/
|
|
2288
|
+
defineDeliveryOption(body: any, params: DefineDeliveryOptionParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2289
|
+
/**
|
|
2290
|
+
*
|
|
2291
|
+
* @param {string} params.authorization -
|
|
2292
|
+
* @param {string} params.accept -
|
|
2293
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2294
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2295
|
+
*/
|
|
2296
|
+
loadPointsOfSale(body: any, params: LoadPointsOfSaleParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2297
|
+
/**
|
|
2298
|
+
*
|
|
2299
|
+
* @param {string} params.accept -
|
|
2300
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2301
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2302
|
+
*/
|
|
2303
|
+
carregarSellers(body: any, params: CarregarSellersParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2304
|
+
/**
|
|
2305
|
+
*
|
|
2306
|
+
* @param {string} params.userAgent -
|
|
2307
|
+
* @param {string} params.accept -
|
|
2308
|
+
* @param {string} [params.productId] -
|
|
2309
|
+
* @param {string} [params.skuId] -
|
|
2310
|
+
* @param {string} [params.postalCode] -
|
|
2311
|
+
* @param {string} [params.template] -
|
|
2312
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2313
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2314
|
+
*/
|
|
2315
|
+
quoteViaTemplate(params: QuoteViaTemplateParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2316
|
+
/**
|
|
2317
|
+
*
|
|
2318
|
+
* @param {string} params.userAgent -
|
|
2319
|
+
* @param {string} params.accept -
|
|
2320
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2321
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2322
|
+
*/
|
|
2323
|
+
returnLocationId(params: ReturnLocationIdParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2324
|
+
}
|
|
2325
|
+
|
|
2326
|
+
interface RecoverBasketParams {
|
|
2327
|
+
authorization: string;
|
|
2328
|
+
accept: string;
|
|
2329
|
+
cacheControl: string;
|
|
2330
|
+
}
|
|
2331
|
+
interface AddProductToBasketParams {
|
|
2332
|
+
accept: string;
|
|
2333
|
+
}
|
|
2334
|
+
interface AddMetadataToBasketItemParams {
|
|
2335
|
+
authorization: string;
|
|
2336
|
+
accept: string;
|
|
2337
|
+
}
|
|
2338
|
+
interface AddCouponParams {
|
|
2339
|
+
accept: string;
|
|
2340
|
+
}
|
|
2341
|
+
interface RemoveCouponParams {
|
|
2342
|
+
accept: string;
|
|
2343
|
+
}
|
|
2344
|
+
interface AddKitBasketParams {
|
|
2345
|
+
accept: string;
|
|
2346
|
+
}
|
|
2347
|
+
interface AdicionarServiOAdicionalParams {
|
|
2348
|
+
accept: string;
|
|
2349
|
+
}
|
|
2350
|
+
interface RemoverItemDoCarrinhoParams {
|
|
2351
|
+
accept: string;
|
|
2352
|
+
}
|
|
2353
|
+
interface RemoverTodosItemsDoCarrinhoParams {
|
|
2354
|
+
authorization: string;
|
|
2355
|
+
}
|
|
2356
|
+
interface DefineCepDeEntregaParams {
|
|
2357
|
+
accept: string;
|
|
2358
|
+
}
|
|
2359
|
+
|
|
2360
|
+
/**
|
|
2361
|
+
* Service class for BasketService operations.
|
|
2362
|
+
* Provides methods to interact with BasketService-related API endpoints.
|
|
2363
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2364
|
+
*/
|
|
2365
|
+
declare class BasketService extends BaseService {
|
|
2366
|
+
protected recoverBasketConfig: Partial<SdkConfig>;
|
|
2367
|
+
protected addProductToBasketConfig: Partial<SdkConfig>;
|
|
2368
|
+
protected addMetadataToBasketItemConfig: Partial<SdkConfig>;
|
|
2369
|
+
protected addCouponConfig: Partial<SdkConfig>;
|
|
2370
|
+
protected removeCouponConfig: Partial<SdkConfig>;
|
|
2371
|
+
protected addKitBasketConfig: Partial<SdkConfig>;
|
|
2372
|
+
protected adicionarServiOAdicionalConfig: Partial<SdkConfig>;
|
|
2373
|
+
protected removerItemDoCarrinhoConfig: Partial<SdkConfig>;
|
|
2374
|
+
protected removerTodosItemsDoCarrinhoConfig: Partial<SdkConfig>;
|
|
2375
|
+
protected defineCepDeEntregaConfig: Partial<SdkConfig>;
|
|
2376
|
+
/**
|
|
2377
|
+
* Sets method-level configuration for recoverBasket.
|
|
2378
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2379
|
+
* @returns This service instance for method chaining
|
|
2380
|
+
*/
|
|
2381
|
+
setRecoverBasketConfig(config: Partial<SdkConfig>): this;
|
|
2382
|
+
/**
|
|
2383
|
+
* Sets method-level configuration for addProductToBasket.
|
|
2384
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2385
|
+
* @returns This service instance for method chaining
|
|
2386
|
+
*/
|
|
2387
|
+
setAddProductToBasketConfig(config: Partial<SdkConfig>): this;
|
|
2388
|
+
/**
|
|
2389
|
+
* Sets method-level configuration for addMetadataToBasketItem.
|
|
2390
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2391
|
+
* @returns This service instance for method chaining
|
|
2392
|
+
*/
|
|
2393
|
+
setAddMetadataToBasketItemConfig(config: Partial<SdkConfig>): this;
|
|
2394
|
+
/**
|
|
2395
|
+
* Sets method-level configuration for addCoupon.
|
|
2396
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2397
|
+
* @returns This service instance for method chaining
|
|
2398
|
+
*/
|
|
2399
|
+
setAddCouponConfig(config: Partial<SdkConfig>): this;
|
|
2400
|
+
/**
|
|
2401
|
+
* Sets method-level configuration for removeCoupon.
|
|
2402
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2403
|
+
* @returns This service instance for method chaining
|
|
2404
|
+
*/
|
|
2405
|
+
setRemoveCouponConfig(config: Partial<SdkConfig>): this;
|
|
2406
|
+
/**
|
|
2407
|
+
* Sets method-level configuration for addKitBasket.
|
|
2408
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2409
|
+
* @returns This service instance for method chaining
|
|
2410
|
+
*/
|
|
2411
|
+
setAddKitBasketConfig(config: Partial<SdkConfig>): this;
|
|
2412
|
+
/**
|
|
2413
|
+
* Sets method-level configuration for adicionarServiOAdicional.
|
|
2414
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2415
|
+
* @returns This service instance for method chaining
|
|
2416
|
+
*/
|
|
2417
|
+
setAdicionarServiOAdicionalConfig(config: Partial<SdkConfig>): this;
|
|
2418
|
+
/**
|
|
2419
|
+
* Sets method-level configuration for removerItemDoCarrinho.
|
|
2420
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2421
|
+
* @returns This service instance for method chaining
|
|
2422
|
+
*/
|
|
2423
|
+
setRemoverItemDoCarrinhoConfig(config: Partial<SdkConfig>): this;
|
|
2424
|
+
/**
|
|
2425
|
+
* Sets method-level configuration for removerTodosItemsDoCarrinho.
|
|
2426
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2427
|
+
* @returns This service instance for method chaining
|
|
2428
|
+
*/
|
|
2429
|
+
setRemoverTodosItemsDoCarrinhoConfig(config: Partial<SdkConfig>): this;
|
|
2430
|
+
/**
|
|
2431
|
+
* Sets method-level configuration for defineCepDeEntrega.
|
|
2432
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2433
|
+
* @returns This service instance for method chaining
|
|
2434
|
+
*/
|
|
2435
|
+
setDefineCepDeEntregaConfig(config: Partial<SdkConfig>): this;
|
|
2436
|
+
/**
|
|
2437
|
+
*
|
|
2438
|
+
* @param {string} params.authorization -
|
|
2439
|
+
* @param {string} params.accept -
|
|
2440
|
+
* @param {string} params.cacheControl -
|
|
2441
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2442
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2443
|
+
*/
|
|
2444
|
+
recoverBasket(body: any, params: RecoverBasketParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2445
|
+
/**
|
|
2446
|
+
*
|
|
2447
|
+
* @param {string} params.accept -
|
|
2448
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2449
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2450
|
+
*/
|
|
2451
|
+
addProductToBasket(body: any, params: AddProductToBasketParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2452
|
+
/**
|
|
2453
|
+
*
|
|
2454
|
+
* @param {string} params.authorization -
|
|
2455
|
+
* @param {string} params.accept -
|
|
2456
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2457
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2458
|
+
*/
|
|
2459
|
+
addMetadataToBasketItem(body: any, params: AddMetadataToBasketItemParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2460
|
+
/**
|
|
2461
|
+
*
|
|
2462
|
+
* @param {string} params.accept -
|
|
2463
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2464
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2465
|
+
*/
|
|
2466
|
+
addCoupon(body: any, params: AddCouponParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2467
|
+
/**
|
|
2468
|
+
*
|
|
2469
|
+
* @param {string} params.accept -
|
|
2470
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2471
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2472
|
+
*/
|
|
2473
|
+
removeCoupon(body: any, params: RemoveCouponParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2474
|
+
/**
|
|
2475
|
+
*
|
|
2476
|
+
* @param {string} params.accept -
|
|
2477
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2478
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2479
|
+
*/
|
|
2480
|
+
addKitBasket(body: any, params: AddKitBasketParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2481
|
+
/**
|
|
2482
|
+
*
|
|
2483
|
+
* @param {string} params.accept -
|
|
2484
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2485
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2486
|
+
*/
|
|
2487
|
+
adicionarServiOAdicional(body: any, params: AdicionarServiOAdicionalParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2488
|
+
/**
|
|
2489
|
+
*
|
|
2490
|
+
* @param {string} params.accept -
|
|
2491
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2492
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2493
|
+
*/
|
|
2494
|
+
removerItemDoCarrinho(body: any, params: RemoverItemDoCarrinhoParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2495
|
+
/**
|
|
2496
|
+
* StartFragment
|
|
2497
|
+
Simula a API do parceiro que retorna informações sobre promoções
|
|
2498
|
+
|
|
2499
|
+
EndFragment
|
|
2500
|
+
* @param {string} params.authorization -
|
|
2501
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2502
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2503
|
+
*/
|
|
2504
|
+
removerTodosItemsDoCarrinho(body: any, params: RemoverTodosItemsDoCarrinhoParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2505
|
+
/**
|
|
2506
|
+
*
|
|
2507
|
+
* @param {string} params.accept -
|
|
2508
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2509
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2510
|
+
*/
|
|
2511
|
+
defineCepDeEntrega(body: any, params: DefineCepDeEntregaParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2512
|
+
}
|
|
2513
|
+
|
|
2514
|
+
/**
|
|
2515
|
+
* Zod schema for the RetornaOpODeEntregaParaOmsRequest model.
|
|
2516
|
+
* Defines the structure and validation rules for this data type.
|
|
2517
|
+
* This is the shape used in application code - what developers interact with.
|
|
2518
|
+
*/
|
|
2519
|
+
declare const retornaOpODeEntregaParaOmsRequest: z.ZodLazy<z.ZodObject<{
|
|
2520
|
+
groupKey: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2521
|
+
basketId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2522
|
+
customerId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2523
|
+
sessionId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2524
|
+
shopperTicketId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2525
|
+
basketAuthorityToken: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2526
|
+
}, "strip", z.ZodTypeAny, {
|
|
2527
|
+
groupKey?: string | null | undefined;
|
|
2528
|
+
basketId?: string | null | undefined;
|
|
2529
|
+
customerId?: string | null | undefined;
|
|
2530
|
+
sessionId?: string | null | undefined;
|
|
2531
|
+
shopperTicketId?: string | null | undefined;
|
|
2532
|
+
basketAuthorityToken?: string | null | undefined;
|
|
2533
|
+
}, {
|
|
2534
|
+
groupKey?: string | null | undefined;
|
|
2535
|
+
basketId?: string | null | undefined;
|
|
2536
|
+
customerId?: string | null | undefined;
|
|
2537
|
+
sessionId?: string | null | undefined;
|
|
2538
|
+
shopperTicketId?: string | null | undefined;
|
|
2539
|
+
basketAuthorityToken?: string | null | undefined;
|
|
2540
|
+
}>>;
|
|
2541
|
+
/**
|
|
2542
|
+
*
|
|
2543
|
+
* @typedef {RetornaOpODeEntregaParaOmsRequest} retornaOpODeEntregaParaOmsRequest
|
|
2544
|
+
* @property {string}
|
|
2545
|
+
* @property {string}
|
|
2546
|
+
* @property {string}
|
|
2547
|
+
* @property {string}
|
|
2548
|
+
* @property {string}
|
|
2549
|
+
* @property {string}
|
|
2550
|
+
*/
|
|
2551
|
+
type RetornaOpODeEntregaParaOmsRequest = z.infer<typeof retornaOpODeEntregaParaOmsRequest>;
|
|
2552
|
+
|
|
2553
|
+
/**
|
|
2554
|
+
* Service class for CheckoutService operations.
|
|
2555
|
+
* Provides methods to interact with CheckoutService-related API endpoints.
|
|
2556
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2557
|
+
*/
|
|
2558
|
+
declare class CheckoutService extends BaseService {
|
|
2559
|
+
protected recuperaCheckoutConfig: Partial<SdkConfig>;
|
|
2560
|
+
protected selecionaEndereODeEntregaConfig: Partial<SdkConfig>;
|
|
2561
|
+
protected setPostalCodeConfig: Partial<SdkConfig>;
|
|
2562
|
+
protected setaMTodoDeEntregaLocationIdConfig: Partial<SdkConfig>;
|
|
2563
|
+
protected setaMTodoDeEntregaConfig: Partial<SdkConfig>;
|
|
2564
|
+
protected retornaOpODeEntregaParaOmsConfig: Partial<SdkConfig>;
|
|
2565
|
+
protected gruposDePagamentoConfig: Partial<SdkConfig>;
|
|
2566
|
+
protected adicioneCupomNoCheckoutConfig: Partial<SdkConfig>;
|
|
2567
|
+
protected removeCupomNoCheckoutConfig: Partial<SdkConfig>;
|
|
2568
|
+
protected realizaPedidoDeVendaPixConfig: Partial<SdkConfig>;
|
|
2569
|
+
protected realizaPedidoDeVendaCardConfig: Partial<SdkConfig>;
|
|
2570
|
+
/**
|
|
2571
|
+
* Sets method-level configuration for recuperaCheckout.
|
|
2572
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2573
|
+
* @returns This service instance for method chaining
|
|
2574
|
+
*/
|
|
2575
|
+
setRecuperaCheckoutConfig(config: Partial<SdkConfig>): this;
|
|
2576
|
+
/**
|
|
2577
|
+
* Sets method-level configuration for selecionaEndereODeEntrega.
|
|
2578
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2579
|
+
* @returns This service instance for method chaining
|
|
2580
|
+
*/
|
|
2581
|
+
setSelecionaEndereODeEntregaConfig(config: Partial<SdkConfig>): this;
|
|
2582
|
+
/**
|
|
2583
|
+
* Sets method-level configuration for setPostalCode.
|
|
2584
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2585
|
+
* @returns This service instance for method chaining
|
|
2586
|
+
*/
|
|
2587
|
+
setSetPostalCodeConfig(config: Partial<SdkConfig>): this;
|
|
2588
|
+
/**
|
|
2589
|
+
* Sets method-level configuration for setaMTodoDeEntregaLocationId.
|
|
2590
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2591
|
+
* @returns This service instance for method chaining
|
|
2592
|
+
*/
|
|
2593
|
+
setSetaMTodoDeEntregaLocationIdConfig(config: Partial<SdkConfig>): this;
|
|
2594
|
+
/**
|
|
2595
|
+
* Sets method-level configuration for setaMTodoDeEntrega.
|
|
2596
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2597
|
+
* @returns This service instance for method chaining
|
|
2598
|
+
*/
|
|
2599
|
+
setSetaMTodoDeEntregaConfig(config: Partial<SdkConfig>): this;
|
|
2600
|
+
/**
|
|
2601
|
+
* Sets method-level configuration for retornaOpODeEntregaParaOms.
|
|
2602
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2603
|
+
* @returns This service instance for method chaining
|
|
2604
|
+
*/
|
|
2605
|
+
setRetornaOpODeEntregaParaOmsConfig(config: Partial<SdkConfig>): this;
|
|
2606
|
+
/**
|
|
2607
|
+
* Sets method-level configuration for gruposDePagamento.
|
|
2608
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2609
|
+
* @returns This service instance for method chaining
|
|
2610
|
+
*/
|
|
2611
|
+
setGruposDePagamentoConfig(config: Partial<SdkConfig>): this;
|
|
2612
|
+
/**
|
|
2613
|
+
* Sets method-level configuration for adicioneCupomNoCheckout.
|
|
2614
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2615
|
+
* @returns This service instance for method chaining
|
|
2616
|
+
*/
|
|
2617
|
+
setAdicioneCupomNoCheckoutConfig(config: Partial<SdkConfig>): this;
|
|
2618
|
+
/**
|
|
2619
|
+
* Sets method-level configuration for removeCupomNoCheckout.
|
|
2620
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2621
|
+
* @returns This service instance for method chaining
|
|
2622
|
+
*/
|
|
2623
|
+
setRemoveCupomNoCheckoutConfig(config: Partial<SdkConfig>): this;
|
|
2624
|
+
/**
|
|
2625
|
+
* Sets method-level configuration for realizaPedidoDeVendaPix.
|
|
2626
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2627
|
+
* @returns This service instance for method chaining
|
|
2628
|
+
*/
|
|
2629
|
+
setRealizaPedidoDeVendaPixConfig(config: Partial<SdkConfig>): this;
|
|
2630
|
+
/**
|
|
2631
|
+
* Sets method-level configuration for realizaPedidoDeVendaCard.
|
|
2632
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2633
|
+
* @returns This service instance for method chaining
|
|
2634
|
+
*/
|
|
2635
|
+
setRealizaPedidoDeVendaCardConfig(config: Partial<SdkConfig>): this;
|
|
2636
|
+
/**
|
|
2637
|
+
*
|
|
2638
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2639
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2640
|
+
*/
|
|
2641
|
+
recuperaCheckout(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2642
|
+
/**
|
|
2643
|
+
*
|
|
2644
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2645
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2646
|
+
*/
|
|
2647
|
+
selecionaEndereODeEntrega(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2648
|
+
/**
|
|
2649
|
+
*
|
|
2650
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2651
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2652
|
+
*/
|
|
2653
|
+
setPostalCode(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2654
|
+
/**
|
|
2655
|
+
*
|
|
2656
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2657
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2658
|
+
*/
|
|
2659
|
+
setaMTodoDeEntregaLocationId(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2660
|
+
/**
|
|
2661
|
+
*
|
|
2662
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2663
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2664
|
+
*/
|
|
2665
|
+
setaMTodoDeEntrega(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2666
|
+
/**
|
|
2667
|
+
*
|
|
2668
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2669
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2670
|
+
*/
|
|
2671
|
+
retornaOpODeEntregaParaOms(body: RetornaOpODeEntregaParaOmsRequest, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2672
|
+
/**
|
|
2673
|
+
*
|
|
2674
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2675
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2676
|
+
*/
|
|
2677
|
+
gruposDePagamento(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2678
|
+
/**
|
|
2679
|
+
*
|
|
2680
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2681
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2682
|
+
*/
|
|
2683
|
+
adicioneCupomNoCheckout(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2684
|
+
/**
|
|
2685
|
+
*
|
|
2686
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2687
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2688
|
+
*/
|
|
2689
|
+
removeCupomNoCheckout(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2690
|
+
/**
|
|
2691
|
+
*
|
|
2692
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2693
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2694
|
+
*/
|
|
2695
|
+
realizaPedidoDeVendaPix(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2696
|
+
/**
|
|
2697
|
+
*
|
|
2698
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2699
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2700
|
+
*/
|
|
2701
|
+
realizaPedidoDeVendaCard(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2702
|
+
}
|
|
2703
|
+
|
|
2704
|
+
/**
|
|
2705
|
+
* Zod schema for the DetailsOrderRequest model.
|
|
2706
|
+
* Defines the structure and validation rules for this data type.
|
|
2707
|
+
* This is the shape used in application code - what developers interact with.
|
|
2708
|
+
*/
|
|
2709
|
+
declare const detailsOrderRequest: z.ZodLazy<z.ZodObject<{
|
|
2710
|
+
sessionId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2711
|
+
orderNumber: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2712
|
+
customerId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2713
|
+
}, "strip", z.ZodTypeAny, {
|
|
2714
|
+
sessionId?: string | null | undefined;
|
|
2715
|
+
orderNumber?: string | null | undefined;
|
|
2716
|
+
customerId?: number | null | undefined;
|
|
2717
|
+
}, {
|
|
2718
|
+
sessionId?: string | null | undefined;
|
|
2719
|
+
orderNumber?: string | null | undefined;
|
|
2720
|
+
customerId?: number | null | undefined;
|
|
2721
|
+
}>>;
|
|
2722
|
+
/**
|
|
2723
|
+
*
|
|
2724
|
+
* @typedef {DetailsOrderRequest} detailsOrderRequest
|
|
2725
|
+
* @property {string}
|
|
2726
|
+
* @property {string}
|
|
2727
|
+
* @property {number}
|
|
2728
|
+
*/
|
|
2729
|
+
type DetailsOrderRequest = z.infer<typeof detailsOrderRequest>;
|
|
2730
|
+
|
|
2731
|
+
/**
|
|
2732
|
+
* Zod schema for the AccountOrderRequest model.
|
|
2733
|
+
* Defines the structure and validation rules for this data type.
|
|
2734
|
+
* This is the shape used in application code - what developers interact with.
|
|
2735
|
+
*/
|
|
2736
|
+
declare const accountOrderRequest: z.ZodLazy<z.ZodObject<{
|
|
2737
|
+
sessionId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
2738
|
+
pageSize: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2739
|
+
pageIndex: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2740
|
+
customerId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
|
|
2741
|
+
}, "strip", z.ZodTypeAny, {
|
|
2742
|
+
sessionId?: string | null | undefined;
|
|
2743
|
+
pageSize?: number | null | undefined;
|
|
2744
|
+
pageIndex?: number | null | undefined;
|
|
2745
|
+
customerId?: number | null | undefined;
|
|
2746
|
+
}, {
|
|
2747
|
+
sessionId?: string | null | undefined;
|
|
2748
|
+
pageSize?: number | null | undefined;
|
|
2749
|
+
pageIndex?: number | null | undefined;
|
|
2750
|
+
customerId?: number | null | undefined;
|
|
2751
|
+
}>>;
|
|
2752
|
+
/**
|
|
2753
|
+
*
|
|
2754
|
+
* @typedef {AccountOrderRequest} accountOrderRequest
|
|
2755
|
+
* @property {string}
|
|
2756
|
+
* @property {number}
|
|
2757
|
+
* @property {number}
|
|
2758
|
+
* @property {number}
|
|
2759
|
+
*/
|
|
2760
|
+
type AccountOrderRequest = z.infer<typeof accountOrderRequest>;
|
|
2761
|
+
|
|
2762
|
+
/**
|
|
2763
|
+
* Service class for OrdersService operations.
|
|
2764
|
+
* Provides methods to interact with OrdersService-related API endpoints.
|
|
2765
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2766
|
+
*/
|
|
2767
|
+
declare class OrdersService extends BaseService {
|
|
2768
|
+
protected orderListConfig: Partial<SdkConfig>;
|
|
2769
|
+
protected detailsOrderConfig: Partial<SdkConfig>;
|
|
2770
|
+
protected accountOrderConfig: Partial<SdkConfig>;
|
|
2771
|
+
/**
|
|
2772
|
+
* Sets method-level configuration for orderList.
|
|
2773
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2774
|
+
* @returns This service instance for method chaining
|
|
2775
|
+
*/
|
|
2776
|
+
setOrderListConfig(config: Partial<SdkConfig>): this;
|
|
2777
|
+
/**
|
|
2778
|
+
* Sets method-level configuration for detailsOrder.
|
|
2779
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2780
|
+
* @returns This service instance for method chaining
|
|
2781
|
+
*/
|
|
2782
|
+
setDetailsOrderConfig(config: Partial<SdkConfig>): this;
|
|
2783
|
+
/**
|
|
2784
|
+
* Sets method-level configuration for accountOrder.
|
|
2785
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2786
|
+
* @returns This service instance for method chaining
|
|
2787
|
+
*/
|
|
2788
|
+
setAccountOrderConfig(config: Partial<SdkConfig>): this;
|
|
2789
|
+
/**
|
|
2790
|
+
*
|
|
2791
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2792
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2793
|
+
*/
|
|
2794
|
+
orderList(body: any, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2795
|
+
/**
|
|
2796
|
+
*
|
|
2797
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2798
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2799
|
+
*/
|
|
2800
|
+
detailsOrder(body: DetailsOrderRequest, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2801
|
+
/**
|
|
2802
|
+
*
|
|
2803
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2804
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2805
|
+
*/
|
|
2806
|
+
accountOrder(body: AccountOrderRequest, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2807
|
+
}
|
|
2808
|
+
|
|
2809
|
+
/**
|
|
2810
|
+
* Service class for WsService operations.
|
|
2811
|
+
* Provides methods to interact with WsService-related API endpoints.
|
|
2812
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2813
|
+
*/
|
|
2814
|
+
declare class WsService extends BaseService {
|
|
2815
|
+
protected viaccepConfig: Partial<SdkConfig>;
|
|
2816
|
+
/**
|
|
2817
|
+
* Sets method-level configuration for viaccep.
|
|
2818
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2819
|
+
* @returns This service instance for method chaining
|
|
2820
|
+
*/
|
|
2821
|
+
setViaccepConfig(config: Partial<SdkConfig>): this;
|
|
2822
|
+
/**
|
|
2823
|
+
*
|
|
2824
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2825
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2826
|
+
*/
|
|
2827
|
+
viaccep(requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2828
|
+
}
|
|
2829
|
+
|
|
2830
|
+
interface GetBannerParams {
|
|
2831
|
+
userAgent: string;
|
|
2832
|
+
accept: string;
|
|
2833
|
+
positionId?: string;
|
|
2834
|
+
template?: string;
|
|
2835
|
+
}
|
|
2836
|
+
|
|
2837
|
+
/**
|
|
2838
|
+
* Service class for WidgetService operations.
|
|
2839
|
+
* Provides methods to interact with WidgetService-related API endpoints.
|
|
2840
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2841
|
+
*/
|
|
2842
|
+
declare class WidgetService extends BaseService {
|
|
2843
|
+
protected getBannerConfig: Partial<SdkConfig>;
|
|
2844
|
+
/**
|
|
2845
|
+
* Sets method-level configuration for getBanner.
|
|
2846
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2847
|
+
* @returns This service instance for method chaining
|
|
2848
|
+
*/
|
|
2849
|
+
setGetBannerConfig(config: Partial<SdkConfig>): this;
|
|
2850
|
+
/**
|
|
2851
|
+
*
|
|
2852
|
+
* @param {string} params.userAgent -
|
|
2853
|
+
* @param {string} params.accept -
|
|
2854
|
+
* @param {string} [params.positionId] -
|
|
2855
|
+
* @param {string} [params.template] -
|
|
2856
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2857
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2858
|
+
*/
|
|
2859
|
+
getBanner(params: GetBannerParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2860
|
+
}
|
|
2861
|
+
|
|
2862
|
+
interface OndeEncontrarNossasLojasParams {
|
|
2863
|
+
userAgent: string;
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2866
|
+
/**
|
|
2867
|
+
* Service class for OndeEncontrarJsonService operations.
|
|
2868
|
+
* Provides methods to interact with OndeEncontrarJsonService-related API endpoints.
|
|
2869
|
+
* All methods return promises and handle request/response serialization automatically.
|
|
2870
|
+
*/
|
|
2871
|
+
declare class OndeEncontrarJsonService extends BaseService {
|
|
2872
|
+
protected ondeEncontrarNossasLojasConfig: Partial<SdkConfig>;
|
|
2873
|
+
/**
|
|
2874
|
+
* Sets method-level configuration for ondeEncontrarNossasLojas.
|
|
2875
|
+
* @param config - Partial configuration to override service-level defaults
|
|
2876
|
+
* @returns This service instance for method chaining
|
|
2877
|
+
*/
|
|
2878
|
+
setOndeEncontrarNossasLojasConfig(config: Partial<SdkConfig>): this;
|
|
2879
|
+
/**
|
|
2880
|
+
*
|
|
2881
|
+
* @param {string} params.userAgent -
|
|
2882
|
+
* @param {Partial<SdkConfig>} [requestConfig] - The request configuration for retry and validation.
|
|
2883
|
+
* @returns {Promise<HttpResponse<any>>} - OK
|
|
2884
|
+
*/
|
|
2885
|
+
ondeEncontrarNossasLojas(params: OndeEncontrarNossasLojasParams, requestConfig?: Partial<SdkConfig>): Promise<any>;
|
|
2886
|
+
}
|
|
2887
|
+
|
|
2888
|
+
declare class LinxcommerceWebapiSdk {
|
|
2889
|
+
config: SdkConfig;
|
|
2890
|
+
readonly customers: CustomersService;
|
|
2891
|
+
readonly products: ProductsService;
|
|
2892
|
+
readonly address: AddressService;
|
|
2893
|
+
readonly delivery: DeliveryService;
|
|
2894
|
+
readonly basket: BasketService;
|
|
2895
|
+
readonly checkout: CheckoutService;
|
|
2896
|
+
readonly orders: OrdersService;
|
|
2897
|
+
readonly ws: WsService;
|
|
2898
|
+
readonly widget: WidgetService;
|
|
2899
|
+
readonly ondeEncontrarJson: OndeEncontrarJsonService;
|
|
2900
|
+
constructor(config: SdkConfig);
|
|
2901
|
+
set baseUrl(baseUrl: string);
|
|
2902
|
+
set environment(environment: Environment);
|
|
2903
|
+
set timeoutMs(timeoutMs: number);
|
|
2904
|
+
set username(username: string);
|
|
2905
|
+
set password(password: string);
|
|
2906
|
+
}
|
|
2907
|
+
|
|
2908
|
+
export { AccountOrderRequest, AddressService, Addresses, BasketService, BrandsRequest, CheckoutService, CreateBusinessAccountRequest, CreateBusinessAccountRequestCustomer, CreateConsumerRequest, CreateConsumerRequestCustomer, CustomerContact1, CustomerContact2, CustomersService, DeliveryService, DetailsOrderRequest, Environment, ExtendedProperties, HtmlAttributes, HttpError, HttpMetadata, HttpMethod, HttpResponse, LinxcommerceWebapiSdk, LoginRequest, OndeEncontrarJsonService, OrdersService, ProductsDatasourceRequest, ProductsService, RecoverPasswordRequest, RetornaOpODeEntregaParaOmsRequest, RetryOptions, SdkConfig, ValidationOptions, WidgetService, WsService };
|