@aurigma/ng-backoffice-api-client/lib/backoffice-api-client.d.ts

Angular API Client for BackOffice API service of Customer's Canvas web-to-print system.

import { Observable } from 'rxjs';
import { InjectionToken } from '@angular/core';
import { HttpClient, HttpResponseBase } from '@angular/common/http';
export declare const API_BASE_URL: InjectionToken<string>;
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: any): Promise<any>;
    protected getBaseUrl(defultUrl: string): string;
    protected transformResult(url: string, res: HttpResponseBase, cb: (res: HttpResponseBase) => Observable<any>): Observable<any>;
}
export interface IBuildInfoApiClient {
    /**
     * Returns assembly build info.
     * @return Success
     */
    headInfo(): Observable<void>;
    /**
     * Returns assembly build info.
     * @return Success
     */
    getInfo(): Observable<BuildInfoModel>;
}
export declare class BuildInfoApiClient extends ApiClientBase implements IBuildInfoApiClient {
    private http;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
    /**
     * Returns assembly build info.
     * @return Success
     */
    headInfo(): Observable<void>;
    protected processHeadInfo(response: HttpResponseBase): Observable<void>;
    /**
     * Returns assembly build info.
     * @return Success
     */
    getInfo(): Observable<BuildInfoModel>;
    protected processGetInfo(response: HttpResponseBase): Observable<BuildInfoModel>;
}
export interface IProductReferencesManagementApiClient {
    /**
     * 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 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, 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): Observable<PagedOfProductReferenceDto>;
    /**
     * Creates a new storefront product reference.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Create operation parameters.
     * @return Success
     */
    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
    /**
     * 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): Observable<ProductReferenceDto>;
    /**
     * Deletes the storefront product reference.
     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
}
export declare class ProductReferencesManagementApiClient extends ApiClientBase implements IProductReferencesManagementApiClient {
    private http;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
    /**
     * 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 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, 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): Observable<PagedOfProductReferenceDto>;
    protected processGetAll(response: HttpResponseBase): Observable<PagedOfProductReferenceDto>;
    /**
     * Creates a new storefront product reference.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Create operation parameters.
     * @return Success
     */
    create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Observable<ProductReferenceDto>;
    protected processCreate(response: HttpResponseBase): Observable<ProductReferenceDto>;
    /**
     * 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): Observable<ProductReferenceDto>;
    protected processGet(response: HttpResponseBase): Observable<ProductReferenceDto>;
    /**
     * Deletes the storefront product reference.
     * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
     * @param storefrontId Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductReferenceDto>;
    protected processDelete(response: HttpResponseBase): Observable<ProductReferenceDto>;
}
export interface IProductsManagementApiClient {
    /**
     * 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): Observable<PagedOfProductDto>;
    /**
     * Creates a new product and returns its description.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional)
     * @return Success
     */
    createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined): Observable<ProductDto>;
    /**
     * Returns a product by its 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): Observable<ProductDto>;
    /**
     * Deletes a product by its identifier.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    deleteProduct(id: number, tenantId?: number | null | undefined): Observable<void>;
    /**
     * 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): Observable<PagedOfProductOptionDto>;
    /**
     * Returns a list of product variants.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDto>;
    /**
     * Returns a product variant.
     * @param id Product identifier.
     * @param productVariantId Product variant identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductVariantDto>;
    /**
     * Returns a list of product variant designs.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for design name partial match.
     * @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
     * @param designPath (optional) Path filter for designs. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDesignDto>;
    /**
     * Returns a list of product variant mockups.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for design name partial match.
     * @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
     * @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantMockupDto>;
    /**
     * Returns a list of product variant documents.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for document name partial match.
     * @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
     * @param documentPath (optional) Path filter for documents. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDocumentDto>;
    /**
     * Set product variants price. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants price operation parameters.
     * @return Success
     */
    setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Observable<void>;
    /**
     * Set product variants availability. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants availability operation parameters.
     * @return Success
     */
    setProductVariantAvailability(id: number, tenantId?: number | null | undefined, body?: SetProductVariantAvailabilityDto | null | undefined): Observable<void>;
    /**
     * Set product variants SKU. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants SKU operation parameters.
     * @return Success
     */
    setProductVariantSku(id: number, tenantId?: number | null | undefined, body?: SetProductVariantSkuDto | null | undefined): Observable<void>;
    /**
     * Imports products from a specific CSV file and returns a list of imported products descriptions.
     * @param tenantId (optional) Tenant identifier.
     * @param file (optional)
     * @return Success
     */
    importProducts(tenantId?: number | null | undefined, file?: FileParameter | null | undefined): Observable<PagedOfProductDto>;
    /**
     * Creates new designs connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product designs connections creation parameters.
     * @return Success
     */
    createDesignsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDesignConnectionsDto | null | undefined): Observable<void>;
    /**
     * Removes designs connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product designs connections creation parameters.
     * @return Success
     */
    removeDesignsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDesignConnectionsDto | null | undefined): Observable<void>;
    /**
     * Creates new mockups connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product mockups connections creation parameters.
     * @return Success
     */
    createMockupsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductMockupConnectionsDto | null | undefined): Observable<void>;
    /**
     * Removes mockups connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product mockups connections creation parameters.
     * @return Success
     */
    removeMockupsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductMockupConnectionsDto | null | undefined): Observable<void>;
    /**
     * Creates new documents connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product documents connections creation parameters.
     * @return Success
     */
    createDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDocumentConnectionsDto | null | undefined): Observable<void>;
    /**
     * Removes documents connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product documents connections creation parameters.
     * @return Success
     */
    removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined): Observable<void>;
    /**
     * Returns all available product personalization workflows.
     * @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 personalization workflow name.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAvailablePersonalizationWorkflows(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfPersonalizationWorkflowDto>;
    /**
     * Returns all available product processing pipelines.
     * @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
     */
    getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProcessingPipelineDto>;
}
export declare class ProductsManagementApiClient extends ApiClientBase implements IProductsManagementApiClient {
    private http;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
    /**
     * 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): Observable<PagedOfProductDto>;
    protected processGetAllProducts(response: HttpResponseBase): Observable<PagedOfProductDto>;
    /**
     * Creates a new product and returns its description.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional)
     * @return Success
     */
    createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined): Observable<ProductDto>;
    protected processCreateProduct(response: HttpResponseBase): Observable<ProductDto>;
    /**
     * Returns a product by its 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): Observable<ProductDto>;
    protected processGetProduct(response: HttpResponseBase): Observable<ProductDto>;
    /**
     * Deletes a product by its identifier.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    deleteProduct(id: number, tenantId?: number | null | undefined): Observable<void>;
    protected processDeleteProduct(response: HttpResponseBase): Observable<void>;
    /**
     * 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): Observable<PagedOfProductOptionDto>;
    protected processGetProductOptions(response: HttpResponseBase): Observable<PagedOfProductOptionDto>;
    /**
     * Returns a list of product variants.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDto>;
    protected processGetProductVariants(response: HttpResponseBase): Observable<PagedOfProductVariantDto>;
    /**
     * Returns a product variant.
     * @param id Product identifier.
     * @param productVariantId Product variant identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductVariantDto>;
    protected processGetProductVariant(response: HttpResponseBase): Observable<ProductVariantDto>;
    /**
     * Returns a list of product variant designs.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for design name partial match.
     * @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
     * @param designPath (optional) Path filter for designs. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDesignDto>;
    protected processGetProductVariantDesigns(response: HttpResponseBase): Observable<PagedOfProductVariantDesignDto>;
    /**
     * Returns a list of product variant mockups.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for design name partial match.
     * @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
     * @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantMockupDto>;
    protected processGetProductVariantMockups(response: HttpResponseBase): Observable<PagedOfProductVariantMockupDto>;
    /**
     * Returns a list of product variant documents.
     * @param id Product identifier.
     * @param productVersionId (optional) Product version identifier.
     * @param productVariantId (optional) Product variant identifier.
     * @param search (optional) Search string for document name partial match.
     * @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
     * @param documentPath (optional) Path filter for documents. Subfolders included by default.
     * @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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
     * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
     * @param takeAvailableOnly (optional) Defines special filter for available product variants.
     * @param sku (optional) SKU of linked ecommerce product.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProductVariantDocumentDto>;
    protected processGetProductVariantDocuments(response: HttpResponseBase): Observable<PagedOfProductVariantDocumentDto>;
    /**
     * Set product variants price. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants price operation parameters.
     * @return Success
     */
    setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Observable<void>;
    protected processSetProductVariantPrice(response: HttpResponseBase): Observable<void>;
    /**
     * Set product variants availability. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants availability operation parameters.
     * @return Success
     */
    setProductVariantAvailability(id: number, tenantId?: number | null | undefined, body?: SetProductVariantAvailabilityDto | null | undefined): Observable<void>;
    protected processSetProductVariantAvailability(response: HttpResponseBase): Observable<void>;
    /**
     * Set product variants SKU. Variants identifiers will be changed.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Set product variants SKU operation parameters.
     * @return Success
     */
    setProductVariantSku(id: number, tenantId?: number | null | undefined, body?: SetProductVariantSkuDto | null | undefined): Observable<void>;
    protected processSetProductVariantSku(response: HttpResponseBase): Observable<void>;
    /**
     * Imports products from a specific CSV file and returns a list of imported products descriptions.
     * @param tenantId (optional) Tenant identifier.
     * @param file (optional)
     * @return Success
     */
    importProducts(tenantId?: number | null | undefined, file?: FileParameter | null | undefined): Observable<PagedOfProductDto>;
    protected processImportProducts(response: HttpResponseBase): Observable<PagedOfProductDto>;
    /**
     * Creates new designs connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product designs connections creation parameters.
     * @return Success
     */
    createDesignsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDesignConnectionsDto | null | undefined): Observable<void>;
    protected processCreateDesignsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Removes designs connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product designs connections creation parameters.
     * @return Success
     */
    removeDesignsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDesignConnectionsDto | null | undefined): Observable<void>;
    protected processRemoveDesignsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Creates new mockups connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product mockups connections creation parameters.
     * @return Success
     */
    createMockupsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductMockupConnectionsDto | null | undefined): Observable<void>;
    protected processCreateMockupsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Removes mockups connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product mockups connections creation parameters.
     * @return Success
     */
    removeMockupsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductMockupConnectionsDto | null | undefined): Observable<void>;
    protected processRemoveMockupsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Creates new documents connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product documents connections creation parameters.
     * @return Success
     */
    createDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDocumentConnectionsDto | null | undefined): Observable<void>;
    protected processCreateDocumentsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Removes documents connections for a specified product.
     * @param id Product identifier.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Product documents connections creation parameters.
     * @return Success
     */
    removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined): Observable<void>;
    protected processRemoveDocumentsConnections(response: HttpResponseBase): Observable<void>;
    /**
     * Returns all available product personalization workflows.
     * @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 personalization workflow name.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAvailablePersonalizationWorkflows(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfPersonalizationWorkflowDto>;
    protected processGetAvailablePersonalizationWorkflows(response: HttpResponseBase): Observable<PagedOfPersonalizationWorkflowDto>;
    /**
     * Returns all available product processing pipelines.
     * @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
     */
    getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProcessingPipelineDto>;
    protected processGetAvailableProcessingPipelines(response: HttpResponseBase): Observable<PagedOfProcessingPipelineDto>;
}
export interface IStorefrontsManagementApiClient {
    /**
     * Returns all storefronts, relevant to the specified query parameters.
     * @param types (optional) Storefront type 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 tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
    /**
     * Returns a storefront by identifier.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(id: number, tenantId?: number | null | undefined): Observable<StorefrontDto>;
    /**
     * Deletes an existing storefront by its identifier.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    delete(id: number, tenantId?: number | null | undefined): Observable<StorefrontDto>;
    /**
     * Creates new custom storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Custom storefront creation model.
     * @return Success
     */
    createCustomStorefront(tenantId?: number | null | undefined, body?: CreateCustomStorefrontDto | null | undefined): Observable<CustomStorefrontDto>;
    /**
     * Returns extended information about custom storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getCustomStorefront(id: number, tenantId?: number | null | undefined): Observable<CustomStorefrontDto>;
    /**
     * Creates new NopCommerce storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) NopCommerce storefront creation model.
     * @return Success
     */
    createNopCommerceStorefront(tenantId?: number | null | undefined, body?: CreateNopCommerceStorefrontDto | null | undefined): Observable<NopCommerceStorefrontDto>;
    /**
     * Returns extended information about NopCommerce storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getNopCommerceStorefront(id: number, tenantId?: number | null | undefined): Observable<NopCommerceStorefrontDto>;
    /**
     * Creates new WooCommerce storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) WooCommerce storefront creation model.
     * @return Success
     */
    createWooCommerceStorefront(tenantId?: number | null | undefined, body?: CreateWooCommerceStorefrontDto | null | undefined): Observable<WooCommerceStorefrontDto>;
    /**
     * Returns extended information about WooCommerce storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getWooCommerceStorefront(id: number, tenantId?: number | null | undefined): Observable<WooCommerceStorefrontDto>;
    /**
     * Creates new Magento storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Magento storefront creation model.
     * @return Success
     */
    createMagentoStorefront(tenantId?: number | null | undefined, body?: CreateMagentoStorefrontDto | null | undefined): Observable<MagentoStorefrontDto>;
    /**
     * Returns extended information about Magento storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getMagentoStorefront(id: number, tenantId?: number | null | undefined): Observable<MagentoStorefrontDto>;
    /**
     * Creates new BigCommerce storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) BigCommerce storefront creation model.
     * @return Success
     */
    createBigCommerceStorefront(tenantId?: number | null | undefined, body?: CreateBigCommerceStorefrontDto | null | undefined): Observable<BigCommerceStorefrontDto>;
    /**
     * Returns extended information about BigCommerce storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getBigCommerceStorefront(id: number, tenantId?: number | null | undefined): Observable<MagentoStorefrontDto>;
}
export declare class StorefrontsManagementApiClient extends ApiClientBase implements IStorefrontsManagementApiClient {
    private http;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
    /**
     * Returns all storefronts, relevant to the specified query parameters.
     * @param types (optional) Storefront type 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 tenantId (optional) Tenant identifier.
     * @return Success
     */
    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
    protected processGetAll(response: HttpResponseBase): Observable<PagedOfStorefrontDto>;
    /**
     * Returns a storefront by identifier.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    get(id: number, tenantId?: number | null | undefined): Observable<StorefrontDto>;
    protected processGet(response: HttpResponseBase): Observable<StorefrontDto>;
    /**
     * Deletes an existing storefront by its identifier.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    delete(id: number, tenantId?: number | null | undefined): Observable<StorefrontDto>;
    protected processDelete(response: HttpResponseBase): Observable<StorefrontDto>;
    /**
     * Creates new custom storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) Custom storefront creation model.
     * @return Success
     */
    createCustomStorefront(tenantId?: number | null | undefined, body?: CreateCustomStorefrontDto | null | undefined): Observable<CustomStorefrontDto>;
    protected processCreateCustomStorefront(response: HttpResponseBase): Observable<CustomStorefrontDto>;
    /**
     * Returns extended information about custom storefront.
     * @param id Storefront identifier.
     * @param tenantId (optional) Tenant identifier.
     * @return Success
     */
    getCustomStorefront(id: number, tenantId?: number | null | undefined): Observable<CustomStorefrontDto>;
    protected processGetCustomStorefront(response: HttpResponseBase): Observable<CustomStorefrontDto>;
    /**
     * Creates new NopCommerce storefront.
     * @param tenantId (optional) Tenant identifier.
     * @param body (optional) NopCommerce storefront creation model.
     * @return Success
     */
    createNopCommerceStorefront(tenantId?: number | null | undefined, body?: CreateNop