@teemill/product-catalog 1.47.0 → 1.49.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.
Files changed (93) hide show
  1. package/README.md +115 -2
  2. package/api.ts +113 -1
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +66 -1
  7. package/dist/api.js +74 -1
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +66 -1
  15. package/dist/esm/api.js +74 -1
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/AdditionalFile.md +20 -0
  27. package/docs/ApiError.md +22 -0
  28. package/docs/Application.md +28 -0
  29. package/docs/ApplicationMockup.md +22 -0
  30. package/docs/ApplicationSet.md +38 -0
  31. package/docs/ApplicationSet1.md +22 -0
  32. package/docs/ApplicationSetRecord.md +26 -0
  33. package/docs/ApplicationSetsApi.md +317 -0
  34. package/docs/ApplicationSetsResponse.md +22 -0
  35. package/docs/Attribute.md +26 -0
  36. package/docs/AttributeThumbnail.md +23 -0
  37. package/docs/Attributes1Inner.md +22 -0
  38. package/docs/CreateApplication.md +24 -0
  39. package/docs/CreateApplicationSetRequest.md +30 -0
  40. package/docs/CreateApplicationSetRequestRecordsInner.md +22 -0
  41. package/docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md +22 -0
  42. package/docs/CreateBundleProduct.md +54 -0
  43. package/docs/CreateProduct.md +56 -0
  44. package/docs/CreateProductAdditionalFilesInner.md +20 -0
  45. package/docs/CreateProductImagesInner.md +22 -0
  46. package/docs/CreateProductRequest.md +64 -0
  47. package/docs/CreateProductVariant.md +36 -0
  48. package/docs/CreateProductVariantImagesInner.md +20 -0
  49. package/docs/CreateProductVideosInner.md +20 -0
  50. package/docs/DuplicateProducts202Response.md +20 -0
  51. package/docs/DuplicateProductsRequest.md +22 -0
  52. package/docs/ExportProducts202Response.md +20 -0
  53. package/docs/Image.md +35 -0
  54. package/docs/ImageFile.md +22 -0
  55. package/docs/ImportProducts200Response.md +20 -0
  56. package/docs/Location.md +22 -0
  57. package/docs/MetaField.md +23 -0
  58. package/docs/OptimisationHistoryItem.md +22 -0
  59. package/docs/Price.md +23 -0
  60. package/docs/Product.md +86 -0
  61. package/docs/ProductAdditionalFilesInner.md +22 -0
  62. package/docs/ProductApplicationSetsInner.md +24 -0
  63. package/docs/ProductWarehouseProduct.md +22 -0
  64. package/docs/ProductsApi.md +626 -0
  65. package/docs/ProductsResponse.md +22 -0
  66. package/docs/SEOMetadata.md +23 -0
  67. package/docs/SeoOptimiseProducts202Response.md +20 -0
  68. package/docs/SeoOptimiseProductsRequest.md +22 -0
  69. package/docs/Stock.md +22 -0
  70. package/docs/TargetSearchPhraseData.md +22 -0
  71. package/docs/UpdateApplicationSetRequest.md +30 -0
  72. package/docs/UpdateApplicationSetRequestRecordsInner.md +22 -0
  73. package/docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md +22 -0
  74. package/docs/UpdateProductRequest.md +64 -0
  75. package/docs/UpdateProductRequestIntegrationConnectionsInner.md +22 -0
  76. package/docs/UpdateProductsRequest.md +20 -0
  77. package/docs/UpdateProductsRequestProductsInner.md +42 -0
  78. package/docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md +22 -0
  79. package/docs/UpdateProductsRequestProductsInnerSeoMetadata.md +22 -0
  80. package/docs/UpdateProductsRequestProductsInnerVariantsInner.md +30 -0
  81. package/docs/UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md +22 -0
  82. package/docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md +22 -0
  83. package/docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md +23 -0
  84. package/docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md +23 -0
  85. package/docs/Variant.md +58 -0
  86. package/docs/VariantIntegrationConnectionsInner.md +22 -0
  87. package/docs/VariantProduct.md +22 -0
  88. package/docs/VariantsApi.md +138 -0
  89. package/docs/VariantsResponse.md +22 -0
  90. package/docs/Video.md +31 -0
  91. package/docs/VideoFile.md +20 -0
  92. package/index.ts +1 -1
  93. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/product-catalog@1.47.0
