@iblai/iblai-api 3.45.9-ai-plus → 3.45.10-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 (104) hide show
  1. package/dist/index.cjs.js +230 -1566
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +231 -1565
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +230 -1566
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +1 -44
  8. package/dist/types/models/PlatformSkillPointResponse.d.ts +2 -2
  9. package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
  10. package/dist/types/models/Voice.d.ts +2 -2
  11. package/dist/types/services/CatalogService.d.ts +13 -17
  12. package/package.json +1 -1
  13. package/src/core/OpenAPI.ts +1 -1
  14. package/src/index.ts +1 -44
  15. package/src/models/PlatformSkillPointResponse.ts +2 -2
  16. package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
  17. package/src/models/Voice.ts +2 -2
  18. package/src/services/CatalogService.ts +13 -17
  19. package/dist/types/models/BlockSkillPointInfoResponse.d.ts +0 -10
  20. package/dist/types/models/Bot.d.ts +0 -15
  21. package/dist/types/models/BotCommand.d.ts +0 -6
  22. package/dist/types/models/BotCreate.d.ts +0 -12
  23. package/dist/types/models/CourseCompletionCatalogResponse.d.ts +0 -11
  24. package/dist/types/models/CourseSkillPointInfoResponse.d.ts +0 -10
  25. package/dist/types/models/DataSet.d.ts +0 -21
  26. package/dist/types/models/DataSetCreate.d.ts +0 -12
  27. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  28. package/dist/types/models/DiscordConfig.d.ts +0 -7
  29. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  30. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  31. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  32. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  33. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  34. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  35. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  36. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  37. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  38. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  39. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  40. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  41. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  42. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  43. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  44. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  45. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  46. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  47. package/dist/types/models/SlackConfig.d.ts +0 -8
  48. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  49. package/dist/types/models/SlackWebhook.d.ts +0 -6
  50. package/dist/types/models/TeamsConfig.d.ts +0 -7
  51. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  52. package/dist/types/models/Training.d.ts +0 -41
  53. package/dist/types/models/TrainingCreate.d.ts +0 -31
  54. package/dist/types/models/UserSkillPointInfoResponse.d.ts +0 -10
  55. package/dist/types/models/WebexConfig.d.ts +0 -10
  56. package/dist/types/models/WebexWebhook.d.ts +0 -4
  57. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  58. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  59. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  60. package/dist/types/services/AiBotService.d.ts +0 -486
  61. package/dist/types/services/AiFinetuningService.d.ts +0 -162
  62. package/src/models/BlockSkillPointInfoResponse.ts +0 -15
  63. package/src/models/Bot.ts +0 -20
  64. package/src/models/BotCommand.ts +0 -11
  65. package/src/models/BotCreate.ts +0 -17
  66. package/src/models/CourseCompletionCatalogResponse.ts +0 -16
  67. package/src/models/CourseSkillPointInfoResponse.ts +0 -15
  68. package/src/models/DataSet.ts +0 -26
  69. package/src/models/DataSetCreate.ts +0 -17
  70. package/src/models/DataSetStatusEnum.ts +0 -16
  71. package/src/models/DiscordConfig.ts +0 -12
  72. package/src/models/DiscordUserConfig.ts +0 -15
  73. package/src/models/DiscordWebhook.ts +0 -11
  74. package/src/models/PaginatedDataSetList.ts +0 -12
  75. package/src/models/PaginatedTrainingList.ts +0 -12
  76. package/src/models/PatchedBotCommand.ts +0 -11
  77. package/src/models/PatchedBotCreate.ts +0 -17
  78. package/src/models/PatchedDataSet.ts +0 -26
  79. package/src/models/PatchedDiscordConfig.ts +0 -12
  80. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  81. package/src/models/PatchedSlackConfig.ts +0 -13
  82. package/src/models/PatchedSlackUserConfig.ts +0 -22
  83. package/src/models/PatchedTeamsConfig.ts +0 -12
  84. package/src/models/PatchedTrainingCreate.ts +0 -36
  85. package/src/models/PatchedWebexConfig.ts +0 -15
  86. package/src/models/PatchedWhatsappConfig.ts +0 -16
  87. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  88. package/src/models/Provider05cEnum.ts +0 -18
  89. package/src/models/Provider63aEnum.ts +0 -10
  90. package/src/models/SlackConfig.ts +0 -13
  91. package/src/models/SlackUserConfig.ts +0 -22
  92. package/src/models/SlackWebhook.ts +0 -11
  93. package/src/models/TeamsConfig.ts +0 -12
  94. package/src/models/TeamsWebhook.ts +0 -22
  95. package/src/models/Training.ts +0 -46
  96. package/src/models/TrainingCreate.ts +0 -36
  97. package/src/models/UserSkillPointInfoResponse.ts +0 -15
  98. package/src/models/WebexConfig.ts +0 -15
  99. package/src/models/WebexWebhook.ts +0 -9
  100. package/src/models/WhatAppWebHook.ts +0 -8
  101. package/src/models/WhatsappConfig.ts +0 -16
  102. package/src/models/WhatsappUserConfig.ts +0 -15
  103. package/src/services/AiBotService.ts +0 -1174
  104. package/src/services/AiFinetuningService.ts +0 -402
package/dist/index.umd.js CHANGED
@@ -114,7 +114,7 @@
114
114
 
