@iblai/iblai-api 4.266.0-core → 4.267.0-core

package/src/services/CrmService.ts

@@ -2,6 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { _TagAttachRequest } from '../models/_TagAttachRequest';
 import type { Activity } from '../models/Activity';
 import type { Deal } from '../models/Deal';
 import type { DealLostRequest } from '../models/DealLostRequest';
@@ -16,6 +17,7 @@ import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationL
 import type { PaginatedPersonList } from '../models/PaginatedPersonList';
 import type { PaginatedPipelineList } from '../models/PaginatedPipelineList';
 import type { PaginatedPipelineStageList } from '../models/PaginatedPipelineStageList';
+import type { PaginatedTagList } from '../models/PaginatedTagList';
 import type { PatchedActivity } from '../models/PatchedActivity';
 import type { PatchedDeal } from '../models/PatchedDeal';
 import type { PatchedLeadSource } from '../models/PatchedLeadSource';
@@ -23,6 +25,7 @@ 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 { PatchedTag } from '../models/PatchedTag';
 import type { Person } from '../models/Person';
 import type { PersonInviteRequest } from '../models/PersonInviteRequest';
 import type { PersonInviteResponse } from '../models/PersonInviteResponse';
@@ -31,6 +34,7 @@ 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 { Tag } from '../models/Tag';
 import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
@@ -108,7 +112,7 @@ export class CrmService {
      * 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`.
+     * **Required permission:** `Ibl.CRM/Activities/action`.
      * @returns Activity
      * @throws ApiError
      */
@@ -124,7 +128,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Activities/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Activities/action\`.`,
             },
         });
     }
@@ -301,6 +305,7 @@ export class CrmService {
         source,
         stage,
         status,
+        tags,
     }: {
         createdAtGte?: string,
         createdAtLte?: string,
@@ -329,6 +334,7 @@ export class CrmService {
          * * `lost` - Lost
          */
         status?: 'lost' | 'open' | 'won',
+        tags?: string,
     }): CancelablePromise<PaginatedDealList> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -348,6 +354,7 @@ export class CrmService {
                 'source': source,
                 'stage': stage,
                 'status': status,
+                'tags': tags,
             },
             errors: {
                 401: `Authentication required.`,
@@ -359,7 +366,7 @@ export class CrmService {
      * 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`.
+     * **Required permission:** `Ibl.CRM/Deals/action`.
      * @returns Deal
      * @throws ApiError
      */
@@ -375,7 +382,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Deals/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Deals/action\`.`,
             },
         });
     }
@@ -567,6 +574,71 @@ export class CrmService {
             },
         });
     }
+    /**
+     * Attach a tag to this record
+     * Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static crmDealsTagsCreate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        requestBody: _TagAttachRequest,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/crm/deals/{id}/tags/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `No response body`,
+                403: `No response body`,
+                404: `No response body`,
+                409: `No response body`,
+            },
+        });
+    }
+    /**
+     * Detach a tag from this record
+     * Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static crmDealsTagsDestroy({
+        id,
+        tagId,
+    }: {
+        /**
+         * A unique integer value identifying this deal.
+         */
+        id: number,
+        tagId: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/crm/deals/{id}/tags/{tag_id}/',
+            path: {
+                'id': id,
+                'tag_id': tagId,
+            },
+            errors: {
+                403: `No response body`,
+                404: `No response body`,
+            },
+        });
+    }
     /**
      * 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.
@@ -644,7 +716,7 @@ export class CrmService {
      * Create a lead source
      * Creates a new LeadSource in your Platform. `code` must be unique.
      *
-     * **Required permission:** `Ibl.CRM/Pipelines/write`.
+     * **Required permission:** `Ibl.CRM/Pipelines/action`.
      * @returns LeadSource
      * @throws ApiError
      */
@@ -660,7 +732,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
             },
         });
     }
