@iblai/iblai-api 3.45.12-ai-plus → 3.45.13-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.
- package/dist/index.cjs.js +229 -1561
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +230 -1560
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +229 -1561
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +4 -40
- package/dist/types/models/PromptFacet.d.ts +17 -0
- package/dist/types/models/PromptSearchResponse.d.ts +35 -0
- package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
- package/dist/types/models/RecommendedCoursesResponse.d.ts +33 -0
- package/dist/types/models/Voice.d.ts +2 -2
- package/dist/types/services/SearchService.d.ts +12 -8
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +4 -40
- package/src/models/PromptFacet.ts +22 -0
- package/src/models/PromptSearchResponse.ts +40 -0
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/RecommendedCoursesResponse.ts +38 -0
- package/src/models/Voice.ts +2 -2
- package/src/services/SearchService.ts +14 -6
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '3.45.
|
|
113
|
+
VERSION: '3.45.13-ai',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -231,24 +231,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
|
|
|
231
231
|
CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
|
|
232
232
|
})(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
|
|
233
233
|
|
|
234
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
235
|
-
/* istanbul ignore file */
|
|
236
|
-
/* tslint:disable */
|
|
237
|
-
/* eslint-disable */
|
|
238
|
-
/**
|
|
239
|
-
* * `pending` - Pending
|
|
240
|
-
* * `processing` - Processing
|
|
241
|
-
* * `completed` - Completed
|
|
242
|
-
* * `failed` - Failed
|
|
243
|
-
*/
|
|
244
|
-
exports.DataSetStatusEnum = void 0;
|
|
245
|
-
(function (DataSetStatusEnum) {
|
|
246
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
247
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
248
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
249
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
250
|
-
})(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
|
|
251
|
-
|
|
252
234
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
253
235
|
/* istanbul ignore file */
|
|
254
236
|
/* tslint:disable */
|
|
@@ -531,37 +513,21 @@ exports.PromptVisibilityEnum = void 0;
|
|
|
531
513
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
532
514
|
})(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
|
|
533
515
|
|
|
534
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
535
|
-
/* istanbul ignore file */
|
|
536
|
-
/* tslint:disable */
|
|
537
|
-
/* eslint-disable */
|
|
538
|
-
/**
|
|
539
|
-
* * `webex` - Webex
|
|
540
|
-
* * `slack` - Slack
|
|
541
|
-
* * `whatsapp` - Whatsapp
|
|
542
|
-
* * `discord` - Discord
|
|
543
|
-
* * `teams` - Teams
|
|
544
|
-
*/
|
|
545
|
-
exports.Provider05cEnum = void 0;
|
|
546
|
-
(function (Provider05cEnum) {
|
|
547
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
548
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
549
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
550
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
551
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
552
|
-
})(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
|
|
553
|
-
|
|
554
516
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
555
517
|
/* istanbul ignore file */
|
|
556
518
|
/* tslint:disable */
|
|
557
519
|
/* eslint-disable */
|
|
558
520
|
/**
|
|
559
521
|
* * `openai` - Openai
|
|
522
|
+
* * `google` - Google
|
|
523
|
+
* * `elevenlabs` - Elevenlabs
|
|
560
524
|
*/
|
|
561
|
-
exports.
|
|
562
|
-
(function (
|
|
563
|
-
|
|
564
|
-
|
|
525
|
+
exports.ProviderEnum = void 0;
|
|
526
|
+
(function (ProviderEnum) {
|
|
527
|
+
ProviderEnum["OPENAI"] = "openai";
|
|
528
|
+
ProviderEnum["GOOGLE"] = "google";
|
|
529
|
+
ProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
530
|
+
})(exports.ProviderEnum || (exports.ProviderEnum = {}));
|
|
565
531
|
|
|
566
532
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
567
533
|
/* istanbul ignore file */
|
|
@@ -731,22 +697,6 @@ exports.TypeC42Enum = void 0;
|
|
|
731
697
|
TypeC42Enum["ASSESSMENT"] = "assessment";
|
|
732
698
|
})(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
|
|
733
699
|
|
|
734
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
735
|
-
/* istanbul ignore file */
|
|
736
|
-
/* tslint:disable */
|
|
737
|
-
/* eslint-disable */
|
|
738
|
-
/**
|
|
739
|
-
* * `openai` - Openai
|
|
740
|
-
* * `google` - Google
|
|
741
|
-
* * `elevenlabs` - Elevenlabs
|
|
742
|
-
*/
|
|
743
|
-
exports.VoiceProviderEnum = void 0;
|
|
744
|
-
(function (VoiceProviderEnum) {
|
|
745
|
-
VoiceProviderEnum["OPENAI"] = "openai";
|
|
746
|
-
VoiceProviderEnum["GOOGLE"] = "google";
|
|
747
|
-
VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
748
|
-
})(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
|
|
749
|
-
|
|
750
700
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
751
701
|
/* istanbul ignore file */
|
|
752
702
|
/* tslint:disable */
|
|
@@ -5509,1566 +5459,282 @@ class AiAnalyticsService {
|
|
|
5509
5459
|
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index',
|
|
5510
5460
|
path: {
|
|
5511
5461
|
'org': org,
|
|
5512
|
-
'user_id': userId
|
|
5513
|
-
},
|
|
5514
|
-
query: {
|
|
5515
|
-
'department_id': departmentId,
|
|
5516
|
-
'end_date': endDate,
|
|
5517
|
-
'format': format,
|
|
5518
|
-
'include_main_platform': includeMainPlatform,
|
|
5519
|
-
'start_date': startDate
|
|
5520
|
-
}
|
|
5521
|
-
});
|
|
5522
|
-
}
|
|
5523
|
-
/**
|
|
5524
|
-
* Get average grade value for platform, course, or user.
|
|
5525
|
-
*
|
|
5526
|
-
* This endpoint returns the average grade at different levels:
|
|
5527
|
-
* - Platform level: Average grade across all courses
|
|
5528
|
-
* - Course level: Average grade for a specific course
|
|
5529
|
-
* - Learner level: Average grade for a specific learner
|
|
5530
|
-
* - Course-learner level: Grade for a specific learner in a specific course
|
|
5531
|
-
*
|
|
5532
|
-
* Query Parameters:
|
|
5533
|
-
* course_id (str, optional): Filter by course ID
|
|
5534
|
-
* learner_id (str, optional): Filter by username or email
|
|
5535
|
-
*
|
|
5536
|
-
* Returns:
|
|
5537
|
-
* The average grade value based on the specified filters.
|
|
5538
|
-
*
|
|
5539
|
-
* Access Control:
|
|
5540
|
-
* - Platform admins can access any grade data
|
|
5541
|
-
* - Learners can access their own grade data
|
|
5542
|
-
* @param org
|
|
5543
|
-
* @param userId
|
|
5544
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5545
|
-
* @param format Format
|
|
5546
|
-
*
|
|
5547
|
-
* * `json` - json
|
|
5548
|
-
* @param includeMainPlatform Include main platform data
|
|
5549
|
-
* @returns Average
|
|
5550
|
-
* @throws ApiError
|
|
5551
|
-
*/
|
|
5552
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org, userId, departmentId, format = 'json', includeMainPlatform = true) {
|
|
5553
|
-
return request(OpenAPI, {
|
|
5554
|
-
method: 'GET',
|
|
5555
|
-
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
|
|
5556
|
-
path: {
|
|
5557
|
-
'org': org,
|
|
5558
|
-
'user_id': userId
|
|
5559
|
-
},
|
|
5560
|
-
query: {
|
|
5561
|
-
'department_id': departmentId,
|
|
5562
|
-
'format': format,
|
|
5563
|
-
'include_main_platform': includeMainPlatform
|
|
5564
|
-
}
|
|
5565
|
-
});
|
|
5566
|
-
}
|
|
5567
|
-
/**
|
|
5568
|
-
* Evaluates performance index for platform, per course, per user and per user-per course
|
|
5569
|
-
*
|
|
5570
|
-
* Query Params
|
|
5571
|
-
* course_id <optional>
|
|
5572
|
-
* learner_id <optional>
|
|
5573
|
-
* @param org
|
|
5574
|
-
* @param userId
|
|
5575
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5576
|
-
* @param endDate end date. ISO 8601
|
|
5577
|
-
* @param format Format
|
|
5578
|
-
*
|
|
5579
|
-
* * `json` - json
|
|
5580
|
-
* @param includeMainPlatform Include main platform data
|
|
5581
|
-
* @param startDate start date. ISO 8601
|
|
5582
|
-
* @returns Value
|
|
5583
|
-
* @throws ApiError
|
|
5584
|
-
*/
|
|
5585
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
5586
|
-
return request(OpenAPI, {
|
|
5587
|
-
method: 'GET',
|
|
5588
|
-
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
|
|
5589
|
-
path: {
|
|
5590
|
-
'org': org,
|
|
5591
|
-
'user_id': userId
|
|
5592
|
-
},
|
|
5593
|
-
query: {
|
|
5594
|
-
'department_id': departmentId,
|
|
5595
|
-
'end_date': endDate,
|
|
5596
|
-
'format': format,
|
|
5597
|
-
'include_main_platform': includeMainPlatform,
|
|
5598
|
-
'start_date': startDate
|
|
5599
|
-
}
|
|
5600
|
-
});
|
|
5601
|
-
}
|
|
5602
|
-
/**
|
|
5603
|
-
* Time spent in secs on a per-day basis
|
|
5604
|
-
*
|
|
5605
|
-
* Query Params
|
|
5606
|
-
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
5607
|
-
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
5608
|
-
* 3. start_date e.g 2020-10-01
|
|
5609
|
-
* 4. end_date e.g 2020-10-10
|
|
5610
|
-
*
|
|
5611
|
-
* Default result when no query param is added is last_7_days (today inclusive)
|
|
5612
|
-
* @param org
|
|
5613
|
-
* @param userId
|
|
5614
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5615
|
-
* @param endDate end date. ISO 8601
|
|
5616
|
-
* @param format Format
|
|
5617
|
-
*
|
|
5618
|
-
* * `json` - json
|
|
5619
|
-
* @param includeMainPlatform Include main platform data
|
|
5620
|
-
* @param startDate start date. ISO 8601
|
|
5621
|
-
* @returns OverTimeWithTotal
|
|
5622
|
-
* @throws ApiError
|
|
5623
|
-
*/
|
|
5624
|
-
static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
5625
|
-
return request(OpenAPI, {
|
|
5626
|
-
method: 'GET',
|
|
5627
|
-
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
|
|
5628
|
-
path: {
|
|
5629
|
-
'org': org,
|
|
5630
|
-
'user_id': userId
|
|
5631
|
-
},
|
|
5632
|
-
query: {
|
|
5633
|
-
'department_id': departmentId,
|
|
5634
|
-
'end_date': endDate,
|
|
5635
|
-
'format': format,
|
|
5636
|
-
'include_main_platform': includeMainPlatform,
|
|
5637
|
-
'start_date': startDate
|
|
5638
|
-
}
|
|
5639
|
-
});
|
|
5640
|
-
}
|
|
5641
|
-
/**
|
|
5642
|
-
* Get video watch counts over time.
|
|
5643
|
-
*
|
|
5644
|
-
* This endpoint provides daily counts of videos watched over a specified time period,
|
|
5645
|
-
* with options to filter by course or user.
|
|
5646
|
-
*
|
|
5647
|
-
* Query Parameters:
|
|
5648
|
-
* start_date (str, optional): Start date for the time range (ISO format)
|
|
5649
|
-
* end_date (str, optional): End date for the time range (ISO format)
|
|
5650
|
-
* course_id (str, optional): Filter by course ID
|
|
5651
|
-
* user_id (str, optional): Filter by username or email
|
|
5652
|
-
*
|
|
5653
|
-
* Returns:
|
|
5654
|
-
* Daily video watch counts over the specified time period.
|
|
5655
|
-
*
|
|
5656
|
-
* Default time range is the last 7 days if no dates are specified.
|
|
5657
|
-
*
|
|
5658
|
-
* Access Control:
|
|
5659
|
-
* - Platform admins can access any video watch data
|
|
5660
|
-
* - Learners can access their own video watch data
|
|
5661
|
-
* @param org
|
|
5662
|
-
* @param userId
|
|
5663
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5664
|
-
* @param endDate end date. ISO 8601
|
|
5665
|
-
* @param format Format
|
|
5666
|
-
*
|
|
5667
|
-
* * `json` - json
|
|
5668
|
-
* @param includeMainPlatform Include main platform data
|
|
5669
|
-
* @param startDate start date. ISO 8601
|
|
5670
|
-
* @returns OverTimeWithTotal
|
|
5671
|
-
* @throws ApiError
|
|
5672
|
-
*/
|
|
5673
|
-
static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
5674
|
-
return request(OpenAPI, {
|
|
5675
|
-
method: 'GET',
|
|
5676
|
-
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
|
|
5677
|
-
path: {
|
|
5678
|
-
'org': org,
|
|
5679
|
-
'user_id': userId
|
|
5680
|
-
},
|
|
5681
|
-
query: {
|
|
5682
|
-
'department_id': departmentId,
|
|
5683
|
-
'end_date': endDate,
|
|
5684
|
-
'format': format,
|
|
5685
|
-
'include_main_platform': includeMainPlatform,
|
|
5686
|
-
'start_date': startDate
|
|
5687
|
-
}
|
|
5688
|
-
});
|
|
5689
|
-
}
|
|
5690
|
-
/**
|
|
5691
|
-
* Summary Videos watched data for a learner per enrollment
|
|
5692
|
-
*
|
|
5693
|
-
* Query Params
|
|
5694
|
-
* 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
5695
|
-
* @param org
|
|
5696
|
-
* @param userId
|
|
5697
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5698
|
-
* @param endDate end date. ISO 8601
|
|
5699
|
-
* @param format Format
|
|
5700
|
-
*
|
|
5701
|
-
* * `json` - json
|
|
5702
|
-
* @param includeMainPlatform Include main platform data
|
|
5703
|
-
* @param startDate start date. ISO 8601
|
|
5704
|
-
* @returns PerlearnerEngagementVideosWatchedPerCourse
|
|
5705
|
-
* @throws ApiError
|
|
5706
|
-
*/
|
|
5707
|
-
static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
5708
|
-
return request(OpenAPI, {
|
|
5709
|
-
method: 'GET',
|
|
5710
|
-
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/per-course',
|
|
5711
|
-
path: {
|
|
5712
|
-
'org': org,
|
|
5713
|
-
'user_id': userId
|
|
5714
|
-
},
|
|
5715
|
-
query: {
|
|
5716
|
-
'department_id': departmentId,
|
|
5717
|
-
'end_date': endDate,
|
|
5718
|
-
'format': format,
|
|
5719
|
-
'include_main_platform': includeMainPlatform,
|
|
5720
|
-
'start_date': startDate
|
|
5721
|
-
}
|
|
5722
|
-
});
|
|
5723
|
-
}
|
|
5724
|
-
/**
|
|
5725
|
-
* Get a list of user groups with metrics and filtering options.
|
|
5726
|
-
*
|
|
5727
|
-
* This endpoint provides a paginated list of user groups with aggregated metrics
|
|
5728
|
-
* about learner performance, course completions, and skill acquisition.
|
|
5729
|
-
*
|
|
5730
|
-
* This endpoint uses DM token authentication and respects department-based
|
|
5731
|
-
* access controls.
|
|
5732
|
-
*
|
|
5733
|
-
* Query Parameters:
|
|
5734
|
-
* page (int, optional): Page number for pagination
|
|
5735
|
-
* length (int, optional): Number of items per page
|
|
5736
|
-
* program (str, optional): Filter by program
|
|
5737
|
-
* pathway (str, optional): Filter by pathway
|
|
5738
|
-
* groups (list, optional): Filter by group names
|
|
5739
|
-
* location (str, optional): Filter by location
|
|
5740
|
-
* is_enrolled (bool, optional): Filter for groups with enrolled users
|
|
5741
|
-
* start_date (date, optional): Filter by learner join date (start range)
|
|
5742
|
-
* end_date (date, optional): Filter by learner join date (end range)
|
|
5743
|
-
*
|
|
5744
|
-
* Returns:
|
|
5745
|
-
* A paginated list of user groups with comprehensive metrics.
|
|
5746
|
-
*
|
|
5747
|
-
* Access Control:
|
|
5748
|
-
* - Platform admins can see all groups
|
|
5749
|
-
* - Department admins can only see groups in their departments
|
|
5750
|
-
* @param org
|
|
5751
|
-
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5752
|
-
* @param endDate Filter by learners date_joined. Start date. ISO 8601
|
|
5753
|
-
* @param format Format
|
|
5754
|
-
*
|
|
5755
|
-
* * `json` - json
|
|
5756
|
-
* @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
|
|
5757
|
-
* @param includeMainPlatform Include main platform data
|
|
5758
|
-
* @param isEnrolled Filter for users who have at least an enrollment
|
|
5759
|
-
* @param length Size of data to return
|
|
5760
|
-
* @param location Location search string
|
|
5761
|
-
* @param page Page offset
|
|
5762
|
-
* @param pathway Pathway string
|
|
5763
|
-
* @param program Program search string
|
|
5764
|
-
* @param startDate Filter by learners date_joined. Start date. ISO 8601
|
|
5765
|
-
* @returns GroupList
|
|
5766
|
-
* @throws ApiError
|
|
5767
|
-
*/
|
|
5768
|
-
static aiAnalyticsUserGroupsOrgsRetrieve(org, departmentId, endDate, format = 'json', groups, includeMainPlatform = true, isEnrolled, length, location, page, pathway, program, startDate) {
|
|
5769
|
-
return request(OpenAPI, {
|
|
5770
|
-
method: 'GET',
|
|
5771
|
-
url: '/api/ai-analytics/user-groups/orgs/{org}/',
|
|
5772
|
-
path: {
|
|
5773
|
-
'org': org
|
|
5774
|
-
},
|
|
5775
|
-
query: {
|
|
5776
|
-
'department_id': departmentId,
|
|
5777
|
-
'end_date': endDate,
|
|
5778
|
-
'format': format,
|
|
5779
|
-
'groups': groups,
|
|
5780
|
-
'include_main_platform': includeMainPlatform,
|
|
5781
|
-
'is_enrolled': isEnrolled,
|
|
5782
|
-
'length': length,
|
|
5783
|
-
'location': location,
|
|
5784
|
-
'page': page,
|
|
5785
|
-
'pathway': pathway,
|
|
5786
|
-
'program': program,
|
|
5787
|
-
'start_date': startDate
|
|
5788
|
-
}
|
|
5789
|
-
});
|
|
5790
|
-
}
|
|
5791
|
-
}
|
|
5792
|
-
|
|
5793
|
-
class AiBotService {
|
|
5794
|
-
/**
|
|
5795
|
-
* Create modify and update bot information for a specific tenant.
|
|
5796
|
-
* @param org
|
|
5797
|
-
* @returns Bot
|
|
5798
|
-
* @throws ApiError
|
|
5799
|
-
*/
|
|
5800
|
-
static aiBotV1BotsBotList(org) {
|
|
5801
|
-
return request(OpenAPI, {
|
|
5802
|
-
method: 'GET',
|
|
5803
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
5804
|
-
path: {
|
|
5805
|
-
'org': org
|
|
5806
|
-
}
|
|
5807
|
-
});
|
|
5808
|
-
}
|
|
5809
|
-
/**
|
|
5810
|
-
* Create modify and update bot information for a specific tenant.
|
|
5811
|
-
* @param org
|
|
5812
|
-
* @param requestBody
|
|
5813
|
-
* @returns BotCreate
|
|
5814
|
-
* @throws ApiError
|
|
5815
|
-
*/
|
|
5816
|
-
static aiBotV1BotsBotCreate(org, requestBody) {
|
|
5817
|
-
return request(OpenAPI, {
|
|
5818
|
-
method: 'POST',
|
|
5819
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
5820
|
-
path: {
|
|
5821
|
-
'org': org
|
|
5822
|
-
},
|
|
5823
|
-
body: requestBody,
|
|
5824
|
-
mediaType: 'application/json'
|
|
5825
|
-
});
|
|
5826
|
-
}
|
|
5827
|
-
/**
|
|
5828
|
-
* Create slash commands for a specific bot
|
|
5829
|
-
* eg. /iblai-baseline
|
|
5830
|
-
* @param org
|
|
5831
|
-
* @returns BotCommand
|
|
5832
|
-
* @throws ApiError
|
|
5833
|
-
*/
|
|
5834
|
-
static aiBotV1BotsBotCommandsList(org) {
|
|
5835
|
-
return request(OpenAPI, {
|
|
5836
|
-
method: 'GET',
|
|
5837
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
5838
|
-
path: {
|
|
5839
|
-
'org': org
|
|
5840
|
-
}
|
|
5841
|
-
});
|
|
5842
|
-
}
|
|
5843
|
-
/**
|
|
5844
|
-
* Create slash commands for a specific bot
|
|
5845
|
-
* eg. /iblai-baseline
|
|
5846
|
-
* @param org
|
|
5847
|
-
* @param requestBody
|
|
5848
|
-
* @returns BotCommand
|
|
5849
|
-
* @throws ApiError
|
|
5850
|
-
*/
|
|
5851
|
-
static aiBotV1BotsBotCommandsCreate(org, requestBody) {
|
|
5852
|
-
return request(OpenAPI, {
|
|
5853
|
-
method: 'POST',
|
|
5854
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
5855
|
-
path: {
|
|
5856
|
-
'org': org
|
|
5857
|
-
},
|
|
5858
|
-
body: requestBody,
|
|
5859
|
-
mediaType: 'application/json'
|
|
5860
|
-
});
|
|
5861
|
-
}
|
|
5862
|
-
/**
|
|
5863
|
-
* Create slash commands for a specific bot
|
|
5864
|
-
* eg. /iblai-baseline
|
|
5865
|
-
* @param id A unique integer value identifying this bot command.
|
|
5866
|
-
* @param org
|
|
5867
|
-
* @returns BotCommand
|
|
5868
|
-
* @throws ApiError
|
|
5869
|
-
*/
|
|
5870
|
-
static aiBotV1BotsBotCommandsRetrieve(id, org) {
|
|
5871
|
-
return request(OpenAPI, {
|
|
5872
|
-
method: 'GET',
|
|
5873
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5874
|
-
path: {
|
|
5875
|
-
'id': id,
|
|
5876
|
-
'org': org
|
|
5877
|
-
}
|
|
5878
|
-
});
|
|
5879
|
-
}
|
|
5880
|
-
/**
|
|
5881
|
-
* Create slash commands for a specific bot
|
|
5882
|
-
* eg. /iblai-baseline
|
|
5883
|
-
* @param id A unique integer value identifying this bot command.
|
|
5884
|
-
* @param org
|
|
5885
|
-
* @param requestBody
|
|
5886
|
-
* @returns BotCommand
|
|
5887
|
-
* @throws ApiError
|
|
5888
|
-
*/
|
|
5889
|
-
static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
|
|
5890
|
-
return request(OpenAPI, {
|
|
5891
|
-
method: 'PUT',
|
|
5892
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5893
|
-
path: {
|
|
5894
|
-
'id': id,
|
|
5895
|
-
'org': org
|
|
5896
|
-
},
|
|
5897
|
-
body: requestBody,
|
|
5898
|
-
mediaType: 'application/json'
|
|
5899
|
-
});
|
|
5900
|
-
}
|
|
5901
|
-
/**
|
|
5902
|
-
* Create slash commands for a specific bot
|
|
5903
|
-
* eg. /iblai-baseline
|
|
5904
|
-
* @param id A unique integer value identifying this bot command.
|
|
5905
|
-
* @param org
|
|
5906
|
-
* @param requestBody
|
|
5907
|
-
* @returns BotCommand
|
|
5908
|
-
* @throws ApiError
|
|
5909
|
-
*/
|
|
5910
|
-
static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
|
|
5911
|
-
return request(OpenAPI, {
|
|
5912
|
-
method: 'PATCH',
|
|
5913
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5914
|
-
path: {
|
|
5915
|
-
'id': id,
|
|
5916
|
-
'org': org
|
|
5917
|
-
},
|
|
5918
|
-
body: requestBody,
|
|
5919
|
-
mediaType: 'application/json'
|
|
5920
|
-
});
|
|
5921
|
-
}
|
|
5922
|
-
/**
|
|
5923
|
-
* Create slash commands for a specific bot
|
|
5924
|
-
* eg. /iblai-baseline
|
|
5925
|
-
* @param id A unique integer value identifying this bot command.
|
|
5926
|
-
* @param org
|
|
5927
|
-
* @returns void
|
|
5928
|
-
* @throws ApiError
|
|
5929
|
-
*/
|
|
5930
|
-
static aiBotV1BotsBotCommandsDestroy(id, org) {
|
|
5931
|
-
return request(OpenAPI, {
|
|
5932
|
-
method: 'DELETE',
|
|
5933
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5934
|
-
path: {
|
|
5935
|
-
'id': id,
|
|
5936
|
-
'org': org
|
|
5937
|
-
}
|
|
5938
|
-
});
|
|
5939
|
-
}
|
|
5940
|
-
/**
|
|
5941
|
-
* Create modify and update bot information for a specific tenant.
|
|
5942
|
-
* @param id A unique integer value identifying this bot.
|
|
5943
|
-
* @param org
|
|
5944
|
-
* @returns Bot
|
|
5945
|
-
* @throws ApiError
|
|
5946
|
-
*/
|
|
5947
|
-
static aiBotV1BotsBotRetrieve(id, org) {
|
|
5948
|
-
return request(OpenAPI, {
|
|
5949
|
-
method: 'GET',
|
|
5950
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5951
|
-
path: {
|
|
5952
|
-
'id': id,
|
|
5953
|
-
'org': org
|
|
5954
|
-
}
|
|
5955
|
-
});
|
|
5956
|
-
}
|
|
5957
|
-
/**
|
|
5958
|
-
* Create modify and update bot information for a specific tenant.
|
|
5959
|
-
* @param id A unique integer value identifying this bot.
|
|
5960
|
-
* @param org
|
|
5961
|
-
* @param requestBody
|
|
5962
|
-
* @returns BotCreate
|
|
5963
|
-
* @throws ApiError
|
|
5964
|
-
*/
|
|
5965
|
-
static aiBotV1BotsBotUpdate(id, org, requestBody) {
|
|
5966
|
-
return request(OpenAPI, {
|
|
5967
|
-
method: 'PUT',
|
|
5968
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5969
|
-
path: {
|
|
5970
|
-
'id': id,
|
|
5971
|
-
'org': org
|
|
5972
|
-
},
|
|
5973
|
-
body: requestBody,
|
|
5974
|
-
mediaType: 'application/json'
|
|
5975
|
-
});
|
|
5976
|
-
}
|
|
5977
|
-
/**
|
|
5978
|
-
* Create modify and update bot information for a specific tenant.
|
|
5979
|
-
* @param id A unique integer value identifying this bot.
|
|
5980
|
-
* @param org
|
|
5981
|
-
* @param requestBody
|
|
5982
|
-
* @returns BotCreate
|
|
5983
|
-
* @throws ApiError
|
|
5984
|
-
*/
|
|
5985
|
-
static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
|
|
5986
|
-
return request(OpenAPI, {
|
|
5987
|
-
method: 'PATCH',
|
|
5988
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5989
|
-
path: {
|
|
5990
|
-
'id': id,
|
|
5991
|
-
'org': org
|
|
5992
|
-
},
|
|
5993
|
-
body: requestBody,
|
|
5994
|
-
mediaType: 'application/json'
|
|
5995
|
-
});
|
|
5996
|
-
}
|
|
5997
|
-
/**
|
|
5998
|
-
* Create modify and update bot information for a specific tenant.
|
|
5999
|
-
* @param id A unique integer value identifying this bot.
|
|
6000
|
-
* @param org
|
|
6001
|
-
* @returns void
|
|
6002
|
-
* @throws ApiError
|
|
6003
|
-
*/
|
|
6004
|
-
static aiBotV1BotsBotDestroy(id, org) {
|
|
6005
|
-
return request(OpenAPI, {
|
|
6006
|
-
method: 'DELETE',
|
|
6007
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
6008
|
-
path: {
|
|
6009
|
-
'id': id,
|
|
6010
|
-
'org': org
|
|
6011
|
-
}
|
|
6012
|
-
});
|
|
6013
|
-
}
|
|
6014
|
-
/**
|
|
6015
|
-
* Create modify and update bot information for a specific tenant.
|
|
6016
|
-
* @param id A unique integer value identifying this bot.
|
|
6017
|
-
* @param org
|
|
6018
|
-
* @returns DiscordConfig
|
|
6019
|
-
* @throws ApiError
|
|
6020
|
-
*/
|
|
6021
|
-
static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
|
|
6022
|
-
return request(OpenAPI, {
|
|
6023
|
-
method: 'GET',
|
|
6024
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6025
|
-
path: {
|
|
6026
|
-
'id': id,
|
|
6027
|
-
'org': org
|
|
6028
|
-
}
|
|
6029
|
-
});
|
|
6030
|
-
}
|
|
6031
|
-
/**
|
|
6032
|
-
* Create modify and update bot information for a specific tenant.
|
|
6033
|
-
* @param id A unique integer value identifying this bot.
|
|
6034
|
-
* @param org
|
|
6035
|
-
* @param requestBody
|
|
6036
|
-
* @returns DiscordConfig
|
|
6037
|
-
* @throws ApiError
|
|
6038
|
-
*/
|
|
6039
|
-
static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
|
|
6040
|
-
return request(OpenAPI, {
|
|
6041
|
-
method: 'PATCH',
|
|
6042
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6043
|
-
path: {
|
|
6044
|
-
'id': id,
|
|
6045
|
-
'org': org
|
|
6046
|
-
},
|
|
6047
|
-
body: requestBody,
|
|
6048
|
-
mediaType: 'application/json'
|
|
6049
|
-
});
|
|
6050
|
-
}
|
|
6051
|
-
/**
|
|
6052
|
-
* Create modify and update bot information for a specific tenant.
|
|
6053
|
-
* @param id A unique integer value identifying this bot.
|
|
6054
|
-
* @param org
|
|
6055
|
-
* @returns SlackConfig
|
|
6056
|
-
* @throws ApiError
|
|
6057
|
-
*/
|
|
6058
|
-
static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
|
|
6059
|
-
return request(OpenAPI, {
|
|
6060
|
-
method: 'GET',
|
|
6061
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
|
|
6062
|
-
path: {
|
|
6063
|
-
'id': id,
|
|
6064
|
-
'org': org
|
|
6065
|
-
}
|
|
6066
|
-
});
|
|
6067
|
-
}
|
|
6068
|
-
/**
|
|
6069
|
-
* Create modify and update bot information for a specific tenant.
|
|
6070
|
-
* @param id A unique integer value identifying this bot.
|
|
6071
|
-
* @param org
|
|
6072
|
-
* @param requestBody
|
|
6073
|
-
* @returns SlackConfig
|
|
6074
|
-
* @throws ApiError
|
|
6075
|
-
*/
|
|
6076
|
-
static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
|
|
6077
|
-
return request(OpenAPI, {
|
|
6078
|
-
method: 'POST',
|
|
6079
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6080
|
-
path: {
|
|
6081
|
-
'id': id,
|
|
6082
|
-
'org': org
|
|
6083
|
-
},
|
|
6084
|
-
body: requestBody,
|
|
6085
|
-
mediaType: 'application/json'
|
|
6086
|
-
});
|
|
6087
|
-
}
|
|
6088
|
-
/**
|
|
6089
|
-
* Create modify and update bot information for a specific tenant.
|
|
6090
|
-
* @param id A unique integer value identifying this bot.
|
|
6091
|
-
* @param org
|
|
6092
|
-
* @param requestBody
|
|
6093
|
-
* @returns SlackConfig
|
|
6094
|
-
* @throws ApiError
|
|
6095
|
-
*/
|
|
6096
|
-
static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
|
|
6097
|
-
return request(OpenAPI, {
|
|
6098
|
-
method: 'PUT',
|
|
6099
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6100
|
-
path: {
|
|
6101
|
-
'id': id,
|
|
6102
|
-
'org': org
|
|
6103
|
-
},
|
|
6104
|
-
body: requestBody,
|
|
6105
|
-
mediaType: 'application/json'
|
|
6106
|
-
});
|
|
6107
|
-
}
|
|
6108
|
-
/**
|
|
6109
|
-
* Create modify and update bot information for a specific tenant.
|
|
6110
|
-
* @param id A unique integer value identifying this bot.
|
|
6111
|
-
* @param org
|
|
6112
|
-
* @param requestBody
|
|
6113
|
-
* @returns SlackConfig
|
|
6114
|
-
* @throws ApiError
|
|
6115
|
-
*/
|
|
6116
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
|
|
6117
|
-
return request(OpenAPI, {
|
|
6118
|
-
method: 'PATCH',
|
|
6119
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6120
|
-
path: {
|
|
6121
|
-
'id': id,
|
|
6122
|
-
'org': org
|
|
6123
|
-
},
|
|
6124
|
-
body: requestBody,
|
|
6125
|
-
mediaType: 'application/json'
|
|
6126
|
-
});
|
|
6127
|
-
}
|
|
6128
|
-
/**
|
|
6129
|
-
* Create modify and update bot information for a specific tenant.
|
|
6130
|
-
* @param id A unique integer value identifying this bot.
|
|
6131
|
-
* @param org
|
|
6132
|
-
* @returns TeamsConfig
|
|
6133
|
-
* @throws ApiError
|
|
6134
|
-
*/
|
|
6135
|
-
static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
|
|
6136
|
-
return request(OpenAPI, {
|
|
6137
|
-
method: 'GET',
|
|
6138
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
6139
|
-
path: {
|
|
6140
|
-
'id': id,
|
|
6141
|
-
'org': org
|
|
6142
|
-
}
|
|
6143
|
-
});
|
|
6144
|
-
}
|
|
6145
|
-
/**
|
|
6146
|
-
* Create modify and update bot information for a specific tenant.
|
|
6147
|
-
* @param id A unique integer value identifying this bot.
|
|
6148
|
-
* @param org
|
|
6149
|
-
* @param requestBody
|
|
6150
|
-
* @returns TeamsConfig
|
|
6151
|
-
* @throws ApiError
|
|
6152
|
-
*/
|
|
6153
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
|
|
6154
|
-
return request(OpenAPI, {
|
|
6155
|
-
method: 'POST',
|
|
6156
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6157
|
-
path: {
|
|
6158
|
-
'id': id,
|
|
6159
|
-
'org': org
|
|
6160
|
-
},
|
|
6161
|
-
body: requestBody,
|
|
6162
|
-
mediaType: 'application/json'
|
|
6163
|
-
});
|
|
6164
|
-
}
|
|
6165
|
-
/**
|
|
6166
|
-
* Create modify and update bot information for a specific tenant.
|
|
6167
|
-
* @param id A unique integer value identifying this bot.
|
|
6168
|
-
* @param org
|
|
6169
|
-
* @param requestBody
|
|
6170
|
-
* @returns TeamsConfig
|
|
6171
|
-
* @throws ApiError
|
|
6172
|
-
*/
|
|
6173
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
|
|
6174
|
-
return request(OpenAPI, {
|
|
6175
|
-
method: 'PUT',
|
|
6176
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6177
|
-
path: {
|
|
6178
|
-
'id': id,
|
|
6179
|
-
'org': org
|
|
6180
|
-
},
|
|
6181
|
-
body: requestBody,
|
|
6182
|
-
mediaType: 'application/json'
|
|
6183
|
-
});
|
|
6184
|
-
}
|
|
6185
|
-
/**
|
|
6186
|
-
* Create modify and update bot information for a specific tenant.
|
|
6187
|
-
* @param id A unique integer value identifying this bot.
|
|
6188
|
-
* @param org
|
|
6189
|
-
* @param requestBody
|
|
6190
|
-
* @returns TeamsConfig
|
|
6191
|
-
* @throws ApiError
|
|
6192
|
-
*/
|
|
6193
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
|
|
6194
|
-
return request(OpenAPI, {
|
|
6195
|
-
method: 'PATCH',
|
|
6196
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6197
|
-
path: {
|
|
6198
|
-
'id': id,
|
|
6199
|
-
'org': org
|
|
6200
|
-
},
|
|
6201
|
-
body: requestBody,
|
|
6202
|
-
mediaType: 'application/json'
|
|
6203
|
-
});
|
|
6204
|
-
}
|
|
6205
|
-
/**
|
|
6206
|
-
* Create modify and update bot information for a specific tenant.
|
|
6207
|
-
* @param id A unique integer value identifying this bot.
|
|
6208
|
-
* @param org
|
|
6209
|
-
* @returns WebexConfig
|
|
6210
|
-
* @throws ApiError
|
|
6211
|
-
*/
|
|
6212
|
-
static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
|
|
6213
|
-
return request(OpenAPI, {
|
|
6214
|
-
method: 'GET',
|
|
6215
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6216
|
-
path: {
|
|
6217
|
-
'id': id,
|
|
6218
|
-
'org': org
|
|
6219
|
-
}
|
|
6220
|
-
});
|
|
6221
|
-
}
|
|
6222
|
-
/**
|
|
6223
|
-
* Create modify and update bot information for a specific tenant.
|
|
6224
|
-
* @param id A unique integer value identifying this bot.
|
|
6225
|
-
* @param org
|
|
6226
|
-
* @param requestBody
|
|
6227
|
-
* @returns WebexConfig
|
|
6228
|
-
* @throws ApiError
|
|
6229
|
-
*/
|
|
6230
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
|
|
6231
|
-
return request(OpenAPI, {
|
|
6232
|
-
method: 'PATCH',
|
|
6233
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6234
|
-
path: {
|
|
6235
|
-
'id': id,
|
|
6236
|
-
'org': org
|
|
6237
|
-
},
|
|
6238
|
-
body: requestBody,
|
|
6239
|
-
mediaType: 'application/json'
|
|
6240
|
-
});
|
|
6241
|
-
}
|
|
6242
|
-
/**
|
|
6243
|
-
* Create modify and update bot information for a specific tenant.
|
|
6244
|
-
* @param id A unique integer value identifying this bot.
|
|
6245
|
-
* @param org
|
|
6246
|
-
* @returns WhatsappConfig
|
|
6247
|
-
* @throws ApiError
|
|
6248
|
-
*/
|
|
6249
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
|
|
6250
|
-
return request(OpenAPI, {
|
|
6251
|
-
method: 'GET',
|
|
6252
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
6253
|
-
path: {
|
|
6254
|
-
'id': id,
|
|
6255
|
-
'org': org
|
|
6256
|
-
}
|
|
6257
|
-
});
|
|
6258
|
-
}
|
|
6259
|
-
/**
|
|
6260
|
-
* Create modify and update bot information for a specific tenant.
|
|
6261
|
-
* @param id A unique integer value identifying this bot.
|
|
6262
|
-
* @param org
|
|
6263
|
-
* @param requestBody
|
|
6264
|
-
* @returns WhatsappConfig
|
|
6265
|
-
* @throws ApiError
|
|
6266
|
-
*/
|
|
6267
|
-
static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
|
|
6268
|
-
return request(OpenAPI, {
|
|
6269
|
-
method: 'PUT',
|
|
6270
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6271
|
-
path: {
|
|
6272
|
-
'id': id,
|
|
6273
|
-
'org': org
|
|
6274
|
-
},
|
|
6275
|
-
body: requestBody,
|
|
6276
|
-
mediaType: 'application/json'
|
|
6277
|
-
});
|
|
6278
|
-
}
|
|
6279
|
-
/**
|
|
6280
|
-
* Create modify and update bot information for a specific tenant.
|
|
6281
|
-
* @param id A unique integer value identifying this bot.
|
|
6282
|
-
* @param org
|
|
6283
|
-
* @param requestBody
|
|
6284
|
-
* @returns WhatsappConfig
|
|
6285
|
-
* @throws ApiError
|
|
6286
|
-
*/
|
|
6287
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
|
|
6288
|
-
return request(OpenAPI, {
|
|
6289
|
-
method: 'PATCH',
|
|
6290
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6291
|
-
path: {
|
|
6292
|
-
'id': id,
|
|
6293
|
-
'org': org
|
|
6294
|
-
},
|
|
6295
|
-
body: requestBody,
|
|
6296
|
-
mediaType: 'application/json'
|
|
6297
|
-
});
|
|
6298
|
-
}
|
|
6299
|
-
/**
|
|
6300
|
-
* Setup discord user id linkage with discord bots
|
|
6301
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6302
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6303
|
-
* @param org
|
|
6304
|
-
* @returns DiscordUserConfig
|
|
6305
|
-
* @throws ApiError
|
|
6306
|
-
*/
|
|
6307
|
-
static aiBotV1BotsDiscordUserConfigList(org) {
|
|
6308
|
-
return request(OpenAPI, {
|
|
6309
|
-
method: 'GET',
|
|
6310
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6311
|
-
path: {
|
|
6312
|
-
'org': org
|
|
6313
|
-
}
|
|
6314
|
-
});
|
|
6315
|
-
}
|
|
6316
|
-
/**
|
|
6317
|
-
* Setup discord user id linkage with discord bots
|
|
6318
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6319
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6320
|
-
* @param org
|
|
6321
|
-
* @param requestBody
|
|
6322
|
-
* @returns DiscordUserConfig
|
|
6323
|
-
* @throws ApiError
|
|
6324
|
-
*/
|
|
6325
|
-
static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
|
|
6326
|
-
return request(OpenAPI, {
|
|
6327
|
-
method: 'POST',
|
|
6328
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6329
|
-
path: {
|
|
6330
|
-
'org': org
|
|
6331
|
-
},
|
|
6332
|
-
body: requestBody,
|
|
6333
|
-
mediaType: 'application/json'
|
|
6334
|
-
});
|
|
6335
|
-
}
|
|
6336
|
-
/**
|
|
6337
|
-
* Setup discord user id linkage with discord bots
|
|
6338
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6339
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6340
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6341
|
-
* @param org
|
|
6342
|
-
* @returns DiscordUserConfig
|
|
6343
|
-
* @throws ApiError
|
|
6344
|
-
*/
|
|
6345
|
-
static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
|
|
6346
|
-
return request(OpenAPI, {
|
|
6347
|
-
method: 'GET',
|
|
6348
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6349
|
-
path: {
|
|
6350
|
-
'id': id,
|
|
6351
|
-
'org': org
|
|
6352
|
-
}
|
|
6353
|
-
});
|
|
6354
|
-
}
|
|
6355
|
-
/**
|
|
6356
|
-
* Setup discord user id linkage with discord bots
|
|
6357
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6358
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6359
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6360
|
-
* @param org
|
|
6361
|
-
* @param requestBody
|
|
6362
|
-
* @returns DiscordUserConfig
|
|
6363
|
-
* @throws ApiError
|
|
6364
|
-
*/
|
|
6365
|
-
static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
|
|
6366
|
-
return request(OpenAPI, {
|
|
6367
|
-
method: 'PUT',
|
|
6368
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6369
|
-
path: {
|
|
6370
|
-
'id': id,
|
|
6371
|
-
'org': org
|
|
6372
|
-
},
|
|
6373
|
-
body: requestBody,
|
|
6374
|
-
mediaType: 'application/json'
|
|
6375
|
-
});
|
|
6376
|
-
}
|
|
6377
|
-
/**
|
|
6378
|
-
* Setup discord user id linkage with discord bots
|
|
6379
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6380
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6381
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6382
|
-
* @param org
|
|
6383
|
-
* @param requestBody
|
|
6384
|
-
* @returns DiscordUserConfig
|
|
6385
|
-
* @throws ApiError
|
|
6386
|
-
*/
|
|
6387
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
|
|
6388
|
-
return request(OpenAPI, {
|
|
6389
|
-
method: 'PATCH',
|
|
6390
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6391
|
-
path: {
|
|
6392
|
-
'id': id,
|
|
6393
|
-
'org': org
|
|
6394
|
-
},
|
|
6395
|
-
body: requestBody,
|
|
6396
|
-
mediaType: 'application/json'
|
|
6397
|
-
});
|
|
6398
|
-
}
|
|
6399
|
-
/**
|
|
6400
|
-
* Setup discord user id linkage with discord bots
|
|
6401
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6402
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6403
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6404
|
-
* @param org
|
|
6405
|
-
* @returns void
|
|
6406
|
-
* @throws ApiError
|
|
6407
|
-
*/
|
|
6408
|
-
static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
|
|
6409
|
-
return request(OpenAPI, {
|
|
6410
|
-
method: 'DELETE',
|
|
6411
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6412
|
-
path: {
|
|
6413
|
-
'id': id,
|
|
6414
|
-
'org': org
|
|
6415
|
-
}
|
|
6416
|
-
});
|
|
6417
|
-
}
|
|
6418
|
-
/**
|
|
6419
|
-
* Setup slack username and domain linkage with slack bots
|
|
6420
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6421
|
-
* @param org
|
|
6422
|
-
* @returns SlackUserConfig
|
|
6423
|
-
* @throws ApiError
|
|
6424
|
-
*/
|
|
6425
|
-
static aiBotV1BotsSlackUserConfigList(org) {
|
|
6426
|
-
return request(OpenAPI, {
|
|
6427
|
-
method: 'GET',
|
|
6428
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6429
|
-
path: {
|
|
6430
|
-
'org': org
|
|
6431
|
-
}
|
|
6432
|
-
});
|
|
6433
|
-
}
|
|
6434
|
-
/**
|
|
6435
|
-
* Setup slack username and domain linkage with slack bots
|
|
6436
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6437
|
-
* @param org
|
|
6438
|
-
* @param requestBody
|
|
6439
|
-
* @returns SlackUserConfig
|
|
6440
|
-
* @throws ApiError
|
|
6441
|
-
*/
|
|
6442
|
-
static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
|
|
6443
|
-
return request(OpenAPI, {
|
|
6444
|
-
method: 'POST',
|
|
6445
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6446
|
-
path: {
|
|
6447
|
-
'org': org
|
|
6448
|
-
},
|
|
6449
|
-
body: requestBody,
|
|
6450
|
-
mediaType: 'application/json'
|
|
6451
|
-
});
|
|
6452
|
-
}
|
|
6453
|
-
/**
|
|
6454
|
-
* Setup slack username and domain linkage with slack bots
|
|
6455
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6456
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6457
|
-
* @param org
|
|
6458
|
-
* @returns SlackUserConfig
|
|
6459
|
-
* @throws ApiError
|
|
6460
|
-
*/
|
|
6461
|
-
static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
|
|
6462
|
-
return request(OpenAPI, {
|
|
6463
|
-
method: 'GET',
|
|
6464
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6465
|
-
path: {
|
|
6466
|
-
'id': id,
|
|
6467
|
-
'org': org
|
|
6468
|
-
}
|
|
6469
|
-
});
|
|
6470
|
-
}
|
|
6471
|
-
/**
|
|
6472
|
-
* Setup slack username and domain linkage with slack bots
|
|
6473
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6474
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6475
|
-
* @param org
|
|
6476
|
-
* @param requestBody
|
|
6477
|
-
* @returns SlackUserConfig
|
|
6478
|
-
* @throws ApiError
|
|
6479
|
-
*/
|
|
6480
|
-
static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
|
|
6481
|
-
return request(OpenAPI, {
|
|
6482
|
-
method: 'PUT',
|
|
6483
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6484
|
-
path: {
|
|
6485
|
-
'id': id,
|
|
6486
|
-
'org': org
|
|
6487
|
-
},
|
|
6488
|
-
body: requestBody,
|
|
6489
|
-
mediaType: 'application/json'
|
|
6490
|
-
});
|
|
6491
|
-
}
|
|
6492
|
-
/**
|
|
6493
|
-
* Setup slack username and domain linkage with slack bots
|
|
6494
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6495
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6496
|
-
* @param org
|
|
6497
|
-
* @param requestBody
|
|
6498
|
-
* @returns SlackUserConfig
|
|
6499
|
-
* @throws ApiError
|
|
6500
|
-
*/
|
|
6501
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
|
|
6502
|
-
return request(OpenAPI, {
|
|
6503
|
-
method: 'PATCH',
|
|
6504
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6505
|
-
path: {
|
|
6506
|
-
'id': id,
|
|
6507
|
-
'org': org
|
|
6508
|
-
},
|
|
6509
|
-
body: requestBody,
|
|
6510
|
-
mediaType: 'application/json'
|
|
6511
|
-
});
|
|
6512
|
-
}
|
|
6513
|
-
/**
|
|
6514
|
-
* Setup slack username and domain linkage with slack bots
|
|
6515
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6516
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6517
|
-
* @param org
|
|
6518
|
-
* @returns void
|
|
6519
|
-
* @throws ApiError
|
|
6520
|
-
*/
|
|
6521
|
-
static aiBotV1BotsSlackUserConfigDestroy(id, org) {
|
|
6522
|
-
return request(OpenAPI, {
|
|
6523
|
-
method: 'DELETE',
|
|
6524
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6525
|
-
path: {
|
|
6526
|
-
'id': id,
|
|
6527
|
-
'org': org
|
|
6528
|
-
}
|
|
6529
|
-
});
|
|
6530
|
-
}
|
|
6531
|
-
/**
|
|
6532
|
-
* Setup phone number linkage with whatsapp bots
|
|
6533
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6534
|
-
* @param org
|
|
6535
|
-
* @returns WhatsappUserConfig
|
|
6536
|
-
* @throws ApiError
|
|
6537
|
-
*/
|
|
6538
|
-
static aiBotV1BotsWhatsappUserConfigList(org) {
|
|
6539
|
-
return request(OpenAPI, {
|
|
6540
|
-
method: 'GET',
|
|
6541
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6542
|
-
path: {
|
|
6543
|
-
'org': org
|
|
6544
|
-
}
|
|
6545
|
-
});
|
|
6546
|
-
}
|
|
6547
|
-
/**
|
|
6548
|
-
* Setup phone number linkage with whatsapp bots
|
|
6549
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6550
|
-
* @param org
|
|
6551
|
-
* @param requestBody
|
|
6552
|
-
* @returns WhatsappUserConfig
|
|
6553
|
-
* @throws ApiError
|
|
6554
|
-
*/
|
|
6555
|
-
static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
|
|
6556
|
-
return request(OpenAPI, {
|
|
6557
|
-
method: 'POST',
|
|
6558
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6559
|
-
path: {
|
|
6560
|
-
'org': org
|
|
6561
|
-
},
|
|
6562
|
-
body: requestBody,
|
|
6563
|
-
mediaType: 'application/json'
|
|
6564
|
-
});
|
|
6565
|
-
}
|
|
6566
|
-
/**
|
|
6567
|
-
* Setup phone number linkage with whatsapp bots
|
|
6568
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6569
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6570
|
-
* @param org
|
|
6571
|
-
* @returns WhatsappUserConfig
|
|
6572
|
-
* @throws ApiError
|
|
6573
|
-
*/
|
|
6574
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
|
|
6575
|
-
return request(OpenAPI, {
|
|
6576
|
-
method: 'GET',
|
|
6577
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6578
|
-
path: {
|
|
6579
|
-
'id': id,
|
|
6580
|
-
'org': org
|
|
6581
|
-
}
|
|
6582
|
-
});
|
|
6583
|
-
}
|
|
6584
|
-
/**
|
|
6585
|
-
* Setup phone number linkage with whatsapp bots
|
|
6586
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6587
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6588
|
-
* @param org
|
|
6589
|
-
* @param requestBody
|
|
6590
|
-
* @returns WhatsappUserConfig
|
|
6591
|
-
* @throws ApiError
|
|
6592
|
-
*/
|
|
6593
|
-
static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
|
|
6594
|
-
return request(OpenAPI, {
|
|
6595
|
-
method: 'PUT',
|
|
6596
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6597
|
-
path: {
|
|
6598
|
-
'id': id,
|
|
6599
|
-
'org': org
|
|
6600
|
-
},
|
|
6601
|
-
body: requestBody,
|
|
6602
|
-
mediaType: 'application/json'
|
|
6603
|
-
});
|
|
6604
|
-
}
|
|
6605
|
-
/**
|
|
6606
|
-
* Setup phone number linkage with whatsapp bots
|
|
6607
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6608
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6609
|
-
* @param org
|
|
6610
|
-
* @param requestBody
|
|
6611
|
-
* @returns WhatsappUserConfig
|
|
6612
|
-
* @throws ApiError
|
|
6613
|
-
*/
|
|
6614
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
|
|
6615
|
-
return request(OpenAPI, {
|
|
6616
|
-
method: 'PATCH',
|
|
6617
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6618
|
-
path: {
|
|
6619
|
-
'id': id,
|
|
6620
|
-
'org': org
|
|
6621
|
-
},
|
|
6622
|
-
body: requestBody,
|
|
6623
|
-
mediaType: 'application/json'
|
|
6624
|
-
});
|
|
6625
|
-
}
|
|
6626
|
-
/**
|
|
6627
|
-
* Setup phone number linkage with whatsapp bots
|
|
6628
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6629
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6630
|
-
* @param org
|
|
6631
|
-
* @returns void
|
|
6632
|
-
* @throws ApiError
|
|
6633
|
-
*/
|
|
6634
|
-
static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
|
|
6635
|
-
return request(OpenAPI, {
|
|
6636
|
-
method: 'DELETE',
|
|
6637
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6638
|
-
path: {
|
|
6639
|
-
'id': id,
|
|
6640
|
-
'org': org
|
|
6641
|
-
}
|
|
6642
|
-
});
|
|
6643
|
-
}
|
|
6644
|
-
/**
|
|
6645
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6646
|
-
* @param name
|
|
6647
|
-
* @param org
|
|
6648
|
-
* @param requestBody
|
|
6649
|
-
* @returns DiscordWebhook
|
|
6650
|
-
* @throws ApiError
|
|
6651
|
-
*/
|
|
6652
|
-
static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
|
|
6653
|
-
return request(OpenAPI, {
|
|
6654
|
-
method: 'POST',
|
|
6655
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
|
|
6656
|
-
path: {
|
|
6657
|
-
'name': name,
|
|
6658
|
-
'org': org
|
|
6659
|
-
},
|
|
6660
|
-
body: requestBody,
|
|
6661
|
-
mediaType: 'application/json'
|
|
6662
|
-
});
|
|
6663
|
-
}
|
|
6664
|
-
/**
|
|
6665
|
-
* @param name
|
|
6666
|
-
* @param org
|
|
6667
|
-
* @param requestBody
|
|
6668
|
-
* @returns SlackWebhook
|
|
6669
|
-
* @throws ApiError
|
|
6670
|
-
*/
|
|
6671
|
-
static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
|
|
6672
|
-
return request(OpenAPI, {
|
|
6673
|
-
method: 'POST',
|
|
6674
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
|
|
6675
|
-
path: {
|
|
6676
|
-
'name': name,
|
|
6677
|
-
'org': org
|
|
6678
|
-
},
|
|
6679
|
-
body: requestBody,
|
|
6680
|
-
mediaType: 'application/json'
|
|
6681
|
-
});
|
|
6682
|
-
}
|
|
6683
|
-
/**
|
|
6684
|
-
* @param name
|
|
6685
|
-
* @param org
|
|
6686
|
-
* @param requestBody
|
|
6687
|
-
* @returns TeamsWebhook
|
|
6688
|
-
* @throws ApiError
|
|
6689
|
-
*/
|
|
6690
|
-
static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
|
|
6691
|
-
return request(OpenAPI, {
|
|
6692
|
-
method: 'POST',
|
|
6693
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
|
|
6694
|
-
path: {
|
|
6695
|
-
'name': name,
|
|
6696
|
-
'org': org
|
|
6697
|
-
},
|
|
6698
|
-
body: requestBody,
|
|
6699
|
-
mediaType: 'application/json'
|
|
6700
|
-
});
|
|
6701
|
-
}
|
|
6702
|
-
/**
|
|
6703
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6704
|
-
* @param name
|
|
6705
|
-
* @param org
|
|
6706
|
-
* @param requestBody
|
|
6707
|
-
* @returns WebexWebhook
|
|
6708
|
-
* @throws ApiError
|
|
6709
|
-
*/
|
|
6710
|
-
static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
|
|
6711
|
-
return request(OpenAPI, {
|
|
6712
|
-
method: 'POST',
|
|
6713
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
6714
|
-
path: {
|
|
6715
|
-
'name': name,
|
|
6716
|
-
'org': org
|
|
6717
|
-
},
|
|
6718
|
-
body: requestBody,
|
|
6719
|
-
mediaType: 'application/json'
|
|
6720
|
-
});
|
|
6721
|
-
}
|
|
6722
|
-
/**
|
|
6723
|
-
* Respond to whatsapp's webhook challenge.
|
|
6724
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
6725
|
-
* @param name
|
|
6726
|
-
* @param org
|
|
6727
|
-
* @returns WhatAppWebHook
|
|
6728
|
-
* @throws ApiError
|
|
6729
|
-
*/
|
|
6730
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
|
|
6731
|
-
return request(OpenAPI, {
|
|
6732
|
-
method: 'GET',
|
|
6733
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6734
|
-
path: {
|
|
6735
|
-
'name': name,
|
|
6736
|
-
'org': org
|
|
6737
|
-
}
|
|
6738
|
-
});
|
|
6739
|
-
}
|
|
6740
|
-
/**
|
|
6741
|
-
* Accept and process webhook events from whatsapp.
|
|
6742
|
-
* @param name
|
|
6743
|
-
* @param org
|
|
6744
|
-
* @param requestBody
|
|
6745
|
-
* @returns WhatAppWebHook
|
|
6746
|
-
* @throws ApiError
|
|
6747
|
-
*/
|
|
6748
|
-
static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
|
|
6749
|
-
return request(OpenAPI, {
|
|
6750
|
-
method: 'POST',
|
|
6751
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6752
|
-
path: {
|
|
6753
|
-
'name': name,
|
|
6754
|
-
'org': org
|
|
6755
|
-
},
|
|
6756
|
-
body: requestBody,
|
|
6757
|
-
mediaType: 'application/json'
|
|
6758
|
-
});
|
|
6759
|
-
}
|
|
6760
|
-
}
|
|
6761
|
-
|
|
6762
|
-
class AiFinetuningService {
|
|
6763
|
-
/**
|
|
6764
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6765
|
-
* @param org
|
|
6766
|
-
* @param username
|
|
6767
|
-
* @param dateCreated
|
|
6768
|
-
* @param numDataPoints
|
|
6769
|
-
* @param ordering Which field to use when ordering the results.
|
|
6770
|
-
* @param page A page number within the paginated result set.
|
|
6771
|
-
* @param pageSize Number of results to return per page.
|
|
6772
|
-
* @param retryAttempts
|
|
6773
|
-
* @param search A search term.
|
|
6774
|
-
* @param status * `pending` - Pending
|
|
6775
|
-
* * `processing` - Processing
|
|
6776
|
-
* * `completed` - Completed
|
|
6777
|
-
* * `failed` - Failed
|
|
6778
|
-
* @returns PaginatedDataSetList
|
|
6779
|
-
* @throws ApiError
|
|
6780
|
-
*/
|
|
6781
|
-
static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
|
|
6782
|
-
return request(OpenAPI, {
|
|
6783
|
-
method: 'GET',
|
|
6784
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6785
|
-
path: {
|
|
6786
|
-
'org': org,
|
|
6787
|
-
'username': username
|
|
6788
|
-
},
|
|
6789
|
-
query: {
|
|
6790
|
-
'date_created': dateCreated,
|
|
6791
|
-
'num_data_points': numDataPoints,
|
|
6792
|
-
'ordering': ordering,
|
|
6793
|
-
'page': page,
|
|
6794
|
-
'page_size': pageSize,
|
|
6795
|
-
'retry_attempts': retryAttempts,
|
|
6796
|
-
'search': search,
|
|
6797
|
-
'status': status
|
|
6798
|
-
}
|
|
6799
|
-
});
|
|
6800
|
-
}
|
|
6801
|
-
/**
|
|
6802
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6803
|
-
* @param org
|
|
6804
|
-
* @param username
|
|
6805
|
-
* @param requestBody
|
|
6806
|
-
* @returns DataSetCreate
|
|
6807
|
-
* @throws ApiError
|
|
6808
|
-
*/
|
|
6809
|
-
static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
|
|
6810
|
-
return request(OpenAPI, {
|
|
6811
|
-
method: 'POST',
|
|
6812
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6813
|
-
path: {
|
|
6814
|
-
'org': org,
|
|
6815
|
-
'username': username
|
|
6816
|
-
},
|
|
6817
|
-
body: requestBody,
|
|
6818
|
-
mediaType: 'application/json'
|
|
6819
|
-
});
|
|
6820
|
-
}
|
|
6821
|
-
/**
|
|
6822
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6823
|
-
* @param id A UUID string identifying this data set.
|
|
6824
|
-
* @param org
|
|
6825
|
-
* @param username
|
|
6826
|
-
* @returns DataSet
|
|
6827
|
-
* @throws ApiError
|
|
6828
|
-
*/
|
|
6829
|
-
static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
|
|
6830
|
-
return request(OpenAPI, {
|
|
6831
|
-
method: 'GET',
|
|
6832
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6833
|
-
path: {
|
|
6834
|
-
'id': id,
|
|
6835
|
-
'org': org,
|
|
6836
|
-
'username': username
|
|
6837
|
-
}
|
|
6838
|
-
});
|
|
6839
|
-
}
|
|
6840
|
-
/**
|
|
6841
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6842
|
-
* @param id A UUID string identifying this data set.
|
|
6843
|
-
* @param org
|
|
6844
|
-
* @param username
|
|
6845
|
-
* @param requestBody
|
|
6846
|
-
* @returns DataSet
|
|
6847
|
-
* @throws ApiError
|
|
6848
|
-
*/
|
|
6849
|
-
static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
|
|
6850
|
-
return request(OpenAPI, {
|
|
6851
|
-
method: 'PUT',
|
|
6852
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6853
|
-
path: {
|
|
6854
|
-
'id': id,
|
|
6855
|
-
'org': org,
|
|
6856
|
-
'username': username
|
|
6857
|
-
},
|
|
6858
|
-
body: requestBody,
|
|
6859
|
-
mediaType: 'application/json'
|
|
6860
|
-
});
|
|
6861
|
-
}
|
|
6862
|
-
/**
|
|
6863
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6864
|
-
* @param id A UUID string identifying this data set.
|
|
6865
|
-
* @param org
|
|
6866
|
-
* @param username
|
|
6867
|
-
* @param requestBody
|
|
6868
|
-
* @returns DataSet
|
|
6869
|
-
* @throws ApiError
|
|
6870
|
-
*/
|
|
6871
|
-
static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
|
|
6872
|
-
return request(OpenAPI, {
|
|
6873
|
-
method: 'PATCH',
|
|
6874
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6875
|
-
path: {
|
|
6876
|
-
'id': id,
|
|
6877
|
-
'org': org,
|
|
6878
|
-
'username': username
|
|
6879
|
-
},
|
|
6880
|
-
body: requestBody,
|
|
6881
|
-
mediaType: 'application/json'
|
|
6882
|
-
});
|
|
6883
|
-
}
|
|
6884
|
-
/**
|
|
6885
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6886
|
-
* @param id A UUID string identifying this data set.
|
|
6887
|
-
* @param org
|
|
6888
|
-
* @param username
|
|
6889
|
-
* @returns void
|
|
6890
|
-
* @throws ApiError
|
|
6891
|
-
*/
|
|
6892
|
-
static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
|
|
6893
|
-
return request(OpenAPI, {
|
|
6894
|
-
method: 'DELETE',
|
|
6895
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6896
|
-
path: {
|
|
6897
|
-
'id': id,
|
|
6898
|
-
'org': org,
|
|
6899
|
-
'username': username
|
|
6900
|
-
}
|
|
6901
|
-
});
|
|
6902
|
-
}
|
|
6903
|
-
/**
|
|
6904
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6905
|
-
* @param org
|
|
6906
|
-
* @param username
|
|
6907
|
-
* @param baseModelName
|
|
6908
|
-
* @param dataset
|
|
6909
|
-
* @param dateCreated
|
|
6910
|
-
* @param fineTunedModel
|
|
6911
|
-
* @param lastModified
|
|
6912
|
-
* @param ordering Which field to use when ordering the results.
|
|
6913
|
-
* @param page A page number within the paginated result set.
|
|
6914
|
-
* @param pageSize Number of results to return per page.
|
|
6915
|
-
* @param preprocessDataset
|
|
6916
|
-
* @param provider * `openai` - Openai
|
|
6917
|
-
* @param search A search term.
|
|
6918
|
-
* @param status * `pending` - Pending
|
|
6919
|
-
* * `processing` - Processing
|
|
6920
|
-
* * `completed` - Completed
|
|
6921
|
-
* * `cancelled` - Cancelled
|
|
6922
|
-
* * `failed` - Failed
|
|
6923
|
-
* @returns PaginatedTrainingList
|
|
6924
|
-
* @throws ApiError
|
|
6925
|
-
*/
|
|
6926
|
-
static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
|
|
6927
|
-
return request(OpenAPI, {
|
|
6928
|
-
method: 'GET',
|
|
6929
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
6930
|
-
path: {
|
|
6931
|
-
'org': org,
|
|
6932
|
-
'username': username
|
|
5462
|
+
'user_id': userId
|
|
6933
5463
|
},
|
|
6934
5464
|
query: {
|
|
6935
|
-
'
|
|
6936
|
-
'
|
|
6937
|
-
'
|
|
6938
|
-
'
|
|
6939
|
-
'
|
|
6940
|
-
'ordering': ordering,
|
|
6941
|
-
'page': page,
|
|
6942
|
-
'page_size': pageSize,
|
|
6943
|
-
'preprocess_dataset': preprocessDataset,
|
|
6944
|
-
'provider': provider,
|
|
6945
|
-
'search': search,
|
|
6946
|
-
'status': status
|
|
5465
|
+
'department_id': departmentId,
|
|
5466
|
+
'end_date': endDate,
|
|
5467
|
+
'format': format,
|
|
5468
|
+
'include_main_platform': includeMainPlatform,
|
|
5469
|
+
'start_date': startDate
|
|
6947
5470
|
}
|
|
6948
5471
|
});
|
|
6949
5472
|
}
|
|
6950
5473
|
/**
|
|
6951
|
-
*
|
|
5474
|
+
* Get average grade value for platform, course, or user.
|
|
5475
|
+
*
|
|
5476
|
+
* This endpoint returns the average grade at different levels:
|
|
5477
|
+
* - Platform level: Average grade across all courses
|
|
5478
|
+
* - Course level: Average grade for a specific course
|
|
5479
|
+
* - Learner level: Average grade for a specific learner
|
|
5480
|
+
* - Course-learner level: Grade for a specific learner in a specific course
|
|
5481
|
+
*
|
|
5482
|
+
* Query Parameters:
|
|
5483
|
+
* course_id (str, optional): Filter by course ID
|
|
5484
|
+
* learner_id (str, optional): Filter by username or email
|
|
5485
|
+
*
|
|
5486
|
+
* Returns:
|
|
5487
|
+
* The average grade value based on the specified filters.
|
|
5488
|
+
*
|
|
5489
|
+
* Access Control:
|
|
5490
|
+
* - Platform admins can access any grade data
|
|
5491
|
+
* - Learners can access their own grade data
|
|
6952
5492
|
* @param org
|
|
6953
|
-
* @param
|
|
6954
|
-
* @param
|
|
6955
|
-
* @
|
|
5493
|
+
* @param userId
|
|
5494
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5495
|
+
* @param format Format
|
|
5496
|
+
*
|
|
5497
|
+
* * `json` - json
|
|
5498
|
+
* @param includeMainPlatform Include main platform data
|
|
5499
|
+
* @returns Average
|
|
6956
5500
|
* @throws ApiError
|
|
6957
5501
|
*/
|
|
6958
|
-
static
|
|
5502
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org, userId, departmentId, format = 'json', includeMainPlatform = true) {
|
|
6959
5503
|
return request(OpenAPI, {
|
|
6960
|
-
method: '
|
|
6961
|
-
url: '/api/ai-
|
|
5504
|
+
method: 'GET',
|
|
5505
|
+
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
|
|
6962
5506
|
path: {
|
|
6963
5507
|
'org': org,
|
|
6964
|
-
'
|
|
5508
|
+
'user_id': userId
|
|
6965
5509
|
},
|
|
6966
|
-
|
|
6967
|
-
|
|
5510
|
+
query: {
|
|
5511
|
+
'department_id': departmentId,
|
|
5512
|
+
'format': format,
|
|
5513
|
+
'include_main_platform': includeMainPlatform
|
|
5514
|
+
}
|
|
6968
5515
|
});
|
|
6969
5516
|
}
|
|
6970
5517
|
/**
|
|
6971
|
-
*
|
|
6972
|
-
*
|
|
5518
|
+
* Evaluates performance index for platform, per course, per user and per user-per course
|
|
5519
|
+
*
|
|
5520
|
+
* Query Params
|
|
5521
|
+
* course_id <optional>
|
|
5522
|
+
* learner_id <optional>
|
|
6973
5523
|
* @param org
|
|
6974
|
-
* @param
|
|
6975
|
-
* @
|
|
5524
|
+
* @param userId
|
|
5525
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5526
|
+
* @param endDate end date. ISO 8601
|
|
5527
|
+
* @param format Format
|
|
5528
|
+
*
|
|
5529
|
+
* * `json` - json
|
|
5530
|
+
* @param includeMainPlatform Include main platform data
|
|
5531
|
+
* @param startDate start date. ISO 8601
|
|
5532
|
+
* @returns Value
|
|
6976
5533
|
* @throws ApiError
|
|
6977
5534
|
*/
|
|
6978
|
-
static
|
|
5535
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
6979
5536
|
return request(OpenAPI, {
|
|
6980
5537
|
method: 'GET',
|
|
6981
|
-
url: '/api/ai-
|
|
5538
|
+
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
|
|
6982
5539
|
path: {
|
|
6983
|
-
'id': id,
|
|
6984
5540
|
'org': org,
|
|
6985
|
-
'
|
|
5541
|
+
'user_id': userId
|
|
5542
|
+
},
|
|
5543
|
+
query: {
|
|
5544
|
+
'department_id': departmentId,
|
|
5545
|
+
'end_date': endDate,
|
|
5546
|
+
'format': format,
|
|
5547
|
+
'include_main_platform': includeMainPlatform,
|
|
5548
|
+
'start_date': startDate
|
|
6986
5549
|
}
|
|
6987
5550
|
});
|
|
6988
5551
|
}
|
|
6989
5552
|
/**
|
|
6990
|
-
*
|
|
6991
|
-
*
|
|
5553
|
+
* Time spent in secs on a per-day basis
|
|
5554
|
+
*
|
|
5555
|
+
* Query Params
|
|
5556
|
+
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
5557
|
+
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
5558
|
+
* 3. start_date e.g 2020-10-01
|
|
5559
|
+
* 4. end_date e.g 2020-10-10
|
|
5560
|
+
*
|
|
5561
|
+
* Default result when no query param is added is last_7_days (today inclusive)
|
|
6992
5562
|
* @param org
|
|
6993
|
-
* @param
|
|
6994
|
-
* @param
|
|
6995
|
-
* @
|
|
5563
|
+
* @param userId
|
|
5564
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5565
|
+
* @param endDate end date. ISO 8601
|
|
5566
|
+
* @param format Format
|
|
5567
|
+
*
|
|
5568
|
+
* * `json` - json
|
|
5569
|
+
* @param includeMainPlatform Include main platform data
|
|
5570
|
+
* @param startDate start date. ISO 8601
|
|
5571
|
+
* @returns OverTimeWithTotal
|
|
6996
5572
|
* @throws ApiError
|
|
6997
5573
|
*/
|
|
6998
|
-
static
|
|
5574
|
+
static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
6999
5575
|
return request(OpenAPI, {
|
|
7000
|
-
method: '
|
|
7001
|
-
url: '/api/ai-
|
|
5576
|
+
method: 'GET',
|
|
5577
|
+
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
|
|
7002
5578
|
path: {
|
|
7003
|
-
'id': id,
|
|
7004
5579
|
'org': org,
|
|
7005
|
-
'
|
|
5580
|
+
'user_id': userId
|
|
7006
5581
|
},
|
|
7007
|
-
|
|
7008
|
-
|
|
5582
|
+
query: {
|
|
5583
|
+
'department_id': departmentId,
|
|
5584
|
+
'end_date': endDate,
|
|
5585
|
+
'format': format,
|
|
5586
|
+
'include_main_platform': includeMainPlatform,
|
|
5587
|
+
'start_date': startDate
|
|
5588
|
+
}
|
|
7009
5589
|
});
|
|
7010
5590
|
}
|
|
7011
5591
|
/**
|
|
7012
|
-
*
|
|
7013
|
-
*
|
|
5592
|
+
* Get video watch counts over time.
|
|
5593
|
+
*
|
|
5594
|
+
* This endpoint provides daily counts of videos watched over a specified time period,
|
|
5595
|
+
* with options to filter by course or user.
|
|
5596
|
+
*
|
|
5597
|
+
* Query Parameters:
|
|
5598
|
+
* start_date (str, optional): Start date for the time range (ISO format)
|
|
5599
|
+
* end_date (str, optional): End date for the time range (ISO format)
|
|
5600
|
+
* course_id (str, optional): Filter by course ID
|
|
5601
|
+
* user_id (str, optional): Filter by username or email
|
|
5602
|
+
*
|
|
5603
|
+
* Returns:
|
|
5604
|
+
* Daily video watch counts over the specified time period.
|
|
5605
|
+
*
|
|
5606
|
+
* Default time range is the last 7 days if no dates are specified.
|
|
5607
|
+
*
|
|
5608
|
+
* Access Control:
|
|
5609
|
+
* - Platform admins can access any video watch data
|
|
5610
|
+
* - Learners can access their own video watch data
|
|
7014
5611
|
* @param org
|
|
7015
|
-
* @param
|
|
7016
|
-
* @param
|
|
7017
|
-
* @
|
|
5612
|
+
* @param userId
|
|
5613
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5614
|
+
* @param endDate end date. ISO 8601
|
|
5615
|
+
* @param format Format
|
|
5616
|
+
*
|
|
5617
|
+
* * `json` - json
|
|
5618
|
+
* @param includeMainPlatform Include main platform data
|
|
5619
|
+
* @param startDate start date. ISO 8601
|
|
5620
|
+
* @returns OverTimeWithTotal
|
|
7018
5621
|
* @throws ApiError
|
|
7019
5622
|
*/
|
|
7020
|
-
static
|
|
5623
|
+
static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
7021
5624
|
return request(OpenAPI, {
|
|
7022
|
-
method: '
|
|
7023
|
-
url: '/api/ai-
|
|
5625
|
+
method: 'GET',
|
|
5626
|
+
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
|
|
7024
5627
|
path: {
|
|
7025
|
-
'id': id,
|
|
7026
5628
|
'org': org,
|
|
7027
|
-
'
|
|
5629
|
+
'user_id': userId
|
|
7028
5630
|
},
|
|
7029
|
-
|
|
7030
|
-
|
|
5631
|
+
query: {
|
|
5632
|
+
'department_id': departmentId,
|
|
5633
|
+
'end_date': endDate,
|
|
5634
|
+
'format': format,
|
|
5635
|
+
'include_main_platform': includeMainPlatform,
|
|
5636
|
+
'start_date': startDate
|
|
5637
|
+
}
|
|
7031
5638
|
});
|
|
7032
5639
|
}
|
|
7033
5640
|
/**
|
|
7034
|
-
*
|
|
7035
|
-
*
|
|
5641
|
+
* Summary Videos watched data for a learner per enrollment
|
|
5642
|
+
*
|
|
5643
|
+
* Query Params
|
|
5644
|
+
* 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
|
|
7036
5645
|
* @param org
|
|
7037
|
-
* @param
|
|
7038
|
-
* @
|
|
5646
|
+
* @param userId
|
|
5647
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5648
|
+
* @param endDate end date. ISO 8601
|
|
5649
|
+
* @param format Format
|
|
5650
|
+
*
|
|
5651
|
+
* * `json` - json
|
|
5652
|
+
* @param includeMainPlatform Include main platform data
|
|
5653
|
+
* @param startDate start date. ISO 8601
|
|
5654
|
+
* @returns PerlearnerEngagementVideosWatchedPerCourse
|
|
7039
5655
|
* @throws ApiError
|
|
7040
5656
|
*/
|
|
7041
|
-
static
|
|
5657
|
+
static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
|
|
7042
5658
|
return request(OpenAPI, {
|
|
7043
|
-
method: '
|
|
7044
|
-
url: '/api/ai-
|
|
5659
|
+
method: 'GET',
|
|
5660
|
+
url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/per-course',
|
|
7045
5661
|
path: {
|
|
7046
|
-
'id': id,
|
|
7047
5662
|
'org': org,
|
|
7048
|
-
'
|
|
5663
|
+
'user_id': userId
|
|
5664
|
+
},
|
|
5665
|
+
query: {
|
|
5666
|
+
'department_id': departmentId,
|
|
5667
|
+
'end_date': endDate,
|
|
5668
|
+
'format': format,
|
|
5669
|
+
'include_main_platform': includeMainPlatform,
|
|
5670
|
+
'start_date': startDate
|
|
7049
5671
|
}
|
|
7050
5672
|
});
|
|
7051
5673
|
}
|
|
7052
5674
|
/**
|
|
7053
|
-
*
|
|
7054
|
-
*
|
|
5675
|
+
* Get a list of user groups with metrics and filtering options.
|
|
5676
|
+
*
|
|
5677
|
+
* This endpoint provides a paginated list of user groups with aggregated metrics
|
|
5678
|
+
* about learner performance, course completions, and skill acquisition.
|
|
5679
|
+
*
|
|
5680
|
+
* This endpoint uses DM token authentication and respects department-based
|
|
5681
|
+
* access controls.
|
|
5682
|
+
*
|
|
5683
|
+
* Query Parameters:
|
|
5684
|
+
* page (int, optional): Page number for pagination
|
|
5685
|
+
* length (int, optional): Number of items per page
|
|
5686
|
+
* program (str, optional): Filter by program
|
|
5687
|
+
* pathway (str, optional): Filter by pathway
|
|
5688
|
+
* groups (list, optional): Filter by group names
|
|
5689
|
+
* location (str, optional): Filter by location
|
|
5690
|
+
* is_enrolled (bool, optional): Filter for groups with enrolled users
|
|
5691
|
+
* start_date (date, optional): Filter by learner join date (start range)
|
|
5692
|
+
* end_date (date, optional): Filter by learner join date (end range)
|
|
7055
5693
|
*
|
|
7056
|
-
* NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
|
|
7057
|
-
* training list endpoint.
|
|
7058
5694
|
* Returns:
|
|
7059
|
-
*
|
|
5695
|
+
* A paginated list of user groups with comprehensive metrics.
|
|
5696
|
+
*
|
|
5697
|
+
* Access Control:
|
|
5698
|
+
* - Platform admins can see all groups
|
|
5699
|
+
* - Department admins can only see groups in their departments
|
|
7060
5700
|
* @param org
|
|
7061
|
-
* @param
|
|
7062
|
-
* @
|
|
5701
|
+
* @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
|
|
5702
|
+
* @param endDate Filter by learners date_joined. Start date. ISO 8601
|
|
5703
|
+
* @param format Format
|
|
5704
|
+
*
|
|
5705
|
+
* * `json` - json
|
|
5706
|
+
* @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
|
|
5707
|
+
* @param includeMainPlatform Include main platform data
|
|
5708
|
+
* @param isEnrolled Filter for users who have at least an enrollment
|
|
5709
|
+
* @param length Size of data to return
|
|
5710
|
+
* @param location Location search string
|
|
5711
|
+
* @param page Page offset
|
|
5712
|
+
* @param pathway Pathway string
|
|
5713
|
+
* @param program Program search string
|
|
5714
|
+
* @param startDate Filter by learners date_joined. Start date. ISO 8601
|
|
5715
|
+
* @returns GroupList
|
|
7063
5716
|
* @throws ApiError
|
|
7064
5717
|
*/
|
|
7065
|
-
static
|
|
5718
|
+
static aiAnalyticsUserGroupsOrgsRetrieve(org, departmentId, endDate, format = 'json', groups, includeMainPlatform = true, isEnrolled, length, location, page, pathway, program, startDate) {
|
|
7066
5719
|
return request(OpenAPI, {
|
|
7067
5720
|
method: 'GET',
|
|
7068
|
-
url: '/api/ai-
|
|
5721
|
+
url: '/api/ai-analytics/user-groups/orgs/{org}/',
|
|
7069
5722
|
path: {
|
|
7070
|
-
'org': org
|
|
7071
|
-
|
|
5723
|
+
'org': org
|
|
5724
|
+
},
|
|
5725
|
+
query: {
|
|
5726
|
+
'department_id': departmentId,
|
|
5727
|
+
'end_date': endDate,
|
|
5728
|
+
'format': format,
|
|
5729
|
+
'groups': groups,
|
|
5730
|
+
'include_main_platform': includeMainPlatform,
|
|
5731
|
+
'is_enrolled': isEnrolled,
|
|
5732
|
+
'length': length,
|
|
5733
|
+
'location': location,
|
|
5734
|
+
'page': page,
|
|
5735
|
+
'pathway': pathway,
|
|
5736
|
+
'program': program,
|
|
5737
|
+
'start_date': startDate
|
|
7072
5738
|
}
|
|
7073
5739
|
});
|
|
7074
5740
|
}
|
|
@@ -32154,6 +30820,7 @@ class SearchService {
|
|
|
32154
30820
|
* @param audience Filter by target audience
|
|
32155
30821
|
* @param category Filter by mentor category
|
|
32156
30822
|
* @param createdBy Filter mentors created by specific user
|
|
30823
|
+
* @param featured Filter by featured status
|
|
32157
30824
|
* @param id Retrieve a specific mentor by ID
|
|
32158
30825
|
* @param limit Number of results per page
|
|
32159
30826
|
* @param llm Filter by language model type
|
|
@@ -32167,7 +30834,7 @@ class SearchService {
|
|
|
32167
30834
|
* @returns MentorSearchResponse
|
|
32168
30835
|
* @throws ApiError
|
|
32169
30836
|
*/
|
|
32170
|
-
static searchMentorsRetrieve(audience, category, createdBy, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
|
|
30837
|
+
static searchMentorsRetrieve(audience, category, createdBy, featured, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
|
|
32171
30838
|
return request(OpenAPI, {
|
|
32172
30839
|
method: 'GET',
|
|
32173
30840
|
url: '/api/search/mentors/',
|
|
@@ -32175,6 +30842,7 @@ class SearchService {
|
|
|
32175
30842
|
'audience': audience,
|
|
32176
30843
|
'category': category,
|
|
32177
30844
|
'created_by': createdBy,
|
|
30845
|
+
'featured': featured,
|
|
32178
30846
|
'id': id,
|
|
32179
30847
|
'limit': limit,
|
|
32180
30848
|
'llm': llm,
|
|
@@ -32247,6 +30915,7 @@ class SearchService {
|
|
|
32247
30915
|
* @param audience Filter by target audience
|
|
32248
30916
|
* @param category Filter by mentor category
|
|
32249
30917
|
* @param createdBy Filter mentors created by specific user
|
|
30918
|
+
* @param featured Filter by featured status
|
|
32250
30919
|
* @param id Retrieve a specific mentor by ID
|
|
32251
30920
|
* @param limit Number of results per page
|
|
32252
30921
|
* @param llm Filter by language model type
|
|
@@ -32260,7 +30929,7 @@ class SearchService {
|
|
|
32260
30929
|
* @returns MentorSearchResponse
|
|
32261
30930
|
* @throws ApiError
|
|
32262
30931
|
*/
|
|
32263
|
-
static searchOrgsUsersMentorsRetrieve(org, username, audience, category, createdBy, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
|
|
30932
|
+
static searchOrgsUsersMentorsRetrieve(org, username, audience, category, createdBy, featured, id, limit = 12, llm, offset, orderBy, orderDirection = 'desc', query, tags, tenant, uniqueId) {
|
|
32264
30933
|
return request(OpenAPI, {
|
|
32265
30934
|
method: 'GET',
|
|
32266
30935
|
url: '/api/search/orgs/{org}/users/{username}/mentors/',
|
|
@@ -32272,6 +30941,7 @@ class SearchService {
|
|
|
32272
30941
|
'audience': audience,
|
|
32273
30942
|
'category': category,
|
|
32274
30943
|
'created_by': createdBy,
|
|
30944
|
+
'featured': featured,
|
|
32275
30945
|
'id': id,
|
|
32276
30946
|
'limit': limit,
|
|
32277
30947
|
'llm': llm,
|
|
@@ -32334,7 +31004,7 @@ class SearchService {
|
|
|
32334
31004
|
* @param style Filter by prompt style
|
|
32335
31005
|
* @param tenant Filter by tenant/organization
|
|
32336
31006
|
* @param tone Filter by prompt tone
|
|
32337
|
-
* @returns
|
|
31007
|
+
* @returns PromptSearchResponse
|
|
32338
31008
|
* @throws ApiError
|
|
32339
31009
|
*/
|
|
32340
31010
|
static searchOrgsUsersPromptsRetrieve(org, username, alphabetical = false, category, filterFacet, language, limit = 10, mentor, offset, orderDirection = 'desc', query, sortBy, style, tenant, tone) {
|
|
@@ -32394,7 +31064,7 @@ class SearchService {
|
|
|
32394
31064
|
* @param subject Filter by subject areas
|
|
32395
31065
|
* @param tags Filter by tags
|
|
32396
31066
|
* @param topics Filter by topic areas
|
|
32397
|
-
* @returns
|
|
31067
|
+
* @returns RecommendedCoursesResponse
|
|
32398
31068
|
* @throws ApiError
|
|
32399
31069
|
*/
|
|
32400
31070
|
static searchOrgsUsersRecommendedRetrieve(org, username, certificate, content, courseId, duration, language, level, limit = 12, offset, pathwayId, price, programId, programType, query, resourceId, resourceType, roleId, selfPaced, skillId, skills, subject, tags, topics) {
|
|
@@ -32642,7 +31312,7 @@ class SearchService {
|
|
|
32642
31312
|
* @param style Filter by prompt style
|
|
32643
31313
|
* @param tenant Filter by tenant/organization
|
|
32644
31314
|
* @param tone Filter by prompt tone
|
|
32645
|
-
* @returns
|
|
31315
|
+
* @returns PromptSearchResponse
|
|
32646
31316
|
* @throws ApiError
|
|
32647
31317
|
*/
|
|
32648
31318
|
static searchPromptsRetrieve(alphabetical = false, category, filterFacet, language, limit = 10, mentor, offset, orderDirection = 'desc', query, sortBy, style, tenant, tone) {
|
|
@@ -33632,8 +32302,6 @@ class UserGroupsService {
|
|
|
33632
32302
|
|
|
33633
32303
|
exports.AiAccountService = AiAccountService;
|
|
33634
32304
|
exports.AiAnalyticsService = AiAnalyticsService;
|
|
33635
|
-
exports.AiBotService = AiBotService;
|
|
33636
|
-
exports.AiFinetuningService = AiFinetuningService;
|
|
33637
32305
|
exports.AiIndexService = AiIndexService;
|
|
33638
32306
|
exports.AiMarketingService = AiMarketingService;
|
|
33639
32307
|
exports.AiMediaService = AiMediaService;
|