@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,53 @@
+/**
+ * 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/dist/types/models/ProgramInvitationRedemption.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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/dist/types/models/ProgramLicenseAssignmentCreate.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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/dist/types/models/ProgramLicenseAssignmentDetail.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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/dist/types/models/ProgramLicenseCreateDetail.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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/dist/types/models/ProgramLicenseDetail.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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>;
+};

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

@@ -0,0 +1,56 @@
+/**
+ * Request serializer for ProgramLicenseGroupAssignmentView POST endpoint.
+ *
+ * This serializer validates the request data for creating or updating a program license group assignment.
+ * Group assignments will automatically create individual assignments for all users in the group.
+ *
+ * Fields:
+ * license_id: The ID of the program license to assign
+ * group_id: The ID of the user group to assign the license to
+ * 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 group assignment should be active
+ * fulfilled: Whether the group assignment should be marked as fulfilled
+ * redirect_to: URL to redirect to after fulfillment
+ * metadata: Additional metadata for the group assignment
+ *
+ * Notes:
+ * - All users in the group will receive individual license assignments
+ * - The license must have enough available seats for all users in the group
+ * - If the license doesn't have enough seats, the operation will fail
+ * - Users who already have a direct assignment to this license will not be affected
+ */
+export type ProgramLicenseGroupAssignmentCreate = {
+    /**
+     * The ID of the program license to assign
+     */
+    license_id: number;
+    /**
+     * The ID of the user group to assign the license to
+     */
+    group_id: number;
+    /**
+     * 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 group assignment should be active
+     */
+    active?: boolean;
+    /**
+     * Whether the group assignment should be marked as fulfilled
+     */
+    fulfilled?: boolean;
+    /**
+     * URL to redirect to after fulfillment
+     */
+    redirect_to?: string | null;
+    /**
+     * Additional metadata for the group assignment
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,85 @@
+/**
+ * Response serializer for program license group assignment details.
+ *
+ * This serializer represents a program license group assignment with all its attributes,
+ * including group information, license details, and assignment status.
+ *
+ * Fields:
+ * id: The unique identifier for the group assignment
+ * group_id: The ID of the group assigned the license
+ * group_name: The name of the group assigned the license
+ * active: Whether the group assignment is active and valid
+ * fulfilled: Whether the group assignment has been processed/fulfilled
+ * redirect_to: URL to redirect to after fulfillment
+ * metadata: Additional metadata for the group assignment
+ * created: When the group assignment was created
+ * modified: When the group 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
+ * user_count: Number of users in the group
+ * assigned_count: Number of users in the group who have been assigned the license
+ */
+export type ProgramLicenseGroupAssignmentDetail = {
+    /**
+     * The unique identifier for the assignment
+     */
+    id: number;
+    /**
+     * The ID of the group assigned the license
+     */
+    group_id: number;
+    /**
+     * The name of the group assigned the license
+     */
+    group_name: string;
+    /**
+     * Whether the assignment is active and valid
+     */
+    active: boolean;
+    /**
+     * Whether the assignment has been processed/fulfilled
+     */
+    fulfilled: boolean;
+    /**
+     * 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;
+    /**
+     * Number of users in the group
+     */
+    user_count: number;
+    /**
+     * Number of users in the group who have been assigned the license
+     */
+    assigned_count: number;
+};

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

@@ -0,0 +1,76 @@
+/**
+ * Request serializer for ProgramLicenseUpdateView POST endpoint.
+ *
+ * This serializer validates the request data for updating an existing program license.
+ * Either license_id or external_id must be provided to identify the license to update.
+ *
+ * Fields:
+ * license_id: The ID of the license to update (required if external_id not provided)
+ * external_id: External identifier of the license to update (required if license_id not provided)
+ * name: Updated display name for the license
+ * count: Updated number of seats purchased
+ * started: Updated date when license should begin
+ * expired: Updated date when license should expire
+ * active: Updated active status
+ * metadata: Updated additional license metadata
+ * enrollment_config: Updated enrollment configuration
+ * source: Updated source identifier
+ * transaction_id: Transaction identifier for tracking
+ * change_type: Type of change being made (default: "update")
+ *
+ * Notes:
+ * - Cannot update the platform or program associated with a license
+ * - A license history record is automatically created for each update
+ * - If count is reduced, it must not be less than the number of active assignments
+ * - Setting active=false will not deactivate existing assignments
+ */
+export type ProgramLicenseUpdateDetail = {
+    /**
+     * The ID of the license to update (required if external_id not provided)
+     */
+    license_id?: number;
+    /**
+     * External identifier of the license to update (required if license_id not provided)
+     */
+    external_id?: string;
+    /**
+     * Updated display name for the license
+     */
+    name?: string;
+    /**
+     * Updated number of seats purchased
+     */
+    count?: number;
+    /**
+     * Updated date when license should begin
+     */
+    started?: string;
+    /**
+     * Updated date when license should expire
+     */
+    expired?: string | null;
+    /**
+     * Updated active status
+     */
+    active?: boolean;
+    /**
+     * Updated additional license metadata
+     */
+    metadata?: Record<string, any>;
+    /**
+     * Updated enrollment configuration
+     */
+    enrollment_config?: Record<string, any>;
+    /**
+     * Updated source identifier
+     */
+    source?: string;
+    /**
+     * Transaction identifier for tracking
+     */
+    transaction_id?: string;
+    /**
+     * Type of change being made
+     */
+    change_type?: string;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for program review info response.
+ */
+export type ProgramReviewInfoResponse = {
+    /**
+     * The program key associated with the reviews
+     */
+    program_key: string;
+    /**
+     * Average rating of the program
+     */
+    avg_rating: number | null;
+    /**
+     * Total number of reviews for the program
+     */
+    count: number;
+};

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

@@ -0,0 +1,28 @@
+import type { ProgramCoursePosition } from './ProgramCoursePosition';
+export type ProgramSearch = {
+    course_list: Array<ProgramCoursePosition>;
+    /**
+     * A unique program ID identifiable by edX.
+     */
+    program_id: string;
+    readonly program_key: string;
+    /**
+     * The verbose name of the program.
+     */
+    name?: string;
+    /**
+     * Select if this program should be enabled.
+     */
+    enabled?: boolean;
+    /**
+     * An additional unique slug field. (Optional)
+     */
+    slug?: string | null;
+    org?: string;
+    readonly platform_key: string;
+    readonly program_type: string;
+    /**
+     * Metadata
+     */
+    data?: any;
+};

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for ProgramSuggestionBulkManagementView POST endpoint
+ */
+export type ProgramSuggestionBulkCreate = {
+    /**
+     * The platform for the suggestions
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * List of suggestion data objects, each containing program_key, user_id, etc.
+     */
+    suggestion_data: Array<Record<string, any>>;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+};