@uptime.app/contracts 2.0.50 → 2.0.52-UPM-7636.0

package/dist/esm/learn-upon/webhook-types.d.ts

@@ -0,0 +1,253 @@
+export interface LearnUponWebhookUser {
+    /** Unique numeric identifier for a user */
+    userId: string;
+    /** Email address for a user */
+    email: string;
+    /** Unique identifier for a user, for portals that require usernames */
+    username?: string;
+}
+export interface LearnUponWebhookCourseCompletion {
+    /** Unique numeric identifier for the LearnUpon portal */
+    portalId: string;
+    /** Unique numeric identifier for the enrollment */
+    enrollmentId: string;
+    /** Unique numeric identifier for the course */
+    courseId: string;
+    /** If you enable course reference codes on your portal, this field contains the references and data from that attribute */
+    courseReferenceCode?: string;
+    /** When you offer certificates for a course, the details appear in a listed/embedded object */
+    certification?: {
+        /** Set to a date (UTC) when the learner's certificate will expire: empty string indicates no expiry */
+        certExpiresAt: string;
+        /** If you have set up recertification policies on your course certificate, and the user was awarded a certificate, this value is set to true when the user was automatically recertified by LearnUpon on the course */
+        wasRecertified: boolean;
+        /** The name of the certificate awarded, if any */
+        certificationName: string;
+    };
+    /** The date and time (UTC) that the learner's access to this course expires, if set */
+    courseAccessExpiresAt?: string;
+    /** The date and time (UTC) that the learner enrolled on the course */
+    dateEnrolled: string;
+    /** The date and time (UTC) that the learner started the course */
+    dateStarted: string;
+    /** The date and time (UTC) that the learner completed the course */
+    dateCompleted: string;
+    /** Indicates the status of the learner on the course having completed it: values are completed, passed or failed */
+    enrollmentStatus: 'completed' | 'passed' | 'failed';
+    /** The percentage scored for the learner on the course: this value is the learner's average score across all modules with scores in the course */
+    percentage: number;
+    /** Indicates if the learner has more attempts on the course: this value appears if a learner reaches a failed status, but they have an exam that allows them to re-attempt the course */
+    hasAttemptsRemaining: boolean;
+    /** Indicates if the completion was marked complete manually by an authorized user */
+    manuallyMarkedComplete: boolean;
+    /** Unique numeric identifier of the person who manually marked the learner as complete */
+    manuallyMarkedCompleteById?: string;
+    /** List of unique identifiers for an individual user */
+    user: LearnUponWebhookUser;
+    /** 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;
+    }>;
+    /** The list of modules and related statuses in the course: for each module in your course, you get a status, a date the status was set, and scores where relevant */
+    modules: Array<{
+        /** Unique id of the module in LearnUpon */
+        id: string;
+        /** The name of the module in LearnUpon */
+        name: string;
+        /** The type of the module: values include module, page, exam, scorm, tincan, assignment, survey, checklist, training, event */
+        type: string;
+        /** The status of the module at the time the learner completed the course, with one of the following statuses: not_started, in_progress, completed, passed, failed, pending_review, attended, no_show, cancelled */
+        status: string;
+        /** The score that the learner achieved, if the module included a test, such as an exam or assignment. Normally an integer, but can be a float in some particular modules (e.g. SCORM Module) */
+        percentage?: number;
+        /** Date and time in UTC format when the user completed this module */
+        dateCompleted: string;
+        /** Date and time in UTC format when the user started this module */
+        dateStarted?: string;
+        /** The number of attempts by the learner, on the module, assuming this module is exam-based */
+        attempts?: number;
+        /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
+        isKnowledgeCheck?: boolean;
+        /** Order of the modules in the course, if set */
+        sequence: number;
+        /** Indicates if the completion was marked complete manually by an authorized user. Default is false */
+        markedCompleted: boolean;
+        /** Additional data specific to module type */
+        additional_data: any;
+    }>;
+    /** Date and time of course completion in UTC format */
+    eventCreated: string;
+}
+export interface LearnUponWebhookModuleCompletition {
+    /** Unique numeric identifier for the LearnUpon portal */
+    portalId: string;
+    /** List of unique identifiers for an individual user */
+    user: LearnUponWebhookUser;
+    /** Unique numeric identifier for the enrollment */
+    enrollmentId: string;
+    /** Unique numeric identifier for the course */
+    courseId: string;
+    /** Unique numeric identifier for the module the learner completed */
+    moduleId: string;
+    /** The date and time (UTC) that the learner started the module */
+    dateStarted: string;
+    /** The date and time (UTC) that the learner completed the module */
+    dateCompleted: string;
+    /** Indicates if the completion was marked complete manually by an authorized user. Default is false */
+    markedCompleted: boolean;
+    /** Type of module the learner completed: one of module, page, exam, scorm, tincan, assignment, survey, checklist, training, event */
+    type: 'module' | 'page' | 'exam' | 'scorm' | 'tincan' | 'assignment' | 'survey' | 'checklist' | 'training' | 'event';
+    /** Refers to the order of the modules within the course */
+    sequence: number;
+    /** Indicates the status of the learner on the module having completed it: one of completed, failed, pending_review, not_started (when learner never started course, and markedCompleted=true) */
+    status: 'completed' | 'failed' | 'pending_review' | 'not_started' | 'passed';
+    /** The score of the module completed. Can be null */
+    percentage?: number;
+    /** Provides details for specific module types like exams and surveys. Can be null */
+    additionalData?: {
+        /** Unique numeric identifier of the exam in LearnUpon */
+        examId?: string;
+        /** Indicates if the exam is a knowledge test (true) only or formal exam (false) */
+        isKnowledgeTest?: boolean;
+        /** The number of attempts on this exam by the learner so far */
+        attemptsTaken?: number;
+        /** The number of attempts permitted, assuming attempts are limited (see unlimitedAttemptsAllowed attribute) */
+        attemptsAllowed?: number;
+        /** Set to true if the exam has unlimited attempts permitted: otherwise false. When set, this attribute overrides attemptsAllowed */
+        unlimitedAttemptsAllowed?: boolean;
+        /** Set to true when the exam is a timed exam */
+        timedExam?: boolean;
+        /** The number of minutes allocated to complete the exam */
+        timeAllowed?: number;
+        /** The number of seconds taken by the learner to complete the exam */
+        timeTaken?: number;
+        /** Set to true if LearnUpon automatically submitted the exam, when the allocated time (timeAllowed) elapsed in full */
+        wasAutoSubmitted?: boolean;
+        /** The number of correct answers required to pass the exam, if you do not use passPercentage attribute */
+        passMark?: number;
+        /** The passing percentage required for this exam. When set, this value overrides passMark */
+        passPercentage?: number;
+        /** Survey only: unique numeric identifier for a survey in LearnUpon */
+        surveyId?: string;
+        /** Attributes about the feedback the instructor provides, including an array for any feedback attachments */
+        instructorFeedback?: {
+            /** Unique numeric identifier of the instructor who reviews the assignment */
+            reviewedByUserId: string;
+            /** Indicates if the assignment was reviewed automatically with a pre-set score. Default is null */
+            wasAutocompleted: boolean;
+            /** Contains details of any uploaded response by the instructor */
+            uploads?: Array<{
+                /** Unique numeric identifier for the upload */
+                id: string;
+                /** URL link to the content uploaded by either the instructor or the learner */
+                url: string;
+            }>;
+            /** Any text entered by the instructor to acknowledge the assignment. Can be provided automatically by autocomplete */
+            feedback: string;
+            /** The date and time (UTC) that the instructor reviewed the assignment */
+            reviewedAt: string;
+            /** Numeric value assigned for the assignment. Can be provided automatically by autocomplete */
+            score: number;
+        };
+        /** Attributes about the answer provided by the learner, including an array for any uploaded content */
+        assignmentAnswer?: {
+            /** Unique numeric identifier for the learner's answer to this assignment */
+            id: string;
+            /** Any text entered in the UI by the learner as part of their assignment response. This attribute truncates at 3000 characters */
+            answer: string;
+            /** Indicates if the learner's answer shown in the webhook was cut short */
+            truncated: boolean;
+            /** Contains details of any uploaded content by the learner */
+            uploads?: Array<{
+                /** Unique numeric identifier for the upload */
+                id: string;
+                /** URL link to the content uploaded by either the instructor or the learner */
+                url: string;
+            }>;
+            /** The date and time (UTC) that the learner sent the assignment */
+            answerSubmittedAt: string;
+        };
+    };
+    /** Date and time of event completion in UTC format */
+    eventCreated: string;
+}
+export interface LearnUponWebhookCourseEnrollment {
+    /** Unique numeric identifier for the LearnUpon portal */
+    portalId: string;
+    /** Date of enrollment in UTC format */
+    eventCreated: string;
+    /** List of unique identifiers for an individual user */
+    user: LearnUponWebhookUser;
+    /** Unique identifier for this enrollment action */
+    enrollmentId: string;
+    /** The course due date for this enrollment */
+    dueDate?: string;
+    /** Unique identifier for the course */
+    courseId: string;
+    /** If you have set up recertification policies on your course certificate, and the user was awarded a certificate, this value is set to true when the user is automatically recertified by LearnUpon on the course. Default false */
+    wasRecertified: boolean;
+}
+export interface LearnUponWebhookCourseUnenrollment {
+    /** Unique numeric identifier for the LearnUpon portal */
+    portalId: string;
+    /** Unique identifier for the course */
+    courseId: string;
+    /** Unique identifier for the original enrollment action */
+    enrollmentId: string;
+    /** List of unique identifiers for an individual user */
+    user: LearnUponWebhookUser;
+    /** Date of unenrollment in UTC format */
+    eventCreated: string;
+}
+export interface LearnUponWebhookCourseUpdate {
+    /** Unique numeric identifier for the LearnUpon portal */
+    portalId: string;
+    /** Unique identifier numeric for the course */
+    courseId: string;
+    /** The title of the course */
+    courseName: string;
+    /** The short description, which appears on the My Courses page or the catalog */
+    courseDescription?: string;
+    /** If you have course reference codes enabled on your portal, this attribute contains the references and data from that attribute */
+    courseReferenceCode?: string;
+    /** The status of the course at the time LearnUpon sends the webhook, for courses with a status of Published, Under Revision, Archived or Deleted */
+    courseStatus: 'active' | 'inactive' | 'archived';
+    /** The type of course */
+    courseType: 'standard' | 'blended' | 'event' | 'microlearning';
+    /** The URL for the course */
+    courseUrl: string;
+    /** The date and time that the course was created in UTC format */
+    courseCreatedAt: string;
+    /** The date and time that the course was last updated in UTC format */
+    courseUpdatedAt: string;
+    /** The date and time that the course was first published, in UTC format */
+    coursePublishedAt?: string;
+    /** The date and time that the course was archived, in UTC format */
+    courseArchivedAt?: string;
+    /** The course length if specified (in minutes) */
+    courseDuration?: number;
+    /** The language of the course */
+    courseLanguage?: string;
+    /** The course category information */
+    courseCategory?: {
+        /** Unique identifier for the category */
+        id: string;
+        /** The name of the category */
+        name: string;
+    };
+    /** The course instructor information */
+    courseInstructor?: {
+        /** Unique identifier for the instructor */
+        id: string;
+        /** The name of the instructor */
+        name: string;
+        /** The email address of the instructor */
+        email: string;
+    };
+    /** Date and time of course completion in UTC format */
+    eventCreated: string;
+}
+//# sourceMappingURL=webhook-types.d.ts.map

