@ikonintegration/module-config-api 2.0.8 → 2.0.11

package/Api.ts

@@ -1882,7 +1882,7 @@ export interface TilePermissionsResponse {
      * Map of tile IDs to permission entries
      * @example {"tile1":[{"role":"admin","access":"READ"},{"role":"user","access":"READ"}],"tile2":[{"role":"admin","access":"READ"}]}
      */
-    tilePermissions?: Record<
+    tilePermissions: Record<
       string,
       {
         /**
@@ -2800,7 +2800,7 @@ export interface FaqResponse {
   answer?: string
 }
 
-export interface InputI1Zjq906Kx {
+export interface InputSd925Fyovd {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -2823,7 +2823,7 @@ export interface InputI1Zjq906Kx {
   answer?: string
 }
 
-export interface InputLleaava7Ug {
+export interface InputLz115Z1F9W {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -2939,6 +2939,8 @@ export interface CertificationResponse {
    * @example "standard"
    */
   certificationEngineType?: string
+  /** Array of webhooks invoked when the certification is renewed */
+  renewalWebhooks?: string[]
   /**
    * Array of requirement ID arrays (nested structure for requirement groups)
    * @example [["req1","req2"],["req3"]]
@@ -3132,6 +3134,8 @@ export interface CertificationRequestBody {
    * @example "standard"
    */
   certificationEngineType?: string
+  /** Array of webhooks invoked when the certification is renewed */
+  renewalWebhooks?: string[]
   /**
    * Array of requirement ID arrays (nested structure for requirement groups)
    * @example [["req1","req2"],["req3"]]
@@ -3346,6 +3350,8 @@ export interface CertificationListResponse {
      * @example "standard"
      */
     certificationEngineType?: string
+    /** Array of webhooks invoked when the certification is renewed */
+    renewalWebhooks?: string[]
     /**
      * Array of requirement ID arrays (nested structure for requirement groups)
      * @example [["req1","req2"],["req3"]]
@@ -3587,6 +3593,11 @@ export interface CourseResponse {
    * @example ["req1","req2"]
    */
   requirementsIDs?: string[]
+  /**
+   * Flag that indicates that users can request enrolment to the course, it will enable the Request Enrolment button in the LMS FE.
+   * @example true
+   */
+  enableRequestToEnrol?: boolean
   /**
    * Whether required on renewal
    * @example false
@@ -3624,8 +3635,15 @@ export interface CourseResponse {
    * @example false
    */
   allowIfAnyRequirementMet?: boolean
+  /**
+   * Only allow enrolment in this course if the session date is within the certification validity. If certification is expired in the date of the session selected, block enrolment.
+   * @example false
+   */
+  allowOnlyIfCertificationIsValid?: boolean
   /** Array of course fail webhook URLs */
   courseFailWebhooks?: string[]
+  /** string containing a url to be invoked to determine if the courses external requiements are met */
+  externalRequirementWebhook?: string
   /**
    * Whether to lock after failure
    * @example false
@@ -3798,6 +3816,24 @@ export interface CourseResponse {
    * @example false
    */
   preventLaunchIfCompleted?: boolean
+  /** Array of IDM user attributes that can be requirements for the course. Attributes must have a boolean true value to enable enrolment in the course. */
+  requirementUserAttribIDs?: {
+    /**
+     * Partition ID
+     * @example "partition-001"
+     */
+    partition: string
+    /**
+     * Name of the attribute, found under the value object in the partition record
+     * @example "hasSafetyTraining"
+     */
+    attributeName: string
+    /**
+     * Description used for message displayed to user when requirement is not met
+     * @example "hasSafetyTraining"
+     */
+    description: string
+  }[]
 }
 
 /** Course request body for create/update operations */
@@ -3849,6 +3885,11 @@ export interface CourseRequestBody {
    * @example ["req1","req2"]
    */
   requirementsIDs?: string[]
+  /**
+   * Flag that indicates that users can request enrolment to the course, it will enable the Request Enrolment button in the LMS FE.
+   * @example true
+   */
+  enableRequestToEnrol?: boolean
   /**
    * Whether required on renewal
    * @example false
@@ -3886,8 +3927,15 @@ export interface CourseRequestBody {
    * @example false
    */
   allowIfAnyRequirementMet?: boolean
+  /**
+   * Only allow enrolment in this course if the session date is within the certification validity. If certification is expired in the date of the session selected, block enrolment.
+   * @example false
+   */
+  allowOnlyIfCertificationIsValid?: boolean
   /** Array of course fail webhook URLs */
   courseFailWebhooks?: string[]
+  /** string containing a url to be invoked to determine if the courses external requiements are met */
+  externalRequirementWebhook?: string
   /**
    * Whether to lock after failure
    * @example false
@@ -4060,6 +4108,24 @@ export interface CourseRequestBody {
    * @example false
    */
   preventLaunchIfCompleted?: boolean
+  /** Array of IDM user attributes that can be requirements for the course. Attributes must have a boolean true value to enable enrolment in the course. */
+  requirementUserAttribIDs?: {
+    /**
+     * Partition ID
+     * @example "partition-001"
+     */
+    partition: string
+    /**
+     * Name of the attribute, found under the value object in the partition record
+     * @example "hasSafetyTraining"
+     */
+    attributeName: string
+    /**
+     * Description used for message displayed to user when requirement is not met
+     * @example "hasSafetyTraining"
+     */
+    description: string
+  }[]
 }
 
 /** Request body for adding a coursebook */
@@ -4082,6 +4148,7 @@ export interface AddCourseBookResponse {
     fileID: string
     fileName: string
   }[]
+  [key: string]: any
 }
 
 /** File sign response with signed URL */
