@uptime.app/contracts 3.0.38-rc.0 → 3.0.38

package/src/learn-upon/learn-upon-course-enrollment-events.ts

@@ -1,21 +1,21 @@
-import { LearnUponCourseEnrollment } from './learn-upon-course-enrollment';
-
-export interface LearnUponCourseEnrollmentCreatedEvent {
-    id: string;
-    type: 'LearnUponCourseEnrollmentCreated';
-    payload: LearnUponCourseEnrollment;
-}
-
-export interface LearnUponCourseEnrollmentUpdatedEvent {
-    id: string;
-    type: 'LearnUponCourseEnrollmentUpdated';
-    payload: LearnUponCourseEnrollment;
-}
-
-export interface LearnUponCourseEnrollmentDeletedEvent {
-    id: string;
-    type: 'LearnUponCourseEnrollmentDeleted';
-    payload: LearnUponCourseEnrollment;
-}
-
-export type LearnUponCourseEnrollmentChangedEvent = LearnUponCourseEnrollmentCreatedEvent | LearnUponCourseEnrollmentUpdatedEvent | LearnUponCourseEnrollmentDeletedEvent;
+import { LearnUponCourseEnrollment } from './learn-upon-course-enrollment';
+
+export interface LearnUponCourseEnrollmentCreatedEvent {
+    id: string;
+    type: 'LearnUponCourseEnrollmentCreated';
+    payload: LearnUponCourseEnrollment;
+}
+
+export interface LearnUponCourseEnrollmentUpdatedEvent {
+    id: string;
+    type: 'LearnUponCourseEnrollmentUpdated';
+    payload: LearnUponCourseEnrollment;
+}
+
+export interface LearnUponCourseEnrollmentDeletedEvent {
+    id: string;
+    type: 'LearnUponCourseEnrollmentDeleted';
+    payload: LearnUponCourseEnrollment;
+}
+
+export type LearnUponCourseEnrollmentChangedEvent = LearnUponCourseEnrollmentCreatedEvent | LearnUponCourseEnrollmentUpdatedEvent | LearnUponCourseEnrollmentDeletedEvent;

package/src/learn-upon/learn-upon-course-enrollment.ts

@@ -1,63 +1,63 @@
-
-export interface LearnUponCourseEnrollment {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    uptimeCourseId: string;
-    uptimeLearnUponPortalId: string;
-    uptimeUserId: string;
-
-    /** The enrollment status of the learner */
-    status: LearnUponCourseEnrollmentStatus;
-
-    /** The date the user started the course, in UTC format */
-    startedAt?: string;
-
-    /** The date the user finished the course, in UTC format */
-    completedAt?: string;
-
-    /** The date the user last accessed the course, in UTC format */
-    lastAccessedAt?: string;
-
-    /** The date the user was enrolled on the course, in UTC format */
-    enrolledAt: string;
-
-    /** If set, date when access to the course expires for the learner, in UTC format */
-    accessExpiresAt?: string;
-
-    /** If set, the date by which the learner must complete the course, in UTC format */
-    dueDate?: string;
-
-    /** Name of any certificate the user receives for completion */
-    certificateName?: string;
-
-    /** If set, when the certification expires */
-    certificationExpiresAt?: string;
-
-    /** If set to true, indicates that recertification policies on your course certificate applied on this enrollment */
-    wasRecertified: boolean;
-
-    /** The number of modules the learner has completed, as a percentage of the number of modules in the course */
-    percentageComplete: number;
-
-    /** The score achieved by the learner */
-    percentageScore?: number;
-
-    /** Indicates if a user's completed course was unenrolled */
-    unenrolled: boolean;
-
-    /** Indicates if the enrollment came through the portal catalog. Default is false */
-    fromCatalog: boolean;
-
-    /** Indicates when the enrollment was last updated, in UTC format */
-    enrollmentUpdatedAt: string;
-}
-
-export type LearnUponCourseEnrollmentStatus =
-    | 'not_started'
-    | 'in_progress'
-    | 'completed'
-    | 'passed'
-    | 'failed'
+
+export interface LearnUponCourseEnrollment {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    uptimeCourseId: string;
+    uptimeLearnUponPortalId: string;
+    uptimeUserId: string;
+
+    /** The enrollment status of the learner */
+    status: LearnUponCourseEnrollmentStatus;
+
+    /** The date the user started the course, in UTC format */
+    startedAt?: string;
+
+    /** The date the user finished the course, in UTC format */
+    completedAt?: string;
+
+    /** The date the user last accessed the course, in UTC format */
+    lastAccessedAt?: string;
+
+    /** The date the user was enrolled on the course, in UTC format */
+    enrolledAt: string;
+
+    /** If set, date when access to the course expires for the learner, in UTC format */
+    accessExpiresAt?: string;
+
+    /** If set, the date by which the learner must complete the course, in UTC format */
+    dueDate?: string;
+
+    /** Name of any certificate the user receives for completion */
+    certificateName?: string;
+
+    /** If set, when the certification expires */
+    certificationExpiresAt?: string;
+
+    /** If set to true, indicates that recertification policies on your course certificate applied on this enrollment */
+    wasRecertified: boolean;
+
+    /** The number of modules the learner has completed, as a percentage of the number of modules in the course */
+    percentageComplete: number;
+
+    /** The score achieved by the learner */
+    percentageScore?: number;
+
+    /** Indicates if a user's completed course was unenrolled */
+    unenrolled: boolean;
+
+    /** Indicates if the enrollment came through the portal catalog. Default is false */
+    fromCatalog: boolean;
+
+    /** Indicates when the enrollment was last updated, in UTC format */
+    enrollmentUpdatedAt: string;
+}
+
+export type LearnUponCourseEnrollmentStatus =
+    | 'not_started'
+    | 'in_progress'
+    | 'completed'
+    | 'passed'
+    | 'failed'
     | 'pending_review';

