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