@teemill/product-catalog 1.88.0 → 1.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/api.ts +135 -17
- package/base.ts +3 -3
- package/common.ts +3 -3
- package/configuration.ts +3 -3
- package/dist/api.d.ts +132 -17
- package/dist/api.js +13 -9
- package/dist/base.d.ts +3 -3
- package/dist/base.js +3 -3
- package/dist/common.d.ts +3 -3
- package/dist/common.js +3 -3
- package/dist/configuration.d.ts +3 -3
- package/dist/configuration.js +3 -3
- package/dist/esm/api.d.ts +132 -17
- package/dist/esm/api.js +11 -7
- package/dist/esm/base.d.ts +3 -3
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +3 -3
- package/dist/esm/common.js +3 -3
- package/dist/esm/configuration.d.ts +3 -3
- package/dist/esm/configuration.js +3 -3
- package/dist/esm/index.d.ts +3 -3
- package/dist/esm/index.js +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- 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/CreateDigitalProduct.md +25 -0
- package/docs/CreateDigitalProductVariantsInner.md +24 -0
- package/docs/CreateDigitalProductVariantsInnerAttributesInner.md +22 -0
- package/docs/CreateDigitalProductVariantsInnerImagesInner.md +20 -0
- package/docs/CreateProduct.md +2 -2
- package/docs/CreateProductRequest.md +4 -2
- 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 +2 -1
- package/docs/ProductsApi.md +1 -1
- package/docs/Variant.md +2 -0
- package/docs/VariantGfnVariant.md +25 -0
- package/docs/VariantWarehouseVariant.md +2 -1
- package/index.ts +3 -3
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
/**
|
|
@@ -738,6 +742,50 @@ export interface CreateBundleProductSeoMetadata {
|
|
|
738
742
|
*/
|
|
739
743
|
'description'?: string | null;
|
|
740
744
|
}
|
|
745
|
+
/**
|
|
746
|
+
* A digital product is a product that is not physical, it is a service that is sold.
|
|
747
|
+
*/
|
|
748
|
+
export interface CreateDigitalProduct {
|
|
749
|
+
/**
|
|
750
|
+
* The title of the product
|
|
751
|
+
*/
|
|
752
|
+
'title': string;
|
|
753
|
+
/**
|
|
754
|
+
* An explicit flag to indicate that the product is a digital product.
|
|
755
|
+
*/
|
|
756
|
+
'isDigital': boolean;
|
|
757
|
+
/**
|
|
758
|
+
* A list of variants to create for the product.
|
|
759
|
+
*/
|
|
760
|
+
'variants': Array<CreateDigitalProductVariantsInner>;
|
|
761
|
+
}
|
|
762
|
+
export interface CreateDigitalProductVariantsInner {
|
|
763
|
+
/**
|
|
764
|
+
* The attributes of the variant.
|
|
765
|
+
*/
|
|
766
|
+
'attributes': Array<CreateDigitalProductVariantsInnerAttributesInner>;
|
|
767
|
+
/**
|
|
768
|
+
* Images to attach to the product.
|
|
769
|
+
*/
|
|
770
|
+
'images': Array<CreateDigitalProductVariantsInnerImagesInner>;
|
|
771
|
+
'retailPrice': Price;
|
|
772
|
+
}
|
|
773
|
+
export interface CreateDigitalProductVariantsInnerAttributesInner {
|
|
774
|
+
/**
|
|
775
|
+
* The name of the attribute.
|
|
776
|
+
*/
|
|
777
|
+
'name': string;
|
|
778
|
+
/**
|
|
779
|
+
* The value of the attribute.
|
|
780
|
+
*/
|
|
781
|
+
'value': string;
|
|
782
|
+
}
|
|
783
|
+
export interface CreateDigitalProductVariantsInnerImagesInner {
|
|
784
|
+
/**
|
|
785
|
+
* Publicly available file URL.
|
|
786
|
+
*/
|
|
787
|
+
'src': string;
|
|
788
|
+
}
|
|
741
789
|
export interface CreateProduct {
|
|
742
790
|
/**
|
|
743
791
|
* Reference to the product in the 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.
|
|
@@ -781,7 +829,7 @@ export interface CreateProduct {
|
|
|
781
829
|
*/
|
|
782
830
|
'internalTags'?: Array<string>;
|
|
783
831
|
/**
|
|
784
|
-
*
|
|
832
|
+
* 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
833
|
*/
|
|
786
834
|
'variants': Array<CreateProductVariant>;
|
|
787
835
|
/**
|
|
@@ -837,12 +885,12 @@ export interface CreateProductImagesInner {
|
|
|
837
885
|
/**
|
|
838
886
|
* @type CreateProductRequest
|
|
839
887
|
*/
|
|
840
|
-
export type CreateProductRequest = CreateBundleProduct | CreateProduct;
|
|
888
|
+
export type CreateProductRequest = CreateBundleProduct | CreateDigitalProduct | CreateProduct;
|
|
841
889
|
export interface CreateProductVariant {
|
|
842
890
|
/**
|
|
843
|
-
*
|
|
891
|
+
* 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
892
|
*/
|
|
845
|
-
'attributes': Array<
|
|
893
|
+
'attributes': Array<CreateProductVariantAttributesInner>;
|
|
846
894
|
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
847
895
|
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
|
|
848
896
|
/**
|
|
@@ -854,7 +902,7 @@ export interface CreateProductVariant {
|
|
|
854
902
|
*/
|
|
855
903
|
'applications'?: Array<Application>;
|
|
856
904
|
/**
|
|
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
|
|
905
|
+
* 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
906
|
*/
|
|
859
907
|
'images'?: Array<CreateProductVariantImagesInner>;
|
|
860
908
|
/**
|
|
@@ -867,6 +915,21 @@ export interface CreateProductVariant {
|
|
|
867
915
|
'shopifyId'?: number | null;
|
|
868
916
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
|
|
869
917
|
}
|
|
918
|
+
export interface CreateProductVariantAttributesInner {
|
|
919
|
+
/**
|
|
920
|
+
* Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing.
|
|
921
|
+
*/
|
|
922
|
+
'name': CreateProductVariantAttributesInnerNameEnum;
|
|
923
|
+
/**
|
|
924
|
+
* Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing.
|
|
925
|
+
*/
|
|
926
|
+
'value': string;
|
|
927
|
+
}
|
|
928
|
+
export declare const CreateProductVariantAttributesInnerNameEnum: {
|
|
929
|
+
readonly Size: "Size";
|
|
930
|
+
readonly Colour: "Colour";
|
|
931
|
+
};
|
|
932
|
+
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
870
933
|
export interface CreateProductVariantImagesInner {
|
|
871
934
|
/**
|
|
872
935
|
* ID of the image if it already exists. A new image will be created if this is not provided.
|
|
@@ -1103,7 +1166,11 @@ export interface Product {
|
|
|
1103
1166
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1104
1167
|
*/
|
|
1105
1168
|
'shopifyId'?: number | null;
|
|
1169
|
+
/**
|
|
1170
|
+
* @deprecated
|
|
1171
|
+
*/
|
|
1106
1172
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1173
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1107
1174
|
/**
|
|
1108
1175
|
* Key/value pairs that can be used to store additional information about the product
|
|
1109
1176
|
*/
|
|
@@ -1217,7 +1284,11 @@ export interface ProductBundleItemsInner {
|
|
|
1217
1284
|
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1218
1285
|
*/
|
|
1219
1286
|
'shopifyId'?: number | null;
|
|
1287
|
+
/**
|
|
1288
|
+
* @deprecated
|
|
1289
|
+
*/
|
|
1220
1290
|
'warehouseProduct'?: ProductWarehouseProduct;
|
|
1291
|
+
'gfnProduct'?: ProductGfnProduct;
|
|
1221
1292
|
/**
|
|
1222
1293
|
* Key/value pairs that can be used to store additional information about the product
|
|
1223
1294
|
*/
|
|
@@ -1238,6 +1309,23 @@ export interface ProductBundleItemsInner {
|
|
|
1238
1309
|
'license'?: License;
|
|
1239
1310
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1240
1311
|
}
|
|
1312
|
+
/**
|
|
1313
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
|
|
1314
|
+
*/
|
|
1315
|
+
export interface ProductGfnProduct {
|
|
1316
|
+
/**
|
|
1317
|
+
* Unique object identifier
|
|
1318
|
+
*/
|
|
1319
|
+
'id'?: string;
|
|
1320
|
+
/**
|
|
1321
|
+
* 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.
|
|
1322
|
+
*/
|
|
1323
|
+
'gfnProductRef'?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Meta fields from the GFN Catalog product
|
|
1326
|
+
*/
|
|
1327
|
+
'metafields'?: Array<MetaField>;
|
|
1328
|
+
}
|
|
1241
1329
|
export interface ProductType {
|
|
1242
1330
|
/**
|
|
1243
1331
|
* Unique object identifier
|
|
@@ -1255,6 +1343,9 @@ export interface ProductTypeListResponse {
|
|
|
1255
1343
|
*/
|
|
1256
1344
|
'nextPageToken': number | null;
|
|
1257
1345
|
}
|
|
1346
|
+
/**
|
|
1347
|
+
* The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
|
|
1348
|
+
*/
|
|
1258
1349
|
export interface ProductWarehouseProduct {
|
|
1259
1350
|
/**
|
|
1260
1351
|
* Unique object identifier
|
|
@@ -1265,7 +1356,7 @@ export interface ProductWarehouseProduct {
|
|
|
1265
1356
|
*/
|
|
1266
1357
|
'gfnProductRef'?: string;
|
|
1267
1358
|
/**
|
|
1268
|
-
* Meta fields from the
|
|
1359
|
+
* Meta fields from the GFN Catalog product
|
|
1269
1360
|
*/
|
|
1270
1361
|
'metafields'?: Array<MetaField>;
|
|
1271
1362
|
}
|
|
@@ -1909,7 +2000,28 @@ export interface Variant {
|
|
|
1909
2000
|
'metafields'?: Array<MetaField>;
|
|
1910
2001
|
'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
|
|
1911
2002
|
'wholesaleCost'?: VariantWholesaleCost;
|
|
2003
|
+
/**
|
|
2004
|
+
* @deprecated
|
|
2005
|
+
*/
|
|
1912
2006
|
'warehouseVariant'?: VariantWarehouseVariant;
|
|
2007
|
+
'gfnVariant'?: VariantGfnVariant;
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
|
|
2011
|
+
*/
|
|
2012
|
+
export interface VariantGfnVariant {
|
|
2013
|
+
/**
|
|
2014
|
+
* Unique object identifier
|
|
2015
|
+
*/
|
|
2016
|
+
'id'?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* Reference to the variant in the Global Fulfillment Network (GFN) catalog.
|
|
2019
|
+
*/
|
|
2020
|
+
'gfnVariantRef'?: string;
|
|
2021
|
+
/**
|
|
2022
|
+
* Meta fields from the GFN Catalog variant
|
|
2023
|
+
*/
|
|
2024
|
+
'metafields'?: Array<MetaField>;
|
|
1913
2025
|
}
|
|
1914
2026
|
export interface VariantIntegrationConnectionsInner {
|
|
1915
2027
|
'integrationCode': string;
|
|
@@ -1928,6 +2040,9 @@ export interface VariantProduct {
|
|
|
1928
2040
|
*/
|
|
1929
2041
|
'ref'?: string;
|
|
1930
2042
|
}
|
|
2043
|
+
/**
|
|
2044
|
+
* The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
|
|
2045
|
+
*/
|
|
1931
2046
|
export interface VariantWarehouseVariant {
|
|
1932
2047
|
/**
|
|
1933
2048
|
* Unique object identifier
|
|
@@ -1938,7 +2053,7 @@ export interface VariantWarehouseVariant {
|
|
|
1938
2053
|
*/
|
|
1939
2054
|
'gfnVariantRef'?: string;
|
|
1940
2055
|
/**
|
|
1941
|
-
* Meta fields from the
|
|
2056
|
+
* Meta fields from the GFN Catalog variant
|
|
1942
2057
|
*/
|
|
1943
2058
|
'metafields'?: Array<MetaField>;
|
|
1944
2059
|
}
|
|
@@ -3074,7 +3189,7 @@ export declare class ProductTypesApi extends BaseAPI {
|
|
|
3074
3189
|
*/
|
|
3075
3190
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3076
3191
|
/**
|
|
3077
|
-
* Creates a new catalog product based on a
|
|
3192
|
+
* 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.
|
|
3078
3193
|
* @summary Create product
|
|
3079
3194
|
* @param {string} project What project it is
|
|
3080
3195
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3194,7 +3309,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3194
3309
|
*/
|
|
3195
3310
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
3196
3311
|
/**
|
|
3197
|
-
* Creates a new catalog product based on a
|
|
3312
|
+
* 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.
|
|
3198
3313
|
* @summary Create product
|
|
3199
3314
|
* @param {string} project What project it is
|
|
3200
3315
|
* @param {CreateProductRequest} [createProductRequest]
|
|
@@ -3314,7 +3429,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3314
3429
|
*/
|
|
3315
3430
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3316
3431
|
/**
|
|
3317
|
-
* Creates a new catalog product based on a
|
|
3432
|
+
* 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.
|
|
3318
3433
|
* @summary Create product
|
|
3319
3434
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3320
3435
|
* @param {*} [options] Override http request option.
|
|
@@ -3608,7 +3723,7 @@ export interface ProductsApiUpdateProductsRequest {
|
|
|
3608
3723
|
*/
|
|
3609
3724
|
export declare class ProductsApi extends BaseAPI {
|
|
3610
3725
|
/**
|
|
3611
|
-
* Creates a new catalog product based on a
|
|
3726
|
+
* 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.
|
|
3612
3727
|
* @summary Create product
|
|
3613
3728
|
* @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
|
|
3614
3729
|
* @param {*} [options] Override http request option.
|
package/dist/esm/api.js
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
* Product Catalog
|
|
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
|
|
4
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
* Product Catalog
|
|
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
|
|
4
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
* Product Catalog
|
|
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
|
|
4
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
3
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
* Product Catalog
|
|
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
|
|
4
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
-
* Product Catalog
|
|
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
|
|
2
|
+
* Product Catalog
|
|
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.89.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
* Product Catalog
|
|
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
|
|
5
|
+
* Product Catalog
|
|
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.89.0
|
|
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
|
|
package/docs/BundleProduct.md
CHANGED
|
@@ -35,6 +35,7 @@ Name | Type | Description | Notes
|
|
|
35
35
|
**includeInDataFeeds** | **boolean** | | [optional] [default to undefined]
|
|
36
36
|
**shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
|
|
37
37
|
**warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) | | [optional] [default to undefined]
|
|
38
|
+
**gfnProduct** | [**ProductGfnProduct**](ProductGfnProduct.md) | | [optional] [default to undefined]
|
|
38
39
|
**metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
|
|
39
40
|
**personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
|
|
40
41
|
**optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
|
|
@@ -78,6 +79,7 @@ const instance: BundleProduct = {
|
|
|
78
79
|
includeInDataFeeds,
|
|
79
80
|
shopifyId,
|
|
80
81
|
warehouseProduct,
|
|
82
|
+
gfnProduct,
|
|
81
83
|
metafields,
|
|
82
84
|
personalizationTemplate,
|
|
83
85
|
optimisationHistory,
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**technology** | **string** | Technology to use for the application. | [default to undefined]
|
|
9
9
|
**placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
|
|
10
10
|
**additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
|
|
11
|
-
**src** | **string** | Publicly available design file URL. This will fill the design area of the
|
|
11
|
+
**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. | [default to undefined]
|
|
12
12
|
**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]
|
|
13
13
|
**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]
|
|
14
14
|
**properties** | [**CreateApplicationProperties**](CreateApplicationProperties.md) | | [optional] [default to undefined]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CreateDigitalProduct
|
|
2
|
+
|
|
3
|
+
A digital product is a product that is not physical, it is a service that is sold.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**title** | **string** | The title of the product | [default to undefined]
|
|
10
|
+
**isDigital** | **boolean** | An explicit flag to indicate that the product is a digital product. | [default to undefined]
|
|
11
|
+
**variants** | [**Array<CreateDigitalProductVariantsInner>**](CreateDigitalProductVariantsInner.md) | A list of variants to create for the product. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CreateDigitalProduct } from '@teemill/product-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: CreateDigitalProduct = {
|
|
19
|
+
title,
|
|
20
|
+
isDigital,
|
|
21
|
+
variants,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateDigitalProductVariantsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**attributes** | [**Array<CreateDigitalProductVariantsInnerAttributesInner>**](CreateDigitalProductVariantsInnerAttributesInner.md) | The attributes of the variant. | [default to undefined]
|
|
9
|
+
**images** | [**Array<CreateDigitalProductVariantsInnerImagesInner>**](CreateDigitalProductVariantsInnerImagesInner.md) | Images to attach to the product. | [default to undefined]
|
|
10
|
+
**retailPrice** | [**Price**](Price.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateDigitalProductVariantsInner } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: CreateDigitalProductVariantsInner = {
|
|
18
|
+
attributes,
|
|
19
|
+
images,
|
|
20
|
+
retailPrice,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CreateDigitalProductVariantsInnerAttributesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | The name of the attribute. | [default to undefined]
|
|
9
|
+
**value** | **string** | The value of the attribute. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CreateDigitalProductVariantsInnerAttributesInner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: CreateDigitalProductVariantsInnerAttributesInner = {
|
|
17
|
+
name,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|