@ikonintegration/bccsa-program-api 3.0.19 → 3.0.20
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 +93 -93
- package/dist/Api.d.ts +3174 -0
- package/dist/Api.js +1623 -0
- package/dist/Api.js.map +1 -0
- package/package.json +1 -1
- package/tsconfig.json +4 -2
package/dist/Api.d.ts
ADDED
|
@@ -0,0 +1,3174 @@
|
|
|
1
|
+
/** Default API Error response */
|
|
2
|
+
export interface ErrorResponse {
|
|
3
|
+
/** Error message */
|
|
4
|
+
err: string;
|
|
5
|
+
/** Error code */
|
|
6
|
+
errCode: string;
|
|
7
|
+
}
|
|
8
|
+
export interface InputC7J0Vk93Lo {
|
|
9
|
+
/**
|
|
10
|
+
* Name of the person filling out the contact form
|
|
11
|
+
* @example "John Doe"
|
|
12
|
+
*/
|
|
13
|
+
name: string;
|
|
14
|
+
/**
|
|
15
|
+
* Email address of the person filling out the contact form
|
|
16
|
+
* @format email
|
|
17
|
+
* @example "john@mail"
|
|
18
|
+
*/
|
|
19
|
+
email: string;
|
|
20
|
+
/**
|
|
21
|
+
* Comments or message from the person filling out the contact form
|
|
22
|
+
* @example "I have a question about my account."
|
|
23
|
+
*/
|
|
24
|
+
comments: string;
|
|
25
|
+
}
|
|
26
|
+
/** Timestamp of when the record was created */
|
|
27
|
+
export type CreatedOn = number;
|
|
28
|
+
/** User who created the record */
|
|
29
|
+
export type CreatedBy = string;
|
|
30
|
+
/** User who last updated the record */
|
|
31
|
+
export type UpdatedBy = string;
|
|
32
|
+
/** Timestamp of last update */
|
|
33
|
+
export type UpdateOn = number;
|
|
34
|
+
/** Entity identifier for Course */
|
|
35
|
+
export type DbEntity = string;
|
|
36
|
+
/** Unique identifier of the course record */
|
|
37
|
+
export type Id = string;
|
|
38
|
+
/** Certification process ID linked to this course */
|
|
39
|
+
export type CertProcID = string;
|
|
40
|
+
/** User ID associated with the course */
|
|
41
|
+
export type UserID = string;
|
|
42
|
+
/** Customer ID associated with the course */
|
|
43
|
+
export type CustomerID = string;
|
|
44
|
+
/** Tenant ID associated with the course */
|
|
45
|
+
export type TenantID = string;
|
|
46
|
+
/** Course ID reference */
|
|
47
|
+
export type CourseID = string;
|
|
48
|
+
/** When cooldown started */
|
|
49
|
+
export type CooldownStartedOn = number;
|
|
50
|
+
/** When cooldown was overwritten */
|
|
51
|
+
export type CooldownOverwrittenOn = number;
|
|
52
|
+
/** When course was locked */
|
|
53
|
+
export type CourseLockedOn = number;
|
|
54
|
+
/** When course lock was overwritten */
|
|
55
|
+
export type CourseLockOverwrittenOn = number;
|
|
56
|
+
/** Voucher code for the license */
|
|
57
|
+
export type LicenseVoucherCode = string;
|
|
58
|
+
/** License ID used in the course */
|
|
59
|
+
export type LicenseID = string;
|
|
60
|
+
/** ID for license invalidation */
|
|
61
|
+
export type LicenseInvalidateID = string;
|
|
62
|
+
/** Session ticket ID for course access */
|
|
63
|
+
export type SessionTicketID = string;
|
|
64
|
+
/** Session ID for course tracking */
|
|
65
|
+
export type SessionID = string;
|
|
66
|
+
/** Result of the course */
|
|
67
|
+
export type CourseResult = string;
|
|
68
|
+
/** Certificate number for the course */
|
|
69
|
+
export type CourseCertNumber = string;
|
|
70
|
+
/** Date of course completion */
|
|
71
|
+
export type CompletionDate = number;
|
|
72
|
+
/** Date when certificate was printed */
|
|
73
|
+
export type CertificatePrintedOn = number;
|
|
74
|
+
/** Date when card was printed */
|
|
75
|
+
export type CardPrintedOnDate = number;
|
|
76
|
+
/** Date of certificate/card shipping */
|
|
77
|
+
export type ShippingDate = number;
|
|
78
|
+
/** Whether data is copied from an alternate certification process */
|
|
79
|
+
export type IsCopiedFromAlternateCP = boolean;
|
|
80
|
+
/** Reminders sent before course expiry */
|
|
81
|
+
export type ExpireReminders = string[];
|
|
82
|
+
/** Expiration date of the course */
|
|
83
|
+
export type ExpiryDate = number;
|
|
84
|
+
/** Key used for indexing expiryDate */
|
|
85
|
+
export type ExpiryDateKey = string;
|
|
86
|
+
/** Whether the course has been invalidated */
|
|
87
|
+
export type Invalidated = boolean;
|
|
88
|
+
/** Whether a course retake has been requested */
|
|
89
|
+
export type RetakeRequested = boolean;
|
|
90
|
+
/** Current state of the course */
|
|
91
|
+
export type State = string;
|
|
92
|
+
/** Approval state of the course */
|
|
93
|
+
export type ApprovalState = string;
|
|
94
|
+
/** Notes about the course approval process */
|
|
95
|
+
export type ApprovalNotes = string;
|
|
96
|
+
/** List of submitted files for the course */
|
|
97
|
+
export type SubmissionItems = {
|
|
98
|
+
fileID?: string;
|
|
99
|
+
fileName?: string;
|
|
100
|
+
}[];
|
|
101
|
+
/** User who waived the course requirement */
|
|
102
|
+
export type WaivedBy = string;
|
|
103
|
+
/** Date when course was waived */
|
|
104
|
+
export type WaivedOn = number;
|
|
105
|
+
/** Justifications for overridden course restrictions */
|
|
106
|
+
export interface OverwrittenJustification {
|
|
107
|
+
cooldown_override?: string;
|
|
108
|
+
course_unlock?: string;
|
|
109
|
+
}
|
|
110
|
+
/** Response schema for user data */
|
|
111
|
+
export interface UserResponseEntity {
|
|
112
|
+
userResp?: {
|
|
113
|
+
applications?: {
|
|
114
|
+
/** @example 1717230000000 */
|
|
115
|
+
createdOn?: number;
|
|
116
|
+
/** @example "USR#abc" */
|
|
117
|
+
createdBy?: string;
|
|
118
|
+
/** @example "USR#xyz" */
|
|
119
|
+
updatedBy?: string;
|
|
120
|
+
/** @example 1717230000000 */
|
|
121
|
+
updatedOn?: number;
|
|
122
|
+
/** @example "prgCertificationApplication" */
|
|
123
|
+
dbEntity?: string;
|
|
124
|
+
/** @example "CUST#123" */
|
|
125
|
+
customerID: string;
|
|
126
|
+
/** @example "TEN#456" */
|
|
127
|
+
tenantID: string;
|
|
128
|
+
/** @example "USR#789" */
|
|
129
|
+
userID: string;
|
|
130
|
+
/** @example "CP#0001" */
|
|
131
|
+
certProcID: string;
|
|
132
|
+
/** @example "CERT#01" */
|
|
133
|
+
certificationID?: string;
|
|
134
|
+
/** @example "initial" */
|
|
135
|
+
type: string;
|
|
136
|
+
/** @example "LIC#999" */
|
|
137
|
+
licenseID?: string;
|
|
138
|
+
/** @example "LICINV#555" */
|
|
139
|
+
licenseInvalidateID?: string;
|
|
140
|
+
/** @example "submitted" */
|
|
141
|
+
state?: string;
|
|
142
|
+
/** @example 1717231111111 */
|
|
143
|
+
submittedOn?: number;
|
|
144
|
+
/** @example "USR#sub" */
|
|
145
|
+
submittedBy?: string;
|
|
146
|
+
/** @example "USR#rev" */
|
|
147
|
+
reviewedBy?: string;
|
|
148
|
+
/** @example 1717232222222 */
|
|
149
|
+
reviewedOn?: number;
|
|
150
|
+
/** @example "Everything looks good." */
|
|
151
|
+
reviewNotes?: string;
|
|
152
|
+
/** @example 1 */
|
|
153
|
+
reviewAcknowledge?: number;
|
|
154
|
+
/** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
|
|
155
|
+
submissionItems?: {
|
|
156
|
+
/** @example "ITEM#1" */
|
|
157
|
+
id?: string;
|
|
158
|
+
/** @example 1 */
|
|
159
|
+
version?: number;
|
|
160
|
+
/** @example "doc" */
|
|
161
|
+
type?: string;
|
|
162
|
+
}[];
|
|
163
|
+
/** @example ["ITEM#2"] */
|
|
164
|
+
blacklistedItems?: string[];
|
|
165
|
+
}[];
|
|
166
|
+
certificationProcesses?: {
|
|
167
|
+
/** @example "abc123" */
|
|
168
|
+
id: string;
|
|
169
|
+
/** @example "tenant001" */
|
|
170
|
+
tenantID: string;
|
|
171
|
+
/** @example "user001" */
|
|
172
|
+
userID: string;
|
|
173
|
+
/** @example "cert001" */
|
|
174
|
+
certificationID: string;
|
|
175
|
+
/** @example 1717000000000 */
|
|
176
|
+
createdOn?: number;
|
|
177
|
+
/** @example "admin" */
|
|
178
|
+
createdBy?: string;
|
|
179
|
+
/** @example "admin" */
|
|
180
|
+
updatedBy?: string;
|
|
181
|
+
/** @example 1717000000000 */
|
|
182
|
+
updatedOn?: number;
|
|
183
|
+
/** @example "prgCertificationProcess" */
|
|
184
|
+
dbEntity?: string;
|
|
185
|
+
/** @example "CERT-2025-XYZ" */
|
|
186
|
+
certNumber?: string;
|
|
187
|
+
/** @example 1717000000000 */
|
|
188
|
+
completionDate?: number;
|
|
189
|
+
/** @example 1716000000000 */
|
|
190
|
+
originalCompletionDate?: number;
|
|
191
|
+
/** @example 1717000000000 */
|
|
192
|
+
cardPrintedOn?: number;
|
|
193
|
+
/** @example 1717000000000 */
|
|
194
|
+
certificatePrintedOn?: number;
|
|
195
|
+
/** @example 1717000000000 */
|
|
196
|
+
shippingDate?: number;
|
|
197
|
+
/** @example 1717000000000 */
|
|
198
|
+
lastCourseCompletionDate?: number;
|
|
199
|
+
/** @example ["course1","course2"] */
|
|
200
|
+
blockedCourses?: string[];
|
|
201
|
+
triggerState?: Record<string, {
|
|
202
|
+
/** @example "triggered" */
|
|
203
|
+
state?: string;
|
|
204
|
+
/** @example 1717000000000 */
|
|
205
|
+
updatedOn?: number;
|
|
206
|
+
/** @example "OK" */
|
|
207
|
+
requestResult?: any;
|
|
208
|
+
}>;
|
|
209
|
+
/** @example 85 */
|
|
210
|
+
pointsAchieved?: number;
|
|
211
|
+
/** @example ["email1","email2"] */
|
|
212
|
+
expireReminders?: string[];
|
|
213
|
+
/** @example 1718000000000 */
|
|
214
|
+
expiryDate?: number;
|
|
215
|
+
/** @example "active" */
|
|
216
|
+
state?: string;
|
|
217
|
+
/** @example "completed" */
|
|
218
|
+
stage?: string;
|
|
219
|
+
/** @example "passed" */
|
|
220
|
+
stageLastCourseState?: string;
|
|
221
|
+
/** @example 1717000000000 */
|
|
222
|
+
manualOverrideOn?: number;
|
|
223
|
+
/** @example 120.5 */
|
|
224
|
+
pendingPaymentValue?: number;
|
|
225
|
+
/** @example "Manual override" */
|
|
226
|
+
overwrittenJustification?: string;
|
|
227
|
+
/** @example 15 */
|
|
228
|
+
commissionAmount?: number;
|
|
229
|
+
/** @example "affiliate001" */
|
|
230
|
+
commissionPayTo?: string;
|
|
231
|
+
/** @example 15 */
|
|
232
|
+
commissionPaid?: number;
|
|
233
|
+
/** @example "manager" */
|
|
234
|
+
waivedBy?: string;
|
|
235
|
+
/** @example 1717000000000 */
|
|
236
|
+
waivedOn?: number;
|
|
237
|
+
/** @example "Waived due to exception" */
|
|
238
|
+
waivedComments?: string;
|
|
239
|
+
}[];
|
|
240
|
+
courses?: {
|
|
241
|
+
/** Timestamp of when the record was created */
|
|
242
|
+
createdOn?: CreatedOn;
|
|
243
|
+
/** User who created the record */
|
|
244
|
+
createdBy?: CreatedBy;
|
|
245
|
+
/** User who last updated the record */
|
|
246
|
+
updatedBy?: UpdatedBy;
|
|
247
|
+
/** Timestamp of last update */
|
|
248
|
+
updateOn?: UpdateOn;
|
|
249
|
+
/** Entity identifier for Course */
|
|
250
|
+
dbEntity?: DbEntity;
|
|
251
|
+
/** Unique identifier of the course record */
|
|
252
|
+
id: Id;
|
|
253
|
+
/** Certification process ID linked to this course */
|
|
254
|
+
certProcID: CertProcID;
|
|
255
|
+
/** User ID associated with the course */
|
|
256
|
+
userID: UserID;
|
|
257
|
+
/** Customer ID associated with the course */
|
|
258
|
+
customerID: CustomerID;
|
|
259
|
+
/** Tenant ID associated with the course */
|
|
260
|
+
tenantID: TenantID;
|
|
261
|
+
/** Course ID reference */
|
|
262
|
+
courseID?: CourseID;
|
|
263
|
+
/** When cooldown started */
|
|
264
|
+
cooldownStartedOn?: CooldownStartedOn;
|
|
265
|
+
/** When cooldown was overwritten */
|
|
266
|
+
cooldownOverwrittenOn?: CooldownOverwrittenOn;
|
|
267
|
+
/** When course was locked */
|
|
268
|
+
courseLockedOn?: CourseLockedOn;
|
|
269
|
+
/** When course lock was overwritten */
|
|
270
|
+
courseLockOverwrittenOn?: CourseLockOverwrittenOn;
|
|
271
|
+
/** Voucher code for the license */
|
|
272
|
+
licenseVoucherCode?: LicenseVoucherCode;
|
|
273
|
+
/** License ID used in the course */
|
|
274
|
+
licenseID?: LicenseID;
|
|
275
|
+
/** ID for license invalidation */
|
|
276
|
+
licenseInvalidateID?: LicenseInvalidateID;
|
|
277
|
+
/** Session ticket ID for course access */
|
|
278
|
+
sessionTicketID?: SessionTicketID;
|
|
279
|
+
/** Session ID for course tracking */
|
|
280
|
+
sessionID?: SessionID;
|
|
281
|
+
/** Result of the course */
|
|
282
|
+
courseResult?: CourseResult;
|
|
283
|
+
/** Certificate number for the course */
|
|
284
|
+
courseCertNumber?: CourseCertNumber;
|
|
285
|
+
/** Date of course completion */
|
|
286
|
+
completionDate?: CompletionDate;
|
|
287
|
+
/** Date when certificate was printed */
|
|
288
|
+
certificatePrintedOn?: CertificatePrintedOn;
|
|
289
|
+
/** Date when card was printed */
|
|
290
|
+
cardPrintedOnDate?: CardPrintedOnDate;
|
|
291
|
+
/** Date of certificate/card shipping */
|
|
292
|
+
shippingDate?: ShippingDate;
|
|
293
|
+
/** Whether data is copied from an alternate certification process */
|
|
294
|
+
isCopiedFromAlternateCP?: IsCopiedFromAlternateCP;
|
|
295
|
+
/** Reminders sent before course expiry */
|
|
296
|
+
expireReminders?: ExpireReminders;
|
|
297
|
+
/** Expiration date of the course */
|
|
298
|
+
expiryDate?: ExpiryDate;
|
|
299
|
+
/** Key used for indexing expiryDate */
|
|
300
|
+
expiryDateKey?: ExpiryDateKey;
|
|
301
|
+
/** Whether the course has been invalidated */
|
|
302
|
+
invalidated?: Invalidated;
|
|
303
|
+
/** Whether a course retake has been requested */
|
|
304
|
+
retakeRequested?: RetakeRequested;
|
|
305
|
+
/** Current state of the course */
|
|
306
|
+
state?: State;
|
|
307
|
+
/** Approval state of the course */
|
|
308
|
+
approvalState?: ApprovalState;
|
|
309
|
+
/** Notes about the course approval process */
|
|
310
|
+
approvalNotes?: ApprovalNotes;
|
|
311
|
+
/** List of submitted files for the course */
|
|
312
|
+
submissionItems?: SubmissionItems;
|
|
313
|
+
/** User who waived the course requirement */
|
|
314
|
+
waivedBy?: WaivedBy;
|
|
315
|
+
/** Date when course was waived */
|
|
316
|
+
waivedOn?: WaivedOn;
|
|
317
|
+
/** Justifications for overridden course restrictions */
|
|
318
|
+
overwrittenJustification?: OverwrittenJustification;
|
|
319
|
+
}[];
|
|
320
|
+
};
|
|
321
|
+
transactionID?: string | null;
|
|
322
|
+
}
|
|
323
|
+
/** Associated Certification ID */
|
|
324
|
+
export type CertificationID = string;
|
|
325
|
+
/** Type of application */
|
|
326
|
+
export type Type = string;
|
|
327
|
+
/** Timestamp when the application was submitted */
|
|
328
|
+
export type SubmittedOn = number;
|
|
329
|
+
/** User who submitted the application */
|
|
330
|
+
export type SubmittedBy = string;
|
|
331
|
+
/** User who reviewed the application */
|
|
332
|
+
export type ReviewedBy = string;
|
|
333
|
+
/** Timestamp when the application was reviewed */
|
|
334
|
+
export type ReviewedOn = number;
|
|
335
|
+
/** Notes related to the review process */
|
|
336
|
+
export type ReviewNotes = string;
|
|
337
|
+
/** Whether the review was acknowledged */
|
|
338
|
+
export type ReviewAcknowledge = number;
|
|
339
|
+
/** Version of the submission item */
|
|
340
|
+
export type Version = number;
|
|
341
|
+
/** List of blacklisted item IDs for this application */
|
|
342
|
+
export type BlacklistedItems = string[];
|
|
343
|
+
/** Response schema for applications */
|
|
344
|
+
export interface ApplicationResponseSchema {
|
|
345
|
+
applications: {
|
|
346
|
+
/** Timestamp of when the application was created */
|
|
347
|
+
createdOn?: CreatedOn;
|
|
348
|
+
/** User who created the application */
|
|
349
|
+
createdBy?: CreatedBy;
|
|
350
|
+
/** User who last updated the application */
|
|
351
|
+
updatedBy?: UpdatedBy;
|
|
352
|
+
/** Timestamp of the last update */
|
|
353
|
+
updateOn?: UpdateOn;
|
|
354
|
+
/** Static identifier for the entity type */
|
|
355
|
+
dbEntity?: DbEntity;
|
|
356
|
+
/** Customer ID associated with the application */
|
|
357
|
+
customerID: CustomerID;
|
|
358
|
+
/** Tenant ID associated with the application */
|
|
359
|
+
tenantID: TenantID;
|
|
360
|
+
/** User ID for whom the application was submitted */
|
|
361
|
+
userID: UserID;
|
|
362
|
+
/** Certification Process ID related to this application */
|
|
363
|
+
certProcID: CertProcID;
|
|
364
|
+
/** Associated Certification ID */
|
|
365
|
+
certificationID?: CertificationID;
|
|
366
|
+
/** Type of application */
|
|
367
|
+
type: Type;
|
|
368
|
+
/** ID of the license involved in the application */
|
|
369
|
+
licenseID?: LicenseID;
|
|
370
|
+
/** ID of the license invalidation record */
|
|
371
|
+
licenseInvalidateID?: LicenseInvalidateID;
|
|
372
|
+
/** Current state of the application */
|
|
373
|
+
state?: State;
|
|
374
|
+
/** Timestamp when the application was submitted */
|
|
375
|
+
submittedOn?: SubmittedOn;
|
|
376
|
+
/** User who submitted the application */
|
|
377
|
+
submittedBy?: SubmittedBy;
|
|
378
|
+
/** User who reviewed the application */
|
|
379
|
+
reviewedBy?: ReviewedBy;
|
|
380
|
+
/** Timestamp when the application was reviewed */
|
|
381
|
+
reviewedOn?: ReviewedOn;
|
|
382
|
+
/** Notes related to the review process */
|
|
383
|
+
reviewNotes?: ReviewNotes;
|
|
384
|
+
/** Whether the review was acknowledged */
|
|
385
|
+
reviewAcknowledge?: ReviewAcknowledge;
|
|
386
|
+
/** List of submission items attached to the application */
|
|
387
|
+
submissionItems?: SubmissionItems & {
|
|
388
|
+
/** ID of the submission item */
|
|
389
|
+
id?: Id;
|
|
390
|
+
/** Version of the submission item */
|
|
391
|
+
version?: Version;
|
|
392
|
+
/** Type of the submission item */
|
|
393
|
+
type?: Type;
|
|
394
|
+
}[];
|
|
395
|
+
/** List of blacklisted item IDs for this application */
|
|
396
|
+
blacklistedItems?: BlacklistedItems;
|
|
397
|
+
}[] | null;
|
|
398
|
+
transactionID?: string | null;
|
|
399
|
+
}
|
|
400
|
+
/** Timestamp when the entry was last updated */
|
|
401
|
+
export type UpdatedOn = number;
|
|
402
|
+
/** Name of the user or entity */
|
|
403
|
+
export type Name = string;
|
|
404
|
+
/** Title of the certification process */
|
|
405
|
+
export type CertTitle = string;
|
|
406
|
+
/** User display name */
|
|
407
|
+
export type DisplayName = string;
|
|
408
|
+
/** ID of the submitted file */
|
|
409
|
+
export type FileID = string;
|
|
410
|
+
/** Name of the submitted file */
|
|
411
|
+
export type FileName = string;
|
|
412
|
+
/** Response schema for pending approvals */
|
|
413
|
+
export interface PendingApprovalResponseSchema {
|
|
414
|
+
paItems: {
|
|
415
|
+
/** User who created the pending approval entry */
|
|
416
|
+
createdBy: CreatedBy;
|
|
417
|
+
/** Timestamp when the pending approval was created */
|
|
418
|
+
createdOn: CreatedOn;
|
|
419
|
+
/** User who last updated the entry */
|
|
420
|
+
updatedBy?: UpdatedBy;
|
|
421
|
+
/** Timestamp when the entry was last updated */
|
|
422
|
+
updatedOn?: UpdatedOn;
|
|
423
|
+
/** Static identifier for the entity type */
|
|
424
|
+
dbEntity: DbEntity;
|
|
425
|
+
/** ID of the pending approval */
|
|
426
|
+
id: Id;
|
|
427
|
+
/** Type of pending approval */
|
|
428
|
+
type: Type;
|
|
429
|
+
/** User ID associated with the pending approval */
|
|
430
|
+
userID: UserID;
|
|
431
|
+
/** Name of the user or entity */
|
|
432
|
+
name?: Name;
|
|
433
|
+
/** Certification Process ID */
|
|
434
|
+
certProcID?: CertProcID;
|
|
435
|
+
/** Title of the certification process */
|
|
436
|
+
certTitle?: CertTitle;
|
|
437
|
+
/** Tenant ID */
|
|
438
|
+
tenantID: TenantID;
|
|
439
|
+
/** Course ID if applicable */
|
|
440
|
+
courseID?: CourseID;
|
|
441
|
+
/** User display name */
|
|
442
|
+
displayName?: DisplayName;
|
|
443
|
+
/** List of submitted files for approval */
|
|
444
|
+
submissionItems?: SubmissionItems & {
|
|
445
|
+
/** ID of the submitted file */
|
|
446
|
+
fileID?: FileID;
|
|
447
|
+
/** Name of the submitted file */
|
|
448
|
+
fileName?: FileName;
|
|
449
|
+
}[];
|
|
450
|
+
}[] | null;
|
|
451
|
+
}
|
|
452
|
+
export interface Input6Gwyovjhwz {
|
|
453
|
+
/**
|
|
454
|
+
* ID of the certification to filter applications by
|
|
455
|
+
* @example "certification123"
|
|
456
|
+
*/
|
|
457
|
+
certificationID: string;
|
|
458
|
+
/**
|
|
459
|
+
* Type of application, can be null or omitted
|
|
460
|
+
* @example "typeA"
|
|
461
|
+
*/
|
|
462
|
+
type?: string | null;
|
|
463
|
+
/**
|
|
464
|
+
* State of the application
|
|
465
|
+
* @example "submitted"
|
|
466
|
+
*/
|
|
467
|
+
state: string;
|
|
468
|
+
/**
|
|
469
|
+
* Timestamp for the start of the submission date range
|
|
470
|
+
* @example 1672531200
|
|
471
|
+
*/
|
|
472
|
+
submittedFrom?: number | null;
|
|
473
|
+
/**
|
|
474
|
+
* Timestamp for the end of the submission date range
|
|
475
|
+
* @example 1672617600
|
|
476
|
+
*/
|
|
477
|
+
submittedTo?: number | null;
|
|
478
|
+
/**
|
|
479
|
+
* Timestamp for the start of the review date range
|
|
480
|
+
* @example 1672704000
|
|
481
|
+
*/
|
|
482
|
+
reviewedFrom?: number | null;
|
|
483
|
+
/**
|
|
484
|
+
* Timestamp for the end of the review date range
|
|
485
|
+
* @example 1672790400
|
|
486
|
+
*/
|
|
487
|
+
reviewedTo?: number | null;
|
|
488
|
+
/**
|
|
489
|
+
* Timestamp for the start of the creation date range
|
|
490
|
+
* @example 1672876800
|
|
491
|
+
*/
|
|
492
|
+
createdFrom?: number | null;
|
|
493
|
+
/**
|
|
494
|
+
* Timestamp for the end of the creation date range
|
|
495
|
+
* @example 1672963200
|
|
496
|
+
*/
|
|
497
|
+
createdTo?: number | null;
|
|
498
|
+
/**
|
|
499
|
+
* User course status, can be null or omitted. Used to filter applications based on user course status.
|
|
500
|
+
* @example "completed"
|
|
501
|
+
*/
|
|
502
|
+
userCourseStatus?: string | null;
|
|
503
|
+
/**
|
|
504
|
+
* Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
|
|
505
|
+
* @example true
|
|
506
|
+
*/
|
|
507
|
+
ignoreCompletedCertifications?: boolean | null;
|
|
508
|
+
}
|
|
509
|
+
export interface Input36F4Tt4Jxa {
|
|
510
|
+
/**
|
|
511
|
+
* ID of the certification to filter applications by
|
|
512
|
+
* @example "certification123"
|
|
513
|
+
*/
|
|
514
|
+
certificationID: string;
|
|
515
|
+
/**
|
|
516
|
+
* Type of application, can be null or omitted
|
|
517
|
+
* @example "typeA"
|
|
518
|
+
*/
|
|
519
|
+
type?: string | null;
|
|
520
|
+
/**
|
|
521
|
+
* State of the application
|
|
522
|
+
* @example "submitted"
|
|
523
|
+
*/
|
|
524
|
+
state?: string | null;
|
|
525
|
+
/**
|
|
526
|
+
* Timestamp for the start of the submission date range
|
|
527
|
+
* @example 1672531200
|
|
528
|
+
*/
|
|
529
|
+
submittedFrom?: number | null;
|
|
530
|
+
/**
|
|
531
|
+
* Timestamp for the end of the submission date range
|
|
532
|
+
* @example 1672617600
|
|
533
|
+
*/
|
|
534
|
+
submittedTo?: number | null;
|
|
535
|
+
/**
|
|
536
|
+
* Timestamp for the start of the review date range
|
|
537
|
+
* @example 1672704000
|
|
538
|
+
*/
|
|
539
|
+
reviewedFrom?: number | null;
|
|
540
|
+
/**
|
|
541
|
+
* Timestamp for the end of the review date range
|
|
542
|
+
* @example 1672790400
|
|
543
|
+
*/
|
|
544
|
+
reviewedTo?: number | null;
|
|
545
|
+
/**
|
|
546
|
+
* Timestamp for the start of the creation date range
|
|
547
|
+
* @example 1672876800
|
|
548
|
+
*/
|
|
549
|
+
createdFrom?: number | null;
|
|
550
|
+
/**
|
|
551
|
+
* Timestamp for the end of the creation date range
|
|
552
|
+
* @example 1672963200
|
|
553
|
+
*/
|
|
554
|
+
createdTo?: number | null;
|
|
555
|
+
/**
|
|
556
|
+
* User course status, can be null or omitted. Used to filter applications based on user course status.
|
|
557
|
+
* @example "completed"
|
|
558
|
+
*/
|
|
559
|
+
userCourseStatus?: string | null;
|
|
560
|
+
/**
|
|
561
|
+
* Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
|
|
562
|
+
* @example true
|
|
563
|
+
*/
|
|
564
|
+
ignoreCompletedCertifications?: boolean | null;
|
|
565
|
+
}
|
|
566
|
+
export interface Input2Xewbjzunb {
|
|
567
|
+
/**
|
|
568
|
+
* ID of the certification to filter applications by
|
|
569
|
+
* @example "certification123"
|
|
570
|
+
*/
|
|
571
|
+
certificationID: string;
|
|
572
|
+
/**
|
|
573
|
+
* Type of application, can be null or omitted
|
|
574
|
+
* @example "typeA"
|
|
575
|
+
*/
|
|
576
|
+
type?: string | null;
|
|
577
|
+
/**
|
|
578
|
+
* State of the application
|
|
579
|
+
* @example "submitted"
|
|
580
|
+
*/
|
|
581
|
+
state: string;
|
|
582
|
+
/**
|
|
583
|
+
* Timestamp for the start of the submission date range
|
|
584
|
+
* @example 1672531200
|
|
585
|
+
*/
|
|
586
|
+
submittedFrom?: number | null;
|
|
587
|
+
/**
|
|
588
|
+
* Timestamp for the end of the submission date range
|
|
589
|
+
* @example 1672617600
|
|
590
|
+
*/
|
|
591
|
+
submittedTo?: number | null;
|
|
592
|
+
/**
|
|
593
|
+
* Timestamp for the start of the review date range
|
|
594
|
+
* @example 1672704000
|
|
595
|
+
*/
|
|
596
|
+
reviewedFrom?: number | null;
|
|
597
|
+
/**
|
|
598
|
+
* Timestamp for the end of the review date range
|
|
599
|
+
* @example 1672790400
|
|
600
|
+
*/
|
|
601
|
+
reviewedTo?: number | null;
|
|
602
|
+
/**
|
|
603
|
+
* Timestamp for the start of the creation date range
|
|
604
|
+
* @example 1672876800
|
|
605
|
+
*/
|
|
606
|
+
createdFrom?: number | null;
|
|
607
|
+
/**
|
|
608
|
+
* Timestamp for the end of the creation date range
|
|
609
|
+
* @example 1672963200
|
|
610
|
+
*/
|
|
611
|
+
createdTo?: number | null;
|
|
612
|
+
/**
|
|
613
|
+
* User course status, can be null or omitted. Used to filter applications based on user course status.
|
|
614
|
+
* @example "completed"
|
|
615
|
+
*/
|
|
616
|
+
userCourseStatus?: string | null;
|
|
617
|
+
/**
|
|
618
|
+
* Flag to ignore completed certifications when filtering applications. Defaults to false if not provided.
|
|
619
|
+
* @example true
|
|
620
|
+
*/
|
|
621
|
+
ignoreCompletedCertifications?: boolean | null;
|
|
622
|
+
}
|
|
623
|
+
export interface InputV3Qfis9943 {
|
|
624
|
+
/**
|
|
625
|
+
* The ID of the certificate specifications to be used for the email
|
|
626
|
+
* @example "certSpecsID123"
|
|
627
|
+
*/
|
|
628
|
+
certSpecsID: string;
|
|
629
|
+
/**
|
|
630
|
+
* The ID of the course associated with the certificate
|
|
631
|
+
* @example "courseID456"
|
|
632
|
+
*/
|
|
633
|
+
courseID: string;
|
|
634
|
+
/**
|
|
635
|
+
* Whether to CC administrators in the email
|
|
636
|
+
* @example true
|
|
637
|
+
*/
|
|
638
|
+
ccAdmins?: boolean;
|
|
639
|
+
/** List of recipients who will receive the certificate email */
|
|
640
|
+
recipients: {
|
|
641
|
+
/**
|
|
642
|
+
* Full name of the recipient
|
|
643
|
+
* @example "Jane Doe"
|
|
644
|
+
*/
|
|
645
|
+
name: string;
|
|
646
|
+
/**
|
|
647
|
+
* The date the recipient completed the course (format: yyyy-mm-dd)
|
|
648
|
+
* @example "2025-06-01"
|
|
649
|
+
*/
|
|
650
|
+
completionDate: string;
|
|
651
|
+
/**
|
|
652
|
+
* The certificate number assigned to the recipient
|
|
653
|
+
* @example "CERT-0001"
|
|
654
|
+
*/
|
|
655
|
+
certNum: string;
|
|
656
|
+
/**
|
|
657
|
+
* Email address of the recipient
|
|
658
|
+
* @format email
|
|
659
|
+
* @example "jane.doe@example.com"
|
|
660
|
+
*/
|
|
661
|
+
emailAddress: string;
|
|
662
|
+
}[];
|
|
663
|
+
}
|
|
664
|
+
export interface InputLjapkp800K {
|
|
665
|
+
/**
|
|
666
|
+
* The ID of the product for which the license is being redeemed
|
|
667
|
+
* @example "productID123"
|
|
668
|
+
*/
|
|
669
|
+
productID: string;
|
|
670
|
+
/**
|
|
671
|
+
* The ID of the session associated with the license redemption
|
|
672
|
+
* @example "sessionID456"
|
|
673
|
+
*/
|
|
674
|
+
sessionID?: string;
|
|
675
|
+
}
|
|
676
|
+
export interface InputCsz2Jddceqg {
|
|
677
|
+
/**
|
|
678
|
+
* Search term to filter licenses
|
|
679
|
+
* @example "active"
|
|
680
|
+
*/
|
|
681
|
+
searchTerm?: string;
|
|
682
|
+
/**
|
|
683
|
+
* Order of sorting, e.g., "asc" or "desc"
|
|
684
|
+
* @example "asc"
|
|
685
|
+
*/
|
|
686
|
+
sortOrder?: any;
|
|
687
|
+
/**
|
|
688
|
+
* Field by which to sort the report
|
|
689
|
+
* @example "created_at"
|
|
690
|
+
*/
|
|
691
|
+
sortField?: any;
|
|
692
|
+
}
|
|
693
|
+
export interface Input9Hqlmphca8 {
|
|
694
|
+
/**
|
|
695
|
+
* Search term to filter licenses
|
|
696
|
+
* @example "active"
|
|
697
|
+
*/
|
|
698
|
+
searchTerm?: string;
|
|
699
|
+
/**
|
|
700
|
+
* Start date for the report
|
|
701
|
+
* @example "2023-01-01T00:00:00Z"
|
|
702
|
+
*/
|
|
703
|
+
from?: any;
|
|
704
|
+
/**
|
|
705
|
+
* Order of sorting, e.g., "asc" or "desc"
|
|
706
|
+
* @example "asc"
|
|
707
|
+
*/
|
|
708
|
+
sortOrder?: any;
|
|
709
|
+
/**
|
|
710
|
+
* Field by which to sort the report
|
|
711
|
+
* @example "created_at"
|
|
712
|
+
*/
|
|
713
|
+
sortField?: any;
|
|
714
|
+
}
|
|
715
|
+
/** Filters offered for NCSO export report */
|
|
716
|
+
export interface NcsoReportRequestSchema {
|
|
717
|
+
filters: {
|
|
718
|
+
originalCompletionDateFrom?: number;
|
|
719
|
+
originalCompletionDateTo?: number;
|
|
720
|
+
completionDateFrom?: number;
|
|
721
|
+
completionDateTo?: number;
|
|
722
|
+
expiryDateFrom?: number;
|
|
723
|
+
expiryDateTo?: number;
|
|
724
|
+
hideExpired?: boolean;
|
|
725
|
+
};
|
|
726
|
+
}
|
|
727
|
+
/** Filters offered for NCSO export report */
|
|
728
|
+
export interface NcsoReportExportRequestSchema {
|
|
729
|
+
certifications: {
|
|
730
|
+
name: string;
|
|
731
|
+
email?: string;
|
|
732
|
+
city?: string;
|
|
733
|
+
phone?: string;
|
|
734
|
+
originalCompletionDate?: number;
|
|
735
|
+
completionDate?: number;
|
|
736
|
+
expiryDate?: number;
|
|
737
|
+
status?: string;
|
|
738
|
+
hasOtherCertifications?: boolean;
|
|
739
|
+
notes?: string;
|
|
740
|
+
listedOnWebsite?: boolean;
|
|
741
|
+
}[];
|
|
742
|
+
}
|
|
743
|
+
/** Report export as xlsx */
|
|
744
|
+
export interface ReportXLSXSchema {
|
|
745
|
+
xlsxStream: any;
|
|
746
|
+
contentType: ReportXlsxSchemaContentTypeEnum;
|
|
747
|
+
}
|
|
748
|
+
export interface Input80Fhicjw8R {
|
|
749
|
+
/**
|
|
750
|
+
* Start date for the report
|
|
751
|
+
* @example "2023-01-01T00:00:00Z"
|
|
752
|
+
*/
|
|
753
|
+
from?: any;
|
|
754
|
+
/**
|
|
755
|
+
* End date for the report
|
|
756
|
+
* @example "2023-12-31T23:59:59Z"
|
|
757
|
+
*/
|
|
758
|
+
to?: any;
|
|
759
|
+
/**
|
|
760
|
+
* List of columns to include in the report
|
|
761
|
+
* @example ["name","email","created_at"]
|
|
762
|
+
*/
|
|
763
|
+
columns: string[];
|
|
764
|
+
/**
|
|
765
|
+
* Type of date to filter by, e.g., "created_at", "updated_at"
|
|
766
|
+
* @example "created_at"
|
|
767
|
+
*/
|
|
768
|
+
dateType?: string;
|
|
769
|
+
}
|
|
770
|
+
export interface InputUgivd08Qxw {
|
|
771
|
+
/** List of user IDs to search for in the tenant. */
|
|
772
|
+
IDs: (string | null)[];
|
|
773
|
+
}
|
|
774
|
+
export interface InputJx8Xphf53G {
|
|
775
|
+
/** The term to search for in the user profiles. */
|
|
776
|
+
searchTerm?: string | null;
|
|
777
|
+
/** Filter criteria for the user search. */
|
|
778
|
+
filter: {
|
|
779
|
+
/** Quantifier for advanced search, used when searchTerm is ignored. */
|
|
780
|
+
quantifier?: string;
|
|
781
|
+
advancedFilters?: {
|
|
782
|
+
field?: string;
|
|
783
|
+
qualifier?: string;
|
|
784
|
+
value?: string | string[];
|
|
785
|
+
}[];
|
|
786
|
+
status?: string | null;
|
|
787
|
+
from?: number | null;
|
|
788
|
+
sortOrder?: string | null;
|
|
789
|
+
sortField?: string | null;
|
|
790
|
+
courseSpecsID?: string | string[];
|
|
791
|
+
registerDate1?: string | null;
|
|
792
|
+
registerDate2?: string | null;
|
|
793
|
+
certSpecsID?: string | string[];
|
|
794
|
+
signinDate1?: string | null;
|
|
795
|
+
signinDate2?: string | null;
|
|
796
|
+
organization?: string | null;
|
|
797
|
+
employerID?: string | null;
|
|
798
|
+
certExpDate1?: string | null;
|
|
799
|
+
certExpDate2?: string | null;
|
|
800
|
+
userCourseStatus?: string | null;
|
|
801
|
+
applicationFilters?: {
|
|
802
|
+
createdDate1?: number | null;
|
|
803
|
+
createdDate2?: number | null;
|
|
804
|
+
submittedDate1?: number | null;
|
|
805
|
+
submittedDate2?: number | null;
|
|
806
|
+
reviewedDate1?: number | null;
|
|
807
|
+
reviewedDate2?: number | null;
|
|
808
|
+
status?: string | null;
|
|
809
|
+
type?: string | null;
|
|
810
|
+
ignoreCompletedCertifications?: boolean;
|
|
811
|
+
};
|
|
812
|
+
};
|
|
813
|
+
}
|
|
814
|
+
export interface InputVyjyqo4Fqig {
|
|
815
|
+
/** The term to search for in the user profiles. */
|
|
816
|
+
searchTerm?: string | null;
|
|
817
|
+
/** Filter criteria for the user search. */
|
|
818
|
+
filter: {
|
|
819
|
+
/** Quantifier for advanced search, used when searchTerm is ignored. */
|
|
820
|
+
quantifier?: string;
|
|
821
|
+
advancedFilters?: {
|
|
822
|
+
field?: string;
|
|
823
|
+
qualifier?: string;
|
|
824
|
+
value?: string | string[];
|
|
825
|
+
}[];
|
|
826
|
+
status?: string | null;
|
|
827
|
+
from?: number | null;
|
|
828
|
+
sortOrder?: string | null;
|
|
829
|
+
sortField?: string | null;
|
|
830
|
+
courseSpecsID?: string | string[];
|
|
831
|
+
registerDate1?: string | null;
|
|
832
|
+
registerDate2?: string | null;
|
|
833
|
+
certSpecsID?: string | string[];
|
|
834
|
+
signinDate1?: string | null;
|
|
835
|
+
signinDate2?: string | null;
|
|
836
|
+
organization?: string | null;
|
|
837
|
+
employerID?: string | null;
|
|
838
|
+
certExpDate1?: string | null;
|
|
839
|
+
certExpDate2?: string | null;
|
|
840
|
+
userCourseStatus?: string | null;
|
|
841
|
+
applicationFilters?: {
|
|
842
|
+
createdDate1?: number | null;
|
|
843
|
+
createdDate2?: number | null;
|
|
844
|
+
submittedDate1?: number | null;
|
|
845
|
+
submittedDate2?: number | null;
|
|
846
|
+
reviewedDate1?: number | null;
|
|
847
|
+
reviewedDate2?: number | null;
|
|
848
|
+
status?: string | null;
|
|
849
|
+
type?: string | null;
|
|
850
|
+
ignoreCompletedCertifications?: boolean;
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
}
|
|
854
|
+
/** External system ID 2 */
|
|
855
|
+
export type ExternalID2 = number;
|
|
856
|
+
export interface Output2Ap8L2U1E4 {
|
|
857
|
+
/** External system ID 2 */
|
|
858
|
+
userCount: ExternalID2;
|
|
859
|
+
transactionID?: string | null;
|
|
860
|
+
}
|
|
861
|
+
export interface Output1Oh09Nkr3Mj {
|
|
862
|
+
/**
|
|
863
|
+
* Signed URL for the course file
|
|
864
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
865
|
+
*/
|
|
866
|
+
fileURL: string;
|
|
867
|
+
}
|
|
868
|
+
export interface OutputU7Gnd99Lsg {
|
|
869
|
+
/**
|
|
870
|
+
* Amount to be refunded for the cancellation
|
|
871
|
+
* @example 0
|
|
872
|
+
*/
|
|
873
|
+
refundAmount: number;
|
|
874
|
+
/**
|
|
875
|
+
* Shipping charges applicable for the cancellation
|
|
876
|
+
* @example 0
|
|
877
|
+
*/
|
|
878
|
+
shippingCharges: number;
|
|
879
|
+
/**
|
|
880
|
+
* Total value paid for the course
|
|
881
|
+
* @example 0
|
|
882
|
+
*/
|
|
883
|
+
valuePaid: number;
|
|
884
|
+
/**
|
|
885
|
+
* Price of the product associated with the course
|
|
886
|
+
* @example 0
|
|
887
|
+
*/
|
|
888
|
+
productPrice: number;
|
|
889
|
+
/**
|
|
890
|
+
* Charge applied for the cancellation
|
|
891
|
+
* @example 0
|
|
892
|
+
*/
|
|
893
|
+
cancelationCharge: number;
|
|
894
|
+
/**
|
|
895
|
+
* Taxes applicable on the cancellation
|
|
896
|
+
* @example 0
|
|
897
|
+
*/
|
|
898
|
+
taxes: number;
|
|
899
|
+
/**
|
|
900
|
+
* ID of the original order, if applicable
|
|
901
|
+
* @example null
|
|
902
|
+
*/
|
|
903
|
+
originalOrderID: string | null;
|
|
904
|
+
/**
|
|
905
|
+
* Transaction ID for the cancellation process
|
|
906
|
+
* @example "cmbtgpcd800240byldq29bqt0-cmbtgpcd800250bylby45corg"
|
|
907
|
+
*/
|
|
908
|
+
transactionID: string;
|
|
909
|
+
}
|
|
910
|
+
/** Timestamp when the application will be auto-unlocked */
|
|
911
|
+
export type AutoUnlockOn = number;
|
|
912
|
+
/** Certification number issued to the user */
|
|
913
|
+
export type CertNumber = string;
|
|
914
|
+
/** Original date of completion */
|
|
915
|
+
export type OriginalCompletionDate = number;
|
|
916
|
+
/** Date when the card was printed */
|
|
917
|
+
export type CardPrintedOn = number;
|
|
918
|
+
/** Completion date of the last related course */
|
|
919
|
+
export type LastCourseCompletionDate = number;
|
|
920
|
+
/** Date when manual override was applied */
|
|
921
|
+
export type ManualOverrideOn = number;
|
|
922
|
+
/** Stage of the certification process */
|
|
923
|
+
export type Stage = string;
|
|
924
|
+
/** Last state of the course within this stage */
|
|
925
|
+
export type StageLastCourseState = string;
|
|
926
|
+
/** Points achieved in the process */
|
|
927
|
+
export type PointsAchieved = number;
|
|
928
|
+
/** Pending payment value */
|
|
929
|
+
export type PendingPaymentValue = number;
|
|
930
|
+
/** Courses that are currently blocked */
|
|
931
|
+
export type BlockedCourses = string[];
|
|
932
|
+
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
933
|
+
export type TriggerState = Record<string, {
|
|
934
|
+
state?: string;
|
|
935
|
+
updatedOn?: number;
|
|
936
|
+
requestResult?: string;
|
|
937
|
+
}>;
|
|
938
|
+
/** Amount to be paid as commission */
|
|
939
|
+
export type CommissionAmount = number;
|
|
940
|
+
/** Recipient of the commission payment */
|
|
941
|
+
export type CommissionPayTo = string;
|
|
942
|
+
/** Amount of commission already paid */
|
|
943
|
+
export type CommissionPaid = number;
|
|
944
|
+
/** Comments related to the waiver */
|
|
945
|
+
export type WaivedComments = string;
|
|
946
|
+
/** Response with list of certification processes */
|
|
947
|
+
export interface CertificationProcessResponseSchema {
|
|
948
|
+
procs: {
|
|
949
|
+
/** Unique identifier for the certification process */
|
|
950
|
+
id: Id;
|
|
951
|
+
/** Tenant ID associated with this certification process */
|
|
952
|
+
tenantID: TenantID;
|
|
953
|
+
/** User ID associated with this certification process */
|
|
954
|
+
userID: UserID;
|
|
955
|
+
/** ID of the certification being processed */
|
|
956
|
+
certificationID: CertificationID;
|
|
957
|
+
/** Timestamp of when the record was created */
|
|
958
|
+
createdOn?: CreatedOn;
|
|
959
|
+
/** User who created the record */
|
|
960
|
+
createdBy?: CreatedBy;
|
|
961
|
+
/** Timestamp of last update */
|
|
962
|
+
updatedOn?: UpdatedOn;
|
|
963
|
+
/** User who last updated the record */
|
|
964
|
+
updatedBy?: UpdatedBy;
|
|
965
|
+
/** Internal database entity identifier */
|
|
966
|
+
dbEntity?: DbEntity;
|
|
967
|
+
/** Timestamp when the application will be auto-unlocked */
|
|
968
|
+
autoUnlockOn?: AutoUnlockOn;
|
|
969
|
+
/** Certification number issued to the user */
|
|
970
|
+
certNumber?: CertNumber;
|
|
971
|
+
/** Date of certification completion */
|
|
972
|
+
completionDate?: CompletionDate;
|
|
973
|
+
/** Original date of completion */
|
|
974
|
+
originalCompletionDate?: OriginalCompletionDate;
|
|
975
|
+
/** Date when the card was printed */
|
|
976
|
+
cardPrintedOn?: CardPrintedOn;
|
|
977
|
+
/** Date when the certificate was printed */
|
|
978
|
+
certificatePrintedOn?: CertificatePrintedOn;
|
|
979
|
+
/** Shipping date of the certificate/card */
|
|
980
|
+
shippingDate?: ShippingDate;
|
|
981
|
+
/** Completion date of the last related course */
|
|
982
|
+
lastCourseCompletionDate?: LastCourseCompletionDate;
|
|
983
|
+
/** Expiration date of the certification */
|
|
984
|
+
expiryDate?: ExpiryDate;
|
|
985
|
+
/** Date when manual override was applied */
|
|
986
|
+
manualOverrideOn?: ManualOverrideOn;
|
|
987
|
+
/** State of the certification process */
|
|
988
|
+
state?: State;
|
|
989
|
+
/** Stage of the certification process */
|
|
990
|
+
stage?: Stage;
|
|
991
|
+
/** Last state of the course within this stage */
|
|
992
|
+
stageLastCourseState?: StageLastCourseState;
|
|
993
|
+
/** Points achieved in the process */
|
|
994
|
+
pointsAchieved?: PointsAchieved;
|
|
995
|
+
/** Pending payment value */
|
|
996
|
+
pendingPaymentValue?: PendingPaymentValue;
|
|
997
|
+
/** Courses that are currently blocked */
|
|
998
|
+
blockedCourses?: BlockedCourses;
|
|
999
|
+
/** List of reminder IDs sent before expiry */
|
|
1000
|
+
expireReminders?: ExpireReminders;
|
|
1001
|
+
/** Status information for trigger states (e.g., NEW, RENEW) */
|
|
1002
|
+
triggerState?: TriggerState;
|
|
1003
|
+
/** Amount to be paid as commission */
|
|
1004
|
+
commissionAmount?: CommissionAmount;
|
|
1005
|
+
/** Recipient of the commission payment */
|
|
1006
|
+
commissionPayTo?: CommissionPayTo;
|
|
1007
|
+
/** Amount of commission already paid */
|
|
1008
|
+
commissionPaid?: CommissionPaid;
|
|
1009
|
+
/** User who waived the certification */
|
|
1010
|
+
waivedBy?: WaivedBy;
|
|
1011
|
+
/** Date when the waiver occurred */
|
|
1012
|
+
waivedOn?: WaivedOn;
|
|
1013
|
+
/** Comments related to the waiver */
|
|
1014
|
+
waivedComments?: WaivedComments;
|
|
1015
|
+
/** Justification text for overwritten actions */
|
|
1016
|
+
overwrittenJustification?: OverwrittenJustification & string;
|
|
1017
|
+
}[] | null;
|
|
1018
|
+
transactionID?: string | null;
|
|
1019
|
+
}
|
|
1020
|
+
/** Response schema for certification application data */
|
|
1021
|
+
export interface CertificationApplicationResponseEntity {
|
|
1022
|
+
/** @example 1717230000000 */
|
|
1023
|
+
createdOn?: number;
|
|
1024
|
+
/** @example "USR#abc" */
|
|
1025
|
+
createdBy?: string;
|
|
1026
|
+
/** @example "USR#xyz" */
|
|
1027
|
+
updatedBy?: string;
|
|
1028
|
+
/** @example 1717230000000 */
|
|
1029
|
+
updatedOn?: number;
|
|
1030
|
+
/** @example "prgCertificationApplication" */
|
|
1031
|
+
dbEntity?: string;
|
|
1032
|
+
/** @example "CUST#123" */
|
|
1033
|
+
customerID: string;
|
|
1034
|
+
/** @example "TEN#456" */
|
|
1035
|
+
tenantID: string;
|
|
1036
|
+
/** @example "USR#789" */
|
|
1037
|
+
userID: string;
|
|
1038
|
+
/** @example "CP#0001" */
|
|
1039
|
+
certProcID: string;
|
|
1040
|
+
/** @example "CERT#01" */
|
|
1041
|
+
certificationID?: string;
|
|
1042
|
+
/** @example "initial" */
|
|
1043
|
+
type: string;
|
|
1044
|
+
/** @example "LIC#999" */
|
|
1045
|
+
licenseID?: string;
|
|
1046
|
+
/** @example "LICINV#555" */
|
|
1047
|
+
licenseInvalidateID?: string;
|
|
1048
|
+
/** @example "submitted" */
|
|
1049
|
+
state?: string;
|
|
1050
|
+
/** @example 1717231111111 */
|
|
1051
|
+
submittedOn?: number;
|
|
1052
|
+
/** @example "USR#sub" */
|
|
1053
|
+
submittedBy?: string;
|
|
1054
|
+
/** @example "USR#rev" */
|
|
1055
|
+
reviewedBy?: string;
|
|
1056
|
+
/** @example 1717232222222 */
|
|
1057
|
+
reviewedOn?: number;
|
|
1058
|
+
/** @example "Everything looks good." */
|
|
1059
|
+
reviewNotes?: string;
|
|
1060
|
+
/** @example 1 */
|
|
1061
|
+
reviewAcknowledge?: number;
|
|
1062
|
+
/** @example [{"id":"ITEM#1","version":1,"type":"doc"}] */
|
|
1063
|
+
submissionItems?: {
|
|
1064
|
+
/** @example "ITEM#1" */
|
|
1065
|
+
id?: string;
|
|
1066
|
+
/** @example 1 */
|
|
1067
|
+
version?: number;
|
|
1068
|
+
/** @example "doc" */
|
|
1069
|
+
type?: string;
|
|
1070
|
+
}[];
|
|
1071
|
+
/** @example ["ITEM#2"] */
|
|
1072
|
+
blacklistedItems?: string[];
|
|
1073
|
+
}
|
|
1074
|
+
/** Label of the course enrolled (course version) */
|
|
1075
|
+
export type OnlineCourseLabel = string;
|
|
1076
|
+
/** Single course object */
|
|
1077
|
+
export interface CourseResponseEntity {
|
|
1078
|
+
/** Timestamp of when the record was created */
|
|
1079
|
+
createdOn?: CreatedOn;
|
|
1080
|
+
/** User who created the record */
|
|
1081
|
+
createdBy?: CreatedBy;
|
|
1082
|
+
/** User who last updated the record */
|
|
1083
|
+
updatedBy?: UpdatedBy;
|
|
1084
|
+
/** Timestamp of last update */
|
|
1085
|
+
updateOn?: UpdateOn;
|
|
1086
|
+
/** Entity identifier for Course */
|
|
1087
|
+
dbEntity?: DbEntity;
|
|
1088
|
+
/** Unique identifier of the course record */
|
|
1089
|
+
id: Id;
|
|
1090
|
+
/** Certification process ID linked to this course */
|
|
1091
|
+
certProcID: CertProcID;
|
|
1092
|
+
/** User ID associated with the course */
|
|
1093
|
+
userID: UserID;
|
|
1094
|
+
/** Customer ID associated with the course */
|
|
1095
|
+
customerID: CustomerID;
|
|
1096
|
+
/** Tenant ID associated with the course */
|
|
1097
|
+
tenantID: TenantID;
|
|
1098
|
+
/** Course ID reference */
|
|
1099
|
+
courseID?: CourseID;
|
|
1100
|
+
/** When cooldown started */
|
|
1101
|
+
cooldownStartedOn?: CooldownStartedOn;
|
|
1102
|
+
/** When cooldown was overwritten */
|
|
1103
|
+
cooldownOverwrittenOn?: CooldownOverwrittenOn;
|
|
1104
|
+
/** When course was locked */
|
|
1105
|
+
courseLockedOn?: CourseLockedOn;
|
|
1106
|
+
/** When course lock was overwritten */
|
|
1107
|
+
courseLockOverwrittenOn?: CourseLockOverwrittenOn;
|
|
1108
|
+
/** Voucher code for the license */
|
|
1109
|
+
licenseVoucherCode?: LicenseVoucherCode;
|
|
1110
|
+
/** License ID used in the course */
|
|
1111
|
+
licenseID?: LicenseID;
|
|
1112
|
+
/** ID for license invalidation */
|
|
1113
|
+
licenseInvalidateID?: LicenseInvalidateID;
|
|
1114
|
+
/** Session ticket ID for course access */
|
|
1115
|
+
sessionTicketID?: SessionTicketID;
|
|
1116
|
+
/** Session ID for course tracking */
|
|
1117
|
+
sessionID?: SessionID;
|
|
1118
|
+
/** Result of the course */
|
|
1119
|
+
courseResult?: CourseResult;
|
|
1120
|
+
/** Certificate number for the course */
|
|
1121
|
+
courseCertNumber?: CourseCertNumber;
|
|
1122
|
+
/** Date of course completion */
|
|
1123
|
+
completionDate?: CompletionDate;
|
|
1124
|
+
/** Date when certificate was printed */
|
|
1125
|
+
certificatePrintedOn?: CertificatePrintedOn;
|
|
1126
|
+
/** Date when card was printed */
|
|
1127
|
+
cardPrintedOnDate?: CardPrintedOnDate;
|
|
1128
|
+
/** Date of certificate/card shipping */
|
|
1129
|
+
shippingDate?: ShippingDate;
|
|
1130
|
+
/** Whether data is copied from an alternate certification process */
|
|
1131
|
+
isCopiedFromAlternateCP?: IsCopiedFromAlternateCP;
|
|
1132
|
+
/** Reminders sent before course expiry */
|
|
1133
|
+
expireReminders?: ExpireReminders;
|
|
1134
|
+
/** Expiration date of the course */
|
|
1135
|
+
expiryDate?: ExpiryDate;
|
|
1136
|
+
/** Key used for indexing expiryDate */
|
|
1137
|
+
expiryDateKey?: ExpiryDateKey;
|
|
1138
|
+
/** Whether the course has been invalidated */
|
|
1139
|
+
invalidated?: Invalidated;
|
|
1140
|
+
/** Whether a course retake has been requested */
|
|
1141
|
+
retakeRequested?: RetakeRequested;
|
|
1142
|
+
/** Current state of the course */
|
|
1143
|
+
state?: State;
|
|
1144
|
+
/** Approval state of the course */
|
|
1145
|
+
approvalState?: ApprovalState;
|
|
1146
|
+
/** Notes about the course approval process */
|
|
1147
|
+
approvalNotes?: ApprovalNotes;
|
|
1148
|
+
/** List of submitted files for the course */
|
|
1149
|
+
submissionItems?: SubmissionItems;
|
|
1150
|
+
/** User who waived the course requirement */
|
|
1151
|
+
waivedBy?: WaivedBy;
|
|
1152
|
+
/** Date when course was waived */
|
|
1153
|
+
waivedOn?: WaivedOn;
|
|
1154
|
+
/** Label of the course enrolled (course version) */
|
|
1155
|
+
onlineCourseLabel?: OnlineCourseLabel;
|
|
1156
|
+
/** Justifications for overridden course restrictions */
|
|
1157
|
+
overwrittenJustification?: OverwrittenJustification;
|
|
1158
|
+
}
|
|
1159
|
+
export interface OutputKk5Ahwsca2 {
|
|
1160
|
+
/**
|
|
1161
|
+
* Signed URL for the course file
|
|
1162
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1163
|
+
*/
|
|
1164
|
+
fileURL: string;
|
|
1165
|
+
}
|
|
1166
|
+
/** Response with list of expanded certification processeses */
|
|
1167
|
+
export interface UserExpandedCPResponseSchema {
|
|
1168
|
+
procs?: {
|
|
1169
|
+
user?: Record<string, any>;
|
|
1170
|
+
courses?: Record<string, any>[];
|
|
1171
|
+
certificationProcesses?: Record<string, any>[];
|
|
1172
|
+
applications?: Record<string, any>[];
|
|
1173
|
+
};
|
|
1174
|
+
transactionID?: string | null;
|
|
1175
|
+
}
|
|
1176
|
+
/** Application Foreign Fill response type */
|
|
1177
|
+
export interface OutputYh2G6Inklt {
|
|
1178
|
+
items: {
|
|
1179
|
+
userID: string;
|
|
1180
|
+
createdOn?: number;
|
|
1181
|
+
createdBy?: string;
|
|
1182
|
+
updatedBy?: string;
|
|
1183
|
+
updatedOn?: number;
|
|
1184
|
+
dbEntity?: string;
|
|
1185
|
+
tenantID: string;
|
|
1186
|
+
compositeID: string;
|
|
1187
|
+
timestamp: number;
|
|
1188
|
+
sourceID: string;
|
|
1189
|
+
expiresOn?: number;
|
|
1190
|
+
resultDate?: number;
|
|
1191
|
+
isHistoric?: boolean;
|
|
1192
|
+
type?: string;
|
|
1193
|
+
procID?: string;
|
|
1194
|
+
sourceType?: string;
|
|
1195
|
+
issuedOn?: number;
|
|
1196
|
+
approvedBy?: string;
|
|
1197
|
+
rejectedBy?: string;
|
|
1198
|
+
reviewedOn?: number;
|
|
1199
|
+
additionalNotes?: string;
|
|
1200
|
+
fileItems?: {
|
|
1201
|
+
fileID: string;
|
|
1202
|
+
fileName: string;
|
|
1203
|
+
}[];
|
|
1204
|
+
}[];
|
|
1205
|
+
}
|
|
1206
|
+
/** Composite ID (could be a derived or synthetic key) */
|
|
1207
|
+
export type CompositeID = string;
|
|
1208
|
+
/** Certification process ID */
|
|
1209
|
+
export type ProcID = string;
|
|
1210
|
+
/** Effective timestamp of this record (e.g., event time) */
|
|
1211
|
+
export type Timestamp = number;
|
|
1212
|
+
/** Source object ID (e.g., course, cert) */
|
|
1213
|
+
export type SourceID = string;
|
|
1214
|
+
/** Type of the source (e.g., COURSE or CERT) */
|
|
1215
|
+
export type SourceType = string;
|
|
1216
|
+
/** Expiration date of this entry, if applicable */
|
|
1217
|
+
export type ExpiresOn = number;
|
|
1218
|
+
/** Date when the result was achieved (e.g., passed) */
|
|
1219
|
+
export type ResultDate = number;
|
|
1220
|
+
/** Response containing student history records */
|
|
1221
|
+
export interface StudentHistoryResponseSchema {
|
|
1222
|
+
items: {
|
|
1223
|
+
/** ID of the user who created this record */
|
|
1224
|
+
createdBy?: CreatedBy;
|
|
1225
|
+
/** Timestamp when this record was created */
|
|
1226
|
+
createdOn?: CreatedOn;
|
|
1227
|
+
/** ID of the user who last updated this record */
|
|
1228
|
+
updatedBy?: UpdatedBy;
|
|
1229
|
+
/** Timestamp of the last update */
|
|
1230
|
+
updateOn?: UpdateOn;
|
|
1231
|
+
/** Fixed database entity identifier */
|
|
1232
|
+
dbEntity?: DbEntity;
|
|
1233
|
+
/** Composite ID (could be a derived or synthetic key) */
|
|
1234
|
+
compositeID: CompositeID;
|
|
1235
|
+
/** ID of the user associated with this history entry */
|
|
1236
|
+
userID: UserID;
|
|
1237
|
+
/** Certification process ID */
|
|
1238
|
+
procID: ProcID;
|
|
1239
|
+
/** Effective timestamp of this record (e.g., event time) */
|
|
1240
|
+
timestamp: Timestamp;
|
|
1241
|
+
/** Tenant that owns this record */
|
|
1242
|
+
tenantID: TenantID;
|
|
1243
|
+
/** Source object ID (e.g., course, cert) */
|
|
1244
|
+
sourceID: SourceID;
|
|
1245
|
+
/** Type of the source (e.g., COURSE or CERT) */
|
|
1246
|
+
sourceType: SourceType;
|
|
1247
|
+
/** Expiration date of this entry, if applicable */
|
|
1248
|
+
expiresOn?: ExpiresOn;
|
|
1249
|
+
/** The type/category of the student history record */
|
|
1250
|
+
type: Type;
|
|
1251
|
+
/** Date when the result was achieved (e.g., passed) */
|
|
1252
|
+
resultDate?: ResultDate;
|
|
1253
|
+
}[];
|
|
1254
|
+
transactionID?: string | null;
|
|
1255
|
+
}
|
|
1256
|
+
/** Response with list of user certification processes and it's upcoming courses and sessions */
|
|
1257
|
+
export interface UserUpcomingCoursesResponseSchema {
|
|
1258
|
+
procs?: {
|
|
1259
|
+
user?: Record<string, any>;
|
|
1260
|
+
courses?: Record<string, any>[];
|
|
1261
|
+
certificationProcesses?: Record<string, any>[];
|
|
1262
|
+
sessions?: Record<string, any>[];
|
|
1263
|
+
};
|
|
1264
|
+
transactionID?: string | null;
|
|
1265
|
+
}
|
|
1266
|
+
/** Timestamp when user agreed to terms */
|
|
1267
|
+
export type AgreedOnTerms = number;
|
|
1268
|
+
/** Whether user agreed with certification terms */
|
|
1269
|
+
export type AgreedWithCertTerms = boolean;
|
|
1270
|
+
/** Map of member numbers keyed by string */
|
|
1271
|
+
export type MemberNumber = Record<string, string>;
|
|
1272
|
+
/** Name to appear on certificate */
|
|
1273
|
+
export type CertNameOnCertificate = string;
|
|
1274
|
+
/** Map of certification dates keyed by string */
|
|
1275
|
+
export type CertificationDate = Record<string, number>;
|
|
1276
|
+
/** Map of original certification dates keyed by string */
|
|
1277
|
+
export type CertificationOriginalDate = Record<string, number>;
|
|
1278
|
+
/** Map of certification expiration dates keyed by string */
|
|
1279
|
+
export type CertificationExpirationDate = Record<string, number>;
|
|
1280
|
+
/** Name of the company associated with the user */
|
|
1281
|
+
export type CompanyName = string;
|
|
1282
|
+
/** User email address */
|
|
1283
|
+
export type Email = string;
|
|
1284
|
+
/** Email address used to send emails on behalf of user */
|
|
1285
|
+
export type SendEmailAs = string;
|
|
1286
|
+
/** User first name */
|
|
1287
|
+
export type FirstName = string;
|
|
1288
|
+
/** User last name */
|
|
1289
|
+
export type LastName = string;
|
|
1290
|
+
/** Employer ID associated with the user */
|
|
1291
|
+
export type EmployerID = string;
|
|
1292
|
+
/** User phone number */
|
|
1293
|
+
export type PhoneNumber = string;
|
|
1294
|
+
/** ITA number of the user */
|
|
1295
|
+
export type ItaNumber = string;
|
|
1296
|
+
/** Whether user should receive gifts */
|
|
1297
|
+
export type SendGift = boolean;
|
|
1298
|
+
/** Preferred language of the user */
|
|
1299
|
+
export type PreferredLanguage = string;
|
|
1300
|
+
/** ID of the user who referred this user */
|
|
1301
|
+
export type ReferredByID = string;
|
|
1302
|
+
/** Name of the user who referred this user */
|
|
1303
|
+
export type ReferredByName = string;
|
|
1304
|
+
/** Timestamp of last signin */
|
|
1305
|
+
export type SigninDate = number;
|
|
1306
|
+
/** List of IDs of entities the user manages */
|
|
1307
|
+
export type ManagerOf = string[];
|
|
1308
|
+
/** List of IDs of entities the user is member of */
|
|
1309
|
+
export type MemberOf = string[];
|
|
1310
|
+
/** List of pending invitation IDs */
|
|
1311
|
+
export type PendingInvitations = string[];
|
|
1312
|
+
/** Whether the user is sponsored */
|
|
1313
|
+
export type IsSponsored = boolean;
|
|
1314
|
+
/** External system ID 1 */
|
|
1315
|
+
export type ExternalID = string;
|
|
1316
|
+
/** Whether the user is enabled */
|
|
1317
|
+
export type IsEnabled = boolean;
|
|
1318
|
+
/** Whether the user has opted out of having their certification information published to 3rd party integrations */
|
|
1319
|
+
export type CertifiedUserOptOut = boolean;
|
|
1320
|
+
export interface PartitionEntry {
|
|
1321
|
+
partID: string;
|
|
1322
|
+
userID: string;
|
|
1323
|
+
updateByApp?: string;
|
|
1324
|
+
updateOn?: number;
|
|
1325
|
+
value?: any;
|
|
1326
|
+
}
|
|
1327
|
+
/** User data from IDM including user profile and partition data */
|
|
1328
|
+
export interface UserDataResponse {
|
|
1329
|
+
/** IDM user object */
|
|
1330
|
+
user: Record<string, any>;
|
|
1331
|
+
/** User partition data from IDM */
|
|
1332
|
+
partitions: PartitionEntry[];
|
|
1333
|
+
}
|
|
1334
|
+
/** Response schema for certification process data */
|
|
1335
|
+
export interface CertificationProcessResponseEntity {
|
|
1336
|
+
/** @example "abc123" */
|
|
1337
|
+
id: string;
|
|
1338
|
+
/** @example "tenant001" */
|
|
1339
|
+
tenantID: string;
|
|
1340
|
+
/** @example "user001" */
|
|
1341
|
+
userID: string;
|
|
1342
|
+
/** @example "cert001" */
|
|
1343
|
+
certificationID: string;
|
|
1344
|
+
/** @example 1717000000000 */
|
|
1345
|
+
createdOn?: number;
|
|
1346
|
+
/** @example "admin" */
|
|
1347
|
+
createdBy?: string;
|
|
1348
|
+
/** @example "admin" */
|
|
1349
|
+
updatedBy?: string;
|
|
1350
|
+
/** @example 1717000000000 */
|
|
1351
|
+
updatedOn?: number;
|
|
1352
|
+
/** @example "prgCertificationProcess" */
|
|
1353
|
+
dbEntity?: string;
|
|
1354
|
+
/** @example "CERT-2025-XYZ" */
|
|
1355
|
+
certNumber?: string;
|
|
1356
|
+
/** @example 1717000000000 */
|
|
1357
|
+
completionDate?: number;
|
|
1358
|
+
/** @example 1716000000000 */
|
|
1359
|
+
originalCompletionDate?: number;
|
|
1360
|
+
/** @example 1717000000000 */
|
|
1361
|
+
cardPrintedOn?: number;
|
|
1362
|
+
/** @example 1717000000000 */
|
|
1363
|
+
certificatePrintedOn?: number;
|
|
1364
|
+
/** @example 1717000000000 */
|
|
1365
|
+
shippingDate?: number;
|
|
1366
|
+
/** @example 1717000000000 */
|
|
1367
|
+
lastCourseCompletionDate?: number;
|
|
1368
|
+
/** @example ["course1","course2"] */
|
|
1369
|
+
blockedCourses?: string[];
|
|
1370
|
+
triggerState?: Record<string, {
|
|
1371
|
+
/** @example "triggered" */
|
|
1372
|
+
state?: string;
|
|
1373
|
+
/** @example 1717000000000 */
|
|
1374
|
+
updatedOn?: number;
|
|
1375
|
+
/** @example "OK" */
|
|
1376
|
+
requestResult?: any;
|
|
1377
|
+
}>;
|
|
1378
|
+
/** @example 85 */
|
|
1379
|
+
pointsAchieved?: number;
|
|
1380
|
+
/** @example ["email1","email2"] */
|
|
1381
|
+
expireReminders?: string[];
|
|
1382
|
+
/** @example 1718000000000 */
|
|
1383
|
+
expiryDate?: number;
|
|
1384
|
+
/** @example "active" */
|
|
1385
|
+
state?: string;
|
|
1386
|
+
/** @example "completed" */
|
|
1387
|
+
stage?: string;
|
|
1388
|
+
/** @example "passed" */
|
|
1389
|
+
stageLastCourseState?: string;
|
|
1390
|
+
/** @example 1717000000000 */
|
|
1391
|
+
manualOverrideOn?: number;
|
|
1392
|
+
/** @example 120.5 */
|
|
1393
|
+
pendingPaymentValue?: number;
|
|
1394
|
+
/** @example "Manual override" */
|
|
1395
|
+
overwrittenJustification?: string;
|
|
1396
|
+
/** @example 15 */
|
|
1397
|
+
commissionAmount?: number;
|
|
1398
|
+
/** @example "affiliate001" */
|
|
1399
|
+
commissionPayTo?: string;
|
|
1400
|
+
/** @example 15 */
|
|
1401
|
+
commissionPaid?: number;
|
|
1402
|
+
/** @example "manager" */
|
|
1403
|
+
waivedBy?: string;
|
|
1404
|
+
/** @example 1717000000000 */
|
|
1405
|
+
waivedOn?: number;
|
|
1406
|
+
/** @example "Waived due to exception" */
|
|
1407
|
+
waivedComments?: string;
|
|
1408
|
+
user?: Record<string, any>;
|
|
1409
|
+
courses?: Record<string, any>[];
|
|
1410
|
+
applications?: Record<string, any>[];
|
|
1411
|
+
applicationItems?: Record<string, any>[];
|
|
1412
|
+
transactionID?: string | null;
|
|
1413
|
+
}
|
|
1414
|
+
export interface InputGhzia6Oe3O {
|
|
1415
|
+
issuedOn?: number;
|
|
1416
|
+
expiresOn?: number;
|
|
1417
|
+
fileItems?: {
|
|
1418
|
+
fileID: string;
|
|
1419
|
+
fileName: string;
|
|
1420
|
+
}[];
|
|
1421
|
+
additionalNotes?: string | null;
|
|
1422
|
+
}
|
|
1423
|
+
export interface Input9Hlh5Puwxcf {
|
|
1424
|
+
/**
|
|
1425
|
+
* Indicates whether the application is locked
|
|
1426
|
+
* @example true
|
|
1427
|
+
*/
|
|
1428
|
+
isApplicationLocked: boolean;
|
|
1429
|
+
}
|
|
1430
|
+
export interface OutputKfff393Yn2K {
|
|
1431
|
+
/**
|
|
1432
|
+
* Signed URL for the course file
|
|
1433
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1434
|
+
*/
|
|
1435
|
+
fileURL: string;
|
|
1436
|
+
}
|
|
1437
|
+
export interface Input399F4Vzf2A {
|
|
1438
|
+
/**
|
|
1439
|
+
* Indicates whether the waiver is approved
|
|
1440
|
+
* @example true
|
|
1441
|
+
*/
|
|
1442
|
+
approved: boolean;
|
|
1443
|
+
/**
|
|
1444
|
+
* Optional notes regarding the waiver
|
|
1445
|
+
* @example "Waiver granted due to special circumstances."
|
|
1446
|
+
*/
|
|
1447
|
+
additionalNotes?: string | null;
|
|
1448
|
+
}
|
|
1449
|
+
export interface InputPlz242Pxo1 {
|
|
1450
|
+
/**
|
|
1451
|
+
* Optional notes regarding the waiver
|
|
1452
|
+
* @example "Waiver granted due to special circumstances."
|
|
1453
|
+
*/
|
|
1454
|
+
additionalNotes?: string | null;
|
|
1455
|
+
}
|
|
1456
|
+
export interface InputWipuiyq3Gx {
|
|
1457
|
+
students: {
|
|
1458
|
+
/**
|
|
1459
|
+
* User ID of the student to redeem the course for
|
|
1460
|
+
* @example "userID"
|
|
1461
|
+
*/
|
|
1462
|
+
userID: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* Activation code for the course, if applicable
|
|
1465
|
+
* @example "activationCode"
|
|
1466
|
+
*/
|
|
1467
|
+
activationCode?: string;
|
|
1468
|
+
}[];
|
|
1469
|
+
/**
|
|
1470
|
+
* ID of the course to redeem
|
|
1471
|
+
* @example "courseID"
|
|
1472
|
+
*/
|
|
1473
|
+
courseID: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Organization ID for the course redemption
|
|
1476
|
+
* @example "orgID"
|
|
1477
|
+
*/
|
|
1478
|
+
orgID?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Session ID for the course, if applicable
|
|
1481
|
+
* @example "sessionID"
|
|
1482
|
+
*/
|
|
1483
|
+
sessionID?: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* Session ID for automatic enrollment, if applicable
|
|
1486
|
+
* @example "autoEnrolSessionID"
|
|
1487
|
+
*/
|
|
1488
|
+
autoEnrolSessionID?: string;
|
|
1489
|
+
}
|
|
1490
|
+
export interface InputS9Wa09Jr5M {
|
|
1491
|
+
invites: {
|
|
1492
|
+
/**
|
|
1493
|
+
* Email address of the user to invite
|
|
1494
|
+
* @example "mail@mail.com"
|
|
1495
|
+
*/
|
|
1496
|
+
email: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* User ID of the user to invite, if available
|
|
1499
|
+
* @example "userID"
|
|
1500
|
+
*/
|
|
1501
|
+
userID?: string;
|
|
1502
|
+
}[];
|
|
1503
|
+
/**
|
|
1504
|
+
* ID of the course to redeem
|
|
1505
|
+
* @example "courseID"
|
|
1506
|
+
*/
|
|
1507
|
+
courseID: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Session ID for the course, if applicable
|
|
1510
|
+
* @example "sessionID"
|
|
1511
|
+
*/
|
|
1512
|
+
sessionID?: string;
|
|
1513
|
+
/**
|
|
1514
|
+
* Indicates if the invite is for a reserved seat
|
|
1515
|
+
* @example true
|
|
1516
|
+
*/
|
|
1517
|
+
isReservedSeat: boolean;
|
|
1518
|
+
}
|
|
1519
|
+
export interface Input9Idwlxns6V {
|
|
1520
|
+
/**
|
|
1521
|
+
* Indicates whether to waive the certification process
|
|
1522
|
+
* @example true
|
|
1523
|
+
*/
|
|
1524
|
+
waive: boolean;
|
|
1525
|
+
/**
|
|
1526
|
+
* Optional comments regarding the waiver
|
|
1527
|
+
* @example "Waive granted due to special circumstances."
|
|
1528
|
+
*/
|
|
1529
|
+
comments?: string | null;
|
|
1530
|
+
}
|
|
1531
|
+
/** Certification move response schema */
|
|
1532
|
+
export interface OutputAwpe8Eohm3 {
|
|
1533
|
+
errors?: {
|
|
1534
|
+
status: string;
|
|
1535
|
+
object?: Record<string, any>;
|
|
1536
|
+
ignoreError?: boolean;
|
|
1537
|
+
}[];
|
|
1538
|
+
}
|
|
1539
|
+
/** Schema for writing a certification trigger check. */
|
|
1540
|
+
export interface Input5Rbt3210Wa {
|
|
1541
|
+
/**
|
|
1542
|
+
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1543
|
+
* @example "CHECKED"
|
|
1544
|
+
*/
|
|
1545
|
+
value: Input5Rbt3210WaValueEnum;
|
|
1546
|
+
/**
|
|
1547
|
+
* List of course IDs that are blocked by this trigger check.
|
|
1548
|
+
* @example ["course1","course2"]
|
|
1549
|
+
*/
|
|
1550
|
+
blockedCourses?: string[];
|
|
1551
|
+
}
|
|
1552
|
+
export interface InputTnjt9Libv1 {
|
|
1553
|
+
/**
|
|
1554
|
+
* Indicates whether the application item is approved
|
|
1555
|
+
* @example true
|
|
1556
|
+
*/
|
|
1557
|
+
approved: boolean;
|
|
1558
|
+
/**
|
|
1559
|
+
* Optional notes regarding the review of the application item
|
|
1560
|
+
* @example "Reviewed and approved with no issues."
|
|
1561
|
+
*/
|
|
1562
|
+
additionalNotes?: string | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* Timestamp when the item was issued
|
|
1565
|
+
* @example 1672531199000
|
|
1566
|
+
*/
|
|
1567
|
+
issuedOn?: number;
|
|
1568
|
+
/**
|
|
1569
|
+
* Timestamp when the item expires
|
|
1570
|
+
* @example 1704067199000
|
|
1571
|
+
*/
|
|
1572
|
+
expiresOn?: number;
|
|
1573
|
+
}
|
|
1574
|
+
/** Create Student History requirements */
|
|
1575
|
+
export interface StudentHistoryRequestSchema {
|
|
1576
|
+
requirements: string[];
|
|
1577
|
+
}
|
|
1578
|
+
export interface InputXx8Af8Xgud {
|
|
1579
|
+
/**
|
|
1580
|
+
* Optional activation key for the application
|
|
1581
|
+
* @example "AK-123456"
|
|
1582
|
+
*/
|
|
1583
|
+
activationKey?: string;
|
|
1584
|
+
}
|
|
1585
|
+
/** Schema for course submission item details post request. */
|
|
1586
|
+
export interface InputW1Wygqy1G9 {
|
|
1587
|
+
/**
|
|
1588
|
+
* The ID of the file being submitted.
|
|
1589
|
+
* @example "fileID123"
|
|
1590
|
+
*/
|
|
1591
|
+
fileID: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* The name of the file being submitted.
|
|
1594
|
+
* @example "submissionFile.pdf"
|
|
1595
|
+
*/
|
|
1596
|
+
fileName: string;
|
|
1597
|
+
}
|
|
1598
|
+
/** Schema for the response to course submission item details post request. */
|
|
1599
|
+
export interface OutputW1Wygqy1G9 {
|
|
1600
|
+
submissionItems: {
|
|
1601
|
+
/**
|
|
1602
|
+
* The ID of the file being submitted.
|
|
1603
|
+
* @example "fileID123"
|
|
1604
|
+
*/
|
|
1605
|
+
fileID: string;
|
|
1606
|
+
/**
|
|
1607
|
+
* The name of the file being submitted.
|
|
1608
|
+
* @example "submissionFile.pdf"
|
|
1609
|
+
*/
|
|
1610
|
+
fileName: string;
|
|
1611
|
+
}[];
|
|
1612
|
+
}
|
|
1613
|
+
/** Pending approval submission parameters */
|
|
1614
|
+
export interface InputKat1Qr6Mvq {
|
|
1615
|
+
/**
|
|
1616
|
+
* Type of pending approval
|
|
1617
|
+
* @example "certification"
|
|
1618
|
+
*/
|
|
1619
|
+
type: string;
|
|
1620
|
+
/** List of files submitted for pending approval */
|
|
1621
|
+
submissionItems: {
|
|
1622
|
+
/**
|
|
1623
|
+
* ID of the submitted file
|
|
1624
|
+
* @example "fileID123"
|
|
1625
|
+
*/
|
|
1626
|
+
fileID: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Name of the submitted file
|
|
1629
|
+
* @example "document.pdf"
|
|
1630
|
+
*/
|
|
1631
|
+
fileName: string;
|
|
1632
|
+
}[];
|
|
1633
|
+
}
|
|
1634
|
+
export interface Input5C1Vlfuer8 {
|
|
1635
|
+
/**
|
|
1636
|
+
* The ID of the course for which the license is being redeemed
|
|
1637
|
+
* @example "courseID123"
|
|
1638
|
+
*/
|
|
1639
|
+
courseID: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* The activation code for the license redemption
|
|
1642
|
+
* @example "activationCode456"
|
|
1643
|
+
*/
|
|
1644
|
+
activationCode?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* The ID of the session associated with the license redemption
|
|
1647
|
+
* @example "sessionID789"
|
|
1648
|
+
*/
|
|
1649
|
+
sessionID?: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* The ID of the referral associated with the license redemption
|
|
1652
|
+
* @example "referralID123"
|
|
1653
|
+
*/
|
|
1654
|
+
referralID?: string | null;
|
|
1655
|
+
/**
|
|
1656
|
+
* The name of the referral associated with the license redemption
|
|
1657
|
+
* @example "referralName456"
|
|
1658
|
+
*/
|
|
1659
|
+
referralName?: string | null;
|
|
1660
|
+
/**
|
|
1661
|
+
* The ID of the employer associated with the license redemption
|
|
1662
|
+
* @example "employerID789"
|
|
1663
|
+
*/
|
|
1664
|
+
employerID?: string | null;
|
|
1665
|
+
/**
|
|
1666
|
+
* The name of the employer associated with the license redemption
|
|
1667
|
+
* @example "employerName012"
|
|
1668
|
+
*/
|
|
1669
|
+
employerName?: string | null;
|
|
1670
|
+
/**
|
|
1671
|
+
* The CUs associated with the employer for the license redemption
|
|
1672
|
+
* @example "employerCUsData"
|
|
1673
|
+
*/
|
|
1674
|
+
employerCUs?: any;
|
|
1675
|
+
/**
|
|
1676
|
+
* Indicates if the order is a no-cost order
|
|
1677
|
+
* @example true
|
|
1678
|
+
*/
|
|
1679
|
+
isNoCostOrder?: boolean | null;
|
|
1680
|
+
/**
|
|
1681
|
+
* The invitation code for the license redemption
|
|
1682
|
+
* @example "invitationCode345"
|
|
1683
|
+
*/
|
|
1684
|
+
invitationCode?: string | null;
|
|
1685
|
+
/**
|
|
1686
|
+
* Shipping information for any materials associated with the license redemption
|
|
1687
|
+
* @example "materialShippingInfoData"
|
|
1688
|
+
*/
|
|
1689
|
+
materialShippingInfo?: any;
|
|
1690
|
+
/**
|
|
1691
|
+
* The ID of the session for automatic enrollment
|
|
1692
|
+
* @example "autoEnrolSessionID678"
|
|
1693
|
+
*/
|
|
1694
|
+
autoEnrolSessionID?: string | null;
|
|
1695
|
+
/**
|
|
1696
|
+
* The response to the acknowledgement of terms or conditions
|
|
1697
|
+
* @example "Accepted"
|
|
1698
|
+
*/
|
|
1699
|
+
acknowledgement?: string | null;
|
|
1700
|
+
}
|
|
1701
|
+
/** Validate certification move response schema */
|
|
1702
|
+
export interface Output14Cjbffl65 {
|
|
1703
|
+
courses: {
|
|
1704
|
+
name: string;
|
|
1705
|
+
status: string;
|
|
1706
|
+
state: string;
|
|
1707
|
+
}[];
|
|
1708
|
+
status: string;
|
|
1709
|
+
certProcID: string;
|
|
1710
|
+
validated: boolean;
|
|
1711
|
+
mustCreateCP: boolean;
|
|
1712
|
+
}
|
|
1713
|
+
export interface InputT941Yc1Ixd {
|
|
1714
|
+
/**
|
|
1715
|
+
* Comments regarding the end of the cooldown period
|
|
1716
|
+
* @example "Cooldown period ended successfully."
|
|
1717
|
+
*/
|
|
1718
|
+
comments: string;
|
|
1719
|
+
}
|
|
1720
|
+
export interface OutputQy22Ubvomc {
|
|
1721
|
+
/**
|
|
1722
|
+
* Signed URL for the course file
|
|
1723
|
+
* @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
|
|
1724
|
+
*/
|
|
1725
|
+
fileURL: string;
|
|
1726
|
+
}
|
|
1727
|
+
export interface Input7All4Ddetf {
|
|
1728
|
+
/** @example true */
|
|
1729
|
+
agreedWithCertTerms: boolean;
|
|
1730
|
+
/** @example 1717230000000 */
|
|
1731
|
+
agreedOnTerms: number;
|
|
1732
|
+
/** @example "John" */
|
|
1733
|
+
firstName: string;
|
|
1734
|
+
/** @example "Doe" */
|
|
1735
|
+
lastName: string;
|
|
1736
|
+
/** @example "+1-555-5555" */
|
|
1737
|
+
phoneNumber?: string | null;
|
|
1738
|
+
/** @example "john.doe@example.com" */
|
|
1739
|
+
email: string;
|
|
1740
|
+
/** @example "legacy@domain.com" */
|
|
1741
|
+
sendAsEmail?: string;
|
|
1742
|
+
/** @example "alternate@domain.com" */
|
|
1743
|
+
sendEmailAs?: string;
|
|
1744
|
+
/** @example "John A. Doe" */
|
|
1745
|
+
certNameOnCertificate?: any;
|
|
1746
|
+
/** @example "ITA123456" */
|
|
1747
|
+
itaNumber?: any;
|
|
1748
|
+
/** @example false */
|
|
1749
|
+
sendGift?: boolean;
|
|
1750
|
+
/** @example "active" */
|
|
1751
|
+
state?: any;
|
|
1752
|
+
/** @example "USR#123" */
|
|
1753
|
+
id?: any;
|
|
1754
|
+
/** @example "TEN#001" */
|
|
1755
|
+
tenantID?: any;
|
|
1756
|
+
/** @example "USR#admin" */
|
|
1757
|
+
createdBy?: any;
|
|
1758
|
+
/** @example "USR#admin" */
|
|
1759
|
+
updatedBy?: any;
|
|
1760
|
+
/** @example "USR#ref001" */
|
|
1761
|
+
referredByID?: any;
|
|
1762
|
+
/** @example "Jane Smith" */
|
|
1763
|
+
referredByName?: any;
|
|
1764
|
+
/** @example "EMP#001" */
|
|
1765
|
+
employerID?: any;
|
|
1766
|
+
/** @example 1717231234567 */
|
|
1767
|
+
signinDate?: any;
|
|
1768
|
+
/** @example 1717231234567 */
|
|
1769
|
+
certificationDate?: any;
|
|
1770
|
+
/** @example 1750000000000 */
|
|
1771
|
+
certificationExpirationDate?: any;
|
|
1772
|
+
/** @example 1680000000000 */
|
|
1773
|
+
certificationOriginalDate?: any;
|
|
1774
|
+
/** @example "MBR#5678" */
|
|
1775
|
+
memberNumber?: any;
|
|
1776
|
+
/** @example 1717231111111 */
|
|
1777
|
+
updatedOn?: any;
|
|
1778
|
+
/** @example 1717000000000 */
|
|
1779
|
+
createdOn?: any;
|
|
1780
|
+
/** @example "TXN#abc123" */
|
|
1781
|
+
transactionID?: any;
|
|
1782
|
+
/** @example ["USR#789","USR#101"] */
|
|
1783
|
+
managerOf?: any;
|
|
1784
|
+
/** @example ["GRP#teamA"] */
|
|
1785
|
+
memberOf?: any;
|
|
1786
|
+
/** @example "prgUser" */
|
|
1787
|
+
dbEntity?: any;
|
|
1788
|
+
/** @example "+1-222-3333" */
|
|
1789
|
+
mobilePhone?: string | null;
|
|
1790
|
+
/** @example "en" */
|
|
1791
|
+
preferredLanguage?: string | null;
|
|
1792
|
+
/** @example false */
|
|
1793
|
+
certifiedUserOptOut?: boolean;
|
|
1794
|
+
/** @example "EXT#555" */
|
|
1795
|
+
externalID?: string | null;
|
|
1796
|
+
/** @example "EXT#999" */
|
|
1797
|
+
externalID2?: string | null;
|
|
1798
|
+
}
|
|
1799
|
+
export interface Input4Qafniraggl {
|
|
1800
|
+
/**
|
|
1801
|
+
* Comments regarding the course unlock action
|
|
1802
|
+
* @example "Course unlocked successfully."
|
|
1803
|
+
*/
|
|
1804
|
+
comments: string;
|
|
1805
|
+
}
|
|
1806
|
+
export interface InputBq2R7Mz35F {
|
|
1807
|
+
/**
|
|
1808
|
+
* ITA number to update for the user
|
|
1809
|
+
* @example "ITA123456"
|
|
1810
|
+
*/
|
|
1811
|
+
itaNumber: string;
|
|
1812
|
+
}
|
|
1813
|
+
export interface InputIqnpk7Aisr {
|
|
1814
|
+
/** @example true */
|
|
1815
|
+
agreedWithCertTerms: boolean;
|
|
1816
|
+
/** @example 1717230000000 */
|
|
1817
|
+
agreedOnTerms: number;
|
|
1818
|
+
/** @example "John" */
|
|
1819
|
+
firstName: string;
|
|
1820
|
+
/** @example "Doe" */
|
|
1821
|
+
lastName: string;
|
|
1822
|
+
/** @example "+1-555-5555" */
|
|
1823
|
+
phoneNumber?: string | null;
|
|
1824
|
+
/** @example "john.doe@example.com" */
|
|
1825
|
+
email: string;
|
|
1826
|
+
/** @example "legacy@domain.com" */
|
|
1827
|
+
sendAsEmail?: string;
|
|
1828
|
+
/** @example "alternate@domain.com" */
|
|
1829
|
+
sendEmailAs?: string;
|
|
1830
|
+
/** @example "John A. Doe" */
|
|
1831
|
+
certNameOnCertificate?: any;
|
|
1832
|
+
/** @example "ITA123456" */
|
|
1833
|
+
itaNumber?: any;
|
|
1834
|
+
/** @example false */
|
|
1835
|
+
sendGift?: boolean;
|
|
1836
|
+
/** @example "active" */
|
|
1837
|
+
state?: any;
|
|
1838
|
+
/** @example "USR#123" */
|
|
1839
|
+
id?: any;
|
|
1840
|
+
/** @example "TEN#001" */
|
|
1841
|
+
tenantID?: any;
|
|
1842
|
+
/** @example "USR#admin" */
|
|
1843
|
+
createdBy?: any;
|
|
1844
|
+
/** @example "USR#admin" */
|
|
1845
|
+
updatedBy?: any;
|
|
1846
|
+
/** @example "USR#ref001" */
|
|
1847
|
+
referredByID?: any;
|
|
1848
|
+
/** @example "Jane Smith" */
|
|
1849
|
+
referredByName?: any;
|
|
1850
|
+
/** @example "EMP#001" */
|
|
1851
|
+
employerID?: any;
|
|
1852
|
+
/** @example 1717231234567 */
|
|
1853
|
+
signinDate?: any;
|
|
1854
|
+
/** @example 1717231234567 */
|
|
1855
|
+
certificationDate?: any;
|
|
1856
|
+
/** @example 1750000000000 */
|
|
1857
|
+
certificationExpirationDate?: any;
|
|
1858
|
+
/** @example 1680000000000 */
|
|
1859
|
+
certificationOriginalDate?: any;
|
|
1860
|
+
/** @example "MBR#5678" */
|
|
1861
|
+
memberNumber?: any;
|
|
1862
|
+
/** @example 1717231111111 */
|
|
1863
|
+
updatedOn?: any;
|
|
1864
|
+
/** @example 1717000000000 */
|
|
1865
|
+
createdOn?: any;
|
|
1866
|
+
/** @example "TXN#abc123" */
|
|
1867
|
+
transactionID?: any;
|
|
1868
|
+
/** @example ["USR#789","USR#101"] */
|
|
1869
|
+
managerOf?: any;
|
|
1870
|
+
/** @example ["GRP#teamA"] */
|
|
1871
|
+
memberOf?: any;
|
|
1872
|
+
/** @example "prgUser" */
|
|
1873
|
+
dbEntity?: any;
|
|
1874
|
+
/** @example "+1-222-3333" */
|
|
1875
|
+
mobilePhone?: string | null;
|
|
1876
|
+
/** @example "en" */
|
|
1877
|
+
preferredLanguage?: string | null;
|
|
1878
|
+
/** @example false */
|
|
1879
|
+
certifiedUserOptOut?: boolean;
|
|
1880
|
+
/** @example "EXT#555" */
|
|
1881
|
+
externalID?: string | null;
|
|
1882
|
+
/** @example "EXT#999" */
|
|
1883
|
+
externalID2?: string | null;
|
|
1884
|
+
}
|
|
1885
|
+
export interface InputDafkg0Qaax {
|
|
1886
|
+
/**
|
|
1887
|
+
* The grade to override the course result with
|
|
1888
|
+
* @example "A"
|
|
1889
|
+
*/
|
|
1890
|
+
resultGrade: string;
|
|
1891
|
+
}
|
|
1892
|
+
/** Pending approval review parameters */
|
|
1893
|
+
export interface Input11X2Ed4Ag4 {
|
|
1894
|
+
/**
|
|
1895
|
+
* Notes provided by the reviewer for the pending approval
|
|
1896
|
+
* @example "Please review the submitted documents."
|
|
1897
|
+
*/
|
|
1898
|
+
approvalNotes?: string | null;
|
|
1899
|
+
/**
|
|
1900
|
+
* Indicates whether the pending approval is approved or not
|
|
1901
|
+
* @example true
|
|
1902
|
+
*/
|
|
1903
|
+
approved: boolean;
|
|
1904
|
+
}
|
|
1905
|
+
/** Schema for overriding course result dates. */
|
|
1906
|
+
export interface Input61Papmu6Rw {
|
|
1907
|
+
/**
|
|
1908
|
+
* The date when the course result expires, in milliseconds since epoch.
|
|
1909
|
+
* @example 1735689600000
|
|
1910
|
+
*/
|
|
1911
|
+
expiryDate?: number;
|
|
1912
|
+
/**
|
|
1913
|
+
* The date when the course was completed, in milliseconds since epoch.
|
|
1914
|
+
* @example 1735689600000
|
|
1915
|
+
*/
|
|
1916
|
+
completionDate?: number;
|
|
1917
|
+
}
|
|
1918
|
+
export interface InputOrbzcylnioi {
|
|
1919
|
+
filter: {
|
|
1920
|
+
from?: number;
|
|
1921
|
+
sortOrder?: string;
|
|
1922
|
+
sortField?: string;
|
|
1923
|
+
};
|
|
1924
|
+
}
|
|
1925
|
+
export interface OutputOrbzcylnioi {
|
|
1926
|
+
users: {
|
|
1927
|
+
firstName: string;
|
|
1928
|
+
lastName: string;
|
|
1929
|
+
/** @format email */
|
|
1930
|
+
email: string;
|
|
1931
|
+
phoneNumber?: string;
|
|
1932
|
+
certNumber: string;
|
|
1933
|
+
certDate: number;
|
|
1934
|
+
certExpiration: string;
|
|
1935
|
+
}[];
|
|
1936
|
+
total: number;
|
|
1937
|
+
}
|
|
1938
|
+
export declare enum ReportXlsxSchemaContentTypeEnum {
|
|
1939
|
+
ApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
|
|
1940
|
+
}
|
|
1941
|
+
/**
|
|
1942
|
+
* The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
|
|
1943
|
+
* @example "CHECKED"
|
|
1944
|
+
*/
|
|
1945
|
+
export declare enum Input5Rbt3210WaValueEnum {
|
|
1946
|
+
CHECKED = "CHECKED",
|
|
1947
|
+
UNCHECKED = "UNCHECKED",
|
|
1948
|
+
NOVALUE = "NOVALUE"
|
|
1949
|
+
}
|
|
1950
|
+
export type ListContactUsData = any;
|
|
1951
|
+
export type ListContactUsError = ErrorResponse;
|
|
1952
|
+
export type ListConfigData = any;
|
|
1953
|
+
export type ListConfigError = ErrorResponse;
|
|
1954
|
+
export interface GetUserParams {
|
|
1955
|
+
/** @example "allFlag" */
|
|
1956
|
+
allFlag: string;
|
|
1957
|
+
/** @example "userID" */
|
|
1958
|
+
userId: string;
|
|
1959
|
+
}
|
|
1960
|
+
export type GetUserData = UserResponseEntity;
|
|
1961
|
+
export type GetUserError = ErrorResponse;
|
|
1962
|
+
export interface GetEventsParams {
|
|
1963
|
+
/** Exclude online events */
|
|
1964
|
+
excludeOnline?: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* Start time of the event range
|
|
1967
|
+
* @example "1781158057000"
|
|
1968
|
+
*/
|
|
1969
|
+
startTime: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* End time of the event range
|
|
1972
|
+
* @example "1781158057000"
|
|
1973
|
+
*/
|
|
1974
|
+
endTime: string;
|
|
1975
|
+
}
|
|
1976
|
+
export type GetEventsData = any;
|
|
1977
|
+
export type GetEventsError = ErrorResponse;
|
|
1978
|
+
export type DeleteOrgData = any;
|
|
1979
|
+
export type DeleteOrgError = ErrorResponse;
|
|
1980
|
+
export interface ListReportAffiliateParams {
|
|
1981
|
+
/** @example "1704067200" */
|
|
1982
|
+
from: string;
|
|
1983
|
+
/** @example "1704153600" */
|
|
1984
|
+
to: string;
|
|
1985
|
+
}
|
|
1986
|
+
export type ListReportAffiliateData = any;
|
|
1987
|
+
export type ListReportAffiliateError = ErrorResponse;
|
|
1988
|
+
export type ListReportCompletedWithConsentData = any;
|
|
1989
|
+
export type ListReportCompletedWithConsentError = ErrorResponse;
|
|
1990
|
+
export type ListPendingApplicationsData = ApplicationResponseSchema;
|
|
1991
|
+
export type ListPendingApplicationsError = ErrorResponse;
|
|
1992
|
+
export type ListPendingApprovalsData = PendingApprovalResponseSchema;
|
|
1993
|
+
export type ListPendingApprovalsError = ErrorResponse;
|
|
1994
|
+
export type ListConfigResult = any;
|
|
1995
|
+
export type ListConfigFail = ErrorResponse;
|
|
1996
|
+
export type CreateReportApplicationExportData = any;
|
|
1997
|
+
export type CreateReportApplicationExportError = ErrorResponse;
|
|
1998
|
+
export type ListReportApplicationStatusData = any;
|
|
1999
|
+
export type ListReportApplicationStatusError = ErrorResponse;
|
|
2000
|
+
export type CreateReportApplicationsReportData = any;
|
|
2001
|
+
export type CreateReportApplicationsReportError = ErrorResponse;
|
|
2002
|
+
export type CreateCertificatesEmailData = any;
|
|
2003
|
+
export type CreateCertificatesEmailError = ErrorResponse;
|
|
2004
|
+
export interface CreateReportCompletedCertificationsPreviewParams {
|
|
2005
|
+
/** @example "1704067200" */
|
|
2006
|
+
from: string;
|
|
2007
|
+
/** @example "1704153600" */
|
|
2008
|
+
to: string;
|
|
2009
|
+
}
|
|
2010
|
+
export type CreateReportCompletedCertificationsPreviewData = any;
|
|
2011
|
+
export type CreateReportCompletedCertificationsPreviewError = ErrorResponse;
|
|
2012
|
+
export interface ListReportCompletedCertificationsParams {
|
|
2013
|
+
/** @example "1704067200" */
|
|
2014
|
+
from: string;
|
|
2015
|
+
/** @example "1704153600" */
|
|
2016
|
+
to: string;
|
|
2017
|
+
}
|
|
2018
|
+
export type ListReportCompletedCertificationsData = any;
|
|
2019
|
+
export type ListReportCompletedCertificationsError = ErrorResponse;
|
|
2020
|
+
export type CreateLicenseRedeemData = any;
|
|
2021
|
+
export type CreateLicenseRedeemError = ErrorResponse;
|
|
2022
|
+
export type ListReportOrglicensesData = any;
|
|
2023
|
+
export type ListReportOrglicensesError = ErrorResponse;
|
|
2024
|
+
export type CreateReportOrglicensesPreviewData = any;
|
|
2025
|
+
export type CreateReportOrglicensesPreviewError = ErrorResponse;
|
|
2026
|
+
export type CreateReportNcsoReportExportData = NcsoReportExportRequestSchema;
|
|
2027
|
+
export type CreateReportNcsoReportExportError = ErrorResponse;
|
|
2028
|
+
export type CreateReportNcsoReportData = ReportXLSXSchema;
|
|
2029
|
+
export type CreateReportNcsoReportError = ErrorResponse;
|
|
2030
|
+
export type CreateReportUsersAdvancedData = any;
|
|
2031
|
+
export type CreateReportUsersAdvancedError = ErrorResponse;
|
|
2032
|
+
export type ListSearchUsersIdsData = any;
|
|
2033
|
+
export type ListSearchUsersIdsError = ErrorResponse;
|
|
2034
|
+
export type CreateSearchUsersTermData = any;
|
|
2035
|
+
export type CreateSearchUsersTermError = ErrorResponse;
|
|
2036
|
+
export type CreateReportUsersSimpleData = any;
|
|
2037
|
+
export type CreateReportUsersSimpleError = ErrorResponse;
|
|
2038
|
+
export type CreateSearchUsersCountData = Output2Ap8L2U1E4;
|
|
2039
|
+
export type CreateSearchUsersCountError = ErrorResponse;
|
|
2040
|
+
export type CreateCertificationApplicationAcknowledgeData = any;
|
|
2041
|
+
export type CreateCertificationApplicationAcknowledgeError = ErrorResponse;
|
|
2042
|
+
export type DeleteCertificationApplicationItemData = any;
|
|
2043
|
+
export type DeleteCertificationApplicationItemError = ErrorResponse;
|
|
2044
|
+
export type CreateCertificationApplicationItemData = any;
|
|
2045
|
+
export type CreateCertificationApplicationItemError = ErrorResponse;
|
|
2046
|
+
export type DeleteCertificationApplicationBlacklistData = any;
|
|
2047
|
+
export type DeleteCertificationApplicationBlacklistError = ErrorResponse;
|
|
2048
|
+
export type DeleteCertificationData = any;
|
|
2049
|
+
export type DeleteCertificationError = ErrorResponse;
|
|
2050
|
+
export type GetCertificationData = CertificationProcessResponseEntity;
|
|
2051
|
+
export type GetCertificationError = ErrorResponse;
|
|
2052
|
+
export type CreateCertificationData = any;
|
|
2053
|
+
export type CreateCertificationError = ErrorResponse;
|
|
2054
|
+
export type DeleteCertificationApplicationData = any;
|
|
2055
|
+
export type DeleteCertificationApplicationError = ErrorResponse;
|
|
2056
|
+
export type GetCertificationApplicationData = CertificationApplicationResponseEntity;
|
|
2057
|
+
export type GetCertificationApplicationError = ErrorResponse;
|
|
2058
|
+
export type CreateCertificationApplicationData = any;
|
|
2059
|
+
export type CreateCertificationApplicationError = ErrorResponse;
|
|
2060
|
+
export type DeleteCertificationCourseFileSignData = any;
|
|
2061
|
+
export type DeleteCertificationCourseFileSignError = ErrorResponse;
|
|
2062
|
+
export type GetCertificationCourseFileSignData = OutputKk5Ahwsca2;
|
|
2063
|
+
export type GetCertificationCourseFileSignError = ErrorResponse;
|
|
2064
|
+
export interface CreateCertificationCourseFileSignParams {
|
|
2065
|
+
/** @example "pdf" */
|
|
2066
|
+
fileType: string;
|
|
2067
|
+
/** @example "userID" */
|
|
2068
|
+
userId: string;
|
|
2069
|
+
/** @example "certProcID" */
|
|
2070
|
+
certProcId: string;
|
|
2071
|
+
/** @example "courseID" */
|
|
2072
|
+
courseId: string;
|
|
2073
|
+
/** @example "fileID" */
|
|
2074
|
+
fileId: string;
|
|
2075
|
+
}
|
|
2076
|
+
export type CreateCertificationCourseFileSignData = OutputQy22Ubvomc;
|
|
2077
|
+
export type CreateCertificationCourseFileSignError = ErrorResponse;
|
|
2078
|
+
export type DeleteCertificationCourseDocumentData = any;
|
|
2079
|
+
export type DeleteCertificationCourseDocumentError = ErrorResponse;
|
|
2080
|
+
export type CreateCertificationCourseDocumentData = OutputW1Wygqy1G9;
|
|
2081
|
+
export type CreateCertificationCourseDocumentError = ErrorResponse;
|
|
2082
|
+
export type DeleteUserData = any;
|
|
2083
|
+
export type DeleteUserError = ErrorResponse;
|
|
2084
|
+
export type GetUserResult = UserResponseEntity;
|
|
2085
|
+
export type GetUserFail = ErrorResponse;
|
|
2086
|
+
export type CreateUserData = any;
|
|
2087
|
+
export type CreateUserError = ErrorResponse;
|
|
2088
|
+
export type UpdateUserData = any;
|
|
2089
|
+
export type UpdateUserError = ErrorResponse;
|
|
2090
|
+
export type DeleteCertificationCourseData = any;
|
|
2091
|
+
export type DeleteCertificationCourseError = ErrorResponse;
|
|
2092
|
+
export type GetCertificationApplicationItemFileData = Output1Oh09Nkr3Mj;
|
|
2093
|
+
export type GetCertificationApplicationItemFileError = ErrorResponse;
|
|
2094
|
+
export interface CreateCertificationApplicationItemFileParams {
|
|
2095
|
+
/** @example "pdf" */
|
|
2096
|
+
fileType: string;
|
|
2097
|
+
/** @example "userID" */
|
|
2098
|
+
userId: string;
|
|
2099
|
+
/** @example "certProcID" */
|
|
2100
|
+
certProcId: string;
|
|
2101
|
+
/** @example "sourceID" */
|
|
2102
|
+
sourceId: string;
|
|
2103
|
+
/** @example "fileVersion" */
|
|
2104
|
+
fileVersion: string;
|
|
2105
|
+
}
|
|
2106
|
+
export type CreateCertificationApplicationItemFileData = OutputKfff393Yn2K;
|
|
2107
|
+
export type CreateCertificationApplicationItemFileError = ErrorResponse;
|
|
2108
|
+
export type GetCertificationCourseSessionCalcCancelationChargesData = OutputU7Gnd99Lsg;
|
|
2109
|
+
export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse;
|
|
2110
|
+
export type GetCertificationsData = CertificationProcessResponseSchema;
|
|
2111
|
+
export type GetCertificationsError = ErrorResponse;
|
|
2112
|
+
export type GetCourseData = CourseResponseEntity;
|
|
2113
|
+
export type GetCourseError = ErrorResponse;
|
|
2114
|
+
export type GetCertificationsExpandedData = UserExpandedCPResponseSchema;
|
|
2115
|
+
export type GetCertificationsExpandedError = ErrorResponse;
|
|
2116
|
+
export type GetCertificationApplicationForeignFillData = OutputYh2G6Inklt;
|
|
2117
|
+
export type GetCertificationApplicationForeignFillError = ErrorResponse;
|
|
2118
|
+
export type GetCertificationPrintData = any;
|
|
2119
|
+
export type GetCertificationPrintError = ErrorResponse;
|
|
2120
|
+
export type GetCertificationCoursePrintData = any;
|
|
2121
|
+
export type GetCertificationCoursePrintError = ErrorResponse;
|
|
2122
|
+
export type GetRequirementData = StudentHistoryResponseSchema;
|
|
2123
|
+
export type GetRequirementError = ErrorResponse;
|
|
2124
|
+
export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSchema;
|
|
2125
|
+
export type GetCertificationsUpcomingCoursesError = ErrorResponse;
|
|
2126
|
+
export type GetUserDataData = UserDataResponse;
|
|
2127
|
+
export type GetUserDataError = ErrorResponse;
|
|
2128
|
+
export type CreateCertificationApplicationLockData = any;
|
|
2129
|
+
export type CreateCertificationApplicationLockError = ErrorResponse;
|
|
2130
|
+
export type CreateSessionAddData = any;
|
|
2131
|
+
export type CreateSessionAddError = ErrorResponse;
|
|
2132
|
+
export type CreateCertificationApplicationPreApprovalData = any;
|
|
2133
|
+
export type CreateCertificationApplicationPreApprovalError = ErrorResponse;
|
|
2134
|
+
export type CreateCertificationApplicationReviewData = any;
|
|
2135
|
+
export type CreateCertificationApplicationReviewError = ErrorResponse;
|
|
2136
|
+
export type CreateCertificationApplicationPreApprovalReviewData = any;
|
|
2137
|
+
export type CreateCertificationApplicationPreApprovalReviewError = ErrorResponse;
|
|
2138
|
+
export type CreateCertificationCourseBatchRedeemData = any;
|
|
2139
|
+
export type CreateCertificationCourseBatchRedeemError = ErrorResponse;
|
|
2140
|
+
export type CreateCertificationCourseBatchInviteData = any;
|
|
2141
|
+
export type CreateCertificationCourseBatchInviteError = ErrorResponse;
|
|
2142
|
+
export type CreateCertificationCourseSessionCancelEnrolData = any;
|
|
2143
|
+
export type CreateCertificationCourseSessionCancelEnrolError = ErrorResponse;
|
|
2144
|
+
export type CreateCertificationRenewData = any;
|
|
2145
|
+
export type CreateCertificationRenewError = ErrorResponse;
|
|
2146
|
+
export type CreateCertificationRestartData = any;
|
|
2147
|
+
export type CreateCertificationRestartError = ErrorResponse;
|
|
2148
|
+
export type CreateCertificationWaiveData = any;
|
|
2149
|
+
export type CreateCertificationWaiveError = ErrorResponse;
|
|
2150
|
+
export type CreateCertificationMoveData = OutputAwpe8Eohm3;
|
|
2151
|
+
export type CreateCertificationMoveError = ErrorResponse;
|
|
2152
|
+
export type CreateCertificationCourseSessionReplaceData = any;
|
|
2153
|
+
export type CreateCertificationCourseSessionReplaceError = ErrorResponse;
|
|
2154
|
+
export type CreateCertificationTriggerCheckData = any;
|
|
2155
|
+
export type CreateCertificationTriggerCheckError = ErrorResponse;
|
|
2156
|
+
export type CreateCertificationTriggerSetData = any;
|
|
2157
|
+
export type CreateCertificationTriggerSetError = ErrorResponse;
|
|
2158
|
+
export type CreateRefreshOrgMembershipData = any;
|
|
2159
|
+
export type CreateRefreshOrgMembershipError = ErrorResponse;
|
|
2160
|
+
export type CreateCertificationCourseRetakeData = any;
|
|
2161
|
+
export type CreateCertificationCourseRetakeError = ErrorResponse;
|
|
2162
|
+
export type CreateCertificationCourseRevokeData = any;
|
|
2163
|
+
export type CreateCertificationCourseRevokeError = ErrorResponse;
|
|
2164
|
+
export type CreateCertificationApplicationItemRemoveData = any;
|
|
2165
|
+
export type CreateCertificationApplicationItemRemoveError = ErrorResponse;
|
|
2166
|
+
export type CreateCertificationApplicationItemReviewData = any;
|
|
2167
|
+
export type CreateCertificationApplicationItemReviewError = ErrorResponse;
|
|
2168
|
+
export type ListRequirementsData = StudentHistoryResponseSchema;
|
|
2169
|
+
export type ListRequirementsError = ErrorResponse;
|
|
2170
|
+
export type CreateCertificationApplicationSubmitData = any;
|
|
2171
|
+
export type CreateCertificationApplicationSubmitError = ErrorResponse;
|
|
2172
|
+
export type CreateCertificationCoursePendingApprovalData = any;
|
|
2173
|
+
export type CreateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2174
|
+
export type UpdateCertificationCoursePendingApprovalData = any;
|
|
2175
|
+
export type UpdateCertificationCoursePendingApprovalError = ErrorResponse;
|
|
2176
|
+
export type CreateCertificationCourseRedeemData = any;
|
|
2177
|
+
export type CreateCertificationCourseRedeemError = ErrorResponse;
|
|
2178
|
+
export type CreateCertificationMoveValidateData = Output14Cjbffl65;
|
|
2179
|
+
export type CreateCertificationMoveValidateError = ErrorResponse;
|
|
2180
|
+
export type CreateCertificationCourseEndCooldownData = any;
|
|
2181
|
+
export type CreateCertificationCourseEndCooldownError = ErrorResponse;
|
|
2182
|
+
export type CreateCertificationCourseUnlockCourseData = any;
|
|
2183
|
+
export type CreateCertificationCourseUnlockCourseError = ErrorResponse;
|
|
2184
|
+
export type CreateUpdateItaData = any;
|
|
2185
|
+
export type CreateUpdateItaError = ErrorResponse;
|
|
2186
|
+
export type UpdateCertificationCourseOverrideResultData = any;
|
|
2187
|
+
export type UpdateCertificationCourseOverrideResultError = ErrorResponse;
|
|
2188
|
+
export type UpdateCertificationSetDatesData = any;
|
|
2189
|
+
export type UpdateCertificationSetDatesError = ErrorResponse;
|
|
2190
|
+
export type CreateCertificationPublishInfoData = any;
|
|
2191
|
+
export type CreateCertificationPublishInfoError = ErrorResponse;
|
|
2192
|
+
export type CreateCertificationResult = OutputOrbzcylnioi;
|
|
2193
|
+
export type CreateCertificationFail = ErrorResponse;
|
|
2194
|
+
export type CreateCertificationPublishInfoResult = any;
|
|
2195
|
+
export type CreateCertificationPublishInfoFail = ErrorResponse;
|
|
2196
|
+
import type { AxiosInstance, AxiosRequestConfig, ResponseType } from 'axios';
|
|
2197
|
+
export type QueryParamsType = Record<string | number, any>;
|
|
2198
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
2199
|
+
/** set parameter to `true` for call `securityWorker` for this request */
|
|
2200
|
+
secure?: boolean;
|
|
2201
|
+
/** request path */
|
|
2202
|
+
path: string;
|
|
2203
|
+
/** content type of request body */
|
|
2204
|
+
type?: ContentType;
|
|
2205
|
+
/** query params */
|
|
2206
|
+
query?: QueryParamsType;
|
|
2207
|
+
/** format of response (i.e. response.json() -> format: "json") */
|
|
2208
|
+
format?: ResponseType;
|
|
2209
|
+
/** request body */
|
|
2210
|
+
body?: unknown;
|
|
2211
|
+
}
|
|
2212
|
+
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
|
|
2213
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
|
|
2214
|
+
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
2215
|
+
secure?: boolean;
|
|
2216
|
+
format?: ResponseType;
|
|
2217
|
+
}
|
|
2218
|
+
export declare enum ContentType {
|
|
2219
|
+
Json = "application/json",
|
|
2220
|
+
FormData = "multipart/form-data",
|
|
2221
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
2222
|
+
Text = "text/plain"
|
|
2223
|
+
}
|
|
2224
|
+
export declare class HttpClient<SecurityDataType = unknown> {
|
|
2225
|
+
instance: AxiosInstance;
|
|
2226
|
+
private securityData;
|
|
2227
|
+
private securityWorker?;
|
|
2228
|
+
private secure?;
|
|
2229
|
+
private format?;
|
|
2230
|
+
constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
|
|
2231
|
+
setSecurityData: (data: SecurityDataType | null) => void;
|
|
2232
|
+
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
|
|
2233
|
+
protected stringifyFormItem(formItem: unknown): string;
|
|
2234
|
+
protected createFormData(input: Record<string, unknown>): FormData;
|
|
2235
|
+
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<T>;
|
|
2236
|
+
}
|
|
2237
|
+
/**
|
|
2238
|
+
* @title BCCSA Program API
|
|
2239
|
+
* @version 3.0.20
|
|
2240
|
+
* @baseUrl http://localhost:8080
|
|
2241
|
+
* @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
|
|
2242
|
+
*/
|
|
2243
|
+
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
2244
|
+
contactUs: {
|
|
2245
|
+
/**
|
|
2246
|
+
* @description This endpoint allows users to submit a contact form with their name, email, and comments. The form submission is processed and an email is sent to the admin recipient specified in the tenant configuration.
|
|
2247
|
+
*
|
|
2248
|
+
* @tags Contact Us
|
|
2249
|
+
* @name ListContactUs
|
|
2250
|
+
* @summary Contact Us
|
|
2251
|
+
* @request POST:/contactUs
|
|
2252
|
+
* @secure
|
|
2253
|
+
*/
|
|
2254
|
+
listContactUs: (data: InputC7J0Vk93Lo, params?: RequestParams) => Promise<any>;
|
|
2255
|
+
};
|
|
2256
|
+
customer: {
|
|
2257
|
+
/**
|
|
2258
|
+
* @description Retrieve config from customer.
|
|
2259
|
+
*
|
|
2260
|
+
* @tags Config
|
|
2261
|
+
* @name ListConfig
|
|
2262
|
+
* @summary Get Config
|
|
2263
|
+
* @request GET:/customer/config
|
|
2264
|
+
* @secure
|
|
2265
|
+
*/
|
|
2266
|
+
listConfig: (params?: RequestParams) => Promise<any>;
|
|
2267
|
+
/**
|
|
2268
|
+
* @description Retrieve user from customer.
|
|
2269
|
+
*
|
|
2270
|
+
* @tags User
|
|
2271
|
+
* @name GetUser
|
|
2272
|
+
* @summary Get User
|
|
2273
|
+
* @request GET:/customer/user/{userID}
|
|
2274
|
+
* @secure
|
|
2275
|
+
*/
|
|
2276
|
+
getUser: ({ userId, ...query }: GetUserParams, params?: RequestParams) => Promise<UserResponseEntity>;
|
|
2277
|
+
/**
|
|
2278
|
+
* @description Retrieve user events from customer within a specified time range.
|
|
2279
|
+
*
|
|
2280
|
+
* @tags Events
|
|
2281
|
+
* @name GetEvents
|
|
2282
|
+
* @summary Get User Events
|
|
2283
|
+
* @request GET:/customer/events/{startTime}/{endTime}
|
|
2284
|
+
* @secure
|
|
2285
|
+
*/
|
|
2286
|
+
getEvents: ({ startTime, endTime, ...query }: GetEventsParams, params?: RequestParams) => Promise<any>;
|
|
2287
|
+
};
|
|
2288
|
+
tenant: {
|
|
2289
|
+
/**
|
|
2290
|
+
* @description Delete bridge
|
|
2291
|
+
*
|
|
2292
|
+
* @tags Tenant
|
|
2293
|
+
* @name DeleteOrg
|
|
2294
|
+
* @summary Delete bridge
|
|
2295
|
+
* @request DELETE:/tenant/org/{orgID}
|
|
2296
|
+
* @secure
|
|
2297
|
+
*/
|
|
2298
|
+
deleteOrg: (orgId: string, params?: RequestParams) => Promise<any>;
|
|
2299
|
+
/**
|
|
2300
|
+
* @description Retrieve Affiliate Payments for the tenant.
|
|
2301
|
+
*
|
|
2302
|
+
* @tags Tenant
|
|
2303
|
+
* @name ListReportAffiliate
|
|
2304
|
+
* @summary Get Affiliate Payments
|
|
2305
|
+
* @request GET:/tenant/report/affiliate
|
|
2306
|
+
* @secure
|
|
2307
|
+
*/
|
|
2308
|
+
listReportAffiliate: (query: ListReportAffiliateParams, params?: RequestParams) => Promise<any>;
|
|
2309
|
+
/**
|
|
2310
|
+
* @description List users that achieved their designation and allow their data to be published.
|
|
2311
|
+
*
|
|
2312
|
+
* @tags Tenant
|
|
2313
|
+
* @name ListReportCompletedWithConsent
|
|
2314
|
+
* @summary Get users with completed designations and consent for publication
|
|
2315
|
+
* @request GET:/tenant/report/completedWithConsent
|
|
2316
|
+
* @secure
|
|
2317
|
+
*/
|
|
2318
|
+
listReportCompletedWithConsent: (params?: RequestParams) => Promise<any>;
|
|
2319
|
+
/**
|
|
2320
|
+
* @description Retrieve pending applications for the tenant.
|
|
2321
|
+
*
|
|
2322
|
+
* @tags Tenant
|
|
2323
|
+
* @name ListPendingApplications
|
|
2324
|
+
* @summary Get Pending Applications
|
|
2325
|
+
* @request GET:/tenant/pendingApplications
|
|
2326
|
+
* @secure
|
|
2327
|
+
*/
|
|
2328
|
+
listPendingApplications: (params?: RequestParams) => Promise<ApplicationResponseSchema>;
|
|
2329
|
+
/**
|
|
2330
|
+
* @description Retrieve pending approvals for the tenant.
|
|
2331
|
+
*
|
|
2332
|
+
* @tags Tenant
|
|
2333
|
+
* @name ListPendingApprovals
|
|
2334
|
+
* @summary Get Pending Approvals
|
|
2335
|
+
* @request GET:/tenant/pendingApprovals
|
|
2336
|
+
* @secure
|
|
2337
|
+
*/
|
|
2338
|
+
listPendingApprovals: (params?: RequestParams) => Promise<PendingApprovalResponseSchema>;
|
|
2339
|
+
/**
|
|
2340
|
+
* @description Retrieve config for the tenant.
|
|
2341
|
+
*
|
|
2342
|
+
* @tags Tenant
|
|
2343
|
+
* @name ListConfig
|
|
2344
|
+
* @summary Get Tenant Config
|
|
2345
|
+
* @request GET:/tenant/config
|
|
2346
|
+
* @secure
|
|
2347
|
+
*/
|
|
2348
|
+
listConfig: (params?: RequestParams) => Promise<any>;
|
|
2349
|
+
/**
|
|
2350
|
+
* @description Export a report of applications based on the provided filters.
|
|
2351
|
+
*
|
|
2352
|
+
* @tags Application
|
|
2353
|
+
* @name CreateReportApplicationExport
|
|
2354
|
+
* @summary Application report
|
|
2355
|
+
* @request POST:/tenant/report/applicationExport
|
|
2356
|
+
* @secure
|
|
2357
|
+
*/
|
|
2358
|
+
createReportApplicationExport: (data: Input6Gwyovjhwz, params?: RequestParams) => Promise<any>;
|
|
2359
|
+
/**
|
|
2360
|
+
* @description Export a report of applications based on the provided filters.
|
|
2361
|
+
*
|
|
2362
|
+
* @tags Applications
|
|
2363
|
+
* @name ListReportApplicationStatus
|
|
2364
|
+
* @summary Applications report
|
|
2365
|
+
* @request POST:/tenant/report/applicationStatus
|
|
2366
|
+
* @secure
|
|
2367
|
+
*/
|
|
2368
|
+
listReportApplicationStatus: (data: Input36F4Tt4Jxa, params?: RequestParams) => Promise<any>;
|
|
2369
|
+
/**
|
|
2370
|
+
* @description Export a report of applications based on the provided filters.
|
|
2371
|
+
*
|
|
2372
|
+
* @tags Applications
|
|
2373
|
+
* @name CreateReportApplicationsReport
|
|
2374
|
+
* @summary Applications report
|
|
2375
|
+
* @request POST:/tenant/report/applicationsReport
|
|
2376
|
+
* @secure
|
|
2377
|
+
*/
|
|
2378
|
+
createReportApplicationsReport: (data: Input2Xewbjzunb, params?: RequestParams) => Promise<any>;
|
|
2379
|
+
/**
|
|
2380
|
+
* @description This route allows you to post certificates email for the tenant.
|
|
2381
|
+
*
|
|
2382
|
+
* @tags Tenant
|
|
2383
|
+
* @name CreateCertificatesEmail
|
|
2384
|
+
* @summary Post Certificates Email
|
|
2385
|
+
* @request POST:/tenant/certificates/email
|
|
2386
|
+
* @secure
|
|
2387
|
+
*/
|
|
2388
|
+
createCertificatesEmail: (data: InputV3Qfis9943, params?: RequestParams) => Promise<any>;
|
|
2389
|
+
/**
|
|
2390
|
+
* @description Generate a preview of the completed certifications report.
|
|
2391
|
+
*
|
|
2392
|
+
* @tags CompletedCertifications
|
|
2393
|
+
* @name CreateReportCompletedCertificationsPreview
|
|
2394
|
+
* @summary Preview Completed Certifications Report
|
|
2395
|
+
* @request POST:/tenant/report/completedCertifications/preview
|
|
2396
|
+
* @secure
|
|
2397
|
+
*/
|
|
2398
|
+
createReportCompletedCertificationsPreview: (query: CreateReportCompletedCertificationsPreviewParams, params?: RequestParams) => Promise<any>;
|
|
2399
|
+
/**
|
|
2400
|
+
* @description Generates the completed certifications report.
|
|
2401
|
+
*
|
|
2402
|
+
* @tags CompletedCertifications
|
|
2403
|
+
* @name ListReportCompletedCertifications
|
|
2404
|
+
* @summary Completed Certifications Report
|
|
2405
|
+
* @request POST:/tenant/report/completedCertifications
|
|
2406
|
+
* @secure
|
|
2407
|
+
*/
|
|
2408
|
+
listReportCompletedCertifications: (query: ListReportCompletedCertificationsParams, params?: RequestParams) => Promise<any>;
|
|
2409
|
+
/**
|
|
2410
|
+
* @description Redeems a license for a user by product ID.
|
|
2411
|
+
*
|
|
2412
|
+
* @tags License
|
|
2413
|
+
* @name CreateLicenseRedeem
|
|
2414
|
+
* @summary Redeem a License for a User
|
|
2415
|
+
* @request POST:/tenant/license/redeem/{userID}
|
|
2416
|
+
* @secure
|
|
2417
|
+
*/
|
|
2418
|
+
createLicenseRedeem: (userId: string, data: InputLjapkp800K, params?: RequestParams) => Promise<any>;
|
|
2419
|
+
/**
|
|
2420
|
+
* @description Generate a of the organization licenses report based on search filters.
|
|
2421
|
+
*
|
|
2422
|
+
* @tags OrgLicenses
|
|
2423
|
+
* @name ListReportOrglicenses
|
|
2424
|
+
* @summary Org Licenses Report
|
|
2425
|
+
* @request POST:/tenant/report/orglicenses/
|
|
2426
|
+
* @secure
|
|
2427
|
+
*/
|
|
2428
|
+
listReportOrglicenses: (data: InputCsz2Jddceqg, params?: RequestParams) => Promise<any>;
|
|
2429
|
+
/**
|
|
2430
|
+
* @description Generate a preview of the organization licenses report based on search filters.
|
|
2431
|
+
*
|
|
2432
|
+
* @tags OrgLicenses
|
|
2433
|
+
* @name CreateReportOrglicensesPreview
|
|
2434
|
+
* @summary Preview Org Licenses Report
|
|
2435
|
+
* @request POST:/tenant/report/orglicenses/preview
|
|
2436
|
+
* @secure
|
|
2437
|
+
*/
|
|
2438
|
+
createReportOrglicensesPreview: (data: Input9Hqlmphca8, params?: RequestParams) => Promise<any>;
|
|
2439
|
+
/**
|
|
2440
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2441
|
+
*
|
|
2442
|
+
* @tags Reports
|
|
2443
|
+
* @name CreateReportNcsoReportExport
|
|
2444
|
+
* @summary NCSO Export report
|
|
2445
|
+
* @request POST:/tenant/report/ncsoReport/export
|
|
2446
|
+
* @secure
|
|
2447
|
+
*/
|
|
2448
|
+
createReportNcsoReportExport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<NcsoReportExportRequestSchema>;
|
|
2449
|
+
/**
|
|
2450
|
+
* @description Custom NCSO specific export containing certification information for NCSO users.
|
|
2451
|
+
*
|
|
2452
|
+
* @tags Reports
|
|
2453
|
+
* @name CreateReportNcsoReport
|
|
2454
|
+
* @summary NCSO Export report
|
|
2455
|
+
* @request POST:/tenant/report/ncsoReport
|
|
2456
|
+
* @secure
|
|
2457
|
+
*/
|
|
2458
|
+
createReportNcsoReport: (data: NcsoReportRequestSchema, params?: RequestParams) => Promise<ReportXLSXSchema>;
|
|
2459
|
+
/**
|
|
2460
|
+
* @description Advanced search for users in the tenant by filters, with report generation.
|
|
2461
|
+
*
|
|
2462
|
+
* @tags Users
|
|
2463
|
+
* @name CreateReportUsersAdvanced
|
|
2464
|
+
* @summary Advanced report generated by search users from tenant by filters
|
|
2465
|
+
* @request POST:/tenant/report/users/advanced
|
|
2466
|
+
* @secure
|
|
2467
|
+
*/
|
|
2468
|
+
createReportUsersAdvanced: (data: Input80Fhicjw8R, params?: RequestParams) => Promise<any>;
|
|
2469
|
+
/**
|
|
2470
|
+
* @description Searches for users in the tenant by their IDs.
|
|
2471
|
+
*
|
|
2472
|
+
* @tags Users
|
|
2473
|
+
* @name ListSearchUsersIds
|
|
2474
|
+
* @summary Search Users from tenant by IDs
|
|
2475
|
+
* @request POST:/tenant/search/users/ids
|
|
2476
|
+
* @secure
|
|
2477
|
+
*/
|
|
2478
|
+
listSearchUsersIds: (data: InputUgivd08Qxw, params?: RequestParams) => Promise<any>;
|
|
2479
|
+
/**
|
|
2480
|
+
* @description Searches for users in the tenant by term and filters.
|
|
2481
|
+
*
|
|
2482
|
+
* @tags Users
|
|
2483
|
+
* @name CreateSearchUsersTerm
|
|
2484
|
+
* @summary Search Users from tenant by term
|
|
2485
|
+
* @request POST:/tenant/search/users/term
|
|
2486
|
+
* @secure
|
|
2487
|
+
*/
|
|
2488
|
+
createSearchUsersTerm: (data: InputJx8Xphf53G, params?: RequestParams) => Promise<any>;
|
|
2489
|
+
/**
|
|
2490
|
+
* @description Simple search for users in the tenant by term and filters, with report generation.
|
|
2491
|
+
*
|
|
2492
|
+
* @tags Users
|
|
2493
|
+
* @name CreateReportUsersSimple
|
|
2494
|
+
* @summary Simple report generated by search users from tenant by term
|
|
2495
|
+
* @request POST:/tenant/report/users/simple
|
|
2496
|
+
* @secure
|
|
2497
|
+
*/
|
|
2498
|
+
createReportUsersSimple: (data: InputVyjyqo4Fqig, params?: RequestParams) => Promise<any>;
|
|
2499
|
+
/**
|
|
2500
|
+
* @description Retrieve user by ID.
|
|
2501
|
+
*
|
|
2502
|
+
* @tags User
|
|
2503
|
+
* @name CreateSearchUsersCount
|
|
2504
|
+
* @summary Retrieve tenant user count
|
|
2505
|
+
* @request POST:/tenant/search/users/count
|
|
2506
|
+
* @secure
|
|
2507
|
+
*/
|
|
2508
|
+
createSearchUsersCount: (params?: RequestParams) => Promise<Output2Ap8L2U1E4>;
|
|
2509
|
+
};
|
|
2510
|
+
user: {
|
|
2511
|
+
/**
|
|
2512
|
+
* @description This route allows you to acknowledge a pre approval review for a certification application for a user. This is used to acknowledge the decision made during the pre approval review.
|
|
2513
|
+
*
|
|
2514
|
+
* @tags Application
|
|
2515
|
+
* @name CreateCertificationApplicationAcknowledge
|
|
2516
|
+
* @summary Acknowledge Certification Application Pre Approval Review
|
|
2517
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/acknowledge
|
|
2518
|
+
* @secure
|
|
2519
|
+
*/
|
|
2520
|
+
createCertificationApplicationAcknowledge: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
|
|
2521
|
+
/**
|
|
2522
|
+
* @description Delete application item by type.
|
|
2523
|
+
*
|
|
2524
|
+
* @tags Application
|
|
2525
|
+
* @name DeleteCertificationApplicationItem
|
|
2526
|
+
* @summary Delete Application Item
|
|
2527
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2528
|
+
* @secure
|
|
2529
|
+
*/
|
|
2530
|
+
deleteCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
|
|
2531
|
+
/**
|
|
2532
|
+
* @description This route allows you to add an item to a certification application for a user.
|
|
2533
|
+
*
|
|
2534
|
+
* @tags Application
|
|
2535
|
+
* @name CreateCertificationApplicationItem
|
|
2536
|
+
* @summary Add Application Item
|
|
2537
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/item/{sourceID}
|
|
2538
|
+
* @secure
|
|
2539
|
+
*/
|
|
2540
|
+
createCertificationApplicationItem: (userId: string, certProcId: string, applicationType: string, sourceId: string, data: InputGhzia6Oe3O, params?: RequestParams) => Promise<any>;
|
|
2541
|
+
/**
|
|
2542
|
+
* @description Delete a certification process application by type.
|
|
2543
|
+
*
|
|
2544
|
+
* @tags Application
|
|
2545
|
+
* @name DeleteCertificationApplicationBlacklist
|
|
2546
|
+
* @summary Delete Certification Process Application
|
|
2547
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}/blacklist/{sourceID}
|
|
2548
|
+
* @secure
|
|
2549
|
+
*/
|
|
2550
|
+
deleteCertificationApplicationBlacklist: (userId: string, certProcId: string, applicationType: string, sourceId: string, params?: RequestParams) => Promise<any>;
|
|
2551
|
+
/**
|
|
2552
|
+
* @description Delete certification process by user and certproc IDs.
|
|
2553
|
+
*
|
|
2554
|
+
* @tags Certification
|
|
2555
|
+
* @name DeleteCertification
|
|
2556
|
+
* @summary Delete Certification Process
|
|
2557
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}
|
|
2558
|
+
* @secure
|
|
2559
|
+
*/
|
|
2560
|
+
deleteCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2561
|
+
/**
|
|
2562
|
+
* @description Retrieve course for a user by their user ID.
|
|
2563
|
+
*
|
|
2564
|
+
* @tags Certification
|
|
2565
|
+
* @name GetCertification
|
|
2566
|
+
* @summary Get Certification Process for User
|
|
2567
|
+
* @request GET:/user/{userID}/certification/{certProcID}
|
|
2568
|
+
* @secure
|
|
2569
|
+
*/
|
|
2570
|
+
getCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<CertificationProcessResponseEntity>;
|
|
2571
|
+
/**
|
|
2572
|
+
* @description This route allows you to start a certification process for a user.
|
|
2573
|
+
*
|
|
2574
|
+
* @tags Certification
|
|
2575
|
+
* @name CreateCertification
|
|
2576
|
+
* @summary Start Certification Process
|
|
2577
|
+
* @request POST:/user/{userID}/certification/{certProcID}
|
|
2578
|
+
* @secure
|
|
2579
|
+
*/
|
|
2580
|
+
createCertification: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2581
|
+
/**
|
|
2582
|
+
* @description Delete a certification process application by type.
|
|
2583
|
+
*
|
|
2584
|
+
* @tags Application
|
|
2585
|
+
* @name DeleteCertificationApplication
|
|
2586
|
+
* @summary Delete Certification Process Application
|
|
2587
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
2588
|
+
* @secure
|
|
2589
|
+
*/
|
|
2590
|
+
deleteCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
|
|
2591
|
+
/**
|
|
2592
|
+
* @description Get certification process application by type.
|
|
2593
|
+
*
|
|
2594
|
+
* @tags Application
|
|
2595
|
+
* @name GetCertificationApplication
|
|
2596
|
+
* @summary Get Certification Process
|
|
2597
|
+
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
2598
|
+
* @secure
|
|
2599
|
+
*/
|
|
2600
|
+
getCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<CertificationApplicationResponseEntity>;
|
|
2601
|
+
/**
|
|
2602
|
+
* @description Start certification process application by type.
|
|
2603
|
+
*
|
|
2604
|
+
* @tags User
|
|
2605
|
+
* @name CreateCertificationApplication
|
|
2606
|
+
* @summary Start Certification Process Application
|
|
2607
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}
|
|
2608
|
+
* @secure
|
|
2609
|
+
*/
|
|
2610
|
+
createCertificationApplication: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
|
|
2611
|
+
/**
|
|
2612
|
+
* @description Delete course file for a user by IDs.
|
|
2613
|
+
*
|
|
2614
|
+
* @tags Course
|
|
2615
|
+
* @name DeleteCertificationCourseFileSign
|
|
2616
|
+
* @summary Delete Course File
|
|
2617
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2618
|
+
* @secure
|
|
2619
|
+
*/
|
|
2620
|
+
deleteCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<any>;
|
|
2621
|
+
/**
|
|
2622
|
+
* @description Retrieve course file for a user by IDs.
|
|
2623
|
+
*
|
|
2624
|
+
* @tags Course
|
|
2625
|
+
* @name GetCertificationCourseFileSign
|
|
2626
|
+
* @summary Get Course File
|
|
2627
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2628
|
+
* @secure
|
|
2629
|
+
*/
|
|
2630
|
+
getCertificationCourseFileSign: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<OutputKk5Ahwsca2>;
|
|
2631
|
+
/**
|
|
2632
|
+
* @description This route allows you to create a signed URL for a course file for a user in a specific course.
|
|
2633
|
+
*
|
|
2634
|
+
* @tags Course
|
|
2635
|
+
* @name CreateCertificationCourseFileSign
|
|
2636
|
+
* @summary Course file
|
|
2637
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/fileSign/{fileID}
|
|
2638
|
+
* @secure
|
|
2639
|
+
*/
|
|
2640
|
+
createCertificationCourseFileSign: ({ userId, certProcId, courseId, fileId, ...query }: CreateCertificationCourseFileSignParams, params?: RequestParams) => Promise<OutputQy22Ubvomc>;
|
|
2641
|
+
/**
|
|
2642
|
+
* @description Delete submission item (file) for a user in a course by IDs.
|
|
2643
|
+
*
|
|
2644
|
+
* @tags Course
|
|
2645
|
+
* @name DeleteCertificationCourseDocument
|
|
2646
|
+
* @summary Delete Submission Item
|
|
2647
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2648
|
+
* @secure
|
|
2649
|
+
*/
|
|
2650
|
+
deleteCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, params?: RequestParams) => Promise<any>;
|
|
2651
|
+
/**
|
|
2652
|
+
* @description This route allows you to set or override a course submission item (file) for a user in a specific course.
|
|
2653
|
+
*
|
|
2654
|
+
* @tags Course
|
|
2655
|
+
* @name CreateCertificationCourseDocument
|
|
2656
|
+
* @summary Set Course Submission Item
|
|
2657
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/document/{fileID}
|
|
2658
|
+
* @secure
|
|
2659
|
+
*/
|
|
2660
|
+
createCertificationCourseDocument: (userId: string, certProcId: string, courseId: string, fileId: string, data: InputW1Wygqy1G9, params?: RequestParams) => Promise<OutputW1Wygqy1G9>;
|
|
2661
|
+
/**
|
|
2662
|
+
* @description Delete user by ID.
|
|
2663
|
+
*
|
|
2664
|
+
* @tags User
|
|
2665
|
+
* @name DeleteUser
|
|
2666
|
+
* @summary Delete User
|
|
2667
|
+
* @request DELETE:/user/{userID}
|
|
2668
|
+
* @secure
|
|
2669
|
+
*/
|
|
2670
|
+
deleteUser: (userId: string, params?: RequestParams) => Promise<any>;
|
|
2671
|
+
/**
|
|
2672
|
+
* @description Retrieve user by ID.
|
|
2673
|
+
*
|
|
2674
|
+
* @tags User
|
|
2675
|
+
* @name GetUser
|
|
2676
|
+
* @summary Get User
|
|
2677
|
+
* @request GET:/user/{userID}
|
|
2678
|
+
* @secure
|
|
2679
|
+
*/
|
|
2680
|
+
getUser: (userId: string, params?: RequestParams) => Promise<UserResponseEntity>;
|
|
2681
|
+
/**
|
|
2682
|
+
* @description Create a new user in the system. This endpoint allows you to create a user with the provided details. The user will be added to the database and an email notification will be sent to the user.
|
|
2683
|
+
*
|
|
2684
|
+
* @tags User
|
|
2685
|
+
* @name CreateUser
|
|
2686
|
+
* @summary CreateUser
|
|
2687
|
+
* @request POST:/user/{userID}
|
|
2688
|
+
* @secure
|
|
2689
|
+
*/
|
|
2690
|
+
createUser: (userId: string, data: Input7All4Ddetf, params?: RequestParams) => Promise<any>;
|
|
2691
|
+
/**
|
|
2692
|
+
* @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user.
|
|
2693
|
+
*
|
|
2694
|
+
* @tags User
|
|
2695
|
+
* @name UpdateUser
|
|
2696
|
+
* @summary Update User
|
|
2697
|
+
* @request PUT:/user/{userID}
|
|
2698
|
+
* @secure
|
|
2699
|
+
*/
|
|
2700
|
+
updateUser: (userId: string, data: InputIqnpk7Aisr, params?: RequestParams) => Promise<any>;
|
|
2701
|
+
/**
|
|
2702
|
+
* @description Delete course from user
|
|
2703
|
+
*
|
|
2704
|
+
* @tags User
|
|
2705
|
+
* @name DeleteCertificationCourse
|
|
2706
|
+
* @summary Delete course from user
|
|
2707
|
+
* @request DELETE:/user/{userID}/certification/{certProcID}/course/{courseID}
|
|
2708
|
+
* @secure
|
|
2709
|
+
*/
|
|
2710
|
+
deleteCertificationCourse: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2711
|
+
/**
|
|
2712
|
+
* @description Generate a signed url to download a specific file version of an application item for a user in a certification process.
|
|
2713
|
+
*
|
|
2714
|
+
* @tags Application
|
|
2715
|
+
* @name GetCertificationApplicationItemFile
|
|
2716
|
+
* @summary Get Application Item File
|
|
2717
|
+
* @request GET:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2718
|
+
* @secure
|
|
2719
|
+
*/
|
|
2720
|
+
getCertificationApplicationItemFile: (userId: string, certProcId: string, sourceId: string, fileVersion: string, params?: RequestParams) => Promise<Output1Oh09Nkr3Mj>;
|
|
2721
|
+
/**
|
|
2722
|
+
* @description Generate a signed URL for uploading a specific file version of an application item for a user in a certification process.
|
|
2723
|
+
*
|
|
2724
|
+
* @tags Application
|
|
2725
|
+
* @name CreateCertificationApplicationItemFile
|
|
2726
|
+
* @summary Post Application Item File
|
|
2727
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/file/{fileVersion}
|
|
2728
|
+
* @secure
|
|
2729
|
+
*/
|
|
2730
|
+
createCertificationApplicationItemFile: ({ userId, certProcId, sourceId, fileVersion, ...query }: CreateCertificationApplicationItemFileParams, params?: RequestParams) => Promise<OutputKfff393Yn2K>;
|
|
2731
|
+
/**
|
|
2732
|
+
* @description Retrieve the cancelation charges for a course based on the user, session, and course details.
|
|
2733
|
+
*
|
|
2734
|
+
* @tags Course
|
|
2735
|
+
* @name GetCertificationCourseSessionCalcCancelationCharges
|
|
2736
|
+
* @summary Get cancelation charges
|
|
2737
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/calcCancelationCharges
|
|
2738
|
+
* @secure
|
|
2739
|
+
*/
|
|
2740
|
+
getCertificationCourseSessionCalcCancelationCharges: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<OutputU7Gnd99Lsg>;
|
|
2741
|
+
/**
|
|
2742
|
+
* @description Retrieves the certification processes for a user by their user ID.
|
|
2743
|
+
*
|
|
2744
|
+
* @tags Certifications
|
|
2745
|
+
* @name GetCertifications
|
|
2746
|
+
* @summary Certifications for User
|
|
2747
|
+
* @request GET:/user/{userID}/certifications
|
|
2748
|
+
* @secure
|
|
2749
|
+
*/
|
|
2750
|
+
getCertifications: (userId: string, params?: RequestParams) => Promise<CertificationProcessResponseSchema>;
|
|
2751
|
+
/**
|
|
2752
|
+
* @description Retrieve course for a user by their user ID and courseID (cpID::examID).
|
|
2753
|
+
*
|
|
2754
|
+
* @tags Course
|
|
2755
|
+
* @name GetCourse
|
|
2756
|
+
* @summary Get Course
|
|
2757
|
+
* @request GET:/user/{userID}/course/{courseID}
|
|
2758
|
+
* @secure
|
|
2759
|
+
*/
|
|
2760
|
+
getCourse: (userId: string, courseId: string, params?: RequestParams) => Promise<CourseResponseEntity>;
|
|
2761
|
+
/**
|
|
2762
|
+
* @description Retrieves the certification processes expanded for a user by their user ID.
|
|
2763
|
+
*
|
|
2764
|
+
* @tags Certifications
|
|
2765
|
+
* @name GetCertificationsExpanded
|
|
2766
|
+
* @summary Certifications expanded for User
|
|
2767
|
+
* @request GET:/user/{userID}/certifications/expanded
|
|
2768
|
+
* @secure
|
|
2769
|
+
*/
|
|
2770
|
+
getCertificationsExpanded: (userId: string, params?: RequestParams) => Promise<UserExpandedCPResponseSchema>;
|
|
2771
|
+
/**
|
|
2772
|
+
* @description Get certification process application by type.
|
|
2773
|
+
*
|
|
2774
|
+
* @tags Application
|
|
2775
|
+
* @name GetCertificationApplicationForeignFill
|
|
2776
|
+
* @summary Get Certification Process
|
|
2777
|
+
* @request GET:/user/{userID}/certification/{certProcID}/application/{applicationType}/foreignFill
|
|
2778
|
+
* @secure
|
|
2779
|
+
*/
|
|
2780
|
+
getCertificationApplicationForeignFill: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<OutputYh2G6Inklt>;
|
|
2781
|
+
/**
|
|
2782
|
+
* @description This endpoint will print certificate
|
|
2783
|
+
*
|
|
2784
|
+
* @tags Certification
|
|
2785
|
+
* @name GetCertificationPrint
|
|
2786
|
+
* @summary Print Certificate
|
|
2787
|
+
* @request GET:/user/{userID}/certification/{certProcID}/print
|
|
2788
|
+
* @secure
|
|
2789
|
+
*/
|
|
2790
|
+
getCertificationPrint: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2791
|
+
/**
|
|
2792
|
+
* @description This endpoint will print course
|
|
2793
|
+
*
|
|
2794
|
+
* @tags Course
|
|
2795
|
+
* @name GetCertificationCoursePrint
|
|
2796
|
+
* @summary Print Course
|
|
2797
|
+
* @request GET:/user/{userID}/certification/{certProcID}/course/{courseID}/print
|
|
2798
|
+
* @secure
|
|
2799
|
+
*/
|
|
2800
|
+
getCertificationCoursePrint: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
2801
|
+
/**
|
|
2802
|
+
* @description Returns the requirement status (e.g. student history) for a given user and source (e.g. course)
|
|
2803
|
+
*
|
|
2804
|
+
* @tags Requirement
|
|
2805
|
+
* @name GetRequirement
|
|
2806
|
+
* @summary Get user requirement status
|
|
2807
|
+
* @request GET:/user/{userID}/requirement/{sourceID}
|
|
2808
|
+
* @secure
|
|
2809
|
+
*/
|
|
2810
|
+
getRequirement: (userId: string, sourceId: string, params?: RequestParams) => Promise<StudentHistoryResponseSchema>;
|
|
2811
|
+
/**
|
|
2812
|
+
* @description Retrieves the upcoming courses for a user by their user ID.
|
|
2813
|
+
*
|
|
2814
|
+
* @tags Certifications
|
|
2815
|
+
* @name GetCertificationsUpcomingCourses
|
|
2816
|
+
* @summary Get Upcoming Courses for User
|
|
2817
|
+
* @request GET:/user/{userID}/certifications/upcomingCourses
|
|
2818
|
+
* @secure
|
|
2819
|
+
*/
|
|
2820
|
+
getCertificationsUpcomingCourses: (userId: string, params?: RequestParams) => Promise<UserUpcomingCoursesResponseSchema>;
|
|
2821
|
+
/**
|
|
2822
|
+
* @description Retrieve user data from IDM including user profile and partition data. Uses API credentials for full read access.
|
|
2823
|
+
*
|
|
2824
|
+
* @tags User
|
|
2825
|
+
* @name GetUserData
|
|
2826
|
+
* @summary Get User Data
|
|
2827
|
+
* @request GET:/user/{userID}/userData
|
|
2828
|
+
* @secure
|
|
2829
|
+
*/
|
|
2830
|
+
getUserData: (userId: string, params?: RequestParams) => Promise<UserDataResponse>;
|
|
2831
|
+
/**
|
|
2832
|
+
* @description This route indicates users should not be able to advance or make changes to applications in this certification.
|
|
2833
|
+
*
|
|
2834
|
+
* @tags Application
|
|
2835
|
+
* @name CreateCertificationApplicationLock
|
|
2836
|
+
* @summary Lock Certification Application
|
|
2837
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/lock
|
|
2838
|
+
* @secure
|
|
2839
|
+
*/
|
|
2840
|
+
createCertificationApplicationLock: (userId: string, certProcId: string, applicationType: string, data: Input9Hlh5Puwxcf, params?: RequestParams) => Promise<any>;
|
|
2841
|
+
/**
|
|
2842
|
+
* @description This endpoint allows you to add a user to a session in a certification process. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
2843
|
+
*
|
|
2844
|
+
* @tags User
|
|
2845
|
+
* @name CreateSessionAdd
|
|
2846
|
+
* @summary Add user to session
|
|
2847
|
+
* @request POST:/user/{userID}/session/{sessionID}/add
|
|
2848
|
+
* @secure
|
|
2849
|
+
*/
|
|
2850
|
+
createSessionAdd: (userId: string, sessionId: string, params?: RequestParams) => Promise<any>;
|
|
2851
|
+
/**
|
|
2852
|
+
* @description This route allows a user to request pre-approval for an application type in a certification process.
|
|
2853
|
+
*
|
|
2854
|
+
* @tags Application
|
|
2855
|
+
* @name CreateCertificationApplicationPreApproval
|
|
2856
|
+
* @summary Certification Application Pre Approval
|
|
2857
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApproval
|
|
2858
|
+
* @secure
|
|
2859
|
+
*/
|
|
2860
|
+
createCertificationApplicationPreApproval: (userId: string, certProcId: string, applicationType: string, params?: RequestParams) => Promise<any>;
|
|
2861
|
+
/**
|
|
2862
|
+
* @description This route allows you to review a certification application for a user.
|
|
2863
|
+
*
|
|
2864
|
+
* @tags Application
|
|
2865
|
+
* @name CreateCertificationApplicationReview
|
|
2866
|
+
* @summary Review Certification Application
|
|
2867
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/review
|
|
2868
|
+
* @secure
|
|
2869
|
+
*/
|
|
2870
|
+
createCertificationApplicationReview: (userId: string, certProcId: string, applicationType: string, data: Input399F4Vzf2A, params?: RequestParams) => Promise<any>;
|
|
2871
|
+
/**
|
|
2872
|
+
* @description This route allows you to pre approval review a certification application for a user. This is used to review applications before they are submitted for final approval.
|
|
2873
|
+
*
|
|
2874
|
+
* @tags Application
|
|
2875
|
+
* @name CreateCertificationApplicationPreApprovalReview
|
|
2876
|
+
* @summary Pre Approval Review Certification Application
|
|
2877
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/preApprovalReview
|
|
2878
|
+
* @secure
|
|
2879
|
+
*/
|
|
2880
|
+
createCertificationApplicationPreApprovalReview: (userId: string, certProcId: string, applicationType: string, data: InputPlz242Pxo1, params?: RequestParams) => Promise<any>;
|
|
2881
|
+
/**
|
|
2882
|
+
* @description This endpoint allows the redemption of a batch course for a user in a certification process. It requires the user ID and certification process ID as path parameters, and the course redemption details in the request body.
|
|
2883
|
+
*
|
|
2884
|
+
* @tags Certification
|
|
2885
|
+
* @name CreateCertificationCourseBatchRedeem
|
|
2886
|
+
* @summary Redeem Batch Course for User
|
|
2887
|
+
* @request POST:/user/certification/{certSpecID}/course/batchRedeem
|
|
2888
|
+
* @secure
|
|
2889
|
+
*/
|
|
2890
|
+
createCertificationCourseBatchRedeem: (certSpecId: string, data: InputWipuiyq3Gx, params?: RequestParams) => Promise<any>;
|
|
2891
|
+
/**
|
|
2892
|
+
* @description This endpoint allows for batch redeeming of course invites for a certification specification.
|
|
2893
|
+
*
|
|
2894
|
+
* @tags Course
|
|
2895
|
+
* @name CreateCertificationCourseBatchInvite
|
|
2896
|
+
* @summary Batch Course Invite
|
|
2897
|
+
* @request POST:/user/certification/{certSpecID}/course/batchInvite
|
|
2898
|
+
* @secure
|
|
2899
|
+
*/
|
|
2900
|
+
createCertificationCourseBatchInvite: (certSpecId: string, data: InputS9Wa09Jr5M, params?: RequestParams) => Promise<any>;
|
|
2901
|
+
/**
|
|
2902
|
+
* @description This endpoint allows you to cancel a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, course ID, and session ID as path parameters.
|
|
2903
|
+
*
|
|
2904
|
+
* @tags Certification
|
|
2905
|
+
* @name CreateCertificationCourseSessionCancelEnrol
|
|
2906
|
+
* @summary Cancel Certification Enrolment
|
|
2907
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/cancelEnrol
|
|
2908
|
+
* @secure
|
|
2909
|
+
*/
|
|
2910
|
+
createCertificationCourseSessionCancelEnrol: (userId: string, certProcId: string, courseId: string, sessionId: string, params?: RequestParams) => Promise<any>;
|
|
2911
|
+
/**
|
|
2912
|
+
* @description This route allows you to renew a certification process for a user. It will change the state of the certification process to "in progress" and reset the expiration date.
|
|
2913
|
+
*
|
|
2914
|
+
* @tags Certification
|
|
2915
|
+
* @name CreateCertificationRenew
|
|
2916
|
+
* @summary Renew Certification Process
|
|
2917
|
+
* @request POST:/user/{userID}/certification/{certProcID}/renew
|
|
2918
|
+
* @secure
|
|
2919
|
+
*/
|
|
2920
|
+
createCertificationRenew: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2921
|
+
/**
|
|
2922
|
+
* @description This route allows you to restart a certification process for a user.
|
|
2923
|
+
*
|
|
2924
|
+
* @tags Certification
|
|
2925
|
+
* @name CreateCertificationRestart
|
|
2926
|
+
* @summary Restart Certification Process
|
|
2927
|
+
* @request POST:/user/{userID}/certification/{certProcID}/restart
|
|
2928
|
+
* @secure
|
|
2929
|
+
*/
|
|
2930
|
+
createCertificationRestart: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2931
|
+
/**
|
|
2932
|
+
* @description This route allows you to waive a certification process for a user.
|
|
2933
|
+
*
|
|
2934
|
+
* @tags Certification
|
|
2935
|
+
* @name CreateCertificationWaive
|
|
2936
|
+
* @summary Waive Certification Process
|
|
2937
|
+
* @request POST:/user/{userID}/certification/{certProcID}/waive
|
|
2938
|
+
* @secure
|
|
2939
|
+
*/
|
|
2940
|
+
createCertificationWaive: (userId: string, certProcId: string, data: Input9Idwlxns6V, params?: RequestParams) => Promise<any>;
|
|
2941
|
+
/**
|
|
2942
|
+
* @description This endpoint moves a user in a certification process to another user by checking the requirements for the specified user and certification process.
|
|
2943
|
+
*
|
|
2944
|
+
* @tags Certification
|
|
2945
|
+
* @name CreateCertificationMove
|
|
2946
|
+
* @summary Move Certification
|
|
2947
|
+
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}
|
|
2948
|
+
* @secure
|
|
2949
|
+
*/
|
|
2950
|
+
createCertificationMove: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<OutputAwpe8Eohm3>;
|
|
2951
|
+
/**
|
|
2952
|
+
* @description This endpoint allows you to replace a certification enrolment for a user in a specific course session. It requires the user ID, certification process ID, secondary user ID, course ID, and session ID as path parameters.
|
|
2953
|
+
*
|
|
2954
|
+
* @tags Certification
|
|
2955
|
+
* @name CreateCertificationCourseSessionReplace
|
|
2956
|
+
* @summary Replace Certification Enrolment
|
|
2957
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/session/{sessionID}/replace/{secUserID}
|
|
2958
|
+
* @secure
|
|
2959
|
+
*/
|
|
2960
|
+
createCertificationCourseSessionReplace: (userId: string, certProcId: string, courseId: string, sessionId: string, secUserId: string, params?: RequestParams) => Promise<any>;
|
|
2961
|
+
/**
|
|
2962
|
+
* @description This route allows you to set a trigger check for a certification process, such as blocking courses.
|
|
2963
|
+
*
|
|
2964
|
+
* @tags Certification
|
|
2965
|
+
* @name CreateCertificationTriggerCheck
|
|
2966
|
+
* @summary Set trigger check for certification process
|
|
2967
|
+
* @request POST:/user/{userID}/certification/{certProcID}/trigger/check
|
|
2968
|
+
* @secure
|
|
2969
|
+
*/
|
|
2970
|
+
createCertificationTriggerCheck: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
2971
|
+
/**
|
|
2972
|
+
* @description This route allows you to set a trigger for a certification process, such as blocking courses.
|
|
2973
|
+
*
|
|
2974
|
+
* @tags Certification
|
|
2975
|
+
* @name CreateCertificationTriggerSet
|
|
2976
|
+
* @summary Set trigger for certification process
|
|
2977
|
+
* @request POST:/user/{userID}/certification/{certProcID}/trigger/set
|
|
2978
|
+
* @secure
|
|
2979
|
+
*/
|
|
2980
|
+
createCertificationTriggerSet: (userId: string, certProcId: string, data: Input5Rbt3210Wa, params?: RequestParams) => Promise<any>;
|
|
2981
|
+
/**
|
|
2982
|
+
* @description This endpoint allows you to refresh the organization membership for a user by providing the user ID and the requirements to be checked.
|
|
2983
|
+
*
|
|
2984
|
+
* @tags User
|
|
2985
|
+
* @name CreateRefreshOrgMembership
|
|
2986
|
+
* @summary Refresh Organization Membership
|
|
2987
|
+
* @request POST:/user/{userID}/refreshOrgMembership
|
|
2988
|
+
* @secure
|
|
2989
|
+
*/
|
|
2990
|
+
createRefreshOrgMembership: (userId: string, params?: RequestParams) => Promise<any>;
|
|
2991
|
+
/**
|
|
2992
|
+
* @description This route allows you to retake a course for a certification process for a user in a specific course.
|
|
2993
|
+
*
|
|
2994
|
+
* @tags Course
|
|
2995
|
+
* @name CreateCertificationCourseRetake
|
|
2996
|
+
* @summary Retake Course
|
|
2997
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/retake
|
|
2998
|
+
* @secure
|
|
2999
|
+
*/
|
|
3000
|
+
createCertificationCourseRetake: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3001
|
+
/**
|
|
3002
|
+
* @description This route allows you to revoke a course for a certification process for a user in a specific course.
|
|
3003
|
+
*
|
|
3004
|
+
* @tags Course
|
|
3005
|
+
* @name CreateCertificationCourseRevoke
|
|
3006
|
+
* @summary Revoke Course
|
|
3007
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/revoke
|
|
3008
|
+
* @secure
|
|
3009
|
+
*/
|
|
3010
|
+
createCertificationCourseRevoke: (userId: string, certProcId: string, courseId: string, params?: RequestParams) => Promise<any>;
|
|
3011
|
+
/**
|
|
3012
|
+
* @description Remove a specific version of an application item for a user in a certification process.
|
|
3013
|
+
*
|
|
3014
|
+
* @tags Application
|
|
3015
|
+
* @name CreateCertificationApplicationItemRemove
|
|
3016
|
+
* @summary Remove Application Item
|
|
3017
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/remove/{itemVersion}
|
|
3018
|
+
* @secure
|
|
3019
|
+
*/
|
|
3020
|
+
createCertificationApplicationItemRemove: (userId: string, certProcId: string, sourceId: string, itemVersion: string, params?: RequestParams) => Promise<any>;
|
|
3021
|
+
/**
|
|
3022
|
+
* @description Remove a specific version of an application item for a user in a certification process.
|
|
3023
|
+
*
|
|
3024
|
+
* @tags Application
|
|
3025
|
+
* @name CreateCertificationApplicationItemReview
|
|
3026
|
+
* @summary Remove Application Item
|
|
3027
|
+
* @request POST:/user/{userID}/certification/{certProcID}/applicationItem/{sourceID}/review/{itemVersion}
|
|
3028
|
+
* @secure
|
|
3029
|
+
*/
|
|
3030
|
+
createCertificationApplicationItemReview: (userId: string, certProcId: string, sourceId: string, itemVersion: string, data: InputTnjt9Libv1, params?: RequestParams) => Promise<any>;
|
|
3031
|
+
/**
|
|
3032
|
+
* @description Returns the status of multiple requirements (e.g. student history) for a given user
|
|
3033
|
+
*
|
|
3034
|
+
* @tags Requirements
|
|
3035
|
+
* @name ListRequirements
|
|
3036
|
+
* @summary User requirements status
|
|
3037
|
+
* @request POST:/user/{userID}/requirements
|
|
3038
|
+
* @secure
|
|
3039
|
+
*/
|
|
3040
|
+
listRequirements: (userId: string, data: StudentHistoryRequestSchema, params?: RequestParams) => Promise<StudentHistoryResponseSchema>;
|
|
3041
|
+
/**
|
|
3042
|
+
* @description Request certification process application submission approval
|
|
3043
|
+
*
|
|
3044
|
+
* @tags Application
|
|
3045
|
+
* @name CreateCertificationApplicationSubmit
|
|
3046
|
+
* @summary Submit Application Approval
|
|
3047
|
+
* @request POST:/user/{userID}/certification/{certProcID}/application/{applicationType}/submit
|
|
3048
|
+
* @secure
|
|
3049
|
+
*/
|
|
3050
|
+
createCertificationApplicationSubmit: (userId: string, certProcId: string, applicationType: string, data: InputXx8Af8Xgud, params?: RequestParams) => Promise<any>;
|
|
3051
|
+
/**
|
|
3052
|
+
* @description This route allows you to submit a pending approval.
|
|
3053
|
+
*
|
|
3054
|
+
* @tags Course
|
|
3055
|
+
* @name CreateCertificationCoursePendingApproval
|
|
3056
|
+
* @summary Submit Pending Approval
|
|
3057
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3058
|
+
* @secure
|
|
3059
|
+
*/
|
|
3060
|
+
createCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: InputKat1Qr6Mvq, params?: RequestParams) => Promise<any>;
|
|
3061
|
+
/**
|
|
3062
|
+
* @description This route allows you to review a pending approval.
|
|
3063
|
+
*
|
|
3064
|
+
* @tags Course
|
|
3065
|
+
* @name UpdateCertificationCoursePendingApproval
|
|
3066
|
+
* @summary Review Pending Approval
|
|
3067
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/pendingApproval/{paID}
|
|
3068
|
+
* @secure
|
|
3069
|
+
*/
|
|
3070
|
+
updateCertificationCoursePendingApproval: (userId: string, certProcId: string, courseId: string, paId: string, data: Input11X2Ed4Ag4, params?: RequestParams) => Promise<any>;
|
|
3071
|
+
/**
|
|
3072
|
+
* @description Redeems a license for a user by product ID.
|
|
3073
|
+
*
|
|
3074
|
+
* @tags License
|
|
3075
|
+
* @name CreateCertificationCourseRedeem
|
|
3076
|
+
* @summary Redeem a License for a User
|
|
3077
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/redeem
|
|
3078
|
+
* @secure
|
|
3079
|
+
*/
|
|
3080
|
+
createCertificationCourseRedeem: (userId: string, certProcId: string, data: Input5C1Vlfuer8, params?: RequestParams) => Promise<any>;
|
|
3081
|
+
/**
|
|
3082
|
+
* @description This endpoint validates the move of a user in a certification process by checking the requirements for the specified user and certification process.
|
|
3083
|
+
*
|
|
3084
|
+
* @tags Certification
|
|
3085
|
+
* @name CreateCertificationMoveValidate
|
|
3086
|
+
* @summary Validate Certification Move
|
|
3087
|
+
* @request POST:/user/{userID}/certification/{certProcID}/move/{secUserID}/validate
|
|
3088
|
+
* @secure
|
|
3089
|
+
*/
|
|
3090
|
+
createCertificationMoveValidate: (userId: string, certProcId: string, secUserId: string, params?: RequestParams) => Promise<Output14Cjbffl65>;
|
|
3091
|
+
/**
|
|
3092
|
+
* @description This route allows you to end the course period for a certification process for a user in a specific course.
|
|
3093
|
+
*
|
|
3094
|
+
* @tags Course
|
|
3095
|
+
* @name CreateCertificationCourseEndCooldown
|
|
3096
|
+
* @summary End Course Cooldown
|
|
3097
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/endCooldown
|
|
3098
|
+
* @secure
|
|
3099
|
+
*/
|
|
3100
|
+
createCertificationCourseEndCooldown: (userId: string, certProcId: string, courseId: string, data: InputT941Yc1Ixd, params?: RequestParams) => Promise<any>;
|
|
3101
|
+
/**
|
|
3102
|
+
* @description This route allows you to unlock a course for a certification process for a user in a specific course.
|
|
3103
|
+
*
|
|
3104
|
+
* @tags Course
|
|
3105
|
+
* @name CreateCertificationCourseUnlockCourse
|
|
3106
|
+
* @summary Unlock Course
|
|
3107
|
+
* @request POST:/user/{userID}/certification/{certProcID}/course/{courseID}/unlockCourse
|
|
3108
|
+
* @secure
|
|
3109
|
+
*/
|
|
3110
|
+
createCertificationCourseUnlockCourse: (userId: string, certProcId: string, courseId: string, data: Input4Qafniraggl, params?: RequestParams) => Promise<any>;
|
|
3111
|
+
/**
|
|
3112
|
+
* @description This endpoint allows updating the ITA number for a user. It requires the user ID as a path parameter and the new ITA number in the request body.
|
|
3113
|
+
*
|
|
3114
|
+
* @tags User
|
|
3115
|
+
* @name CreateUpdateIta
|
|
3116
|
+
* @summary Update User ITA Number
|
|
3117
|
+
* @request POST:/user/{userID}/updateITA
|
|
3118
|
+
* @secure
|
|
3119
|
+
*/
|
|
3120
|
+
createUpdateIta: (userId: string, data: InputBq2R7Mz35F, params?: RequestParams) => Promise<any>;
|
|
3121
|
+
/**
|
|
3122
|
+
* @description This route allows you to override the result of a course for a user in a certification process.
|
|
3123
|
+
*
|
|
3124
|
+
* @tags Course
|
|
3125
|
+
* @name UpdateCertificationCourseOverrideResult
|
|
3126
|
+
* @summary Override Course Result
|
|
3127
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/course/{courseID}/overrideResult
|
|
3128
|
+
* @secure
|
|
3129
|
+
*/
|
|
3130
|
+
updateCertificationCourseOverrideResult: (userId: string, certProcId: string, courseId: string, data: InputDafkg0Qaax, params?: RequestParams) => Promise<any>;
|
|
3131
|
+
/**
|
|
3132
|
+
* @description This route allows you to set or override the dates for a certification process for a user.
|
|
3133
|
+
*
|
|
3134
|
+
* @tags Certification
|
|
3135
|
+
* @name UpdateCertificationSetDates
|
|
3136
|
+
* @summary Set Certification Dates
|
|
3137
|
+
* @request PUT:/user/{userID}/certification/{certProcID}/setDates
|
|
3138
|
+
* @secure
|
|
3139
|
+
*/
|
|
3140
|
+
updateCertificationSetDates: (userId: string, certProcId: string, data: Input61Papmu6Rw, params?: RequestParams) => Promise<any>;
|
|
3141
|
+
/**
|
|
3142
|
+
* @description This route allows you to publish certification information to a LMS event bus.
|
|
3143
|
+
*
|
|
3144
|
+
* @tags Certification
|
|
3145
|
+
* @name CreateCertificationPublishInfo
|
|
3146
|
+
* @summary Publish certification information to LMS event bus
|
|
3147
|
+
* @request POST:/user/{userID}/certification/{certProcID}/publishInfo
|
|
3148
|
+
* @secure
|
|
3149
|
+
*/
|
|
3150
|
+
createCertificationPublishInfo: (userId: string, certProcId: string, params?: RequestParams) => Promise<any>;
|
|
3151
|
+
};
|
|
3152
|
+
users: {
|
|
3153
|
+
/**
|
|
3154
|
+
* @description Searches for users by their certification specifications.
|
|
3155
|
+
*
|
|
3156
|
+
* @tags Users
|
|
3157
|
+
* @name CreateCertification
|
|
3158
|
+
* @summary Search Users by Certification
|
|
3159
|
+
* @request POST:/users/certification/{certSpecID}
|
|
3160
|
+
* @secure
|
|
3161
|
+
*/
|
|
3162
|
+
createCertification: (certSpecId: string, data: InputOrbzcylnioi, params?: RequestParams) => Promise<OutputOrbzcylnioi>;
|
|
3163
|
+
/**
|
|
3164
|
+
* @description Publishes all certification information for the specified certification specification (certSpecID). Triggers a bulk publish event for this certification.
|
|
3165
|
+
*
|
|
3166
|
+
* @tags Users
|
|
3167
|
+
* @name CreateCertificationPublishInfo
|
|
3168
|
+
* @summary Publish Certification Information
|
|
3169
|
+
* @request POST:/users/certification/{certSpecID}/publishInfo
|
|
3170
|
+
* @secure
|
|
3171
|
+
*/
|
|
3172
|
+
createCertificationPublishInfo: (certSpecId: string, params?: RequestParams) => Promise<any>;
|
|
3173
|
+
};
|
|
3174
|
+
}
|