@aurigma/axios-storefront-api-client 2.2.53

package/dist/esm/storefront-api-client.d.ts

@@ -0,0 +1,973 @@
+/// <reference types="node" />
+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 {
+    /**
+     * Gets assembly build info
+     * @return Success
+     */
+    headInfo(): Promise<void>;
+    /**
+     * Gets 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);
+    /**
+     * Gets assembly build info
+     * @return Success
+     */
+    headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processHeadInfo(response: AxiosResponse): Promise<void>;
+    /**
+     * Gets assembly build info
+     * @return Success
+     */
+    getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
+    protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
+}
+export interface IProductReferencesApiClient {
+    /**
+     * Gets all storefront product references relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier
+     * @param productSpecificationId (optional) Cusomer's Canvas product specification filter
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
+    /**
+     * Creates new storefront product reference
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProductReferenceDto | undefined): Promise<ProductReferenceDto>;
+    /**
+     * Gets 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
+    /**
+     * Deletes 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
+    /**
+     * Gets product specification by 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductSpecificationDto>;
+    /**
+     * Gets product configuration information by 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
+}
+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);
+    /**
+     * Gets all storefront product references relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier
+     * @param productSpecificationId (optional) Cusomer's Canvas product specification filter
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
+    /**
+     * Creates new storefront product reference
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProductReferenceDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
+    protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
+    /**
+     * Gets 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
+    protected processGet(response: AxiosResponse): Promise<ProductReferenceDto>;
+    /**
+     * Deletes 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
+    protected processDelete(response: AxiosResponse): Promise<ProductReferenceDto>;
+    /**
+     * Gets product specification by 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
+    protected processGetProductSpecification(response: AxiosResponse): Promise<ProductSpecificationDto>;
+    /**
+     * Gets product configuration information by 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
+    protected processGetProductConfig(response: AxiosResponse): Promise<ProductReferenceDto>;
+}
+export interface IProductSpecificationsApiClient {
+    /**
+     * Gets all product specifications relevant to specified query parameters
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProductSpecificationDto>;
+    /**
+     * Gets product specification by id
+     * @param id Product specification identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductSpecificationDto>;
+    /**
+     * Gets product configuration description by product specification id
+     * @param id Product specification identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getConfiguration(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<string>;
+}
+export declare class ProductSpecificationsApiClient extends ApiClientBase implements IProductSpecificationsApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets all product specifications relevant to specified query parameters
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductSpecificationDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfProductSpecificationDto>;
+    /**
+     * Gets product specification by id
+     * @param id Product specification identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
+    protected processGet(response: AxiosResponse): Promise<ProductSpecificationDto>;
+    /**
+     * Gets product configuration description by product specification id
+     * @param id Product specification identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getConfiguration(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
+    protected processGetConfiguration(response: AxiosResponse): Promise<string>;
+}
+export interface IProjectsApiClient {
+    /**
+     * Gets all projects relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param ownerId (optional) Project owner (storefront user id) filter
+     * @param productReference (optional) Product reference filter
+     * @param status (optional) Project status filter
+     * @param datePeriod (optional) Project date period filter
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectDto>;
+    /**
+     * Creates new project
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProjectDto | undefined): Promise<ProjectDto>;
+    /**
+     * Gets project by id
+     * @param id Project identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectDto>;
+    /**
+     * Gets available project transitions
+     * @param id Project identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    /**
+     * Changes project status
+     * @param id Project identifier
+     * @param transition Transition identifying name
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    changeStatus(id: number, transition: string | null, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectStatusDto>;
+    /**
+     * Force changes project status
+     * @param id Project identifier
+     * @param status Project status code
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    forceStatus(id: number, status: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectStatusDto>;
+    /**
+     * Gets all project statuses
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAllStatuses(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectStatusDto>;
+    /**
+     * Gets all project transitions
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAllTransitions(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    /**
+     * Gets project pdf url
+     * @param id Project unique identifier
+     * @param designUserId User identifier
+     * @param designId Design identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectPdfResultDto>;
+    /**
+     * Gets project pdf files in zip archive
+     * @param id Project unique identifier
+     * @param designUserId User identifier
+     * @param designId Design identifier
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with proper filename supplied (default value is 'false')
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<FileResponse>;
+    /**
+     * Gets project order data from ecommerce system
+     * @param id Project identifier
+     * @return Success
+     */
+    getProjectOrder(id: number): Promise<any>;
+}
+export declare class ProjectsApiClient extends ApiClientBase implements IProjectsApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets all projects relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param ownerId (optional) Project owner (storefront user id) filter
+     * @param productReference (optional) Product reference filter
+     * @param status (optional) Project status filter
+     * @param datePeriod (optional) Project date period filter
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
+    /**
+     * Creates new project
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProjectDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreate(response: AxiosResponse): Promise<ProjectDto>;
+    /**
+     * Gets project by id
+     * @param id Project identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processGet(response: AxiosResponse): Promise<ProjectDto>;
+    /**
+     * Gets available project transitions
+     * @param id Project identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
+    protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    /**
+     * Changes project status
+     * @param id Project identifier
+     * @param transition Transition identifying name
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    changeStatus(id: number, transition: string | null, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+    protected processChangeStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
+    /**
+     * Force changes project status
+     * @param id Project identifier
+     * @param status Project status code
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    forceStatus(id: number, status: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+    protected processForceStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
+    /**
+     * Gets all project statuses
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAllStatuses(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusDto>;
+    protected processGetAllStatuses(response: AxiosResponse): Promise<PagedOfProjectStatusDto>;
+    /**
+     * Gets all project transitions
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAllTransitions(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
+    protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    /**
+     * Gets project pdf url
+     * @param id Project unique identifier
+     * @param designUserId User identifier
+     * @param designId Design identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectPdfResultDto>;
+    protected processGetProjectPdfUrl(response: AxiosResponse): Promise<ProjectPdfResultDto>;
+    /**
+     * Gets project pdf files in zip archive
+     * @param id Project unique identifier
+     * @param designUserId User identifier
+     * @param designId Design identifier
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with proper filename supplied (default value is 'false')
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processGetProjectPdfZip(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Gets project order data from ecommerce system
+     * @param id Project identifier
+     * @return Success
+     */
+    getProjectOrder(id: number, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processGetProjectOrder(response: AxiosResponse): Promise<any>;
+}
+export interface IStorefrontsApiClient {
+    /**
+     * Gets all storefronts relevant to 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 much 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
+     * @param userId (optional) User 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, userId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
+    /**
+     * Gets storefront
+     * @param id Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<StorefrontDto>;
+}
+export declare class StorefrontsApiClient extends ApiClientBase implements IStorefrontsApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets all storefronts relevant to 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 much 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
+     * @param userId (optional) User 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, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
+    /**
+     * Gets storefront
+     * @param id Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontDto>;
+    protected processGet(response: AxiosResponse): Promise<StorefrontDto>;
+}
+export interface IStorefrontUsersApiClient {
+    /**
+     * Gets all storefront users relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param storefrontUserId (optional) Storefront user identifier
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, storefrontUserId?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfStorefrontUserDto>;
+    /**
+     * Creates new storefront user
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined): Promise<StorefrontUserDto>;
+    /**
+     * Gets storefront user by id
+     * @param id Storefront user identifier
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<StorefrontUserDto>;
+    /**
+     * Merges anonymous storefront user data to regular storefront user account
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Merge operation parameters
+     * @return Success
+     */
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined): Promise<void>;
+    /**
+     * Gets storefront user token
+     * @param storefrontUserId Storefront user identifier
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getToken(storefrontUserId: string, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<void>;
+}
+export declare class StorefrontUsersApiClient extends ApiClientBase implements IStorefrontUsersApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets all storefront users relevant to specified query parameters
+     * @param storefrontId Storefront identifier
+     * @param storefrontUserId (optional) Storefront user identifier
+     * @param skip (optional) Defines page start offset from beginning of sorted result list
+     * @param take (optional) Defines page length (how much 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
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getAll(storefrontId: number, storefrontUserId?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontUserDto>;
+    protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontUserDto>;
+    /**
+     * Creates new storefront user
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Create operation parameters
+     * @return Success
+     */
+    create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
+    protected processCreate(response: AxiosResponse): Promise<StorefrontUserDto>;
+    /**
+     * Gets storefront user by id
+     * @param id Storefront user identifier
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    get(id: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
+    protected processGet(response: AxiosResponse): Promise<StorefrontUserDto>;
+    /**
+     * Merges anonymous storefront user data to regular storefront user account
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @param body (optional) Merge operation parameters
+     * @return Success
+     */
+    mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processMergeAnonymous(response: AxiosResponse): Promise<void>;
+    /**
+     * Gets storefront user token
+     * @param storefrontUserId Storefront user identifier
+     * @param storefrontId Storefront identifier
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getToken(storefrontUserId: string, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processGetToken(response: AxiosResponse): Promise<void>;
+}
+export interface ITenantInfoApiClient {
+    /**
+     * Gets information about tenant applications
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getApplicationsInfo(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<TenantApplicationsInfoDto>;
+    /**
+     * Gets information about tenant
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getInfo(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<TenantInfoDto>;
+}
+export declare class TenantInfoApiClient extends ApiClientBase implements ITenantInfoApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Gets information about tenant applications
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getApplicationsInfo(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantApplicationsInfoDto>;
+    protected processGetApplicationsInfo(response: AxiosResponse): Promise<TenantApplicationsInfoDto>;
+    /**
+     * Gets information about tenant
+     * @param tenantId (optional) Tenant identifier
+     * @param userId (optional) User identifier
+     * @return Success
+     */
+    getInfo(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantInfoDto>;
+    protected processGetInfo(response: AxiosResponse): Promise<TenantInfoDto>;
+}
+/** Information about a service */
+export interface BuildInfoModel {
+    /** Version number */
+    version?: string | null;
+    /** Build date (UTC) */
+    buildDate?: string | null;
+    /** Build configuration (Debug | Release) */
+    configuration?: string | null;
+    /** Service name */
+    appName?: string | null;
+}
+/** Storefront product reference dto class */
+export interface ProductReferenceDto {
+    /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier */
+    productReference?: string | null;
+    /** Customer's Canvas product specification identifier */
+    productSpecificationId?: number;
+    /** Storefront identifier */
+    storefrontId?: number;
+    /** Tenant identifier */
+    tenantId?: number;
+    /** Storefront product reference creation date and time */
+    created?: string;
+}
+/** Paged list of items */
+export interface PagedOfProductReferenceDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: ProductReferenceDto[] | null;
+}
+/** Dto class, containing create operation parameters for storefront product reference */
+export interface CreateProductReferenceDto {
+    /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier */
+    productReference: string;
+    /** Customer's Canvas product specification identifier */
+    productSpecificationId: number;
+}
+export interface ProblemDetails {
+    type?: string | null;
+    title?: string | null;
+    status?: number | null;
+    detail?: string | null;
+    instance?: string | null;
+}
+/** Product attribute dto class */
+export interface ProductAttributeDto {
+    /** Product attribute name */
+    name?: string | null;
+    /** Product attribute type */
+    type?: string | null;
+    /** Product attribute value */
+    value?: any | null;
+}
+/** Product specification dto class */
+export interface ProductSpecificationDto {
+    /** Product specification identifier */
+    id?: number;
+    /** Tenant identifier */
+    tenantId?: number;
+    /** Product specification name */
+    name?: string | null;
+    /** List of product attributes */
+    productAttributes?: ProductAttributeDto[] | null;
+    /** Product specification creation time */
+    created?: string;
+    /** Product specification modification time */
+    lastModified?: string | null;
+}
+/** Paged list of items */
+export interface PagedOfProductSpecificationDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: ProductSpecificationDto[] | null;
+}
+/** Available date period filter values for queries */
+export declare enum DatePeriod {
+    All = "All",
+    Today = "Today",
+    Last7Days = "Last7Days",
+    Last30Days = "Last30Days"
+}
+/** Project item dto class */
+export interface ProjectItemDto {
+    /** Item name */
+    name?: string | null;
+    /** Item quantity information */
+    quantity?: number | null;
+    /** Item information */
+    fields?: {
+        [key: string]: any;
+    } | null;
+    /** Additional item information */
+    hidden?: any | null;
+    /** List of item associated design identifiers */
+    designIds?: string[] | null;
+    /** SKU */
+    sku?: string | null;
+}
+/** Project dto class */
+export interface ProjectDto {
+    /** Project identifier */
+    id?: number;
+    /** Product reference (i.e external reference to Customer's Canvas product specification) */
+    productReference?: string | null;
+    /** Storefront identifier */
+    storefrontId?: number;
+    /** Project tenant indentifier */
+    tenantId?: number;
+    /** Order identifier in ecommerce system */
+    orderId?: string | null;
+    /** Order url in ecommerce system */
+    orderUrl?: string | null;
+    /** Order number in ecommerce system */
+    orderNumber?: number | null;
+    /** Line item ID from external ecommerce system order. */
+    orderLineItemId?: string | null;
+    /** Line item index from external ecommerce system order. */
+    orderLineItemIndex?: number | null;
+    /** Customer identifier in ecommerce system */
+    customerId?: string | null;
+    /** Customer name in ecommerce system */
+    customerName?: string | null;
+    /** Project name */
+    name?: string | null;
+    /** Project owner identifier */
+    ownerId?: string | null;
+    /** List of project items */
+    items?: ProjectItemDto[] | null;
+    /** Project status code */
+    status?: number;
+    /** Project creation time */
+    created?: string;
+    /** Project modification time */
+    lastModified?: string | null;
+    /** Description of the project */
+    description?: string | null;
+}
+/** Paged list of items */
+export interface PagedOfProjectDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: ProjectDto[] | null;
+}
+/** Dto class, containing create operation parameters for project entity */
+export interface CreateProjectDto {
+    /** Product reference (i.e external reference to Customer's Canvas product specification - main subject of this project) */
+    productReference: string;
+    /** Order identifier in ecommerce system */
+    orderId?: string | null;
+    /** Order url in ecommerce system */
+    orderUrl?: string | null;
+    /** Order number in ecommerce system */
+    orderNumber?: number | null;
+    /** Line item index from ecommerce system order */
+    orderLineItemIndex?: number | null;
+    /** Line Item id from ecommerce system order */
+    orderLineItemId?: string | null;
+    /** Customer identifier in ecommerce system */
+    customerId?: string | null;
+    /** Customer name in ecommerce system */
+    customerName?: string | null;
+    /** Project name */
+    name?: string | null;
+    /** Project owner identifier */
+    ownerId: string;
+    /** List of project items */
+    items?: ProjectItemDto[] | null;
+    /** Description of the project */
+    description?: string | null;
+}
+/** Project transition dto class */
+export interface ProjectTransitionDto {
+    /** Transition identifying name */
+    name?: string | null;
+    /** Transition display name */
+    displayName?: string | null;
+    /** Project status code from which transition to the result status code can be done */
+    startStatus?: number;
+    /** Transition result project status code */
+    resultStatus?: number;
+}
+/** Paged list of items */
+export interface PagedOfProjectTransitionDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: ProjectTransitionDto[] | null;
+}
+/** Information about project transition conflict */
+export interface ProjectTransitionConflictDto {
+    /** List of available project transitions */
+    availableTransitions?: ProjectTransitionDto[] | null;
+}
+/** Project status dto class */
+export interface ProjectStatusDto {
+    /** Status code */
+    code?: number;
+    /** Status display name */
+    displayName?: string | null;
+}
+/** Paged list of items */
+export interface PagedOfProjectStatusDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: ProjectStatusDto[] | null;
+}
+/** Dto class, containing result of get project pdf url operation */
+export interface ProjectPdfResultDto {
+    /** Project pdf url */
+    url?: string | null;
+}
+/** Storefront types */
+export declare enum StorefrontType {
+    Custom = "Custom",
+    Shopify = "Shopify",
+    DocketManager = "DocketManager",
+    Auth0Saml = "Auth0Saml"
+}
+/** Storefront dto class */
+export interface StorefrontDto {
+    /** Storefront identifier */
+    id?: number;
+    /** Tenant identifier */
+    tenantId?: number;
+    /** Storefront name */
+    name?: string | null;
+    type?: StorefrontType;
+    /** Storefront entity creation date and time */
+    created?: string;
+}
+/** Paged list of items */
+export interface PagedOfStorefrontDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: StorefrontDto[] | null;
+}
+/** Storefront user dto class */
+export interface StorefrontUserDto {
+    /** Storefront user identifier */
+    userId?: string | null;
+    /** Storefront tenant indentifier */
+    tenantId?: number;
+    /** Storefront identifier */
+    storefrontId?: number | null;
+    /** Indicates whether user is an anonymous */
+    isAnonymous?: boolean;
+}
+/** Paged list of items */
+export interface PagedOfStorefrontUserDto {
+    /** Items count */
+    total?: number;
+    /** Items list */
+    items?: StorefrontUserDto[] | null;
+}
+/** Dto class, containing create operation parameters for storefront user entity */
+export interface CreateStorefrontUserDto {
+    /** Storefront user identifier */
+    storefrontUserId?: string | null;
+    /** Indicates whether user is an anonymous */
+    isAnonymous?: boolean;
+}
+/** Dto class, containing parameters for merge anonymous user operation */
+export interface MergeAnonymousUserDataInput {
+    /** Anonymous storefront user identifier */
+    anonymousStorefrontUserId?: string | null;
+    /** Regular storefront user identifier */
+    regularStorefrontUserId?: string | null;
+}
+/** Dto class, containing information about tenant applications */
+export interface TenantApplicationsInfoDto {
+    designEditorUrl?: string | null;
+    uiFrameworkUrl?: string | null;
+    preflightUrl?: string | null;
+    dynamicImageUrl?: string | null;
+    tenantId?: number;
+}
+/** Dto class, containing information about tenant */
+export interface TenantInfoDto {
+    /** Tenant identifier */
+    tenantId?: number;
+    /** Tenancy name */
+    tenancyName?: string | null;
+    /** Tenant creation time */
+    tenantCreationTime?: string;
+}
+export interface FileResponse {
+    data: Blob;
+    status: number;
+    fileName?: string;
+    headers?: {
+        [name: string]: any;
+    };
+}
+export declare class ApiException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isApiException: boolean;
+    static isApiException(obj: any): obj is ApiException;
+}