115
115
  const OpenAPI = {
116
116
  BASE: 'https://base.manager.iblai.app',
117
- VERSION: '3.45.9-ai-plus',
117
+ VERSION: '3.45.10-ai',
118
118
  WITH_CREDENTIALS: false,
119
119
  CREDENTIALS: 'include',
120
120
  TOKEN: undefined,
@@ -235,24 +235,6 @@
235
235
  CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
236
236
  })(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
237
237
 
238
- /* generated using openapi-typescript-codegen -- do not edit */
239
- /* istanbul ignore file */
240
- /* tslint:disable */
241
- /* eslint-disable */
242
- /**
243
- * * `pending` - Pending
244
- * * `processing` - Processing
245
- * * `completed` - Completed
246
- * * `failed` - Failed
247
- */
248
- exports.DataSetStatusEnum = void 0;
249
- (function (DataSetStatusEnum) {
250
- DataSetStatusEnum["PENDING"] = "pending";
251
- DataSetStatusEnum["PROCESSING"] = "processing";
252
- DataSetStatusEnum["COMPLETED"] = "completed";
253
- DataSetStatusEnum["FAILED"] = "failed";
254
- })(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
255
-
256
238
  /* generated using openapi-typescript-codegen -- do not edit */
257
239
  /* istanbul ignore file */
258
240
  /* tslint:disable */
@@ -535,37 +517,21 @@
535
517
  PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
536
518
  })(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
537
519
 
538
- /* generated using openapi-typescript-codegen -- do not edit */
539
- /* istanbul ignore file */
540
- /* tslint:disable */
541
- /* eslint-disable */
542
- /**
543
- * * `webex` - Webex
544
- * * `slack` - Slack
545
- * * `whatsapp` - Whatsapp
546
- * * `discord` - Discord
547
- * * `teams` - Teams
548
- */
549
- exports.Provider05cEnum = void 0;
550
- (function (Provider05cEnum) {
551
- Provider05cEnum["WEBEX"] = "webex";
552
- Provider05cEnum["SLACK"] = "slack";
553
- Provider05cEnum["WHATSAPP"] = "whatsapp";
554
- Provider05cEnum["DISCORD"] = "discord";
555
- Provider05cEnum["TEAMS"] = "teams";
556
- })(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
557
-
558
520
  /* generated using openapi-typescript-codegen -- do not edit */
559
521
  /* istanbul ignore file */
560
522
  /* tslint:disable */
561
523
  /* eslint-disable */
562
524
  /**
563
525
  * * `openai` - Openai
526
+ * * `google` - Google
527
+ * * `elevenlabs` - Elevenlabs
564
528
  */
565
- exports.Provider63aEnum = void 0;
566
- (function (Provider63aEnum) {
567
- Provider63aEnum["OPENAI"] = "openai";
568
- })(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
529
+ exports.ProviderEnum = void 0;
530
+ (function (ProviderEnum) {
531
+ ProviderEnum["OPENAI"] = "openai";
532
+ ProviderEnum["GOOGLE"] = "google";
533
+ ProviderEnum["ELEVENLABS"] = "elevenlabs";
534
+ })(exports.ProviderEnum || (exports.ProviderEnum = {}));
569
535
 
570
536
  /* generated using openapi-typescript-codegen -- do not edit */
571
537
  /* istanbul ignore file */
@@ -735,22 +701,6 @@
735
701
  TypeC42Enum["ASSESSMENT"] = "assessment";
736
702
  })(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
737
703
 
738
- /* generated using openapi-typescript-codegen -- do not edit */
739
- /* istanbul ignore file */
740
- /* tslint:disable */
741
- /* eslint-disable */
742
- /**
743
- * * `openai` - Openai
744
- * * `google` - Google
745
- * * `elevenlabs` - Elevenlabs
746
- */
747
- exports.VoiceProviderEnum = void 0;
748
- (function (VoiceProviderEnum) {
749
- VoiceProviderEnum["OPENAI"] = "openai";
750
- VoiceProviderEnum["GOOGLE"] = "google";
751
- VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
752
- })(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
753
-
754
704
  /* generated using openapi-typescript-codegen -- do not edit */
755
705
  /* istanbul ignore file */
756
706
  /* tslint:disable */
@@ -5512,1567 +5462,283 @@
5512
5462
  method: 'GET',
5513
5463
  url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/engagement-index',
5514
5464
  path: {
5515
- 'org': org,
5516
- 'user_id': userId
5517
- },
5518
- query: {
5519
- 'department_id': departmentId,
5520
- 'end_date': endDate,
5521
- 'format': format,
5522
- 'include_main_platform': includeMainPlatform,
5523
- 'start_date': startDate
5524
- }
5525
- });
5526
- }
5527
- /**
5528
- * Get average grade value for platform, course, or user.
5529
- *
5530
- * This endpoint returns the average grade at different levels:
5531
- * - Platform level: Average grade across all courses
5532
- * - Course level: Average grade for a specific course
5533
- * - Learner level: Average grade for a specific learner
5534
- * - Course-learner level: Grade for a specific learner in a specific course
5535
- *
5536
- * Query Parameters:
5537
- * course_id (str, optional): Filter by course ID
5538
- * learner_id (str, optional): Filter by username or email
5539
- *
5540
- * Returns:
5541
- * The average grade value based on the specified filters.
5542
- *
5543
- * Access Control:
5544
- * - Platform admins can access any grade data
5545
- * - Learners can access their own grade data
5546
- * @param org
5547
- * @param userId
5548
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5549
- * @param format Format
5550
- *
5551
- * * `json` - json
5552
- * @param includeMainPlatform Include main platform data
5553
- * @returns Average
5554
- * @throws ApiError
5555
- */
5556
- static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org, userId, departmentId, format = 'json', includeMainPlatform = true) {
5557
- return request(OpenAPI, {
5558
- method: 'GET',
5559
- url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
5560
- path: {
5561
- 'org': org,
5562
- 'user_id': userId
5563
- },
5564
- query: {
5565
- 'department_id': departmentId,
5566
- 'format': format,
5567
- 'include_main_platform': includeMainPlatform
5568
- }
5569
- });
5570
- }
5571
- /**
5572
- * Evaluates performance index for platform, per course, per user and per user-per course
5573
- *
5574
- * Query Params
5575
- * course_id <optional>
5576
- * learner_id <optional>
5577
- * @param org
5578
- * @param userId
5579
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5580
- * @param endDate end date. ISO 8601
5581
- * @param format Format
5582
- *
5583
- * * `json` - json
5584
- * @param includeMainPlatform Include main platform data
5585
- * @param startDate start date. ISO 8601
5586
- * @returns Value
5587
- * @throws ApiError
5588
- */
5589
- static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
5590
- return request(OpenAPI, {
5591
- method: 'GET',
5592
- url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
5593
- path: {
5594
- 'org': org,
5595
- 'user_id': userId
5596
- },
5597
- query: {
5598
- 'department_id': departmentId,
5599
- 'end_date': endDate,
5600
- 'format': format,
5601
- 'include_main_platform': includeMainPlatform,
5602
- 'start_date': startDate
5603
- }
5604
- });
5605
- }
5606
- /**
5607
- * Time spent in secs on a per-day basis
5608
- *
5609
- * Query Params
5610
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
5611
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
5612
- * 3. start_date e.g 2020-10-01
5613
- * 4. end_date e.g 2020-10-10
5614
- *
5615
- * Default result when no query param is added is last_7_days (today inclusive)
5616
- * @param org
5617
- * @param userId
5618
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5619
- * @param endDate end date. ISO 8601
5620
- * @param format Format
5621
- *
5622
- * * `json` - json
5623
- * @param includeMainPlatform Include main platform data
5624
- * @param startDate start date. ISO 8601
5625
- * @returns OverTimeWithTotal
5626
- * @throws ApiError
5627
- */
5628
- static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
5629
- return request(OpenAPI, {
5630
- method: 'GET',
5631
- url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
5632
- path: {
5633
- 'org': org,
5634
- 'user_id': userId
5635
- },
5636
- query: {
5637
- 'department_id': departmentId,
5638
- 'end_date': endDate,
5639
- 'format': format,
5640
- 'include_main_platform': includeMainPlatform,
5641
- 'start_date': startDate
5642
- }
5643
- });
5644
- }
5645
- /**
5646
- * Get video watch counts over time.
5647
- *
5648
- * This endpoint provides daily counts of videos watched over a specified time period,
5649
- * with options to filter by course or user.
5650
- *
5651
- * Query Parameters:
5652
- * start_date (str, optional): Start date for the time range (ISO format)
5653
- * end_date (str, optional): End date for the time range (ISO format)
5654
- * course_id (str, optional): Filter by course ID
5655
- * user_id (str, optional): Filter by username or email
5656
- *
5657
- * Returns:
5658
- * Daily video watch counts over the specified time period.
5659
- *
5660
- * Default time range is the last 7 days if no dates are specified.
5661
- *
5662
- * Access Control:
5663
- * - Platform admins can access any video watch data
5664
- * - Learners can access their own video watch data
5665
- * @param org
5666
- * @param userId
5667
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5668
- * @param endDate end date. ISO 8601
5669
- * @param format Format
5670
- *
5671
- * * `json` - json
5672
- * @param includeMainPlatform Include main platform data
5673
- * @param startDate start date. ISO 8601
5674
- * @returns OverTimeWithTotal
5675
- * @throws ApiError
5676
- */
5677
- static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
5678
- return request(OpenAPI, {
5679
- method: 'GET',
5680
- url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
5681
- path: {
5682
- 'org': org,
5683
- 'user_id': userId
5684
- },
5685
- query: {
5686
- 'department_id': departmentId,
5687
- 'end_date': endDate,
5688
- 'format': format,
5689
- 'include_main_platform': includeMainPlatform,
5690
- 'start_date': startDate
5691
- }
5692
- });
5693
- }
5694
- /**
5695
- * Summary Videos watched data for a learner per enrollment
5696
- *
5697
- * Query Params
5698
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
5699
- * @param org
5700
- * @param userId
5701
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5702
- * @param endDate end date. ISO 8601
5703
- * @param format Format
5704
- *
5705
- * * `json` - json
5706
- * @param includeMainPlatform Include main platform data
5707
- * @param startDate start date. ISO 8601
5708
- * @returns PerlearnerEngagementVideosWatchedPerCourse
5709
- * @throws ApiError
5710
- */
5711
- static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
5712
- return request(OpenAPI, {
5713
- method: 'GET',
5714
- url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/per-course',
5715
- path: {
5716
- 'org': org,
5717
- 'user_id': userId
5718
- },
5719
- query: {
5720
- 'department_id': departmentId,
5721
- 'end_date': endDate,
5722
- 'format': format,
5723
- 'include_main_platform': includeMainPlatform,
5724
- 'start_date': startDate
5725
- }
5726
- });
5727
- }
5728
- /**
5729
- * Get a list of user groups with metrics and filtering options.
5730
- *
5731
- * This endpoint provides a paginated list of user groups with aggregated metrics
5732
- * about learner performance, course completions, and skill acquisition.
5733
- *
5734
- * This endpoint uses DM token authentication and respects department-based
5735
- * access controls.
5736
- *
5737
- * Query Parameters:
5738
- * page (int, optional): Page number for pagination
5739
- * length (int, optional): Number of items per page
5740
- * program (str, optional): Filter by program
5741
- * pathway (str, optional): Filter by pathway
5742
- * groups (list, optional): Filter by group names
5743
- * location (str, optional): Filter by location
5744
- * is_enrolled (bool, optional): Filter for groups with enrolled users
5745
- * start_date (date, optional): Filter by learner join date (start range)
5746
- * end_date (date, optional): Filter by learner join date (end range)
5747
- *
5748
- * Returns:
5749
- * A paginated list of user groups with comprehensive metrics.
5750
- *
5751
- * Access Control:
5752
- * - Platform admins can see all groups
5753
- * - Department admins can only see groups in their departments
5754
- * @param org
5755
- * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5756
- * @param endDate Filter by learners date_joined. Start date. ISO 8601
5757
- * @param format Format
5758
- *
5759
- * * `json` - json
5760
- * @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
5761
- * @param includeMainPlatform Include main platform data
5762
- * @param isEnrolled Filter for users who have at least an enrollment
5763
- * @param length Size of data to return
5764
- * @param location Location search string
5765
- * @param page Page offset
5766
- * @param pathway Pathway string
5767
- * @param program Program search string
5768
- * @param startDate Filter by learners date_joined. Start date. ISO 8601
5769
- * @returns GroupList
5770
- * @throws ApiError
5771
- */
5772
- static aiAnalyticsUserGroupsOrgsRetrieve(org, departmentId, endDate, format = 'json', groups, includeMainPlatform = true, isEnrolled, length, location, page, pathway, program, startDate) {
5773
- return request(OpenAPI, {
5774
- method: 'GET',
5775
- url: '/api/ai-analytics/user-groups/orgs/{org}/',
5776
- path: {
5777
- 'org': org
5778
- },
5779
- query: {
5780
- 'department_id': departmentId,
5781
- 'end_date': endDate,
5782
- 'format': format,
5783
- 'groups': groups,
5784
- 'include_main_platform': includeMainPlatform,
5785
- 'is_enrolled': isEnrolled,
5786
- 'length': length,
5787
- 'location': location,
5788
- 'page': page,
5789
- 'pathway': pathway,
5790
- 'program': program,
5791
- 'start_date': startDate
5792
- }
5793
- });
5794
- }
5795
- }
5796
-
5797
- class AiBotService {
5798
- /**
5799
- * Create modify and update bot information for a specific tenant.
5800
- * @param org
5801
- * @returns Bot
5802
- * @throws ApiError
5803
- */
5804
- static aiBotV1BotsBotList(org) {
5805
- return request(OpenAPI, {
5806
- method: 'GET',
5807
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5808
- path: {
5809
- 'org': org
5810
- }
5811
- });
5812
- }
5813
- /**
5814
- * Create modify and update bot information for a specific tenant.
5815
- * @param org
5816
- * @param requestBody
5817
- * @returns BotCreate
5818
- * @throws ApiError
5819
- */
5820
- static aiBotV1BotsBotCreate(org, requestBody) {
5821
- return request(OpenAPI, {
5822
- method: 'POST',
5823
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5824
- path: {
5825
- 'org': org
5826
- },
5827
- body: requestBody,
5828
- mediaType: 'application/json'
5829
- });
5830
- }
5831
- /**
5832
- * Create slash commands for a specific bot
5833
- * eg. /iblai-baseline
5834
- * @param org
5835
- * @returns BotCommand
5836
- * @throws ApiError
5837
- */
5838
- static aiBotV1BotsBotCommandsList(org) {
5839
- return request(OpenAPI, {
5840
- method: 'GET',
5841
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5842
- path: {
5843
- 'org': org
5844
- }
5845
- });
5846
- }
5847
- /**
5848
- * Create slash commands for a specific bot
5849
- * eg. /iblai-baseline
5850
- * @param org
5851
- * @param requestBody
5852
- * @returns BotCommand
5853
- * @throws ApiError
5854
- */
5855
- static aiBotV1BotsBotCommandsCreate(org, requestBody) {
5856
- return request(OpenAPI, {
5857
- method: 'POST',
5858
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5859
- path: {
5860
- 'org': org
5861
- },
5862
- body: requestBody,
5863
- mediaType: 'application/json'
5864
- });
5865
- }
5866
- /**
5867
- * Create slash commands for a specific bot
5868
- * eg. /iblai-baseline
5869
- * @param id A unique integer value identifying this bot command.
5870
- * @param org
5871
- * @returns BotCommand
5872
- * @throws ApiError
5873
- */
5874
- static aiBotV1BotsBotCommandsRetrieve(id, org) {
5875
- return request(OpenAPI, {
5876
- method: 'GET',
5877
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5878
- path: {
5879
- 'id': id,
5880
- 'org': org
5881
- }
5882
- });
5883
- }
5884
- /**
5885
- * Create slash commands for a specific bot
5886
- * eg. /iblai-baseline
5887
- * @param id A unique integer value identifying this bot command.
5888
- * @param org
5889
- * @param requestBody
5890
- * @returns BotCommand
5891
- * @throws ApiError
5892
- */
5893
- static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
5894
- return request(OpenAPI, {
5895
- method: 'PUT',
5896
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5897
- path: {
5898
- 'id': id,
5899
- 'org': org
5900
- },
5901
- body: requestBody,
5902
- mediaType: 'application/json'
5903
- });
5904
- }
5905
- /**
5906
- * Create slash commands for a specific bot
5907
- * eg. /iblai-baseline
5908
- * @param id A unique integer value identifying this bot command.
5909
- * @param org
5910
- * @param requestBody
5911
- * @returns BotCommand
5912
- * @throws ApiError
5913
- */
5914
- static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
5915
- return request(OpenAPI, {
5916
- method: 'PATCH',
5917
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5918
- path: {
5919
- 'id': id,
5920
- 'org': org
5921
- },
5922
- body: requestBody,
5923
- mediaType: 'application/json'
5924
- });
5925
- }
5926
- /**
5927
- * Create slash commands for a specific bot
5928
- * eg. /iblai-baseline
5929
- * @param id A unique integer value identifying this bot command.
5930
- * @param org
5931
- * @returns void
5932
- * @throws ApiError
5933
- */
5934
- static aiBotV1BotsBotCommandsDestroy(id, org) {
5935
- return request(OpenAPI, {
5936
- method: 'DELETE',
5937
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5938
- path: {
5939
- 'id': id,
5940
- 'org': org
5941
- }
5942
- });
5943
- }
5944
- /**
5945
- * Create modify and update bot information for a specific tenant.
5946
- * @param id A unique integer value identifying this bot.
5947
- * @param org
5948
- * @returns Bot
5949
- * @throws ApiError
5950
- */
5951
- static aiBotV1BotsBotRetrieve(id, org) {
5952
- return request(OpenAPI, {
5953
- method: 'GET',
5954
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5955
- path: {
5956
- 'id': id,
5957
- 'org': org
5958
- }
5959
- });
5960
- }
5961
- /**
5962
- * Create modify and update bot information for a specific tenant.
5963
- * @param id A unique integer value identifying this bot.
5964
- * @param org
5965
- * @param requestBody
5966
- * @returns BotCreate
5967
- * @throws ApiError
5968
- */
5969
- static aiBotV1BotsBotUpdate(id, org, requestBody) {
5970
- return request(OpenAPI, {
5971
- method: 'PUT',
5972
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5973
- path: {
5974
- 'id': id,
5975
- 'org': org
5976
- },
5977
- body: requestBody,
5978
- mediaType: 'application/json'
5979
- });
5980
- }
5981
- /**
5982
- * Create modify and update bot information for a specific tenant.
5983
- * @param id A unique integer value identifying this bot.
5984
- * @param org
5985
- * @param requestBody
5986
- * @returns BotCreate
5987
- * @throws ApiError
5988
- */
5989
- static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
5990
- return request(OpenAPI, {
5991
- method: 'PATCH',
5992
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5993
- path: {
5994
- 'id': id,
5995
- 'org': org
5996
- },
5997
- body: requestBody,
5998
- mediaType: 'application/json'
5999
- });
6000
- }
6001
- /**
6002
- * Create modify and update bot information for a specific tenant.
6003
- * @param id A unique integer value identifying this bot.
6004
- * @param org
6005
- * @returns void
6006
- * @throws ApiError
6007
- */
6008
- static aiBotV1BotsBotDestroy(id, org) {
6009
- return request(OpenAPI, {
6010
- method: 'DELETE',
6011
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
6012
- path: {
6013
- 'id': id,
6014
- 'org': org
6015
- }
6016
- });
6017
- }
6018
- /**
6019
- * Create modify and update bot information for a specific tenant.
6020
- * @param id A unique integer value identifying this bot.
6021
- * @param org
6022
- * @returns DiscordConfig
6023
- * @throws ApiError
6024
- */
6025
- static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
6026
- return request(OpenAPI, {
6027
- method: 'GET',
6028
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
6029
- path: {
6030
- 'id': id,
6031
- 'org': org
6032
- }
6033
- });
6034
- }
6035
- /**
6036
- * Create modify and update bot information for a specific tenant.
6037
- * @param id A unique integer value identifying this bot.
6038
- * @param org
6039
- * @param requestBody
6040
- * @returns DiscordConfig
6041
- * @throws ApiError
6042
- */
6043
- static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
6044
- return request(OpenAPI, {
6045
- method: 'PATCH',
6046
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
6047
- path: {
6048
- 'id': id,
6049
- 'org': org
6050
- },
6051
- body: requestBody,
6052
- mediaType: 'application/json'
6053
- });
6054
- }
6055
- /**
6056
- * Create modify and update bot information for a specific tenant.
6057
- * @param id A unique integer value identifying this bot.
6058
- * @param org
6059
- * @returns SlackConfig
6060
- * @throws ApiError
6061
- */
6062
- static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
6063
- return request(OpenAPI, {
6064
- method: 'GET',
6065
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
6066
- path: {
6067
- 'id': id,
6068
- 'org': org
6069
- }
6070
- });
6071
- }
6072
- /**
6073
- * Create modify and update bot information for a specific tenant.
6074
- * @param id A unique integer value identifying this bot.
6075
- * @param org
6076
- * @param requestBody
6077
- * @returns SlackConfig
6078
- * @throws ApiError
6079
- */
6080
- static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
6081
- return request(OpenAPI, {
6082
- method: 'POST',
6083
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6084
- path: {
6085
- 'id': id,
6086
- 'org': org
6087
- },
6088
- body: requestBody,
6089
- mediaType: 'application/json'
6090
- });
6091
- }
6092
- /**
6093
- * Create modify and update bot information for a specific tenant.
6094
- * @param id A unique integer value identifying this bot.
6095
- * @param org
6096
- * @param requestBody
6097
- * @returns SlackConfig
6098
- * @throws ApiError
6099
- */
6100
- static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
6101
- return request(OpenAPI, {
6102
- method: 'PUT',
6103
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6104
- path: {
6105
- 'id': id,
6106
- 'org': org
6107
- },
6108
- body: requestBody,
6109
- mediaType: 'application/json'
6110
- });
6111
- }
6112
- /**
6113
- * Create modify and update bot information for a specific tenant.
6114
- * @param id A unique integer value identifying this bot.
6115
- * @param org
6116
- * @param requestBody
6117
- * @returns SlackConfig
6118
- * @throws ApiError
6119
- */
6120
- static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
6121
- return request(OpenAPI, {
6122
- method: 'PATCH',
6123
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
6124
- path: {
6125
- 'id': id,
6126
- 'org': org
6127
- },
6128
- body: requestBody,
6129
- mediaType: 'application/json'
6130
- });
6131
- }
6132
- /**
6133
- * Create modify and update bot information for a specific tenant.
6134
- * @param id A unique integer value identifying this bot.
6135
- * @param org
6136
- * @returns TeamsConfig
6137
- * @throws ApiError
6138
- */
6139
- static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
6140
- return request(OpenAPI, {
6141
- method: 'GET',
6142
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
6143
- path: {
6144
- 'id': id,
6145
- 'org': org
6146
- }
6147
- });
6148
- }
6149
- /**
6150
- * Create modify and update bot information for a specific tenant.
6151
- * @param id A unique integer value identifying this bot.
6152
- * @param org
6153
- * @param requestBody
6154
- * @returns TeamsConfig
6155
- * @throws ApiError
6156
- */
6157
- static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
6158
- return request(OpenAPI, {
6159
- method: 'POST',
6160
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6161
- path: {
6162
- 'id': id,
6163
- 'org': org
6164
- },
6165
- body: requestBody,
6166
- mediaType: 'application/json'
6167
- });
6168
- }
6169
- /**
6170
- * Create modify and update bot information for a specific tenant.
6171
- * @param id A unique integer value identifying this bot.
6172
- * @param org
6173
- * @param requestBody
6174
- * @returns TeamsConfig
6175
- * @throws ApiError
6176
- */
6177
- static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
6178
- return request(OpenAPI, {
6179
- method: 'PUT',
6180
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6181
- path: {
6182
- 'id': id,
6183
- 'org': org
6184
- },
6185
- body: requestBody,
6186
- mediaType: 'application/json'
6187
- });
6188
- }
6189
- /**
6190
- * Create modify and update bot information for a specific tenant.
6191
- * @param id A unique integer value identifying this bot.
6192
- * @param org
6193
- * @param requestBody
6194
- * @returns TeamsConfig
6195
- * @throws ApiError
6196
- */
6197
- static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
6198
- return request(OpenAPI, {
6199
- method: 'PATCH',
6200
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
6201
- path: {
6202
- 'id': id,
6203
- 'org': org
6204
- },
6205
- body: requestBody,
6206
- mediaType: 'application/json'
6207
- });
6208
- }
6209
- /**
6210
- * Create modify and update bot information for a specific tenant.
6211
- * @param id A unique integer value identifying this bot.
6212
- * @param org
6213
- * @returns WebexConfig
6214
- * @throws ApiError
6215
- */
6216
- static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
6217
- return request(OpenAPI, {
6218
- method: 'GET',
6219
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
6220
- path: {
6221
- 'id': id,
6222
- 'org': org
6223
- }
6224
- });
6225
- }
6226
- /**
6227
- * Create modify and update bot information for a specific tenant.
6228
- * @param id A unique integer value identifying this bot.
6229
- * @param org
6230
- * @param requestBody
6231
- * @returns WebexConfig
6232
- * @throws ApiError
6233
- */
6234
- static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
6235
- return request(OpenAPI, {
6236
- method: 'PATCH',
6237
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
6238
- path: {
6239
- 'id': id,
6240
- 'org': org
6241
- },
6242
- body: requestBody,
6243
- mediaType: 'application/json'
6244
- });
6245
- }
6246
- /**
6247
- * Create modify and update bot information for a specific tenant.
6248
- * @param id A unique integer value identifying this bot.
6249
- * @param org
6250
- * @returns WhatsappConfig
6251
- * @throws ApiError
6252
- */
6253
- static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
6254
- return request(OpenAPI, {
6255
- method: 'GET',
6256
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
6257
- path: {
6258
- 'id': id,
6259
- 'org': org
6260
- }
6261
- });
6262
- }
6263
- /**
6264
- * Create modify and update bot information for a specific tenant.
6265
- * @param id A unique integer value identifying this bot.
6266
- * @param org
6267
- * @param requestBody
6268
- * @returns WhatsappConfig
6269
- * @throws ApiError
6270
- */
6271
- static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
6272
- return request(OpenAPI, {
6273
- method: 'PUT',
6274
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
6275
- path: {
6276
- 'id': id,
6277
- 'org': org
6278
- },
6279
- body: requestBody,
6280
- mediaType: 'application/json'
6281
- });
6282
- }
6283
- /**
6284
- * Create modify and update bot information for a specific tenant.
6285
- * @param id A unique integer value identifying this bot.
6286
- * @param org
6287
- * @param requestBody
6288
- * @returns WhatsappConfig
6289
- * @throws ApiError
6290
- */
6291
- static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
6292
- return request(OpenAPI, {
6293
- method: 'PATCH',
6294
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
6295
- path: {
6296
- 'id': id,
6297
- 'org': org
6298
- },
6299
- body: requestBody,
6300
- mediaType: 'application/json'
6301
- });
6302
- }
6303
- /**
6304
- * Setup discord user id linkage with discord bots
6305
- * this will be used to authenticate the user when interracting with discord bots.
6306
- * the user id can be copied from the discord app after tapping on the user profile.
6307
- * @param org
6308
- * @returns DiscordUserConfig
6309
- * @throws ApiError
6310
- */
6311
- static aiBotV1BotsDiscordUserConfigList(org) {
6312
- return request(OpenAPI, {
6313
- method: 'GET',
6314
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
6315
- path: {
6316
- 'org': org
6317
- }
6318
- });
6319
- }
6320
- /**
6321
- * Setup discord user id linkage with discord bots
6322
- * this will be used to authenticate the user when interracting with discord bots.
6323
- * the user id can be copied from the discord app after tapping on the user profile.
6324
- * @param org
6325
- * @param requestBody
6326
- * @returns DiscordUserConfig
6327
- * @throws ApiError
6328
- */
6329
- static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
6330
- return request(OpenAPI, {
6331
- method: 'POST',
6332
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
6333
- path: {
6334
- 'org': org
6335
- },
6336
- body: requestBody,
6337
- mediaType: 'application/json'
6338
- });
6339
- }
6340
- /**
6341
- * Setup discord user id linkage with discord bots
6342
- * this will be used to authenticate the user when interracting with discord bots.
6343
- * the user id can be copied from the discord app after tapping on the user profile.
6344
- * @param id A unique integer value identifying this discord user config.
6345
- * @param org
6346
- * @returns DiscordUserConfig
6347
- * @throws ApiError
6348
- */
6349
- static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
6350
- return request(OpenAPI, {
6351
- method: 'GET',
6352
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6353
- path: {
6354
- 'id': id,
6355
- 'org': org
6356
- }
6357
- });
6358
- }
6359
- /**
6360
- * Setup discord user id linkage with discord bots
6361
- * this will be used to authenticate the user when interracting with discord bots.
6362
- * the user id can be copied from the discord app after tapping on the user profile.
6363
- * @param id A unique integer value identifying this discord user config.
6364
- * @param org
6365
- * @param requestBody
6366
- * @returns DiscordUserConfig
6367
- * @throws ApiError
6368
- */
6369
- static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
6370
- return request(OpenAPI, {
6371
- method: 'PUT',
6372
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6373
- path: {
6374
- 'id': id,
6375
- 'org': org
6376
- },
6377
- body: requestBody,
6378
- mediaType: 'application/json'
6379
- });
6380
- }
6381
- /**
6382
- * Setup discord user id linkage with discord bots
6383
- * this will be used to authenticate the user when interracting with discord bots.
6384
- * the user id can be copied from the discord app after tapping on the user profile.
6385
- * @param id A unique integer value identifying this discord user config.
6386
- * @param org
6387
- * @param requestBody
6388
- * @returns DiscordUserConfig
6389
- * @throws ApiError
6390
- */
6391
- static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
6392
- return request(OpenAPI, {
6393
- method: 'PATCH',
6394
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6395
- path: {
6396
- 'id': id,
6397
- 'org': org
6398
- },
6399
- body: requestBody,
6400
- mediaType: 'application/json'
6401
- });
6402
- }
6403
- /**
6404
- * Setup discord user id linkage with discord bots
6405
- * this will be used to authenticate the user when interracting with discord bots.
6406
- * the user id can be copied from the discord app after tapping on the user profile.
6407
- * @param id A unique integer value identifying this discord user config.
6408
- * @param org
6409
- * @returns void
6410
- * @throws ApiError
6411
- */
6412
- static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
6413
- return request(OpenAPI, {
6414
- method: 'DELETE',
6415
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
6416
- path: {
6417
- 'id': id,
6418
- 'org': org
6419
- }
6420
- });
6421
- }
6422
- /**
6423
- * Setup slack username and domain linkage with slack bots
6424
- * this will be used to authenticate the user when interracting with slack bots.
6425
- * @param org
6426
- * @returns SlackUserConfig
6427
- * @throws ApiError
6428
- */
6429
- static aiBotV1BotsSlackUserConfigList(org) {
6430
- return request(OpenAPI, {
6431
- method: 'GET',
6432
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
6433
- path: {
6434
- 'org': org
6435
- }
6436
- });
6437
- }
6438
- /**
6439
- * Setup slack username and domain linkage with slack bots
6440
- * this will be used to authenticate the user when interracting with slack bots.
6441
- * @param org
6442
- * @param requestBody
6443
- * @returns SlackUserConfig
6444
- * @throws ApiError
6445
- */
6446
- static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
6447
- return request(OpenAPI, {
6448
- method: 'POST',
6449
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
6450
- path: {
6451
- 'org': org
6452
- },
6453
- body: requestBody,
6454
- mediaType: 'application/json'
6455
- });
6456
- }
6457
- /**
6458
- * Setup slack username and domain linkage with slack bots
6459
- * this will be used to authenticate the user when interracting with slack bots.
6460
- * @param id A unique integer value identifying this slack user config.
6461
- * @param org
6462
- * @returns SlackUserConfig
6463
- * @throws ApiError
6464
- */
6465
- static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
6466
- return request(OpenAPI, {
6467
- method: 'GET',
6468
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6469
- path: {
6470
- 'id': id,
6471
- 'org': org
6472
- }
6473
- });
6474
- }
6475
- /**
6476
- * Setup slack username and domain linkage with slack bots
6477
- * this will be used to authenticate the user when interracting with slack bots.
6478
- * @param id A unique integer value identifying this slack user config.
6479
- * @param org
6480
- * @param requestBody
6481
- * @returns SlackUserConfig
6482
- * @throws ApiError
6483
- */
6484
- static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
6485
- return request(OpenAPI, {
6486
- method: 'PUT',
6487
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6488
- path: {
6489
- 'id': id,
6490
- 'org': org
6491
- },
6492
- body: requestBody,
6493
- mediaType: 'application/json'
6494
- });
6495
- }
6496
- /**
6497
- * Setup slack username and domain linkage with slack bots
6498
- * this will be used to authenticate the user when interracting with slack bots.
6499
- * @param id A unique integer value identifying this slack user config.
6500
- * @param org
6501
- * @param requestBody
6502
- * @returns SlackUserConfig
6503
- * @throws ApiError
6504
- */
6505
- static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
6506
- return request(OpenAPI, {
6507
- method: 'PATCH',
6508
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6509
- path: {
6510
- 'id': id,
6511
- 'org': org
6512
- },
6513
- body: requestBody,
6514
- mediaType: 'application/json'
6515
- });
6516
- }
6517
- /**
6518
- * Setup slack username and domain linkage with slack bots
6519
- * this will be used to authenticate the user when interracting with slack bots.
6520
- * @param id A unique integer value identifying this slack user config.
6521
- * @param org
6522
- * @returns void
6523
- * @throws ApiError
6524
- */
6525
- static aiBotV1BotsSlackUserConfigDestroy(id, org) {
6526
- return request(OpenAPI, {
6527
- method: 'DELETE',
6528
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
6529
- path: {
6530
- 'id': id,
6531
- 'org': org
6532
- }
6533
- });
6534
- }
6535
- /**
6536
- * Setup phone number linkage with whatsapp bots
6537
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6538
- * @param org
6539
- * @returns WhatsappUserConfig
6540
- * @throws ApiError
6541
- */
6542
- static aiBotV1BotsWhatsappUserConfigList(org) {
6543
- return request(OpenAPI, {
6544
- method: 'GET',
6545
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
6546
- path: {
6547
- 'org': org
6548
- }
6549
- });
6550
- }
6551
- /**
6552
- * Setup phone number linkage with whatsapp bots
6553
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6554
- * @param org
6555
- * @param requestBody
6556
- * @returns WhatsappUserConfig
6557
- * @throws ApiError
6558
- */
6559
- static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
6560
- return request(OpenAPI, {
6561
- method: 'POST',
6562
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
6563
- path: {
6564
- 'org': org
6565
- },
6566
- body: requestBody,
6567
- mediaType: 'application/json'
6568
- });
6569
- }
6570
- /**
6571
- * Setup phone number linkage with whatsapp bots
6572
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6573
- * @param id A unique integer value identifying this whatsapp user config.
6574
- * @param org
6575
- * @returns WhatsappUserConfig
6576
- * @throws ApiError
6577
- */
6578
- static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
6579
- return request(OpenAPI, {
6580
- method: 'GET',
6581
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6582
- path: {
6583
- 'id': id,
6584
- 'org': org
6585
- }
6586
- });
6587
- }
6588
- /**
6589
- * Setup phone number linkage with whatsapp bots
6590
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6591
- * @param id A unique integer value identifying this whatsapp user config.
6592
- * @param org
6593
- * @param requestBody
6594
- * @returns WhatsappUserConfig
6595
- * @throws ApiError
6596
- */
6597
- static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
6598
- return request(OpenAPI, {
6599
- method: 'PUT',
6600
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6601
- path: {
6602
- 'id': id,
6603
- 'org': org
6604
- },
6605
- body: requestBody,
6606
- mediaType: 'application/json'
6607
- });
6608
- }
6609
- /**
6610
- * Setup phone number linkage with whatsapp bots
6611
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6612
- * @param id A unique integer value identifying this whatsapp user config.
6613
- * @param org
6614
- * @param requestBody
6615
- * @returns WhatsappUserConfig
6616
- * @throws ApiError
6617
- */
6618
- static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
6619
- return request(OpenAPI, {
6620
- method: 'PATCH',
6621
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6622
- path: {
6623
- 'id': id,
6624
- 'org': org
6625
- },
6626
- body: requestBody,
6627
- mediaType: 'application/json'
6628
- });
6629
- }
6630
- /**
6631
- * Setup phone number linkage with whatsapp bots
6632
- * This phone number will be used to authenticate and allow access to whatsapp bots.
6633
- * @param id A unique integer value identifying this whatsapp user config.
6634
- * @param org
6635
- * @returns void
6636
- * @throws ApiError
6637
- */
6638
- static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
6639
- return request(OpenAPI, {
6640
- method: 'DELETE',
6641
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
6642
- path: {
6643
- 'id': id,
6644
- 'org': org
6645
- }
6646
- });
6647
- }
6648
- /**
6649
- * Webhook endpoint to receive and process discord messages.
6650
- * @param name
6651
- * @param org
6652
- * @param requestBody
6653
- * @returns DiscordWebhook
6654
- * @throws ApiError
6655
- */
6656
- static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
6657
- return request(OpenAPI, {
6658
- method: 'POST',
6659
- url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
6660
- path: {
6661
- 'name': name,
6662
- 'org': org
6663
- },
6664
- body: requestBody,
6665
- mediaType: 'application/json'
6666
- });
6667
- }
6668
- /**
6669
- * @param name
6670
- * @param org
6671
- * @param requestBody
6672
- * @returns SlackWebhook
6673
- * @throws ApiError
6674
- */
6675
- static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
6676
- return request(OpenAPI, {
6677
- method: 'POST',
6678
- url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
6679
- path: {
6680
- 'name': name,
6681
- 'org': org
6682
- },
6683
- body: requestBody,
6684
- mediaType: 'application/json'
6685
- });
6686
- }
6687
- /**
6688
- * @param name
6689
- * @param org
6690
- * @param requestBody
6691
- * @returns TeamsWebhook
6692
- * @throws ApiError
6693
- */
6694
- static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
6695
- return request(OpenAPI, {
6696
- method: 'POST',
6697
- url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
6698
- path: {
6699
- 'name': name,
6700
- 'org': org
6701
- },
6702
- body: requestBody,
6703
- mediaType: 'application/json'
6704
- });
6705
- }
6706
- /**
6707
- * Webhook endpoint to receive and process discord messages.
6708
- * @param name
6709
- * @param org
6710
- * @param requestBody
6711
- * @returns WebexWebhook
6712
- * @throws ApiError
6713
- */
6714
- static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
6715
- return request(OpenAPI, {
6716
- method: 'POST',
6717
- url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
6718
- path: {
6719
- 'name': name,
6720
- 'org': org
6721
- },
6722
- body: requestBody,
6723
- mediaType: 'application/json'
6724
- });
6725
- }
6726
- /**
6727
- * Respond to whatsapp's webhook challenge.
6728
- * Parameters Required include the tenant key (org) and the name of the bot: (name)
6729
- * @param name
6730
- * @param org
6731
- * @returns WhatAppWebHook
6732
- * @throws ApiError
6733
- */
6734
- static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
6735
- return request(OpenAPI, {
6736
- method: 'GET',
6737
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
6738
- path: {
6739
- 'name': name,
6740
- 'org': org
6741
- }
6742
- });
6743
- }
6744
- /**
6745
- * Accept and process webhook events from whatsapp.
6746
- * @param name
6747
- * @param org
6748
- * @param requestBody
6749
- * @returns WhatAppWebHook
6750
- * @throws ApiError
6751
- */
6752
- static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
6753
- return request(OpenAPI, {
6754
- method: 'POST',
6755
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
6756
- path: {
6757
- 'name': name,
6758
- 'org': org
6759
- },
6760
- body: requestBody,
6761
- mediaType: 'application/json'
6762
- });
6763
- }
6764
- }
6765
-
6766
- class AiFinetuningService {
6767
- /**
6768
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6769
- * @param org
6770
- * @param username
6771
- * @param dateCreated
6772
- * @param numDataPoints
6773
- * @param ordering Which field to use when ordering the results.
6774
- * @param page A page number within the paginated result set.
6775
- * @param pageSize Number of results to return per page.
6776
- * @param retryAttempts
6777
- * @param search A search term.
6778
- * @param status * `pending` - Pending
6779
- * * `processing` - Processing
6780
- * * `completed` - Completed
6781
- * * `failed` - Failed
6782
- * @returns PaginatedDataSetList
6783
- * @throws ApiError
6784
- */
6785
- static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
6786
- return request(OpenAPI, {
6787
- method: 'GET',
6788
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
6789
- path: {
6790
- 'org': org,
6791
- 'username': username
6792
- },
6793
- query: {
6794
- 'date_created': dateCreated,
6795
- 'num_data_points': numDataPoints,
6796
- 'ordering': ordering,
6797
- 'page': page,
6798
- 'page_size': pageSize,
6799
- 'retry_attempts': retryAttempts,
6800
- 'search': search,
6801
- 'status': status
6802
- }
6803
- });
6804
- }
6805
- /**
6806
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6807
- * @param org
6808
- * @param username
6809
- * @param requestBody
6810
- * @returns DataSetCreate
6811
- * @throws ApiError
6812
- */
6813
- static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
6814
- return request(OpenAPI, {
6815
- method: 'POST',
6816
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
6817
- path: {
6818
- 'org': org,
6819
- 'username': username
6820
- },
6821
- body: requestBody,
6822
- mediaType: 'application/json'
6823
- });
6824
- }
6825
- /**
6826
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6827
- * @param id A UUID string identifying this data set.
6828
- * @param org
6829
- * @param username
6830
- * @returns DataSet
6831
- * @throws ApiError
6832
- */
6833
- static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
6834
- return request(OpenAPI, {
6835
- method: 'GET',
6836
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6837
- path: {
6838
- 'id': id,
6839
- 'org': org,
6840
- 'username': username
6841
- }
6842
- });
6843
- }
6844
- /**
6845
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6846
- * @param id A UUID string identifying this data set.
6847
- * @param org
6848
- * @param username
6849
- * @param requestBody
6850
- * @returns DataSet
6851
- * @throws ApiError
6852
- */
6853
- static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
6854
- return request(OpenAPI, {
6855
- method: 'PUT',
6856
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6857
- path: {
6858
- 'id': id,
6859
- 'org': org,
6860
- 'username': username
6861
- },
6862
- body: requestBody,
6863
- mediaType: 'application/json'
6864
- });
6865
- }
6866
- /**
6867
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6868
- * @param id A UUID string identifying this data set.
6869
- * @param org
6870
- * @param username
6871
- * @param requestBody
6872
- * @returns DataSet
6873
- * @throws ApiError
6874
- */
6875
- static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
6876
- return request(OpenAPI, {
6877
- method: 'PATCH',
6878
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6879
- path: {
6880
- 'id': id,
6881
- 'org': org,
6882
- 'username': username
6883
- },
6884
- body: requestBody,
6885
- mediaType: 'application/json'
6886
- });
6887
- }
6888
- /**
6889
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6890
- * @param id A UUID string identifying this data set.
6891
- * @param org
6892
- * @param username
6893
- * @returns void
6894
- * @throws ApiError
6895
- */
6896
- static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
6897
- return request(OpenAPI, {
6898
- method: 'DELETE',
6899
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6900
- path: {
6901
- 'id': id,
6902
- 'org': org,
6903
- 'username': username
6904
- }
6905
- });
6906
- }
6907
- /**
6908
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6909
- * @param org
6910
- * @param username
6911
- * @param baseModelName
6912
- * @param dataset
6913
- * @param dateCreated
6914
- * @param fineTunedModel
6915
- * @param lastModified
6916
- * @param ordering Which field to use when ordering the results.
6917
- * @param page A page number within the paginated result set.
6918
- * @param pageSize Number of results to return per page.
6919
- * @param preprocessDataset
6920
- * @param provider * `openai` - Openai
6921
- * @param search A search term.
6922
- * @param status * `pending` - Pending
6923
- * * `processing` - Processing
6924
- * * `completed` - Completed
6925
- * * `cancelled` - Cancelled
6926
- * * `failed` - Failed
6927
- * @returns PaginatedTrainingList
6928
- * @throws ApiError
6929
- */
6930
- static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
6931
- return request(OpenAPI, {
6932
- method: 'GET',
6933
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
6934
- path: {
6935
- 'org': org,
6936
- 'username': username
6937
- },
6938
- query: {
6939
- 'base_model_name': baseModelName,
6940
- 'dataset': dataset,
6941
- 'date_created': dateCreated,
6942
- 'fine_tuned_model': fineTunedModel,
6943
- 'last_modified': lastModified,
6944
- 'ordering': ordering,
6945
- 'page': page,
6946
- 'page_size': pageSize,
6947
- 'preprocess_dataset': preprocessDataset,
6948
- 'provider': provider,
6949
- 'search': search,
6950
- 'status': status
5465
+ 'org': org,
5466
+ 'user_id': userId
5467
+ },
5468
+ query: {
5469
+ 'department_id': departmentId,
5470
+ 'end_date': endDate,
5471
+ 'format': format,
5472
+ 'include_main_platform': includeMainPlatform,
5473
+ 'start_date': startDate
6951
5474
  }
6952
5475
  });
