@ikonintegration/module-config-api 2.0.15 → 2.0.17

package/Api.ts

@@ -45,10 +45,10 @@ export interface CustomerResponse {
    */
   id: string
   /**
-   * Display name of the customer
-   * @example "ACME Corporation"
+   * Timezone code
+   * @example "America/Vancouver"
    */
-  displayName?: string
+  timezoneCode: string
   /**
    * Admin role identifier
    * @example "admin"
@@ -59,11 +59,6 @@ export interface CustomerResponse {
    * @example "user"
    */
   userRole?: string
-  /**
-   * Timezone code
-   * @example "America/Vancouver"
-   */
-  timezoneCode: string
   /**
    * Instructor role identifier
    * @example "instructor"
@@ -79,6 +74,16 @@ export interface CustomerResponse {
    * @example "idm_token_456"
    */
   idmToken?: string
+  /**
+   * IDM API user
+   * @example "api_user"
+   */
+  idmAPIUser?: string
+  /**
+   * IDM API password
+   * @example "api_password"
+   */
+  idmAPIPassword?: string
   /**
    * Email sender address
    * @example "noreply@example.com"
@@ -110,7 +115,7 @@ export interface CustomerResponse {
    */
   orgUserRole?: string
   /**
-   * namespace for the instance of org module to be used. Used to build the LMS FE.
+   * Namespace for the instance of org module to be used. Used to build the LMS FE.
    * @example "bccsa"
    */
   orgModNamespace?: string
@@ -124,11 +129,21 @@ export interface CustomerResponse {
    * @example ["req1","req2"]
    */
   allowedForeignReqs?: string[]
+  /**
+   * Display name of the customer
+   * @example "ACME Corporation"
+   */
+  displayName?: string
   /**
    * Shared module license API key
    * @example "license_api_key"
    */
   sharedModuleLicenseAPIKey?: string
+  /**
+   * Shared module config API key
+   * @example "config_api_key"
+   */
+  sharedModuleConfigAPIKey?: string
   /**
    * Shared module auditing API key
    * @example "auditing_api_key"
@@ -154,16 +169,32 @@ export interface CustomerResponse {
    * @example "mailer_api_key"
    */
   sharedModuleMailerAPIKey?: string
-  /**
-   * Authentication configuration object
-   * @example {"provider":"cognito","region":"us-west-2"}
-   */
-  authConfig?: any
-  /**
-   * UI theme identifier
-   * @example "default"
-   */
-  theme?: string
+  /** Authentication configuration object */
+  authConfig?: AuthConfig
+  portalConfig?: {
+    /**
+     * Portal theme identifier
+     * @example "default"
+     */
+    theme?: string
+    /**
+     * Portal domain
+     * @example "portal.example.com"
+     */
+    domain?: string
+    /**
+     * Cookies hub domain for the portal
+     * @example ".example.com"
+     */
+    cookiesHubDomain?: string
+    /**
+     * Accepted connections origin
+     * @example "https://app.example.com"
+     */
+    acceptConnectionsFrom?: string
+  }
+  /** UI theme configuration object */
+  theme?: ThemeConfig
   /**
    * Customer domain
    * @example "customer.example.com"
@@ -175,65 +206,69 @@ export interface CustomerResponse {
    */
   cookiesHubDomain?: string
   /**
-   * Platform for accepting connections
-   * @example "web"
+   * List of origins allowed to connect
+   * @example ["https://app.example.com"]
    */
-  acceptConnectionsPlatform?: string
+  acceptConnectionsFrom?: string[]
   /**
    * Worksafe terminology
    * @example "WorkSafeBC"
    */
   worksafeTerm?: string
-  /**
-   * List of cancelation policies
-   * @example [{"type":"standard","rules":[]}]
-   */
-  cancelationPolicies?: any[]
-  /**
-   * Whether to use business days
-   * @example 1
-   */
-  isBusinessDays?: number
-  /**
-   * Whether bookings can be canceled
-   * @example true
-   */
-  canBeCanceled?: boolean
-  /**
-   * Whether bookings can be rescheduled
-   * @example true
-   */
-  canBeRescheduled?: boolean
-  /**
-   * List of rules
-   * @example []
-   */
-  rules?: any[]
-  /**
-   * Days before for policy application
-   * @example 7
-   */
-  useDaysBefore?: number
-  /**
-   * Percentage refunded on cancelation
-   * @example 100
-   */
-  percentageRefunded?: number
-  /**
-   * Amount charged on cancelation
-   * @example 0
-   */
-  amountCharged?: number
-  /**
-   * Whether to deduct enrollment payment
-   * @example false
-   */
-  deductEnrollmentPayment?: boolean
-  /**
-   * Whether customer has refund policy
-   * @example true
-   */
-  hasRefundPolicy?: boolean
+  /** List of cancelation policies */
+  cancelationPolicies?: {
+    /**
+     * Cancelation policy identifier
+     * @example "policy_1"
+     */
+    id?: string
+    /**
+     * Cancelation policy description
+     * @example "Standard cancelation policy"
+     */
+    description?: string
+    /** Cancel policy configuration */
+    cancelPolicy?: {
+      /**
+       * Whether to use business days for calculations
+       * @example true
+       */
+      isBusinessDays?: boolean
+      /**
+       * Whether bookings can be canceled
+       * @example true
+       */
+      canBeCanceled?: boolean
+      /**
+       * Whether bookings can be rescheduled
+       * @example true
+       */
+      canBeRescheduled?: boolean
+      /** List of cancelation rules */
+      rules?: {
+        /**
+         * Number of days before the event for this rule to apply
+         * @example 7
+         */
+        untilDaysBefore?: number
+        /**
+         * Percentage refunded on cancelation
+         * @example 100
+         */
+        percentageRefunded?: number
+        /**
+         * Amount charged on cancelation
+         * @example 0
+         */
+        amountCharged?: number
+        /**
+         * Whether to deduct enrolment payment
+         * @example false
+         */
+        deductEnrolmentPayment?: boolean
+      }[]
+    }
+  }[]
   /**
    * Sales tax label
    * @example "GST"
@@ -244,51 +279,77 @@ export interface CustomerResponse {
    * @example false
    */
   ignoreCustomAttributesForSignUp?: boolean
-  /**
-   * List of cooldown policies
-   * @example [{"courseID":"course1","cooldownPolicy":{"rules":[]}}]
-   */
-  cooldownPolicies?: any[]
-  /**
-   * Number of failed attempts before refill
-   * @example 3
-   */
-  refillFailedAttempts?: number
-  /**
-   * Cooldown period in days
-   * @example 30
-   */
-  cooldownPeriod?: number
-  /**
-   * Whether to invalidate course requirements
-   * @example false
-   */
-  invalidateCourseRequirements?: boolean
-  /**
-   * Whether to lock application
-   * @example false
-   */
-  lockApplication?: boolean
-  /**
-   * Days before auto-unlock
-   * @example 90
-   */
-  autoUnlockDays?: number
-  /**
-   * UI configuration object
-   * @example {"primaryColor":"#007bff"}
-   */
-  ui?: any
-  /**
-   * Banner configuration object
-   * @example {"enabled":true,"message":"Welcome!"}
-   */
-  banner?: any
   /**
    * Customer timezone
    * @example "America/Vancouver"
    */
   timezone?: string
+  /** Tile permissions configuration */
+  tilePermissions?: any
+  /** List of cooldown policies */
+  cooldownPolicies?: {
+    /**
+     * Cooldown policy identifier
+     * @example "cooldown_1"
+     */
+    id?: string
+    /**
+     * Cooldown policy description
+     * @example "Standard cooldown policy"
+     */
+    description?: string
+    /** Cooldown policy configuration */
+    cooldownPolicy?: {
+      /** List of cooldown rules */
+      rules?: {
+        /**
+         * Number of failed attempts before this rule applies
+         * @example 3
+         */
+        untilFailedAttempts?: number
+        /**
+         * Cooldown period in days
+         * @example 30
+         */
+        cooldownPeriod?: number
+        /**
+         * Whether to invalidate course requirements
+         * @example false
+         */
+        invalidateCourseRequirements?: boolean
+        /**
+         * Whether to lock application
+         * @example false
+         */
+        lockApplication?: boolean
+        /**
+         * Blocks the course using a trigger block
+         * @example false
+         */
+        blockCourse?: boolean
+        /**
+         * Days before auto-unlock
+         * @example 90
+         */
+        autoUnlockInDays?: number
+      }[]
+    }
+  }[]
+  ui?: {
+    /** Banner configuration */
+    banner?: {
+      /**
+       * Banner type
+       * @example "info"
+       */
+      type?: string
+      /**
+       * Banner content
+       * @example "Welcome to the platform!"
+       */
+      content?: string
+    }
+  }
   /**
    * List of feature flags
    * @example [{"name":"dark_mode","enabled":true}]
@@ -309,6 +370,18 @@ export interface CustomerResponse {
   }[]
 }
 
+/**
+ * Authentication configuration object
+ * @example {"provider":"cognito","region":"us-west-2"}
+ */
+export type AuthConfig = Record<string, any>
+
+/**
+ * UI theme configuration object
+ * @example {"primaryColor":"#007bff"}
+ */
+export type ThemeConfig = Record<string, any>
+
 /** Customer request body for create/update operations */
 export interface CustomerRequestBody {
   /**
@@ -317,10 +390,10 @@ export interface CustomerRequestBody {
    */
   id: string
   /**
-   * Display name of the customer
-   * @example "ACME Corporation"
+   * Timezone code
+   * @example "America/Vancouver"
    */
-  displayName?: string
+  timezoneCode: string
   /**
    * Admin role identifier
    * @example "admin"
@@ -331,11 +404,6 @@ export interface CustomerRequestBody {
    * @example "user"
    */
   userRole?: string
-  /**
-   * Timezone code
-   * @example "America/Vancouver"
-   */
-  timezoneCode: string
   /**
    * Instructor role identifier
    * @example "instructor"
@@ -351,6 +419,16 @@ export interface CustomerRequestBody {
    * @example "idm_token_456"
    */
   idmToken?: string
+  /**
+   * IDM API user
+   * @example "api_user"
+   */
+  idmAPIUser?: string
+  /**
+   * IDM API password
+   * @example "api_password"
+   */
+  idmAPIPassword?: string
   /**
    * Email sender address
    * @example "noreply@example.com"
@@ -382,7 +460,7 @@ export interface CustomerRequestBody {
    */
   orgUserRole?: string
   /**
-   * namespace for the instance of org module to be used. Used to build the LMS FE.
+   * Namespace for the instance of org module to be used. Used to build the LMS FE.
    * @example "bccsa"
    */
   orgModNamespace?: string
@@ -396,11 +474,21 @@ export interface CustomerRequestBody {
    * @example ["req1","req2"]
    */
   allowedForeignReqs?: string[]
+  /**
+   * Display name of the customer
+   * @example "ACME Corporation"
+   */
+  displayName?: string
   /**
    * Shared module license API key
    * @example "license_api_key"
    */
   sharedModuleLicenseAPIKey?: string
+  /**
+   * Shared module config API key
+   * @example "config_api_key"
+   */
+  sharedModuleConfigAPIKey?: string
   /**
    * Shared module auditing API key
    * @example "auditing_api_key"
@@ -426,16 +514,32 @@ export interface CustomerRequestBody {
    * @example "mailer_api_key"
    */
   sharedModuleMailerAPIKey?: string
-  /**
-   * Authentication configuration object
-   * @example {"provider":"cognito","region":"us-west-2"}
-   */
-  authConfig?: any
-  /**
-   * UI theme identifier
-   * @example "default"
-   */
-  theme?: string
+  /** Authentication configuration object */
+  authConfig?: AuthConfig
+  portalConfig?: {
+    /**
+     * Portal theme identifier
+     * @example "default"
+     */
+    theme?: string
+    /**
+     * Portal domain
+     * @example "portal.example.com"
+     */
+    domain?: string
+    /**
+     * Cookies hub domain for the portal
+     * @example ".example.com"
+     */
+    cookiesHubDomain?: string
+    /**
+     * Accepted connections origin
+     * @example "https://app.example.com"
+     */
+    acceptConnectionsFrom?: string
+  }
+  /** UI theme configuration object */
+  theme?: ThemeConfig
   /**
    * Customer domain
    * @example "customer.example.com"
@@ -447,65 +551,69 @@ export interface CustomerRequestBody {
    */
   cookiesHubDomain?: string
   /**
-   * Platform for accepting connections
-   * @example "web"
+   * List of origins allowed to connect
+   * @example ["https://app.example.com"]
    */
-  acceptConnectionsPlatform?: string
+  acceptConnectionsFrom?: string[]
   /**
    * Worksafe terminology
    * @example "WorkSafeBC"
    */
   worksafeTerm?: string
-  /**
-   * List of cancelation policies
-   * @example [{"type":"standard","rules":[]}]
-   */
-  cancelationPolicies?: any[]
-  /**
-   * Whether to use business days
-   * @example 1
-   */
-  isBusinessDays?: number
-  /**
-   * Whether bookings can be canceled
-   * @example true
-   */
-  canBeCanceled?: boolean
-  /**
-   * Whether bookings can be rescheduled
-   * @example true
-   */
-  canBeRescheduled?: boolean
-  /**
-   * List of rules
-   * @example []
-   */
-  rules?: any[]
-  /**
-   * Days before for policy application
-   * @example 7
-   */
-  useDaysBefore?: number
-  /**
-   * Percentage refunded on cancelation
-   * @example 100
-   */
-  percentageRefunded?: number
-  /**
-   * Amount charged on cancelation
-   * @example 0
-   */
-  amountCharged?: number
-  /**
-   * Whether to deduct enrollment payment
-   * @example false
-   */
-  deductEnrollmentPayment?: boolean
-  /**
-   * Whether customer has refund policy
-   * @example true
-   */
-  hasRefundPolicy?: boolean
+  /** List of cancelation policies */
+  cancelationPolicies?: {
+    /**
+     * Cancelation policy identifier
+     * @example "policy_1"
+     */
+    id?: string
+    /**
+     * Cancelation policy description
+     * @example "Standard cancelation policy"
+     */
+    description?: string
+    /** Cancel policy configuration */
+    cancelPolicy?: {
+      /**
+       * Whether to use business days for calculations
+       * @example true
+       */
+      isBusinessDays?: boolean
+      /**
+       * Whether bookings can be canceled
+       * @example true
+       */
+      canBeCanceled?: boolean
+      /**
+       * Whether bookings can be rescheduled
+       * @example true
+       */
+      canBeRescheduled?: boolean
+      /** List of cancelation rules */
+      rules?: {
+        /**
+         * Number of days before the event for this rule to apply
+         * @example 7
+         */
+        untilDaysBefore?: number
+        /**
+         * Percentage refunded on cancelation
+         * @example 100
+         */
+        percentageRefunded?: number
+        /**
+         * Amount charged on cancelation
+         * @example 0
+         */
+        amountCharged?: number
+        /**
+         * Whether to deduct enrolment payment
+         * @example false
+         */
+        deductEnrolmentPayment?: boolean
+      }[]
+    }
+  }[]
   /**
    * Sales tax label
    * @example "GST"
@@ -516,51 +624,77 @@ export interface CustomerRequestBody {
    * @example false
    */
   ignoreCustomAttributesForSignUp?: boolean
-  /**
-   * List of cooldown policies
-   * @example [{"courseID":"course1","cooldownPolicy":{"rules":[]}}]
-   */
-  cooldownPolicies?: any[]
-  /**
-   * Number of failed attempts before refill
-   * @example 3
-   */
-  refillFailedAttempts?: number
-  /**
-   * Cooldown period in days
-   * @example 30
-   */
-  cooldownPeriod?: number
-  /**
-   * Whether to invalidate course requirements
-   * @example false
-   */
-  invalidateCourseRequirements?: boolean
-  /**
-   * Whether to lock application
-   * @example false
-   */
-  lockApplication?: boolean
-  /**
-   * Days before auto-unlock
-   * @example 90
-   */
-  autoUnlockDays?: number
-  /**
-   * UI configuration object
-   * @example {"primaryColor":"#007bff"}
-   */
-  ui?: any
-  /**
-   * Banner configuration object
-   * @example {"enabled":true,"message":"Welcome!"}
-   */
-  banner?: any
   /**
    * Customer timezone
    * @example "America/Vancouver"
    */
   timezone?: string
+  /** Tile permissions configuration */
+  tilePermissions?: any
+  /** List of cooldown policies */
+  cooldownPolicies?: {
+    /**
+     * Cooldown policy identifier
+     * @example "cooldown_1"
+     */
+    id?: string
+    /**
+     * Cooldown policy description
+     * @example "Standard cooldown policy"
+     */
+    description?: string
+    /** Cooldown policy configuration */
+    cooldownPolicy?: {
+      /** List of cooldown rules */
+      rules?: {
+        /**
+         * Number of failed attempts before this rule applies
+         * @example 3
+         */
+        untilFailedAttempts?: number
+        /**
+         * Cooldown period in days
+         * @example 30
+         */
+        cooldownPeriod?: number
+        /**
+         * Whether to invalidate course requirements
+         * @example false
+         */
+        invalidateCourseRequirements?: boolean
+        /**
+         * Whether to lock application
+         * @example false
+         */
+        lockApplication?: boolean
+        /**
+         * Blocks the course using a trigger block
+         * @example false
+         */
+        blockCourse?: boolean
+        /**
+         * Days before auto-unlock
+         * @example 90
+         */
+        autoUnlockInDays?: number
+      }[]
+    }
+  }[]
+  ui?: {
+    /** Banner configuration */
+    banner?: {
+      /**
+       * Banner type
+       * @example "info"
+       */
+      type?: string
+      /**
+       * Banner content
+       * @example "Welcome to the platform!"
+       */
+      content?: string
+    }
+  }
   /**
    * List of feature flags
    * @example [{"name":"dark_mode","enabled":true}]
@@ -2800,7 +2934,7 @@ export interface FaqResponse {
   answer?: string
 }
 
-export interface InputOmmkv6Qbjz {
+export interface InputZhvrz8Yp0W {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -2823,7 +2957,7 @@ export interface InputOmmkv6Qbjz {
   answer?: string
 }
 
-export interface InputGhx4Iq09Fe {
+export interface Input9397F836Qfh {
   /**
    * Tenant ID this FAQ belongs to
    * @example "tenant456"
@@ -5220,7 +5354,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title No title
- * @version 2.0.15
+ * @version 2.0.17
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -5885,7 +6019,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    createFaq: (tenantId: string, faqId: string, data: InputOmmkv6Qbjz, params: RequestParams = {}) =>
+    createFaq: (tenantId: string, faqId: string, data: InputZhvrz8Yp0W, params: RequestParams = {}) =>
       this.request<CreateFaqData, CreateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'POST',
@@ -5904,7 +6038,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/tenant/{tenantID}/faq/{faqID}
      * @secure
      */
-    updateFaq: (tenantId: string, faqId: string, data: InputGhx4Iq09Fe, params: RequestParams = {}) =>
+    updateFaq: (tenantId: string, faqId: string, data: Input9397F836Qfh, params: RequestParams = {}) =>
       this.request<UpdateFaqData, UpdateFaqError>({
         path: `/tenant/${tenantId}/faq/${faqId}`,
         method: 'PUT',