@iblai/iblai-api 3.35.5-ai-plus → 3.35.6-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.
- package/dist/index.cjs.js +239 -1555
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +240 -1554
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +239 -1555
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +3 -40
- package/dist/types/models/MarkAllReadRequest.d.ts +9 -0
- package/dist/types/models/MarkAllReadResponse.d.ts +7 -0
- package/dist/types/models/Notification.d.ts +1 -0
- package/dist/types/models/PatchedNotification.d.ts +1 -0
- package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
- package/dist/types/models/Voice.d.ts +2 -2
- package/dist/types/services/CredentialsService.d.ts +3 -1
- package/dist/types/services/NotificationService.d.ts +10 -0
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +3 -40
- package/src/models/MarkAllReadRequest.ts +14 -0
- package/src/models/MarkAllReadResponse.ts +12 -0
- package/src/models/Notification.ts +1 -0
- package/src/models/PatchedNotification.ts +1 -0
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/Voice.ts +2 -2
- package/src/services/CredentialsService.ts +3 -1
- package/src/services/NotificationService.ts +23 -0
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '3.35.
|
|
113
|
+
VERSION: '3.35.6-ai',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -231,24 +231,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
|
|
|
231
231
|
CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
|
|
232
232
|
})(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
|
|
233
233
|
|
|
234
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
235
|
-
/* istanbul ignore file */
|
|
236
|
-
/* tslint:disable */
|
|
237
|
-
/* eslint-disable */
|
|
238
|
-
/**
|
|
239
|
-
* * `pending` - Pending
|
|
240
|
-
* * `processing` - Processing
|
|
241
|
-
* * `completed` - Completed
|
|
242
|
-
* * `failed` - Failed
|
|
243
|
-
*/
|
|
244
|
-
exports.DataSetStatusEnum = void 0;
|
|
245
|
-
(function (DataSetStatusEnum) {
|
|
246
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
247
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
248
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
249
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
250
|
-
})(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
|
|
251
|
-
|
|
252
234
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
253
235
|
/* istanbul ignore file */
|
|
254
236
|
/* tslint:disable */
|
|
@@ -531,37 +513,21 @@ exports.PromptVisibilityEnum = void 0;
|
|
|
531
513
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
532
514
|
})(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
|
|
533
515
|
|
|
534
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
535
|
-
/* istanbul ignore file */
|
|
536
|
-
/* tslint:disable */
|
|
537
|
-
/* eslint-disable */
|
|
538
|
-
/**
|
|
539
|
-
* * `webex` - Webex
|
|
540
|
-
* * `slack` - Slack
|
|
541
|
-
* * `whatsapp` - Whatsapp
|
|
542
|
-
* * `discord` - Discord
|
|
543
|
-
* * `teams` - Teams
|
|
544
|
-
*/
|
|
545
|
-
exports.Provider05cEnum = void 0;
|
|
546
|
-
(function (Provider05cEnum) {
|
|
547
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
548
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
549
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
550
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
551
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
552
|
-
})(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
|
|
553
|
-
|
|
554
516
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
555
517
|
/* istanbul ignore file */
|
|
556
518
|
/* tslint:disable */
|
|
557
519
|
/* eslint-disable */
|
|
558
520
|
/**
|
|
559
521
|
* * `openai` - Openai
|
|
522
|
+
* * `google` - Google
|
|
523
|
+
* * `elevenlabs` - Elevenlabs
|
|
560
524
|
*/
|
|
561
|
-
exports.
|
|
562
|
-
(function (
|
|
563
|
-
|
|
564
|
-
|
|
525
|
+
exports.ProviderEnum = void 0;
|
|
526
|
+
(function (ProviderEnum) {
|
|
527
|
+
ProviderEnum["OPENAI"] = "openai";
|
|
528
|
+
ProviderEnum["GOOGLE"] = "google";
|
|
529
|
+
ProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
530
|
+
})(exports.ProviderEnum || (exports.ProviderEnum = {}));
|
|
565
531
|
|
|
566
532
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
567
533
|
/* istanbul ignore file */
|
|
@@ -717,22 +683,6 @@ exports.TypeC42Enum = void 0;
|
|
|
717
683
|
TypeC42Enum["ASSESSMENT"] = "assessment";
|
|
718
684
|
})(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
|
|
719
685
|
|
|
720
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
721
|
-
/* istanbul ignore file */
|
|
722
|
-
/* tslint:disable */
|
|
723
|
-
/* eslint-disable */
|
|
724
|
-
/**
|
|
725
|
-
* * `openai` - Openai
|
|
726
|
-
* * `google` - Google
|
|
727
|
-
* * `elevenlabs` - Elevenlabs
|
|
728
|
-
*/
|
|
729
|
-
exports.VoiceProviderEnum = void 0;
|
|
730
|
-
(function (VoiceProviderEnum) {
|
|
731
|
-
VoiceProviderEnum["OPENAI"] = "openai";
|
|
732
|
-
VoiceProviderEnum["GOOGLE"] = "google";
|
|
733
|
-
VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
734
|
-
})(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
|
|
735
|
-
|
|
736
686
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
737
687
|
/* istanbul ignore file */
|
|
738
688
|
/* tslint:disable */
|
|
@@ -2768,1561 +2718,277 @@ class AiAnalyticsService {
|
|
|
2768
2718
|
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2769
2719
|
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
2770
2720
|
* mentor_id (str): Filter by mentor unique ID.
|
|
2771
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
2772
|
-
* @param org
|
|
2773
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2774
|
-
* @param userId
|
|
2775
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
2776
|
-
* @param mentorId Filter by mentor unique ID
|
|
2777
|
-
* @returns UserTrendByPeriod
|
|
2778
|
-
* @throws ApiError
|
|
2779
|
-
*/
|
|
2780
|
-
static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(endDate, org, startDate, userId, aggregation = 'daily', mentorId) {
|
|
2781
|
-
return request(OpenAPI, {
|
|
2782
|
-
method: 'GET',
|
|
2783
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cohorts-over-time/',
|
|
2784
|
-
path: {
|
|
2785
|
-
'org': org,
|
|
2786
|
-
'user_id': userId
|
|
2787
|
-
},
|
|
2788
|
-
query: {
|
|
2789
|
-
'aggregation': aggregation,
|
|
2790
|
-
'end_date': endDate,
|
|
2791
|
-
'mentor_id': mentorId,
|
|
2792
|
-
'start_date': startDate
|
|
2793
|
-
},
|
|
2794
|
-
errors: {
|
|
2795
|
-
400: `Invalid parameters`,
|
|
2796
|
-
404: `Organization not found`
|
|
2797
|
-
}
|
|
2798
|
-
});
|
|
2799
|
-
}
|
|
2800
|
-
/**
|
|
2801
|
-
* Retrieve LLM usage costs for a specific user.
|
|
2802
|
-
*
|
|
2803
|
-
* This endpoint returns data on the total cost of LLM usage for a specific user
|
|
2804
|
-
* within a specified date range. The cost is calculated by summing the costs
|
|
2805
|
-
* of all observations associated with traces from the tenant's sessions.
|
|
2806
|
-
*
|
|
2807
|
-
* Args:
|
|
2808
|
-
* request: The HTTP request containing filter query parameters.
|
|
2809
|
-
* org: Organization key identifier.
|
|
2810
|
-
* user_id: User key identifier.
|
|
2811
|
-
*
|
|
2812
|
-
* Returns:
|
|
2813
|
-
* Response: Total LLM usage cost for the specified tenant.
|
|
2814
|
-
*
|
|
2815
|
-
* Raises:
|
|
2816
|
-
* NotFound: If the specified organization does not exist.
|
|
2817
|
-
* BadRequest: If the provided parameters are invalid.
|
|
2818
|
-
*
|
|
2819
|
-
* Query Parameters:
|
|
2820
|
-
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2821
|
-
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2822
|
-
* @param endDate
|
|
2823
|
-
* @param org
|
|
2824
|
-
* @param startDate
|
|
2825
|
-
* @param userId
|
|
2826
|
-
* @param username
|
|
2827
|
-
* @returns Cost
|
|
2828
|
-
* @throws ApiError
|
|
2829
|
-
*/
|
|
2830
|
-
static aiAnalyticsOrgsUsersUserCostRetrieve(endDate, org, startDate, userId, username) {
|
|
2831
|
-
return request(OpenAPI, {
|
|
2832
|
-
method: 'GET',
|
|
2833
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cost/',
|
|
2834
|
-
path: {
|
|
2835
|
-
'org': org,
|
|
2836
|
-
'user_id': userId
|
|
2837
|
-
},
|
|
2838
|
-
query: {
|
|
2839
|
-
'end_date': endDate,
|
|
2840
|
-
'start_date': startDate,
|
|
2841
|
-
'username': username
|
|
2842
|
-
},
|
|
2843
|
-
errors: {
|
|
2844
|
-
400: `Invalid parameters`,
|
|
2845
|
-
404: `Organization not found`
|
|
2846
|
-
}
|
|
2847
|
-
});
|
|
2848
|
-
}
|
|
2849
|
-
/**
|
|
2850
|
-
* Retrieve aggregated user chat feedback counts.
|
|
2851
|
-
*
|
|
2852
|
-
* This endpoint returns data on the number of user chat feedback entries
|
|
2853
|
-
* within a specified date range, with options for different time aggregations
|
|
2854
|
-
* (hourly, daily, weekly). Results can be filtered by mentor.
|
|
2855
|
-
*
|
|
2856
|
-
* Args:
|
|
2857
|
-
* request: The HTTP request containing filter query parameters.
|
|
2858
|
-
* org: Organization key identifier.
|
|
2859
|
-
*
|
|
2860
|
-
* Returns:
|
|
2861
|
-
* Response: Time series data of feedback counts.
|
|
2862
|
-
*
|
|
2863
|
-
* Raises:
|
|
2864
|
-
* NotFound: If the specified organization does not exist.
|
|
2865
|
-
* BadRequest: If the provided parameters are invalid.
|
|
2866
|
-
*
|
|
2867
|
-
* Query Parameters:
|
|
2868
|
-
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2869
|
-
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2870
|
-
* mentor_id (str): Filter by mentor unique ID.
|
|
2871
|
-
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
2872
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
2873
|
-
* @param org
|
|
2874
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2875
|
-
* @param userId
|
|
2876
|
-
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
2877
|
-
* @param mentorId Filter by mentor unique ID
|
|
2878
|
-
* @returns UserChatFeedbackCount
|
|
2879
|
-
* @throws ApiError
|
|
2880
|
-
*/
|
|
2881
|
-
static aiAnalyticsOrgsUsersUserFeedbackList(endDate, org, startDate, userId, aggregation = 'daily', mentorId) {
|
|
2882
|
-
return request(OpenAPI, {
|
|
2883
|
-
method: 'GET',
|
|
2884
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-feedback/',
|
|
2885
|
-
path: {
|
|
2886
|
-
'org': org,
|
|
2887
|
-
'user_id': userId
|
|
2888
|
-
},
|
|
2889
|
-
query: {
|
|
2890
|
-
'aggregation': aggregation,
|
|
2891
|
-
'end_date': endDate,
|
|
2892
|
-
'mentor_id': mentorId,
|
|
2893
|
-
'start_date': startDate
|
|
2894
|
-
},
|
|
2895
|
-
errors: {
|
|
2896
|
-
400: `Invalid parameters`,
|
|
2897
|
-
404: `Organization not found`
|
|
2898
|
-
}
|
|
2899
|
-
});
|
|
2900
|
-
}
|
|
2901
|
-
/**
|
|
2902
|
-
* Retrieve comprehensive user metrics.
|
|
2903
|
-
*
|
|
2904
|
-
* This endpoint returns data on various user metrics with month-over-month
|
|
2905
|
-
* change calculations:
|
|
2906
|
-
* - Registered users: Total users registered on the platform
|
|
2907
|
-
* - New users: Users who joined in the current month
|
|
2908
|
-
* - Unique users: Distinct users who have had sessions
|
|
2909
|
-
* - Veteran users: Users who have been active for at least 6 months
|
|
2910
|
-
*
|
|
2911
|
-
* Results can be filtered by mentor.
|
|
2912
|
-
*
|
|
2913
|
-
* Args:
|
|
2914
|
-
* request: The HTTP request containing filter query parameters.
|
|
2915
|
-
* org: Organization key identifier.
|
|
2916
|
-
*
|
|
2917
|
-
* Returns:
|
|
2918
|
-
* Response: Comprehensive user metrics with month-over-month changes.
|
|
2919
|
-
*
|
|
2920
|
-
* Raises:
|
|
2921
|
-
* NotFound: If the specified organization does not exist.
|
|
2922
|
-
*
|
|
2923
|
-
* Query Parameters:
|
|
2924
|
-
* mentor_id (str): Filter metrics by mentor unique ID.
|
|
2925
|
-
* @param org
|
|
2926
|
-
* @param userId
|
|
2927
|
-
* @param groupBy
|
|
2928
|
-
* @param mentorId Filter metrics by mentor unique ID
|
|
2929
|
-
* @returns UserMetricsResponse
|
|
2930
|
-
* @throws ApiError
|
|
2931
|
-
*/
|
|
2932
|
-
static aiAnalyticsOrgsUsersUserMetricsRetrieve(org, userId, groupBy = 'day', mentorId) {
|
|
2933
|
-
return request(OpenAPI, {
|
|
2934
|
-
method: 'GET',
|
|
2935
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/',
|
|
2936
|
-
path: {
|
|
2937
|
-
'org': org,
|
|
2938
|
-
'user_id': userId
|
|
2939
|
-
},
|
|
2940
|
-
query: {
|
|
2941
|
-
'group_by': groupBy,
|
|
2942
|
-
'mentor_id': mentorId
|
|
2943
|
-
},
|
|
2944
|
-
errors: {
|
|
2945
|
-
404: `Organization not found`
|
|
2946
|
-
}
|
|
2947
|
-
});
|
|
2948
|
-
}
|
|
2949
|
-
/**
|
|
2950
|
-
* Retrieve user distribution data for pie charts.
|
|
2951
|
-
*
|
|
2952
|
-
* This endpoint returns data on the distribution of new versus returning users
|
|
2953
|
-
* within a specified date range, including both counts and percentages,
|
|
2954
|
-
* suitable for pie chart visualization.
|
|
2955
|
-
*
|
|
2956
|
-
* Args:
|
|
2957
|
-
* request: The HTTP request containing filter query parameters.
|
|
2958
|
-
* org: Organization key identifier.
|
|
2959
|
-
*
|
|
2960
|
-
* Returns:
|
|
2961
|
-
* Response: Distribution of new versus returning users with counts and percentages.
|
|
2962
|
-
*
|
|
2963
|
-
* Raises:
|
|
2964
|
-
* NotFound: If the specified organization does not exist.
|
|
2965
|
-
* BadRequest: If the provided parameters are invalid.
|
|
2966
|
-
*
|
|
2967
|
-
* Query Parameters:
|
|
2968
|
-
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2969
|
-
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2970
|
-
* mentor_id (str): Filter by mentor unique ID.
|
|
2971
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
2972
|
-
* @param org
|
|
2973
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2974
|
-
* @param userId
|
|
2975
|
-
* @param mentorId Filter by mentor unique ID
|
|
2976
|
-
* @returns PieChartData
|
|
2977
|
-
* @throws ApiError
|
|
2978
|
-
*/
|
|
2979
|
-
static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(endDate, org, startDate, userId, mentorId) {
|
|
2980
|
-
return request(OpenAPI, {
|
|
2981
|
-
method: 'GET',
|
|
2982
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/',
|
|
2983
|
-
path: {
|
|
2984
|
-
'org': org,
|
|
2985
|
-
'user_id': userId
|
|
2986
|
-
},
|
|
2987
|
-
query: {
|
|
2988
|
-
'end_date': endDate,
|
|
2989
|
-
'mentor_id': mentorId,
|
|
2990
|
-
'start_date': startDate
|
|
2991
|
-
},
|
|
2992
|
-
errors: {
|
|
2993
|
-
400: `Invalid parameters`,
|
|
2994
|
-
404: `Organization not found`
|
|
2995
|
-
}
|
|
2996
|
-
});
|
|
2997
|
-
}
|
|
2998
|
-
/**
|
|
2999
|
-
* Retrieve user sentiment distribution.
|
|
3000
|
-
*
|
|
3001
|
-
* This endpoint returns data on the distribution of user sentiments (positive,
|
|
3002
|
-
* negative, neutral) within a specified date range, expressed as percentages.
|
|
3003
|
-
*
|
|
3004
|
-
* Args:
|
|
3005
|
-
* request: The HTTP request containing filter query parameters.
|
|
3006
|
-
* org: Organization key identifier.
|
|
3007
|
-
*
|
|
3008
|
-
* Returns:
|
|
3009
|
-
* Response: Sentiment distribution percentages and total sentiment count.
|
|
3010
|
-
*
|
|
3011
|
-
* Raises:
|
|
3012
|
-
* NotFound: If the specified organization does not exist.
|
|
3013
|
-
* BadRequest: If the provided parameters are invalid.
|
|
3014
|
-
*
|
|
3015
|
-
* Query Parameters:
|
|
3016
|
-
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
3017
|
-
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
3018
|
-
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
3019
|
-
* @param org
|
|
3020
|
-
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
3021
|
-
* @param userId
|
|
3022
|
-
* @param groupBy
|
|
3023
|
-
* @returns SentimentSummary
|
|
3024
|
-
* @throws ApiError
|
|
3025
|
-
*/
|
|
3026
|
-
static aiAnalyticsOrgsUsersUserSentimentRetrieve(endDate, org, startDate, userId, groupBy = 'day') {
|
|
3027
|
-
return request(OpenAPI, {
|
|
3028
|
-
method: 'GET',
|
|
3029
|
-
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/',
|
|
3030
|
-
path: {
|
|
3031
|
-
'org': org,
|
|
3032
|
-
'user_id': userId
|
|
3033
|
-
},
|
|
3034
|
-
query: {
|
|
3035
|
-
'end_date': endDate,
|
|
3036
|
-
'group_by': groupBy,
|
|
3037
|
-
'start_date': startDate
|
|
3038
|
-
},
|
|
3039
|
-
errors: {
|
|
3040
|
-
400: `Invalid parameters`,
|
|
3041
|
-
404: `Organization not found`
|
|
3042
|
-
}
|
|
3043
|
-
});
|
|
3044
|
-
}
|
|
3045
|
-
}
|
|
3046
|
-
|
|
3047
|
-
class AiBotService {
|
|
3048
|
-
/**
|
|
3049
|
-
* Create modify and update bot information for a specific tenant.
|
|
3050
|
-
* @param org
|
|
3051
|
-
* @returns Bot
|
|
3052
|
-
* @throws ApiError
|
|
3053
|
-
*/
|
|
3054
|
-
static aiBotV1BotsBotList(org) {
|
|
3055
|
-
return request(OpenAPI, {
|
|
3056
|
-
method: 'GET',
|
|
3057
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
3058
|
-
path: {
|
|
3059
|
-
'org': org
|
|
3060
|
-
}
|
|
3061
|
-
});
|
|
3062
|
-
}
|
|
3063
|
-
/**
|
|
3064
|
-
* Create modify and update bot information for a specific tenant.
|
|
3065
|
-
* @param org
|
|
3066
|
-
* @param requestBody
|
|
3067
|
-
* @returns BotCreate
|
|
3068
|
-
* @throws ApiError
|
|
3069
|
-
*/
|
|
3070
|
-
static aiBotV1BotsBotCreate(org, requestBody) {
|
|
3071
|
-
return request(OpenAPI, {
|
|
3072
|
-
method: 'POST',
|
|
3073
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/',
|
|
3074
|
-
path: {
|
|
3075
|
-
'org': org
|
|
3076
|
-
},
|
|
3077
|
-
body: requestBody,
|
|
3078
|
-
mediaType: 'application/json'
|
|
3079
|
-
});
|
|
3080
|
-
}
|
|
3081
|
-
/**
|
|
3082
|
-
* Create slash commands for a specific bot
|
|
3083
|
-
* eg. /iblai-baseline
|
|
3084
|
-
* @param org
|
|
3085
|
-
* @returns BotCommand
|
|
3086
|
-
* @throws ApiError
|
|
3087
|
-
*/
|
|
3088
|
-
static aiBotV1BotsBotCommandsList(org) {
|
|
3089
|
-
return request(OpenAPI, {
|
|
3090
|
-
method: 'GET',
|
|
3091
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
3092
|
-
path: {
|
|
3093
|
-
'org': org
|
|
3094
|
-
}
|
|
3095
|
-
});
|
|
3096
|
-
}
|
|
3097
|
-
/**
|
|
3098
|
-
* Create slash commands for a specific bot
|
|
3099
|
-
* eg. /iblai-baseline
|
|
3100
|
-
* @param org
|
|
3101
|
-
* @param requestBody
|
|
3102
|
-
* @returns BotCommand
|
|
3103
|
-
* @throws ApiError
|
|
3104
|
-
*/
|
|
3105
|
-
static aiBotV1BotsBotCommandsCreate(org, requestBody) {
|
|
3106
|
-
return request(OpenAPI, {
|
|
3107
|
-
method: 'POST',
|
|
3108
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
3109
|
-
path: {
|
|
3110
|
-
'org': org
|
|
3111
|
-
},
|
|
3112
|
-
body: requestBody,
|
|
3113
|
-
mediaType: 'application/json'
|
|
3114
|
-
});
|
|
3115
|
-
}
|
|
3116
|
-
/**
|
|
3117
|
-
* Create slash commands for a specific bot
|
|
3118
|
-
* eg. /iblai-baseline
|
|
3119
|
-
* @param id A unique integer value identifying this bot command.
|
|
3120
|
-
* @param org
|
|
3121
|
-
* @returns BotCommand
|
|
3122
|
-
* @throws ApiError
|
|
3123
|
-
*/
|
|
3124
|
-
static aiBotV1BotsBotCommandsRetrieve(id, org) {
|
|
3125
|
-
return request(OpenAPI, {
|
|
3126
|
-
method: 'GET',
|
|
3127
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
3128
|
-
path: {
|
|
3129
|
-
'id': id,
|
|
3130
|
-
'org': org
|
|
3131
|
-
}
|
|
3132
|
-
});
|
|
3133
|
-
}
|
|
3134
|
-
/**
|
|
3135
|
-
* Create slash commands for a specific bot
|
|
3136
|
-
* eg. /iblai-baseline
|
|
3137
|
-
* @param id A unique integer value identifying this bot command.
|
|
3138
|
-
* @param org
|
|
3139
|
-
* @param requestBody
|
|
3140
|
-
* @returns BotCommand
|
|
3141
|
-
* @throws ApiError
|
|
3142
|
-
*/
|
|
3143
|
-
static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
|
|
3144
|
-
return request(OpenAPI, {
|
|
3145
|
-
method: 'PUT',
|
|
3146
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
3147
|
-
path: {
|
|
3148
|
-
'id': id,
|
|
3149
|
-
'org': org
|
|
3150
|
-
},
|
|
3151
|
-
body: requestBody,
|
|
3152
|
-
mediaType: 'application/json'
|
|
3153
|
-
});
|
|
3154
|
-
}
|
|
3155
|
-
/**
|
|
3156
|
-
* Create slash commands for a specific bot
|
|
3157
|
-
* eg. /iblai-baseline
|
|
3158
|
-
* @param id A unique integer value identifying this bot command.
|
|
3159
|
-
* @param org
|
|
3160
|
-
* @param requestBody
|
|
3161
|
-
* @returns BotCommand
|
|
3162
|
-
* @throws ApiError
|
|
3163
|
-
*/
|
|
3164
|
-
static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
|
|
3165
|
-
return request(OpenAPI, {
|
|
3166
|
-
method: 'PATCH',
|
|
3167
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
3168
|
-
path: {
|
|
3169
|
-
'id': id,
|
|
3170
|
-
'org': org
|
|
3171
|
-
},
|
|
3172
|
-
body: requestBody,
|
|
3173
|
-
mediaType: 'application/json'
|
|
3174
|
-
});
|
|
3175
|
-
}
|
|
3176
|
-
/**
|
|
3177
|
-
* Create slash commands for a specific bot
|
|
3178
|
-
* eg. /iblai-baseline
|
|
3179
|
-
* @param id A unique integer value identifying this bot command.
|
|
3180
|
-
* @param org
|
|
3181
|
-
* @returns void
|
|
3182
|
-
* @throws ApiError
|
|
3183
|
-
*/
|
|
3184
|
-
static aiBotV1BotsBotCommandsDestroy(id, org) {
|
|
3185
|
-
return request(OpenAPI, {
|
|
3186
|
-
method: 'DELETE',
|
|
3187
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
3188
|
-
path: {
|
|
3189
|
-
'id': id,
|
|
3190
|
-
'org': org
|
|
3191
|
-
}
|
|
3192
|
-
});
|
|
3193
|
-
}
|
|
3194
|
-
/**
|
|
3195
|
-
* Create modify and update bot information for a specific tenant.
|
|
3196
|
-
* @param id A unique integer value identifying this bot.
|
|
3197
|
-
* @param org
|
|
3198
|
-
* @returns Bot
|
|
3199
|
-
* @throws ApiError
|
|
3200
|
-
*/
|
|
3201
|
-
static aiBotV1BotsBotRetrieve(id, org) {
|
|
3202
|
-
return request(OpenAPI, {
|
|
3203
|
-
method: 'GET',
|
|
3204
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
3205
|
-
path: {
|
|
3206
|
-
'id': id,
|
|
3207
|
-
'org': org
|
|
3208
|
-
}
|
|
3209
|
-
});
|
|
3210
|
-
}
|
|
3211
|
-
/**
|
|
3212
|
-
* Create modify and update bot information for a specific tenant.
|
|
3213
|
-
* @param id A unique integer value identifying this bot.
|
|
3214
|
-
* @param org
|
|
3215
|
-
* @param requestBody
|
|
3216
|
-
* @returns BotCreate
|
|
3217
|
-
* @throws ApiError
|
|
3218
|
-
*/
|
|
3219
|
-
static aiBotV1BotsBotUpdate(id, org, requestBody) {
|
|
3220
|
-
return request(OpenAPI, {
|
|
3221
|
-
method: 'PUT',
|
|
3222
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
3223
|
-
path: {
|
|
3224
|
-
'id': id,
|
|
3225
|
-
'org': org
|
|
3226
|
-
},
|
|
3227
|
-
body: requestBody,
|
|
3228
|
-
mediaType: 'application/json'
|
|
3229
|
-
});
|
|
3230
|
-
}
|
|
3231
|
-
/**
|
|
3232
|
-
* Create modify and update bot information for a specific tenant.
|
|
3233
|
-
* @param id A unique integer value identifying this bot.
|
|
3234
|
-
* @param org
|
|
3235
|
-
* @param requestBody
|
|
3236
|
-
* @returns BotCreate
|
|
3237
|
-
* @throws ApiError
|
|
3238
|
-
*/
|
|
3239
|
-
static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
|
|
3240
|
-
return request(OpenAPI, {
|
|
3241
|
-
method: 'PATCH',
|
|
3242
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
3243
|
-
path: {
|
|
3244
|
-
'id': id,
|
|
3245
|
-
'org': org
|
|
3246
|
-
},
|
|
3247
|
-
body: requestBody,
|
|
3248
|
-
mediaType: 'application/json'
|
|
3249
|
-
});
|
|
3250
|
-
}
|
|
3251
|
-
/**
|
|
3252
|
-
* Create modify and update bot information for a specific tenant.
|
|
3253
|
-
* @param id A unique integer value identifying this bot.
|
|
3254
|
-
* @param org
|
|
3255
|
-
* @returns void
|
|
3256
|
-
* @throws ApiError
|
|
3257
|
-
*/
|
|
3258
|
-
static aiBotV1BotsBotDestroy(id, org) {
|
|
3259
|
-
return request(OpenAPI, {
|
|
3260
|
-
method: 'DELETE',
|
|
3261
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
3262
|
-
path: {
|
|
3263
|
-
'id': id,
|
|
3264
|
-
'org': org
|
|
3265
|
-
}
|
|
3266
|
-
});
|
|
3267
|
-
}
|
|
3268
|
-
/**
|
|
3269
|
-
* Create modify and update bot information for a specific tenant.
|
|
3270
|
-
* @param id A unique integer value identifying this bot.
|
|
3271
|
-
* @param org
|
|
3272
|
-
* @returns DiscordConfig
|
|
3273
|
-
* @throws ApiError
|
|
3274
|
-
*/
|
|
3275
|
-
static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
|
|
3276
|
-
return request(OpenAPI, {
|
|
3277
|
-
method: 'GET',
|
|
3278
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
3279
|
-
path: {
|
|
3280
|
-
'id': id,
|
|
3281
|
-
'org': org
|
|
3282
|
-
}
|
|
3283
|
-
});
|
|
3284
|
-
}
|
|
3285
|
-
/**
|
|
3286
|
-
* Create modify and update bot information for a specific tenant.
|
|
3287
|
-
* @param id A unique integer value identifying this bot.
|
|
3288
|
-
* @param org
|
|
3289
|
-
* @param requestBody
|
|
3290
|
-
* @returns DiscordConfig
|
|
3291
|
-
* @throws ApiError
|
|
3292
|
-
*/
|
|
3293
|
-
static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
|
|
3294
|
-
return request(OpenAPI, {
|
|
3295
|
-
method: 'PATCH',
|
|
3296
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
3297
|
-
path: {
|
|
3298
|
-
'id': id,
|
|
3299
|
-
'org': org
|
|
3300
|
-
},
|
|
3301
|
-
body: requestBody,
|
|
3302
|
-
mediaType: 'application/json'
|
|
3303
|
-
});
|
|
3304
|
-
}
|
|
3305
|
-
/**
|
|
3306
|
-
* Create modify and update bot information for a specific tenant.
|
|
3307
|
-
* @param id A unique integer value identifying this bot.
|
|
3308
|
-
* @param org
|
|
3309
|
-
* @returns SlackConfig
|
|
3310
|
-
* @throws ApiError
|
|
3311
|
-
*/
|
|
3312
|
-
static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
|
|
3313
|
-
return request(OpenAPI, {
|
|
3314
|
-
method: 'GET',
|
|
3315
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
|
|
3316
|
-
path: {
|
|
3317
|
-
'id': id,
|
|
3318
|
-
'org': org
|
|
3319
|
-
}
|
|
3320
|
-
});
|
|
3321
|
-
}
|
|
3322
|
-
/**
|
|
3323
|
-
* Create modify and update bot information for a specific tenant.
|
|
3324
|
-
* @param id A unique integer value identifying this bot.
|
|
3325
|
-
* @param org
|
|
3326
|
-
* @param requestBody
|
|
3327
|
-
* @returns SlackConfig
|
|
3328
|
-
* @throws ApiError
|
|
3329
|
-
*/
|
|
3330
|
-
static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
|
|
3331
|
-
return request(OpenAPI, {
|
|
3332
|
-
method: 'POST',
|
|
3333
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
3334
|
-
path: {
|
|
3335
|
-
'id': id,
|
|
3336
|
-
'org': org
|
|
3337
|
-
},
|
|
3338
|
-
body: requestBody,
|
|
3339
|
-
mediaType: 'application/json'
|
|
3340
|
-
});
|
|
3341
|
-
}
|
|
3342
|
-
/**
|
|
3343
|
-
* Create modify and update bot information for a specific tenant.
|
|
3344
|
-
* @param id A unique integer value identifying this bot.
|
|
3345
|
-
* @param org
|
|
3346
|
-
* @param requestBody
|
|
3347
|
-
* @returns SlackConfig
|
|
3348
|
-
* @throws ApiError
|
|
3349
|
-
*/
|
|
3350
|
-
static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
|
|
3351
|
-
return request(OpenAPI, {
|
|
3352
|
-
method: 'PUT',
|
|
3353
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
3354
|
-
path: {
|
|
3355
|
-
'id': id,
|
|
3356
|
-
'org': org
|
|
3357
|
-
},
|
|
3358
|
-
body: requestBody,
|
|
3359
|
-
mediaType: 'application/json'
|
|
3360
|
-
});
|
|
3361
|
-
}
|
|
3362
|
-
/**
|
|
3363
|
-
* Create modify and update bot information for a specific tenant.
|
|
3364
|
-
* @param id A unique integer value identifying this bot.
|
|
3365
|
-
* @param org
|
|
3366
|
-
* @param requestBody
|
|
3367
|
-
* @returns SlackConfig
|
|
3368
|
-
* @throws ApiError
|
|
3369
|
-
*/
|
|
3370
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
|
|
3371
|
-
return request(OpenAPI, {
|
|
3372
|
-
method: 'PATCH',
|
|
3373
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
3374
|
-
path: {
|
|
3375
|
-
'id': id,
|
|
3376
|
-
'org': org
|
|
3377
|
-
},
|
|
3378
|
-
body: requestBody,
|
|
3379
|
-
mediaType: 'application/json'
|
|
3380
|
-
});
|
|
3381
|
-
}
|
|
3382
|
-
/**
|
|
3383
|
-
* Create modify and update bot information for a specific tenant.
|
|
3384
|
-
* @param id A unique integer value identifying this bot.
|
|
3385
|
-
* @param org
|
|
3386
|
-
* @returns TeamsConfig
|
|
3387
|
-
* @throws ApiError
|
|
3388
|
-
*/
|
|
3389
|
-
static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
|
|
3390
|
-
return request(OpenAPI, {
|
|
3391
|
-
method: 'GET',
|
|
3392
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
3393
|
-
path: {
|
|
3394
|
-
'id': id,
|
|
3395
|
-
'org': org
|
|
3396
|
-
}
|
|
3397
|
-
});
|
|
3398
|
-
}
|
|
3399
|
-
/**
|
|
3400
|
-
* Create modify and update bot information for a specific tenant.
|
|
3401
|
-
* @param id A unique integer value identifying this bot.
|
|
3402
|
-
* @param org
|
|
3403
|
-
* @param requestBody
|
|
3404
|
-
* @returns TeamsConfig
|
|
3405
|
-
* @throws ApiError
|
|
3406
|
-
*/
|
|
3407
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
|
|
3408
|
-
return request(OpenAPI, {
|
|
3409
|
-
method: 'POST',
|
|
3410
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
3411
|
-
path: {
|
|
3412
|
-
'id': id,
|
|
3413
|
-
'org': org
|
|
3414
|
-
},
|
|
3415
|
-
body: requestBody,
|
|
3416
|
-
mediaType: 'application/json'
|
|
3417
|
-
});
|
|
3418
|
-
}
|
|
3419
|
-
/**
|
|
3420
|
-
* Create modify and update bot information for a specific tenant.
|
|
3421
|
-
* @param id A unique integer value identifying this bot.
|
|
3422
|
-
* @param org
|
|
3423
|
-
* @param requestBody
|
|
3424
|
-
* @returns TeamsConfig
|
|
3425
|
-
* @throws ApiError
|
|
3426
|
-
*/
|
|
3427
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
|
|
3428
|
-
return request(OpenAPI, {
|
|
3429
|
-
method: 'PUT',
|
|
3430
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
3431
|
-
path: {
|
|
3432
|
-
'id': id,
|
|
3433
|
-
'org': org
|
|
3434
|
-
},
|
|
3435
|
-
body: requestBody,
|
|
3436
|
-
mediaType: 'application/json'
|
|
3437
|
-
});
|
|
3438
|
-
}
|
|
3439
|
-
/**
|
|
3440
|
-
* Create modify and update bot information for a specific tenant.
|
|
3441
|
-
* @param id A unique integer value identifying this bot.
|
|
3442
|
-
* @param org
|
|
3443
|
-
* @param requestBody
|
|
3444
|
-
* @returns TeamsConfig
|
|
3445
|
-
* @throws ApiError
|
|
3446
|
-
*/
|
|
3447
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
|
|
3448
|
-
return request(OpenAPI, {
|
|
3449
|
-
method: 'PATCH',
|
|
3450
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
3451
|
-
path: {
|
|
3452
|
-
'id': id,
|
|
3453
|
-
'org': org
|
|
3454
|
-
},
|
|
3455
|
-
body: requestBody,
|
|
3456
|
-
mediaType: 'application/json'
|
|
3457
|
-
});
|
|
3458
|
-
}
|
|
3459
|
-
/**
|
|
3460
|
-
* Create modify and update bot information for a specific tenant.
|
|
3461
|
-
* @param id A unique integer value identifying this bot.
|
|
3462
|
-
* @param org
|
|
3463
|
-
* @returns WebexConfig
|
|
3464
|
-
* @throws ApiError
|
|
3465
|
-
*/
|
|
3466
|
-
static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
|
|
3467
|
-
return request(OpenAPI, {
|
|
3468
|
-
method: 'GET',
|
|
3469
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
3470
|
-
path: {
|
|
3471
|
-
'id': id,
|
|
3472
|
-
'org': org
|
|
3473
|
-
}
|
|
3474
|
-
});
|
|
3475
|
-
}
|
|
3476
|
-
/**
|
|
3477
|
-
* Create modify and update bot information for a specific tenant.
|
|
3478
|
-
* @param id A unique integer value identifying this bot.
|
|
3479
|
-
* @param org
|
|
3480
|
-
* @param requestBody
|
|
3481
|
-
* @returns WebexConfig
|
|
3482
|
-
* @throws ApiError
|
|
3483
|
-
*/
|
|
3484
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
|
|
3485
|
-
return request(OpenAPI, {
|
|
3486
|
-
method: 'PATCH',
|
|
3487
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
3488
|
-
path: {
|
|
3489
|
-
'id': id,
|
|
3490
|
-
'org': org
|
|
3491
|
-
},
|
|
3492
|
-
body: requestBody,
|
|
3493
|
-
mediaType: 'application/json'
|
|
3494
|
-
});
|
|
3495
|
-
}
|
|
3496
|
-
/**
|
|
3497
|
-
* Create modify and update bot information for a specific tenant.
|
|
3498
|
-
* @param id A unique integer value identifying this bot.
|
|
3499
|
-
* @param org
|
|
3500
|
-
* @returns WhatsappConfig
|
|
3501
|
-
* @throws ApiError
|
|
3502
|
-
*/
|
|
3503
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
|
|
3504
|
-
return request(OpenAPI, {
|
|
3505
|
-
method: 'GET',
|
|
3506
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
3507
|
-
path: {
|
|
3508
|
-
'id': id,
|
|
3509
|
-
'org': org
|
|
3510
|
-
}
|
|
3511
|
-
});
|
|
3512
|
-
}
|
|
3513
|
-
/**
|
|
3514
|
-
* Create modify and update bot information for a specific tenant.
|
|
3515
|
-
* @param id A unique integer value identifying this bot.
|
|
3516
|
-
* @param org
|
|
3517
|
-
* @param requestBody
|
|
3518
|
-
* @returns WhatsappConfig
|
|
3519
|
-
* @throws ApiError
|
|
3520
|
-
*/
|
|
3521
|
-
static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
|
|
3522
|
-
return request(OpenAPI, {
|
|
3523
|
-
method: 'PUT',
|
|
3524
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
3525
|
-
path: {
|
|
3526
|
-
'id': id,
|
|
3527
|
-
'org': org
|
|
3528
|
-
},
|
|
3529
|
-
body: requestBody,
|
|
3530
|
-
mediaType: 'application/json'
|
|
3531
|
-
});
|
|
3532
|
-
}
|
|
3533
|
-
/**
|
|
3534
|
-
* Create modify and update bot information for a specific tenant.
|
|
3535
|
-
* @param id A unique integer value identifying this bot.
|
|
3536
|
-
* @param org
|
|
3537
|
-
* @param requestBody
|
|
3538
|
-
* @returns WhatsappConfig
|
|
3539
|
-
* @throws ApiError
|
|
3540
|
-
*/
|
|
3541
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
|
|
3542
|
-
return request(OpenAPI, {
|
|
3543
|
-
method: 'PATCH',
|
|
3544
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
3545
|
-
path: {
|
|
3546
|
-
'id': id,
|
|
3547
|
-
'org': org
|
|
3548
|
-
},
|
|
3549
|
-
body: requestBody,
|
|
3550
|
-
mediaType: 'application/json'
|
|
3551
|
-
});
|
|
3552
|
-
}
|
|
3553
|
-
/**
|
|
3554
|
-
* Setup discord user id linkage with discord bots
|
|
3555
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3556
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3557
|
-
* @param org
|
|
3558
|
-
* @returns DiscordUserConfig
|
|
3559
|
-
* @throws ApiError
|
|
3560
|
-
*/
|
|
3561
|
-
static aiBotV1BotsDiscordUserConfigList(org) {
|
|
3562
|
-
return request(OpenAPI, {
|
|
3563
|
-
method: 'GET',
|
|
3564
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
3565
|
-
path: {
|
|
3566
|
-
'org': org
|
|
3567
|
-
}
|
|
3568
|
-
});
|
|
3569
|
-
}
|
|
3570
|
-
/**
|
|
3571
|
-
* Setup discord user id linkage with discord bots
|
|
3572
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3573
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3574
|
-
* @param org
|
|
3575
|
-
* @param requestBody
|
|
3576
|
-
* @returns DiscordUserConfig
|
|
3577
|
-
* @throws ApiError
|
|
3578
|
-
*/
|
|
3579
|
-
static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
|
|
3580
|
-
return request(OpenAPI, {
|
|
3581
|
-
method: 'POST',
|
|
3582
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
3583
|
-
path: {
|
|
3584
|
-
'org': org
|
|
3585
|
-
},
|
|
3586
|
-
body: requestBody,
|
|
3587
|
-
mediaType: 'application/json'
|
|
3588
|
-
});
|
|
3589
|
-
}
|
|
3590
|
-
/**
|
|
3591
|
-
* Setup discord user id linkage with discord bots
|
|
3592
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3593
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3594
|
-
* @param id A unique integer value identifying this discord user config.
|
|
3595
|
-
* @param org
|
|
3596
|
-
* @returns DiscordUserConfig
|
|
3597
|
-
* @throws ApiError
|
|
3598
|
-
*/
|
|
3599
|
-
static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
|
|
3600
|
-
return request(OpenAPI, {
|
|
3601
|
-
method: 'GET',
|
|
3602
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
3603
|
-
path: {
|
|
3604
|
-
'id': id,
|
|
3605
|
-
'org': org
|
|
3606
|
-
}
|
|
3607
|
-
});
|
|
3608
|
-
}
|
|
3609
|
-
/**
|
|
3610
|
-
* Setup discord user id linkage with discord bots
|
|
3611
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3612
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3613
|
-
* @param id A unique integer value identifying this discord user config.
|
|
3614
|
-
* @param org
|
|
3615
|
-
* @param requestBody
|
|
3616
|
-
* @returns DiscordUserConfig
|
|
3617
|
-
* @throws ApiError
|
|
3618
|
-
*/
|
|
3619
|
-
static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
|
|
3620
|
-
return request(OpenAPI, {
|
|
3621
|
-
method: 'PUT',
|
|
3622
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
3623
|
-
path: {
|
|
3624
|
-
'id': id,
|
|
3625
|
-
'org': org
|
|
3626
|
-
},
|
|
3627
|
-
body: requestBody,
|
|
3628
|
-
mediaType: 'application/json'
|
|
3629
|
-
});
|
|
3630
|
-
}
|
|
3631
|
-
/**
|
|
3632
|
-
* Setup discord user id linkage with discord bots
|
|
3633
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3634
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3635
|
-
* @param id A unique integer value identifying this discord user config.
|
|
3636
|
-
* @param org
|
|
3637
|
-
* @param requestBody
|
|
3638
|
-
* @returns DiscordUserConfig
|
|
3639
|
-
* @throws ApiError
|
|
3640
|
-
*/
|
|
3641
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
|
|
3642
|
-
return request(OpenAPI, {
|
|
3643
|
-
method: 'PATCH',
|
|
3644
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
3645
|
-
path: {
|
|
3646
|
-
'id': id,
|
|
3647
|
-
'org': org
|
|
3648
|
-
},
|
|
3649
|
-
body: requestBody,
|
|
3650
|
-
mediaType: 'application/json'
|
|
3651
|
-
});
|
|
3652
|
-
}
|
|
3653
|
-
/**
|
|
3654
|
-
* Setup discord user id linkage with discord bots
|
|
3655
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
3656
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
3657
|
-
* @param id A unique integer value identifying this discord user config.
|
|
3658
|
-
* @param org
|
|
3659
|
-
* @returns void
|
|
3660
|
-
* @throws ApiError
|
|
3661
|
-
*/
|
|
3662
|
-
static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
|
|
3663
|
-
return request(OpenAPI, {
|
|
3664
|
-
method: 'DELETE',
|
|
3665
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
3666
|
-
path: {
|
|
3667
|
-
'id': id,
|
|
3668
|
-
'org': org
|
|
3669
|
-
}
|
|
3670
|
-
});
|
|
3671
|
-
}
|
|
3672
|
-
/**
|
|
3673
|
-
* Setup slack username and domain linkage with slack bots
|
|
3674
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3675
|
-
* @param org
|
|
3676
|
-
* @returns SlackUserConfig
|
|
3677
|
-
* @throws ApiError
|
|
3678
|
-
*/
|
|
3679
|
-
static aiBotV1BotsSlackUserConfigList(org) {
|
|
3680
|
-
return request(OpenAPI, {
|
|
3681
|
-
method: 'GET',
|
|
3682
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
3683
|
-
path: {
|
|
3684
|
-
'org': org
|
|
3685
|
-
}
|
|
3686
|
-
});
|
|
3687
|
-
}
|
|
3688
|
-
/**
|
|
3689
|
-
* Setup slack username and domain linkage with slack bots
|
|
3690
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3691
|
-
* @param org
|
|
3692
|
-
* @param requestBody
|
|
3693
|
-
* @returns SlackUserConfig
|
|
3694
|
-
* @throws ApiError
|
|
3695
|
-
*/
|
|
3696
|
-
static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
|
|
3697
|
-
return request(OpenAPI, {
|
|
3698
|
-
method: 'POST',
|
|
3699
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
3700
|
-
path: {
|
|
3701
|
-
'org': org
|
|
3702
|
-
},
|
|
3703
|
-
body: requestBody,
|
|
3704
|
-
mediaType: 'application/json'
|
|
3705
|
-
});
|
|
3706
|
-
}
|
|
3707
|
-
/**
|
|
3708
|
-
* Setup slack username and domain linkage with slack bots
|
|
3709
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3710
|
-
* @param id A unique integer value identifying this slack user config.
|
|
3711
|
-
* @param org
|
|
3712
|
-
* @returns SlackUserConfig
|
|
3713
|
-
* @throws ApiError
|
|
3714
|
-
*/
|
|
3715
|
-
static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
|
|
3716
|
-
return request(OpenAPI, {
|
|
3717
|
-
method: 'GET',
|
|
3718
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
3719
|
-
path: {
|
|
3720
|
-
'id': id,
|
|
3721
|
-
'org': org
|
|
3722
|
-
}
|
|
3723
|
-
});
|
|
3724
|
-
}
|
|
3725
|
-
/**
|
|
3726
|
-
* Setup slack username and domain linkage with slack bots
|
|
3727
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3728
|
-
* @param id A unique integer value identifying this slack user config.
|
|
3729
|
-
* @param org
|
|
3730
|
-
* @param requestBody
|
|
3731
|
-
* @returns SlackUserConfig
|
|
3732
|
-
* @throws ApiError
|
|
3733
|
-
*/
|
|
3734
|
-
static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
|
|
3735
|
-
return request(OpenAPI, {
|
|
3736
|
-
method: 'PUT',
|
|
3737
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
3738
|
-
path: {
|
|
3739
|
-
'id': id,
|
|
3740
|
-
'org': org
|
|
3741
|
-
},
|
|
3742
|
-
body: requestBody,
|
|
3743
|
-
mediaType: 'application/json'
|
|
3744
|
-
});
|
|
3745
|
-
}
|
|
3746
|
-
/**
|
|
3747
|
-
* Setup slack username and domain linkage with slack bots
|
|
3748
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3749
|
-
* @param id A unique integer value identifying this slack user config.
|
|
3750
|
-
* @param org
|
|
3751
|
-
* @param requestBody
|
|
3752
|
-
* @returns SlackUserConfig
|
|
3753
|
-
* @throws ApiError
|
|
3754
|
-
*/
|
|
3755
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
|
|
3756
|
-
return request(OpenAPI, {
|
|
3757
|
-
method: 'PATCH',
|
|
3758
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
3759
|
-
path: {
|
|
3760
|
-
'id': id,
|
|
3761
|
-
'org': org
|
|
3762
|
-
},
|
|
3763
|
-
body: requestBody,
|
|
3764
|
-
mediaType: 'application/json'
|
|
3765
|
-
});
|
|
3766
|
-
}
|
|
3767
|
-
/**
|
|
3768
|
-
* Setup slack username and domain linkage with slack bots
|
|
3769
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
3770
|
-
* @param id A unique integer value identifying this slack user config.
|
|
3771
|
-
* @param org
|
|
3772
|
-
* @returns void
|
|
3773
|
-
* @throws ApiError
|
|
3774
|
-
*/
|
|
3775
|
-
static aiBotV1BotsSlackUserConfigDestroy(id, org) {
|
|
3776
|
-
return request(OpenAPI, {
|
|
3777
|
-
method: 'DELETE',
|
|
3778
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
3779
|
-
path: {
|
|
3780
|
-
'id': id,
|
|
3781
|
-
'org': org
|
|
3782
|
-
}
|
|
3783
|
-
});
|
|
3784
|
-
}
|
|
3785
|
-
/**
|
|
3786
|
-
* Setup phone number linkage with whatsapp bots
|
|
3787
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3788
|
-
* @param org
|
|
3789
|
-
* @returns WhatsappUserConfig
|
|
3790
|
-
* @throws ApiError
|
|
3791
|
-
*/
|
|
3792
|
-
static aiBotV1BotsWhatsappUserConfigList(org) {
|
|
3793
|
-
return request(OpenAPI, {
|
|
3794
|
-
method: 'GET',
|
|
3795
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
3796
|
-
path: {
|
|
3797
|
-
'org': org
|
|
3798
|
-
}
|
|
3799
|
-
});
|
|
3800
|
-
}
|
|
3801
|
-
/**
|
|
3802
|
-
* Setup phone number linkage with whatsapp bots
|
|
3803
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3804
|
-
* @param org
|
|
3805
|
-
* @param requestBody
|
|
3806
|
-
* @returns WhatsappUserConfig
|
|
3807
|
-
* @throws ApiError
|
|
3808
|
-
*/
|
|
3809
|
-
static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
|
|
3810
|
-
return request(OpenAPI, {
|
|
3811
|
-
method: 'POST',
|
|
3812
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
3813
|
-
path: {
|
|
3814
|
-
'org': org
|
|
3815
|
-
},
|
|
3816
|
-
body: requestBody,
|
|
3817
|
-
mediaType: 'application/json'
|
|
3818
|
-
});
|
|
3819
|
-
}
|
|
3820
|
-
/**
|
|
3821
|
-
* Setup phone number linkage with whatsapp bots
|
|
3822
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3823
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
3824
|
-
* @param org
|
|
3825
|
-
* @returns WhatsappUserConfig
|
|
3826
|
-
* @throws ApiError
|
|
3827
|
-
*/
|
|
3828
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
|
|
3829
|
-
return request(OpenAPI, {
|
|
3830
|
-
method: 'GET',
|
|
3831
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
3832
|
-
path: {
|
|
3833
|
-
'id': id,
|
|
3834
|
-
'org': org
|
|
3835
|
-
}
|
|
3836
|
-
});
|
|
3837
|
-
}
|
|
3838
|
-
/**
|
|
3839
|
-
* Setup phone number linkage with whatsapp bots
|
|
3840
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3841
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
3842
|
-
* @param org
|
|
3843
|
-
* @param requestBody
|
|
3844
|
-
* @returns WhatsappUserConfig
|
|
3845
|
-
* @throws ApiError
|
|
3846
|
-
*/
|
|
3847
|
-
static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
|
|
3848
|
-
return request(OpenAPI, {
|
|
3849
|
-
method: 'PUT',
|
|
3850
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
3851
|
-
path: {
|
|
3852
|
-
'id': id,
|
|
3853
|
-
'org': org
|
|
3854
|
-
},
|
|
3855
|
-
body: requestBody,
|
|
3856
|
-
mediaType: 'application/json'
|
|
3857
|
-
});
|
|
3858
|
-
}
|
|
3859
|
-
/**
|
|
3860
|
-
* Setup phone number linkage with whatsapp bots
|
|
3861
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3862
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
3863
|
-
* @param org
|
|
3864
|
-
* @param requestBody
|
|
3865
|
-
* @returns WhatsappUserConfig
|
|
3866
|
-
* @throws ApiError
|
|
3867
|
-
*/
|
|
3868
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
|
|
3869
|
-
return request(OpenAPI, {
|
|
3870
|
-
method: 'PATCH',
|
|
3871
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
3872
|
-
path: {
|
|
3873
|
-
'id': id,
|
|
3874
|
-
'org': org
|
|
3875
|
-
},
|
|
3876
|
-
body: requestBody,
|
|
3877
|
-
mediaType: 'application/json'
|
|
3878
|
-
});
|
|
3879
|
-
}
|
|
3880
|
-
/**
|
|
3881
|
-
* Setup phone number linkage with whatsapp bots
|
|
3882
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
3883
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
3884
|
-
* @param org
|
|
3885
|
-
* @returns void
|
|
3886
|
-
* @throws ApiError
|
|
3887
|
-
*/
|
|
3888
|
-
static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
|
|
3889
|
-
return request(OpenAPI, {
|
|
3890
|
-
method: 'DELETE',
|
|
3891
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
3892
|
-
path: {
|
|
3893
|
-
'id': id,
|
|
3894
|
-
'org': org
|
|
3895
|
-
}
|
|
3896
|
-
});
|
|
3897
|
-
}
|
|
3898
|
-
/**
|
|
3899
|
-
* Webhook endpoint to receive and process discord messages.
|
|
3900
|
-
* @param name
|
|
3901
|
-
* @param org
|
|
3902
|
-
* @param requestBody
|
|
3903
|
-
* @returns DiscordWebhook
|
|
3904
|
-
* @throws ApiError
|
|
3905
|
-
*/
|
|
3906
|
-
static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
|
|
3907
|
-
return request(OpenAPI, {
|
|
3908
|
-
method: 'POST',
|
|
3909
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
|
|
3910
|
-
path: {
|
|
3911
|
-
'name': name,
|
|
3912
|
-
'org': org
|
|
3913
|
-
},
|
|
3914
|
-
body: requestBody,
|
|
3915
|
-
mediaType: 'application/json'
|
|
3916
|
-
});
|
|
3917
|
-
}
|
|
3918
|
-
/**
|
|
3919
|
-
* @param name
|
|
3920
|
-
* @param org
|
|
3921
|
-
* @param requestBody
|
|
3922
|
-
* @returns SlackWebhook
|
|
3923
|
-
* @throws ApiError
|
|
3924
|
-
*/
|
|
3925
|
-
static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
|
|
3926
|
-
return request(OpenAPI, {
|
|
3927
|
-
method: 'POST',
|
|
3928
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
|
|
3929
|
-
path: {
|
|
3930
|
-
'name': name,
|
|
3931
|
-
'org': org
|
|
3932
|
-
},
|
|
3933
|
-
body: requestBody,
|
|
3934
|
-
mediaType: 'application/json'
|
|
3935
|
-
});
|
|
3936
|
-
}
|
|
3937
|
-
/**
|
|
3938
|
-
* @param name
|
|
3939
|
-
* @param org
|
|
3940
|
-
* @param requestBody
|
|
3941
|
-
* @returns TeamsWebhook
|
|
3942
|
-
* @throws ApiError
|
|
3943
|
-
*/
|
|
3944
|
-
static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
|
|
3945
|
-
return request(OpenAPI, {
|
|
3946
|
-
method: 'POST',
|
|
3947
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
|
|
3948
|
-
path: {
|
|
3949
|
-
'name': name,
|
|
3950
|
-
'org': org
|
|
3951
|
-
},
|
|
3952
|
-
body: requestBody,
|
|
3953
|
-
mediaType: 'application/json'
|
|
3954
|
-
});
|
|
3955
|
-
}
|
|
3956
|
-
/**
|
|
3957
|
-
* Webhook endpoint to receive and process discord messages.
|
|
3958
|
-
* @param name
|
|
3959
|
-
* @param org
|
|
3960
|
-
* @param requestBody
|
|
3961
|
-
* @returns WebexWebhook
|
|
3962
|
-
* @throws ApiError
|
|
3963
|
-
*/
|
|
3964
|
-
static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
|
|
3965
|
-
return request(OpenAPI, {
|
|
3966
|
-
method: 'POST',
|
|
3967
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
3968
|
-
path: {
|
|
3969
|
-
'name': name,
|
|
3970
|
-
'org': org
|
|
3971
|
-
},
|
|
3972
|
-
body: requestBody,
|
|
3973
|
-
mediaType: 'application/json'
|
|
3974
|
-
});
|
|
3975
|
-
}
|
|
3976
|
-
/**
|
|
3977
|
-
* Respond to whatsapp's webhook challenge.
|
|
3978
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
3979
|
-
* @param name
|
|
3980
|
-
* @param org
|
|
3981
|
-
* @returns WhatAppWebHook
|
|
3982
|
-
* @throws ApiError
|
|
3983
|
-
*/
|
|
3984
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
|
|
3985
|
-
return request(OpenAPI, {
|
|
3986
|
-
method: 'GET',
|
|
3987
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
3988
|
-
path: {
|
|
3989
|
-
'name': name,
|
|
3990
|
-
'org': org
|
|
3991
|
-
}
|
|
3992
|
-
});
|
|
3993
|
-
}
|
|
3994
|
-
/**
|
|
3995
|
-
* Accept and process webhook events from whatsapp.
|
|
3996
|
-
* @param name
|
|
3997
|
-
* @param org
|
|
3998
|
-
* @param requestBody
|
|
3999
|
-
* @returns WhatAppWebHook
|
|
4000
|
-
* @throws ApiError
|
|
4001
|
-
*/
|
|
4002
|
-
static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
|
|
4003
|
-
return request(OpenAPI, {
|
|
4004
|
-
method: 'POST',
|
|
4005
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
4006
|
-
path: {
|
|
4007
|
-
'name': name,
|
|
4008
|
-
'org': org
|
|
4009
|
-
},
|
|
4010
|
-
body: requestBody,
|
|
4011
|
-
mediaType: 'application/json'
|
|
4012
|
-
});
|
|
4013
|
-
}
|
|
4014
|
-
}
|
|
4015
|
-
|
|
4016
|
-
class AiFinetuningService {
|
|
4017
|
-
/**
|
|
4018
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4019
|
-
* @param org
|
|
4020
|
-
* @param username
|
|
4021
|
-
* @param dateCreated
|
|
4022
|
-
* @param numDataPoints
|
|
4023
|
-
* @param ordering Which field to use when ordering the results.
|
|
4024
|
-
* @param page A page number within the paginated result set.
|
|
4025
|
-
* @param pageSize Number of results to return per page.
|
|
4026
|
-
* @param retryAttempts
|
|
4027
|
-
* @param search A search term.
|
|
4028
|
-
* @param status * `pending` - Pending
|
|
4029
|
-
* * `processing` - Processing
|
|
4030
|
-
* * `completed` - Completed
|
|
4031
|
-
* * `failed` - Failed
|
|
4032
|
-
* @returns PaginatedDataSetList
|
|
4033
|
-
* @throws ApiError
|
|
4034
|
-
*/
|
|
4035
|
-
static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
|
|
4036
|
-
return request(OpenAPI, {
|
|
4037
|
-
method: 'GET',
|
|
4038
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
4039
|
-
path: {
|
|
4040
|
-
'org': org,
|
|
4041
|
-
'username': username
|
|
4042
|
-
},
|
|
4043
|
-
query: {
|
|
4044
|
-
'date_created': dateCreated,
|
|
4045
|
-
'num_data_points': numDataPoints,
|
|
4046
|
-
'ordering': ordering,
|
|
4047
|
-
'page': page,
|
|
4048
|
-
'page_size': pageSize,
|
|
4049
|
-
'retry_attempts': retryAttempts,
|
|
4050
|
-
'search': search,
|
|
4051
|
-
'status': status
|
|
4052
|
-
}
|
|
4053
|
-
});
|
|
4054
|
-
}
|
|
4055
|
-
/**
|
|
4056
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4057
|
-
* @param org
|
|
4058
|
-
* @param username
|
|
4059
|
-
* @param requestBody
|
|
4060
|
-
* @returns DataSetCreate
|
|
4061
|
-
* @throws ApiError
|
|
4062
|
-
*/
|
|
4063
|
-
static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
|
|
4064
|
-
return request(OpenAPI, {
|
|
4065
|
-
method: 'POST',
|
|
4066
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
4067
|
-
path: {
|
|
4068
|
-
'org': org,
|
|
4069
|
-
'username': username
|
|
4070
|
-
},
|
|
4071
|
-
body: requestBody,
|
|
4072
|
-
mediaType: 'application/json'
|
|
4073
|
-
});
|
|
4074
|
-
}
|
|
4075
|
-
/**
|
|
4076
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4077
|
-
* @param id A UUID string identifying this data set.
|
|
4078
|
-
* @param org
|
|
4079
|
-
* @param username
|
|
4080
|
-
* @returns DataSet
|
|
4081
|
-
* @throws ApiError
|
|
4082
|
-
*/
|
|
4083
|
-
static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
|
|
4084
|
-
return request(OpenAPI, {
|
|
4085
|
-
method: 'GET',
|
|
4086
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
4087
|
-
path: {
|
|
4088
|
-
'id': id,
|
|
4089
|
-
'org': org,
|
|
4090
|
-
'username': username
|
|
4091
|
-
}
|
|
4092
|
-
});
|
|
4093
|
-
}
|
|
4094
|
-
/**
|
|
4095
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4096
|
-
* @param id A UUID string identifying this data set.
|
|
4097
|
-
* @param org
|
|
4098
|
-
* @param username
|
|
4099
|
-
* @param requestBody
|
|
4100
|
-
* @returns DataSet
|
|
4101
|
-
* @throws ApiError
|
|
4102
|
-
*/
|
|
4103
|
-
static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
|
|
4104
|
-
return request(OpenAPI, {
|
|
4105
|
-
method: 'PUT',
|
|
4106
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
4107
|
-
path: {
|
|
4108
|
-
'id': id,
|
|
4109
|
-
'org': org,
|
|
4110
|
-
'username': username
|
|
4111
|
-
},
|
|
4112
|
-
body: requestBody,
|
|
4113
|
-
mediaType: 'application/json'
|
|
4114
|
-
});
|
|
4115
|
-
}
|
|
4116
|
-
/**
|
|
4117
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4118
|
-
* @param id A UUID string identifying this data set.
|
|
4119
|
-
* @param org
|
|
4120
|
-
* @param username
|
|
4121
|
-
* @param requestBody
|
|
4122
|
-
* @returns DataSet
|
|
4123
|
-
* @throws ApiError
|
|
4124
|
-
*/
|
|
4125
|
-
static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
|
|
4126
|
-
return request(OpenAPI, {
|
|
4127
|
-
method: 'PATCH',
|
|
4128
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
4129
|
-
path: {
|
|
4130
|
-
'id': id,
|
|
4131
|
-
'org': org,
|
|
4132
|
-
'username': username
|
|
4133
|
-
},
|
|
4134
|
-
body: requestBody,
|
|
4135
|
-
mediaType: 'application/json'
|
|
4136
|
-
});
|
|
4137
|
-
}
|
|
4138
|
-
/**
|
|
4139
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4140
|
-
* @param id A UUID string identifying this data set.
|
|
4141
|
-
* @param org
|
|
4142
|
-
* @param username
|
|
4143
|
-
* @returns void
|
|
4144
|
-
* @throws ApiError
|
|
4145
|
-
*/
|
|
4146
|
-
static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
|
|
4147
|
-
return request(OpenAPI, {
|
|
4148
|
-
method: 'DELETE',
|
|
4149
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
4150
|
-
path: {
|
|
4151
|
-
'id': id,
|
|
4152
|
-
'org': org,
|
|
4153
|
-
'username': username
|
|
4154
|
-
}
|
|
4155
|
-
});
|
|
4156
|
-
}
|
|
4157
|
-
/**
|
|
4158
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
4159
|
-
* @param org
|
|
4160
|
-
* @param username
|
|
4161
|
-
* @param baseModelName
|
|
4162
|
-
* @param dataset
|
|
4163
|
-
* @param dateCreated
|
|
4164
|
-
* @param fineTunedModel
|
|
4165
|
-
* @param lastModified
|
|
4166
|
-
* @param ordering Which field to use when ordering the results.
|
|
4167
|
-
* @param page A page number within the paginated result set.
|
|
4168
|
-
* @param pageSize Number of results to return per page.
|
|
4169
|
-
* @param preprocessDataset
|
|
4170
|
-
* @param provider * `openai` - Openai
|
|
4171
|
-
* @param search A search term.
|
|
4172
|
-
* @param status * `pending` - Pending
|
|
4173
|
-
* * `processing` - Processing
|
|
4174
|
-
* * `completed` - Completed
|
|
4175
|
-
* * `cancelled` - Cancelled
|
|
4176
|
-
* * `failed` - Failed
|
|
4177
|
-
* @returns PaginatedTrainingList
|
|
4178
|
-
* @throws ApiError
|
|
4179
|
-
*/
|
|
4180
|
-
static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
|
|
4181
|
-
return request(OpenAPI, {
|
|
4182
|
-
method: 'GET',
|
|
4183
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
4184
|
-
path: {
|
|
4185
|
-
'org': org,
|
|
4186
|
-
'username': username
|
|
4187
|
-
},
|
|
4188
|
-
query: {
|
|
4189
|
-
'base_model_name': baseModelName,
|
|
4190
|
-
'dataset': dataset,
|
|
4191
|
-
'date_created': dateCreated,
|
|
4192
|
-
'fine_tuned_model': fineTunedModel,
|
|
4193
|
-
'last_modified': lastModified,
|
|
4194
|
-
'ordering': ordering,
|
|
4195
|
-
'page': page,
|
|
4196
|
-
'page_size': pageSize,
|
|
4197
|
-
'preprocess_dataset': preprocessDataset,
|
|
4198
|
-
'provider': provider,
|
|
4199
|
-
'search': search,
|
|
4200
|
-
'status': status
|
|
4201
|
-
}
|
|
4202
|
-
});
|
|
4203
|
-
}
|
|
4204
|
-
/**
|
|
4205
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
2721
|
+
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
4206
2722
|
* @param org
|
|
4207
|
-
* @param
|
|
4208
|
-
* @param
|
|
4209
|
-
* @
|
|
2723
|
+
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2724
|
+
* @param userId
|
|
2725
|
+
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
2726
|
+
* @param mentorId Filter by mentor unique ID
|
|
2727
|
+
* @returns UserTrendByPeriod
|
|
4210
2728
|
* @throws ApiError
|
|
4211
2729
|
*/
|
|
4212
|
-
static
|
|
2730
|
+
static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve(endDate, org, startDate, userId, aggregation = 'daily', mentorId) {
|
|
4213
2731
|
return request(OpenAPI, {
|
|
4214
|
-
method: '
|
|
4215
|
-
url: '/api/ai-
|
|
2732
|
+
method: 'GET',
|
|
2733
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cohorts-over-time/',
|
|
4216
2734
|
path: {
|
|
4217
2735
|
'org': org,
|
|
4218
|
-
'
|
|
2736
|
+
'user_id': userId
|
|
4219
2737
|
},
|
|
4220
|
-
|
|
4221
|
-
|
|
2738
|
+
query: {
|
|
2739
|
+
'aggregation': aggregation,
|
|
2740
|
+
'end_date': endDate,
|
|
2741
|
+
'mentor_id': mentorId,
|
|
2742
|
+
'start_date': startDate
|
|
2743
|
+
},
|
|
2744
|
+
errors: {
|
|
2745
|
+
400: `Invalid parameters`,
|
|
2746
|
+
404: `Organization not found`
|
|
2747
|
+
}
|
|
4222
2748
|
});
|
|
4223
2749
|
}
|
|
4224
2750
|
/**
|
|
4225
|
-
*
|
|
4226
|
-
*
|
|
2751
|
+
* Retrieve LLM usage costs for a specific user.
|
|
2752
|
+
*
|
|
2753
|
+
* This endpoint returns data on the total cost of LLM usage for a specific user
|
|
2754
|
+
* within a specified date range. The cost is calculated by summing the costs
|
|
2755
|
+
* of all observations associated with traces from the tenant's sessions.
|
|
2756
|
+
*
|
|
2757
|
+
* Args:
|
|
2758
|
+
* request: The HTTP request containing filter query parameters.
|
|
2759
|
+
* org: Organization key identifier.
|
|
2760
|
+
* user_id: User key identifier.
|
|
2761
|
+
*
|
|
2762
|
+
* Returns:
|
|
2763
|
+
* Response: Total LLM usage cost for the specified tenant.
|
|
2764
|
+
*
|
|
2765
|
+
* Raises:
|
|
2766
|
+
* NotFound: If the specified organization does not exist.
|
|
2767
|
+
* BadRequest: If the provided parameters are invalid.
|
|
2768
|
+
*
|
|
2769
|
+
* Query Parameters:
|
|
2770
|
+
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2771
|
+
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2772
|
+
* @param endDate
|
|
4227
2773
|
* @param org
|
|
2774
|
+
* @param startDate
|
|
2775
|
+
* @param userId
|
|
4228
2776
|
* @param username
|
|
4229
|
-
* @returns
|
|
2777
|
+
* @returns Cost
|
|
4230
2778
|
* @throws ApiError
|
|
4231
2779
|
*/
|
|
4232
|
-
static
|
|
2780
|
+
static aiAnalyticsOrgsUsersUserCostRetrieve(endDate, org, startDate, userId, username) {
|
|
4233
2781
|
return request(OpenAPI, {
|
|
4234
2782
|
method: 'GET',
|
|
4235
|
-
url: '/api/ai-
|
|
2783
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-cost/',
|
|
4236
2784
|
path: {
|
|
4237
|
-
'id': id,
|
|
4238
2785
|
'org': org,
|
|
2786
|
+
'user_id': userId
|
|
2787
|
+
},
|
|
2788
|
+
query: {
|
|
2789
|
+
'end_date': endDate,
|
|
2790
|
+
'start_date': startDate,
|
|
4239
2791
|
'username': username
|
|
2792
|
+
},
|
|
2793
|
+
errors: {
|
|
2794
|
+
400: `Invalid parameters`,
|
|
2795
|
+
404: `Organization not found`
|
|
4240
2796
|
}
|
|
4241
2797
|
});
|
|
4242
2798
|
}
|
|
4243
2799
|
/**
|
|
4244
|
-
*
|
|
4245
|
-
*
|
|
2800
|
+
* Retrieve aggregated user chat feedback counts.
|
|
2801
|
+
*
|
|
2802
|
+
* This endpoint returns data on the number of user chat feedback entries
|
|
2803
|
+
* within a specified date range, with options for different time aggregations
|
|
2804
|
+
* (hourly, daily, weekly). Results can be filtered by mentor.
|
|
2805
|
+
*
|
|
2806
|
+
* Args:
|
|
2807
|
+
* request: The HTTP request containing filter query parameters.
|
|
2808
|
+
* org: Organization key identifier.
|
|
2809
|
+
*
|
|
2810
|
+
* Returns:
|
|
2811
|
+
* Response: Time series data of feedback counts.
|
|
2812
|
+
*
|
|
2813
|
+
* Raises:
|
|
2814
|
+
* NotFound: If the specified organization does not exist.
|
|
2815
|
+
* BadRequest: If the provided parameters are invalid.
|
|
2816
|
+
*
|
|
2817
|
+
* Query Parameters:
|
|
2818
|
+
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2819
|
+
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2820
|
+
* mentor_id (str): Filter by mentor unique ID.
|
|
2821
|
+
* aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
|
|
2822
|
+
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
4246
2823
|
* @param org
|
|
4247
|
-
* @param
|
|
4248
|
-
* @param
|
|
4249
|
-
* @
|
|
2824
|
+
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2825
|
+
* @param userId
|
|
2826
|
+
* @param aggregation Time aggregation level (hourly, daily, weekly)
|
|
2827
|
+
* @param mentorId Filter by mentor unique ID
|
|
2828
|
+
* @returns UserChatFeedbackCount
|
|
4250
2829
|
* @throws ApiError
|
|
4251
2830
|
*/
|
|
4252
|
-
static
|
|
2831
|
+
static aiAnalyticsOrgsUsersUserFeedbackList(endDate, org, startDate, userId, aggregation = 'daily', mentorId) {
|
|
4253
2832
|
return request(OpenAPI, {
|
|
4254
|
-
method: '
|
|
4255
|
-
url: '/api/ai-
|
|
2833
|
+
method: 'GET',
|
|
2834
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-feedback/',
|
|
4256
2835
|
path: {
|
|
4257
|
-
'id': id,
|
|
4258
2836
|
'org': org,
|
|
4259
|
-
'
|
|
2837
|
+
'user_id': userId
|
|
4260
2838
|
},
|
|
4261
|
-
|
|
4262
|
-
|
|
2839
|
+
query: {
|
|
2840
|
+
'aggregation': aggregation,
|
|
2841
|
+
'end_date': endDate,
|
|
2842
|
+
'mentor_id': mentorId,
|
|
2843
|
+
'start_date': startDate
|
|
2844
|
+
},
|
|
2845
|
+
errors: {
|
|
2846
|
+
400: `Invalid parameters`,
|
|
2847
|
+
404: `Organization not found`
|
|
2848
|
+
}
|
|
4263
2849
|
});
|
|
4264
2850
|
}
|
|
4265
2851
|
/**
|
|
4266
|
-
*
|
|
4267
|
-
*
|
|
2852
|
+
* Retrieve comprehensive user metrics.
|
|
2853
|
+
*
|
|
2854
|
+
* This endpoint returns data on various user metrics with month-over-month
|
|
2855
|
+
* change calculations:
|
|
2856
|
+
* - Registered users: Total users registered on the platform
|
|
2857
|
+
* - New users: Users who joined in the current month
|
|
2858
|
+
* - Unique users: Distinct users who have had sessions
|
|
2859
|
+
* - Veteran users: Users who have been active for at least 6 months
|
|
2860
|
+
*
|
|
2861
|
+
* Results can be filtered by mentor.
|
|
2862
|
+
*
|
|
2863
|
+
* Args:
|
|
2864
|
+
* request: The HTTP request containing filter query parameters.
|
|
2865
|
+
* org: Organization key identifier.
|
|
2866
|
+
*
|
|
2867
|
+
* Returns:
|
|
2868
|
+
* Response: Comprehensive user metrics with month-over-month changes.
|
|
2869
|
+
*
|
|
2870
|
+
* Raises:
|
|
2871
|
+
* NotFound: If the specified organization does not exist.
|
|
2872
|
+
*
|
|
2873
|
+
* Query Parameters:
|
|
2874
|
+
* mentor_id (str): Filter metrics by mentor unique ID.
|
|
4268
2875
|
* @param org
|
|
4269
|
-
* @param
|
|
4270
|
-
* @param
|
|
4271
|
-
* @
|
|
2876
|
+
* @param userId
|
|
2877
|
+
* @param groupBy
|
|
2878
|
+
* @param mentorId Filter metrics by mentor unique ID
|
|
2879
|
+
* @returns UserMetricsResponse
|
|
4272
2880
|
* @throws ApiError
|
|
4273
2881
|
*/
|
|
4274
|
-
static
|
|
2882
|
+
static aiAnalyticsOrgsUsersUserMetricsRetrieve(org, userId, groupBy = 'day', mentorId) {
|
|
4275
2883
|
return request(OpenAPI, {
|
|
4276
|
-
method: '
|
|
4277
|
-
url: '/api/ai-
|
|
2884
|
+
method: 'GET',
|
|
2885
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/',
|
|
4278
2886
|
path: {
|
|
4279
|
-
'id': id,
|
|
4280
2887
|
'org': org,
|
|
4281
|
-
'
|
|
2888
|
+
'user_id': userId
|
|
4282
2889
|
},
|
|
4283
|
-
|
|
4284
|
-
|
|
2890
|
+
query: {
|
|
2891
|
+
'group_by': groupBy,
|
|
2892
|
+
'mentor_id': mentorId
|
|
2893
|
+
},
|
|
2894
|
+
errors: {
|
|
2895
|
+
404: `Organization not found`
|
|
2896
|
+
}
|
|
4285
2897
|
});
|
|
4286
2898
|
}
|
|
4287
2899
|
/**
|
|
4288
|
-
*
|
|
4289
|
-
*
|
|
2900
|
+
* Retrieve user distribution data for pie charts.
|
|
2901
|
+
*
|
|
2902
|
+
* This endpoint returns data on the distribution of new versus returning users
|
|
2903
|
+
* within a specified date range, including both counts and percentages,
|
|
2904
|
+
* suitable for pie chart visualization.
|
|
2905
|
+
*
|
|
2906
|
+
* Args:
|
|
2907
|
+
* request: The HTTP request containing filter query parameters.
|
|
2908
|
+
* org: Organization key identifier.
|
|
2909
|
+
*
|
|
2910
|
+
* Returns:
|
|
2911
|
+
* Response: Distribution of new versus returning users with counts and percentages.
|
|
2912
|
+
*
|
|
2913
|
+
* Raises:
|
|
2914
|
+
* NotFound: If the specified organization does not exist.
|
|
2915
|
+
* BadRequest: If the provided parameters are invalid.
|
|
2916
|
+
*
|
|
2917
|
+
* Query Parameters:
|
|
2918
|
+
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2919
|
+
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2920
|
+
* mentor_id (str): Filter by mentor unique ID.
|
|
2921
|
+
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
4290
2922
|
* @param org
|
|
4291
|
-
* @param
|
|
4292
|
-
* @
|
|
2923
|
+
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2924
|
+
* @param userId
|
|
2925
|
+
* @param mentorId Filter by mentor unique ID
|
|
2926
|
+
* @returns PieChartData
|
|
4293
2927
|
* @throws ApiError
|
|
4294
2928
|
*/
|
|
4295
|
-
static
|
|
2929
|
+
static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve(endDate, org, startDate, userId, mentorId) {
|
|
4296
2930
|
return request(OpenAPI, {
|
|
4297
|
-
method: '
|
|
4298
|
-
url: '/api/ai-
|
|
2931
|
+
method: 'GET',
|
|
2932
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/',
|
|
4299
2933
|
path: {
|
|
4300
|
-
'id': id,
|
|
4301
2934
|
'org': org,
|
|
4302
|
-
'
|
|
2935
|
+
'user_id': userId
|
|
2936
|
+
},
|
|
2937
|
+
query: {
|
|
2938
|
+
'end_date': endDate,
|
|
2939
|
+
'mentor_id': mentorId,
|
|
2940
|
+
'start_date': startDate
|
|
2941
|
+
},
|
|
2942
|
+
errors: {
|
|
2943
|
+
400: `Invalid parameters`,
|
|
2944
|
+
404: `Organization not found`
|
|
4303
2945
|
}
|
|
4304
2946
|
});
|
|
4305
2947
|
}
|
|
4306
2948
|
/**
|
|
4307
|
-
*
|
|
4308
|
-
*
|
|
2949
|
+
* Retrieve user sentiment distribution.
|
|
2950
|
+
*
|
|
2951
|
+
* This endpoint returns data on the distribution of user sentiments (positive,
|
|
2952
|
+
* negative, neutral) within a specified date range, expressed as percentages.
|
|
2953
|
+
*
|
|
2954
|
+
* Args:
|
|
2955
|
+
* request: The HTTP request containing filter query parameters.
|
|
2956
|
+
* org: Organization key identifier.
|
|
4309
2957
|
*
|
|
4310
|
-
* NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
|
|
4311
|
-
* training list endpoint.
|
|
4312
2958
|
* Returns:
|
|
4313
|
-
* Response:
|
|
2959
|
+
* Response: Sentiment distribution percentages and total sentiment count.
|
|
2960
|
+
*
|
|
2961
|
+
* Raises:
|
|
2962
|
+
* NotFound: If the specified organization does not exist.
|
|
2963
|
+
* BadRequest: If the provided parameters are invalid.
|
|
2964
|
+
*
|
|
2965
|
+
* Query Parameters:
|
|
2966
|
+
* start_date (str): Start date for filtering (YYYY-MM-DD) - required.
|
|
2967
|
+
* end_date (str): End date for filtering (YYYY-MM-DD) - required.
|
|
2968
|
+
* @param endDate End date for filtering (YYYY-MM-DD)
|
|
4314
2969
|
* @param org
|
|
4315
|
-
* @param
|
|
4316
|
-
* @
|
|
2970
|
+
* @param startDate Start date for filtering (YYYY-MM-DD)
|
|
2971
|
+
* @param userId
|
|
2972
|
+
* @param groupBy
|
|
2973
|
+
* @returns SentimentSummary
|
|
4317
2974
|
* @throws ApiError
|
|
4318
2975
|
*/
|
|
4319
|
-
static
|
|
2976
|
+
static aiAnalyticsOrgsUsersUserSentimentRetrieve(endDate, org, startDate, userId, groupBy = 'day') {
|
|
4320
2977
|
return request(OpenAPI, {
|
|
4321
2978
|
method: 'GET',
|
|
4322
|
-
url: '/api/ai-
|
|
2979
|
+
url: '/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/',
|
|
4323
2980
|
path: {
|
|
4324
2981
|
'org': org,
|
|
4325
|
-
'
|
|
2982
|
+
'user_id': userId
|
|
2983
|
+
},
|
|
2984
|
+
query: {
|
|
2985
|
+
'end_date': endDate,
|
|
2986
|
+
'group_by': groupBy,
|
|
2987
|
+
'start_date': startDate
|
|
2988
|
+
},
|
|
2989
|
+
errors: {
|
|
2990
|
+
400: `Invalid parameters`,
|
|
2991
|
+
404: `Organization not found`
|
|
4326
2992
|
}
|
|
4327
2993
|
});
|
|
4328
2994
|
}
|
|
@@ -24334,7 +23000,9 @@ class CredentialsService {
|
|
|
24334
23000
|
* A JSON response containing the assertion details using the AssertionSerializer format
|
|
24335
23001
|
*
|
|
24336
23002
|
* Error Responses:
|
|
24337
|
-
* 404 Not Found:
|
|
23003
|
+
* 404 Not Found:
|
|
23004
|
+
* - If the assertion doesn't exist: Empty response with 404 status
|
|
23005
|
+
* - If the assertion has been revoked: JSON with error detail and revocation reason
|
|
24338
23006
|
* 500 Internal Server Error: If an unexpected error occurs
|
|
24339
23007
|
* @param entityId
|
|
24340
23008
|
* @returns any No response body
|
|
@@ -25848,6 +24516,24 @@ class NotificationService {
|
|
|
25848
24516
|
mediaType: 'application/json'
|
|
25849
24517
|
});
|
|
25850
24518
|
}
|
|
24519
|
+
/**
|
|
24520
|
+
* Mark all notifications as read for a user. Optionally provide specific notification IDs.
|
|
24521
|
+
* @param platformKey
|
|
24522
|
+
* @param requestBody
|
|
24523
|
+
* @returns MarkAllReadResponse
|
|
24524
|
+
* @throws ApiError
|
|
24525
|
+
*/
|
|
24526
|
+
static notificationV1OrgsMarkAllAsReadCreate(platformKey, requestBody) {
|
|
24527
|
+
return request(OpenAPI, {
|
|
24528
|
+
method: 'POST',
|
|
24529
|
+
url: '/api/notification/v1/orgs/{platform_key}/mark-all-as-read',
|
|
24530
|
+
path: {
|
|
24531
|
+
'platform_key': platformKey
|
|
24532
|
+
},
|
|
24533
|
+
body: requestBody,
|
|
24534
|
+
mediaType: 'application/json'
|
|
24535
|
+
});
|
|
24536
|
+
}
|
|
25851
24537
|
}
|
|
25852
24538
|
|
|
25853
24539
|
class NotificationBuilderService {
|
|
@@ -29990,8 +28676,6 @@ class UserGroupsService {
|
|
|
29990
28676
|
|
|
29991
28677
|
exports.AiAccountService = AiAccountService;
|
|
29992
28678
|
exports.AiAnalyticsService = AiAnalyticsService;
|
|
29993
|
-
exports.AiBotService = AiBotService;
|
|
29994
|
-
exports.AiFinetuningService = AiFinetuningService;
|
|
29995
28679
|
exports.AiIndexService = AiIndexService;
|
|
29996
28680
|
exports.AiMarketingService = AiMarketingService;
|
|
29997
28681
|
exports.AiMentorService = AiMentorService;
|