@aurigma/axios-storefront-api-client/dist/cjs/storefront-api-client.d.ts

Axios API Client for Storefront API service of Customer's Canvas web-to-print system.

import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
export declare class ApiClientConfiguration {
    apiUrl: string;
    apiKey: string;
    private authorizationToken;
    getAuthorizationToken(): Promise<string>;
    setAuthorizationToken(token: string): void;
}
export declare class ApiClientBase {
    private configuration;
    constructor(configuration: ApiClientConfiguration);
    protected transformOptions(options: AxiosRequestConfig): Promise<AxiosRequestConfig>;
    protected getBaseUrl(defultUrl: string): string;
    protected transformResult(url: string, res: AxiosResponse, cb: (res: AxiosResponse) => Promise<any>): Promise<any>;
}
export interface IBuildInfoApiClient {
    /**
     * Returns an assembly build info.
     * @return Success
     */
    headInfo(): Promise<void>;
    /**
     * Returns an assembly build info.
     * @return Success
     */
    getInfo(): Promise<BuildInfoModel>;
}
export declare class BuildInfoApiClient extends ApiClientBase implements IBuildInfoApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Returns an assembly build info.
     * @return Success
     */
    headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
    protected processHeadInfo(response: AxiosResponse): Promise<void>;
    /**
     * Returns an assembly build info.
     * @return Success
     */
    getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
    protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
}
export interface IProcessingPipelinesApiClient {
    /**
     * Returns all processing pipelines relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param search (optional) Search string for partial by processing pipeline name.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProcessingPipelineDto>;
    /**
     * Returns a processing pipeline.
     * @param id Processing pipeline identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(id: number, tenantId?: number | null | undefined): Promise<ProcessingPipelineDto>;
}
export declare class ProcessingPipelinesApiClient extends ApiClientBase implements IProcessingPipelinesApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Returns all processing pipelines relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param search (optional) Search string for partial by processing pipeline name.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProcessingPipelineDto>;
    protected processGetAll(response: AxiosResponse): Promise<PagedOfProcessingPipelineDto>;
    /**
     * Returns a processing pipeline.
     * @param id Processing pipeline identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProcessingPipelineDto>;
    protected processGet(response: AxiosResponse): Promise<ProcessingPipelineDto>;
}
export interface IProductBundlesApiClient {
    /**
     * Returns all product bundles, relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductBundles(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductBundleDto>;
    /**
     * Returns a product bundle by its identifier.
     * @param id Product identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier. Optional
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductBundleDto>;
    /**
     * Returns a product bundle summary by product bundle identifier.
     * @param id Product bundle identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
    /**
     * Returns a product bundle personalization workflow description by product bundle identifier.
     * @param id Product bundle identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
}
export declare class ProductBundlesApiClient extends ApiClientBase implements IProductBundlesApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Returns all product bundles, relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductBundles(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductBundleDto>;
    protected processGetAllProductBundles(response: AxiosResponse): Promise<PagedOfProductBundleDto>;
    /**
     * Returns a product bundle by its identifier.
     * @param id Product identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier. Optional
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductBundleDto>;
    protected processGetProductBundle(response: AxiosResponse): Promise<ProductBundleDto>;
    /**
     * Returns a product bundle summary by product bundle identifier.
     * @param id Product bundle identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
    protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
    /**
     * Returns a product bundle personalization workflow description by product bundle identifier.
     * @param id Product bundle identifier.
     * @param productBundleVersionId (optional) Product bundle version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
    protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
}
export interface IProductLinksApiClient {
    /**
     * Returns all product links, relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductLinks(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
    /**
     * Returns a product link by its identifier.
     * @param id Product identifier.
     * @param productLinkVersionId (optional) Product link version identifier. Optional
     * @param productVersionId (optional) Product version identifier which represents linked product version. Optional
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
    /**
     * Returns a product link summary by product link identifier.
     * @param id Product link identifier.
     * @param productLinkVersionId (optional) Product link version identifier.
     * @param productVersionId (optional) Product link identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
    /**
     * Returns a product link personalization workflow description by product link identifier.
     * @param id Product link identifier.
     * @param productLinkVersionId (optional) Product link version identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productFilterId (optional) Product filter identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
}
export declare class ProductLinksApiClient extends ApiClientBase implements IProductLinksApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Returns all product links, relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductLinks(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
    protected processGetAllProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
    /**
     * Returns a product link by its identifier.
     * @param id Product identifier.
     * @param productLinkVersionId (optional) Product link version identifier. Optional
     * @param productVersionId (optional) Product version identifier which represents linked product version. Optional
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
    protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
    /**
     * Returns a product link summary by product link identifier.
     * @param id Product link identifier.
     * @param productLinkVersionId (optional) Product link version identifier.
     * @param productVersionId (optional) Product link identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
    protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
    /**
     * Returns a product link personalization workflow description by product link identifier.
     * @param id Product link identifier.
     * @param productLinkVersionId (optional) Product link version identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productFilterId (optional) Product filter identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
    protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
}
export interface IProductReferencesApiClient {
    /**
     * Returns all storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
    /**
     * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductSpecificationDto>;
    /**
     * Returns a list of products associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductDto>;
    /**
     * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
    /**
     * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductBundles(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductBundleDto>;
    /**
     * Returns a storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
    /**
     * Returns a product specification by the storefront product reference.
     * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductSpecificationDto>;
    /**
     * Returns a product by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProduct(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductDto>;
    /**
     * Returns a product summary by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(reference: string | null, storefrontId: number, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
    /**
     * Returns a product link by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
    /**
     * Returns a product bundle by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductBundleDto>;
    /**
     * Returns a product cost details from ecommerce system.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param sku Product SKU.
     * @param storefrontId Storefront identifier.
     * @param storefrontUserId (optional) Storefront user identifier.
     * @param currencyCode (optional) Product cost currency code.
     * @param quantity (optional) Product quantity.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined): Promise<ProductCostDetailsDto>;
    /**
     * Returns a product personalization workflow.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId (optional) Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
}
export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
    private instance;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
    /**
     * Returns all storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
    protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
    /**
     * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductSpecificationDto>;
    protected processGetAllProductSpecifications(response: AxiosResponse): Promise<PagedOfProductSpecificationDto>;
    /**
     * Returns a list of products associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductDto>;
    protected processGetAllProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
    /**
     * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
    protected processGetAllProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
    /**
     * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
     * @param storefrontId Storefront identifier.
     * @param productReference (optional) Product reference filter.
    Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
     * @param productSpecificationId (optional) Customer's Canvas product specification filter.
     * @param productId (optional) Customer's Canvas product filter.
     * @param productLinkId (optional) Customer's Canvas product link filter.
     * @param productBundleId (optional) Customer's Canvas product bundle filter.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU filter.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProductBundles(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductBundleDto>;
    protected processGetAllProductBundles(response: AxiosResponse): Promise<PagedOfProductBundleDto>;
    /**
     * Returns a storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
    protected processGet(response: AxiosResponse): Promise<ProductReferenceDto>;
    /**
     * Returns a product specification by the storefront product reference.
     * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
    protected processGetProductSpecification(response: AxiosResponse): Promise<ProductSpecificationDto>;
    /**
     * Returns a product by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProduct(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
    protected processGetProduct(response: AxiosResponse): Promise<ProductDto>;
    /**
     * Returns a product summary by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(reference: string | null, storefrontId: number, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
    protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
    /**
     * Returns a product link by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
    protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
    /**
     * Returns a product bundle by storefront product reference.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductBundleDto>;
    protected processGetProductBundle(response: AxiosResponse): Promise<ProductBundleDto>;
    /**
     * Returns a product cost details from ecommerce system.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param sku Product SKU.
     * @param storefrontId Storefront identifier.
     * @param storefrontUserId (optional) Storefront user identifier.
     * @param currencyCode (optional) Product cost currency code.
     * @param quantity (optional) Product quantity.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductCostDetailsDto>;
    protected processGetProductCostDetails(response: AxiosResponse): Promise<ProductCostDetailsDto>;
    /**
     * Returns a product personalization workflow.
     * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
     * @param storefrontId (optional) Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
    protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
}
export interface IProductsApiClient {
    /**
     * Returns all products, relevant to the specified query parameters.
     * @param skip (optional) Defines page start offset from beginning of sorted result list.
     * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
     * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
     * @param search (optional) Search string for partial match.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tags (optional) List of tags that product should have.
     * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAllProducts(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductDto>;
    /**
     * Returns a product by identifier.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductDto>;
    /**
     * Returns a product summary by product identifier.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productLinkId (optional) Product link identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param sku (optional) Product variant SKU.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
    /**
     * Returns a list of product options.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductOptionDto>;
    /**
     * Returns a list of product options for all products.
     * @param tenantId (option