@iblai/iblai-api 3.48.3-ai-plus → 3.48.4-ai

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.
Files changed (162) hide show
  1. package/dist/index.cjs.js +5918 -6748
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +5919 -6747
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +5918 -6748
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +1 -40
  8. package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
  9. package/dist/types/models/Voice.d.ts +2 -2
  10. package/dist/types/services/AiAccountService.d.ts +66 -41
  11. package/dist/types/services/AiAnalyticsService.d.ts +2021 -923
  12. package/dist/types/services/AiIndexService.d.ts +78 -71
  13. package/dist/types/services/AiMarketingService.d.ts +17 -13
  14. package/dist/types/services/AiMediaService.d.ts +45 -41
  15. package/dist/types/services/AiMentorService.d.ts +1545 -1037
  16. package/dist/types/services/AiPromptService.d.ts +342 -228
  17. package/dist/types/services/AnalyticsService.d.ts +42 -13
  18. package/dist/types/services/AudienceService.d.ts +345 -149
  19. package/dist/types/services/CareerService.d.ts +117 -90
  20. package/dist/types/services/CatalogService.d.ts +3735 -1072
  21. package/dist/types/services/CoreService.d.ts +441 -215
  22. package/dist/types/services/CredentialsService.d.ts +173 -138
  23. package/dist/types/services/DepartmentsService.d.ts +53 -16
  24. package/dist/types/services/EngagementService.d.ts +459 -179
  25. package/dist/types/services/FeaturesService.d.ts +16 -7
  26. package/dist/types/services/FinanceService.d.ts +49 -20
  27. package/dist/types/services/MediaResourcesService.d.ts +243 -67
  28. package/dist/types/services/NotificationBuilderService.d.ts +31 -17
  29. package/dist/types/services/NotificationService.d.ts +56 -49
  30. package/dist/types/services/OrgsService.d.ts +106 -77
  31. package/dist/types/services/OverviewService.d.ts +154 -55
  32. package/dist/types/services/PerformanceService.d.ts +132 -56
  33. package/dist/types/services/PerlearnerService.d.ts +431 -217
  34. package/dist/types/services/PlatformService.d.ts +221 -116
  35. package/dist/types/services/ProviderAssociationService.d.ts +3 -2
  36. package/dist/types/services/ProvidersService.d.ts +27 -18
  37. package/dist/types/services/ProvisionService.d.ts +3 -2
  38. package/dist/types/services/RecommendationsService.d.ts +3 -3
  39. package/dist/types/services/ReportsService.d.ts +22 -16
  40. package/dist/types/services/RolesService.d.ts +8 -6
  41. package/dist/types/services/SearchService.d.ts +730 -195
  42. package/dist/types/services/ServiceService.d.ts +33 -29
  43. package/dist/types/services/SkillsService.d.ts +40 -32
  44. package/dist/types/services/UserGroupsService.d.ts +53 -16
  45. package/package.json +1 -1
  46. package/src/core/OpenAPI.ts +1 -1
  47. package/src/index.ts +1 -40
  48. package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
  49. package/src/models/Voice.ts +2 -2
  50. package/src/services/AiAccountService.ts +81 -55
  51. package/src/services/AiAnalyticsService.ts +2422 -1181
  52. package/src/services/AiIndexService.ts +112 -87
  53. package/src/services/AiMarketingService.ts +25 -16
  54. package/src/services/AiMediaService.ts +67 -51
  55. package/src/services/AiMentorService.ts +2105 -1265
  56. package/src/services/AiPromptService.ts +484 -275
  57. package/src/services/AnalyticsService.ts +45 -16
  58. package/src/services/AudienceService.ts +380 -184
  59. package/src/services/CareerService.ts +144 -117
  60. package/src/services/CatalogService.ts +3995 -1332
  61. package/src/services/CoreService.ts +523 -291
  62. package/src/services/CredentialsService.ts +253 -173
  63. package/src/services/DepartmentsService.ts +56 -19
  64. package/src/services/EngagementService.ts +528 -236
  65. package/src/services/FeaturesService.ts +19 -10
  66. package/src/services/FinanceService.ts +54 -25
  67. package/src/services/MediaResourcesService.ts +251 -75
  68. package/src/services/NotificationBuilderService.ts +36 -22
  69. package/src/services/NotificationService.ts +73 -61
  70. package/src/services/OrgsService.ts +135 -106
  71. package/src/services/OverviewService.ts +172 -73
  72. package/src/services/PerformanceService.ts +153 -77
  73. package/src/services/PerlearnerService.ts +591 -279
  74. package/src/services/PlatformService.ts +278 -157
  75. package/src/services/ProviderAssociationService.ts +4 -3
  76. package/src/services/ProvidersService.ts +36 -27
  77. package/src/services/ProvisionService.ts +4 -3
  78. package/src/services/RecommendationsService.ts +5 -4
  79. package/src/services/ReportsService.ts +28 -22
  80. package/src/services/RolesService.ts +10 -8
  81. package/src/services/SearchService.ts +771 -236
  82. package/src/services/ServiceService.ts +49 -39
  83. package/src/services/SkillsService.ts +56 -44
  84. package/src/services/UserGroupsService.ts +56 -19
  85. package/dist/types/models/Bot.d.ts +0 -15
  86. package/dist/types/models/BotCommand.d.ts +0 -6
  87. package/dist/types/models/BotCreate.d.ts +0 -12
  88. package/dist/types/models/DataSet.d.ts +0 -21
  89. package/dist/types/models/DataSetCreate.d.ts +0 -12
  90. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  91. package/dist/types/models/DiscordConfig.d.ts +0 -7
  92. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  93. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  94. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  95. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  96. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  97. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  98. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  99. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  100. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  101. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  102. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  103. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  104. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  105. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  106. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  107. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  108. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  109. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  110. package/dist/types/models/SlackConfig.d.ts +0 -8
  111. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  112. package/dist/types/models/SlackWebhook.d.ts +0 -6
  113. package/dist/types/models/TeamsConfig.d.ts +0 -7
  114. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  115. package/dist/types/models/Training.d.ts +0 -41
  116. package/dist/types/models/TrainingCreate.d.ts +0 -31
  117. package/dist/types/models/WebexConfig.d.ts +0 -10
  118. package/dist/types/models/WebexWebhook.d.ts +0 -4
  119. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  120. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  121. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  122. package/dist/types/services/AiBotService.d.ts +0 -486
  123. package/dist/types/services/AiFinetuningService.d.ts +0 -162
  124. package/src/models/Bot.ts +0 -20
  125. package/src/models/BotCommand.ts +0 -11
  126. package/src/models/BotCreate.ts +0 -17
  127. package/src/models/DataSet.ts +0 -26
  128. package/src/models/DataSetCreate.ts +0 -17
  129. package/src/models/DataSetStatusEnum.ts +0 -16
  130. package/src/models/DiscordConfig.ts +0 -12
  131. package/src/models/DiscordUserConfig.ts +0 -15
  132. package/src/models/DiscordWebhook.ts +0 -11
  133. package/src/models/PaginatedDataSetList.ts +0 -12
  134. package/src/models/PaginatedTrainingList.ts +0 -12
  135. package/src/models/PatchedBotCommand.ts +0 -11
  136. package/src/models/PatchedBotCreate.ts +0 -17
  137. package/src/models/PatchedDataSet.ts +0 -26
  138. package/src/models/PatchedDiscordConfig.ts +0 -12
  139. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  140. package/src/models/PatchedSlackConfig.ts +0 -13
  141. package/src/models/PatchedSlackUserConfig.ts +0 -22
  142. package/src/models/PatchedTeamsConfig.ts +0 -12
  143. package/src/models/PatchedTrainingCreate.ts +0 -36
  144. package/src/models/PatchedWebexConfig.ts +0 -15
  145. package/src/models/PatchedWhatsappConfig.ts +0 -16
  146. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  147. package/src/models/Provider05cEnum.ts +0 -18
  148. package/src/models/Provider63aEnum.ts +0 -10
  149. package/src/models/SlackConfig.ts +0 -13
  150. package/src/models/SlackUserConfig.ts +0 -22
  151. package/src/models/SlackWebhook.ts +0 -11
  152. package/src/models/TeamsConfig.ts +0 -12
  153. package/src/models/TeamsWebhook.ts +0 -22
  154. package/src/models/Training.ts +0 -46
  155. package/src/models/TrainingCreate.ts +0 -36
  156. package/src/models/WebexConfig.ts +0 -15
  157. package/src/models/WebexWebhook.ts +0 -9
  158. package/src/models/WhatAppWebHook.ts +0 -8
  159. package/src/models/WhatsappConfig.ts +0 -16
  160. package/src/models/WhatsappUserConfig.ts +0 -15
  161. package/src/services/AiBotService.ts +0 -1174
  162. package/src/services/AiFinetuningService.ts +0 -402
