@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,10 @@
+import type { ActiveUsersPerCourseData } from './ActiveUsersPerCourseData';
+import type { OvertimeMeta } from './OvertimeMeta';
+export type ActiveUsersPerCourse = {
+    data: Array<ActiveUsersPerCourseData>;
+    /**
+     * Total unique active users in this period
+     */
+    total: number;
+    meta: OvertimeMeta;
+};

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

@@ -0,0 +1,14 @@
+export type ActiveUsersPerCourseData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Active users for the period
+     */
+    user_count: number;
+};

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

@@ -0,0 +1,8 @@
+import type { ActivityData } from './ActivityData';
+export type ActivityAPI = {
+    data?: Array<ActivityData>;
+    /**
+     * Total rows
+     */
+    total: number;
+};

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

@@ -0,0 +1,38 @@
+export type ActivityData = {
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Course name
+     */
+    name: string;
+    /**
+     * Course start date
+     */
+    course_start: string;
+    /**
+     * Course end date
+     */
+    course_end: string;
+    /**
+     * Overall course average time invested (other students inclusive)
+     */
+    average_time_invested: number;
+    /**
+     * Total time spent
+     */
+    time_invested: number;
+    /**
+     * Days from today the course has been accessed
+     */
+    days_away: string;
+    /**
+     * When course was last accessed
+     */
+    last_access_date: string;
+    /**
+     * Unique days course was accessed
+     */
+    days_accessed: number;
+};

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

