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

package/src/services/DealsService.ts

@@ -0,0 +1,337 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export 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
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/deals/',
+            query: {
+                'created_at__gte': createdAtGte,
+                'created_at__lte': createdAtLte,
+                'expected_close_date__gte': expectedCloseDateGte,
+                'expected_close_date__lte': expectedCloseDateLte,
+                'metadata__has_key': metadataHasKey,
+                'organization': organization,
+                'owner': owner,
+                'page': page,
+                'page_size': pageSize,
+                'person': person,
+                'pipeline': pipeline,
+                'source': source,
+                'stage': stage,
+                'status': status,
+            },
+            errors: {
+                401: `Authentication required.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/list\`.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static dealsCreate({
+        requestBody,
+    }: {
+        requestBody: Deal,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/deals/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+            },
+        });
+    }
+    /**
+     * Retrieve a deal
+     * Returns a single Deal by id.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/read`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    public static dealsRetrieve({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/deals/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Deals/read\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+    /**
+     * Replace a deal
+     * Replaces all editable fields on the Deal.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/write`.
+     * @returns Deal
+     * @throws ApiError
+     */
+    public static dealsUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody: Deal,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/deals/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static dealsPartialUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody?: PatchedDeal,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/deals/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+    /**
+     * Delete a deal
+     * Deletes the Deal.
+     *
+     * **Required permission:** `Ibl.CRM/Deals/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static dealsDestroy({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/deals/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Deals/delete\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static dealsLostCreate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody: DealLostRequest,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/deals/{id}/lost/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Missing \`lost_reason\`, no \`is_lost\` stage configured, or the supplied stage_code is not flagged is_lost=True.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static dealsMoveStageCreate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody?: DealMoveStageRequest,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/deals/{id}/move-stage/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error (e.g. stage not in pipeline).`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                404: `Deal or stage not found.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static dealsWonCreate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody?: DealWonRequest,
+    }): CancelablePromise<Deal> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/deals/{id}/won/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `No \`is_won\` stage configured, or the supplied stage_code is not flagged is_won=True.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                404: `Deal not found.`,
+            },
+        });
+    }
+}

package/src/services/LeadSourcesService.ts

@@ -0,0 +1,198 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LeadSource } from '../models/LeadSource';
+import type { PaginatedLeadSourceList } from '../models/PaginatedLeadSourceList';
+import type { PatchedLeadSource } from '../models/PatchedLeadSource';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class LeadSourcesService {
+    /**
+     * List lead sources
+     * Returns a paginated list of LeadSources in your Platform.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/list`.
+     * @returns PaginatedLeadSourceList
+     * @throws ApiError
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/lead-sources/',
+            query: {
+                'code': code,
+                'name': name,
+                'page': page,
+                'page_size': pageSize,
+            },
+            errors: {
+                401: `Authentication required.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/list\`.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static leadSourcesCreate({
+        requestBody,
+    }: {
+        requestBody: LeadSource,
+    }): CancelablePromise<LeadSource> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/lead-sources/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+            },
+        });
+    }
+    /**
+     * Retrieve a lead source
+     * Returns a single LeadSource by id.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/read`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    public static leadSourcesRetrieve({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number,
+    }): CancelablePromise<LeadSource> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/lead-sources/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/read\`.`,
+                404: `LeadSource not found.`,
+            },
+        });
+    }
+    /**
+     * Replace a lead source
+     * Replaces all editable fields on the LeadSource.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    public static leadSourcesUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number,
+        requestBody: LeadSource,
+    }): CancelablePromise<LeadSource> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/lead-sources/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `LeadSource not found.`,
+            },
+        });
+    }
+    /**
+     * Update a lead source
+     * Updates only the supplied fields on the LeadSource.
+     *
+     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * @returns LeadSource
+     * @throws ApiError
+     */
+    public static leadSourcesPartialUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number,
+        requestBody?: PatchedLeadSource,
+    }): CancelablePromise<LeadSource> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/lead-sources/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                404: `LeadSource not found.`,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static leadSourcesDestroy({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this lead source.
+         */
+        id: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/lead-sources/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Pipelines/delete\`.`,
+                404: `LeadSource not found.`,
+            },
+        });
+    }
+}

package/src/services/PersonsService.ts

@@ -35,7 +35,7 @@ export 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