@iblai/iblai-api 4.261.1-core → 4.262.0-core

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

@@ -0,0 +1,222 @@
+import type { Organization } from '../models/Organization';
+import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationList';
+import type { PaginatedPersonList } from '../models/PaginatedPersonList';
+import type { PatchedOrganization } from '../models/PatchedOrganization';
+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';
+export declare class CrmService {
+    /**
+     * 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
+     */
+    static crmOrganizationsList({ name, owner, page, pageSize, }: {
+        name?: string;
+        owner?: number;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<PaginatedOrganizationList>;
+    /**
+     * 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`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static crmOrganizationsCreate({ requestBody, }: {
+        requestBody: Organization;
+    }): CancelablePromise<Organization>;
+    /**
+     * Retrieve an organization
+     * Returns a single organization by id.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/read`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static crmOrganizationsRetrieve({ id, }: {
+        id: string;
+    }): CancelablePromise<Organization>;
+    /**
+     * Replace an organization
+     * Replaces all editable fields on the organization.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/write`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static crmOrganizationsUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody: Organization;
+    }): CancelablePromise<Organization>;
+    /**
+     * Update an organization
+     * Updates only the supplied fields on the organization.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/write`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static crmOrganizationsPartialUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PatchedOrganization;
+    }): CancelablePromise<Organization>;
+    /**
+     * 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
+     */
+    static crmOrganizationsDestroy({ id, }: {
+        id: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static crmPersonsList({ createdAtGte, createdAtLte, lifecycleStage, metadataHasKey, organization, owner, page, pageSize, }: {
+        createdAtGte?: string;
+        createdAtLte?: string;
+        /**
+         * Funnel position. Free-form transitions in v0.
+         *
+         * * `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;
+    }): CancelablePromise<PaginatedPersonList>;
+    /**
+     * 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`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static crmPersonsCreate({ requestBody, }: {
+        requestBody: Person;
+    }): CancelablePromise<Person>;
+    /**
+     * Retrieve a person
+     * Returns a single person by id.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/read`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static crmPersonsRetrieve({ id, }: {
+        id: string;
+    }): CancelablePromise<Person>;
+    /**
+     * Replace a person
+     * Replaces all editable fields on the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/write`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static crmPersonsUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody: Person;
+    }): CancelablePromise<Person>;
+    /**
+     * Update a person
+     * Updates only the supplied fields on the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/write`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static crmPersonsPartialUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PatchedPerson;
+    }): CancelablePromise<Person>;
+    /**
+     * Delete a person
+     * Deletes the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static crmPersonsDestroy({ id, }: {
+        id: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static crmPersonsInviteCreate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PersonInviteRequest;
+    }): CancelablePromise<PersonInviteResponse>;
+    /**
+     * 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
+     */
+    static crmPersonsLinkUserCreate({ id, requestBody, }: {
+        id: string;
+        requestBody: PersonLinkUserRequest;
+    }): CancelablePromise<Person>;
+    /**
+     * 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
+     */
+    static crmPersonsMergeCreate({ requestBody, }: {
+        requestBody: PersonMergeRequest;
+    }): CancelablePromise<PersonMergeResponse>;
+}

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

@@ -0,0 +1,83 @@
+import type { Organization } from '../models/Organization';
+import type { PaginatedOrganizationList } from '../models/PaginatedOrganizationList';
+import type { PatchedOrganization } from '../models/PatchedOrganization';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare 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
+     */
+    static organizationsList({ name, owner, page, pageSize, }: {
+        name?: string;
+        owner?: number;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<PaginatedOrganizationList>;
+    /**
+     * 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`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static organizationsCreate({ requestBody, }: {
+        requestBody: Organization;
+    }): CancelablePromise<Organization>;
+    /**
+     * Retrieve an organization
+     * Returns a single organization by id.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/read`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static organizationsRetrieve({ id, }: {
+        id: string;
+    }): CancelablePromise<Organization>;
+    /**
+     * Replace an organization
+     * Replaces all editable fields on the organization.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/write`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static organizationsUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody: Organization;
+    }): CancelablePromise<Organization>;
+    /**
+     * Update an organization
+     * Updates only the supplied fields on the organization.
+     *
+     * **Required permission:** `Ibl.CRM/Organizations/write`.
+     * @returns Organization
+     * @throws ApiError
+     */
+    static organizationsPartialUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PatchedOrganization;
+    }): CancelablePromise<Organization>;
+    /**
+     * 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
+     */
+    static organizationsDestroy({ id, }: {
+        id: string;
+    }): CancelablePromise<void>;
+}

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

@@ -0,0 +1,142 @@
+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';
+export declare 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
+     */
+    static personsList({ createdAtGte, createdAtLte, lifecycleStage, metadataHasKey, organization, owner, page, pageSize, }: {
+        createdAtGte?: string;
+        createdAtLte?: string;
+        /**
+         * Funnel position. Free-form transitions in v0.
+         *
+         * * `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;
+    }): CancelablePromise<PaginatedPersonList>;
+    /**
+     * 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`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static personsCreate({ requestBody, }: {
+        requestBody: Person;
+    }): CancelablePromise<Person>;
+    /**
+     * Retrieve a person
+     * Returns a single person by id.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/read`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static personsRetrieve({ id, }: {
+        id: string;
+    }): CancelablePromise<Person>;
+    /**
+     * Replace a person
+     * Replaces all editable fields on the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/write`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static personsUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody: Person;
+    }): CancelablePromise<Person>;
+    /**
+     * Update a person
+     * Updates only the supplied fields on the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/write`.
+     * @returns Person
+     * @throws ApiError
+     */
+    static personsPartialUpdate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PatchedPerson;
+    }): CancelablePromise<Person>;
+    /**
+     * Delete a person
+     * Deletes the person.
+     *
+     * **Required permission:** `Ibl.CRM/Persons/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static personsDestroy({ id, }: {
+        id: string;
+    }): CancelablePromise<void>;
+    /**
+     * 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
+     */
+    static personsInviteCreate({ id, requestBody, }: {
+        id: string;
+        requestBody?: PersonInviteRequest;
+    }): CancelablePromise<PersonInviteResponse>;
+    /**
+     * 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
+     */
+    static personsLinkUserCreate({ id, requestBody, }: {
+        id: string;
+        requestBody: PersonLinkUserRequest;
+    }): CancelablePromise<Person>;
+    /**
+     * 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
+     */
+    static personsMergeCreate({ requestBody, }: {
+        requestBody: PersonMergeRequest;
+    }): CancelablePromise<PersonMergeResponse>;
+}

package/package.json

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