@iblai/iblai-api 3.65.2-ai-plus → 3.66.0-ai

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