package/src/learn-upon/learn-upon-course-events.ts

@@ -1,21 +1,21 @@
-import { LearnUponCourse } from './learn-upon-course';
-
-export interface LearnUponCourseCreatedEvent {
-    id: string;
-    type: 'LearnUponCourseCreated';
-    payload: LearnUponCourse;
-}
-
-export interface LearnUponCourseUpdatedEvent {
-    id: string;
-    type: 'LearnUponCourseUpdated';
-    payload: LearnUponCourse;
-}
-
-export interface LearnUponCourseDeletedEvent {
-    id: string;
-    type: 'LearnUponCourseDeleted';
-    payload: LearnUponCourse;
-}
-
-export type LearnUponCourseChangedEvent = LearnUponCourseCreatedEvent | LearnUponCourseUpdatedEvent | LearnUponCourseDeletedEvent;
+import { LearnUponCourse } from './learn-upon-course';
+
+export interface LearnUponCourseCreatedEvent {
+    id: string;
+    type: 'LearnUponCourseCreated';
+    payload: LearnUponCourse;
+}
+
+export interface LearnUponCourseUpdatedEvent {
+    id: string;
+    type: 'LearnUponCourseUpdated';
+    payload: LearnUponCourse;
+}
+
+export interface LearnUponCourseDeletedEvent {
+    id: string;
+    type: 'LearnUponCourseDeleted';
+    payload: LearnUponCourse;
+}
+
+export type LearnUponCourseChangedEvent = LearnUponCourseCreatedEvent | LearnUponCourseUpdatedEvent | LearnUponCourseDeletedEvent;

package/src/learn-upon/learn-upon-course.ts

