@uptime.app/contracts 2.0.55 → 2.0.57-rc.0

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

@@ -1,46 +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 */
+/**
+ * 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

@@ -1,19 +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) */
+
+/**
+ * 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

@@ -1,40 +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 */
+/**
+ * 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

@@ -1,23 +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 */
+
+/**
+ * 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

@@ -1,11 +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 */
+
+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

@@ -1,53 +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 */
+/**
+ * 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 */
 }

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

@@ -1,76 +1,76 @@
-/**
- * https://docs.learnupon.com/webhooks/v2/#course-update
- * TODO - many of these fields may be optional
- */
-export interface LearnUponWebhookCourseUpdate {
-    courseId: number; /** Unique identifier numeric for the course */
-    courseName: string; /** The title of the course */
-    courseReferenceCode: string; /** If you have course reference codes enabled on your portal, this attribute contains the references and data from that attribute */
-    courseKeywords: string; /** If you have keywords added to your course, they appear here */
-    courseShortDescription: string; /** The short description, which appears on the My Courses page or the catalog */
-    datePublished: string; /** The date and time that the course was first published, in UTC format */
-    courseVersion: number; /** The version of the course */
-    courseSourceId: number; /** This is the source course_id for each version of a course. For example: for 3 courses, A, B, C (versions 1, 2, 3 respectively) each of these courses use the same courseSourceId value, the id of the first course. This attribute lets you group together courses that stem from the same root course, in their version tree */
-    courseStatus: 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 */
-    thumbnailImageUrl: string; /** The main thumbnail image URL for the course */
-    cataloged: boolean; /** Indicates if the course is available in the internal catalog (true). Default value is false */
-    modules: LearnUponWebhookCourseModule[]; /** The list of modules and module types in the course */
-    courseIsSellable: boolean; /** Notes if the course is available on the storefront. Default value is false, for not sellable */
-    price: number; /** The price of the course */
-    membershipPricing: LearnUponWebhookCourseUpdateMembershipPricing[]; /** If you use associations in your portal, the pricing for each type of member is in a listed/embedded object */
-    dueDate: LearnUponWebhookCourseUpdateDueDate; /** The course due date, or set number of days to complete the course after an enrollment for a learner */
-    accessExpires: LearnUponWebhookCourseAccessExpires; /** The course expiry date, or set number of days before an enrollment expires after an enrollment for a learner */
-    difficulty: string; /** Indicates the difficulty level on your course */
-    courseLength: number; /** The course length if specified */
-    courseLengthUnit: string; /** Indicates the length unit for your course, hours or minutes */
-    certificate: LearnUponWebhookCourseUpdateCertificate; /** If learners can get a certificate on this course, this attribute contains the information */
-    credits: LearnUponWebhookCourseUpdateCredits[]; /** If you issue credits for your course, the credits appear here in a listed/embedded object */
-    badges: LearnUponWebhookCourseUpdateBadges[]; /** Describes the badges learners can receive, in a listed/embedded object */
-    eventCreated: string; /** Date and time of course completion in UTC format */
-}
-
-export interface LearnUponWebhookCourseUpdateCertificate {
-    certificateName: string; /** The name of the certificate awarded to a learner, on successful completion of the course */
-    certExpiresNumDaysAfterAward: number; /** The set number of days before a certificate expires after awarding */
-    autoReenroll: boolean; /**  */
-    autoReenrollNumDaysBeforeCertExpires: number; /** 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 */
-}
-
-export interface LearnUponWebhookCourseUpdateDueDate {
-    numOfDaysAfterEnrollment: number; /** The number of days after enrollment on this course, for completing the course */
-    setDate: string; /** The date and time when this course is due for completion in UTC format */
-}
-
-export interface LearnUponWebhookCourseAccessExpires {
-    numOfDaysAfterEnrollment: number; /** The number of days learners can access this course before it expires */
-    setDate: string; /** The set expiry date for this course in UTC format. If set, learners cannot access after this date */
-}
-
-
-export interface LearnUponWebhookCourseModule {
-    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 */
-    isKnowledgeCheck: boolean; /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
-    startAt: string; /** Legacy ILTs only: start date and time that the ILT session is scheduled, in UTC format */
-    endAt: string; /** Legacy ILTs only: end date and time that the ILT session is scheduled to complete, in UTC format */
-    maxCapacity: number; /** Legacy ILTs only: the maximum number of learners allowed to attend the ILT session */
-}
-
-
-export interface LearnUponWebhookCourseUpdateMembershipPricing {
-    name: string; /** The name provided as the membership type in your portal */
-    price: number; /** The course price for the specific membership type */
-}
-
-
-export interface LearnUponWebhookCourseUpdateCredits {
-    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 LearnUponWebhookCourseUpdateBadges {
-    name: string; /** The name of the badge */
-    type: string; /** The type of badge */
-    points: number; /** The number of points awarded */
-    achieved: string; /** Notes when learner will receive the badge: for example, on completion of the course */
+/**
+ * https://docs.learnupon.com/webhooks/v2/#course-update
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponWebhookCourseUpdate {
+    courseId: number; /** Unique identifier numeric for the course */
+    courseName: string; /** The title of the course */
+    courseReferenceCode: string; /** If you have course reference codes enabled on your portal, this attribute contains the references and data from that attribute */
+    courseKeywords: string; /** If you have keywords added to your course, they appear here */
+    courseShortDescription: string; /** The short description, which appears on the My Courses page or the catalog */
+    datePublished: string; /** The date and time that the course was first published, in UTC format */
+    courseVersion: number; /** The version of the course */
+    courseSourceId: number; /** This is the source course_id for each version of a course. For example: for 3 courses, A, B, C (versions 1, 2, 3 respectively) each of these courses use the same courseSourceId value, the id of the first course. This attribute lets you group together courses that stem from the same root course, in their version tree */
+    courseStatus: 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 */
+    thumbnailImageUrl: string; /** The main thumbnail image URL for the course */
+    cataloged: boolean; /** Indicates if the course is available in the internal catalog (true). Default value is false */
+    modules: LearnUponWebhookCourseModule[]; /** The list of modules and module types in the course */
+    courseIsSellable: boolean; /** Notes if the course is available on the storefront. Default value is false, for not sellable */
+    price: number; /** The price of the course */
+    membershipPricing: LearnUponWebhookCourseUpdateMembershipPricing[]; /** If you use associations in your portal, the pricing for each type of member is in a listed/embedded object */
+    dueDate: LearnUponWebhookCourseUpdateDueDate; /** The course due date, or set number of days to complete the course after an enrollment for a learner */
+    accessExpires: LearnUponWebhookCourseAccessExpires; /** The course expiry date, or set number of days before an enrollment expires after an enrollment for a learner */
+    difficulty: string; /** Indicates the difficulty level on your course */
+    courseLength: number; /** The course length if specified */
+    courseLengthUnit: string; /** Indicates the length unit for your course, hours or minutes */
+    certificate: LearnUponWebhookCourseUpdateCertificate; /** If learners can get a certificate on this course, this attribute contains the information */
+    credits: LearnUponWebhookCourseUpdateCredits[]; /** If you issue credits for your course, the credits appear here in a listed/embedded object */
+    badges: LearnUponWebhookCourseUpdateBadges[]; /** Describes the badges learners can receive, in a listed/embedded object */
+    eventCreated: string; /** Date and time of course completion in UTC format */
+}
+
+export interface LearnUponWebhookCourseUpdateCertificate {
+    certificateName: string; /** The name of the certificate awarded to a learner, on successful completion of the course */
+    certExpiresNumDaysAfterAward: number; /** The set number of days before a certificate expires after awarding */
+    autoReenroll: boolean; /**  */
+    autoReenrollNumDaysBeforeCertExpires: number; /** 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 */
+}
+
+export interface LearnUponWebhookCourseUpdateDueDate {
+    numOfDaysAfterEnrollment: number; /** The number of days after enrollment on this course, for completing the course */
+    setDate: string; /** The date and time when this course is due for completion in UTC format */
+}
+
+export interface LearnUponWebhookCourseAccessExpires {
+    numOfDaysAfterEnrollment: number; /** The number of days learners can access this course before it expires */
+    setDate: string; /** The set expiry date for this course in UTC format. If set, learners cannot access after this date */
+}
+
+
+export interface LearnUponWebhookCourseModule {
+    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 */
+    isKnowledgeCheck: boolean; /** If the module is an exam, indicates if the exam was a knowledge test only (true) or formal exam (false) */
+    startAt: string; /** Legacy ILTs only: start date and time that the ILT session is scheduled, in UTC format */
+    endAt: string; /** Legacy ILTs only: end date and time that the ILT session is scheduled to complete, in UTC format */
+    maxCapacity: number; /** Legacy ILTs only: the maximum number of learners allowed to attend the ILT session */
+}
+
+
+export interface LearnUponWebhookCourseUpdateMembershipPricing {
+    name: string; /** The name provided as the membership type in your portal */
+    price: number; /** The course price for the specific membership type */
+}
+
+
+export interface LearnUponWebhookCourseUpdateCredits {
+    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 LearnUponWebhookCourseUpdateBadges {
+    name: string; /** The name of the badge */
+    type: string; /** The type of badge */
+    points: number; /** The number of points awarded */
+    achieved: string; /** Notes when learner will receive the badge: for example, on completion of the course */
 }

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

@@ -1,18 +1,18 @@
-/**
- * LearnUpon enrollment representation https://docs.learnupon.com/webhooks/v2/#course-enrollment
- * TODO - many of these fields may be optional
- */
-export interface LearnUponWebhookEnrollment {
-    eventCreated: string; /** Date of enrollment in UTC format */
-    user: LearnUponWebhookEnrollmentUser /** List of unique identifiers for an individual user */
-    enrollmentId: number; /** Unique identifier for this enrollment action */
-    dueDate: string; /** The course due date for this enrollment */
-    courseId: number; /** Unique identifier for the course */
-    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 is automatically recertified by LearnUpon on the course. Default false */
-}
-
-export interface LearnUponWebhookEnrollmentUser {
-    userId: number;
-    email : string;
-    username: string;
+/**
+ * LearnUpon enrollment representation https://docs.learnupon.com/webhooks/v2/#course-enrollment
+ * TODO - many of these fields may be optional
+ */
+export interface LearnUponWebhookEnrollment {
+    eventCreated: string; /** Date of enrollment in UTC format */
+    user: LearnUponWebhookEnrollmentUser /** List of unique identifiers for an individual user */
+    enrollmentId: number; /** Unique identifier for this enrollment action */
+    dueDate: string; /** The course due date for this enrollment */
+    courseId: number; /** Unique identifier for the course */
+    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 is automatically recertified by LearnUpon on the course. Default false */
+}
+
+export interface LearnUponWebhookEnrollmentUser {
+    userId: number;
+    email : string;
+    username: string;
 }