@teemill/product-catalog 1.95.3 → 1.96.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog
  * 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.
  *
- * The version of the OpenAPI document: 1.95.3
+ * The version of the OpenAPI document: 1.96.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -504,6 +504,63 @@ export declare const AutoMerchProductsRequestFieldsEnum: {
     readonly TargetSearchPhraseData: "targetSearchPhraseData";
 };
 export type AutoMerchProductsRequestFieldsEnum = typeof AutoMerchProductsRequestFieldsEnum[keyof typeof AutoMerchProductsRequestFieldsEnum];
+/**
+ * Product marketplace listing updates grouped by marketplace.
+ */
+export interface BulkUpdateMarketplaceListing {
+    /**
+     * The marketplace code to update.
+     */
+    'code': string;
+    'products': Array<BulkUpdateMarketplaceListingProduct>;
+}
+/**
+ * Marketplace listing fields to update for a single product within a marketplace group.
+ */
+export interface BulkUpdateMarketplaceListingProduct {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    'title'?: string | null;
+    'description'?: string | null;
+    'metaTitle'?: string | null;
+    'metaDescription'?: string | null;
+    'price'?: number | null;
+    'images'?: Array<ImageFile> | null;
+}
+/**
+ * Listing updates scoped to exactly one marketplace per HTTP request. To change another marketplace, issue another request.
+ */
+export interface BulkUpdateMarketplaceListingRequest {
+    /**
+     * Must contain exactly one marketplace group (`code` plus the `products` to update).
+     */
+    'marketplace': Array<BulkUpdateMarketplaceListing>;
+}
+/**
+ * Updated marketplace listing data grouped by marketplace.
+ */
+export interface BulkUpdateMarketplaceListingResponse {
+    'marketplaceListings': Array<BulkUpdatedMarketplaceListings>;
+}
+/**
+ * Updated marketplace listing data for a product.
+ */
+export interface BulkUpdatedMarketplaceListing {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    'listing': MarketplaceListingFields | null;
+}
+/**
+ * Updated product listings for a marketplace.
+ */
+export interface BulkUpdatedMarketplaceListings {
+    'code': string;
+    'products': Array<BulkUpdatedMarketplaceListing>;
+}
 /**
  * A bundle product that groups multiple items together at a combined price.
  */
@@ -1182,6 +1239,39 @@ export interface Location {
      */
     'country': string;
 }
+/**
+ * Product listing data for a marketplace.
+ */
+export interface MarketplaceListing {
+    /**
+     * The marketplace code.
+     */
+    'code': string;
+    /**
+     * The display name of the marketplace.
+     */
+    'name': string;
+    'title'?: string | null;
+    'description'?: string | null;
+    'metaTitle'?: string | null;
+    'metaDescription'?: string | null;
+    'price'?: number | null;
+    'images'?: Array<Image>;
+}
+/**
+ * Product listing fields for a marketplace.
+ */
+export interface MarketplaceListingFields {
+    'title'?: string | null;
+    'description'?: string | null;
+    'metaTitle'?: string | null;
+    'metaDescription'?: string | null;
+    'price'?: number | null;
+    'images'?: Array<Image> | null;
+}
+export interface MarketplaceListingsResponse {
+    'marketplaceListings': Array<MarketplaceListing>;
+}
 /**
  * Key/value pairs that can be used to store additional information on the product
  */
