@iblai/iblai-api 4.288.1-core → 4.289.0-core

package/src/services/OrganizationsService.ts

@@ -1,249 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { _TagAttachRequest } from '../models/_TagAttachRequest';
-import type { Organization } from '../models/Organization';
-import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationList';
-import type { PatchedOrganization } from '../models/PatchedOrganization';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class OrganizationsService {
-    /**
-     * List organizations
-     * Returns a paginated list of organizations in your Platform. Supports filtering by `owner` and by `name` (case-insensitive substring match).
-     *
-     * **Required permission:** `Ibl.CRM/Organizations/list`.
-     * @returns PaginatedOrganizationList
-     * @throws ApiError
-     */
-    public static organizationsList({
-        name,
-        owner,
-        page,
-        pageSize,
-        tags,
-    }: {
-        name?: string,
-        owner?: number,
-        /**
-         * A page number within the paginated result set.
-         */
-        page?: number,
-        /**
-         * Number of results to return per page.
-         */
-        pageSize?: number,
-        tags?: string,
-    }): CancelablePromise<PaginatedOrganizationList> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/organizations/',
-            query: {
-                'name': name,
-                'owner': owner,
-                'page': page,
-                'page_size': pageSize,
-                'tags': tags,
-            },
-            errors: {
-                401: `Authentication required.`,
-                403: `Missing required permission \`Ibl.CRM/Organizations/list\`.`,
-            },
-        });
-    }
-    /**
-     * 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/action`.
-     * @returns Organization
-     * @throws ApiError
-     */
-    public static organizationsCreate({
-        requestBody,
-    }: {
-        requestBody: Organization,
-    }): CancelablePromise<Organization> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/organizations/',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error (for example, duplicate name).`,
-                403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`,
-            },
-        });
-    }
-    /**
-     * Retrieve an organization
-     * Returns a single organization by id.
-     *
-     * **Required permission:** `Ibl.CRM/Organizations/read`.
-     * @returns Organization
-     * @throws ApiError
-     */
-    public static organizationsRetrieve({
-        id,
-    }: {
-        id: string,
-    }): CancelablePromise<Organization> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/organizations/{id}/',
-            path: {
-                'id': id,
-            },
-            errors: {
-                403: `Missing required permission \`Ibl.CRM/Organizations/read\`.`,
-                404: `Organization not found.`,
-            },
-        });
-    }
-    /**
-     * Replace an organization
-     * Replaces all editable fields on the organization.
-     *
-     * **Required permission:** `Ibl.CRM/Organizations/write`.
-     * @returns Organization
-     * @throws ApiError
-     */
-    public static organizationsUpdate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody: Organization,
-    }): CancelablePromise<Organization> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/organizations/{id}/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Organizations/write\`.`,
-                404: `Organization not found.`,
-            },
-        });
-    }
-    /**
-     * Update an organization
-     * Updates only the supplied fields on the organization.
-     *
-     * **Required permission:** `Ibl.CRM/Organizations/write`.
-     * @returns Organization
-     * @throws ApiError
-     */
-    public static organizationsPartialUpdate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody?: PatchedOrganization,
-    }): CancelablePromise<Organization> {
-        return __request(OpenAPI, {
-            method: 'PATCH',
-            url: '/organizations/{id}/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Organizations/write\`.`,
-                404: `Organization not found.`,
-            },
-        });
-    }
-    /**
-     * Delete an organization
-     * Deletes the organization. Any persons linked to it are kept; their organization reference is cleared.
-     *
-     * **Required permission:** `Ibl.CRM/Organizations/delete`.
-     * @returns void
-     * @throws ApiError
-     */
-    public static organizationsDestroy({
-        id,
-    }: {
-        id: string,
-    }): CancelablePromise<void> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/organizations/{id}/',
-            path: {
-                'id': id,
-            },
-            errors: {
-                403: `Missing required permission \`Ibl.CRM/Organizations/delete\`.`,
-                404: `Organization not found.`,
-            },
-        });
-    }
-    /**
-     * 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 organizationsTagsCreate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody: _TagAttachRequest,
-    }): CancelablePromise<any> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/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 organizationsTagsDestroy({
-        id,
-        tagId,
-    }: {
-        id: string,
-        tagId: string,
-    }): CancelablePromise<void> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/organizations/{id}/tags/{tag_id}/',
-            path: {
-                'id': id,
-                'tag_id': tagId,
-            },
-            errors: {
-                403: `No response body`,
-                404: `No response body`,
-            },
-        });
-    }
-}

package/src/services/PersonsService.ts

@@ -1,367 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { _TagAttachRequest } from '../models/_TagAttachRequest';
-import type { PaginatedPersonList } from '../models/PaginatedPersonList';
-import type { PatchedPerson } from '../models/PatchedPerson';
-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 { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class PersonsService {
-    /**
-     * 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`.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/list`.
-     * @returns PaginatedPersonList
-     * @throws ApiError
-     */
-    public static personsList({
-        createdAtGte,
-        createdAtLte,
-        lifecycleStage,
-        metadataHasKey,
-        organization,
-        owner,
-        page,
-        pageSize,
-        tags,
-    }: {
-        createdAtGte?: string,
-        createdAtLte?: string,
-        /**
-         * Funnel position. Transitions are unrestricted — any stage may move to any other.
-         *
-         * * `lead` - Lead
-         * * `qualified` - Qualified
-         * * `opportunity` - Opportunity
-         * * `customer` - Customer
-         * * `churned` - Churned
-         */
-        lifecycleStage?: 'churned' | 'customer' | 'lead' | 'opportunity' | 'qualified',
-        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,
-        tags?: string,
-    }): CancelablePromise<PaginatedPersonList> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/persons/',
-            query: {
-                'created_at__gte': createdAtGte,
-                'created_at__lte': createdAtLte,
-                'lifecycle_stage': lifecycleStage,
-                'metadata__has_key': metadataHasKey,
-                'organization': organization,
-                'owner': owner,
-                'page': page,
-                'page_size': pageSize,
-                'tags': tags,
-            },
-            errors: {
-                401: `Authentication required.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/list\`.`,
-            },
-        });
-    }
-    /**
-     * 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/action`.
-     * @returns Person
-     * @throws ApiError
-     */
-    public static personsCreate({
-        requestBody,
-    }: {
-        requestBody: Person,
-    }): CancelablePromise<Person> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/persons/',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/action\`.`,
-            },
-        });
-    }
-    /**
-     * Retrieve a person
-     * Returns a single person by id.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/read`.
-     * @returns Person
-     * @throws ApiError
-     */
-    public static personsRetrieve({
-        id,
-    }: {
-        id: string,
-    }): CancelablePromise<Person> {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/persons/{id}/',
-            path: {
-                'id': id,
-            },
-            errors: {
-                403: `Missing required permission \`Ibl.CRM/Persons/read\`.`,
-                404: `Person not found.`,
-            },
-        });
-    }
-    /**
-     * Replace a person
-     * Replaces all editable fields on the person.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/write`.
-     * @returns Person
-     * @throws ApiError
-     */
-    public static personsUpdate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody: Person,
-    }): CancelablePromise<Person> {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/persons/{id}/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/write\`.`,
-                404: `Person not found.`,
-            },
-        });
-    }
-    /**
-     * Update a person
-     * Updates only the supplied fields on the person.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/write`.
-     * @returns Person
-     * @throws ApiError
-     */
-    public static personsPartialUpdate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody?: PatchedPerson,
-    }): CancelablePromise<Person> {
-        return __request(OpenAPI, {
-            method: 'PATCH',
-            url: '/persons/{id}/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/write\`.`,
-                404: `Person not found.`,
-            },
-        });
-    }
-    /**
-     * Delete a person
-     * Deletes the person.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/delete`.
-     * @returns void
-     * @throws ApiError
-     */
-    public static personsDestroy({
-        id,
-    }: {
-        id: string,
-    }): CancelablePromise<void> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/persons/{id}/',
-            path: {
-                'id': id,
-            },
-            errors: {
-                403: `Missing required permission \`Ibl.CRM/Persons/delete\`.`,
-                404: `Person not found.`,
-            },
-        });
-    }
-    /**
-     * Invite a person to the platform
-     * Sends a platform invitation to the person's `primary_email`. On acceptance, the invitee joins your Platform with the privileges configured in the request body.
-     *
-     * Returns `409 Conflict` if an active invitation already exists for this email in your Platform, and `422 Unprocessable Entity` if the person is already linked to a platform user.
-     *
-     * **Required permission:** `Ibl.CRM/Invite/action`.
-     * @returns PersonInviteResponse
-     * @throws ApiError
-     */
-    public static personsInviteCreate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody?: PersonInviteRequest,
-    }): CancelablePromise<PersonInviteResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/persons/{id}/invite/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Person has no \`primary_email\`; cannot invite.`,
-                403: `Missing required permission \`Ibl.CRM/Invite/action\`.`,
-                404: `Person not found.`,
-                422: `Person is already linked to a platform user.`,
-            },
-        });
-    }
-    /**
-     * Bind a person to an existing platform user
-     * Links this person to an existing platform user. The target user must already be a member of your Platform — if they are not, send them an invitation via `POST /persons/{id}/invite/` instead.
-     *
-     * This call is idempotent: linking a person that is already bound to the same user is a no-op. Re-linking a person that is already bound to a *different* user is refused; the existing binding is preserved and the unchanged person is returned.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/write`.
-     * @returns Person
-     * @throws ApiError
-     */
-    public static personsLinkUserCreate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody: PersonLinkUserRequest,
-    }): CancelablePromise<Person> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/persons/{id}/link-user/',
-            path: {
-                'id': id,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/write\`, or the target user is not a member of your Platform.`,
-                404: `Person or user not found.`,
-            },
-        });
-    }
-    /**
-     * 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 personsTagsCreate({
-        id,
-        requestBody,
-    }: {
-        id: string,
-        requestBody: _TagAttachRequest,
-    }): CancelablePromise<any> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/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 personsTagsDestroy({
-        id,
-        tagId,
-    }: {
-        id: string,
-        tagId: string,
-    }): CancelablePromise<void> {
-        return __request(OpenAPI, {
-            method: 'DELETE',
-            url: '/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`.
-     *
-     * All ids — both the primary and every duplicate — must belong to your Platform. `primary_id` may not appear in `duplicate_ids`.
-     *
-     * **Required permission:** `Ibl.CRM/Persons/write`.
-     * @returns PersonMergeResponse
-     * @throws ApiError
-     */
-    public static personsMergeCreate({
-        requestBody,
-    }: {
-        requestBody: PersonMergeRequest,
-    }): CancelablePromise<PersonMergeResponse> {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/persons/merge/',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Validation error: the primary appears in duplicates, or one or more ids belong to another Platform.`,
-                403: `Missing required permission \`Ibl.CRM/Persons/write\`.`,
-                404: `Primary person not found.`,
-            },
-        });
-    }
-}