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