@ikonintegration/module-config-api 2.0.16 → 2.0.17

package/dist/Api.d.ts

@@ -33,10 +33,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"
@@ -47,11 +47,6 @@ export interface CustomerResponse {
      * @example "user"
      */
     userRole?: string;
-    /**
-     * Timezone code
-     * @example "America/Vancouver"
-     */
-    timezoneCode: string;
     /**
      * Instructor role identifier
      * @example "instructor"
@@ -67,6 +62,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"
@@ -98,7 +103,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;
@@ -112,11 +117,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"
@@ -142,16 +157,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"
@@ -163,65 +194,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"
@@ -232,56 +267,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;
-    /**
-     * Blocks the course using a trigger block
-     * @example false
-     */
-    blockCourse?: 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}]
@@ -301,6 +357,16 @@ export interface CustomerResponse {
         metadata?: string;
     }[];
 }
+/**
+ * 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 {
     /**
@@ -309,10 +375,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"
@@ -323,11 +389,6 @@ export interface CustomerRequestBody {
      * @example "user"
      */
     userRole?: string;
-    /**
-     * Timezone code
-     * @example "America/Vancouver"
-     */
-    timezoneCode: string;
     /**
      * Instructor role identifier
      * @example "instructor"
@@ -343,6 +404,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"
@@ -374,7 +445,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;
@@ -388,11 +459,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"
@@ -418,16 +499,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"
@@ -439,65 +536,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"
@@ -508,56 +609,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;
-    /**
-     * Blocks the course using a trigger block
-     * @example false
-     */
-    blockCourse?: 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}]
@@ -2772,7 +2894,7 @@ export interface FaqResponse {
      */
     answer?: string;
 }
-export interface InputFchy2Vqm36 {
+export interface InputZhvrz8Yp0W {
     /**
      * Tenant ID this FAQ belongs to
      * @example "tenant456"
@@ -2794,7 +2916,7 @@ export interface InputFchy2Vqm36 {
      */
     answer?: string;
 }
-export interface InputArlvymhzth {
+export interface Input9397F836Qfh {
     /**
      * Tenant ID this FAQ belongs to
      * @example "tenant456"
@@ -4951,7 +5073,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title No title
- * @version 2.0.16
+ * @version 2.0.17
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -5315,7 +5437,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/tenant/{tenantID}/faq/{faqID}
          * @secure
          */
-        createFaq: (tenantId: string, faqId: string, data: InputFchy2Vqm36, params?: RequestParams) => Promise<any>;
+        createFaq: (tenantId: string, faqId: string, data: InputZhvrz8Yp0W, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing FAQ.
          *
@@ -5325,7 +5447,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/tenant/{tenantID}/faq/{faqID}
          * @secure
          */
-        updateFaq: (tenantId: string, faqId: string, data: InputArlvymhzth, params?: RequestParams) => Promise<any>;
+        updateFaq: (tenantId: string, faqId: string, data: Input9397F836Qfh, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a FAQ.
          *