@ikonintegration/bccsa-program-api 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Api.ts +3752 -0
- package/dist/Api.d.ts +2384 -0
- package/dist/Api.js +2145 -0
- package/dist/Api.js.map +1 -0
- package/package.json +16 -0
- package/tsconfig.json +16 -0
package/dist/Api.js
ADDED
|
@@ -0,0 +1,2145 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/*
|
|
5
|
+
* ---------------------------------------------------------------
|
|
6
|
+
* ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API ##
|
|
7
|
+
* ## ##
|
|
8
|
+
* ## AUTHOR: acacode ##
|
|
9
|
+
* ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
|
|
10
|
+
* ---------------------------------------------------------------
|
|
11
|
+
*/
|
|
12
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
13
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
14
|
+
};
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.SessionBatchUpdateSchemaResultStatusEnum = exports.SessionBatchUpdateSchemaAttendanceStatusEnum = exports.SessionsInstructorSetSchemaInstructorTypeEnum = exports.SessionInstructorSchemaInstructorTypeEnum = exports.InputXxwuna2NnResultStatusEnum = exports.InputHuw5M2U5GxResultStatusEnum = exports.Input56A08Qop2CChargeResultEnum = exports.Input5S9QlxsfdwAttendanceStatusEnum = exports.InputQ59Gbvuj7GAttendanceStatusEnum = exports.SessionUpdateSchemaTypeEnum = exports.SessionUpdateSchemaHasMaterialEnum = exports.SessionUpdateSchemaReleaseTypeEnum = exports.SessionCreateSchemaTypeEnum = exports.SessionCreateSchemaHasMaterialEnum = exports.SessionCreateSchemaReleaseTypeEnum = exports.SessionCourseTemplateUpdateSchemaTypeEnum = exports.SessionCourseTemplateUpdateSchemaHasMaterialEnum = exports.SessionCourseTemplateUpdateSchemaReleaseTypeEnum = exports.SessionCourseTemplateCreateSchemaTypeEnum = exports.SessionCourseTemplateCreateSchemaHasMaterialEnum = exports.SessionCourseTemplateCreateSchemaReleaseTypeEnum = void 0;
|
|
17
|
+
var SessionCourseTemplateCreateSchemaReleaseTypeEnum;
|
|
18
|
+
(function (SessionCourseTemplateCreateSchemaReleaseTypeEnum) {
|
|
19
|
+
SessionCourseTemplateCreateSchemaReleaseTypeEnum["NONE"] = "NONE";
|
|
20
|
+
SessionCourseTemplateCreateSchemaReleaseTypeEnum["AUTO"] = "AUTO";
|
|
21
|
+
SessionCourseTemplateCreateSchemaReleaseTypeEnum["MANUAL"] = "MANUAL";
|
|
22
|
+
SessionCourseTemplateCreateSchemaReleaseTypeEnum["SCHEDULE"] = "SCHEDULE";
|
|
23
|
+
})(SessionCourseTemplateCreateSchemaReleaseTypeEnum || (exports.SessionCourseTemplateCreateSchemaReleaseTypeEnum = SessionCourseTemplateCreateSchemaReleaseTypeEnum = {}));
|
|
24
|
+
var SessionCourseTemplateCreateSchemaHasMaterialEnum;
|
|
25
|
+
(function (SessionCourseTemplateCreateSchemaHasMaterialEnum) {
|
|
26
|
+
SessionCourseTemplateCreateSchemaHasMaterialEnum["NONE"] = "NONE";
|
|
27
|
+
SessionCourseTemplateCreateSchemaHasMaterialEnum["INDIVIDUAL"] = "INDIVIDUAL";
|
|
28
|
+
SessionCourseTemplateCreateSchemaHasMaterialEnum["ALL"] = "ALL";
|
|
29
|
+
})(SessionCourseTemplateCreateSchemaHasMaterialEnum || (exports.SessionCourseTemplateCreateSchemaHasMaterialEnum = SessionCourseTemplateCreateSchemaHasMaterialEnum = {}));
|
|
30
|
+
var SessionCourseTemplateCreateSchemaTypeEnum;
|
|
31
|
+
(function (SessionCourseTemplateCreateSchemaTypeEnum) {
|
|
32
|
+
SessionCourseTemplateCreateSchemaTypeEnum["SCHEDULED_PRESENTIAL"] = "SCHEDULED_PRESENTIAL";
|
|
33
|
+
SessionCourseTemplateCreateSchemaTypeEnum["SCHEDULED_ONLINE_EXT"] = "SCHEDULED_ONLINE_EXT";
|
|
34
|
+
SessionCourseTemplateCreateSchemaTypeEnum["SCHEDULED_VILT"] = "SCHEDULED_VILT";
|
|
35
|
+
SessionCourseTemplateCreateSchemaTypeEnum["SCHEDULED_WEBINAR"] = "SCHEDULED_WEBINAR";
|
|
36
|
+
SessionCourseTemplateCreateSchemaTypeEnum["ONLINE_EXT"] = "ONLINE_EXT";
|
|
37
|
+
SessionCourseTemplateCreateSchemaTypeEnum["ONLINE"] = "ONLINE";
|
|
38
|
+
})(SessionCourseTemplateCreateSchemaTypeEnum || (exports.SessionCourseTemplateCreateSchemaTypeEnum = SessionCourseTemplateCreateSchemaTypeEnum = {}));
|
|
39
|
+
var SessionCourseTemplateUpdateSchemaReleaseTypeEnum;
|
|
40
|
+
(function (SessionCourseTemplateUpdateSchemaReleaseTypeEnum) {
|
|
41
|
+
SessionCourseTemplateUpdateSchemaReleaseTypeEnum["NONE"] = "NONE";
|
|
42
|
+
SessionCourseTemplateUpdateSchemaReleaseTypeEnum["AUTO"] = "AUTO";
|
|
43
|
+
SessionCourseTemplateUpdateSchemaReleaseTypeEnum["MANUAL"] = "MANUAL";
|
|
44
|
+
SessionCourseTemplateUpdateSchemaReleaseTypeEnum["SCHEDULE"] = "SCHEDULE";
|
|
45
|
+
})(SessionCourseTemplateUpdateSchemaReleaseTypeEnum || (exports.SessionCourseTemplateUpdateSchemaReleaseTypeEnum = SessionCourseTemplateUpdateSchemaReleaseTypeEnum = {}));
|
|
46
|
+
var SessionCourseTemplateUpdateSchemaHasMaterialEnum;
|
|
47
|
+
(function (SessionCourseTemplateUpdateSchemaHasMaterialEnum) {
|
|
48
|
+
SessionCourseTemplateUpdateSchemaHasMaterialEnum["NONE"] = "NONE";
|
|
49
|
+
SessionCourseTemplateUpdateSchemaHasMaterialEnum["INDIVIDUAL"] = "INDIVIDUAL";
|
|
50
|
+
SessionCourseTemplateUpdateSchemaHasMaterialEnum["ALL"] = "ALL";
|
|
51
|
+
})(SessionCourseTemplateUpdateSchemaHasMaterialEnum || (exports.SessionCourseTemplateUpdateSchemaHasMaterialEnum = SessionCourseTemplateUpdateSchemaHasMaterialEnum = {}));
|
|
52
|
+
var SessionCourseTemplateUpdateSchemaTypeEnum;
|
|
53
|
+
(function (SessionCourseTemplateUpdateSchemaTypeEnum) {
|
|
54
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["SCHEDULED_PRESENTIAL"] = "SCHEDULED_PRESENTIAL";
|
|
55
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["SCHEDULED_ONLINE_EXT"] = "SCHEDULED_ONLINE_EXT";
|
|
56
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["SCHEDULED_VILT"] = "SCHEDULED_VILT";
|
|
57
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["SCHEDULED_WEBINAR"] = "SCHEDULED_WEBINAR";
|
|
58
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["ONLINE_EXT"] = "ONLINE_EXT";
|
|
59
|
+
SessionCourseTemplateUpdateSchemaTypeEnum["ONLINE"] = "ONLINE";
|
|
60
|
+
})(SessionCourseTemplateUpdateSchemaTypeEnum || (exports.SessionCourseTemplateUpdateSchemaTypeEnum = SessionCourseTemplateUpdateSchemaTypeEnum = {}));
|
|
61
|
+
var SessionCreateSchemaReleaseTypeEnum;
|
|
62
|
+
(function (SessionCreateSchemaReleaseTypeEnum) {
|
|
63
|
+
SessionCreateSchemaReleaseTypeEnum["NONE"] = "NONE";
|
|
64
|
+
SessionCreateSchemaReleaseTypeEnum["AUTO"] = "AUTO";
|
|
65
|
+
SessionCreateSchemaReleaseTypeEnum["MANUAL"] = "MANUAL";
|
|
66
|
+
SessionCreateSchemaReleaseTypeEnum["SCHEDULE"] = "SCHEDULE";
|
|
67
|
+
})(SessionCreateSchemaReleaseTypeEnum || (exports.SessionCreateSchemaReleaseTypeEnum = SessionCreateSchemaReleaseTypeEnum = {}));
|
|
68
|
+
var SessionCreateSchemaHasMaterialEnum;
|
|
69
|
+
(function (SessionCreateSchemaHasMaterialEnum) {
|
|
70
|
+
SessionCreateSchemaHasMaterialEnum["NONE"] = "NONE";
|
|
71
|
+
SessionCreateSchemaHasMaterialEnum["INDIVIDUAL"] = "INDIVIDUAL";
|
|
72
|
+
SessionCreateSchemaHasMaterialEnum["ALL"] = "ALL";
|
|
73
|
+
})(SessionCreateSchemaHasMaterialEnum || (exports.SessionCreateSchemaHasMaterialEnum = SessionCreateSchemaHasMaterialEnum = {}));
|
|
74
|
+
var SessionCreateSchemaTypeEnum;
|
|
75
|
+
(function (SessionCreateSchemaTypeEnum) {
|
|
76
|
+
SessionCreateSchemaTypeEnum["SCHEDULED_PRESENTIAL"] = "SCHEDULED_PRESENTIAL";
|
|
77
|
+
SessionCreateSchemaTypeEnum["SCHEDULED_ONLINE_EXT"] = "SCHEDULED_ONLINE_EXT";
|
|
78
|
+
SessionCreateSchemaTypeEnum["SCHEDULED_VILT"] = "SCHEDULED_VILT";
|
|
79
|
+
SessionCreateSchemaTypeEnum["SCHEDULED_WEBINAR"] = "SCHEDULED_WEBINAR";
|
|
80
|
+
SessionCreateSchemaTypeEnum["ONLINE_EXT"] = "ONLINE_EXT";
|
|
81
|
+
SessionCreateSchemaTypeEnum["ONLINE"] = "ONLINE";
|
|
82
|
+
})(SessionCreateSchemaTypeEnum || (exports.SessionCreateSchemaTypeEnum = SessionCreateSchemaTypeEnum = {}));
|
|
83
|
+
var SessionUpdateSchemaReleaseTypeEnum;
|
|
84
|
+
(function (SessionUpdateSchemaReleaseTypeEnum) {
|
|
85
|
+
SessionUpdateSchemaReleaseTypeEnum["NONE"] = "NONE";
|
|
86
|
+
SessionUpdateSchemaReleaseTypeEnum["AUTO"] = "AUTO";
|
|
87
|
+
SessionUpdateSchemaReleaseTypeEnum["MANUAL"] = "MANUAL";
|
|
88
|
+
SessionUpdateSchemaReleaseTypeEnum["SCHEDULE"] = "SCHEDULE";
|
|
89
|
+
})(SessionUpdateSchemaReleaseTypeEnum || (exports.SessionUpdateSchemaReleaseTypeEnum = SessionUpdateSchemaReleaseTypeEnum = {}));
|
|
90
|
+
var SessionUpdateSchemaHasMaterialEnum;
|
|
91
|
+
(function (SessionUpdateSchemaHasMaterialEnum) {
|
|
92
|
+
SessionUpdateSchemaHasMaterialEnum["NONE"] = "NONE";
|
|
93
|
+
SessionUpdateSchemaHasMaterialEnum["INDIVIDUAL"] = "INDIVIDUAL";
|
|
94
|
+
SessionUpdateSchemaHasMaterialEnum["ALL"] = "ALL";
|
|
95
|
+
})(SessionUpdateSchemaHasMaterialEnum || (exports.SessionUpdateSchemaHasMaterialEnum = SessionUpdateSchemaHasMaterialEnum = {}));
|
|
96
|
+
var SessionUpdateSchemaTypeEnum;
|
|
97
|
+
(function (SessionUpdateSchemaTypeEnum) {
|
|
98
|
+
SessionUpdateSchemaTypeEnum["SCHEDULED_PRESENTIAL"] = "SCHEDULED_PRESENTIAL";
|
|
99
|
+
SessionUpdateSchemaTypeEnum["SCHEDULED_ONLINE_EXT"] = "SCHEDULED_ONLINE_EXT";
|
|
100
|
+
SessionUpdateSchemaTypeEnum["SCHEDULED_VILT"] = "SCHEDULED_VILT";
|
|
101
|
+
SessionUpdateSchemaTypeEnum["SCHEDULED_WEBINAR"] = "SCHEDULED_WEBINAR";
|
|
102
|
+
SessionUpdateSchemaTypeEnum["ONLINE_EXT"] = "ONLINE_EXT";
|
|
103
|
+
SessionUpdateSchemaTypeEnum["ONLINE"] = "ONLINE";
|
|
104
|
+
})(SessionUpdateSchemaTypeEnum || (exports.SessionUpdateSchemaTypeEnum = SessionUpdateSchemaTypeEnum = {}));
|
|
105
|
+
var InputQ59Gbvuj7GAttendanceStatusEnum;
|
|
106
|
+
(function (InputQ59Gbvuj7GAttendanceStatusEnum) {
|
|
107
|
+
InputQ59Gbvuj7GAttendanceStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
108
|
+
InputQ59Gbvuj7GAttendanceStatusEnum["NO_SHOW"] = "NO_SHOW";
|
|
109
|
+
InputQ59Gbvuj7GAttendanceStatusEnum["ATTENDED"] = "ATTENDED";
|
|
110
|
+
})(InputQ59Gbvuj7GAttendanceStatusEnum || (exports.InputQ59Gbvuj7GAttendanceStatusEnum = InputQ59Gbvuj7GAttendanceStatusEnum = {}));
|
|
111
|
+
var Input5S9QlxsfdwAttendanceStatusEnum;
|
|
112
|
+
(function (Input5S9QlxsfdwAttendanceStatusEnum) {
|
|
113
|
+
Input5S9QlxsfdwAttendanceStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
114
|
+
Input5S9QlxsfdwAttendanceStatusEnum["NO_SHOW"] = "NO_SHOW";
|
|
115
|
+
Input5S9QlxsfdwAttendanceStatusEnum["ATTENDED"] = "ATTENDED";
|
|
116
|
+
})(Input5S9QlxsfdwAttendanceStatusEnum || (exports.Input5S9QlxsfdwAttendanceStatusEnum = Input5S9QlxsfdwAttendanceStatusEnum = {}));
|
|
117
|
+
var Input56A08Qop2CChargeResultEnum;
|
|
118
|
+
(function (Input56A08Qop2CChargeResultEnum) {
|
|
119
|
+
Input56A08Qop2CChargeResultEnum["SUCCESS"] = "SUCCESS";
|
|
120
|
+
Input56A08Qop2CChargeResultEnum["FAIL"] = "FAIL";
|
|
121
|
+
})(Input56A08Qop2CChargeResultEnum || (exports.Input56A08Qop2CChargeResultEnum = Input56A08Qop2CChargeResultEnum = {}));
|
|
122
|
+
var InputHuw5M2U5GxResultStatusEnum;
|
|
123
|
+
(function (InputHuw5M2U5GxResultStatusEnum) {
|
|
124
|
+
InputHuw5M2U5GxResultStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
125
|
+
InputHuw5M2U5GxResultStatusEnum["FAIL"] = "FAIL";
|
|
126
|
+
InputHuw5M2U5GxResultStatusEnum["PASS"] = "PASS";
|
|
127
|
+
})(InputHuw5M2U5GxResultStatusEnum || (exports.InputHuw5M2U5GxResultStatusEnum = InputHuw5M2U5GxResultStatusEnum = {}));
|
|
128
|
+
var InputXxwuna2NnResultStatusEnum;
|
|
129
|
+
(function (InputXxwuna2NnResultStatusEnum) {
|
|
130
|
+
InputXxwuna2NnResultStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
131
|
+
InputXxwuna2NnResultStatusEnum["FAIL"] = "FAIL";
|
|
132
|
+
InputXxwuna2NnResultStatusEnum["PASS"] = "PASS";
|
|
133
|
+
})(InputXxwuna2NnResultStatusEnum || (exports.InputXxwuna2NnResultStatusEnum = InputXxwuna2NnResultStatusEnum = {}));
|
|
134
|
+
/** Instructor type */
|
|
135
|
+
var SessionInstructorSchemaInstructorTypeEnum;
|
|
136
|
+
(function (SessionInstructorSchemaInstructorTypeEnum) {
|
|
137
|
+
SessionInstructorSchemaInstructorTypeEnum["PRIMARY"] = "PRIMARY";
|
|
138
|
+
SessionInstructorSchemaInstructorTypeEnum["SECONDARY"] = "SECONDARY";
|
|
139
|
+
})(SessionInstructorSchemaInstructorTypeEnum || (exports.SessionInstructorSchemaInstructorTypeEnum = SessionInstructorSchemaInstructorTypeEnum = {}));
|
|
140
|
+
/** Instructor type */
|
|
141
|
+
var SessionsInstructorSetSchemaInstructorTypeEnum;
|
|
142
|
+
(function (SessionsInstructorSetSchemaInstructorTypeEnum) {
|
|
143
|
+
SessionsInstructorSetSchemaInstructorTypeEnum["PRIMARY"] = "PRIMARY";
|
|
144
|
+
SessionsInstructorSetSchemaInstructorTypeEnum["SECONDARY"] = "SECONDARY";
|
|
145
|
+
})(SessionsInstructorSetSchemaInstructorTypeEnum || (exports.SessionsInstructorSetSchemaInstructorTypeEnum = SessionsInstructorSetSchemaInstructorTypeEnum = {}));
|
|
146
|
+
var SessionBatchUpdateSchemaAttendanceStatusEnum;
|
|
147
|
+
(function (SessionBatchUpdateSchemaAttendanceStatusEnum) {
|
|
148
|
+
SessionBatchUpdateSchemaAttendanceStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
149
|
+
SessionBatchUpdateSchemaAttendanceStatusEnum["NO_SHOW"] = "NO_SHOW";
|
|
150
|
+
SessionBatchUpdateSchemaAttendanceStatusEnum["ATTENDED"] = "ATTENDED";
|
|
151
|
+
})(SessionBatchUpdateSchemaAttendanceStatusEnum || (exports.SessionBatchUpdateSchemaAttendanceStatusEnum = SessionBatchUpdateSchemaAttendanceStatusEnum = {}));
|
|
152
|
+
var SessionBatchUpdateSchemaResultStatusEnum;
|
|
153
|
+
(function (SessionBatchUpdateSchemaResultStatusEnum) {
|
|
154
|
+
SessionBatchUpdateSchemaResultStatusEnum["INCOMPLETE"] = "INCOMPLETE";
|
|
155
|
+
SessionBatchUpdateSchemaResultStatusEnum["FAIL"] = "FAIL";
|
|
156
|
+
SessionBatchUpdateSchemaResultStatusEnum["PASS"] = "PASS";
|
|
157
|
+
})(SessionBatchUpdateSchemaResultStatusEnum || (exports.SessionBatchUpdateSchemaResultStatusEnum = SessionBatchUpdateSchemaResultStatusEnum = {}));
|
|
158
|
+
const axios_1 = __importDefault(require("axios"));
|
|
159
|
+
var ContentType;
|
|
160
|
+
(function (ContentType) {
|
|
161
|
+
ContentType["Json"] = "application/json";
|
|
162
|
+
ContentType["FormData"] = "multipart/form-data";
|
|
163
|
+
ContentType["UrlEncoded"] = "application/x-www-form-urlencoded";
|
|
164
|
+
ContentType["Text"] = "text/plain";
|
|
165
|
+
})(ContentType || (exports.ContentType = ContentType = {}));
|
|
166
|
+
class HttpClient {
|
|
167
|
+
constructor({ securityWorker, secure, format, ...axiosConfig } = {}) {
|
|
168
|
+
this.securityData = null;
|
|
169
|
+
this.setSecurityData = (data) => {
|
|
170
|
+
this.securityData = data;
|
|
171
|
+
};
|
|
172
|
+
this.request = async ({ secure, path, type, query, format, body, ...params }) => {
|
|
173
|
+
const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) &&
|
|
174
|
+
this.securityWorker &&
|
|
175
|
+
(await this.securityWorker(this.securityData))) ||
|
|
176
|
+
{};
|
|
177
|
+
const requestParams = this.mergeRequestParams(params, secureParams);
|
|
178
|
+
const responseFormat = format || this.format || undefined;
|
|
179
|
+
if (type === ContentType.FormData && body && body !== null && typeof body === 'object') {
|
|
180
|
+
body = this.createFormData(body);
|
|
181
|
+
}
|
|
182
|
+
if (type === ContentType.Text && body && body !== null && typeof body !== 'string') {
|
|
183
|
+
body = JSON.stringify(body);
|
|
184
|
+
}
|
|
185
|
+
return this.instance
|
|
186
|
+
.request({
|
|
187
|
+
...requestParams,
|
|
188
|
+
headers: {
|
|
189
|
+
...(requestParams.headers || {}),
|
|
190
|
+
...(type ? { 'Content-Type': type } : {}),
|
|
191
|
+
},
|
|
192
|
+
params: query,
|
|
193
|
+
responseType: responseFormat,
|
|
194
|
+
data: body,
|
|
195
|
+
url: path,
|
|
196
|
+
})
|
|
197
|
+
.then(response => response.data);
|
|
198
|
+
};
|
|
199
|
+
this.instance = axios_1.default.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || 'http://localhost:8080' });
|
|
200
|
+
this.secure = secure;
|
|
201
|
+
this.format = format;
|
|
202
|
+
this.securityWorker = securityWorker;
|
|
203
|
+
}
|
|
204
|
+
mergeRequestParams(params1, params2) {
|
|
205
|
+
const method = params1.method || (params2 && params2.method);
|
|
206
|
+
return {
|
|
207
|
+
...this.instance.defaults,
|
|
208
|
+
...params1,
|
|
209
|
+
...(params2 || {}),
|
|
210
|
+
headers: {
|
|
211
|
+
...((method && this.instance.defaults.headers[method.toLowerCase()]) || {}),
|
|
212
|
+
...(params1.headers || {}),
|
|
213
|
+
...((params2 && params2.headers) || {}),
|
|
214
|
+
},
|
|
215
|
+
};
|
|
216
|
+
}
|
|
217
|
+
stringifyFormItem(formItem) {
|
|
218
|
+
if (typeof formItem === 'object' && formItem !== null) {
|
|
219
|
+
return JSON.stringify(formItem);
|
|
220
|
+
}
|
|
221
|
+
else {
|
|
222
|
+
return `${formItem}`;
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
createFormData(input) {
|
|
226
|
+
if (input instanceof FormData) {
|
|
227
|
+
return input;
|
|
228
|
+
}
|
|
229
|
+
return Object.keys(input || {}).reduce((formData, key) => {
|
|
230
|
+
const property = input[key];
|
|
231
|
+
const propertyContent = property instanceof Array ? property : [property];
|
|
232
|
+
for (const formItem of propertyContent) {
|
|
233
|
+
const isFileType = formItem instanceof Blob || formItem instanceof File;
|
|
234
|
+
formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
|
|
235
|
+
}
|
|
236
|
+
return formData;
|
|
237
|
+
}, new FormData());
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
exports.HttpClient = HttpClient;
|
|
241
|
+
/**
|
|
242
|
+
* @title Classroom Module API
|
|
243
|
+
* @version 2.0.0
|
|
244
|
+
* @baseUrl http://localhost:8080
|
|
245
|
+
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
246
|
+
*/
|
|
247
|
+
class Api extends HttpClient {
|
|
248
|
+
constructor() {
|
|
249
|
+
super(...arguments);
|
|
250
|
+
this.region = {
|
|
251
|
+
/**
|
|
252
|
+
* @description Retrieve a region by ID
|
|
253
|
+
*
|
|
254
|
+
* @tags Region
|
|
255
|
+
* @name GetRegion
|
|
256
|
+
* @summary Get Region
|
|
257
|
+
* @request GET:/region/{regionID}
|
|
258
|
+
* @secure
|
|
259
|
+
*/
|
|
260
|
+
getRegion: (regionId, params = {}) => this.request({
|
|
261
|
+
path: `/region/${regionId}`,
|
|
262
|
+
method: 'GET',
|
|
263
|
+
secure: true,
|
|
264
|
+
...params,
|
|
265
|
+
}),
|
|
266
|
+
/**
|
|
267
|
+
* @description Create a new region
|
|
268
|
+
*
|
|
269
|
+
* @tags Region
|
|
270
|
+
* @name CreateRegion
|
|
271
|
+
* @summary Create Region
|
|
272
|
+
* @request POST:/region/{regionID}
|
|
273
|
+
* @secure
|
|
274
|
+
*/
|
|
275
|
+
createRegion: (regionId, data, params = {}) => this.request({
|
|
276
|
+
path: `/region/${regionId}`,
|
|
277
|
+
method: 'POST',
|
|
278
|
+
body: data,
|
|
279
|
+
secure: true,
|
|
280
|
+
type: ContentType.Json,
|
|
281
|
+
...params,
|
|
282
|
+
}),
|
|
283
|
+
/**
|
|
284
|
+
* @description Update an existing region
|
|
285
|
+
*
|
|
286
|
+
* @tags Region
|
|
287
|
+
* @name UpdateRegion
|
|
288
|
+
* @summary Update Region
|
|
289
|
+
* @request PUT:/region/{regionID}
|
|
290
|
+
* @secure
|
|
291
|
+
*/
|
|
292
|
+
updateRegion: (regionId, data, params = {}) => this.request({
|
|
293
|
+
path: `/region/${regionId}`,
|
|
294
|
+
method: 'PUT',
|
|
295
|
+
body: data,
|
|
296
|
+
secure: true,
|
|
297
|
+
type: ContentType.Json,
|
|
298
|
+
...params,
|
|
299
|
+
}),
|
|
300
|
+
/**
|
|
301
|
+
* @description Delete a region by ID
|
|
302
|
+
*
|
|
303
|
+
* @tags Region
|
|
304
|
+
* @name DeleteRegion
|
|
305
|
+
* @summary Delete Region
|
|
306
|
+
* @request DELETE:/region/{regionID}
|
|
307
|
+
* @secure
|
|
308
|
+
*/
|
|
309
|
+
deleteRegion: (regionId, params = {}) => this.request({
|
|
310
|
+
path: `/region/${regionId}`,
|
|
311
|
+
method: 'DELETE',
|
|
312
|
+
secure: true,
|
|
313
|
+
...params,
|
|
314
|
+
}),
|
|
315
|
+
};
|
|
316
|
+
this.regions = {
|
|
317
|
+
/**
|
|
318
|
+
* @description Retrieve all regions for the current customer
|
|
319
|
+
*
|
|
320
|
+
* @tags Region
|
|
321
|
+
* @name ListRegions
|
|
322
|
+
* @summary Get All Regions
|
|
323
|
+
* @request GET:/regions
|
|
324
|
+
* @secure
|
|
325
|
+
*/
|
|
326
|
+
listRegions: (params = {}) => this.request({
|
|
327
|
+
path: `/regions`,
|
|
328
|
+
method: 'GET',
|
|
329
|
+
secure: true,
|
|
330
|
+
...params,
|
|
331
|
+
}),
|
|
332
|
+
};
|
|
333
|
+
this.city = {
|
|
334
|
+
/**
|
|
335
|
+
* @description Retrieve a city by ID
|
|
336
|
+
*
|
|
337
|
+
* @tags City
|
|
338
|
+
* @name GetCity
|
|
339
|
+
* @summary Get City
|
|
340
|
+
* @request GET:/city/{cityID}
|
|
341
|
+
* @secure
|
|
342
|
+
*/
|
|
343
|
+
getCity: (cityId, params = {}) => this.request({
|
|
344
|
+
path: `/city/${cityId}`,
|
|
345
|
+
method: 'GET',
|
|
346
|
+
secure: true,
|
|
347
|
+
...params,
|
|
348
|
+
}),
|
|
349
|
+
/**
|
|
350
|
+
* @description Create a new city
|
|
351
|
+
*
|
|
352
|
+
* @tags City
|
|
353
|
+
* @name CreateCity
|
|
354
|
+
* @summary Create City
|
|
355
|
+
* @request POST:/city/{cityID}
|
|
356
|
+
* @secure
|
|
357
|
+
*/
|
|
358
|
+
createCity: (cityId, data, params = {}) => this.request({
|
|
359
|
+
path: `/city/${cityId}`,
|
|
360
|
+
method: 'POST',
|
|
361
|
+
body: data,
|
|
362
|
+
secure: true,
|
|
363
|
+
type: ContentType.Json,
|
|
364
|
+
...params,
|
|
365
|
+
}),
|
|
366
|
+
/**
|
|
367
|
+
* @description Update an existing city
|
|
368
|
+
*
|
|
369
|
+
* @tags City
|
|
370
|
+
* @name UpdateCity
|
|
371
|
+
* @summary Update City
|
|
372
|
+
* @request PUT:/city/{cityID}
|
|
373
|
+
* @secure
|
|
374
|
+
*/
|
|
375
|
+
updateCity: (cityId, data, params = {}) => this.request({
|
|
376
|
+
path: `/city/${cityId}`,
|
|
377
|
+
method: 'PUT',
|
|
378
|
+
body: data,
|
|
379
|
+
secure: true,
|
|
380
|
+
type: ContentType.Json,
|
|
381
|
+
...params,
|
|
382
|
+
}),
|
|
383
|
+
/**
|
|
384
|
+
* @description Delete a city by ID
|
|
385
|
+
*
|
|
386
|
+
* @tags City
|
|
387
|
+
* @name DeleteCity
|
|
388
|
+
* @summary Delete City
|
|
389
|
+
* @request DELETE:/city/{cityID}
|
|
390
|
+
* @secure
|
|
391
|
+
*/
|
|
392
|
+
deleteCity: (cityId, params = {}) => this.request({
|
|
393
|
+
path: `/city/${cityId}`,
|
|
394
|
+
method: 'DELETE',
|
|
395
|
+
secure: true,
|
|
396
|
+
...params,
|
|
397
|
+
}),
|
|
398
|
+
};
|
|
399
|
+
this.cities = {
|
|
400
|
+
/**
|
|
401
|
+
* @description Retrieve all cities for the current customer
|
|
402
|
+
*
|
|
403
|
+
* @tags City
|
|
404
|
+
* @name ListCities
|
|
405
|
+
* @summary Get All Cities
|
|
406
|
+
* @request GET:/cities
|
|
407
|
+
* @secure
|
|
408
|
+
*/
|
|
409
|
+
listCities: (params = {}) => this.request({
|
|
410
|
+
path: `/cities`,
|
|
411
|
+
method: 'GET',
|
|
412
|
+
secure: true,
|
|
413
|
+
...params,
|
|
414
|
+
}),
|
|
415
|
+
};
|
|
416
|
+
this.venue = {
|
|
417
|
+
/**
|
|
418
|
+
* @description Retrieve a venue by ID
|
|
419
|
+
*
|
|
420
|
+
* @tags Venue
|
|
421
|
+
* @name GetVenue
|
|
422
|
+
* @summary Get Venue
|
|
423
|
+
* @request GET:/venue/{venueID}
|
|
424
|
+
* @secure
|
|
425
|
+
*/
|
|
426
|
+
getVenue: (venueId, params = {}) => this.request({
|
|
427
|
+
path: `/venue/${venueId}`,
|
|
428
|
+
method: 'GET',
|
|
429
|
+
secure: true,
|
|
430
|
+
...params,
|
|
431
|
+
}),
|
|
432
|
+
/**
|
|
433
|
+
* @description Create a new venue
|
|
434
|
+
*
|
|
435
|
+
* @tags Venue
|
|
436
|
+
* @name CreateVenue
|
|
437
|
+
* @summary Create Venue
|
|
438
|
+
* @request POST:/venue/{venueID}
|
|
439
|
+
* @secure
|
|
440
|
+
*/
|
|
441
|
+
createVenue: (venueId, data, params = {}) => this.request({
|
|
442
|
+
path: `/venue/${venueId}`,
|
|
443
|
+
method: 'POST',
|
|
444
|
+
body: data,
|
|
445
|
+
secure: true,
|
|
446
|
+
type: ContentType.Json,
|
|
447
|
+
...params,
|
|
448
|
+
}),
|
|
449
|
+
/**
|
|
450
|
+
* @description Update an existing venue
|
|
451
|
+
*
|
|
452
|
+
* @tags Venue
|
|
453
|
+
* @name UpdateVenue
|
|
454
|
+
* @summary Update Venue
|
|
455
|
+
* @request PUT:/venue/{venueID}
|
|
456
|
+
* @secure
|
|
457
|
+
*/
|
|
458
|
+
updateVenue: (venueId, data, params = {}) => this.request({
|
|
459
|
+
path: `/venue/${venueId}`,
|
|
460
|
+
method: 'PUT',
|
|
461
|
+
body: data,
|
|
462
|
+
secure: true,
|
|
463
|
+
type: ContentType.Json,
|
|
464
|
+
...params,
|
|
465
|
+
}),
|
|
466
|
+
/**
|
|
467
|
+
* @description Delete a venue by ID
|
|
468
|
+
*
|
|
469
|
+
* @tags Venue
|
|
470
|
+
* @name DeleteVenue
|
|
471
|
+
* @summary Delete Venue
|
|
472
|
+
* @request DELETE:/venue/{venueID}
|
|
473
|
+
* @secure
|
|
474
|
+
*/
|
|
475
|
+
deleteVenue: (venueId, params = {}) => this.request({
|
|
476
|
+
path: `/venue/${venueId}`,
|
|
477
|
+
method: 'DELETE',
|
|
478
|
+
secure: true,
|
|
479
|
+
...params,
|
|
480
|
+
}),
|
|
481
|
+
};
|
|
482
|
+
this.venues = {
|
|
483
|
+
/**
|
|
484
|
+
* @description Retrieve all venues for the current customer
|
|
485
|
+
*
|
|
486
|
+
* @tags Venue
|
|
487
|
+
* @name ListVenues
|
|
488
|
+
* @summary Get All Venues
|
|
489
|
+
* @request GET:/venues
|
|
490
|
+
* @secure
|
|
491
|
+
*/
|
|
492
|
+
listVenues: (params = {}) => this.request({
|
|
493
|
+
path: `/venues`,
|
|
494
|
+
method: 'GET',
|
|
495
|
+
secure: true,
|
|
496
|
+
...params,
|
|
497
|
+
}),
|
|
498
|
+
};
|
|
499
|
+
this.instructor = {
|
|
500
|
+
/**
|
|
501
|
+
* @description Retrieve an instructor by ID with expanded details
|
|
502
|
+
*
|
|
503
|
+
* @tags Instructor
|
|
504
|
+
* @name GetInstructor
|
|
505
|
+
* @summary Get Instructor
|
|
506
|
+
* @request GET:/instructor/{instructorID}
|
|
507
|
+
* @secure
|
|
508
|
+
*/
|
|
509
|
+
getInstructor: (instructorId, params = {}) => this.request({
|
|
510
|
+
path: `/instructor/${instructorId}`,
|
|
511
|
+
method: 'GET',
|
|
512
|
+
secure: true,
|
|
513
|
+
...params,
|
|
514
|
+
}),
|
|
515
|
+
/**
|
|
516
|
+
* @description Register a user as an instructor
|
|
517
|
+
*
|
|
518
|
+
* @tags Instructor
|
|
519
|
+
* @name CreateInstructor
|
|
520
|
+
* @summary Create Instructor
|
|
521
|
+
* @request POST:/instructor/{instructorID}
|
|
522
|
+
* @secure
|
|
523
|
+
*/
|
|
524
|
+
createInstructor: (instructorId, data, params = {}) => this.request({
|
|
525
|
+
path: `/instructor/${instructorId}`,
|
|
526
|
+
method: 'POST',
|
|
527
|
+
body: data,
|
|
528
|
+
secure: true,
|
|
529
|
+
type: ContentType.Json,
|
|
530
|
+
...params,
|
|
531
|
+
}),
|
|
532
|
+
/**
|
|
533
|
+
* @description Update an instructor
|
|
534
|
+
*
|
|
535
|
+
* @tags Instructor
|
|
536
|
+
* @name UpdateInstructor
|
|
537
|
+
* @summary Update Instructor
|
|
538
|
+
* @request PUT:/instructor/{instructorID}
|
|
539
|
+
* @secure
|
|
540
|
+
*/
|
|
541
|
+
updateInstructor: (instructorId, data, params = {}) => this.request({
|
|
542
|
+
path: `/instructor/${instructorId}`,
|
|
543
|
+
method: 'PUT',
|
|
544
|
+
body: data,
|
|
545
|
+
secure: true,
|
|
546
|
+
type: ContentType.Json,
|
|
547
|
+
...params,
|
|
548
|
+
}),
|
|
549
|
+
/**
|
|
550
|
+
* @description Remove an instructor
|
|
551
|
+
*
|
|
552
|
+
* @tags Instructor
|
|
553
|
+
* @name DeleteInstructor
|
|
554
|
+
* @summary Delete Instructor
|
|
555
|
+
* @request DELETE:/instructor/{instructorID}
|
|
556
|
+
* @secure
|
|
557
|
+
*/
|
|
558
|
+
deleteInstructor: (instructorId, params = {}) => this.request({
|
|
559
|
+
path: `/instructor/${instructorId}`,
|
|
560
|
+
method: 'DELETE',
|
|
561
|
+
secure: true,
|
|
562
|
+
...params,
|
|
563
|
+
}),
|
|
564
|
+
/**
|
|
565
|
+
* @description Retrieve courses assigned to an instructor
|
|
566
|
+
*
|
|
567
|
+
* @tags Instructor
|
|
568
|
+
* @name GetCourse
|
|
569
|
+
* @summary Get Instructor Courses
|
|
570
|
+
* @request GET:/instructor/{instructorID}/course
|
|
571
|
+
* @secure
|
|
572
|
+
*/
|
|
573
|
+
getCourse: (instructorId, params = {}) => this.request({
|
|
574
|
+
path: `/instructor/${instructorId}/course`,
|
|
575
|
+
method: 'GET',
|
|
576
|
+
secure: true,
|
|
577
|
+
...params,
|
|
578
|
+
}),
|
|
579
|
+
/**
|
|
580
|
+
* @description Smart update courses assigned to an instructor
|
|
581
|
+
*
|
|
582
|
+
* @tags Instructor
|
|
583
|
+
* @name CreateCourse
|
|
584
|
+
* @summary Update Instructor Courses
|
|
585
|
+
* @request POST:/instructor/{instructorID}/course
|
|
586
|
+
* @secure
|
|
587
|
+
*/
|
|
588
|
+
createCourse: (instructorId, data, params = {}) => this.request({
|
|
589
|
+
path: `/instructor/${instructorId}/course`,
|
|
590
|
+
method: 'POST',
|
|
591
|
+
body: data,
|
|
592
|
+
secure: true,
|
|
593
|
+
type: ContentType.Json,
|
|
594
|
+
...params,
|
|
595
|
+
}),
|
|
596
|
+
/**
|
|
597
|
+
* @description Retrieve regions assigned to an instructor
|
|
598
|
+
*
|
|
599
|
+
* @tags Instructor
|
|
600
|
+
* @name GetRegion
|
|
601
|
+
* @summary Get Instructor Regions
|
|
602
|
+
* @request GET:/instructor/{instructorID}/region
|
|
603
|
+
* @secure
|
|
604
|
+
*/
|
|
605
|
+
getRegion: (instructorId, params = {}) => this.request({
|
|
606
|
+
path: `/instructor/${instructorId}/region`,
|
|
607
|
+
method: 'GET',
|
|
608
|
+
secure: true,
|
|
609
|
+
...params,
|
|
610
|
+
}),
|
|
611
|
+
/**
|
|
612
|
+
* @description Smart update regions assigned to an instructor
|
|
613
|
+
*
|
|
614
|
+
* @tags Instructor
|
|
615
|
+
* @name CreateRegion
|
|
616
|
+
* @summary Update Instructor Regions
|
|
617
|
+
* @request POST:/instructor/{instructorID}/region
|
|
618
|
+
* @secure
|
|
619
|
+
*/
|
|
620
|
+
createRegion: (instructorId, data, params = {}) => this.request({
|
|
621
|
+
path: `/instructor/${instructorId}/region`,
|
|
622
|
+
method: 'POST',
|
|
623
|
+
body: data,
|
|
624
|
+
secure: true,
|
|
625
|
+
type: ContentType.Json,
|
|
626
|
+
...params,
|
|
627
|
+
}),
|
|
628
|
+
/**
|
|
629
|
+
* @description Retrieve instructor calendar events within a time range
|
|
630
|
+
*
|
|
631
|
+
* @tags Instructor
|
|
632
|
+
* @name ListEvents
|
|
633
|
+
* @summary Get Instructor Events
|
|
634
|
+
* @request POST:/instructor/{instructorID}/events
|
|
635
|
+
* @secure
|
|
636
|
+
*/
|
|
637
|
+
listEvents: (instructorId, data, params = {}) => this.request({
|
|
638
|
+
path: `/instructor/${instructorId}/events`,
|
|
639
|
+
method: 'POST',
|
|
640
|
+
body: data,
|
|
641
|
+
secure: true,
|
|
642
|
+
type: ContentType.Json,
|
|
643
|
+
...params,
|
|
644
|
+
}),
|
|
645
|
+
/**
|
|
646
|
+
* @description Retrieve an instructor availability event
|
|
647
|
+
*
|
|
648
|
+
* @tags InstructorCalendar
|
|
649
|
+
* @name GetAvailabilityEvent
|
|
650
|
+
* @summary Get Availability Event
|
|
651
|
+
* @request GET:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
652
|
+
* @secure
|
|
653
|
+
*/
|
|
654
|
+
getAvailabilityEvent: (instructorId, startTime, params = {}) => this.request({
|
|
655
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
656
|
+
method: 'GET',
|
|
657
|
+
secure: true,
|
|
658
|
+
...params,
|
|
659
|
+
}),
|
|
660
|
+
/**
|
|
661
|
+
* @description Create an instructor availability event
|
|
662
|
+
*
|
|
663
|
+
* @tags InstructorCalendar
|
|
664
|
+
* @name CreateAvailabilityEvent
|
|
665
|
+
* @summary Create Availability Event
|
|
666
|
+
* @request POST:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
667
|
+
* @secure
|
|
668
|
+
*/
|
|
669
|
+
createAvailabilityEvent: (instructorId, startTime, data, params = {}) => this.request({
|
|
670
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
671
|
+
method: 'POST',
|
|
672
|
+
body: data,
|
|
673
|
+
secure: true,
|
|
674
|
+
type: ContentType.Json,
|
|
675
|
+
...params,
|
|
676
|
+
}),
|
|
677
|
+
/**
|
|
678
|
+
* @description Update an instructor availability event (delete + recreate)
|
|
679
|
+
*
|
|
680
|
+
* @tags InstructorCalendar
|
|
681
|
+
* @name UpdateAvailabilityEvent
|
|
682
|
+
* @summary Update Availability Event
|
|
683
|
+
* @request PUT:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
684
|
+
* @secure
|
|
685
|
+
*/
|
|
686
|
+
updateAvailabilityEvent: (instructorId, startTime, data, params = {}) => this.request({
|
|
687
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
688
|
+
method: 'PUT',
|
|
689
|
+
body: data,
|
|
690
|
+
secure: true,
|
|
691
|
+
type: ContentType.Json,
|
|
692
|
+
...params,
|
|
693
|
+
}),
|
|
694
|
+
/**
|
|
695
|
+
* @description Delete an instructor availability event
|
|
696
|
+
*
|
|
697
|
+
* @tags InstructorCalendar
|
|
698
|
+
* @name DeleteAvailabilityEvent
|
|
699
|
+
* @summary Delete Availability Event
|
|
700
|
+
* @request DELETE:/instructor/{instructorID}/availabilityEvent/{startTime}
|
|
701
|
+
* @secure
|
|
702
|
+
*/
|
|
703
|
+
deleteAvailabilityEvent: (instructorId, startTime, params = {}) => this.request({
|
|
704
|
+
path: `/instructor/${instructorId}/availabilityEvent/${startTime}`,
|
|
705
|
+
method: 'DELETE',
|
|
706
|
+
secure: true,
|
|
707
|
+
...params,
|
|
708
|
+
}),
|
|
709
|
+
/**
|
|
710
|
+
* @description Retrieve a calendar sync configuration
|
|
711
|
+
*
|
|
712
|
+
* @tags InstructorCalendarSync
|
|
713
|
+
* @name GetCalendarSync
|
|
714
|
+
* @summary Get Instructor Calendar Sync
|
|
715
|
+
* @request GET:/instructor/{instructorID}/calendarSync/{providerID}
|
|
716
|
+
* @secure
|
|
717
|
+
*/
|
|
718
|
+
getCalendarSync: (instructorId, providerId, params = {}) => this.request({
|
|
719
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
720
|
+
method: 'GET',
|
|
721
|
+
secure: true,
|
|
722
|
+
...params,
|
|
723
|
+
}),
|
|
724
|
+
/**
|
|
725
|
+
* @description Create a calendar sync configuration
|
|
726
|
+
*
|
|
727
|
+
* @tags InstructorCalendarSync
|
|
728
|
+
* @name CreateCalendarSync
|
|
729
|
+
* @summary Create Instructor Calendar Sync
|
|
730
|
+
* @request POST:/instructor/{instructorID}/calendarSync/{providerID}
|
|
731
|
+
* @secure
|
|
732
|
+
*/
|
|
733
|
+
createCalendarSync: (instructorId, providerId, params = {}) => this.request({
|
|
734
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
735
|
+
method: 'POST',
|
|
736
|
+
secure: true,
|
|
737
|
+
...params,
|
|
738
|
+
}),
|
|
739
|
+
/**
|
|
740
|
+
* @description Update a calendar sync configuration
|
|
741
|
+
*
|
|
742
|
+
* @tags InstructorCalendarSync
|
|
743
|
+
* @name UpdateCalendarSync
|
|
744
|
+
* @summary Update Instructor Calendar Sync
|
|
745
|
+
* @request PUT:/instructor/{instructorID}/calendarSync/{providerID}
|
|
746
|
+
* @secure
|
|
747
|
+
*/
|
|
748
|
+
updateCalendarSync: (instructorId, providerId, params = {}) => this.request({
|
|
749
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
750
|
+
method: 'PUT',
|
|
751
|
+
secure: true,
|
|
752
|
+
...params,
|
|
753
|
+
}),
|
|
754
|
+
/**
|
|
755
|
+
* @description Delete a calendar sync configuration
|
|
756
|
+
*
|
|
757
|
+
* @tags InstructorCalendarSync
|
|
758
|
+
* @name DeleteCalendarSync
|
|
759
|
+
* @summary Delete Instructor Calendar Sync
|
|
760
|
+
* @request DELETE:/instructor/{instructorID}/calendarSync/{providerID}
|
|
761
|
+
* @secure
|
|
762
|
+
*/
|
|
763
|
+
deleteCalendarSync: (instructorId, providerId, params = {}) => this.request({
|
|
764
|
+
path: `/instructor/${instructorId}/calendarSync/${providerId}`,
|
|
765
|
+
method: 'DELETE',
|
|
766
|
+
secure: true,
|
|
767
|
+
...params,
|
|
768
|
+
}),
|
|
769
|
+
/**
|
|
770
|
+
* @description Retrieve all calendar sync configurations for an instructor
|
|
771
|
+
*
|
|
772
|
+
* @tags InstructorCalendarSync
|
|
773
|
+
* @name GetCalendarSyncs
|
|
774
|
+
* @summary Get All Instructor Calendar Syncs
|
|
775
|
+
* @request GET:/instructor/{instructorID}/calendarSyncs
|
|
776
|
+
* @secure
|
|
777
|
+
*/
|
|
778
|
+
getCalendarSyncs: (instructorId, params = {}) => this.request({
|
|
779
|
+
path: `/instructor/${instructorId}/calendarSyncs`,
|
|
780
|
+
method: 'GET',
|
|
781
|
+
secure: true,
|
|
782
|
+
...params,
|
|
783
|
+
}),
|
|
784
|
+
};
|
|
785
|
+
this.instructors = {
|
|
786
|
+
/**
|
|
787
|
+
* @description Retrieve all instructors for the current customer
|
|
788
|
+
*
|
|
789
|
+
* @tags Instructor
|
|
790
|
+
* @name ListInstructors
|
|
791
|
+
* @summary Get All Instructors
|
|
792
|
+
* @request GET:/instructors
|
|
793
|
+
* @secure
|
|
794
|
+
*/
|
|
795
|
+
listInstructors: (params = {}) => this.request({
|
|
796
|
+
path: `/instructors`,
|
|
797
|
+
method: 'GET',
|
|
798
|
+
secure: true,
|
|
799
|
+
...params,
|
|
800
|
+
}),
|
|
801
|
+
};
|
|
802
|
+
this.course = {
|
|
803
|
+
/**
|
|
804
|
+
* @description Retrieve course calendar configuration
|
|
805
|
+
*
|
|
806
|
+
* @tags CourseCalendar
|
|
807
|
+
* @name GetCalendar
|
|
808
|
+
* @summary Get Course Calendar
|
|
809
|
+
* @request GET:/course/{courseID}/calendar
|
|
810
|
+
* @secure
|
|
811
|
+
*/
|
|
812
|
+
getCalendar: (courseId, params = {}) => this.request({
|
|
813
|
+
path: `/course/${courseId}/calendar`,
|
|
814
|
+
method: 'GET',
|
|
815
|
+
secure: true,
|
|
816
|
+
...params,
|
|
817
|
+
}),
|
|
818
|
+
/**
|
|
819
|
+
* @description Upsert course calendar configuration
|
|
820
|
+
*
|
|
821
|
+
* @tags CourseCalendar
|
|
822
|
+
* @name UpdateCalendar
|
|
823
|
+
* @summary Update Course Calendar
|
|
824
|
+
* @request PUT:/course/{courseID}/calendar
|
|
825
|
+
* @secure
|
|
826
|
+
*/
|
|
827
|
+
updateCalendar: (courseId, data, params = {}) => this.request({
|
|
828
|
+
path: `/course/${courseId}/calendar`,
|
|
829
|
+
method: 'PUT',
|
|
830
|
+
body: data,
|
|
831
|
+
secure: true,
|
|
832
|
+
type: ContentType.Json,
|
|
833
|
+
...params,
|
|
834
|
+
}),
|
|
835
|
+
/**
|
|
836
|
+
* @description Retrieve a course enrolment ticket
|
|
837
|
+
*
|
|
838
|
+
* @tags CourseTicket
|
|
839
|
+
* @name GetStudentTicket
|
|
840
|
+
* @summary Get Course Ticket
|
|
841
|
+
* @request GET:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
842
|
+
* @secure
|
|
843
|
+
*/
|
|
844
|
+
getStudentTicket: (courseId, userId, ticketId, params = {}) => this.request({
|
|
845
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
846
|
+
method: 'GET',
|
|
847
|
+
secure: true,
|
|
848
|
+
...params,
|
|
849
|
+
}),
|
|
850
|
+
/**
|
|
851
|
+
* @description Generate a course enrolment ticket
|
|
852
|
+
*
|
|
853
|
+
* @tags CourseTicket
|
|
854
|
+
* @name CreateStudentTicket
|
|
855
|
+
* @summary Create Course Ticket
|
|
856
|
+
* @request POST:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
857
|
+
* @secure
|
|
858
|
+
*/
|
|
859
|
+
createStudentTicket: (courseId, userId, ticketId, params = {}) => this.request({
|
|
860
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
861
|
+
method: 'POST',
|
|
862
|
+
secure: true,
|
|
863
|
+
...params,
|
|
864
|
+
}),
|
|
865
|
+
/**
|
|
866
|
+
* @description Delete a course enrolment ticket
|
|
867
|
+
*
|
|
868
|
+
* @tags CourseTicket
|
|
869
|
+
* @name DeleteStudentTicket
|
|
870
|
+
* @summary Delete Course Ticket
|
|
871
|
+
* @request DELETE:/course/{courseID}/student/{userID}/ticket/{ticketID}
|
|
872
|
+
* @secure
|
|
873
|
+
*/
|
|
874
|
+
deleteStudentTicket: (courseId, userId, ticketId, params = {}) => this.request({
|
|
875
|
+
path: `/course/${courseId}/student/${userId}/ticket/${ticketId}`,
|
|
876
|
+
method: 'DELETE',
|
|
877
|
+
secure: true,
|
|
878
|
+
...params,
|
|
879
|
+
}),
|
|
880
|
+
};
|
|
881
|
+
this.courses = {
|
|
882
|
+
/**
|
|
883
|
+
* @description Retrieve a course calendar sync configuration
|
|
884
|
+
*
|
|
885
|
+
* @tags CourseCalendarSync
|
|
886
|
+
* @name GetCalendarSync
|
|
887
|
+
* @summary Get Course Calendar Sync
|
|
888
|
+
* @request GET:/courses/calendarSync/{providerID}
|
|
889
|
+
* @secure
|
|
890
|
+
*/
|
|
891
|
+
getCalendarSync: (providerId, params = {}) => this.request({
|
|
892
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
893
|
+
method: 'GET',
|
|
894
|
+
secure: true,
|
|
895
|
+
...params,
|
|
896
|
+
}),
|
|
897
|
+
/**
|
|
898
|
+
* @description Create a course calendar sync
|
|
899
|
+
*
|
|
900
|
+
* @tags CourseCalendarSync
|
|
901
|
+
* @name CreateCalendarSync
|
|
902
|
+
* @summary Create Course Calendar Sync
|
|
903
|
+
* @request POST:/courses/calendarSync/{providerID}
|
|
904
|
+
* @secure
|
|
905
|
+
*/
|
|
906
|
+
createCalendarSync: (providerId, params = {}) => this.request({
|
|
907
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
908
|
+
method: 'POST',
|
|
909
|
+
secure: true,
|
|
910
|
+
...params,
|
|
911
|
+
}),
|
|
912
|
+
/**
|
|
913
|
+
* @description Update a course calendar sync
|
|
914
|
+
*
|
|
915
|
+
* @tags CourseCalendarSync
|
|
916
|
+
* @name UpdateCalendarSync
|
|
917
|
+
* @summary Update Course Calendar Sync
|
|
918
|
+
* @request PUT:/courses/calendarSync/{providerID}
|
|
919
|
+
* @secure
|
|
920
|
+
*/
|
|
921
|
+
updateCalendarSync: (providerId, params = {}) => this.request({
|
|
922
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
923
|
+
method: 'PUT',
|
|
924
|
+
secure: true,
|
|
925
|
+
...params,
|
|
926
|
+
}),
|
|
927
|
+
/**
|
|
928
|
+
* @description Delete a course calendar sync
|
|
929
|
+
*
|
|
930
|
+
* @tags CourseCalendarSync
|
|
931
|
+
* @name DeleteCalendarSync
|
|
932
|
+
* @summary Delete Course Calendar Sync
|
|
933
|
+
* @request DELETE:/courses/calendarSync/{providerID}
|
|
934
|
+
* @secure
|
|
935
|
+
*/
|
|
936
|
+
deleteCalendarSync: (providerId, params = {}) => this.request({
|
|
937
|
+
path: `/courses/calendarSync/${providerId}`,
|
|
938
|
+
method: 'DELETE',
|
|
939
|
+
secure: true,
|
|
940
|
+
...params,
|
|
941
|
+
}),
|
|
942
|
+
/**
|
|
943
|
+
* @description Retrieve all course calendar syncs for the customer
|
|
944
|
+
*
|
|
945
|
+
* @tags CourseCalendarSync
|
|
946
|
+
* @name ListCalendarSyncs
|
|
947
|
+
* @summary Get All Course Calendar Syncs
|
|
948
|
+
* @request GET:/courses/calendarSyncs
|
|
949
|
+
* @secure
|
|
950
|
+
*/
|
|
951
|
+
listCalendarSyncs: (params = {}) => this.request({
|
|
952
|
+
path: `/courses/calendarSyncs`,
|
|
953
|
+
method: 'GET',
|
|
954
|
+
secure: true,
|
|
955
|
+
...params,
|
|
956
|
+
}),
|
|
957
|
+
/**
|
|
958
|
+
* @description Retrieve all courses for the current tenant or customer
|
|
959
|
+
*
|
|
960
|
+
* @tags Course
|
|
961
|
+
* @name ListCourses
|
|
962
|
+
* @summary Get All Courses
|
|
963
|
+
* @request GET:/courses
|
|
964
|
+
* @secure
|
|
965
|
+
*/
|
|
966
|
+
listCourses: (params = {}) => this.request({
|
|
967
|
+
path: `/courses`,
|
|
968
|
+
method: 'GET',
|
|
969
|
+
secure: true,
|
|
970
|
+
...params,
|
|
971
|
+
}),
|
|
972
|
+
};
|
|
973
|
+
this.template = {
|
|
974
|
+
/**
|
|
975
|
+
* @description Retrieve a session course template by ID
|
|
976
|
+
*
|
|
977
|
+
* @tags Template
|
|
978
|
+
* @name GetTemplate
|
|
979
|
+
* @summary Get Template
|
|
980
|
+
* @request GET:/template/{templateID}
|
|
981
|
+
* @secure
|
|
982
|
+
*/
|
|
983
|
+
getTemplate: (templateId, params = {}) => this.request({
|
|
984
|
+
path: `/template/${templateId}`,
|
|
985
|
+
method: 'GET',
|
|
986
|
+
secure: true,
|
|
987
|
+
...params,
|
|
988
|
+
}),
|
|
989
|
+
/**
|
|
990
|
+
* @description Create a new session course template
|
|
991
|
+
*
|
|
992
|
+
* @tags Template
|
|
993
|
+
* @name CreateTemplate
|
|
994
|
+
* @summary Create Template
|
|
995
|
+
* @request POST:/template/{templateID}
|
|
996
|
+
* @secure
|
|
997
|
+
*/
|
|
998
|
+
createTemplate: (templateId, data, params = {}) => this.request({
|
|
999
|
+
path: `/template/${templateId}`,
|
|
1000
|
+
method: 'POST',
|
|
1001
|
+
body: data,
|
|
1002
|
+
secure: true,
|
|
1003
|
+
type: ContentType.Json,
|
|
1004
|
+
...params,
|
|
1005
|
+
}),
|
|
1006
|
+
/**
|
|
1007
|
+
* @description Update an existing session course template
|
|
1008
|
+
*
|
|
1009
|
+
* @tags Template
|
|
1010
|
+
* @name UpdateTemplate
|
|
1011
|
+
* @summary Update Template
|
|
1012
|
+
* @request PUT:/template/{templateID}
|
|
1013
|
+
* @secure
|
|
1014
|
+
*/
|
|
1015
|
+
updateTemplate: (templateId, data, params = {}) => this.request({
|
|
1016
|
+
path: `/template/${templateId}`,
|
|
1017
|
+
method: 'PUT',
|
|
1018
|
+
body: data,
|
|
1019
|
+
secure: true,
|
|
1020
|
+
type: ContentType.Json,
|
|
1021
|
+
...params,
|
|
1022
|
+
}),
|
|
1023
|
+
/**
|
|
1024
|
+
* @description Delete a session course template
|
|
1025
|
+
*
|
|
1026
|
+
* @tags Template
|
|
1027
|
+
* @name DeleteTemplate
|
|
1028
|
+
* @summary Delete Template
|
|
1029
|
+
* @request DELETE:/template/{templateID}
|
|
1030
|
+
* @secure
|
|
1031
|
+
*/
|
|
1032
|
+
deleteTemplate: (templateId, params = {}) => this.request({
|
|
1033
|
+
path: `/template/${templateId}`,
|
|
1034
|
+
method: 'DELETE',
|
|
1035
|
+
secure: true,
|
|
1036
|
+
...params,
|
|
1037
|
+
}),
|
|
1038
|
+
};
|
|
1039
|
+
this.templates = {
|
|
1040
|
+
/**
|
|
1041
|
+
* @description Retrieve all session course templates
|
|
1042
|
+
*
|
|
1043
|
+
* @tags Template
|
|
1044
|
+
* @name ListTemplates
|
|
1045
|
+
* @summary Get All Templates
|
|
1046
|
+
* @request GET:/templates
|
|
1047
|
+
* @secure
|
|
1048
|
+
*/
|
|
1049
|
+
listTemplates: (params = {}) => this.request({
|
|
1050
|
+
path: `/templates`,
|
|
1051
|
+
method: 'GET',
|
|
1052
|
+
secure: true,
|
|
1053
|
+
...params,
|
|
1054
|
+
}),
|
|
1055
|
+
};
|
|
1056
|
+
this.locations = {
|
|
1057
|
+
/**
|
|
1058
|
+
* @description Retrieve all locations (regions, cities, venues map)
|
|
1059
|
+
*
|
|
1060
|
+
* @tags Location
|
|
1061
|
+
* @name ListLocations
|
|
1062
|
+
* @summary Get Locations
|
|
1063
|
+
* @request GET:/locations
|
|
1064
|
+
* @secure
|
|
1065
|
+
*/
|
|
1066
|
+
listLocations: (params = {}) => this.request({
|
|
1067
|
+
path: `/locations`,
|
|
1068
|
+
method: 'GET',
|
|
1069
|
+
secure: true,
|
|
1070
|
+
...params,
|
|
1071
|
+
}),
|
|
1072
|
+
};
|
|
1073
|
+
this.search = {
|
|
1074
|
+
/**
|
|
1075
|
+
* @description Search for sessions by an array of IDs
|
|
1076
|
+
*
|
|
1077
|
+
* @tags Search
|
|
1078
|
+
* @name ListSessionsIds
|
|
1079
|
+
* @summary Search Sessions by IDs
|
|
1080
|
+
* @request POST:/search/sessions/ids
|
|
1081
|
+
* @secure
|
|
1082
|
+
*/
|
|
1083
|
+
listSessionsIds: (data, params = {}) => this.request({
|
|
1084
|
+
path: `/search/sessions/ids`,
|
|
1085
|
+
method: 'POST',
|
|
1086
|
+
body: data,
|
|
1087
|
+
secure: true,
|
|
1088
|
+
type: ContentType.Json,
|
|
1089
|
+
...params,
|
|
1090
|
+
}),
|
|
1091
|
+
};
|
|
1092
|
+
this.session = {
|
|
1093
|
+
/**
|
|
1094
|
+
* @description Retrieve a session by ID
|
|
1095
|
+
*
|
|
1096
|
+
* @tags Session
|
|
1097
|
+
* @name GetSession
|
|
1098
|
+
* @summary Get Session
|
|
1099
|
+
* @request GET:/session/{sessionID}
|
|
1100
|
+
* @secure
|
|
1101
|
+
*/
|
|
1102
|
+
getSession: (sessionId, params = {}) => this.request({
|
|
1103
|
+
path: `/session/${sessionId}`,
|
|
1104
|
+
method: 'GET',
|
|
1105
|
+
secure: true,
|
|
1106
|
+
...params,
|
|
1107
|
+
}),
|
|
1108
|
+
/**
|
|
1109
|
+
* @description Create a new session
|
|
1110
|
+
*
|
|
1111
|
+
* @tags Session
|
|
1112
|
+
* @name CreateSession
|
|
1113
|
+
* @summary Create Session
|
|
1114
|
+
* @request POST:/session/{sessionID}
|
|
1115
|
+
* @secure
|
|
1116
|
+
*/
|
|
1117
|
+
createSession: (sessionId, data, params = {}) => this.request({
|
|
1118
|
+
path: `/session/${sessionId}`,
|
|
1119
|
+
method: 'POST',
|
|
1120
|
+
body: data,
|
|
1121
|
+
secure: true,
|
|
1122
|
+
type: ContentType.Json,
|
|
1123
|
+
...params,
|
|
1124
|
+
}),
|
|
1125
|
+
/**
|
|
1126
|
+
* @description Update an existing session
|
|
1127
|
+
*
|
|
1128
|
+
* @tags Session
|
|
1129
|
+
* @name UpdateSession
|
|
1130
|
+
* @summary Update Session
|
|
1131
|
+
* @request PUT:/session/{sessionID}
|
|
1132
|
+
* @secure
|
|
1133
|
+
*/
|
|
1134
|
+
updateSession: (sessionId, data, params = {}) => this.request({
|
|
1135
|
+
path: `/session/${sessionId}`,
|
|
1136
|
+
method: 'PUT',
|
|
1137
|
+
body: data,
|
|
1138
|
+
secure: true,
|
|
1139
|
+
type: ContentType.Json,
|
|
1140
|
+
...params,
|
|
1141
|
+
}),
|
|
1142
|
+
/**
|
|
1143
|
+
* @description Delete a session
|
|
1144
|
+
*
|
|
1145
|
+
* @tags Session
|
|
1146
|
+
* @name DeleteSession
|
|
1147
|
+
* @summary Delete Session
|
|
1148
|
+
* @request DELETE:/session/{sessionID}
|
|
1149
|
+
* @secure
|
|
1150
|
+
*/
|
|
1151
|
+
deleteSession: (sessionId, params = {}) => this.request({
|
|
1152
|
+
path: `/session/${sessionId}`,
|
|
1153
|
+
method: 'DELETE',
|
|
1154
|
+
secure: true,
|
|
1155
|
+
...params,
|
|
1156
|
+
}),
|
|
1157
|
+
/**
|
|
1158
|
+
* @description Transition session to next state
|
|
1159
|
+
*
|
|
1160
|
+
* @tags Session
|
|
1161
|
+
* @name CreateNext
|
|
1162
|
+
* @summary Advance Session State
|
|
1163
|
+
* @request POST:/session/{sessionID}/next
|
|
1164
|
+
* @secure
|
|
1165
|
+
*/
|
|
1166
|
+
createNext: (sessionId, params = {}) => this.request({
|
|
1167
|
+
path: `/session/${sessionId}/next`,
|
|
1168
|
+
method: 'POST',
|
|
1169
|
+
secure: true,
|
|
1170
|
+
...params,
|
|
1171
|
+
}),
|
|
1172
|
+
/**
|
|
1173
|
+
* @description Cancel a session
|
|
1174
|
+
*
|
|
1175
|
+
* @tags Session
|
|
1176
|
+
* @name CreateCancel
|
|
1177
|
+
* @summary Cancel Session
|
|
1178
|
+
* @request POST:/session/{sessionID}/cancel
|
|
1179
|
+
* @secure
|
|
1180
|
+
*/
|
|
1181
|
+
createCancel: (sessionId, params = {}) => this.request({
|
|
1182
|
+
path: `/session/${sessionId}/cancel`,
|
|
1183
|
+
method: 'POST',
|
|
1184
|
+
secure: true,
|
|
1185
|
+
...params,
|
|
1186
|
+
}),
|
|
1187
|
+
/**
|
|
1188
|
+
* @description Lock a session
|
|
1189
|
+
*
|
|
1190
|
+
* @tags Session
|
|
1191
|
+
* @name CreateLock
|
|
1192
|
+
* @summary Lock Session
|
|
1193
|
+
* @request POST:/session/{sessionID}/lock
|
|
1194
|
+
* @secure
|
|
1195
|
+
*/
|
|
1196
|
+
createLock: (sessionId, params = {}) => this.request({
|
|
1197
|
+
path: `/session/${sessionId}/lock`,
|
|
1198
|
+
method: 'POST',
|
|
1199
|
+
secure: true,
|
|
1200
|
+
...params,
|
|
1201
|
+
}),
|
|
1202
|
+
/**
|
|
1203
|
+
* @description Unlock a locked session
|
|
1204
|
+
*
|
|
1205
|
+
* @tags Session
|
|
1206
|
+
* @name CreateUnlock
|
|
1207
|
+
* @summary Unlock Session
|
|
1208
|
+
* @request POST:/session/{sessionID}/unlock
|
|
1209
|
+
* @secure
|
|
1210
|
+
*/
|
|
1211
|
+
createUnlock: (sessionId, params = {}) => this.request({
|
|
1212
|
+
path: `/session/${sessionId}/unlock`,
|
|
1213
|
+
method: 'POST',
|
|
1214
|
+
secure: true,
|
|
1215
|
+
...params,
|
|
1216
|
+
}),
|
|
1217
|
+
/**
|
|
1218
|
+
* @description Publish or unpublish session calendar events
|
|
1219
|
+
*
|
|
1220
|
+
* @tags Session
|
|
1221
|
+
* @name CreatePublish
|
|
1222
|
+
* @summary Publish Session
|
|
1223
|
+
* @request POST:/session/{sessionID}/publish
|
|
1224
|
+
* @secure
|
|
1225
|
+
*/
|
|
1226
|
+
createPublish: (sessionId, data, params = {}) => this.request({
|
|
1227
|
+
path: `/session/${sessionId}/publish`,
|
|
1228
|
+
method: 'POST',
|
|
1229
|
+
body: data,
|
|
1230
|
+
secure: true,
|
|
1231
|
+
type: ContentType.Json,
|
|
1232
|
+
...params,
|
|
1233
|
+
}),
|
|
1234
|
+
/**
|
|
1235
|
+
* @description Release session access to students
|
|
1236
|
+
*
|
|
1237
|
+
* @tags Session
|
|
1238
|
+
* @name CreateRelease
|
|
1239
|
+
* @summary Release Session
|
|
1240
|
+
* @request POST:/session/{sessionID}/release
|
|
1241
|
+
* @secure
|
|
1242
|
+
*/
|
|
1243
|
+
createRelease: (sessionId, params = {}) => this.request({
|
|
1244
|
+
path: `/session/${sessionId}/release`,
|
|
1245
|
+
method: 'POST',
|
|
1246
|
+
secure: true,
|
|
1247
|
+
...params,
|
|
1248
|
+
}),
|
|
1249
|
+
/**
|
|
1250
|
+
* @description Refresh material shipping info for session
|
|
1251
|
+
*
|
|
1252
|
+
* @tags Session
|
|
1253
|
+
* @name CreateRefreshShipping
|
|
1254
|
+
* @summary Refresh Shipping
|
|
1255
|
+
* @request POST:/session/{sessionID}/refreshShipping
|
|
1256
|
+
* @secure
|
|
1257
|
+
*/
|
|
1258
|
+
createRefreshShipping: (sessionId, params = {}) => this.request({
|
|
1259
|
+
path: `/session/${sessionId}/refreshShipping`,
|
|
1260
|
+
method: 'POST',
|
|
1261
|
+
secure: true,
|
|
1262
|
+
...params,
|
|
1263
|
+
}),
|
|
1264
|
+
/**
|
|
1265
|
+
* @description Update material shipped status for a session
|
|
1266
|
+
*
|
|
1267
|
+
* @tags Session
|
|
1268
|
+
* @name CreateCourseMaterial
|
|
1269
|
+
* @summary Update Course Material Status
|
|
1270
|
+
* @request POST:/session/{sessionID}/courseMaterial
|
|
1271
|
+
* @secure
|
|
1272
|
+
*/
|
|
1273
|
+
createCourseMaterial: (sessionId, data, params = {}) => this.request({
|
|
1274
|
+
path: `/session/${sessionId}/courseMaterial`,
|
|
1275
|
+
method: 'POST',
|
|
1276
|
+
body: data,
|
|
1277
|
+
secure: true,
|
|
1278
|
+
type: ContentType.Json,
|
|
1279
|
+
...params,
|
|
1280
|
+
}),
|
|
1281
|
+
/**
|
|
1282
|
+
* @description Duplicate a session to new dates
|
|
1283
|
+
*
|
|
1284
|
+
* @tags Session
|
|
1285
|
+
* @name CreateDuplicate
|
|
1286
|
+
* @summary Duplicate Session
|
|
1287
|
+
* @request POST:/session/{sessionID}/duplicate
|
|
1288
|
+
* @secure
|
|
1289
|
+
*/
|
|
1290
|
+
createDuplicate: (sessionId, data, params = {}) => this.request({
|
|
1291
|
+
path: `/session/${sessionId}/duplicate`,
|
|
1292
|
+
method: 'POST',
|
|
1293
|
+
body: data,
|
|
1294
|
+
secure: true,
|
|
1295
|
+
type: ContentType.Json,
|
|
1296
|
+
...params,
|
|
1297
|
+
}),
|
|
1298
|
+
/**
|
|
1299
|
+
* @description Move a student between sessions of the same course
|
|
1300
|
+
*
|
|
1301
|
+
* @tags Session
|
|
1302
|
+
* @name CreateMoveStudent
|
|
1303
|
+
* @summary Move Student
|
|
1304
|
+
* @request POST:/session/{sessionID}/moveStudent/{userID}/{newSessionID}
|
|
1305
|
+
* @secure
|
|
1306
|
+
*/
|
|
1307
|
+
createMoveStudent: (sessionId, userId, newSessionId, params = {}) => this.request({
|
|
1308
|
+
path: `/session/${sessionId}/moveStudent/${userId}/${newSessionId}`,
|
|
1309
|
+
method: 'POST',
|
|
1310
|
+
secure: true,
|
|
1311
|
+
...params,
|
|
1312
|
+
}),
|
|
1313
|
+
/**
|
|
1314
|
+
* @description Retrieve all attendances for a session
|
|
1315
|
+
*
|
|
1316
|
+
* @tags Session Attendance
|
|
1317
|
+
* @name GetAttendances
|
|
1318
|
+
* @summary Get Session Attendances
|
|
1319
|
+
* @request GET:/session/{sessionID}/attendances
|
|
1320
|
+
* @secure
|
|
1321
|
+
*/
|
|
1322
|
+
getAttendances: (sessionId, params = {}) => this.request({
|
|
1323
|
+
path: `/session/${sessionId}/attendances`,
|
|
1324
|
+
method: 'GET',
|
|
1325
|
+
secure: true,
|
|
1326
|
+
...params,
|
|
1327
|
+
}),
|
|
1328
|
+
/**
|
|
1329
|
+
* @description Retrieve all enrolments for a session
|
|
1330
|
+
*
|
|
1331
|
+
* @tags Session Enrolment
|
|
1332
|
+
* @name GetEnrolments
|
|
1333
|
+
* @summary Get Session Enrolments
|
|
1334
|
+
* @request GET:/session/{sessionID}/enrolments
|
|
1335
|
+
* @secure
|
|
1336
|
+
*/
|
|
1337
|
+
getEnrolments: (sessionId, params = {}) => this.request({
|
|
1338
|
+
path: `/session/${sessionId}/enrolments`,
|
|
1339
|
+
method: 'GET',
|
|
1340
|
+
secure: true,
|
|
1341
|
+
...params,
|
|
1342
|
+
}),
|
|
1343
|
+
/**
|
|
1344
|
+
* @description Retrieve all results for a session
|
|
1345
|
+
*
|
|
1346
|
+
* @tags Session Result
|
|
1347
|
+
* @name GetResults
|
|
1348
|
+
* @summary Get Session Results
|
|
1349
|
+
* @request GET:/session/{sessionID}/results
|
|
1350
|
+
* @secure
|
|
1351
|
+
*/
|
|
1352
|
+
getResults: (sessionId, params = {}) => this.request({
|
|
1353
|
+
path: `/session/${sessionId}/results`,
|
|
1354
|
+
method: 'GET',
|
|
1355
|
+
secure: true,
|
|
1356
|
+
...params,
|
|
1357
|
+
}),
|
|
1358
|
+
/**
|
|
1359
|
+
* @description Retrieve all enrolment invitations for a session
|
|
1360
|
+
*
|
|
1361
|
+
* @tags Session Invitation
|
|
1362
|
+
* @name GetInvitations
|
|
1363
|
+
* @summary Get Session Invitations
|
|
1364
|
+
* @request GET:/session/{sessionID}/invitations
|
|
1365
|
+
* @secure
|
|
1366
|
+
*/
|
|
1367
|
+
getInvitations: (sessionId, params = {}) => this.request({
|
|
1368
|
+
path: `/session/${sessionId}/invitations`,
|
|
1369
|
+
method: 'GET',
|
|
1370
|
+
secure: true,
|
|
1371
|
+
...params,
|
|
1372
|
+
}),
|
|
1373
|
+
/**
|
|
1374
|
+
* @description Retrieve financial charges for a user in a session
|
|
1375
|
+
*
|
|
1376
|
+
* @tags Session Financial Charge
|
|
1377
|
+
* @name GetCharges
|
|
1378
|
+
* @summary Get Session Charges
|
|
1379
|
+
* @request GET:/session/{sessionID}/charges/{userID}
|
|
1380
|
+
* @secure
|
|
1381
|
+
*/
|
|
1382
|
+
getCharges: (sessionId, userId, params = {}) => this.request({
|
|
1383
|
+
path: `/session/${sessionId}/charges/${userId}`,
|
|
1384
|
+
method: 'GET',
|
|
1385
|
+
secure: true,
|
|
1386
|
+
...params,
|
|
1387
|
+
}),
|
|
1388
|
+
/**
|
|
1389
|
+
* @description Retrieve a specific attendance record
|
|
1390
|
+
*
|
|
1391
|
+
* @tags Session Attendance
|
|
1392
|
+
* @name GetAttendance
|
|
1393
|
+
* @summary Get Session Attendance
|
|
1394
|
+
* @request GET:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
1395
|
+
* @secure
|
|
1396
|
+
*/
|
|
1397
|
+
getAttendance: (sessionId, attendanceId, externalId, params = {}) => this.request({
|
|
1398
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
1399
|
+
method: 'GET',
|
|
1400
|
+
secure: true,
|
|
1401
|
+
...params,
|
|
1402
|
+
}),
|
|
1403
|
+
/**
|
|
1404
|
+
* @description Create a new attendance record
|
|
1405
|
+
*
|
|
1406
|
+
* @tags Session Attendance
|
|
1407
|
+
* @name CreateAttendance
|
|
1408
|
+
* @summary Create Session Attendance
|
|
1409
|
+
* @request POST:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
1410
|
+
* @secure
|
|
1411
|
+
*/
|
|
1412
|
+
createAttendance: (sessionId, attendanceId, externalId, data, params = {}) => this.request({
|
|
1413
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
1414
|
+
method: 'POST',
|
|
1415
|
+
body: data,
|
|
1416
|
+
secure: true,
|
|
1417
|
+
type: ContentType.Json,
|
|
1418
|
+
...params,
|
|
1419
|
+
}),
|
|
1420
|
+
/**
|
|
1421
|
+
* @description Update an existing attendance record
|
|
1422
|
+
*
|
|
1423
|
+
* @tags Session Attendance
|
|
1424
|
+
* @name UpdateAttendance
|
|
1425
|
+
* @summary Update Session Attendance
|
|
1426
|
+
* @request PUT:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
1427
|
+
* @secure
|
|
1428
|
+
*/
|
|
1429
|
+
updateAttendance: (sessionId, attendanceId, externalId, data, params = {}) => this.request({
|
|
1430
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
1431
|
+
method: 'PUT',
|
|
1432
|
+
body: data,
|
|
1433
|
+
secure: true,
|
|
1434
|
+
type: ContentType.Json,
|
|
1435
|
+
...params,
|
|
1436
|
+
}),
|
|
1437
|
+
/**
|
|
1438
|
+
* @description Delete an attendance record
|
|
1439
|
+
*
|
|
1440
|
+
* @tags Session Attendance
|
|
1441
|
+
* @name DeleteAttendance
|
|
1442
|
+
* @summary Delete Session Attendance
|
|
1443
|
+
* @request DELETE:/session/{sessionID}/attendance/{attendanceID}/{externalID}
|
|
1444
|
+
* @secure
|
|
1445
|
+
*/
|
|
1446
|
+
deleteAttendance: (sessionId, attendanceId, externalId, params = {}) => this.request({
|
|
1447
|
+
path: `/session/${sessionId}/attendance/${attendanceId}/${externalId}`,
|
|
1448
|
+
method: 'DELETE',
|
|
1449
|
+
secure: true,
|
|
1450
|
+
...params,
|
|
1451
|
+
}),
|
|
1452
|
+
/**
|
|
1453
|
+
* @description Retrieve a specific enrolment record
|
|
1454
|
+
*
|
|
1455
|
+
* @tags Session Enrolment
|
|
1456
|
+
* @name GetEnrolment
|
|
1457
|
+
* @summary Get Session Enrolment
|
|
1458
|
+
* @request GET:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
1459
|
+
* @secure
|
|
1460
|
+
*/
|
|
1461
|
+
getEnrolment: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1462
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
1463
|
+
method: 'GET',
|
|
1464
|
+
secure: true,
|
|
1465
|
+
...params,
|
|
1466
|
+
}),
|
|
1467
|
+
/**
|
|
1468
|
+
* @description Create a new session enrolment
|
|
1469
|
+
*
|
|
1470
|
+
* @tags Session Enrolment
|
|
1471
|
+
* @name CreateEnrolment
|
|
1472
|
+
* @summary Create Session Enrolment
|
|
1473
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
1474
|
+
* @secure
|
|
1475
|
+
*/
|
|
1476
|
+
createEnrolment: (sessionId, enrolmentId, externalId, data, params = {}) => this.request({
|
|
1477
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
1478
|
+
method: 'POST',
|
|
1479
|
+
body: data,
|
|
1480
|
+
secure: true,
|
|
1481
|
+
type: ContentType.Json,
|
|
1482
|
+
...params,
|
|
1483
|
+
}),
|
|
1484
|
+
/**
|
|
1485
|
+
* @description Update an existing session enrolment
|
|
1486
|
+
*
|
|
1487
|
+
* @tags Session Enrolment
|
|
1488
|
+
* @name UpdateEnrolment
|
|
1489
|
+
* @summary Update Session Enrolment
|
|
1490
|
+
* @request PUT:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
1491
|
+
* @secure
|
|
1492
|
+
*/
|
|
1493
|
+
updateEnrolment: (sessionId, enrolmentId, externalId, data, params = {}) => this.request({
|
|
1494
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
1495
|
+
method: 'PUT',
|
|
1496
|
+
body: data,
|
|
1497
|
+
secure: true,
|
|
1498
|
+
type: ContentType.Json,
|
|
1499
|
+
...params,
|
|
1500
|
+
}),
|
|
1501
|
+
/**
|
|
1502
|
+
* @description Delete a session enrolment
|
|
1503
|
+
*
|
|
1504
|
+
* @tags Session Enrolment
|
|
1505
|
+
* @name DeleteEnrolment
|
|
1506
|
+
* @summary Delete Session Enrolment
|
|
1507
|
+
* @request DELETE:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}
|
|
1508
|
+
* @secure
|
|
1509
|
+
*/
|
|
1510
|
+
deleteEnrolment: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1511
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}`,
|
|
1512
|
+
method: 'DELETE',
|
|
1513
|
+
secure: true,
|
|
1514
|
+
...params,
|
|
1515
|
+
}),
|
|
1516
|
+
/**
|
|
1517
|
+
* @description Retrieve an enrolment by session and user
|
|
1518
|
+
*
|
|
1519
|
+
* @tags Session Enrolment
|
|
1520
|
+
* @name GetEnrolment2
|
|
1521
|
+
* @summary Get Session Enrolment By User
|
|
1522
|
+
* @request GET:/session/{sessionID}/enrolment/{enrolmentID}
|
|
1523
|
+
* @originalName getEnrolment
|
|
1524
|
+
* @duplicate
|
|
1525
|
+
* @secure
|
|
1526
|
+
*/
|
|
1527
|
+
getEnrolment2: (sessionId, enrolmentId, params = {}) => this.request({
|
|
1528
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}`,
|
|
1529
|
+
method: 'GET',
|
|
1530
|
+
secure: true,
|
|
1531
|
+
...params,
|
|
1532
|
+
}),
|
|
1533
|
+
/**
|
|
1534
|
+
* @description Release a session enrolment
|
|
1535
|
+
*
|
|
1536
|
+
* @tags Session Enrolment
|
|
1537
|
+
* @name CreateEnrolmentRelease
|
|
1538
|
+
* @summary Release Session Enrolment
|
|
1539
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/release
|
|
1540
|
+
* @secure
|
|
1541
|
+
*/
|
|
1542
|
+
createEnrolmentRelease: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1543
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/release`,
|
|
1544
|
+
method: 'POST',
|
|
1545
|
+
secure: true,
|
|
1546
|
+
...params,
|
|
1547
|
+
}),
|
|
1548
|
+
/**
|
|
1549
|
+
* @description Cancel a session enrolment
|
|
1550
|
+
*
|
|
1551
|
+
* @tags Session Enrolment
|
|
1552
|
+
* @name CreateEnrolmentCancel
|
|
1553
|
+
* @summary Cancel Session Enrolment
|
|
1554
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/cancel
|
|
1555
|
+
* @secure
|
|
1556
|
+
*/
|
|
1557
|
+
createEnrolmentCancel: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1558
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/cancel`,
|
|
1559
|
+
method: 'POST',
|
|
1560
|
+
secure: true,
|
|
1561
|
+
...params,
|
|
1562
|
+
}),
|
|
1563
|
+
/**
|
|
1564
|
+
* @description Generate SSO launch link for an online session enrolment
|
|
1565
|
+
*
|
|
1566
|
+
* @tags Session Enrolment
|
|
1567
|
+
* @name CreateEnrolmentLaunch
|
|
1568
|
+
* @summary Launch Session Enrolment SSO
|
|
1569
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/launch
|
|
1570
|
+
* @secure
|
|
1571
|
+
*/
|
|
1572
|
+
createEnrolmentLaunch: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1573
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/launch`,
|
|
1574
|
+
method: 'POST',
|
|
1575
|
+
secure: true,
|
|
1576
|
+
...params,
|
|
1577
|
+
}),
|
|
1578
|
+
/**
|
|
1579
|
+
* @description Check the result for an online session enrolment
|
|
1580
|
+
*
|
|
1581
|
+
* @tags Session Enrolment
|
|
1582
|
+
* @name CreateEnrolmentCheckResult
|
|
1583
|
+
* @summary Check Enrolment Result
|
|
1584
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/checkResult
|
|
1585
|
+
* @secure
|
|
1586
|
+
*/
|
|
1587
|
+
createEnrolmentCheckResult: (sessionId, enrolmentId, externalId, params = {}) => this.request({
|
|
1588
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/checkResult`,
|
|
1589
|
+
method: 'POST',
|
|
1590
|
+
secure: true,
|
|
1591
|
+
...params,
|
|
1592
|
+
}),
|
|
1593
|
+
/**
|
|
1594
|
+
* @description Create a financial charge for an enrolment
|
|
1595
|
+
*
|
|
1596
|
+
* @tags Session Enrolment
|
|
1597
|
+
* @name CreateEnrolmentCharge
|
|
1598
|
+
* @summary Create Enrolment Charge
|
|
1599
|
+
* @request POST:/session/{sessionID}/enrolment/{enrolmentID}/{externalID}/charge
|
|
1600
|
+
* @secure
|
|
1601
|
+
*/
|
|
1602
|
+
createEnrolmentCharge: (sessionId, enrolmentId, externalId, data, params = {}) => this.request({
|
|
1603
|
+
path: `/session/${sessionId}/enrolment/${enrolmentId}/${externalId}/charge`,
|
|
1604
|
+
method: 'POST',
|
|
1605
|
+
body: data,
|
|
1606
|
+
secure: true,
|
|
1607
|
+
type: ContentType.Json,
|
|
1608
|
+
...params,
|
|
1609
|
+
}),
|
|
1610
|
+
/**
|
|
1611
|
+
* @description Retrieve a specific session result
|
|
1612
|
+
*
|
|
1613
|
+
* @tags Session Result
|
|
1614
|
+
* @name GetResult
|
|
1615
|
+
* @summary Get Session Result
|
|
1616
|
+
* @request GET:/session/{sessionID}/result/{resultID}/{externalID}
|
|
1617
|
+
* @secure
|
|
1618
|
+
*/
|
|
1619
|
+
getResult: (sessionId, resultId, externalId, params = {}) => this.request({
|
|
1620
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
1621
|
+
method: 'GET',
|
|
1622
|
+
secure: true,
|
|
1623
|
+
...params,
|
|
1624
|
+
}),
|
|
1625
|
+
/**
|
|
1626
|
+
* @description Create a new session result
|
|
1627
|
+
*
|
|
1628
|
+
* @tags Session Result
|
|
1629
|
+
* @name CreateResult
|
|
1630
|
+
* @summary Create Session Result
|
|
1631
|
+
* @request POST:/session/{sessionID}/result/{resultID}/{externalID}
|
|
1632
|
+
* @secure
|
|
1633
|
+
*/
|
|
1634
|
+
createResult: (sessionId, resultId, externalId, data, params = {}) => this.request({
|
|
1635
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
1636
|
+
method: 'POST',
|
|
1637
|
+
body: data,
|
|
1638
|
+
secure: true,
|
|
1639
|
+
type: ContentType.Json,
|
|
1640
|
+
...params,
|
|
1641
|
+
}),
|
|
1642
|
+
/**
|
|
1643
|
+
* @description Update an existing session result
|
|
1644
|
+
*
|
|
1645
|
+
* @tags Session Result
|
|
1646
|
+
* @name UpdateResult
|
|
1647
|
+
* @summary Update Session Result
|
|
1648
|
+
* @request PUT:/session/{sessionID}/result/{resultID}/{externalID}
|
|
1649
|
+
* @secure
|
|
1650
|
+
*/
|
|
1651
|
+
updateResult: (sessionId, resultId, externalId, data, params = {}) => this.request({
|
|
1652
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
1653
|
+
method: 'PUT',
|
|
1654
|
+
body: data,
|
|
1655
|
+
secure: true,
|
|
1656
|
+
type: ContentType.Json,
|
|
1657
|
+
...params,
|
|
1658
|
+
}),
|
|
1659
|
+
/**
|
|
1660
|
+
* @description Delete a session result
|
|
1661
|
+
*
|
|
1662
|
+
* @tags Session Result
|
|
1663
|
+
* @name DeleteResult
|
|
1664
|
+
* @summary Delete Session Result
|
|
1665
|
+
* @request DELETE:/session/{sessionID}/result/{resultID}/{externalID}
|
|
1666
|
+
* @secure
|
|
1667
|
+
*/
|
|
1668
|
+
deleteResult: (sessionId, resultId, externalId, params = {}) => this.request({
|
|
1669
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}`,
|
|
1670
|
+
method: 'DELETE',
|
|
1671
|
+
secure: true,
|
|
1672
|
+
...params,
|
|
1673
|
+
}),
|
|
1674
|
+
/**
|
|
1675
|
+
* @description Publish a session result
|
|
1676
|
+
*
|
|
1677
|
+
* @tags Session Result
|
|
1678
|
+
* @name CreateResultPublish
|
|
1679
|
+
* @summary Publish Session Result
|
|
1680
|
+
* @request POST:/session/{sessionID}/result/{resultID}/{externalID}/publish
|
|
1681
|
+
* @secure
|
|
1682
|
+
*/
|
|
1683
|
+
createResultPublish: (sessionId, resultId, externalId, params = {}) => this.request({
|
|
1684
|
+
path: `/session/${sessionId}/result/${resultId}/${externalId}/publish`,
|
|
1685
|
+
method: 'POST',
|
|
1686
|
+
secure: true,
|
|
1687
|
+
...params,
|
|
1688
|
+
}),
|
|
1689
|
+
/**
|
|
1690
|
+
* @description Retrieve a session instructor assignment
|
|
1691
|
+
*
|
|
1692
|
+
* @tags Session Instructor
|
|
1693
|
+
* @name GetInstructor
|
|
1694
|
+
* @summary Get Session Instructor
|
|
1695
|
+
* @request GET:/session/{sessionID}/instructor/{instructorID}
|
|
1696
|
+
* @secure
|
|
1697
|
+
*/
|
|
1698
|
+
getInstructor: (sessionId, instructorId, params = {}) => this.request({
|
|
1699
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
1700
|
+
method: 'GET',
|
|
1701
|
+
secure: true,
|
|
1702
|
+
...params,
|
|
1703
|
+
}),
|
|
1704
|
+
/**
|
|
1705
|
+
* @description Assign an instructor to a session
|
|
1706
|
+
*
|
|
1707
|
+
* @tags Session Instructor
|
|
1708
|
+
* @name CreateInstructor
|
|
1709
|
+
* @summary Assign Session Instructor
|
|
1710
|
+
* @request POST:/session/{sessionID}/instructor/{instructorID}
|
|
1711
|
+
* @secure
|
|
1712
|
+
*/
|
|
1713
|
+
createInstructor: (sessionId, instructorId, data, params = {}) => this.request({
|
|
1714
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
1715
|
+
method: 'POST',
|
|
1716
|
+
body: data,
|
|
1717
|
+
secure: true,
|
|
1718
|
+
type: ContentType.Json,
|
|
1719
|
+
...params,
|
|
1720
|
+
}),
|
|
1721
|
+
/**
|
|
1722
|
+
* @description Update a session instructor assignment
|
|
1723
|
+
*
|
|
1724
|
+
* @tags Session Instructor
|
|
1725
|
+
* @name UpdateInstructor
|
|
1726
|
+
* @summary Update Session Instructor
|
|
1727
|
+
* @request PUT:/session/{sessionID}/instructor/{instructorID}
|
|
1728
|
+
* @secure
|
|
1729
|
+
*/
|
|
1730
|
+
updateInstructor: (sessionId, instructorId, data, params = {}) => this.request({
|
|
1731
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
1732
|
+
method: 'PUT',
|
|
1733
|
+
body: data,
|
|
1734
|
+
secure: true,
|
|
1735
|
+
type: ContentType.Json,
|
|
1736
|
+
...params,
|
|
1737
|
+
}),
|
|
1738
|
+
/**
|
|
1739
|
+
* @description Remove an instructor from a session
|
|
1740
|
+
*
|
|
1741
|
+
* @tags Session Instructor
|
|
1742
|
+
* @name DeleteInstructor
|
|
1743
|
+
* @summary Unassign Session Instructor
|
|
1744
|
+
* @request DELETE:/session/{sessionID}/instructor/{instructorID}
|
|
1745
|
+
* @secure
|
|
1746
|
+
*/
|
|
1747
|
+
deleteInstructor: (sessionId, instructorId, params = {}) => this.request({
|
|
1748
|
+
path: `/session/${sessionId}/instructor/${instructorId}`,
|
|
1749
|
+
method: 'DELETE',
|
|
1750
|
+
secure: true,
|
|
1751
|
+
...params,
|
|
1752
|
+
}),
|
|
1753
|
+
/**
|
|
1754
|
+
* @description Retrieve a session invitation
|
|
1755
|
+
*
|
|
1756
|
+
* @tags Session Invitation
|
|
1757
|
+
* @name GetInvitation
|
|
1758
|
+
* @summary Get Session Invitation
|
|
1759
|
+
* @request GET:/session/{sessionID}/invitation/{invitationID}
|
|
1760
|
+
* @secure
|
|
1761
|
+
*/
|
|
1762
|
+
getInvitation: (sessionId, invitationId, params = {}) => this.request({
|
|
1763
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
1764
|
+
method: 'GET',
|
|
1765
|
+
secure: true,
|
|
1766
|
+
...params,
|
|
1767
|
+
}),
|
|
1768
|
+
/**
|
|
1769
|
+
* @description Create a new session invitation
|
|
1770
|
+
*
|
|
1771
|
+
* @tags Session Invitation
|
|
1772
|
+
* @name CreateInvitation
|
|
1773
|
+
* @summary Create Session Invitation
|
|
1774
|
+
* @request POST:/session/{sessionID}/invitation/{invitationID}
|
|
1775
|
+
* @secure
|
|
1776
|
+
*/
|
|
1777
|
+
createInvitation: (sessionId, invitationId, data, params = {}) => this.request({
|
|
1778
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
1779
|
+
method: 'POST',
|
|
1780
|
+
body: data,
|
|
1781
|
+
secure: true,
|
|
1782
|
+
type: ContentType.Json,
|
|
1783
|
+
...params,
|
|
1784
|
+
}),
|
|
1785
|
+
/**
|
|
1786
|
+
* @description Update an existing session invitation
|
|
1787
|
+
*
|
|
1788
|
+
* @tags Session Invitation
|
|
1789
|
+
* @name UpdateInvitation
|
|
1790
|
+
* @summary Update Session Invitation
|
|
1791
|
+
* @request PUT:/session/{sessionID}/invitation/{invitationID}
|
|
1792
|
+
* @secure
|
|
1793
|
+
*/
|
|
1794
|
+
updateInvitation: (sessionId, invitationId, data, params = {}) => this.request({
|
|
1795
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
1796
|
+
method: 'PUT',
|
|
1797
|
+
body: data,
|
|
1798
|
+
secure: true,
|
|
1799
|
+
type: ContentType.Json,
|
|
1800
|
+
...params,
|
|
1801
|
+
}),
|
|
1802
|
+
/**
|
|
1803
|
+
* @description Delete a session invitation
|
|
1804
|
+
*
|
|
1805
|
+
* @tags Session Invitation
|
|
1806
|
+
* @name DeleteInvitation
|
|
1807
|
+
* @summary Delete Session Invitation
|
|
1808
|
+
* @request DELETE:/session/{sessionID}/invitation/{invitationID}
|
|
1809
|
+
* @secure
|
|
1810
|
+
*/
|
|
1811
|
+
deleteInvitation: (sessionId, invitationId, params = {}) => this.request({
|
|
1812
|
+
path: `/session/${sessionId}/invitation/${invitationId}`,
|
|
1813
|
+
method: 'DELETE',
|
|
1814
|
+
secure: true,
|
|
1815
|
+
...params,
|
|
1816
|
+
}),
|
|
1817
|
+
/**
|
|
1818
|
+
* @description Validate a session invitation code
|
|
1819
|
+
*
|
|
1820
|
+
* @tags Session Invitation
|
|
1821
|
+
* @name GetInvitationValidate
|
|
1822
|
+
* @summary Validate Session Invitation
|
|
1823
|
+
* @request GET:/session/invitation/validate/{invitationCode}
|
|
1824
|
+
* @secure
|
|
1825
|
+
*/
|
|
1826
|
+
getInvitationValidate: (invitationCode, params = {}) => this.request({
|
|
1827
|
+
path: `/session/invitation/validate/${invitationCode}`,
|
|
1828
|
+
method: 'GET',
|
|
1829
|
+
secure: true,
|
|
1830
|
+
...params,
|
|
1831
|
+
}),
|
|
1832
|
+
/**
|
|
1833
|
+
* @description Retrieve a specific financial charge
|
|
1834
|
+
*
|
|
1835
|
+
* @tags Session Financial Charge
|
|
1836
|
+
* @name GetCharge
|
|
1837
|
+
* @summary Get Session Financial Charge
|
|
1838
|
+
* @request GET:/session/{sessionID}/charge/{userID}/{timestamp}
|
|
1839
|
+
* @secure
|
|
1840
|
+
*/
|
|
1841
|
+
getCharge: (sessionId, userId, timestamp, params = {}) => this.request({
|
|
1842
|
+
path: `/session/${sessionId}/charge/${userId}/${timestamp}`,
|
|
1843
|
+
method: 'GET',
|
|
1844
|
+
secure: true,
|
|
1845
|
+
...params,
|
|
1846
|
+
}),
|
|
1847
|
+
/**
|
|
1848
|
+
* @description Get a signed URL to download a session document
|
|
1849
|
+
*
|
|
1850
|
+
* @tags Session Document
|
|
1851
|
+
* @name GetDocumentFileSign
|
|
1852
|
+
* @summary Get Session Document Signed URL
|
|
1853
|
+
* @request GET:/session/{sessionID}/document/fileSign/{fileID}
|
|
1854
|
+
* @secure
|
|
1855
|
+
*/
|
|
1856
|
+
getDocumentFileSign: (sessionId, fileId, params = {}) => this.request({
|
|
1857
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
1858
|
+
method: 'GET',
|
|
1859
|
+
secure: true,
|
|
1860
|
+
...params,
|
|
1861
|
+
}),
|
|
1862
|
+
/**
|
|
1863
|
+
* @description Get a signed URL to upload a session document
|
|
1864
|
+
*
|
|
1865
|
+
* @tags Session Document
|
|
1866
|
+
* @name CreateDocumentFileSign
|
|
1867
|
+
* @summary Get Session Document Upload URL
|
|
1868
|
+
* @request POST:/session/{sessionID}/document/fileSign/{fileID}
|
|
1869
|
+
* @secure
|
|
1870
|
+
*/
|
|
1871
|
+
createDocumentFileSign: (sessionId, fileId, params = {}) => this.request({
|
|
1872
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
1873
|
+
method: 'POST',
|
|
1874
|
+
secure: true,
|
|
1875
|
+
...params,
|
|
1876
|
+
}),
|
|
1877
|
+
/**
|
|
1878
|
+
* @description Get a signed URL to delete a session document
|
|
1879
|
+
*
|
|
1880
|
+
* @tags Session Document
|
|
1881
|
+
* @name DeleteDocumentFileSign
|
|
1882
|
+
* @summary Delete Session Document
|
|
1883
|
+
* @request DELETE:/session/{sessionID}/document/fileSign/{fileID}
|
|
1884
|
+
* @secure
|
|
1885
|
+
*/
|
|
1886
|
+
deleteDocumentFileSign: (sessionId, fileId, params = {}) => this.request({
|
|
1887
|
+
path: `/session/${sessionId}/document/fileSign/${fileId}`,
|
|
1888
|
+
method: 'DELETE',
|
|
1889
|
+
secure: true,
|
|
1890
|
+
...params,
|
|
1891
|
+
}),
|
|
1892
|
+
/**
|
|
1893
|
+
* @description Add a document to a session
|
|
1894
|
+
*
|
|
1895
|
+
* @tags Session Document
|
|
1896
|
+
* @name CreateDocument
|
|
1897
|
+
* @summary Add Session Document
|
|
1898
|
+
* @request POST:/session/{sessionID}/document
|
|
1899
|
+
* @secure
|
|
1900
|
+
*/
|
|
1901
|
+
createDocument: (sessionId, data, params = {}) => this.request({
|
|
1902
|
+
path: `/session/${sessionId}/document`,
|
|
1903
|
+
method: 'POST',
|
|
1904
|
+
body: data,
|
|
1905
|
+
secure: true,
|
|
1906
|
+
type: ContentType.Json,
|
|
1907
|
+
...params,
|
|
1908
|
+
}),
|
|
1909
|
+
/**
|
|
1910
|
+
* @description Remove a document from a session
|
|
1911
|
+
*
|
|
1912
|
+
* @tags Session Document
|
|
1913
|
+
* @name DeleteDocument
|
|
1914
|
+
* @summary Delete Session Document
|
|
1915
|
+
* @request DELETE:/session/{sessionID}/document/{fileID}
|
|
1916
|
+
* @secure
|
|
1917
|
+
*/
|
|
1918
|
+
deleteDocument: (sessionId, fileId, params = {}) => this.request({
|
|
1919
|
+
path: `/session/${sessionId}/document/${fileId}`,
|
|
1920
|
+
method: 'DELETE',
|
|
1921
|
+
secure: true,
|
|
1922
|
+
...params,
|
|
1923
|
+
}),
|
|
1924
|
+
/**
|
|
1925
|
+
* @description Batch create or update attendances and results for a session
|
|
1926
|
+
*
|
|
1927
|
+
* @tags Session Attendance, Session Result
|
|
1928
|
+
* @name CreateAttendancesResultsBatchUpsert
|
|
1929
|
+
* @summary Batch Upsert Attendances and Results
|
|
1930
|
+
* @request POST:/session/{sessionID}/attendances/results/batchUpsert
|
|
1931
|
+
* @secure
|
|
1932
|
+
*/
|
|
1933
|
+
createAttendancesResultsBatchUpsert: (sessionId, data, params = {}) => this.request({
|
|
1934
|
+
path: `/session/${sessionId}/attendances/results/batchUpsert`,
|
|
1935
|
+
method: 'POST',
|
|
1936
|
+
body: data,
|
|
1937
|
+
secure: true,
|
|
1938
|
+
type: ContentType.Json,
|
|
1939
|
+
...params,
|
|
1940
|
+
}),
|
|
1941
|
+
/**
|
|
1942
|
+
* @description Retrieve user data for a session
|
|
1943
|
+
*
|
|
1944
|
+
* @tags Session
|
|
1945
|
+
* @name GetUserData
|
|
1946
|
+
* @summary Get Session User Data
|
|
1947
|
+
* @request GET:/session/{sessionID}/userData/{userID}/{externalID}
|
|
1948
|
+
* @secure
|
|
1949
|
+
*/
|
|
1950
|
+
getUserData: (sessionId, userId, externalId, params = {}) => this.request({
|
|
1951
|
+
path: `/session/${sessionId}/userData/${userId}/${externalId}`,
|
|
1952
|
+
method: 'GET',
|
|
1953
|
+
secure: true,
|
|
1954
|
+
...params,
|
|
1955
|
+
}),
|
|
1956
|
+
/**
|
|
1957
|
+
* @description List session events within a time range
|
|
1958
|
+
*
|
|
1959
|
+
* @tags Session
|
|
1960
|
+
* @name ListEvents
|
|
1961
|
+
* @summary List Session Events
|
|
1962
|
+
* @request POST:/session/events/{startTime}/{endTime}
|
|
1963
|
+
* @secure
|
|
1964
|
+
*/
|
|
1965
|
+
listEvents: (startTime, endTime, params = {}) => this.request({
|
|
1966
|
+
path: `/session/events/${startTime}/${endTime}`,
|
|
1967
|
+
method: 'POST',
|
|
1968
|
+
secure: true,
|
|
1969
|
+
...params,
|
|
1970
|
+
}),
|
|
1971
|
+
/**
|
|
1972
|
+
* @description List session events within a time range filtered by course
|
|
1973
|
+
*
|
|
1974
|
+
* @tags Session
|
|
1975
|
+
* @name ListEvents2
|
|
1976
|
+
* @summary List Session Events By Course
|
|
1977
|
+
* @request POST:/session/events/{startTime}/{endTime}/{courseID}
|
|
1978
|
+
* @originalName listEvents
|
|
1979
|
+
* @duplicate
|
|
1980
|
+
* @secure
|
|
1981
|
+
*/
|
|
1982
|
+
listEvents2: (startTime, endTime, courseId, params = {}) => this.request({
|
|
1983
|
+
path: `/session/events/${startTime}/${endTime}/${courseId}`,
|
|
1984
|
+
method: 'POST',
|
|
1985
|
+
secure: true,
|
|
1986
|
+
...params,
|
|
1987
|
+
}),
|
|
1988
|
+
};
|
|
1989
|
+
this.sessions = {
|
|
1990
|
+
/**
|
|
1991
|
+
* @description Assign an instructor to multiple sessions
|
|
1992
|
+
*
|
|
1993
|
+
* @tags Session Instructor
|
|
1994
|
+
* @name CreateInstructor
|
|
1995
|
+
* @summary Set Instructor On Sessions
|
|
1996
|
+
* @request POST:/sessions/instructor/{instructorID}
|
|
1997
|
+
* @secure
|
|
1998
|
+
*/
|
|
1999
|
+
createInstructor: (instructorId, data, params = {}) => this.request({
|
|
2000
|
+
path: `/sessions/instructor/${instructorId}`,
|
|
2001
|
+
method: 'POST',
|
|
2002
|
+
body: data,
|
|
2003
|
+
secure: true,
|
|
2004
|
+
type: ContentType.Json,
|
|
2005
|
+
...params,
|
|
2006
|
+
}),
|
|
2007
|
+
};
|
|
2008
|
+
this.customer = {
|
|
2009
|
+
/**
|
|
2010
|
+
* @description List customer-wide session events within a time range
|
|
2011
|
+
*
|
|
2012
|
+
* @tags Session
|
|
2013
|
+
* @name ListSessionEvents
|
|
2014
|
+
* @summary List Customer Session Events
|
|
2015
|
+
* @request POST:/customer/session/events/{startTime}/{endTime}
|
|
2016
|
+
* @secure
|
|
2017
|
+
*/
|
|
2018
|
+
listSessionEvents: (startTime, endTime, params = {}) => this.request({
|
|
2019
|
+
path: `/customer/session/events/${startTime}/${endTime}`,
|
|
2020
|
+
method: 'POST',
|
|
2021
|
+
secure: true,
|
|
2022
|
+
...params,
|
|
2023
|
+
}),
|
|
2024
|
+
};
|
|
2025
|
+
this.reports = {
|
|
2026
|
+
/**
|
|
2027
|
+
* @description Generate enrolments per period report with optional course filter
|
|
2028
|
+
*
|
|
2029
|
+
* @tags Reports
|
|
2030
|
+
* @name CreateEnrolmentsPerPeriod
|
|
2031
|
+
* @summary Enrolments Per Period Report
|
|
2032
|
+
* @request POST:/reports/enrolmentsPerPeriod
|
|
2033
|
+
* @secure
|
|
2034
|
+
*/
|
|
2035
|
+
createEnrolmentsPerPeriod: (data, params = {}) => this.request({
|
|
2036
|
+
path: `/reports/enrolmentsPerPeriod`,
|
|
2037
|
+
method: 'POST',
|
|
2038
|
+
body: data,
|
|
2039
|
+
secure: true,
|
|
2040
|
+
type: ContentType.Json,
|
|
2041
|
+
...params,
|
|
2042
|
+
}),
|
|
2043
|
+
/**
|
|
2044
|
+
* @description Generate session results analysis aggregation report
|
|
2045
|
+
*
|
|
2046
|
+
* @tags Reports
|
|
2047
|
+
* @name ListSessionResultsAnalysis
|
|
2048
|
+
* @summary Session Results Analysis Report
|
|
2049
|
+
* @request POST:/reports/sessionResultsAnalysis
|
|
2050
|
+
* @secure
|
|
2051
|
+
*/
|
|
2052
|
+
listSessionResultsAnalysis: (data, params = {}) => this.request({
|
|
2053
|
+
path: `/reports/sessionResultsAnalysis`,
|
|
2054
|
+
method: 'POST',
|
|
2055
|
+
body: data,
|
|
2056
|
+
secure: true,
|
|
2057
|
+
type: ContentType.Json,
|
|
2058
|
+
...params,
|
|
2059
|
+
}),
|
|
2060
|
+
/**
|
|
2061
|
+
* @description Preview session results report without row limit
|
|
2062
|
+
*
|
|
2063
|
+
* @tags Reports
|
|
2064
|
+
* @name CreateSessionResultsPreview
|
|
2065
|
+
* @summary Session Results Preview
|
|
2066
|
+
* @request POST:/reports/sessionResults/preview
|
|
2067
|
+
* @secure
|
|
2068
|
+
*/
|
|
2069
|
+
createSessionResultsPreview: (data, params = {}) => this.request({
|
|
2070
|
+
path: `/reports/sessionResults/preview`,
|
|
2071
|
+
method: 'POST',
|
|
2072
|
+
body: data,
|
|
2073
|
+
secure: true,
|
|
2074
|
+
type: ContentType.Json,
|
|
2075
|
+
...params,
|
|
2076
|
+
}),
|
|
2077
|
+
/**
|
|
2078
|
+
* @description Generate session results report with max rows limit
|
|
2079
|
+
*
|
|
2080
|
+
* @tags Reports
|
|
2081
|
+
* @name ListSessionResults
|
|
2082
|
+
* @summary Session Results Report
|
|
2083
|
+
* @request POST:/reports/sessionResults
|
|
2084
|
+
* @secure
|
|
2085
|
+
*/
|
|
2086
|
+
listSessionResults: (data, params = {}) => this.request({
|
|
2087
|
+
path: `/reports/sessionResults`,
|
|
2088
|
+
method: 'POST',
|
|
2089
|
+
body: data,
|
|
2090
|
+
secure: true,
|
|
2091
|
+
type: ContentType.Json,
|
|
2092
|
+
...params,
|
|
2093
|
+
}),
|
|
2094
|
+
/**
|
|
2095
|
+
* @description Generate session list report
|
|
2096
|
+
*
|
|
2097
|
+
* @tags Reports
|
|
2098
|
+
* @name CreateSessionList
|
|
2099
|
+
* @summary Session List Report
|
|
2100
|
+
* @request POST:/reports/sessionList
|
|
2101
|
+
* @secure
|
|
2102
|
+
*/
|
|
2103
|
+
createSessionList: (data, params = {}) => this.request({
|
|
2104
|
+
path: `/reports/sessionList`,
|
|
2105
|
+
method: 'POST',
|
|
2106
|
+
body: data,
|
|
2107
|
+
secure: true,
|
|
2108
|
+
type: ContentType.Json,
|
|
2109
|
+
...params,
|
|
2110
|
+
}),
|
|
2111
|
+
/**
|
|
2112
|
+
* @description Generate Excel charges report for a session
|
|
2113
|
+
*
|
|
2114
|
+
* @tags Reports
|
|
2115
|
+
* @name ListSessionCharges
|
|
2116
|
+
* @summary Session Charges Report
|
|
2117
|
+
* @request POST:/reports/sessionCharges/{sessionID}
|
|
2118
|
+
* @secure
|
|
2119
|
+
*/
|
|
2120
|
+
listSessionCharges: (sessionId, params = {}) => this.request({
|
|
2121
|
+
path: `/reports/sessionCharges/${sessionId}`,
|
|
2122
|
+
method: 'POST',
|
|
2123
|
+
secure: true,
|
|
2124
|
+
...params,
|
|
2125
|
+
}),
|
|
2126
|
+
/**
|
|
2127
|
+
* @description Generate Excel shipping manifest report for a session
|
|
2128
|
+
*
|
|
2129
|
+
* @tags Reports
|
|
2130
|
+
* @name CreateSessionShippingManifest
|
|
2131
|
+
* @summary Session Shipping Manifest Report
|
|
2132
|
+
* @request POST:/reports/sessionShippingManifest/{sessionID}
|
|
2133
|
+
* @secure
|
|
2134
|
+
*/
|
|
2135
|
+
createSessionShippingManifest: (sessionId, params = {}) => this.request({
|
|
2136
|
+
path: `/reports/sessionShippingManifest/${sessionId}`,
|
|
2137
|
+
method: 'POST',
|
|
2138
|
+
secure: true,
|
|
2139
|
+
...params,
|
|
2140
|
+
}),
|
|
2141
|
+
};
|
|
2142
|
+
}
|
|
2143
|
+
}
|
|
2144
|
+
exports.Api = Api;
|
|
2145
|
+
//# sourceMappingURL=Api.js.map
|