@iblai/iblai-api 4.265.1-core → 4.265.2-core

package/src/services/PipelinesService.ts

@@ -0,0 +1,406 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PaginatedPipelineList } from '../models/PaginatedPipelineList';
+import type { PaginatedPipelineStageList } from '../models/PaginatedPipelineStageList';
+import type { PatchedPipeline } from '../models/PatchedPipeline';
+import type { PatchedPipelineStage } from '../models/PatchedPipelineStage';
+import type { Pipeline } from '../models/Pipeline';
+import type { PipelineStage } from '../models/PipelineStage';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class PipelinesService {
+    /**
+     * List pipelines
+     * Returns a paginated list of Pipelines in your Platform. Each Pipeline includes its ordered `stages` inline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/list`.
+     * @returns PaginatedPipelineList
+     * @throws ApiError
+     */
+    public static pipelinesList({
+        code,
+        isDefault,
+        name,
+        page,
+        pageSize,
+    }: {
+        code?: string,
+        isDefault?: boolean,
+        name?: string,
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+    }): CancelablePromise<PaginatedPipelineList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/pipelines/',
+            query: {
+                'code': code,
+                'is_default': isDefault,
+                'name': name,
+                'page': page,
+                'page_size': pageSize,
+            },
+            errors: {
+                401: `Authentication required.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/list\`.`,
+            },
+        });
+    }
+    /**
+     * Create a pipeline
+     * Creates a new Pipeline. `code` must be unique within your Platform. Promoting another Pipeline to `is_default=true` while one already exists will fail — unset the existing default first.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    public static pipelinesCreate({
+        requestBody,
+    }: {
+        requestBody: Pipeline,
+    }): CancelablePromise<Pipeline> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/pipelines/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+            },
+        });
+    }
+    /**
+     * List stages for a pipeline
+     * Returns the ordered list of PipelineStages for the given Pipeline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/list`.
+     * @returns PaginatedPipelineStageList
+     * @throws ApiError
+     */
+    public static pipelinesStagesList({
+        pipelinePk,
+        code,
+        isLost,
+        isWon,
+        page,
+        pageSize,
+    }: {
+        pipelinePk: number,
+        code?: string,
+        isLost?: boolean,
+        isWon?: boolean,
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+    }): CancelablePromise<PaginatedPipelineStageList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/pipelines/{pipeline_pk}/stages/',
+            path: {
+                'pipeline_pk': pipelinePk,
+            },
+            query: {
+                'code': code,
+                'is_lost': isLost,
+                'is_won': isWon,
+                'page': page,
+                'page_size': pageSize,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/list\`.`,
+                404: `Pipeline not found.`,
+            },
+        });
+    }
+    /**
+     * Create a stage
+     * Creates a new PipelineStage in the URL Pipeline. `code` must be unique within that Pipeline. At most one of `is_won` / `is_lost` may be true.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    public static pipelinesStagesCreate({
+        pipelinePk,
+        requestBody,
+    }: {
+        pipelinePk: number,
+        requestBody: PipelineStage,
+    }): CancelablePromise<PipelineStage> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/pipelines/{pipeline_pk}/stages/',
+            path: {
+                'pipeline_pk': pipelinePk,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `Pipeline not found.`,
+            },
+        });
+    }
+    /**
+     * Retrieve a stage
+     * Returns a single PipelineStage by id (must belong to the URL Pipeline).
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/read`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    public static pipelinesStagesRetrieve({
+        id,
+        pipelinePk,
+    }: {
+        id: number,
+        pipelinePk: number,
+    }): CancelablePromise<PipelineStage> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/pipelines/{pipeline_pk}/stages/{id}/',
+            path: {
+                'id': id,
+                'pipeline_pk': pipelinePk,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/read\`.`,
+                404: `Stage not found in this Pipeline.`,
+            },
+        });
+    }
+    /**
+     * Replace a stage
+     * Replaces all editable fields on the PipelineStage.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    public static pipelinesStagesUpdate({
+        id,
+        pipelinePk,
+        requestBody,
+    }: {
+        id: number,
+        pipelinePk: number,
+        requestBody: PipelineStage,
+    }): CancelablePromise<PipelineStage> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/pipelines/{pipeline_pk}/stages/{id}/',
+            path: {
+                'id': id,
+                'pipeline_pk': pipelinePk,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `Stage not found in this Pipeline.`,
+            },
+        });
+    }
+    /**
+     * Update a stage
+     * Updates only the supplied fields on the PipelineStage.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    public static pipelinesStagesPartialUpdate({
+        id,
+        pipelinePk,
+        requestBody,
+    }: {
+        id: number,
+        pipelinePk: number,
+        requestBody?: PatchedPipelineStage,
+    }): CancelablePromise<PipelineStage> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/pipelines/{pipeline_pk}/stages/{id}/',
+            path: {
+                'id': id,
+                'pipeline_pk': pipelinePk,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `Stage not found in this Pipeline.`,
+            },
+        });
+    }
+    /**
+     * Delete a stage
+     * Deletes the PipelineStage. Fails with `409 Conflict` if any Deal still references it (FK is PROTECTed).
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static pipelinesStagesDestroy({
+        id,
+        pipelinePk,
+    }: {
+        id: number,
+        pipelinePk: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/pipelines/{pipeline_pk}/stages/{id}/',
+            path: {
+                'id': id,
+                'pipeline_pk': pipelinePk,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/delete\`.`,
+                404: `Stage not found in this Pipeline.`,
+                409: `Stage still has Deals attached.`,
+            },
+        });
+    }
+    /**
+     * Retrieve a pipeline
+     * Returns a single Pipeline by id, including its ordered `stages`.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/read`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    public static pipelinesRetrieve({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number,
+    }): CancelablePromise<Pipeline> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/pipelines/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/read\`.`,
+                404: `Pipeline not found.`,
+            },
+        });
+    }
+    /**
+     * Replace a pipeline
+     * Replaces all editable fields on the Pipeline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    public static pipelinesUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number,
+        requestBody: Pipeline,
+    }): CancelablePromise<Pipeline> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/pipelines/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `Pipeline not found.`,
+            },
+        });
+    }
+    /**
+     * Update a pipeline
+     * Updates only the supplied fields on the Pipeline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    public static pipelinesPartialUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number,
+        requestBody?: PatchedPipeline,
+    }): CancelablePromise<Pipeline> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/pipelines/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `Pipeline not found.`,
+            },
+        });
+    }
+    /**
+     * Delete a pipeline
+     * Deletes the Pipeline. Fails with `409 Conflict` if any Deal still references it (FK is PROTECTed).
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static pipelinesDestroy({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/pipelines/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/delete\`.`,
+                404: `Pipeline not found.`,
+                409: `Pipeline still has Deals attached.`,
+            },
+        });
+    }
+}