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