@ikonintegration/bccsa-program-api 2.0.0 → 2.0.1

package/Api.ts

@@ -17,14 +17,14 @@ export interface ErrorResponse {
   errCode: string
 }
 
-export interface Input9Jxov33U7D {
+export interface InputGi0Lhci0S7 {
   /** @minLength 1 */
   customerID: string
   /** @minLength 1 */
   name: string
 }
 
-export interface InputUse5Vle8Ta {
+export interface InputT7S2Ffm20G {
   /** @minLength 1 */
   customerID: string
   /** @minLength 1 */
@@ -146,7 +146,7 @@ export interface VenueUpdateSchema {
    */
   name: string
   /** Venue address */
-  address: {
+  address?: {
     /**
      * Street address line 1
      * @minLength 1
@@ -192,30 +192,65 @@ export interface InstructorRegionUpdateSchema {
   regionIDs: string[]
 }
 
-export interface Input33N9Vgyjyy {
+export interface Input0Bwxjnyfvq {
   startTime: string | number
   endTime: string | number
   expandSessions?: boolean
 }
 
-export interface Input56Hzg6Xiz2 {
+export interface Input1Srqkq778V {
+  /** @minLength 1 */
+  customerID: string
+  /** @minLength 1 */
+  userID: string
   startTime: string | number
   endTime: string | number
   description?: string
 }
 
-export interface Input3Yilrlis7M {
+export interface Input5U6Cac26Dt {
+  /** @minLength 1 */
+  customerID: string
+  /** @minLength 1 */
+  userID: string
   startTime: string | number
   endTime: string | number
   description?: string
 }
 
-export interface InputKi6Tbrci1R {
+export interface InputDssliidtyi {
   /** @minLength 1 */
   calendarColor: string
 }
 
+export interface InputK4Pil7Tp6El {
+  createdBy?: string
+  /** @default 1787187914037 */
+  createdOn?: number
+  updatedBy?: string
+  updatedOn?: number
+  /** @default "clrCustomerCalendarSync" */
+  dbEntity?: string
+  customerID: string
+  providerID: string
+  syncProvider?: string
+}
+
+export interface InputG2Nfyegvqh {
+  createdBy?: string
+  /** @default 1787187914038 */
+  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
@@ -259,6 +294,7 @@ export interface SessionCourseTemplateCreateSchema {
   chargeDeferred?: boolean
   checkGradeDelay?: number
   courseMaterialProductID?: string | null
+  customerID?: string | null
   isEligibleForNoCost?: boolean
   cancelationPolicyID?: string | null
   reschedulePolicyID?: string | null
@@ -301,6 +337,7 @@ export interface SessionCourseTemplateCreateSchema {
 }
 
 export interface SessionCourseTemplateUpdateSchema {
+  id?: string | null
   /**
    * Template name
    * @minLength 1
@@ -334,6 +371,7 @@ export interface SessionCourseTemplateUpdateSchema {
   chargeDeferred?: boolean
   checkGradeDelay?: number
   courseMaterialProductID?: string | null
+  customerID?: string | null
   isEligibleForNoCost?: boolean
   cancelationPolicyID?: string | null
   reschedulePolicyID?: string | null
@@ -486,11 +524,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
@@ -592,11 +630,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
@@ -617,17 +655,17 @@ export interface SessionDuplicateSchema {
   newSessionDates: number[]
 }
 
-export interface InputQ59Gbvuj7G {
-  attendanceStatus: InputQ59Gbvuj7GAttendanceStatusEnum
+export interface Input71F35Oj5Sv {
+  attendanceStatus: Input71F35Oj5SvAttendanceStatusEnum
   additionalNotes?: string | null
 }
 
-export interface Input5S9Qlxsfdw {
-  attendanceStatus: Input5S9QlxsfdwAttendanceStatusEnum
+export interface InputMgedcinh82 {
+  attendanceStatus: InputMgedcinh82AttendanceStatusEnum
   additionalNotes?: string | null
 }
 
-export interface InputKdcf6Vev2F {
+export interface InputBzj6A4Mn8S {
   /** @minLength 1 */
   ticketID: string
   /** @minLength 1 */
@@ -637,14 +675,14 @@ export interface InputKdcf6Vev2F {
   [key: string]: any
 }
 
-export interface InputPcoc6Mas3J {
+export interface InputZx8S769Zqt {
   materialShippingInfo?: Record<string, any>
   [key: string]: any
 }
 
-export interface Input56A08Qop2C {
+export interface Input7O5Np9Bgno {
   amount: number
-  chargeResult: Input56A08Qop2CChargeResultEnum
+  chargeResult: Input7O5Np9BgnoChargeResultEnum
   description?: string | null
   /** @minLength 1 */
   paymentProvider: string
@@ -652,31 +690,84 @@ export interface Input56A08Qop2C {
   timestamp: number
 }
 
-export interface InputHuw5M2U5Gx {
-  resultStatus: InputHuw5M2U5GxResultStatusEnum
+export interface InputDdxhv25Ss8 {
+  createdBy?: string
+  /** @default 1787187914075 */
+  createdOn?: number
+  updatedBy?: string
+  updatedOn?: number
+  /** @default "clrSessionResult" */
+  dbEntity?: string
+  id?: string
+  sessionID: string
+  customerID: string
+  tenantID: string
+  courseID?: string
+  userID: string
+  externalID: string
+  resultStatus: InputDdxhv25Ss8ResultStatusEnum
   resultNotes?: string | null
   resultGrade?: number
+  resultDate?: number
+  isPublished?: boolean
+  isManuallyPublished?: boolean
   retainAcessToCourse?: boolean
   resultOverrideDate?: number
-  isManuallyPublished?: boolean
+  externalResult?: any
   orgID?: string | null
   employerName?: string | null
+  onlineCourseLabelItem?: string
+  onlineCourseIDItem?: string
+  onlineGradeIDItem?: any
+  onlineScoreGradeIDItem?: any
+  onlineQuizIDItem?: any
+  checkGradeDelayItem?: any
 }
 
-export interface InputXxwuna2Nn {
-  resultStatus: InputXxwuna2NnResultStatusEnum
-  resultNotes?: string | null
+export interface InputYzz7Hv93Fz {
+  resultStatus: InputYzz7Hv93FzResultStatusEnum
+  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 {
@@ -686,7 +777,7 @@ export interface SessionsInstructorSetSchema {
   instructorType: SessionsInstructorSetSchemaInstructorTypeEnum
 }
 
-export interface InputW0Gt14Iief {
+export interface Input7Cjmbhs07Z {
   activationCode?: string | null
   /** @minLength 1 */
   email: string
@@ -695,7 +786,7 @@ export interface InputW0Gt14Iief {
   maxUsage: number
 }
 
-export interface InputF61Tonm0Be {
+export interface InputFbvybobhpoh {
   useCount?: any
   maxUsage: number
 }
@@ -774,20 +865,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
   }
 }
 
@@ -809,9 +894,15 @@ export interface SessionListReportSchema {
     instructorID?: string | null
     /** Optional state filter */
     state?: string | null
+    /** Tenant ID */
+    tenantID?: string | null
   }
 }
 
+export interface InputMni27Dyuar {
+  updateShippingInfo?: boolean
+}
+
 export enum SessionCourseTemplateCreateSchemaReleaseTypeEnum {
   NONE = 'NONE',
   AUTO = 'AUTO',
@@ -900,30 +991,30 @@ export enum SessionUpdateSchemaTypeEnum {
   ONLINE = 'ONLINE',
 }
 
-export enum InputQ59Gbvuj7GAttendanceStatusEnum {
+export enum Input71F35Oj5SvAttendanceStatusEnum {
   INCOMPLETE = 'INCOMPLETE',
   NO_SHOW = 'NO_SHOW',
   ATTENDED = 'ATTENDED',
 }
 
-export enum Input5S9QlxsfdwAttendanceStatusEnum {
+export enum InputMgedcinh82AttendanceStatusEnum {
   INCOMPLETE = 'INCOMPLETE',
   NO_SHOW = 'NO_SHOW',
   ATTENDED = 'ATTENDED',
 }
 
-export enum Input56A08Qop2CChargeResultEnum {
+export enum Input7O5Np9BgnoChargeResultEnum {
   SUCCESS = 'SUCCESS',
   FAIL = 'FAIL',
 }
 
-export enum InputHuw5M2U5GxResultStatusEnum {
+export enum InputDdxhv25Ss8ResultStatusEnum {
   INCOMPLETE = 'INCOMPLETE',
   FAIL = 'FAIL',
   PASS = 'PASS',
 }
 
-export enum InputXxwuna2NnResultStatusEnum {
+export enum InputYzz7Hv93FzResultStatusEnum {
   INCOMPLETE = 'INCOMPLETE',
   FAIL = 'FAIL',
   PASS = 'PASS',
@@ -1563,7 +1654,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title Classroom Module API
- * @version 2.0.0
+ * @version 2.0.1
  * @baseUrl http://localhost:8080
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
  */
@@ -1595,7 +1686,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/region/{regionID}
      * @secure
      */
-    createRegion: (regionId: string, data: Input9Jxov33U7D, params: RequestParams = {}) =>
+    createRegion: (regionId: string, data: InputGi0Lhci0S7, params: RequestParams = {}) =>
       this.request<CreateRegionData, CreateRegionError>({
         path: `/region/${regionId}`,
         method: 'POST',
@@ -1614,7 +1705,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/region/{regionID}
      * @secure
      */
-    updateRegion: (regionId: string, data: InputUse5Vle8Ta, params: RequestParams = {}) =>
+    updateRegion: (regionId: string, data: InputT7S2Ffm20G, params: RequestParams = {}) =>
       this.request<UpdateRegionData, UpdateRegionError>({
         path: `/region/${regionId}`,
         method: 'PUT',
@@ -1995,7 +2086,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/instructor/{instructorID}/events
      * @secure
      */
-    listEvents: (instructorId: string, data: Input33N9Vgyjyy, params: RequestParams = {}) =>
+    listEvents: (instructorId: string, data: Input0Bwxjnyfvq, params: RequestParams = {}) =>
       this.request<ListEventsData, ListEventsError>({
         path: `/instructor/${instructorId}/events`,
         method: 'POST',
@@ -2034,7 +2125,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     createAvailabilityEvent: (
       instructorId: string,
       startTime: string,
-      data: Input56Hzg6Xiz2,
+      data: Input1Srqkq778V,
       params: RequestParams = {}
     ) =>
       this.request<CreateAvailabilityEventData, CreateAvailabilityEventError>({
@@ -2058,7 +2149,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     updateAvailabilityEvent: (
       instructorId: string,
       startTime: string,
-      data: Input3Yilrlis7M,
+      data: Input5U6Cac26Dt,
       params: RequestParams = {}
     ) =>
       this.request<UpdateAvailabilityEventData, UpdateAvailabilityEventError>({
@@ -2217,7 +2308,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/course/{courseID}/calendar
      * @secure
      */
-    updateCalendar: (courseId: string, data: InputKi6Tbrci1R, params: RequestParams = {}) =>
+    updateCalendar: (courseId: string, data: InputDssliidtyi, params: RequestParams = {}) =>
       this.request<UpdateCalendarData, UpdateCalendarError>({
         path: `/course/${courseId}/calendar`,
         method: 'PUT',
@@ -2305,11 +2396,13 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/courses/calendarSync/{providerID}
      * @secure
      */
-    createCalendarSync: (providerId: string, params: RequestParams = {}) =>
+    createCalendarSync: (providerId: string, data: InputK4Pil7Tp6El, params: RequestParams = {}) =>
       this.request<CreateCalendarSyncResult, CreateCalendarSyncFail>({
         path: `/courses/calendarSync/${providerId}`,
         method: 'POST',
+        body: data,
         secure: true,
+        type: ContentType.Json,
         ...params,
       }),
 
@@ -2322,11 +2415,13 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/courses/calendarSync/{providerID}
      * @secure
      */
-    updateCalendarSync: (providerId: string, params: RequestParams = {}) =>
+    updateCalendarSync: (providerId: string, data: InputG2Nfyegvqh, params: RequestParams = {}) =>
       this.request<UpdateCalendarSyncResult, UpdateCalendarSyncFail>({
         path: `/courses/calendarSync/${providerId}`,
         method: 'PUT',
+        body: data,
         secure: true,
+        type: ContentType.Json,
         ...params,
       }),
 
@@ -2874,7 +2969,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       attendanceId: string,
       externalId: string,
-      data: InputQ59Gbvuj7G,
+      data: Input71F35Oj5Sv,
       params: RequestParams = {}
     ) =>
       this.request<CreateAttendanceData, CreateAttendanceError>({
@@ -2899,7 +2994,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       attendanceId: string,
       externalId: string,
-      data: Input5S9Qlxsfdw,
+      data: InputMgedcinh82,
       params: RequestParams = {}
     ) =>
       this.request<UpdateAttendanceData, UpdateAttendanceError>({
@@ -2958,7 +3053,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       enrolmentId: string,
       externalId: string,
-      data: InputKdcf6Vev2F,
+      data: InputBzj6A4Mn8S,
       params: RequestParams = {}
     ) =>
       this.request<CreateEnrolmentData, CreateEnrolmentError>({
@@ -2983,7 +3078,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       enrolmentId: string,
       externalId: string,
-      data: InputPcoc6Mas3J,
+      data: InputZx8S769Zqt,
       params: RequestParams = {}
     ) =>
       this.request<UpdateEnrolmentData, UpdateEnrolmentError>({
@@ -3117,7 +3212,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       enrolmentId: string,
       externalId: string,
-      data: Input56A08Qop2C,
+      data: Input7O5Np9Bgno,
       params: RequestParams = {}
     ) =>
       this.request<CreateEnrolmentChargeData, CreateEnrolmentChargeError>({
@@ -3159,7 +3254,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       resultId: string,
       externalId: string,
-      data: InputHuw5M2U5Gx,
+      data: InputDdxhv25Ss8,
       params: RequestParams = {}
     ) =>
       this.request<CreateResultData, CreateResultError>({
@@ -3184,7 +3279,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
       sessionId: string,
       resultId: string,
       externalId: string,
-      data: InputXxwuna2Nn,
+      data: InputYzz7Hv93Fz,
       params: RequestParams = {}
     ) =>
       this.request<UpdateResultData, UpdateResultError>({
@@ -3338,7 +3433,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/session/{sessionID}/invitation/{invitationID}
      * @secure
      */
-    createInvitation: (sessionId: string, invitationId: string, data: InputW0Gt14Iief, params: RequestParams = {}) =>
+    createInvitation: (sessionId: string, invitationId: string, data: Input7Cjmbhs07Z, params: RequestParams = {}) =>
       this.request<CreateInvitationData, CreateInvitationError>({
         path: `/session/${sessionId}/invitation/${invitationId}`,
         method: 'POST',
@@ -3357,7 +3452,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request PUT:/session/{sessionID}/invitation/{invitationID}
      * @secure
      */
-    updateInvitation: (sessionId: string, invitationId: string, data: InputF61Tonm0Be, params: RequestParams = {}) =>
+    updateInvitation: (sessionId: string, invitationId: string, data: InputFbvybobhpoh, params: RequestParams = {}) =>
       this.request<UpdateInvitationData, UpdateInvitationError>({
         path: `/session/${sessionId}/invitation/${invitationId}`,
         method: 'PUT',
@@ -3551,31 +3646,31 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @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 = {}) =>
+    listEvents: (startTime: string, endTime: string, courseId: string, params: RequestParams = {}) =>
       this.request<ListEventsResult, ListEventsFail>({
-        path: `/session/events/${startTime}/${endTime}`,
+        path: `/session/events/${startTime}/${endTime}/${courseId}`,
         method: 'POST',
         secure: true,
         ...params,
       }),
 
     /**
-     * @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
      */
     listEvents2: (startTime: string, endTime: string, courseId: string, params: RequestParams = {}) =>
       this.request<ListEvents2Data, ListEvents2Error>({
-        path: `/session/events/${startTime}/${endTime}/${courseId}`,
+        path: `/session/events/${startTime}/${endTime}`,
         method: 'POST',
         secure: true,
         ...params,
@@ -3741,11 +3836,13 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @request POST:/reports/sessionShippingManifest/{sessionID}
      * @secure
      */
-    createSessionShippingManifest: (sessionId: string, params: RequestParams = {}) =>
+    createSessionShippingManifest: (sessionId: string, data: InputMni27Dyuar, params: RequestParams = {}) =>
       this.request<CreateSessionShippingManifestData, CreateSessionShippingManifestError>({
         path: `/reports/sessionShippingManifest/${sessionId}`,
         method: 'POST',
+        body: data,
         secure: true,
+        type: ContentType.Json,
         ...params,
       }),
   }