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

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

@@ -1,16 +1,394 @@
+import type { Activity } from '../models/Activity';
+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 { LeadSource } from '../models/LeadSource';
 import type { Organization } from '../models/Organization';
+import type { PaginatedActivityList } from '../models/PaginatedActivityList';
+import type { PaginatedDealList } from '../models/PaginatedDealList';
+import type { PaginatedLeadSourceList } from '../models/PaginatedLeadSourceList';
 import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationList';
 import type { PaginatedPersonList } from '../models/PaginatedPersonList';
+import type { PaginatedPipelineList } from '../models/PaginatedPipelineList';
+import type { PaginatedPipelineStageList } from '../models/PaginatedPipelineStageList';
+import type { PatchedActivity } from '../models/PatchedActivity';
+import type { PatchedDeal } from '../models/PatchedDeal';
+import type { PatchedLeadSource } from '../models/PatchedLeadSource';
 import type { PatchedOrganization } from '../models/PatchedOrganization';
 import type { PatchedPerson } from '../models/PatchedPerson';
+import type { PatchedPipeline } from '../models/PatchedPipeline';
+import type { PatchedPipelineStage } from '../models/PatchedPipelineStage';
 import type { Person } from '../models/Person';
 import type { PersonInviteRequest } from '../models/PersonInviteRequest';
 import type { PersonInviteResponse } from '../models/PersonInviteResponse';
 import type { PersonLinkUserRequest } from '../models/PersonLinkUserRequest';
 import type { PersonMergeRequest } from '../models/PersonMergeRequest';
 import type { PersonMergeResponse } from '../models/PersonMergeResponse';
+import type { Pipeline } from '../models/Pipeline';
+import type { PipelineStage } from '../models/PipelineStage';
 import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class CrmService {
+    /**
+     * List activities
+     * Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, schedule-from ranges, and `metadata__has_key`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/list`.
+     * @returns PaginatedActivityList
+     * @throws ApiError
+     */
+    static crmActivitiesList({ deal, isDone, metadataHasKey, owner, page, pageSize, person, scheduleFromGte, scheduleFromLte, type, }: {
+        deal?: number;
+        isDone?: boolean;
+        metadataHasKey?: string;
+        owner?: number;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+        person?: string;
+        scheduleFromGte?: string;
+        scheduleFromLte?: string;
+        /**
+         * Interaction kind.
+         *
+         * * `call` - Call
+         * * `meeting` - Meeting
+         * * `email` - Email
+         * * `note` - Note
+         * * `task` - Task
+         * * `lunch` - Lunch
+         * * `deadline` - Deadline
+         */
+        type?: 'call' | 'deadline' | 'email' | 'lunch' | 'meeting' | 'note' | 'task';
+    }): CancelablePromise<PaginatedActivityList>;
+    /**
+     * Create an activity
+     * Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static crmActivitiesCreate({ requestBody, }: {
+        requestBody: Activity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Retrieve an activity
+     * Returns a single Activity by id.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/read`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static crmActivitiesRetrieve({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<Activity>;
+    /**
+     * Replace an activity
+     * Replaces all editable fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static crmActivitiesUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+        requestBody: Activity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Update an activity
+     * Updates only the supplied fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static crmActivitiesPartialUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+        requestBody?: PatchedActivity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Delete an activity
+     * Deletes the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static crmActivitiesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<void>;
+    /**
+     * Mark an activity as done
+     * Flips `is_done=True` and stamps `done_at` if it isn't already set. Idempotent — calling on an already-done Activity preserves the original `done_at`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static crmActivitiesDoneCreate({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<Activity>;
+    /**
+     * 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 crmDealsList({ 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 crmDealsCreate({ 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 crmDealsRetrieve({ 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 crmDealsUpdate({ 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 crmDealsPartialUpdate({ 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 crmDealsDestroy({ 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 crmDealsLostCreate({ 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 crmDealsMoveStageCreate({ 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 crmDealsWonCreate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number;
+        requestBody?: DealWonRequest;
+    }): CancelablePromise<Deal>;
+    /**
+     * List lead sources
+     * Returns a paginated list of LeadSources in your Platform.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/list`.
+     * @returns PaginatedLeadSourceList
+     * @throws ApiError
+     */
+    static crmLeadSourcesList({ 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 crmLeadSourcesCreate({ 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 crmLeadSourcesRetrieve({ 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 crmLeadSourcesUpdate({ 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 crmLeadSourcesPartialUpdate({ 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 crmLeadSourcesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number;
+    }): CancelablePromise<void>;
     /**
      * List organizations
      * Returns a paginated list of organizations in your Platform. Supports filtering by `owner` and by `name` (case-insensitive substring match).
@@ -100,7 +478,7 @@ export declare class CrmService {
         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
@@ -219,4 +597,178 @@ export declare class CrmService {
     static crmPersonsMergeCreate({ requestBody, }: {
         requestBody: PersonMergeRequest;
     }): CancelablePromise<PersonMergeResponse>;
+    /**
+     * 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 crmPipelinesList({ 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 crmPipelinesCreate({ 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 crmPipelinesStagesList({ 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 crmPipelinesStagesCreate({ 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 crmPipelinesStagesRetrieve({ 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 crmPipelinesStagesUpdate({ 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 crmPipelinesStagesPartialUpdate({ 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 crmPipelinesStagesDestroy({ 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 crmPipelinesRetrieve({ 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 crmPipelinesUpdate({ 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 crmPipelinesPartialUpdate({ 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 crmPipelinesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this pipeline.
+         */
+        id: number;
+    }): CancelablePromise<void>;
 }