@iblai/iblai-api 0.0.1-core

package/src/models/ProgramLicenseGroupAssignmentCreate.ts

@@ -0,0 +1,61 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/ProgramLicenseGroupAssignmentDetail.ts

@@ -0,0 +1,90 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/ProgramLicenseUpdateDetail.ts

@@ -0,0 +1,81 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/ProgramReviewInfoResponse.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/ProgramSearch.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ProgramSuggestionBulkCreate.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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;
+};
+

package/src/models/ProgramSuggestionCreate.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramSuggestionManagementView POST endpoint
+ */
+export type ProgramSuggestionCreate = {
+    /**
+     * The platform for the suggestion
+     */
+    platform_key: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The program key to suggest
+     */
+    program_key: string;
+    /**
+     * The user to suggest the program to
+     */
+    user_id: string;
+    /**
+     * The username of the user to suggest the program to
+     */
+    username?: string;
+    /**
+     * The email of the user to suggest the program to
+     */
+    email?: string;
+    /**
+     * The user who suggested the program
+     */
+    suggested_by?: string;
+    /**
+     * Whether the suggestion is direct
+     */
+    direct?: boolean;
+    /**
+     * Flag to ensure department admins can call the API
+     */
+    department_mode?: boolean;
+    /**
+     * Whether the suggestion is accepted
+     */
+    accepted?: boolean;
+    /**
+     * Whether the suggestion is visible
+     */
+    visible?: boolean;
+    /**
+     * Additional suggestion metadata
+     */
+    metadata?: Record<string, any>;
+};
+

package/src/models/ProgramSuggestionDetail.ts

@@ -0,0 +1,58 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for program suggestion details
+ */
+export type ProgramSuggestionDetail = {
+    /**
+     * The unique identifier for the suggestion
+     */
+    id: number;
+    /**
+     * The ID of the user receiving the suggestion
+     */
+    user_id: number;
+    /**
+     * The username of the user receiving the suggestion
+     */
+    username: string;
+    /**
+     * The full name of the user receiving the suggestion
+     */
+    name: string;
+    /**
+     * The platform key associated with the suggestion
+     */
+    platform_key: string;
+    /**
+     * Whether the suggestion has been accepted by the user
+     */
+    accepted: boolean;
+    /**
+     * Whether the suggestion is visible to the user
+     */
+    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;
+};
+

package/src/models/ProgramTypeEnum.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `bachelors` - Bachelor's Degree
+ * * `masters` - Master's Degree
+ * * `phd` - PhD
+ * * `diploma` - Diploma
+ * * `certificate` - Certificate
+ * * `ungraded` - Ungraded
+ * * `other` - Other
+ */
+export enum ProgramTypeEnum {
+    BACHELORS = 'bachelors',
+    MASTERS = 'masters',
+    PHD = 'phd',
+    DIPLOMA = 'diploma',
+    CERTIFICATE = 'certificate',
+    UNGRADED = 'ungraded',
+    OTHER = 'other',
+}

package/src/models/Recipient.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for recipient data
+ */
+export type Recipient = {
+    username: string;
+    email: string;
+    status?: string;
+};
+

package/src/models/RecommendationSearchAPI.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RecommendationSearchAPI = {
+    search_api_url: string;
+};
+

package/src/models/RedirectTokenRequest.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RedirectTokenRequest = {
+    url: string;
+};
+

package/src/models/RedirectTokenResponse.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RedirectTokenResponse = {
+    readonly platform_key: string;
+    url: string;
+    readonly token: string;
+};
+

package/src/models/ReportCreate.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportStatus } from './ReportStatus';
+/**
+ * Returns this a report is successfully created
+ */
+export type ReportCreate = {
+    data: ReportStatus;
+};
+

package/src/models/ReportData.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportStatus } from './ReportStatus';
+export type ReportData = {
+    /**
+     * Report Name
+     */
+    display_name?: string;
+    /**
+     * Report Description
+     */
+    description?: string;
+    /**
+     * Report slug
+     */
+    report_name?: string;
+    icon?: string;
+    /**
+     * Extra parameters to be passed to the report create view, e.g learner_id
+     */
+    extra_query_params?: Array<any>;
+    /**
+     * Columns to be available in the report
+     */
+    result_columns?: Array<any>;
+    /**
+     * Report Status if any available
+     */
+    status?: ReportStatus;
+};
+

package/src/models/ReportDetail.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportData } from './ReportData';
+export type ReportDetail = {
+    data: ReportData;
+};
+

package/src/models/ReportList.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ReportData } from './ReportData';
+export type ReportList = {
+    data: Array<ReportData>;
+};
+

package/src/models/ReportRequest.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ReportRequest = {
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Advanced report filtering. e,g: {'username': 'username1, username2' }
+     */
+    params?: Record<string, any>;
+    /**
+     *
+     * Advanced Query to run the report, supports SQL Like queries.
+     *
+     * e.g For date type filtering
+     * date_joined > '2021-01-01'
+     *
+     * See https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html#pandas.DataFrame.query
+     *
+     */
+    query?: string;
+};
+

package/src/models/ReportStatus.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { StateEnum } from './StateEnum';
+export type ReportStatus = {
+    /**
+     * Used to download the report
+     */
+    report_id?: string;
+    /**
+     * Report slug, this is passed when calling the create report endpoint
+     */
+    report_name?: string;
+    /**
+     * Report States
+     *
+     * * `pending` - Pending
+     * * `running` - Running
+     * * `accumulating` - Accumulating
+     * * `processing` - Processing
+     * * `storing` - Storing
+     * * `completed` - Completed
+     * * `cancelled` - Cancelled
+     * * `error` - Error
+     * * `expired` - Expired
+     */
+    state?: StateEnum;
+    /**
+     * Report request timestamp (ISO 8601)
+     */
+    started_on?: string;
+    /**
+     * Report Owner
+     */
+    owner?: string;
+    /**
+     * When report would expire and not available for download anymore
+     */
+    expires?: string;
+    /**
+     * Download link for report when available
+     */
+    url?: string;
+};
+

package/src/models/ReportedRole.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Role } from './Role';
+export type ReportedRole = {
+    user_id?: number;
+    username?: string;
+    roles: Array<Role>;
+    readonly data: any;
+};
+

package/src/models/ReportedRoleCreateUpdateRequest.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for reported role creation/update request parameters.
+ */
+export type ReportedRoleCreateUpdateRequest = {
+    /**
+     * User ID
+     */
+    user_id?: number;
+    /**
+     * Username
+     */
+    username?: string;
+    /**
+     * List of roles (can be role IDs or objects with name, platform_key, etc.)
+     */
+    roles: Array<Record<string, any>>;
+    /**
+     * Additional data
+     */
+    data?: any;
+};
+