@devrev/typescript-sdk 1.1.36 → 1.1.39
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.
|
@@ -468,6 +468,67 @@ export declare enum AggregationDetailAggregationType {
|
|
|
468
468
|
Sum = "sum",
|
|
469
469
|
UniqueCount = "unique_count"
|
|
470
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
* ai-agent-event-execute-error
|
|
473
|
+
* An error object providing the error message for the AI agent event
|
|
474
|
+
* execution.
|
|
475
|
+
*/
|
|
476
|
+
export interface AiAgentEventExecuteError {
|
|
477
|
+
/**
|
|
478
|
+
* The error message for the AI agent event execution.
|
|
479
|
+
* @maxLength 512
|
|
480
|
+
*/
|
|
481
|
+
error: string;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* ai-agent-event-execute-progress
|
|
485
|
+
* A progress object providing the status of the AI agent event execution.
|
|
486
|
+
*/
|
|
487
|
+
export interface AiAgentEventExecuteProgress {
|
|
488
|
+
progress_state?: 'skill_executed' | 'skill_triggered';
|
|
489
|
+
/**
|
|
490
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
491
|
+
* has been executed.
|
|
492
|
+
*/
|
|
493
|
+
skill_executed?: AiAgentEventExecuteProgressSkillExecuted;
|
|
494
|
+
/**
|
|
495
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
496
|
+
* has been triggered.
|
|
497
|
+
*/
|
|
498
|
+
skill_triggered?: AiAgentEventExecuteProgressSkillTriggered;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* ai-agent-event-execute-progress-skill-executed
|
|
502
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
503
|
+
* has been executed.
|
|
504
|
+
*/
|
|
505
|
+
export interface AiAgentEventExecuteProgressSkillExecuted {
|
|
506
|
+
/** The arguments for the skill call. */
|
|
507
|
+
args?: object;
|
|
508
|
+
/** The output of the skill call. */
|
|
509
|
+
output: object;
|
|
510
|
+
/**
|
|
511
|
+
* The name of the skill.
|
|
512
|
+
* @maxLength 512
|
|
513
|
+
*/
|
|
514
|
+
skill_name: string;
|
|
515
|
+
}
|
|
516
|
+
/**
|
|
517
|
+
* ai-agent-event-execute-progress-skill-triggered
|
|
518
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
519
|
+
* has been triggered.
|
|
520
|
+
*/
|
|
521
|
+
export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
522
|
+
/** The arguments for the skill call. */
|
|
523
|
+
args: object;
|
|
524
|
+
/**
|
|
525
|
+
* The name of the skill.
|
|
526
|
+
* @maxLength 512
|
|
527
|
+
*/
|
|
528
|
+
skill_name: string;
|
|
529
|
+
workflow?: WorkflowSummary;
|
|
530
|
+
workflow_run?: WorkflowRunSummary;
|
|
531
|
+
}
|
|
471
532
|
/**
|
|
472
533
|
* airdrop-sync-units-get-request
|
|
473
534
|
* Request to get a sync unit.
|
|
@@ -608,6 +669,11 @@ export interface ArchetypeMetricTarget {
|
|
|
608
669
|
*/
|
|
609
670
|
warning_target_time?: string;
|
|
610
671
|
}
|
|
672
|
+
/**
|
|
673
|
+
* archetype-sla-summary
|
|
674
|
+
* SLA summary for the object.
|
|
675
|
+
*/
|
|
676
|
+
export type ArchetypeSlaSummary = object;
|
|
611
677
|
/** article */
|
|
612
678
|
export type Article = AtomBase & {
|
|
613
679
|
/** Parts relevant to the article. */
|
|
@@ -1818,6 +1884,68 @@ export declare enum BooleanExpressionType {
|
|
|
1818
1884
|
export type Capability = PartBase;
|
|
1819
1885
|
/** capability-summary */
|
|
1820
1886
|
export type CapabilitySummary = PartBaseSummary;
|
|
1887
|
+
/**
|
|
1888
|
+
* chat-completions-request
|
|
1889
|
+
* The request to complete a chat conversation.
|
|
1890
|
+
*/
|
|
1891
|
+
export interface ChatCompletionsRequest {
|
|
1892
|
+
/**
|
|
1893
|
+
* The maximum number of tokens that can be generated in the chat
|
|
1894
|
+
* completion.
|
|
1895
|
+
* @format int32
|
|
1896
|
+
*/
|
|
1897
|
+
max_tokens?: number;
|
|
1898
|
+
/**
|
|
1899
|
+
* A list of messages comprising the conversation so far.
|
|
1900
|
+
* @minItems 1
|
|
1901
|
+
*/
|
|
1902
|
+
messages: ChatCompletionsRequestMessage[];
|
|
1903
|
+
/**
|
|
1904
|
+
* Sequences where the API will stop generating further tokens.
|
|
1905
|
+
* Maximum of 4 sequences are supported. Defaults to none.
|
|
1906
|
+
*/
|
|
1907
|
+
stop_sequences?: string[];
|
|
1908
|
+
/** If set, partial message deltas will be sent. Defaults to false. */
|
|
1909
|
+
stream?: boolean;
|
|
1910
|
+
/**
|
|
1911
|
+
* What sampling temperature to use. Value can be between 0 and 2 and
|
|
1912
|
+
* defaults to 1.0. Higher values like 0.8 will make the output more
|
|
1913
|
+
* random, while lower values like 0.2 will make it more focused and
|
|
1914
|
+
* deterministic.
|
|
1915
|
+
* @format float
|
|
1916
|
+
*/
|
|
1917
|
+
temperature?: number;
|
|
1918
|
+
/**
|
|
1919
|
+
* An alternative to sampling with temperature, called nucleus
|
|
1920
|
+
* sampling, where the model considers the results of the tokens with
|
|
1921
|
+
* top_p probability mass. So 0.1 means only the tokens comprising the
|
|
1922
|
+
* top 10% probability mass are considered. For openai: Between 0 and
|
|
1923
|
+
* 1. Defaults to 1.0.
|
|
1924
|
+
* @format float
|
|
1925
|
+
*/
|
|
1926
|
+
top_p?: number;
|
|
1927
|
+
}
|
|
1928
|
+
/** chat-completions-request-message */
|
|
1929
|
+
export interface ChatCompletionsRequestMessage {
|
|
1930
|
+
/** Text content of the message. */
|
|
1931
|
+
content: string;
|
|
1932
|
+
/** The role of the entity that is creating the message. */
|
|
1933
|
+
role: ChatCompletionsRequestMessageRole;
|
|
1934
|
+
}
|
|
1935
|
+
/** The role of the entity that is creating the message. */
|
|
1936
|
+
export declare enum ChatCompletionsRequestMessageRole {
|
|
1937
|
+
Assistant = "assistant",
|
|
1938
|
+
System = "system",
|
|
1939
|
+
User = "user"
|
|
1940
|
+
}
|
|
1941
|
+
/**
|
|
1942
|
+
* chat-completions-response
|
|
1943
|
+
* The response for the generated chat completion.
|
|
1944
|
+
*/
|
|
1945
|
+
export interface ChatCompletionsResponse {
|
|
1946
|
+
/** Text response generated for the chat. */
|
|
1947
|
+
text_response?: string;
|
|
1948
|
+
}
|
|
1821
1949
|
/**
|
|
1822
1950
|
* client-context
|
|
1823
1951
|
* Properties of client to be used in track API.
|
|
@@ -2184,6 +2312,8 @@ export type Conversation = AtomBase & {
|
|
|
2184
2312
|
metadata?: ConversationMetadata;
|
|
2185
2313
|
/** Owner IDs for the conversation. */
|
|
2186
2314
|
owned_by?: UserSummary[];
|
|
2315
|
+
/** SLA summary for the object. */
|
|
2316
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
2187
2317
|
sla_tracker?: SlaTrackerSummary;
|
|
2188
2318
|
/** Describes the current stage of a work item. */
|
|
2189
2319
|
stage?: LegacyStage;
|
|
@@ -4550,6 +4680,8 @@ export interface EnumValue {
|
|
|
4550
4680
|
* @format int64
|
|
4551
4681
|
*/
|
|
4552
4682
|
ordinal: number;
|
|
4683
|
+
/** The actual value of the enum value. */
|
|
4684
|
+
value?: any;
|
|
4553
4685
|
}
|
|
4554
4686
|
/**
|
|
4555
4687
|
* enum-value-summary
|
|
@@ -4852,6 +4984,21 @@ export interface EventAccountUpdated {
|
|
|
4852
4984
|
account: Account;
|
|
4853
4985
|
old_account?: Account;
|
|
4854
4986
|
}
|
|
4987
|
+
/** event-ai-agent-response */
|
|
4988
|
+
export interface EventAiAgentResponse {
|
|
4989
|
+
agent_response?: 'error' | 'message' | 'progress';
|
|
4990
|
+
/** The metadata given by client to be passed to the event source. */
|
|
4991
|
+
client_metadata?: object;
|
|
4992
|
+
/**
|
|
4993
|
+
* An error object providing the error message for the AI agent event
|
|
4994
|
+
* execution.
|
|
4995
|
+
*/
|
|
4996
|
+
error?: AiAgentEventExecuteError;
|
|
4997
|
+
/** The final response of asynchronous agent events execution. */
|
|
4998
|
+
message?: string;
|
|
4999
|
+
/** A progress object providing the status of the AI agent event execution. */
|
|
5000
|
+
progress?: AiAgentEventExecuteProgress;
|
|
5001
|
+
}
|
|
4855
5002
|
/** event-conversation-created */
|
|
4856
5003
|
export interface EventConversationCreated {
|
|
4857
5004
|
conversation: Conversation;
|
|
@@ -5431,6 +5578,29 @@ export declare enum GenericNotificationEventType {
|
|
|
5431
5578
|
Reminder = "reminder",
|
|
5432
5579
|
Update = "update"
|
|
5433
5580
|
}
|
|
5581
|
+
/**
|
|
5582
|
+
* get-reply-request
|
|
5583
|
+
* The request to get a reply for a query using an organization's
|
|
5584
|
+
* knowledge base.
|
|
5585
|
+
*/
|
|
5586
|
+
export interface GetReplyRequest {
|
|
5587
|
+
/**
|
|
5588
|
+
* The query string.
|
|
5589
|
+
* @minLength 1
|
|
5590
|
+
* @maxLength 10000
|
|
5591
|
+
*/
|
|
5592
|
+
query: string;
|
|
5593
|
+
}
|
|
5594
|
+
/**
|
|
5595
|
+
* get-reply-response
|
|
5596
|
+
* The response for the generated reply.
|
|
5597
|
+
*/
|
|
5598
|
+
export interface GetReplyResponse {
|
|
5599
|
+
/** The reply generated for the requested query. */
|
|
5600
|
+
reply?: string;
|
|
5601
|
+
/** Sources from which the reply is generated. */
|
|
5602
|
+
sources?: TuringSources[];
|
|
5603
|
+
}
|
|
5434
5604
|
/**
|
|
5435
5605
|
* get-rev-users-personal-data-request
|
|
5436
5606
|
* Request object to get a contact's information.
|
|
@@ -6221,6 +6391,8 @@ export type Issue = WorkBase & {
|
|
|
6221
6391
|
developed_with?: PartSummary[];
|
|
6222
6392
|
/** Priority of the work based upon impact and criticality. */
|
|
6223
6393
|
priority?: IssuePriority;
|
|
6394
|
+
/** SLA summary for the object. */
|
|
6395
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
6224
6396
|
sla_tracker?: SlaTrackerSummary;
|
|
6225
6397
|
/** Vista group item. */
|
|
6226
6398
|
sprint?: VistaGroupItemSummary;
|
|
@@ -9640,6 +9812,16 @@ export interface SetIssueSelector {
|
|
|
9640
9812
|
*/
|
|
9641
9813
|
tags?: string[];
|
|
9642
9814
|
}
|
|
9815
|
+
/**
|
|
9816
|
+
* set-money
|
|
9817
|
+
* The money value to create.
|
|
9818
|
+
*/
|
|
9819
|
+
export interface SetMoney {
|
|
9820
|
+
/** The amount. */
|
|
9821
|
+
amount: string;
|
|
9822
|
+
/** The currency code conforming ISO 4217 standard. */
|
|
9823
|
+
currency: string;
|
|
9824
|
+
}
|
|
9643
9825
|
/** set-org-schedule-fragment-summary */
|
|
9644
9826
|
export interface SetOrgScheduleFragmentSummary {
|
|
9645
9827
|
/** Organization schedule fragment ID. */
|
|
@@ -11256,6 +11438,8 @@ export type Ticket = WorkBase & {
|
|
|
11256
11438
|
sentiment_summary?: string;
|
|
11257
11439
|
/** Severity of the ticket. */
|
|
11258
11440
|
severity?: TicketSeverity;
|
|
11441
|
+
/** SLA summary for the object. */
|
|
11442
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
11259
11443
|
sla_tracker?: SlaTrackerSummary;
|
|
11260
11444
|
/** Source channel of the ticket. */
|
|
11261
11445
|
source_channel?: string;
|
|
@@ -11805,6 +11989,14 @@ export interface TrackEventsPublishRequest {
|
|
|
11805
11989
|
}
|
|
11806
11990
|
/** track-events-publish-response */
|
|
11807
11991
|
export type TrackEventsPublishResponse = object;
|
|
11992
|
+
/** turing-sources */
|
|
11993
|
+
export type TuringSources = (ArticleSummary | QuestionAnswerSummary) & {
|
|
11994
|
+
type: TuringSourcesType;
|
|
11995
|
+
};
|
|
11996
|
+
export declare enum TuringSourcesType {
|
|
11997
|
+
Article = "article",
|
|
11998
|
+
QuestionAnswer = "question_answer"
|
|
11999
|
+
}
|
|
11808
12000
|
/**
|
|
11809
12001
|
* unit
|
|
11810
12002
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -12395,6 +12587,7 @@ export interface WebhookEventRequest {
|
|
|
12395
12587
|
account_created?: EventAccountCreated;
|
|
12396
12588
|
account_deleted?: EventAccountDeleted;
|
|
12397
12589
|
account_updated?: EventAccountUpdated;
|
|
12590
|
+
ai_agent_response?: EventAiAgentResponse;
|
|
12398
12591
|
conversation_created?: EventConversationCreated;
|
|
12399
12592
|
conversation_deleted?: EventConversationDeleted;
|
|
12400
12593
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -12826,6 +13019,10 @@ export declare enum WorkType {
|
|
|
12826
13019
|
Task = "task",
|
|
12827
13020
|
Ticket = "ticket"
|
|
12828
13021
|
}
|
|
13022
|
+
/** workflow-run-summary */
|
|
13023
|
+
export type WorkflowRunSummary = AtomBaseSummary;
|
|
13024
|
+
/** workflow-summary */
|
|
13025
|
+
export type WorkflowSummary = AtomBaseSummary;
|
|
12829
13026
|
/** works-create-request */
|
|
12830
13027
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
|
|
12831
13028
|
type: WorkType;
|
|
@@ -12919,6 +13116,8 @@ export interface WorksCreateRequestOpportunity {
|
|
|
12919
13116
|
* @format double
|
|
12920
13117
|
*/
|
|
12921
13118
|
amount?: number;
|
|
13119
|
+
/** The money value to create. */
|
|
13120
|
+
annual_contract_value?: SetMoney;
|
|
12922
13121
|
/** Contacts involved in the opportunity. */
|
|
12923
13122
|
contacts?: string[];
|
|
12924
13123
|
/**
|
|
@@ -12940,6 +13139,8 @@ export interface WorksCreateRequestOpportunity {
|
|
|
12940
13139
|
* @format double
|
|
12941
13140
|
*/
|
|
12942
13141
|
probability?: number;
|
|
13142
|
+
/** The money value to create. */
|
|
13143
|
+
value?: SetMoney;
|
|
12943
13144
|
}
|
|
12944
13145
|
/** works-create-request-task */
|
|
12945
13146
|
export interface WorksCreateRequestTask {
|
|
@@ -13326,6 +13527,8 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
13326
13527
|
* @format double
|
|
13327
13528
|
*/
|
|
13328
13529
|
amount?: number | null;
|
|
13530
|
+
/** The money value to create. */
|
|
13531
|
+
annual_contract_value?: SetMoney;
|
|
13329
13532
|
contacts?: WorksUpdateRequestOpportunityContacts;
|
|
13330
13533
|
/**
|
|
13331
13534
|
* Updates the customer budget.
|
|
@@ -13343,6 +13546,8 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
13343
13546
|
* @format double
|
|
13344
13547
|
*/
|
|
13345
13548
|
probability?: number | null;
|
|
13549
|
+
/** The money value to create. */
|
|
13550
|
+
value?: SetMoney;
|
|
13346
13551
|
}
|
|
13347
13552
|
/** works-update-request-opportunity-contacts */
|
|
13348
13553
|
export interface WorksUpdateRequestOpportunityContacts {
|
|
@@ -16404,6 +16609,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16404
16609
|
* @secure
|
|
16405
16610
|
*/
|
|
16406
16611
|
updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any>>;
|
|
16612
|
+
/**
|
|
16613
|
+
* @description Returns a response for the chat conversation.
|
|
16614
|
+
*
|
|
16615
|
+
* @tags recommendations
|
|
16616
|
+
* @name ChatCompletions
|
|
16617
|
+
* @request POST:/recommendations.chat.completions
|
|
16618
|
+
* @secure
|
|
16619
|
+
*/
|
|
16620
|
+
chatCompletions: (data: ChatCompletionsRequest, params?: RequestParams) => Promise<AxiosResponse<ChatCompletionsResponse, any>>;
|
|
16621
|
+
/**
|
|
16622
|
+
* @description Gets a reply for a user query.
|
|
16623
|
+
*
|
|
16624
|
+
* @tags recommendations
|
|
16625
|
+
* @name GetReply
|
|
16626
|
+
* @request POST:/recommendations.get-reply
|
|
16627
|
+
* @secure
|
|
16628
|
+
*/
|
|
16629
|
+
getReply: (data: GetReplyRequest, params?: RequestParams) => Promise<AxiosResponse<GetReplyResponse, any>>;
|
|
16407
16630
|
/**
|
|
16408
16631
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
16409
16632
|
*
|
|
@@ -33,9 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
37
|
-
exports.
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = void 0;
|
|
36
|
+
exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.ChatCompletionsRequestMessageRole = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingChannel = exports.ListMode = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncUnitSyncType = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -197,6 +197,13 @@ var BooleanExpressionType;
|
|
|
197
197
|
BooleanExpressionType["Or"] = "or";
|
|
198
198
|
BooleanExpressionType["Primitive"] = "primitive";
|
|
199
199
|
})(BooleanExpressionType = exports.BooleanExpressionType || (exports.BooleanExpressionType = {}));
|
|
200
|
+
/** The role of the entity that is creating the message. */
|
|
201
|
+
var ChatCompletionsRequestMessageRole;
|
|
202
|
+
(function (ChatCompletionsRequestMessageRole) {
|
|
203
|
+
ChatCompletionsRequestMessageRole["Assistant"] = "assistant";
|
|
204
|
+
ChatCompletionsRequestMessageRole["System"] = "system";
|
|
205
|
+
ChatCompletionsRequestMessageRole["User"] = "user";
|
|
206
|
+
})(ChatCompletionsRequestMessageRole = exports.ChatCompletionsRequestMessageRole || (exports.ChatCompletionsRequestMessageRole = {}));
|
|
200
207
|
/** Source of the code change object. */
|
|
201
208
|
var CodeChangeSource;
|
|
202
209
|
(function (CodeChangeSource) {
|
|
@@ -1073,6 +1080,11 @@ var TimelineEntryVisibility;
|
|
|
1073
1080
|
TimelineEntryVisibility["Private"] = "private";
|
|
1074
1081
|
TimelineEntryVisibility["Public"] = "public";
|
|
1075
1082
|
})(TimelineEntryVisibility = exports.TimelineEntryVisibility || (exports.TimelineEntryVisibility = {}));
|
|
1083
|
+
var TuringSourcesType;
|
|
1084
|
+
(function (TuringSourcesType) {
|
|
1085
|
+
TuringSourcesType["Article"] = "article";
|
|
1086
|
+
TuringSourcesType["QuestionAnswer"] = "question_answer";
|
|
1087
|
+
})(TuringSourcesType = exports.TuringSourcesType || (exports.TuringSourcesType = {}));
|
|
1076
1088
|
/**
|
|
1077
1089
|
* This defines the UOM unit type. For example, for 'number of video
|
|
1078
1090
|
* calls', unit type will be a number.
|
|
@@ -3052,6 +3064,24 @@ class Api extends HttpClient {
|
|
|
3052
3064
|
* @secure
|
|
3053
3065
|
*/
|
|
3054
3066
|
this.updateQuestionAnswer = (data, params = {}) => this.request(Object.assign({ path: `/question-answers.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3067
|
+
/**
|
|
3068
|
+
* @description Returns a response for the chat conversation.
|
|
3069
|
+
*
|
|
3070
|
+
* @tags recommendations
|
|
3071
|
+
* @name ChatCompletions
|
|
3072
|
+
* @request POST:/recommendations.chat.completions
|
|
3073
|
+
* @secure
|
|
3074
|
+
*/
|
|
3075
|
+
this.chatCompletions = (data, params = {}) => this.request(Object.assign({ path: `/recommendations.chat.completions`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3076
|
+
/**
|
|
3077
|
+
* @description Gets a reply for a user query.
|
|
3078
|
+
*
|
|
3079
|
+
* @tags recommendations
|
|
3080
|
+
* @name GetReply
|
|
3081
|
+
* @request POST:/recommendations.get-reply
|
|
3082
|
+
* @secure
|
|
3083
|
+
*/
|
|
3084
|
+
this.getReply = (data, params = {}) => this.request(Object.assign({ path: `/recommendations.get-reply`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3055
3085
|
/**
|
|
3056
3086
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
3057
3087
|
*
|
|
@@ -231,6 +231,67 @@ export interface AccountsUpdateRequestWebsites {
|
|
|
231
231
|
export interface AccountsUpdateResponse {
|
|
232
232
|
account: Account;
|
|
233
233
|
}
|
|
234
|
+
/**
|
|
235
|
+
* ai-agent-event-execute-error
|
|
236
|
+
* An error object providing the error message for the AI agent event
|
|
237
|
+
* execution.
|
|
238
|
+
*/
|
|
239
|
+
export interface AiAgentEventExecuteError {
|
|
240
|
+
/**
|
|
241
|
+
* The error message for the AI agent event execution.
|
|
242
|
+
* @maxLength 512
|
|
243
|
+
*/
|
|
244
|
+
error: string;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* ai-agent-event-execute-progress
|
|
248
|
+
* A progress object providing the status of the AI agent event execution.
|
|
249
|
+
*/
|
|
250
|
+
export interface AiAgentEventExecuteProgress {
|
|
251
|
+
progress_state?: 'skill_executed' | 'skill_triggered';
|
|
252
|
+
/**
|
|
253
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
254
|
+
* has been executed.
|
|
255
|
+
*/
|
|
256
|
+
skill_executed?: AiAgentEventExecuteProgressSkillExecuted;
|
|
257
|
+
/**
|
|
258
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
259
|
+
* has been triggered.
|
|
260
|
+
*/
|
|
261
|
+
skill_triggered?: AiAgentEventExecuteProgressSkillTriggered;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* ai-agent-event-execute-progress-skill-executed
|
|
265
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
266
|
+
* has been executed.
|
|
267
|
+
*/
|
|
268
|
+
export interface AiAgentEventExecuteProgressSkillExecuted {
|
|
269
|
+
/** The arguments for the skill call. */
|
|
270
|
+
args?: object;
|
|
271
|
+
/** The output of the skill call. */
|
|
272
|
+
output: object;
|
|
273
|
+
/**
|
|
274
|
+
* The name of the skill.
|
|
275
|
+
* @maxLength 512
|
|
276
|
+
*/
|
|
277
|
+
skill_name: string;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* ai-agent-event-execute-progress-skill-triggered
|
|
281
|
+
* The progress for the AI agent event execution indicating that the skill
|
|
282
|
+
* has been triggered.
|
|
283
|
+
*/
|
|
284
|
+
export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
285
|
+
/** The arguments for the skill call. */
|
|
286
|
+
args: object;
|
|
287
|
+
/**
|
|
288
|
+
* The name of the skill.
|
|
289
|
+
* @maxLength 512
|
|
290
|
+
*/
|
|
291
|
+
skill_name: string;
|
|
292
|
+
workflow?: WorkflowSummary;
|
|
293
|
+
workflow_run?: WorkflowRunSummary;
|
|
294
|
+
}
|
|
234
295
|
/**
|
|
235
296
|
* archetype-metric-target
|
|
236
297
|
* Metric with corresponding target values.
|
|
@@ -291,6 +352,11 @@ export interface ArchetypeMetricTarget {
|
|
|
291
352
|
*/
|
|
292
353
|
warning_target_time?: string;
|
|
293
354
|
}
|
|
355
|
+
/**
|
|
356
|
+
* archetype-sla-summary
|
|
357
|
+
* SLA summary for the object.
|
|
358
|
+
*/
|
|
359
|
+
export type ArchetypeSlaSummary = object;
|
|
294
360
|
/** artifact */
|
|
295
361
|
export type Artifact = AtomBase;
|
|
296
362
|
/** artifact-summary */
|
|
@@ -885,6 +951,8 @@ export type Conversation = AtomBase & {
|
|
|
885
951
|
metadata?: ConversationMetadata;
|
|
886
952
|
/** Owner IDs for the conversation. */
|
|
887
953
|
owned_by?: UserSummary[];
|
|
954
|
+
/** SLA summary for the object. */
|
|
955
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
888
956
|
sla_tracker?: SlaTrackerSummary;
|
|
889
957
|
/** Describes the current stage of a work item. */
|
|
890
958
|
stage?: LegacyStage;
|
|
@@ -1382,6 +1450,8 @@ export interface EnumValue {
|
|
|
1382
1450
|
* @format int64
|
|
1383
1451
|
*/
|
|
1384
1452
|
ordinal: number;
|
|
1453
|
+
/** The actual value of the enum value. */
|
|
1454
|
+
value?: any;
|
|
1385
1455
|
}
|
|
1386
1456
|
/** error */
|
|
1387
1457
|
export interface Error {
|
|
@@ -1666,6 +1736,21 @@ export interface EventAccountUpdated {
|
|
|
1666
1736
|
account: Account;
|
|
1667
1737
|
old_account?: Account;
|
|
1668
1738
|
}
|
|
1739
|
+
/** event-ai-agent-response */
|
|
1740
|
+
export interface EventAiAgentResponse {
|
|
1741
|
+
agent_response?: 'error' | 'message' | 'progress';
|
|
1742
|
+
/** The metadata given by client to be passed to the event source. */
|
|
1743
|
+
client_metadata?: object;
|
|
1744
|
+
/**
|
|
1745
|
+
* An error object providing the error message for the AI agent event
|
|
1746
|
+
* execution.
|
|
1747
|
+
*/
|
|
1748
|
+
error?: AiAgentEventExecuteError;
|
|
1749
|
+
/** The final response of asynchronous agent events execution. */
|
|
1750
|
+
message?: string;
|
|
1751
|
+
/** A progress object providing the status of the AI agent event execution. */
|
|
1752
|
+
progress?: AiAgentEventExecuteProgress;
|
|
1753
|
+
}
|
|
1669
1754
|
/** event-conversation-created */
|
|
1670
1755
|
export interface EventConversationCreated {
|
|
1671
1756
|
conversation: Conversation;
|
|
@@ -2038,6 +2123,8 @@ export type Issue = WorkBase & {
|
|
|
2038
2123
|
developed_with?: PartSummary[];
|
|
2039
2124
|
/** Priority of the work based upon impact and criticality. */
|
|
2040
2125
|
priority?: IssuePriority;
|
|
2126
|
+
/** SLA summary for the object. */
|
|
2127
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
2041
2128
|
sla_tracker?: SlaTrackerSummary;
|
|
2042
2129
|
/** Vista group item. */
|
|
2043
2130
|
sprint?: VistaGroupItemSummary;
|
|
@@ -4118,6 +4205,8 @@ export type Ticket = WorkBase & {
|
|
|
4118
4205
|
sentiment_summary?: string;
|
|
4119
4206
|
/** Severity of the ticket. */
|
|
4120
4207
|
severity?: TicketSeverity;
|
|
4208
|
+
/** SLA summary for the object. */
|
|
4209
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
4121
4210
|
sla_tracker?: SlaTrackerSummary;
|
|
4122
4211
|
/** Source channel of the ticket. */
|
|
4123
4212
|
source_channel?: string;
|
|
@@ -4547,6 +4636,7 @@ export interface WebhookEventRequest {
|
|
|
4547
4636
|
account_created?: EventAccountCreated;
|
|
4548
4637
|
account_deleted?: EventAccountDeleted;
|
|
4549
4638
|
account_updated?: EventAccountUpdated;
|
|
4639
|
+
ai_agent_response?: EventAiAgentResponse;
|
|
4550
4640
|
conversation_created?: EventConversationCreated;
|
|
4551
4641
|
conversation_deleted?: EventConversationDeleted;
|
|
4552
4642
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -4873,6 +4963,10 @@ export declare enum WorkType {
|
|
|
4873
4963
|
Issue = "issue",
|
|
4874
4964
|
Ticket = "ticket"
|
|
4875
4965
|
}
|
|
4966
|
+
/** workflow-run-summary */
|
|
4967
|
+
export type WorkflowRunSummary = AtomBaseSummary;
|
|
4968
|
+
/** workflow-summary */
|
|
4969
|
+
export type WorkflowSummary = AtomBaseSummary;
|
|
4876
4970
|
/** works-create-request */
|
|
4877
4971
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTicket) & {
|
|
4878
4972
|
type: WorkType;
|