@iblai/iblai-api 4.415.0-core → 4.416.0-core

package/dist/types/models/PatchedSavedView.d.ts

@@ -0,0 +1,41 @@
+import type { _Column } from './_Column';
+import type { _Filter } from './_Filter';
+import type { _Sort } from './_Sort';
+import type { ObjectTypeEnum } from './ObjectTypeEnum';
+import type { SavedViewTypeEnum } from './SavedViewTypeEnum';
+export type PatchedSavedView = {
+    readonly id?: number;
+    /**
+     * Tenant this view belongs to.
+     */
+    readonly platform?: number;
+    /**
+     * The list this view belongs to.
+     *
+     * * `persons` - Persons
+     * * `organizations` - Organizations
+     * * `deals` - Deals
+     * * `activities` - Activities
+     */
+    object_type?: ObjectTypeEnum;
+    /**
+     * Unique per user and list.
+     */
+    name?: string;
+    /**
+     * `kanban` is available for deals only.
+     *
+     * * `table` - Table
+     * * `kanban` - Kanban
+     */
+    type?: SavedViewTypeEnum;
+    columns?: Array<_Column>;
+    filters?: Array<_Filter>;
+    sorts?: Array<_Sort>;
+    /**
+     * Kanban column field (e.g. `stage`).
+     */
+    group_by?: string;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

package/dist/types/models/Person.d.ts

@@ -39,6 +39,10 @@ export type Person = {
      * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
      */
     organization?: string | null;
+    /**
+     * The organization's name, or null.
+     */
+    readonly organization_name: string | null;
     /**
      * Id of the platform user who owns / manages this person (internal account manager). Optional.
      */

package/dist/types/models/Pipeline.d.ts

@@ -21,7 +21,7 @@ export type Pipeline = {
      */
     is_default?: boolean;
     /**
-     * Days a Deal can sit in a stage before it's surfaced as stale.
+     * Days without a change before an open Deal shows `is_stale`; 0 turns it off.
      */
     rotten_days?: number;
     readonly stages: Array<PipelineStage>;

package/dist/types/models/PipelineStageReorderRequest.d.ts

@@ -0,0 +1,6 @@
+export type PipelineStageReorderRequest = {
+    /**
+     * Every stage id of the Pipeline, in the new left-to-right order.
+     */
+    order: Array<number>;
+};

package/dist/types/models/SavedView.d.ts

@@ -0,0 +1,41 @@
+import type { _Column } from './_Column';
+import type { _Filter } from './_Filter';
+import type { _Sort } from './_Sort';
+import type { ObjectTypeEnum } from './ObjectTypeEnum';
+import type { SavedViewTypeEnum } from './SavedViewTypeEnum';
+export type SavedView = {
+    readonly id: number;
+    /**
+     * Tenant this view belongs to.
+     */
+    readonly platform: number;
+    /**
+     * The list this view belongs to.
+     *
+     * * `persons` - Persons
+     * * `organizations` - Organizations
+     * * `deals` - Deals
+     * * `activities` - Activities
+     */
+    object_type: ObjectTypeEnum;
+    /**
+     * Unique per user and list.
+     */
+    name: string;
+    /**
+     * `kanban` is available for deals only.
+     *
+     * * `table` - Table
+     * * `kanban` - Kanban
+     */
+    type?: SavedViewTypeEnum;
+    columns?: Array<_Column>;
+    filters?: Array<_Filter>;
+    sorts?: Array<_Sort>;
+    /**
+     * Kanban column field (e.g. `stage`).
+     */
+    group_by?: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

package/dist/types/models/SavedViewTypeEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * * `table` - Table
+ * * `kanban` - Kanban
+ */
+export declare enum SavedViewTypeEnum {
+    TABLE = "table",
+    KANBAN = "kanban"
+}

package/dist/types/models/SearchDeal.d.ts

@@ -0,0 +1,40 @@
+import type { Status05cEnum } from './Status05cEnum';
+export type SearchDeal = {
+    readonly id: number;
+    /**
+     * Short display name (e.g. 'Acme renewal — 2026').
+     */
+    title: string;
+    /**
+     * Service-managed (read-only in serializer). Derived from the destination stage's is_won/is_lost.
+     *
+     * * `open` - Open
+     * * `won` - Won
+     * * `lost` - Lost
+     */
+    status?: Status05cEnum;
+    /**
+     * Estimated deal value in `currency`.
+     */
+    lead_value?: string;
+    /**
+     * ISO 4217 currency code.
+     */
+    currency?: string;
+    /**
+     * Primary contact for this Deal. PROTECTed — can't delete a Person with open Deals.
+     */
+    person: string;
+    /**
+     * Organization the Deal is with (nullable for solo-individual deals).
+     */
+    organization?: string | null;
+    /**
+     * Pipeline this Deal flows through.
+     */
+    pipeline: number;
+    /**
+     * Current stage. Must belong to `pipeline`.
+     */
+    stage: number;
+};

package/dist/types/models/SearchOrganization.d.ts

@@ -0,0 +1,10 @@
+export type SearchOrganization = {
+    /**
+     * Opaque UUID — used in API URLs and external references.
+     */
+    readonly id: string;
+    /**
+     * Display name. Unique within the platform.
+     */
+    name: string;
+};

package/dist/types/models/SearchPerson.d.ts

@@ -0,0 +1,33 @@
+import type { LifecycleStageEnum } from './LifecycleStageEnum';
+export type SearchPerson = {
+    /**
+     * Opaque UUID — used in API URLs and external references.
+     */
+    readonly id: string;
+    /**
+     * Full display name.
+     */
+    name: string;
+    /**
+     * Email used by the Person→User auto-link query (case-insensitive match).
+     */
+    primary_email?: string;
+    /**
+     * Free-text job title at their Organization.
+     */
+    job_title?: string;
+    /**
+     * The Organization this Person belongs to (nullable).
+     */
+    organization?: string | null;
+    /**
+     * Funnel position. Transitions are unrestricted — any stage may move to any other.
+     *
+     * * `lead` - Lead
+     * * `qualified` - Qualified
+     * * `opportunity` - Opportunity
+     * * `customer` - Customer
+     * * `churned` - Churned
+     */
+    lifecycle_stage?: LifecycleStageEnum;
+};

package/dist/types/models/SearchResponse.d.ts

@@ -0,0 +1,12 @@
+import type { SearchDeal } from './SearchDeal';
+import type { SearchOrganization } from './SearchOrganization';
+import type { SearchPerson } from './SearchPerson';
+/**
+ * One bucket per resource the caller may list; an unlisted bucket is absent.
+ */
+export type SearchResponse = {
+    'q': string;
+    persons?: Array<SearchPerson>;
+    organizations?: Array<SearchOrganization>;
+    deals?: Array<SearchDeal>;
+};

package/dist/types/models/{DealStatusEnum.d.ts → Status05cEnum.d.ts}

@@ -3,7 +3,7 @@
  * * `won` - Won
  * * `lost` - Lost
  */
-export declare enum DealStatusEnum {
+export declare enum Status05cEnum {
     OPEN = "open",
     WON = "won",
     LOST = "lost"

package/dist/types/models/_Column.d.ts

@@ -0,0 +1,7 @@
+export type _Column = {
+    /**
+     * Field name shown as a column.
+     */
+    id: string;
+    visible?: boolean;
+};

package/dist/types/models/_Filter.d.ts

@@ -0,0 +1,8 @@
+export type _Filter = {
+    field: string;
+    /**
+     * e.g. `is`, `contains`, `gte`.
+     */
+    op: string;
+    value?: any;
+};

package/dist/types/models/_Sort.d.ts

@@ -0,0 +1,5 @@
+import type { DirEnum } from './DirEnum';
+export type _Sort = {
+    field: string;
+    dir?: DirEnum;
+};