@iblai/iblai-api 4.3.1-ai-plus → 4.4.0-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 +330 -1719
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +331 -1718
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +330 -1719
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -39
- package/dist/types/models/GuidedPrompt.d.ts +4 -0
- package/dist/types/models/GuidedPromptsResponse.d.ts +2 -0
- package/dist/types/services/AiPromptService.d.ts +2 -1
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -39
- package/src/models/{WhatAppWebHook.ts → GuidedPrompt.ts} +3 -2
- package/src/models/GuidedPromptsResponse.ts +2 -0
- package/src/services/AiPromptService.ts +5 -0
- 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 -642
- package/dist/types/services/AiFinetuningService.d.ts +0 -232
- 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/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1330
- package/src/services/AiFinetuningService.ts +0 -472
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: '4.
|
|
113
|
+
VERSION: '4.4.0-ai',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -271,24 +271,6 @@ exports.CrawlerPatternTypeEnum = void 0;
|
|
|
271
271
|
CrawlerPatternTypeEnum["REGEX"] = "regex";
|
|
272
272
|
})(exports.CrawlerPatternTypeEnum || (exports.CrawlerPatternTypeEnum = {}));
|
|
273
273
|
|
|
274
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
275
|
-
/* istanbul ignore file */
|
|
276
|
-
/* tslint:disable */
|
|
277
|
-
/* eslint-disable */
|
|
278
|
-
/**
|
|
279
|
-
* * `pending` - Pending
|
|
280
|
-
* * `processing` - Processing
|
|
281
|
-
* * `completed` - Completed
|
|
282
|
-
* * `failed` - Failed
|
|
283
|
-
*/
|
|
284
|
-
exports.DataSetStatusEnum = void 0;
|
|
285
|
-
(function (DataSetStatusEnum) {
|
|
286
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
287
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
288
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
289
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
290
|
-
})(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
|
|
291
|
-
|
|
292
274
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
293
275
|
/* istanbul ignore file */
|
|
294
276
|
/* tslint:disable */
|
|
@@ -585,26 +567,6 @@ exports.PromptVisibilityEnum = void 0;
|
|
|
585
567
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
586
568
|
})(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
|
|
587
569
|
|
|
588
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
589
|
-
/* istanbul ignore file */
|
|
590
|
-
/* tslint:disable */
|
|
591
|
-
/* eslint-disable */
|
|
592
|
-
/**
|
|
593
|
-
* * `webex` - Webex
|
|
594
|
-
* * `slack` - Slack
|
|
595
|
-
* * `whatsapp` - Whatsapp
|
|
596
|
-
* * `discord` - Discord
|
|
597
|
-
* * `teams` - Teams
|
|
598
|
-
*/
|
|
599
|
-
exports.Provider05cEnum = void 0;
|
|
600
|
-
(function (Provider05cEnum) {
|
|
601
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
602
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
603
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
604
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
605
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
606
|
-
})(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
|
|
607
|
-
|
|
608
570
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
609
571
|
/* istanbul ignore file */
|
|
610
572
|
/* tslint:disable */
|
|
@@ -621,18 +583,6 @@ exports.Provider637Enum = void 0;
|
|
|
621
583
|
Provider637Enum["ELEVENLABS"] = "elevenlabs";
|
|
622
584
|
})(exports.Provider637Enum || (exports.Provider637Enum = {}));
|
|
623
585
|
|
|
624
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
625
|
-
/* istanbul ignore file */
|
|
626
|
-
/* tslint:disable */
|
|
627
|
-
/* eslint-disable */
|
|
628
|
-
/**
|
|
629
|
-
* * `openai` - Openai
|
|
630
|
-
*/
|
|
631
|
-
exports.Provider63aEnum = void 0;
|
|
632
|
-
(function (Provider63aEnum) {
|
|
633
|
-
Provider63aEnum["OPENAI"] = "openai";
|
|
634
|
-
})(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
|
|
635
|
-
|
|
636
586
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
637
587
|
/* istanbul ignore file */
|
|
638
588
|
/* tslint:disable */
|
|
@@ -8639,1853 +8589,512 @@ class AiAnalyticsService {
|
|
|
8639
8589
|
* @returns any No response body
|
|
8640
8590
|
* @throws ApiError
|
|
8641
8591
|
*/
|
|
8642
|
-
static platformOrgsCoursesProgressInProgressRetrieve({
|
|
8643
|
-
courseId,
|
|
8644
|
-
org
|
|
8645
|
-
}) {
|
|
8646
|
-
return request(OpenAPI, {
|
|
8647
|
-
method: 'GET',
|
|
8648
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/progress/in-progress',
|
|
8649
|
-
path: {
|
|
8650
|
-
'course_id': courseId,
|
|
8651
|
-
'org': org
|
|
8652
|
-
}
|
|
8653
|
-
});
|
|
8654
|
-
}
|
|
8655
|
-
/**
|
|
8656
|
-
* Started means an enrollment
|
|
8657
|
-
*
|
|
8658
|
-
* For platform : Total users who have atleast an enrollment
|
|
8659
|
-
* For course : Total users enrolled
|
|
8660
|
-
* For learner : Total courses in progress
|
|
8661
|
-
*
|
|
8662
|
-
* Query Params
|
|
8663
|
-
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8664
|
-
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
8665
|
-
* @returns any No response body
|
|
8666
|
-
* @throws ApiError
|
|
8667
|
-
*/
|
|
8668
|
-
static platformOrgsCoursesProgressStartedRetrieve({
|
|
8669
|
-
courseId,
|
|
8670
|
-
org
|
|
8671
|
-
}) {
|
|
8672
|
-
return request(OpenAPI, {
|
|
8673
|
-
method: 'GET',
|
|
8674
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/progress/started',
|
|
8675
|
-
path: {
|
|
8676
|
-
'course_id': courseId,
|
|
8677
|
-
'org': org
|
|
8678
|
-
}
|
|
8679
|
-
});
|
|
8680
|
-
}
|
|
8681
|
-
/**
|
|
8682
|
-
* Base class for API views that return a single count value.
|
|
8683
|
-
*
|
|
8684
|
-
* This class formats the response as {"data": {value_key: count}} where
|
|
8685
|
-
* value_key is configurable (defaults to "count").
|
|
8686
|
-
*
|
|
8687
|
-
* Attributes:
|
|
8688
|
-
* value_key: The key used in the response for the count value
|
|
8689
|
-
* @returns any No response body
|
|
8690
|
-
* @throws ApiError
|
|
8691
|
-
*/
|
|
8692
|
-
static platformOrgsCoursesUsersGradesPassedRetrieve({
|
|
8693
|
-
courseId,
|
|
8694
|
-
org,
|
|
8695
|
-
userId
|
|
8696
|
-
}) {
|
|
8697
|
-
return request(OpenAPI, {
|
|
8698
|
-
method: 'GET',
|
|
8699
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed',
|
|
8700
|
-
path: {
|
|
8701
|
-
'course_id': courseId,
|
|
8702
|
-
'org': org,
|
|
8703
|
-
'user_id': userId
|
|
8704
|
-
}
|
|
8705
|
-
});
|
|
8706
|
-
}
|
|
8707
|
-
/**
|
|
8708
|
-
* Gives Percentage of units completed in course for a specific learner
|
|
8709
|
-
* @returns PerlearnerCourseProgress
|
|
8710
|
-
* @throws ApiError
|
|
8711
|
-
*/
|
|
8712
|
-
static platformOrgsCoursesUsersProgressRetrieve({
|
|
8713
|
-
courseId,
|
|
8714
|
-
org,
|
|
8715
|
-
userId,
|
|
8716
|
-
departmentId,
|
|
8717
|
-
format = 'json',
|
|
8718
|
-
includeMainPlatform = true
|
|
8719
|
-
}) {
|
|
8720
|
-
return request(OpenAPI, {
|
|
8721
|
-
method: 'GET',
|
|
8722
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
|
|
8723
|
-
path: {
|
|
8724
|
-
'course_id': courseId,
|
|
8725
|
-
'org': org,
|
|
8726
|
-
'user_id': userId
|
|
8727
|
-
},
|
|
8728
|
-
query: {
|
|
8729
|
-
'department_id': departmentId,
|
|
8730
|
-
'format': format,
|
|
8731
|
-
'include_main_platform': includeMainPlatform
|
|
8732
|
-
}
|
|
8733
|
-
});
|
|
8734
|
-
}
|
|
8735
|
-
/**
|
|
8736
|
-
* Average days used to complete a course
|
|
8737
|
-
*
|
|
8738
|
-
* Query Params
|
|
8739
|
-
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8740
|
-
* @returns any No response body
|
|
8741
|
-
* @throws ApiError
|
|
8742
|
-
*/
|
|
8743
|
-
static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({
|
|
8744
|
-
courseId,
|
|
8745
|
-
org,
|
|
8746
|
-
userId
|
|
8747
|
-
}) {
|
|
8748
|
-
return request(OpenAPI, {
|
|
8749
|
-
method: 'GET',
|
|
8750
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
|
|
8751
|
-
path: {
|
|
8752
|
-
'course_id': courseId,
|
|
8753
|
-
'org': org,
|
|
8754
|
-
'user_id': userId
|
|
8755
|
-
}
|
|
8756
|
-
});
|
|
8757
|
-
}
|
|
8758
|
-
/**
|
|
8759
|
-
* Time spent count in seconds within a course by a learner
|
|
8760
|
-
* @returns Count
|
|
8761
|
-
* @throws ApiError
|
|
8762
|
-
*/
|
|
8763
|
-
static platformOrgsCoursesUsersTimeCountRetrieve({
|
|
8764
|
-
courseId,
|
|
8765
|
-
org,
|
|
8766
|
-
userId,
|
|
8767
|
-
departmentId,
|
|
8768
|
-
endDate,
|
|
8769
|
-
format = 'json',
|
|
8770
|
-
includeMainPlatform = true,
|
|
8771
|
-
startDate
|
|
8772
|
-
}) {
|
|
8773
|
-
return request(OpenAPI, {
|
|
8774
|
-
method: 'GET',
|
|
8775
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
|
|
8776
|
-
path: {
|
|
8777
|
-
'course_id': courseId,
|
|
8778
|
-
'org': org,
|
|
8779
|
-
'user_id': userId
|
|
8780
|
-
},
|
|
8781
|
-
query: {
|
|
8782
|
-
'department_id': departmentId,
|
|
8783
|
-
'end_date': endDate,
|
|
8784
|
-
'format': format,
|
|
8785
|
-
'include_main_platform': includeMainPlatform,
|
|
8786
|
-
'start_date': startDate
|
|
8787
|
-
}
|
|
8788
|
-
});
|
|
8789
|
-
}
|
|
8790
|
-
/**
|
|
8791
|
-
* (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
|
|
8792
|
-
* @returns VideosCount
|
|
8793
|
-
* @throws ApiError
|
|
8794
|
-
*/
|
|
8795
|
-
static platformOrgsCoursesUsersVideosCountRetrieve({
|
|
8796
|
-
courseId,
|
|
8797
|
-
org,
|
|
8798
|
-
userId,
|
|
8799
|
-
departmentId,
|
|
8800
|
-
format = 'json',
|
|
8801
|
-
includeMainPlatform = true
|
|
8802
|
-
}) {
|
|
8803
|
-
return request(OpenAPI, {
|
|
8804
|
-
method: 'GET',
|
|
8805
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
|
|
8806
|
-
path: {
|
|
8807
|
-
'course_id': courseId,
|
|
8808
|
-
'org': org,
|
|
8809
|
-
'user_id': userId
|
|
8810
|
-
},
|
|
8811
|
-
query: {
|
|
8812
|
-
'department_id': departmentId,
|
|
8813
|
-
'format': format,
|
|
8814
|
-
'include_main_platform': includeMainPlatform
|
|
8815
|
-
}
|
|
8816
|
-
});
|
|
8817
|
-
}
|
|
8818
|
-
/**
|
|
8819
|
-
* Count of total videos in a course
|
|
8820
|
-
*
|
|
8821
|
-
* Query Params
|
|
8822
|
-
* course_id e.g course-v1:Org+Course4+Run
|
|
8823
|
-
* @returns any No response body
|
|
8824
|
-
* @throws ApiError
|
|
8825
|
-
*/
|
|
8826
|
-
static platformOrgsCoursesVideosRetrieve2({
|
|
8827
|
-
courseId,
|
|
8828
|
-
org
|
|
8829
|
-
}) {
|
|
8830
|
-
return request(OpenAPI, {
|
|
8831
|
-
method: 'GET',
|
|
8832
|
-
url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
|
|
8833
|
-
path: {
|
|
8834
|
-
'course_id': courseId,
|
|
8835
|
-
'org': org
|
|
8836
|
-
}
|
|
8837
|
-
});
|
|
8838
|
-
}
|
|
8839
|
-
/**
|
|
8840
|
-
* Get total count of courses on the platform.
|
|
8841
|
-
*
|
|
8842
|
-
* This endpoint returns the total number of courses available on the platform.
|
|
8843
|
-
*
|
|
8844
|
-
* Returns:
|
|
8845
|
-
* The total count of courses on the platform.
|
|
8846
|
-
* @returns Count
|
|
8847
|
-
* @throws ApiError
|
|
8848
|
-
*/
|
|
8849
|
-
static platformOrgsCoursesCountRetrieve({
|
|
8850
|
-
org,
|
|
8851
|
-
departmentId,
|
|
8852
|
-
format = 'json',
|
|
8853
|
-
includeMainPlatform = true
|
|
8854
|
-
}) {
|
|
8855
|
-
return request(OpenAPI, {
|
|
8856
|
-
method: 'GET',
|
|
8857
|
-
url: '/api/platform/orgs/{org}/courses/count',
|
|
8858
|
-
path: {
|
|
8859
|
-
'org': org
|
|
8860
|
-
},
|
|
8861
|
-
query: {
|
|
8862
|
-
'department_id': departmentId,
|
|
8863
|
-
'format': format,
|
|
8864
|
-
'include_main_platform': includeMainPlatform
|
|
8865
|
-
}
|
|
8866
|
-
});
|
|
8867
|
-
}
|
|
8868
|
-
/**
|
|
8869
|
-
* List grading information on a per-course basis.
|
|
8870
|
-
*
|
|
8871
|
-
* This endpoint provides grading statistics for all courses, including
|
|
8872
|
-
* average grades and completion rates.
|
|
8873
|
-
*
|
|
8874
|
-
* Returns:
|
|
8875
|
-
* A list of courses with their associated grading metrics.
|
|
8876
|
-
* @returns any No response body
|
|
8877
|
-
* @throws ApiError
|
|
8878
|
-
*/
|
|
8879
|
-
static platformOrgsCoursesGradesRetrieve({
|
|
8880
|
-
org
|
|
8881
|
-
}) {
|
|
8882
|
-
return request(OpenAPI, {
|
|
8883
|
-
method: 'GET',
|
|
8884
|
-
url: '/api/platform/orgs/{org}/courses/grades',
|
|
8885
|
-
path: {
|
|
8886
|
-
'org': org
|
|
8887
|
-
}
|
|
8888
|
-
});
|
|
8889
|
-
}
|
|
8890
|
-
/**
|
|
8891
|
-
* Get video watch statistics on a per-course basis.
|
|
8892
|
-
*
|
|
8893
|
-
* This endpoint provides a list of courses with aggregated video watch metrics,
|
|
8894
|
-
* including total views and completion percentages.
|
|
8895
|
-
*
|
|
8896
|
-
* Returns:
|
|
8897
|
-
* A list of courses with:
|
|
8898
|
-
* - Course identification (ID and name)
|
|
8899
|
-
* - Video watch count
|
|
8900
|
-
* - Percentage of total videos watched
|
|
8901
|
-
* @returns WatchedVideosPerCourse
|
|
8902
|
-
* @throws ApiError
|
|
8903
|
-
*/
|
|
8904
|
-
static platformOrgsCoursesVideosRetrieve({
|
|
8905
|
-
org,
|
|
8906
|
-
departmentId,
|
|
8907
|
-
format = 'json',
|
|
8908
|
-
includeMainPlatform = true
|
|
8909
|
-
}) {
|
|
8910
|
-
return request(OpenAPI, {
|
|
8911
|
-
method: 'GET',
|
|
8912
|
-
url: '/api/platform/orgs/{org}/courses/videos',
|
|
8913
|
-
path: {
|
|
8914
|
-
'org': org
|
|
8915
|
-
},
|
|
8916
|
-
query: {
|
|
8917
|
-
'department_id': departmentId,
|
|
8918
|
-
'format': format,
|
|
8919
|
-
'include_main_platform': includeMainPlatform
|
|
8920
|
-
}
|
|
8921
|
-
});
|
|
8922
|
-
}
|
|
8923
|
-
/**
|
|
8924
|
-
* Get completion count statistics.
|
|
8925
|
-
*
|
|
8926
|
-
* This endpoint returns completion counts at different levels:
|
|
8927
|
-
* - Platform level: Total users who have completed at least one course
|
|
8928
|
-
* - Course level: Total completions for a specific course
|
|
8929
|
-
* - Learner level: Total courses completed by a specific learner
|
|
8930
|
-
*
|
|
8931
|
-
* Query Parameters:
|
|
8932
|
-
* course_id (str, optional): Filter by course ID
|
|
8933
|
-
* user_id (str, optional): Filter by username or email
|
|
8934
|
-
*
|
|
8935
|
-
* Returns:
|
|
8936
|
-
* A count of completions based on the specified filters.
|
|
8937
|
-
* @returns any No response body
|
|
8938
|
-
* @throws ApiError
|
|
8939
|
-
*/
|
|
8940
|
-
static platformOrgsProgressCompletedRetrieve({
|
|
8941
|
-
org
|
|
8942
|
-
}) {
|
|
8943
|
-
return request(OpenAPI, {
|
|
8944
|
-
method: 'GET',
|
|
8945
|
-
url: '/api/platform/orgs/{org}/progress/completed',
|
|
8946
|
-
path: {
|
|
8947
|
-
'org': org
|
|
8948
|
-
}
|
|
8949
|
-
});
|
|
8950
|
-
}
|
|
8951
|
-
/**
|
|
8952
|
-
* Average of total completed units
|
|
8953
|
-
* @returns any No response body
|
|
8954
|
-
* @throws ApiError
|
|
8955
|
-
*/
|
|
8956
|
-
static platformOrgsProgressCompletionRateRetrieve({
|
|
8957
|
-
org
|
|
8958
|
-
}) {
|
|
8959
|
-
return request(OpenAPI, {
|
|
8960
|
-
method: 'GET',
|
|
8961
|
-
url: '/api/platform/orgs/{org}/progress/completion-rate',
|
|
8962
|
-
path: {
|
|
8963
|
-
'org': org
|
|
8964
|
-
}
|
|
8965
|
-
});
|
|
8966
|
-
}
|
|
8967
|
-
/**
|
|
8968
|
-
* In Progress means any unit completion in the past 30 days
|
|
8969
|
-
*
|
|
8970
|
-
* For platform : Total users who have atleast a course in_progress on the platform
|
|
8971
|
-
* For course : Total users
|
|
8972
|
-
* For learner : Total courses in progress
|
|
8973
|
-
*
|
|
8974
|
-
* Query Params
|
|
8975
|
-
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8976
|
-
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
8977
|
-
* @returns any No response body
|
|
8978
|
-
* @throws ApiError
|
|
8979
|
-
*/
|
|
8980
|
-
static platformOrgsProgressInProgressRetrieve({
|
|
8981
|
-
org
|
|
8982
|
-
}) {
|
|
8983
|
-
return request(OpenAPI, {
|
|
8984
|
-
method: 'GET',
|
|
8985
|
-
url: '/api/platform/orgs/{org}/progress/in-progress',
|
|
8986
|
-
path: {
|
|
8987
|
-
'org': org
|
|
8988
|
-
}
|
|
8989
|
-
});
|
|
8990
|
-
}
|
|
8991
|
-
/**
|
|
8992
|
-
* Started means an enrollment
|
|
8993
|
-
*
|
|
8994
|
-
* For platform : Total users who have atleast an enrollment
|
|
8995
|
-
* For course : Total users enrolled
|
|
8996
|
-
* For learner : Total courses in progress
|
|
8997
|
-
*
|
|
8998
|
-
* Query Params
|
|
8999
|
-
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
9000
|
-
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
9001
|
-
* @returns any No response body
|
|
9002
|
-
* @throws ApiError
|
|
9003
|
-
*/
|
|
9004
|
-
static platformOrgsProgressStartedRetrieve({
|
|
9005
|
-
org
|
|
9006
|
-
}) {
|
|
9007
|
-
return request(OpenAPI, {
|
|
9008
|
-
method: 'GET',
|
|
9009
|
-
url: '/api/platform/orgs/{org}/progress/started',
|
|
9010
|
-
path: {
|
|
9011
|
-
'org': org
|
|
9012
|
-
}
|
|
9013
|
-
});
|
|
9014
|
-
}
|
|
9015
|
-
/**
|
|
9016
|
-
* Total time spent count on the platform within specified range or all time
|
|
9017
|
-
*
|
|
9018
|
-
* Query Params
|
|
9019
|
-
* 1. start_date e.g 2020-10-01
|
|
9020
|
-
* 2. end_date e.g 2020-10-10
|
|
9021
|
-
*
|
|
9022
|
-
* Default result is all time
|
|
9023
|
-
* @returns any No response body
|
|
9024
|
-
* @throws ApiError
|
|
9025
|
-
*/
|
|
9026
|
-
static platformOrgsTimeCountRetrieve({
|
|
9027
|
-
org
|
|
9028
|
-
}) {
|
|
9029
|
-
return request(OpenAPI, {
|
|
9030
|
-
method: 'GET',
|
|
9031
|
-
url: '/api/platform/orgs/{org}/time/count',
|
|
9032
|
-
path: {
|
|
9033
|
-
'org': org
|
|
9034
|
-
}
|
|
9035
|
-
});
|
|
9036
|
-
}
|
|
9037
|
-
/**
|
|
9038
|
-
* Get count of active users on the platform.
|
|
9039
|
-
*
|
|
9040
|
-
* This endpoint returns the number of users who have had activity on the platform,
|
|
9041
|
-
* either for all time or within a specified date range.
|
|
9042
|
-
*
|
|
9043
|
-
* Query Parameters:
|
|
9044
|
-
* start_date (str, optional): Start date for filtering (ISO format)
|
|
9045
|
-
* end_date (str, optional): End date for filtering (ISO format)
|
|
9046
|
-
*
|
|
9047
|
-
* Returns:
|
|
9048
|
-
* The count of active users and change metrics compared to previous periods.
|
|
9049
|
-
*
|
|
9050
|
-
* Default behavior returns the count for all time if no date range is specified.
|
|
9051
|
-
* @returns OverTimeWithTotal
|
|
9052
|
-
* @throws ApiError
|
|
9053
|
-
*/
|
|
9054
|
-
static platformOrgsUsersActiveCountRetrieve({
|
|
9055
|
-
org,
|
|
9056
|
-
departmentId,
|
|
9057
|
-
endDate,
|
|
9058
|
-
format = 'json',
|
|
9059
|
-
includeMainPlatform = true,
|
|
9060
|
-
startDate
|
|
9061
|
-
}) {
|
|
9062
|
-
return request(OpenAPI, {
|
|
9063
|
-
method: 'GET',
|
|
9064
|
-
url: '/api/platform/orgs/{org}/users/active/count',
|
|
9065
|
-
path: {
|
|
9066
|
-
'org': org
|
|
9067
|
-
},
|
|
9068
|
-
query: {
|
|
9069
|
-
'department_id': departmentId,
|
|
9070
|
-
'end_date': endDate,
|
|
9071
|
-
'format': format,
|
|
9072
|
-
'include_main_platform': includeMainPlatform,
|
|
9073
|
-
'start_date': startDate
|
|
9074
|
-
}
|
|
9075
|
-
});
|
|
9076
|
-
}
|
|
9077
|
-
/**
|
|
9078
|
-
* Get count of registered users on the platform.
|
|
9079
|
-
*
|
|
9080
|
-
* This endpoint returns the number of users registered on the platform,
|
|
9081
|
-
* either for all time or within a specified date range.
|
|
9082
|
-
*
|
|
9083
|
-
* Query Parameters:
|
|
9084
|
-
* start_date (str, optional): Start date for filtering (ISO format)
|
|
9085
|
-
* end_date (str, optional): End date for filtering (ISO format)
|
|
9086
|
-
*
|
|
9087
|
-
* Returns:
|
|
9088
|
-
* The count of registered users and change metrics compared to previous periods.
|
|
9089
|
-
*
|
|
9090
|
-
* Default behavior returns the count for all time if no date range is specified.
|
|
9091
|
-
* @returns OverTimeWithTotal
|
|
9092
|
-
* @throws ApiError
|
|
9093
|
-
*/
|
|
9094
|
-
static platformOrgsUsersCountRetrieve({
|
|
9095
|
-
org,
|
|
9096
|
-
departmentId,
|
|
9097
|
-
endDate,
|
|
9098
|
-
format = 'json',
|
|
9099
|
-
includeMainPlatform = true,
|
|
9100
|
-
startDate
|
|
9101
|
-
}) {
|
|
9102
|
-
return request(OpenAPI, {
|
|
9103
|
-
method: 'GET',
|
|
9104
|
-
url: '/api/platform/orgs/{org}/users/count',
|
|
9105
|
-
path: {
|
|
9106
|
-
'org': org
|
|
9107
|
-
},
|
|
9108
|
-
query: {
|
|
9109
|
-
'department_id': departmentId,
|
|
9110
|
-
'end_date': endDate,
|
|
9111
|
-
'format': format,
|
|
9112
|
-
'include_main_platform': includeMainPlatform,
|
|
9113
|
-
'start_date': startDate
|
|
9114
|
-
}
|
|
9115
|
-
});
|
|
9116
|
-
}
|
|
9117
|
-
/**
|
|
9118
|
-
* Count of users who have completed a course on the platform within specified range or all time
|
|
9119
|
-
*
|
|
9120
|
-
* Query Params
|
|
9121
|
-
* 1. start_date e.g 2020-10-01
|
|
9122
|
-
* 2. end_date e.g 2020-10-10
|
|
9123
|
-
*
|
|
9124
|
-
* Default is all time
|
|
9125
|
-
* @returns OverTimeWithTotal
|
|
9126
|
-
* @throws ApiError
|
|
9127
|
-
*/
|
|
9128
|
-
static platformOrgsUsersCoursesCompletedCountRetrieve({
|
|
9129
|
-
org,
|
|
9130
|
-
departmentId,
|
|
9131
|
-
endDate,
|
|
9132
|
-
format = 'json',
|
|
9133
|
-
includeMainPlatform = true,
|
|
9134
|
-
startDate
|
|
9135
|
-
}) {
|
|
9136
|
-
return request(OpenAPI, {
|
|
9137
|
-
method: 'GET',
|
|
9138
|
-
url: '/api/platform/orgs/{org}/users/courses-completed/count',
|
|
9139
|
-
path: {
|
|
9140
|
-
'org': org
|
|
9141
|
-
},
|
|
9142
|
-
query: {
|
|
9143
|
-
'department_id': departmentId,
|
|
9144
|
-
'end_date': endDate,
|
|
9145
|
-
'format': format,
|
|
9146
|
-
'include_main_platform': includeMainPlatform,
|
|
9147
|
-
'start_date': startDate
|
|
9148
|
-
}
|
|
9149
|
-
});
|
|
9150
|
-
}
|
|
9151
|
-
}
|
|
9152
|
-
|
|
9153
|
-
class AiBotService {
|
|
9154
|
-
/**
|
|
9155
|
-
* Create modify and update bot information for a specific tenant.
|
|
9156
|
-
* @returns Bot
|
|
9157
|
-
* @throws ApiError
|
|
9158
|
-
*/
|
|
9159
|
-
static aiBotV1BotsBotList({
|
|
9160
|
-
org
|
|
9161
|
-
}) {
|
|
9162
|
-
return request(OpenAPI, {
|
|
9163
|
-
method: 'GET',
|
|
9164
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
9165
|
-
path: {
|
|
9166
|
-
'org': org
|
|
9167
|
-
}
|
|
9168
|
-
});
|
|
9169
|
-
}
|
|
9170
|
-
/**
|
|
9171
|
-
* Create modify and update bot information for a specific tenant.
|
|
9172
|
-
* @returns BotCreate
|
|
9173
|
-
* @throws ApiError
|
|
9174
|
-
*/
|
|
9175
|
-
static aiBotV1BotsBotCreate({
|
|
9176
|
-
org,
|
|
9177
|
-
requestBody
|
|
9178
|
-
}) {
|
|
9179
|
-
return request(OpenAPI, {
|
|
9180
|
-
method: 'POST',
|
|
9181
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
9182
|
-
path: {
|
|
9183
|
-
'org': org
|
|
9184
|
-
},
|
|
9185
|
-
body: requestBody,
|
|
9186
|
-
mediaType: 'application/json'
|
|
9187
|
-
});
|
|
9188
|
-
}
|
|
9189
|
-
/**
|
|
9190
|
-
* Create slash commands for a specific bot
|
|
9191
|
-
* eg. /iblai-baseline
|
|
9192
|
-
* @returns BotCommand
|
|
9193
|
-
* @throws ApiError
|
|
9194
|
-
*/
|
|
9195
|
-
static aiBotV1BotsBotCommandsList({
|
|
9196
|
-
org
|
|
9197
|
-
}) {
|
|
9198
|
-
return request(OpenAPI, {
|
|
9199
|
-
method: 'GET',
|
|
9200
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
9201
|
-
path: {
|
|
9202
|
-
'org': org
|
|
9203
|
-
}
|
|
9204
|
-
});
|
|
9205
|
-
}
|
|
9206
|
-
/**
|
|
9207
|
-
* Create slash commands for a specific bot
|
|
9208
|
-
* eg. /iblai-baseline
|
|
9209
|
-
* @returns BotCommand
|
|
9210
|
-
* @throws ApiError
|
|
9211
|
-
*/
|
|
9212
|
-
static aiBotV1BotsBotCommandsCreate({
|
|
9213
|
-
org,
|
|
9214
|
-
requestBody
|
|
9215
|
-
}) {
|
|
9216
|
-
return request(OpenAPI, {
|
|
9217
|
-
method: 'POST',
|
|
9218
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
9219
|
-
path: {
|
|
9220
|
-
'org': org
|
|
9221
|
-
},
|
|
9222
|
-
body: requestBody,
|
|
9223
|
-
mediaType: 'application/json'
|
|
9224
|
-
});
|
|
9225
|
-
}
|
|
9226
|
-
/**
|
|
9227
|
-
* Create slash commands for a specific bot
|
|
9228
|
-
* eg. /iblai-baseline
|
|
9229
|
-
* @returns BotCommand
|
|
9230
|
-
* @throws ApiError
|
|
9231
|
-
*/
|
|
9232
|
-
static aiBotV1BotsBotCommandsRetrieve({
|
|
9233
|
-
id,
|
|
9234
|
-
org
|
|
9235
|
-
}) {
|
|
9236
|
-
return request(OpenAPI, {
|
|
9237
|
-
method: 'GET',
|
|
9238
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
9239
|
-
path: {
|
|
9240
|
-
'id': id,
|
|
9241
|
-
'org': org
|
|
9242
|
-
}
|
|
9243
|
-
});
|
|
9244
|
-
}
|
|
9245
|
-
/**
|
|
9246
|
-
* Create slash commands for a specific bot
|
|
9247
|
-
* eg. /iblai-baseline
|
|
9248
|
-
* @returns BotCommand
|
|
9249
|
-
* @throws ApiError
|
|
9250
|
-
*/
|
|
9251
|
-
static aiBotV1BotsBotCommandsUpdate({
|
|
9252
|
-
id,
|
|
9253
|
-
org,
|
|
9254
|
-
requestBody
|
|
9255
|
-
}) {
|
|
9256
|
-
return request(OpenAPI, {
|
|
9257
|
-
method: 'PUT',
|
|
9258
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
9259
|
-
path: {
|
|
9260
|
-
'id': id,
|
|
9261
|
-
'org': org
|
|
9262
|
-
},
|
|
9263
|
-
body: requestBody,
|
|
9264
|
-
mediaType: 'application/json'
|
|
9265
|
-
});
|
|
9266
|
-
}
|
|
9267
|
-
/**
|
|
9268
|
-
* Create slash commands for a specific bot
|
|
9269
|
-
* eg. /iblai-baseline
|
|
9270
|
-
* @returns BotCommand
|
|
9271
|
-
* @throws ApiError
|
|
9272
|
-
*/
|
|
9273
|
-
static aiBotV1BotsBotCommandsPartialUpdate({
|
|
9274
|
-
id,
|
|
9275
|
-
org,
|
|
9276
|
-
requestBody
|
|
9277
|
-
}) {
|
|
9278
|
-
return request(OpenAPI, {
|
|
9279
|
-
method: 'PATCH',
|
|
9280
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
9281
|
-
path: {
|
|
9282
|
-
'id': id,
|
|
9283
|
-
'org': org
|
|
9284
|
-
},
|
|
9285
|
-
body: requestBody,
|
|
9286
|
-
mediaType: 'application/json'
|
|
9287
|
-
});
|
|
9288
|
-
}
|
|
9289
|
-
/**
|
|
9290
|
-
* Create slash commands for a specific bot
|
|
9291
|
-
* eg. /iblai-baseline
|
|
9292
|
-
* @returns void
|
|
9293
|
-
* @throws ApiError
|
|
9294
|
-
*/
|
|
9295
|
-
static aiBotV1BotsBotCommandsDestroy({
|
|
9296
|
-
id,
|
|
9297
|
-
org
|
|
9298
|
-
}) {
|
|
9299
|
-
return request(OpenAPI, {
|
|
9300
|
-
method: 'DELETE',
|
|
9301
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
9302
|
-
path: {
|
|
9303
|
-
'id': id,
|
|
9304
|
-
'org': org
|
|
9305
|
-
}
|
|
9306
|
-
});
|
|
9307
|
-
}
|
|
9308
|
-
/**
|
|
9309
|
-
* Create modify and update bot information for a specific tenant.
|
|
9310
|
-
* @returns Bot
|
|
9311
|
-
* @throws ApiError
|
|
9312
|
-
*/
|
|
9313
|
-
static aiBotV1BotsBotRetrieve({
|
|
9314
|
-
id,
|
|
9315
|
-
org
|
|
9316
|
-
}) {
|
|
9317
|
-
return request(OpenAPI, {
|
|
9318
|
-
method: 'GET',
|
|
9319
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
9320
|
-
path: {
|
|
9321
|
-
'id': id,
|
|
9322
|
-
'org': org
|
|
9323
|
-
}
|
|
9324
|
-
});
|
|
9325
|
-
}
|
|
9326
|
-
/**
|
|
9327
|
-
* Create modify and update bot information for a specific tenant.
|
|
9328
|
-
* @returns BotCreate
|
|
9329
|
-
* @throws ApiError
|
|
9330
|
-
*/
|
|
9331
|
-
static aiBotV1BotsBotUpdate({
|
|
9332
|
-
id,
|
|
9333
|
-
org,
|
|
9334
|
-
requestBody
|
|
9335
|
-
}) {
|
|
9336
|
-
return request(OpenAPI, {
|
|
9337
|
-
method: 'PUT',
|
|
9338
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
9339
|
-
path: {
|
|
9340
|
-
'id': id,
|
|
9341
|
-
'org': org
|
|
9342
|
-
},
|
|
9343
|
-
body: requestBody,
|
|
9344
|
-
mediaType: 'application/json'
|
|
9345
|
-
});
|
|
9346
|
-
}
|
|
9347
|
-
/**
|
|
9348
|
-
* Create modify and update bot information for a specific tenant.
|
|
9349
|
-
* @returns BotCreate
|
|
9350
|
-
* @throws ApiError
|
|
9351
|
-
*/
|
|
9352
|
-
static aiBotV1BotsBotPartialUpdate({
|
|
9353
|
-
id,
|
|
9354
|
-
org,
|
|
9355
|
-
requestBody
|
|
9356
|
-
}) {
|
|
9357
|
-
return request(OpenAPI, {
|
|
9358
|
-
method: 'PATCH',
|
|
9359
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
9360
|
-
path: {
|
|
9361
|
-
'id': id,
|
|
9362
|
-
'org': org
|
|
9363
|
-
},
|
|
9364
|
-
body: requestBody,
|
|
9365
|
-
mediaType: 'application/json'
|
|
9366
|
-
});
|
|
9367
|
-
}
|
|
9368
|
-
/**
|
|
9369
|
-
* Create modify and update bot information for a specific tenant.
|
|
9370
|
-
* @returns void
|
|
9371
|
-
* @throws ApiError
|
|
9372
|
-
*/
|
|
9373
|
-
static aiBotV1BotsBotDestroy({
|
|
9374
|
-
id,
|
|
9375
|
-
org
|
|
9376
|
-
}) {
|
|
9377
|
-
return request(OpenAPI, {
|
|
9378
|
-
method: 'DELETE',
|
|
9379
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
9380
|
-
path: {
|
|
9381
|
-
'id': id,
|
|
9382
|
-
'org': org
|
|
9383
|
-
}
|
|
9384
|
-
});
|
|
9385
|
-
}
|
|
9386
|
-
/**
|
|
9387
|
-
* Create modify and update bot information for a specific tenant.
|
|
9388
|
-
* @returns DiscordConfig
|
|
9389
|
-
* @throws ApiError
|
|
9390
|
-
*/
|
|
9391
|
-
static aiBotV1BotsBotConfigDiscordRetrieve({
|
|
9392
|
-
id,
|
|
9393
|
-
org
|
|
9394
|
-
}) {
|
|
9395
|
-
return request(OpenAPI, {
|
|
9396
|
-
method: 'GET',
|
|
9397
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
9398
|
-
path: {
|
|
9399
|
-
'id': id,
|
|
9400
|
-
'org': org
|
|
9401
|
-
}
|
|
9402
|
-
});
|
|
9403
|
-
}
|
|
9404
|
-
/**
|
|
9405
|
-
* Create modify and update bot information for a specific tenant.
|
|
9406
|
-
* @returns DiscordConfig
|
|
9407
|
-
* @throws ApiError
|
|
9408
|
-
*/
|
|
9409
|
-
static aiBotV1BotsBotConfigDiscordPartialUpdate({
|
|
9410
|
-
id,
|
|
9411
|
-
org,
|
|
9412
|
-
requestBody
|
|
9413
|
-
}) {
|
|
9414
|
-
return request(OpenAPI, {
|
|
9415
|
-
method: 'PATCH',
|
|
9416
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
9417
|
-
path: {
|
|
9418
|
-
'id': id,
|
|
9419
|
-
'org': org
|
|
9420
|
-
},
|
|
9421
|
-
body: requestBody,
|
|
9422
|
-
mediaType: 'application/json'
|
|
9423
|
-
});
|
|
9424
|
-
}
|
|
9425
|
-
/**
|
|
9426
|
-
* Create modify and update bot information for a specific tenant.
|
|
9427
|
-
* @returns SlackConfig
|
|
9428
|
-
* @throws ApiError
|
|
9429
|
-
*/
|
|
9430
|
-
static aiBotV1BotsBotConfigSlackRetrieve({
|
|
9431
|
-
id,
|
|
9432
|
-
org
|
|
9433
|
-
}) {
|
|
9434
|
-
return request(OpenAPI, {
|
|
9435
|
-
method: 'GET',
|
|
9436
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
|
|
9437
|
-
path: {
|
|
9438
|
-
'id': id,
|
|
9439
|
-
'org': org
|
|
9440
|
-
}
|
|
9441
|
-
});
|
|
9442
|
-
}
|
|
9443
|
-
/**
|
|
9444
|
-
* Create modify and update bot information for a specific tenant.
|
|
9445
|
-
* @returns SlackConfig
|
|
9446
|
-
* @throws ApiError
|
|
9447
|
-
*/
|
|
9448
|
-
static aiBotV1BotsBotConfigSlackUpdateCreate({
|
|
9449
|
-
id,
|
|
9450
|
-
org,
|
|
9451
|
-
requestBody
|
|
9452
|
-
}) {
|
|
9453
|
-
return request(OpenAPI, {
|
|
9454
|
-
method: 'POST',
|
|
9455
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
9456
|
-
path: {
|
|
9457
|
-
'id': id,
|
|
9458
|
-
'org': org
|
|
9459
|
-
},
|
|
9460
|
-
body: requestBody,
|
|
9461
|
-
mediaType: 'application/json'
|
|
9462
|
-
});
|
|
9463
|
-
}
|
|
9464
|
-
/**
|
|
9465
|
-
* Create modify and update bot information for a specific tenant.
|
|
9466
|
-
* @returns SlackConfig
|
|
9467
|
-
* @throws ApiError
|
|
9468
|
-
*/
|
|
9469
|
-
static aiBotV1BotsBotConfigSlackUpdateUpdate({
|
|
9470
|
-
id,
|
|
9471
|
-
org,
|
|
9472
|
-
requestBody
|
|
9473
|
-
}) {
|
|
9474
|
-
return request(OpenAPI, {
|
|
9475
|
-
method: 'PUT',
|
|
9476
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
9477
|
-
path: {
|
|
9478
|
-
'id': id,
|
|
9479
|
-
'org': org
|
|
9480
|
-
},
|
|
9481
|
-
body: requestBody,
|
|
9482
|
-
mediaType: 'application/json'
|
|
9483
|
-
});
|
|
9484
|
-
}
|
|
9485
|
-
/**
|
|
9486
|
-
* Create modify and update bot information for a specific tenant.
|
|
9487
|
-
* @returns SlackConfig
|
|
9488
|
-
* @throws ApiError
|
|
9489
|
-
*/
|
|
9490
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate({
|
|
9491
|
-
id,
|
|
9492
|
-
org,
|
|
9493
|
-
requestBody
|
|
9494
|
-
}) {
|
|
9495
|
-
return request(OpenAPI, {
|
|
9496
|
-
method: 'PATCH',
|
|
9497
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
9498
|
-
path: {
|
|
9499
|
-
'id': id,
|
|
9500
|
-
'org': org
|
|
9501
|
-
},
|
|
9502
|
-
body: requestBody,
|
|
9503
|
-
mediaType: 'application/json'
|
|
9504
|
-
});
|
|
9505
|
-
}
|
|
9506
|
-
/**
|
|
9507
|
-
* Create modify and update bot information for a specific tenant.
|
|
9508
|
-
* @returns TeamsConfig
|
|
9509
|
-
* @throws ApiError
|
|
9510
|
-
*/
|
|
9511
|
-
static aiBotV1BotsBotConfigTeamsRetrieve({
|
|
9512
|
-
id,
|
|
9513
|
-
org
|
|
9514
|
-
}) {
|
|
9515
|
-
return request(OpenAPI, {
|
|
9516
|
-
method: 'GET',
|
|
9517
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
9518
|
-
path: {
|
|
9519
|
-
'id': id,
|
|
9520
|
-
'org': org
|
|
9521
|
-
}
|
|
9522
|
-
});
|
|
9523
|
-
}
|
|
9524
|
-
/**
|
|
9525
|
-
* Create modify and update bot information for a specific tenant.
|
|
9526
|
-
* @returns TeamsConfig
|
|
9527
|
-
* @throws ApiError
|
|
9528
|
-
*/
|
|
9529
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate({
|
|
9530
|
-
id,
|
|
9531
|
-
org,
|
|
9532
|
-
requestBody
|
|
9533
|
-
}) {
|
|
9534
|
-
return request(OpenAPI, {
|
|
9535
|
-
method: 'POST',
|
|
9536
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9537
|
-
path: {
|
|
9538
|
-
'id': id,
|
|
9539
|
-
'org': org
|
|
9540
|
-
},
|
|
9541
|
-
body: requestBody,
|
|
9542
|
-
mediaType: 'application/json'
|
|
9543
|
-
});
|
|
9544
|
-
}
|
|
9545
|
-
/**
|
|
9546
|
-
* Create modify and update bot information for a specific tenant.
|
|
9547
|
-
* @returns TeamsConfig
|
|
9548
|
-
* @throws ApiError
|
|
9549
|
-
*/
|
|
9550
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate({
|
|
9551
|
-
id,
|
|
9552
|
-
org,
|
|
9553
|
-
requestBody
|
|
9554
|
-
}) {
|
|
9555
|
-
return request(OpenAPI, {
|
|
9556
|
-
method: 'PUT',
|
|
9557
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9558
|
-
path: {
|
|
9559
|
-
'id': id,
|
|
9560
|
-
'org': org
|
|
9561
|
-
},
|
|
9562
|
-
body: requestBody,
|
|
9563
|
-
mediaType: 'application/json'
|
|
9564
|
-
});
|
|
9565
|
-
}
|
|
9566
|
-
/**
|
|
9567
|
-
* Create modify and update bot information for a specific tenant.
|
|
9568
|
-
* @returns TeamsConfig
|
|
9569
|
-
* @throws ApiError
|
|
9570
|
-
*/
|
|
9571
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate({
|
|
9572
|
-
id,
|
|
9573
|
-
org,
|
|
9574
|
-
requestBody
|
|
9575
|
-
}) {
|
|
9576
|
-
return request(OpenAPI, {
|
|
9577
|
-
method: 'PATCH',
|
|
9578
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9579
|
-
path: {
|
|
9580
|
-
'id': id,
|
|
9581
|
-
'org': org
|
|
9582
|
-
},
|
|
9583
|
-
body: requestBody,
|
|
9584
|
-
mediaType: 'application/json'
|
|
9585
|
-
});
|
|
9586
|
-
}
|
|
9587
|
-
/**
|
|
9588
|
-
* Create modify and update bot information for a specific tenant.
|
|
9589
|
-
* @returns WebexConfig
|
|
9590
|
-
* @throws ApiError
|
|
9591
|
-
*/
|
|
9592
|
-
static aiBotV1BotsBotConfigWebexRetrieve({
|
|
9593
|
-
id,
|
|
9594
|
-
org
|
|
9595
|
-
}) {
|
|
9596
|
-
return request(OpenAPI, {
|
|
9597
|
-
method: 'GET',
|
|
9598
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
9599
|
-
path: {
|
|
9600
|
-
'id': id,
|
|
9601
|
-
'org': org
|
|
9602
|
-
}
|
|
9603
|
-
});
|
|
9604
|
-
}
|
|
9605
|
-
/**
|
|
9606
|
-
* Create modify and update bot information for a specific tenant.
|
|
9607
|
-
* @returns WebexConfig
|
|
9608
|
-
* @throws ApiError
|
|
9609
|
-
*/
|
|
9610
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate({
|
|
9611
|
-
id,
|
|
9612
|
-
org,
|
|
9613
|
-
requestBody
|
|
9614
|
-
}) {
|
|
9615
|
-
return request(OpenAPI, {
|
|
9616
|
-
method: 'PATCH',
|
|
9617
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
9618
|
-
path: {
|
|
9619
|
-
'id': id,
|
|
9620
|
-
'org': org
|
|
9621
|
-
},
|
|
9622
|
-
body: requestBody,
|
|
9623
|
-
mediaType: 'application/json'
|
|
9624
|
-
});
|
|
9625
|
-
}
|
|
9626
|
-
/**
|
|
9627
|
-
* Create modify and update bot information for a specific tenant.
|
|
9628
|
-
* @returns WhatsappConfig
|
|
9629
|
-
* @throws ApiError
|
|
9630
|
-
*/
|
|
9631
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve({
|
|
9632
|
-
id,
|
|
9633
|
-
org
|
|
9634
|
-
}) {
|
|
9635
|
-
return request(OpenAPI, {
|
|
9636
|
-
method: 'GET',
|
|
9637
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
9638
|
-
path: {
|
|
9639
|
-
'id': id,
|
|
9640
|
-
'org': org
|
|
9641
|
-
}
|
|
9642
|
-
});
|
|
9643
|
-
}
|
|
9644
|
-
/**
|
|
9645
|
-
* Create modify and update bot information for a specific tenant.
|
|
9646
|
-
* @returns WhatsappConfig
|
|
9647
|
-
* @throws ApiError
|
|
9648
|
-
*/
|
|
9649
|
-
static aiBotV1BotsBotWhatsappConfigUpdate({
|
|
9650
|
-
id,
|
|
9651
|
-
org,
|
|
9652
|
-
requestBody
|
|
9653
|
-
}) {
|
|
9654
|
-
return request(OpenAPI, {
|
|
9655
|
-
method: 'PUT',
|
|
9656
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
9657
|
-
path: {
|
|
9658
|
-
'id': id,
|
|
9659
|
-
'org': org
|
|
9660
|
-
},
|
|
9661
|
-
body: requestBody,
|
|
9662
|
-
mediaType: 'application/json'
|
|
9663
|
-
});
|
|
9664
|
-
}
|
|
9665
|
-
/**
|
|
9666
|
-
* Create modify and update bot information for a specific tenant.
|
|
9667
|
-
* @returns WhatsappConfig
|
|
9668
|
-
* @throws ApiError
|
|
9669
|
-
*/
|
|
9670
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate({
|
|
9671
|
-
id,
|
|
9672
|
-
org,
|
|
9673
|
-
requestBody
|
|
9674
|
-
}) {
|
|
9675
|
-
return request(OpenAPI, {
|
|
9676
|
-
method: 'PATCH',
|
|
9677
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
9678
|
-
path: {
|
|
9679
|
-
'id': id,
|
|
9680
|
-
'org': org
|
|
9681
|
-
},
|
|
9682
|
-
body: requestBody,
|
|
9683
|
-
mediaType: 'application/json'
|
|
9684
|
-
});
|
|
9685
|
-
}
|
|
9686
|
-
/**
|
|
9687
|
-
* Setup discord user id linkage with discord bots
|
|
9688
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9689
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9690
|
-
* @returns DiscordUserConfig
|
|
9691
|
-
* @throws ApiError
|
|
9692
|
-
*/
|
|
9693
|
-
static aiBotV1BotsDiscordUserConfigList({
|
|
9694
|
-
org
|
|
9695
|
-
}) {
|
|
9696
|
-
return request(OpenAPI, {
|
|
9697
|
-
method: 'GET',
|
|
9698
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
9699
|
-
path: {
|
|
9700
|
-
'org': org
|
|
9701
|
-
}
|
|
9702
|
-
});
|
|
9703
|
-
}
|
|
9704
|
-
/**
|
|
9705
|
-
* Setup discord user id linkage with discord bots
|
|
9706
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9707
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9708
|
-
* @returns DiscordUserConfig
|
|
9709
|
-
* @throws ApiError
|
|
9710
|
-
*/
|
|
9711
|
-
static aiBotV1BotsDiscordUserConfigCreate({
|
|
9712
|
-
org,
|
|
9713
|
-
requestBody
|
|
9714
|
-
}) {
|
|
9715
|
-
return request(OpenAPI, {
|
|
9716
|
-
method: 'POST',
|
|
9717
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
9718
|
-
path: {
|
|
9719
|
-
'org': org
|
|
9720
|
-
},
|
|
9721
|
-
body: requestBody,
|
|
9722
|
-
mediaType: 'application/json'
|
|
9723
|
-
});
|
|
9724
|
-
}
|
|
9725
|
-
/**
|
|
9726
|
-
* Setup discord user id linkage with discord bots
|
|
9727
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9728
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9729
|
-
* @returns DiscordUserConfig
|
|
9730
|
-
* @throws ApiError
|
|
9731
|
-
*/
|
|
9732
|
-
static aiBotV1BotsDiscordUserConfigRetrieve({
|
|
9733
|
-
id,
|
|
9734
|
-
org
|
|
9735
|
-
}) {
|
|
9736
|
-
return request(OpenAPI, {
|
|
9737
|
-
method: 'GET',
|
|
9738
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9739
|
-
path: {
|
|
9740
|
-
'id': id,
|
|
9741
|
-
'org': org
|
|
9742
|
-
}
|
|
9743
|
-
});
|
|
9744
|
-
}
|
|
9745
|
-
/**
|
|
9746
|
-
* Setup discord user id linkage with discord bots
|
|
9747
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9748
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9749
|
-
* @returns DiscordUserConfig
|
|
9750
|
-
* @throws ApiError
|
|
9751
|
-
*/
|
|
9752
|
-
static aiBotV1BotsDiscordUserConfigUpdate({
|
|
9753
|
-
id,
|
|
9754
|
-
org,
|
|
9755
|
-
requestBody
|
|
9756
|
-
}) {
|
|
9757
|
-
return request(OpenAPI, {
|
|
9758
|
-
method: 'PUT',
|
|
9759
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9760
|
-
path: {
|
|
9761
|
-
'id': id,
|
|
9762
|
-
'org': org
|
|
9763
|
-
},
|
|
9764
|
-
body: requestBody,
|
|
9765
|
-
mediaType: 'application/json'
|
|
9766
|
-
});
|
|
9767
|
-
}
|
|
9768
|
-
/**
|
|
9769
|
-
* Setup discord user id linkage with discord bots
|
|
9770
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9771
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9772
|
-
* @returns DiscordUserConfig
|
|
9773
|
-
* @throws ApiError
|
|
9774
|
-
*/
|
|
9775
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate({
|
|
9776
|
-
id,
|
|
9777
|
-
org,
|
|
9778
|
-
requestBody
|
|
9779
|
-
}) {
|
|
9780
|
-
return request(OpenAPI, {
|
|
9781
|
-
method: 'PATCH',
|
|
9782
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9783
|
-
path: {
|
|
9784
|
-
'id': id,
|
|
9785
|
-
'org': org
|
|
9786
|
-
},
|
|
9787
|
-
body: requestBody,
|
|
9788
|
-
mediaType: 'application/json'
|
|
9789
|
-
});
|
|
9790
|
-
}
|
|
9791
|
-
/**
|
|
9792
|
-
* Setup discord user id linkage with discord bots
|
|
9793
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9794
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9795
|
-
* @returns void
|
|
9796
|
-
* @throws ApiError
|
|
9797
|
-
*/
|
|
9798
|
-
static aiBotV1BotsDiscordUserConfigDestroy({
|
|
9799
|
-
id,
|
|
9800
|
-
org
|
|
9801
|
-
}) {
|
|
9802
|
-
return request(OpenAPI, {
|
|
9803
|
-
method: 'DELETE',
|
|
9804
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9805
|
-
path: {
|
|
9806
|
-
'id': id,
|
|
9807
|
-
'org': org
|
|
9808
|
-
}
|
|
9809
|
-
});
|
|
9810
|
-
}
|
|
9811
|
-
/**
|
|
9812
|
-
* Setup slack username and domain linkage with slack bots
|
|
9813
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9814
|
-
* @returns SlackUserConfig
|
|
9815
|
-
* @throws ApiError
|
|
9816
|
-
*/
|
|
9817
|
-
static aiBotV1BotsSlackUserConfigList({
|
|
9818
|
-
org
|
|
9819
|
-
}) {
|
|
9820
|
-
return request(OpenAPI, {
|
|
9821
|
-
method: 'GET',
|
|
9822
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
9823
|
-
path: {
|
|
9824
|
-
'org': org
|
|
9825
|
-
}
|
|
9826
|
-
});
|
|
9827
|
-
}
|
|
9828
|
-
/**
|
|
9829
|
-
* Setup slack username and domain linkage with slack bots
|
|
9830
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9831
|
-
* @returns SlackUserConfig
|
|
9832
|
-
* @throws ApiError
|
|
9833
|
-
*/
|
|
9834
|
-
static aiBotV1BotsSlackUserConfigCreate({
|
|
9835
|
-
org,
|
|
9836
|
-
requestBody
|
|
9837
|
-
}) {
|
|
9838
|
-
return request(OpenAPI, {
|
|
9839
|
-
method: 'POST',
|
|
9840
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
9841
|
-
path: {
|
|
9842
|
-
'org': org
|
|
9843
|
-
},
|
|
9844
|
-
body: requestBody,
|
|
9845
|
-
mediaType: 'application/json'
|
|
9846
|
-
});
|
|
9847
|
-
}
|
|
9848
|
-
/**
|
|
9849
|
-
* Setup slack username and domain linkage with slack bots
|
|
9850
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9851
|
-
* @returns SlackUserConfig
|
|
9852
|
-
* @throws ApiError
|
|
9853
|
-
*/
|
|
9854
|
-
static aiBotV1BotsSlackUserConfigRetrieve({
|
|
9855
|
-
id,
|
|
9856
|
-
org
|
|
9857
|
-
}) {
|
|
9858
|
-
return request(OpenAPI, {
|
|
9859
|
-
method: 'GET',
|
|
9860
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
9861
|
-
path: {
|
|
9862
|
-
'id': id,
|
|
9863
|
-
'org': org
|
|
9864
|
-
}
|
|
9865
|
-
});
|
|
9866
|
-
}
|
|
9867
|
-
/**
|
|
9868
|
-
* Setup slack username and domain linkage with slack bots
|
|
9869
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9870
|
-
* @returns SlackUserConfig
|
|
9871
|
-
* @throws ApiError
|
|
9872
|
-
*/
|
|
9873
|
-
static aiBotV1BotsSlackUserConfigUpdate({
|
|
9874
|
-
id,
|
|
9875
|
-
org,
|
|
9876
|
-
requestBody
|
|
9877
|
-
}) {
|
|
9878
|
-
return request(OpenAPI, {
|
|
9879
|
-
method: 'PUT',
|
|
9880
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
9881
|
-
path: {
|
|
9882
|
-
'id': id,
|
|
9883
|
-
'org': org
|
|
9884
|
-
},
|
|
9885
|
-
body: requestBody,
|
|
9886
|
-
mediaType: 'application/json'
|
|
9887
|
-
});
|
|
9888
|
-
}
|
|
9889
|
-
/**
|
|
9890
|
-
* Setup slack username and domain linkage with slack bots
|
|
9891
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9892
|
-
* @returns SlackUserConfig
|
|
9893
|
-
* @throws ApiError
|
|
9894
|
-
*/
|
|
9895
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate({
|
|
9896
|
-
id,
|
|
9897
|
-
org,
|
|
9898
|
-
requestBody
|
|
9899
|
-
}) {
|
|
9900
|
-
return request(OpenAPI, {
|
|
9901
|
-
method: 'PATCH',
|
|
9902
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
9903
|
-
path: {
|
|
9904
|
-
'id': id,
|
|
9905
|
-
'org': org
|
|
9906
|
-
},
|
|
9907
|
-
body: requestBody,
|
|
9908
|
-
mediaType: 'application/json'
|
|
9909
|
-
});
|
|
9910
|
-
}
|
|
9911
|
-
/**
|
|
9912
|
-
* Setup slack username and domain linkage with slack bots
|
|
9913
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
9914
|
-
* @returns void
|
|
9915
|
-
* @throws ApiError
|
|
9916
|
-
*/
|
|
9917
|
-
static aiBotV1BotsSlackUserConfigDestroy({
|
|
9918
|
-
id,
|
|
9919
|
-
org
|
|
9920
|
-
}) {
|
|
9921
|
-
return request(OpenAPI, {
|
|
9922
|
-
method: 'DELETE',
|
|
9923
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
9924
|
-
path: {
|
|
9925
|
-
'id': id,
|
|
9926
|
-
'org': org
|
|
9927
|
-
}
|
|
9928
|
-
});
|
|
9929
|
-
}
|
|
9930
|
-
/**
|
|
9931
|
-
* Setup phone number linkage with whatsapp bots
|
|
9932
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
9933
|
-
* @returns WhatsappUserConfig
|
|
9934
|
-
* @throws ApiError
|
|
9935
|
-
*/
|
|
9936
|
-
static aiBotV1BotsWhatsappUserConfigList({
|
|
9937
|
-
org
|
|
9938
|
-
}) {
|
|
9939
|
-
return request(OpenAPI, {
|
|
9940
|
-
method: 'GET',
|
|
9941
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
9942
|
-
path: {
|
|
9943
|
-
'org': org
|
|
9944
|
-
}
|
|
9945
|
-
});
|
|
9946
|
-
}
|
|
9947
|
-
/**
|
|
9948
|
-
* Setup phone number linkage with whatsapp bots
|
|
9949
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
9950
|
-
* @returns WhatsappUserConfig
|
|
9951
|
-
* @throws ApiError
|
|
9952
|
-
*/
|
|
9953
|
-
static aiBotV1BotsWhatsappUserConfigCreate({
|
|
9954
|
-
org,
|
|
9955
|
-
requestBody
|
|
9956
|
-
}) {
|
|
9957
|
-
return request(OpenAPI, {
|
|
9958
|
-
method: 'POST',
|
|
9959
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
9960
|
-
path: {
|
|
9961
|
-
'org': org
|
|
9962
|
-
},
|
|
9963
|
-
body: requestBody,
|
|
9964
|
-
mediaType: 'application/json'
|
|
9965
|
-
});
|
|
9966
|
-
}
|
|
9967
|
-
/**
|
|
9968
|
-
* Setup phone number linkage with whatsapp bots
|
|
9969
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
9970
|
-
* @returns WhatsappUserConfig
|
|
9971
|
-
* @throws ApiError
|
|
9972
|
-
*/
|
|
9973
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve({
|
|
9974
|
-
id,
|
|
9975
|
-
org
|
|
9976
|
-
}) {
|
|
9977
|
-
return request(OpenAPI, {
|
|
9978
|
-
method: 'GET',
|
|
9979
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
9980
|
-
path: {
|
|
9981
|
-
'id': id,
|
|
9982
|
-
'org': org
|
|
9983
|
-
}
|
|
9984
|
-
});
|
|
9985
|
-
}
|
|
9986
|
-
/**
|
|
9987
|
-
* Setup phone number linkage with whatsapp bots
|
|
9988
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
9989
|
-
* @returns WhatsappUserConfig
|
|
9990
|
-
* @throws ApiError
|
|
9991
|
-
*/
|
|
9992
|
-
static aiBotV1BotsWhatsappUserConfigUpdate({
|
|
9993
|
-
id,
|
|
9994
|
-
org,
|
|
9995
|
-
requestBody
|
|
9996
|
-
}) {
|
|
9997
|
-
return request(OpenAPI, {
|
|
9998
|
-
method: 'PUT',
|
|
9999
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10000
|
-
path: {
|
|
10001
|
-
'id': id,
|
|
10002
|
-
'org': org
|
|
10003
|
-
},
|
|
10004
|
-
body: requestBody,
|
|
10005
|
-
mediaType: 'application/json'
|
|
10006
|
-
});
|
|
10007
|
-
}
|
|
10008
|
-
/**
|
|
10009
|
-
* Setup phone number linkage with whatsapp bots
|
|
10010
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10011
|
-
* @returns WhatsappUserConfig
|
|
10012
|
-
* @throws ApiError
|
|
10013
|
-
*/
|
|
10014
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate({
|
|
10015
|
-
id,
|
|
10016
|
-
org,
|
|
10017
|
-
requestBody
|
|
10018
|
-
}) {
|
|
10019
|
-
return request(OpenAPI, {
|
|
10020
|
-
method: 'PATCH',
|
|
10021
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10022
|
-
path: {
|
|
10023
|
-
'id': id,
|
|
10024
|
-
'org': org
|
|
10025
|
-
},
|
|
10026
|
-
body: requestBody,
|
|
10027
|
-
mediaType: 'application/json'
|
|
10028
|
-
});
|
|
10029
|
-
}
|
|
10030
|
-
/**
|
|
10031
|
-
* Setup phone number linkage with whatsapp bots
|
|
10032
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10033
|
-
* @returns void
|
|
10034
|
-
* @throws ApiError
|
|
10035
|
-
*/
|
|
10036
|
-
static aiBotV1BotsWhatsappUserConfigDestroy({
|
|
10037
|
-
id,
|
|
8592
|
+
static platformOrgsCoursesProgressInProgressRetrieve({
|
|
8593
|
+
courseId,
|
|
10038
8594
|
org
|
|
10039
8595
|
}) {
|
|
10040
8596
|
return request(OpenAPI, {
|
|
10041
|
-
method: '
|
|
10042
|
-
url: '/api/
|
|
8597
|
+
method: 'GET',
|
|
8598
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/progress/in-progress',
|
|
10043
8599
|
path: {
|
|
10044
|
-
'
|
|
8600
|
+
'course_id': courseId,
|
|
10045
8601
|
'org': org
|
|
10046
8602
|
}
|
|
10047
8603
|
});
|
|
10048
8604
|
}
|
|
10049
8605
|
/**
|
|
10050
|
-
*
|
|
10051
|
-
*
|
|
8606
|
+
* Started means an enrollment
|
|
8607
|
+
*
|
|
8608
|
+
* For platform : Total users who have atleast an enrollment
|
|
8609
|
+
* For course : Total users enrolled
|
|
8610
|
+
* For learner : Total courses in progress
|
|
8611
|
+
*
|
|
8612
|
+
* Query Params
|
|
8613
|
+
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8614
|
+
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
8615
|
+
* @returns any No response body
|
|
10052
8616
|
* @throws ApiError
|
|
10053
8617
|
*/
|
|
10054
|
-
static
|
|
10055
|
-
|
|
10056
|
-
org
|
|
10057
|
-
requestBody
|
|
8618
|
+
static platformOrgsCoursesProgressStartedRetrieve({
|
|
8619
|
+
courseId,
|
|
8620
|
+
org
|
|
10058
8621
|
}) {
|
|
10059
8622
|
return request(OpenAPI, {
|
|
10060
|
-
method: '
|
|
10061
|
-
url: '/api/
|
|
8623
|
+
method: 'GET',
|
|
8624
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/progress/started',
|
|
10062
8625
|
path: {
|
|
10063
|
-
'
|
|
8626
|
+
'course_id': courseId,
|
|
10064
8627
|
'org': org
|
|
10065
|
-
}
|
|
10066
|
-
body: requestBody,
|
|
10067
|
-
mediaType: 'application/json'
|
|
8628
|
+
}
|
|
10068
8629
|
});
|
|
10069
8630
|
}
|
|
10070
8631
|
/**
|
|
10071
|
-
*
|
|
8632
|
+
* Base class for API views that return a single count value.
|
|
8633
|
+
*
|
|
8634
|
+
* This class formats the response as {"data": {value_key: count}} where
|
|
8635
|
+
* value_key is configurable (defaults to "count").
|
|
8636
|
+
*
|
|
8637
|
+
* Attributes:
|
|
8638
|
+
* value_key: The key used in the response for the count value
|
|
8639
|
+
* @returns any No response body
|
|
10072
8640
|
* @throws ApiError
|
|
10073
8641
|
*/
|
|
10074
|
-
static
|
|
10075
|
-
|
|
8642
|
+
static platformOrgsCoursesUsersGradesPassedRetrieve({
|
|
8643
|
+
courseId,
|
|
10076
8644
|
org,
|
|
10077
|
-
|
|
8645
|
+
userId
|
|
10078
8646
|
}) {
|
|
10079
8647
|
return request(OpenAPI, {
|
|
10080
|
-
method: '
|
|
10081
|
-
url: '/api/
|
|
8648
|
+
method: 'GET',
|
|
8649
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed',
|
|
10082
8650
|
path: {
|
|
10083
|
-
'
|
|
10084
|
-
'org': org
|
|
10085
|
-
|
|
10086
|
-
|
|
10087
|
-
mediaType: 'application/json'
|
|
8651
|
+
'course_id': courseId,
|
|
8652
|
+
'org': org,
|
|
8653
|
+
'user_id': userId
|
|
8654
|
+
}
|
|
10088
8655
|
});
|
|
10089
8656
|
}
|
|
10090
8657
|
/**
|
|
10091
|
-
*
|
|
8658
|
+
* Gives Percentage of units completed in course for a specific learner
|
|
8659
|
+
* @returns PerlearnerCourseProgress
|
|
10092
8660
|
* @throws ApiError
|
|
10093
8661
|
*/
|
|
10094
|
-
static
|
|
10095
|
-
|
|
8662
|
+
static platformOrgsCoursesUsersProgressRetrieve({
|
|
8663
|
+
courseId,
|
|
10096
8664
|
org,
|
|
10097
|
-
|
|
8665
|
+
userId,
|
|
8666
|
+
departmentId,
|
|
8667
|
+
format = 'json',
|
|
8668
|
+
includeMainPlatform = true
|
|
10098
8669
|
}) {
|
|
10099
8670
|
return request(OpenAPI, {
|
|
10100
|
-
method: '
|
|
10101
|
-
url: '/api/
|
|
8671
|
+
method: 'GET',
|
|
8672
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
|
|
10102
8673
|
path: {
|
|
10103
|
-
'
|
|
10104
|
-
'org': org
|
|
8674
|
+
'course_id': courseId,
|
|
8675
|
+
'org': org,
|
|
8676
|
+
'user_id': userId
|
|
10105
8677
|
},
|
|
10106
|
-
|
|
10107
|
-
|
|
8678
|
+
query: {
|
|
8679
|
+
'department_id': departmentId,
|
|
8680
|
+
'format': format,
|
|
8681
|
+
'include_main_platform': includeMainPlatform
|
|
8682
|
+
}
|
|
10108
8683
|
});
|
|
10109
8684
|
}
|
|
10110
8685
|
/**
|
|
10111
|
-
*
|
|
10112
|
-
*
|
|
8686
|
+
* Average days used to complete a course
|
|
8687
|
+
*
|
|
8688
|
+
* Query Params
|
|
8689
|
+
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8690
|
+
* @returns any No response body
|
|
10113
8691
|
* @throws ApiError
|
|
10114
8692
|
*/
|
|
10115
|
-
static
|
|
10116
|
-
|
|
8693
|
+
static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({
|
|
8694
|
+
courseId,
|
|
10117
8695
|
org,
|
|
10118
|
-
|
|
10119
|
-
}) {
|
|
10120
|
-
return request(OpenAPI, {
|
|
10121
|
-
method: 'POST',
|
|
10122
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
10123
|
-
path: {
|
|
10124
|
-
'name': name,
|
|
10125
|
-
'org': org
|
|
10126
|
-
},
|
|
10127
|
-
body: requestBody,
|
|
10128
|
-
mediaType: 'application/json'
|
|
10129
|
-
});
|
|
10130
|
-
}
|
|
10131
|
-
/**
|
|
10132
|
-
* Respond to whatsapp's webhook challenge.
|
|
10133
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
10134
|
-
* @returns WhatAppWebHook
|
|
10135
|
-
* @throws ApiError
|
|
10136
|
-
*/
|
|
10137
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve({
|
|
10138
|
-
name,
|
|
10139
|
-
org
|
|
8696
|
+
userId
|
|
10140
8697
|
}) {
|
|
10141
8698
|
return request(OpenAPI, {
|
|
10142
8699
|
method: 'GET',
|
|
10143
|
-
url: '/api/
|
|
8700
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
|
|
10144
8701
|
path: {
|
|
10145
|
-
'
|
|
10146
|
-
'org': org
|
|
8702
|
+
'course_id': courseId,
|
|
8703
|
+
'org': org,
|
|
8704
|
+
'user_id': userId
|
|
10147
8705
|
}
|
|
10148
8706
|
});
|
|
10149
8707
|
}
|
|
10150
8708
|
/**
|
|
10151
|
-
*
|
|
10152
|
-
* @returns
|
|
8709
|
+
* Time spent count in seconds within a course by a learner
|
|
8710
|
+
* @returns Count
|
|
10153
8711
|
* @throws ApiError
|
|
10154
8712
|
*/
|
|
10155
|
-
static
|
|
10156
|
-
|
|
8713
|
+
static platformOrgsCoursesUsersTimeCountRetrieve({
|
|
8714
|
+
courseId,
|
|
10157
8715
|
org,
|
|
10158
|
-
|
|
8716
|
+
userId,
|
|
8717
|
+
departmentId,
|
|
8718
|
+
endDate,
|
|
8719
|
+
format = 'json',
|
|
8720
|
+
includeMainPlatform = true,
|
|
8721
|
+
startDate
|
|
10159
8722
|
}) {
|
|
10160
8723
|
return request(OpenAPI, {
|
|
10161
|
-
method: '
|
|
10162
|
-
url: '/api/
|
|
8724
|
+
method: 'GET',
|
|
8725
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
|
|
10163
8726
|
path: {
|
|
10164
|
-
'
|
|
10165
|
-
'org': org
|
|
8727
|
+
'course_id': courseId,
|
|
8728
|
+
'org': org,
|
|
8729
|
+
'user_id': userId
|
|
10166
8730
|
},
|
|
10167
|
-
|
|
10168
|
-
|
|
8731
|
+
query: {
|
|
8732
|
+
'department_id': departmentId,
|
|
8733
|
+
'end_date': endDate,
|
|
8734
|
+
'format': format,
|
|
8735
|
+
'include_main_platform': includeMainPlatform,
|
|
8736
|
+
'start_date': startDate
|
|
8737
|
+
}
|
|
10169
8738
|
});
|
|
10170
8739
|
}
|
|
10171
|
-
}
|
|
10172
|
-
|
|
10173
|
-
class AiFinetuningService {
|
|
10174
8740
|
/**
|
|
10175
|
-
*
|
|
10176
|
-
* @returns
|
|
8741
|
+
* (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
|
|
8742
|
+
* @returns VideosCount
|
|
10177
8743
|
* @throws ApiError
|
|
10178
8744
|
*/
|
|
10179
|
-
static
|
|
8745
|
+
static platformOrgsCoursesUsersVideosCountRetrieve({
|
|
8746
|
+
courseId,
|
|
10180
8747
|
org,
|
|
10181
|
-
|
|
10182
|
-
|
|
10183
|
-
|
|
10184
|
-
|
|
10185
|
-
page,
|
|
10186
|
-
pageSize,
|
|
10187
|
-
retryAttempts,
|
|
10188
|
-
search,
|
|
10189
|
-
status
|
|
8748
|
+
userId,
|
|
8749
|
+
departmentId,
|
|
8750
|
+
format = 'json',
|
|
8751
|
+
includeMainPlatform = true
|
|
10190
8752
|
}) {
|
|
10191
8753
|
return request(OpenAPI, {
|
|
10192
8754
|
method: 'GET',
|
|
10193
|
-
url: '/api/
|
|
8755
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
|
|
10194
8756
|
path: {
|
|
8757
|
+
'course_id': courseId,
|
|
10195
8758
|
'org': org,
|
|
10196
|
-
'
|
|
8759
|
+
'user_id': userId
|
|
10197
8760
|
},
|
|
10198
8761
|
query: {
|
|
10199
|
-
'
|
|
10200
|
-
'
|
|
10201
|
-
'
|
|
10202
|
-
'page': page,
|
|
10203
|
-
'page_size': pageSize,
|
|
10204
|
-
'retry_attempts': retryAttempts,
|
|
10205
|
-
'search': search,
|
|
10206
|
-
'status': status
|
|
8762
|
+
'department_id': departmentId,
|
|
8763
|
+
'format': format,
|
|
8764
|
+
'include_main_platform': includeMainPlatform
|
|
10207
8765
|
}
|
|
10208
8766
|
});
|
|
10209
8767
|
}
|
|
10210
8768
|
/**
|
|
10211
|
-
*
|
|
10212
|
-
*
|
|
8769
|
+
* Count of total videos in a course
|
|
8770
|
+
*
|
|
8771
|
+
* Query Params
|
|
8772
|
+
* course_id e.g course-v1:Org+Course4+Run
|
|
8773
|
+
* @returns any No response body
|
|
10213
8774
|
* @throws ApiError
|
|
10214
8775
|
*/
|
|
10215
|
-
static
|
|
10216
|
-
|
|
10217
|
-
|
|
10218
|
-
requestBody
|
|
8776
|
+
static platformOrgsCoursesVideosRetrieve2({
|
|
8777
|
+
courseId,
|
|
8778
|
+
org
|
|
10219
8779
|
}) {
|
|
10220
8780
|
return request(OpenAPI, {
|
|
10221
|
-
method: '
|
|
10222
|
-
url: '/api/
|
|
8781
|
+
method: 'GET',
|
|
8782
|
+
url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
|
|
10223
8783
|
path: {
|
|
10224
|
-
'
|
|
10225
|
-
'
|
|
10226
|
-
}
|
|
10227
|
-
body: requestBody,
|
|
10228
|
-
mediaType: 'application/json'
|
|
8784
|
+
'course_id': courseId,
|
|
8785
|
+
'org': org
|
|
8786
|
+
}
|
|
10229
8787
|
});
|
|
10230
8788
|
}
|
|
10231
8789
|
/**
|
|
10232
|
-
*
|
|
10233
|
-
*
|
|
8790
|
+
* Get total count of courses on the platform.
|
|
8791
|
+
*
|
|
8792
|
+
* This endpoint returns the total number of courses available on the platform.
|
|
8793
|
+
*
|
|
8794
|
+
* Returns:
|
|
8795
|
+
* The total count of courses on the platform.
|
|
8796
|
+
* @returns Count
|
|
10234
8797
|
* @throws ApiError
|
|
10235
8798
|
*/
|
|
10236
|
-
static
|
|
10237
|
-
id,
|
|
8799
|
+
static platformOrgsCoursesCountRetrieve({
|
|
10238
8800
|
org,
|
|
10239
|
-
|
|
8801
|
+
departmentId,
|
|
8802
|
+
format = 'json',
|
|
8803
|
+
includeMainPlatform = true
|
|
10240
8804
|
}) {
|
|
10241
8805
|
return request(OpenAPI, {
|
|
10242
8806
|
method: 'GET',
|
|
10243
|
-
url: '/api/
|
|
8807
|
+
url: '/api/platform/orgs/{org}/courses/count',
|
|
10244
8808
|
path: {
|
|
10245
|
-
'
|
|
10246
|
-
|
|
10247
|
-
|
|
8809
|
+
'org': org
|
|
8810
|
+
},
|
|
8811
|
+
query: {
|
|
8812
|
+
'department_id': departmentId,
|
|
8813
|
+
'format': format,
|
|
8814
|
+
'include_main_platform': includeMainPlatform
|
|
10248
8815
|
}
|
|
10249
8816
|
});
|
|
10250
8817
|
}
|
|
10251
8818
|
/**
|
|
10252
|
-
*
|
|
10253
|
-
*
|
|
8819
|
+
* List grading information on a per-course basis.
|
|
8820
|
+
*
|
|
8821
|
+
* This endpoint provides grading statistics for all courses, including
|
|
8822
|
+
* average grades and completion rates.
|
|
8823
|
+
*
|
|
8824
|
+
* Returns:
|
|
8825
|
+
* A list of courses with their associated grading metrics.
|
|
8826
|
+
* @returns any No response body
|
|
10254
8827
|
* @throws ApiError
|
|
10255
8828
|
*/
|
|
10256
|
-
static
|
|
10257
|
-
|
|
10258
|
-
org,
|
|
10259
|
-
username,
|
|
10260
|
-
requestBody
|
|
8829
|
+
static platformOrgsCoursesGradesRetrieve({
|
|
8830
|
+
org
|
|
10261
8831
|
}) {
|
|
10262
8832
|
return request(OpenAPI, {
|
|
10263
|
-
method: '
|
|
10264
|
-
url: '/api/
|
|
8833
|
+
method: 'GET',
|
|
8834
|
+
url: '/api/platform/orgs/{org}/courses/grades',
|
|
10265
8835
|
path: {
|
|
10266
|
-
'
|
|
10267
|
-
|
|
10268
|
-
'username': username
|
|
10269
|
-
},
|
|
10270
|
-
body: requestBody,
|
|
10271
|
-
mediaType: 'application/json'
|
|
8836
|
+
'org': org
|
|
8837
|
+
}
|
|
10272
8838
|
});
|
|
10273
8839
|
}
|
|
10274
8840
|
/**
|
|
10275
|
-
*
|
|
10276
|
-
*
|
|
8841
|
+
* Get video watch statistics on a per-course basis.
|
|
8842
|
+
*
|
|
8843
|
+
* This endpoint provides a list of courses with aggregated video watch metrics,
|
|
8844
|
+
* including total views and completion percentages.
|
|
8845
|
+
*
|
|
8846
|
+
* Returns:
|
|
8847
|
+
* A list of courses with:
|
|
8848
|
+
* - Course identification (ID and name)
|
|
8849
|
+
* - Video watch count
|
|
8850
|
+
* - Percentage of total videos watched
|
|
8851
|
+
* @returns WatchedVideosPerCourse
|
|
10277
8852
|
* @throws ApiError
|
|
10278
8853
|
*/
|
|
10279
|
-
static
|
|
10280
|
-
id,
|
|
8854
|
+
static platformOrgsCoursesVideosRetrieve({
|
|
10281
8855
|
org,
|
|
10282
|
-
|
|
10283
|
-
|
|
8856
|
+
departmentId,
|
|
8857
|
+
format = 'json',
|
|
8858
|
+
includeMainPlatform = true
|
|
10284
8859
|
}) {
|
|
10285
8860
|
return request(OpenAPI, {
|
|
10286
|
-
method: '
|
|
10287
|
-
url: '/api/
|
|
8861
|
+
method: 'GET',
|
|
8862
|
+
url: '/api/platform/orgs/{org}/courses/videos',
|
|
10288
8863
|
path: {
|
|
10289
|
-
'
|
|
10290
|
-
'org': org,
|
|
10291
|
-
'username': username
|
|
8864
|
+
'org': org
|
|
10292
8865
|
},
|
|
10293
|
-
|
|
10294
|
-
|
|
8866
|
+
query: {
|
|
8867
|
+
'department_id': departmentId,
|
|
8868
|
+
'format': format,
|
|
8869
|
+
'include_main_platform': includeMainPlatform
|
|
8870
|
+
}
|
|
10295
8871
|
});
|
|
10296
8872
|
}
|
|
10297
8873
|
/**
|
|
10298
|
-
*
|
|
10299
|
-
*
|
|
8874
|
+
* Get completion count statistics.
|
|
8875
|
+
*
|
|
8876
|
+
* This endpoint returns completion counts at different levels:
|
|
8877
|
+
* - Platform level: Total users who have completed at least one course
|
|
8878
|
+
* - Course level: Total completions for a specific course
|
|
8879
|
+
* - Learner level: Total courses completed by a specific learner
|
|
8880
|
+
*
|
|
8881
|
+
* Query Parameters:
|
|
8882
|
+
* course_id (str, optional): Filter by course ID
|
|
8883
|
+
* user_id (str, optional): Filter by username or email
|
|
8884
|
+
*
|
|
8885
|
+
* Returns:
|
|
8886
|
+
* A count of completions based on the specified filters.
|
|
8887
|
+
* @returns any No response body
|
|
10300
8888
|
* @throws ApiError
|
|
10301
8889
|
*/
|
|
10302
|
-
static
|
|
10303
|
-
|
|
10304
|
-
org,
|
|
10305
|
-
username
|
|
8890
|
+
static platformOrgsProgressCompletedRetrieve({
|
|
8891
|
+
org
|
|
10306
8892
|
}) {
|
|
10307
8893
|
return request(OpenAPI, {
|
|
10308
|
-
method: '
|
|
10309
|
-
url: '/api/
|
|
8894
|
+
method: 'GET',
|
|
8895
|
+
url: '/api/platform/orgs/{org}/progress/completed',
|
|
10310
8896
|
path: {
|
|
10311
|
-
'
|
|
10312
|
-
'org': org,
|
|
10313
|
-
'username': username
|
|
8897
|
+
'org': org
|
|
10314
8898
|
}
|
|
10315
8899
|
});
|
|
10316
8900
|
}
|
|
10317
8901
|
/**
|
|
10318
|
-
*
|
|
10319
|
-
* @returns
|
|
8902
|
+
* Average of total completed units
|
|
8903
|
+
* @returns any No response body
|
|
10320
8904
|
* @throws ApiError
|
|
10321
8905
|
*/
|
|
10322
|
-
static
|
|
10323
|
-
org
|
|
10324
|
-
username,
|
|
10325
|
-
baseModelName,
|
|
10326
|
-
dataset,
|
|
10327
|
-
dateCreated,
|
|
10328
|
-
fineTunedModel,
|
|
10329
|
-
lastModified,
|
|
10330
|
-
ordering,
|
|
10331
|
-
page,
|
|
10332
|
-
pageSize,
|
|
10333
|
-
preprocessDataset,
|
|
10334
|
-
provider,
|
|
10335
|
-
search,
|
|
10336
|
-
status
|
|
8906
|
+
static platformOrgsProgressCompletionRateRetrieve({
|
|
8907
|
+
org
|
|
10337
8908
|
}) {
|
|
10338
8909
|
return request(OpenAPI, {
|
|
10339
8910
|
method: 'GET',
|
|
10340
|
-
url: '/api/
|
|
8911
|
+
url: '/api/platform/orgs/{org}/progress/completion-rate',
|
|
10341
8912
|
path: {
|
|
10342
|
-
'org': org
|
|
10343
|
-
'username': username
|
|
10344
|
-
},
|
|
10345
|
-
query: {
|
|
10346
|
-
'base_model_name': baseModelName,
|
|
10347
|
-
'dataset': dataset,
|
|
10348
|
-
'date_created': dateCreated,
|
|
10349
|
-
'fine_tuned_model': fineTunedModel,
|
|
10350
|
-
'last_modified': lastModified,
|
|
10351
|
-
'ordering': ordering,
|
|
10352
|
-
'page': page,
|
|
10353
|
-
'page_size': pageSize,
|
|
10354
|
-
'preprocess_dataset': preprocessDataset,
|
|
10355
|
-
'provider': provider,
|
|
10356
|
-
'search': search,
|
|
10357
|
-
'status': status
|
|
8913
|
+
'org': org
|
|
10358
8914
|
}
|
|
10359
8915
|
});
|
|
10360
8916
|
}
|
|
10361
8917
|
/**
|
|
10362
|
-
*
|
|
10363
|
-
*
|
|
8918
|
+
* In Progress means any unit completion in the past 30 days
|
|
8919
|
+
*
|
|
8920
|
+
* For platform : Total users who have atleast a course in_progress on the platform
|
|
8921
|
+
* For course : Total users
|
|
8922
|
+
* For learner : Total courses in progress
|
|
8923
|
+
*
|
|
8924
|
+
* Query Params
|
|
8925
|
+
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8926
|
+
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
8927
|
+
* @returns any No response body
|
|
10364
8928
|
* @throws ApiError
|
|
10365
8929
|
*/
|
|
10366
|
-
static
|
|
10367
|
-
org
|
|
10368
|
-
username,
|
|
10369
|
-
requestBody
|
|
8930
|
+
static platformOrgsProgressInProgressRetrieve({
|
|
8931
|
+
org
|
|
10370
8932
|
}) {
|
|
10371
8933
|
return request(OpenAPI, {
|
|
10372
|
-
method: '
|
|
10373
|
-
url: '/api/
|
|
8934
|
+
method: 'GET',
|
|
8935
|
+
url: '/api/platform/orgs/{org}/progress/in-progress',
|
|
10374
8936
|
path: {
|
|
10375
|
-
'org': org
|
|
10376
|
-
|
|
10377
|
-
},
|
|
10378
|
-
body: requestBody,
|
|
10379
|
-
mediaType: 'application/json'
|
|
8937
|
+
'org': org
|
|
8938
|
+
}
|
|
10380
8939
|
});
|
|
10381
8940
|
}
|
|
10382
8941
|
/**
|
|
10383
|
-
*
|
|
10384
|
-
*
|
|
8942
|
+
* Started means an enrollment
|
|
8943
|
+
*
|
|
8944
|
+
* For platform : Total users who have atleast an enrollment
|
|
8945
|
+
* For course : Total users enrolled
|
|
8946
|
+
* For learner : Total courses in progress
|
|
8947
|
+
*
|
|
8948
|
+
* Query Params
|
|
8949
|
+
* 1. course_id <optional> e.g course-v1:Org+Course4+Run
|
|
8950
|
+
* 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
|
|
8951
|
+
* @returns any No response body
|
|
10385
8952
|
* @throws ApiError
|
|
10386
8953
|
*/
|
|
10387
|
-
static
|
|
10388
|
-
|
|
10389
|
-
org,
|
|
10390
|
-
username
|
|
8954
|
+
static platformOrgsProgressStartedRetrieve({
|
|
8955
|
+
org
|
|
10391
8956
|
}) {
|
|
10392
8957
|
return request(OpenAPI, {
|
|
10393
8958
|
method: 'GET',
|
|
10394
|
-
url: '/api/
|
|
8959
|
+
url: '/api/platform/orgs/{org}/progress/started',
|
|
10395
8960
|
path: {
|
|
10396
|
-
'
|
|
10397
|
-
'org': org,
|
|
10398
|
-
'username': username
|
|
8961
|
+
'org': org
|
|
10399
8962
|
}
|
|
10400
8963
|
});
|
|
10401
8964
|
}
|
|
10402
8965
|
/**
|
|
10403
|
-
*
|
|
10404
|
-
*
|
|
8966
|
+
* Total time spent count on the platform within specified range or all time
|
|
8967
|
+
*
|
|
8968
|
+
* Query Params
|
|
8969
|
+
* 1. start_date e.g 2020-10-01
|
|
8970
|
+
* 2. end_date e.g 2020-10-10
|
|
8971
|
+
*
|
|
8972
|
+
* Default result is all time
|
|
8973
|
+
* @returns any No response body
|
|
10405
8974
|
* @throws ApiError
|
|
10406
8975
|
*/
|
|
10407
|
-
static
|
|
10408
|
-
|
|
10409
|
-
org,
|
|
10410
|
-
username,
|
|
10411
|
-
requestBody
|
|
8976
|
+
static platformOrgsTimeCountRetrieve({
|
|
8977
|
+
org
|
|
10412
8978
|
}) {
|
|
10413
8979
|
return request(OpenAPI, {
|
|
10414
|
-
method: '
|
|
10415
|
-
url: '/api/
|
|
8980
|
+
method: 'GET',
|
|
8981
|
+
url: '/api/platform/orgs/{org}/time/count',
|
|
10416
8982
|
path: {
|
|
10417
|
-
'
|
|
10418
|
-
|
|
10419
|
-
'username': username
|
|
10420
|
-
},
|
|
10421
|
-
body: requestBody,
|
|
10422
|
-
mediaType: 'application/json'
|
|
8983
|
+
'org': org
|
|
8984
|
+
}
|
|
10423
8985
|
});
|
|
10424
8986
|
}
|
|
10425
8987
|
/**
|
|
10426
|
-
*
|
|
10427
|
-
*
|
|
8988
|
+
* Get count of active users on the platform.
|
|
8989
|
+
*
|
|
8990
|
+
* This endpoint returns the number of users who have had activity on the platform,
|
|
8991
|
+
* either for all time or within a specified date range.
|
|
8992
|
+
*
|
|
8993
|
+
* Query Parameters:
|
|
8994
|
+
* start_date (str, optional): Start date for filtering (ISO format)
|
|
8995
|
+
* end_date (str, optional): End date for filtering (ISO format)
|
|
8996
|
+
*
|
|
8997
|
+
* Returns:
|
|
8998
|
+
* The count of active users and change metrics compared to previous periods.
|
|
8999
|
+
*
|
|
9000
|
+
* Default behavior returns the count for all time if no date range is specified.
|
|
9001
|
+
* @returns OverTimeWithTotal
|
|
10428
9002
|
* @throws ApiError
|
|
10429
9003
|
*/
|
|
10430
|
-
static
|
|
10431
|
-
id,
|
|
9004
|
+
static platformOrgsUsersActiveCountRetrieve({
|
|
10432
9005
|
org,
|
|
10433
|
-
|
|
10434
|
-
|
|
9006
|
+
departmentId,
|
|
9007
|
+
endDate,
|
|
9008
|
+
format = 'json',
|
|
9009
|
+
includeMainPlatform = true,
|
|
9010
|
+
startDate
|
|
10435
9011
|
}) {
|
|
10436
9012
|
return request(OpenAPI, {
|
|
10437
|
-
method: '
|
|
10438
|
-
url: '/api/
|
|
9013
|
+
method: 'GET',
|
|
9014
|
+
url: '/api/platform/orgs/{org}/users/active/count',
|
|
10439
9015
|
path: {
|
|
10440
|
-
'
|
|
10441
|
-
'org': org,
|
|
10442
|
-
'username': username
|
|
9016
|
+
'org': org
|
|
10443
9017
|
},
|
|
10444
|
-
|
|
10445
|
-
|
|
9018
|
+
query: {
|
|
9019
|
+
'department_id': departmentId,
|
|
9020
|
+
'end_date': endDate,
|
|
9021
|
+
'format': format,
|
|
9022
|
+
'include_main_platform': includeMainPlatform,
|
|
9023
|
+
'start_date': startDate
|
|
9024
|
+
}
|
|
10446
9025
|
});
|
|
10447
9026
|
}
|
|
10448
9027
|
/**
|
|
10449
|
-
*
|
|
10450
|
-
*
|
|
9028
|
+
* Get count of registered users on the platform.
|
|
9029
|
+
*
|
|
9030
|
+
* This endpoint returns the number of users registered on the platform,
|
|
9031
|
+
* either for all time or within a specified date range.
|
|
9032
|
+
*
|
|
9033
|
+
* Query Parameters:
|
|
9034
|
+
* start_date (str, optional): Start date for filtering (ISO format)
|
|
9035
|
+
* end_date (str, optional): End date for filtering (ISO format)
|
|
9036
|
+
*
|
|
9037
|
+
* Returns:
|
|
9038
|
+
* The count of registered users and change metrics compared to previous periods.
|
|
9039
|
+
*
|
|
9040
|
+
* Default behavior returns the count for all time if no date range is specified.
|
|
9041
|
+
* @returns OverTimeWithTotal
|
|
10451
9042
|
* @throws ApiError
|
|
10452
9043
|
*/
|
|
10453
|
-
static
|
|
10454
|
-
id,
|
|
9044
|
+
static platformOrgsUsersCountRetrieve({
|
|
10455
9045
|
org,
|
|
10456
|
-
|
|
9046
|
+
departmentId,
|
|
9047
|
+
endDate,
|
|
9048
|
+
format = 'json',
|
|
9049
|
+
includeMainPlatform = true,
|
|
9050
|
+
startDate
|
|
10457
9051
|
}) {
|
|
10458
9052
|
return request(OpenAPI, {
|
|
10459
|
-
method: '
|
|
10460
|
-
url: '/api/
|
|
9053
|
+
method: 'GET',
|
|
9054
|
+
url: '/api/platform/orgs/{org}/users/count',
|
|
10461
9055
|
path: {
|
|
10462
|
-
'
|
|
10463
|
-
|
|
10464
|
-
|
|
9056
|
+
'org': org
|
|
9057
|
+
},
|
|
9058
|
+
query: {
|
|
9059
|
+
'department_id': departmentId,
|
|
9060
|
+
'end_date': endDate,
|
|
9061
|
+
'format': format,
|
|
9062
|
+
'include_main_platform': includeMainPlatform,
|
|
9063
|
+
'start_date': startDate
|
|
10465
9064
|
}
|
|
10466
9065
|
});
|
|
10467
9066
|
}
|
|
10468
9067
|
/**
|
|
10469
|
-
*
|
|
10470
|
-
* Filtering and pagination is allowed.
|
|
9068
|
+
* Count of users who have completed a course on the platform within specified range or all time
|
|
10471
9069
|
*
|
|
10472
|
-
*
|
|
10473
|
-
*
|
|
10474
|
-
*
|
|
10475
|
-
*
|
|
10476
|
-
*
|
|
9070
|
+
* Query Params
|
|
9071
|
+
* 1. start_date e.g 2020-10-01
|
|
9072
|
+
* 2. end_date e.g 2020-10-10
|
|
9073
|
+
*
|
|
9074
|
+
* Default is all time
|
|
9075
|
+
* @returns OverTimeWithTotal
|
|
10477
9076
|
* @throws ApiError
|
|
10478
9077
|
*/
|
|
10479
|
-
static
|
|
9078
|
+
static platformOrgsUsersCoursesCompletedCountRetrieve({
|
|
10480
9079
|
org,
|
|
10481
|
-
|
|
9080
|
+
departmentId,
|
|
9081
|
+
endDate,
|
|
9082
|
+
format = 'json',
|
|
9083
|
+
includeMainPlatform = true,
|
|
9084
|
+
startDate
|
|
10482
9085
|
}) {
|
|
10483
9086
|
return request(OpenAPI, {
|
|
10484
9087
|
method: 'GET',
|
|
10485
|
-
url: '/api/
|
|
9088
|
+
url: '/api/platform/orgs/{org}/users/courses-completed/count',
|
|
10486
9089
|
path: {
|
|
10487
|
-
'org': org
|
|
10488
|
-
|
|
9090
|
+
'org': org
|
|
9091
|
+
},
|
|
9092
|
+
query: {
|
|
9093
|
+
'department_id': departmentId,
|
|
9094
|
+
'end_date': endDate,
|
|
9095
|
+
'format': format,
|
|
9096
|
+
'include_main_platform': includeMainPlatform,
|
|
9097
|
+
'start_date': startDate
|
|
10489
9098
|
}
|
|
10490
9099
|
});
|
|
10491
9100
|
}
|
|
@@ -20466,7 +19075,8 @@ class AiPromptService {
|
|
|
20466
19075
|
static aiPromptOrgsUsersSessionsGuidedPromptsRetrieve({
|
|
20467
19076
|
org,
|
|
20468
19077
|
sessionId,
|
|
20469
|
-
userId
|
|
19078
|
+
userId,
|
|
19079
|
+
count = 5
|
|
20470
19080
|
}) {
|
|
20471
19081
|
return request(OpenAPI, {
|
|
20472
19082
|
method: 'GET',
|
|
@@ -20475,6 +19085,9 @@ class AiPromptService {
|
|
|
20475
19085
|
'org': org,
|
|
20476
19086
|
'session_id': sessionId,
|
|
20477
19087
|
'user_id': userId
|
|
19088
|
+
},
|
|
19089
|
+
query: {
|
|
19090
|
+
'count': count
|
|
20478
19091
|
}
|
|
20479
19092
|
});
|
|
20480
19093
|
}
|
|
@@ -35632,8 +34245,6 @@ class SkillsService {
|
|
|
35632
34245
|
|
|
35633
34246
|
exports.AiAccountService = AiAccountService;
|
|
35634
34247
|
exports.AiAnalyticsService = AiAnalyticsService;
|
|
35635
|
-
exports.AiBotService = AiBotService;
|
|
35636
|
-
exports.AiFinetuningService = AiFinetuningService;
|
|
35637
34248
|
exports.AiIndexService = AiIndexService;
|
|
35638
34249
|
exports.AiMarketingService = AiMarketingService;
|
|
35639
34250
|
exports.AiMediaService = AiMediaService;
|