6953
5476
  }
6954
5477
  /**
6955
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
5478
+ * Get average grade value for platform, course, or user.
5479
+ *
5480
+ * This endpoint returns the average grade at different levels:
5481
+ * - Platform level: Average grade across all courses
5482
+ * - Course level: Average grade for a specific course
5483
+ * - Learner level: Average grade for a specific learner
5484
+ * - Course-learner level: Grade for a specific learner in a specific course
5485
+ *
5486
+ * Query Parameters:
5487
+ * course_id (str, optional): Filter by course ID
5488
+ * learner_id (str, optional): Filter by username or email
5489
+ *
5490
+ * Returns:
5491
+ * The average grade value based on the specified filters.
5492
+ *
5493
+ * Access Control:
5494
+ * - Platform admins can access any grade data
5495
+ * - Learners can access their own grade data
6956
5496
  * @param org
6957
- * @param username
6958
- * @param requestBody
6959
- * @returns TrainingCreate
5497
+ * @param userId
5498
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5499
+ * @param format Format
5500
+ *
5501
+ * * `json` - json
5502
+ * @param includeMainPlatform Include main platform data
5503
+ * @returns Average
6960
5504
  * @throws ApiError
6961
5505
  */
6962
- static aiFinetuningV1OrgUserTrainingsCreate(org, username, requestBody) {
5506
+ static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve(org, userId, departmentId, format = 'json', includeMainPlatform = true) {
6963
5507
  return request(OpenAPI, {
6964
- method: 'POST',
6965
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
5508
+ method: 'GET',
5509
+ url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/grades/average',
6966
5510
  path: {
6967
5511
  'org': org,
6968
- 'username': username
5512
+ 'user_id': userId
6969
5513
  },
6970
- body: requestBody,
6971
- mediaType: 'application/json'
5514
+ query: {
5515
+ 'department_id': departmentId,
5516
+ 'format': format,
5517
+ 'include_main_platform': includeMainPlatform
5518
+ }
6972
5519
  });
6973
5520
  }
6974
5521
  /**
6975
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6976
- * @param id A UUID string identifying this training.
5522
+ * Evaluates performance index for platform, per course, per user and per user-per course
5523
+ *
5524
+ * Query Params
5525
+ * course_id <optional>
5526
+ * learner_id <optional>
6977
5527
  * @param org
6978
- * @param username
6979
- * @returns Training
5528
+ * @param userId
5529
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5530
+ * @param endDate end date. ISO 8601
5531
+ * @param format Format
5532
+ *
5533
+ * * `json` - json
5534
+ * @param includeMainPlatform Include main platform data
5535
+ * @param startDate start date. ISO 8601
5536
+ * @returns Value
6980
5537
  * @throws ApiError
6981
5538
  */
6982
- static aiFinetuningV1OrgUserTrainingsRetrieve(id, org, username) {
5539
+ static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
6983
5540
  return request(OpenAPI, {
6984
5541
  method: 'GET',
6985
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
5542
+ url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/performance-index',
6986
5543
  path: {
6987
- 'id': id,
6988
5544
  'org': org,
6989
- 'username': username
5545
+ 'user_id': userId
5546
+ },
5547
+ query: {
5548
+ 'department_id': departmentId,
5549
+ 'end_date': endDate,
5550
+ 'format': format,
5551
+ 'include_main_platform': includeMainPlatform,
5552
+ 'start_date': startDate
6990
5553
  }
6991
5554
  });
6992
5555
  }
6993
5556
  /**
6994
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6995
- * @param id A UUID string identifying this training.
5557
+ * Time spent in secs on a per-day basis
5558
+ *
5559
+ * Query Params
5560
+ * 1. course_id <optional> e.g course-v1:Org+Course4+Run
5561
+ * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
5562
+ * 3. start_date e.g 2020-10-01
5563
+ * 4. end_date e.g 2020-10-10
5564
+ *
5565
+ * Default result when no query param is added is last_7_days (today inclusive)
6996
5566
  * @param org
6997
- * @param username
6998
- * @param requestBody
6999
- * @returns TrainingCreate
5567
+ * @param userId
5568
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5569
+ * @param endDate end date. ISO 8601
5570
+ * @param format Format
5571
+ *
5572
+ * * `json` - json
5573
+ * @param includeMainPlatform Include main platform data
5574
+ * @param startDate start date. ISO 8601
5575
+ * @returns OverTimeWithTotal
7000
5576
  * @throws ApiError
7001
5577
  */
7002
- static aiFinetuningV1OrgUserTrainingsUpdate(id, org, username, requestBody) {
5578
+ static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
7003
5579
  return request(OpenAPI, {
7004
- method: 'PUT',
7005
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
5580
+ method: 'GET',
5581
+ url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/overview/time/over-time',
7006
5582
  path: {
7007
- 'id': id,
7008
5583
  'org': org,
7009
- 'username': username
5584
+ 'user_id': userId
7010
5585
  },
7011
- body: requestBody,
7012
- mediaType: 'application/json'
5586
+ query: {
5587
+ 'department_id': departmentId,
5588
+ 'end_date': endDate,
5589
+ 'format': format,
5590
+ 'include_main_platform': includeMainPlatform,
5591
+ 'start_date': startDate
5592
+ }
7013
5593
  });
7014
5594
  }
7015
5595
  /**
7016
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7017
- * @param id A UUID string identifying this training.
5596
+ * Get video watch counts over time.
5597
+ *
5598
+ * This endpoint provides daily counts of videos watched over a specified time period,
5599
+ * with options to filter by course or user.
5600
+ *
5601
+ * Query Parameters:
5602
+ * start_date (str, optional): Start date for the time range (ISO format)
5603
+ * end_date (str, optional): End date for the time range (ISO format)
5604
+ * course_id (str, optional): Filter by course ID
5605
+ * user_id (str, optional): Filter by username or email
5606
+ *
5607
+ * Returns:
5608
+ * Daily video watch counts over the specified time period.
5609
+ *
5610
+ * Default time range is the last 7 days if no dates are specified.
5611
+ *
5612
+ * Access Control:
5613
+ * - Platform admins can access any video watch data
5614
+ * - Learners can access their own video watch data
7018
5615
  * @param org
7019
- * @param username
7020
- * @param requestBody
7021
- * @returns TrainingCreate
5616
+ * @param userId
5617
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5618
+ * @param endDate end date. ISO 8601
5619
+ * @param format Format
5620
+ *
5621
+ * * `json` - json
5622
+ * @param includeMainPlatform Include main platform data
5623
+ * @param startDate start date. ISO 8601
5624
+ * @returns OverTimeWithTotal
7022
5625
  * @throws ApiError
7023
5626
  */
7024
- static aiFinetuningV1OrgUserTrainingsPartialUpdate(id, org, username, requestBody) {
5627
+ static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
7025
5628
  return request(OpenAPI, {
7026
- method: 'PATCH',
7027
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
5629
+ method: 'GET',
5630
+ url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/over-time',
7028
5631
  path: {
7029
- 'id': id,
7030
5632
  'org': org,
7031
- 'username': username
5633
+ 'user_id': userId
7032
5634
  },
7033
- body: requestBody,
7034
- mediaType: 'application/json'
5635
+ query: {
5636
+ 'department_id': departmentId,
5637
+ 'end_date': endDate,
5638
+ 'format': format,
5639
+ 'include_main_platform': includeMainPlatform,
5640
+ 'start_date': startDate
5641
+ }
7035
5642
  });
7036
5643
  }
7037
5644
  /**
7038
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7039
- * @param id A UUID string identifying this training.
5645
+ * Summary Videos watched data for a learner per enrollment
5646
+ *
5647
+ * Query Params
5648
+ * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
7040
5649
  * @param org
7041
- * @param username
7042
- * @returns void
5650
+ * @param userId
5651
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5652
+ * @param endDate end date. ISO 8601
5653
+ * @param format Format
5654
+ *
5655
+ * * `json` - json
5656
+ * @param includeMainPlatform Include main platform data
5657
+ * @param startDate start date. ISO 8601
5658
+ * @returns PerlearnerEngagementVideosWatchedPerCourse
7043
5659
  * @throws ApiError
7044
5660
  */
7045
- static aiFinetuningV1OrgUserTrainingsDestroy(id, org, username) {
5661
+ static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve(org, userId, departmentId, endDate, format = 'json', includeMainPlatform = true, startDate) {
7046
5662
  return request(OpenAPI, {
7047
- method: 'DELETE',
7048
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
5663
+ method: 'GET',
5664
+ url: '/api/ai-analytics/perlearner/orgs/{org}/users/{user_id}/videos/per-course',
7049
5665
  path: {
7050
- 'id': id,
7051
5666
  'org': org,
7052
- 'username': username
5667
+ 'user_id': userId
5668
+ },
5669
+ query: {
5670
+ 'department_id': departmentId,
5671
+ 'end_date': endDate,
5672
+ 'format': format,
5673
+ 'include_main_platform': includeMainPlatform,
5674
+ 'start_date': startDate
7053
5675
  }
7054
5676
  });
7055
5677
  }
7056
5678
  /**
7057
- * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
7058
- * Filtering and pagination is allowed.
5679
+ * Get a list of user groups with metrics and filtering options.
5680
+ *
5681
+ * This endpoint provides a paginated list of user groups with aggregated metrics
5682
+ * about learner performance, course completions, and skill acquisition.
5683
+ *
5684
+ * This endpoint uses DM token authentication and respects department-based
5685
+ * access controls.
5686
+ *
5687
+ * Query Parameters:
5688
+ * page (int, optional): Page number for pagination
5689
+ * length (int, optional): Number of items per page
5690
+ * program (str, optional): Filter by program
5691
+ * pathway (str, optional): Filter by pathway
5692
+ * groups (list, optional): Filter by group names
5693
+ * location (str, optional): Filter by location
5694
+ * is_enrolled (bool, optional): Filter for groups with enrolled users
5695
+ * start_date (date, optional): Filter by learner join date (start range)
5696
+ * end_date (date, optional): Filter by learner join date (end range)
7059
5697
  *
7060
- * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
7061
- * training list endpoint.
7062
5698
  * Returns:
7063
- * Response: A paginated response containing the serialized fine-tuned models.
5699
+ * A paginated list of user groups with comprehensive metrics.
5700
+ *
5701
+ * Access Control:
5702
+ * - Platform admins can see all groups
5703
+ * - Department admins can only see groups in their departments
7064
5704
  * @param org
7065
- * @param username
7066
- * @returns Training
5705
+ * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
5706
+ * @param endDate Filter by learners date_joined. Start date. ISO 8601
5707
+ * @param format Format
5708
+ *
5709
+ * * `json` - json
5710
+ * @param groups Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
5711
+ * @param includeMainPlatform Include main platform data
5712
+ * @param isEnrolled Filter for users who have at least an enrollment
5713
+ * @param length Size of data to return
5714
+ * @param location Location search string
5715
+ * @param page Page offset
5716
+ * @param pathway Pathway string
5717
+ * @param program Program search string
5718
+ * @param startDate Filter by learners date_joined. Start date. ISO 8601
5719
+ * @returns GroupList
7067
5720
  * @throws ApiError
7068
5721
  */
7069
- static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve(org, username) {
5722
+ static aiAnalyticsUserGroupsOrgsRetrieve(org, departmentId, endDate, format = 'json', groups, includeMainPlatform = true, isEnrolled, length, location, page, pathway, program, startDate) {
7070
5723
  return request(OpenAPI, {
7071
5724
  method: 'GET',
7072
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
5725
+ url: '/api/ai-analytics/user-groups/orgs/{org}/',
7073
5726
  path: {
7074
- 'org': org,
7075
- 'username': username
5727
+ 'org': org
5728
+ },
5729
+ query: {
5730
+ 'department_id': departmentId,
5731
+ 'end_date': endDate,
5732
+ 'format': format,
5733
+ 'groups': groups,
5734
+ 'include_main_platform': includeMainPlatform,
5735
+ 'is_enrolled': isEnrolled,
5736
+ 'length': length,
5737
+ 'location': location,
5738
+ 'page': page,
5739
+ 'pathway': pathway,
5740
+ 'program': program,
5741
+ 'start_date': startDate
7076
5742
  }
7077
5743
  });
7078
5744
  }
@@ -20684,10 +19350,10 @@
20684
19350
  });
20685
19351
  }