package/dist/esm/learn-upon/webhook-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-types.d.ts","sourceRoot":"","sources":["../../../src/learn-upon/webhook-types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACjC,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gCAAgC;IAC7C,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,2HAA2H;IAC3H,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,+FAA+F;IAC/F,aAAa,CAAC,EAAE;QACZ,uGAAuG;QACvG,aAAa,EAAE,MAAM,CAAC;QACtB,uNAAuN;QACvN,cAAc,EAAE,OAAO,CAAC;QACxB,kDAAkD;QAClD,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,uFAAuF;IACvF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sEAAsE;IACtE,YAAY,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,oHAAoH;IACpH,gBAAgB,EAAE,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACpD,kJAAkJ;IAClJ,UAAU,EAAE,MAAM,CAAC;IACnB,yLAAyL;IACzL,oBAAoB,EAAE,OAAO,CAAC;IAC9B,qFAAqF;IACrF,sBAAsB,EAAE,OAAO,CAAC;IAChC,0FAA0F;IAC1F,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,wDAAwD;IACxD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,gGAAgG;IAChG,OAAO,CAAC,EAAE,KAAK,CAAC;QACZ,0DAA0D;QAC1D,IAAI,EAAE,MAAM,CAAC;QACb,gGAAgG;QAChG,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;IACH,qKAAqK;IACrK,OAAO,EAAE,KAAK,CAAC;QACX,2CAA2C;QAC3C,EAAE,EAAE,MAAM,CAAC;QACX,0CAA0C;QAC1C,IAAI,EAAE,MAAM,CAAC;QACb,+HAA+H;QAC/H,IAAI,EAAE,MAAM,CAAC;QACb,mNAAmN;QACnN,MAAM,EAAE,MAAM,CAAC;QACf,gMAAgM;QAChM,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sEAAsE;QACtE,aAAa,EAAE,MAAM,CAAC;QACtB,oEAAoE;QACpE,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,+FAA+F;QAC/F,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,8GAA8G;QAC9G,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,iDAAiD;QACjD,QAAQ,EAAE,MAAM,CAAC;QACjB,uGAAuG;QACvG,eAAe,EAAE,OAAO,CAAC;QACzB,8CAA8C;QAC9C,eAAe,EAAE,GAAG,CAAC;KACxB,CAAC,CAAC;IACH,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kCAAkC;IAC/C,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,uGAAuG;IACvG,eAAe,EAAE,OAAO,CAAC;IACzB,qIAAqI;IACrI,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC;IACrH,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,iMAAiM;IACjM,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,gBAAgB,GAAG,aAAa,GAAG,QAAQ,CAAC;IAC7E,qDAAqD;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qFAAqF;IACrF,cAAc,CAAC,EAAE;QAEb,yDAAyD;QACzD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,mFAAmF;QACnF,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,gEAAgE;QAChE,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,+GAA+G;QAC/G,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,oIAAoI;QACpI,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,gDAAgD;QAChD,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,2DAA2D;QAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,sEAAsE;QACtE,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,uHAAuH;QACvH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,0GAA0G;QAC1G,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,6FAA6F;QAC7F,cAAc,CAAC,EAAE,MAAM,CAAC;QAGxB,uEAAuE;QACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAGlB,6GAA6G;QAC7G,kBAAkB,CAAC,EAAE;YACjB,6EAA6E;YAC7E,gBAAgB,EAAE,MAAM,CAAC;YACzB,mGAAmG;YACnG,gBAAgB,EAAE,OAAO,CAAC;YAC1B,kEAAkE;YAClE,OAAO,CAAC,EAAE,KAAK,CAAC;gBACZ,+CAA+C;gBAC/C,EAAE,EAAE,MAAM,CAAC;gBACX,+EAA+E;gBAC/E,GAAG,EAAE,MAAM,CAAC;aACf,CAAC,CAAC;YACH,sHAAsH;YACtH,QAAQ,EAAE,MAAM,CAAC;YACjB,0EAA0E;YAC1E,UAAU,EAAE,MAAM,CAAC;YACnB,+FAA+F;YAC/F,KAAK,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,uGAAuG;QACvG,gBAAgB,CAAC,EAAE;YACf,4EAA4E;YAC5E,EAAE,EAAE,MAAM,CAAC;YACX,kIAAkI;YAClI,MAAM,EAAE,MAAM,CAAC;YACf,2EAA2E;YAC3E,SAAS,EAAE,OAAO,CAAC;YACnB,8DAA8D;YAC9D,OAAO,CAAC,EAAE,KAAK,CAAC;gBACZ,+CAA+C;gBAC/C,EAAE,EAAE,MAAM,CAAC;gBACX,+EAA+E;gBAC/E,GAAG,EAAE,MAAM,CAAC;aACf,CAAC,CAAC;YACH,mEAAmE;YACnE,iBAAiB,EAAE,MAAM,CAAC;SAC7B,CAAC;KACL,CAAC;IACF,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gCAAgC;IAC7C,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,qOAAqO;IACrO,cAAc,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,kCAAkC;IAC/C,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,YAAY,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IACzC,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,iFAAiF;IACjF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qIAAqI;IACrI,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oJAAoJ;IACpJ,YAAY,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IACjD,yBAAyB;IACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,eAAe,CAAC;IAC/D,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,eAAe,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sCAAsC;IACtC,cAAc,CAAC,EAAE;QACb,yCAAyC;QACzC,EAAE,EAAE,MAAM,CAAC;QACX,+BAA+B;QAC/B,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,wCAAwC;IACxC,gBAAgB,CAAC,EAAE;QACf,2CAA2C;QAC3C,EAAE,EAAE,MAAM,CAAC;QACX,iCAAiC;QACjC,IAAI,EAAE,MAAM,CAAC;QACb,0CAA0C;QAC1C,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACxB"}

