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