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