1
+ ## @teemill/product-catalog@1.49.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/product-catalog@1.47.0 --save
39
+ npm install @teemill/product-catalog@1.49.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -44,3 +44,116 @@ _unPublished (not recommended):_
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
46
  ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *https://api.podos.io*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *ApplicationSetsApi* | [**createApplicationSet**](docs/ApplicationSetsApi.md#createapplicationset) | **POST** /v1/catalog/applications/sets | Create application set
55
+ *ApplicationSetsApi* | [**deleteApplicationSet**](docs/ApplicationSetsApi.md#deleteapplicationset) | **DELETE** /v1/catalog/applications/sets/{applicationSetId} | Delete an application set
56
+ *ApplicationSetsApi* | [**getApplicationSet**](docs/ApplicationSetsApi.md#getapplicationset) | **GET** /v1/catalog/applications/sets/{applicationSetId} | Get an application set
57
+ *ApplicationSetsApi* | [**listApplicationSets**](docs/ApplicationSetsApi.md#listapplicationsets) | **GET** /v1/catalog/applications/sets | List application sets
58
+ *ApplicationSetsApi* | [**updateApplicationSet**](docs/ApplicationSetsApi.md#updateapplicationset) | **PATCH** /v1/catalog/applications/sets/{applicationSetId} | Update application set
59
+ *ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
60
+ *ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
61
+ *ProductsApi* | [**duplicateProducts**](docs/ProductsApi.md#duplicateproducts) | **POST** /v1/catalog/products/duplicate | Duplicate products.
62
+ *ProductsApi* | [**exportProducts**](docs/ProductsApi.md#exportproducts) | **GET** /v1/catalog/products/export | Export products
63
+ *ProductsApi* | [**getProduct**](docs/ProductsApi.md#getproduct) | **GET** /v1/catalog/products/{productId} | Get product
64
+ *ProductsApi* | [**importProducts**](docs/ProductsApi.md#importproducts) | **POST** /v1/catalog/products/import | Import products
65
+ *ProductsApi* | [**listProducts**](docs/ProductsApi.md#listproducts) | **GET** /v1/catalog/products | List products
66
+ *ProductsApi* | [**seoOptimiseProducts**](docs/ProductsApi.md#seooptimiseproducts) | **POST** /v1/catalog/products/ai-seo-optimise | AI SEO optimise products.
67
+ *ProductsApi* | [**updateProduct**](docs/ProductsApi.md#updateproduct) | **PATCH** /v1/catalog/products/{productId} | Update product
68
+ *ProductsApi* | [**updateProducts**](docs/ProductsApi.md#updateproducts) | **PATCH** /v1/catalog/products | Update products
69
+ *VariantsApi* | [**getVariant**](docs/VariantsApi.md#getvariant) | **GET** /v1/catalog/variants/{variantId} | Get variant
70
+ *VariantsApi* | [**listVariants**](docs/VariantsApi.md#listvariants) | **GET** /v1/catalog/variants | List variants
71
+
72
+
73
+ ### Documentation For Models
74
+
75
+ - [AdditionalFile](docs/AdditionalFile.md)
76
+ - [ApiError](docs/ApiError.md)
77
+ - [Application](docs/Application.md)
78
+ - [ApplicationMockup](docs/ApplicationMockup.md)
79
+ - [ApplicationSet](docs/ApplicationSet.md)
80
+ - [ApplicationSet1](docs/ApplicationSet1.md)
81
+ - [ApplicationSetRecord](docs/ApplicationSetRecord.md)
82
+ - [ApplicationSetsResponse](docs/ApplicationSetsResponse.md)
83
+ - [Attribute](docs/Attribute.md)
84
+ - [AttributeThumbnail](docs/AttributeThumbnail.md)
85
+ - [Attributes1Inner](docs/Attributes1Inner.md)
86
+ - [CreateApplication](docs/CreateApplication.md)
87
+ - [CreateApplicationSetRequest](docs/CreateApplicationSetRequest.md)
88
+ - [CreateApplicationSetRequestRecordsInner](docs/CreateApplicationSetRequestRecordsInner.md)
89
+ - [CreateApplicationSetRequestRecordsInnerAttributesInner](docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md)
90
+ - [CreateBundleProduct](docs/CreateBundleProduct.md)
91
+ - [CreateProduct](docs/CreateProduct.md)
92
+ - [CreateProductAdditionalFilesInner](docs/CreateProductAdditionalFilesInner.md)
93
+ - [CreateProductImagesInner](docs/CreateProductImagesInner.md)
94
+ - [CreateProductRequest](docs/CreateProductRequest.md)
95
+ - [CreateProductVariant](docs/CreateProductVariant.md)
96
+ - [CreateProductVariantImagesInner](docs/CreateProductVariantImagesInner.md)
97
+ - [CreateProductVideosInner](docs/CreateProductVideosInner.md)
98
+ - [DuplicateProducts202Response](docs/DuplicateProducts202Response.md)
99
+ - [DuplicateProductsRequest](docs/DuplicateProductsRequest.md)
100
+ - [ExportProducts202Response](docs/ExportProducts202Response.md)
101
+ - [Image](docs/Image.md)
102
+ - [ImageFile](docs/ImageFile.md)
103
+ - [ImportProducts200Response](docs/ImportProducts200Response.md)
104
+ - [Location](docs/Location.md)
105
+ - [MetaField](docs/MetaField.md)
106
+ - [OptimisationHistoryItem](docs/OptimisationHistoryItem.md)
107
+ - [Price](docs/Price.md)
108
+ - [Product](docs/Product.md)
109
+ - [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
110
+ - [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
111
+ - [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
112
+ - [ProductsResponse](docs/ProductsResponse.md)
113
+ - [SEOMetadata](docs/SEOMetadata.md)
114
+ - [SeoOptimiseProducts202Response](docs/SeoOptimiseProducts202Response.md)
115
+ - [SeoOptimiseProductsRequest](docs/SeoOptimiseProductsRequest.md)
116
+ - [Stock](docs/Stock.md)
117
+ - [TargetSearchPhraseData](docs/TargetSearchPhraseData.md)
118
+ - [UpdateApplicationSetRequest](docs/UpdateApplicationSetRequest.md)
119
+ - [UpdateApplicationSetRequestRecordsInner](docs/UpdateApplicationSetRequestRecordsInner.md)
120
+ - [UpdateApplicationSetRequestRecordsInnerAttributesInner](docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md)
121
+ - [UpdateProductRequest](docs/UpdateProductRequest.md)
122
+ - [UpdateProductRequestIntegrationConnectionsInner](docs/UpdateProductRequestIntegrationConnectionsInner.md)
123
+ - [UpdateProductsRequest](docs/UpdateProductsRequest.md)
124
+ - [UpdateProductsRequestProductsInner](docs/UpdateProductsRequestProductsInner.md)
125
+ - [UpdateProductsRequestProductsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md)
126
+ - [UpdateProductsRequestProductsInnerSeoMetadata](docs/UpdateProductsRequestProductsInnerSeoMetadata.md)
127
+ - [UpdateProductsRequestProductsInnerVariantsInner](docs/UpdateProductsRequestProductsInnerVariantsInner.md)
128
+ - [UpdateProductsRequestProductsInnerVariantsInnerAttributesInner](docs/UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md)
129
+ - [UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md)
130
+ - [UpdateProductsRequestProductsInnerVariantsInnerRetailPrice](docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md)
131
+ - [UpdateProductsRequestProductsInnerVariantsInnerSalePrice](docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md)
132
+ - [Variant](docs/Variant.md)
133
+ - [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
134
+ - [VariantProduct](docs/VariantProduct.md)
135
+ - [VariantsResponse](docs/VariantsResponse.md)
136
+ - [Video](docs/Video.md)
137
+ - [VideoFile](docs/VideoFile.md)
138
+
139
+
140
+ <a id="documentation-for-authorization"></a>
141
+ ## Documentation For Authorization
142
+
143
+
144
+ Authentication schemes defined for the API:
145
+ <a id="api-key"></a>
146
+ ### api-key
147
+
148
+ - **Type**: API key
149
+ - **API key parameter name**: Authorization
150
+ - **Location**: HTTP header
151
+
152
+ <a id="session-oauth"></a>
153
+ ### session-oauth
154
+
155
+ - **Type**: OAuth
156
+ - **Flow**: password
157
+ - **Authorization URL**:
158
+ - **Scopes**: N/A
159
+
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
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 warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.49.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -872,6 +872,19 @@ export interface DuplicateProductsRequest {
872
872
  */
873
873
  'projects': Array<string>;
874
874
  }
875
+ /**
876
+ *
877
+ * @export
878
+ * @interface ExportProducts202Response
879
+ */
880
+ export interface ExportProducts202Response {
881
+ /**
882
+ * A message describing the export status
883
+ * @type {string}
884
+ * @memberof ExportProducts202Response
885
+ */
886
+ 'message'?: string;
887
+ }
875
888
  /**
876
889
  * Image description
877
890
  * @export
@@ -1379,6 +1392,12 @@ export interface SeoOptimiseProductsRequest {
1379
1392
  * @memberof SeoOptimiseProductsRequest
1380
1393
  */
1381
1394
  'ids'?: Array<string>;
1395
+ /**
1396
+ * If provided, only the specified fields will be updated.
1397
+ * @type {Array<string>}
1398
+ * @memberof SeoOptimiseProductsRequest
1399
+ */
1400
+ 'fields'?: Array<string>;
1382
1401
  }
1383
1402
  /**
1384
1403
  *
@@ -2929,6 +2948,50 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
2929
2948
  options: localVarRequestOptions,
2930
2949
  };
2931
2950
  },
2951
+ /**
2952
+ * Export the project\'s products and variants as a CSV file.
2953
+ * @summary Export products
2954
+ * @param {string} project What project it is
2955
+ * @param {*} [options] Override http request option.
2956
+ * @throws {RequiredError}
2957
+ */
2958
+ exportProducts: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2959
+ // verify required parameter 'project' is not null or undefined
2960
+ assertParamExists('exportProducts', 'project', project)
2961
+ const localVarPath = `/v1/catalog/products/export`;
2962
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2963
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2964
+ let baseOptions;
2965
+ if (configuration) {
2966
+ baseOptions = configuration.baseOptions;
2967
+ }
2968
+
2969
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2970
+ const localVarHeaderParameter = {} as any;
2971
+ const localVarQueryParameter = {} as any;
2972
+
2973
+ // authentication session-oauth required
2974
+ // oauth required
2975
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2976
+
2977
+ // authentication api-key required
2978
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2979
+
2980
+ if (project !== undefined) {
2981
+ localVarQueryParameter['project'] = project;
2982
+ }
2983
+
2984
+
2985
+
2986
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2987
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2988
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2989
+
2990
+ return {
2991
+ url: toPathString(localVarUrlObj),
2992
+ options: localVarRequestOptions,
2993
+ };
2994
+ },
2932
2995
  /**
2933
2996
  * Gets a product by a given ID.
2934
2997
  * @summary Get product
@@ -3301,6 +3364,19 @@ export const ProductsApiFp = function(configuration?: Configuration) {
3301
3364
  const localVarOperationServerBasePath = operationServerMap['ProductsApi.duplicateProducts']?.[localVarOperationServerIndex]?.url;
3302
3365
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3303
3366
  },
3367
+ /**
3368
+ * Export the project\'s products and variants as a CSV file.
3369
+ * @summary Export products
3370
+ * @param {string} project What project it is
3371
+ * @param {*} [options] Override http request option.
3372
+ * @throws {RequiredError}
3373
+ */
3374
+ async exportProducts(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3375
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, options);
3376
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3377
+ const localVarOperationServerBasePath = operationServerMap['ProductsApi.exportProducts']?.[localVarOperationServerIndex]?.url;
3378
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3379
+ },
3304
3380
  /**
3305
3381
  * Gets a product by a given ID.
3306
3382
  * @summary Get product
@@ -3431,6 +3507,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
3431
3507
  duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateProducts202Response> {
3432
3508
  return localVarFp.duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(axios, basePath));
3433
3509
  },
3510
+ /**
3511
+ * Export the project\'s products and variants as a CSV file.
3512
+ * @summary Export products
3513
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
3514
+ * @param {*} [options] Override http request option.
3515
+ * @throws {RequiredError}
3516
+ */
3517
+ exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3518
+ return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
3519
+ },
3434
3520
  /**
3435
3521
  * Gets a product by a given ID.
3436
3522
  * @summary Get product
@@ -3557,6 +3643,20 @@ export interface ProductsApiDuplicateProductsRequest {
3557
3643
  readonly duplicateProductsRequest?: DuplicateProductsRequest
3558
3644
  }
3559
3645
 
3646
+ /**
3647
+ * Request parameters for exportProducts operation in ProductsApi.
3648
+ * @export
3649
+ * @interface ProductsApiExportProductsRequest
3650
+ */
3651
+ export interface ProductsApiExportProductsRequest {
3652
+ /**
3653
+ * What project it is
3654
+ * @type {string}
3655
+ * @memberof ProductsApiExportProducts
3656
+ */
3657
+ readonly project: string
3658
+ }
3659
+
3560
3660
  /**
3561
3661
  * Request parameters for getProduct operation in ProductsApi.
3562
3662
  * @export
@@ -3768,6 +3868,18 @@ export class ProductsApi extends BaseAPI {
3768
3868
  return ProductsApiFp(this.configuration).duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(this.axios, this.basePath));
3769
3869
  }
3770
3870
 
3871
+ /**
3872
+ * Export the project\'s products and variants as a CSV file.
3873
+ * @summary Export products
3874
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
3875
+ * @param {*} [options] Override http request option.
3876
+ * @throws {RequiredError}
3877
+ * @memberof ProductsApi
3878
+ */
3879
+ public exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig) {
3880
+ return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
3881
+ }
3882
+
3771
3883
  /**
3772
3884
  * Gets a product by a given ID.
3773
3885
  * @summary Get product
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
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 warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.49.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
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 warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.49.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
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 warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.47.0
7
+ * The version of the OpenAPI document: 1.49.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.49.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -850,6 +850,19 @@ export interface DuplicateProductsRequest {
850
850
  */
851
851
  'projects': Array<string>;
852
852
  }
853
+ /**
854
+ *
855
+ * @export
856
+ * @interface ExportProducts202Response
857
+ */
858
+ export interface ExportProducts202Response {
859
+ /**
860
+ * A message describing the export status
861
+ * @type {string}
862
+ * @memberof ExportProducts202Response
863
+ */
864
+ 'message'?: string;
865
+ }
853
866
  /**
854
867
  * Image description
855
868
  * @export
@@ -1354,6 +1367,12 @@ export interface SeoOptimiseProductsRequest {
1354
1367
  * @memberof SeoOptimiseProductsRequest
1355
1368
  */
1356
1369
  'ids'?: Array<string>;
1370
+ /**
1371
+ * If provided, only the specified fields will be updated.
1372
+ * @type {Array<string>}
1373
+ * @memberof SeoOptimiseProductsRequest
1374
+ */
1375
+ 'fields'?: Array<string>;
1357
1376
  }
1358
1377
  /**
1359
1378
  *
@@ -2493,6 +2512,14 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
2493
2512
  * @throws {RequiredError}
2494
2513
  */
2495
2514
  duplicateProducts: (project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2515
+ /**
2516
+ * Export the project\'s products and variants as a CSV file.
2517
+ * @summary Export products
2518
+ * @param {string} project What project it is
2519
+ * @param {*} [options] Override http request option.
2520
+ * @throws {RequiredError}
2521
+ */
2522
+ exportProducts: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2496
2523
  /**
2497
2524
  * Gets a product by a given ID.
2498
2525
  * @summary Get product
@@ -2586,6 +2613,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
2586
2613
  * @throws {RequiredError}
2587
2614
  */
2588
2615
  duplicateProducts(project: string, duplicateProductsRequest?: DuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateProducts202Response>>;
2616
+ /**
2617
+ * Export the project\'s products and variants as a CSV file.
2618
+ * @summary Export products
2619
+ * @param {string} project What project it is
2620
+ * @param {*} [options] Override http request option.
2621
+ * @throws {RequiredError}
2622
+ */
2623
+ exportProducts(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2589
2624
  /**
2590
2625
  * Gets a product by a given ID.
2591
2626
  * @summary Get product
@@ -2676,6 +2711,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
2676
2711
  * @throws {RequiredError}
2677
2712
  */
2678
2713
  duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateProducts202Response>;
2714
+ /**
2715
+ * Export the project\'s products and variants as a CSV file.
2716
+ * @summary Export products
2717
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
2718
+ * @param {*} [options] Override http request option.
2719
+ * @throws {RequiredError}
2720
+ */
2721
+ exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2679
2722
  /**
2680
2723
  * Gets a product by a given ID.
2681
2724
  * @summary Get product
@@ -2782,6 +2825,19 @@ export interface ProductsApiDuplicateProductsRequest {
2782
2825
  */
2783
2826
  readonly duplicateProductsRequest?: DuplicateProductsRequest;
2784
2827
  }
2828
+ /**
2829
+ * Request parameters for exportProducts operation in ProductsApi.
2830
+ * @export
2831
+ * @interface ProductsApiExportProductsRequest
2832
+ */
2833
+ export interface ProductsApiExportProductsRequest {
2834
+ /**
2835
+ * What project it is
2836
+ * @type {string}
2837
+ * @memberof ProductsApiExportProducts
2838
+ */
2839
+ readonly project: string;
2840
+ }
2785
2841
  /**
2786
2842
  * Request parameters for getProduct operation in ProductsApi.
2787
2843
  * @export
@@ -2966,6 +3022,15 @@ export declare class ProductsApi extends BaseAPI {
2966
3022
  * @memberof ProductsApi
2967
3023
  */
2968
3024
  duplicateProducts(requestParameters: ProductsApiDuplicateProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateProducts202Response, any>>;
3025
+ /**
3026
+ * Export the project\'s products and variants as a CSV file.
3027
+ * @summary Export products
3028
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
3029
+ * @param {*} [options] Override http request option.
3030
+ * @throws {RequiredError}
3031
+ * @memberof ProductsApi
3032
+ */
3033
+ exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
2969
3034
  /**
2970
3035
  * Gets a product by a given ID.
2971
3036
  * @summary Get product
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.47.0
8
+ * The version of the OpenAPI document: 1.49.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -648,6 +648,42 @@ const ProductsApiAxiosParamCreator = function (configuration) {
648
648
  options: localVarRequestOptions,
649
649
  };
650
650
  }),
651
+ /**
652
+ * Export the project\'s products and variants as a CSV file.
653
+ * @summary Export products
654
+ * @param {string} project What project it is
655
+ * @param {*} [options] Override http request option.
656
+ * @throws {RequiredError}
657
+ */
658
+ exportProducts: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
659
+ // verify required parameter 'project' is not null or undefined
660
+ (0, common_1.assertParamExists)('exportProducts', 'project', project);
661
+ const localVarPath = `/v1/catalog/products/export`;
662
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
663
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
664
+ let baseOptions;
665
+ if (configuration) {
666
+ baseOptions = configuration.baseOptions;
667
+ }
668
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
669
+ const localVarHeaderParameter = {};
670
+ const localVarQueryParameter = {};
671
+ // authentication session-oauth required
672
+ // oauth required
673
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
674
+ // authentication api-key required
675
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
676
+ if (project !== undefined) {
677
+ localVarQueryParameter['project'] = project;
678
+ }
679
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
680
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
681
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
682
+ return {
683
+ url: (0, common_1.toPathString)(localVarUrlObj),
684
+ options: localVarRequestOptions,
685
+ };
686
+ }),
651
687
  /**
652
688
  * Gets a product by a given ID.
653
689
  * @summary Get product
@@ -971,6 +1007,22 @@ const ProductsApiFp = function (configuration) {
971
1007
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
972
1008
  });
973
1009
  },
1010
+ /**
1011
+ * Export the project\'s products and variants as a CSV file.
1012
+ * @summary Export products
1013
+ * @param {string} project What project it is
1014
+ * @param {*} [options] Override http request option.
1015
+ * @throws {RequiredError}
1016
+ */
1017
+ exportProducts(project, options) {
1018
+ return __awaiter(this, void 0, void 0, function* () {
1019
+ var _a, _b, _c;
1020
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, options);
1021
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1022
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.exportProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1023
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1024
+ });
1025
+ },
974
1026
  /**
975
1027
  * Gets a product by a given ID.
976
1028
  * @summary Get product
@@ -1119,6 +1171,16 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
1119
1171
  duplicateProducts(requestParameters, options) {
1120
1172
  return localVarFp.duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(axios, basePath));
1121
1173
  },
1174
+ /**
1175
+ * Export the project\'s products and variants as a CSV file.
1176
+ * @summary Export products
1177
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
1178
+ * @param {*} [options] Override http request option.
1179
+ * @throws {RequiredError}
1180
+ */
1181
+ exportProducts(requestParameters, options) {
1182
+ return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
1183
+ },
1122
1184
  /**
1123
1185
  * Gets a product by a given ID.
1124
1186
  * @summary Get product
@@ -1222,6 +1284,17 @@ class ProductsApi extends base_1.BaseAPI {
1222
1284
  duplicateProducts(requestParameters, options) {
1223
1285
  return (0, exports.ProductsApiFp)(this.configuration).duplicateProducts(requestParameters.project, requestParameters.duplicateProductsRequest, options).then((request) => request(this.axios, this.basePath));
1224
1286
  }
1287
+ /**
1288
+ * Export the project\'s products and variants as a CSV file.
1289
+ * @summary Export products
1290
+ * @param {ProductsApiExportProductsRequest} requestParameters Request parameters.
1291
+ * @param {*} [options] Override http request option.
1292
+ * @throws {RequiredError}
1293
+ * @memberof ProductsApi
1294
+ */
1295
+ exportProducts(requestParameters, options) {
1296
+ return (0, exports.ProductsApiFp)(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1297
+ }
1225
1298
  /**
1226
1299
  * Gets a product by a given ID.
1227
1300
  * @summary Get product
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.49.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.47.0
8
+ * The version of the OpenAPI document: 1.49.0
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
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.49.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.47.0
8
+ * The version of the OpenAPI document: 1.49.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.47.0
5
+ * The version of the OpenAPI document: 1.49.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.47.0
8
+ * The version of the OpenAPI document: 1.49.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).