@teemill/product-catalog 1.96.0 → 1.97.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/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
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 product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.96.0
5
+ * The version of the OpenAPI document: 1.97.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -504,63 +504,6 @@ export declare const AutoMerchProductsRequestFieldsEnum: {
504
504
  readonly TargetSearchPhraseData: "targetSearchPhraseData";
505
505
  };
506
506
  export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
507
- /**
508
- * Product marketplace listing updates grouped by marketplace.
509
- */
510
- export interface BulkUpdateMarketplaceListing {
511
- /**
512
- * The marketplace code to update.
513
- */
514
- 'code': string;
515
- 'products': Array<BulkUpdateMarketplaceListingProduct>;
516
- }
517
- /**
518
- * Marketplace listing fields to update for a single product within a marketplace group.
519
- */
520
- export interface BulkUpdateMarketplaceListingProduct {
521
- /**
522
- * Unique object identifier
523
- */
524
- 'id': string;
525
- 'title'?: string | null;
526
- 'description'?: string | null;
527
- 'metaTitle'?: string | null;
528
- 'metaDescription'?: string | null;
529
- 'price'?: number | null;
530
- 'images'?: Array<ImageFile> | null;
531
- }
532
- /**
533
- * Listing updates scoped to exactly one marketplace per HTTP request. To change another marketplace, issue another request.
534
- */
535
- export interface BulkUpdateMarketplaceListingRequest {
536
- /**
537
- * Must contain exactly one marketplace group (`code` plus the `products` to update).
538
- */
539
- 'marketplace': Array<BulkUpdateMarketplaceListing>;
540
- }
541
- /**
542
- * Updated marketplace listing data grouped by marketplace.
543
- */
544
- export interface BulkUpdateMarketplaceListingResponse {
545
- 'marketplaceListings': Array<BulkUpdatedMarketplaceListings>;
546
- }
547
- /**
548
- * Updated marketplace listing data for a product.
549
- */
550
- export interface BulkUpdatedMarketplaceListing {
551
- /**
552
- * Unique object identifier
553
- */
554
- 'id': string;
555
- 'listing': MarketplaceListingFields | null;
556
- }
557
- /**
558
- * Updated product listings for a marketplace.
559
- */
560
- export interface BulkUpdatedMarketplaceListings {
561
- 'code': string;
562
- 'products': Array<BulkUpdatedMarketplaceListing>;
563
- }
564
507
  /**
565
508
  * A bundle product that groups multiple items together at a combined price.
566
509
  */
@@ -1256,22 +1199,12 @@ export interface MarketplaceListing {
1256
1199
  'metaTitle'?: string | null;
1257
1200
  'metaDescription'?: string | null;
1258
1201
  'price'?: number | null;
1202
+ /**
1203
+ * Listing-specific tags for this marketplace.
1204
+ */
1205
+ 'tags'?: Array<string> | null;
1259
1206
  'images'?: Array<Image>;
1260
1207
  }
1261
- /**
1262
- * Product listing fields for a marketplace.
1263
- */
1264
- export interface MarketplaceListingFields {
1265
- 'title'?: string | null;
1266
- 'description'?: string | null;
1267
- 'metaTitle'?: string | null;
1268
- 'metaDescription'?: string | null;
1269
- 'price'?: number | null;
1270
- 'images'?: Array<Image> | null;
1271
- }
1272
- export interface MarketplaceListingsResponse {
1273
- 'marketplaceListings': Array<MarketplaceListing>;
1274
- }
1275
1208
  /**
1276
1209
  * Key/value pairs that can be used to store additional information on the product
1277
1210
  */
@@ -2010,27 +1943,6 @@ export interface UpdateApplicationSetRequestRecordsInnerAttributesInner {
2010
1943
  */
2011
1944
  'value'?: string;
2012
1945
  }
