@iblai/iblai-api 3.34.5-core

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

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

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

@@ -0,0 +1,4 @@
+import type { CourseGradeSummaryData } from './CourseGradeSummaryData';
+export type CourseGradeSummary = {
+    data?: Array<CourseGradeSummaryData>;
+};

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

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

@@ -0,0 +1,4 @@
+import type { CourseGradingDetailData } from './CourseGradingDetailData';
+export type CourseGradingDetail = {
+    data?: Array<CourseGradingDetailData>;
+};

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

@@ -0,0 +1,12 @@
+import type { CourseGradeDetailSubSection } from './CourseGradeDetailSubSection';
+export type CourseGradingDetailData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    subsections?: Array<CourseGradeDetailSubSection>;
+};

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

@@ -0,0 +1,7 @@
+export type CoursePoint = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    points: number;
+};

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

@@ -0,0 +1,8 @@
+import type { Skill } from './Skill';
+export type CourseSkill = {
+    /**
+     * The edX course ID string for the course.
+     */
+    course_id: string;
+    skills: Array<Skill>;
+};

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

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

@@ -0,0 +1,4 @@
+import type { Skill } from './Skill';
+export type DesiredSkill = {
+    skills: Array<Skill>;
+};

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

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

@@ -0,0 +1,4 @@
+import type { DetailedGradeViewData } from './DetailedGradeViewData';
+export type DetailedGradeView = {
+    data?: Array<DetailedGradeViewData>;
+};

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

@@ -0,0 +1,12 @@
+import type { DetailedGradeSubsection } from './DetailedGradeSubsection';
+export type DetailedGradeViewData = {
+    /**
+     * Chapter name
+     */
+    display_name: string;
+    /**
+     * Chapter Id
+     */
+    id: string;
+    children?: Array<DetailedGradeSubsection>;
+};

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

@@ -0,0 +1,30 @@
+import type { Institution } from './Institution';
+import type { UserInfo } from './UserInfo';
+export type Education = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly user_info: UserInfo;
+    readonly institution: Institution;
+    institution_id: number;
+    degree?: string | null;
+    field_of_study?: string | null;
+    start_date: string;
+    end_date?: string | null;
+    grade?: string | null;
+    activities?: string | null;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+    is_current?: boolean | null;
+};

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