package/dist/esm/learn-upon/webhook-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=webhook-types.js.map

package/dist/esm/learn-upon/webhook-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-types.js","sourceRoot":"","sources":["../../../src/learn-upon/webhook-types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "2.0.50",
+  "version": "2.0.52-UPM-7636.0",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -14,5 +14,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "84705665c62b17ad6668f8a83b21012c8772f311"
+  "gitHead": "9a78980722ada56db5927fd0af202507dd48b42e"
 }

package/src/b2b-organisation/b2b-organisation-member.ts

@@ -9,4 +9,12 @@ export interface B2BOrganisationMember {
     /** Added Nov 2024. AppRole.B2bAdmin or AppRole.B2bMember */
     role: string;
     profileId?: string;
+    joinedVia?: B2BOrganisationMemberJoinedVia;
+
+}
+
+export enum B2BOrganisationMemberJoinedVia {
+    INVITATION = 'INVITATION',
+    PUBLIC_LINK = 'PUBLIC_LINK',
+    SSO = 'SSO',
 }

package/src/index.ts

@@ -179,4 +179,6 @@ export * from './message-bus/Context';
 export * from './identity-provider/identity-provider';
 export * from './identity-provider/identity-provider-events';
 export * from './identity-provider/domain-identity-provider';
-export * from './identity-provider/domain-identity-provider-events';
+export * from './identity-provider/domain-identity-provider-events';
+
+export * from './learn-upon/webhook-types';

