@teemill/product-catalog 1.15.0 → 1.16.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 +394 -105
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +343 -89
- package/dist/api.js +77 -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 +343 -89
- package/dist/esm/api.js +76 -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.16.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";
|
|
@@ -194,6 +219,12 @@ export interface CreateProductRequest {
|
|
|
194
219
|
* @memberof CreateProductRequest
|
|
195
220
|
*/
|
|
196
221
|
'tags'?: Array<string>;
|
|
222
|
+
/**
|
|
223
|
+
* Internal tags used for internal searching and filtering.
|
|
224
|
+
* @type {Array<string>}
|
|
225
|
+
* @memberof CreateProductRequest
|
|
226
|
+
*/
|
|
227
|
+
'internalTags'?: Array<string>;
|
|
197
228
|
/**
|
|
198
229
|
* Variants
|
|
199
230
|
* @type {Array<CreateProductVariant>}
|
|
@@ -208,10 +239,23 @@ export interface CreateProductRequest {
|
|
|
208
239
|
'images'?: Array<CreateProductRequestImagesInner>;
|
|
209
240
|
/**
|
|
210
241
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
211
|
-
* @type {Array<
|
|
242
|
+
* @type {Array<CreateProductRequestAdditionalFilesInner>}
|
|
212
243
|
* @memberof CreateProductRequest
|
|
213
244
|
*/
|
|
214
|
-
'additionalFiles'?: Array<
|
|
245
|
+
'additionalFiles'?: Array<CreateProductRequestAdditionalFilesInner>;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
*
|
|
249
|
+
* @export
|
|
250
|
+
* @interface CreateProductRequestAdditionalFilesInner
|
|
251
|
+
*/
|
|
252
|
+
export interface CreateProductRequestAdditionalFilesInner {
|
|
253
|
+
/**
|
|
254
|
+
* Publicly available file URL.
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof CreateProductRequestAdditionalFilesInner
|
|
257
|
+
*/
|
|
258
|
+
'src'?: string;
|
|
215
259
|
}
|
|
216
260
|
/**
|
|
217
261
|
*
|
|
@@ -271,10 +315,10 @@ export interface CreateProductVariant {
|
|
|
271
315
|
'applications'?: Array<Application>;
|
|
272
316
|
/**
|
|
273
317
|
* 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<
|
|
318
|
+
* @type {Array<CreateProductVariantImagesInner>}
|
|
275
319
|
* @memberof CreateProductVariant
|
|
276
320
|
*/
|
|
277
|
-
'images'?: Array<
|
|
321
|
+
'images'?: Array<CreateProductVariantImagesInner>;
|
|
278
322
|
}
|
|
279
323
|
/**
|
|
280
324
|
*
|
|
@@ -287,7 +331,7 @@ export interface CreateProductVariantAttributesInner {
|
|
|
287
331
|
* @type {string}
|
|
288
332
|
* @memberof CreateProductVariantAttributesInner
|
|
289
333
|
*/
|
|
290
|
-
'name':
|
|
334
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
291
335
|
/**
|
|
292
336
|
* Attribute value
|
|
293
337
|
* @type {string}
|
|
@@ -295,6 +339,24 @@ export interface CreateProductVariantAttributesInner {
|
|
|
295
339
|
*/
|
|
296
340
|
'value': string;
|
|
297
341
|
}
|
|
342
|
+
export declare const CreateProductVariantAttributesInnerNameEnum: {
|
|
343
|
+
readonly Size: "Size";
|
|
344
|
+
readonly Colour: "Colour";
|
|
345
|
+
};
|
|
346
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
347
|
+
/**
|
|
348
|
+
*
|
|
349
|
+
* @export
|
|
350
|
+
* @interface CreateProductVariantImagesInner
|
|
351
|
+
*/
|
|
352
|
+
export interface CreateProductVariantImagesInner {
|
|
353
|
+
/**
|
|
354
|
+
* Publicly available file URL.
|
|
355
|
+
* @type {string}
|
|
356
|
+
* @memberof CreateProductVariantImagesInner
|
|
357
|
+
*/
|
|
358
|
+
'src'?: string;
|
|
359
|
+
}
|
|
298
360
|
/**
|
|
299
361
|
* Variant retail price including tax.
|
|
300
362
|
* @export
|
|
@@ -312,8 +374,12 @@ export interface CreateProductVariantRetailPrice {
|
|
|
312
374
|
* @type {string}
|
|
313
375
|
* @memberof CreateProductVariantRetailPrice
|
|
314
376
|
*/
|
|
315
|
-
'currencyCode':
|
|
377
|
+
'currencyCode': CreateProductVariantRetailPriceCurrencyCodeEnum;
|
|
316
378
|
}
|
|
379
|
+
export declare const CreateProductVariantRetailPriceCurrencyCodeEnum: {
|
|
380
|
+
readonly Gbp: "GBP";
|
|
381
|
+
};
|
|
382
|
+
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
317
383
|
/**
|
|
318
384
|
* Image description
|
|
319
385
|
* @export
|
|
@@ -366,28 +432,28 @@ export interface Image {
|
|
|
366
432
|
/**
|
|
367
433
|
*
|
|
368
434
|
* @export
|
|
369
|
-
* @interface
|
|
435
|
+
* @interface ImageFile
|
|
370
436
|
*/
|
|
371
|
-
export interface
|
|
437
|
+
export interface ImageFile {
|
|
372
438
|
/**
|
|
373
|
-
*
|
|
439
|
+
* Publicly available file URL.
|
|
374
440
|
* @type {string}
|
|
375
|
-
* @memberof
|
|
441
|
+
* @memberof ImageFile
|
|
376
442
|
*/
|
|
377
|
-
'
|
|
443
|
+
'src'?: string;
|
|
378
444
|
}
|
|
379
445
|
/**
|
|
380
446
|
*
|
|
381
447
|
* @export
|
|
382
|
-
* @interface
|
|
448
|
+
* @interface ImportProducts200Response
|
|
383
449
|
*/
|
|
384
|
-
export interface
|
|
450
|
+
export interface ImportProducts200Response {
|
|
385
451
|
/**
|
|
386
|
-
*
|
|
452
|
+
* Id of the product import
|
|
387
453
|
* @type {string}
|
|
388
|
-
* @memberof
|
|
454
|
+
* @memberof ImportProducts200Response
|
|
389
455
|
*/
|
|
390
|
-
'
|
|
456
|
+
'importId'?: string;
|
|
391
457
|
}
|
|
392
458
|
/**
|
|
393
459
|
* Standard price definition that defines the amount, tax rate and currency.
|
|
@@ -406,8 +472,12 @@ export interface Price {
|
|
|
406
472
|
* @type {string}
|
|
407
473
|
* @memberof Price
|
|
408
474
|
*/
|
|
409
|
-
'currencyCode'?:
|
|
475
|
+
'currencyCode'?: PriceCurrencyCodeEnum;
|
|
410
476
|
}
|
|
477
|
+
export declare const PriceCurrencyCodeEnum: {
|
|
478
|
+
readonly Gbp: "GBP";
|
|
479
|
+
};
|
|
480
|
+
export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
|
|
411
481
|
/**
|
|
412
482
|
*
|
|
413
483
|
* @export
|
|
@@ -462,6 +532,12 @@ export interface Product {
|
|
|
462
532
|
* @memberof Product
|
|
463
533
|
*/
|
|
464
534
|
'tags'?: Array<string>;
|
|
535
|
+
/**
|
|
536
|
+
*
|
|
537
|
+
* @type {Array<string>}
|
|
538
|
+
* @memberof Product
|
|
539
|
+
*/
|
|
540
|
+
'internalTags'?: Array<string>;
|
|
465
541
|
/**
|
|
466
542
|
*
|
|
467
543
|
* @type {string}
|
|
@@ -611,6 +687,12 @@ export interface UpdateProductRequest {
|
|
|
611
687
|
* @memberof UpdateProductRequest
|
|
612
688
|
*/
|
|
613
689
|
'tags'?: Array<string>;
|
|
690
|
+
/**
|
|
691
|
+
* Additional product tags used for internal searching and filtering.
|
|
692
|
+
* @type {Array<string>}
|
|
693
|
+
* @memberof UpdateProductRequest
|
|
694
|
+
*/
|
|
695
|
+
'internalTags'?: Array<string>;
|
|
614
696
|
/**
|
|
615
697
|
* Variants
|
|
616
698
|
* @type {Array<CreateProductVariant>}
|
|
@@ -619,16 +701,16 @@ export interface UpdateProductRequest {
|
|
|
619
701
|
'variants'?: Array<CreateProductVariant>;
|
|
620
702
|
/**
|
|
621
703
|
* Images to attach to the product. For example, photos of models using/wearing the product.
|
|
622
|
-
* @type {Array<
|
|
704
|
+
* @type {Array<ImageFile>}
|
|
623
705
|
* @memberof UpdateProductRequest
|
|
624
706
|
*/
|
|
625
|
-
'images'?: Array<
|
|
707
|
+
'images'?: Array<ImageFile>;
|
|
626
708
|
/**
|
|
627
709
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
628
|
-
* @type {Array<
|
|
710
|
+
* @type {Array<AdditionalFile>}
|
|
629
711
|
* @memberof UpdateProductRequest
|
|
630
712
|
*/
|
|
631
|
-
'additionalFiles'?: Array<
|
|
713
|
+
'additionalFiles'?: Array<AdditionalFile>;
|
|
632
714
|
}
|
|
633
715
|
/**
|
|
634
716
|
*
|
|
@@ -909,63 +991,196 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
909
991
|
/**
|
|
910
992
|
* 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
993
|
* @summary Create product
|
|
912
|
-
* @param {
|
|
913
|
-
* @param {CreateProductRequest} [createProductRequest]
|
|
994
|
+
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
914
995
|
* @param {*} [options] Override http request option.
|
|
915
996
|
* @throws {RequiredError}
|
|
916
997
|
*/
|
|
917
|
-
createProduct(
|
|
998
|
+
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
918
999
|
/**
|
|
919
1000
|
* Deletes a catalog product
|
|
920
1001
|
* @summary Delete catalog product
|
|
921
|
-
* @param {
|
|
922
|
-
* @param {string} productId Product\'s unique identifier
|
|
1002
|
+
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
923
1003
|
* @param {*} [options] Override http request option.
|
|
924
1004
|
* @throws {RequiredError}
|
|
925
1005
|
*/
|
|
926
|
-
deleteProduct(
|
|
1006
|
+
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
927
1007
|
/**
|
|
928
1008
|
* Gets a product by a given ID.
|
|
929
1009
|
* @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.
|
|
1010
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
933
1011
|
* @param {*} [options] Override http request option.
|
|
934
1012
|
* @throws {RequiredError}
|
|
935
1013
|
*/
|
|
936
|
-
getProduct(
|
|
1014
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
937
1015
|
/**
|
|
938
1016
|
* Lists all enabled store listing products attached to the given project.
|
|
939
1017
|
* @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.
|
|
1018
|
+
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
945
1019
|
* @param {*} [options] Override http request option.
|
|
946
1020
|
* @throws {RequiredError}
|
|
947
1021
|
*/
|
|
948
|
-
getProducts(
|
|
1022
|
+
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
949
1023
|
/**
|
|
950
1024
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
951
1025
|
* @summary Import products
|
|
952
|
-
* @param {
|
|
953
|
-
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
1026
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
954
1027
|
* @param {*} [options] Override http request option.
|
|
955
1028
|
* @throws {RequiredError}
|
|
956
1029
|
*/
|
|
957
|
-
importProducts(
|
|
1030
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
|
|
958
1031
|
/**
|
|
959
1032
|
* Updates a product by a given ID.
|
|
960
1033
|
* @summary Update product
|
|
961
|
-
* @param {
|
|
962
|
-
* @param {string} productId Product\'s unique identifier
|
|
963
|
-
* @param {UpdateProductRequest} [updateProductRequest]
|
|
1034
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
964
1035
|
* @param {*} [options] Override http request option.
|
|
965
1036
|
* @throws {RequiredError}
|
|
966
1037
|
*/
|
|
967
|
-
updateProduct(
|
|
1038
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
968
1039
|
};
|
|
1040
|
+
/**
|
|
1041
|
+
* Request parameters for createProduct operation in ProductsApi.
|
|
1042
|
+
* @export
|
|
1043
|
+
* @interface ProductsApiCreateProductRequest
|
|
1044
|
+
*/
|
|
1045
|
+
export interface ProductsApiCreateProductRequest {
|
|
1046
|
+
/**
|
|
1047
|
+
* What project it is
|
|
1048
|
+
* @type {string}
|
|
1049
|
+
* @memberof ProductsApiCreateProduct
|
|
1050
|
+
*/
|
|
1051
|
+
readonly project: string;
|
|
1052
|
+
/**
|
|
1053
|
+
*
|
|
1054
|
+
* @type {CreateProductRequest}
|
|
1055
|
+
* @memberof ProductsApiCreateProduct
|
|
1056
|
+
*/
|
|
1057
|
+
readonly createProductRequest?: CreateProductRequest;
|
|
1058
|
+
}
|
|
1059
|
+
/**
|
|
1060
|
+
* Request parameters for deleteProduct operation in ProductsApi.
|
|
1061
|
+
* @export
|
|
1062
|
+
* @interface ProductsApiDeleteProductRequest
|
|
1063
|
+
*/
|
|
1064
|
+
export interface ProductsApiDeleteProductRequest {
|
|
1065
|
+
/**
|
|
1066
|
+
* What project it is
|
|
1067
|
+
* @type {string}
|
|
1068
|
+
* @memberof ProductsApiDeleteProduct
|
|
1069
|
+
*/
|
|
1070
|
+
readonly project: string;
|
|
1071
|
+
/**
|
|
1072
|
+
* Product\'s unique identifier
|
|
1073
|
+
* @type {string}
|
|
1074
|
+
* @memberof ProductsApiDeleteProduct
|
|
1075
|
+
*/
|
|
1076
|
+
readonly productId: string;
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
1080
|
+
* @export
|
|
1081
|
+
* @interface ProductsApiGetProductRequest
|
|
1082
|
+
*/
|
|
1083
|
+
export interface ProductsApiGetProductRequest {
|
|
1084
|
+
/**
|
|
1085
|
+
* What project it is
|
|
1086
|
+
* @type {string}
|
|
1087
|
+
* @memberof ProductsApiGetProduct
|
|
1088
|
+
*/
|
|
1089
|
+
readonly project: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Product\'s unique identifier
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof ProductsApiGetProduct
|
|
1094
|
+
*/
|
|
1095
|
+
readonly productId: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Filter response fields to only include a subset of the resource.
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof ProductsApiGetProduct
|
|
1100
|
+
*/
|
|
1101
|
+
readonly fields?: string;
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Request parameters for getProducts operation in ProductsApi.
|
|
1105
|
+
* @export
|
|
1106
|
+
* @interface ProductsApiGetProductsRequest
|
|
1107
|
+
*/
|
|
1108
|
+
export interface ProductsApiGetProductsRequest {
|
|
1109
|
+
/**
|
|
1110
|
+
* What project it is
|
|
1111
|
+
* @type {string}
|
|
1112
|
+
* @memberof ProductsApiGetProducts
|
|
1113
|
+
*/
|
|
1114
|
+
readonly project: string;
|
|
1115
|
+
/**
|
|
1116
|
+
* Page reference token
|
|
1117
|
+
* @type {number}
|
|
1118
|
+
* @memberof ProductsApiGetProducts
|
|
1119
|
+
*/
|
|
1120
|
+
readonly pageToken?: number;
|
|
1121
|
+
/**
|
|
1122
|
+
* Search term to filter based on product tags.
|
|
1123
|
+
* @type {string}
|
|
1124
|
+
* @memberof ProductsApiGetProducts
|
|
1125
|
+
*/
|
|
1126
|
+
readonly search?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1129
|
+
* @type {number}
|
|
1130
|
+
* @memberof ProductsApiGetProducts
|
|
1131
|
+
*/
|
|
1132
|
+
readonly pageSize?: number;
|
|
1133
|
+
/**
|
|
1134
|
+
* Filter response fields to only include a subset of the resource.
|
|
1135
|
+
* @type {string}
|
|
1136
|
+
* @memberof ProductsApiGetProducts
|
|
1137
|
+
*/
|
|
1138
|
+
readonly fields?: string;
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
* Request parameters for importProducts operation in ProductsApi.
|
|
1142
|
+
* @export
|
|
1143
|
+
* @interface ProductsApiImportProductsRequest
|
|
1144
|
+
*/
|
|
1145
|
+
export interface ProductsApiImportProductsRequest {
|
|
1146
|
+
/**
|
|
1147
|
+
* What project it is
|
|
1148
|
+
* @type {string}
|
|
1149
|
+
* @memberof ProductsApiImportProducts
|
|
1150
|
+
*/
|
|
1151
|
+
readonly project: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* A data URL of a CSV file containing data for one or more products.
|
|
1154
|
+
* @type {string}
|
|
1155
|
+
* @memberof ProductsApiImportProducts
|
|
1156
|
+
*/
|
|
1157
|
+
readonly body?: string;
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
* Request parameters for updateProduct operation in ProductsApi.
|
|
1161
|
+
* @export
|
|
1162
|
+
* @interface ProductsApiUpdateProductRequest
|
|
1163
|
+
*/
|
|
1164
|
+
export interface ProductsApiUpdateProductRequest {
|
|
1165
|
+
/**
|
|
1166
|
+
* What project it is
|
|
1167
|
+
* @type {string}
|
|
1168
|
+
* @memberof ProductsApiUpdateProduct
|
|
1169
|
+
*/
|
|
1170
|
+
readonly project: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* Product\'s unique identifier
|
|
1173
|
+
* @type {string}
|
|
1174
|
+
* @memberof ProductsApiUpdateProduct
|
|
1175
|
+
*/
|
|
1176
|
+
readonly productId: string;
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
* @type {UpdateProductRequest}
|
|
1180
|
+
* @memberof ProductsApiUpdateProduct
|
|
1181
|
+
*/
|
|
1182
|
+
readonly updateProductRequest?: UpdateProductRequest;
|
|
1183
|
+
}
|
|
969
1184
|
/**
|
|
970
1185
|
* ProductsApi - object-oriented interface
|
|
971
1186
|
* @export
|
|
@@ -976,68 +1191,57 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
976
1191
|
/**
|
|
977
1192
|
* 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
1193
|
* @summary Create product
|
|
979
|
-
* @param {
|
|
980
|
-
* @param {CreateProductRequest} [createProductRequest]
|
|
1194
|
+
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
981
1195
|
* @param {*} [options] Override http request option.
|
|
982
1196
|
* @throws {RequiredError}
|
|
983
1197
|
* @memberof ProductsApi
|
|
984
1198
|
*/
|
|
985
|
-
createProduct(
|
|
1199
|
+
createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
986
1200
|
/**
|
|
987
1201
|
* Deletes a catalog product
|
|
988
1202
|
* @summary Delete catalog product
|
|
989
|
-
* @param {
|
|
990
|
-
* @param {string} productId Product\'s unique identifier
|
|
1203
|
+
* @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
|
|
991
1204
|
* @param {*} [options] Override http request option.
|
|
992
1205
|
* @throws {RequiredError}
|
|
993
1206
|
* @memberof ProductsApi
|
|
994
1207
|
*/
|
|
995
|
-
deleteProduct(
|
|
1208
|
+
deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
996
1209
|
/**
|
|
997
1210
|
* Gets a product by a given ID.
|
|
998
1211
|
* @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.
|
|
1212
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
1002
1213
|
* @param {*} [options] Override http request option.
|
|
1003
1214
|
* @throws {RequiredError}
|
|
1004
1215
|
* @memberof ProductsApi
|
|
1005
1216
|
*/
|
|
1006
|
-
getProduct(
|
|
1217
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
1007
1218
|
/**
|
|
1008
1219
|
* Lists all enabled store listing products attached to the given project.
|
|
1009
1220
|
* @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.
|
|
1221
|
+
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
1015
1222
|
* @param {*} [options] Override http request option.
|
|
1016
1223
|
* @throws {RequiredError}
|
|
1017
1224
|
* @memberof ProductsApi
|
|
1018
1225
|
*/
|
|
1019
|
-
getProducts(
|
|
1226
|
+
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
1020
1227
|
/**
|
|
1021
1228
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1022
1229
|
* @summary Import products
|
|
1023
|
-
* @param {
|
|
1024
|
-
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
1230
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
1025
1231
|
* @param {*} [options] Override http request option.
|
|
1026
1232
|
* @throws {RequiredError}
|
|
1027
1233
|
* @memberof ProductsApi
|
|
1028
1234
|
*/
|
|
1029
|
-
importProducts(
|
|
1235
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
1030
1236
|
/**
|
|
1031
1237
|
* Updates a product by a given ID.
|
|
1032
1238
|
* @summary Update product
|
|
1033
|
-
* @param {
|
|
1034
|
-
* @param {string} productId Product\'s unique identifier
|
|
1035
|
-
* @param {UpdateProductRequest} [updateProductRequest]
|
|
1239
|
+
* @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
|
|
1036
1240
|
* @param {*} [options] Override http request option.
|
|
1037
1241
|
* @throws {RequiredError}
|
|
1038
1242
|
* @memberof ProductsApi
|
|
1039
1243
|
*/
|
|
1040
|
-
updateProduct(
|
|
1244
|
+
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
1041
1245
|
}
|
|
1042
1246
|
/**
|
|
1043
1247
|
* VariantsApi - axios parameter creator
|
|
@@ -1103,26 +1307,82 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
|
|
|
1103
1307
|
/**
|
|
1104
1308
|
* Gets a variant by a given ID.
|
|
1105
1309
|
* @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.
|
|
1310
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1109
1311
|
* @param {*} [options] Override http request option.
|
|
1110
1312
|
* @throws {RequiredError}
|
|
1111
1313
|
*/
|
|
1112
|
-
getVariant(
|
|
1314
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
1113
1315
|
/**
|
|
1114
1316
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1115
1317
|
* @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.
|
|
1318
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1121
1319
|
* @param {*} [options] Override http request option.
|
|
1122
1320
|
* @throws {RequiredError}
|
|
1123
1321
|
*/
|
|
1124
|
-
listVariants(
|
|
1322
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse>;
|
|
1125
1323
|
};
|
|
1324
|
+
/**
|
|
1325
|
+
* Request parameters for getVariant operation in VariantsApi.
|
|
1326
|
+
* @export
|
|
1327
|
+
* @interface VariantsApiGetVariantRequest
|
|
1328
|
+
*/
|
|
1329
|
+
export interface VariantsApiGetVariantRequest {
|
|
1330
|
+
/**
|
|
1331
|
+
* What project it is
|
|
1332
|
+
* @type {string}
|
|
1333
|
+
* @memberof VariantsApiGetVariant
|
|
1334
|
+
*/
|
|
1335
|
+
readonly project: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Variants unique identifier
|
|
1338
|
+
* @type {string}
|
|
1339
|
+
* @memberof VariantsApiGetVariant
|
|
1340
|
+
*/
|
|
1341
|
+
readonly variantId: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Filter response fields to only include a subset of the resource.
|
|
1344
|
+
* @type {string}
|
|
1345
|
+
* @memberof VariantsApiGetVariant
|
|
1346
|
+
*/
|
|
1347
|
+
readonly fields?: string;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* Request parameters for listVariants operation in VariantsApi.
|
|
1351
|
+
* @export
|
|
1352
|
+
* @interface VariantsApiListVariantsRequest
|
|
1353
|
+
*/
|
|
1354
|
+
export interface VariantsApiListVariantsRequest {
|
|
1355
|
+
/**
|
|
1356
|
+
* What project it is
|
|
1357
|
+
* @type {string}
|
|
1358
|
+
* @memberof VariantsApiListVariants
|
|
1359
|
+
*/
|
|
1360
|
+
readonly project: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Search term to filter based on product tags.
|
|
1363
|
+
* @type {string}
|
|
1364
|
+
* @memberof VariantsApiListVariants
|
|
1365
|
+
*/
|
|
1366
|
+
readonly search?: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* Page reference token
|
|
1369
|
+
* @type {number}
|
|
1370
|
+
* @memberof VariantsApiListVariants
|
|
1371
|
+
*/
|
|
1372
|
+
readonly pageToken?: number;
|
|
1373
|
+
/**
|
|
1374
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1375
|
+
* @type {number}
|
|
1376
|
+
* @memberof VariantsApiListVariants
|
|
1377
|
+
*/
|
|
1378
|
+
readonly pageSize?: number;
|
|
1379
|
+
/**
|
|
1380
|
+
* Filter response fields to only include a subset of the resource.
|
|
1381
|
+
* @type {string}
|
|
1382
|
+
* @memberof VariantsApiListVariants
|
|
1383
|
+
*/
|
|
1384
|
+
readonly fields?: string;
|
|
1385
|
+
}
|
|
1126
1386
|
/**
|
|
1127
1387
|
* VariantsApi - object-oriented interface
|
|
1128
1388
|
* @export
|
|
@@ -1133,25 +1393,19 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
1133
1393
|
/**
|
|
1134
1394
|
* Gets a variant by a given ID.
|
|
1135
1395
|
* @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.
|
|
1396
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1139
1397
|
* @param {*} [options] Override http request option.
|
|
1140
1398
|
* @throws {RequiredError}
|
|
1141
1399
|
* @memberof VariantsApi
|
|
1142
1400
|
*/
|
|
1143
|
-
getVariant(
|
|
1401
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
1144
1402
|
/**
|
|
1145
1403
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1146
1404
|
* @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.
|
|
1405
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1152
1406
|
* @param {*} [options] Override http request option.
|
|
1153
1407
|
* @throws {RequiredError}
|
|
1154
1408
|
* @memberof VariantsApi
|
|
1155
1409
|
*/
|
|
1156
|
-
listVariants(
|
|
1410
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
|
|
1157
1411
|
}
|