@teemill/product-catalog 1.15.0 → 1.17.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/.openapi-generator/VERSION +1 -1
- package/README.md +2 -2
- package/api.ts +1232 -179
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +824 -89
- package/dist/api.js +518 -90
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +824 -89
- package/dist/esm/api.js +513 -89
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.17.0
|
|
6
6
|
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,6 +13,19 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AdditionalFile
|
|
20
|
+
*/
|
|
21
|
+
export interface AdditionalFile {
|
|
22
|
+
/**
|
|
23
|
+
* Publicly available file URL.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AdditionalFile
|
|
26
|
+
*/
|
|
27
|
+
'src'?: string;
|
|
28
|
+
}
|
|
16
29
|
/**
|
|
17
30
|
*
|
|
18
31
|
* @export
|
|
@@ -43,7 +56,7 @@ export interface Application {
|
|
|
43
56
|
* @type {string}
|
|
44
57
|
* @memberof Application
|
|
45
58
|
*/
|
|
46
|
-
'technology':
|
|
59
|
+
'technology': ApplicationTechnologyEnum;
|
|
47
60
|
/**
|
|
48
61
|
* Placement of the application. Available placements depend on the chosen product and technology.
|
|
49
62
|
* @type {string}
|
|
@@ -63,6 +76,18 @@ export interface Application {
|
|
|
63
76
|
*/
|
|
64
77
|
'mockup'?: ApplicationMockup;
|
|
65
78
|
}
|
|
79
|
+
export declare const ApplicationTechnologyEnum: {
|
|
80
|
+
readonly Dtg: "dtg";
|
|
81
|
+
readonly Embroidery: "embroidery";
|
|
82
|
+
readonly Dtf: "dtf";
|
|
83
|
+
readonly Pretreat: "pretreat";
|
|
84
|
+
readonly MugSublimation: "mug_sublimation";
|
|
85
|
+
readonly ManualPrint: "manual_print";
|
|
86
|
+
readonly AdditionalApplication: "additional_application";
|
|
87
|
+
readonly NotebookSublimation: "notebook_sublimation";
|
|
88
|
+
readonly DuplexPrint: "duplex_print";
|
|
89
|
+
};
|
|
90
|
+
export type ApplicationTechnologyEnum = typeof ApplicationTechnologyEnum[keyof typeof ApplicationTechnologyEnum];
|
|
66
91
|
export declare const ApplicationPlacementEnum: {
|
|
67
92
|
readonly Front: "front";
|
|
68
93
|
readonly Back: "back";
|
|
@@ -90,6 +115,124 @@ export interface ApplicationMockup {
|
|
|
90
115
|
*/
|
|
91
116
|
'preview'?: string;
|
|
92
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @export
|
|
121
|
+
* @interface ApplicationSet
|
|
122
|
+
*/
|
|
123
|
+
export interface ApplicationSet {
|
|
124
|
+
/**
|
|
125
|
+
* Unique object identifier
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof ApplicationSet
|
|
128
|
+
*/
|
|
129
|
+
'id'?: string;
|
|
130
|
+
/**
|
|
131
|
+
* Name of the application set
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof ApplicationSet
|
|
134
|
+
*/
|
|
135
|
+
'name': string;
|
|
136
|
+
/**
|
|
137
|
+
* Description of the application set
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof ApplicationSet
|
|
140
|
+
*/
|
|
141
|
+
'description'?: string;
|
|
142
|
+
/**
|
|
143
|
+
* The width, in pixels of the images in the set
|
|
144
|
+
* @type {number}
|
|
145
|
+
* @memberof ApplicationSet
|
|
146
|
+
*/
|
|
147
|
+
'width': number;
|
|
148
|
+
/**
|
|
149
|
+
* The height, in pixels of the images in the set
|
|
150
|
+
* @type {number}
|
|
151
|
+
* @memberof ApplicationSet
|
|
152
|
+
*/
|
|
153
|
+
'height': number;
|
|
154
|
+
/**
|
|
155
|
+
* The DPI used when printing the images in the set
|
|
156
|
+
* @type {number}
|
|
157
|
+
* @memberof ApplicationSet
|
|
158
|
+
*/
|
|
159
|
+
'dpi': number;
|
|
160
|
+
/**
|
|
161
|
+
* List of application set records
|
|
162
|
+
* @type {Array<ApplicationSetRecord>}
|
|
163
|
+
* @memberof ApplicationSet
|
|
164
|
+
*/
|
|
165
|
+
'records'?: Array<ApplicationSetRecord>;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @export
|
|
170
|
+
* @interface ApplicationSet1
|
|
171
|
+
*/
|
|
172
|
+
export interface ApplicationSet1 {
|
|
173
|
+
/**
|
|
174
|
+
* Unique object identifier
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof ApplicationSet1
|
|
177
|
+
*/
|
|
178
|
+
'id'?: string;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
*
|
|
182
|
+
* @export
|
|
183
|
+
* @interface ApplicationSetRecord
|
|
184
|
+
*/
|
|
185
|
+
export interface ApplicationSetRecord {
|
|
186
|
+
/**
|
|
187
|
+
* Unique object identifier
|
|
188
|
+
* @type {string}
|
|
189
|
+
* @memberof ApplicationSetRecord
|
|
190
|
+
*/
|
|
191
|
+
'id'?: string;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {ApplicationSet1}
|
|
195
|
+
* @memberof ApplicationSetRecord
|
|
196
|
+
*/
|
|
197
|
+
'set'?: ApplicationSet1;
|
|
198
|
+
/**
|
|
199
|
+
* Name of the option that this record represents
|
|
200
|
+
* @type {string}
|
|
201
|
+
* @memberof ApplicationSetRecord
|
|
202
|
+
*/
|
|
203
|
+
'optionName'?: string;
|
|
204
|
+
/**
|
|
205
|
+
* The value of the option that this record represents
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof ApplicationSetRecord
|
|
208
|
+
*/
|
|
209
|
+
'optionValue'?: string;
|
|
210
|
+
/**
|
|
211
|
+
* List of applications for this record
|
|
212
|
+
* @type {Array<Application>}
|
|
213
|
+
* @memberof ApplicationSetRecord
|
|
214
|
+
*/
|
|
215
|
+
'applications'?: Array<Application>;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @export
|
|
220
|
+
* @interface ApplicationSetsResponse
|
|
221
|
+
*/
|
|
222
|
+
export interface ApplicationSetsResponse {
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {Array<ApplicationSet>}
|
|
226
|
+
* @memberof ApplicationSetsResponse
|
|
227
|
+
*/
|
|
228
|
+
'applicationSets'?: Array<ApplicationSet>;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {number}
|
|
232
|
+
* @memberof ApplicationSetsResponse
|
|
233
|
+
*/
|
|
234
|
+
'nextPageToken'?: number;
|
|
235
|
+
}
|
|
93
236
|
/**
|
|
94
237
|
*
|
|
95
238
|
* @export
|
|
@@ -146,6 +289,49 @@ export declare const AttributeThumbnailTypeEnum: {
|
|
|
146
289
|
readonly Image: "image";
|
|
147
290
|
};
|
|
148
291
|
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
292
|
+
/**
|
|
293
|
+
*
|
|
294
|
+
* @export
|
|
295
|
+
* @interface CreateApplicationSetRequest
|
|
296
|
+
*/
|
|
297
|
+
export interface CreateApplicationSetRequest {
|
|
298
|
+
/**
|
|
299
|
+
* Name of the application set
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof CreateApplicationSetRequest
|
|
302
|
+
*/
|
|
303
|
+
'name'?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Description of the application set
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof CreateApplicationSetRequest
|
|
308
|
+
*/
|
|
309
|
+
'description'?: string;
|
|
310
|
+
/**
|
|
311
|
+
* The width, in pixels of the images in the set
|
|
312
|
+
* @type {number}
|
|
313
|
+
* @memberof CreateApplicationSetRequest
|
|
314
|
+
*/
|
|
315
|
+
'width'?: number;
|
|
316
|
+
/**
|
|
317
|
+
* The height, in pixels of the images in the set
|
|
318
|
+
* @type {number}
|
|
319
|
+
* @memberof CreateApplicationSetRequest
|
|
320
|
+
*/
|
|
321
|
+
'height'?: number;
|
|
322
|
+
/**
|
|
323
|
+
* The DPI used when printing the images in the set
|
|
324
|
+
* @type {number}
|
|
325
|
+
* @memberof CreateApplicationSetRequest
|
|
326
|
+
*/
|
|
327
|
+
'dpi'?: number;
|
|
328
|
+
/**
|
|
329
|
+
* List of application set records
|
|
330
|
+
* @type {Array<ApplicationSetRecord>}
|
|
331
|
+
* @memberof CreateApplicationSetRequest
|
|
332
|
+
*/
|
|
333
|
+
'records'?: Array<ApplicationSetRecord>;
|
|
334
|
+
}
|
|
149
335
|
/**
|
|
150
336
|
*
|
|
151
337
|
* @export
|
|
@@ -194,6 +380,12 @@ export interface CreateProductRequest {
|
|
|
194
380
|
* @memberof CreateProductRequest
|
|
195
381
|
*/
|
|
196
382
|
'tags'?: Array<string>;
|
|
383
|
+
/**
|
|
384
|
+
* Internal tags used for internal searching and filtering.
|
|
385
|
+
* @type {Array<string>}
|
|
386
|
+
* @memberof CreateProductRequest
|
|
387
|
+
*/
|
|
388
|
+
'internalTags'?: Array<string>;
|
|
197
389
|
/**
|
|
198
390
|
* Variants
|
|
199
391
|
* @type {Array<CreateProductVariant>}
|
|
@@ -208,10 +400,23 @@ export interface CreateProductRequest {
|
|
|
208
400
|
'images'?: Array<CreateProductRequestImagesInner>;
|
|
209
401
|
/**
|
|
210
402
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
211
|
-
* @type {Array<
|
|
403
|
+
* @type {Array<CreateProductRequestAdditionalFilesInner>}
|
|
212
404
|
* @memberof CreateProductRequest
|
|
213
405
|
*/
|
|
214
|
-
'additionalFiles'?: Array<
|
|
406
|
+
'additionalFiles'?: Array<CreateProductRequestAdditionalFilesInner>;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @export
|
|
411
|
+
* @interface CreateProductRequestAdditionalFilesInner
|
|
412
|
+
*/
|
|
413
|
+
export interface CreateProductRequestAdditionalFilesInner {
|
|
414
|
+
/**
|
|
415
|
+
* Publicly available file URL.
|
|
416
|
+
* @type {string}
|
|
417
|
+
* @memberof CreateProductRequestAdditionalFilesInner
|
|
418
|
+
*/
|
|
419
|
+
'src'?: string;
|
|
215
420
|
}
|
|
216
421
|
/**
|
|
217
422
|
*
|
|
@@ -271,10 +476,10 @@ export interface CreateProductVariant {
|
|
|
271
476
|
'applications'?: Array<Application>;
|
|
272
477
|
/**
|
|
273
478
|
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the warehouse product provided. Accepts PNG and JPEG files.
|
|
274
|
-
* @type {Array<
|
|
479
|
+
* @type {Array<CreateProductVariantImagesInner>}
|
|
275
480
|
* @memberof CreateProductVariant
|
|
276
481
|
*/
|
|
277
|
-
'images'?: Array<
|
|
482
|
+
'images'?: Array<CreateProductVariantImagesInner>;
|
|
278
483
|
}
|
|
279
484
|
/**
|
|
280
485
|
*
|
|
@@ -287,7 +492,7 @@ export interface CreateProductVariantAttributesInner {
|
|
|
287
492
|
* @type {string}
|
|
288
493
|
* @memberof CreateProductVariantAttributesInner
|
|
289
494
|
*/
|
|
290
|
-
'name':
|
|
495
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
291
496
|
/**
|
|
292
497
|
* Attribute value
|
|
293
498
|
* @type {string}
|
|
@@ -295,6 +500,24 @@ export interface CreateProductVariantAttributesInner {
|
|
|
295
500
|
*/
|
|
296
501
|
'value': string;
|
|
297
502
|
}
|
|
503
|
+
export declare const CreateProductVariantAttributesInnerNameEnum: {
|
|
504
|
+
readonly Size: "Size";
|
|
505
|
+
readonly Colour: "Colour";
|
|
506
|
+
};
|
|
507
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @export
|
|
511
|
+
* @interface CreateProductVariantImagesInner
|
|
512
|
+
*/
|
|
513
|
+
export interface CreateProductVariantImagesInner {
|
|
514
|
+
/**
|
|
515
|
+
* Publicly available file URL.
|
|
516
|
+
* @type {string}
|
|
517
|
+
* @memberof CreateProductVariantImagesInner
|
|
518
|
+
*/
|
|
519
|
+
'src'?: string;
|
|
520
|
+
}
|
|
298
521
|
/**
|
|
299
522
|
* Variant retail price including tax.
|
|
300
523
|
* @export
|
|
@@ -312,8 +535,12 @@ export interface CreateProductVariantRetailPrice {
|
|
|
312
535
|
* @type {string}
|
|
313
536
|
* @memberof CreateProductVariantRetailPrice
|
|
314
537
|
*/
|
|
315
|
-
'currencyCode':
|
|
538
|
+
'currencyCode': CreateProductVariantRetailPriceCurrencyCodeEnum;
|
|
316
539
|
}
|
|
540
|
+
export declare const CreateProductVariantRetailPriceCurrencyCodeEnum: {
|
|
541
|
+
readonly Gbp: "GBP";
|
|
542
|
+
};
|
|
543
|
+
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
317
544
|
/**
|
|
318
545
|
* Image description
|
|
319
546
|
* @export
|
|
@@ -366,28 +593,28 @@ export interface Image {
|
|
|
366
593
|
/**
|
|
367
594
|
*
|
|
368
595
|
* @export
|
|
369
|
-
* @interface
|
|
596
|
+
* @interface ImageFile
|
|
370
597
|
*/
|
|
371
|
-
export interface
|
|
598
|
+
export interface ImageFile {
|
|
372
599
|
/**
|
|
373
|
-
*
|
|
600
|
+
* Publicly available file URL.
|
|
374
601
|
* @type {string}
|
|
375
|
-
* @memberof
|
|
602
|
+
* @memberof ImageFile
|
|
376
603
|
*/
|
|
377
|
-
'
|
|
604
|
+
'src'?: string;
|
|
378
605
|
}
|
|
379
606
|
/**
|
|
380
607
|
*
|
|
381
608
|
* @export
|
|
382
|
-
* @interface
|
|
609
|
+
* @interface ImportProducts200Response
|
|
383
610
|
*/
|
|
384
|
-
export interface
|
|
611
|
+
export interface ImportProducts200Response {
|
|
385
612
|
/**
|
|
386
|
-
*
|
|
613
|
+
* Id of the product import
|
|
387
614
|
* @type {string}
|
|
388
|
-
* @memberof
|
|
615
|
+
* @memberof ImportProducts200Response
|
|
389
616
|
*/
|
|
390
|
-
'
|
|
617
|
+
'importId'?: string;
|
|
391
618
|
}
|
|
392
619
|
/**
|
|
393
620
|
* Standard price definition that defines the amount, tax rate and currency.
|
|
@@ -406,8 +633,12 @@ export interface Price {
|
|
|
406
633
|
* @type {string}
|
|
407
634
|
* @memberof Price
|
|
408
635
|
*/
|
|
409
|
-
'currencyCode'?:
|
|
636
|
+
'currencyCode'?: PriceCurrencyCodeEnum;
|
|
410
637
|
}
|
|
638
|
+
export declare const PriceCurrencyCodeEnum: {
|
|
639
|
+
readonly Gbp: "GBP";
|
|
640
|
+
};
|
|
641
|
+
export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
|
|
411
642
|
/**
|
|
412
643
|
*
|
|
413
644
|
* @export
|
|
@@ -462,6 +693,12 @@ export interface Product {
|
|
|
462
693
|
* @memberof Product
|
|
463
694
|
*/
|
|
464
695
|
'tags'?: Array<string>;
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @type {Array<string>}
|
|
699
|
+
* @memberof Product
|
|
700
|
+
*/
|
|
701
|
+
'internalTags'?: Array<string>;
|
|
465
702
|
/**
|
|
466
703
|
*
|
|
467
704
|
* @type {string}
|
|
@@ -611,6 +848,12 @@ export interface UpdateProductRequest {
|
|
|
611
848
|
* @memberof UpdateProductRequest
|
|
612
849
|
*/
|
|
613
850
|
'tags'?: Array<string>;
|
|
851
|
+
/**
|
|
852
|
+
* Additional product tags used for internal searching and filtering.
|
|
853
|
+
* @type {Array<string>}
|
|
854
|
+
* @memberof UpdateProductRequest
|
|
855
|
+
*/
|
|
856
|
+
'internalTags'?: Array<string>;
|
|
614
857
|
/**
|
|
615
858
|
* Variants
|
|
616
859
|
* @type {Array<CreateProductVariant>}
|
|
@@ -619,16 +862,16 @@ export interface UpdateProductRequest {
|
|
|
619
862
|
'variants'?: Array<CreateProductVariant>;
|
|
620
863
|
/**
|
|
621
864
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
622
|
-
* @type {Array<
|
|
865
|
+
* @type {Array<ImageFile>}
|
|
623
866
|
* @memberof UpdateProductRequest
|
|
624
867
|
*/
|
|
625
|
-
'images'?: Array<
|
|
868
|
+
'images'?: Array<ImageFile>;
|
|
626
869
|
/**
|
|
627
870
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
628
|
-
* @type {Array<
|
|
871
|
+
* @type {Array<AdditionalFile>}
|
|
629
872
|
* @memberof UpdateProductRequest
|
|
630
873
|
*/
|
|
631
|
-
'additionalFiles'?: Array<
|
|
874
|
+
'additionalFiles'?: Array<AdditionalFile>;
|
|
632
875
|
}
|
|
633
876
|
/**
|
|
634
877
|
*
|
|
@@ -771,6 +1014,326 @@ export interface VariantsResponse {
|
|
|
771
1014
|
*/
|
|
772
1015
|
'nextPageToken'?: number;
|
|
773
1016
|
}
|
|
1017
|
+
/**
|
|
1018
|
+
* ApplicationSetsApi - axios parameter creator
|
|
1019
|
+
* @export
|
|
1020
|
+
*/
|
|
1021
|
+
export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1022
|
+
/**
|
|
1023
|
+
* Creates a new application set.
|
|
1024
|
+
* @summary Create application set
|
|
1025
|
+
* @param {string} project What project it is
|
|
1026
|
+
* @param {CreateApplicationSetRequest} [createApplicationSetRequest] Create a new application set.
|
|
1027
|
+
* @param {*} [options] Override http request option.
|
|
1028
|
+
* @throws {RequiredError}
|
|
1029
|
+
*/
|
|
1030
|
+
createApplicationSet: (project: string, createApplicationSetRequest?: CreateApplicationSetRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Deletes an existing application set.
|
|
1033
|
+
* @summary Delete an application set
|
|
1034
|
+
* @param {string} project What project it is
|
|
1035
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @throws {RequiredError}
|
|
1038
|
+
*/
|
|
1039
|
+
deleteApplicationSet: (project: string, applicationSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1040
|
+
/**
|
|
1041
|
+
* Get an application by the given id.
|
|
1042
|
+
* @summary Get an application set
|
|
1043
|
+
* @param {string} project What project it is
|
|
1044
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1045
|
+
* @param {*} [options] Override http request option.
|
|
1046
|
+
* @throws {RequiredError}
|
|
1047
|
+
*/
|
|
1048
|
+
getApplicationSet: (project: string, applicationSetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1049
|
+
/**
|
|
1050
|
+
* Lists all application sets that belong to the given project.
|
|
1051
|
+
* @summary List application sets
|
|
1052
|
+
* @param {string} project What project it is
|
|
1053
|
+
* @param {number} [pageToken] Page reference token
|
|
1054
|
+
* @param {string} [search] Search term to filter based on product tags.
|
|
1055
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1056
|
+
* @param {*} [options] Override http request option.
|
|
1057
|
+
* @throws {RequiredError}
|
|
1058
|
+
*/
|
|
1059
|
+
listApplicationSets: (project: string, pageToken?: number, search?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Updates an existing application set.
|
|
1062
|
+
* @summary Update application set
|
|
1063
|
+
* @param {string} project What project it is
|
|
1064
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1065
|
+
* @param {CreateApplicationSetRequest} [createApplicationSetRequest] Create a new application set.
|
|
1066
|
+
* @param {*} [options] Override http request option.
|
|
1067
|
+
* @throws {RequiredError}
|
|
1068
|
+
*/
|
|
1069
|
+
updateApplicationSet: (project: string, applicationSetId: string, createApplicationSetRequest?: CreateApplicationSetRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1070
|
+
};
|
|
1071
|
+
/**
|
|
1072
|
+
* ApplicationSetsApi - functional programming interface
|
|
1073
|
+
* @export
|
|
1074
|
+
*/
|
|
1075
|
+
export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
|
|
1076
|
+
/**
|
|
1077
|
+
* Creates a new application set.
|
|
1078
|
+
* @summary Create application set
|
|
1079
|
+
* @param {string} project What project it is
|
|
1080
|
+
* @param {CreateApplicationSetRequest} [createApplicationSetRequest] Create a new application set.
|
|
1081
|
+
* @param {*} [options] Override http request option.
|
|
1082
|
+
* @throws {RequiredError}
|
|
1083
|
+
*/
|
|
1084
|
+
createApplicationSet(project: string, createApplicationSetRequest?: CreateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationSet>>;
|
|
1085
|
+
/**
|
|
1086
|
+
* Deletes an existing application set.
|
|
1087
|
+
* @summary Delete an application set
|
|
1088
|
+
* @param {string} project What project it is
|
|
1089
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1090
|
+
* @param {*} [options] Override http request option.
|
|
1091
|
+
* @throws {RequiredError}
|
|
1092
|
+
*/
|
|
1093
|
+
deleteApplicationSet(project: string, applicationSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1094
|
+
/**
|
|
1095
|
+
* Get an application by the given id.
|
|
1096
|
+
* @summary Get an application set
|
|
1097
|
+
* @param {string} project What project it is
|
|
1098
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
getApplicationSet(project: string, applicationSetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationSet>>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Lists all application sets that belong to the given project.
|
|
1105
|
+
* @summary List application sets
|
|
1106
|
+
* @param {string} project What project it is
|
|
1107
|
+
* @param {number} [pageToken] Page reference token
|
|
1108
|
+
* @param {string} [search] Search term to filter based on product tags.
|
|
1109
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
*/
|
|
1113
|
+
listApplicationSets(project: string, pageToken?: number, search?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationSetsResponse>>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Updates an existing application set.
|
|
1116
|
+
* @summary Update application set
|
|
1117
|
+
* @param {string} project What project it is
|
|
1118
|
+
* @param {string} applicationSetId Application set\'s unique identifier
|
|
1119
|
+
* @param {CreateApplicationSetRequest} [createApplicationSetRequest] Create a new application set.
|
|
1120
|
+
* @param {*} [options] Override http request option.
|
|
1121
|
+
* @throws {RequiredError}
|
|
1122
|
+
*/
|
|
1123
|
+
updateApplicationSet(project: string, applicationSetId: string, createApplicationSetRequest?: CreateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationSet>>;
|
|
1124
|
+
};
|
|
1125
|
+
/**
|
|
1126
|
+
* ApplicationSetsApi - factory interface
|
|
1127
|
+
* @export
|
|
1128
|
+
*/
|
|
1129
|
+
export declare const ApplicationSetsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1130
|
+
/**
|
|
1131
|
+
* Creates a new application set.
|
|
1132
|
+
* @summary Create application set
|
|
1133
|
+
* @param {ApplicationSetsApiCreateApplicationSetRequest} requestParameters Request parameters.
|
|
1134
|
+
* @param {*} [options] Override http request option.
|
|
1135
|
+
* @throws {RequiredError}
|
|
1136
|
+
*/
|
|
1137
|
+
createApplicationSet(requestParameters: ApplicationSetsApiCreateApplicationSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationSet>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Deletes an existing application set.
|
|
1140
|
+
* @summary Delete an application set
|
|
1141
|
+
* @param {ApplicationSetsApiDeleteApplicationSetRequest} requestParameters Request parameters.
|
|
1142
|
+
* @param {*} [options] Override http request option.
|
|
1143
|
+
* @throws {RequiredError}
|
|
1144
|
+
*/
|
|
1145
|
+
deleteApplicationSet(requestParameters: ApplicationSetsApiDeleteApplicationSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Get an application by the given id.
|
|
1148
|
+
* @summary Get an application set
|
|
1149
|
+
* @param {ApplicationSetsApiGetApplicationSetRequest} requestParameters Request parameters.
|
|
1150
|
+
* @param {*} [options] Override http request option.
|
|
1151
|
+
* @throws {RequiredError}
|
|
1152
|
+
*/
|
|
1153
|
+
getApplicationSet(requestParameters: ApplicationSetsApiGetApplicationSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationSet>;
|
|
1154
|
+
/**
|
|
1155
|
+
* Lists all application sets that belong to the given project.
|
|
1156
|
+
* @summary List application sets
|
|
1157
|
+
* @param {ApplicationSetsApiListApplicationSetsRequest} requestParameters Request parameters.
|
|
1158
|
+
* @param {*} [options] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
*/
|
|
1161
|
+
listApplicationSets(requestParameters: ApplicationSetsApiListApplicationSetsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationSetsResponse>;
|
|
1162
|
+
/**
|
|
1163
|
+
* Updates an existing application set.
|
|
1164
|
+
* @summary Update application set
|
|
1165
|
+
* @param {ApplicationSetsApiUpdateApplicationSetRequest} requestParameters Request parameters.
|
|
1166
|
+
* @param {*} [options] Override http request option.
|
|
1167
|
+
* @throws {RequiredError}
|
|
1168
|
+
*/
|
|
1169
|
+
updateApplicationSet(requestParameters: ApplicationSetsApiUpdateApplicationSetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ApplicationSet>;
|
|
1170
|
+
};
|
|
1171
|
+
/**
|
|
1172
|
+
* Request parameters for createApplicationSet operation in ApplicationSetsApi.
|
|
1173
|
+
* @export
|
|
1174
|
+
* @interface ApplicationSetsApiCreateApplicationSetRequest
|
|
1175
|
+
*/
|
|
1176
|
+
export interface ApplicationSetsApiCreateApplicationSetRequest {
|
|
1177
|
+
/**
|
|
1178
|
+
* What project it is
|
|
1179
|
+
* @type {string}
|
|
1180
|
+
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
1181
|
+
*/
|
|
1182
|
+
readonly project: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* Create a new application set.
|
|
1185
|
+
* @type {CreateApplicationSetRequest}
|
|
1186
|
+
* @memberof ApplicationSetsApiCreateApplicationSet
|
|
1187
|
+
*/
|
|
1188
|
+
readonly createApplicationSetRequest?: CreateApplicationSetRequest;
|
|
1189
|
+
}
|
|
1190
|
+
/**
|
|
1191
|
+
* Request parameters for deleteApplicationSet operation in ApplicationSetsApi.
|
|
1192
|
+
* @export
|
|
1193
|
+
* @interface ApplicationSetsApiDeleteApplicationSetRequest
|
|
1194
|
+
*/
|
|
1195
|
+
export interface ApplicationSetsApiDeleteApplicationSetRequest {
|
|
1196
|
+
/**
|
|
1197
|
+
* What project it is
|
|
1198
|
+
* @type {string}
|
|
1199
|
+
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
1200
|
+
*/
|
|
1201
|
+
readonly project: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* Application set\'s unique identifier
|
|
1204
|
+
* @type {string}
|
|
1205
|
+
* @memberof ApplicationSetsApiDeleteApplicationSet
|
|
1206
|
+
*/
|
|
1207
|
+
readonly applicationSetId: string;
|
|
1208
|
+
}
|
|
1209
|
+
/**
|
|
1210
|
+
* Request parameters for getApplicationSet operation in ApplicationSetsApi.
|
|
1211
|
+
* @export
|
|
1212
|
+
* @interface ApplicationSetsApiGetApplicationSetRequest
|
|
1213
|
+
*/
|
|
1214
|
+
export interface ApplicationSetsApiGetApplicationSetRequest {
|
|
1215
|
+
/**
|
|
1216
|
+
* What project it is
|
|
1217
|
+
* @type {string}
|
|
1218
|
+
* @memberof ApplicationSetsApiGetApplicationSet
|
|
1219
|
+
*/
|
|
1220
|
+
readonly project: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* Application set\'s unique identifier
|
|
1223
|
+
* @type {string}
|
|
1224
|
+
* @memberof ApplicationSetsApiGetApplicationSet
|
|
1225
|
+
*/
|
|
1226
|
+
readonly applicationSetId: string;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Request parameters for listApplicationSets operation in ApplicationSetsApi.
|
|
1230
|
+
* @export
|
|
1231
|
+
* @interface ApplicationSetsApiListApplicationSetsRequest
|
|
1232
|
+
*/
|
|
1233
|
+
export interface ApplicationSetsApiListApplicationSetsRequest {
|
|
1234
|
+
/**
|
|
1235
|
+
* What project it is
|
|
1236
|
+
* @type {string}
|
|
1237
|
+
* @memberof ApplicationSetsApiListApplicationSets
|
|
1238
|
+
*/
|
|
1239
|
+
readonly project: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* Page reference token
|
|
1242
|
+
* @type {number}
|
|
1243
|
+
* @memberof ApplicationSetsApiListApplicationSets
|
|
1244
|
+
*/
|
|
1245
|
+
readonly pageToken?: number;
|
|
1246
|
+
/**
|
|
1247
|
+
* Search term to filter based on product tags.
|
|
1248
|
+
* @type {string}
|
|
1249
|
+
* @memberof ApplicationSetsApiListApplicationSets
|
|
1250
|
+
*/
|
|
1251
|
+
readonly search?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1254
|
+
* @type {number}
|
|
1255
|
+
* @memberof ApplicationSetsApiListApplicationSets
|
|
1256
|
+
*/
|
|
1257
|
+
readonly pageSize?: number;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* Request parameters for updateApplicationSet operation in ApplicationSetsApi.
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface ApplicationSetsApiUpdateApplicationSetRequest
|
|
1263
|
+
*/
|
|
1264
|
+
export interface ApplicationSetsApiUpdateApplicationSetRequest {
|
|
1265
|
+
/**
|
|
1266
|
+
* What project it is
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
1269
|
+
*/
|
|
1270
|
+
readonly project: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* Application set\'s unique identifier
|
|
1273
|
+
* @type {string}
|
|
1274
|
+
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
1275
|
+
*/
|
|
1276
|
+
readonly applicationSetId: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Create a new application set.
|
|
1279
|
+
* @type {CreateApplicationSetRequest}
|
|
1280
|
+
* @memberof ApplicationSetsApiUpdateApplicationSet
|
|
1281
|
+
*/
|
|
1282
|
+
readonly createApplicationSetRequest?: CreateApplicationSetRequest;
|
|
1283
|
+
}
|
|
1284
|
+
/**
|
|
1285
|
+
* ApplicationSetsApi - object-oriented interface
|
|
1286
|
+
* @export
|
|
1287
|
+
* @class ApplicationSetsApi
|
|
1288
|
+
* @extends {BaseAPI}
|
|
1289
|
+
*/
|
|
1290
|
+
export declare class ApplicationSetsApi extends BaseAPI {
|
|
1291
|
+
/**
|
|
1292
|
+
* Creates a new application set.
|
|
1293
|
+
* @summary Create application set
|
|
1294
|
+
* @param {ApplicationSetsApiCreateApplicationSetRequest} requestParameters Request parameters.
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
* @memberof ApplicationSetsApi
|
|
1298
|
+
*/
|
|
1299
|
+
createApplicationSet(requestParameters: ApplicationSetsApiCreateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Deletes an existing application set.
|
|
1302
|
+
* @summary Delete an application set
|
|
1303
|
+
* @param {ApplicationSetsApiDeleteApplicationSetRequest} requestParameters Request parameters.
|
|
1304
|
+
* @param {*} [options] Override http request option.
|
|
1305
|
+
* @throws {RequiredError}
|
|
1306
|
+
* @memberof ApplicationSetsApi
|
|
1307
|
+
*/
|
|
1308
|
+
deleteApplicationSet(requestParameters: ApplicationSetsApiDeleteApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1309
|
+
/**
|
|
1310
|
+
* Get an application by the given id.
|
|
1311
|
+
* @summary Get an application set
|
|
1312
|
+
* @param {ApplicationSetsApiGetApplicationSetRequest} requestParameters Request parameters.
|
|
1313
|
+
* @param {*} [options] Override http request option.
|
|
1314
|
+
* @throws {RequiredError}
|
|
1315
|
+
* @memberof ApplicationSetsApi
|
|
1316
|
+
*/
|
|
1317
|
+
getApplicationSet(requestParameters: ApplicationSetsApiGetApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
1318
|
+
/**
|
|
1319
|
+
* Lists all application sets that belong to the given project.
|
|
1320
|
+
* @summary List application sets
|
|
1321
|
+
* @param {ApplicationSetsApiListApplicationSetsRequest} requestParameters Request parameters.
|
|
1322
|
+
* @param {*} [options] Override http request option.
|
|
1323
|
+
* @throws {RequiredError}
|
|
1324
|
+
* @memberof ApplicationSetsApi
|
|
1325
|
+
*/
|
|
1326
|
+
listApplicationSets(requestParameters: ApplicationSetsApiListApplicationSetsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSetsResponse, any>>;
|
|
1327
|
+
/**
|
|
1328
|
+
* Updates an existing application set.
|
|
1329
|
+
* @summary Update application set
|
|
1330
|
+
* @param {ApplicationSetsApiUpdateApplicationSetRequest} requestParameters Request parameters.
|
|
1331
|
+
* @param {*} [options] Override http request option.
|
|
1332
|
+
* @throws {RequiredError}
|
|
1333
|
+
* @memberof ApplicationSetsApi
|
|
1334
|
+
*/
|
|
1335
|
+
updateApplicationSet(requestParameters: ApplicationSetsApiUpdateApplicationSetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationSet, any>>;
|
|
1336
|
+
}
|
|
774
1337
|
/**
|
|
775
1338
|
* ProductsApi - axios parameter creator
|
|
776
1339
|
* @export
|
|
@@ -909,63 +1472,196 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
909
1472
|
/**
|
|
910
1473
|
* Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
|
|
911
1474
|
* @summary Create product
|
|
912
|
-
* @param {
|
|
913
|
-
* @param {CreateProductRequest} [createProductRequest]
|
|
1475
|
+
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
914
1476
|
* @param {*} [options] Override http request option.
|
|
915
1477
|
* @throws {RequiredError}
|
|
916
1478
|
*/
|
|
917
|
-
createProduct(
|
|
1479
|
+
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
918
1480
|
/**
|
|
919
1481
|
* Deletes a catalog product
|
|
920
1482
|
* @summary Delete catalog product
|
|
921
|
-
* @param {
|
|
922
|
-
* @param {string} productId Product\'s unique identifier
|
|
1483
|
+
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
923
1484
|
* @param {*} [options] Override http request option.
|
|
924
1485
|
* @throws {RequiredError}
|
|
925
1486
|
*/
|
|
926
|
-
deleteProduct(
|
|
1487
|
+
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
927
1488
|
/**
|
|
928
1489
|
* Gets a product by a given ID.
|
|
929
1490
|
* @summary Get product
|
|
930
|
-
* @param {
|
|
931
|
-
* @param {string} productId Product\'s unique identifier
|
|
932
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1491
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
933
1492
|
* @param {*} [options] Override http request option.
|
|
934
1493
|
* @throws {RequiredError}
|
|
935
1494
|
*/
|
|
936
|
-
getProduct(
|
|
1495
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
937
1496
|
/**
|
|
938
1497
|
* Lists all enabled store listing products attached to the given project.
|
|
939
1498
|
* @summary List products
|
|
940
|
-
* @param {
|
|
941
|
-
* @param {number} [pageToken] Page reference token
|
|
942
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
943
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
944
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1499
|
+
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
945
1500
|
* @param {*} [options] Override http request option.
|
|
946
1501
|
* @throws {RequiredError}
|
|
947
1502
|
*/
|
|
948
|
-
getProducts(
|
|
1503
|
+
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
949
1504
|
/**
|
|
950
1505
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
951
1506
|
* @summary Import products
|
|
952
|
-
* @param {
|
|
953
|
-
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
1507
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
954
1508
|
* @param {*} [options] Override http request option.
|
|
955
1509
|
* @throws {RequiredError}
|
|
956
1510
|
*/
|
|
957
|
-
importProducts(
|
|
1511
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
|
|
958
1512
|
/**
|
|
959
1513
|
* Updates a product by a given ID.
|
|
960
1514
|
* @summary Update product
|
|
961
|
-
* @param {
|
|
962
|
-
* @param {string} productId Product\'s unique identifier
|
|
963
|
-
* @param {UpdateProductRequest} [updateProductRequest]
|
|
1515
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
964
1516
|
* @param {*} [options] Override http request option.
|
|
965
1517
|
* @throws {RequiredError}
|
|
966
1518
|
*/
|
|
967
|
-
updateProduct(
|
|
1519
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
968
1520
|
};
|
|
1521
|
+
/**
|
|
1522
|
+
* Request parameters for createProduct operation in ProductsApi.
|
|
1523
|
+
* @export
|
|
1524
|
+
* @interface ProductsApiCreateProductRequest
|
|
1525
|
+
*/
|
|
1526
|
+
export interface ProductsApiCreateProductRequest {
|
|
1527
|
+
/**
|
|
1528
|
+
* What project it is
|
|
1529
|
+
* @type {string}
|
|
1530
|
+
* @memberof ProductsApiCreateProduct
|
|
1531
|
+
*/
|
|
1532
|
+
readonly project: string;
|
|
1533
|
+
/**
|
|
1534
|
+
*
|
|
1535
|
+
* @type {CreateProductRequest}
|
|
1536
|
+
* @memberof ProductsApiCreateProduct
|
|
1537
|
+
*/
|
|
1538
|
+
readonly createProductRequest?: CreateProductRequest;
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Request parameters for deleteProduct operation in ProductsApi.
|
|
1542
|
+
* @export
|
|
1543
|
+
* @interface ProductsApiDeleteProductRequest
|
|
1544
|
+
*/
|
|
1545
|
+
export interface ProductsApiDeleteProductRequest {
|
|
1546
|
+
/**
|
|
1547
|
+
* What project it is
|
|
1548
|
+
* @type {string}
|
|
1549
|
+
* @memberof ProductsApiDeleteProduct
|
|
1550
|
+
*/
|
|
1551
|
+
readonly project: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* Product\'s unique identifier
|
|
1554
|
+
* @type {string}
|
|
1555
|
+
* @memberof ProductsApiDeleteProduct
|
|
1556
|
+
*/
|
|
1557
|
+
readonly productId: string;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
1561
|
+
* @export
|
|
1562
|
+
* @interface ProductsApiGetProductRequest
|
|
1563
|
+
*/
|
|
1564
|
+
export interface ProductsApiGetProductRequest {
|
|
1565
|
+
/**
|
|
1566
|
+
* What project it is
|
|
1567
|
+
* @type {string}
|
|
1568
|
+
* @memberof ProductsApiGetProduct
|
|
1569
|
+
*/
|
|
1570
|
+
readonly project: string;
|
|
1571
|
+
/**
|
|
1572
|
+
* Product\'s unique identifier
|
|
1573
|
+
* @type {string}
|
|
1574
|
+
* @memberof ProductsApiGetProduct
|
|
1575
|
+
*/
|
|
1576
|
+
readonly productId: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* Filter response fields to only include a subset of the resource.
|
|
1579
|
+
* @type {string}
|
|
1580
|
+
* @memberof ProductsApiGetProduct
|
|
1581
|
+
*/
|
|
1582
|
+
readonly fields?: string;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* Request parameters for getProducts operation in ProductsApi.
|
|
1586
|
+
* @export
|
|
1587
|
+
* @interface ProductsApiGetProductsRequest
|
|
1588
|
+
*/
|
|
1589
|
+
export interface ProductsApiGetProductsRequest {
|
|
1590
|
+
/**
|
|
1591
|
+
* What project it is
|
|
1592
|
+
* @type {string}
|
|
1593
|
+
* @memberof ProductsApiGetProducts
|
|
1594
|
+
*/
|
|
1595
|
+
readonly project: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* Page reference token
|
|
1598
|
+
* @type {number}
|
|
1599
|
+
* @memberof ProductsApiGetProducts
|
|
1600
|
+
*/
|
|
1601
|
+
readonly pageToken?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Search term to filter based on product tags.
|
|
1604
|
+
* @type {string}
|
|
1605
|
+
* @memberof ProductsApiGetProducts
|
|
1606
|
+
*/
|
|
1607
|
+
readonly search?: string;
|
|
1608
|
+
/**
|
|
1609
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1610
|
+
* @type {number}
|
|
1611
|
+
* @memberof ProductsApiGetProducts
|
|
1612
|
+
*/
|
|
1613
|
+
readonly pageSize?: number;
|
|
1614
|
+
/**
|
|
1615
|
+
* Filter response fields to only include a subset of the resource.
|
|
1616
|
+
* @type {string}
|
|
1617
|
+
* @memberof ProductsApiGetProducts
|
|
1618
|
+
*/
|
|
1619
|
+
readonly fields?: string;
|
|
1620
|
+
}
|
|
1621
|
+
/**
|
|
1622
|
+
* Request parameters for importProducts operation in ProductsApi.
|
|
1623
|
+
* @export
|
|
1624
|
+
* @interface ProductsApiImportProductsRequest
|
|
1625
|
+
*/
|
|
1626
|
+
export interface ProductsApiImportProductsRequest {
|
|
1627
|
+
/**
|
|
1628
|
+
* What project it is
|
|
1629
|
+
* @type {string}
|
|
1630
|
+
* @memberof ProductsApiImportProducts
|
|
1631
|
+
*/
|
|
1632
|
+
readonly project: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* A data URL of a CSV file containing data for one or more products.
|
|
1635
|
+
* @type {string}
|
|
1636
|
+
* @memberof ProductsApiImportProducts
|
|
1637
|
+
*/
|
|
1638
|
+
readonly body?: string;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* Request parameters for updateProduct operation in ProductsApi.
|
|
1642
|
+
* @export
|
|
1643
|
+
* @interface ProductsApiUpdateProductRequest
|
|
1644
|
+
*/
|
|
1645
|
+
export interface ProductsApiUpdateProductRequest {
|
|
1646
|
+
/**
|
|
1647
|
+
* What project it is
|
|
1648
|
+
* @type {string}
|
|
1649
|
+
* @memberof ProductsApiUpdateProduct
|
|
1650
|
+
*/
|
|
1651
|
+
readonly project: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* Product\'s unique identifier
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof ProductsApiUpdateProduct
|
|
1656
|
+
*/
|
|
1657
|
+
readonly productId: string;
|
|
1658
|
+
/**
|
|
1659
|
+
*
|
|
1660
|
+
* @type {UpdateProductRequest}
|
|
1661
|
+
* @memberof ProductsApiUpdateProduct
|
|
1662
|
+
*/
|
|
1663
|
+
readonly updateProductRequest?: UpdateProductRequest;
|
|
1664
|
+
}
|
|
969
1665
|
/**
|
|
970
1666
|
* ProductsApi - object-oriented interface
|
|
971
1667
|
* @export
|
|
@@ -976,68 +1672,57 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
976
1672
|
/**
|
|
977
1673
|
* Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
|
|
978
1674
|
* @summary Create product
|
|
979
|
-
* @param {
|
|
980
|
-
* @param {CreateProductRequest} [createProductRequest]
|
|
1675
|
+
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
981
1676
|
* @param {*} [options] Override http request option.
|
|
982
1677
|
* @throws {RequiredError}
|
|
983
1678
|
* @memberof ProductsApi
|
|
984
1679
|
*/
|
|
985
|
-
createProduct(
|
|
1680
|
+
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
986
1681
|
/**
|
|
987
1682
|
* Deletes a catalog product
|
|
988
1683
|
* @summary Delete catalog product
|
|
989
|
-
* @param {
|
|
990
|
-
* @param {string} productId Product\'s unique identifier
|
|
1684
|
+
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
991
1685
|
* @param {*} [options] Override http request option.
|
|
992
1686
|
* @throws {RequiredError}
|
|
993
1687
|
* @memberof ProductsApi
|
|
994
1688
|
*/
|
|
995
|
-
deleteProduct(
|
|
1689
|
+
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
996
1690
|
/**
|
|
997
1691
|
* Gets a product by a given ID.
|
|
998
1692
|
* @summary Get product
|
|
999
|
-
* @param {
|
|
1000
|
-
* @param {string} productId Product\'s unique identifier
|
|
1001
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1693
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
1002
1694
|
* @param {*} [options] Override http request option.
|
|
1003
1695
|
* @throws {RequiredError}
|
|
1004
1696
|
* @memberof ProductsApi
|
|
1005
1697
|
*/
|
|
1006
|
-
getProduct(
|
|
1698
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
1007
1699
|
/**
|
|
1008
1700
|
* Lists all enabled store listing products attached to the given project.
|
|
1009
1701
|
* @summary List products
|
|
1010
|
-
* @param {
|
|
1011
|
-
* @param {number} [pageToken] Page reference token
|
|
1012
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
1013
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1014
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1702
|
+
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
1015
1703
|
* @param {*} [options] Override http request option.
|
|
1016
1704
|
* @throws {RequiredError}
|
|
1017
1705
|
* @memberof ProductsApi
|
|
1018
1706
|
*/
|
|
1019
|
-
getProducts(
|
|
1707
|
+
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
1020
1708
|
/**
|
|
1021
1709
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1022
1710
|
* @summary Import products
|
|
1023
|
-
* @param {
|
|
1024
|
-
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
1711
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
1025
1712
|
* @param {*} [options] Override http request option.
|
|
1026
1713
|
* @throws {RequiredError}
|
|
1027
1714
|
* @memberof ProductsApi
|
|
1028
1715
|
*/
|
|
1029
|
-
importProducts(
|
|
1716
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
1030
1717
|
/**
|
|
1031
1718
|
* Updates a product by a given ID.
|
|
1032
1719
|
* @summary Update product
|
|
1033
|
-
* @param {
|
|
1034
|
-
* @param {string} productId Product\'s unique identifier
|
|
1035
|
-
* @param {UpdateProductRequest} [updateProductRequest]
|
|
1720
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
1036
1721
|
* @param {*} [options] Override http request option.
|
|
1037
1722
|
* @throws {RequiredError}
|
|
1038
1723
|
* @memberof ProductsApi
|
|
1039
1724
|
*/
|
|
1040
|
-
updateProduct(
|
|
1725
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
1041
1726
|
}
|
|
1042
1727
|
/**
|
|
1043
1728
|
* VariantsApi - axios parameter creator
|
|
@@ -1103,26 +1788,82 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
|
|
|
1103
1788
|
/**
|
|
1104
1789
|
* Gets a variant by a given ID.
|
|
1105
1790
|
* @summary Get variant
|
|
1106
|
-
* @param {
|
|
1107
|
-
* @param {string} variantId Variants unique identifier
|
|
1108
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1791
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1109
1792
|
* @param {*} [options] Override http request option.
|
|
1110
1793
|
* @throws {RequiredError}
|
|
1111
1794
|
*/
|
|
1112
|
-
getVariant(
|
|
1795
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
1113
1796
|
/**
|
|
1114
1797
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1115
1798
|
* @summary List variants
|
|
1116
|
-
* @param {
|
|
1117
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
1118
|
-
* @param {number} [pageToken] Page reference token
|
|
1119
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1120
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1799
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1121
1800
|
* @param {*} [options] Override http request option.
|
|
1122
1801
|
* @throws {RequiredError}
|
|
1123
1802
|
*/
|
|
1124
|
-
listVariants(
|
|
1803
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse>;
|
|
1125
1804
|
};
|
|
1805
|
+
/**
|
|
1806
|
+
* Request parameters for getVariant operation in VariantsApi.
|
|
1807
|
+
* @export
|
|
1808
|
+
* @interface VariantsApiGetVariantRequest
|
|
1809
|
+
*/
|
|
1810
|
+
export interface VariantsApiGetVariantRequest {
|
|
1811
|
+
/**
|
|
1812
|
+
* What project it is
|
|
1813
|
+
* @type {string}
|
|
1814
|
+
* @memberof VariantsApiGetVariant
|
|
1815
|
+
*/
|
|
1816
|
+
readonly project: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Variants unique identifier
|
|
1819
|
+
* @type {string}
|
|
1820
|
+
* @memberof VariantsApiGetVariant
|
|
1821
|
+
*/
|
|
1822
|
+
readonly variantId: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* Filter response fields to only include a subset of the resource.
|
|
1825
|
+
* @type {string}
|
|
1826
|
+
* @memberof VariantsApiGetVariant
|
|
1827
|
+
*/
|
|
1828
|
+
readonly fields?: string;
|
|
1829
|
+
}
|
|
1830
|
+
/**
|
|
1831
|
+
* Request parameters for listVariants operation in VariantsApi.
|
|
1832
|
+
* @export
|
|
1833
|
+
* @interface VariantsApiListVariantsRequest
|
|
1834
|
+
*/
|
|
1835
|
+
export interface VariantsApiListVariantsRequest {
|
|
1836
|
+
/**
|
|
1837
|
+
* What project it is
|
|
1838
|
+
* @type {string}
|
|
1839
|
+
* @memberof VariantsApiListVariants
|
|
1840
|
+
*/
|
|
1841
|
+
readonly project: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* Search term to filter based on product tags.
|
|
1844
|
+
* @type {string}
|
|
1845
|
+
* @memberof VariantsApiListVariants
|
|
1846
|
+
*/
|
|
1847
|
+
readonly search?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* Page reference token
|
|
1850
|
+
* @type {number}
|
|
1851
|
+
* @memberof VariantsApiListVariants
|
|
1852
|
+
*/
|
|
1853
|
+
readonly pageToken?: number;
|
|
1854
|
+
/**
|
|
1855
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1856
|
+
* @type {number}
|
|
1857
|
+
* @memberof VariantsApiListVariants
|
|
1858
|
+
*/
|
|
1859
|
+
readonly pageSize?: number;
|
|
1860
|
+
/**
|
|
1861
|
+
* Filter response fields to only include a subset of the resource.
|
|
1862
|
+
* @type {string}
|
|
1863
|
+
* @memberof VariantsApiListVariants
|
|
1864
|
+
*/
|
|
1865
|
+
readonly fields?: string;
|
|
1866
|
+
}
|
|
1126
1867
|
/**
|
|
1127
1868
|
* VariantsApi - object-oriented interface
|
|
1128
1869
|
* @export
|
|
@@ -1133,25 +1874,19 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
1133
1874
|
/**
|
|
1134
1875
|
* Gets a variant by a given ID.
|
|
1135
1876
|
* @summary Get variant
|
|
1136
|
-
* @param {
|
|
1137
|
-
* @param {string} variantId Variants unique identifier
|
|
1138
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1877
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1139
1878
|
* @param {*} [options] Override http request option.
|
|
1140
1879
|
* @throws {RequiredError}
|
|
1141
1880
|
* @memberof VariantsApi
|
|
1142
1881
|
*/
|
|
1143
|
-
getVariant(
|
|
1882
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
1144
1883
|
/**
|
|
1145
1884
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1146
1885
|
* @summary List variants
|
|
1147
|
-
* @param {
|
|
1148
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
1149
|
-
* @param {number} [pageToken] Page reference token
|
|
1150
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1151
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1886
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1152
1887
|
* @param {*} [options] Override http request option.
|
|
1153
1888
|
* @throws {RequiredError}
|
|
1154
1889
|
* @memberof VariantsApi
|
|
1155
1890
|
*/
|
|
1156
|
-
listVariants(
|
|
1891
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
|
|
1157
1892
|
}
|