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

package/src/core/OpenAPI.ts

@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: 'https://base.manager.iblai.app',
-    VERSION: '4.261.1-core',
+    VERSION: '4.262.0-core',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/src/index.ts

@@ -199,6 +199,7 @@ export type { LearnerListPagination } from './models/LearnerListPagination';
 export type { LearnerListResponse } from './models/LearnerListResponse';
 export type { LearnerMetrics } from './models/LearnerMetrics';
 export type { LearnerSummary } from './models/LearnerSummary';
+export { LifecycleStageEnum } from './models/LifecycleStageEnum';
 export type { LtiKey } from './models/LtiKey';
 export type { LtiLaunchGate } from './models/LtiLaunchGate';
 export type { LtiMentor } from './models/LtiMentor';
@@ -232,6 +233,7 @@ export type { NotificationToggle } from './models/NotificationToggle';
 export type { NotificationTypePreference } from './models/NotificationTypePreference';
 export type { NullEnum } from './models/NullEnum';
 export type { OnboardingStatusUpdate } from './models/OnboardingStatusUpdate';
+export type { Organization } from './models/Organization';
 export type { OverTime } from './models/OverTime';
 export type { OvertimeDataPoint } from './models/OvertimeDataPoint';
 export type { OvertimeMeta } from './models/OvertimeMeta';
@@ -248,8 +250,10 @@ export type { PaginatedCourseSuggestion } from './models/PaginatedCourseSuggesti
 export type { PaginatedItemPaywallConfigList } from './models/PaginatedItemPaywallConfigList';
 export type { PaginatedItemSubscriptionList } from './models/PaginatedItemSubscriptionList';
 export type { PaginatedItemSubscriptionListList } from './models/PaginatedItemSubscriptionListList';
+export type { PaginatedOrganizationList } from './models/PaginatedOrganizationList';
 export type { PaginatedPathwayGroupSuggestion } from './models/PaginatedPathwayGroupSuggestion';
 export type { PaginatedPathwaySuggestion } from './models/PaginatedPathwaySuggestion';
+export type { PaginatedPersonList } from './models/PaginatedPersonList';
 export type { PaginatedPlatformInvitation } from './models/PaginatedPlatformInvitation';
 export type { PaginatedPlatformLicense } from './models/PaginatedPlatformLicense';
 export type { PaginatedProgramGroupSuggestion } from './models/PaginatedProgramGroupSuggestion';
@@ -278,6 +282,8 @@ export type { PatchedNotification } from './models/PatchedNotification';
 export type { PatchedNotificationTemplateDetail } from './models/PatchedNotificationTemplateDetail';
 export type { PatchedNotificationToggle } from './models/PatchedNotificationToggle';
 export type { PatchedNotificationTypePreference } from './models/PatchedNotificationTypePreference';
+export type { PatchedOrganization } from './models/PatchedOrganization';
+export type { PatchedPerson } from './models/PatchedPerson';
 export type { PatchedPlatformPublicImageAsset } from './models/PatchedPlatformPublicImageAsset';
 export type { PatchedPlatformPublicMetadata } from './models/PatchedPlatformPublicMetadata';
 export type { PatchedRbacGroup } from './models/PatchedRbacGroup';
@@ -330,6 +336,13 @@ export type { PerLearnerTimeSpentInCourseTree } from './models/PerLearnerTimeSpe
 export type { PerlearnerUserList } from './models/PerlearnerUserList';
 export type { PerlearnerUserListData } from './models/PerlearnerUserListData';
 export type { PermissionCheckRequest } from './models/PermissionCheckRequest';
+export type { Person } from './models/Person';
+export type { PersonInviteConflict } from './models/PersonInviteConflict';
+export type { PersonInviteRequest } from './models/PersonInviteRequest';
+export type { PersonInviteResponse } from './models/PersonInviteResponse';
+export type { PersonLinkUserRequest } from './models/PersonLinkUserRequest';
+export type { PersonMergeRequest } from './models/PersonMergeRequest';
+export type { PersonMergeResponse } from './models/PersonMergeResponse';
 export type { Platform } from './models/Platform';
 export type { PlatformApiKey } from './models/PlatformApiKey';
 export type { PlatformConfigurationList } from './models/PlatformConfigurationList';
@@ -579,11 +592,14 @@ export { CommerceService } from './services/CommerceService';
 export { CoreService } from './services/CoreService';
 export { CredentialsService } from './services/CredentialsService';
 export { CreditsService } from './services/CreditsService';
+export { CrmService } from './services/CrmService';
 export { CustomDomainsService } from './services/CustomDomainsService';
 export { FeaturesService } from './services/FeaturesService';
 export { ItemsService } from './services/ItemsService';
 export { MediaService } from './services/MediaService';
 export { NotificationsService } from './services/NotificationsService';
