@iblai/iblai-api 0.0.1-core

package/src/models/ProgramDeleteResponse.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for program deletion response.
+ */
+export type ProgramDeleteResponse = {
+    /**
+     * Number of programs deleted
+     */
+    count: number;
+    /**
+     * Types of objects deleted
+     */
+    type: Record<string, any>;
+};
+

package/src/models/ProgramEnrollment.ts

@@ -0,0 +1,35 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ProgramEnrollment = {
+    user_id?: number;
+    username?: string;
+    program_id?: string;
+    program_key?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment started
+     */
+    started?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Date when enrollment expires (null, if not expiring)
+     */
+    expired?: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+};
+

package/src/models/ProgramEnrollmentPlus.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Includes metadata+
+ */
+export type ProgramEnrollmentPlus = {
+    user_id?: number;
+    username?: string;
+    program_id?: string;
+    program_key?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment started
+     */
+    started?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Date when enrollment expires (null, if not expiring)
+     */
+    expired?: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+    metadata?: any;
+};
+

package/src/models/ProgramGroupSuggestionCreate.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramGroupSuggestionManagementView POST endpoint
+ */
+export type ProgramGroupSuggestionCreate = {
+    /**
+     * The platform for the group suggestion
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The program key to suggest
+     */
+    program_key: string;
+    /**
+     * The group to suggest the program to
+     */
+    group_id: number;
+    /**
+     * Whether the suggestion is accepted
+     */
+    accepted?: boolean;
+    /**
+     * Whether the suggestion is visible
+     */
+    visible?: boolean;
+    /**
+     * Additional suggestion metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+};
+

package/src/models/ProgramGroupSuggestionDetail.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for program group suggestion details
+ */
+export type ProgramGroupSuggestionDetail = {
+    /**
+     * The unique identifier for the group suggestion
+     */
+    id: number;
+    /**
+     * The ID of the group receiving the suggestion
+     */
+    group_id: number;
+    /**
+     * The name of the group receiving the suggestion
+     */
+    group_name: string;
+    /**
+     * The platform key associated with the suggestion
+     */
+    platform_key: string;
+    /**
+     * Whether the suggestion has been accepted
+     */
+    accepted: boolean;
+    /**
+     * Whether the suggestion is visible
+     */
+    visible: boolean;
+    /**
+     * When the suggestion was created
+     */
+    created: string;
+    /**
+     * When the suggestion was last modified
+     */
+    modified: string;
+    /**
+     * Additional metadata for the suggestion
+     */
+    metadata: Record<string, any>;
+    /**
+     * The program key being suggested
+     */
+    program_key: string;
+    /**
+     * The name of the program being suggested
+     */
+    program_name: string;
+    /**
+     * Number of users in the group
+     */
+    user_count: number;
+};
+

package/src/models/ProgramInvitationCreate.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramInvitationView POST endpoint
+ */
+export type ProgramInvitationCreate = {
+    /**
+     * The program to create an invitation for
+     */
+    program_key: string;
+    /**
+     * The email address to invite
+     */
+    email?: string;
+    /**
+     * The username to invite
+     */
+    username?: string;
+    /**
+     * Whether the invitation is active
+     */
+    active?: boolean;
+    /**
+     * The source of the invitation
+     */
+    source?: string;
+    /**
+     * URL to redirect to after accepting the invitation
+     */
+    redirect_to?: string;
+    /**
+     * When the invitation was created
+     */
+    created?: string;
+    /**
+     * When the invitation expires
+     */
+    expired?: string;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata?: Record<string, any>;
+};
+

package/src/models/ProgramInvitationDetail.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for program invitation details
+ */
+export type ProgramInvitationDetail = {
+    /**
+     * The unique identifier for the invitation
+     */
+    id: number;
+    /**
+     * The ID of the user associated with the invitation
+     */
+    user_id: number | null;
+    /**
+     * The username of the user associated with the invitation
+     */
+    username: string | null;
+    /**
+     * The email address associated with the invitation
+     */
+    email: string | null;
+    /**
+     * When the invitation was created
+     */
+    created: string;
+    /**
+     * When the invitation was started
+     */
+    started: string | null;
+    /**
+     * When the invitation expires
+     */
+    expired: string | null;
+    /**
+     * The source of the invitation
+     */
+    source: string | null;
+    /**
+     * URL to redirect to after accepting the invitation
+     */
+    redirect_to: string | null;
+    /**
+     * Whether the invitation is active
+     */
+    active: boolean;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata: Record<string, any>;
+    /**
+     * The program key associated with the invitation
+     */
+    program_key: string;
+};
+

package/src/models/ProgramInvitationRedemption.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramInvitationRedemptionView POST endpoint
+ */
+export type ProgramInvitationRedemption = {
+    /**
+     * The program key for the invitation
+     */
+    program_key: string;
+    /**
+     * The source identifier for the invitation
+     */
+    source: string;
+    /**
+     * The email to associate with the invitation
+     */
+    email?: string;
+    /**
+     * The username to associate with the invitation
+     */
+    username?: string;
+    /**
+     * Additional metadata for the invitation
+     */
+    metadata?: Record<string, any>;
+};
+

package/src/models/ProgramLicenseAssignmentCreate.ts

@@ -0,0 +1,75 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramLicenseAssignmentView POST endpoint.
+ *
+ * This serializer validates the request data for creating or updating a program license assignment.
+ * Either user_id or email must be provided to identify the user to assign the license to.
+ *
+ * Fields:
+ * license_id: The ID of the program license to assign
+ * user_id: The user ID to assign the license to (required if email not provided)
+ * username: The username to assign the license to (alternative to user_id)
+ * email: The email to assign the license to (required if user_id not provided)
+ * platform_key: The unique identifier for the platform (for permission validation)
+ * platform_org: The organization identifier for the platform (for permission validation)
+ * active: Whether the assignment should be active
+ * fulfilled: Whether the assignment should be marked as fulfilled
+ * direct: Whether the assignment is being directly assigned to the user
+ * redirect_to: URL to redirect to after fulfillment
+ * metadata: Additional metadata for the assignment
+ *
+ * Notes:
+ * - If both user_id and email are provided, user_id takes precedence
+ * - If the user doesn't exist but email is provided, an email-only assignment will be created
+ * - The license must have available seats for the assignment to succeed
+ */
+export type ProgramLicenseAssignmentCreate = {
+    /**
+     * The ID of the program license to assign
+     */
+    license_id: number;
+    /**
+     * The user ID to assign the license to (required if email not provided)
+     */
+    user_id?: number;
+    /**
+     * The username to assign the license to (alternative to user_id)
+     */
+    username?: string;
+    /**
+     * The email to assign the license to (required if user_id not provided)
+     */
+    email?: string;
+    /**
+     * The unique identifier for the platform (for permission validation)
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform (for permission validation)
+     */
+    platform_org?: string;
+    /**
+     * Whether the assignment should be active
+     */
+    active?: boolean;
+    /**
+     * Whether the assignment should be marked as fulfilled
+     */
+    fulfilled?: boolean;
+    /**
+     * Whether the assignment is being directly assigned to the user
+     */
+    direct?: boolean;
+    /**
+     * URL to redirect to after fulfillment
+     */
+    redirect_to?: string | null;
+    /**
+     * Additional metadata for the assignment
+     */
+    metadata?: Record<string, any>;
+};
+

package/src/models/ProgramLicenseAssignmentDetail.ts

@@ -0,0 +1,95 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for program license assignment details.
+ *
+ * This serializer represents a program license assignment with all its attributes,
+ * including user information, license details, and assignment status.
+ *
+ * Fields:
+ * id: The unique identifier for the assignment
+ * user_id: The ID of the user assigned the license (may be null for email-only assignments)
+ * username: The username of the user assigned the license (may be null for email-only assignments)
+ * name: The full name of the user assigned the license (may be null for email-only assignments)
+ * email: The email address of the user assigned the license (may be null for user-only assignments)
+ * active: Whether the assignment is active and valid
+ * fulfilled: Whether the assignment has been processed/fulfilled
+ * direct: Whether the assignment was directly assigned to the user (vs. via a group)
+ * redirect_to: URL to redirect to after fulfillment
+ * metadata: Additional metadata for the assignment
+ * created: When the assignment was created
+ * modified: When the assignment was last modified
+ * license_id: The ID of the program license
+ * license_name: The name of the program license
+ * program_key: The program key associated with the license
+ * program_name: The name of the program associated with the license
+ */
+export type ProgramLicenseAssignmentDetail = {
+    /**
+     * The unique identifier for the assignment
+     */
+    id: number;
+    /**
+     * The ID of the user assigned the license
+     */
+    user_id: number | null;
+    /**
+     * The username of the user assigned the license
+     */
+    username: string | null;
+    /**
+     * The full name of the user assigned the license
+     */
+    name: string | null;
+    /**
+     * The email address of the user assigned the license
+     */
+    email: string | null;
+    /**
+     * Whether the assignment is active and valid
+     */
+    active: boolean;
+    /**
+     * Whether the assignment has been processed/fulfilled
+     */
+    fulfilled: boolean;
+    /**
+     * Whether the assignment was directly assigned to the user (vs. via a group)
+     */
+    direct: boolean | null;
+    /**
+     * URL to redirect to after fulfillment
+     */
+    redirect_to: string | null;
+    /**
+     * Additional metadata for the assignment
+     */
+    metadata: Record<string, any> | null;
+    /**
+     * When the assignment was created
+     */
+    created: string;
+    /**
+     * When the assignment was last modified
+     */
+    modified: string;
+    /**
+     * The ID of the program license
+     */
+    license_id: number;
+    /**
+     * The name of the program license
+     */
+    license_name: string;
+    /**
+     * The program key associated with the license
+     */
+    program_key: string;
+    /**
+     * The name of the program associated with the license
+     */
+    program_name: string;
+};
+

package/src/models/ProgramLicenseCreateDetail.ts

@@ -0,0 +1,66 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramLicenseCreateView POST endpoint
+ */
+export type ProgramLicenseCreateDetail = {
+    /**
+     * The unique identifier for the platform (required if platform_id not provided)
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform (required if platform_id not provided)
+     */
+    platform_org?: string;
+    /**
+     * The ID of the platform (required if platform_key/org not provided)
+     */
+    platform_id?: number;
+    /**
+     * The unique identifier for the program to license
+     */
+    program_key: string;
+    /**
+     * Display name for the license
+     */
+    name: string;
+    /**
+     * Number of seats purchased
+     */
+    count: number;
+    /**
+     * Date when license should begin
+     */
+    started: string;
+    /**
+     * Date when license should expire
+     */
+    expired?: string | null;
+    /**
+     * External identifier for the license
+     */
+    external_id?: string | null;
+    /**
+     * Whether the license should be active
+     */
+    active?: boolean;
+    /**
+     * Additional license metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Enrollment configuration
+     */
+    enrollment_config?: Record<string, any>;
+    /**
+     * Source identifier
+     */
+    source?: string;
+    /**
+     * Transaction identifier for tracking
+     */
+    transaction_id?: string;
+};
+

package/src/models/ProgramLicenseDetail.ts

@@ -0,0 +1,95 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for program license details.
+ *
+ * This serializer represents a program license with all its attributes,
+ * including basic license information, program details, and usage statistics.
+ *
+ * Fields:
+ * id: The unique identifier for the license
+ * created: When the license was created
+ * started: When the license becomes active
+ * expired: When the license expires (null if no expiration)
+ * name: The display name of the license
+ * count: The number of seats purchased
+ * active: Whether the license is active
+ * metadata: Additional license metadata
+ * source: The source identifier for the license
+ * external_id: External identifier for the license (null if none)
+ * platform_key: The platform key associated with the license
+ * program_id: The program ID associated with the license
+ * program_name: The name of the program associated with the license
+ * usage_count: Number of assignments using this license
+ * assignments: Assignment counts (if verbose mode is enabled)
+ *
+ * Notes:
+ * - The assignments field is only included when verbose=true in the request
+ * - The expired field may be null if the license doesn't expire
+ * - The external_id field may be null if not provided
+ */
+export type ProgramLicenseDetail = {
+    /**
+     * The unique identifier for the license
+     */
+    id: number;
+    /**
+     * When the license was created
+     */
+    created: string;
+    /**
+     * When the license becomes active
+     */
+    started: string;
+    /**
+     * When the license expires (null if no expiration)
+     */
+    expired: string | null;
+    /**
+     * The display name of the license
+     */
+    name: string;
+    /**
+     * The number of seats purchased
+     */
+    count: number;
+    /**
+     * Whether the license is active
+     */
+    active: boolean;
+    /**
+     * Additional license metadata
+     */
+    metadata: Record<string, any>;
+    /**
+     * The source identifier for the license
+     */
+    source: string;
+    /**
+     * External identifier for the license (null if none)
+     */
+    external_id: string | null;
+    /**
+     * The platform key associated with the license
+     */
+    platform_key: string;
+    /**
+     * The program ID associated with the license
+     */
+    program_id: string;
+    /**
+     * The name of the program associated with the license
+     */
+    program_name: string;
+    /**
+     * Number of assignments using this license
+     */
+    usage_count: number;
+    /**
+     * Assignment counts by status (only included in verbose mode)
+     */
+    assignments?: Record<string, number>;
+};
+