@@ -0,0 +1,10 @@
+export type App = {
+    name: string;
+    url: string;
+    type: string;
+    metadata?: any;
+    /**
+     * If true, users will be required to complete onboarding before using this app
+     */
+    onboarding_required?: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type AppleSubscriptionStatusRequest = {
+    bundle_id?: string;
+};

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

@@ -0,0 +1,3 @@
+export type AppleSubscriptionStatusView = {
+    data: any;
+};

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

@@ -0,0 +1,3 @@
+export type AppleVerifyTransactionId = {
+    apple_transaction_id: string;
+};

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

@@ -0,0 +1,15 @@
+import type { AcceptanceEnum } from './AcceptanceEnum';
+export type Assertion = {
+    entityId: string;
+    issuedOn: string;
+    readonly credentialDetails: Record<string, string>;
+    readonly recipient: Record<string, string>;
+    metadata?: any;
+    readonly course: Record<string, string>;
+    readonly program: Record<string, string>;
+    narrative?: string | null;
+    revoked?: boolean;
+    revocationReason: string;
+    acceptance?: AcceptanceEnum;
+    expires: string;
+};

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

@@ -0,0 +1,5 @@
+export type AssociateAccountResponse = {
+    success?: boolean;
+    message: any;
+    data: any;
+};

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

@@ -0,0 +1,3 @@
+export type AssociateAppleAccount = {
+    app_receipt: string;
+};

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

@@ -0,0 +1,10 @@
+export type AuthToken = {
+    /**
+     * Token
+     */
+    token: string;
+    /**
+     * Token Expiration Date
+     */
+    expires: string;
+};

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

@@ -0,0 +1,4 @@
+import type { AverageData } from './AverageData';
+export type Average = {
+    data: AverageData;
+};

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

@@ -0,0 +1,6 @@
+export type AverageData = {
+    /**
+     * Average
+     */
+    average: number;
+};

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

@@ -0,0 +1,22 @@
+/**
+ * Returns
+ * {
+     * "data": {
+         * "2022-04-26": 0,
+         * "2022-04-27": 0,
+         * ...
+         * "2023-01-01": 0
+         * },
+         * "average": 0
+         * }
+         */
+export type AverageOvertime = {
+    /**
+     * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
+     */
+    data?: Record<string, any>;
+    /**
+     * average
+     */
+    average?: number;
+};

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

@@ -0,0 +1,4 @@
+import type { AvgCourseGradeWithCutoffData } from './AvgCourseGradeWithCutoffData';
+export type AvgCourseGradeWithCutoff = {
+    data?: AvgCourseGradeWithCutoffData;
+};

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

@@ -0,0 +1,10 @@
+export type AvgCourseGradeWithCutoffData = {
+    /**
+     * Dictionary showing grade cutoffs
+     */
+    grade_cutoffs: Record<string, any>;
+    /**
+     * Course Average grade
+     */
+    average_grade: number;
+};

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

@@ -0,0 +1,5 @@
+export type BaseErrorResponse = {
+    success?: boolean;
+    message: any;
+    data?: any;
+};

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

@@ -0,0 +1,5 @@
+export type BaseResponse = {
+    success?: boolean;
+    message: any;
+    data?: any;
+};

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for BlankCourseInvitationView POST endpoint
+ */
+export type BlankCourseInvitationCreate = {
+    /**
+     * The course to create invitations for
+     */
+    course_id: string;
+    /**
+     * The source identifier for the invitations
+     */
+    source: string;
+    /**
+     * The number of blank invitations to create
+     */
+    count: number;
+    /**
+     * Additional metadata for the invitations
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,2 @@
+export declare enum BlankEnum {
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for BlankPlatformInvitationView POST endpoint
+ */
+export type BlankPlatformInvitationCreate = {
+    /**
+     * The platform to create invitations for
+     */
+    platform_key: string;
+    /**
+     * The source identifier for the invitations
+     */
+    source: string;
+    /**
+     * The number of blank invitations to create
+     */
+    count: number;
+    /**
+     * Additional metadata for the invitations
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,21 @@
+/**
+ * Request serializer for BlankProgramInvitationView POST endpoint
+ */
+export type BlankProgramInvitationCreate = {
+    /**
+     * The program to create invitations for
+     */
+    program_key: string;
+    /**
+     * The source identifier for the invitations
+     */
+    source: string;
+    /**
+     * The number of blank invitations to create
+     */
+    count: number;
+    /**
+     * Additional metadata for the invitations
+     */
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,18 @@
+/**
+ * Request serializer for BlockSkillPointInfoView POST endpoint.
+ * Validates request body for updating block skill point information.
+ */
+export type BlockSkillPointInfoRequest = {
+    /**
+     * ID of the block to update skill point information for
+     */
+    block_id: string;
+    /**
+     * Dictionary mapping skill names to point values. Example: {'skill_name': 5}
+     */
+    point_data: Record<string, number>;
+    /**
+     * If True, removes all skills not in point_data. If False, only updates specified skills.
+     */
+    overwrite?: boolean;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Response serializer for BlockSkillPointInfoView GET endpoint.
+ * Returns a mapping of skill names/objects to their point values.
+ */
+export type BlockSkillPointInfoResponse = {
+    /**
+     * Dictionary mapping skill names/objects to point values. Keys are skill names (or skill objects if get_obj=True)
+     */
+    skill_points: Record<string, number>;
+};

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

@@ -0,0 +1,14 @@
+import type { CourseInvitationCreate } from './CourseInvitationCreate';
+/**
+ * Request serializer for BulkCourseInvitationView POST endpoint
+ */
+export type BulkCourseInvitationCreate = {
+    /**
+     * List of invitation data objects
+     */
+    invitation_data: Array<CourseInvitationCreate>;
+    /**
+     * The platform key for permission validation
+     */
+    platform_key?: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for bulk invitation creation
+ */
+export type BulkCourseInvitationResponse = {
+    /**
+     * Number of successfully created invitations
+     */
+    successes: number;
+    /**
+     * List of error codes for failed invitations
+     */
+    error_codes: Array<string>;
+};

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

@@ -0,0 +1,4 @@
+export type BulkCreateAssertion = {
+    skipped: Array<any>;
+    issued: Array<any>;
+};

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

@@ -0,0 +1,14 @@
+import type { PlatformInvitationCreate } from './PlatformInvitationCreate';
+/**
+ * Request serializer for BulkPlatformInvitationView POST endpoint
+ */
+export type BulkPlatformInvitationCreate = {
+    /**
+     * List of invitation data objects
+     */
+    invitation_data: Array<PlatformInvitationCreate>;
+    /**
+     * The platform key for permission validation
+     */
+    platform_key?: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for bulk invitation creation
+ */
+export type BulkPlatformInvitationResponse = {
+    /**
+     * Number of successfully created invitations
+     */
+    successes: number;
+    /**
+     * List of error codes for failed invitations
+     */
+    error_codes: Array<string>;
+};

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

@@ -0,0 +1,14 @@
+import type { ProgramInvitationCreate } from './ProgramInvitationCreate';
+/**
+ * Request serializer for BulkProgramInvitationView POST endpoint
+ */
+export type BulkProgramInvitationCreate = {
+    /**
+     * List of invitation data objects
+     */
+    invitation_data: Array<ProgramInvitationCreate>;
+    /**
+     * The platform key for permission validation
+     */
+    platform_key?: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for bulk invitation creation
+ */
+export type BulkProgramInvitationResponse = {
+    /**
+     * Number of successfully created invitations
+     */
+    successes: number;
+    /**
+     * List of error codes for failed invitations
+     */
+    error_codes: Array<string>;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Response serializer for bulk suggestion operation results
+ */
+export type BulkSuggestionResponse = {
+    /**
+     * Number of successfully created suggestions
+     */
+    successes: number;
+    /**
+     * List of error codes for failed suggestions
+     */
+    error_codes: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Serializer for campaign enablement requests.
+ */
+export type CampaignEnablement = {
+    campaign_id?: number;
+    campaign_title?: string;
+    email?: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Serializer for campaign exclusion requests.
+ */
+export type CampaignExclusion = {
+    campaign_id?: number;
+    campaign_title?: string;
+    email?: string;
+};

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

@@ -0,0 +1,25 @@
+/**
+ * Serializer for auto increment information response.
+ */
+export type CatalogAutoIncrementResponse = {
+    /**
+     * Platform key identifier
+     */
+    platform_key: string;
+    /**
+     * Platform organization identifier
+     */
+    platform_org: string;
+    /**
+     * Current course number
+     */
+    course_number: number;
+    /**
+     * Current program number
+     */
+    program_number: number;
+    /**
+     * Current pathway number
+     */
+    pathway_number: number;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for auto increment update request parameters.
+ */
+export type CatalogAutoIncrementUpdateRequest = {
+    /**
+     * Platform key identifier
+     */
+    key?: string;
+    /**
+     * Platform organization identifier
+     */
+    org?: string;
+    /**
+     * Type of number requested (e.g., course, program, pathway)
+     */
+    number_type: string;
+};

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

@@ -0,0 +1,5 @@
+import type { CeleryHeartbeatStatusEnum } from './CeleryHeartbeatStatusEnum';
+export type CeleryHeartbeat = {
+    status: CeleryHeartbeatStatusEnum;
+    message: string;
+};

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

@@ -0,0 +1,5 @@
+import type { CeleryHeartbeatFailStatusEnum } from './CeleryHeartbeatFailStatusEnum';
+export type CeleryHeartbeatFail = {
+    status: CeleryHeartbeatFailStatusEnum;
+    message: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `unhealthy` - unhealthy
+ * * `healthy` - healthy
+ */
+export declare enum CeleryHeartbeatFailStatusEnum {
+    UNHEALTHY = "unhealthy",
+    HEALTHY = "healthy"
+}

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

@@ -0,0 +1,8 @@
+/**
+ * * `healthy` - healthy
+ * * `unhealthy` - unhealthy
+ */
+export declare enum CeleryHeartbeatStatusEnum {
+    HEALTHY = "healthy",
+    UNHEALTHY = "unhealthy"
+}

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

@@ -0,0 +1,23 @@
+import type { UserInfo } from './UserInfo';
+export type Company = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly user_info: UserInfo;
+    name: string;
+    industry?: string | null;
+    website?: string | null;
+    logo_url?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,7 @@
+/**
+ * Response serializer for context endpoint
+ */
+export type ContextResponse = {
+    status: string;
+    data: Record<string, any>;
+};

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

@@ -0,0 +1,4 @@
+import type { CountData } from './CountData';
+export type Count = {
+    data: CountData;
+};

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

@@ -0,0 +1,6 @@
+export type CountData = {
+    /**
+     * Total
+     */
+    count: number;
+};

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

@@ -0,0 +1,15 @@
+export type Course = {
+    /**
+     * The edX course ID string for the course.
+     */
+    readonly course_id: string;
+    /**
+     * The display name of the course. (Should match edX)
+     */
+    readonly name: string;
+    /**
+     * An additional unique slug field. (Optional)
+     */
+    readonly slug: string | null;
+    org?: string;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Request serializer for CourseLicenseAccessRequestUserView POST endpoint
+ */
+export type CourseAccessRequestCreate = {
+    /**
+     * The unique identifier for the platform
+     */
+    platform_key?: string;
+    /**
+     * The organization identifier for the platform
+     */
+    platform_org?: string;
+    /**
+     * The unique identifier for the course
+     */
+    course_id: string;
+};

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

@@ -0,0 +1,49 @@
+/**
+ * Response serializer for access request details
+ */
+export type CourseAccessRequestDetail = {
+    /**
+     * The unique identifier for the access request
+     */
+    id: number;
+    /**
+     * The ID of the user who made the request
+     */
+    user_id: number;
+    /**
+     * The username of the user who made the request
+     */
+    username: string;
+    /**
+     * The full name of the user who made the request
+     */
+    name: string;
+    /**
+     * Whether the request has been approved (null if not reviewed)
+     */
+    approved: boolean | null;
+    /**
+     * Whether the request has been reviewed
+     */
+    reviewed: boolean;
+    /**
+     * When the request was created
+     */
+    created: string;
+    /**
+     * When the request was last modified
+     */
+    modified: string;
+    /**
+     * Additional metadata for the request
+     */
+    metadata?: Record<string, any>;
+    /**
+     * The platform key associated with the request
+     */
+    platform_key: string;
+    /**
+     * The course ID associated with the request
+     */
+    course_id: string;
+};