@iblai/iblai-api 4.5.4-ai-plus → 4.6.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.
Files changed (94) hide show
  1. package/dist/index.cjs.js +382 -1685
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +383 -1684
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +382 -1685
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -39
  8. package/dist/types/models/LtiMentor.d.ts +21 -0
  9. package/dist/types/models/LtiMentorCourseXBlock.d.ts +10 -0
  10. package/dist/types/services/CoreService.d.ts +53 -0
  11. package/package.json +1 -1
  12. package/src/core/OpenAPI.ts +1 -1
  13. package/src/index.ts +2 -39
  14. package/src/models/LtiMentor.ts +26 -0
  15. package/src/models/LtiMentorCourseXBlock.ts +15 -0
  16. package/src/services/CoreService.ts +113 -0
  17. package/dist/types/models/Bot.d.ts +0 -15
  18. package/dist/types/models/BotCommand.d.ts +0 -6
  19. package/dist/types/models/BotCreate.d.ts +0 -12
  20. package/dist/types/models/DataSet.d.ts +0 -21
  21. package/dist/types/models/DataSetCreate.d.ts +0 -12
  22. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  23. package/dist/types/models/DiscordConfig.d.ts +0 -7
  24. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  25. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  26. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  27. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  28. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  29. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  30. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  31. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  32. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  33. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  34. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  35. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  36. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  37. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  38. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  39. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  40. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  41. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  42. package/dist/types/models/SlackConfig.d.ts +0 -8
  43. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  44. package/dist/types/models/SlackWebhook.d.ts +0 -6
  45. package/dist/types/models/TeamsConfig.d.ts +0 -7
  46. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  47. package/dist/types/models/Training.d.ts +0 -41
  48. package/dist/types/models/TrainingCreate.d.ts +0 -31
  49. package/dist/types/models/WebexConfig.d.ts +0 -10
  50. package/dist/types/models/WebexWebhook.d.ts +0 -4
  51. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  52. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  53. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  54. package/dist/types/services/AiBotService.d.ts +0 -642
  55. package/dist/types/services/AiFinetuningService.d.ts +0 -232
  56. package/src/models/Bot.ts +0 -20
  57. package/src/models/BotCommand.ts +0 -11
  58. package/src/models/BotCreate.ts +0 -17
  59. package/src/models/DataSet.ts +0 -26
  60. package/src/models/DataSetCreate.ts +0 -17
  61. package/src/models/DataSetStatusEnum.ts +0 -16
  62. package/src/models/DiscordConfig.ts +0 -12
  63. package/src/models/DiscordUserConfig.ts +0 -15
  64. package/src/models/DiscordWebhook.ts +0 -11
  65. package/src/models/PaginatedDataSetList.ts +0 -12
  66. package/src/models/PaginatedTrainingList.ts +0 -12
  67. package/src/models/PatchedBotCommand.ts +0 -11
  68. package/src/models/PatchedBotCreate.ts +0 -17
  69. package/src/models/PatchedDataSet.ts +0 -26
  70. package/src/models/PatchedDiscordConfig.ts +0 -12
  71. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  72. package/src/models/PatchedSlackConfig.ts +0 -13
  73. package/src/models/PatchedSlackUserConfig.ts +0 -22
  74. package/src/models/PatchedTeamsConfig.ts +0 -12
  75. package/src/models/PatchedTrainingCreate.ts +0 -36
  76. package/src/models/PatchedWebexConfig.ts +0 -15
  77. package/src/models/PatchedWhatsappConfig.ts +0 -16
  78. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  79. package/src/models/Provider05cEnum.ts +0 -18
  80. package/src/models/Provider63aEnum.ts +0 -10
  81. package/src/models/SlackConfig.ts +0 -13
  82. package/src/models/SlackUserConfig.ts +0 -22
  83. package/src/models/SlackWebhook.ts +0 -11
  84. package/src/models/TeamsConfig.ts +0 -12
  85. package/src/models/TeamsWebhook.ts +0 -22
  86. package/src/models/Training.ts +0 -46
  87. package/src/models/TrainingCreate.ts +0 -36
  88. package/src/models/WebexConfig.ts +0 -15
  89. package/src/models/WebexWebhook.ts +0 -9
  90. package/src/models/WhatAppWebHook.ts +0 -8
  91. package/src/models/WhatsappConfig.ts +0 -16
  92. package/src/models/WhatsappUserConfig.ts +0 -15
  93. package/src/services/AiBotService.ts +0 -1330
  94. 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: '4.5.4-ai-plus',
111
+ VERSION: '4.6.0-ai',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
@@ -269,24 +269,6 @@ var CrawlerPatternTypeEnum;
269
269
  CrawlerPatternTypeEnum["REGEX"] = "regex";
270
270
  })(CrawlerPatternTypeEnum || (CrawlerPatternTypeEnum = {}));
271
271
 
272
- /* generated using openapi-typescript-codegen -- do not edit */
273
- /* istanbul ignore file */
274
- /* tslint:disable */
275
- /* eslint-disable */
276
- /**
277
- * * `pending` - Pending
278
- * * `processing` - Processing
279
- * * `completed` - Completed
280
- * * `failed` - Failed
281
- */
282
- var DataSetStatusEnum;
283
- (function (DataSetStatusEnum) {
284
- DataSetStatusEnum["PENDING"] = "pending";
285
- DataSetStatusEnum["PROCESSING"] = "processing";
286
- DataSetStatusEnum["COMPLETED"] = "completed";
287
- DataSetStatusEnum["FAILED"] = "failed";
288
- })(DataSetStatusEnum || (DataSetStatusEnum = {}));
289
-
290
272
  /* generated using openapi-typescript-codegen -- do not edit */
291
273
  /* istanbul ignore file */
292
274
  /* tslint:disable */
@@ -583,26 +565,6 @@ var PromptVisibilityEnum;
583
565
  PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
584
566
  })(PromptVisibilityEnum || (PromptVisibilityEnum = {}));
585
567
 
586
- /* generated using openapi-typescript-codegen -- do not edit */
587
- /* istanbul ignore file */
588
- /* tslint:disable */
589
- /* eslint-disable */
590
- /**
591
- * * `webex` - Webex
592
- * * `slack` - Slack
593
- * * `whatsapp` - Whatsapp
594
- * * `discord` - Discord
595
- * * `teams` - Teams
596
- */
597
- var Provider05cEnum;
598
- (function (Provider05cEnum) {
599
- Provider05cEnum["WEBEX"] = "webex";
600
- Provider05cEnum["SLACK"] = "slack";
601
- Provider05cEnum["WHATSAPP"] = "whatsapp";
602
- Provider05cEnum["DISCORD"] = "discord";
603
- Provider05cEnum["TEAMS"] = "teams";
604
- })(Provider05cEnum || (Provider05cEnum = {}));
605
-
606
568
  /* generated using openapi-typescript-codegen -- do not edit */
607
569
  /* istanbul ignore file */
608
570
  /* tslint:disable */
@@ -619,18 +581,6 @@ var Provider637Enum;
619
581
  Provider637Enum["ELEVENLABS"] = "elevenlabs";
620
582
  })(Provider637Enum || (Provider637Enum = {}));
621
583
 
622
- /* generated using openapi-typescript-codegen -- do not edit */
623
- /* istanbul ignore file */
624
- /* tslint:disable */
625
- /* eslint-disable */
626
- /**
627
- * * `openai` - Openai
628
- */
629
- var Provider63aEnum;
630
- (function (Provider63aEnum) {
631
- Provider63aEnum["OPENAI"] = "openai";
632
- })(Provider63aEnum || (Provider63aEnum = {}));
633
-
634
584
  /* generated using openapi-typescript-codegen -- do not edit */
635
585
  /* istanbul ignore file */
636
586
  /* tslint:disable */
