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

package/dist/types/services/DealsService.d.ts

@@ -0,0 +1,160 @@
+import type { Deal } from '../models/Deal';
+import type { DealLostRequest } from '../models/DealLostRequest';
+import type { DealMoveStageRequest } from '../models/DealMoveStageRequest';
+import type { DealWonRequest } from '../models/DealWonRequest';
+import type { PaginatedDealList } from '../models/PaginatedDealList';
+import type { PatchedDeal } from '../models/PatchedDeal';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class DealsService {
+    /**
+     * List deals
+     * Returns a paginated list of Deals in your Platform. Supports filtering by `status`, `pipeline`, `stage`, `owner`, `source`, `person`, `organization`, expected-close-date and created-at ranges, and `metadata__has_key`.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/list`.
+     * @returns PaginatedDealList
+     * @throws ApiError
+     */
+    static dealsList({ createdAtGte, createdAtLte, expectedCloseDateGte, expectedCloseDateLte, metadataHasKey, organization, owner, page, pageSize, person, pipeline, source, stage, status, }: {
+        createdAtGte?: string;
+        createdAtLte?: string;
+        expectedCloseDateGte?: string;
+        expectedCloseDateLte?: string;
+        metadataHasKey?: string;
+        organization?: string;
+        owner?: number;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+        person?: string;
+        pipeline?: number;
+        source?: number;
+        stage?: number;
+        /**
+         * Service-managed (read-only in serializer). Derived from the destination stage's is_won/is_lost.
+         *
+         * * `open` - Open
+         * * `won` - Won
+         * * `lost` - Lost
+         */
+        status?: 'lost' | 'open' | 'won';
+    }): CancelablePromise<PaginatedDealList>;
+    /**
+     * Create a deal
+     * Creates a new Deal. All FK targets (`person`, `organization`, `pipeline`, `stage`, `source`) must belong to your Platform; `stage` must belong to `pipeline`. `status` and `closed_at` are service-managed — passing them returns `400`.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsCreate({ requestBody, }: {
+        requestBody: Deal;
+    }): CancelablePromise<Deal>;
+    /**
+     * Retrieve a deal
+     * Returns a single Deal by id.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/read`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsRetrieve({ id, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+    }): CancelablePromise<Deal>;
+    /**
+     * Replace a deal
+     * Replaces all editable fields on the Deal.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody: Deal;
+    }): CancelablePromise<Deal>;
+    /**
+     * Update a deal
+     * Updates only the supplied fields on the Deal. Direct writes to `status` or `closed_at` are rejected with `400` — use `POST /deals/{id}/move-stage/`, `won/`, or `lost/`.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsPartialUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody?: PatchedDeal;
+    }): CancelablePromise<Deal>;
+    /**
+     * Delete a deal
+     * Deletes the Deal.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static dealsDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+    }): CancelablePromise<void>;
+    /**
+     * Mark a deal as lost
+     * Moves the Deal into a closed-lost stage and persists `lost_reason`. If `stage_code` is omitted, the first `is_lost=True` stage in the Deal's pipeline (by sort order) is used.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsLostCreate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody: DealLostRequest;
+    }): CancelablePromise<Deal>;
+    /**
+     * Move a deal to a different stage
+     * Moves the Deal to the stage identified by `stage_id` or `stage_code`. The target stage must belong to this Deal's pipeline. Records an audit Activity and emits `deal_stage_changed`. `Deal.status` is recomputed from the new stage's `is_won` / `is_lost` flags.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsMoveStageCreate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody?: DealMoveStageRequest;
+    }): CancelablePromise<Deal>;
+    /**
+     * Mark a deal as won
+     * Moves the Deal into a closed-won stage and sets `status='won'`. If `stage_code` is omitted, the first `is_won=True` stage in the Deal's pipeline (by sort order) is used.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    static dealsWonCreate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody?: DealWonRequest;
+    }): CancelablePromise<Deal>;
+}

package/dist/types/services/LeadSourcesService.d.ts

@@ -0,0 +1,95 @@
+import type { LeadSource } from '../models/LeadSource';
+import type { PaginatedLeadSourceList } from '../models/PaginatedLeadSourceList';
+import type { PatchedLeadSource } from '../models/PatchedLeadSource';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class LeadSourcesService {
+    /**
+     * List lead sources
+     * Returns a paginated list of LeadSources in your Platform.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/list`.
+     * @returns PaginatedLeadSourceList
+     * @throws ApiError
+     */
+    static leadSourcesList({ code, name, page, pageSize, }: {
+        code?: string;
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<PaginatedLeadSourceList>;
+    /**
+     * Create a lead source
+     * Creates a new LeadSource in your Platform. `code` must be unique.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    static leadSourcesCreate({ requestBody, }: {
+        requestBody: LeadSource;
+    }): CancelablePromise<LeadSource>;
+    /**
+     * Retrieve a lead source
+     * Returns a single LeadSource by id.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/read`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    static leadSourcesRetrieve({ id, }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number;
+    }): CancelablePromise<LeadSource>;
+    /**
+     * Replace a lead source
+     * Replaces all editable fields on the LeadSource.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    static leadSourcesUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number;
+        requestBody: LeadSource;
+    }): CancelablePromise<LeadSource>;
+    /**
+     * Update a lead source
+     * Updates only the supplied fields on the LeadSource.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    static leadSourcesPartialUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number;
+        requestBody?: PatchedLeadSource;
+    }): CancelablePromise<LeadSource>;
+    /**
+     * Delete a lead source
+     * Deletes the LeadSource. Any Deals referencing it have their `source` cleared.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static leadSourcesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number;
+    }): CancelablePromise<void>;
+}

package/dist/types/services/PersonsService.d.ts

@@ -20,7 +20,7 @@ export declare class PersonsService {
         createdAtGte?: string;
         createdAtLte?: string;
         /**
-         * Funnel position. Free-form transitions in v0.
+         * Funnel position. Transitions are unrestricted — any stage may move to any other.
          *
          * * `lead` - Lead
          * * `qualified` - Qualified

package/dist/types/services/PipelinesService.d.ts

@@ -0,0 +1,183 @@
+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';
+export declare 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
+     */
+    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>;
+    /**
+     * 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
+     */
+    static pipelinesCreate({ requestBody, }: {
+        requestBody: Pipeline;
+    }): CancelablePromise<Pipeline>;
+    /**
+     * 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
+     */
+    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>;
+    /**
+     * 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
+     */
+    static pipelinesStagesCreate({ pipelinePk, requestBody, }: {
+        pipelinePk: number;
+        requestBody: PipelineStage;
+    }): CancelablePromise<PipelineStage>;
+    /**
+     * 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
+     */
+    static pipelinesStagesRetrieve({ id, pipelinePk, }: {
+        id: number;
+        pipelinePk: number;
+    }): CancelablePromise<PipelineStage>;
+    /**
+     * Replace a stage
+     * Replaces all editable fields on the PipelineStage.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    static pipelinesStagesUpdate({ id, pipelinePk, requestBody, }: {
+        id: number;
+        pipelinePk: number;
+        requestBody: PipelineStage;
+    }): CancelablePromise<PipelineStage>;
+    /**
+     * Update a stage
+     * Updates only the supplied fields on the PipelineStage.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns PipelineStage
+     * @throws ApiError
+     */
+    static pipelinesStagesPartialUpdate({ id, pipelinePk, requestBody, }: {
+        id: number;
+        pipelinePk: number;
+        requestBody?: PatchedPipelineStage;
+    }): CancelablePromise<PipelineStage>;
+    /**
+     * 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
+     */
+    static pipelinesStagesDestroy({ id, pipelinePk, }: {
+        id: number;
+        pipelinePk: number;
+    }): CancelablePromise<void>;
+    /**
+     * Retrieve a pipeline
+     * Returns a single Pipeline by id, including its ordered `stages`.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/read`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    static pipelinesRetrieve({ id, }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number;
+    }): CancelablePromise<Pipeline>;
+    /**
+     * Replace a pipeline
+     * Replaces all editable fields on the Pipeline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    static pipelinesUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number;
+        requestBody: Pipeline;
+    }): CancelablePromise<Pipeline>;
+    /**
+     * Update a pipeline
+     * Updates only the supplied fields on the Pipeline.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns Pipeline
+     * @throws ApiError
+     */
+    static pipelinesPartialUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number;
+        requestBody?: PatchedPipeline;
+    }): CancelablePromise<Pipeline>;
+    /**
+     * 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
+     */
+    static pipelinesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number;
+    }): CancelablePromise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/iblai-api",
-  "version": "4.265.1-core",
+  "version": "4.265.2-core",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "type": "module",