@aurigma/axios-backoffice-api-client 2.63.14 → 2.66.1

package/dist/cjs/backoffice-api-client.d.ts

@@ -693,6 +693,172 @@ export declare module BackOfficeApiClient {
         getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProcessingPipelineDto>;
         protected processGetAvailableProcessingPipelines(response: AxiosResponse): Promise<PagedOfProcessingPipelineDto>;
     }
+    interface IProjectStatusesManagementApiClient {
+        /**
+         * Returns a list of all existing project statuses.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        getAll(tenantId?: number | null | undefined): Promise<PagedOfProjectStatusDto>;
+        /**
+         * Creates a new project status and returns its description.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status creation parameters.
+         * @return Success
+         */
+        create(tenantId?: number | null | undefined, body?: CreateProjectStatusDto | null | undefined): Promise<ProjectStatusDto>;
+        /**
+         * Returns a project status by its identifier.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        get(id: number, tenantId?: number | null | undefined): Promise<ProjectStatusDto>;
+        /**
+         * Updates an existing project status and returns its description.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status update parameters.
+         * @return Success
+         */
+        update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusDto | null | undefined): Promise<ProjectStatusDto>;
+        /**
+         * Deletes an existing project status and returns its description.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        delete(id: number, tenantId?: number | null | undefined): Promise<ProjectStatusDto>;
+    }
+    class ProjectStatusesManagementApiClient extends ApiClientBase implements IProjectStatusesManagementApiClient {
+        private instance;
+        private baseUrl;
+        protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+        constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+        /**
+         * Returns a list of all existing project statuses.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        getAll(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusDto>;
+        protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectStatusDto>;
+        /**
+         * Creates a new project status and returns its description.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status creation parameters.
+         * @return Success
+         */
+        create(tenantId?: number | null | undefined, body?: CreateProjectStatusDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+        protected processCreate(response: AxiosResponse): Promise<ProjectStatusDto>;
+        /**
+         * Returns a project status by its identifier.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+        protected processGet(response: AxiosResponse): Promise<ProjectStatusDto>;
+        /**
+         * Updates an existing project status and returns its description.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status update parameters.
+         * @return Success
+         */
+        update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+        protected processUpdate(response: AxiosResponse): Promise<ProjectStatusDto>;
+        /**
+         * Deletes an existing project status and returns its description.
+         * @param id Status identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        delete(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
+        protected processDelete(response: AxiosResponse): Promise<ProjectStatusDto>;
+    }
+    interface IProjectStatusTransitionsManagementApiClient {
+        /**
+         * Returns a list of all existing project status transitions.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        getAll(tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+        /**
+         * Returns a project status transition by its identifier.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        get(id: number, tenantId?: number | null | undefined): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Updates an existing project status transition and returns its description.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status transition update parameters.
+         * @return Success
+         */
+        update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusTransitionDto | null | undefined): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Deletes an existing project status transition and returns its description.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        delete(id: number, tenantId?: number | null | undefined): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Creates a new project status transition and returns its description.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status transition creation parameters.
+         * @return Success
+         */
+        create(tenantId?: number | null | undefined, body?: CreateProjectStatusTransitionDto | null | undefined): Promise<ProjectStatusTransitionDto>;
+    }
+    class ProjectStatusTransitionsManagementApiClient extends ApiClientBase implements IProjectStatusTransitionsManagementApiClient {
+        private instance;
+        private baseUrl;
+        protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+        constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+        /**
+         * Returns a list of all existing project status transitions.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        getAll(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+        protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
+        /**
+         * Returns a project status transition by its identifier.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusTransitionDto>;
+        protected processGet(response: AxiosResponse): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Updates an existing project status transition and returns its description.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status transition update parameters.
+         * @return Success
+         */
+        update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusTransitionDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusTransitionDto>;
+        protected processUpdate(response: AxiosResponse): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Deletes an existing project status transition and returns its description.
+         * @param id Status transition identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        delete(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusTransitionDto>;
+        protected processDelete(response: AxiosResponse): Promise<ProjectStatusTransitionDto>;
+        /**
+         * Creates a new project status transition and returns its description.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Status transition creation parameters.
+         * @return Success
+         */
+        create(tenantId?: number | null | undefined, body?: CreateProjectStatusTransitionDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusTransitionDto>;
+        protected processCreate(response: AxiosResponse): Promise<ProjectStatusTransitionDto>;
+    }
     interface IStorefrontsManagementApiClient {
         /**
          * Returns all storefronts, relevant to the specified query parameters.
@@ -701,10 +867,11 @@ export declare module BackOfficeApiClient {
          * @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 status (optional) Storefront status.
          * @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): Promise<PagedOfStorefrontDto>;
+        getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
         /**
          * Returns a storefront by identifier.
          * @param id Storefront identifier.
@@ -802,10 +969,11 @@ export declare module BackOfficeApiClient {
          * @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 status (optional) Storefront status.
          * @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, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
+        getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
         protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
         /**
          * Returns a storefront by identifier.
@@ -1695,6 +1863,92 @@ export declare module BackOfficeApiClient {
         total?: number;
         items?: ProcessingPipelineDto[] | null;
     }
+    /** Project status parameters. */
+    interface ProjectStatusDto {
+        /** Project status identifier. */
+        id?: number;
+        /** Status code. */
+        code?: number;
+        /** Status mark color. */
+        color?: string | null;
+        /** Status display name. */
+        displayName?: string | null;
+        /** Indicates if status is initial for all projects. Only one status may be used as initial. */
+        isInitial?: boolean;
+        /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
+        isFinal?: boolean;
+    }
+    /** DTO, containing results of paged query. */
+    interface PagedOfProjectStatusDto {
+        total?: number;
+        items?: ProjectStatusDto[] | null;
+    }
+    /** Project status creation parameters. */
+    interface CreateProjectStatusDto {
+        /** Status code. */
+        code?: number;
+        /** Status mark color. */
+        color?: string | null;
+        /** Status display name. */
+        displayName?: string | null;
+        /** Indicates if status is initial for all projects. Only one status may be used as initial. */
+        isInitial?: boolean;
+        /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
+        isFinal?: boolean;
+    }
+    /** Project status update parameters. */
+    interface UpdateProjectStatusDto {
+        /** Status code. */
+        code?: number | null;
+        /** Status mark color. */
+        color?: string | null;
+        /** Status display name. */
+        displayName?: string | null;
+        /** Indicates if status is initial for all projects. Only one status may be used as initial. */
+        isInitial?: boolean | null;
+        /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
+        isFinal?: boolean | null;
+    }
+    /** Project status transition dto class. */
+    interface ProjectStatusTransitionDto {
+        /** Transition identifier. */
+        id?: number;
+        /** 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;
+    }
+    /** DTO, containing results of paged query. */
+    interface PagedOfProjectStatusTransitionDto {
+        total?: number;
+        items?: ProjectStatusTransitionDto[] | null;
+    }
+    /** Project status transition update parameters. */
+    interface UpdateProjectStatusTransitionDto {
+        /** Transition hidden system 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;
+    }
+    /** Project status transition creation parameters. */
+    interface CreateProjectStatusTransitionDto {
+        /** Transition hidden system 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;
+    }
     /** Storefront types. */
     enum StorefrontType {
         Custom = "Custom",
@@ -1708,6 +1962,11 @@ export declare module BackOfficeApiClient {
         Shopify = "Shopify",
         ShopifyCustom = "ShopifyCustom"
     }
+    /** Storefront status. */
+    enum StorefrontStatus {
+        Dev = "Dev",
+        Prod = "Prod"
+    }
     /** Dto class, containing information about a storefront. */
     interface StorefrontDto {
         /** Storefront identifier. */