@@ -8765,1795 +8715,454 @@ class AiAnalyticsService {
8765
8715
  return request(OpenAPI, {
8766
8716
  method: 'GET',
8767
8717
  url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/grades/passed',
8768
- path: {
8769
- 'course_id': courseId,
8770
- 'org': org,
8771
- 'user_id': userId
8772
- }
8773
- });
8774
- }
8775
- /**
8776
- * Gives Percentage of units completed in course for a specific learner
8777
- * @returns PerlearnerCourseProgress
8778
- * @throws ApiError
8779
- */
8780
- static platformOrgsCoursesUsersProgressRetrieve({
8781
- courseId,
8782
- org,
8783
- userId,
8784
- departmentId,
8785
- format = 'json',
8786
- includeMainPlatform = true
8787
- }) {
8788
- return request(OpenAPI, {
8789
- method: 'GET',
8790
- url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
8791
- path: {
8792
- 'course_id': courseId,
8793
- 'org': org,
8794
- 'user_id': userId
8795
- },
8796
- query: {
8797
- 'department_id': departmentId,
8798
- 'format': format,
8799
- 'include_main_platform': includeMainPlatform
8800
- }
8801
- });
8802
- }
8803
- /**
8804
- * Average days used to complete a course
8805
- *
8806
- * Query Params
8807
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
8808
- * @returns any No response body
8809
- * @throws ApiError
8810
- */
8811
- static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({
8812
- courseId,
8813
- org,
8814
- userId
8815
- }) {
8816
- return request(OpenAPI, {
8817
- method: 'GET',
8818
- url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
8819
- path: {
8820
- 'course_id': courseId,
8821
- 'org': org,
8822
- 'user_id': userId
8823
- }
8824
- });
8825
- }
8826
- /**
8827
- * Time spent count in seconds within a course by a learner
8828
- * @returns Count
8829
- * @throws ApiError
8830
- */
8831
- static platformOrgsCoursesUsersTimeCountRetrieve({
8832
- courseId,
8833
- org,
8834
- userId,
8835
- departmentId,
8836
- endDate,
8837
- format = 'json',
8838
- includeMainPlatform = true,
8839
- startDate
8840
- }) {
8841
- return request(OpenAPI, {
8842
- method: 'GET',
8843
- url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
8844
- path: {
8845
- 'course_id': courseId,
8846
- 'org': org,
8847
- 'user_id': userId
8848
- },
8849
- query: {
8850
- 'department_id': departmentId,
8851
- 'end_date': endDate,
8852
- 'format': format,
8853
- 'include_main_platform': includeMainPlatform,
8854
- 'start_date': startDate
8855
- }
8856
- });
8857
- }
8858
- /**
8859
- * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
8860
- * @returns VideosCount
8861
- * @throws ApiError
8862
- */
8863
- static platformOrgsCoursesUsersVideosCountRetrieve({
8864
- courseId,
8865
- org,
8866
- userId,
8867
- departmentId,
8868
- format = 'json',
8869
- includeMainPlatform = true
8870
- }) {
8871
- return request(OpenAPI, {
8872
- method: 'GET',
8873
- url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
8874
- path: {
8875
- 'course_id': courseId,
8876
- 'org': org,
8877
- 'user_id': userId
8878
- },
8879
- query: {
8880
- 'department_id': departmentId,
8881
- 'format': format,
8882
- 'include_main_platform': includeMainPlatform
8883
- }
8884
- });
8885
- }
8886
- /**
8887
- * Count of total videos in a course
8888
- *
8889
- * Query Params
8890
- * course_id e.g course-v1:Org+Course4+Run
8891
- * @returns any No response body
8892
- * @throws ApiError
8893
- */
8894
- static platformOrgsCoursesVideosRetrieve2({
8895
- courseId,
8896
- org
8897
- }) {
8898
- return request(OpenAPI, {
8899
- method: 'GET',
8900
- url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
8901
- path: {
8902
- 'course_id': courseId,
8903
- 'org': org
8904
- }
8905
- });
8906
- }
8907
- /**
8908
- * Get total count of courses on the platform.
8909
- *
8910
- * This endpoint returns the total number of courses available on the platform.
8911
- *
8912
- * Returns:
8913
- * The total count of courses on the platform.
8914
- * @returns Count
8915
- * @throws ApiError
8916
- */
8917
- static platformOrgsCoursesCountRetrieve({
8918
- org,
8919
- departmentId,
8920
- format = 'json',
8921
- includeMainPlatform = true
8922
- }) {
8923
- return request(OpenAPI, {
8924
- method: 'GET',
8925
- url: '/api/platform/orgs/{org}/courses/count',
8926
- path: {
8927
- 'org': org
8928
- },
8929
- query: {
8930
- 'department_id': departmentId,
8931
- 'format': format,
8932
- 'include_main_platform': includeMainPlatform
8933
- }
8934
- });
8935
- }
8936
- /**
8937
- * List grading information on a per-course basis.
8938
- *
8939
- * This endpoint provides grading statistics for all courses, including
8940
- * average grades and completion rates.
8941
- *
8942
- * Returns:
8943
- * A list of courses with their associated grading metrics.
8944
- * @returns any No response body
8945
- * @throws ApiError
8946
- */
8947
- static platformOrgsCoursesGradesRetrieve({
8948
- org
8949
- }) {
8950
- return request(OpenAPI, {
8951
- method: 'GET',
8952
- url: '/api/platform/orgs/{org}/courses/grades',
8953
- path: {
8954
- 'org': org
8955
- }
8956
- });
8957
- }
8958
- /**
8959
- * Get video watch statistics on a per-course basis.
8960
- *
8961
- * This endpoint provides a list of courses with aggregated video watch metrics,
8962
- * including total views and completion percentages.
8963
- *
8964
- * Returns:
8965
- * A list of courses with:
8966
- * - Course identification (ID and name)
8967
- * - Video watch count
8968
- * - Percentage of total videos watched
8969
- * @returns WatchedVideosPerCourse
8970
- * @throws ApiError
8971
- */
8972
- static platformOrgsCoursesVideosRetrieve({
8973
- org,
8974
- departmentId,
8975
- format = 'json',
8976
- includeMainPlatform = true
8977
- }) {
8978
- return request(OpenAPI, {
8979
- method: 'GET',
8980
- url: '/api/platform/orgs/{org}/courses/videos',
8981
- path: {
8982
- 'org': org
8983
- },
8984
- query: {
8985
- 'department_id': departmentId,
8986
- 'format': format,
8987
- 'include_main_platform': includeMainPlatform
8988
- }
8989
- });
8990
- }
8991
- /**
8992
- * Get completion count statistics.
8993
- *
8994
- * This endpoint returns completion counts at different levels:
8995
- * - Platform level: Total users who have completed at least one course
8996
- * - Course level: Total completions for a specific course
8997
- * - Learner level: Total courses completed by a specific learner
8998
- *
8999
- * Query Parameters:
9000
- * course_id (str, optional): Filter by course ID
9001
- * user_id (str, optional): Filter by username or email
9002
- *
9003
- * Returns:
9004
- * A count of completions based on the specified filters.
9005
- * @returns any No response body
9006
- * @throws ApiError
9007
- */
9008
- static platformOrgsProgressCompletedRetrieve({
9009
- org
9010
- }) {
9011
- return request(OpenAPI, {
9012
- method: 'GET',
9013
- url: '/api/platform/orgs/{org}/progress/completed',
9014
- path: {
9015
- 'org': org
9016
- }
9017
- });
9018
- }
9019
- /**
9020
- * Average of total completed units
9021
- * @returns any No response body
9022
- * @throws ApiError
9023
- */
9024
- static platformOrgsProgressCompletionRateRetrieve({
9025
- org
9026
- }) {
9027
- return request(OpenAPI, {
9028
- method: 'GET',
9029
- url: '/api/platform/orgs/{org}/progress/completion-rate',
9030
- path: {
9031
- 'org': org
9032
- }
9033
- });
9034
- }
9035
- /**
9036
- * In Progress means any unit completion in the past 30 days
9037
- *
9038
- * For platform : Total users who have atleast a course in_progress on the platform
9039
- * For course : Total users
9040
- * For learner : Total courses in progress
9041
- *
9042
- * Query Params
9043
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
9044
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
9045
- * @returns any No response body
9046
- * @throws ApiError
9047
- */
9048
- static platformOrgsProgressInProgressRetrieve({
9049
- org
9050
- }) {
9051
- return request(OpenAPI, {
9052
- method: 'GET',
9053
- url: '/api/platform/orgs/{org}/progress/in-progress',
9054
- path: {
9055
- 'org': org
9056
- }
9057
- });
9058
- }
9059
- /**
9060
- * Started means an enrollment
9061
- *
9062
- * For platform : Total users who have atleast an enrollment
9063
- * For course : Total users enrolled
9064
- * For learner : Total courses in progress
9065
- *
9066
- * Query Params
9067
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
9068
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
9069
- * @returns any No response body
9070
- * @throws ApiError
9071
- */
9072
- static platformOrgsProgressStartedRetrieve({
9073
- org
9074
- }) {
9075
- return request(OpenAPI, {
9076
- method: 'GET',
9077
- url: '/api/platform/orgs/{org}/progress/started',
9078
- path: {
9079
- 'org': org
9080
- }
9081
- });
9082
- }
9083
- /**
9084
- * Total time spent count on the platform within specified range or all time
9085
- *
9086
- * Query Params
9087
- * 1. start_date e.g 2020-10-01
9088
- * 2. end_date e.g 2020-10-10
9089
- *
9090
- * Default result is all time
9091
- * @returns any No response body
9092
- * @throws ApiError
9093
- */
9094
- static platformOrgsTimeCountRetrieve({
9095
- org
9096
- }) {
9097
- return request(OpenAPI, {
9098
- method: 'GET',
9099
- url: '/api/platform/orgs/{org}/time/count',
9100
- path: {
9101
- 'org': org
9102
- }
9103
- });
9104
- }
9105
- /**
9106
- * Get count of active users on the platform.
9107
- *
9108
- * This endpoint returns the number of users who have had activity on the platform,
9109
- * either for all time or within a specified date range.
9110
- *
9111
- * Query Parameters:
9112
- * start_date (str, optional): Start date for filtering (ISO format)
9113
- * end_date (str, optional): End date for filtering (ISO format)
9114
- *
9115
- * Returns:
9116
- * The count of active users and change metrics compared to previous periods.
9117
- *
9118
- * Default behavior returns the count for all time if no date range is specified.
9119
- * @returns OverTimeWithTotal
9120
- * @throws ApiError
9121
- */
9122
- static platformOrgsUsersActiveCountRetrieve({
9123
- org,
9124
- departmentId,
9125
- endDate,
9126
- format = 'json',
9127
- includeMainPlatform = true,
9128
- startDate
9129
- }) {
9130
- return request(OpenAPI, {
9131
- method: 'GET',
9132
- url: '/api/platform/orgs/{org}/users/active/count',
9133
- path: {
9134
- 'org': org
9135
- },
9136
- query: {
9137
- 'department_id': departmentId,
9138
- 'end_date': endDate,
9139
- 'format': format,
9140
- 'include_main_platform': includeMainPlatform,
9141
- 'start_date': startDate
9142
- }
9143
- });
9144
- }
9145
- /**
9146
- * Get count of registered users on the platform.
9147
- *
9148
- * This endpoint returns the number of users registered on the platform,
9149
- * either for all time or within a specified date range.
9150
- *
9151
- * Query Parameters:
9152
- * start_date (str, optional): Start date for filtering (ISO format)
9153
- * end_date (str, optional): End date for filtering (ISO format)
9154
- *
9155
- * Returns:
9156
- * The count of registered users and change metrics compared to previous periods.
9157
- *
9158
- * Default behavior returns the count for all time if no date range is specified.
9159
- * @returns OverTimeWithTotal
9160
- * @throws ApiError
9161
- */
9162
- static platformOrgsUsersCountRetrieve({
9163
- org,
9164
- departmentId,
9165
- endDate,
9166
- format = 'json',
9167
- includeMainPlatform = true,
9168
- startDate
9169
- }) {
9170
- return request(OpenAPI, {
9171
- method: 'GET',
9172
- url: '/api/platform/orgs/{org}/users/count',
9173
- path: {
9174
- 'org': org
9175
- },
9176
- query: {
9177
- 'department_id': departmentId,
9178
- 'end_date': endDate,
9179
- 'format': format,
9180
- 'include_main_platform': includeMainPlatform,
9181
- 'start_date': startDate
9182
- }
9183
- });
9184
- }
9185
- /**
9186
- * Count of users who have completed a course on the platform within specified range or all time
9187
- *
9188
- * Query Params
9189
- * 1. start_date e.g 2020-10-01
9190
- * 2. end_date e.g 2020-10-10
9191
- *
9192
- * Default is all time
9193
- * @returns OverTimeWithTotal
9194
- * @throws ApiError
9195
- */
9196
- static platformOrgsUsersCoursesCompletedCountRetrieve({
9197
- org,
9198
- departmentId,
9199
- endDate,
9200
- format = 'json',
9201
- includeMainPlatform = true,
9202
- startDate
9203
- }) {
9204
- return request(OpenAPI, {
9205
- method: 'GET',
9206
- url: '/api/platform/orgs/{org}/users/courses-completed/count',
9207
- path: {
9208
- 'org': org
9209
- },
9210
- query: {
9211
- 'department_id': departmentId,
9212
- 'end_date': endDate,
9213
- 'format': format,
9214
- 'include_main_platform': includeMainPlatform,
9215
- 'start_date': startDate
9216
- }
9217
- });
9218
- }
9219
- }
9220
-
9221
- class AiBotService {
9222
- /**
9223
- * Create modify and update bot information for a specific tenant.
9224
- * @returns Bot
9225
- * @throws ApiError
9226
- */
9227
- static aiBotV1BotsBotList({
9228
- org
9229
- }) {
9230
- return request(OpenAPI, {
9231
- method: 'GET',
9232
- url: '/api/ai-bot/v1/bots/{org}/bot/',
9233
- path: {
9234
- 'org': org
9235
- }
9236
- });
9237
- }
9238
- /**
9239
- * Create modify and update bot information for a specific tenant.
9240
- * @returns BotCreate
9241
- * @throws ApiError
9242
- */
9243
- static aiBotV1BotsBotCreate({
9244
- org,
9245
- requestBody
9246
- }) {
9247
- return request(OpenAPI, {
9248
- method: 'POST',
9249
- url: '/api/ai-bot/v1/bots/{org}/bot/',
9250
- path: {
9251
- 'org': org
9252
- },
9253
- body: requestBody,
9254
- mediaType: 'application/json'
9255
- });
9256
- }
9257
- /**
9258
- * Create slash commands for a specific bot
9259
- * eg. /iblai-baseline
9260
- * @returns BotCommand
9261
- * @throws ApiError
9262
- */
9263
- static aiBotV1BotsBotCommandsList({
9264
- org
9265
- }) {
9266
- return request(OpenAPI, {
9267
- method: 'GET',
9268
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
9269
- path: {
9270
- 'org': org
9271
- }
9272
- });
9273
- }
9274
- /**
9275
- * Create slash commands for a specific bot
9276
- * eg. /iblai-baseline
9277
- * @returns BotCommand
9278
- * @throws ApiError
9279
- */
9280
- static aiBotV1BotsBotCommandsCreate({
9281
- org,
9282
- requestBody
9283
- }) {
9284
- return request(OpenAPI, {
9285
- method: 'POST',
9286
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
9287
- path: {
9288
- 'org': org
9289
- },
9290
- body: requestBody,
9291
- mediaType: 'application/json'
9292
- });
9293
- }
9294
- /**
9295
- * Create slash commands for a specific bot
9296
- * eg. /iblai-baseline
9297
- * @returns BotCommand
9298
- * @throws ApiError
9299
- */
9300
- static aiBotV1BotsBotCommandsRetrieve({
9301
- id,
9302
- org
9303
- }) {
9304
- return request(OpenAPI, {
9305
- method: 'GET',
9306
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9307
- path: {
9308
- 'id': id,
9309
- 'org': org
9310
- }
9311
- });
9312
- }
9313
- /**
9314
- * Create slash commands for a specific bot
9315
- * eg. /iblai-baseline
9316
- * @returns BotCommand
9317
- * @throws ApiError
9318
- */
9319
- static aiBotV1BotsBotCommandsUpdate({
9320
- id,
9321
- org,
9322
- requestBody
9323
- }) {
9324
- return request(OpenAPI, {
9325
- method: 'PUT',
9326
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9327
- path: {
9328
- 'id': id,
9329
- 'org': org
9330
- },
9331
- body: requestBody,
9332
- mediaType: 'application/json'
9333
- });
9334
- }
9335
- /**
9336
- * Create slash commands for a specific bot
9337
- * eg. /iblai-baseline
9338
- * @returns BotCommand
9339
- * @throws ApiError
9340
- */
9341
- static aiBotV1BotsBotCommandsPartialUpdate({
9342
- id,
9343
- org,
9344
- requestBody
9345
- }) {
9346
- return request(OpenAPI, {
9347
- method: 'PATCH',
9348
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9349
- path: {
9350
- 'id': id,
9351
- 'org': org
9352
- },
9353
- body: requestBody,
9354
- mediaType: 'application/json'
9355
- });
9356
- }
9357
- /**
9358
- * Create slash commands for a specific bot
9359
- * eg. /iblai-baseline
9360
- * @returns void
9361
- * @throws ApiError
9362
- */
9363
- static aiBotV1BotsBotCommandsDestroy({
9364
- id,
9365
- org
9366
- }) {
9367
- return request(OpenAPI, {
9368
- method: 'DELETE',
9369
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9370
- path: {
9371
- 'id': id,
9372
- 'org': org
9373
- }
9374
- });
9375
- }
9376
- /**
9377
- * Create modify and update bot information for a specific tenant.
9378
- * @returns Bot
9379
- * @throws ApiError
9380
- */
9381
- static aiBotV1BotsBotRetrieve({
9382
- id,
9383
- org
9384
- }) {
9385
- return request(OpenAPI, {
9386
- method: 'GET',
9387
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9388
- path: {
9389
- 'id': id,
9390
- 'org': org
9391
- }
9392
- });
9393
- }
9394
- /**
9395
- * Create modify and update bot information for a specific tenant.
9396
- * @returns BotCreate
9397
- * @throws ApiError
9398
- */
9399
- static aiBotV1BotsBotUpdate({
9400
- id,
9401
- org,
9402
- requestBody
9403
- }) {
9404
- return request(OpenAPI, {
9405
- method: 'PUT',
9406
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9407
- path: {
9408
- 'id': id,
9409
- 'org': org
9410
- },
9411
- body: requestBody,
9412
- mediaType: 'application/json'
9413
- });
9414
- }
9415
- /**
9416
- * Create modify and update bot information for a specific tenant.
9417
- * @returns BotCreate
9418
- * @throws ApiError
9419
- */
9420
- static aiBotV1BotsBotPartialUpdate({
9421
- id,
9422
- org,
9423
- requestBody
9424
- }) {
9425
- return request(OpenAPI, {
9426
- method: 'PATCH',
9427
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9428
- path: {
9429
- 'id': id,
9430
- 'org': org
9431
- },
9432
- body: requestBody,
9433
- mediaType: 'application/json'
9434
- });
9435
- }
9436
- /**
9437
- * Create modify and update bot information for a specific tenant.
9438
- * @returns void
9439
- * @throws ApiError
9440
- */
9441
- static aiBotV1BotsBotDestroy({
9442
- id,
9443
- org
9444
- }) {
9445
- return request(OpenAPI, {
9446
- method: 'DELETE',
9447
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9448
- path: {
9449
- 'id': id,
9450
- 'org': org
9451
- }
9452
- });
9453
- }
9454
- /**
9455
- * Create modify and update bot information for a specific tenant.
9456
- * @returns DiscordConfig
9457
- * @throws ApiError
9458
- */
9459
- static aiBotV1BotsBotConfigDiscordRetrieve({
9460
- id,
9461
- org
9462
- }) {
9463
- return request(OpenAPI, {
9464
- method: 'GET',
9465
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
9466
- path: {
9467
- 'id': id,
9468
- 'org': org
9469
- }
9470
- });
9471
- }
9472
- /**
9473
- * Create modify and update bot information for a specific tenant.
9474
- * @returns DiscordConfig
9475
- * @throws ApiError
9476
- */
9477
- static aiBotV1BotsBotConfigDiscordPartialUpdate({
9478
- id,
9479
- org,
9480
- requestBody
9481
- }) {
9482
- return request(OpenAPI, {
9483
- method: 'PATCH',
9484
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
9485
- path: {
9486
- 'id': id,
9487
- 'org': org
9488
- },
9489
- body: requestBody,
9490
- mediaType: 'application/json'
9491
- });
9492
- }
9493
- /**
9494
- * Create modify and update bot information for a specific tenant.
9495
- * @returns SlackConfig
9496
- * @throws ApiError
9497
- */
9498
- static aiBotV1BotsBotConfigSlackRetrieve({
9499
- id,
9500
- org
9501
- }) {
9502
- return request(OpenAPI, {
9503
- method: 'GET',
9504
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
9505
- path: {
9506
- 'id': id,
9507
- 'org': org
9508
- }
9509
- });
9510
- }
9511
- /**
9512
- * Create modify and update bot information for a specific tenant.
9513
- * @returns SlackConfig
9514
- * @throws ApiError
9515
- */
9516
- static aiBotV1BotsBotConfigSlackUpdateCreate({
9517
- id,
9518
- org,
9519
- requestBody
9520
- }) {
9521
- return request(OpenAPI, {
9522
- method: 'POST',
9523
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9524
- path: {
9525
- 'id': id,
9526
- 'org': org
9527
- },
9528
- body: requestBody,
9529
- mediaType: 'application/json'
9530
- });
9531
- }
9532
- /**
9533
- * Create modify and update bot information for a specific tenant.
9534
- * @returns SlackConfig
9535
- * @throws ApiError
9536
- */
9537
- static aiBotV1BotsBotConfigSlackUpdateUpdate({
9538
- id,
9539
- org,
9540
- requestBody
9541
- }) {
9542
- return request(OpenAPI, {
9543
- method: 'PUT',
9544
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9545
- path: {
9546
- 'id': id,
9547
- 'org': org
9548
- },
9549
- body: requestBody,
9550
- mediaType: 'application/json'
9551
- });
9552
- }
9553
- /**
9554
- * Create modify and update bot information for a specific tenant.
9555
- * @returns SlackConfig
9556
- * @throws ApiError
9557
- */
9558
- static aiBotV1BotsBotConfigSlackUpdatePartialUpdate({
9559
- id,
9560
- org,
9561
- requestBody
9562
- }) {
9563
- return request(OpenAPI, {
9564
- method: 'PATCH',
9565
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9566
- path: {
9567
- 'id': id,
9568
- 'org': org
9569
- },
9570
- body: requestBody,
9571
- mediaType: 'application/json'
9572
- });
9573
- }
9574
- /**
9575
- * Create modify and update bot information for a specific tenant.
9576
- * @returns TeamsConfig
9577
- * @throws ApiError
9578
- */
9579
- static aiBotV1BotsBotConfigTeamsRetrieve({
9580
- id,
9581
- org
9582
- }) {
9583
- return request(OpenAPI, {
9584
- method: 'GET',
9585
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
9586
- path: {
9587
- 'id': id,
9588
- 'org': org
9589
- }
9590
- });
9591
- }
9592
- /**
9593
- * Create modify and update bot information for a specific tenant.
9594
- * @returns TeamsConfig
9595
- * @throws ApiError
9596
- */
9597
- static aiBotV1BotsBotConfigTeamsUpdateCreate({
9598
- id,
9599
- org,
9600
- requestBody
9601
- }) {
9602
- return request(OpenAPI, {
9603
- method: 'POST',
9604
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9605
- path: {
9606
- 'id': id,
9607
- 'org': org
9608
- },
9609
- body: requestBody,
9610
- mediaType: 'application/json'
9611
- });
9612
- }
9613
- /**
9614
- * Create modify and update bot information for a specific tenant.
9615
- * @returns TeamsConfig
9616
- * @throws ApiError
9617
- */
9618
- static aiBotV1BotsBotConfigTeamsUpdateUpdate({
9619
- id,
9620
- org,
9621
- requestBody
9622
- }) {
9623
- return request(OpenAPI, {
9624
- method: 'PUT',
9625
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9626
- path: {
9627
- 'id': id,
9628
- 'org': org
9629
- },
9630
- body: requestBody,
9631
- mediaType: 'application/json'
9632
- });
9633
- }
9634
- /**
9635
- * Create modify and update bot information for a specific tenant.
9636
- * @returns TeamsConfig
9637
- * @throws ApiError
9638
- */
9639
- static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate({
9640
- id,
9641
- org,
9642
- requestBody
9643
- }) {
9644
- return request(OpenAPI, {
9645
- method: 'PATCH',
9646
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9647
- path: {
9648
- 'id': id,
9649
- 'org': org
9650
- },
9651
- body: requestBody,
9652
- mediaType: 'application/json'
9653
- });
9654
- }
9655
- /**
9656
- * Create modify and update bot information for a specific tenant.
9657
- * @returns WebexConfig
9658
- * @throws ApiError
9659
- */
9660
- static aiBotV1BotsBotConfigWebexRetrieve({
9661
- id,
9662
- org
9663
- }) {
9664
- return request(OpenAPI, {
9665
- method: 'GET',
9666
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
9667
- path: {
9668
- 'id': id,
9669
- 'org': org
9670
- }
9671
- });
9672
- }
9673
- /**
9674
- * Create modify and update bot information for a specific tenant.
9675
- * @returns WebexConfig
9676
- * @throws ApiError
9677
- */
9678
- static aiBotV1BotsBotConfigWebexPartialUpdate({
9679
- id,
9680
- org,
9681
- requestBody
9682
- }) {
9683
- return request(OpenAPI, {
9684
- method: 'PATCH',
9685
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
9686
- path: {
9687
- 'id': id,
9688
- 'org': org
9689
- },
9690
- body: requestBody,
9691
- mediaType: 'application/json'
9692
- });
9693
- }
9694
- /**
9695
- * Create modify and update bot information for a specific tenant.
9696
- * @returns WhatsappConfig
9697
- * @throws ApiError
9698
- */
9699
- static aiBotV1BotsBotConfigWhatsappRetrieve({
9700
- id,
9701
- org
9702
- }) {
9703
- return request(OpenAPI, {
9704
- method: 'GET',
9705
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
9706
- path: {
9707
- 'id': id,
9708
- 'org': org
9709
- }
9710
- });
9711
- }
9712
- /**
9713
- * Create modify and update bot information for a specific tenant.
9714
- * @returns WhatsappConfig
9715
- * @throws ApiError
9716
- */
9717
- static aiBotV1BotsBotWhatsappConfigUpdate({
9718
- id,
9719
- org,
9720
- requestBody
9721
- }) {
9722
- return request(OpenAPI, {
9723
- method: 'PUT',
9724
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
9725
- path: {
9726
- 'id': id,
9727
- 'org': org
9728
- },
9729
- body: requestBody,
9730
- mediaType: 'application/json'
9731
- });
9732
- }
9733
- /**
9734
- * Create modify and update bot information for a specific tenant.
9735
- * @returns WhatsappConfig
9736
- * @throws ApiError
9737
- */
9738
- static aiBotV1BotsBotWhatsappConfigPartialUpdate({
9739
- id,
9740
- org,
9741
- requestBody
9742
- }) {
9743
- return request(OpenAPI, {
9744
- method: 'PATCH',
9745
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
9746
- path: {
9747
- 'id': id,
9748
- 'org': org
9749
- },
9750
- body: requestBody,
9751
- mediaType: 'application/json'
9752
- });
9753
- }
9754
- /**
9755
- * Setup discord user id linkage with discord bots
9756
- * this will be used to authenticate the user when interracting with discord bots.
9757
- * the user id can be copied from the discord app after tapping on the user profile.
9758
- * @returns DiscordUserConfig
9759
- * @throws ApiError
9760
- */
9761
- static aiBotV1BotsDiscordUserConfigList({
9762
- org
9763
- }) {
9764
- return request(OpenAPI, {
9765
- method: 'GET',
9766
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
9767
- path: {
9768
- 'org': org
9769
- }
9770
- });
9771
- }
9772
- /**
9773
- * Setup discord user id linkage with discord bots
9774
- * this will be used to authenticate the user when interracting with discord bots.
9775
- * the user id can be copied from the discord app after tapping on the user profile.
9776
- * @returns DiscordUserConfig
9777
- * @throws ApiError
9778
- */
9779
- static aiBotV1BotsDiscordUserConfigCreate({
9780
- org,
9781
- requestBody
9782
- }) {
9783
- return request(OpenAPI, {
9784
- method: 'POST',
9785
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
9786
- path: {
9787
- 'org': org
9788
- },
9789
- body: requestBody,
9790
- mediaType: 'application/json'
9791
- });
9792
- }
9793
- /**
9794
- * Setup discord user id linkage with discord bots
9795
- * this will be used to authenticate the user when interracting with discord bots.
9796
- * the user id can be copied from the discord app after tapping on the user profile.
9797
- * @returns DiscordUserConfig
9798
- * @throws ApiError
9799
- */
9800
- static aiBotV1BotsDiscordUserConfigRetrieve({
9801
- id,
9802
- org
9803
- }) {
9804
- return request(OpenAPI, {
9805
- method: 'GET',
9806
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9807
- path: {
9808
- 'id': id,
9809
- 'org': org
9810
- }
9811
- });
9812
- }
9813
- /**
9814
- * Setup discord user id linkage with discord bots
9815
- * this will be used to authenticate the user when interracting with discord bots.
9816
- * the user id can be copied from the discord app after tapping on the user profile.
9817
- * @returns DiscordUserConfig
9818
- * @throws ApiError
9819
- */
9820
- static aiBotV1BotsDiscordUserConfigUpdate({
9821
- id,
9822
- org,
9823
- requestBody
9824
- }) {
9825
- return request(OpenAPI, {
9826
- method: 'PUT',
9827
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9828
- path: {
9829
- 'id': id,
9830
- 'org': org
9831
- },
9832
- body: requestBody,
9833
- mediaType: 'application/json'
9834
- });
9835
- }
9836
- /**
9837
- * Setup discord user id linkage with discord bots
9838
- * this will be used to authenticate the user when interracting with discord bots.
9839
- * the user id can be copied from the discord app after tapping on the user profile.
9840
- * @returns DiscordUserConfig
9841
- * @throws ApiError
9842
- */
9843
- static aiBotV1BotsDiscordUserConfigPartialUpdate({
9844
- id,
9845
- org,
9846
- requestBody
9847
- }) {
9848
- return request(OpenAPI, {
9849
- method: 'PATCH',
9850
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9851
- path: {
9852
- 'id': id,
9853
- 'org': org
9854
- },
9855
- body: requestBody,
9856
- mediaType: 'application/json'
9857
- });
9858
- }
9859
- /**
9860
- * Setup discord user id linkage with discord bots
9861
- * this will be used to authenticate the user when interracting with discord bots.
9862
- * the user id can be copied from the discord app after tapping on the user profile.
9863
- * @returns void
9864
- * @throws ApiError
9865
- */
9866
- static aiBotV1BotsDiscordUserConfigDestroy({
9867
- id,
9868
- org
9869
- }) {
9870
- return request(OpenAPI, {
9871
- method: 'DELETE',
9872
- url: '/api/ai-bot/v1/bots/{org}/discord-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 aiBotV1BotsSlackUserConfigList({
9886
- org
9887
- }) {
9888
- return request(OpenAPI, {
9889
- method: 'GET',
9890
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
9891
- path: {
9892
- 'org': org
9893
- }
9894
- });
9895
- }
9896
- /**
9897
- * Setup slack username and domain linkage with slack bots
9898
- * this will be used to authenticate the user when interracting with slack bots.
9899
- * @returns SlackUserConfig
9900
- * @throws ApiError
9901
- */
9902
- static aiBotV1BotsSlackUserConfigCreate({
9903
- org,
9904
- requestBody
9905
- }) {
9906
- return request(OpenAPI, {
9907
- method: 'POST',
9908
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
9909
- path: {
9910
- 'org': org
9911
- },
9912
- body: requestBody,
9913
- mediaType: 'application/json'
9914
- });
9915
- }
9916
- /**
9917
- * Setup slack username and domain linkage with slack bots
9918
- * this will be used to authenticate the user when interracting with slack bots.
9919
- * @returns SlackUserConfig
9920
- * @throws ApiError
9921
- */
9922
- static aiBotV1BotsSlackUserConfigRetrieve({
9923
- id,
9924
- org
9925
- }) {
9926
- return request(OpenAPI, {
9927
- method: 'GET',
9928
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9929
- path: {
9930
- 'id': id,
9931
- 'org': org
9932
- }
9933
- });
9934
- }
9935
- /**
9936
- * Setup slack username and domain linkage with slack bots
9937
- * this will be used to authenticate the user when interracting with slack bots.
9938
- * @returns SlackUserConfig
9939
- * @throws ApiError
9940
- */
9941
- static aiBotV1BotsSlackUserConfigUpdate({
9942
- id,
9943
- org,
9944
- requestBody
9945
- }) {
9946
- return request(OpenAPI, {
9947
- method: 'PUT',
9948
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9949
- path: {
9950
- 'id': id,
9951
- 'org': org
9952
- },
9953
- body: requestBody,
9954
- mediaType: 'application/json'
9955
- });
9956
- }
9957
- /**
9958
- * Setup slack username and domain linkage with slack bots
9959
- * this will be used to authenticate the user when interracting with slack bots.
9960
- * @returns SlackUserConfig
9961
- * @throws ApiError
9962
- */
9963
- static aiBotV1BotsSlackUserConfigPartialUpdate({
9964
- id,
9965
- org,
9966
- requestBody
9967
- }) {
9968
- return request(OpenAPI, {
9969
- method: 'PATCH',
9970
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9971
- path: {
9972
- 'id': id,
9973
- 'org': org
9974
- },
9975
- body: requestBody,
9976
- mediaType: 'application/json'
9977
- });
9978
- }
9979
- /**
9980
- * Setup slack username and domain linkage with slack bots
9981
- * this will be used to authenticate the user when interracting with slack bots.
9982
- * @returns void
9983
- * @throws ApiError
9984
- */
9985
- static aiBotV1BotsSlackUserConfigDestroy({
9986
- id,
9987
- org
9988
- }) {
9989
- return request(OpenAPI, {
9990
- method: 'DELETE',
9991
- url: '/api/ai-bot/v1/bots/{org}/slack-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 aiBotV1BotsWhatsappUserConfigList({
10005
- org
10006
- }) {
10007
- return request(OpenAPI, {
10008
- method: 'GET',
10009
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
10010
- path: {
10011
- 'org': org
10012
- }
10013
- });
10014
- }
10015
- /**
10016
- * Setup phone number linkage with whatsapp bots
10017
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10018
- * @returns WhatsappUserConfig
10019
- * @throws ApiError
10020
- */
10021
- static aiBotV1BotsWhatsappUserConfigCreate({
10022
- org,
10023
- requestBody
10024
- }) {
10025
- return request(OpenAPI, {
10026
- method: 'POST',
10027
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
10028
- path: {
10029
- 'org': org
10030
- },
10031
- body: requestBody,
10032
- mediaType: 'application/json'
10033
- });
10034
- }
10035
- /**
10036
- * Setup phone number linkage with whatsapp bots
10037
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10038
- * @returns WhatsappUserConfig
10039
- * @throws ApiError
10040
- */
10041
- static aiBotV1BotsWhatsappUserConfigRetrieve({
10042
- id,
10043
- org
10044
- }) {
10045
- return request(OpenAPI, {
10046
- method: 'GET',
10047
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10048
- path: {
10049
- 'id': id,
10050
- 'org': org
10051
- }
10052
- });
10053
- }
10054
- /**
10055
- * Setup phone number linkage with whatsapp bots
10056
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10057
- * @returns WhatsappUserConfig
10058
- * @throws ApiError
10059
- */
10060
- static aiBotV1BotsWhatsappUserConfigUpdate({
10061
- id,
10062
- org,
10063
- requestBody
10064
- }) {
10065
- return request(OpenAPI, {
10066
- method: 'PUT',
10067
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10068
- path: {
10069
- 'id': id,
10070
- 'org': org
10071
- },
10072
- body: requestBody,
10073
- mediaType: 'application/json'
10074
- });
10075
- }
10076
- /**
10077
- * Setup phone number linkage with whatsapp bots
10078
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10079
- * @returns WhatsappUserConfig
10080
- * @throws ApiError
10081
- */
10082
- static aiBotV1BotsWhatsappUserConfigPartialUpdate({
10083
- id,
10084
- org,
10085
- requestBody
10086
- }) {
10087
- return request(OpenAPI, {
10088
- method: 'PATCH',
10089
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10090
- path: {
10091
- 'id': id,
10092
- 'org': org
10093
- },
10094
- body: requestBody,
10095
- mediaType: 'application/json'
10096
- });
10097
- }
10098
- /**
10099
- * Setup phone number linkage with whatsapp bots
10100
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10101
- * @returns void
10102
- * @throws ApiError
10103
- */
10104
- static aiBotV1BotsWhatsappUserConfigDestroy({
10105
- id,
10106
- org
10107
- }) {
10108
- return request(OpenAPI, {
10109
- method: 'DELETE',
10110
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10111
- path: {
10112
- 'id': id,
10113
- 'org': org
10114
- }
10115
- });
10116
- }
10117
- /**
10118
- * Webhook endpoint to receive and process discord messages.
10119
- * @returns DiscordWebhook
10120
- * @throws ApiError
10121
- */
10122
- static aiBotV1BotsWebhooksDiscordCreate({
10123
- name,
10124
- org,
10125
- requestBody
10126
- }) {
10127
- return request(OpenAPI, {
10128
- method: 'POST',
10129
- url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
10130
- path: {
10131
- 'name': name,
10132
- 'org': org
10133
- },
10134
- body: requestBody,
10135
- mediaType: 'application/json'
10136
- });
10137
- }
10138
- /**
10139
- * @returns SlackWebhook
10140
- * @throws ApiError
10141
- */
10142
- static aiBotV1BotsWebhooksSlackCreate({
10143
- name,
10144
- org,
10145
- requestBody
10146
- }) {
10147
- return request(OpenAPI, {
10148
- method: 'POST',
10149
- url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
10150
- path: {
10151
- 'name': name,
10152
- 'org': org
10153
- },
10154
- body: requestBody,
10155
- mediaType: 'application/json'
10156
- });
10157
- }
10158
- /**
10159
- * @returns TeamsWebhook
10160
- * @throws ApiError
10161
- */
10162
- static aiBotV1BotsWebhooksTeamsCreate({
10163
- name,
10164
- org,
10165
- requestBody
10166
- }) {
10167
- return request(OpenAPI, {
10168
- method: 'POST',
10169
- url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
10170
- path: {
10171
- 'name': name,
10172
- 'org': org
10173
- },
10174
- body: requestBody,
10175
- mediaType: 'application/json'
8718
+ path: {
8719
+ 'course_id': courseId,
8720
+ 'org': org,
8721
+ 'user_id': userId
8722
+ }
10176
8723
  });
10177
8724
  }
10178
8725
  /**
10179
- * Webhook endpoint to receive and process discord messages.
10180
- * @returns WebexWebhook
8726
+ * Gives Percentage of units completed in course for a specific learner
8727
+ * @returns PerlearnerCourseProgress
10181
8728
  * @throws ApiError
10182
8729
  */
10183
- static aiBotV1BotsWebhooksWebexCreate({
10184
- name,
8730
+ static platformOrgsCoursesUsersProgressRetrieve({
8731
+ courseId,
10185
8732
  org,
10186
- requestBody
8733
+ userId,
8734
+ departmentId,
8735
+ format = 'json',
8736
+ includeMainPlatform = true
10187
8737
  }) {
10188
8738
  return request(OpenAPI, {
10189
- method: 'POST',
10190
- url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
8739
+ method: 'GET',
8740
+ url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress',
10191
8741
  path: {
10192
- 'name': name,
10193
- 'org': org
8742
+ 'course_id': courseId,
8743
+ 'org': org,
8744
+ 'user_id': userId
10194
8745
  },
10195
- body: requestBody,
10196
- mediaType: 'application/json'
8746
+ query: {
8747
+ 'department_id': departmentId,
8748
+ 'format': format,
8749
+ 'include_main_platform': includeMainPlatform
8750
+ }
10197
8751
  });
10198
8752
  }
10199
8753
  /**
10200
- * Respond to whatsapp's webhook challenge.
10201
- * Parameters Required include the tenant key (org) and the name of the bot: (name)
10202
- * @returns WhatAppWebHook
8754
+ * Average days used to complete a course
8755
+ *
8756
+ * Query Params
8757
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
8758
+ * @returns any No response body
10203
8759
  * @throws ApiError
10204
8760
  */
10205
- static aiBotV1BotsWebhooksWhatsappRetrieve({
10206
- name,
10207
- org
8761
+ static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({
8762
+ courseId,
8763
+ org,
8764
+ userId
10208
8765
  }) {
10209
8766
  return request(OpenAPI, {
10210
8767
  method: 'GET',
10211
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
8768
+ url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/progress/days-to-complete',
10212
8769
  path: {
10213
- 'name': name,
10214
- 'org': org
8770
+ 'course_id': courseId,
8771
+ 'org': org,
8772
+ 'user_id': userId
10215
8773
  }
10216
8774
  });
10217
8775
  }
10218
8776
  /**
10219
- * Accept and process webhook events from whatsapp.
10220
- * @returns WhatAppWebHook
8777
+ * Time spent count in seconds within a course by a learner
8778
+ * @returns Count
10221
8779
  * @throws ApiError
10222
8780
  */
10223
- static aiBotV1BotsWebhooksWhatsappCreate({
10224
- name,
8781
+ static platformOrgsCoursesUsersTimeCountRetrieve({
8782
+ courseId,
10225
8783
  org,
10226
- requestBody
8784
+ userId,
8785
+ departmentId,
8786
+ endDate,
8787
+ format = 'json',
8788
+ includeMainPlatform = true,
8789
+ startDate
10227
8790
  }) {
10228
8791
  return request(OpenAPI, {
10229
- method: 'POST',
10230
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
8792
+ method: 'GET',
8793
+ url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/time/count',
10231
8794
  path: {
10232
- 'name': name,
10233
- 'org': org
8795
+ 'course_id': courseId,
8796
+ 'org': org,
8797
+ 'user_id': userId
10234
8798
  },
10235
- body: requestBody,
10236
- mediaType: 'application/json'
8799
+ query: {
8800
+ 'department_id': departmentId,
8801
+ 'end_date': endDate,
8802
+ 'format': format,
8803
+ 'include_main_platform': includeMainPlatform,
8804
+ 'start_date': startDate
8805
+ }
10237
8806
  });
10238
8807
  }
10239
- }
10240
-
10241
- class AiFinetuningService {
10242
8808
  /**
10243
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10244
- * @returns PaginatedDataSetList
8809
+ * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
8810
+ * @returns VideosCount
10245
8811
  * @throws ApiError
10246
8812
  */
10247
- static aiFinetuningV1OrgUserDatasetsList({
8813
+ static platformOrgsCoursesUsersVideosCountRetrieve({
8814
+ courseId,
10248
8815
  org,
10249
- username,
10250
- dateCreated,
10251
- numDataPoints,
10252
- ordering,
10253
- page,
10254
- pageSize,
10255
- retryAttempts,
10256
- search,
10257
- status
8816
+ userId,
8817
+ departmentId,
8818
+ format = 'json',
8819
+ includeMainPlatform = true
10258
8820
  }) {
10259
8821
  return request(OpenAPI, {
10260
8822
  method: 'GET',
10261
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
8823
+ url: '/api/platform/orgs/{org}/courses/{course_id}/users/{user_id}/videos/count',
10262
8824
  path: {
8825
+ 'course_id': courseId,
10263
8826
  'org': org,
10264
- 'username': username
8827
+ 'user_id': userId
10265
8828
  },
10266
8829
  query: {
10267
- 'date_created': dateCreated,
10268
- 'num_data_points': numDataPoints,
10269
- 'ordering': ordering,
10270
- 'page': page,
10271
- 'page_size': pageSize,
10272
- 'retry_attempts': retryAttempts,
10273
- 'search': search,
10274
- 'status': status
8830
+ 'department_id': departmentId,
8831
+ 'format': format,
8832
+ 'include_main_platform': includeMainPlatform
10275
8833
  }
10276
8834
  });
10277
8835
  }
10278
8836
  /**
10279
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10280
- * @returns DataSetCreate
8837
+ * Count of total videos in a course
8838
+ *
8839
+ * Query Params
8840
+ * course_id e.g course-v1:Org+Course4+Run
8841
+ * @returns any No response body
10281
8842
  * @throws ApiError
10282
8843
  */
10283
- static aiFinetuningV1OrgUserDatasetsCreate({
10284
- org,
10285
- username,
10286
- requestBody
8844
+ static platformOrgsCoursesVideosRetrieve2({
8845
+ courseId,
8846
+ org
10287
8847
  }) {
10288
8848
  return request(OpenAPI, {
10289
- method: 'POST',
10290
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
8849
+ method: 'GET',
8850
+ url: '/api/platform/orgs/{org}/courses/{course_id}/videos/',
10291
8851
  path: {
10292
- 'org': org,
10293
- 'username': username
10294
- },
10295
- body: requestBody,
10296
- mediaType: 'application/json'
8852
+ 'course_id': courseId,
8853
+ 'org': org
8854
+ }
10297
8855
  });
10298
8856
  }
10299
8857
  /**
10300
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10301
- * @returns DataSet
8858
+ * Get total count of courses on the platform.
8859
+ *
8860
+ * This endpoint returns the total number of courses available on the platform.
8861
+ *
8862
+ * Returns:
8863
+ * The total count of courses on the platform.
8864
+ * @returns Count
10302
8865
  * @throws ApiError
10303
8866
  */
10304
- static aiFinetuningV1OrgUserDatasetsRetrieve({
10305
- id,
8867
+ static platformOrgsCoursesCountRetrieve({
10306
8868
  org,
10307
- username
8869
+ departmentId,
8870
+ format = 'json',
8871
+ includeMainPlatform = true
10308
8872
  }) {
10309
8873
  return request(OpenAPI, {
10310
8874
  method: 'GET',
10311
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
8875
+ url: '/api/platform/orgs/{org}/courses/count',
10312
8876
  path: {
10313
- 'id': id,
10314
- 'org': org,
10315
- 'username': username
8877
+ 'org': org
8878
+ },
8879
+ query: {
8880
+ 'department_id': departmentId,
8881
+ 'format': format,
8882
+ 'include_main_platform': includeMainPlatform
10316
8883
  }
10317
8884
  });
10318
8885
  }
10319
8886
  /**
10320
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10321
- * @returns DataSet
8887
+ * List grading information on a per-course basis.
8888
+ *
8889
+ * This endpoint provides grading statistics for all courses, including
8890
+ * average grades and completion rates.
8891
+ *
8892
+ * Returns:
8893
+ * A list of courses with their associated grading metrics.
8894
+ * @returns any No response body
10322
8895
  * @throws ApiError
10323
8896
  */
10324
- static aiFinetuningV1OrgUserDatasetsUpdate({
10325
- id,
10326
- org,
10327
- username,
10328
- requestBody
8897
+ static platformOrgsCoursesGradesRetrieve({
8898
+ org
10329
8899
  }) {
10330
8900
  return request(OpenAPI, {
10331
- method: 'PUT',
10332
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
8901
+ method: 'GET',
8902
+ url: '/api/platform/orgs/{org}/courses/grades',
10333
8903
  path: {
10334
- 'id': id,
10335
- 'org': org,
10336
- 'username': username
10337
- },
10338
- body: requestBody,
10339
- mediaType: 'application/json'
8904
+ 'org': org
8905
+ }
10340
8906
  });
10341
8907
  }
10342
8908
  /**
10343
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10344
- * @returns DataSet
8909
+ * Get video watch statistics on a per-course basis.
8910
+ *
8911
+ * This endpoint provides a list of courses with aggregated video watch metrics,
8912
+ * including total views and completion percentages.
8913
+ *
8914
+ * Returns:
8915
+ * A list of courses with:
8916
+ * - Course identification (ID and name)
8917
+ * - Video watch count
8918
+ * - Percentage of total videos watched
8919
+ * @returns WatchedVideosPerCourse
10345
8920
  * @throws ApiError
10346
8921
  */
10347
- static aiFinetuningV1OrgUserDatasetsPartialUpdate({
10348
- id,
8922
+ static platformOrgsCoursesVideosRetrieve({
10349
8923
  org,
10350
- username,
10351
- requestBody
8924
+ departmentId,
8925
+ format = 'json',
8926
+ includeMainPlatform = true
10352
8927
  }) {
10353
8928
  return request(OpenAPI, {
10354
- method: 'PATCH',
10355
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
8929
+ method: 'GET',
8930
+ url: '/api/platform/orgs/{org}/courses/videos',
10356
8931
  path: {
10357
- 'id': id,
10358
- 'org': org,
10359
- 'username': username
8932
+ 'org': org
10360
8933
  },
10361
- body: requestBody,
10362
- mediaType: 'application/json'
8934
+ query: {
8935
+ 'department_id': departmentId,
8936
+ 'format': format,
8937
+ 'include_main_platform': includeMainPlatform
8938
+ }
10363
8939
  });
10364
8940
  }
10365
8941
  /**
10366
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10367
- * @returns void
8942
+ * Get completion count statistics.
8943
+ *
8944
+ * This endpoint returns completion counts at different levels:
8945
+ * - Platform level: Total users who have completed at least one course
8946
+ * - Course level: Total completions for a specific course
8947
+ * - Learner level: Total courses completed by a specific learner
8948
+ *
8949
+ * Query Parameters:
8950
+ * course_id (str, optional): Filter by course ID
8951
+ * user_id (str, optional): Filter by username or email
8952
+ *
8953
+ * Returns:
8954
+ * A count of completions based on the specified filters.
8955
+ * @returns any No response body
10368
8956
  * @throws ApiError
10369
8957
  */
10370
- static aiFinetuningV1OrgUserDatasetsDestroy({
10371
- id,
10372
- org,
10373
- username
8958
+ static platformOrgsProgressCompletedRetrieve({
8959
+ org
10374
8960
  }) {
10375
8961
  return request(OpenAPI, {
10376
- method: 'DELETE',
10377
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
8962
+ method: 'GET',
8963
+ url: '/api/platform/orgs/{org}/progress/completed',
10378
8964
  path: {
10379
- 'id': id,
10380
- 'org': org,
10381
- 'username': username
8965
+ 'org': org
10382
8966
  }
10383
8967
  });
10384
8968
  }
10385
8969
  /**
10386
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10387
- * @returns PaginatedTrainingList
8970
+ * Average of total completed units
8971
+ * @returns any No response body
10388
8972
  * @throws ApiError
10389
8973
  */
10390
- static aiFinetuningV1OrgUserTrainingsList({
10391
- org,
10392
- username,
10393
- baseModelName,
10394
- dataset,
10395
- dateCreated,
10396
- fineTunedModel,
10397
- lastModified,
10398
- ordering,
10399
- page,
10400
- pageSize,
10401
- preprocessDataset,
10402
- provider,
10403
- search,
10404
- status
8974
+ static platformOrgsProgressCompletionRateRetrieve({
8975
+ org
10405
8976
  }) {
10406
8977
  return request(OpenAPI, {
10407
8978
  method: 'GET',
10408
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
8979
+ url: '/api/platform/orgs/{org}/progress/completion-rate',
10409
8980
  path: {
10410
- 'org': org,
10411
- 'username': username
10412
- },
10413
- query: {
10414
- 'base_model_name': baseModelName,
10415
- 'dataset': dataset,
10416
- 'date_created': dateCreated,
10417
- 'fine_tuned_model': fineTunedModel,
10418
- 'last_modified': lastModified,
10419
- 'ordering': ordering,
10420
- 'page': page,
10421
- 'page_size': pageSize,
10422
- 'preprocess_dataset': preprocessDataset,
10423
- 'provider': provider,
10424
- 'search': search,
10425
- 'status': status
8981
+ 'org': org
10426
8982
  }
10427
8983
  });
10428
8984
  }
10429
8985
  /**
10430
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10431
- * @returns TrainingCreate
8986
+ * In Progress means any unit completion in the past 30 days
8987
+ *
8988
+ * For platform : Total users who have atleast a course in_progress on the platform
8989
+ * For course : Total users
8990
+ * For learner : Total courses in progress
8991
+ *
8992
+ * Query Params
8993
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
8994
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
8995
+ * @returns any No response body
10432
8996
  * @throws ApiError
10433
8997
  */
10434
- static aiFinetuningV1OrgUserTrainingsCreate({
10435
- org,
10436
- username,
10437
- requestBody
8998
+ static platformOrgsProgressInProgressRetrieve({
8999
+ org
10438
9000
  }) {
10439
9001
  return request(OpenAPI, {
10440
- method: 'POST',
10441
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
9002
+ method: 'GET',
9003
+ url: '/api/platform/orgs/{org}/progress/in-progress',
10442
9004
  path: {
10443
- 'org': org,
10444
- 'username': username
10445
- },
10446
- body: requestBody,
10447
- mediaType: 'application/json'
9005
+ 'org': org
9006
+ }
10448
9007
  });
10449
9008
  }
10450
9009
  /**
10451
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10452
- * @returns Training
9010
+ * Started means an enrollment
9011
+ *
9012
+ * For platform : Total users who have atleast an enrollment
9013
+ * For course : Total users enrolled
9014
+ * For learner : Total courses in progress
9015
+ *
9016
+ * Query Params
9017
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
9018
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
9019
+ * @returns any No response body
10453
9020
  * @throws ApiError
10454
9021
  */
10455
- static aiFinetuningV1OrgUserTrainingsRetrieve({
10456
- id,
10457
- org,
10458
- username
9022
+ static platformOrgsProgressStartedRetrieve({
9023
+ org
10459
9024
  }) {
10460
9025
  return request(OpenAPI, {
10461
9026
  method: 'GET',
10462
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
9027
+ url: '/api/platform/orgs/{org}/progress/started',
10463
9028
  path: {
10464
- 'id': id,
10465
- 'org': org,
10466
- 'username': username
9029
+ 'org': org
10467
9030
  }
10468
9031
  });
10469
9032
  }
10470
9033
  /**
10471
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10472
- * @returns TrainingCreate
9034
+ * Total time spent count on the platform within specified range or all time
9035
+ *
9036
+ * Query Params
9037
+ * 1. start_date e.g 2020-10-01
9038
+ * 2. end_date e.g 2020-10-10
9039
+ *
9040
+ * Default result is all time
9041
+ * @returns any No response body
10473
9042
  * @throws ApiError
10474
9043
  */
10475
- static aiFinetuningV1OrgUserTrainingsUpdate({
10476
- id,
10477
- org,
10478
- username,
10479
- requestBody
9044
+ static platformOrgsTimeCountRetrieve({
9045
+ org
10480
9046
  }) {
10481
9047
  return request(OpenAPI, {
10482
- method: 'PUT',
10483
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
9048
+ method: 'GET',
9049
+ url: '/api/platform/orgs/{org}/time/count',
10484
9050
  path: {
10485
- 'id': id,
10486
- 'org': org,
10487
- 'username': username
10488
- },
10489
- body: requestBody,
10490
- mediaType: 'application/json'
9051
+ 'org': org
9052
+ }
10491
9053
  });
10492
9054
  }
10493
9055
  /**
10494
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10495
- * @returns TrainingCreate
9056
+ * Get count of active users on the platform.
9057
+ *
9058
+ * This endpoint returns the number of users who have had activity on the platform,
9059
+ * either for all time or within a specified date range.
9060
+ *
9061
+ * Query Parameters:
9062
+ * start_date (str, optional): Start date for filtering (ISO format)
9063
+ * end_date (str, optional): End date for filtering (ISO format)
9064
+ *
9065
+ * Returns:
9066
+ * The count of active users and change metrics compared to previous periods.
9067
+ *
9068
+ * Default behavior returns the count for all time if no date range is specified.
9069
+ * @returns OverTimeWithTotal
10496
9070
  * @throws ApiError
10497
9071
  */
10498
- static aiFinetuningV1OrgUserTrainingsPartialUpdate({
10499
- id,
9072
+ static platformOrgsUsersActiveCountRetrieve({
10500
9073
  org,
10501
- username,
10502
- requestBody
9074
+ departmentId,
9075
+ endDate,
9076
+ format = 'json',
9077
+ includeMainPlatform = true,
9078
+ startDate
10503
9079
  }) {
10504
9080
  return request(OpenAPI, {
10505
- method: 'PATCH',
10506
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
9081
+ method: 'GET',
9082
+ url: '/api/platform/orgs/{org}/users/active/count',
10507
9083
  path: {
10508
- 'id': id,
10509
- 'org': org,
10510
- 'username': username
9084
+ 'org': org
10511
9085
  },
10512
- body: requestBody,
10513
- mediaType: 'application/json'
9086
+ query: {
9087
+ 'department_id': departmentId,
9088
+ 'end_date': endDate,
9089
+ 'format': format,
9090
+ 'include_main_platform': includeMainPlatform,
9091
+ 'start_date': startDate
9092
+ }
10514
9093
  });
10515
9094
  }
10516
9095
  /**
10517
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10518
- * @returns void
9096
+ * Get count of registered users on the platform.
9097
+ *
9098
+ * This endpoint returns the number of users registered on the platform,
9099
+ * either for all time or within a specified date range.
9100
+ *
9101
+ * Query Parameters:
9102
+ * start_date (str, optional): Start date for filtering (ISO format)
9103
+ * end_date (str, optional): End date for filtering (ISO format)
9104
+ *
9105
+ * Returns:
9106
+ * The count of registered users and change metrics compared to previous periods.
9107
+ *
9108
+ * Default behavior returns the count for all time if no date range is specified.
9109
+ * @returns OverTimeWithTotal
10519
9110
  * @throws ApiError
10520
9111
  */
10521
- static aiFinetuningV1OrgUserTrainingsDestroy({
10522
- id,
9112
+ static platformOrgsUsersCountRetrieve({
10523
9113
  org,
10524
- username
9114
+ departmentId,
9115
+ endDate,
9116
+ format = 'json',
9117
+ includeMainPlatform = true,
9118
+ startDate
10525
9119
  }) {
10526
9120
  return request(OpenAPI, {
10527
- method: 'DELETE',
10528
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
9121
+ method: 'GET',
9122
+ url: '/api/platform/orgs/{org}/users/count',
10529
9123
  path: {
10530
- 'id': id,
10531
- 'org': org,
10532
- 'username': username
9124
+ 'org': org
9125
+ },
9126
+ query: {
9127
+ 'department_id': departmentId,
9128
+ 'end_date': endDate,
9129
+ 'format': format,
9130
+ 'include_main_platform': includeMainPlatform,
9131
+ 'start_date': startDate
10533
9132
  }
10534
9133
  });
10535
9134
  }
10536
9135
  /**
10537
- * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
10538
- * Filtering and pagination is allowed.
9136
+ * Count of users who have completed a course on the platform within specified range or all time
10539
9137
  *
10540
- * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
10541
- * training list endpoint.
10542
- * Returns:
10543
- * Response: A paginated response containing the serialized fine-tuned models.
10544
- * @returns Training
9138
+ * Query Params
9139
+ * 1. start_date e.g 2020-10-01
9140
+ * 2. end_date e.g 2020-10-10
9141
+ *
9142
+ * Default is all time
9143
+ * @returns OverTimeWithTotal
10545
9144
  * @throws ApiError
10546
9145
  */
10547
- static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve({
9146
+ static platformOrgsUsersCoursesCompletedCountRetrieve({
10548
9147
  org,
10549
- username
9148
+ departmentId,
9149
+ endDate,
9150
+ format = 'json',
9151
+ includeMainPlatform = true,
9152
+ startDate
10550
9153
  }) {
10551
9154
  return request(OpenAPI, {
10552
9155
  method: 'GET',
10553
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
9156
+ url: '/api/platform/orgs/{org}/users/courses-completed/count',
10554
9157
  path: {
10555
- 'org': org,
10556
- 'username': username
9158
+ 'org': org
9159
+ },
9160
+ query: {
9161
+ 'department_id': departmentId,
9162
+ 'end_date': endDate,
9163
+ 'format': format,
9164
+ 'include_main_platform': includeMainPlatform,
9165
+ 'start_date': startDate
10557
9166
  }
10558
9167
  });
10559
9168
  }
@@ -29576,6 +28185,96 @@ class CoreService {
29576
28185
  }
29577
28186
  });
29578
28187
  }
28188
+ /**
28189
+ * List your LTI Mentor's
28190
+ * @returns LtiMentor
28191
+ * @throws ApiError
28192
+ */
28193
+ static coreLti1P3ProviderLtiMentorsList({
28194
+ platformKey
28195
+ }) {
28196
+ return request(OpenAPI, {
28197
+ method: 'GET',
28198
+ url: '/api/core/lti/1p3/provider/lti-mentors/',
28199
+ query: {
28200
+ 'platform_key': platformKey
28201
+ }
28202
+ });
28203
+ }
28204
+ /**
28205
+ * Create a new LTI Mentor
28206
+ * @returns LtiMentor
28207
+ * @throws ApiError
28208
+ */
28209
+ static coreLti1P3ProviderLtiMentorsCreate({
28210
+ requestBody
28211
+ }) {
28212
+ return request(OpenAPI, {
28213
+ method: 'POST',
28214
+ url: '/api/core/lti/1p3/provider/lti-mentors/',
28215
+ body: requestBody,
28216
+ mediaType: 'application/json'
28217
+ });
28218
+ }
28219
+ /**
28220
+ * Get details about a specific LTI Mentor
28221
+ * @returns LtiMentor
28222
+ * @throws ApiError
28223
+ */
28224
+ static coreLti1P3ProviderLtiMentorsRetrieve({
28225
+ id,
28226
+ platformKey
28227
+ }) {
28228
+ return request(OpenAPI, {
28229
+ method: 'GET',
28230
+ url: '/api/core/lti/1p3/provider/lti-mentors/{id}/',
28231
+ path: {
28232
+ 'id': id
28233
+ },
28234
+ query: {
28235
+ 'platform_key': platformKey
28236
+ }
28237
+ });
28238
+ }
28239
+ /**
28240
+ * Update an LTI Mentor
28241
+ * @returns LtiMentor
28242
+ * @throws ApiError
28243
+ */
28244
+ static coreLti1P3ProviderLtiMentorsUpdate({
28245
+ id,
28246
+ requestBody
28247
+ }) {
28248
+ return request(OpenAPI, {
28249
+ method: 'PUT',
28250
+ url: '/api/core/lti/1p3/provider/lti-mentors/{id}/',
28251
+ path: {
28252
+ 'id': id
28253
+ },
28254
+ body: requestBody,
28255
+ mediaType: 'application/json'
28256
+ });
28257
+ }
28258
+ /**
28259
+ * Delete an LTI Mentor
28260
+ * @returns void
28261
+ * @throws ApiError
28262
+ */
28263
+ static coreLti1P3ProviderLtiMentorsDestroy({
28264
+ id,
28265
+ platformKey
28266
+ }) {
28267
+ return request(OpenAPI, {
28268
+ method: 'DELETE',
28269
+ url: '/api/core/lti/1p3/provider/lti-mentors/{id}/',
28270
+ path: {
28271
+ 'id': id
28272
+ },
28273
+ query: {
28274
+ 'platform_key': platformKey
28275
+ }
28276
+ });
28277
+ }
29579
28278
  /**
29580
28279
  * List your LTI Tool's
29581
28280
  * @returns LtiTool
@@ -35681,5 +34380,5 @@ class SkillsService {
35681
34380
  }
35682
34381
  }
35683
34382
 
35684
- export { AcceptanceEnum, AccessEnum, AiAccountService, AiAnalyticsService, AiBotService, AiFinetuningService, AiIndexService, AiMarketingService, AiMediaService, AiMentorService, AiPromptService, AlignMentorBubbleEnum, ApiError, BlankEnum, CallConfigurationModeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, ComponentBlockTypeEnum, ConnectedServiceProviderEnum, CoreService, CourseCreationTaskStatusEnum, CrawlerPatternTypeEnum, CredentialsService, CustomDomainsService, DataSetStatusEnum, FeaturesService, GooglePayAccountResponseStatusEnum, GreetingMethodEnum, HumanSupportTicketStatusEnum, InstitutionTypeEnum, ItemTypeEnum, KindEnum, LlmProviderEnum, MediaService, MediaTypeEnum, MentorVisibilityEnum, NotificationSourceTypeEnum, NotificationStatusEnum, NotificationsService, OpenAPI, PeriodicAgentLogStatusEnum, PlatformListStatusEnum, PreviousAgentStatusEnum, ProgramTypeEnum, PromptVisibilityEnum, Provider05cEnum, Provider637Enum, Provider63aEnum, RatingEnum, RecommendationsService, ReportsService, ResourceScrappedDataStatusEnum, ScimService, SearchService, ServiceEnum, SkillsService, StateEnum, Status6eeEnum, StepStatusEnum, StripeCheckoutSessionRequestModeEnum, SttProviderEnum, TargetSystemEnum, ThemeEnum, TrainingStatusEnum, TransportEnum, TtsProviderEnum, TypeC42Enum };
34383
+ export { AcceptanceEnum, AccessEnum, AiAccountService, AiAnalyticsService, AiIndexService, AiMarketingService, AiMediaService, AiMentorService, AiPromptService, AlignMentorBubbleEnum, ApiError, BlankEnum, CallConfigurationModeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, ComponentBlockTypeEnum, ConnectedServiceProviderEnum, CoreService, CourseCreationTaskStatusEnum, CrawlerPatternTypeEnum, CredentialsService, CustomDomainsService, FeaturesService, GooglePayAccountResponseStatusEnum, GreetingMethodEnum, HumanSupportTicketStatusEnum, InstitutionTypeEnum, ItemTypeEnum, KindEnum, LlmProviderEnum, MediaService, MediaTypeEnum, MentorVisibilityEnum, NotificationSourceTypeEnum, NotificationStatusEnum, NotificationsService, OpenAPI, PeriodicAgentLogStatusEnum, PlatformListStatusEnum, PreviousAgentStatusEnum, ProgramTypeEnum, PromptVisibilityEnum, Provider637Enum, RatingEnum, RecommendationsService, ReportsService, ResourceScrappedDataStatusEnum, ScimService, SearchService, ServiceEnum, SkillsService, StateEnum, Status6eeEnum, StepStatusEnum, StripeCheckoutSessionRequestModeEnum, SttProviderEnum, TargetSystemEnum, ThemeEnum, TrainingStatusEnum, TransportEnum, TtsProviderEnum, TypeC42Enum };
35685
34384
  //# sourceMappingURL=index.esm.js.map