@@ -0,0 +1,6 @@
+import type { EngagementPerCourseData } from './EngagementPerCourseData';
+import type { Pagination } from './Pagination';
+export type EngagementPerCourse = {
+    data?: Array<EngagementPerCourseData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,26 @@
+export type EngagementPerCourseData = {
+    /**
+     * edx Course Id
+     */
+    course_id: string;
+    /**
+     * Course start date
+     */
+    course_start: string;
+    /**
+     * Course end date
+     */
+    course_end: string;
+    /**
+     * Average days spent by each learners on the course
+     */
+    average_days: number;
+    /**
+     * Average days spent by learner on the course
+     */
+    average_time_spent: number;
+    /**
+     * Course name
+     */
+    name: string;
+};

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

@@ -0,0 +1,8 @@
+import type { EnrollmentsData } from './EnrollmentsData';
+import type { OvertimeMeta } from './OvertimeMeta';
+import type { Pagination } from './Pagination';
+export type Enrollments = {
+    data?: Array<EnrollmentsData>;
+    pagination: Pagination;
+    meta?: OvertimeMeta;
+};

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

@@ -0,0 +1,18 @@
+export type EnrollmentsData = {
+    /**
+     * Edx Course ID
+     */
+    course_id: string;
+    /**
+     * Course Name
+     */
+    name: string;
+    /**
+     * Number of users
+     */
+    users: number;
+    /**
+     * Percentage ...
+     */
+    percentage: number;
+};

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

@@ -0,0 +1,6 @@
+import type { EnrollmentsPerUserData } from './EnrollmentsPerUserData';
+import type { Pagination } from './Pagination';
+export type EnrollmentsPerUser = {
+    data?: Array<EnrollmentsPerUserData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,18 @@
+export type EnrollmentsPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Email
+     */
+    email: string;
+    /**
+     * Course start date
+     */
+    timestamp: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * Generic error response serializer
+ */
+export type ErrorResponse = {
+    status: string;
+    message: string;
+    details?: any;
+};

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

@@ -0,0 +1,29 @@
+import type { Company } from './Company';
+import type { UserInfo } from './UserInfo';
+export type Experience = {
+    readonly id: number;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly user_info: UserInfo;
+    readonly company: Company;
+    company_id: number;
+    title: string;
+    employment_type?: string | null;
+    location?: string | null;
+    start_date: string;
+    end_date?: string | null;
+    is_current?: boolean;
+    description?: string | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,10 @@
+export type FloatOverTime = {
+    /**
+     * Date of event
+     */
+    date: string;
+    /**
+     * Total quantity for date
+     */
+    total: number;
+};

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

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

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

@@ -0,0 +1,26 @@
+export type GradingPerUserData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    full_name: string;
+    /**
+     * Course enrollment date
+     */
+    start_date: string;
+    /**
+     * Total assessment submissions
+     */
+    submissions: number;
+    /**
+     * Last active time
+     */
+    last_active: string;
+    /**
+     * TStudent course grade
+     */
+    percent: number;
+};

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

@@ -0,0 +1,6 @@
+import type { GroupListData } from './GroupListData';
+import type { Pagination } from './Pagination';
+export type GroupList = {
+    data?: Array<GroupListData>;
+    pagination: Pagination;
+};

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

@@ -0,0 +1,16 @@
+/**
+ * Serializer for department list endpoint
+ */
+export type GroupListData = {
+    id: number;
+    name: string;
+    platform: string;
+    courses_enrolled: number;
+    courses_completed: number;
+    completion_rate: number;
+    pathways_completed: number;
+    certificates_earned: number;
+    skills_points: number;
+    skills_earned: number;
+    time_spent: string;
+};

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

@@ -0,0 +1,3 @@
+export type ImageUpload = {
+    file: string;
+};

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

@@ -0,0 +1,20 @@
+import type { InstitutionTypeEnum } from './InstitutionTypeEnum';
+export type Institution = {
+    readonly id: number;
+    name: string;
+    institution_type?: InstitutionTypeEnum;
+    location?: string | null;
+    website?: string | null;
+    accreditation?: string | null;
+    established_year?: number | null;
+    /**
+     * Metadata
+     */
+    data?: any;
+    /**
+     * Metadata
+     */
+    metadata?: any;
+    created_at?: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * * `university` - University
+ * * `college` - College
+ * * `institute` - Institute
+ * * `academy` - Academy
+ * * `other` - Other
+ */
+export declare enum InstitutionTypeEnum {
+    UNIVERSITY = "university",
+    COLLEGE = "college",
+    INSTITUTE = "institute",
+    ACADEMY = "academy",
+    OTHER = "other"
+}

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

@@ -0,0 +1,9 @@
+export type Issuer = {
+    readonly name: string;
+    readonly org: string;
+    entityId: string;
+    readonly signatories: Record<string, string>;
+    readonly url: string;
+    iconImage: string;
+    allowed_template_tags?: any;
+};

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

@@ -0,0 +1,5 @@
+export type IssuerAuthority = {
+    name: string;
+    title: string;
+    signature: string;
+};

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

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

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

@@ -0,0 +1,83 @@
+export type LearnerInformationAPIData = {
+    /**
+     * learner username
+     */
+    username: string;
+    /**
+     * learner Name
+     */
+    name: string;
+    /**
+     * learner email
+     */
+    email: string;
+    /**
+     * Registration Timestamp e.g 2022-05-05T00:00:00+00:00
+     */
+    date_joined: string;
+    /**
+     * Last Activity Timestamp e.g 2022-05-05T00:00:00+00:00
+     */
+    last_activity: string;
+    /**
+     * Total assessments attempted
+     */
+    total_assessments?: number;
+    /**
+     * Total time spent in seconds
+     */
+    total_time_spent?: number;
+    /**
+     * Total videos watched
+     */
+    total_videos?: number;
+    /**
+     * Total courses completed
+     */
+    course_completions?: number;
+    time_spent_overtime?: Record<string, any>;
+    /**
+     * last location - continent
+     */
+    continent?: string;
+    /**
+     * last location - continent code
+     */
+    continent_code?: string;
+    /**
+     * last location - country
+     */
+    country?: string;
+    /**
+     * last location - country code
+     */
+    country_code?: string;
+    /**
+     * last location - region
+     */
+    region?: string;
+    /**
+     * last location - region code
+     */
+    region_code?: string;
+    /**
+     * last location
+     */
+    location?: string;
+    /**
+     * last location - city
+     */
+    city?: string;
+    /**
+     * last known browser
+     */
+    browser?: string;
+    /**
+     * last known operating system
+     */
+    operating_system?: string;
+    /**
+     * last known browser resolution
+     */
+    resolution?: string;
+};

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

@@ -0,0 +1,19 @@
+export type LtiKey = {
+    readonly id: number;
+    /**
+     * Name of the RSA Key
+     */
+    name: string;
+    /**
+     * Public Key in PEM format
+     */
+    readonly public_key: string;
+    /**
+     * Public key in JWK format
+     */
+    readonly public_jwk: any;
+    /**
+     * Platform Key
+     */
+    platform_key: string;
+};

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

@@ -0,0 +1,8 @@
+export type LtiLaunchGate = {
+    allowed_keys?: Array<string>;
+    allowed_courses?: Array<string>;
+    /**
+     * If True, a target_link_uri will work with any content within this org
+     */
+    allow_all_within_org?: boolean;
+};

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

@@ -0,0 +1,46 @@
+import type { LtiLaunchGate } from './LtiLaunchGate';
+export type LtiTool = {
+    readonly id: number;
+    /**
+     * The title of the tool
+     */
+    title: string;
+    /**
+     * This value will look someting like https://example.com. Value provided by Lti 1.3 Platform.
+     */
+    issuer: string;
+    /**
+     * The client id provided by Lti 1.3 Platform
+     */
+    client_id: string;
+    /**
+     * The Platforms OIDC Login endpoint. Value provided by LTI 1.3 Platform.
+     */
+    auth_login_url: string;
+    /**
+     * The Platforms OIDC Token endpoint. Value provided by LTI 1.3 Platform.
+     */
+    auth_token_url: string;
+    /**
+     * The platforms Oauth2 Audience (aud). Usually can be skipped.
+     */
+    auth_audience?: string | null;
+    /**
+     * The platforms JWKS endpoint. Value provided by LTI 1.3 Platform.
+     */
+    key_set_url?: string | null;
+    /**
+     * In case Platform's JWKS endpoint is not available, you can provide the JWKS here. Value provided by LTI 1.3 Platform.
+     */
+    key_set?: any;
+    /**
+     * Reference to Lti Tool
+     */
+    tool_key: number;
+    /**
+     * List of deployment ids. Example: ["1", "deployment-2"]. Value(s) provided by LTI 1.3 Platform.
+     */
+    deployment_ids: Array<string>;
+    platform_key: string;
+    launch_gate: LtiLaunchGate;
+};

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

@@ -0,0 +1,8 @@
+import type { FloatOverTime } from './FloatOverTime';
+export type NetRevenueOverTime = {
+    data?: Array<FloatOverTime>;
+    /**
+     * Grand total of all data
+     */
+    total?: number;
+};

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

@@ -0,0 +1,6 @@
+import type { NewPerLearnerListData } from './NewPerLearnerListData';
+import type { Pagination } from './Pagination';
+export type NewPerLearnerList = {
+    data?: Array<NewPerLearnerListData>;
+    pagination: Pagination;
+};