package/src/learn-upon/from-lydia.ts

@@ -0,0 +1,16 @@
+
+// todo LearnUponApiEnrollment.modules may not be available when searching for a users enrollments
+
+export interface APITraining {
+    id: string;  // from LearnUponApiEnrollment.course_id | LearnUponWebhookCourseUpdate.courseId | LearnUponApiCourse.id
+    title: string; // from LearnUponApiCourse.name | LearnUponApiEnrollment.course_name | LearnUponWebhookCourseUpdate.courseName
+    dueDate: string;  // from LearnUponWebhookEnrollment.dueDate | LearnUponApiEnrollment.due_date
+    completedModulesCount: number; // from LearnUponApiEnrollment.percentage_complete | LearnUponApiEnrollment.modules LearnUponWebhookModuleComplete
+    totalModulesCount: number; // from LearnUponApiEnrollment.modules | LearnUponApiCourse.number_of_modules | LearnUponWebhookCourseUpdate.modules
+    coverUrl: string; // from LearnUponApiCourse.thumbnail_image_url | LearnUponWebhookCourseUpdate.thumbnailImageUrl
+    isStarted?: boolean; // from LearnUponApiEnrollment.date_started |  ModuleComplete webhook (assuming is started is 1 or more modules complete)
+    isCertificate?: boolean; // from LearnUponApiEnrollment.certificate_name or LearnUponWebhookCourseUpdate.certificate .  Not LearnUponApiCourse ??
+
+    // not looking at this for now
+    isLiveSession?: boolean;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * LearnUpon course representation https://docs.learnupon.com/api/#courses
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponApiCourse {
+    id: number; /** Unique numeric identifier for the course */
+    name: string; /** The title of the course */
+    version: number; /** The version of the course */
+    source_id: number; /** The source course_id for a course. When you update a course (re-version a course) the source id does not change This ID groups courses together that stem from the same root course in their version tree */
+    created_at: string; /** Date/time when the course was created, in UTC format */
+    sellable: boolean; /** If set to true, indicates the course is published to the store: default is false. */
+    cataloged: boolean; /** If set to true, indicates if the course is published to the catalog: default is false */
+    date_published: string; /** Date/time when the course was published, in UTC format */
+    keywords: string; /** Keywords you provide, to help users find your course in the catalog or the store */
+    reference_code: string; /** A customer reference code, to help you find your courses in the library in search, and use in reports: not generated by LearnUpon */
+    manager_can_enroll: boolean; /** If set to true, indicates the manager can enroll their group members on this course: default is false */
+    allow_users_rate_course: boolean; /** If set to (default)true, indicates learners can rate this course */
+    number_of_reviews: number; /** Number of reviews/ratings recorded for this course: use in combination with number_of_stars to calculate an average rating */
+    number_of_stars: number; /** Number of stars awarded to the course: use in combination with number_of_reviews to calculate an average rating */
+    minute_length: number; /** The course length, if specified, that appears in your store or catalog */
+    course_length_unit: string; /** The length unit for your course: hours or minutes */
+    num_enrolled: number; /** Number of learners currently enrolled */
+    num_not_started: number; /** Number of learners who have not started the course */
+    num_in_progress: number; /** Number of learners who are currently in progress */
+    num_completed: number; /** Number of learners who have completed the course */
+    num_passed: number; /** Number of learners who have passed the course */
+    num_failed: number; /** Number of learners who have failed the course */
+    num_pending_review: number; /** Number of learners who have submitted all of their assignments for their course */
+    number_of_modules: number; /** Number of modules in this course */
+    price: number; /** Price in cents for your course */
+    published_status_id: string; /** The current published status of the course: one of published, draft, archived or under_revision */
+    difficulty_level: string; /** The difficulty level set on your course: one of not_applicable, basic, intermediate or advanced */
+    description_html: string; /** Course description, with full HTML markup */
+    description_text: string; /** Course description, raw text */
+    objectives_html: string; /** Course objectives, with full HTML markup */
+    objectives_text: string; /** Course objectives, raw text */
+    credits_to_be_awarded: string; /** Comma-separated list of credits the learner earns by completing or passing the course. Example: "CEU:2.00,CPE:3.00" */
+    due_days_after_enrollment: number; /** The number of days after enrollment, when the learner is due to complete the course */
+    due_date_after_enrollment: string; /** The date/time, when this course is due for completion, in UTC format */
+    send_due_date_reminders: boolean; /** If set to true, indicates that due date reminders are enabled on this course: default is false */
+    due_date_reminder_days: number; /** For the first reminder LearnUpon sends: number of days before the course is due for completion */
+    due_date_reminder_days_2: number; /** For the second reminder LearnUpon sends: number of days before the course is due for completion */
+    thumbnail_image_url: string; /** Public URL of the course thumbnail image: returns null if the course has no thumbnail */
+    license_expires: string; /** Licensed course only: the date/time the course license expires, in UTC format, returns null if the license is open ended */
+    license_number_enrollments_purchased: number; /** Licensed course only: the number of enrollments purchased for the license, returns null if the license is unlimited */
+    license_is_open_ended: boolean; /** Licensed course only: indicates if the license is open ended (never expires), default is false */
+    license_has_unlimited_enrollments: boolean; /** Licensed course only: indicates if the license has an unlimited number of enrollments available, default is false */
+    owner_first_name: string; /** The first name of the course owner */
+    owner_last_name: string; /** The last name of the course owner */
+    owner_email: string; /** The email address of the course owner */
+    owner_id: number; /** Unique numeric identifier for the course owner: portal administrator, or instructor with course creation privileges */
+    learning_awards: any; /** Gamification only: requires query by course_id, and contains gamification related data */
+    customDataFieldValues /** An object containing the list of custom data field definitions. Returned only when the portal admin has defined custom course data fields */
+}

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

@@ -0,0 +1,46 @@
+/**
+ * LearnUpon enrollment representation https://docs.learnupon.com/api/#enrollments
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponApiEnrollment {
+    id: number; /** Unique numeric identifier for the enrollment */
+    percentage: number; /** The score achieved by the learner */
+    date_started: string; /** The date the user started the course, in UTC format */
+    date_completed: string; /** The date the user finished the course, in UTC format */
+    date_lastaccessed: string; /** The date the user last accessed the course, in UTC format */
+    date_enrolled: string; /** The date the user was enrolled on the course, in UTC format */
+    course_id: number; /** Unique numeric identifier for the course */
+    course_name: string; /** The exact title of the course, using the most recent published course title */
+    course_source_id: number; /** For re-versioned courses, provides the course_id of the source course. Example: for course version 4, this field contains the course_id for version 3 (not version 1) */
+    user_id: number; /** Unique numeric identifier for the user enrolled */
+    first_name: string; /** The first name of the user enrolled */
+    last_name: string; /** The last name of the user enrolled */
+    email: string; /** The email address of the user enrolled: LearnUpon's default identifier for users. */
+    username: string; /** The username of the user enrolled, visible only if you implement usernames on your portal. See Unique identifiers: email or username */
+    due_date: string; /** If set, the date by which the learner must complete the course, in UTC format */
+    status: string; /** The enrollment status of the learner, one of the following statuses: not_started, in_progress, completed, passed, failed, pending_review */
+    course_access_expires_at: string; /** If set, date when access to the course expires for the learner, in UTC format */
+    certificate_name: string; /** Name of any certificate the user receives for completion */
+    cert_expires_at: string; /** If set, when the the certification expires */
+    version: number; /** The course version */
+    was_recertified: boolean; /** If set to true, indicates that recertification policies on your course certificate applied on this enrollment. For users who complete a course that has automatic recertification rules enabled, when they repeat the course, they are automatically recertified by LearnUpon */
+    percentage_complete: number; /** The number of modules the learner has completed, as a percentage of the number of modules in the course */
+    unenrolled: boolean; /** Indicates if a user's completed course was unenrolled: enrollment is hidden from the learners' views, but appears in the course history report, in audit/learning history data */
+    from_store: boolean; /** Indicates if the enrollment came through eCommerce. Default is false */
+    from_catalog: boolean; /** Indicates if the enrollment came through the portal catalog. Default is false */
+    updated_at: string; /** Indicates when the enrollment was last updated, in UTC format */
+    group_id: number; /** Displays the learner's group_id, if they belong to a group */
+    is_overdue: boolean; /** Applicable only for courses with due dates: indicates if the course is overdue */
+    // TODO - check if this is supported when getting a users enrollments?!?! or do you need the enrollment id?
+    modules: LearnUponApiEnrollmentModule[] /** A list of module details for the given {enrollment_id} */
+}
+
+export interface LearnUponApiEnrollmentModule {
+    id: number; /** Unique numeric identifier for the module */
+    title: string; /** Name of the module that appears to learners in the interface */
+    sequence: number; /** Order in which the module appears in the enrollment */
+    date_started: string; /** The date the learner started the module, in UTC format */
+    date_completed: string; /** The date the learner finished the module, in UTC format */
+    date_lastaccessed: string; /** The date the learner last accessed the module, in UTC format */
+    status: string; /** Current status of the module, one of not_started, in_progress, completed, passed, failed or pending_review */
+}

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

