@ikonintegration/bccsa-program-api 2.0.0 → 2.0.2

package/dist/Api.d.ts

@@ -5,13 +5,13 @@ export interface ErrorResponse {
     /** Error code */
     errCode: string;
 }
-export interface Input9Jxov33U7D {
+export interface InputRyn8Fqi8Q8 {
     /** @minLength 1 */
     customerID: string;
     /** @minLength 1 */
     name: string;
 }
-export interface InputUse5Vle8Ta {
+export interface InputA37Dqilje2F {
     /** @minLength 1 */
     customerID: string;
     /** @minLength 1 */
@@ -129,7 +129,7 @@ export interface VenueUpdateSchema {
      */
     name: string;
     /** Venue address */
-    address: {
+    address?: {
         /**
          * Street address line 1
          * @minLength 1
@@ -170,26 +170,59 @@ export interface InstructorRegionUpdateSchema {
     /** List of region IDs */
     regionIDs: string[];
 }
-export interface Input33N9Vgyjyy {
+export interface InputOb05Eq1Siz {
     startTime: string | number;
     endTime: string | number;
     expandSessions?: boolean;
 }
-export interface Input56Hzg6Xiz2 {
+export interface InputRvfjoz2Va7H {
+    /** @minLength 1 */
+    customerID: string;
+    /** @minLength 1 */
+    userID: string;
     startTime: string | number;
     endTime: string | number;
     description?: string;
 }
-export interface Input3Yilrlis7M {
+export interface InputSnnpdh9Ntel {
+    /** @minLength 1 */
+    customerID: string;
+    /** @minLength 1 */
+    userID: string;
     startTime: string | number;
     endTime: string | number;
     description?: string;
 }
-export interface InputKi6Tbrci1R {
+export interface Input37Rcsdcvr4 {
     /** @minLength 1 */
     calendarColor: string;
 }
+export interface InputS3N0Gqu4Tn {
+    createdBy?: string;
+    /** @default 1787190907967 */
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+    /** @default "clrCustomerCalendarSync" */
+    dbEntity?: string;
+    customerID: string;
+    providerID: string;
+    syncProvider?: string;
+}
+export interface InputJklpdji565 {
+    createdBy?: string;
+    /** @default 1787190907967 */
+    createdOn?: number;
+    updatedBy?: string;
+    updatedOn?: number;
+    /** @default "clrCustomerCalendarSync" */
+    dbEntity?: string;
+    customerID: string;
+    providerID: string;
+    syncProvider?: string;
+}
 export interface SessionCourseTemplateCreateSchema {
+    id?: string | null;
     /**
      * Tenant ID
      * @minLength 1
@@ -233,6 +266,7 @@ export interface SessionCourseTemplateCreateSchema {
     chargeDeferred?: boolean;
     checkGradeDelay?: number;
     courseMaterialProductID?: string | null;
+    customerID?: string | null;
     isEligibleForNoCost?: boolean;
     cancelationPolicyID?: string | null;
     reschedulePolicyID?: string | null;
@@ -274,6 +308,7 @@ export interface SessionCourseTemplateCreateSchema {
     accessLink?: string | null;
 }
 export interface SessionCourseTemplateUpdateSchema {
+    id?: string | null;
     /**
      * Template name
      * @minLength 1
@@ -307,6 +342,7 @@ export interface SessionCourseTemplateUpdateSchema {
     chargeDeferred?: boolean;
     checkGradeDelay?: number;
     courseMaterialProductID?: string | null;
+    customerID?: string | null;
     isEligibleForNoCost?: boolean;
     cancelationPolicyID?: string | null;
     reschedulePolicyID?: string | null;
@@ -455,11 +491,11 @@ export interface SessionCreateSchema {
     dbEntity?: string | null;
     startDate: (string | number)[];
     endDate: (string | number)[];
-    onlineCourseLabel?: string[] | null;
-    onlineCourseID?: string[] | null;
+    onlineCourseLabel?: (string | null)[];
+    onlineCourseID?: (string | null)[];
     onlineGradeID?: any[];
     onlineQuizID?: any[];
-    onlineScoreGradeID?: string[] | null;
+    onlineScoreGradeID?: (string | null)[];
     enrolmentCount?: number;
     enrolmentReservedCount?: number;
     charges?: any;
@@ -558,11 +594,11 @@ export interface SessionUpdateSchema {
     dbEntity?: string | null;
     startDate: (string | number)[];
     endDate: (string | number)[];
-    onlineCourseLabel?: string[] | null;
-    onlineCourseID?: string[] | null;
+    onlineCourseLabel?: (string | null)[];
+    onlineCourseID?: (string | null)[];
     onlineGradeID?: any[];
     onlineQuizID?: any[];
-    onlineScoreGradeID?: string[] | null;
+    onlineScoreGradeID?: (string | null)[];
     enrolmentCount?: number;
     enrolmentReservedCount?: number;
     charges?: any;
@@ -579,15 +615,15 @@ export interface SessionDuplicateSchema {
     /** Array of timestamps for new sessions */
     newSessionDates: number[];
 }
-export interface InputQ59Gbvuj7G {
-    attendanceStatus: InputQ59Gbvuj7GAttendanceStatusEnum;
+export interface InputFqn05Tb1Yv {
+    attendanceStatus: InputFqn05Tb1YvAttendanceStatusEnum;
     additionalNotes?: string | null;
 }
-export interface Input5S9Qlxsfdw {
-    attendanceStatus: Input5S9QlxsfdwAttendanceStatusEnum;
+export interface Input91Decqoqn8 {
+    attendanceStatus: Input91Decqoqn8AttendanceStatusEnum;
     additionalNotes?: string | null;
 }
-export interface InputKdcf6Vev2F {
+export interface InputW0G2O8Cuvdl {
     /** @minLength 1 */
     ticketID: string;
     /** @minLength 1 */
@@ -596,42 +632,70 @@ export interface InputKdcf6Vev2F {
     isReservedSeat?: boolean;
     [key: string]: any;
 }
-export interface InputPcoc6Mas3J {
+export interface InputSclutmxuej {
     materialShippingInfo?: Record<string, any>;
     [key: string]: any;
 }
-export interface Input56A08Qop2C {
+export interface InputZsatdyx4Yb {
     amount: number;
-    chargeResult: Input56A08Qop2CChargeResultEnum;
+    chargeResult: InputZsatdyx4YbChargeResultEnum;
     description?: string | null;
     /** @minLength 1 */
     paymentProvider: string;
     providerTransactionID?: string | null;
     timestamp: number;
 }
-export interface InputHuw5M2U5Gx {
-    resultStatus: InputHuw5M2U5GxResultStatusEnum;
-    resultNotes?: string | null;
+export interface InputO95Jklccli {
+    resultStatus: InputO95JklccliResultStatusEnum;
+    resultNotes?: string | number;
     resultGrade?: number;
+    resultDate?: number;
     retainAcessToCourse?: boolean;
     resultOverrideDate?: number;
-    isManuallyPublished?: boolean;
-    orgID?: string | null;
-    employerName?: string | null;
 }
-export interface InputXxwuna2Nn {
-    resultStatus: InputXxwuna2NnResultStatusEnum;
-    resultNotes?: string | null;
+export interface InputDyh11Pfxop {
+    resultStatus: InputDyh11PfxopResultStatusEnum;
+    resultNotes?: string | number;
     resultGrade?: number;
+    resultDate?: number;
     retainAcessToCourse?: boolean;
     resultOverrideDate?: number;
-    isManuallyPublished?: boolean;
-    orgID?: string | null;
-    employerName?: string | null;
 }
 export interface SessionInstructorSchema {
+    /**
+     * Instructor assignment ID
+     * @minLength 1
+     */
+    id?: string;
+    /**
+     * Session ID
+     * @minLength 1
+     */
+    sessionID: string;
+    /**
+     * Customer ID
+     * @minLength 1
+     */
+    customerID: string;
+    /**
+     * Tenant ID
+     * @minLength 1
+     */
+    tenantID: string;
+    /**
+     * Course ID
+     * @minLength 1
+     */
+    courseID?: string;
+    /**
+     * User ID
+     * @minLength 1
+     */
+    userID: string;
     /** Instructor type */
     instructorType: SessionInstructorSchemaInstructorTypeEnum;
+    /** Instructor assignment start time (timestamp) */
+    startTime?: number;
 }
 export interface SessionsInstructorSetSchema {
     /** Array of session IDs */
@@ -639,7 +703,7 @@ export interface SessionsInstructorSetSchema {
     /** Instructor type */
     instructorType: SessionsInstructorSetSchemaInstructorTypeEnum;
 }
-export interface InputW0Gt14Iief {
+export interface Input1Qxi23Thcx {
     activationCode?: string | null;
     /** @minLength 1 */
     email: string;
@@ -647,7 +711,7 @@ export interface InputW0Gt14Iief {
     isReservedSeat?: boolean;
     maxUsage: number;
 }
-export interface InputF61Tonm0Be {
+export interface InputFa6Do54Syp {
     useCount?: any;
     maxUsage: number;
 }
@@ -721,20 +785,14 @@ export interface SessionResultReportSchema {
 }
 export interface SessionResultsReportSchema {
     filters: {
-        /**
-         * Start date
-         * @minLength 1
-         */
-        dateFrom: string;
-        /**
-         * End date
-         * @minLength 1
-         */
-        dateTo: string;
+        dateFrom: string | number;
+        dateTo: string | number;
         /** Optional course IDs filter */
         courseIDs?: any;
         /** Optional pagination from */
         from?: any;
+        /** Tenant ID */
+        tenantID?: string | null;
     };
 }
 export interface SessionListReportSchema {
@@ -755,8 +813,13 @@ export interface SessionListReportSchema {
         instructorID?: string | null;
         /** Optional state filter */
         state?: string | null;
+        /** Tenant ID */
+        tenantID?: string | null;
     };
 }
+export interface Input72L9Nt3Sdc {
+    updateShippingInfo?: boolean;
+}
 export declare enum SessionCourseTemplateCreateSchemaReleaseTypeEnum {
     NONE = "NONE",
     AUTO = "AUTO",
@@ -833,26 +896,26 @@ export declare enum SessionUpdateSchemaTypeEnum {
     ONLINE_EXT = "ONLINE_EXT",
     ONLINE = "ONLINE"
 }
-export declare enum InputQ59Gbvuj7GAttendanceStatusEnum {
+export declare enum InputFqn05Tb1YvAttendanceStatusEnum {
     INCOMPLETE = "INCOMPLETE",
     NO_SHOW = "NO_SHOW",
     ATTENDED = "ATTENDED"
 }
-export declare enum Input5S9QlxsfdwAttendanceStatusEnum {
+export declare enum Input91Decqoqn8AttendanceStatusEnum {
     INCOMPLETE = "INCOMPLETE",
     NO_SHOW = "NO_SHOW",
     ATTENDED = "ATTENDED"
 }
-export declare enum Input56A08Qop2CChargeResultEnum {
+export declare enum InputZsatdyx4YbChargeResultEnum {
     SUCCESS = "SUCCESS",
     FAIL = "FAIL"
 }
-export declare enum InputHuw5M2U5GxResultStatusEnum {
+export declare enum InputO95JklccliResultStatusEnum {
     INCOMPLETE = "INCOMPLETE",
     FAIL = "FAIL",
     PASS = "PASS"
 }
-export declare enum InputXxwuna2NnResultStatusEnum {
+export declare enum InputDyh11PfxopResultStatusEnum {
     INCOMPLETE = "INCOMPLETE",
     FAIL = "FAIL",
     PASS = "PASS"
@@ -1156,7 +1219,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title Classroom Module API
- * @version 2.0.0
+ * @version 2.0.2
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -1181,7 +1244,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/region/{regionID}
          * @secure
          */
-        createRegion: (regionId: string, data: Input9Jxov33U7D, params?: RequestParams) => Promise<any>;
+        createRegion: (regionId: string, data: InputRyn8Fqi8Q8, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing region
          *
@@ -1191,7 +1254,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/region/{regionID}
          * @secure
          */
-        updateRegion: (regionId: string, data: InputUse5Vle8Ta, params?: RequestParams) => Promise<any>;
+        updateRegion: (regionId: string, data: InputA37Dqilje2F, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a region by ID
          *
@@ -1413,7 +1476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/instructor/{instructorID}/events
          * @secure
          */
-        listEvents: (instructorId: string, data: Input33N9Vgyjyy, params?: RequestParams) => Promise<any>;
+        listEvents: (instructorId: string, data: InputOb05Eq1Siz, params?: RequestParams) => Promise<any>;
         /**
          * @description Retrieve an instructor availability event
          *
@@ -1433,7 +1496,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/instructor/{instructorID}/availabilityEvent/{startTime}
          * @secure
          */
-        createAvailabilityEvent: (instructorId: string, startTime: string, data: Input56Hzg6Xiz2, params?: RequestParams) => Promise<any>;
+        createAvailabilityEvent: (instructorId: string, startTime: string, data: InputRvfjoz2Va7H, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an instructor availability event (delete + recreate)
          *
@@ -1443,7 +1506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/instructor/{instructorID}/availabilityEvent/{startTime}
          * @secure
          */
-        updateAvailabilityEvent: (instructorId: string, startTime: string, data: Input3Yilrlis7M, params?: RequestParams) => Promise<any>;
+        updateAvailabilityEvent: (instructorId: string, startTime: string, data: InputSnnpdh9Ntel, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete an instructor availability event
          *
@@ -1537,7 +1600,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/course/{courseID}/calendar
          * @secure
          */
-        updateCalendar: (courseId: string, data: InputKi6Tbrci1R, params?: RequestParams) => Promise<any>;
+        updateCalendar: (courseId: string, data: Input37Rcsdcvr4, params?: RequestParams) => Promise<any>;
         /**
          * @description Retrieve a course enrolment ticket
          *
@@ -1589,7 +1652,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/courses/calendarSync/{providerID}
          * @secure
          */
-        createCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
+        createCalendarSync: (providerId: string, data: InputS3N0Gqu4Tn, params?: RequestParams) => Promise<any>;
         /**
          * @description Update a course calendar sync
          *
@@ -1599,7 +1662,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/courses/calendarSync/{providerID}
          * @secure
          */
-        updateCalendarSync: (providerId: string, params?: RequestParams) => Promise<any>;
+        updateCalendarSync: (providerId: string, data: InputJklpdji565, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a course calendar sync
          *
@@ -1919,7 +1982,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/session/{sessionID}/attendance/{attendanceID}/{externalID}
          * @secure
          */
-        createAttendance: (sessionId: string, attendanceId: string, externalId: string, data: InputQ59Gbvuj7G, params?: RequestParams) => Promise<any>;
+        createAttendance: (sessionId: string, attendanceId: string, externalId: string, data: InputFqn05Tb1Yv, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing attendance record
          *
@@ -1929,7 +1992,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/session/{sessionID}/attendance/{attendanceID}/{externalID}
          * @secure
          */
-        updateAttendance: (sessionId: string, attendanceId: string, externalId: string, data: Input5S9Qlxsfdw, params?: RequestParams) => Promise<any>;
+        updateAttendance: (sessionId: string, attendanceId: string, externalId: string, data: Input91Decqoqn8, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete an attendance record
          *
@@ -1959,7 +2022,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
          * @secure
          */
-        createEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputKdcf6Vev2F, params?: RequestParams) => Promise<any>;
+        createEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputW0G2O8Cuvdl, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing session enrolment
          *
@@ -1969,7 +2032,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
          * @secure
          */
-        updateEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputPcoc6Mas3J, params?: RequestParams) => Promise<any>;
+        updateEnrolment: (sessionId: string, enrolmentId: string, externalId: string, data: InputSclutmxuej, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a session enrolment
          *
@@ -2041,7 +2104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/charge
          * @secure
          */
-        createEnrolmentCharge: (sessionId: string, enrolmentId: string, externalId: string, data: Input56A08Qop2C, params?: RequestParams) => Promise<any>;
+        createEnrolmentCharge: (sessionId: string, enrolmentId: string, externalId: string, data: InputZsatdyx4Yb, params?: RequestParams) => Promise<any>;
         /**
          * @description Retrieve a specific session result
          *
@@ -2061,7 +2124,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/session/{sessionID}/result/{resultID}/{externalID}
          * @secure
          */
-        createResult: (sessionId: string, resultId: string, externalId: string, data: InputHuw5M2U5Gx, params?: RequestParams) => Promise<any>;
+        createResult: (sessionId: string, resultId: string, externalId: string, data: InputO95Jklccli, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing session result
          *
@@ -2071,7 +2134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/session/{sessionID}/result/{resultID}/{externalID}
          * @secure
          */
-        updateResult: (sessionId: string, resultId: string, externalId: string, data: InputXxwuna2Nn, params?: RequestParams) => Promise<any>;
+        updateResult: (sessionId: string, resultId: string, externalId: string, data: InputDyh11Pfxop, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a session result
          *
@@ -2151,7 +2214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/session/{sessionID}/invitation/{invitationID}
          * @secure
          */
-        createInvitation: (sessionId: string, invitationId: string, data: InputW0Gt14Iief, params?: RequestParams) => Promise<any>;
+        createInvitation: (sessionId: string, invitationId: string, data: Input1Qxi23Thcx, params?: RequestParams) => Promise<any>;
         /**
          * @description Update an existing session invitation
          *
@@ -2161,7 +2224,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/session/{sessionID}/invitation/{invitationID}
          * @secure
          */
-        updateInvitation: (sessionId: string, invitationId: string, data: InputF61Tonm0Be, params?: RequestParams) => Promise<any>;
+        updateInvitation: (sessionId: string, invitationId: string, data: InputFa6Do54Syp, params?: RequestParams) => Promise<any>;
         /**
          * @description Delete a session invitation
          *
@@ -2268,17 +2331,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @tags Session
          * @name ListEvents
          * @summary List Session Events
-         * @request POST:/session/events/{startTime}/{endTime}
+         * @request POST:/session/events/{startTime}/{endTime}/{courseID}
          * @secure
          */
-        listEvents: (startTime: string, endTime: string, params?: RequestParams) => Promise<any>;
+        listEvents: (startTime: string, endTime: string, courseId: string, params?: RequestParams) => Promise<any>;
         /**
-         * @description List session events within a time range filtered by course
+         * @description List session events within a time range
          *
          * @tags Session
          * @name ListEvents2
-         * @summary List Session Events By Course
-         * @request POST:/session/events/{startTime}/{endTime}/{courseID}
+         * @summary List Session Events
+         * @request POST:/session/events/{startTime}/{endTime}
          * @originalName listEvents
          * @duplicate
          * @secure
@@ -2379,6 +2442,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/reports/sessionShippingManifest/{sessionID}
          * @secure
          */
-        createSessionShippingManifest: (sessionId: string, params?: RequestParams) => Promise<any>;
+        createSessionShippingManifest: (sessionId: string, data: Input72L9Nt3Sdc, params?: RequestParams) => Promise<any>;
     };
 }