@teemill/product-catalog 1.11.1 → 1.12.0

package/dist/esm/api.d.ts

@@ -0,0 +1,1120 @@
+/**
+ * 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.12.0
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ *
+ * @export
+ * @interface Attribute
+ */
+export interface Attribute {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof Attribute
+     */
+    'name': string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof Attribute
+     */
+    'value': string;
+    /**
+     *
+     * @type {AttributeThumbnail}
+     * @memberof Attribute
+     */
+    'thumbnail'?: AttributeThumbnail;
+    /**
+     * Attribute tags
+     * @type {Array<string>}
+     * @memberof Attribute
+     */
+    'tags'?: Array<string>;
+}
+/**
+ * Attribute thumbnail, intended for interfaces like storefront colour selector.
+ * @export
+ * @interface AttributeThumbnail
+ */
+export interface AttributeThumbnail {
+    /**
+     *
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    'type'?: AttributeThumbnailTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    'value'?: string;
+}
+export declare const AttributeThumbnailTypeEnum: {
+    readonly Text: "text";
+    readonly Color: "color";
+    readonly Image: "image";
+};
+export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
+/**
+ *
+ * @export
+ * @interface CreateProductRequest
+ */
+export interface CreateProductRequest {
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    'gfnProductRef': string;
+    /**
+     * Product title
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    'title'?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    'description'?: string;
+    /**
+     * Whether the product is enabled upon creation.
+     * @type {boolean}
+     * @memberof CreateProductRequest
+     */
+    'enabled'?: boolean;
+    /**
+     * A custom URL slug for the product. This must be unique for each product on the project.
+     * @type {string}
+     * @memberof CreateProductRequest
+     */
+    'slug'?: string;
+    /**
+     *
+     * @type {CreateProductRequestSeoMetadata}
+     * @memberof CreateProductRequest
+     */
+    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    /**
+     * Additional product tags used for searching and filtering.
+     * @type {Array<string>}
+     * @memberof CreateProductRequest
+     */
+    'tags'?: Array<string>;
+    /**
+     * Variants
+     * @type {Array<CreateProductVariant>}
+     * @memberof CreateProductRequest
+     */
+    'variants': Array<CreateProductVariant>;
+    /**
+     * Images to attach to the product. For example, photos of models using/wearing the product.
+     * @type {Array<CreateProductRequestImagesInner>}
+     * @memberof CreateProductRequest
+     */
+    'images'?: Array<CreateProductRequestImagesInner>;
+    /**
+     * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
+     * @type {Array<CreateProductRequestImagesInner>}
+     * @memberof CreateProductRequest
+     */
+    'additionalFiles'?: Array<CreateProductRequestImagesInner>;
+}
+/**
+ *
+ * @export
+ * @interface CreateProductRequestImagesInner
+ */
+export interface CreateProductRequestImagesInner {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof CreateProductRequestImagesInner
+     */
+    'src'?: string;
+}
+/**
+ *
+ * @export
+ * @interface CreateProductRequestSeoMetadata
+ */
+export interface CreateProductRequestSeoMetadata {
+    /**
+     * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
+     * @type {string}
+     * @memberof CreateProductRequestSeoMetadata
+     */
+    'title'?: string;
+}
+/**
+ *
+ * @export
+ * @interface CreateProductVariant
+ */
+export interface CreateProductVariant {
+    /**
+     * Attributes associated to a variant such as Colour and Size.
+     * @type {Array<CreateProductVariantAttributesInner>}
+     * @memberof CreateProductVariant
+     */
+    'attributes': Array<CreateProductVariantAttributesInner>;
+    /**
+     *
+     * @type {CreateProductVariantRetailPrice}
+     * @memberof CreateProductVariant
+     */
+    'retailPrice': CreateProductVariantRetailPrice;
+    /**
+     * A custom stock keeping unit for the variant.
+     * @type {string}
+     * @memberof CreateProductVariant
+     */
+    'sku'?: string;
+    /**
+     * Design applications. If not provided, the product will be blank.
+     * @type {Array<CreateProductVariantApplicationsInner>}
+     * @memberof CreateProductVariant
+     */
+    'applications'?: Array<CreateProductVariantApplicationsInner>;
+    /**
+     * 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>}
+     * @memberof CreateProductVariant
+     */
+    'images'?: Array<CreateProductRequestImagesInner>;
+}
+/**
+ *
+ * @export
+ * @interface CreateProductVariantApplicationsInner
+ */
+export interface CreateProductVariantApplicationsInner {
+    /**
+     * Technology to use for the application.
+     * @type {string}
+     * @memberof CreateProductVariantApplicationsInner
+     */
+    'technology': string;
+    /**
+     * Placement of the application. Available placements depend on the chosen product and technology.
+     * @type {string}
+     * @memberof CreateProductVariantApplicationsInner
+     */
+    'placement': CreateProductVariantApplicationsInnerPlacementEnum;
+    /**
+     * Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area. Accepts PNG and JPEG files.
+     * @type {string}
+     * @memberof CreateProductVariantApplicationsInner
+     */
+    'src': string;
+}
+export declare const CreateProductVariantApplicationsInnerPlacementEnum: {
+    readonly Front: "front";
+    readonly Back: "back";
+    readonly Left: "left";
+    readonly Right: "right";
+    readonly Neck: "neck";
+};
+export type CreateProductVariantApplicationsInnerPlacementEnum = typeof CreateProductVariantApplicationsInnerPlacementEnum[keyof typeof CreateProductVariantApplicationsInnerPlacementEnum];
+/**
+ *
+ * @export
+ * @interface CreateProductVariantAttributesInner
+ */
+export interface CreateProductVariantAttributesInner {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof CreateProductVariantAttributesInner
+     */
+    'name': string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof CreateProductVariantAttributesInner
+     */
+    'value': string;
+}
+/**
+ * Variant retail price including tax.
+ * @export
+ * @interface CreateProductVariantRetailPrice
+ */
+export interface CreateProductVariantRetailPrice {
+    /**
+     * Price including tax in the specified currency.
+     * @type {number}
+     * @memberof CreateProductVariantRetailPrice
+     */
+    'amount': number;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof CreateProductVariantRetailPrice
+     */
+    'currencyCode': string;
+}
+/**
+ * Image description
+ * @export
+ * @interface Image
+ */
+export interface Image {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Image
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'src'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'alt'?: string;
+    /**
+     * List of variant Ids
+     * @type {Array<string>}
+     * @memberof Image
+     */
+    'variantIds'?: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof Image
+     */
+    'sortOrder'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Image
+     */
+    'updatedAt'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ImportProducts200Response
+ */
+export interface ImportProducts200Response {
+    /**
+     * Id of the product import
+     * @type {string}
+     * @memberof ImportProducts200Response
+     */
+    'importId'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ModelFile
+ */
+export interface ModelFile {
+    /**
+     * Publicly available file URL.
+     * @type {string}
+     * @memberof ModelFile
+     */
+    'src'?: string;
+}
+/**
+ * Standard price definition that defines the amount, tax rate and currency.
+ * @export
+ * @interface Price
+ */
+export interface Price {
+    /**
+     * Price including tax in the specified currency.
+     * @type {number}
+     * @memberof Price
+     */
+    'amount'?: number;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof Price
+     */
+    'currencyCode'?: string;
+}
+/**
+ *
+ * @export
+ * @interface Product
+ */
+export interface Product {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Product
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Product
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'title': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'description': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'slug'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Product
+     */
+    'enabled'?: boolean;
+    /**
+     *
+     * @type {SeoMetadata}
+     * @memberof Product
+     */
+    'seoMetadata'?: SeoMetadata;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Product
+     */
+    'tags'?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'updatedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Product
+     */
+    'publishedAt'?: string;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Product
+     */
+    'images'?: Array<Image>;
+    /**
+     * Variants
+     * @type {Array<Variant>}
+     * @memberof Product
+     */
+    'variants'?: Array<Variant>;
+    /**
+     * Additional files attached to the product.
+     * @type {Array<ProductAdditionalFilesInner>}
+     * @memberof Product
+     */
+    'additionalFiles'?: Array<ProductAdditionalFilesInner>;
+}
+/**
+ *
+ * @export
+ * @interface ProductAdditionalFilesInner
+ */
+export interface ProductAdditionalFilesInner {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    'id'?: string;
+    /**
+     * File URL
+     * @type {string}
+     * @memberof ProductAdditionalFilesInner
+     */
+    'src'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ProductsResponse
+ */
+export interface ProductsResponse {
+    /**
+     *
+     * @type {Array<Product>}
+     * @memberof ProductsResponse
+     */
+    'products'?: Array<Product>;
+    /**
+     *
+     * @type {number}
+     * @memberof ProductsResponse
+     */
+    'nextPageToken'?: number;
+}
+/**
+ * SEO metadata for the product
+ * @export
+ * @interface SeoMetadata
+ */
+export interface SeoMetadata {
+    /**
+     * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
+     * @type {string}
+     * @memberof SeoMetadata
+     */
+    'title'?: string;
+}
+/**
+ *
+ * @export
+ * @interface Stock
+ */
+export interface Stock {
+    /**
+     *
+     * @type {number}
+     * @memberof Stock
+     */
+    'level'?: number;
+}
+/**
+ *
+ * @export
+ * @interface UpdateProductRequest
+ */
+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.
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    'gfnProductRef'?: string;
+    /**
+     * Product title
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    'title'?: string;
+    /**
+     * Product description
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    'description'?: string;
+    /**
+     * Whether the product is enabled upon creation.
+     * @type {boolean}
+     * @memberof UpdateProductRequest
+     */
+    'enabled'?: boolean;
+    /**
+     * A custom URL slug for the product. This must be unique for each product on the project.
+     * @type {string}
+     * @memberof UpdateProductRequest
+     */
+    'slug'?: string;
+    /**
+     *
+     * @type {CreateProductRequestSeoMetadata}
+     * @memberof UpdateProductRequest
+     */
+    'seoMetadata'?: CreateProductRequestSeoMetadata;
+    /**
+     * Additional product tags used for searching and filtering.
+     * @type {Array<string>}
+     * @memberof UpdateProductRequest
+     */
+    'tags'?: Array<string>;
+    /**
+     * Variants
+     * @type {Array<CreateProductVariant>}
+     * @memberof UpdateProductRequest
+     */
+    'variants'?: Array<CreateProductVariant>;
+    /**
+     * Images to attach to the product. For example, photos of models using/wearing the product.
+     * @type {Array<any>}
+     * @memberof UpdateProductRequest
+     */
+    'images'?: Array<any>;
+    /**
+     * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
+     * @type {Array<any>}
+     * @memberof UpdateProductRequest
+     */
+    'additionalFiles'?: Array<any>;
+}
+/**
+ *
+ * @export
+ * @interface Variant
+ */
+export interface Variant {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Variant
+     */
+    'id'?: string;
+    /**
+     * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
+     * @type {Array<Attribute>}
+     * @memberof Variant
+     */
+    'attributes': Array<Attribute>;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'sku': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Variant
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {VariantProduct}
+     * @memberof Variant
+     */
+    'product'?: VariantProduct;
+    /**
+     *
+     * @type {number}
+     * @memberof Variant
+     */
+    'sortOrder'?: number;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'retailPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'salePrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Variant
+     */
+    'price'?: Price;
+    /**
+     *
+     * @type {Stock}
+     * @memberof Variant
+     */
+    'stock'?: Stock;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'createdAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'updatedAt'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Variant
+     */
+    'publishedAt'?: string;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Variant
+     */
+    'images'?: Array<Image>;
+}
+/**
+ *
+ * @export
+ * @interface VariantProduct
+ */
+export interface VariantProduct {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof VariantProduct
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof VariantProduct
+     */
+    'ref'?: string;
+}
+/**
+ *
+ * @export
+ * @interface VariantsResponse
+ */
+export interface VariantsResponse {
+    /**
+     *
+     * @type {Array<Variant>}
+     * @memberof VariantsResponse
+     */
+    'variants'?: Array<Variant>;
+    /**
+     *
+     * @type {number}
+     * @memberof VariantsResponse
+     */
+    'nextPageToken'?: number;
+}
+/**
+ * ProductsApi - axios parameter creator
+ * @export
+ */
+export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct: (project: string, createProductRequest?: CreateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes a catalog product
+     * @summary Delete catalog product
+     * @param {string} project What project it is
+     * @param {string} productId Product\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct: (project: string, productId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProducts: (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct: (project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductsApi - functional programming interface
+ * @export
+ */
+export declare const ProductsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct(project: string, createProductRequest?: CreateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct(project: string, productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct(project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
+};
+/**
+ * ProductsApi - factory interface
+ * @export
+ */
+export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct(project: string, createProductRequest?: CreateProductRequest, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct(project: string, productId: string, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProduct(project: string, productId: string, fields?: string, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    importProducts(project: string, body?: string, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct(project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: any): AxiosPromise<Product>;
+};
+/**
+ * ProductsApi - object-oriented interface
+ * @export
+ * @class ProductsApi
+ * @extends {BaseAPI}
+ */
+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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    createProduct(project: string, createProductRequest?: CreateProductRequest, 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProduct(project: string, productId: string, 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProduct(project: string, productId: string, fields?: string, 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 {*} [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>>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    importProducts(project: string, body?: string, 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    updateProduct(project: string, productId: string, updateProductRequest?: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
+}
+/**
+ * VariantsApi - axios parameter creator
+ * @export
+ */
+export declare const VariantsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVariant: (project: string, variantId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVariants: (project: string, search?: string, pageToken?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * VariantsApi - functional programming interface
+ * @export
+ */
+export declare const VariantsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVariant(project: string, variantId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVariants(project: string, search?: string, pageToken?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VariantsResponse>>;
+};
+/**
+ * VariantsApi - factory interface
+ * @export
+ */
+export declare const VariantsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getVariant(project: string, variantId: string, fields?: string, options?: any): 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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listVariants(project: string, search?: string, pageToken?: number, pageSize?: number, fields?: string, options?: any): AxiosPromise<VariantsResponse>;
+};
+/**
+ * VariantsApi - object-oriented interface
+ * @export
+ * @class VariantsApi
+ * @extends {BaseAPI}
+ */
+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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VariantsApi
+     */
+    getVariant(project: string, variantId: string, fields?: string, 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 {*} [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>>;
+}