@@ -31,25 +31,41 @@ export class EngagementService {
31
31
  *
32
32
  * Returns:
33
33
  * A paginated list of courses with their engagement metrics.
34
- * @param org
35
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
36
- * @param format Format
37
- *
38
- * * `json` - json
39
- * @param includeMainPlatform Include main platform data
40
- * @param length Size of data to return
41
- * @param page Page offset
42
34
  * @returns EngagementPerCourse
43
35
  * @throws ApiError
44
36
  */
45
- public static engagementOrgsActivityRetrieve(
37
+ public static engagementOrgsActivityRetrieve({
38
+ org,
39
+ departmentId,
40
+ format = 'json',
41
+ includeMainPlatform = true,
42
+ length,
43
+ page,
44
+ }: {
46
45
  org: string,
46
+ /**
47
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
48
+ */
47
49
  departmentId?: number,
48
- format: 'json' = 'json',
49
- includeMainPlatform: boolean = true,
50
+ /**
51
+ * Format
52
+ *
53
+ * * `json` - json
54
+ */
55
+ format?: 'json',
56
+ /**
57
+ * Include main platform data
58
+ */
59
+ includeMainPlatform?: boolean,
60
+ /**
61
+ * Size of data to return
62
+ */
50
63
  length?: number,
64
+ /**
65
+ * Page offset
66
+ */
51
67
  page?: number,
52
- ): CancelablePromise<EngagementPerCourse> {
68
+ }): CancelablePromise<EngagementPerCourse> {
53
69
  return __request(OpenAPI, {
54
70
  method: 'GET',
55
71
  url: '/api/engagement/orgs/{org}/activity',
@@ -73,25 +89,41 @@ export class EngagementService {
73
89
  * 2. end_date e.g 2020-10-10
74
90
  *
75
91
  * Default result when no query param is added is last_7_days (today inclusive)
76
- * @param org
77
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
78
- * @param endDate end date. ISO 8601
79
- * @param format Format
80
- *
81
- * * `json` - json
82
- * @param includeMainPlatform Include main platform data
83
- * @param startDate start date. ISO 8601
84
92
  * @returns OvertimeWithChangeInfo
85
93
  * @throws ApiError
86
94
  */
87
- public static engagementOrgsCourseCompletionOverTimeRetrieve(
95
+ public static engagementOrgsCourseCompletionOverTimeRetrieve({
96
+ org,
97
+ departmentId,
98
+ endDate,
99
+ format = 'json',
100
+ includeMainPlatform = true,
101
+ startDate,
102
+ }: {
88
103
  org: string,
104
+ /**
105
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
106
+ */
89
107
  departmentId?: number,
108
+ /**
109
+ * end date. ISO 8601
110
+ */
90
111
  endDate?: string,
91
- format: 'json' = 'json',
92
- includeMainPlatform: boolean = true,
112
+ /**
113
+ * Format
114
+ *
115
+ * * `json` - json
116
+ */
117
+ format?: 'json',
118
+ /**
119
+ * Include main platform data
120
+ */
121
+ includeMainPlatform?: boolean,
122
+ /**
123
+ * start date. ISO 8601
124
+ */
93
125
  startDate?: string,
94
- ): CancelablePromise<OvertimeWithChangeInfo> {
126
+ }): CancelablePromise<OvertimeWithChangeInfo> {
95
127
  return __request(OpenAPI, {
96
128
  method: 'GET',
97
129
  url: '/api/engagement/orgs/{org}/course_completion/over-time',
@@ -119,25 +151,41 @@ export class EngagementService {
119
151
  * - Enrollment count
120
152
  * - Completion count
121
153
  * - Average completion rate
122
- * @param org
123
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
124
- * @param format Format
125
- *
126
- * * `json` - json
127
- * @param includeMainPlatform Include main platform data
128
- * @param length Size of data to return
129
- * @param page Page offset
130
154
  * @returns CourseCompletionPerCourse
131
155
  * @throws ApiError
132
156
  */
133
- public static engagementOrgsCourseCompletionPerCourseRetrieve(
157
+ public static engagementOrgsCourseCompletionPerCourseRetrieve({
158
+ org,
159
+ departmentId,
160
+ format = 'json',
161
+ includeMainPlatform = true,
162
+ length,
163
+ page,
164
+ }: {
134
165
  org: string,
166
+ /**
167
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
168
+ */
135
169
  departmentId?: number,
136
- format: 'json' = 'json',
137
- includeMainPlatform: boolean = true,
170
+ /**
171
+ * Format
172
+ *
173
+ * * `json` - json
174
+ */
175
+ format?: 'json',
176
+ /**
177
+ * Include main platform data
178
+ */
179
+ includeMainPlatform?: boolean,
180
+ /**
181
+ * Size of data to return
182
+ */
138
183
  length?: number,
184
+ /**
185
+ * Page offset
186
+ */
139
187
  page?: number,
140
- ): CancelablePromise<CourseCompletionPerCourse> {
188
+ }): CancelablePromise<CourseCompletionPerCourse> {
141
189
  return __request(OpenAPI, {
142
190
  method: 'GET',
143
191
  url: '/api/engagement/orgs/{org}/course_completion/per-course',
@@ -162,27 +210,43 @@ export class EngagementService {
162
210
  * 3. course_id <optional>
163
211
  *
164
212
  * Default result when no query param is added is last_7_days (today inclusive)
165
- * @param courseId
166
- * @param org
167
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
168
- * @param endDate end date. ISO 8601
169
- * @param format Format
170
- *
171
- * * `json` - json
172
- * @param includeMainPlatform Include main platform data
173
- * @param startDate start date. ISO 8601
174
213
  * @returns AverageOvertime
175
214
  * @throws ApiError
176
215
  */
177
- public static engagementOrgsCoursesTimeAverageRetrieve(
216
+ public static engagementOrgsCoursesTimeAverageRetrieve({
217
+ courseId,
218
+ org,
219
+ departmentId,
220
+ endDate,
221
+ format = 'json',
222
+ includeMainPlatform = true,
223
+ startDate,
224
+ }: {
178
225
  courseId: string,
179
226
  org: string,
227
+ /**
228
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
229
+ */
180
230
  departmentId?: number,
231
+ /**
232
+ * end date. ISO 8601
233
+ */
181
234
  endDate?: string,
182
- format: 'json' = 'json',
183
- includeMainPlatform: boolean = true,
235
+ /**
236
+ * Format
237
+ *
238
+ * * `json` - json
239
+ */
240
+ format?: 'json',
241
+ /**
242
+ * Include main platform data
243
+ */
244
+ includeMainPlatform?: boolean,
245
+ /**
246
+ * start date. ISO 8601
247
+ */
184
248
  startDate?: string,
185
- ): CancelablePromise<AverageOvertime> {
249
+ }): CancelablePromise<AverageOvertime> {
186
250
  return __request(OpenAPI, {
187
251
  method: 'GET',
188
252
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/average',
@@ -208,23 +272,33 @@ export class EngagementService {
208
272
  * Query Params
209
273
  * 1. start_date <optional> e.g 2020-10-01
210
274
  * 2. end_date <optional> e.g 2020-10-10
211
- * @param courseId
212
- * @param org
213
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
214
- * @param format Format
215
- *
216
- * * `json` - json
217
- * @param includeMainPlatform Include main platform data
218
275
  * @returns TimeDetail
219
276
  * @throws ApiError
220
277
  */
221
- public static engagementOrgsCoursesTimeDetailRetrieve(
278
+ public static engagementOrgsCoursesTimeDetailRetrieve({
279
+ courseId,
280
+ org,
281
+ departmentId,
282
+ format = 'json',
283
+ includeMainPlatform = true,
284
+ }: {
222
285
  courseId: string,
223
286
  org: string,
287
+ /**
288
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
289
+ */
224
290
  departmentId?: number,
225
- format: 'json' = 'json',
226
- includeMainPlatform: boolean = true,
227
- ): CancelablePromise<TimeDetail> {
291
+ /**
292
+ * Format
293
+ *
294
+ * * `json` - json
295
+ */
296
+ format?: 'json',
297
+ /**
298
+ * Include main platform data
299
+ */
300
+ includeMainPlatform?: boolean,
301
+ }): CancelablePromise<TimeDetail> {
228
302
  return __request(OpenAPI, {
229
303
  method: 'GET',
230
304
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/detail',
@@ -249,27 +323,43 @@ export class EngagementService {
249
323
  * 3. course_id
250
324
  *
251
325
  * Default result when no query param is added is last_7_days (today inclusive)
252
- * @param courseId
253
- * @param org
254
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
255
- * @param endDate end date. ISO 8601
256
- * @param format Format
257
- *
258
- * * `json` - json
259
- * @param includeMainPlatform Include main platform data
260
- * @param startDate start date. ISO 8601
261
326
  * @returns OverTimeWithTotal
262
327
  * @throws ApiError
263
328
  */
264
- public static engagementOrgsCoursesTimeOverTimeRetrieve(
329
+ public static engagementOrgsCoursesTimeOverTimeRetrieve({
330
+ courseId,
331
+ org,
332
+ departmentId,
333
+ endDate,
334
+ format = 'json',
335
+ includeMainPlatform = true,
336
+ startDate,
337
+ }: {
265
338
  courseId: string,
266
339
  org: string,
340
+ /**
341
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
342
+ */
267
343
  departmentId?: number,
344
+ /**
345
+ * end date. ISO 8601
346
+ */
268
347
  endDate?: string,
269
- format: 'json' = 'json',
270
- includeMainPlatform: boolean = true,
348
+ /**
349
+ * Format
350
+ *
351
+ * * `json` - json
352
+ */
353
+ format?: 'json',
354
+ /**
355
+ * Include main platform data
356
+ */
357
+ includeMainPlatform?: boolean,
358
+ /**
359
+ * start date. ISO 8601
360
+ */
271
361
  startDate?: string,
272
- ): CancelablePromise<OverTimeWithTotal> {
362
+ }): CancelablePromise<OverTimeWithTotal> {
273
363
  return __request(OpenAPI, {
274
364
  method: 'GET',
275
365
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/over-time',
@@ -291,31 +381,53 @@ export class EngagementService {
291
381
  *
292
382
  * Query Params
293
383
  * course_id e.g course-v1:Org+Course4+Run
294
- * @param courseId
295
- * @param org
296
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
297
- * @param endDate end date. ISO 8601
298
- * @param format Format
299
- *
300
- * * `json` - json
301
- * @param includeMainPlatform Include main platform data
302
- * @param length Size of data to return
303
- * @param page Page offset
304
- * @param startDate start date. ISO 8601
305
384
  * @returns TimeSpentByUsersInCourse
306
385
  * @throws ApiError
307
386
  */
308
- public static engagementOrgsCoursesTimeUsersRetrieve(
387
+ public static engagementOrgsCoursesTimeUsersRetrieve({
388
+ courseId,
389
+ org,
390
+ departmentId,
391
+ endDate,
392
+ format = 'json',
393
+ includeMainPlatform = true,
394
+ length,
395
+ page,
396
+ startDate,
397
+ }: {
309
398
  courseId: string,
310
399
  org: string,
400
+ /**
401
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
402
+ */
311
403
  departmentId?: number,
404
+ /**
405
+ * end date. ISO 8601
406
+ */
312
407
  endDate?: string,
313
- format: 'json' = 'json',
314
- includeMainPlatform: boolean = true,
408
+ /**
409
+ * Format
410
+ *
411
+ * * `json` - json
412
+ */
413
+ format?: 'json',
414
+ /**
415
+ * Include main platform data
416
+ */
417
+ includeMainPlatform?: boolean,
418
+ /**
419
+ * Size of data to return
420
+ */
315
421
  length?: number,
422
+ /**
423
+ * Page offset
424
+ */
316
425
  page?: number,
426
+ /**
427
+ * start date. ISO 8601
428
+ */
317
429
  startDate?: string,
318
- ): CancelablePromise<TimeSpentByUsersInCourse> {
430
+ }): CancelablePromise<TimeSpentByUsersInCourse> {
319
431
  return __request(OpenAPI, {
320
432
  method: 'GET',
321
433
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users',
@@ -343,29 +455,45 @@ export class EngagementService {
343
455
  * Query Params
344
456
  * 3. start_date <optional> e.g 2020-10-01
345
457
  * 4. end_date <optional> e.g 2020-10-10
346
- * @param courseId
347
- * @param org
348
- * @param userId
349
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
350
- * @param endDate end date. ISO 8601
351
- * @param format Format
352
- *
353
- * * `json` - json
354
- * @param includeMainPlatform Include main platform data
355
- * @param startDate start date. ISO 8601
356
458
  * @returns PerLearnerTimeSpentInCourseTree
357
459
  * @throws ApiError
358
460
  */
359
- public static engagementOrgsCoursesTimeUsersDetailRetrieve(
461
+ public static engagementOrgsCoursesTimeUsersDetailRetrieve({
462
+ courseId,
463
+ org,
464
+ userId,
465
+ departmentId,
466
+ endDate,
467
+ format = 'json',
468
+ includeMainPlatform = true,
469
+ startDate,
470
+ }: {
360
471
  courseId: string,
361
472
  org: string,
362
473
  userId: string,
474
+ /**
475
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
476
+ */
363
477
  departmentId?: number,
478
+ /**
479
+ * end date. ISO 8601
480
+ */
364
481
  endDate?: string,
365
- format: 'json' = 'json',
366
- includeMainPlatform: boolean = true,
482
+ /**
483
+ * Format
484
+ *
485
+ * * `json` - json
486
+ */
487
+ format?: 'json',
488
+ /**
489
+ * Include main platform data
490
+ */
491
+ includeMainPlatform?: boolean,
492
+ /**
493
+ * start date. ISO 8601
494
+ */
367
495
  startDate?: string,
368
- ): CancelablePromise<PerLearnerTimeSpentInCourseTree> {
496
+ }): CancelablePromise<PerLearnerTimeSpentInCourseTree> {
369
497
  return __request(OpenAPI, {
370
498
  method: 'GET',
371
499
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/detail',
@@ -393,29 +521,45 @@ export class EngagementService {
393
521
  * 4. end_date e.g 2020-10-10
394
522
  *
395
523
  * Default result when no query param is added is last_7_days (today inclusive)
396
- * @param courseId
397
- * @param org
398
- * @param userId
399
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
400
- * @param endDate end date. ISO 8601
401
- * @param format Format
402
- *
403
- * * `json` - json
404
- * @param includeMainPlatform Include main platform data
405
- * @param startDate start date. ISO 8601
406
524
  * @returns OverTimeWithTotal
407
525
  * @throws ApiError
408
526
  */
409
- public static engagementOrgsCoursesTimeUsersOverTimeRetrieve(
527
+ public static engagementOrgsCoursesTimeUsersOverTimeRetrieve({
528
+ courseId,
529
+ org,
530
+ userId,
531
+ departmentId,
532
+ endDate,
533
+ format = 'json',
534
+ includeMainPlatform = true,
535
+ startDate,
536
+ }: {
410
537
  courseId: string,
411
538
  org: string,
412
539
  userId: string,
540
+ /**
541
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
542
+ */
413
543
  departmentId?: number,
544
+ /**
545
+ * end date. ISO 8601
546
+ */
414
547
  endDate?: string,
415
- format: 'json' = 'json',
416
- includeMainPlatform: boolean = true,
548
+ /**
549
+ * Format
550
+ *
551
+ * * `json` - json
552
+ */
553
+ format?: 'json',
554
+ /**
555
+ * Include main platform data
556
+ */
557
+ includeMainPlatform?: boolean,
558
+ /**
559
+ * start date. ISO 8601
560
+ */
417
561
  startDate?: string,
418
- ): CancelablePromise<OverTimeWithTotal> {
562
+ }): CancelablePromise<OverTimeWithTotal> {
419
563
  return __request(OpenAPI, {
420
564
  method: 'GET',
421
565
  url: '/api/engagement/orgs/{org}/courses/{course_id}/time/users/{user_id}/over-time',
@@ -444,23 +588,33 @@ export class EngagementService {
444
588
  *
445
589
  * Returns:
446
590
  * Detailed video engagement metrics for the specified course.
447
- * @param courseId
448
- * @param org
449
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
450
- * @param format Format
451
- *
452
- * * `json` - json
453
- * @param includeMainPlatform Include main platform data
454
591
  * @returns VideosSpecificCourse
455
592
  * @throws ApiError
456
593
  */
457
- public static engagementOrgsCoursesVideosRetrieve(
594
+ public static engagementOrgsCoursesVideosRetrieve({
595
+ courseId,
596
+ org,
597
+ departmentId,
598
+ format = 'json',
599
+ includeMainPlatform = true,
600
+ }: {
458
601
  courseId: string,
459
602
  org: string,
603
+ /**
604
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
605
+ */
460
606
  departmentId?: number,
461
- format: 'json' = 'json',
462
- includeMainPlatform: boolean = true,
463
- ): CancelablePromise<VideosSpecificCourse> {
607
+ /**
608
+ * Format
609
+ *
610
+ * * `json` - json
611
+ */
612
+ format?: 'json',
613
+ /**
614
+ * Include main platform data
615
+ */
616
+ includeMainPlatform?: boolean,
617
+ }): CancelablePromise<VideosSpecificCourse> {
464
618
  return __request(OpenAPI, {
465
619
  method: 'GET',
466
620
  url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/',
@@ -495,27 +649,43 @@ export class EngagementService {
495
649
  * Access Control:
496
650
  * - Platform admins can access any video watch data
497
651
  * - Learners can access their own video watch data
498
- * @param courseId
499
- * @param org
500
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
501
- * @param endDate end date. ISO 8601
502
- * @param format Format
503
- *
504
- * * `json` - json
505
- * @param includeMainPlatform Include main platform data
506
- * @param startDate start date. ISO 8601
507
652
  * @returns OverTimeWithTotal
508
653
  * @throws ApiError
509
654
  */
510
- public static engagementOrgsCoursesVideosOverTimeRetrieve(
655
+ public static engagementOrgsCoursesVideosOverTimeRetrieve({
656
+ courseId,
657
+ org,
658
+ departmentId,
659
+ endDate,
660
+ format = 'json',
661
+ includeMainPlatform = true,
662
+ startDate,
663
+ }: {
511
664
  courseId: string,
512
665
  org: string,
666
+ /**
667
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
668
+ */
513
669
  departmentId?: number,
670
+ /**
671
+ * end date. ISO 8601
672
+ */
514
673
  endDate?: string,
515
- format: 'json' = 'json',
516
- includeMainPlatform: boolean = true,
674
+ /**
675
+ * Format
676
+ *
677
+ * * `json` - json
678
+ */
679
+ format?: 'json',
680
+ /**
681
+ * Include main platform data
682
+ */
683
+ includeMainPlatform?: boolean,
684
+ /**
685
+ * start date. ISO 8601
686
+ */
517
687
  startDate?: string,
518
- ): CancelablePromise<OverTimeWithTotal> {
688
+ }): CancelablePromise<OverTimeWithTotal> {
519
689
  return __request(OpenAPI, {
520
690
  method: 'GET',
521
691
  url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/over-time',
@@ -546,23 +716,33 @@ export class EngagementService {
546
716
  * - Section and subsection organization
547
717
  * - Video identification and metadata
548
718
  * - Watch counts and completion rates
549
- * @param courseId
550
- * @param org
551
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
552
- * @param format Format
553
- *
554
- * * `json` - json
555
- * @param includeMainPlatform Include main platform data
556
719
  * @returns VideosInCourseSummary
557
720
  * @throws ApiError
558
721
  */
559
- public static engagementOrgsCoursesVideosSummaryRetrieve(
722
+ public static engagementOrgsCoursesVideosSummaryRetrieve({
723
+ courseId,
724
+ org,
725
+ departmentId,
726
+ format = 'json',
727
+ includeMainPlatform = true,
728
+ }: {
560
729
  courseId: string,
561
730
  org: string,
731
+ /**
732
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
733
+ */
562
734
  departmentId?: number,
563
- format: 'json' = 'json',
564
- includeMainPlatform: boolean = true,
565
- ): CancelablePromise<VideosInCourseSummary> {
735
+ /**
736
+ * Format
737
+ *
738
+ * * `json` - json
739
+ */
740
+ format?: 'json',
741
+ /**
742
+ * Include main platform data
743
+ */
744
+ includeMainPlatform?: boolean,
745
+ }): CancelablePromise<VideosInCourseSummary> {
566
746
  return __request(OpenAPI, {
567
747
  method: 'GET',
568
748
  url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/summary',
@@ -582,23 +762,33 @@ export class EngagementService {
582
762
  *
583
763
  * Kwargs
584
764
  * course_id e.g course-v1:Org+Course4+Run
585
- * @param courseId
586
- * @param org
587
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
588
- * @param format Format
589
- *
590
- * * `json` - json
591
- * @param includeMainPlatform Include main platform data
592
765
  * @returns WatchedVideosPerUser
593
766
  * @throws ApiError
594
767
  */
595
- public static engagementOrgsCoursesVideosUsersRetrieve(
768
+ public static engagementOrgsCoursesVideosUsersRetrieve({
769
+ courseId,
770
+ org,
771
+ departmentId,
772
+ format = 'json',
773
+ includeMainPlatform = true,
774
+ }: {
596
775
  courseId: string,
597
776
  org: string,
777
+ /**
778
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
779
+ */
598
780
  departmentId?: number,
599
- format: 'json' = 'json',
600
- includeMainPlatform: boolean = true,
601
- ): CancelablePromise<WatchedVideosPerUser> {
781
+ /**
782
+ * Format
783
+ *
784
+ * * `json` - json
785
+ */
786
+ format?: 'json',
787
+ /**
788
+ * Include main platform data
789
+ */
790
+ includeMainPlatform?: boolean,
791
+ }): CancelablePromise<WatchedVideosPerUser> {
602
792
  return __request(OpenAPI, {
603
793
  method: 'GET',
604
794
  url: '/api/engagement/orgs/{org}/courses/{course_id}/videos/users',
@@ -620,25 +810,41 @@ export class EngagementService {
620
810
  * Query Params
621
811
  * 1. start_date e.g 2020-10-01
622
812
  * 2. end_date e.g 2020-10-10
623
- * @param org
624
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
625
- * @param endDate end date. ISO 8601
626
- * @param format Format
627
- *
628
- * * `json` - json
629
- * @param includeMainPlatform Include main platform data
630
- * @param startDate start date. ISO 8601
631
813
  * @returns AverageOvertime
632
814
  * @throws ApiError
633
815
  */
634
- public static engagementOrgsTimeAveragePerlearnerPercourseRetrieve(
816
+ public static engagementOrgsTimeAveragePerlearnerPercourseRetrieve({
817
+ org,
818
+ departmentId,
819
+ endDate,
820
+ format = 'json',
821
+ includeMainPlatform = true,
822
+ startDate,
823
+ }: {
635
824
  org: string,
825
+ /**
826
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
827
+ */
636
828
  departmentId?: number,
829
+ /**
830
+ * end date. ISO 8601
831
+ */
637
832
  endDate?: string,
638
- format: 'json' = 'json',
639
- includeMainPlatform: boolean = true,
833
+ /**
834
+ * Format
835
+ *
836
+ * * `json` - json
837
+ */
838
+ format?: 'json',
839
+ /**
840
+ * Include main platform data
841
+ */
842
+ includeMainPlatform?: boolean,
843
+ /**
844
+ * start date. ISO 8601
845
+ */
640
846
  startDate?: string,
641
- ): CancelablePromise<AverageOvertime> {
847
+ }): CancelablePromise<AverageOvertime> {
642
848
  return __request(OpenAPI, {
643
849
  method: 'GET',
644
850
  url: '/api/engagement/orgs/{org}/time/average-perlearner-percourse',
@@ -663,25 +869,41 @@ export class EngagementService {
663
869
  * 3. course_id <optional>
664
870
  *
665
871
  * Default result when no query param is added is last_7_days (today inclusive)
666
- * @param org
667
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
668
- * @param endDate end date. ISO 8601
669
- * @param format Format
670
- *
671
- * * `json` - json
672
- * @param includeMainPlatform Include main platform data
673
- * @param startDate start date. ISO 8601
674
872
  * @returns AverageOvertime
675
873
  * @throws ApiError
676
874
  */
677
- public static engagementOrgsTimeAverageWithOverTimeRetrieve(
875
+ public static engagementOrgsTimeAverageWithOverTimeRetrieve({
876
+ org,
877
+ departmentId,
878
+ endDate,
879
+ format = 'json',
880
+ includeMainPlatform = true,
881
+ startDate,
882
+ }: {
678
883
  org: string,
884
+ /**
885
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
886
+ */
679
887
  departmentId?: number,
888
+ /**
889
+ * end date. ISO 8601
890
+ */
680
891
  endDate?: string,
681
- format: 'json' = 'json',
682
- includeMainPlatform: boolean = true,
892
+ /**
893
+ * Format
894
+ *
895
+ * * `json` - json
896
+ */
897
+ format?: 'json',
898
+ /**
899
+ * Include main platform data
900
+ */
901
+ includeMainPlatform?: boolean,
902
+ /**
903
+ * start date. ISO 8601
904
+ */
683
905
  startDate?: string,
684
- ): CancelablePromise<AverageOvertime> {
906
+ }): CancelablePromise<AverageOvertime> {
685
907
  return __request(OpenAPI, {
686
908
  method: 'GET',
687
909
  url: '/api/engagement/orgs/{org}/time/average-with-over-time',
@@ -712,25 +934,41 @@ export class EngagementService {
712
934
  * compared to previous periods.
713
935
  *
714
936
  * Default time range is the last 7 days if no dates are specified.
715
- * @param org
716
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
717
- * @param endDate end date. ISO 8601
718
- * @param format Format
719
- *
720
- * * `json` - json
721
- * @param includeMainPlatform Include main platform data
722
- * @param startDate start date. ISO 8601
723
937
  * @returns OvertimeWithChangeInfo
724
938
  * @throws ApiError
725
939
  */
726
- public static engagementOrgsTimeOverTimeRetrieve(
940
+ public static engagementOrgsTimeOverTimeRetrieve({
941
+ org,
942
+ departmentId,
943
+ endDate,
944
+ format = 'json',
945
+ includeMainPlatform = true,
946
+ startDate,
947
+ }: {
727
948
  org: string,
949
+ /**
950
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
951
+ */
728
952
  departmentId?: number,
953
+ /**
954
+ * end date. ISO 8601
955
+ */
729
956
  endDate?: string,
730
- format: 'json' = 'json',
731
- includeMainPlatform: boolean = true,
957
+ /**
958
+ * Format
959
+ *
960
+ * * `json` - json
961
+ */
962
+ format?: 'json',
963
+ /**
964
+ * Include main platform data
965
+ */
966
+ includeMainPlatform?: boolean,
967
+ /**
968
+ * start date. ISO 8601
969
+ */
732
970
  startDate?: string,
733
- ): CancelablePromise<OvertimeWithChangeInfo> {
971
+ }): CancelablePromise<OvertimeWithChangeInfo> {
734
972
  return __request(OpenAPI, {
735
973
  method: 'GET',
736
974
  url: '/api/engagement/orgs/{org}/time/over-time',
@@ -764,29 +1002,51 @@ export class EngagementService {
764
1002
  * - Total time spent (in seconds)
765
1003
  * - Formatted time spent (human-readable)
766
1004
  * - Percentage of total platform time
767
- * @param org
768
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
769
- * @param endDate end date. ISO 8601
770
- * @param format Format
771
- *
772
- * * `json` - json
773
- * @param includeMainPlatform Include main platform data
774
- * @param length Size of data to return
775
- * @param page Page offset
776
- * @param startDate start date. ISO 8601
777
1005
  * @returns TimeSpentPerCourse
778
1006
  * @throws ApiError
779
1007
  */
780
- public static engagementOrgsTimePerCourseRetrieve(
1008
+ public static engagementOrgsTimePerCourseRetrieve({
1009
+ org,
1010
+ departmentId,
1011
+ endDate,
1012
+ format = 'json',
1013
+ includeMainPlatform = true,
1014
+ length,
1015
+ page,
1016
+ startDate,
1017
+ }: {
781
1018
  org: string,
1019
+ /**
1020
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1021
+ */
782
1022
  departmentId?: number,
1023
+ /**
1024
+ * end date. ISO 8601
1025
+ */
783
1026
  endDate?: string,
784
- format: 'json' = 'json',
785
- includeMainPlatform: boolean = true,
1027
+ /**
1028
+ * Format
1029
+ *
1030
+ * * `json` - json
1031
+ */
1032
+ format?: 'json',
1033
+ /**
1034
+ * Include main platform data
1035
+ */
1036
+ includeMainPlatform?: boolean,
1037
+ /**
1038
+ * Size of data to return
1039
+ */
786
1040
  length?: number,
1041
+ /**
1042
+ * Page offset
1043
+ */
787
1044
  page?: number,
1045
+ /**
1046
+ * start date. ISO 8601
1047
+ */
788
1048
  startDate?: string,
789
- ): CancelablePromise<TimeSpentPerCourse> {
1049
+ }): CancelablePromise<TimeSpentPerCourse> {
790
1050
  return __request(OpenAPI, {
791
1051
  method: 'GET',
792
1052
  url: '/api/engagement/orgs/{org}/time/per-course',
@@ -816,25 +1076,41 @@ export class EngagementService {
816
1076
  *
817
1077
  * Returns:
818
1078
  * A paginated list of courses with their video engagement metrics.
819
- * @param org
820
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
821
- * @param format Format
822
- *
823
- * * `json` - json
824
- * @param includeMainPlatform Include main platform data
825
- * @param length Size of data to return
826
- * @param page Page offset
827
1079
  * @returns VideoEngagementPerCourse
828
1080
  * @throws ApiError
829
1081
  */
830
- public static engagementOrgsVideosRetrieve(
1082
+ public static engagementOrgsVideosRetrieve({
1083
+ org,
1084
+ departmentId,
1085
+ format = 'json',
1086
+ includeMainPlatform = true,
1087
+ length,
1088
+ page,
1089
+ }: {
831
1090
  org: string,
1091
+ /**
1092
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1093
+ */
832
1094
  departmentId?: number,
833
- format: 'json' = 'json',
834
- includeMainPlatform: boolean = true,
1095
+ /**
1096
+ * Format
1097
+ *
1098
+ * * `json` - json
1099
+ */
1100
+ format?: 'json',
1101
+ /**
1102
+ * Include main platform data
1103
+ */
1104
+ includeMainPlatform?: boolean,
1105
+ /**
1106
+ * Size of data to return
1107
+ */
835
1108
  length?: number,
1109
+ /**
1110
+ * Page offset
1111
+ */
836
1112
  page?: number,
837
- ): CancelablePromise<VideoEngagementPerCourse> {
1113
+ }): CancelablePromise<VideoEngagementPerCourse> {
838
1114
  return __request(OpenAPI, {
839
1115
  method: 'GET',
840
1116
  url: '/api/engagement/orgs/{org}/videos/',
@@ -870,25 +1146,41 @@ export class EngagementService {
870
1146
  * Access Control:
871
1147
  * - Platform admins can access any video watch data
872
1148
  * - Learners can access their own video watch data
873
- * @param org
874
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
875
- * @param endDate end date. ISO 8601
876
- * @param format Format
877
- *
878
- * * `json` - json
879
- * @param includeMainPlatform Include main platform data
880
- * @param startDate start date. ISO 8601
881
1149
  * @returns OverTimeWithTotal
882
1150
  * @throws ApiError
883
1151
  */
884
- public static engagementOrgsVideosOverTimeRetrieve(
1152
+ public static engagementOrgsVideosOverTimeRetrieve({
1153
+ org,
1154
+ departmentId,
1155
+ endDate,
1156
+ format = 'json',
1157
+ includeMainPlatform = true,
1158
+ startDate,
1159
+ }: {
885
1160
  org: string,
1161
+ /**
1162
+ * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1163
+ */
886
1164
  departmentId?: number,
1165
+ /**
1166
+ * end date. ISO 8601
1167
+ */
887
1168
  endDate?: string,
888
- format: 'json' = 'json',
889
- includeMainPlatform: boolean = true,
1169
+ /**
1170
+ * Format
1171
+ *
1172
+ * * `json` - json
1173
+ */
1174
+ format?: 'json',
1175
+ /**
1176
+ * Include main platform data
1177
+ */
1178
+ includeMainPlatform?: boolean,
1179
+ /**
1180
+ * start date. ISO 8601
1181
+ */
890
1182
  startDate?: string,
891
- ): CancelablePromise<OverTimeWithTotal> {
1183
+ }): CancelablePromise<OverTimeWithTotal> {
892
1184
  return __request(OpenAPI, {
893
1185
  method: 'GET',
894
1186
  url: '/api/engagement/orgs/{org}/videos/over-time',