@@ -4099,6 +4166,7 @@ export interface CourseBookResponse {
     fileID: string
     fileName: string
   }[]
+  [key: string]: any
 }
 
 /** List of courses response */
@@ -4171,6 +4239,11 @@ export interface CourseListResponse {
      * @example ["req1","req2"]
      */
     requirementsIDs?: string[]
+    /**
+     * Flag that indicates that users can request enrolment to the course, it will enable the Request Enrolment button in the LMS FE.
+     * @example true
+     */
+    enableRequestToEnrol?: boolean
     /**
      * Whether required on renewal
      * @example false
@@ -4208,8 +4281,15 @@ export interface CourseListResponse {
      * @example false
      */
     allowIfAnyRequirementMet?: boolean
+    /**
+     * Only allow enrolment in this course if the session date is within the certification validity. If certification is expired in the date of the session selected, block enrolment.
+     * @example false
+     */
+    allowOnlyIfCertificationIsValid?: boolean
     /** Array of course fail webhook URLs */
     courseFailWebhooks?: string[]
+    /** string containing a url to be invoked to determine if the courses external requiements are met */
+    externalRequirementWebhook?: string
     /**
      * Whether to lock after failure
      * @example false
@@ -4382,6 +4462,24 @@ export interface CourseListResponse {
      * @example false
      */
     preventLaunchIfCompleted?: boolean
+    /** Array of IDM user attributes that can be requirements for the course. Attributes must have a boolean true value to enable enrolment in the course. */
+    requirementUserAttribIDs?: {
+      /**
+       * Partition ID
+       * @example "partition-001"
+       */
+      partition: string
+      /**
+       * Name of the attribute, found under the value object in the partition record
+       * @example "hasSafetyTraining"
+       */
+      attributeName: string
+      /**
+       * Description used for message displayed to user when requirement is not met
+       * @example "hasSafetyTraining"
+       */
+      description: string
+    }[]
   }[]
 }
 
@@ -5071,7 +5169,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title No title
- * @version 2.0.8
+ * @version 2.0.11
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -5736,7 +5834,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    createFaq: (tenantId: string, faqId: string, data: InputI1Zjq906Kx, params: RequestParams = {}) =>
+    createFaq: (tenantId: string, faqId: string, data: InputSd925Fyovd, params: RequestParams = {}) =>
       this.request<CreateFaqData, CreateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'POST',
@@ -5755,7 +5853,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    updateFaq: (tenantId: string, faqId: string, data: InputLleaava7Ug, params: RequestParams = {}) =>
+    updateFaq: (tenantId: string, faqId: string, data: InputLz115Z1F9W, params: RequestParams = {}) =>
       this.request<UpdateFaqData, UpdateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'PUT',