@teemill/product-catalog 1.87.0 → 1.88.1
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 +5 -2
- package/api.ts +95 -13
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +92 -13
- package/dist/api.js +12 -8
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +92 -13
- package/dist/esm/api.js +10 -6
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/Application.md +1 -1
- package/docs/ApplicationPropertiesPositionInference.md +1 -1
- package/docs/BundleProduct.md +2 -0
- package/docs/CreateApplication.md +1 -1
- package/docs/CreateProduct.md +2 -2
- package/docs/CreateProductRequest.md +1 -1
- package/docs/CreateProductVariant.md +2 -2
- package/docs/CreateProductVariantAttributesInner.md +22 -0
- package/docs/Product.md +2 -0
- package/docs/ProductBundleItemsInner.md +2 -0
- package/docs/ProductGfnProduct.md +25 -0
- package/docs/ProductWarehouseProduct.md +3 -0
- package/docs/ProductsApi.md +1 -1
- package/docs/Variant.md +2 -0
- package/docs/VariantGfnVariant.md +25 -0
- package/docs/VariantWarehouseVariant.md +3 -0
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Product Catalog API
|
|
6
|
-
* Manage your 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
|
|
6
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.88.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = void 0;
|
|
25
|
+
exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductCreatorsApi = exports.ProductCreatorsApiFactory = exports.ProductCreatorsApiFp = exports.ProductCreatorsApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.RecommendationPriorityEnum = exports.PriceCurrencyCodeEnum = exports.CreateProductVariantAttributesInnerNameEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = exports.ActionImpactEnum = void 0;
|
|
26
|
+
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = void 0;
|
|
27
27
|
const axios_1 = require("axios");
|
|
28
28
|
// Some imports not used depending on template conditions
|
|
29
29
|
// @ts-ignore
|
|
@@ -106,6 +106,10 @@ exports.CreateApplicationPropertiesFontStyleEnum = {
|
|
|
106
106
|
Italic: 'italic',
|
|
107
107
|
Oblique: 'oblique'
|
|
108
108
|
};
|
|
109
|
+
exports.CreateProductVariantAttributesInnerNameEnum = {
|
|
110
|
+
Size: 'Size',
|
|
111
|
+
Colour: 'Colour'
|
|
112
|
+
};
|
|
109
113
|
exports.PriceCurrencyCodeEnum = {
|
|
110
114
|
Gbp: 'GBP'
|
|
111
115
|
};
|
|
@@ -1791,7 +1795,7 @@ exports.ProductTypesApi = ProductTypesApi;
|
|
|
1791
1795
|
const ProductsApiAxiosParamCreator = function (configuration) {
|
|
1792
1796
|
return {
|
|
1793
1797
|
/**
|
|
1794
|
-
* Creates a new catalog product based on a
|
|
1798
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
1795
1799
|
* @summary Create product
|
|
1796
1800
|
* @param {string} project What project it is
|
|
1797
1801
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -2320,7 +2324,7 @@ const ProductsApiFp = function (configuration) {
|
|
|
2320
2324
|
const localVarAxiosParamCreator = (0, exports.ProductsApiAxiosParamCreator)(configuration);
|
|
2321
2325
|
return {
|
|
2322
2326
|
/**
|
|
2323
|
-
* Creates a new catalog product based on a
|
|
2327
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2324
2328
|
* @summary Create product
|
|
2325
2329
|
* @param {string} project What project it is
|
|
2326
2330
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -2532,7 +2536,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2532
2536
|
const localVarFp = (0, exports.ProductsApiFp)(configuration);
|
|
2533
2537
|
return {
|
|
2534
2538
|
/**
|
|
2535
|
-
* Creates a new catalog product based on a
|
|
2539
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2536
2540
|
* @summary Create product
|
|
2537
2541
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
2538
2542
|
* @param {*} [options] Override http request option.
|
|
@@ -2649,7 +2653,7 @@ exports.ProductsApiFactory = ProductsApiFactory;
|
|
|
2649
2653
|
*/
|
|
2650
2654
|
class ProductsApi extends base_1.BaseAPI {
|
|
2651
2655
|
/**
|
|
2652
|
-
* Creates a new catalog product based on a
|
|
2656
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2653
2657
|
* @summary Create product
|
|
2654
2658
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
2655
2659
|
* @param {*} [options] Override http request option.
|
package/dist/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Product Catalog API
|
|
6
|
-
* Manage your 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
|
|
6
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.88.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Product Catalog API
|
|
6
|
-
* Manage your 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
|
|
6
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.88.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
5
|
-
* Manage your 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
|
|
5
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -103,7 +103,7 @@ export interface Application {
|
|
|
103
103
|
*/
|
|
104
104
|
'additionalInstructions'?: string | null;
|
|
105
105
|
/**
|
|
106
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
106
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
107
107
|
*/
|
|
108
108
|
'src'?: string;
|
|
109
109
|
/**
|
|
@@ -229,7 +229,7 @@ export interface ApplicationPropertiesPosition {
|
|
|
229
229
|
'z'?: number;
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
|
-
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the
|
|
232
|
+
* Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the GFN Catalog product.
|
|
233
233
|
*/
|
|
234
234
|
export interface ApplicationPropertiesPositionInference {
|
|
235
235
|
/**
|
|
@@ -486,7 +486,11 @@ export interface BundleProduct {
|
|
|
486
486
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
487
487
|
*/
|
|
488
488
|
'shopifyId'?: number | null;
|
|
489
|
+
/**
|
|
490
|
+
* @deprecated
|
|
491
|
+
*/
|
|
489
492
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
493
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
490
494
|
/**
|
|
491
495
|
* Key/value pairs that can be used to store additional information about the product
|
|
492
496
|
*/
|
|
@@ -520,7 +524,7 @@ export interface CreateApplication {
|
|
|
520
524
|
*/
|
|
521
525
|
'additionalInstructions'?: string | null;
|
|
522
526
|
/**
|
|
523
|
-
* Publicly available design file URL. This will fill the design area of the
|
|
527
|
+
* Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
|
|
524
528
|
*/
|
|
525
529
|
'src': string;
|
|
526
530
|
/**
|
|
@@ -781,7 +785,7 @@ export interface CreateProduct {
|
|
|
781
785
|
*/
|
|
782
786
|
'internalTags'?: Array<string>;
|
|
783
787
|
/**
|
|
784
|
-
*
|
|
788
|
+
* The variants to create for this product. Each variant must specify attributes that match a variant in the GFN Catalog for the product referenced by gfnProductRef. Use the GFN Catalog API to list products and variants (e.g. GET /v1/gfn/catalog/products/{productId} and GET /v1/gfn/catalog/variants) to get the exact attribute names and values — they must match exactly, including casing.
|
|
785
789
|
*/
|
|
786
790
|
'variants': Array<CreateProductVariant>;
|
|
787
791
|
/**
|
|
@@ -840,9 +844,9 @@ export interface CreateProductImagesInner {
|
|
|
840
844
|
export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
841
845
|
export interface CreateProductVariant {
|
|
842
846
|
/**
|
|
843
|
-
*
|
|
847
|
+
* One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match).
|
|
844
848
|
*/
|
|
845
|
-
'attributes': Array<
|
|
849
|
+
'attributes': Array<CreateProductVariantAttributesInner>;
|
|
846
850
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
847
851
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
848
852
|
/**
|
|
@@ -854,7 +858,7 @@ export interface CreateProductVariant {
|
|
|
854
858
|
*/
|
|
855
859
|
'applications'?: Array<Application>;
|
|
856
860
|
/**
|
|
857
|
-
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the
|
|
861
|
+
* Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the GFN Catalog product. Accepts PNG and JPEG files.
|
|
858
862
|
*/
|
|
859
863
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
860
864
|
/**
|
|
@@ -867,6 +871,21 @@ export interface CreateProductVariant {
|
|
|
867
871
|
'shopifyId'?: number | null;
|
|
868
872
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
869
873
|
}
|
|
874
|
+
export interface CreateProductVariantAttributesInner {
|
|
875
|
+
/**
|
|
876
|
+
* Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing.
|
|
877
|
+
*/
|
|
878
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
879
|
+
/**
|
|
880
|
+
* Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing.
|
|
881
|
+
*/
|
|
882
|
+
'value': string;
|
|
883
|
+
}
|
|
884
|
+
export declare const CreateProductVariantAttributesInnerNameEnum: {
|
|
885
|
+
readonly Size: "Size";
|
|
886
|
+
readonly Colour: "Colour";
|
|
887
|
+
};
|
|
888
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
870
889
|
export interface CreateProductVariantImagesInner {
|
|
871
890
|
/**
|
|
872
891
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
@@ -1103,7 +1122,11 @@ export interface Product {
|
|
|
1103
1122
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1104
1123
|
*/
|
|
1105
1124
|
'shopifyId'?: number | null;
|
|
1125
|
+
/**
|
|
1126
|
+
* @deprecated
|
|
1127
|
+
*/
|
|
1106
1128
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1129
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1107
1130
|
/**
|
|
1108
1131
|
* Key/value pairs that can be used to store additional information about the product
|
|
1109
1132
|
*/
|
|
@@ -1217,7 +1240,11 @@ export interface ProductBundleItemsInner {
|
|
|
1217
1240
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1218
1241
|
*/
|
|
1219
1242
|
'shopifyId'?: number | null;
|
|
1243
|
+
/**
|
|
1244
|
+
* @deprecated
|
|
1245
|
+
*/
|
|
1220
1246
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1247
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1221
1248
|
/**
|
|
1222
1249
|
* Key/value pairs that can be used to store additional information about the product
|
|
1223
1250
|
*/
|
|
@@ -1238,6 +1265,23 @@ export interface ProductBundleItemsInner {
|
|
|
1238
1265
|
'license'?: License;
|
|
1239
1266
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1240
1267
|
}
|
|
1268
|
+
/**
|
|
1269
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
|
|
1270
|
+
*/
|
|
1271
|
+
export interface ProductGfnProduct {
|
|
1272
|
+
/**
|
|
1273
|
+
* Unique object identifier
|
|
1274
|
+
*/
|
|
1275
|
+
'id'?: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
1278
|
+
*/
|
|
1279
|
+
'gfnProductRef'?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* Meta fields from the GFN Catalog product
|
|
1282
|
+
*/
|
|
1283
|
+
'metafields'?: Array<MetaField>;
|
|
1284
|
+
}
|
|
1241
1285
|
export interface ProductType {
|
|
1242
1286
|
/**
|
|
1243
1287
|
* Unique object identifier
|
|
@@ -1255,6 +1299,9 @@ export interface ProductTypeListResponse {
|
|
|
1255
1299
|
*/
|
|
1256
1300
|
'nextPageToken': number | null;
|
|
1257
1301
|
}
|
|
1302
|
+
/**
|
|
1303
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
|
|
1304
|
+
*/
|
|
1258
1305
|
export interface ProductWarehouseProduct {
|
|
1259
1306
|
/**
|
|
1260
1307
|
* Unique object identifier
|
|
@@ -1264,6 +1311,10 @@ export interface ProductWarehouseProduct {
|
|
|
1264
1311
|
* Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
1265
1312
|
*/
|
|
1266
1313
|
'gfnProductRef'?: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* Meta fields from the GFN Catalog product
|
|
1316
|
+
*/
|
|
1317
|
+
'metafields'?: Array<MetaField>;
|
|
1267
1318
|
}
|
|
1268
1319
|
export interface ProductsResponse {
|
|
1269
1320
|
'products'?: Array<Product>;
|
|
@@ -1905,7 +1956,28 @@ export interface Variant {
|
|
|
1905
1956
|
'metafields'?: Array<MetaField>;
|
|
1906
1957
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
1907
1958
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
1959
|
+
/**
|
|
1960
|
+
* @deprecated
|
|
1961
|
+
*/
|
|
1908
1962
|
'warehouseVariant'?: VariantWarehouseVariant;
|
|
1963
|
+
'gfnVariant'?: VariantGfnVariant;
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
|
|
1967
|
+
*/
|
|
1968
|
+
export interface VariantGfnVariant {
|
|
1969
|
+
/**
|
|
1970
|
+
* Unique object identifier
|
|
1971
|
+
*/
|
|
1972
|
+
'id'?: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1975
|
+
*/
|
|
1976
|
+
'gfnVariantRef'?: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Meta fields from the GFN Catalog variant
|
|
1979
|
+
*/
|
|
1980
|
+
'metafields'?: Array<MetaField>;
|
|
1909
1981
|
}
|
|
1910
1982
|
export interface VariantIntegrationConnectionsInner {
|
|
1911
1983
|
'integrationCode': string;
|
|
@@ -1924,6 +1996,9 @@ export interface VariantProduct {
|
|
|
1924
1996
|
*/
|
|
1925
1997
|
'ref'?: string;
|
|
1926
1998
|
}
|
|
1999
|
+
/**
|
|
2000
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
|
|
2001
|
+
*/
|
|
1927
2002
|
export interface VariantWarehouseVariant {
|
|
1928
2003
|
/**
|
|
1929
2004
|
* Unique object identifier
|
|
@@ -1933,6 +2008,10 @@ export interface VariantWarehouseVariant {
|
|
|
1933
2008
|
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
1934
2009
|
*/
|
|
1935
2010
|
'gfnVariantRef'?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* Meta fields from the GFN Catalog variant
|
|
2013
|
+
*/
|
|
2014
|
+
'metafields'?: Array<MetaField>;
|
|
1936
2015
|
}
|
|
1937
2016
|
export interface VariantWholesaleCost {
|
|
1938
2017
|
'item': RequiredPrice;
|
|
@@ -3066,7 +3145,7 @@ export declare class ProductTypesApi extends BaseAPI {
|
|
|
3066
3145
|
*/
|
|
3067
3146
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3068
3147
|
/**
|
|
3069
|
-
* Creates a new catalog product based on a
|
|
3148
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3070
3149
|
* @summary Create product
|
|
3071
3150
|
* @param {string} project What project it is
|
|
3072
3151
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3186,7 +3265,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3186
3265
|
*/
|
|
3187
3266
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3188
3267
|
/**
|
|
3189
|
-
* Creates a new catalog product based on a
|
|
3268
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3190
3269
|
* @summary Create product
|
|
3191
3270
|
* @param {string} project What project it is
|
|
3192
3271
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3306,7 +3385,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3306
3385
|
*/
|
|
3307
3386
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3308
3387
|
/**
|
|
3309
|
-
* Creates a new catalog product based on a
|
|
3388
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3310
3389
|
* @summary Create product
|
|
3311
3390
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3312
3391
|
* @param {*} [options] Override http request option.
|
|
@@ -3600,7 +3679,7 @@ export interface ProductsApiUpdateProductsRequest {
|
|
|
3600
3679
|
*/
|
|
3601
3680
|
export declare class ProductsApi extends BaseAPI {
|
|
3602
3681
|
/**
|
|
3603
|
-
* Creates a new catalog product based on a
|
|
3682
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
3604
3683
|
* @summary Create product
|
|
3605
3684
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3606
3685
|
* @param {*} [options] Override http request option.
|
package/dist/esm/api.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
5
|
-
* Manage your 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
|
|
5
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -102,6 +102,10 @@ export const CreateApplicationPropertiesFontStyleEnum = {
|
|
|
102
102
|
Italic: 'italic',
|
|
103
103
|
Oblique: 'oblique'
|
|
104
104
|
};
|
|
105
|
+
export const CreateProductVariantAttributesInnerNameEnum = {
|
|
106
|
+
Size: 'Size',
|
|
107
|
+
Colour: 'Colour'
|
|
108
|
+
};
|
|
105
109
|
export const PriceCurrencyCodeEnum = {
|
|
106
110
|
Gbp: 'GBP'
|
|
107
111
|
};
|
|
@@ -1763,7 +1767,7 @@ export class ProductTypesApi extends BaseAPI {
|
|
|
1763
1767
|
export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
1764
1768
|
return {
|
|
1765
1769
|
/**
|
|
1766
|
-
* Creates a new catalog product based on a
|
|
1770
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
1767
1771
|
* @summary Create product
|
|
1768
1772
|
* @param {string} project What project it is
|
|
1769
1773
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -2291,7 +2295,7 @@ export const ProductsApiFp = function (configuration) {
|
|
|
2291
2295
|
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration);
|
|
2292
2296
|
return {
|
|
2293
2297
|
/**
|
|
2294
|
-
* Creates a new catalog product based on a
|
|
2298
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2295
2299
|
* @summary Create product
|
|
2296
2300
|
* @param {string} project What project it is
|
|
2297
2301
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -2502,7 +2506,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2502
2506
|
const localVarFp = ProductsApiFp(configuration);
|
|
2503
2507
|
return {
|
|
2504
2508
|
/**
|
|
2505
|
-
* Creates a new catalog product based on a
|
|
2509
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2506
2510
|
* @summary Create product
|
|
2507
2511
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
2508
2512
|
* @param {*} [options] Override http request option.
|
|
@@ -2618,7 +2622,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2618
2622
|
*/
|
|
2619
2623
|
export class ProductsApi extends BaseAPI {
|
|
2620
2624
|
/**
|
|
2621
|
-
* Creates a new catalog product based on a
|
|
2625
|
+
* Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
|
|
2622
2626
|
* @summary Create product
|
|
2623
2627
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
2624
2628
|
* @param {*} [options] Override http request option.
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
5
|
-
* Manage your 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
|
|
5
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
5
|
-
* Manage your 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
|
|
5
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/**
|
|
3
3
|
* Product Catalog API
|
|
4
|
-
* Manage your 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
|
|
4
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.88.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Product Catalog API
|
|
5
|
-
* Manage your 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
|
|
5
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.88.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Product Catalog API
|
|
3
|
-
* Manage your 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
|
|
3
|
+
* Manage your 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 product from the GFN Catalog, 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.88.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Product Catalog API
|
|
6
|
-
* Manage your 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
|
|
6
|
+
* Manage your 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 product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.88.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/Application.md
CHANGED
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**technology** | **string** | Technology to use for the application. | [default to undefined]
|
|
10
10
|
**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
|
|
11
11
|
**additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
|
|
12
|
-
**src** | **string** | Publicly available design file URL. This will fill the design area of the
|
|
12
|
+
**src** | **string** | Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area. | [optional] [default to undefined]
|
|
13
13
|
**groupRef** | **string** | A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products. | [optional] [default to undefined]
|
|
14
14
|
**mockup** | [**ApplicationMockup**](ApplicationMockup.md) | | [optional] [default to undefined]
|
|
15
15
|
**stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ApplicationPropertiesPositionInference
|
|
2
2
|
|
|
3
|
-
Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the
|
|
3
|
+
Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the GFN Catalog product.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|