@@ -799,6 +871,7 @@ export class CrmService {
         owner,
         page,
         pageSize,
+        tags,
     }: {
         name?: string,
         owner?: number,
@@ -810,6 +883,7 @@ export class CrmService {
          * Number of results to return per page.
          */
         pageSize?: number,
+        tags?: string,
     }): CancelablePromise<PaginatedOrganizationList> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -819,6 +893,7 @@ export class CrmService {
                 'owner': owner,
                 'page': page,
                 'page_size': pageSize,
+                'tags': tags,
             },
             errors: {
                 401: `Authentication required.`,
@@ -830,7 +905,7 @@ export class CrmService {
      * Create an organization
      * Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
      *
-     * **Required permission:** `Ibl.CRM/Organizations/write`.
+     * **Required permission:** `Ibl.CRM/Organizations/action`.
      * @returns Organization
      * @throws ApiError
      */
@@ -846,7 +921,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error (for example, duplicate name).`,
-                403: `Missing required permission \`Ibl.CRM/Organizations/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`,
             },
         });
     }
@@ -960,6 +1035,65 @@ export class CrmService {
             },
         });
     }
+    /**
+     * Attach a tag to this record
+     * Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static crmOrganizationsTagsCreate({
+        id,
+        requestBody,
+    }: {
+        id: string,
+        requestBody: _TagAttachRequest,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/crm/organizations/{id}/tags/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `No response body`,
+                403: `No response body`,
+                404: `No response body`,
+                409: `No response body`,
+            },
+        });
+    }
+    /**
+     * Detach a tag from this record
+     * Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static crmOrganizationsTagsDestroy({
+        id,
+        tagId,
+    }: {
+        id: string,
+        tagId: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/crm/organizations/{id}/tags/{tag_id}/',
+            path: {
+                'id': id,
+                'tag_id': tagId,
+            },
+            errors: {
+                403: `No response body`,
+                404: `No response body`,
+            },
+        });
+    }
     /**
      * List persons
      * Returns a paginated list of persons in your Platform. Supports filtering by `lifecycle_stage`, `owner`, `organization`, `created_at__gte`/`created_at__lte`, and `metadata__has_key`.
@@ -977,6 +1111,7 @@ export class CrmService {
         owner,
         page,
         pageSize,
+        tags,
     }: {
         createdAtGte?: string,
         createdAtLte?: string,
@@ -1001,6 +1136,7 @@ export class CrmService {
          * Number of results to return per page.
          */
         pageSize?: number,
+        tags?: string,
     }): CancelablePromise<PaginatedPersonList> {
         return __request(OpenAPI, {
             method: 'GET',
@@ -1014,6 +1150,7 @@ export class CrmService {
                 'owner': owner,
                 'page': page,
                 'page_size': pageSize,
+                'tags': tags,
             },
             errors: {
                 401: `Authentication required.`,
@@ -1025,7 +1162,7 @@ export class CrmService {
      * Create a person
      * Creates a new person in your Platform. The Platform is inferred from your credentials. If `organization` is supplied, it must reference an organization in your Platform.
      *
-     * **Required permission:** `Ibl.CRM/Persons/write`.
+     * **Required permission:** `Ibl.CRM/Persons/action`.
      * @returns Person
      * @throws ApiError
      */
@@ -1041,7 +1178,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Persons/action\`.`,
             },
         });
     }
@@ -1220,6 +1357,65 @@ export class CrmService {
             },
         });
     }
+    /**
+     * Attach a tag to this record
+     * Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static crmPersonsTagsCreate({
+        id,
+        requestBody,
+    }: {
+        id: string,
+        requestBody: _TagAttachRequest,
+    }): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/crm/persons/{id}/tags/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `No response body`,
+                403: `No response body`,
+                404: `No response body`,
+                409: `No response body`,
+            },
+        });
+    }
+    /**
+     * Detach a tag from this record
+     * Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static crmPersonsTagsDestroy({
+        id,
+        tagId,
+    }: {
+        id: string,
+        tagId: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/crm/persons/{id}/tags/{tag_id}/',
+            path: {
+                'id': id,
+                'tag_id': tagId,
+            },
+            errors: {
+                403: `No response body`,
+                404: `No response body`,
+            },
+        });
+    }
     /**
      * Merge duplicate persons into a primary
      * Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
@@ -1294,7 +1490,7 @@ export class CrmService {
      * 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`.
+     * **Required permission:** `Ibl.CRM/Pipelines/action`.
      * @returns Pipeline
      * @throws ApiError
      */