@@ -0,0 +1,19 @@
+
+/**
+ * LearnUpon Portal https://docs.learnupon.com/api/#portals
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponApiPortal {
+    id: number; /** Maps to LearnUpon's id field. Unique numeric identifier for the portal. (LearnUpon's id) */
+    title: string; /** Portal name or title. Requires URL encoding to submit the name over a QueryString. The search uses pattern matching, not exact matching. All searches are case insensitive */
+    subdomain: string; /** The subdomain of the portal */
+    created_at: string; /** Date/time for when the portal was created, in UTC format */
+    updated_at: string; /** Date/time for when the portal was last updated, in UTC format */
+    allow_course_authoring: boolean; /** Permissions: indicates if admins in a sub-portal can edit courses in that portal. Default is true, gives permissions to edit courses */
+    number_of_members: number; /** Number of users currently assigned to the portal */
+    number_licenses_purchased: number; /** For portal licensing: indicates the number of licenses purchased for a specific portal */
+    number_licenses_used: number; /** For portal licensing: indicates the number of licenses currently used for a specific portal */
+    logo_image_url: string; /** URL of the logo image of the new portal */
+    header_color: string; /** Hexadecimal code for the portal's header color, default (#419BBD) */
+    navigation_color: string; /** Hexadecimal code for the portal's tab navigation color, default (#256188) */
+}

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