2013
- /**
2014
- * Marketplace listing fields to update for a product.
2015
- */
2016
- export interface UpdateMarketplaceListing {
2017
- /**
2018
- * The marketplace code to update.
2019
- */
2020
- 'code': string;
2021
- 'title'?: string | null;
2022
- 'description'?: string | null;
2023
- 'metaTitle'?: string | null;
2024
- 'metaDescription'?: string | null;
2025
- 'price'?: number | null;
2026
- 'images'?: Array<ImageFile> | null;
2027
- }
2028
- /**
2029
- * Marketplace listings to update for a product.
2030
- */
2031
- export interface UpdateMarketplaceListingRequest {
2032
- 'marketplaces': Array<UpdateMarketplaceListing>;
2033
- }
2034
1946
  export interface UpdateProductRequest {
2035
1947
  /**
2036
1948
  * 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.
@@ -3662,15 +3574,6 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3662
3574
  * @throws {RequiredError}
3663
3575
  */
3664
3576
  autoMerchProducts: (project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3665
- /**
3666
- * Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
3667
- * @summary Bulk update product marketplaces
3668
- * @param {string} project What project it is
3669
- * @param {BulkUpdateMarketplaceListingRequest} bulkUpdateMarketplaceListingRequest Update marketplace listing fields for multiple products for one marketplace only. The &#x60;marketplaces&#x60; array must contain exactly one item (one &#x60;code&#x60; and its &#x60;products&#x60;).
3670
- * @param {*} [options] Override http request option.
3671
- * @throws {RequiredError}
3672
- */
3673
- bulkUpdateProductMarketplaceListings: (project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3674
3577
  /**
3675
3578
  * 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.
3676
3579
  * @summary Create product
@@ -3722,15 +3625,6 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3722
3625
  * @throws {RequiredError}
3723
3626
  */
3724
3627
  exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3725
- /**
3726
- * Gets marketplace listing data for a product.
3727
- * @summary Get product marketplaces
3728
- * @param {string} project What project it is
3729
- * @param {string} productId Product\&#39;s unique identifier
3730
- * @param {*} [options] Override http request option.
3731
- * @throws {RequiredError}
3732
- */
3733
- getMarketplaceListings: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3734
3628
  /**
3735
3629
  * Gets a product by a given ID.
3736
3630
  * @summary Get product
@@ -3791,16 +3685,6 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3791
3685
  * @throws {RequiredError}
3792
3686
  */
3793
3687
  seoOptimiseProducts: (project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3794
- /**
3795
- * Updates marketplace listing data for a product.
3796
- * @summary Update product marketplaces
3797
- * @param {string} project What project it is
3798
- * @param {string} productId Product\&#39;s unique identifier
3799
- * @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
3800
- * @param {*} [options] Override http request option.
3801
- * @throws {RequiredError}
3802
- */
3803
- updateMarketplaceListings: (project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3804
3688
  /**
3805
3689
  * Updates a product by a given ID.
3806
3690
  * @summary Update product
@@ -3834,15 +3718,6 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3834
3718
  * @throws {RequiredError}
3835
3719
  */
3836
3720
  autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoMerchProducts202Response>>;
3837
- /**
3838
- * Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
3839
- * @summary Bulk update product marketplaces
3840
- * @param {string} project What project it is
3841
- * @param {BulkUpdateMarketplaceListingRequest} bulkUpdateMarketplaceListingRequest Update marketplace listing fields for multiple products for one marketplace only. The &#x60;marketplaces&#x60; array must contain exactly one item (one &#x60;code&#x60; and its &#x60;products&#x60;).
3842
- * @param {*} [options] Override http request option.
3843
- * @throws {RequiredError}
3844
- */
3845
- bulkUpdateProductMarketplaceListings(project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkUpdateMarketplaceListingResponse>>;
3846
3721
  /**
3847
3722
  * 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.
3848
3723
  * @summary Create product
@@ -3894,15 +3769,6 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3894
3769
  * @throws {RequiredError}
3895
3770
  */
3896
3771
  exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
3897
- /**
3898
- * Gets marketplace listing data for a product.
3899
- * @summary Get product marketplaces
3900
- * @param {string} project What project it is
3901
- * @param {string} productId Product\&#39;s unique identifier
3902
- * @param {*} [options] Override http request option.
3903
- * @throws {RequiredError}
3904
- */
3905
- getMarketplaceListings(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>>;
3906
3772
  /**
3907
3773
  * Gets a product by a given ID.
3908
3774
  * @summary Get product
@@ -3963,16 +3829,6 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3963
3829
  * @throws {RequiredError}
3964
3830
  */
3965
3831
  seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimiseProducts202Response>>;
3966
- /**
3967
- * Updates marketplace listing data for a product.
3968
- * @summary Update product marketplaces
3969
- * @param {string} project What project it is
3970
- * @param {string} productId Product\&#39;s unique identifier
3971
- * @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
3972
- * @param {*} [options] Override http request option.
3973
- * @throws {RequiredError}
3974
- */
3975
- updateMarketplaceListings(project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>>;
3976
3832
  /**
3977
3833
  * Updates a product by a given ID.
3978
3834
  * @summary Update product
@@ -4005,14 +3861,6 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
4005
3861
  * @throws {RequiredError}
4006
3862
  */
4007
3863
  autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response>;
4008
- /**
4009
- * Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
4010
- * @summary Bulk update product marketplaces
4011
- * @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
4012
- * @param {*} [options] Override http request option.
4013
- * @throws {RequiredError}
4014
- */
4015
- bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUpdateMarketplaceListingResponse>;
4016
3864
  /**
4017
3865
  * 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.
4018
3866
  * @summary Create product
@@ -4053,14 +3901,6 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
4053
3901
  * @throws {RequiredError}
4054
3902
  */
4055
3903
  exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
4056
- /**
4057
- * Gets marketplace listing data for a product.
4058
- * @summary Get product marketplaces
4059
- * @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
4060
- * @param {*} [options] Override http request option.
4061
- * @throws {RequiredError}
4062
- */
4063
- getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse>;
4064
3904
  /**
4065
3905
  * Gets a product by a given ID.
4066
3906
  * @summary Get product
@@ -4093,14 +3933,6 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
4093
3933
  * @throws {RequiredError}
4094
3934
  */
4095
3935
  seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimiseProducts202Response>;
4096
- /**
4097
- * Updates marketplace listing data for a product.
4098
- * @summary Update product marketplaces
4099
- * @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
4100
- * @param {*} [options] Override http request option.
4101
- * @throws {RequiredError}
4102
- */
4103
- updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse>;
4104
3936
  /**
4105
3937
  * Updates a product by a given ID.
4106
3938
  * @summary Update product
@@ -4131,19 +3963,6 @@ export interface ProductsApiAutoMerchProductsRequest {
4131
3963
  */
4132
3964
  readonly autoMerchProductsRequest?: AutoMerchProductsRequest;
4133
3965
  }
4134
- /**
4135
- * Request parameters for bulkUpdateProductMarketplaceListings operation in ProductsApi.
4136
- */
4137
- export interface ProductsApiBulkUpdateProductMarketplaceListingsRequest {
4138
- /**
4139
- * What project it is
4140
- */
4141
- readonly project: string;
4142
- /**
4143
- * Update marketplace listing fields for multiple products for one marketplace only. The &#x60;marketplaces&#x60; array must contain exactly one item (one &#x60;code&#x60; and its &#x60;products&#x60;).
4144
- */
4145
- readonly bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest;
4146
- }
4147
3966
  /**
4148
3967
  * Request parameters for createProduct operation in ProductsApi.
4149
3968
  */
@@ -4233,19 +4052,6 @@ export interface ProductsApiExportProductsRequest {
4233
4052
  */
4234
4053
  readonly marketplaceCode?: string;
4235
4054
  }
4236
- /**
4237
- * Request parameters for getMarketplaceListings operation in ProductsApi.
4238
- */
4239
- export interface ProductsApiGetMarketplaceListingsRequest {
4240
- /**
4241
- * What project it is
4242
- */
4243
- readonly project: string;
4244
- /**
4245
- * Product\&#39;s unique identifier
4246
- */
4247
- readonly productId: string;
4248
- }
4249
4055
  /**
4250
4056
  * Request parameters for getProduct operation in ProductsApi.
4251
4057
  */
@@ -4394,23 +4200,6 @@ export interface ProductsApiSeoOptimiseProductsRequest {
4394
4200
  */
4395
4201
  readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest;
4396
4202
  }
4397
- /**
4398
- * Request parameters for updateMarketplaceListings operation in ProductsApi.
4399
- */
4400
- export interface ProductsApiUpdateMarketplaceListingsRequest {
4401
- /**
4402
- * What project it is
4403
- */
4404
- readonly project: string;
4405
- /**
4406
- * Product\&#39;s unique identifier
4407
- */
4408
- readonly productId: string;
4409
- /**
4410
- * The marketplace listing fields to update. Only the fields provided will be modified.
4411
- */
4412
- readonly updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest;
4413
- }
4414
4203
  /**
4415
4204
  * Request parameters for updateProduct operation in ProductsApi.
4416
4205
  */
@@ -4453,14 +4242,6 @@ export declare class ProductsApi extends BaseAPI {
4453
4242
  * @throws {RequiredError}
4454
4243
  */
4455
4244
  autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoMerchProducts202Response, any, {}>>;
4456
- /**
4457
- * Updates marketplace listing data for multiple products under a single marketplace. Each request carries exactly one marketplace group (see `BulkUpdateMarketplaceListingRequest.marketplace`); send additional requests to update another marketplace code.
4458
- * @summary Bulk update product marketplaces
4459
- * @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
4460
- * @param {*} [options] Override http request option.
4461
- * @throws {RequiredError}
4462
- */
4463
- bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkUpdateMarketplaceListingResponse, any, {}>>;
4464
4245
  /**
4465
4246
  * 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.
4466
4247
  * @summary Create product
@@ -4501,14 +4282,6 @@ export declare class ProductsApi extends BaseAPI {
4501
4282
  * @throws {RequiredError}
4502
4283
  */
4503
4284
  exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4504
- /**
4505
- * Gets marketplace listing data for a product.
4506
- * @summary Get product marketplaces
4507
- * @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
4508
- * @param {*} [options] Override http request option.
4509
- * @throws {RequiredError}
4510
- */
4511
- getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarketplaceListingsResponse, any, {}>>;
4512
4285
  /**
4513
4286
  * Gets a product by a given ID.
4514
4287
  * @summary Get product
@@ -4541,14 +4314,6 @@ export declare class ProductsApi extends BaseAPI {
4541
4314
  * @throws {RequiredError}
4542
4315
  */
4543
4316
  seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimiseProducts202Response, any, {}>>;
4544
- /**
4545
- * Updates marketplace listing data for a product.
4546
- * @summary Update product marketplaces
4547
- * @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
4548
- * @param {*} [options] Override http request option.
4549
- * @throws {RequiredError}
4550
- */
4551
- updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarketplaceListingsResponse, any, {}>>;
4552
4317
  /**
4553
4318
  * Updates a product by a given ID.
4554
4319
  * @summary Update product