@@ -1310,7 +1506,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
             },
         });
     }
@@ -1366,7 +1562,7 @@ export class CrmService {
      * 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`.
+     * **Required permission:** `Ibl.CRM/Pipelines/action`.
      * @returns PipelineStage
      * @throws ApiError
      */
@@ -1387,7 +1583,7 @@ export class CrmService {
             mediaType: 'application/json',
             errors: {
                 400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
+                403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
                 404: `Pipeline not found.`,
             },
         });
@@ -1638,4 +1834,193 @@ export class CrmService {
             },
         });
     }
+    /**
+     * List tags
+     * Returns a paginated list of Tags in your Platform. Supports filtering by `name` (case-insensitive substring) and `created_at__gte`/`created_at__lte` ISO timestamp ranges.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/list`.
+     * @returns PaginatedTagList
+     * @throws ApiError
+     */
+    public static crmTagsList({
+        createdAtGte,
+        createdAtLte,
+        name,
+        page,
+        pageSize,
+    }: {
+        createdAtGte?: string,
+        createdAtLte?: string,
+        name?: string,
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number,
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number,
+    }): CancelablePromise<PaginatedTagList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/crm/tags/',
+            query: {
+                'created_at__gte': createdAtGte,
+                'created_at__lte': createdAtLte,
+                'name': name,
+                'page': page,
+                'page_size': pageSize,
+            },
+            errors: {
+                401: `Authentication required.`,
+                403: `Missing required permission \`Ibl.CRM/Tags/list\`.`,
+            },
+        });
+    }
+    /**
+     * Create a tag
+     * Creates a new Tag in your Platform. `name` must be unique within your Platform; supply `color` as a `#RRGGBB` hex string (defaults to `#888888`).
+     *
+     * **Required permission:** `Ibl.CRM/Tags/action`.
+     * @returns Tag
+     * @throws ApiError
+     */
+    public static crmTagsCreate({
+        requestBody,
+    }: {
+        requestBody: Tag,
+    }): CancelablePromise<Tag> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/crm/tags/',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error (duplicate name, bad color, etc.).`,
+                403: `Missing required permission \`Ibl.CRM/Tags/action\`.`,
+            },
+        });
+    }
+    /**
+     * Retrieve a tag
+     * Returns a single Tag by id.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/read`.
+     * @returns Tag
+     * @throws ApiError
+     */
+    public static crmTagsRetrieve({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this tag.
+         */
+        id: number,
+    }): CancelablePromise<Tag> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/crm/tags/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Tags/read\`.`,
+                404: `Tag not found.`,
+            },
+        });
+    }
+    /**
+     * Replace a tag
+     * Replaces all editable fields on the Tag.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns Tag
+     * @throws ApiError
+     */
+    public static crmTagsUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this tag.
+         */
+        id: number,
+        requestBody: Tag,
+    }): CancelablePromise<Tag> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/crm/tags/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
+                404: `Tag not found.`,
+            },
+        });
+    }
+    /**
+     * Update a tag
+     * Updates only the supplied fields on the Tag (typically `name` or `color`).
+     *
+     * **Required permission:** `Ibl.CRM/Tags/write`.
+     * @returns Tag
+     * @throws ApiError
+     */
+    public static crmTagsPartialUpdate({
+        id,
+        requestBody,
+    }: {
+        /**
+         * A unique integer value identifying this tag.
+         */
+        id: number,
+        requestBody?: PatchedTag,
+    }): CancelablePromise<Tag> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/crm/tags/{id}/',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Validation error.`,
+                403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
+                404: `Tag not found.`,
+            },
+        });
+    }
+    /**
+     * Delete a tag
+     * Deletes the Tag. All attachments to Persons, Organizations, and Deals are removed atomically via cascade.
+     *
+     * **Required permission:** `Ibl.CRM/Tags/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    public static crmTagsDestroy({
+        id,
+    }: {
+        /**
+         * A unique integer value identifying this tag.
+         */
+        id: number,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/crm/tags/{id}/',
+            path: {
+                'id': id,
+            },
+            errors: {
+                403: `Missing required permission \`Ibl.CRM/Tags/delete\`.`,
+                404: `Tag not found.`,
+            },
+        });
+    }
 }