20686
19352
  /**
20687
- * Retrieve catalog-compatible completion information for a user
19353
+ * Retrieve catalog-compatible completion info for user
20688
19354
  * @param userId The user identifier
20689
19355
  * @param fieldKey Specific field to include in the response
20690
- * @returns CourseCompletionCatalogResponse
19356
+ * @returns any
20691
19357
  * @throws ApiError
20692
19358
  */
20693
19359
  static catalogMilestonesCompletionsCourseCatalogRetrieve(userId, fieldKey) {
@@ -20710,7 +19376,7 @@
20710
19376
  * Retrieve completion information for a specific user and course
20711
19377
  * @param courseId The course identifier (e.g., 'course-v1:org+code+run')
20712
19378
  * @param userId The user identifier
20713
- * @returns CourseCompletion
19379
+ * @returns any
20714
19380
  * @throws ApiError
20715
19381
  */
20716
19382
  static catalogMilestonesCompletionsCourseManageRetrieve(courseId, userId) {
@@ -20734,7 +19400,7 @@
20734
19400
  * @param courseId The course identifier (e.g., 'course-v1:org+code+run')
20735
19401
  * @param userId The user identifier
20736
19402
  * @param requestBody
20737
- * @returns CourseCompletion
19403
+ * @returns any
20738
19404
  * @throws ApiError
20739
19405
  */
20740
19406
  static catalogMilestonesCompletionsCourseManageCreate(courseId, userId, requestBody) {
@@ -20860,7 +19526,7 @@
20860
19526
  * Retrieve skill point information for a specific block
20861
19527
  * @param blockId ID of the block to retrieve skill point information for
20862
19528
  * @param getObj If True, returns skill objects instead of skill names as keys
20863
- * @returns BlockSkillPointInfoResponse
19529
+ * @returns any
20864
19530
  * @throws ApiError
20865
19531
  */
20866
19532
  static catalogMilestonesSkillPointsBlockRetrieve(blockId, getObj = false) {
@@ -20909,7 +19575,7 @@
20909
19575
  * Retrieve skill point information for a specific course
20910
19576
  * @param courseId ID of the course to retrieve skill point information for
20911
19577
  * @param getObj If True, returns skill objects instead of skill names as keys
20912
- * @returns CourseSkillPointInfoResponse
19578
+ * @returns any
20913
19579
  * @throws ApiError
20914
19580
  */
20915
19581
  static catalogMilestonesSkillPointsCourseRetrieve(courseId, getObj = false) {
@@ -21086,7 +19752,7 @@
21086
19752
  * Retrieve skill point information for a specific user
21087
19753
  * @param userId ID of the user to retrieve skill point information for
21088
19754
  * @param username Username to retrieve skill point information for
21089
- * @returns UserSkillPointInfoResponse
19755
+ * @returns any
21090
19756
  * @throws ApiError
21091
19757
  */
21092
19758
  static catalogMilestonesSkillPointsUserRetrieve(userId, username) {
@@ -33636,8 +32302,6 @@
33636
32302
 
33637
32303
  exports.AiAccountService = AiAccountService;
33638
32304
  exports.AiAnalyticsService = AiAnalyticsService;
33639
- exports.AiBotService = AiBotService;
33640
- exports.AiFinetuningService = AiFinetuningService;
33641
32305
  exports.AiIndexService = AiIndexService;
33642
32306
  exports.AiMarketingService = AiMarketingService;
33643
32307
  exports.AiMediaService = AiMediaService;