@@ -1348,6 +1438,10 @@ export interface Product {
      */
     'optimisationHistory'?: Array<OptimisationHistoryItem>;
     'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
+    /**
+     * Marketplace-specific listing data that can override product fields during integration syncs.
+     */
+    'marketplaceListings'?: Array<MarketplaceListing>;
     /**
      * Whether to show a sale badge on the product
      */
@@ -1916,6 +2010,27 @@ export interface UpdateApplicationSetRequestRecordsInnerAttributesInner {
      */
     'value'?: string;
 }
+/**
+ * Marketplace listing fields to update for a product.
+ */
+export interface UpdateMarketplaceListing {
+    /**
+     * The marketplace code to update.
+     */
+    'code': string;
+    'title'?: string | null;
+    'description'?: string | null;
+    'metaTitle'?: string | null;
+    'metaDescription'?: string | null;
+    'price'?: number | null;
+    'images'?: Array<ImageFile> | null;
+}
+/**
+ * Marketplace listings to update for a product.
+ */
+export interface UpdateMarketplaceListingRequest {
+    'marketplaces': Array<UpdateMarketplaceListing>;
+}
 export interface UpdateProductRequest {
     /**
      * 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.
@@ -3547,6 +3662,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     autoMerchProducts: (project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Bulk update product marketplaces
+     * @param {string} project What project it is
+     * @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;).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdateProductMarketplaceListings: (project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary Create product
@@ -3593,10 +3717,20 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
      * @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
      * @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
+     * @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets marketplace listing data for a product.
+     * @summary Get product marketplaces
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getMarketplaceListings: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -3657,6 +3791,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     seoOptimiseProducts: (project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates marketplace listing data for a product.
+     * @summary Update product marketplaces
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMarketplaceListings: (project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -3690,6 +3834,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     autoMerchProducts(project: string, autoMerchProductsRequest?: AutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoMerchProducts202Response>>;
+    /**
+     * 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.
+     * @summary Bulk update product marketplaces
+     * @param {string} project What project it is
+     * @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;).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdateProductMarketplaceListings(project: string, bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkUpdateMarketplaceListingResponse>>;
     /**
      * 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.
      * @summary Create product
@@ -3736,10 +3889,20 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
      * @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
      * @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
+     * @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>>;
+    /**
+     * Gets marketplace listing data for a product.
+     * @summary Get product marketplaces
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    getMarketplaceListings(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -3800,6 +3963,16 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     seoOptimiseProducts(project: string, seoOptimiseProductsRequest?: SeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimiseProducts202Response>>;
+    /**
+     * Updates marketplace listing data for a product.
+     * @summary Update product marketplaces
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {UpdateMarketplaceListingRequest} [updateMarketplaceListingRequest] The marketplace listing fields to update. Only the fields provided will be modified.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMarketplaceListings(project: string, productId: string, updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarketplaceListingsResponse>>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -3832,6 +4005,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoMerchProducts202Response>;
+    /**
+     * 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.
+     * @summary Bulk update product marketplaces
+     * @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUpdateMarketplaceListingResponse>;
     /**
      * 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.
      * @summary Create product
@@ -3872,6 +4053,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Gets marketplace listing data for a product.
+     * @summary Get product marketplaces
+     * @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -3904,6 +4093,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimiseProducts202Response>;
+    /**
+     * Updates marketplace listing data for a product.
+     * @summary Update product marketplaces
+     * @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MarketplaceListingsResponse>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
@@ -3934,6 +4131,19 @@ export interface ProductsApiAutoMerchProductsRequest {
      */
     readonly autoMerchProductsRequest?: AutoMerchProductsRequest;
 }
+/**
+ * Request parameters for bulkUpdateProductMarketplaceListings operation in ProductsApi.
+ */
+export interface ProductsApiBulkUpdateProductMarketplaceListingsRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+    /**
+     * 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;).
+     */
+    readonly bulkUpdateMarketplaceListingRequest: BulkUpdateMarketplaceListingRequest;
+}
 /**
  * Request parameters for createProduct operation in ProductsApi.
  */
@@ -4018,6 +4228,23 @@ export interface ProductsApiExportProductsRequest {
      * Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
      */
     readonly minRetailPrice?: number;
+    /**
+     * Export product data in the listing format for the selected marketplace code.
+     */
+    readonly marketplaceCode?: string;
+}
+/**
+ * Request parameters for getMarketplaceListings operation in ProductsApi.
+ */
+export interface ProductsApiGetMarketplaceListingsRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     */
+    readonly productId: string;
 }
 /**
  * Request parameters for getProduct operation in ProductsApi.
@@ -4167,6 +4394,23 @@ export interface ProductsApiSeoOptimiseProductsRequest {
      */
     readonly seoOptimiseProductsRequest?: SeoOptimiseProductsRequest;
 }
+/**
+ * Request parameters for updateMarketplaceListings operation in ProductsApi.
+ */
+export interface ProductsApiUpdateMarketplaceListingsRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     */
+    readonly productId: string;
+    /**
+     * The marketplace listing fields to update. Only the fields provided will be modified.
+     */
+    readonly updateMarketplaceListingRequest?: UpdateMarketplaceListingRequest;
+}
 /**
  * Request parameters for updateProduct operation in ProductsApi.
  */
@@ -4209,6 +4453,14 @@ export declare class ProductsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     autoMerchProducts(requestParameters: ProductsApiAutoMerchProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoMerchProducts202Response, any, {}>>;
+    /**
+     * 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.
+     * @summary Bulk update product marketplaces
+     * @param {ProductsApiBulkUpdateProductMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdateProductMarketplaceListings(requestParameters: ProductsApiBulkUpdateProductMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkUpdateMarketplaceListingResponse, any, {}>>;
     /**
      * 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.
      * @summary Create product
@@ -4249,6 +4501,14 @@ export declare class ProductsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Gets marketplace listing data for a product.
+     * @summary Get product marketplaces
+     * @param {ProductsApiGetMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMarketplaceListings(requestParameters: ProductsApiGetMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarketplaceListingsResponse, any, {}>>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
@@ -4281,6 +4541,14 @@ export declare class ProductsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     seoOptimiseProducts(requestParameters: ProductsApiSeoOptimiseProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimiseProducts202Response, any, {}>>;
+    /**
+     * Updates marketplace listing data for a product.
+     * @summary Update product marketplaces
+     * @param {ProductsApiUpdateMarketplaceListingsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateMarketplaceListings(requestParameters: ProductsApiUpdateMarketplaceListingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarketplaceListingsResponse, any, {}>>;
     /**
      * Updates a product by a given ID.
      * @summary Update product