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

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

@@ -0,0 +1,83 @@
+import type { ActivityTypeEnum } from './ActivityTypeEnum';
+export type PatchedActivity = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id?: number;
+    /**
+     * Platform this Activity belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform?: number;
+    /**
+     * Short summary (e.g. 'Discovery call', 'Stage changed').
+     */
+    title?: string;
+    /**
+     * Interaction kind. One of `call`, `meeting`, `email`, `note`, `task`, `lunch`, `deadline`.
+     *
+     * * `call` - Call
+     * * `meeting` - Meeting
+     * * `email` - Email
+     * * `note` - Note
+     * * `task` - Task
+     * * `lunch` - Lunch
+     * * `deadline` - Deadline
+     */
+    type?: ActivityTypeEnum;
+    /**
+     * Meeting location / call dial-in / venue.
+     */
+    location?: string;
+    /**
+     * Free-text notes.
+     */
+    comment?: string;
+    /**
+     * Scheduled start. Leave null for instant log entries.
+     */
+    schedule_from?: string | null;
+    /**
+     * Scheduled end.
+     */
+    schedule_to?: string | null;
+    /**
+     * Mark the Activity complete. Use `POST /activities/{id}/done/` to flip this and automatically stamp `done_at`.
+     */
+    is_done?: boolean;
+    /**
+     * Read-only. Set automatically the first time `is_done` flips True.
+     */
+    readonly done_at?: string | null;
+    /**
+     * Id of the Deal this Activity is logged against. Either `deal` or `person` is required.
+     */
+    deal?: number | null;
+    /**
+     * UUID of the Person this Activity is logged against. Either `deal` or `person` is required.
+     */
+    person?: string | null;
+    /**
+     * Id of the user who scheduled / logged this Activity. Defaults to the calling user on create.
+     */
+    owner?: number | null;
+    /**
+     * When to remind the owner.
+     */
+    reminder_at?: string | null;
+    /**
+     * Marks that a reminder has been sent for this Activity; prevents the same reminder from firing twice.
+     */
+    readonly reminder_sent?: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at?: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,83 @@
+import type { DealStatusEnum } from './DealStatusEnum';
+export type PatchedDeal = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id?: number;
+    /**
+     * Platform this Deal belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform?: number;
+    /**
+     * Short display name (e.g. 'Acme renewal — 2026').
+     */
+    title?: string;
+    /**
+     * Free-text notes about scope, requirements, etc.
+     */
+    description?: string;
+    /**
+     * Estimated deal value in `currency`.
+     */
+    lead_value?: string;
+    /**
+     * ISO 4217 currency code.
+     */
+    currency?: string;
+    /**
+     * Read-only. Set by the move-stage/won/lost actions and derived from the destination stage's `is_won`/`is_lost`. Direct writes are rejected with `400`; use `POST /deals/{id}/move-stage/` (or `won/` / `lost/`).
+     *
+     * * `open` - Open
+     * * `won` - Won
+     * * `lost` - Lost
+     */
+    readonly status?: DealStatusEnum;
+    /**
+     * Set on a `lost` transition (e.g. 'Chose competitor').
+     */
+    lost_reason?: string;
+    /**
+     * Forecasted close date — used by revenue projections.
+     */
+    expected_close_date?: string | null;
+    /**
+     * Read-only. Set automatically when the Deal enters a won/lost stage and cleared when it re-opens.
+     */
+    readonly closed_at?: string | null;
+    /**
+     * UUID of the primary contact for this Deal. The person must belong to your Platform.
+     */
+    person?: string;
+    /**
+     * UUID of an organization the Deal is with. Optional; must belong to your Platform.
+     */
+    organization?: string | null;
+    /**
+     * Pipeline this Deal flows through. Must belong to your Platform.
+     */
+    pipeline?: number;
+    /**
+     * Current PipelineStage. On create, must belong to `pipeline`. Use `POST /deals/{id}/move-stage/` to change after creation.
+     */
+    stage?: number;
+    /**
+     * Where the Deal originated. Optional; must belong to your Platform.
+     */
+    source?: number | null;
+    /**
+     * Id of the platform user responsible for this Deal (sales rep). Defaults to the calling user on create.
+     */
+    owner?: number | null;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at?: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,30 @@
+export type PatchedLeadSource = {
+    /**
+     * Server-assigned id. Stable across renames.
+     */
+    readonly id?: number;
+    /**
+     * Platform the LeadSource belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform?: number;
+    /**
+     * Display name shown to sales reps when categorizing a Deal.
+     */
+    name?: string;
+    /**
+     * Stable slug used in API payloads and reports. Unique per Platform; lowercase letters, digits, and hyphens.
+     */
+    code?: string;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at?: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at?: string;
+};

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