@@ -0,0 +1,40 @@
+/**
+ * LearnUpon user representation https://docs.learnupon.com/api/#user-object-attributes
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponApiUser {
+    id: number; /** The unique numeric identifier for the user */
+    last_name: string; /** The last name of the user */
+    first_name: string; /** The first name of the user */
+    email: string; /** The email address of the user: see Unique identifiers: email or username */
+    username?: string; /** Appears only if you set up username in place of email as a unique identifier. See Unique identifiers: email or username. */
+    locale: string; /** The ISO language code for the user. See the appendix for a list of supported languages. If not set, then default is the portal's language. */
+    created_at: string; /** The date the user was created, in UTC format */
+    updated_at: string; /** The date of recent change to indicate the most recent change to any ofemail, first_name, last_name, username, display_name, email_disabled, or a reset password request, in UTC format */
+    last_sign_in_at: string; /** The date the user last signed into LearnUpon, in UTC format */
+    account_expires: string; /** The date you set the user's account to expire. Expired accounts cannot access LearnUpon. This attribute overrides enabled attribute. Required format is yyyy-mm-dd like 2025-04-11. The user's account expires at midnight (UTC) on the date specified, thus: midnight on 11th Apr 2025 */
+    sign_in_count: number; /** The number of times the user logged into LearnUpon */
+    enabled: boolean; /** If set to (default)true, indicates the user's account is enabled. An account can remain enabled even if the account has expired: you must check the account_expires attribute, and vice versa. account_expires overrides enabled */
+    timezone_id: string; /** If set, indicates a timezone for displaying dates and times of courses and sessions. This timezone can match, or be different, from the portal default */
+    user_type: string; /** Indicates the user type and their permissions in the portal: one of learner, instructor, manager, admin */
+    can_enroll: boolean; /** Manager user type only: indicates if the user can enroll learners in courses. Default is true */
+    can_unenroll_users: boolean; /** Manager user type only: indicates of the user can unenroll learners in courses. Default is false */
+    can_mark_complete: boolean; /** Manager user type only: indicates if the user can manually mark complete learners on courses. Default is false */
+    can_move_groups: boolean; /** Manager user type only: indicates if the manager can move users from one group to another. The manager must be assigned as manager for both groups. Default is false */
+    can_act_as_instructor: boolean; /** Manager user type only: indicates if the manager has instructor permissions. Default is false */
+    can_manage_trainings: boolean; /** Instructor user type only: indicates if the instructor can create and edit live learning events. Default is false */
+    can_manage_sessions: boolean; /** Instructor user type only: indicates if the instructor can create and edit sessions within live learning events. Default is false */
+    tutor_can_edit_their_courses: boolean; /** Instructor user type only: indicates if the user can edit the courses that they instruct. Default is true */
+    tutor_can_create_courses: boolean; /** Instructor user type only: indicates if the user can create their own courses. Default is false */
+    number_of_enrollments: number; /** Indicates the number of enrollments for the specified user */
+    number_of_enrollments_accessed: number; /** Indicates the number of enrollments that the user has in progress, completed, passed status */
+    // TODO - is CustomData correct? different casing to other properties
+    CustomData?: any /** Optionally defined by admins on your portal: custom data refers to any custom user data fields that you created on your portals */
+    membership_type?: string; /** Associations and memberships feature only. Indicates the membership type of the users. LearnUpon provides Member or Non-member options by default: add new membership types through the portal interface. Attribute options must have no spaces: use hyphens or underscores */
+    number_of_points?: number; /** Gamification only: total number of gamification points awarded to the user */
+    number_of_badges?: number; /** Gamification only: total count of gamification badges awarded to the user */
+    sf_contact_id?: string; /** Salesforce only: Contact ID. Returns null if user record doesn’t have a Salesforce Contact ID */
+    sf_user_id?: string; /** Salesforce only: Salesforce User ID. Returns null if user record doesn’t have a Salesforce user ID */
+    is_salesforce_contact?: boolean; /** Salesforce only: Returns null if user isn’t a Salesforce Contact */
+    customDataFieldValues?: any /** Optional: an object containing custom user data details */
+}

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