+export { OrganizationsService } from './services/OrganizationsService';
+export { PersonsService } from './services/PersonsService';
 export { PlatformsService } from './services/PlatformsService';
 export { PricesService } from './services/PricesService';
 export { RecommendationsService } from './services/RecommendationsService';

package/src/models/LifecycleStageEnum.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `lead` - Lead
+ * * `qualified` - Qualified
+ * * `opportunity` - Opportunity
+ * * `customer` - Customer
+ * * `churned` - Churned
+ */
+export enum LifecycleStageEnum {
+    LEAD = 'lead',
+    QUALIFIED = 'qualified',
+    OPPORTUNITY = 'opportunity',
+    CUSTOMER = 'customer',
+    CHURNED = 'churned',
+}

package/src/models/Organization.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Organization = {
+    /**
+     * Server-assigned UUID.
+     */
+    readonly id: string;
+    /**
+     * Platform the Organization belongs to. Set server-side from the auth token.
+     */
+    readonly platform: number;
+    /**
+     * Display name. Unique per platform (case-sensitive).
+     */
+    name: string;
+    /**
+     * Free-form JSON address (street, city, country, etc.).
+     */
+    address?: any;
+    /**
+     * platform `core.User` id of the internal owner / account manager. Optional.
+     */
+    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/src/models/PaginatedOrganizationList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Organization } from './Organization';
+export type PaginatedOrganizationList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Organization>;
+};
+

package/src/models/PaginatedPersonList.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Person } from './Person';
+export type PaginatedPersonList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Person>;
+};
+

package/src/models/PatchedOrganization.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedOrganization = {
+    /**
+     * Server-assigned UUID.
+     */
+    readonly id?: string;
+    /**
+     * Platform the Organization belongs to. Set server-side from the auth token.
+     */
+    readonly platform?: number;
+    /**
+     * Display name. Unique per platform (case-sensitive).
+     */
+    name?: string;
+    /**
+     * Free-form JSON address (street, city, country, etc.).
+     */
+    address?: any;
+    /**
+     * platform `core.User` id of the internal owner / account manager. Optional.
+     */
+    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/src/models/PatchedPerson.ts

@@ -0,0 +1,78 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LifecycleStageEnum } from './LifecycleStageEnum';
+export type PatchedPerson = {
+    /**
+     * Server-assigned UUID. Stable across renames and merges.
+     */
+    readonly id?: string;
+    /**
+     * Platform the person belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform?: number;
+    /**
+     * Display name (e.g. 'Alice Chen').
+     */
+    name?: string;
+    /**
+     * Canonical email address. When a platform user is created with a matching email in your Platform, this person is automatically linked to them (case-insensitive).
+     */
+    primary_email?: string;
+    /**
+     * Additional email addresses associated with this person.
+     */
+    emails?: any;
+    /**
+     * Phone/contact numbers in any free-form shape.
+     */
+    contact_numbers?: any;
+    /**
+     * Role / job title — display only, not validated.
+     */
+    job_title?: string;
+    /**
+     * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
+     */
+    organization?: string | null;
+    /**
+     * Id of the platform user who owns / manages this person (internal account manager). Optional.
+     */
+    owner?: number | null;
+    /**
+     * Read-only. Populated once this person is bound to a platform user — either automatically on user creation when emails match, or explicitly via `POST /persons/{id}/link-user/`.
+     */
+    readonly platform_user?: number | null;
+    /**
+     * Sales pipeline stage. One of: `lead`, `qualified`, `opportunity`, `customer`, `churned`.
+     *
+     * * `lead` - Lead
+     * * `qualified` - Qualified
+     * * `opportunity` - Opportunity
+     * * `customer` - Customer
+     * * `churned` - Churned
+     */
+    lifecycle_stage?: LifecycleStageEnum;
+    /**
+     * Optional external system id (e.g. import key from another CRM). When non-blank, must be unique within your Platform.
+     */
+    unique_id?: string;
+    /**
+     * Read-only. Set to `false` when the person is linked to a platform user or merged into another person.
+     */
+    readonly active?: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at?: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at?: string;
+};
+

package/src/models/Person.ts