@@ -5,8 +5,9 @@ import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeE
 import type { NullEnum } from './NullEnum';
 import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
 import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
+import type { RecipientsRecipientModeEnum } from './RecipientsRecipientModeEnum';
 import type { Spa } from './Spa';
-import type { TypeD36Enum } from './TypeD36Enum';
+import type { Type4b7Enum } from './Type4b7Enum';
 /**
  * Serializer for detailed template view and editing
  */
@@ -27,6 +28,9 @@ export type PatchedNotificationTemplateDetail = {
      * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
      * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
      * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
+     * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
+     * * `CRM_PERSON_CREATED` - Crm Person Created
+     * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
      * * `CUSTOM_NOTIFICATION` - Custom Notification
      * * `DEFAULT_TEMPLATE` - Default Template
      * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -51,7 +55,7 @@ export type PatchedNotificationTemplateDetail = {
      * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
      * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
      */
-    readonly type?: (TypeD36Enum | NullEnum) | null;
+    readonly type?: (Type4b7Enum | NullEnum) | null;
     /**
      * Template display name
      */
@@ -203,6 +207,24 @@ export type PatchedNotificationTemplateDetail = {
      * Custom targets: user: {type, id}; user_group: {type, id}; rbac_policy: {type, policy_name}
      */
     human_support_custom_recipients?: Array<Record<string, any>>;
+    /**
+     * Recipients config (recipient mode + optional custom targets) for notification types that opt into the generic recipients model (e.g. CRM_*). Null for types that do not.
+     */
+    readonly recipients_config?: string;
+    /**
+     * Who receives this notification: 'platform_admins_only', 'object_owner_only' (falls back to admins), 'object_owner_only_strict' (no fallback), 'platform_admins_and_object_owner' (default), or 'custom'.
+     *
+     * * `platform_admins_only` - platform_admins_only
+     * * `object_owner_only` - object_owner_only
+     * * `object_owner_only_strict` - object_owner_only_strict
+     * * `platform_admins_and_object_owner` - platform_admins_and_object_owner
+     * * `custom` - custom
+     */
+    recipients_recipient_mode?: RecipientsRecipientModeEnum;
+    /**
+     * Custom recipient targets (used when recipient_mode='custom'): user: {type, id}; user_group: {type, id}; rbac_policy: {type, policy_name}.
+     */
+    recipients_custom_recipients?: Array<Record<string, any>>;
     /**
      * New content notification config (ACTIVITY_NEW_CONTENT only)
      */

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

@@ -16,7 +16,7 @@ export type PatchedOrganization = {
      */
     address?: any;
     /**
-     * platform `core.User` id of the internal owner / account manager. Optional.
+     * Id of the Platform user who owns / manages this Organization. Must be an active member of your Platform.
      */
     owner?: number | null;
     /**

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

@@ -0,0 +1,34 @@
+import type { PipelineStage } from './PipelineStage';
+export type PatchedPipeline = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id?: number;
+    /**
+     * Platform this Pipeline belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform?: number;
+    /**
+     * Display name (e.g. 'B2B Sales', 'Renewals').
+     */
+    name?: string;
+    /**
+     * Stable slug used in API payloads. Unique per Platform; lowercase letters, digits, and hyphens.
+     */
+    code?: string;
+    /**
+     * Mark this as the default Pipeline new Deals land in when none is specified. At most one default per Platform — promoting a new default requires un-flagging the old one in the same call set.
+     */
+    is_default?: boolean;
+    /**
+     * Days a Deal can sit in a stage before it's surfaced as stale.
+     */
+    rotten_days?: number;
+    readonly stages?: Array<PipelineStage>;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,40 @@
+export type PatchedPipelineStage = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id?: number;
+    /**
+     * Pipeline this stage belongs to. Set automatically from the URL path; you cannot move a stage between Pipelines.
+     */
+    readonly pipeline?: number;
+    /**
+     * Stable identifier referenced by `Deal.stage` payloads. Unique within the Pipeline.
+     */
+    code?: string;
+    /**
+     * Display name shown on Kanban boards.
+     */
+    name?: string;
+    /**
+     * Win likelihood at this stage (0–100). Used for revenue forecasting.
+     */
+    probability?: number;
+    /**
+     * Left-to-right position on the Kanban board.
+     */
+    sort_order?: number;
+    /**
+     * Closed-won terminal stage. Moving a Deal here sets `Deal.status='won'`.
+     */
+    is_won?: boolean;
+    /**
+     * Closed-lost terminal stage. Moving a Deal here sets `Deal.status='lost'`.
+     */
+    is_lost?: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,34 @@
+import type { PipelineStage } from './PipelineStage';
+export type Pipeline = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id: number;
+    /**
+     * Platform this Pipeline belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform: number;
+    /**
+     * Display name (e.g. 'B2B Sales', 'Renewals').
+     */
+    name: string;
+    /**
+     * Stable slug used in API payloads. Unique per Platform; lowercase letters, digits, and hyphens.
+     */
+    code: string;
+    /**
+     * Mark this as the default Pipeline new Deals land in when none is specified. At most one default per Platform — promoting a new default requires un-flagging the old one in the same call set.
+     */
+    is_default?: boolean;
+    /**
+     * Days a Deal can sit in a stage before it's surfaced as stale.
+     */
+    rotten_days?: number;
+    readonly stages: Array<PipelineStage>;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,40 @@
+export type PipelineStage = {
+    /**
+     * Server-assigned id.
+     */
+    readonly id: number;
+    /**
+     * Pipeline this stage belongs to. Set automatically from the URL path; you cannot move a stage between Pipelines.
+     */
+    readonly pipeline: number;
+    /**
+     * Stable identifier referenced by `Deal.stage` payloads. Unique within the Pipeline.
+     */
+    code: string;
+    /**
+     * Display name shown on Kanban boards.
+     */
+    name: string;
+    /**
+     * Win likelihood at this stage (0–100). Used for revenue forecasting.
+     */
+    probability?: number;
+    /**
+     * Left-to-right position on the Kanban board.
+     */
+    sort_order?: number;
+    /**
+     * Closed-won terminal stage. Moving a Deal here sets `Deal.status='won'`.
+     */
+    is_won?: boolean;
+    /**
+     * Closed-lost terminal stage. Moving a Deal here sets `Deal.status='lost'`.
+     */
+    is_lost?: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * * `platform_admins_only` - platform_admins_only
+ * * `object_owner_only` - object_owner_only
+ * * `object_owner_only_strict` - object_owner_only_strict
+ * * `platform_admins_and_object_owner` - platform_admins_and_object_owner
+ * * `custom` - custom
+ */
+export declare enum RecipientsRecipientModeEnum {
+    PLATFORM_ADMINS_ONLY = "platform_admins_only",
+    OBJECT_OWNER_ONLY = "object_owner_only",
+    OBJECT_OWNER_ONLY_STRICT = "object_owner_only_strict",
+    PLATFORM_ADMINS_AND_OBJECT_OWNER = "platform_admins_and_object_owner",
+    CUSTOM = "custom"
+}

package/dist/types/models/{TypeD36Enum.d.ts → Type4b7Enum.d.ts}

@@ -8,6 +8,9 @@
  * * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
  * * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
  * * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
+ * * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
+ * * `CRM_PERSON_CREATED` - Crm Person Created
+ * * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
  * * `CUSTOM_NOTIFICATION` - Custom Notification
  * * `DEFAULT_TEMPLATE` - Default Template
  * * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
@@ -32,7 +35,7 @@
  * * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
  * * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
  */
-export declare enum TypeD36Enum {
+export declare enum Type4b7Enum {
     ACTIVITY_COURSE_MILESTONE = "ACTIVITY_COURSE_MILESTONE",
     ACTIVITY_NEW_CONTENT = "ACTIVITY_NEW_CONTENT",
     ADMIN_NOTIF_COURSE_ENROLLMENT = "ADMIN_NOTIF_COURSE_ENROLLMENT",
@@ -42,6 +45,9 @@ export declare enum TypeD36Enum {
     COURSE_LICENSE_GROUP_ASSIGNMENT = "COURSE_LICENSE_GROUP_ASSIGNMENT",
     COURSE_SCHEDULE_CHANGE = "COURSE_SCHEDULE_CHANGE",
     COURSES_PROGRESS_SUMMARY = "COURSES_PROGRESS_SUMMARY",
+    CRM_DEAL_STAGE_CHANGED = "CRM_DEAL_STAGE_CHANGED",
+    CRM_PERSON_CREATED = "CRM_PERSON_CREATED",
+    CRM_PERSON_LINKED_TO_USER = "CRM_PERSON_LINKED_TO_USER",
     CUSTOM_NOTIFICATION = "CUSTOM_NOTIFICATION",
     DEFAULT_TEMPLATE = "DEFAULT_TEMPLATE",
     HUMAN_SUPPORT_NOTIFICATION = "HUMAN_SUPPORT_NOTIFICATION",

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

@@ -0,0 +1,126 @@
+import type { Activity } from '../models/Activity';
+import type { PaginatedActivityList } from '../models/PaginatedActivityList';
+import type { PatchedActivity } from '../models/PatchedActivity';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ActivitiesService {
+    /**
+     * List activities
+     * Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, schedule-from ranges, and `metadata__has_key`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/list`.
+     * @returns PaginatedActivityList
+     * @throws ApiError
+     */
+    static activitiesList({ deal, isDone, metadataHasKey, owner, page, pageSize, person, scheduleFromGte, scheduleFromLte, type, }: {
+        deal?: number;
+        isDone?: boolean;
+        metadataHasKey?: string;
+        owner?: number;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+        person?: string;
+        scheduleFromGte?: string;
+        scheduleFromLte?: string;
+        /**
+         * Interaction kind.
+         *
+         * * `call` - Call
+         * * `meeting` - Meeting
+         * * `email` - Email
+         * * `note` - Note
+         * * `task` - Task
+         * * `lunch` - Lunch
+         * * `deadline` - Deadline
+         */
+        type?: 'call' | 'deadline' | 'email' | 'lunch' | 'meeting' | 'note' | 'task';
+    }): CancelablePromise<PaginatedActivityList>;
+    /**
+     * 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`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static activitiesCreate({ requestBody, }: {
+        requestBody: Activity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Retrieve an activity
+     * Returns a single Activity by id.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/read`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static activitiesRetrieve({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<Activity>;
+    /**
+     * Replace an activity
+     * Replaces all editable fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static activitiesUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+        requestBody: Activity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Update an activity
+     * Updates only the supplied fields on the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static activitiesPartialUpdate({ id, requestBody, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+        requestBody?: PatchedActivity;
+    }): CancelablePromise<Activity>;
+    /**
+     * Delete an activity
+     * Deletes the Activity.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/delete`.
+     * @returns void
+     * @throws ApiError
+     */
+    static activitiesDestroy({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<void>;
+    /**
+     * Mark an activity as done
+     * Flips `is_done=True` and stamps `done_at` if it isn't already set. Idempotent — calling on an already-done Activity preserves the original `done_at`.
+     *
+     * **Required permission:** `Ibl.CRM/Activities/write`.
+     * @returns Activity
+     * @throws ApiError
+     */
+    static activitiesDoneCreate({ id, }: {
+        /**
+         * A unique integer value identifying this activity.
+         */
+        id: number;
+    }): CancelablePromise<Activity>;
+}