doboxa-js 1.0.2 → 1.1.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 +134 -72
- package/dist/{chunk-CGJD4ZO5.mjs → chunk-7RN7PBJH.mjs} +11 -1
- package/dist/chunk-7RN7PBJH.mjs.map +1 -0
- package/dist/{chunk-36DDSV5T.mjs → chunk-RTI5YLAB.mjs} +163 -44
- package/dist/chunk-RTI5YLAB.mjs.map +1 -0
- package/dist/client-BrWpdgrN.d.mts +3024 -0
- package/dist/client-BrWpdgrN.d.ts +3024 -0
- package/dist/client.d.mts +1 -0
- package/dist/client.d.ts +1 -0
- package/dist/client.js +167 -28
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +2 -2
- package/dist/errors-lG5MwUyw.d.mts +176 -0
- package/dist/errors-lG5MwUyw.d.ts +176 -0
- package/dist/errors.d.mts +1 -0
- package/dist/errors.d.ts +1 -0
- package/dist/errors.js +11 -0
- package/dist/errors.js.map +1 -1
- package/dist/errors.mjs +3 -1
- package/dist/index.d.mts +153 -0
- package/dist/index.d.ts +153 -0
- package/dist/index.js +172 -46
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +6 -10
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +2 -0
- package/dist/models.d.ts +2 -0
- package/package.json +1 -1
- package/dist/chunk-36DDSV5T.mjs.map +0 -1
- package/dist/chunk-CGJD4ZO5.mjs.map +0 -1
|
@@ -0,0 +1,3024 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Token manager for handling access tokens and refresh tokens
|
|
3
|
+
*/
|
|
4
|
+
declare class TokenManager {
|
|
5
|
+
private accessToken;
|
|
6
|
+
private refreshToken;
|
|
7
|
+
private tokenExpiry;
|
|
8
|
+
private refreshPromise;
|
|
9
|
+
/**
|
|
10
|
+
* Set tokens and calculate expiry
|
|
11
|
+
*/
|
|
12
|
+
setTokens(accessToken: string, refreshToken: string, expiresIn?: number): void;
|
|
13
|
+
/**
|
|
14
|
+
* Get current access token
|
|
15
|
+
*/
|
|
16
|
+
getAccessToken(): string | null;
|
|
17
|
+
/**
|
|
18
|
+
* Get refresh token
|
|
19
|
+
*/
|
|
20
|
+
getRefreshToken(): string | null;
|
|
21
|
+
/**
|
|
22
|
+
* Check if token is expired or will expire soon
|
|
23
|
+
*/
|
|
24
|
+
isTokenExpired(): boolean;
|
|
25
|
+
/**
|
|
26
|
+
* Clear all tokens
|
|
27
|
+
*/
|
|
28
|
+
clearTokens(): void;
|
|
29
|
+
/**
|
|
30
|
+
* Set refresh promise to prevent concurrent refresh requests
|
|
31
|
+
*/
|
|
32
|
+
setRefreshPromise(promise: Promise<string> | null): void;
|
|
33
|
+
/**
|
|
34
|
+
* Get current refresh promise
|
|
35
|
+
*/
|
|
36
|
+
getRefreshPromise(): Promise<string> | null;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
interface HTTPClientConfig {
|
|
40
|
+
baseURL?: string;
|
|
41
|
+
tokenManager: TokenManager;
|
|
42
|
+
onTokenRefresh?: (token: string) => Promise<string>;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* HTTP client wrapper around fetch with Bearer token injection and error handling
|
|
46
|
+
*/
|
|
47
|
+
declare class HTTPClient {
|
|
48
|
+
private baseURL;
|
|
49
|
+
private tokenManager;
|
|
50
|
+
private onTokenRefresh?;
|
|
51
|
+
constructor(config: HTTPClientConfig);
|
|
52
|
+
/**
|
|
53
|
+
* Make an HTTP request
|
|
54
|
+
*/
|
|
55
|
+
request<T>(path: string, options?: RequestInit): Promise<T>;
|
|
56
|
+
/**
|
|
57
|
+
* GET request
|
|
58
|
+
*/
|
|
59
|
+
get<T>(path: string, options?: RequestInit): Promise<T>;
|
|
60
|
+
/**
|
|
61
|
+
* POST request
|
|
62
|
+
*/
|
|
63
|
+
post<T>(path: string, body?: unknown, options?: RequestInit): Promise<T>;
|
|
64
|
+
/**
|
|
65
|
+
* PUT request
|
|
66
|
+
*/
|
|
67
|
+
put<T>(path: string, body?: unknown, options?: RequestInit): Promise<T>;
|
|
68
|
+
/**
|
|
69
|
+
* DELETE request
|
|
70
|
+
*/
|
|
71
|
+
delete<T>(path: string, options?: RequestInit): Promise<T>;
|
|
72
|
+
/**
|
|
73
|
+
* PATCH request
|
|
74
|
+
*/
|
|
75
|
+
patch<T>(path: string, body?: unknown, options?: RequestInit): Promise<T>;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* API V2
|
|
80
|
+
* API V2
|
|
81
|
+
*
|
|
82
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
86
|
+
* https://openapi-generator.tech
|
|
87
|
+
* Do not edit the class manually.
|
|
88
|
+
*/
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @export
|
|
92
|
+
* @interface ApiV2AuthenticationRefreshTokenPost200Response
|
|
93
|
+
*/
|
|
94
|
+
interface ApiV2AuthenticationRefreshTokenPost200Response {
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof ApiV2AuthenticationRefreshTokenPost200Response
|
|
99
|
+
*/
|
|
100
|
+
token?: string;
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof ApiV2AuthenticationRefreshTokenPost200Response
|
|
105
|
+
*/
|
|
106
|
+
refresh_token?: string;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Check if a given object implements the ApiV2AuthenticationRefreshTokenPost200Response interface.
|
|
110
|
+
*/
|
|
111
|
+
declare function instanceOfApiV2AuthenticationRefreshTokenPost200Response(value: object): value is ApiV2AuthenticationRefreshTokenPost200Response;
|
|
112
|
+
declare function ApiV2AuthenticationRefreshTokenPost200ResponseFromJSON(json: any): ApiV2AuthenticationRefreshTokenPost200Response;
|
|
113
|
+
declare function ApiV2AuthenticationRefreshTokenPost200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiV2AuthenticationRefreshTokenPost200Response;
|
|
114
|
+
declare function ApiV2AuthenticationRefreshTokenPost200ResponseToJSON(json: any): ApiV2AuthenticationRefreshTokenPost200Response;
|
|
115
|
+
declare function ApiV2AuthenticationRefreshTokenPost200ResponseToJSONTyped(value?: ApiV2AuthenticationRefreshTokenPost200Response | null, ignoreDiscriminator?: boolean): any;
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* API V2
|
|
119
|
+
* API V2
|
|
120
|
+
*
|
|
121
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
122
|
+
*
|
|
123
|
+
*
|
|
124
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
125
|
+
* https://openapi-generator.tech
|
|
126
|
+
* Do not edit the class manually.
|
|
127
|
+
*/
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @export
|
|
131
|
+
* @interface ApiV2AuthenticationTokenPost200Response
|
|
132
|
+
*/
|
|
133
|
+
interface ApiV2AuthenticationTokenPost200Response {
|
|
134
|
+
/**
|
|
135
|
+
* JWT token, valid for 3600 seconds (1 hour)
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof ApiV2AuthenticationTokenPost200Response
|
|
138
|
+
*/
|
|
139
|
+
token?: string;
|
|
140
|
+
/**
|
|
141
|
+
* Refresh token, valid for 2592000 seconds (30 days)
|
|
142
|
+
* @type {string}
|
|
143
|
+
* @memberof ApiV2AuthenticationTokenPost200Response
|
|
144
|
+
*/
|
|
145
|
+
refresh_token?: string;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* Check if a given object implements the ApiV2AuthenticationTokenPost200Response interface.
|
|
149
|
+
*/
|
|
150
|
+
declare function instanceOfApiV2AuthenticationTokenPost200Response(value: object): value is ApiV2AuthenticationTokenPost200Response;
|
|
151
|
+
declare function ApiV2AuthenticationTokenPost200ResponseFromJSON(json: any): ApiV2AuthenticationTokenPost200Response;
|
|
152
|
+
declare function ApiV2AuthenticationTokenPost200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiV2AuthenticationTokenPost200Response;
|
|
153
|
+
declare function ApiV2AuthenticationTokenPost200ResponseToJSON(json: any): ApiV2AuthenticationTokenPost200Response;
|
|
154
|
+
declare function ApiV2AuthenticationTokenPost200ResponseToJSONTyped(value?: ApiV2AuthenticationTokenPost200Response | null, ignoreDiscriminator?: boolean): any;
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* API V2
|
|
158
|
+
* API V2
|
|
159
|
+
*
|
|
160
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
161
|
+
*
|
|
162
|
+
*
|
|
163
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
164
|
+
* https://openapi-generator.tech
|
|
165
|
+
* Do not edit the class manually.
|
|
166
|
+
*/
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @export
|
|
170
|
+
* @interface Attachment
|
|
171
|
+
*/
|
|
172
|
+
interface Attachment {
|
|
173
|
+
/**
|
|
174
|
+
* Attachment type
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof Attachment
|
|
177
|
+
*/
|
|
178
|
+
type: string;
|
|
179
|
+
/**
|
|
180
|
+
* Path to a printable file (or file name)
|
|
181
|
+
* @type {string}
|
|
182
|
+
* @memberof Attachment
|
|
183
|
+
*/
|
|
184
|
+
file_path: string;
|
|
185
|
+
/**
|
|
186
|
+
* Order articles (foreign_id) related to this waybill
|
|
187
|
+
* @type {Array<string>}
|
|
188
|
+
* @memberof Attachment
|
|
189
|
+
*/
|
|
190
|
+
articles?: Array<string> | null;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Check if a given object implements the Attachment interface.
|
|
194
|
+
*/
|
|
195
|
+
declare function instanceOfAttachment(value: object): value is Attachment;
|
|
196
|
+
declare function AttachmentFromJSON(json: any): Attachment;
|
|
197
|
+
declare function AttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): Attachment;
|
|
198
|
+
declare function AttachmentToJSON(json: any): Attachment;
|
|
199
|
+
declare function AttachmentToJSONTyped(value?: Attachment | null, ignoreDiscriminator?: boolean): any;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* API V2
|
|
203
|
+
* API V2
|
|
204
|
+
*
|
|
205
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
206
|
+
*
|
|
207
|
+
*
|
|
208
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
209
|
+
* https://openapi-generator.tech
|
|
210
|
+
* Do not edit the class manually.
|
|
211
|
+
*/
|
|
212
|
+
/**
|
|
213
|
+
*
|
|
214
|
+
* @export
|
|
215
|
+
* @interface BillingAddress
|
|
216
|
+
*/
|
|
217
|
+
interface BillingAddress {
|
|
218
|
+
/**
|
|
219
|
+
* Customer's first name
|
|
220
|
+
* @type {string}
|
|
221
|
+
* @memberof BillingAddress
|
|
222
|
+
*/
|
|
223
|
+
first_name: string;
|
|
224
|
+
/**
|
|
225
|
+
* Customer's last name
|
|
226
|
+
* @type {string}
|
|
227
|
+
* @memberof BillingAddress
|
|
228
|
+
*/
|
|
229
|
+
last_name: string;
|
|
230
|
+
/**
|
|
231
|
+
* Additional/company name (for delivery)
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof BillingAddress
|
|
234
|
+
*/
|
|
235
|
+
company_name?: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* Customer's phone number
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof BillingAddress
|
|
240
|
+
*/
|
|
241
|
+
phone_number?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Customer's e-mail address
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof BillingAddress
|
|
246
|
+
*/
|
|
247
|
+
email?: string;
|
|
248
|
+
/**
|
|
249
|
+
* Delivery address
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof BillingAddress
|
|
252
|
+
*/
|
|
253
|
+
address1: string;
|
|
254
|
+
/**
|
|
255
|
+
* Optional additional address line
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof BillingAddress
|
|
258
|
+
*/
|
|
259
|
+
address2?: string | null;
|
|
260
|
+
/**
|
|
261
|
+
* City
|
|
262
|
+
* @type {string}
|
|
263
|
+
* @memberof BillingAddress
|
|
264
|
+
*/
|
|
265
|
+
city: string;
|
|
266
|
+
/**
|
|
267
|
+
* Optional region name (required for delivery to some countries)
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof BillingAddress
|
|
270
|
+
*/
|
|
271
|
+
region?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* Postal code
|
|
274
|
+
* @type {string}
|
|
275
|
+
* @memberof BillingAddress
|
|
276
|
+
*/
|
|
277
|
+
post_code: string;
|
|
278
|
+
/**
|
|
279
|
+
* Country code - ISO 3166 alpha 2
|
|
280
|
+
* @type {string}
|
|
281
|
+
* @memberof BillingAddress
|
|
282
|
+
*/
|
|
283
|
+
country_iso: string;
|
|
284
|
+
/**
|
|
285
|
+
* Tax identification number
|
|
286
|
+
* @type {string}
|
|
287
|
+
* @memberof BillingAddress
|
|
288
|
+
*/
|
|
289
|
+
tax_id?: string | null;
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Check if a given object implements the BillingAddress interface.
|
|
293
|
+
*/
|
|
294
|
+
declare function instanceOfBillingAddress(value: object): value is BillingAddress;
|
|
295
|
+
declare function BillingAddressFromJSON(json: any): BillingAddress;
|
|
296
|
+
declare function BillingAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingAddress;
|
|
297
|
+
declare function BillingAddressToJSON(json: any): BillingAddress;
|
|
298
|
+
declare function BillingAddressToJSONTyped(value?: BillingAddress | null, ignoreDiscriminator?: boolean): any;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* API V2
|
|
302
|
+
* API V2
|
|
303
|
+
*
|
|
304
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
305
|
+
*
|
|
306
|
+
*
|
|
307
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
308
|
+
* https://openapi-generator.tech
|
|
309
|
+
* Do not edit the class manually.
|
|
310
|
+
*/
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
* @export
|
|
314
|
+
* @interface Client
|
|
315
|
+
*/
|
|
316
|
+
interface Client {
|
|
317
|
+
/**
|
|
318
|
+
* Client email
|
|
319
|
+
* @type {string}
|
|
320
|
+
* @memberof Client
|
|
321
|
+
*/
|
|
322
|
+
email?: string;
|
|
323
|
+
/**
|
|
324
|
+
* Client token
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof Client
|
|
327
|
+
*/
|
|
328
|
+
token?: string;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* Check if a given object implements the Client interface.
|
|
332
|
+
*/
|
|
333
|
+
declare function instanceOfClient(value: object): value is Client;
|
|
334
|
+
declare function ClientFromJSON(json: any): Client;
|
|
335
|
+
declare function ClientFromJSONTyped(json: any, ignoreDiscriminator: boolean): Client;
|
|
336
|
+
declare function ClientToJSON(json: any): Client;
|
|
337
|
+
declare function ClientToJSONTyped(value?: Client | null, ignoreDiscriminator?: boolean): any;
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* API V2
|
|
341
|
+
* API V2
|
|
342
|
+
*
|
|
343
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
344
|
+
*
|
|
345
|
+
*
|
|
346
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
347
|
+
* https://openapi-generator.tech
|
|
348
|
+
* Do not edit the class manually.
|
|
349
|
+
*/
|
|
350
|
+
/**
|
|
351
|
+
*
|
|
352
|
+
* @export
|
|
353
|
+
* @interface CreateOrderComment
|
|
354
|
+
*/
|
|
355
|
+
interface CreateOrderComment {
|
|
356
|
+
/**
|
|
357
|
+
* Author type
|
|
358
|
+
* @type {string}
|
|
359
|
+
* @memberof CreateOrderComment
|
|
360
|
+
*/
|
|
361
|
+
author_type: CreateOrderCommentAuthorTypeEnum;
|
|
362
|
+
/**
|
|
363
|
+
* Author type
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof CreateOrderComment
|
|
366
|
+
*/
|
|
367
|
+
author_email: string;
|
|
368
|
+
/**
|
|
369
|
+
* Comment content
|
|
370
|
+
* @type {string}
|
|
371
|
+
* @memberof CreateOrderComment
|
|
372
|
+
*/
|
|
373
|
+
content: string;
|
|
374
|
+
/**
|
|
375
|
+
* Comment creation time
|
|
376
|
+
* @type {Date}
|
|
377
|
+
* @memberof CreateOrderComment
|
|
378
|
+
*/
|
|
379
|
+
created_at: Date;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* @export
|
|
383
|
+
* @enum {string}
|
|
384
|
+
*/
|
|
385
|
+
declare enum CreateOrderCommentAuthorTypeEnum {
|
|
386
|
+
client = "client",
|
|
387
|
+
support = "support"
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* Check if a given object implements the CreateOrderComment interface.
|
|
391
|
+
*/
|
|
392
|
+
declare function instanceOfCreateOrderComment(value: object): value is CreateOrderComment;
|
|
393
|
+
declare function CreateOrderCommentFromJSON(json: any): CreateOrderComment;
|
|
394
|
+
declare function CreateOrderCommentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderComment;
|
|
395
|
+
declare function CreateOrderCommentToJSON(json: any): CreateOrderComment;
|
|
396
|
+
declare function CreateOrderCommentToJSONTyped(value?: CreateOrderComment | null, ignoreDiscriminator?: boolean): any;
|
|
397
|
+
|
|
398
|
+
/**
|
|
399
|
+
* API V2
|
|
400
|
+
* API V2
|
|
401
|
+
*
|
|
402
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
403
|
+
*
|
|
404
|
+
*
|
|
405
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
406
|
+
* https://openapi-generator.tech
|
|
407
|
+
* Do not edit the class manually.
|
|
408
|
+
*/
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @export
|
|
412
|
+
* @interface DeliveryAddress
|
|
413
|
+
*/
|
|
414
|
+
interface DeliveryAddress {
|
|
415
|
+
/**
|
|
416
|
+
* Customer's first name
|
|
417
|
+
* @type {string}
|
|
418
|
+
* @memberof DeliveryAddress
|
|
419
|
+
*/
|
|
420
|
+
first_name: string;
|
|
421
|
+
/**
|
|
422
|
+
* Customer's last name
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof DeliveryAddress
|
|
425
|
+
*/
|
|
426
|
+
last_name: string;
|
|
427
|
+
/**
|
|
428
|
+
* Additional/company name (for delivery)
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof DeliveryAddress
|
|
431
|
+
*/
|
|
432
|
+
company_name?: string | null;
|
|
433
|
+
/**
|
|
434
|
+
* Customer's phone number
|
|
435
|
+
* @type {string}
|
|
436
|
+
* @memberof DeliveryAddress
|
|
437
|
+
*/
|
|
438
|
+
phone_number: string;
|
|
439
|
+
/**
|
|
440
|
+
* Customer's e-mail address
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof DeliveryAddress
|
|
443
|
+
*/
|
|
444
|
+
email: string;
|
|
445
|
+
/**
|
|
446
|
+
* Delivery address
|
|
447
|
+
* @type {string}
|
|
448
|
+
* @memberof DeliveryAddress
|
|
449
|
+
*/
|
|
450
|
+
address1: string;
|
|
451
|
+
/**
|
|
452
|
+
* Optional additional address line
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof DeliveryAddress
|
|
455
|
+
*/
|
|
456
|
+
address2?: string | null;
|
|
457
|
+
/**
|
|
458
|
+
* City
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof DeliveryAddress
|
|
461
|
+
*/
|
|
462
|
+
city: string;
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof DeliveryAddress
|
|
467
|
+
*/
|
|
468
|
+
region?: string | null;
|
|
469
|
+
/**
|
|
470
|
+
* Postal code
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof DeliveryAddress
|
|
473
|
+
*/
|
|
474
|
+
post_code: string;
|
|
475
|
+
/**
|
|
476
|
+
* Country code - ISO 3166 alpha 2
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof DeliveryAddress
|
|
479
|
+
*/
|
|
480
|
+
country_iso: string;
|
|
481
|
+
/**
|
|
482
|
+
* Delivery point (e.g. paczkomat) id
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof DeliveryAddress
|
|
485
|
+
*/
|
|
486
|
+
delivery_point_id?: string | null;
|
|
487
|
+
/**
|
|
488
|
+
* Allegro account id for processing smart orders
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof DeliveryAddress
|
|
491
|
+
*/
|
|
492
|
+
allegro_smart_account_id?: string | null;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* Check if a given object implements the DeliveryAddress interface.
|
|
496
|
+
*/
|
|
497
|
+
declare function instanceOfDeliveryAddress(value: object): value is DeliveryAddress;
|
|
498
|
+
declare function DeliveryAddressFromJSON(json: any): DeliveryAddress;
|
|
499
|
+
declare function DeliveryAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeliveryAddress;
|
|
500
|
+
declare function DeliveryAddressToJSON(json: any): DeliveryAddress;
|
|
501
|
+
declare function DeliveryAddressToJSONTyped(value?: DeliveryAddress | null, ignoreDiscriminator?: boolean): any;
|
|
502
|
+
|
|
503
|
+
/**
|
|
504
|
+
* API V2
|
|
505
|
+
* API V2
|
|
506
|
+
*
|
|
507
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
508
|
+
*
|
|
509
|
+
*
|
|
510
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
511
|
+
* https://openapi-generator.tech
|
|
512
|
+
* Do not edit the class manually.
|
|
513
|
+
*/
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @export
|
|
517
|
+
* @interface GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
518
|
+
*/
|
|
519
|
+
interface GetApiV2DiscountCodesExternal200ResponseItemsInner {
|
|
520
|
+
/**
|
|
521
|
+
* Discount code
|
|
522
|
+
* @type {string}
|
|
523
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
524
|
+
*/
|
|
525
|
+
code?: string;
|
|
526
|
+
/**
|
|
527
|
+
* Discount type
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
530
|
+
*/
|
|
531
|
+
type?: string;
|
|
532
|
+
/**
|
|
533
|
+
* Client associated with the discount
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
536
|
+
*/
|
|
537
|
+
client_email?: string;
|
|
538
|
+
/**
|
|
539
|
+
* Domain associated with the discount
|
|
540
|
+
* @type {string}
|
|
541
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
542
|
+
*/
|
|
543
|
+
domain?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Discount currency
|
|
546
|
+
* @type {string}
|
|
547
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
548
|
+
*/
|
|
549
|
+
currency?: string | null;
|
|
550
|
+
/**
|
|
551
|
+
* Discount amount
|
|
552
|
+
* @type {string}
|
|
553
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
554
|
+
*/
|
|
555
|
+
action?: string;
|
|
556
|
+
/**
|
|
557
|
+
* Discount expiration time
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof GetApiV2DiscountCodesExternal200ResponseItemsInner
|
|
560
|
+
*/
|
|
561
|
+
valid_until?: string | null;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Check if a given object implements the GetApiV2DiscountCodesExternal200ResponseItemsInner interface.
|
|
565
|
+
*/
|
|
566
|
+
declare function instanceOfGetApiV2DiscountCodesExternal200ResponseItemsInner(value: object): value is GetApiV2DiscountCodesExternal200ResponseItemsInner;
|
|
567
|
+
declare function GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSON(json: any): GetApiV2DiscountCodesExternal200ResponseItemsInner;
|
|
568
|
+
declare function GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetApiV2DiscountCodesExternal200ResponseItemsInner;
|
|
569
|
+
declare function GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSON(json: any): GetApiV2DiscountCodesExternal200ResponseItemsInner;
|
|
570
|
+
declare function GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSONTyped(value?: GetApiV2DiscountCodesExternal200ResponseItemsInner | null, ignoreDiscriminator?: boolean): any;
|
|
571
|
+
|
|
572
|
+
/**
|
|
573
|
+
* API V2
|
|
574
|
+
* API V2
|
|
575
|
+
*
|
|
576
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
577
|
+
*
|
|
578
|
+
*
|
|
579
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
580
|
+
* https://openapi-generator.tech
|
|
581
|
+
* Do not edit the class manually.
|
|
582
|
+
*/
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
*
|
|
586
|
+
* @export
|
|
587
|
+
* @interface GetApiV2DiscountCodesExternal200Response
|
|
588
|
+
*/
|
|
589
|
+
interface GetApiV2DiscountCodesExternal200Response {
|
|
590
|
+
/**
|
|
591
|
+
*
|
|
592
|
+
* @type {Array<GetApiV2DiscountCodesExternal200ResponseItemsInner>}
|
|
593
|
+
* @memberof GetApiV2DiscountCodesExternal200Response
|
|
594
|
+
*/
|
|
595
|
+
items?: Array<GetApiV2DiscountCodesExternal200ResponseItemsInner>;
|
|
596
|
+
/**
|
|
597
|
+
* Link to the next page of results
|
|
598
|
+
* @type {string}
|
|
599
|
+
* @memberof GetApiV2DiscountCodesExternal200Response
|
|
600
|
+
*/
|
|
601
|
+
next_page?: string | null;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* Check if a given object implements the GetApiV2DiscountCodesExternal200Response interface.
|
|
605
|
+
*/
|
|
606
|
+
declare function instanceOfGetApiV2DiscountCodesExternal200Response(value: object): value is GetApiV2DiscountCodesExternal200Response;
|
|
607
|
+
declare function GetApiV2DiscountCodesExternal200ResponseFromJSON(json: any): GetApiV2DiscountCodesExternal200Response;
|
|
608
|
+
declare function GetApiV2DiscountCodesExternal200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetApiV2DiscountCodesExternal200Response;
|
|
609
|
+
declare function GetApiV2DiscountCodesExternal200ResponseToJSON(json: any): GetApiV2DiscountCodesExternal200Response;
|
|
610
|
+
declare function GetApiV2DiscountCodesExternal200ResponseToJSONTyped(value?: GetApiV2DiscountCodesExternal200Response | null, ignoreDiscriminator?: boolean): any;
|
|
611
|
+
|
|
612
|
+
/**
|
|
613
|
+
* API V2
|
|
614
|
+
* API V2
|
|
615
|
+
*
|
|
616
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
617
|
+
*
|
|
618
|
+
*
|
|
619
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
620
|
+
* https://openapi-generator.tech
|
|
621
|
+
* Do not edit the class manually.
|
|
622
|
+
*/
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @export
|
|
626
|
+
* @interface InvoiceItem
|
|
627
|
+
*/
|
|
628
|
+
interface InvoiceItem {
|
|
629
|
+
/**
|
|
630
|
+
* Doboxa item id. Can be null if invoice item cannot be mapped to order item.
|
|
631
|
+
* @type {string}
|
|
632
|
+
* @memberof InvoiceItem
|
|
633
|
+
*/
|
|
634
|
+
doboxa_item_id?: string | null;
|
|
635
|
+
/**
|
|
636
|
+
* Order.items.foreign_id provided while creating order. Can be null if invoice item cannot be mapped to order item.
|
|
637
|
+
* @type {string}
|
|
638
|
+
* @memberof InvoiceItem
|
|
639
|
+
*/
|
|
640
|
+
foreign_item_id?: string | null;
|
|
641
|
+
/**
|
|
642
|
+
* Item name
|
|
643
|
+
* @type {string}
|
|
644
|
+
* @memberof InvoiceItem
|
|
645
|
+
*/
|
|
646
|
+
name?: string;
|
|
647
|
+
/**
|
|
648
|
+
* Quantity
|
|
649
|
+
* @type {string}
|
|
650
|
+
* @memberof InvoiceItem
|
|
651
|
+
*/
|
|
652
|
+
qty?: string;
|
|
653
|
+
/**
|
|
654
|
+
* Unit type
|
|
655
|
+
* @type {string}
|
|
656
|
+
* @memberof InvoiceItem
|
|
657
|
+
*/
|
|
658
|
+
unit?: string;
|
|
659
|
+
/**
|
|
660
|
+
* Unit net price
|
|
661
|
+
* @type {string}
|
|
662
|
+
* @memberof InvoiceItem
|
|
663
|
+
*/
|
|
664
|
+
net_unit_price?: string;
|
|
665
|
+
/**
|
|
666
|
+
* Net position value
|
|
667
|
+
* @type {string}
|
|
668
|
+
* @memberof InvoiceItem
|
|
669
|
+
*/
|
|
670
|
+
net_value?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Tax amount
|
|
673
|
+
* @type {string}
|
|
674
|
+
* @memberof InvoiceItem
|
|
675
|
+
*/
|
|
676
|
+
vat_value?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Tax rate
|
|
679
|
+
* @type {string}
|
|
680
|
+
* @memberof InvoiceItem
|
|
681
|
+
*/
|
|
682
|
+
vat_rate?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Currency
|
|
685
|
+
* @type {string}
|
|
686
|
+
* @memberof InvoiceItem
|
|
687
|
+
*/
|
|
688
|
+
currency?: string;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* Check if a given object implements the InvoiceItem interface.
|
|
692
|
+
*/
|
|
693
|
+
declare function instanceOfInvoiceItem(value: object): value is InvoiceItem;
|
|
694
|
+
declare function InvoiceItemFromJSON(json: any): InvoiceItem;
|
|
695
|
+
declare function InvoiceItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceItem;
|
|
696
|
+
declare function InvoiceItemToJSON(json: any): InvoiceItem;
|
|
697
|
+
declare function InvoiceItemToJSONTyped(value?: InvoiceItem | null, ignoreDiscriminator?: boolean): any;
|
|
698
|
+
|
|
699
|
+
/**
|
|
700
|
+
* API V2
|
|
701
|
+
* API V2
|
|
702
|
+
*
|
|
703
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
704
|
+
*
|
|
705
|
+
*
|
|
706
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
707
|
+
* https://openapi-generator.tech
|
|
708
|
+
* Do not edit the class manually.
|
|
709
|
+
*/
|
|
710
|
+
/**
|
|
711
|
+
*
|
|
712
|
+
* @export
|
|
713
|
+
* @interface InvoiceOrderItem
|
|
714
|
+
*/
|
|
715
|
+
interface InvoiceOrderItem {
|
|
716
|
+
/**
|
|
717
|
+
* Order item id
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof InvoiceOrderItem
|
|
720
|
+
*/
|
|
721
|
+
doboxa_item_id?: string | null;
|
|
722
|
+
/**
|
|
723
|
+
* Order item external id
|
|
724
|
+
* @type {string}
|
|
725
|
+
* @memberof InvoiceOrderItem
|
|
726
|
+
*/
|
|
727
|
+
foreign_item_id?: string | null;
|
|
728
|
+
}
|
|
729
|
+
/**
|
|
730
|
+
* Check if a given object implements the InvoiceOrderItem interface.
|
|
731
|
+
*/
|
|
732
|
+
declare function instanceOfInvoiceOrderItem(value: object): value is InvoiceOrderItem;
|
|
733
|
+
declare function InvoiceOrderItemFromJSON(json: any): InvoiceOrderItem;
|
|
734
|
+
declare function InvoiceOrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceOrderItem;
|
|
735
|
+
declare function InvoiceOrderItemToJSON(json: any): InvoiceOrderItem;
|
|
736
|
+
declare function InvoiceOrderItemToJSONTyped(value?: InvoiceOrderItem | null, ignoreDiscriminator?: boolean): any;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* API V2
|
|
740
|
+
* API V2
|
|
741
|
+
*
|
|
742
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
743
|
+
*
|
|
744
|
+
*
|
|
745
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
746
|
+
* https://openapi-generator.tech
|
|
747
|
+
* Do not edit the class manually.
|
|
748
|
+
*/
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @export
|
|
753
|
+
* @interface InvoiceOrder
|
|
754
|
+
*/
|
|
755
|
+
interface InvoiceOrder {
|
|
756
|
+
/**
|
|
757
|
+
* Order id
|
|
758
|
+
* @type {string}
|
|
759
|
+
* @memberof InvoiceOrder
|
|
760
|
+
*/
|
|
761
|
+
doboxa_order_id?: string | null;
|
|
762
|
+
/**
|
|
763
|
+
* Order external id
|
|
764
|
+
* @type {string}
|
|
765
|
+
* @memberof InvoiceOrder
|
|
766
|
+
*/
|
|
767
|
+
external_order_id?: string | null;
|
|
768
|
+
/**
|
|
769
|
+
*
|
|
770
|
+
* @type {Array<InvoiceOrderItem>}
|
|
771
|
+
* @memberof InvoiceOrder
|
|
772
|
+
*/
|
|
773
|
+
items?: Array<InvoiceOrderItem>;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* Check if a given object implements the InvoiceOrder interface.
|
|
777
|
+
*/
|
|
778
|
+
declare function instanceOfInvoiceOrder(value: object): value is InvoiceOrder;
|
|
779
|
+
declare function InvoiceOrderFromJSON(json: any): InvoiceOrder;
|
|
780
|
+
declare function InvoiceOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceOrder;
|
|
781
|
+
declare function InvoiceOrderToJSON(json: any): InvoiceOrder;
|
|
782
|
+
declare function InvoiceOrderToJSONTyped(value?: InvoiceOrder | null, ignoreDiscriminator?: boolean): any;
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* API V2
|
|
786
|
+
* API V2
|
|
787
|
+
*
|
|
788
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
789
|
+
*
|
|
790
|
+
*
|
|
791
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
792
|
+
* https://openapi-generator.tech
|
|
793
|
+
* Do not edit the class manually.
|
|
794
|
+
*/
|
|
795
|
+
|
|
796
|
+
/**
|
|
797
|
+
*
|
|
798
|
+
* @export
|
|
799
|
+
* @interface Invoice
|
|
800
|
+
*/
|
|
801
|
+
interface Invoice {
|
|
802
|
+
/**
|
|
803
|
+
* Invoice id
|
|
804
|
+
* @type {string}
|
|
805
|
+
* @memberof Invoice
|
|
806
|
+
*/
|
|
807
|
+
id?: string;
|
|
808
|
+
/**
|
|
809
|
+
* Client owning the Invoice
|
|
810
|
+
* @type {string}
|
|
811
|
+
* @memberof Invoice
|
|
812
|
+
*/
|
|
813
|
+
client?: string;
|
|
814
|
+
/**
|
|
815
|
+
* Direct link to Invoice PDF file
|
|
816
|
+
* @type {string}
|
|
817
|
+
* @memberof Invoice
|
|
818
|
+
*/
|
|
819
|
+
file?: string;
|
|
820
|
+
/**
|
|
821
|
+
* Invoice payment status
|
|
822
|
+
* @type {string}
|
|
823
|
+
* @memberof Invoice
|
|
824
|
+
*/
|
|
825
|
+
state?: InvoiceStateEnum;
|
|
826
|
+
/**
|
|
827
|
+
* Invoice number
|
|
828
|
+
* @type {string}
|
|
829
|
+
* @memberof Invoice
|
|
830
|
+
*/
|
|
831
|
+
document_number?: string;
|
|
832
|
+
/**
|
|
833
|
+
* Amount to pay
|
|
834
|
+
* @type {number}
|
|
835
|
+
* @memberof Invoice
|
|
836
|
+
*/
|
|
837
|
+
document_amount?: number;
|
|
838
|
+
/**
|
|
839
|
+
* Net amount
|
|
840
|
+
* @type {number}
|
|
841
|
+
* @memberof Invoice
|
|
842
|
+
*/
|
|
843
|
+
net_amount?: number;
|
|
844
|
+
/**
|
|
845
|
+
* Tax amount
|
|
846
|
+
* @type {number}
|
|
847
|
+
* @memberof Invoice
|
|
848
|
+
*/
|
|
849
|
+
tax_amount?: number;
|
|
850
|
+
/**
|
|
851
|
+
* Tax rate
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof Invoice
|
|
854
|
+
*/
|
|
855
|
+
tax_rate?: string | null;
|
|
856
|
+
/**
|
|
857
|
+
* Amount already paid
|
|
858
|
+
* @type {number}
|
|
859
|
+
* @memberof Invoice
|
|
860
|
+
*/
|
|
861
|
+
paid_amount?: number;
|
|
862
|
+
/**
|
|
863
|
+
* Currency
|
|
864
|
+
* @type {string}
|
|
865
|
+
* @memberof Invoice
|
|
866
|
+
*/
|
|
867
|
+
currency?: string;
|
|
868
|
+
/**
|
|
869
|
+
* Date of issue
|
|
870
|
+
* @type {Date}
|
|
871
|
+
* @memberof Invoice
|
|
872
|
+
*/
|
|
873
|
+
date_of_issue?: Date;
|
|
874
|
+
/**
|
|
875
|
+
* Due date
|
|
876
|
+
* @type {Date}
|
|
877
|
+
* @memberof Invoice
|
|
878
|
+
*/
|
|
879
|
+
due_date?: Date;
|
|
880
|
+
/**
|
|
881
|
+
* Document type
|
|
882
|
+
* @type {string}
|
|
883
|
+
* @memberof Invoice
|
|
884
|
+
*/
|
|
885
|
+
document_type?: InvoiceDocumentTypeEnum;
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @type {Array<InvoiceOrder>}
|
|
889
|
+
* @memberof Invoice
|
|
890
|
+
*/
|
|
891
|
+
orders?: Array<InvoiceOrder>;
|
|
892
|
+
/**
|
|
893
|
+
*
|
|
894
|
+
* @type {Array<InvoiceItem>}
|
|
895
|
+
* @memberof Invoice
|
|
896
|
+
*/
|
|
897
|
+
invoice_items?: Array<InvoiceItem>;
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* @export
|
|
901
|
+
* @enum {string}
|
|
902
|
+
*/
|
|
903
|
+
declare enum InvoiceStateEnum {
|
|
904
|
+
PAID = "PAID",
|
|
905
|
+
UNPAID = "UNPAID"
|
|
906
|
+
}
|
|
907
|
+
/**
|
|
908
|
+
* @export
|
|
909
|
+
* @enum {string}
|
|
910
|
+
*/
|
|
911
|
+
declare enum InvoiceDocumentTypeEnum {
|
|
912
|
+
main = "main"
|
|
913
|
+
}
|
|
914
|
+
/**
|
|
915
|
+
* Check if a given object implements the Invoice interface.
|
|
916
|
+
*/
|
|
917
|
+
declare function instanceOfInvoice(value: object): value is Invoice;
|
|
918
|
+
declare function InvoiceFromJSON(json: any): Invoice;
|
|
919
|
+
declare function InvoiceFromJSONTyped(json: any, ignoreDiscriminator: boolean): Invoice;
|
|
920
|
+
declare function InvoiceToJSON(json: any): Invoice;
|
|
921
|
+
declare function InvoiceToJSONTyped(value?: Invoice | null, ignoreDiscriminator?: boolean): any;
|
|
922
|
+
|
|
923
|
+
/**
|
|
924
|
+
* API V2
|
|
925
|
+
* API V2
|
|
926
|
+
*
|
|
927
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
928
|
+
*
|
|
929
|
+
*
|
|
930
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
931
|
+
* https://openapi-generator.tech
|
|
932
|
+
* Do not edit the class manually.
|
|
933
|
+
*/
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @export
|
|
937
|
+
* @interface Me
|
|
938
|
+
*/
|
|
939
|
+
interface Me {
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof Me
|
|
944
|
+
*/
|
|
945
|
+
username?: string;
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* Check if a given object implements the Me interface.
|
|
949
|
+
*/
|
|
950
|
+
declare function instanceOfMe(value: object): value is Me;
|
|
951
|
+
declare function MeFromJSON(json: any): Me;
|
|
952
|
+
declare function MeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Me;
|
|
953
|
+
declare function MeToJSON(json: any): Me;
|
|
954
|
+
declare function MeToJSONTyped(value?: Me | null, ignoreDiscriminator?: boolean): any;
|
|
955
|
+
|
|
956
|
+
/**
|
|
957
|
+
* API V2
|
|
958
|
+
* API V2
|
|
959
|
+
*
|
|
960
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
961
|
+
*
|
|
962
|
+
*
|
|
963
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
964
|
+
* https://openapi-generator.tech
|
|
965
|
+
* Do not edit the class manually.
|
|
966
|
+
*/
|
|
967
|
+
/**
|
|
968
|
+
*
|
|
969
|
+
* @export
|
|
970
|
+
* @interface OrderItemCropData
|
|
971
|
+
*/
|
|
972
|
+
interface OrderItemCropData {
|
|
973
|
+
/**
|
|
974
|
+
*
|
|
975
|
+
* @type {string}
|
|
976
|
+
* @memberof OrderItemCropData
|
|
977
|
+
*/
|
|
978
|
+
left?: string | null;
|
|
979
|
+
/**
|
|
980
|
+
*
|
|
981
|
+
* @type {string}
|
|
982
|
+
* @memberof OrderItemCropData
|
|
983
|
+
*/
|
|
984
|
+
top?: string | null;
|
|
985
|
+
/**
|
|
986
|
+
*
|
|
987
|
+
* @type {string}
|
|
988
|
+
* @memberof OrderItemCropData
|
|
989
|
+
*/
|
|
990
|
+
width?: string | null;
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @type {string}
|
|
994
|
+
* @memberof OrderItemCropData
|
|
995
|
+
*/
|
|
996
|
+
height?: string | null;
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {string}
|
|
1000
|
+
* @memberof OrderItemCropData
|
|
1001
|
+
*/
|
|
1002
|
+
original_photo_width?: string | null;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof OrderItemCropData
|
|
1007
|
+
*/
|
|
1008
|
+
original_photo_height?: string | null;
|
|
1009
|
+
/**
|
|
1010
|
+
* Filter - none, blackwhite, sepia
|
|
1011
|
+
* @type {string}
|
|
1012
|
+
* @memberof OrderItemCropData
|
|
1013
|
+
*/
|
|
1014
|
+
filter?: OrderItemCropDataFilterEnum | null;
|
|
1015
|
+
/**
|
|
1016
|
+
* Reflection - none, vertical, horizontal, both
|
|
1017
|
+
* @type {string}
|
|
1018
|
+
* @memberof OrderItemCropData
|
|
1019
|
+
*/
|
|
1020
|
+
reflection?: OrderItemCropDataReflectionEnum | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Number of degrees to rotate the image clockwise
|
|
1023
|
+
* @type {number}
|
|
1024
|
+
* @memberof OrderItemCropData
|
|
1025
|
+
*/
|
|
1026
|
+
rotation?: number | null;
|
|
1027
|
+
/**
|
|
1028
|
+
* Resize the original image by
|
|
1029
|
+
* @type {string}
|
|
1030
|
+
* @memberof OrderItemCropData
|
|
1031
|
+
*/
|
|
1032
|
+
scale?: string | null;
|
|
1033
|
+
}
|
|
1034
|
+
/**
|
|
1035
|
+
* @export
|
|
1036
|
+
* @enum {string}
|
|
1037
|
+
*/
|
|
1038
|
+
declare enum OrderItemCropDataFilterEnum {
|
|
1039
|
+
none = "none",
|
|
1040
|
+
blackwhite = "blackwhite",
|
|
1041
|
+
sepia = "sepia"
|
|
1042
|
+
}
|
|
1043
|
+
/**
|
|
1044
|
+
* @export
|
|
1045
|
+
* @enum {string}
|
|
1046
|
+
*/
|
|
1047
|
+
declare enum OrderItemCropDataReflectionEnum {
|
|
1048
|
+
none = "none",
|
|
1049
|
+
vertical = "vertical",
|
|
1050
|
+
horizontal = "horizontal",
|
|
1051
|
+
both = "both"
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* Check if a given object implements the OrderItemCropData interface.
|
|
1055
|
+
*/
|
|
1056
|
+
declare function instanceOfOrderItemCropData(value: object): value is OrderItemCropData;
|
|
1057
|
+
declare function OrderItemCropDataFromJSON(json: any): OrderItemCropData;
|
|
1058
|
+
declare function OrderItemCropDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderItemCropData;
|
|
1059
|
+
declare function OrderItemCropDataToJSON(json: any): OrderItemCropData;
|
|
1060
|
+
declare function OrderItemCropDataToJSONTyped(value?: OrderItemCropData | null, ignoreDiscriminator?: boolean): any;
|
|
1061
|
+
|
|
1062
|
+
/**
|
|
1063
|
+
* API V2
|
|
1064
|
+
* API V2
|
|
1065
|
+
*
|
|
1066
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1067
|
+
*
|
|
1068
|
+
*
|
|
1069
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1070
|
+
* https://openapi-generator.tech
|
|
1071
|
+
* Do not edit the class manually.
|
|
1072
|
+
*/
|
|
1073
|
+
/**
|
|
1074
|
+
*
|
|
1075
|
+
* @export
|
|
1076
|
+
* @interface OrderItemOriginalData
|
|
1077
|
+
*/
|
|
1078
|
+
interface OrderItemOriginalData {
|
|
1079
|
+
/**
|
|
1080
|
+
* Original item unit price (gross), 9999 = 99.99
|
|
1081
|
+
* @type {number}
|
|
1082
|
+
* @memberof OrderItemOriginalData
|
|
1083
|
+
*/
|
|
1084
|
+
item_unit_price?: number;
|
|
1085
|
+
/**
|
|
1086
|
+
* Original item value (gross), 9999 = 99.99
|
|
1087
|
+
* @type {number}
|
|
1088
|
+
* @memberof OrderItemOriginalData
|
|
1089
|
+
*/
|
|
1090
|
+
item_value?: number;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* Check if a given object implements the OrderItemOriginalData interface.
|
|
1094
|
+
*/
|
|
1095
|
+
declare function instanceOfOrderItemOriginalData(value: object): value is OrderItemOriginalData;
|
|
1096
|
+
declare function OrderItemOriginalDataFromJSON(json: any): OrderItemOriginalData;
|
|
1097
|
+
declare function OrderItemOriginalDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderItemOriginalData;
|
|
1098
|
+
declare function OrderItemOriginalDataToJSON(json: any): OrderItemOriginalData;
|
|
1099
|
+
declare function OrderItemOriginalDataToJSONTyped(value?: OrderItemOriginalData | null, ignoreDiscriminator?: boolean): any;
|
|
1100
|
+
|
|
1101
|
+
/**
|
|
1102
|
+
* API V2
|
|
1103
|
+
* API V2
|
|
1104
|
+
*
|
|
1105
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1106
|
+
*
|
|
1107
|
+
*
|
|
1108
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1109
|
+
* https://openapi-generator.tech
|
|
1110
|
+
* Do not edit the class manually.
|
|
1111
|
+
*/
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
*
|
|
1115
|
+
* @export
|
|
1116
|
+
* @interface OrderItem
|
|
1117
|
+
*/
|
|
1118
|
+
interface OrderItem {
|
|
1119
|
+
/**
|
|
1120
|
+
* Your order item id
|
|
1121
|
+
* @type {string}
|
|
1122
|
+
* @memberof OrderItem
|
|
1123
|
+
*/
|
|
1124
|
+
foreign_id?: string | null;
|
|
1125
|
+
/**
|
|
1126
|
+
* SKU
|
|
1127
|
+
* @type {string}
|
|
1128
|
+
* @memberof OrderItem
|
|
1129
|
+
*/
|
|
1130
|
+
id: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* Your sku
|
|
1133
|
+
* @type {string}
|
|
1134
|
+
* @memberof OrderItem
|
|
1135
|
+
*/
|
|
1136
|
+
additional_sku?: string | null;
|
|
1137
|
+
/**
|
|
1138
|
+
* Product EAN
|
|
1139
|
+
* @type {string}
|
|
1140
|
+
* @memberof OrderItem
|
|
1141
|
+
*/
|
|
1142
|
+
ean?: string | null;
|
|
1143
|
+
/**
|
|
1144
|
+
* Product symbol code
|
|
1145
|
+
* @type {string}
|
|
1146
|
+
* @memberof OrderItem
|
|
1147
|
+
*/
|
|
1148
|
+
symbol_code?: string | null;
|
|
1149
|
+
/**
|
|
1150
|
+
* Article display name
|
|
1151
|
+
* @type {string}
|
|
1152
|
+
* @memberof OrderItem
|
|
1153
|
+
*/
|
|
1154
|
+
name?: string;
|
|
1155
|
+
/**
|
|
1156
|
+
* Quantity (pieces)
|
|
1157
|
+
* @type {number}
|
|
1158
|
+
* @memberof OrderItem
|
|
1159
|
+
*/
|
|
1160
|
+
qty: number;
|
|
1161
|
+
/**
|
|
1162
|
+
* Sale item price, 9999 = 99.99
|
|
1163
|
+
* @type {number}
|
|
1164
|
+
* @memberof OrderItem
|
|
1165
|
+
*/
|
|
1166
|
+
item_price?: number;
|
|
1167
|
+
/**
|
|
1168
|
+
* Custom print width (in cm)
|
|
1169
|
+
* @type {string}
|
|
1170
|
+
* @memberof OrderItem
|
|
1171
|
+
*/
|
|
1172
|
+
width_in_cm?: string | null;
|
|
1173
|
+
/**
|
|
1174
|
+
* Custom print height (in cm)
|
|
1175
|
+
* @type {string}
|
|
1176
|
+
* @memberof OrderItem
|
|
1177
|
+
*/
|
|
1178
|
+
height_in_cm?: string | null;
|
|
1179
|
+
/**
|
|
1180
|
+
* Custom file path or name (e. g. from FTP server)
|
|
1181
|
+
* @type {string}
|
|
1182
|
+
* @memberof OrderItem
|
|
1183
|
+
*/
|
|
1184
|
+
custom_file?: string | null;
|
|
1185
|
+
/**
|
|
1186
|
+
* Additional custom file path or name (e. g. from FTP server)
|
|
1187
|
+
* @type {string}
|
|
1188
|
+
* @memberof OrderItem
|
|
1189
|
+
*/
|
|
1190
|
+
additional_custom_file?: string | null;
|
|
1191
|
+
/**
|
|
1192
|
+
* Optional additional info about the item
|
|
1193
|
+
* @type {string}
|
|
1194
|
+
* @memberof OrderItem
|
|
1195
|
+
*/
|
|
1196
|
+
additional_info?: string | null;
|
|
1197
|
+
/**
|
|
1198
|
+
*
|
|
1199
|
+
* @type {OrderItemCropData}
|
|
1200
|
+
* @memberof OrderItem
|
|
1201
|
+
*/
|
|
1202
|
+
crop_data?: OrderItemCropData | null;
|
|
1203
|
+
/**
|
|
1204
|
+
*
|
|
1205
|
+
* @type {number}
|
|
1206
|
+
* @memberof OrderItem
|
|
1207
|
+
*/
|
|
1208
|
+
readonly initial_price?: number | null;
|
|
1209
|
+
/**
|
|
1210
|
+
*
|
|
1211
|
+
* @type {number}
|
|
1212
|
+
* @memberof OrderItem
|
|
1213
|
+
*/
|
|
1214
|
+
readonly item_delivery_cost?: number | null;
|
|
1215
|
+
/**
|
|
1216
|
+
*
|
|
1217
|
+
* @type {OrderItemOriginalData}
|
|
1218
|
+
* @memberof OrderItem
|
|
1219
|
+
*/
|
|
1220
|
+
readonly item_original_data?: OrderItemOriginalData | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* PHP's RFC3339_EXTENDED date-time (see https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
|
|
1223
|
+
* @type {Date}
|
|
1224
|
+
* @memberof OrderItem
|
|
1225
|
+
*/
|
|
1226
|
+
fulfillment_date?: Date;
|
|
1227
|
+
/**
|
|
1228
|
+
* Custom file id (to reuse in other orders)
|
|
1229
|
+
* @type {string}
|
|
1230
|
+
* @memberof OrderItem
|
|
1231
|
+
*/
|
|
1232
|
+
custom_file_id?: string | null;
|
|
1233
|
+
/**
|
|
1234
|
+
*
|
|
1235
|
+
* @type {number}
|
|
1236
|
+
* @memberof OrderItem
|
|
1237
|
+
*/
|
|
1238
|
+
readonly item_tax?: number | null;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* Check if a given object implements the OrderItem interface.
|
|
1242
|
+
*/
|
|
1243
|
+
declare function instanceOfOrderItem(value: object): value is OrderItem;
|
|
1244
|
+
declare function OrderItemFromJSON(json: any): OrderItem;
|
|
1245
|
+
declare function OrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderItem;
|
|
1246
|
+
declare function OrderItemToJSON(json: any): OrderItem;
|
|
1247
|
+
declare function OrderItemToJSONTyped(value?: Omit<OrderItem, 'initial_price' | 'item_delivery_cost' | 'item_original_data' | 'item_tax'> | null, ignoreDiscriminator?: boolean): any;
|
|
1248
|
+
|
|
1249
|
+
/**
|
|
1250
|
+
* API V2
|
|
1251
|
+
* API V2
|
|
1252
|
+
*
|
|
1253
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1254
|
+
*
|
|
1255
|
+
*
|
|
1256
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1257
|
+
* https://openapi-generator.tech
|
|
1258
|
+
* Do not edit the class manually.
|
|
1259
|
+
*/
|
|
1260
|
+
/**
|
|
1261
|
+
*
|
|
1262
|
+
* @export
|
|
1263
|
+
* @interface OrderOriginalData
|
|
1264
|
+
*/
|
|
1265
|
+
interface OrderOriginalData {
|
|
1266
|
+
/**
|
|
1267
|
+
* Original/client currency
|
|
1268
|
+
* @type {string}
|
|
1269
|
+
* @memberof OrderOriginalData
|
|
1270
|
+
*/
|
|
1271
|
+
currency?: string | null;
|
|
1272
|
+
/**
|
|
1273
|
+
* Original order sum (gross), 9999 = 99.99
|
|
1274
|
+
* @type {number}
|
|
1275
|
+
* @memberof OrderOriginalData
|
|
1276
|
+
*/
|
|
1277
|
+
order_sum?: number;
|
|
1278
|
+
/**
|
|
1279
|
+
* Original order delivery cost, 999 = 9.99
|
|
1280
|
+
* @type {number}
|
|
1281
|
+
* @memberof OrderOriginalData
|
|
1282
|
+
*/
|
|
1283
|
+
delivery_cost?: number | null;
|
|
1284
|
+
/**
|
|
1285
|
+
* Original order payment cost, 999 = 9.99
|
|
1286
|
+
* @type {number}
|
|
1287
|
+
* @memberof OrderOriginalData
|
|
1288
|
+
*/
|
|
1289
|
+
payment_cost?: number | null;
|
|
1290
|
+
/**
|
|
1291
|
+
* Original order rebate, 999 = 9.99
|
|
1292
|
+
* @type {number}
|
|
1293
|
+
* @memberof OrderOriginalData
|
|
1294
|
+
*/
|
|
1295
|
+
rebate?: number | null;
|
|
1296
|
+
}
|
|
1297
|
+
/**
|
|
1298
|
+
* Check if a given object implements the OrderOriginalData interface.
|
|
1299
|
+
*/
|
|
1300
|
+
declare function instanceOfOrderOriginalData(value: object): value is OrderOriginalData;
|
|
1301
|
+
declare function OrderOriginalDataFromJSON(json: any): OrderOriginalData;
|
|
1302
|
+
declare function OrderOriginalDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderOriginalData;
|
|
1303
|
+
declare function OrderOriginalDataToJSON(json: any): OrderOriginalData;
|
|
1304
|
+
declare function OrderOriginalDataToJSONTyped(value?: OrderOriginalData | null, ignoreDiscriminator?: boolean): any;
|
|
1305
|
+
|
|
1306
|
+
/**
|
|
1307
|
+
* API V2
|
|
1308
|
+
* API V2
|
|
1309
|
+
*
|
|
1310
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1311
|
+
*
|
|
1312
|
+
*
|
|
1313
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1314
|
+
* https://openapi-generator.tech
|
|
1315
|
+
* Do not edit the class manually.
|
|
1316
|
+
*/
|
|
1317
|
+
/**
|
|
1318
|
+
*
|
|
1319
|
+
* @export
|
|
1320
|
+
* @interface Waybill
|
|
1321
|
+
*/
|
|
1322
|
+
interface Waybill {
|
|
1323
|
+
/**
|
|
1324
|
+
* Bill number
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof Waybill
|
|
1327
|
+
*/
|
|
1328
|
+
number?: string | null;
|
|
1329
|
+
/**
|
|
1330
|
+
* Company processing the delivery
|
|
1331
|
+
* @type {string}
|
|
1332
|
+
* @memberof Waybill
|
|
1333
|
+
*/
|
|
1334
|
+
delivery_method?: WaybillDeliveryMethodEnum | null;
|
|
1335
|
+
/**
|
|
1336
|
+
* Path to a printable file (or file name)
|
|
1337
|
+
* @type {string}
|
|
1338
|
+
* @memberof Waybill
|
|
1339
|
+
*/
|
|
1340
|
+
file_path: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* Order articles (foreign_id) related to this waybill
|
|
1343
|
+
* @type {Array<string>}
|
|
1344
|
+
* @memberof Waybill
|
|
1345
|
+
*/
|
|
1346
|
+
articles?: Array<string> | null;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* @export
|
|
1350
|
+
* @enum {string}
|
|
1351
|
+
*/
|
|
1352
|
+
declare enum WaybillDeliveryMethodEnum {
|
|
1353
|
+
dpd = "dpd",
|
|
1354
|
+
dpd_de = "dpd_de",
|
|
1355
|
+
dpd_pl = "dpd_pl",
|
|
1356
|
+
gls = "gls",
|
|
1357
|
+
fedex = "fedex",
|
|
1358
|
+
fedex_pl = "fedex_pl",
|
|
1359
|
+
dhl = "dhl",
|
|
1360
|
+
dhl_de = "dhl_de",
|
|
1361
|
+
ups = "ups",
|
|
1362
|
+
inpost = "inpost",
|
|
1363
|
+
to_resolve_in_erp = "to_resolve_in_erp"
|
|
1364
|
+
}
|
|
1365
|
+
/**
|
|
1366
|
+
* Check if a given object implements the Waybill interface.
|
|
1367
|
+
*/
|
|
1368
|
+
declare function instanceOfWaybill(value: object): value is Waybill;
|
|
1369
|
+
declare function WaybillFromJSON(json: any): Waybill;
|
|
1370
|
+
declare function WaybillFromJSONTyped(json: any, ignoreDiscriminator: boolean): Waybill;
|
|
1371
|
+
declare function WaybillToJSON(json: any): Waybill;
|
|
1372
|
+
declare function WaybillToJSONTyped(value?: Waybill | null, ignoreDiscriminator?: boolean): any;
|
|
1373
|
+
|
|
1374
|
+
/**
|
|
1375
|
+
* API V2
|
|
1376
|
+
* API V2
|
|
1377
|
+
*
|
|
1378
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1379
|
+
*
|
|
1380
|
+
*
|
|
1381
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1382
|
+
* https://openapi-generator.tech
|
|
1383
|
+
* Do not edit the class manually.
|
|
1384
|
+
*/
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
* @export
|
|
1389
|
+
* @interface Order
|
|
1390
|
+
*/
|
|
1391
|
+
interface Order {
|
|
1392
|
+
/**
|
|
1393
|
+
* Your order id
|
|
1394
|
+
* @type {string}
|
|
1395
|
+
* @memberof Order
|
|
1396
|
+
*/
|
|
1397
|
+
external_id?: string;
|
|
1398
|
+
/**
|
|
1399
|
+
*
|
|
1400
|
+
* @type {BillingAddress}
|
|
1401
|
+
* @memberof Order
|
|
1402
|
+
*/
|
|
1403
|
+
readonly billing_address?: BillingAddress | null;
|
|
1404
|
+
/**
|
|
1405
|
+
*
|
|
1406
|
+
* @type {DeliveryAddress}
|
|
1407
|
+
* @memberof Order
|
|
1408
|
+
*/
|
|
1409
|
+
deliver_address: DeliveryAddress;
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
* @type {Array<OrderItem>}
|
|
1413
|
+
* @memberof Order
|
|
1414
|
+
*/
|
|
1415
|
+
items: Array<OrderItem>;
|
|
1416
|
+
/**
|
|
1417
|
+
* PHP's RFC3339_EXTENDED date-time (see https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
|
|
1418
|
+
* @type {Date}
|
|
1419
|
+
* @memberof Order
|
|
1420
|
+
*/
|
|
1421
|
+
order_time: Date;
|
|
1422
|
+
/**
|
|
1423
|
+
* PHP's RFC3339_EXTENDED date-time (see https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.rfc3339-extended)
|
|
1424
|
+
* @type {Date}
|
|
1425
|
+
* @memberof Order
|
|
1426
|
+
*/
|
|
1427
|
+
payment_time?: Date | null;
|
|
1428
|
+
/**
|
|
1429
|
+
* Optional order description
|
|
1430
|
+
* @type {string}
|
|
1431
|
+
* @memberof Order
|
|
1432
|
+
*/
|
|
1433
|
+
info?: string | null;
|
|
1434
|
+
/**
|
|
1435
|
+
* Order channel
|
|
1436
|
+
* @type {string}
|
|
1437
|
+
* @memberof Order
|
|
1438
|
+
*/
|
|
1439
|
+
order_channel: string | null;
|
|
1440
|
+
/**
|
|
1441
|
+
* Order source
|
|
1442
|
+
* @type {string}
|
|
1443
|
+
* @memberof Order
|
|
1444
|
+
*/
|
|
1445
|
+
readonly order_source?: string | null;
|
|
1446
|
+
/**
|
|
1447
|
+
* Currency code (ISO 4217)
|
|
1448
|
+
* @type {string}
|
|
1449
|
+
* @memberof Order
|
|
1450
|
+
*/
|
|
1451
|
+
currency: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* Billing company name/id
|
|
1454
|
+
* @type {string}
|
|
1455
|
+
* @memberof Order
|
|
1456
|
+
*/
|
|
1457
|
+
company_name?: string | null;
|
|
1458
|
+
/**
|
|
1459
|
+
* If set to true, a shipping label is required for every order. Currently it is possible to upload shipping labels via FTP
|
|
1460
|
+
* @type {boolean}
|
|
1461
|
+
* @memberof Order
|
|
1462
|
+
*/
|
|
1463
|
+
own_delivery?: boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* Discount code
|
|
1466
|
+
* @type {string}
|
|
1467
|
+
* @memberof Order
|
|
1468
|
+
*/
|
|
1469
|
+
readonly discount_code?: string | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* Partner code
|
|
1472
|
+
* @type {string}
|
|
1473
|
+
* @memberof Order
|
|
1474
|
+
*/
|
|
1475
|
+
readonly partner_code?: string | null;
|
|
1476
|
+
/**
|
|
1477
|
+
*
|
|
1478
|
+
* @type {OrderOriginalData}
|
|
1479
|
+
* @memberof Order
|
|
1480
|
+
*/
|
|
1481
|
+
readonly order_original_data?: OrderOriginalData | null;
|
|
1482
|
+
/**
|
|
1483
|
+
* Original order payment method
|
|
1484
|
+
* @type {string}
|
|
1485
|
+
* @memberof Order
|
|
1486
|
+
*/
|
|
1487
|
+
readonly payment_method?: OrderPaymentMethodEnum | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* Payment transaction id
|
|
1490
|
+
* @type {string}
|
|
1491
|
+
* @memberof Order
|
|
1492
|
+
*/
|
|
1493
|
+
readonly payment_transaction_id?: string | null;
|
|
1494
|
+
/**
|
|
1495
|
+
*
|
|
1496
|
+
* @type {boolean}
|
|
1497
|
+
* @memberof Order
|
|
1498
|
+
*/
|
|
1499
|
+
readonly ag_invoice_requested?: boolean | null;
|
|
1500
|
+
/**
|
|
1501
|
+
*
|
|
1502
|
+
* @type {Array<Waybill>}
|
|
1503
|
+
* @memberof Order
|
|
1504
|
+
*/
|
|
1505
|
+
waybills?: Array<Waybill>;
|
|
1506
|
+
/**
|
|
1507
|
+
*
|
|
1508
|
+
* @type {Array<Attachment>}
|
|
1509
|
+
* @memberof Order
|
|
1510
|
+
*/
|
|
1511
|
+
attachments?: Array<Attachment>;
|
|
1512
|
+
/**
|
|
1513
|
+
* Suggest delivery method (may be taken into consideration according to business agreements)
|
|
1514
|
+
* @type {string}
|
|
1515
|
+
* @memberof Order
|
|
1516
|
+
*/
|
|
1517
|
+
readonly suggested_delivery_method?: string | null;
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* @export
|
|
1521
|
+
* @enum {string}
|
|
1522
|
+
*/
|
|
1523
|
+
declare enum OrderPaymentMethodEnum {
|
|
1524
|
+
gotwka = "got\u00F3wka",
|
|
1525
|
+
przelew = "przelew",
|
|
1526
|
+
karta = "karta",
|
|
1527
|
+
Przelewy_24 = "Przelewy 24",
|
|
1528
|
+
PayU = "PayU",
|
|
1529
|
+
PayU_DE = "PayU DE",
|
|
1530
|
+
PayU_EN = "PayU EN",
|
|
1531
|
+
PayU_PL = "PayU PL",
|
|
1532
|
+
Kompensata = "Kompensata",
|
|
1533
|
+
PayPal = "PayPal",
|
|
1534
|
+
Raty_PayU = "Raty PayU",
|
|
1535
|
+
pobranie = "pobranie",
|
|
1536
|
+
amazon = "amazon",
|
|
1537
|
+
allegro = "allegro",
|
|
1538
|
+
Allegro_PayU = "Allegro PayU",
|
|
1539
|
+
Allegro_P24 = "Allegro P24",
|
|
1540
|
+
etsy = "etsy",
|
|
1541
|
+
emag_ro = "emag.ro",
|
|
1542
|
+
emag_hu = "emag.hu",
|
|
1543
|
+
real = "real",
|
|
1544
|
+
ebay = "ebay",
|
|
1545
|
+
stripe = "stripe",
|
|
1546
|
+
BRW = "BRW",
|
|
1547
|
+
eMag_bg = "eMag.bg",
|
|
1548
|
+
Empik = "Empik",
|
|
1549
|
+
Homeyou = "Home&you",
|
|
1550
|
+
Home24 = "Home24",
|
|
1551
|
+
Kaufland = "Kaufland",
|
|
1552
|
+
Erli = "Erli",
|
|
1553
|
+
Leroy_Merlin = "Leroy Merlin",
|
|
1554
|
+
Castorama = "Castorama",
|
|
1555
|
+
Vivre = "Vivre",
|
|
1556
|
+
Vilandy = "Vilandy",
|
|
1557
|
+
Pigu = "Pigu",
|
|
1558
|
+
Fruugo = "Fruugo",
|
|
1559
|
+
Hood = "Hood",
|
|
1560
|
+
XXXLutz = "XXXLutz",
|
|
1561
|
+
BricoDepot = "BricoDepot",
|
|
1562
|
+
Adyen = "Adyen",
|
|
1563
|
+
Mirakl = "Mirakl",
|
|
1564
|
+
Payoneer = "Payoneer",
|
|
1565
|
+
Hitmeister = "Hitmeister"
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* Check if a given object implements the Order interface.
|
|
1569
|
+
*/
|
|
1570
|
+
declare function instanceOfOrder(value: object): value is Order;
|
|
1571
|
+
declare function OrderFromJSON(json: any): Order;
|
|
1572
|
+
declare function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Order;
|
|
1573
|
+
declare function OrderToJSON(json: any): Order;
|
|
1574
|
+
declare function OrderToJSONTyped(value?: Omit<Order, 'billing_address' | 'order_source' | 'discount_code' | 'partner_code' | 'order_original_data' | 'payment_method' | 'payment_transaction_id' | 'ag_invoice_requested' | 'suggested_delivery_method'> | null, ignoreDiscriminator?: boolean): any;
|
|
1575
|
+
|
|
1576
|
+
/**
|
|
1577
|
+
* API V2
|
|
1578
|
+
* API V2
|
|
1579
|
+
*
|
|
1580
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1581
|
+
*
|
|
1582
|
+
*
|
|
1583
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1584
|
+
* https://openapi-generator.tech
|
|
1585
|
+
* Do not edit the class manually.
|
|
1586
|
+
*/
|
|
1587
|
+
/**
|
|
1588
|
+
*
|
|
1589
|
+
* @export
|
|
1590
|
+
* @interface OrderCancellationResponse
|
|
1591
|
+
*/
|
|
1592
|
+
interface OrderCancellationResponse {
|
|
1593
|
+
/**
|
|
1594
|
+
* Cancellation result
|
|
1595
|
+
* @type {boolean}
|
|
1596
|
+
* @memberof OrderCancellationResponse
|
|
1597
|
+
*/
|
|
1598
|
+
cancelled?: boolean;
|
|
1599
|
+
/**
|
|
1600
|
+
* Additional details regarding the cancellation process
|
|
1601
|
+
* @type {string}
|
|
1602
|
+
* @memberof OrderCancellationResponse
|
|
1603
|
+
*/
|
|
1604
|
+
details?: OrderCancellationResponseDetailsEnum;
|
|
1605
|
+
}
|
|
1606
|
+
/**
|
|
1607
|
+
* @export
|
|
1608
|
+
* @enum {string}
|
|
1609
|
+
*/
|
|
1610
|
+
declare enum OrderCancellationResponseDetailsEnum {
|
|
1611
|
+
cancelled = "cancelled",
|
|
1612
|
+
already_in_production = "already_in_production"
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
* Check if a given object implements the OrderCancellationResponse interface.
|
|
1616
|
+
*/
|
|
1617
|
+
declare function instanceOfOrderCancellationResponse(value: object): value is OrderCancellationResponse;
|
|
1618
|
+
declare function OrderCancellationResponseFromJSON(json: any): OrderCancellationResponse;
|
|
1619
|
+
declare function OrderCancellationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderCancellationResponse;
|
|
1620
|
+
declare function OrderCancellationResponseToJSON(json: any): OrderCancellationResponse;
|
|
1621
|
+
declare function OrderCancellationResponseToJSONTyped(value?: OrderCancellationResponse | null, ignoreDiscriminator?: boolean): any;
|
|
1622
|
+
|
|
1623
|
+
/**
|
|
1624
|
+
* API V2
|
|
1625
|
+
* API V2
|
|
1626
|
+
*
|
|
1627
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1628
|
+
*
|
|
1629
|
+
*
|
|
1630
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1631
|
+
* https://openapi-generator.tech
|
|
1632
|
+
* Do not edit the class manually.
|
|
1633
|
+
*/
|
|
1634
|
+
/**
|
|
1635
|
+
*
|
|
1636
|
+
* @export
|
|
1637
|
+
* @interface OrderComment
|
|
1638
|
+
*/
|
|
1639
|
+
interface OrderComment {
|
|
1640
|
+
/**
|
|
1641
|
+
* Doboxa comment id
|
|
1642
|
+
* @type {string}
|
|
1643
|
+
* @memberof OrderComment
|
|
1644
|
+
*/
|
|
1645
|
+
comment_id?: string;
|
|
1646
|
+
/**
|
|
1647
|
+
* Author type
|
|
1648
|
+
* @type {string}
|
|
1649
|
+
* @memberof OrderComment
|
|
1650
|
+
*/
|
|
1651
|
+
author_type?: OrderCommentAuthorTypeEnum;
|
|
1652
|
+
/**
|
|
1653
|
+
* Comment author. Can be empty
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof OrderComment
|
|
1656
|
+
*/
|
|
1657
|
+
author?: string | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Comment content
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof OrderComment
|
|
1662
|
+
*/
|
|
1663
|
+
content?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Comment creation time
|
|
1666
|
+
* @type {Date}
|
|
1667
|
+
* @memberof OrderComment
|
|
1668
|
+
*/
|
|
1669
|
+
created_at?: Date;
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* @export
|
|
1673
|
+
* @enum {string}
|
|
1674
|
+
*/
|
|
1675
|
+
declare enum OrderCommentAuthorTypeEnum {
|
|
1676
|
+
client = "client",
|
|
1677
|
+
support = "support"
|
|
1678
|
+
}
|
|
1679
|
+
/**
|
|
1680
|
+
* Check if a given object implements the OrderComment interface.
|
|
1681
|
+
*/
|
|
1682
|
+
declare function instanceOfOrderComment(value: object): value is OrderComment;
|
|
1683
|
+
declare function OrderCommentFromJSON(json: any): OrderComment;
|
|
1684
|
+
declare function OrderCommentFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderComment;
|
|
1685
|
+
declare function OrderCommentToJSON(json: any): OrderComment;
|
|
1686
|
+
declare function OrderCommentToJSONTyped(value?: OrderComment | null, ignoreDiscriminator?: boolean): any;
|
|
1687
|
+
|
|
1688
|
+
/**
|
|
1689
|
+
* API V2
|
|
1690
|
+
* API V2
|
|
1691
|
+
*
|
|
1692
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1693
|
+
*
|
|
1694
|
+
*
|
|
1695
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1696
|
+
* https://openapi-generator.tech
|
|
1697
|
+
* Do not edit the class manually.
|
|
1698
|
+
*/
|
|
1699
|
+
/**
|
|
1700
|
+
*
|
|
1701
|
+
* @export
|
|
1702
|
+
* @interface OrderItemStatus
|
|
1703
|
+
*/
|
|
1704
|
+
interface OrderItemStatus {
|
|
1705
|
+
/**
|
|
1706
|
+
* Id assigned to order by doboxa (returned after successful order creation)
|
|
1707
|
+
* @type {string}
|
|
1708
|
+
* @memberof OrderItemStatus
|
|
1709
|
+
*/
|
|
1710
|
+
doboxa_order_id?: string;
|
|
1711
|
+
/**
|
|
1712
|
+
* Id provided in external_id during order creation
|
|
1713
|
+
* @type {string}
|
|
1714
|
+
* @memberof OrderItemStatus
|
|
1715
|
+
*/
|
|
1716
|
+
external_order_id?: string | null;
|
|
1717
|
+
/**
|
|
1718
|
+
* Item id assigned to item by doboxa
|
|
1719
|
+
* @type {string}
|
|
1720
|
+
* @memberof OrderItemStatus
|
|
1721
|
+
*/
|
|
1722
|
+
doboxa_item_id?: string | null;
|
|
1723
|
+
/**
|
|
1724
|
+
* Id provided in items.foreign_id during order creation
|
|
1725
|
+
* @type {string}
|
|
1726
|
+
* @memberof OrderItemStatus
|
|
1727
|
+
*/
|
|
1728
|
+
foreign_item_id?: string | null;
|
|
1729
|
+
/**
|
|
1730
|
+
* SKU of the product related to this item
|
|
1731
|
+
* @type {string}
|
|
1732
|
+
* @memberof OrderItemStatus
|
|
1733
|
+
*/
|
|
1734
|
+
product_sku?: string | null;
|
|
1735
|
+
/**
|
|
1736
|
+
* Product status
|
|
1737
|
+
* @type {string}
|
|
1738
|
+
* @memberof OrderItemStatus
|
|
1739
|
+
*/
|
|
1740
|
+
status?: OrderItemStatusStatusEnum;
|
|
1741
|
+
}
|
|
1742
|
+
/**
|
|
1743
|
+
* @export
|
|
1744
|
+
* @enum {string}
|
|
1745
|
+
*/
|
|
1746
|
+
declare enum OrderItemStatusStatusEnum {
|
|
1747
|
+
new = "new",
|
|
1748
|
+
wait_for_payment = "wait_for_payment",
|
|
1749
|
+
paid = "paid",
|
|
1750
|
+
in_progress = "in_progress",
|
|
1751
|
+
ready_to_be_sent = "ready_to_be_sent",
|
|
1752
|
+
sent = "sent",
|
|
1753
|
+
cancelled = "cancelled",
|
|
1754
|
+
hold = "hold",
|
|
1755
|
+
refund = "refund"
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* Check if a given object implements the OrderItemStatus interface.
|
|
1759
|
+
*/
|
|
1760
|
+
declare function instanceOfOrderItemStatus(value: object): value is OrderItemStatus;
|
|
1761
|
+
declare function OrderItemStatusFromJSON(json: any): OrderItemStatus;
|
|
1762
|
+
declare function OrderItemStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderItemStatus;
|
|
1763
|
+
declare function OrderItemStatusToJSON(json: any): OrderItemStatus;
|
|
1764
|
+
declare function OrderItemStatusToJSONTyped(value?: OrderItemStatus | null, ignoreDiscriminator?: boolean): any;
|
|
1765
|
+
|
|
1766
|
+
/**
|
|
1767
|
+
* API V2
|
|
1768
|
+
* API V2
|
|
1769
|
+
*
|
|
1770
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1771
|
+
*
|
|
1772
|
+
*
|
|
1773
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1774
|
+
* https://openapi-generator.tech
|
|
1775
|
+
* Do not edit the class manually.
|
|
1776
|
+
*/
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
*
|
|
1780
|
+
* @export
|
|
1781
|
+
* @interface OrderStatus
|
|
1782
|
+
*/
|
|
1783
|
+
interface OrderStatus {
|
|
1784
|
+
/**
|
|
1785
|
+
* Order status
|
|
1786
|
+
* @type {string}
|
|
1787
|
+
* @memberof OrderStatus
|
|
1788
|
+
*/
|
|
1789
|
+
status?: OrderStatusStatusEnum;
|
|
1790
|
+
/**
|
|
1791
|
+
* Order items status
|
|
1792
|
+
* @type {Array<OrderItemStatus>}
|
|
1793
|
+
* @memberof OrderStatus
|
|
1794
|
+
*/
|
|
1795
|
+
item_status?: Array<OrderItemStatus>;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* @export
|
|
1799
|
+
* @enum {string}
|
|
1800
|
+
*/
|
|
1801
|
+
declare enum OrderStatusStatusEnum {
|
|
1802
|
+
new = "new",
|
|
1803
|
+
wait_for_payment = "wait_for_payment",
|
|
1804
|
+
paid = "paid",
|
|
1805
|
+
in_progress = "in_progress",
|
|
1806
|
+
ready_to_be_sent = "ready_to_be_sent",
|
|
1807
|
+
sent = "sent",
|
|
1808
|
+
cancelled = "cancelled",
|
|
1809
|
+
hold = "hold",
|
|
1810
|
+
refund = "refund"
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* Check if a given object implements the OrderStatus interface.
|
|
1814
|
+
*/
|
|
1815
|
+
declare function instanceOfOrderStatus(value: object): value is OrderStatus;
|
|
1816
|
+
declare function OrderStatusFromJSON(json: any): OrderStatus;
|
|
1817
|
+
declare function OrderStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderStatus;
|
|
1818
|
+
declare function OrderStatusToJSON(json: any): OrderStatus;
|
|
1819
|
+
declare function OrderStatusToJSONTyped(value?: OrderStatus | null, ignoreDiscriminator?: boolean): any;
|
|
1820
|
+
|
|
1821
|
+
/**
|
|
1822
|
+
* API V2
|
|
1823
|
+
* API V2
|
|
1824
|
+
*
|
|
1825
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1826
|
+
*
|
|
1827
|
+
*
|
|
1828
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1829
|
+
* https://openapi-generator.tech
|
|
1830
|
+
* Do not edit the class manually.
|
|
1831
|
+
*/
|
|
1832
|
+
|
|
1833
|
+
/**
|
|
1834
|
+
*
|
|
1835
|
+
* @export
|
|
1836
|
+
* @interface OrderStatusChange
|
|
1837
|
+
*/
|
|
1838
|
+
interface OrderStatusChange {
|
|
1839
|
+
/**
|
|
1840
|
+
* Doboxa order id
|
|
1841
|
+
* @type {string}
|
|
1842
|
+
* @memberof OrderStatusChange
|
|
1843
|
+
*/
|
|
1844
|
+
order_id?: string;
|
|
1845
|
+
/**
|
|
1846
|
+
* Order status
|
|
1847
|
+
* @type {string}
|
|
1848
|
+
* @memberof OrderStatusChange
|
|
1849
|
+
*/
|
|
1850
|
+
status?: OrderStatusChangeStatusEnum;
|
|
1851
|
+
/**
|
|
1852
|
+
* Order status change time
|
|
1853
|
+
* @type {Date}
|
|
1854
|
+
* @memberof OrderStatusChange
|
|
1855
|
+
*/
|
|
1856
|
+
change_time?: Date;
|
|
1857
|
+
/**
|
|
1858
|
+
* Order items status
|
|
1859
|
+
* @type {Array<OrderItemStatus>}
|
|
1860
|
+
* @memberof OrderStatusChange
|
|
1861
|
+
*/
|
|
1862
|
+
item_status?: Array<OrderItemStatus>;
|
|
1863
|
+
}
|
|
1864
|
+
/**
|
|
1865
|
+
* @export
|
|
1866
|
+
* @enum {string}
|
|
1867
|
+
*/
|
|
1868
|
+
declare enum OrderStatusChangeStatusEnum {
|
|
1869
|
+
new = "new",
|
|
1870
|
+
wait_for_payment = "wait_for_payment",
|
|
1871
|
+
paid = "paid",
|
|
1872
|
+
in_progress = "in_progress",
|
|
1873
|
+
ready_to_be_sent = "ready_to_be_sent",
|
|
1874
|
+
sent = "sent",
|
|
1875
|
+
cancelled = "cancelled",
|
|
1876
|
+
hold = "hold",
|
|
1877
|
+
refund = "refund"
|
|
1878
|
+
}
|
|
1879
|
+
/**
|
|
1880
|
+
* Check if a given object implements the OrderStatusChange interface.
|
|
1881
|
+
*/
|
|
1882
|
+
declare function instanceOfOrderStatusChange(value: object): value is OrderStatusChange;
|
|
1883
|
+
declare function OrderStatusChangeFromJSON(json: any): OrderStatusChange;
|
|
1884
|
+
declare function OrderStatusChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderStatusChange;
|
|
1885
|
+
declare function OrderStatusChangeToJSON(json: any): OrderStatusChange;
|
|
1886
|
+
declare function OrderStatusChangeToJSONTyped(value?: OrderStatusChange | null, ignoreDiscriminator?: boolean): any;
|
|
1887
|
+
|
|
1888
|
+
/**
|
|
1889
|
+
* API V2
|
|
1890
|
+
* API V2
|
|
1891
|
+
*
|
|
1892
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1893
|
+
*
|
|
1894
|
+
*
|
|
1895
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1896
|
+
* https://openapi-generator.tech
|
|
1897
|
+
* Do not edit the class manually.
|
|
1898
|
+
*/
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
*
|
|
1902
|
+
* @export
|
|
1903
|
+
* @interface PageOfClients
|
|
1904
|
+
*/
|
|
1905
|
+
interface PageOfClients {
|
|
1906
|
+
/**
|
|
1907
|
+
*
|
|
1908
|
+
* @type {Array<Client>}
|
|
1909
|
+
* @memberof PageOfClients
|
|
1910
|
+
*/
|
|
1911
|
+
items?: Array<Client>;
|
|
1912
|
+
/**
|
|
1913
|
+
*
|
|
1914
|
+
* @type {string}
|
|
1915
|
+
* @memberof PageOfClients
|
|
1916
|
+
*/
|
|
1917
|
+
next_page?: string | null;
|
|
1918
|
+
}
|
|
1919
|
+
/**
|
|
1920
|
+
* Check if a given object implements the PageOfClients interface.
|
|
1921
|
+
*/
|
|
1922
|
+
declare function instanceOfPageOfClients(value: object): value is PageOfClients;
|
|
1923
|
+
declare function PageOfClientsFromJSON(json: any): PageOfClients;
|
|
1924
|
+
declare function PageOfClientsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageOfClients;
|
|
1925
|
+
declare function PageOfClientsToJSON(json: any): PageOfClients;
|
|
1926
|
+
declare function PageOfClientsToJSONTyped(value?: PageOfClients | null, ignoreDiscriminator?: boolean): any;
|
|
1927
|
+
|
|
1928
|
+
/**
|
|
1929
|
+
* API V2
|
|
1930
|
+
* API V2
|
|
1931
|
+
*
|
|
1932
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1933
|
+
*
|
|
1934
|
+
*
|
|
1935
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1936
|
+
* https://openapi-generator.tech
|
|
1937
|
+
* Do not edit the class manually.
|
|
1938
|
+
*/
|
|
1939
|
+
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
* @export
|
|
1943
|
+
* @interface PageOfInvoices
|
|
1944
|
+
*/
|
|
1945
|
+
interface PageOfInvoices {
|
|
1946
|
+
/**
|
|
1947
|
+
*
|
|
1948
|
+
* @type {Array<Invoice>}
|
|
1949
|
+
* @memberof PageOfInvoices
|
|
1950
|
+
*/
|
|
1951
|
+
items?: Array<Invoice>;
|
|
1952
|
+
/**
|
|
1953
|
+
*
|
|
1954
|
+
* @type {string}
|
|
1955
|
+
* @memberof PageOfInvoices
|
|
1956
|
+
*/
|
|
1957
|
+
next_page?: string | null;
|
|
1958
|
+
}
|
|
1959
|
+
/**
|
|
1960
|
+
* Check if a given object implements the PageOfInvoices interface.
|
|
1961
|
+
*/
|
|
1962
|
+
declare function instanceOfPageOfInvoices(value: object): value is PageOfInvoices;
|
|
1963
|
+
declare function PageOfInvoicesFromJSON(json: any): PageOfInvoices;
|
|
1964
|
+
declare function PageOfInvoicesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageOfInvoices;
|
|
1965
|
+
declare function PageOfInvoicesToJSON(json: any): PageOfInvoices;
|
|
1966
|
+
declare function PageOfInvoicesToJSONTyped(value?: PageOfInvoices | null, ignoreDiscriminator?: boolean): any;
|
|
1967
|
+
|
|
1968
|
+
/**
|
|
1969
|
+
* API V2
|
|
1970
|
+
* API V2
|
|
1971
|
+
*
|
|
1972
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
1973
|
+
*
|
|
1974
|
+
*
|
|
1975
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1976
|
+
* https://openapi-generator.tech
|
|
1977
|
+
* Do not edit the class manually.
|
|
1978
|
+
*/
|
|
1979
|
+
|
|
1980
|
+
/**
|
|
1981
|
+
*
|
|
1982
|
+
* @export
|
|
1983
|
+
* @interface PageOfOrderComments
|
|
1984
|
+
*/
|
|
1985
|
+
interface PageOfOrderComments {
|
|
1986
|
+
/**
|
|
1987
|
+
*
|
|
1988
|
+
* @type {Array<OrderComment>}
|
|
1989
|
+
* @memberof PageOfOrderComments
|
|
1990
|
+
*/
|
|
1991
|
+
items?: Array<OrderComment>;
|
|
1992
|
+
/**
|
|
1993
|
+
*
|
|
1994
|
+
* @type {string}
|
|
1995
|
+
* @memberof PageOfOrderComments
|
|
1996
|
+
*/
|
|
1997
|
+
next_page?: string | null;
|
|
1998
|
+
}
|
|
1999
|
+
/**
|
|
2000
|
+
* Check if a given object implements the PageOfOrderComments interface.
|
|
2001
|
+
*/
|
|
2002
|
+
declare function instanceOfPageOfOrderComments(value: object): value is PageOfOrderComments;
|
|
2003
|
+
declare function PageOfOrderCommentsFromJSON(json: any): PageOfOrderComments;
|
|
2004
|
+
declare function PageOfOrderCommentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageOfOrderComments;
|
|
2005
|
+
declare function PageOfOrderCommentsToJSON(json: any): PageOfOrderComments;
|
|
2006
|
+
declare function PageOfOrderCommentsToJSONTyped(value?: PageOfOrderComments | null, ignoreDiscriminator?: boolean): any;
|
|
2007
|
+
|
|
2008
|
+
/**
|
|
2009
|
+
* API V2
|
|
2010
|
+
* API V2
|
|
2011
|
+
*
|
|
2012
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2013
|
+
*
|
|
2014
|
+
*
|
|
2015
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2016
|
+
* https://openapi-generator.tech
|
|
2017
|
+
* Do not edit the class manually.
|
|
2018
|
+
*/
|
|
2019
|
+
|
|
2020
|
+
/**
|
|
2021
|
+
*
|
|
2022
|
+
* @export
|
|
2023
|
+
* @interface PageOfOrderStatusChanges
|
|
2024
|
+
*/
|
|
2025
|
+
interface PageOfOrderStatusChanges {
|
|
2026
|
+
/**
|
|
2027
|
+
*
|
|
2028
|
+
* @type {Array<OrderStatusChange>}
|
|
2029
|
+
* @memberof PageOfOrderStatusChanges
|
|
2030
|
+
*/
|
|
2031
|
+
items?: Array<OrderStatusChange>;
|
|
2032
|
+
/**
|
|
2033
|
+
*
|
|
2034
|
+
* @type {string}
|
|
2035
|
+
* @memberof PageOfOrderStatusChanges
|
|
2036
|
+
*/
|
|
2037
|
+
next_page?: string | null;
|
|
2038
|
+
}
|
|
2039
|
+
/**
|
|
2040
|
+
* Check if a given object implements the PageOfOrderStatusChanges interface.
|
|
2041
|
+
*/
|
|
2042
|
+
declare function instanceOfPageOfOrderStatusChanges(value: object): value is PageOfOrderStatusChanges;
|
|
2043
|
+
declare function PageOfOrderStatusChangesFromJSON(json: any): PageOfOrderStatusChanges;
|
|
2044
|
+
declare function PageOfOrderStatusChangesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageOfOrderStatusChanges;
|
|
2045
|
+
declare function PageOfOrderStatusChangesToJSON(json: any): PageOfOrderStatusChanges;
|
|
2046
|
+
declare function PageOfOrderStatusChangesToJSONTyped(value?: PageOfOrderStatusChanges | null, ignoreDiscriminator?: boolean): any;
|
|
2047
|
+
|
|
2048
|
+
/**
|
|
2049
|
+
* API V2
|
|
2050
|
+
* API V2
|
|
2051
|
+
*
|
|
2052
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2053
|
+
*
|
|
2054
|
+
*
|
|
2055
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2056
|
+
* https://openapi-generator.tech
|
|
2057
|
+
* Do not edit the class manually.
|
|
2058
|
+
*/
|
|
2059
|
+
/**
|
|
2060
|
+
*
|
|
2061
|
+
* @export
|
|
2062
|
+
* @interface ReturnLabel
|
|
2063
|
+
*/
|
|
2064
|
+
interface ReturnLabel {
|
|
2065
|
+
/**
|
|
2066
|
+
* Tracking number
|
|
2067
|
+
* @type {string}
|
|
2068
|
+
* @memberof ReturnLabel
|
|
2069
|
+
*/
|
|
2070
|
+
number?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Delivery method
|
|
2073
|
+
* @type {string}
|
|
2074
|
+
* @memberof ReturnLabel
|
|
2075
|
+
*/
|
|
2076
|
+
delivery_method?: string;
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* Check if a given object implements the ReturnLabel interface.
|
|
2080
|
+
*/
|
|
2081
|
+
declare function instanceOfReturnLabel(value: object): value is ReturnLabel;
|
|
2082
|
+
declare function ReturnLabelFromJSON(json: any): ReturnLabel;
|
|
2083
|
+
declare function ReturnLabelFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReturnLabel;
|
|
2084
|
+
declare function ReturnLabelToJSON(json: any): ReturnLabel;
|
|
2085
|
+
declare function ReturnLabelToJSONTyped(value?: ReturnLabel | null, ignoreDiscriminator?: boolean): any;
|
|
2086
|
+
|
|
2087
|
+
/**
|
|
2088
|
+
* API V2
|
|
2089
|
+
* API V2
|
|
2090
|
+
*
|
|
2091
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2092
|
+
*
|
|
2093
|
+
*
|
|
2094
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2095
|
+
* https://openapi-generator.tech
|
|
2096
|
+
* Do not edit the class manually.
|
|
2097
|
+
*/
|
|
2098
|
+
/**
|
|
2099
|
+
*
|
|
2100
|
+
* @export
|
|
2101
|
+
* @interface TrackingNumberItem
|
|
2102
|
+
*/
|
|
2103
|
+
interface TrackingNumberItem {
|
|
2104
|
+
/**
|
|
2105
|
+
* Doboxa item id
|
|
2106
|
+
* @type {string}
|
|
2107
|
+
* @memberof TrackingNumberItem
|
|
2108
|
+
*/
|
|
2109
|
+
doboxa_item_id?: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* External item id
|
|
2112
|
+
* @type {string}
|
|
2113
|
+
* @memberof TrackingNumberItem
|
|
2114
|
+
*/
|
|
2115
|
+
foreign_item_id?: string | null;
|
|
2116
|
+
/**
|
|
2117
|
+
* Product SKU
|
|
2118
|
+
* @type {string}
|
|
2119
|
+
* @memberof TrackingNumberItem
|
|
2120
|
+
*/
|
|
2121
|
+
product_sku?: string;
|
|
2122
|
+
}
|
|
2123
|
+
/**
|
|
2124
|
+
* Check if a given object implements the TrackingNumberItem interface.
|
|
2125
|
+
*/
|
|
2126
|
+
declare function instanceOfTrackingNumberItem(value: object): value is TrackingNumberItem;
|
|
2127
|
+
declare function TrackingNumberItemFromJSON(json: any): TrackingNumberItem;
|
|
2128
|
+
declare function TrackingNumberItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackingNumberItem;
|
|
2129
|
+
declare function TrackingNumberItemToJSON(json: any): TrackingNumberItem;
|
|
2130
|
+
declare function TrackingNumberItemToJSONTyped(value?: TrackingNumberItem | null, ignoreDiscriminator?: boolean): any;
|
|
2131
|
+
|
|
2132
|
+
/**
|
|
2133
|
+
* API V2
|
|
2134
|
+
* API V2
|
|
2135
|
+
*
|
|
2136
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2137
|
+
*
|
|
2138
|
+
*
|
|
2139
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2140
|
+
* https://openapi-generator.tech
|
|
2141
|
+
* Do not edit the class manually.
|
|
2142
|
+
*/
|
|
2143
|
+
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
* @export
|
|
2147
|
+
* @interface TrackingNumber
|
|
2148
|
+
*/
|
|
2149
|
+
interface TrackingNumber {
|
|
2150
|
+
/**
|
|
2151
|
+
* Related order id
|
|
2152
|
+
* @type {string}
|
|
2153
|
+
* @memberof TrackingNumber
|
|
2154
|
+
*/
|
|
2155
|
+
order_id?: string;
|
|
2156
|
+
/**
|
|
2157
|
+
* Tracking number
|
|
2158
|
+
* @type {string}
|
|
2159
|
+
* @memberof TrackingNumber
|
|
2160
|
+
*/
|
|
2161
|
+
number?: string;
|
|
2162
|
+
/**
|
|
2163
|
+
* Delivery method
|
|
2164
|
+
* @type {string}
|
|
2165
|
+
* @memberof TrackingNumber
|
|
2166
|
+
*/
|
|
2167
|
+
delivery_method?: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* Sent time. Can be empty (if not yet sent)
|
|
2170
|
+
* @type {Date}
|
|
2171
|
+
* @memberof TrackingNumber
|
|
2172
|
+
*/
|
|
2173
|
+
sent_at?: Date | null;
|
|
2174
|
+
/**
|
|
2175
|
+
* Creation time
|
|
2176
|
+
* @type {Date}
|
|
2177
|
+
* @memberof TrackingNumber
|
|
2178
|
+
*/
|
|
2179
|
+
created_at?: Date;
|
|
2180
|
+
/**
|
|
2181
|
+
*
|
|
2182
|
+
* @type {ReturnLabel}
|
|
2183
|
+
* @memberof TrackingNumber
|
|
2184
|
+
*/
|
|
2185
|
+
return_label?: ReturnLabel;
|
|
2186
|
+
/**
|
|
2187
|
+
* Order items assigned to the tracking number
|
|
2188
|
+
* @type {Array<TrackingNumberItem>}
|
|
2189
|
+
* @memberof TrackingNumber
|
|
2190
|
+
*/
|
|
2191
|
+
order_items?: Array<TrackingNumberItem> | null;
|
|
2192
|
+
}
|
|
2193
|
+
/**
|
|
2194
|
+
* Check if a given object implements the TrackingNumber interface.
|
|
2195
|
+
*/
|
|
2196
|
+
declare function instanceOfTrackingNumber(value: object): value is TrackingNumber;
|
|
2197
|
+
declare function TrackingNumberFromJSON(json: any): TrackingNumber;
|
|
2198
|
+
declare function TrackingNumberFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackingNumber;
|
|
2199
|
+
declare function TrackingNumberToJSON(json: any): TrackingNumber;
|
|
2200
|
+
declare function TrackingNumberToJSONTyped(value?: TrackingNumber | null, ignoreDiscriminator?: boolean): any;
|
|
2201
|
+
|
|
2202
|
+
/**
|
|
2203
|
+
* API V2
|
|
2204
|
+
* API V2
|
|
2205
|
+
*
|
|
2206
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2207
|
+
*
|
|
2208
|
+
*
|
|
2209
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2210
|
+
* https://openapi-generator.tech
|
|
2211
|
+
* Do not edit the class manually.
|
|
2212
|
+
*/
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
* @export
|
|
2217
|
+
* @interface PageOfTrackingNumbers
|
|
2218
|
+
*/
|
|
2219
|
+
interface PageOfTrackingNumbers {
|
|
2220
|
+
/**
|
|
2221
|
+
*
|
|
2222
|
+
* @type {Array<TrackingNumber>}
|
|
2223
|
+
* @memberof PageOfTrackingNumbers
|
|
2224
|
+
*/
|
|
2225
|
+
items?: Array<TrackingNumber>;
|
|
2226
|
+
/**
|
|
2227
|
+
*
|
|
2228
|
+
* @type {string}
|
|
2229
|
+
* @memberof PageOfTrackingNumbers
|
|
2230
|
+
*/
|
|
2231
|
+
next_page?: string | null;
|
|
2232
|
+
}
|
|
2233
|
+
/**
|
|
2234
|
+
* Check if a given object implements the PageOfTrackingNumbers interface.
|
|
2235
|
+
*/
|
|
2236
|
+
declare function instanceOfPageOfTrackingNumbers(value: object): value is PageOfTrackingNumbers;
|
|
2237
|
+
declare function PageOfTrackingNumbersFromJSON(json: any): PageOfTrackingNumbers;
|
|
2238
|
+
declare function PageOfTrackingNumbersFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageOfTrackingNumbers;
|
|
2239
|
+
declare function PageOfTrackingNumbersToJSON(json: any): PageOfTrackingNumbers;
|
|
2240
|
+
declare function PageOfTrackingNumbersToJSONTyped(value?: PageOfTrackingNumbers | null, ignoreDiscriminator?: boolean): any;
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
* API V2
|
|
2244
|
+
* API V2
|
|
2245
|
+
*
|
|
2246
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2247
|
+
*
|
|
2248
|
+
*
|
|
2249
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2250
|
+
* https://openapi-generator.tech
|
|
2251
|
+
* Do not edit the class manually.
|
|
2252
|
+
*/
|
|
2253
|
+
/**
|
|
2254
|
+
*
|
|
2255
|
+
* @export
|
|
2256
|
+
* @interface PostOrderCommentResponse
|
|
2257
|
+
*/
|
|
2258
|
+
interface PostOrderCommentResponse {
|
|
2259
|
+
/**
|
|
2260
|
+
* HTTP status code
|
|
2261
|
+
* @type {number}
|
|
2262
|
+
* @memberof PostOrderCommentResponse
|
|
2263
|
+
*/
|
|
2264
|
+
result_code?: number;
|
|
2265
|
+
/**
|
|
2266
|
+
* Comment id, if successfully created
|
|
2267
|
+
* @type {string}
|
|
2268
|
+
* @memberof PostOrderCommentResponse
|
|
2269
|
+
*/
|
|
2270
|
+
comment_id?: string;
|
|
2271
|
+
}
|
|
2272
|
+
/**
|
|
2273
|
+
* Check if a given object implements the PostOrderCommentResponse interface.
|
|
2274
|
+
*/
|
|
2275
|
+
declare function instanceOfPostOrderCommentResponse(value: object): value is PostOrderCommentResponse;
|
|
2276
|
+
declare function PostOrderCommentResponseFromJSON(json: any): PostOrderCommentResponse;
|
|
2277
|
+
declare function PostOrderCommentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOrderCommentResponse;
|
|
2278
|
+
declare function PostOrderCommentResponseToJSON(json: any): PostOrderCommentResponse;
|
|
2279
|
+
declare function PostOrderCommentResponseToJSONTyped(value?: PostOrderCommentResponse | null, ignoreDiscriminator?: boolean): any;
|
|
2280
|
+
|
|
2281
|
+
/**
|
|
2282
|
+
* API V2
|
|
2283
|
+
* API V2
|
|
2284
|
+
*
|
|
2285
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2286
|
+
*
|
|
2287
|
+
*
|
|
2288
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2289
|
+
* https://openapi-generator.tech
|
|
2290
|
+
* Do not edit the class manually.
|
|
2291
|
+
*/
|
|
2292
|
+
/**
|
|
2293
|
+
*
|
|
2294
|
+
* @export
|
|
2295
|
+
* @interface PostOrderResponse
|
|
2296
|
+
*/
|
|
2297
|
+
interface PostOrderResponse {
|
|
2298
|
+
/**
|
|
2299
|
+
* HTTP status code
|
|
2300
|
+
* @type {number}
|
|
2301
|
+
* @memberof PostOrderResponse
|
|
2302
|
+
*/
|
|
2303
|
+
result_code?: number;
|
|
2304
|
+
/**
|
|
2305
|
+
* Order id, if successfully created
|
|
2306
|
+
* @type {string}
|
|
2307
|
+
* @memberof PostOrderResponse
|
|
2308
|
+
*/
|
|
2309
|
+
order_id?: string;
|
|
2310
|
+
}
|
|
2311
|
+
/**
|
|
2312
|
+
* Check if a given object implements the PostOrderResponse interface.
|
|
2313
|
+
*/
|
|
2314
|
+
declare function instanceOfPostOrderResponse(value: object): value is PostOrderResponse;
|
|
2315
|
+
declare function PostOrderResponseFromJSON(json: any): PostOrderResponse;
|
|
2316
|
+
declare function PostOrderResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOrderResponse;
|
|
2317
|
+
declare function PostOrderResponseToJSON(json: any): PostOrderResponse;
|
|
2318
|
+
declare function PostOrderResponseToJSONTyped(value?: PostOrderResponse | null, ignoreDiscriminator?: boolean): any;
|
|
2319
|
+
|
|
2320
|
+
/**
|
|
2321
|
+
* API V2
|
|
2322
|
+
* API V2
|
|
2323
|
+
*
|
|
2324
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2325
|
+
*
|
|
2326
|
+
*
|
|
2327
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2328
|
+
* https://openapi-generator.tech
|
|
2329
|
+
* Do not edit the class manually.
|
|
2330
|
+
*/
|
|
2331
|
+
/**
|
|
2332
|
+
*
|
|
2333
|
+
* @export
|
|
2334
|
+
* @interface PostOrderStatusItem
|
|
2335
|
+
*/
|
|
2336
|
+
interface PostOrderStatusItem {
|
|
2337
|
+
/**
|
|
2338
|
+
* Item id assigned to item by doboxa
|
|
2339
|
+
* @type {string}
|
|
2340
|
+
* @memberof PostOrderStatusItem
|
|
2341
|
+
*/
|
|
2342
|
+
doboxa_item_id: string | null;
|
|
2343
|
+
/**
|
|
2344
|
+
* Order status
|
|
2345
|
+
* @type {string}
|
|
2346
|
+
* @memberof PostOrderStatusItem
|
|
2347
|
+
*/
|
|
2348
|
+
status: PostOrderStatusItemStatusEnum;
|
|
2349
|
+
}
|
|
2350
|
+
/**
|
|
2351
|
+
* @export
|
|
2352
|
+
* @enum {string}
|
|
2353
|
+
*/
|
|
2354
|
+
declare enum PostOrderStatusItemStatusEnum {
|
|
2355
|
+
new = "new",
|
|
2356
|
+
wait_for_payment = "wait_for_payment",
|
|
2357
|
+
paid = "paid",
|
|
2358
|
+
in_progress = "in_progress",
|
|
2359
|
+
ready_to_be_sent = "ready_to_be_sent",
|
|
2360
|
+
sent = "sent",
|
|
2361
|
+
cancelled = "cancelled",
|
|
2362
|
+
hold = "hold",
|
|
2363
|
+
refund = "refund"
|
|
2364
|
+
}
|
|
2365
|
+
/**
|
|
2366
|
+
* Check if a given object implements the PostOrderStatusItem interface.
|
|
2367
|
+
*/
|
|
2368
|
+
declare function instanceOfPostOrderStatusItem(value: object): value is PostOrderStatusItem;
|
|
2369
|
+
declare function PostOrderStatusItemFromJSON(json: any): PostOrderStatusItem;
|
|
2370
|
+
declare function PostOrderStatusItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOrderStatusItem;
|
|
2371
|
+
declare function PostOrderStatusItemToJSON(json: any): PostOrderStatusItem;
|
|
2372
|
+
declare function PostOrderStatusItemToJSONTyped(value?: PostOrderStatusItem | null, ignoreDiscriminator?: boolean): any;
|
|
2373
|
+
|
|
2374
|
+
/**
|
|
2375
|
+
* API V2
|
|
2376
|
+
* API V2
|
|
2377
|
+
*
|
|
2378
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2379
|
+
*
|
|
2380
|
+
*
|
|
2381
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2382
|
+
* https://openapi-generator.tech
|
|
2383
|
+
* Do not edit the class manually.
|
|
2384
|
+
*/
|
|
2385
|
+
|
|
2386
|
+
/**
|
|
2387
|
+
*
|
|
2388
|
+
* @export
|
|
2389
|
+
* @interface PostOrderStatus
|
|
2390
|
+
*/
|
|
2391
|
+
interface PostOrderStatus {
|
|
2392
|
+
/**
|
|
2393
|
+
* Order status
|
|
2394
|
+
* @type {string}
|
|
2395
|
+
* @memberof PostOrderStatus
|
|
2396
|
+
*/
|
|
2397
|
+
status: PostOrderStatusStatusEnum;
|
|
2398
|
+
/**
|
|
2399
|
+
* Order items status. If any item is not specified, its status will be changed to order status
|
|
2400
|
+
* @type {Array<PostOrderStatusItem>}
|
|
2401
|
+
* @memberof PostOrderStatus
|
|
2402
|
+
*/
|
|
2403
|
+
item_status?: Array<PostOrderStatusItem> | null;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* @export
|
|
2407
|
+
* @enum {string}
|
|
2408
|
+
*/
|
|
2409
|
+
declare enum PostOrderStatusStatusEnum {
|
|
2410
|
+
new = "new",
|
|
2411
|
+
wait_for_payment = "wait_for_payment",
|
|
2412
|
+
paid = "paid",
|
|
2413
|
+
in_progress = "in_progress",
|
|
2414
|
+
ready_to_be_sent = "ready_to_be_sent",
|
|
2415
|
+
sent = "sent",
|
|
2416
|
+
cancelled = "cancelled",
|
|
2417
|
+
hold = "hold",
|
|
2418
|
+
refund = "refund"
|
|
2419
|
+
}
|
|
2420
|
+
/**
|
|
2421
|
+
* Check if a given object implements the PostOrderStatus interface.
|
|
2422
|
+
*/
|
|
2423
|
+
declare function instanceOfPostOrderStatus(value: object): value is PostOrderStatus;
|
|
2424
|
+
declare function PostOrderStatusFromJSON(json: any): PostOrderStatus;
|
|
2425
|
+
declare function PostOrderStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOrderStatus;
|
|
2426
|
+
declare function PostOrderStatusToJSON(json: any): PostOrderStatus;
|
|
2427
|
+
declare function PostOrderStatusToJSONTyped(value?: PostOrderStatus | null, ignoreDiscriminator?: boolean): any;
|
|
2428
|
+
|
|
2429
|
+
/**
|
|
2430
|
+
* API V2
|
|
2431
|
+
* API V2
|
|
2432
|
+
*
|
|
2433
|
+
* The version of the OpenAPI document: 1.0-alpha
|
|
2434
|
+
*
|
|
2435
|
+
*
|
|
2436
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2437
|
+
* https://openapi-generator.tech
|
|
2438
|
+
* Do not edit the class manually.
|
|
2439
|
+
*/
|
|
2440
|
+
/**
|
|
2441
|
+
*
|
|
2442
|
+
* @export
|
|
2443
|
+
* @interface PostOrderStatusResponse
|
|
2444
|
+
*/
|
|
2445
|
+
interface PostOrderStatusResponse {
|
|
2446
|
+
/**
|
|
2447
|
+
* HTTP status code
|
|
2448
|
+
* @type {number}
|
|
2449
|
+
* @memberof PostOrderStatusResponse
|
|
2450
|
+
*/
|
|
2451
|
+
result_code?: number;
|
|
2452
|
+
}
|
|
2453
|
+
/**
|
|
2454
|
+
* Check if a given object implements the PostOrderStatusResponse interface.
|
|
2455
|
+
*/
|
|
2456
|
+
declare function instanceOfPostOrderStatusResponse(value: object): value is PostOrderStatusResponse;
|
|
2457
|
+
declare function PostOrderStatusResponseFromJSON(json: any): PostOrderStatusResponse;
|
|
2458
|
+
declare function PostOrderStatusResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOrderStatusResponse;
|
|
2459
|
+
declare function PostOrderStatusResponseToJSON(json: any): PostOrderStatusResponse;
|
|
2460
|
+
declare function PostOrderStatusResponseToJSONTyped(value?: PostOrderStatusResponse | null, ignoreDiscriminator?: boolean): any;
|
|
2461
|
+
|
|
2462
|
+
interface LoginParams {
|
|
2463
|
+
username: string;
|
|
2464
|
+
password: string;
|
|
2465
|
+
}
|
|
2466
|
+
interface RefreshTokenParams {
|
|
2467
|
+
refresh_token: string;
|
|
2468
|
+
}
|
|
2469
|
+
/**
|
|
2470
|
+
* Authentication resource
|
|
2471
|
+
*/
|
|
2472
|
+
declare class AuthenticationResource {
|
|
2473
|
+
private httpClient;
|
|
2474
|
+
private tokenManager;
|
|
2475
|
+
constructor(httpClient: HTTPClient, tokenManager: TokenManager);
|
|
2476
|
+
/**
|
|
2477
|
+
* Login with username and password
|
|
2478
|
+
*/
|
|
2479
|
+
login(params: LoginParams): Promise<ApiV2AuthenticationTokenPost200Response>;
|
|
2480
|
+
/**
|
|
2481
|
+
* Refresh access token using refresh token
|
|
2482
|
+
*/
|
|
2483
|
+
refreshToken(refreshToken: string): Promise<ApiV2AuthenticationRefreshTokenPost200Response>;
|
|
2484
|
+
}
|
|
2485
|
+
|
|
2486
|
+
interface ConfigurationParameters {
|
|
2487
|
+
basePath?: string;
|
|
2488
|
+
fetchApi?: FetchAPI;
|
|
2489
|
+
middleware?: Middleware[];
|
|
2490
|
+
queryParamsStringify?: (params: HTTPQuery) => string;
|
|
2491
|
+
username?: string;
|
|
2492
|
+
password?: string;
|
|
2493
|
+
apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
|
|
2494
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
|
|
2495
|
+
headers?: HTTPHeaders;
|
|
2496
|
+
credentials?: RequestCredentials;
|
|
2497
|
+
}
|
|
2498
|
+
declare class Configuration {
|
|
2499
|
+
private configuration;
|
|
2500
|
+
constructor(configuration?: ConfigurationParameters);
|
|
2501
|
+
set config(configuration: Configuration);
|
|
2502
|
+
get basePath(): string;
|
|
2503
|
+
get fetchApi(): FetchAPI | undefined;
|
|
2504
|
+
get middleware(): Middleware[];
|
|
2505
|
+
get queryParamsStringify(): (params: HTTPQuery) => string;
|
|
2506
|
+
get username(): string | undefined;
|
|
2507
|
+
get password(): string | undefined;
|
|
2508
|
+
get apiKey(): ((name: string) => string | Promise<string>) | undefined;
|
|
2509
|
+
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
|
|
2510
|
+
get headers(): HTTPHeaders | undefined;
|
|
2511
|
+
get credentials(): RequestCredentials | undefined;
|
|
2512
|
+
}
|
|
2513
|
+
type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
|
|
2514
|
+
type HTTPHeaders = {
|
|
2515
|
+
[key: string]: string;
|
|
2516
|
+
};
|
|
2517
|
+
type HTTPQuery = {
|
|
2518
|
+
[key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
|
|
2519
|
+
};
|
|
2520
|
+
interface FetchParams {
|
|
2521
|
+
url: string;
|
|
2522
|
+
init: RequestInit;
|
|
2523
|
+
}
|
|
2524
|
+
interface RequestContext {
|
|
2525
|
+
fetch: FetchAPI;
|
|
2526
|
+
url: string;
|
|
2527
|
+
init: RequestInit;
|
|
2528
|
+
}
|
|
2529
|
+
interface ResponseContext {
|
|
2530
|
+
fetch: FetchAPI;
|
|
2531
|
+
url: string;
|
|
2532
|
+
init: RequestInit;
|
|
2533
|
+
response: Response;
|
|
2534
|
+
}
|
|
2535
|
+
interface ErrorContext {
|
|
2536
|
+
fetch: FetchAPI;
|
|
2537
|
+
url: string;
|
|
2538
|
+
init: RequestInit;
|
|
2539
|
+
error: unknown;
|
|
2540
|
+
response?: Response;
|
|
2541
|
+
}
|
|
2542
|
+
interface Middleware {
|
|
2543
|
+
pre?(context: RequestContext): Promise<FetchParams | void>;
|
|
2544
|
+
post?(context: ResponseContext): Promise<Response | void>;
|
|
2545
|
+
onError?(context: ErrorContext): Promise<Response | void>;
|
|
2546
|
+
}
|
|
2547
|
+
|
|
2548
|
+
interface OrderCreateParams extends Omit<Order, 'billing_address' | 'order_source' | 'discount_code' | 'partner_code' | 'order_original_data' | 'payment_method' | 'payment_transaction_id' | 'ag_invoice_requested' | 'suggested_delivery_method'> {
|
|
2549
|
+
}
|
|
2550
|
+
interface OrderStatusUpdateParams extends PostOrderStatus {
|
|
2551
|
+
}
|
|
2552
|
+
interface OrderCommentCreateParams extends CreateOrderComment {
|
|
2553
|
+
}
|
|
2554
|
+
interface OrderCancelParams {
|
|
2555
|
+
order_id: string;
|
|
2556
|
+
}
|
|
2557
|
+
/**
|
|
2558
|
+
* Orders resource
|
|
2559
|
+
*/
|
|
2560
|
+
declare class OrdersResource {
|
|
2561
|
+
private httpClient;
|
|
2562
|
+
private orderApi;
|
|
2563
|
+
private cancellationApi;
|
|
2564
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2565
|
+
/**
|
|
2566
|
+
* Create an order
|
|
2567
|
+
*/
|
|
2568
|
+
create(params: OrderCreateParams): Promise<PostOrderResponse>;
|
|
2569
|
+
/**
|
|
2570
|
+
* Get current order status
|
|
2571
|
+
*/
|
|
2572
|
+
getStatus(orderId: string): Promise<OrderStatus>;
|
|
2573
|
+
/**
|
|
2574
|
+
* Update order status
|
|
2575
|
+
*/
|
|
2576
|
+
updateStatus(orderId: string, params: OrderStatusUpdateParams): Promise<PostOrderStatusResponse>;
|
|
2577
|
+
/**
|
|
2578
|
+
* Get order comments
|
|
2579
|
+
*/
|
|
2580
|
+
getComments(orderId: string): Promise<PageOfOrderComments>;
|
|
2581
|
+
/**
|
|
2582
|
+
* Create an order comment
|
|
2583
|
+
*/
|
|
2584
|
+
createComment(orderId: string, params: OrderCommentCreateParams): Promise<PostOrderCommentResponse>;
|
|
2585
|
+
/**
|
|
2586
|
+
* Get order invoices
|
|
2587
|
+
*/
|
|
2588
|
+
getInvoices(orderId: string): Promise<PageOfInvoices>;
|
|
2589
|
+
/**
|
|
2590
|
+
* Get order tracking numbers
|
|
2591
|
+
*/
|
|
2592
|
+
getTrackingNumbers(orderId: string): Promise<PageOfTrackingNumbers>;
|
|
2593
|
+
/**
|
|
2594
|
+
* Cancel an order
|
|
2595
|
+
*/
|
|
2596
|
+
cancel(params: OrderCancelParams): Promise<OrderCancellationResponse>;
|
|
2597
|
+
}
|
|
2598
|
+
|
|
2599
|
+
interface InvoiceListParams {
|
|
2600
|
+
page?: number;
|
|
2601
|
+
from?: string;
|
|
2602
|
+
to?: string;
|
|
2603
|
+
}
|
|
2604
|
+
/**
|
|
2605
|
+
* Invoices resource
|
|
2606
|
+
*/
|
|
2607
|
+
declare class InvoicesResource {
|
|
2608
|
+
private httpClient;
|
|
2609
|
+
private invoiceApi;
|
|
2610
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2611
|
+
/**
|
|
2612
|
+
* List invoices
|
|
2613
|
+
*/
|
|
2614
|
+
list(params?: InvoiceListParams): Promise<PageOfInvoices>;
|
|
2615
|
+
/**
|
|
2616
|
+
* Retrieve a specific invoice
|
|
2617
|
+
*/
|
|
2618
|
+
retrieve(invoiceId: string): Promise<Invoice>;
|
|
2619
|
+
}
|
|
2620
|
+
|
|
2621
|
+
interface ClientListParams {
|
|
2622
|
+
page?: number;
|
|
2623
|
+
}
|
|
2624
|
+
/**
|
|
2625
|
+
* Clients resource
|
|
2626
|
+
*/
|
|
2627
|
+
declare class ClientsResource {
|
|
2628
|
+
private httpClient;
|
|
2629
|
+
private clientApi;
|
|
2630
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2631
|
+
/**
|
|
2632
|
+
* List clients (only commission type)
|
|
2633
|
+
*/
|
|
2634
|
+
list(params?: ClientListParams): Promise<PageOfClients>;
|
|
2635
|
+
}
|
|
2636
|
+
|
|
2637
|
+
interface DiscountCodeListParams {
|
|
2638
|
+
page?: number;
|
|
2639
|
+
}
|
|
2640
|
+
/**
|
|
2641
|
+
* Discount Codes resource
|
|
2642
|
+
*/
|
|
2643
|
+
declare class DiscountCodesResource {
|
|
2644
|
+
private httpClient;
|
|
2645
|
+
private discountCodeApi;
|
|
2646
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2647
|
+
/**
|
|
2648
|
+
* List discount codes (only commission type)
|
|
2649
|
+
*/
|
|
2650
|
+
list(params?: DiscountCodeListParams): Promise<GetApiV2DiscountCodesExternal200Response>;
|
|
2651
|
+
}
|
|
2652
|
+
|
|
2653
|
+
interface TrackingNumberListParams {
|
|
2654
|
+
page?: number;
|
|
2655
|
+
from?: string;
|
|
2656
|
+
to?: string;
|
|
2657
|
+
}
|
|
2658
|
+
/**
|
|
2659
|
+
* Tracking Numbers resource
|
|
2660
|
+
*/
|
|
2661
|
+
declare class TrackingNumbersResource {
|
|
2662
|
+
private httpClient;
|
|
2663
|
+
private trackingNumberApi;
|
|
2664
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2665
|
+
/**
|
|
2666
|
+
* List tracking numbers
|
|
2667
|
+
*/
|
|
2668
|
+
list(params?: TrackingNumberListParams): Promise<PageOfTrackingNumbers>;
|
|
2669
|
+
}
|
|
2670
|
+
|
|
2671
|
+
interface OrderCommentListParams {
|
|
2672
|
+
page?: number;
|
|
2673
|
+
from?: string;
|
|
2674
|
+
to?: string;
|
|
2675
|
+
}
|
|
2676
|
+
/**
|
|
2677
|
+
* Order Comments resource
|
|
2678
|
+
*/
|
|
2679
|
+
declare class OrderCommentsResource {
|
|
2680
|
+
private httpClient;
|
|
2681
|
+
private orderCommentApi;
|
|
2682
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2683
|
+
/**
|
|
2684
|
+
* List order comments
|
|
2685
|
+
*/
|
|
2686
|
+
list(params?: OrderCommentListParams): Promise<PageOfOrderComments>;
|
|
2687
|
+
}
|
|
2688
|
+
|
|
2689
|
+
interface OrderStatusChangeListParams {
|
|
2690
|
+
page?: number;
|
|
2691
|
+
from?: string;
|
|
2692
|
+
to?: string;
|
|
2693
|
+
}
|
|
2694
|
+
/**
|
|
2695
|
+
* Order Status Changes resource
|
|
2696
|
+
*/
|
|
2697
|
+
declare class OrderStatusChangesResource {
|
|
2698
|
+
private httpClient;
|
|
2699
|
+
private orderStatusChangeApi;
|
|
2700
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2701
|
+
/**
|
|
2702
|
+
* List order status changes
|
|
2703
|
+
*/
|
|
2704
|
+
list(params?: OrderStatusChangeListParams): Promise<PageOfOrderStatusChanges>;
|
|
2705
|
+
}
|
|
2706
|
+
|
|
2707
|
+
/**
|
|
2708
|
+
* Users resource
|
|
2709
|
+
*/
|
|
2710
|
+
declare class UsersResource {
|
|
2711
|
+
private httpClient;
|
|
2712
|
+
private userApi;
|
|
2713
|
+
constructor(httpClient: HTTPClient, config: Configuration);
|
|
2714
|
+
/**
|
|
2715
|
+
* Get current user (validate access token)
|
|
2716
|
+
*/
|
|
2717
|
+
me(): Promise<Me>;
|
|
2718
|
+
}
|
|
2719
|
+
|
|
2720
|
+
/**
|
|
2721
|
+
* Actions supported by Doboxa's BaseLinker connector.
|
|
2722
|
+
*/
|
|
2723
|
+
type BaseLinkerAction = 'FileVersion' | 'SupportedMethods' | 'ProductsCategories' | 'ProductsList' | 'ProductsData';
|
|
2724
|
+
/**
|
|
2725
|
+
* Credentials of Doboxa's BaseLinker connector (shop integration file).
|
|
2726
|
+
*/
|
|
2727
|
+
interface BaseLinkerConnectorConfig {
|
|
2728
|
+
/**
|
|
2729
|
+
* Connector URL, e.g. https://pl.doboxa.biz/api/base-linker/{clientToken}/{language}
|
|
2730
|
+
*/
|
|
2731
|
+
url: string;
|
|
2732
|
+
/**
|
|
2733
|
+
* "Hasło" of the integration in the Doboxa client panel
|
|
2734
|
+
*/
|
|
2735
|
+
password: string;
|
|
2736
|
+
}
|
|
2737
|
+
/**
|
|
2738
|
+
* Parameters of a `ProductsList` call.
|
|
2739
|
+
*/
|
|
2740
|
+
interface ProductsListParams {
|
|
2741
|
+
/**
|
|
2742
|
+
* 1-based; past the end returns only `pages`
|
|
2743
|
+
*/
|
|
2744
|
+
page?: number;
|
|
2745
|
+
/**
|
|
2746
|
+
* Filter the list by a single category id
|
|
2747
|
+
*/
|
|
2748
|
+
category_id?: string;
|
|
2749
|
+
}
|
|
2750
|
+
/**
|
|
2751
|
+
* Parameters of a `ProductsData` call.
|
|
2752
|
+
*/
|
|
2753
|
+
interface ProductsDataParams {
|
|
2754
|
+
/**
|
|
2755
|
+
* Design (parent) ids from ProductsList
|
|
2756
|
+
*/
|
|
2757
|
+
products_id: string[];
|
|
2758
|
+
}
|
|
2759
|
+
/**
|
|
2760
|
+
* Error body returned by the connector with HTTP 200.
|
|
2761
|
+
*/
|
|
2762
|
+
interface BaseLinkerError {
|
|
2763
|
+
error: true;
|
|
2764
|
+
error_code: 'no_password' | 'bad_password' | 'unsupported_method' | (string & {});
|
|
2765
|
+
error_text: string;
|
|
2766
|
+
}
|
|
2767
|
+
/**
|
|
2768
|
+
* Connector platform and version.
|
|
2769
|
+
*/
|
|
2770
|
+
interface FileVersionResponse {
|
|
2771
|
+
/**
|
|
2772
|
+
* e.g. "Magento"
|
|
2773
|
+
*/
|
|
2774
|
+
platform: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* e.g. "4.1.91"
|
|
2777
|
+
*/
|
|
2778
|
+
version: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* e.g. 4
|
|
2781
|
+
*/
|
|
2782
|
+
standard: number;
|
|
2783
|
+
}
|
|
2784
|
+
/**
|
|
2785
|
+
* List of actions the connector supports.
|
|
2786
|
+
*/
|
|
2787
|
+
type SupportedMethodsResponse = BaseLinkerAction[];
|
|
2788
|
+
/**
|
|
2789
|
+
* Category id -> "Fototapety / Tematyka / Abstrakcja"
|
|
2790
|
+
*/
|
|
2791
|
+
type ProductsCategoriesResponse = Record<string, string>;
|
|
2792
|
+
/**
|
|
2793
|
+
* First variant of a design, as shown in the list.
|
|
2794
|
+
*/
|
|
2795
|
+
interface ProductsListItem {
|
|
2796
|
+
/**
|
|
2797
|
+
* e.g. "Fototapeta Wikingowie I Smoki Flizelina 90x60"
|
|
2798
|
+
*/
|
|
2799
|
+
name: string;
|
|
2800
|
+
/**
|
|
2801
|
+
* e.g. 999
|
|
2802
|
+
*/
|
|
2803
|
+
quantity: number;
|
|
2804
|
+
/**
|
|
2805
|
+
* e.g. "20.244" - PLN, probably net
|
|
2806
|
+
*/
|
|
2807
|
+
price: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* e.g. "FT-2385-VE90-60"
|
|
2810
|
+
*/
|
|
2811
|
+
sku: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* e.g. "5905451113260"
|
|
2814
|
+
*/
|
|
2815
|
+
ean: string;
|
|
2816
|
+
}
|
|
2817
|
+
/**
|
|
2818
|
+
* A single product of a list page, with its design id.
|
|
2819
|
+
*/
|
|
2820
|
+
interface ProductsListEntry extends ProductsListItem {
|
|
2821
|
+
/**
|
|
2822
|
+
* Design (parent) product id
|
|
2823
|
+
*/
|
|
2824
|
+
id: string;
|
|
2825
|
+
}
|
|
2826
|
+
/**
|
|
2827
|
+
* A page of the product list.
|
|
2828
|
+
*/
|
|
2829
|
+
interface ProductsListResult {
|
|
2830
|
+
/**
|
|
2831
|
+
* Total number of pages
|
|
2832
|
+
*/
|
|
2833
|
+
pages: number;
|
|
2834
|
+
/**
|
|
2835
|
+
* Products of the requested page
|
|
2836
|
+
*/
|
|
2837
|
+
items: ProductsListEntry[];
|
|
2838
|
+
}
|
|
2839
|
+
/**
|
|
2840
|
+
* Raw `ProductsList` response; keys are product ids and `pages` is the total page count.
|
|
2841
|
+
*/
|
|
2842
|
+
type ProductsListResponse = {
|
|
2843
|
+
pages: number;
|
|
2844
|
+
} & {
|
|
2845
|
+
[productId: string]: ProductsListItem | number;
|
|
2846
|
+
};
|
|
2847
|
+
/**
|
|
2848
|
+
* [name, value] pair.
|
|
2849
|
+
*/
|
|
2850
|
+
type ProductFeature = [name: ProductFeatureName | (string & {}), value: string | null];
|
|
2851
|
+
/**
|
|
2852
|
+
* Known feature names returned by the connector.
|
|
2853
|
+
*/
|
|
2854
|
+
type ProductFeatureName = 'product_type' | 'material' | 'dimensions' | 'dimensions_width' | 'dimensions_height' | 'size_code' | 'area_m2' | 'number_of_elements' | 'break_width' | 'break_height' | 'weight_gross' | 'weight_nett' | 'grammage' | 'lamination' | 'printing_technique' | 'structure' | 'length' | 'category_name';
|
|
2855
|
+
/**
|
|
2856
|
+
* A single variant (size x material) of a design.
|
|
2857
|
+
*/
|
|
2858
|
+
interface ProductVariant {
|
|
2859
|
+
/**
|
|
2860
|
+
* Design name without size/material
|
|
2861
|
+
*/
|
|
2862
|
+
full_name: string;
|
|
2863
|
+
/**
|
|
2864
|
+
* e.g. "… Flizelina 90x60"
|
|
2865
|
+
*/
|
|
2866
|
+
name: string;
|
|
2867
|
+
/**
|
|
2868
|
+
* HTML/plain text
|
|
2869
|
+
*/
|
|
2870
|
+
description: string;
|
|
2871
|
+
/**
|
|
2872
|
+
* Size code: "VE90-60", "VEM", "V4", "brak", …
|
|
2873
|
+
*/
|
|
2874
|
+
rozmiar: string;
|
|
2875
|
+
quantity: number;
|
|
2876
|
+
/**
|
|
2877
|
+
* e.g. "20.244"
|
|
2878
|
+
*/
|
|
2879
|
+
price: string;
|
|
2880
|
+
ean: string;
|
|
2881
|
+
/**
|
|
2882
|
+
* e.g. "FT-2385-VE90-60"
|
|
2883
|
+
*/
|
|
2884
|
+
sku: string;
|
|
2885
|
+
features: ProductFeature[];
|
|
2886
|
+
/**
|
|
2887
|
+
* [0] main image, [1] size render, then mask and room shots
|
|
2888
|
+
*/
|
|
2889
|
+
images: string[];
|
|
2890
|
+
category_id: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* e.g. "Fototapety/Tematyka/Dziecięce/Dla chłopca"
|
|
2893
|
+
*/
|
|
2894
|
+
category_name: string;
|
|
2895
|
+
}
|
|
2896
|
+
/**
|
|
2897
|
+
* Parent (design) of a product. Its sku/ean/description are empty and its price
|
|
2898
|
+
* is "0.00" - use the variants for the real values.
|
|
2899
|
+
*/
|
|
2900
|
+
interface ProductData {
|
|
2901
|
+
sku: string;
|
|
2902
|
+
ean: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* e.g. "0.00"
|
|
2905
|
+
*/
|
|
2906
|
+
price: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* e.g. "1.14"
|
|
2909
|
+
*/
|
|
2910
|
+
weight: string;
|
|
2911
|
+
description: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Category path
|
|
2914
|
+
*/
|
|
2915
|
+
description_extra1: string;
|
|
2916
|
+
/**
|
|
2917
|
+
* e.g. "Fototapeta Wikingowie I Smoki"
|
|
2918
|
+
*/
|
|
2919
|
+
name: string;
|
|
2920
|
+
quantity: number;
|
|
2921
|
+
/**
|
|
2922
|
+
* e.g. "Doboxa"
|
|
2923
|
+
*/
|
|
2924
|
+
man_name: string;
|
|
2925
|
+
features: ProductFeature[];
|
|
2926
|
+
images: string[];
|
|
2927
|
+
category_id: string;
|
|
2928
|
+
category_name: string;
|
|
2929
|
+
/**
|
|
2930
|
+
* Variant product id -> variant
|
|
2931
|
+
*/
|
|
2932
|
+
variants: Record<string, ProductVariant>;
|
|
2933
|
+
}
|
|
2934
|
+
/**
|
|
2935
|
+
* Raw `ProductsData` response; keys are design ids.
|
|
2936
|
+
*/
|
|
2937
|
+
type ProductsDataResponse = Record<string, ProductData> | [];
|
|
2938
|
+
|
|
2939
|
+
/**
|
|
2940
|
+
* Product catalog resource.
|
|
2941
|
+
*
|
|
2942
|
+
* Wraps Doboxa's BaseLinker connector (shop integration file). The connector is
|
|
2943
|
+
* a separate API: it lives on its own URL, takes a form body and reports errors
|
|
2944
|
+
* with HTTP 200, so it is called directly instead of through the generated
|
|
2945
|
+
* API v2 client.
|
|
2946
|
+
*/
|
|
2947
|
+
declare class CatalogResource {
|
|
2948
|
+
private config;
|
|
2949
|
+
constructor(config: BaseLinkerConnectorConfig);
|
|
2950
|
+
/**
|
|
2951
|
+
* Call a connector action.
|
|
2952
|
+
*
|
|
2953
|
+
* @param action - Connector action, e.g. "ProductsList"
|
|
2954
|
+
* @param params - Additional action parameters
|
|
2955
|
+
* @throws DoboxaConnectorError on HTTP or connector errors
|
|
2956
|
+
*/
|
|
2957
|
+
private call;
|
|
2958
|
+
/**
|
|
2959
|
+
* Get the connector platform and version.
|
|
2960
|
+
*/
|
|
2961
|
+
fileVersion(): Promise<FileVersionResponse>;
|
|
2962
|
+
/**
|
|
2963
|
+
* Get the list of actions the connector supports.
|
|
2964
|
+
*/
|
|
2965
|
+
supportedMethods(): Promise<SupportedMethodsResponse>;
|
|
2966
|
+
/**
|
|
2967
|
+
* Get all product categories as a map of category id to category path.
|
|
2968
|
+
*/
|
|
2969
|
+
categories(): Promise<ProductsCategoriesResponse>;
|
|
2970
|
+
/**
|
|
2971
|
+
* List one page of products (designs).
|
|
2972
|
+
*
|
|
2973
|
+
* @param params - Page number and optional category filter
|
|
2974
|
+
*/
|
|
2975
|
+
list(params?: ProductsListParams): Promise<ProductsListResult>;
|
|
2976
|
+
/**
|
|
2977
|
+
* Get full product data (images, variants) for the given design ids.
|
|
2978
|
+
*
|
|
2979
|
+
* @param params - Design ids from the product list
|
|
2980
|
+
*/
|
|
2981
|
+
data(params: ProductsDataParams): Promise<Record<string, ProductData>>;
|
|
2982
|
+
}
|
|
2983
|
+
|
|
2984
|
+
interface DoboxaConfig {
|
|
2985
|
+
/**
|
|
2986
|
+
* API key (access token). If not provided, you must call authentication.login() first.
|
|
2987
|
+
*/
|
|
2988
|
+
apiKey?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
* Base URL for the API. Defaults to DOBOXA_API_URL environment variable or http://localhost
|
|
2991
|
+
*/
|
|
2992
|
+
baseURL?: string;
|
|
2993
|
+
/**
|
|
2994
|
+
* Product catalog credentials (Doboxa's BaseLinker connector).
|
|
2995
|
+
* The connector URL and the "Hasło" are shown in the Doboxa panel:
|
|
2996
|
+
* Integracje -> Edycja. When set, `doboxa.catalog` is available.
|
|
2997
|
+
* The catalog does not use the API key, only the connector password.
|
|
2998
|
+
*/
|
|
2999
|
+
catalog?: BaseLinkerConnectorConfig;
|
|
3000
|
+
}
|
|
3001
|
+
/**
|
|
3002
|
+
* Main Doboxa client class
|
|
3003
|
+
*/
|
|
3004
|
+
declare class Doboxa {
|
|
3005
|
+
readonly authentication: AuthenticationResource;
|
|
3006
|
+
readonly orders: OrdersResource;
|
|
3007
|
+
readonly invoices: InvoicesResource;
|
|
3008
|
+
readonly clients: ClientsResource;
|
|
3009
|
+
readonly discountCodes: DiscountCodesResource;
|
|
3010
|
+
readonly trackingNumbers: TrackingNumbersResource;
|
|
3011
|
+
readonly orderComments: OrderCommentsResource;
|
|
3012
|
+
readonly orderStatusChanges: OrderStatusChangesResource;
|
|
3013
|
+
readonly users: UsersResource;
|
|
3014
|
+
/**
|
|
3015
|
+
* Product catalog (BaseLinker connector). Available only when `catalog` config is provided.
|
|
3016
|
+
*/
|
|
3017
|
+
readonly catalog?: CatalogResource;
|
|
3018
|
+
private tokenManager;
|
|
3019
|
+
private httpClient;
|
|
3020
|
+
private config;
|
|
3021
|
+
constructor(config?: DoboxaConfig);
|
|
3022
|
+
}
|
|
3023
|
+
|
|
3024
|
+
export { ClientToJSONTyped as $, AuthenticationResource as A, ApiV2AuthenticationTokenPost200ResponseToJSONTyped as B, ClientsResource as C, Doboxa as D, type Attachment as E, instanceOfAttachment as F, AttachmentFromJSON as G, AttachmentFromJSONTyped as H, InvoicesResource as I, AttachmentToJSON as J, AttachmentToJSONTyped as K, type LoginParams as L, type BillingAddress as M, instanceOfBillingAddress as N, OrdersResource as O, BillingAddressFromJSON as P, BillingAddressFromJSONTyped as Q, type RefreshTokenParams as R, BillingAddressToJSON as S, TrackingNumbersResource as T, UsersResource as U, BillingAddressToJSONTyped as V, type Client as W, instanceOfClient as X, ClientFromJSON as Y, ClientFromJSONTyped as Z, ClientToJSON as _, type DoboxaConfig as a, type OrderCancellationResponse as a$, type CreateOrderComment as a0, CreateOrderCommentAuthorTypeEnum as a1, instanceOfCreateOrderComment as a2, CreateOrderCommentFromJSON as a3, CreateOrderCommentFromJSONTyped as a4, CreateOrderCommentToJSON as a5, CreateOrderCommentToJSONTyped as a6, type DeliveryAddress as a7, instanceOfDeliveryAddress as a8, DeliveryAddressFromJSON as a9, InvoiceItemToJSON as aA, InvoiceItemToJSONTyped as aB, type InvoiceOrder as aC, instanceOfInvoiceOrder as aD, InvoiceOrderFromJSON as aE, InvoiceOrderFromJSONTyped as aF, InvoiceOrderToJSON as aG, InvoiceOrderToJSONTyped as aH, type InvoiceOrderItem as aI, instanceOfInvoiceOrderItem as aJ, InvoiceOrderItemFromJSON as aK, InvoiceOrderItemFromJSONTyped as aL, InvoiceOrderItemToJSON as aM, InvoiceOrderItemToJSONTyped as aN, type Me as aO, instanceOfMe as aP, MeFromJSON as aQ, MeFromJSONTyped as aR, MeToJSON as aS, MeToJSONTyped as aT, type Order as aU, OrderPaymentMethodEnum as aV, instanceOfOrder as aW, OrderFromJSON as aX, OrderFromJSONTyped as aY, OrderToJSON as aZ, OrderToJSONTyped as a_, DeliveryAddressFromJSONTyped as aa, DeliveryAddressToJSON as ab, DeliveryAddressToJSONTyped as ac, type GetApiV2DiscountCodesExternal200Response as ad, instanceOfGetApiV2DiscountCodesExternal200Response as ae, GetApiV2DiscountCodesExternal200ResponseFromJSON as af, GetApiV2DiscountCodesExternal200ResponseFromJSONTyped as ag, GetApiV2DiscountCodesExternal200ResponseToJSON as ah, GetApiV2DiscountCodesExternal200ResponseToJSONTyped as ai, type GetApiV2DiscountCodesExternal200ResponseItemsInner as aj, instanceOfGetApiV2DiscountCodesExternal200ResponseItemsInner as ak, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSON as al, GetApiV2DiscountCodesExternal200ResponseItemsInnerFromJSONTyped as am, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSON as an, GetApiV2DiscountCodesExternal200ResponseItemsInnerToJSONTyped as ao, type Invoice as ap, InvoiceDocumentTypeEnum as aq, instanceOfInvoice as ar, InvoiceFromJSON as as, InvoiceFromJSONTyped as at, InvoiceToJSON as au, InvoiceToJSONTyped as av, type InvoiceItem as aw, instanceOfInvoiceItem as ax, InvoiceItemFromJSON as ay, InvoiceItemFromJSONTyped as az, DiscountCodesResource as b, PageOfClientsFromJSONTyped as b$, OrderCancellationResponseDetailsEnum as b0, instanceOfOrderCancellationResponse as b1, OrderCancellationResponseFromJSON as b2, OrderCancellationResponseFromJSONTyped as b3, OrderCancellationResponseToJSON as b4, OrderCancellationResponseToJSONTyped as b5, type OrderComment as b6, OrderCommentAuthorTypeEnum as b7, instanceOfOrderComment as b8, OrderCommentFromJSON as b9, OrderItemStatusFromJSON as bA, OrderItemStatusFromJSONTyped as bB, OrderItemStatusToJSON as bC, OrderItemStatusToJSONTyped as bD, type OrderOriginalData as bE, instanceOfOrderOriginalData as bF, OrderOriginalDataFromJSON as bG, OrderOriginalDataFromJSONTyped as bH, OrderOriginalDataToJSON as bI, OrderOriginalDataToJSONTyped as bJ, type OrderStatus as bK, OrderStatusStatusEnum as bL, instanceOfOrderStatus as bM, OrderStatusFromJSON as bN, OrderStatusFromJSONTyped as bO, OrderStatusToJSON as bP, OrderStatusToJSONTyped as bQ, type OrderStatusChange as bR, OrderStatusChangeStatusEnum as bS, instanceOfOrderStatusChange as bT, OrderStatusChangeFromJSON as bU, OrderStatusChangeFromJSONTyped as bV, OrderStatusChangeToJSON as bW, OrderStatusChangeToJSONTyped as bX, type PageOfClients as bY, instanceOfPageOfClients as bZ, PageOfClientsFromJSON as b_, OrderCommentFromJSONTyped as ba, OrderCommentToJSON as bb, OrderCommentToJSONTyped as bc, type OrderItem as bd, instanceOfOrderItem as be, OrderItemFromJSON as bf, OrderItemFromJSONTyped as bg, OrderItemToJSON as bh, OrderItemToJSONTyped as bi, type OrderItemCropData as bj, OrderItemCropDataFilterEnum as bk, OrderItemCropDataReflectionEnum as bl, instanceOfOrderItemCropData as bm, OrderItemCropDataFromJSON as bn, OrderItemCropDataFromJSONTyped as bo, OrderItemCropDataToJSON as bp, OrderItemCropDataToJSONTyped as bq, type OrderItemOriginalData as br, instanceOfOrderItemOriginalData as bs, OrderItemOriginalDataFromJSON as bt, OrderItemOriginalDataFromJSONTyped as bu, OrderItemOriginalDataToJSON as bv, OrderItemOriginalDataToJSONTyped as bw, type OrderItemStatus as bx, OrderItemStatusStatusEnum as by, instanceOfOrderItemStatus as bz, OrderCommentsResource as c, ReturnLabelToJSONTyped as c$, PageOfClientsToJSON as c0, PageOfClientsToJSONTyped as c1, type PageOfInvoices as c2, instanceOfPageOfInvoices as c3, PageOfInvoicesFromJSON as c4, PageOfInvoicesFromJSONTyped as c5, PageOfInvoicesToJSON as c6, PageOfInvoicesToJSONTyped as c7, type PageOfOrderComments as c8, instanceOfPageOfOrderComments as c9, PostOrderResponseToJSON as cA, PostOrderResponseToJSONTyped as cB, type PostOrderStatus as cC, PostOrderStatusStatusEnum as cD, instanceOfPostOrderStatus as cE, PostOrderStatusFromJSON as cF, PostOrderStatusFromJSONTyped as cG, PostOrderStatusToJSON as cH, PostOrderStatusToJSONTyped as cI, type PostOrderStatusItem as cJ, PostOrderStatusItemStatusEnum as cK, instanceOfPostOrderStatusItem as cL, PostOrderStatusItemFromJSON as cM, PostOrderStatusItemFromJSONTyped as cN, PostOrderStatusItemToJSON as cO, PostOrderStatusItemToJSONTyped as cP, type PostOrderStatusResponse as cQ, instanceOfPostOrderStatusResponse as cR, PostOrderStatusResponseFromJSON as cS, PostOrderStatusResponseFromJSONTyped as cT, PostOrderStatusResponseToJSON as cU, PostOrderStatusResponseToJSONTyped as cV, type ReturnLabel as cW, instanceOfReturnLabel as cX, ReturnLabelFromJSON as cY, ReturnLabelFromJSONTyped as cZ, ReturnLabelToJSON as c_, PageOfOrderCommentsFromJSON as ca, PageOfOrderCommentsFromJSONTyped as cb, PageOfOrderCommentsToJSON as cc, PageOfOrderCommentsToJSONTyped as cd, type PageOfOrderStatusChanges as ce, instanceOfPageOfOrderStatusChanges as cf, PageOfOrderStatusChangesFromJSON as cg, PageOfOrderStatusChangesFromJSONTyped as ch, PageOfOrderStatusChangesToJSON as ci, PageOfOrderStatusChangesToJSONTyped as cj, type PageOfTrackingNumbers as ck, instanceOfPageOfTrackingNumbers as cl, PageOfTrackingNumbersFromJSON as cm, PageOfTrackingNumbersFromJSONTyped as cn, PageOfTrackingNumbersToJSON as co, PageOfTrackingNumbersToJSONTyped as cp, type PostOrderCommentResponse as cq, instanceOfPostOrderCommentResponse as cr, PostOrderCommentResponseFromJSON as cs, PostOrderCommentResponseFromJSONTyped as ct, PostOrderCommentResponseToJSON as cu, PostOrderCommentResponseToJSONTyped as cv, type PostOrderResponse as cw, instanceOfPostOrderResponse as cx, PostOrderResponseFromJSON as cy, PostOrderResponseFromJSONTyped as cz, OrderStatusChangesResource as d, type TrackingNumber as d0, instanceOfTrackingNumber as d1, TrackingNumberFromJSON as d2, TrackingNumberFromJSONTyped as d3, TrackingNumberToJSON as d4, TrackingNumberToJSONTyped as d5, type TrackingNumberItem as d6, instanceOfTrackingNumberItem as d7, TrackingNumberItemFromJSON as d8, TrackingNumberItemFromJSONTyped as d9, type ProductsDataResponse as dA, TrackingNumberItemToJSON as da, TrackingNumberItemToJSONTyped as db, type Waybill as dc, WaybillDeliveryMethodEnum as dd, instanceOfWaybill as de, WaybillFromJSON as df, WaybillFromJSONTyped as dg, WaybillToJSON as dh, WaybillToJSONTyped as di, type BaseLinkerAction as dj, type BaseLinkerConnectorConfig as dk, type ProductsListParams as dl, type ProductsDataParams as dm, type BaseLinkerError as dn, type FileVersionResponse as dp, type SupportedMethodsResponse as dq, type ProductsCategoriesResponse as dr, type ProductsListItem as ds, type ProductsListEntry as dt, type ProductsListResult as du, type ProductsListResponse as dv, type ProductFeature as dw, type ProductFeatureName as dx, type ProductVariant as dy, type ProductData as dz, CatalogResource as e, type OrderCreateParams as f, type OrderStatusUpdateParams as g, type OrderCommentCreateParams as h, type OrderCancelParams as i, type InvoiceListParams as j, type ClientListParams as k, type DiscountCodeListParams as l, type TrackingNumberListParams as m, type OrderCommentListParams as n, type OrderStatusChangeListParams as o, type ApiV2AuthenticationRefreshTokenPost200Response as p, instanceOfApiV2AuthenticationRefreshTokenPost200Response as q, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSON as r, ApiV2AuthenticationRefreshTokenPost200ResponseFromJSONTyped as s, ApiV2AuthenticationRefreshTokenPost200ResponseToJSON as t, ApiV2AuthenticationRefreshTokenPost200ResponseToJSONTyped as u, type ApiV2AuthenticationTokenPost200Response as v, instanceOfApiV2AuthenticationTokenPost200Response as w, ApiV2AuthenticationTokenPost200ResponseFromJSON as x, ApiV2AuthenticationTokenPost200ResponseFromJSONTyped as y, ApiV2AuthenticationTokenPost200ResponseToJSON as z };
|