@iblai/iblai-api 4.3.1-ai-plus → 4.4.0-ai

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