@@ -0,0 +1,23 @@
+
+/**
+ * Uptime's representation of the config required for a specific LearnUpon Portal
+ */
+export interface LearnUponPortalConfig {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** LearnUpon's id for the portal. set when the portal has been created */
+    portalId?: string;
+
+    // portal settings and properties https://docs.learnupon.com/api/#create-a-new-portal
+    subdomain: string; /** Subdomain of your portal */
+    title: string; /** Title of the new portal */
+    logo_image_url?: string; /** URL of the logo image of the new portal */
+    store_banner_image_url?: string; /** URL for an image, to use as store banner image of the new portal */
+    header_color?: string; /** Hexadecimal code for the portal's header color, default (#419BBD) */
+    navigation_color?: string; /** Hexadecimal code for the portal's tab navigation color, default (#256188) */
+    number_licenses_purchased?: number; /** For portal licensing: you can specify the number of purchased licenses for a given portal */
+    copy_from_parent?: boolean; /** If set to true, the new portal copies many settings from the top-level portal: includes any custom email templates, custom welcome messages, SSO settings, categories, and catalog settings. If SQSSO is set up on the top-level portal, this call generates a new SQSSO secret key, while copying other settings. This key appears in the response */
+    allow_course_authoring?: boolean; /** Permissions: indicates if admins in a sub-portal can edit courses in that portal. Default is true, gives permissions to edit courses */
+}

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

