@teemill/product-catalog 1.14.0 → 1.16.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog API
  * Manage 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.
  *
- * The version of the OpenAPI document: 1.14.0
+ * The version of the OpenAPI document: 1.16.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,19 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface AdditionalFile
+ */
+export interface AdditionalFile {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof AdditionalFile
+     */
+    'src'?: string;
+}
 /**
  *
  * @export
@@ -43,7 +56,7 @@ export interface Application {
      * @type {string}
      * @memberof Application
      */
-    'technology': string;
+    'technology': ApplicationTechnologyEnum;
     /**
      * Placement of the application. Available placements depend on the chosen product and technology.
      * @type {string}
@@ -56,7 +69,25 @@ export interface Application {
      * @memberof Application
      */
     'src': string;
+    /**
+     *
+     * @type {ApplicationMockup}
+     * @memberof Application
+     */
+    'mockup'?: ApplicationMockup;
 }
+export declare const ApplicationTechnologyEnum: {
+    readonly Dtg: "dtg";
+    readonly Embroidery: "embroidery";
+    readonly Dtf: "dtf";
+    readonly Pretreat: "pretreat";
+    readonly MugSublimation: "mug_sublimation";
+    readonly ManualPrint: "manual_print";
+    readonly AdditionalApplication: "additional_application";
+    readonly NotebookSublimation: "notebook_sublimation";
+    readonly DuplexPrint: "duplex_print";
+};
+export type ApplicationTechnologyEnum = typeof ApplicationTechnologyEnum[keyof typeof ApplicationTechnologyEnum];
 export declare const ApplicationPlacementEnum: {
     readonly Front: "front";
     readonly Back: "back";
@@ -65,6 +96,25 @@ export declare const ApplicationPlacementEnum: {
     readonly Neck: "neck";
 };
 export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
+/**
+ *
+ * @export
+ * @interface ApplicationMockup
+ */
+export interface ApplicationMockup {
+    /**
+     * Drive image URL. If provided, this will be used as the mockup image for the variant application rather than generating a new one.
+     * @type {string}
+     * @memberof ApplicationMockup
+     */
+    'file': string;
+    /**
+     * Publicly available mockup image URL. This is a preview of the mockup image for the given application.
+     * @type {string}
+     * @memberof ApplicationMockup
+     */
+    'preview'?: string;
+}
 /**
  *
  * @export
@@ -169,6 +219,12 @@ export interface CreateProductRequest {
      * @memberof CreateProductRequest
      */
     'tags'?: Array<string>;
+    /**
+     * Internal tags used for internal searching and filtering.
+     * @type {Array<string>}
+     * @memberof CreateProductRequest
+     */
+    'internalTags'?: Array<string>;
     /**
      * Variants
      * @type {Array<CreateProductVariant>}
@@ -183,10 +239,23 @@ export interface CreateProductRequest {
     'images'?: Array<CreateProductRequestImagesInner>;
     /**
      * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
-     * @type {Array<CreateProductRequestImagesInner>}
+     * @type {Array<CreateProductRequestAdditionalFilesInner>}
      * @memberof CreateProductRequest
      */
-    'additionalFiles'?: Array<CreateProductRequestImagesInner>;
+    'additionalFiles'?: Array<CreateProductRequestAdditionalFilesInner>;
+}
+/**
+ *
+ * @export
+ * @interface CreateProductRequestAdditionalFilesInner
+ */
+export interface CreateProductRequestAdditionalFilesInner {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof CreateProductRequestAdditionalFilesInner
+     */
+    'src'?: string;
 }
 /**
  *
@@ -246,10 +315,10 @@ export interface CreateProductVariant {
     'applications'?: Array<Application>;
     /**
      * Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the warehouse product provided. Accepts PNG and JPEG files.
-     * @type {Array<CreateProductRequestImagesInner>}
+     * @type {Array<CreateProductVariantImagesInner>}
      * @memberof CreateProductVariant
      */
-    'images'?: Array<CreateProductRequestImagesInner>;
+    'images'?: Array<CreateProductVariantImagesInner>;
 }
 /**
  *
@@ -262,7 +331,7 @@ export interface CreateProductVariantAttributesInner {
      * @type {string}
      * @memberof CreateProductVariantAttributesInner
      */
-    'name': string;
+    'name': CreateProductVariantAttributesInnerNameEnum;
     /**
      * Attribute value
      * @type {string}
@@ -270,6 +339,24 @@ export interface CreateProductVariantAttributesInner {
      */
     'value': string;
 }
+export declare const CreateProductVariantAttributesInnerNameEnum: {
+    readonly Size: "Size";
+    readonly Colour: "Colour";
+};
+export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
+/**
+ *
+ * @export
+ * @interface CreateProductVariantImagesInner
+ */
+export interface CreateProductVariantImagesInner {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof CreateProductVariantImagesInner
+     */
+    'src'?: string;
+}
 /**
  * Variant retail price including tax.
  * @export
@@ -287,8 +374,12 @@ export interface CreateProductVariantRetailPrice {
      * @type {string}
      * @memberof CreateProductVariantRetailPrice
      */