@@ -1,109 +1,109 @@
-export interface LearnUponCourse {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    uptimeLearnUponPortalId: string;
-
-    /** Unique identifier numeric for the course in LearnUpon */
-    courseId: number;
-
-    /** The title of the course */
-    name: string;
-
-    /** If you have course reference codes enabled on your portal, this attribute contains the references and data from that attribute */
-    referenceCode?: string;
-
-    /** If you have keywords added to your course, they appear here */
-    keywords?: string;
-
-    /** The short description, which appears on the My Courses page or the catalog */
-    shortDescription?: string;
-
-    /** The date and time that the course was first published, in UTC format */
-    publishedAt?: string;
-
-    /** The version of the course */
-    courseVersion?: number;
-
-    /** The status of the course: Published, Under Revision, Archived or Deleted */
-    status: 'published' | 'draft' | 'archived' | 'under_revision' | 'deleted';
-
-    /** The main thumbnail image URL for the course */
-    thumbnailImageUrl?: string;
-
-    /** Indicates if the course is available in the internal catalog (true). Default value is false */
-    isCataloged?: boolean;
-
-    /** The list of modules and module types in the course */
-    modules?: Array<{
-        /** Unique id of the module in LearnUpon */
-        id: number;
-        /** The type of the module: values include module, page, exam, scorm, tincan, assignment, survey, checklist, training, event */
-        type: string;
-        /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
-        isKnowledgeCheck?: boolean;
-        /** Legacy ILTs only: start date and time that the ILT session is scheduled, in UTC format */
-        startAt?: string;
-        /** Legacy ILTs only: end date and time that the ILT session is scheduled to complete, in UTC format */
-        endAt?: string;
-        /** Legacy ILTs only: the maximum number of learners allowed to attend the ILT session */
-        maxCapacity?: number;
-    }>;
-
-    /** Number of modules in this course */
-    moduleCount?: number;
-
-    /** The course due date, or set number of days to complete the course after an enrollment for a learner */
-    dueDateDays?: number;
-    dueDateDate?: string;
-
-    /** The course expiry date, or set number of days before an enrollment expires after an enrollment for a learner */
-    accessExpiresDays?: number;
-    accessExpiresDate?: string;
-
-    /** The difficulty level set on your course: one of not_applicable, basic, intermediate or advanced */
-    difficulty: 'not_applicable' | 'basic' | 'intermediate' | 'advanced';
-
-    /** The course length if specified */
-    length?: number;
-    lengthUnit?: string;
-
-    /** If learners can get a certificate on this course, this attribute contains the information */
-    certificate?: {
-        /** The name of the certificate awarded to a learner, on successful completion of the course */
-        certificateName?: string;
-        /** The set number of days before a certificate expires after awarding */
-        certExpiresNumDaysAfterAward?: number;
-        /** Auto re-enrollment setting */
-        autoReenroll?: boolean;
-        /** If the learner is expected to renew their certificate before it expires, this attribute lists the number of days before the expiry, to auto re-enroll the learner */
-        autoReenrollNumDaysBeforeCertExpires?: number;
-    };
-
-    /** If you issue credits for your course, the credits appear here in a listed/embedded object */
-    credits?: Array<{
-        /** The name of the credit that was awarded, like "CPD" */
-        name: string;
-        /** The number of credits that were awarded to the learner by completing the course, like 5.0 */
-        number: number;
-    }>;
-
-    /** Describes the badges learners can receive, in a listed/embedded object */
-    badges?: Array<{
-        /** The name of the badge */
-        name: string;
-        /** The type of badge */
-        type: string;
-        /** The number of points awarded */
-        points: number;
-        /** Notes when learner will receive the badge: for example, on completion of the course */
-        achieved: string;
-    }>;
-
-    descriptionText?: string;
-    descriptionHtml?: string;
-
-    objectivesText?: string;
-    objectivesHtml?: string;
+export interface LearnUponCourse {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    uptimeLearnUponPortalId: string;
+
+    /** Unique identifier numeric for the course in LearnUpon */
+    courseId: number;
+
+    /** The title of the course */
+    name: string;
+
+    /** If you have course reference codes enabled on your portal, this attribute contains the references and data from that attribute */
+    referenceCode?: string;
+
+    /** If you have keywords added to your course, they appear here */
+    keywords?: string;
+
+    /** The short description, which appears on the My Courses page or the catalog */
+    shortDescription?: string;
+
+    /** The date and time that the course was first published, in UTC format */
+    publishedAt?: string;
+
+    /** The version of the course */
+    courseVersion?: number;
+
+    /** The status of the course: Published, Under Revision, Archived or Deleted */
+    status: 'published' | 'draft' | 'archived' | 'under_revision' | 'deleted';
+
+    /** The main thumbnail image URL for the course */
+    thumbnailImageUrl?: string;
+
+    /** Indicates if the course is available in the internal catalog (true). Default value is false */
+    isCataloged?: boolean;
+
+    /** The list of modules and module types in the course */
+    modules?: Array<{
+        /** Unique id of the module in LearnUpon */
+        id: number;
+        /** The type of the module: values include module, page, exam, scorm, tincan, assignment, survey, checklist, training, event */
+        type: string;
+        /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
+        isKnowledgeCheck?: boolean;
+        /** Legacy ILTs only: start date and time that the ILT session is scheduled, in UTC format */
+        startAt?: string;
+        /** Legacy ILTs only: end date and time that the ILT session is scheduled to complete, in UTC format */
+        endAt?: string;
+        /** Legacy ILTs only: the maximum number of learners allowed to attend the ILT session */
+        maxCapacity?: number;
+    }>;
+
+    /** Number of modules in this course */
+    moduleCount?: number;
+
+    /** The course due date, or set number of days to complete the course after an enrollment for a learner */
+    dueDateDays?: number;
+    dueDateDate?: string;
+
+    /** The course expiry date, or set number of days before an enrollment expires after an enrollment for a learner */
+    accessExpiresDays?: number;
+    accessExpiresDate?: string;
+
+    /** The difficulty level set on your course: one of not_applicable, basic, intermediate or advanced */
+    difficulty: 'not_applicable' | 'basic' | 'intermediate' | 'advanced';
+
+    /** The course length if specified */
+    length?: number;
+    lengthUnit?: string;
+
+    /** If learners can get a certificate on this course, this attribute contains the information */
+    certificate?: {
+        /** The name of the certificate awarded to a learner, on successful completion of the course */
+        certificateName?: string;
+        /** The set number of days before a certificate expires after awarding */
+        certExpiresNumDaysAfterAward?: number;
+        /** Auto re-enrollment setting */
+        autoReenroll?: boolean;
+        /** If the learner is expected to renew their certificate before it expires, this attribute lists the number of days before the expiry, to auto re-enroll the learner */
+        autoReenrollNumDaysBeforeCertExpires?: number;
+    };
+
+    /** If you issue credits for your course, the credits appear here in a listed/embedded object */
+    credits?: Array<{
+        /** The name of the credit that was awarded, like "CPD" */
+        name: string;
+        /** The number of credits that were awarded to the learner by completing the course, like 5.0 */
+        number: number;
+    }>;
+
+    /** Describes the badges learners can receive, in a listed/embedded object */
+    badges?: Array<{
+        /** The name of the badge */
+        name: string;
+        /** The type of badge */
+        type: string;
+        /** The number of points awarded */
+        points: number;
+        /** Notes when learner will receive the badge: for example, on completion of the course */
+        achieved: string;
+    }>;
+
+    descriptionText?: string;
+    descriptionHtml?: string;
+
+    objectivesText?: string;
+    objectivesHtml?: string;
 }

package/src/learn-upon/learn-upon-portal-events.ts

@@ -1,21 +1,21 @@
-import { UptimeLearnUponPortal } from './learn-upon-portal';
-
-export interface UptimeLearnUponPortalCreatedEvent {
-    id: string;
-    type: 'UptimeLearnUponPortalCreated';
-    payload: UptimeLearnUponPortal;
-}
-
-export interface UptimeLearnUponPortalUpdatedEvent {
-    id: string;
-    type: 'UptimeLearnUponPortalUpdated';
-    payload: UptimeLearnUponPortal;
-}
-
-export interface UptimeLearnUponPortalDeletedEvent {
-    id: string;
-    type: 'UptimeLearnUponPortalDeleted';
-    payload: UptimeLearnUponPortal;
-}
-
+import { UptimeLearnUponPortal } from './learn-upon-portal';
+
+export interface UptimeLearnUponPortalCreatedEvent {
+    id: string;
+    type: 'UptimeLearnUponPortalCreated';
+    payload: UptimeLearnUponPortal;
+}
+
+export interface UptimeLearnUponPortalUpdatedEvent {
+    id: string;
+    type: 'UptimeLearnUponPortalUpdated';
+    payload: UptimeLearnUponPortal;
+}
+
+export interface UptimeLearnUponPortalDeletedEvent {
+    id: string;
+    type: 'UptimeLearnUponPortalDeleted';
+    payload: UptimeLearnUponPortal;
+}
+
 export type UptimeLearnUponPortalChangedEvent = UptimeLearnUponPortalCreatedEvent | UptimeLearnUponPortalUpdatedEvent | UptimeLearnUponPortalDeletedEvent;

package/src/learn-upon/learn-upon-portal.ts

@@ -1,13 +1,13 @@
-
-/**
- * Uptime's record of a LearnUpon portal.
- */
-export interface UptimeLearnUponPortal {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    learnUponPortalId: number;
-    learnUponSubdomain: string;
-    whiteLabelDomain?: string;
+
+/**
+ * Uptime's record of a LearnUpon portal.
+ */
+export interface UptimeLearnUponPortal {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    learnUponPortalId: number;
+    learnUponSubdomain: string;
+    whiteLabelDomain?: string;
 }

package/src/learn-upon/learn-upon-user-mapping-events.ts

@@ -1,19 +1,19 @@
-import { LearnUponUserMapping } from './learn-upon-user-mapping';
-
-export interface LearnUponUserMappingCreatedEvent {
-    id: string;
-    type: 'LearnUponUserMappingCreated';
-    payload: LearnUponUserMapping;
-}
-
-export interface LearnUponUserMappingUpdatedEvent {
-    id: string;
-    type: 'LearnUponUserMappingUpdated';
-    payload: LearnUponUserMapping;
-}
-
-export interface LearnUponUserMappingDeletedEvent {
-    id: string;
-    type: 'LearnUponUserMappingDeleted';
-    payload: LearnUponUserMapping;
+import { LearnUponUserMapping } from './learn-upon-user-mapping';
+
+export interface LearnUponUserMappingCreatedEvent {
+    id: string;
+    type: 'LearnUponUserMappingCreated';
+    payload: LearnUponUserMapping;
+}
+
+export interface LearnUponUserMappingUpdatedEvent {
+    id: string;
+    type: 'LearnUponUserMappingUpdated';
+    payload: LearnUponUserMapping;
+}
+
+export interface LearnUponUserMappingDeletedEvent {
+    id: string;
+    type: 'LearnUponUserMappingDeleted';
+    payload: LearnUponUserMapping;
 }

package/src/learn-upon/learn-upon-user-mapping.ts

@@ -1,10 +1,10 @@
-
-export interface LearnUponUserMapping {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    learnUponUserId: number;
-    uptimeLearnUponPortalId: string;
+
+export interface LearnUponUserMapping {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    learnUponUserId: number;
+    uptimeLearnUponPortalId: string;
 }