@@ -0,0 +1,11 @@
+
+export interface LearnUponUserMapping {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string; /** Uptime user id */
+    learnUponUserId: number; /** LearnUpon user id */
+    // todo - should we
+    portalId: string; /** LearnUpon portal id */
+}

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

@@ -0,0 +1,53 @@
+/**
+ * https://docs.learnupon.com/webhooks/v2/#course-completion
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponWebhookCourseCompletion {
+    enrollmentId: number; /** Unique numeric identifier for the enrollment */
+    courseId: number; /** Unique numeric identifier for the course */
+    courseReferenceCode: string; /** If you enable course reference codes on your portal, this field contains the references and data from that attribute */
+    certification: LearnUponWebhookCourseCompletionCertification; /** When you offer certificates for a course, the details appear in a listed/embedded object */
+    courseAccessExpiresAt: string; /** The date and time (UTC) that the learner's access to this course expires, if set */
+    dateEnrolled: string; /** The date and time (UTC) that the learner enrolled on the course */
+    dateStarted: string; /** The date and time (UTC) that the learner started the course */
+    dateCompleted: string; /** The date and time (UTC) that the learner completed the course */
+    enrollmentStatus: string; /** Indicates the status of the learner on the course having completed it: values are completed, passed or failed */
+    percentage: number; /** The percentage scored for the learner on the course: this value is the learner's average score across all modules with scores in the course. */
+    hasAttemptsRemaining: boolean; /** Indicates if the learner has more attempts on the course: this value appears if a learner reaches a failed status, but they have an exam that allows them to re-attempt the course */
+    manuallyMarkedComplete: boolean; /** Indicates if the completion was marked complete manually by an authorized user */
+    manuallyMarkedCompleteById: number; /** Unique numeric identifier of the person who manually marked the learner as complete */
+    user: LearnUponWebhookCourseCompletionUser /** List of unique identifiers for an individual user */
+    credits: LearnUponWebhookCourseCompletionCredits[]; /** If you issue credits for your course, the credits appear here in a listed/embedded object */
+    modules: LearnUponWebhookCourseCompletionModule[]; /** The list of modules and related statuses in the course: for each module in your course, you get a status, a date the status was set, and scores where relevant */
+    eventCreated: string; /** Date and time of course completion in UTC format */
+}
+
+export interface LearnUponWebhookCourseCompletionUser {
+    userId: number;
+    email : string;
+    username: string;
+}
+
+
+export interface LearnUponWebhookCourseCompletionCredits {
+    id: number; /** For learning path completions only: Unique numeric identifier for the credit. See Path credits data attributes */
+    name: string; /** The name of the credit that was awarded, like "CPD" */
+    number: number; /** The number of credits that were awarded to the learner by completing the course, like 5.0 */
+}
+export interface LearnUponWebhookCourseCompletionModule {
+    id: number; /** Unique id of the module in LearnUpon */
+    type: string; /** The type of the module: values include module, page, exam, scorm, tincan, assignment, survey, checklist, training, event */
+    name: string; /** The name of the module in LearnUpon */
+    status: string; /** The status of the module at the time the learner completed the course, with one of the following statuses: not_started, in_progress, completed, passed, failed, pending_review, attended, no_show, cancelled */
+    percentage: number; /** The score that the learner achieved, if the module included a test, such as an exam or assignment. Normally an integer, but can be a float in some particular modules (e.g. SCORM Module) */
+    dateCompleted: string; /** Date and time in UTC format when the user completed this module */
+    attempts: number; /** The number of attempts by the learner, on the module, assuming this module is exam-based */
+    isKnowledgeCheck: boolean; /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
+    sequence: number; /** Order of the modules in the course, if set */
+}
+export interface LearnUponWebhookCourseCompletionCertification {
+    id: number; /** For learning path completions only: Unique numeric identifier for the certification. See Learning path completed user attributes */
+    certificationName: string; /** The name of the certificate awarded, if any */
+    certExpiresAt: string; /** Set to a date (UTC) when the learner's certificate will expire: empty string indicates no expiry */
+    wasRecertified: boolean; /** If you have set up recertification policies on your course certificate, and the user was awarded a certificate, this value is set to true when the user was automatically recertified by LearnUpon on the course */
+}