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