@@ -0,0 +1,78 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LifecycleStageEnum } from './LifecycleStageEnum';
+export type Person = {
+    /**
+     * Server-assigned UUID. Stable across renames and merges.
+     */
+    readonly id: string;
+    /**
+     * Platform the person belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
+     */
+    readonly platform: number;
+    /**
+     * Display name (e.g. 'Alice Chen').
+     */
+    name: string;
+    /**
+     * Canonical email address. When a platform user is created with a matching email in your Platform, this person is automatically linked to them (case-insensitive).
+     */
+    primary_email?: string;
+    /**
+     * Additional email addresses associated with this person.
+     */
+    emails?: any;
+    /**
+     * Phone/contact numbers in any free-form shape.
+     */
+    contact_numbers?: any;
+    /**
+     * Role / job title — display only, not validated.
+     */
+    job_title?: string;
+    /**
+     * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
+     */
+    organization?: string | null;
+    /**
+     * Id of the platform user who owns / manages this person (internal account manager). Optional.
+     */
+    owner?: number | null;
+    /**
+     * Read-only. Populated once this person is bound to a platform user — either automatically on user creation when emails match, or explicitly via `POST /persons/{id}/link-user/`.
+     */
+    readonly platform_user: number | null;
+    /**
+     * Sales pipeline stage. One of: `lead`, `qualified`, `opportunity`, `customer`, `churned`.
+     *
+     * * `lead` - Lead
+     * * `qualified` - Qualified
+     * * `opportunity` - Opportunity
+     * * `customer` - Customer
+     * * `churned` - Churned
+     */
+    lifecycle_stage?: LifecycleStageEnum;
+    /**
+     * Optional external system id (e.g. import key from another CRM). When non-blank, must be unique within your Platform.
+     */
+    unique_id?: string;
+    /**
+     * Read-only. Set to `false` when the person is linked to a platform user or merged into another person.
+     */
+    readonly active: boolean;
+    /**
+     * Free-form JSON for Platform-defined attributes.
+     */
+    metadata?: any;
+    /**
+     * Creation timestamp.
+     */
+    readonly created_at: string;
+    /**
+     * Last-modified timestamp.
+     */
+    readonly updated_at: string;
+};
+

package/src/models/PersonInviteConflict.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Shape returned when an active invitation already exists for this email.
+ */
+export type PersonInviteConflict = {
+    detail: string;
+    /**
+     * Id of the pre-existing active invitation.
+     */
+    invitation_id: number;
+    person_id: string;
+    platform_key: string;
+};
+

package/src/models/PersonInviteRequest.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PersonInviteRequest = {
+    /**
+     * Grant Platform-admin privileges on acceptance. Defaults to `false`.
+     */
+    is_admin?: boolean;
+    /**
+     * Grant staff privileges on acceptance. Defaults to `false`.
+     */
+    is_staff?: boolean;
+    /**
+     * Optional enrollment payload. Forwarded to the platform invitation to auto-enroll the invitee in the listed courses, programs, or pathways on acceptance.
+     */
+    enrollment_config?: Record<string, any>;
+    /**
+     * URL to send the invitee to after they accept the invitation (e.g. a custom landing page, an enrollment screen). Passed straight through to the platform invitation row. Leave blank to use the platform default.
+     */
+    redirect_to?: string;
+};
+

package/src/models/PersonInviteResponse.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Shape returned by `POST /persons/{id}/invite/`.
+ */
+export type PersonInviteResponse = {
+    /**
+     * UUID of the person that was invited.
+     */
+    person_id: string;
+    /**
+     * Id of the newly created invitation.
+     */
+    invitation_id: number;
+    /**
+     * Email address the invitation was sent to.
+     */
+    invitation_email: string;
+    /**
+     * Key of the Platform the invitation targets.
+     */
+    platform_key: string;
+    /**
+     * Whether the invitation is auto-accepted when the invitee first signs in.
+     */
+    auto_accept: boolean;
+    /**
+     * Whether the invitation is currently active.
+     */
+    active: boolean;
+    /**
+     * URL the invitee will be sent to after accepting. Null/blank means the platform default destination.
+     */
+    redirect_to: string | null;
+    /**
+     * When the invitation was created.
+     */
+    created: string | null;
+};
+

package/src/models/PersonLinkUserRequest.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PersonLinkUserRequest = {
+    /**
+     * Id of the platform user to bind to this person. The user must already be a member of your Platform — invite them first if they are not.
+     */
+    user_id: number;
+};
+

package/src/models/PersonMergeRequest.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PersonMergeRequest = {
+    /**
+     * UUID of the person to keep (the surviving record). Must belong to your Platform.
+     */
+    primary_id: string;
+    /**
+     * UUIDs of the persons to merge into `primary_id`. Each must belong to your Platform. `primary_id` may not appear in this list. The duplicates are marked inactive; their related records (deals, activities, tags) are re-parented onto the primary.
+     */
+    duplicate_ids: Array<string>;
+};
+

package/src/models/PersonMergeResponse.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Shape returned by `POST /persons/merge/`.
+ */
+export type PersonMergeResponse = {
+    /**
+     * UUID of the surviving (primary) person.
+     */
+    primary_id: string;
+    /**
+     * UUIDs of the persons marked inactive by this merge.
+     */
+    merged_ids: Array<string>;
+    /**
+     * Per-relation counts of related records (deals, activities, tags) re-parented onto the primary.
+     */
+    reparented: Record<string, any>;
+};
+