@iblai/iblai-api 3.45.14-core → 3.45.15-ai-plus

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

@@ -0,0 +1,22 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
+export type PatchedPrompt = {
+    readonly id?: number;
+    mentor?: string;
+    tone?: string | null;
+    style?: string;
+    language?: string;
+    tags?: Array<number>;
+    is_system?: boolean;
+    metadata?: any;
+    category?: string;
+    prompt?: string;
+    title?: string | null;
+    description?: string | null;
+    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    created_by?: string | null;
+    platform?: number;
+};

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

@@ -0,0 +1,9 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+export type PatchedSection = {
+    readonly id?: number;
+    course?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,8 @@
+export type PatchedSlackConfig = {
+    readonly id?: number;
+    bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    app_token?: string;
+    verification_token?: string;
+};

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

@@ -0,0 +1,17 @@
+export type PatchedSlackUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    /**
+     * Team Domain in the stated slack workspace. This is also the workspace name.
+     */
+    slack_team_domain?: string;
+    /**
+     * Username in the stated slack workspace
+     */
+    slack_username?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,9 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+export type PatchedSubSection = {
+    readonly id?: number;
+    section?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,7 @@
+export type PatchedTeamsConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    verification_token?: string;
+};

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

@@ -0,0 +1,31 @@
+import type { Provider63aEnum } from './Provider63aEnum';
+export type PatchedTrainingCreate = {
+    readonly id?: string;
+    project_name?: string;
+    dataset?: string;
+    base_model_name?: string;
+    provider?: Provider63aEnum;
+    text_column?: string;
+    learning_rate?: number;
+    batch_size?: number;
+    num_epochs?: number;
+    block_size?: number;
+    warmup_ratio?: number;
+    lora_r?: number;
+    lora_alpha?: number;
+    lora_dropout?: number;
+    weight_decay?: number;
+    gradient_accumulation?: number;
+    use_peft?: boolean;
+    use_fp16?: boolean;
+    use_int4?: boolean;
+    push_to_hub?: boolean;
+    repo_id?: string;
+    preprocess_dataset?: boolean;
+    prompt_column?: string;
+    prompt_prefix?: string;
+    prompt_suffix?: string;
+    response_prefix?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,11 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { TypeC42Enum } from './TypeC42Enum';
+export type PatchedUnit = {
+    readonly id?: number;
+    subsection?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    type?: TypeC42Enum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,10 @@
+export type PatchedWebexConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    /**
+     * Bot id from webex
+     */
+    webex_bot_id?: string;
+    bot_access_token?: string;
+    bot_username?: string;
+};

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

@@ -0,0 +1,11 @@
+export type PatchedWhatsappConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    phone_number_id?: string;
+    application_secret?: string;
+    webhook_verification_token?: string;
+    /**
+     * Access token to the bot. This can also be a temporary access token.
+     */
+    access_token?: string;
+};

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

@@ -0,0 +1,10 @@
+export type PatchedWhatsappUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    phone_number?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -21,7 +21,7 @@ export type PathwayGroupSuggestionDetail = {
     /**
      * Whether the suggestion has been accepted
      */
-    accepted: boolean;
+    accepted?: boolean;
     /**
      * Whether the suggestion is visible
      */
@@ -57,5 +57,5 @@ export type PathwayGroupSuggestionDetail = {
     /**
      * Number of users in the group
      */
-    user_count: number;
+    user_count?: number;
 };

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

@@ -0,0 +1,42 @@
+import type { Mentor } from './Mentor';
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PeriodicAgent = {
+    readonly id: number;
+    mentor: Mentor;
+    title: string;
+    readonly username: string;
+    description?: string;
+    /**
+     * Prompt for the periodic agent if any.
+     */
+    prompt?: string;
+    task: PeriodicTask;
+    readonly created_at: string;
+    readonly modified_at: string;
+    readonly enabled: boolean;
+    readonly one_off: boolean;
+    readonly platform_key: string;
+    pathway?: string;
+    callback_url?: string;
+    callback_secret?: string;
+    parent_session_id?: string;
+    parent_mentor_id?: number | null;
+    /**
+     * Agent that needs to run before the current agent runs.
+     */
+    previous_agent?: number | null;
+    /**
+     * The status that the previous agent must be in before this agent gets scheduled.
+     *
+     * * `success` - Success
+     * * `error` - Error
+     * * `running` - Running
+     * * `pending` - Pending
+     */
+    previous_agent_status?: PreviousAgentStatusEnum;
+    /**
+     * This will be fed into the run of this agent as part of its input prompt.
+     */
+    readonly previous_agent_output: string;
+};

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

@@ -0,0 +1,41 @@
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PeriodicAgentCreate = {
+    readonly id: number;
+    mentor: number;
+    title: string;
+    readonly username: string;
+    description?: string;
+    /**
+     * Prompt for the periodic agent if any.
+     */
+    prompt?: string;
+    task: PeriodicTask;
+    readonly created_at: string;
+    readonly modified_at: string;
+    readonly enabled: boolean;
+    readonly one_off: boolean;
+    readonly platform_key: string;
+    pathway?: string;
+    callback_url?: string;
+    callback_secret?: string;
+    parent_session_id?: string;
+    parent_mentor_id?: number | null;
+    /**
+     * Agent that needs to run before the current agent runs.
+     */
+    previous_agent?: number | null;
+    /**
+     * The status that the previous agent must be in before this agent gets scheduled.
+     *
+     * * `success` - Success
+     * * `error` - Error
+     * * `running` - Running
+     * * `pending` - Pending
+     */
+    previous_agent_status?: PreviousAgentStatusEnum;
+    /**
+     * This will be fed into the run of this agent as part of its input prompt.
+     */
+    readonly previous_agent_output: string;
+};

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

@@ -0,0 +1,11 @@
+import type { PeriodicAgentLogStatusEnum } from './PeriodicAgentLogStatusEnum';
+export type PeriodicAgentLog = {
+    readonly id: number;
+    content?: string;
+    status?: PeriodicAgentLogStatusEnum;
+    start_time?: string;
+    end_time?: string | null;
+    readonly created_at: string;
+    readonly modified_at: string;
+    periodic_agent: number;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `success` - Success
+ * * `error` - Error
+ * * `running` - Running
+ */
+export declare enum PeriodicAgentLogStatusEnum {
+    SUCCESS = "success",
+    ERROR = "error",
+    RUNNING = "running"
+}

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

@@ -0,0 +1,21 @@
+import type { CrontabSchedule } from './CrontabSchedule';
+export type PeriodicTask = {
+    readonly id: number;
+    /**
+     * Short Description For This Task
+     */
+    readonly name: string;
+    crontab: CrontabSchedule;
+    /**
+     * If True, the schedule will only run the task a single time
+     */
+    one_off?: boolean;
+    /**
+     * Datetime when the schedule should begin triggering the task to run
+     */
+    start_time?: string | null;
+    /**
+     * Set to False to disable the schedule
+     */
+    enabled?: boolean;
+};

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

@@ -0,0 +1,5 @@
+import type { PieChartSegment } from './PieChartSegment';
+export type PieChartData = {
+    new_users: PieChartSegment;
+    returning_users: PieChartSegment;
+};

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

@@ -0,0 +1,4 @@
+export type PieChartSegment = {
+    count: number;
+    percentage: number;
+};

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

@@ -0,0 +1,9 @@
+export type PinnedMessageCreate = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    platform: string;
+    username: string;
+    session_id: string | null;
+};

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

@@ -0,0 +1,7 @@
+import type { ChatHistory } from './ChatHistory';
+import type { Mentor } from './Mentor';
+export type PinnedMessageGet = {
+    session_id: string;
+    mentor: Mentor;
+    messages: Array<ChatHistory>;
+};

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

@@ -0,0 +1,6 @@
+export type PinnedMessageRequest = {
+    /**
+     * Session id of the message to pin
+     */
+    session_id: string;
+};

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

@@ -9,7 +9,7 @@ export type PlatformInvitationDetail = {
     /**
      * The ID of the user associated with the invitation
      */
-    user_id: number | null;
+    user_id?: number | null;
     /**
      * The username of the user associated with the invitation
      */
@@ -21,7 +21,7 @@ export type PlatformInvitationDetail = {
     /**
      * When the invitation was created
      */
-    created: string;
+    created?: string;
     /**
      * When the invitation was started
      */

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

@@ -0,0 +1,12 @@
+export type PlayWrightScript = {
+    readonly id: number;
+    readonly platform: number | null;
+    /**
+     * edX user ID
+     */
+    readonly student: number | null;
+    title: string;
+    description?: string;
+    script: string;
+    readonly is_public: boolean;
+};

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

@@ -0,0 +1,4 @@
+import type { ReuestDataVariableList } from './ReuestDataVariableList';
+export type PredictiveAnalyticsRequest = {
+    prompt: ReuestDataVariableList;
+};

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

@@ -0,0 +1,4 @@
+import type { ResponseDataVariable } from './ResponseDataVariable';
+export type PredictiveAnalyticsResponse = {
+    predictions: Array<ResponseDataVariable>;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * * `success` - Success
+ * * `error` - Error
+ * * `running` - Running
+ * * `pending` - Pending
+ */
+export declare enum PreviousAgentStatusEnum {
+    SUCCESS = "success",
+    ERROR = "error",
+    RUNNING = "running",
+    PENDING = "pending"
+}

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

@@ -20,7 +20,6 @@
  * 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 = {
     /**
@@ -54,11 +53,11 @@ export type ProgramLicenseAssignmentDetail = {
     /**
      * Whether the assignment was directly assigned to the user (vs. via a group)
      */
-    direct: boolean | null;
+    direct?: boolean;
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string;
     /**
      * Additional metadata for the assignment
      */
@@ -66,11 +65,11 @@ export type ProgramLicenseAssignmentDetail = {
     /**
      * When the assignment was created
      */
-    created: string;
+    created?: string;
     /**
      * When the assignment was last modified
      */
-    modified: string;
+    modified?: string;
     /**
      * The ID of the program license
      */
@@ -83,8 +82,4 @@ export type ProgramLicenseAssignmentDetail = {
      * 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/ProgramLicenseDetail.d.ts

@@ -74,11 +74,15 @@ export type ProgramLicenseDetail = {
     /**
      * The program ID associated with the license
      */
-    program_id: string;
+    program_id?: string;
+    /**
+     * The program key associated with the license
+     */
+    program_key?: string;
     /**
      * The name of the program associated with the license
      */
-    program_name: string;
+    program_name?: string;
     /**
      * Number of assignments using this license
      */

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

@@ -0,0 +1,22 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
+export type Prompt = {
+    readonly id: number;
+    mentor?: string;
+    tone?: string | null;
+    style?: string;
+    language?: string;
+    tags?: Array<number>;
+    is_system?: boolean;
+    metadata?: any;
+    category?: string;
+    prompt: string;
+    title?: string | null;
+    description?: string | null;
+    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+    created_by?: string | null;
+    platform: number;
+};

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

@@ -0,0 +1,7 @@
+export type PromptCategory = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    readonly created_at: string | null;
+    readonly updated_at: string | null;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for prompt facets
+ */
+export type PromptFacet = {
+    /**
+     * Total number of prompts in this facet
+     */
+    total: number;
+    /**
+     * Terms and their counts in this facet
+     */
+    terms: Record<string, any>;
+    /**
+     * Count of prompts not in any term
+     */
+    other: number;
+};

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

@@ -0,0 +1,35 @@
+import type { Prompt } from './Prompt';
+import type { PromptFacet } from './PromptFacet';
+/**
+ * Response serializer for PromptSearchView
+ */
+export type PromptSearchResponse = {
+    /**
+     * List of prompts matching the search criteria
+     */
+    results: Array<Prompt>;
+    /**
+     * Total number of prompts matching the search criteria
+     */
+    count: number;
+    /**
+     * URL for the next page of results
+     */
+    next: string | null;
+    /**
+     * URL for the previous page of results
+     */
+    previous: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    num_pages: number;
+    /**
+     * Facet information for filtering
+     */
+    facets?: Record<string, PromptFacet>;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `viewable_by_tenant_admins` - Viewable By Tenant Admins
+ * * `viewable_by_tenant_students` - Viewable By Tenant Students
+ * * `viewable_by_anyone` - Viewable By Anyone
+ */
+export declare enum PromptVisibilityEnum {
+    VIEWABLE_BY_TENANT_ADMINS = "viewable_by_tenant_admins",
+    VIEWABLE_BY_TENANT_STUDENTS = "viewable_by_tenant_students",
+    VIEWABLE_BY_ANYONE = "viewable_by_anyone"
+}

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

@@ -0,0 +1,14 @@
+/**
+ * * `webex` - Webex
+ * * `slack` - Slack
+ * * `whatsapp` - Whatsapp
+ * * `discord` - Discord
+ * * `teams` - Teams
+ */
+export declare enum Provider05cEnum {
+    WEBEX = "webex",
+    SLACK = "slack",
+    WHATSAPP = "whatsapp",
+    DISCORD = "discord",
+    TEAMS = "teams"
+}

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

@@ -0,0 +1,6 @@
+/**
+ * * `openai` - Openai
+ */
+export declare enum Provider63aEnum {
+    OPENAI = "openai"
+}

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

@@ -0,0 +1,8 @@
+export type QuestionCardTag = {
+    readonly id: number;
+    name: string;
+    difficulty: number;
+    readonly total_cards: number;
+    readonly correct_answers: number;
+    readonly correct_rate: number;
+};

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

@@ -0,0 +1,15 @@
+import type { InputQuestion } from './InputQuestion';
+/**
+ * Serializer for incoming request data that includes initial questions and the username.
+ *
+ * Attributes:
+ * username (str): Username of the requesting student or user.
+ * initial_questions (list[InputQuestionSerializer]): List of initial questions provided by the LMS.
+ * question_count (int): Number of questions the mentor (llm) should generate
+ */
+export type QuestionRequest = {
+    username: string;
+    initial_questions: Array<InputQuestion>;
+    question_count?: number;
+    subject: string;
+};

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

@@ -0,0 +1,10 @@
+import type { LLMQuestion } from './LLMQuestion';
+/**
+ * Serializer for the response data that returns additional questions.
+ *
+ * Attributes:
+ * follow_up_questions (list[LLMQuestionSerializer]): List of generated follow-up questions.
+ */
+export type QuestionResponse = {
+    questions: Array<LLMQuestion>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `1` - Up Vote
+ * * `-1` - Down Vote
+ */
+export declare enum RatingEnum {
+    '_1' = 1,
+    '_-1' = -1
+}

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

@@ -0,0 +1,4 @@
+export type RatingRecord = {
+    time: string;
+    total_ratings: number;
+};

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

@@ -0,0 +1,8 @@
+export type RecentlyAccessedMentor = {
+    readonly slug: string | null;
+    readonly name: string | null;
+    readonly description: string | null;
+    readonly recently_accessed_at: string | null;
+    readonly platform_key: string | null;
+    readonly last_accessed_by: string | null;
+};

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

@@ -0,0 +1,3 @@
+export type RecommendCourseBlock = {
+    blocks: Array<any>;
+};