-    'currencyCode': string;
+    'currencyCode': CreateProductVariantRetailPriceCurrencyCodeEnum;
 }
+export declare const CreateProductVariantRetailPriceCurrencyCodeEnum: {
+    readonly Gbp: "GBP";
+};
+export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
 /**
  * Image description
  * @export
@@ -341,28 +432,28 @@ export interface Image {
 /**
  *
  * @export
- * @interface ImportProducts200Response
+ * @interface ImageFile
  */
-export interface ImportProducts200Response {
+export interface ImageFile {
     /**
-     * Id of the product import
+     * Publicly available file URL.
      * @type {string}
-     * @memberof ImportProducts200Response
+     * @memberof ImageFile
      */
-    'importId'?: string;
+    'src'?: string;
 }
 /**
  *
  * @export
- * @interface ModelFile
+ * @interface ImportProducts200Response
  */
-export interface ModelFile {
+export interface ImportProducts200Response {
     /**
-     * Publicly available file URL.
+     * Id of the product import
      * @type {string}
-     * @memberof ModelFile
+     * @memberof ImportProducts200Response
      */
-    'src'?: string;
+    'importId'?: string;
 }
 /**
  * Standard price definition that defines the amount, tax rate and currency.
@@ -381,8 +472,12 @@ export interface Price {
      * @type {string}
      * @memberof Price
      */
-    'currencyCode'?: string;
+    'currencyCode'?: PriceCurrencyCodeEnum;
 }
+export declare const PriceCurrencyCodeEnum: {
+    readonly Gbp: "GBP";
+};
+export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
 /**
  *
  * @export
@@ -437,6 +532,12 @@ export interface Product {
      * @memberof Product
      */
     'tags'?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Product
+     */
+    'internalTags'?: Array<string>;
     /**
      *
      * @type {string}
@@ -586,6 +687,12 @@ export interface UpdateProductRequest {
      * @memberof UpdateProductRequest
      */
     'tags'?: Array<string>;
+    /**
+     * Additional product tags used for internal searching and filtering.
+     * @type {Array<string>}
+     * @memberof UpdateProductRequest
+     */
+    'internalTags'?: Array<string>;
     /**
      * Variants
      * @type {Array<CreateProductVariant>}
@@ -594,16 +701,16 @@ export interface UpdateProductRequest {
     'variants'?: Array<CreateProductVariant>;
     /**
      * Images to attach to the product. For example, photos of models using/wearing the product.
-     * @type {Array<any>}
+     * @type {Array<ImageFile>}
      * @memberof UpdateProductRequest
      */
-    'images'?: Array<any>;
+    'images'?: Array<ImageFile>;
     /**
      * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
-     * @type {Array<any>}
+     * @type {Array<AdditionalFile>}
      * @memberof UpdateProductRequest
      */
-    'additionalFiles'?: Array<any>;
+    'additionalFiles'?: Array<AdditionalFile>;
 }
 /**
  *
@@ -884,63 +991,196 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
     /**
      * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
      * @summary Create product
-     * @param {string} project What project it is
-     * @param {CreateProductRequest} [createProductRequest]
+     * @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createProduct(project: string, createProductRequest?: CreateProductRequest, options?: any): AxiosPromise<Product>;
+    createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
     /**
      * Deletes a catalog product
      * @summary Delete catalog product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
+     * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteProduct(project: string, productId: string, options?: any): AxiosPromise<void>;
+    deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProduct(project: string, productId: string, fields?: string, options?: any): AxiosPromise<Product>;
+    getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
     /**
      * Lists all enabled store listing products attached to the given project.
      * @summary List products
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {string} [search] Search term to filter based on product tags.
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: any): AxiosPromise<ProductsResponse>;
+    getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
     /**
      * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
      * @summary Import products
-     * @param {string} project What project it is
-     * @param {string} [body] A data URL of a CSV file containing data for one or more products.
+     * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    importProducts(project: string, body?: string, options?: any): AxiosPromise<ImportProducts200Response>;
+    importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
-     * @param {UpdateProductRequest} [updateProductRequest]
+     * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    updateProduct(project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: any): AxiosPromise<Product>;
+    updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
 };
+/**
+ * Request parameters for createProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiCreateProductRequest
+ */
+export interface ProductsApiCreateProductRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiCreateProduct
+     */
+    readonly project: string;
+    /**
+     *
+     * @type {CreateProductRequest}
+     * @memberof ProductsApiCreateProduct
+     */
+    readonly createProductRequest?: CreateProductRequest;
+}
+/**
+ * Request parameters for deleteProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiDeleteProductRequest
+ */
+export interface ProductsApiDeleteProductRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiDeleteProduct
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     * @type {string}
+     * @memberof ProductsApiDeleteProduct
+     */
+    readonly productId: string;
+}
+/**
+ * Request parameters for getProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductRequest
+ */
+export interface ProductsApiGetProductRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiGetProduct
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     * @type {string}
+     * @memberof ProductsApiGetProduct
+     */
+    readonly productId: string;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof ProductsApiGetProduct
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for getProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductsRequest
+ */
+export interface ProductsApiGetProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiGetProducts
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof ProductsApiGetProducts
+     */
+    readonly pageToken?: number;
+    /**
+     * Search term to filter based on product tags.
+     * @type {string}
+     * @memberof ProductsApiGetProducts
+     */
+    readonly search?: string;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof ProductsApiGetProducts
+     */
+    readonly pageSize?: number;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof ProductsApiGetProducts
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for importProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiImportProductsRequest
+ */
+export interface ProductsApiImportProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiImportProducts
+     */
+    readonly project: string;
+    /**
+     * A data URL of a CSV file containing data for one or more products.
+     * @type {string}
+     * @memberof ProductsApiImportProducts
+     */
+    readonly body?: string;
+}
+/**
+ * Request parameters for updateProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiUpdateProductRequest
+ */
+export interface ProductsApiUpdateProductRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly project: string;
+    /**
+     * Product\&#39;s unique identifier
+     * @type {string}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly productId: string;
+    /**
+     *
+     * @type {UpdateProductRequest}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly updateProductRequest?: UpdateProductRequest;
+}
 /**
  * ProductsApi - object-oriented interface
  * @export
@@ -951,68 +1191,57 @@ export declare class ProductsApi extends BaseAPI {
     /**
      * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
      * @summary Create product
-     * @param {string} project What project it is
-     * @param {CreateProductRequest} [createProductRequest]
+     * @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    createProduct(project: string, createProductRequest?: CreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
+    createProduct(requestParameters: ProductsApiCreateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
     /**
      * Deletes a catalog product
      * @summary Delete catalog product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
+     * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    deleteProduct(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Gets a product by a given ID.
      * @summary Get product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {ProductsApiGetProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
+    getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
     /**
      * Lists all enabled store listing products attached to the given project.
      * @summary List products
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {string} [search] Search term to filter based on product tags.
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
+    getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
     /**
      * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
      * @summary Import products
-     * @param {string} project What project it is
-     * @param {string} [body] A data URL of a CSV file containing data for one or more products.
+     * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
+    importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
     /**
      * Updates a product by a given ID.
      * @summary Update product
-     * @param {string} project What project it is
-     * @param {string} productId Product\&#39;s unique identifier
-     * @param {UpdateProductRequest} [updateProductRequest]
+     * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    updateProduct(project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
+    updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
 }
 /**
  * VariantsApi - axios parameter creator
@@ -1078,26 +1307,82 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
     /**
      * Gets a variant by a given ID.
      * @summary Get variant
-     * @param {string} project What project it is
-     * @param {string} variantId Variants unique identifier
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getVariant(project: string, variantId: string, fields?: string, options?: any): AxiosPromise<Variant>;
+    getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
     /**
      * Lists all variants that belong to enabled products attached to the given project.
      * @summary List variants
-     * @param {string} project What project it is
-     * @param {string} [search] Search term to filter based on product tags.
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listVariants(project: string, search?: string, pageToken?: number, pageSize?: number, fields?: string, options?: any): AxiosPromise<VariantsResponse>;
+    listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse>;
 };
+/**
+ * Request parameters for getVariant operation in VariantsApi.
+ * @export
+ * @interface VariantsApiGetVariantRequest
+ */
+export interface VariantsApiGetVariantRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly project: string;
+    /**
+     * Variants unique identifier
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly variantId: string;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for listVariants operation in VariantsApi.
+ * @export
+ * @interface VariantsApiListVariantsRequest
+ */
+export interface VariantsApiListVariantsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly project: string;
+    /**
+     * Search term to filter based on product tags.
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly search?: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof VariantsApiListVariants
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof VariantsApiListVariants
+     */
+    readonly pageSize?: number;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly fields?: string;
+}
 /**
  * VariantsApi - object-oriented interface
  * @export
@@ -1108,25 +1393,19 @@ export declare class VariantsApi extends BaseAPI {
     /**
      * Gets a variant by a given ID.
      * @summary Get variant
-     * @param {string} project What project it is
-     * @param {string} variantId Variants unique identifier
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    getVariant(project: string, variantId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
+    getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
     /**
      * Lists all variants that belong to enabled products attached to the given project.
      * @summary List variants
-     * @param {string} project What project it is
-     * @param {string} [search] Search term to filter based on product tags.
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    listVariants(project: string, search?: string, pageToken?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
+    listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
 }