@iblai/iblai-api 3.34.5-core

package/src/models/AcceptanceEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `Unaccepted` - Unaccepted
+ * * `Accepted` - Accepted
+ * * `Rejected` - Rejected
+ */
+export enum AcceptanceEnum {
+    UNACCEPTED = 'Unaccepted',
+    ACCEPTED = 'Accepted',
+    REJECTED = 'Rejected',
+}

package/src/models/ActiveUsersData.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ActiveUsersData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner name
+     */
+    name: string;
+    /**
+     * Engagement index
+     */
+    engagement_index: number;
+    /**
+     * Performance index
+     */
+    performance_index: number;
+};
+

package/src/models/ActiveUsersList.ts

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

package/src/models/ActiveUsersPerCourse.ts

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

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ActiveUsersPerCourseData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Active users for the period
+     */
+    user_count: number;
+};
+

package/src/models/ActivityAPI.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ActivityData } from './ActivityData';
+export type ActivityAPI = {
+    data?: Array<ActivityData>;
+    /**
+     * Total rows
+     */
+    total: number;
+};
+

package/src/models/ActivityData.ts

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

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

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

package/src/models/AverageData.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type AverageData = {
+    /**
+     * Average
+     */
+    average: number;
+};
+

package/src/models/AverageOvertime.ts

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

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

package/src/models/AvgCourseGradeWithCutoffData.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type AvgCourseGradeWithCutoffData = {
+    /**
+     * Dictionary showing grade cutoffs
+     */
+    grade_cutoffs: Record<string, any>;
+    /**
+     * Course Average grade
+     */
+    average_grade: number;
+};
+

package/src/models/BlankEnum.ts

@@ -0,0 +1,7 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export enum BlankEnum {
+    = '',
+}

package/src/models/BulkCreateAssertion.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type BulkCreateAssertion = {
+    skipped: Array<any>;
+    issued: Array<any>;
+};
+

package/src/models/CampaignEnablement.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for campaign enablement requests.
+ */
+export type CampaignEnablement = {
+    campaign_id?: number;
+    campaign_title?: string;
+    email?: string;
+};
+

package/src/models/CampaignExclusion.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for campaign exclusion requests.
+ */
+export type CampaignExclusion = {
+    campaign_id?: number;
+    campaign_title?: string;
+    email?: string;
+};
+

package/src/models/Company.ts

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

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for context endpoint
+ */
+export type ContextResponse = {
+    status: string;
+    data: Record<string, any>;
+};
+

package/src/models/Count.ts

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

package/src/models/CountData.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CountData = {
+    /**
+     * Total
+     */
+    count: number;
+};
+

package/src/models/CourseCompletionPerCourse.ts

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

package/src/models/CourseCompletionPerCourseData.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CourseCompletionPerCourseData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Number of enrollments
+     */
+    enrollments: number;
+    /**
+     * Number of completions
+     */
+    completions: number;
+    /**
+     * Average Completions.
+     */
+    average: number;
+};
+

package/src/models/CourseCompletionSummaryDataOvertime.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CourseCompletionSummaryDataOvertime = {
+    /**
+     * Dates are keys and values are the value for the date in the key. e,g `{"2020-01-01": 30. ...}`
+     */
+    overtime?: Record<string, any>;
+    /**
+     * Total unique active users in this period
+     */
+    total_user_count: number;
+    /**
+     * Total course completions
+     */
+    completed_count: number;
+    /**
+     * Completion percent for the time range
+     */
+    completed_percent: number;
+};
+

package/src/models/CourseCompletionSummaryOvertime.ts

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

package/src/models/CourseGradeDetailBlock.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CourseGradeDetailBlock = {
+    /**
+     * Block name
+     */
+    display_name: string;
+    /**
+     * Block Id
+     */
+    id: string;
+    /**
+     * Total users who have attempted it
+     */
+    attempts?: string;
+    /**
+     * Average block value
+     */
+    average: string;
+};
+

package/src/models/CourseGradeDetailSubSection.ts

@@ -0,0 +1,28 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseGradeDetailBlock } from './CourseGradeDetailBlock';
+export type CourseGradeDetailSubSection = {
+    /**
+     * Block name
+     */
+    display_name: string;
+    /**
+     * Block Id
+     */
+    id: string;
+    /**
+     * Total users who have attempted it
+     */
+    attempts?: string;
+    /**
+     * Average block value
+     */
+    average: string;
+    /**
+     * Problems in section
+     */
+    problems?: Array<CourseGradeDetailBlock>;
+};
+

package/src/models/CourseGradeSummary.ts

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

package/src/models/CourseGradeSummaryData.ts

@@ -0,0 +1,23 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CourseGradeSummaryData = {
+    /**
+     * Assignment Type name
+     */
+    assignment_type: string;
+    /**
+     * Assignment weight
+     */
+    weight: number;
+    /**
+     * Assignment weighted grade average in course
+     */
+    average_weighted_grade: number;
+    /**
+     * Assignment section grade average in course
+     */
+    average_section_grade: number;
+};
+

package/src/models/CourseGradingDetail.ts

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

package/src/models/CourseGradingDetailData.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseGradeDetailSubSection } from './CourseGradeDetailSubSection';
+export type CourseGradingDetailData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<CourseGradeDetailSubSection>;
+};
+

package/src/models/CoursePoint.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CoursePoint = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    points: number;
+};
+

package/src/models/CourseSkill.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Skill } from './Skill';
+export type CourseSkill = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    skills: Array<Skill>;
+};
+

package/src/models/Credential.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Credential = {
+    entityId: string;
+    name: string;
+    name_override?: string | null;
+    description?: string | null;
+    criteriaUrl: string;
+    criteriaNarrative: string;
+    createdAt: string;
+    readonly iconImage: string;
+    icon_image_id: number;
+    readonly backgroundImage: string;
+    background_image_id: number;
+    readonly thumbnailImage: string;
+    thumbnail_image_id: number;
+    readonly catalog_items: Array<string>;
+    readonly courses: Array<Record<string, string>>;
+    readonly programs: string;
+    readonly issuerDetails: Record<string, string>;
+    html_template?: string | null;
+    css_template?: string | null;
+    metadata?: any;
+    credentialType: string;
+    readonly expires: Record<string, number>;
+    tags?: any;
+    readonly signatories: Array<Record<string, string>>;
+    signal: string;
+    readonly pathways: Array<Record<string, string>>;
+};
+

package/src/models/DesiredSkill.ts

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

package/src/models/DetailedGradeSubsection.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type DetailedGradeSubsection = {
+    /**
+     * Subsection name
+     */
+    display_name: string;
+    /**
+     * Subsection Id
+     */
+    id: string;
+    /**
+     * Subsection earned mark
+     */
+    graded_earned: string;
+    /**
+     * Subsection Possible Mark
+     */
+    graded_possible: string;
+    /**
+     * Subsection Grade
+     */
+    graded_percent: string;
+};
+

package/src/models/DetailedGradeView.ts

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