@devrev/typescript-sdk 1.1.38 → 1.1.40
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.
|
|
@@ -2043,6 +2171,208 @@ export interface CodeChangesUpdateRequest {
|
|
|
2043
2171
|
export interface CodeChangesUpdateResponse {
|
|
2044
2172
|
code_change: CodeChange;
|
|
2045
2173
|
}
|
|
2174
|
+
/** command */
|
|
2175
|
+
export type Command = AtomBase & {
|
|
2176
|
+
/** Description of the command. */
|
|
2177
|
+
description?: string;
|
|
2178
|
+
/** Display name of the command. */
|
|
2179
|
+
display_name?: string;
|
|
2180
|
+
/** Name of the command. */
|
|
2181
|
+
name?: string;
|
|
2182
|
+
/** Namespace of the command. */
|
|
2183
|
+
namespace?: string;
|
|
2184
|
+
/**
|
|
2185
|
+
* The list of users, groups and audiences with whom the command is
|
|
2186
|
+
* shared.
|
|
2187
|
+
*/
|
|
2188
|
+
shared_with?: SharedWithMembership[];
|
|
2189
|
+
/** Status of the command. */
|
|
2190
|
+
status?: CommandStatus;
|
|
2191
|
+
/** Surfaces where this command can be invoked. */
|
|
2192
|
+
surfaces?: CommandSurface[];
|
|
2193
|
+
/**
|
|
2194
|
+
* A user friendly description of the parameters which can be passed
|
|
2195
|
+
* to the command.
|
|
2196
|
+
*/
|
|
2197
|
+
usage_hint?: string;
|
|
2198
|
+
};
|
|
2199
|
+
/** Specifies how the action is defined. */
|
|
2200
|
+
export declare enum CommandActionExecutorType {
|
|
2201
|
+
Rego = "rego",
|
|
2202
|
+
Workflow = "workflow"
|
|
2203
|
+
}
|
|
2204
|
+
/** The template engine for resolving message. */
|
|
2205
|
+
export declare enum CommandActionTemplateType {
|
|
2206
|
+
DevrevV1 = "devrev_v1"
|
|
2207
|
+
}
|
|
2208
|
+
/**
|
|
2209
|
+
* command-create-request
|
|
2210
|
+
* The request to create a command.
|
|
2211
|
+
*/
|
|
2212
|
+
export interface CommandCreateRequest {
|
|
2213
|
+
action?: CreateCommandAction;
|
|
2214
|
+
/** Description of the command. */
|
|
2215
|
+
description?: string;
|
|
2216
|
+
/** Display name of the command. */
|
|
2217
|
+
display_name?: string;
|
|
2218
|
+
/** Name of the command. */
|
|
2219
|
+
name: string;
|
|
2220
|
+
/** Namespace of the command. */
|
|
2221
|
+
namespace: string;
|
|
2222
|
+
/**
|
|
2223
|
+
* The list of users, groups and audiences with whom the command is
|
|
2224
|
+
* shared.
|
|
2225
|
+
*/
|
|
2226
|
+
shared_with?: SetSharedWithMembership[];
|
|
2227
|
+
/** ID of the source which created this command. */
|
|
2228
|
+
source?: string;
|
|
2229
|
+
/** Status of the command. */
|
|
2230
|
+
status?: CommandStatus;
|
|
2231
|
+
/** Surfaces where this command can be invoked. */
|
|
2232
|
+
surfaces?: CreateCommandSurface[];
|
|
2233
|
+
/**
|
|
2234
|
+
* A user friendly description of the parameters which can be passed
|
|
2235
|
+
* to the command.
|
|
2236
|
+
*/
|
|
2237
|
+
usage_hint?: string;
|
|
2238
|
+
}
|
|
2239
|
+
/** command-create-response */
|
|
2240
|
+
export interface CommandCreateResponse {
|
|
2241
|
+
command: Command;
|
|
2242
|
+
}
|
|
2243
|
+
/**
|
|
2244
|
+
* command-get-request
|
|
2245
|
+
* The request to get a command.
|
|
2246
|
+
*/
|
|
2247
|
+
export interface CommandGetRequest {
|
|
2248
|
+
/** The command's ID. */
|
|
2249
|
+
id: string;
|
|
2250
|
+
}
|
|
2251
|
+
/** command-get-response */
|
|
2252
|
+
export interface CommandGetResponse {
|
|
2253
|
+
command: Command;
|
|
2254
|
+
}
|
|
2255
|
+
/** Status of the command. */
|
|
2256
|
+
export declare enum CommandStatus {
|
|
2257
|
+
Disabled = "disabled",
|
|
2258
|
+
Draft = "draft",
|
|
2259
|
+
Enabled = "enabled"
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* command-surface
|
|
2263
|
+
* Metadata defining which surfaces this command can be executed on.
|
|
2264
|
+
*/
|
|
2265
|
+
export interface CommandSurface {
|
|
2266
|
+
/** Objects types on which a command can be invoked. */
|
|
2267
|
+
object_types?: CommandSurfaceObjectTypes[];
|
|
2268
|
+
/** Surfaces from where this command can be invoked. */
|
|
2269
|
+
surface?: CommandSurfaceSurface;
|
|
2270
|
+
}
|
|
2271
|
+
/** Objects types on which a command can be invoked. */
|
|
2272
|
+
export declare enum CommandSurfaceObjectTypes {
|
|
2273
|
+
Account = "account",
|
|
2274
|
+
Article = "article",
|
|
2275
|
+
Conversation = "conversation",
|
|
2276
|
+
Engagement = "engagement",
|
|
2277
|
+
Flow = "flow",
|
|
2278
|
+
Incident = "incident",
|
|
2279
|
+
Issue = "issue",
|
|
2280
|
+
Opportunity = "opportunity",
|
|
2281
|
+
Part = "part",
|
|
2282
|
+
RevOrg = "rev_org",
|
|
2283
|
+
RevUser = "rev_user",
|
|
2284
|
+
SnapIn = "snap_in",
|
|
2285
|
+
Ticket = "ticket"
|
|
2286
|
+
}
|
|
2287
|
+
/** Surfaces from where this command can be invoked. */
|
|
2288
|
+
export declare enum CommandSurfaceSurface {
|
|
2289
|
+
CustomerChat = "customer_chat",
|
|
2290
|
+
Discussions = "discussions"
|
|
2291
|
+
}
|
|
2292
|
+
/**
|
|
2293
|
+
* command-update-request
|
|
2294
|
+
* The request to update a command.
|
|
2295
|
+
*/
|
|
2296
|
+
export interface CommandUpdateRequest {
|
|
2297
|
+
action?: UpdateCommandAction;
|
|
2298
|
+
/** Description of the command. */
|
|
2299
|
+
description?: string;
|
|
2300
|
+
/** Display name of the command. */
|
|
2301
|
+
display_name?: string;
|
|
2302
|
+
/** The ID of the command to update. */
|
|
2303
|
+
id: string;
|
|
2304
|
+
/** Name of the command. */
|
|
2305
|
+
name?: string;
|
|
2306
|
+
/** Namespace of the command. */
|
|
2307
|
+
namespace?: string;
|
|
2308
|
+
/**
|
|
2309
|
+
* The list of users, groups and audiences with whom the command is
|
|
2310
|
+
* shared.
|
|
2311
|
+
*/
|
|
2312
|
+
shared_with?: SetSharedWithMembership[];
|
|
2313
|
+
/** ID of the source which created this command. */
|
|
2314
|
+
source?: string;
|
|
2315
|
+
/** Status of the command. */
|
|
2316
|
+
status?: CommandStatus;
|
|
2317
|
+
/** Surfaces where this command can be invoked. */
|
|
2318
|
+
surfaces?: UpdateCommandSurface[];
|
|
2319
|
+
/**
|
|
2320
|
+
* A user friendly description of the parameters which can be passed
|
|
2321
|
+
* to the command.
|
|
2322
|
+
*/
|
|
2323
|
+
usage_hint?: string;
|
|
2324
|
+
}
|
|
2325
|
+
/** command-update-response */
|
|
2326
|
+
export interface CommandUpdateResponse {
|
|
2327
|
+
command: Command;
|
|
2328
|
+
}
|
|
2329
|
+
/** commands-list-request */
|
|
2330
|
+
export interface CommandsListRequest {
|
|
2331
|
+
/**
|
|
2332
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2333
|
+
* iteration starts from the beginning.
|
|
2334
|
+
*/
|
|
2335
|
+
cursor?: string;
|
|
2336
|
+
/** Filtering based on executor_type. */
|
|
2337
|
+
executor_type?: CommandActionExecutorType[];
|
|
2338
|
+
/**
|
|
2339
|
+
* The maximum number of commands to return per page. The default is
|
|
2340
|
+
* '50'.
|
|
2341
|
+
* @format int32
|
|
2342
|
+
*/
|
|
2343
|
+
limit?: number;
|
|
2344
|
+
/**
|
|
2345
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2346
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2347
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2348
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2349
|
+
* always be returned in the specified sort-by order.
|
|
2350
|
+
*/
|
|
2351
|
+
mode?: ListMode;
|
|
2352
|
+
/** Filter commands based on namespace. */
|
|
2353
|
+
namespace?: string[];
|
|
2354
|
+
/** List of fields to sort the commands items by and how to sort them. */
|
|
2355
|
+
sort_by?: string[];
|
|
2356
|
+
/** ID of the object where command is invoked (work/part/conversation). */
|
|
2357
|
+
source_object_id?: string;
|
|
2358
|
+
/** Filter commands based on status. */
|
|
2359
|
+
status?: CommandStatus[];
|
|
2360
|
+
}
|
|
2361
|
+
/** commands-list-response */
|
|
2362
|
+
export interface CommandsListResponse {
|
|
2363
|
+
/** List of commands. */
|
|
2364
|
+
commands: Command[];
|
|
2365
|
+
/**
|
|
2366
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2367
|
+
* sort order. If not set, then no later elements exist.
|
|
2368
|
+
*/
|
|
2369
|
+
next_cursor?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2372
|
+
* sort order. If not set, then no prior elements exist.
|
|
2373
|
+
*/
|
|
2374
|
+
prev_cursor?: string;
|
|
2375
|
+
}
|
|
2046
2376
|
/** comment-search-summary */
|
|
2047
2377
|
export interface CommentSearchSummary {
|
|
2048
2378
|
comment?: TimelineCommentSummary;
|
|
@@ -2184,6 +2514,8 @@ export type Conversation = AtomBase & {
|
|
|
2184
2514
|
metadata?: ConversationMetadata;
|
|
2185
2515
|
/** Owner IDs for the conversation. */
|
|
2186
2516
|
owned_by?: UserSummary[];
|
|
2517
|
+
/** SLA summary for the object. */
|
|
2518
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
2187
2519
|
sla_tracker?: SlaTrackerSummary;
|
|
2188
2520
|
/** Describes the current stage of a work item. */
|
|
2189
2521
|
stage?: LegacyStage;
|
|
@@ -2560,6 +2892,49 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
2560
2892
|
export interface ConversationsUpdateResponse {
|
|
2561
2893
|
conversation: Conversation;
|
|
2562
2894
|
}
|
|
2895
|
+
/** create-command-action */
|
|
2896
|
+
export interface CreateCommandAction {
|
|
2897
|
+
action_details?: CreateCommandActionDetails;
|
|
2898
|
+
/**
|
|
2899
|
+
* IDs of the new artifact items
|
|
2900
|
+
* @example ["ARTIFACT-12345"]
|
|
2901
|
+
*/
|
|
2902
|
+
artifacts?: string[];
|
|
2903
|
+
/**
|
|
2904
|
+
* The raw code to execute, defined in the language specified by
|
|
2905
|
+
* executor
|
|
2906
|
+
*/
|
|
2907
|
+
code?: string;
|
|
2908
|
+
/** Executor specific config */
|
|
2909
|
+
executor_config?: object;
|
|
2910
|
+
/** Specifies how the action is defined. */
|
|
2911
|
+
executor_type: CommandActionExecutorType;
|
|
2912
|
+
/**
|
|
2913
|
+
* The message to populate in discussion box, when the command is
|
|
2914
|
+
* selected to execute.
|
|
2915
|
+
*/
|
|
2916
|
+
message?: string;
|
|
2917
|
+
/**
|
|
2918
|
+
* Function containing logic for the command. If function ID is
|
|
2919
|
+
* specified the executor config is ignored and command is executed by
|
|
2920
|
+
* functions.
|
|
2921
|
+
*/
|
|
2922
|
+
snap_in_function_id?: string;
|
|
2923
|
+
/** The template engine for resolving message. */
|
|
2924
|
+
template_type?: CommandActionTemplateType;
|
|
2925
|
+
}
|
|
2926
|
+
/** create-command-action-details */
|
|
2927
|
+
export interface CreateCommandActionDetails {
|
|
2928
|
+
/** The payload to update the object in context upon command execution. */
|
|
2929
|
+
object_update_payload?: object;
|
|
2930
|
+
}
|
|
2931
|
+
/** create-command-surface */
|
|
2932
|
+
export interface CreateCommandSurface {
|
|
2933
|
+
/** Objects types on which a command can be invoked */
|
|
2934
|
+
object_types?: CommandSurfaceObjectTypes[];
|
|
2935
|
+
/** Surfaces from where this command can be invoked. */
|
|
2936
|
+
surface: CommandSurfaceSurface;
|
|
2937
|
+
}
|
|
2563
2938
|
/**
|
|
2564
2939
|
* create-email-info
|
|
2565
2940
|
* Information related to an email.
|
|
@@ -4550,6 +4925,8 @@ export interface EnumValue {
|
|
|
4550
4925
|
* @format int64
|
|
4551
4926
|
*/
|
|
4552
4927
|
ordinal: number;
|
|
4928
|
+
/** The actual value of the enum value. */
|
|
4929
|
+
value?: any;
|
|
4553
4930
|
}
|
|
4554
4931
|
/**
|
|
4555
4932
|
* enum-value-summary
|
|
@@ -4852,6 +5229,21 @@ export interface EventAccountUpdated {
|
|
|
4852
5229
|
account: Account;
|
|
4853
5230
|
old_account?: Account;
|
|
4854
5231
|
}
|
|
5232
|
+
/** event-ai-agent-response */
|
|
5233
|
+
export interface EventAiAgentResponse {
|
|
5234
|
+
agent_response?: 'error' | 'message' | 'progress';
|
|
5235
|
+
/** The metadata given by client to be passed to the event source. */
|
|
5236
|
+
client_metadata?: object;
|
|
5237
|
+
/**
|
|
5238
|
+
* An error object providing the error message for the AI agent event
|
|
5239
|
+
* execution.
|
|
5240
|
+
*/
|
|
5241
|
+
error?: AiAgentEventExecuteError;
|
|
5242
|
+
/** The final response of asynchronous agent events execution. */
|
|
5243
|
+
message?: string;
|
|
5244
|
+
/** A progress object providing the status of the AI agent event execution. */
|
|
5245
|
+
progress?: AiAgentEventExecuteProgress;
|
|
5246
|
+
}
|
|
4855
5247
|
/** event-conversation-created */
|
|
4856
5248
|
export interface EventConversationCreated {
|
|
4857
5249
|
conversation: Conversation;
|
|
@@ -5431,6 +5823,29 @@ export declare enum GenericNotificationEventType {
|
|
|
5431
5823
|
Reminder = "reminder",
|
|
5432
5824
|
Update = "update"
|
|
5433
5825
|
}
|
|
5826
|
+
/**
|
|
5827
|
+
* get-reply-request
|
|
5828
|
+
* The request to get a reply for a query using an organization's
|
|
5829
|
+
* knowledge base.
|
|
5830
|
+
*/
|
|
5831
|
+
export interface GetReplyRequest {
|
|
5832
|
+
/**
|
|
5833
|
+
* The query string.
|
|
5834
|
+
* @minLength 1
|
|
5835
|
+
* @maxLength 10000
|
|
5836
|
+
*/
|
|
5837
|
+
query: string;
|
|
5838
|
+
}
|
|
5839
|
+
/**
|
|
5840
|
+
* get-reply-response
|
|
5841
|
+
* The response for the generated reply.
|
|
5842
|
+
*/
|
|
5843
|
+
export interface GetReplyResponse {
|
|
5844
|
+
/** The reply generated for the requested query. */
|
|
5845
|
+
reply?: string;
|
|
5846
|
+
/** Sources from which the reply is generated. */
|
|
5847
|
+
sources?: TuringSources[];
|
|
5848
|
+
}
|
|
5434
5849
|
/**
|
|
5435
5850
|
* get-rev-users-personal-data-request
|
|
5436
5851
|
* Request object to get a contact's information.
|
|
@@ -6221,6 +6636,8 @@ export type Issue = WorkBase & {
|
|
|
6221
6636
|
developed_with?: PartSummary[];
|
|
6222
6637
|
/** Priority of the work based upon impact and criticality. */
|
|
6223
6638
|
priority?: IssuePriority;
|
|
6639
|
+
/** SLA summary for the object. */
|
|
6640
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
6224
6641
|
sla_tracker?: SlaTrackerSummary;
|
|
6225
6642
|
/** Vista group item. */
|
|
6226
6643
|
sprint?: VistaGroupItemSummary;
|
|
@@ -8818,6 +9235,8 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
|
8818
9235
|
export interface RevUsersUpdateResponse {
|
|
8819
9236
|
rev_user: RevUser;
|
|
8820
9237
|
}
|
|
9238
|
+
/** role-summary */
|
|
9239
|
+
export type RoleSummary = AtomBaseSummary;
|
|
8821
9240
|
/** saml-connection-fields-map */
|
|
8822
9241
|
export interface SamlConnectionFieldsMap {
|
|
8823
9242
|
/**
|
|
@@ -9640,6 +10059,16 @@ export interface SetIssueSelector {
|
|
|
9640
10059
|
*/
|
|
9641
10060
|
tags?: string[];
|
|
9642
10061
|
}
|
|
10062
|
+
/**
|
|
10063
|
+
* set-money
|
|
10064
|
+
* The money value to create.
|
|
10065
|
+
*/
|
|
10066
|
+
export interface SetMoney {
|
|
10067
|
+
/** The amount. */
|
|
10068
|
+
amount: string;
|
|
10069
|
+
/** The currency code conforming ISO 4217 standard. */
|
|
10070
|
+
currency: string;
|
|
10071
|
+
}
|
|
9643
10072
|
/** set-org-schedule-fragment-summary */
|
|
9644
10073
|
export interface SetOrgScheduleFragmentSummary {
|
|
9645
10074
|
/** Organization schedule fragment ID. */
|
|
@@ -9762,6 +10191,14 @@ export interface SetWeeklyOrgSchedule {
|
|
|
9762
10191
|
*/
|
|
9763
10192
|
period_name: string;
|
|
9764
10193
|
}
|
|
10194
|
+
/**
|
|
10195
|
+
* shared-with-membership
|
|
10196
|
+
* Information about the role the member receives due to the share.
|
|
10197
|
+
*/
|
|
10198
|
+
export interface SharedWithMembership {
|
|
10199
|
+
member?: MemberSummary;
|
|
10200
|
+
role?: RoleSummary;
|
|
10201
|
+
}
|
|
9765
10202
|
/**
|
|
9766
10203
|
* shared-with-membership-filter
|
|
9767
10204
|
* Filter on target item based on intended audience.
|
|
@@ -11256,6 +11693,8 @@ export type Ticket = WorkBase & {
|
|
|
11256
11693
|
sentiment_summary?: string;
|
|
11257
11694
|
/** Severity of the ticket. */
|
|
11258
11695
|
severity?: TicketSeverity;
|
|
11696
|
+
/** SLA summary for the object. */
|
|
11697
|
+
sla_summary?: ArchetypeSlaSummary;
|
|
11259
11698
|
sla_tracker?: SlaTrackerSummary;
|
|
11260
11699
|
/** Source channel of the ticket. */
|
|
11261
11700
|
source_channel?: string;
|
|
@@ -11805,6 +12244,14 @@ export interface TrackEventsPublishRequest {
|
|
|
11805
12244
|
}
|
|
11806
12245
|
/** track-events-publish-response */
|
|
11807
12246
|
export type TrackEventsPublishResponse = object;
|
|
12247
|
+
/** turing-sources */
|
|
12248
|
+
export type TuringSources = (ArticleSummary | QuestionAnswerSummary) & {
|
|
12249
|
+
type: TuringSourcesType;
|
|
12250
|
+
};
|
|
12251
|
+
export declare enum TuringSourcesType {
|
|
12252
|
+
Article = "article",
|
|
12253
|
+
QuestionAnswer = "question_answer"
|
|
12254
|
+
}
|
|
11808
12255
|
/**
|
|
11809
12256
|
* unit
|
|
11810
12257
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -12140,6 +12587,47 @@ export interface UomsUpdateRequestDimensions {
|
|
|
12140
12587
|
export interface UomsUpdateResponse {
|
|
12141
12588
|
uom: Uom;
|
|
12142
12589
|
}
|
|
12590
|
+
/** update-command-action */
|
|
12591
|
+
export interface UpdateCommandAction {
|
|
12592
|
+
action_details?: UpdateCommandActionDetails;
|
|
12593
|
+
/**
|
|
12594
|
+
* IDs of the new artifact items
|
|
12595
|
+
* @example ["ARTIFACT-12345"]
|
|
12596
|
+
*/
|
|
12597
|
+
artifacts?: string[];
|
|
12598
|
+
/**
|
|
12599
|
+
* The raw code to execute, defined in the language specified by
|
|
12600
|
+
* executor
|
|
12601
|
+
*/
|
|
12602
|
+
code?: string;
|
|
12603
|
+
/** Executor specific config */
|
|
12604
|
+
executor_config?: object;
|
|
12605
|
+
/**
|
|
12606
|
+
* The message to populate in discussion box, when the command is
|
|
12607
|
+
* selected to execute.
|
|
12608
|
+
*/
|
|
12609
|
+
message?: string;
|
|
12610
|
+
/**
|
|
12611
|
+
* Function containing logic for the command. If function ID is
|
|
12612
|
+
* specified the executor config is ignored and command is executed by
|
|
12613
|
+
* functions.
|
|
12614
|
+
*/
|
|
12615
|
+
snap_in_function_id?: string;
|
|
12616
|
+
/** The template engine for resolving message. */
|
|
12617
|
+
template_type?: CommandActionTemplateType;
|
|
12618
|
+
}
|
|
12619
|
+
/** update-command-action-details */
|
|
12620
|
+
export interface UpdateCommandActionDetails {
|
|
12621
|
+
/** The payload to update the object in context upon command execution. */
|
|
12622
|
+
object_update_payload?: object;
|
|
12623
|
+
}
|
|
12624
|
+
/** update-command-surface */
|
|
12625
|
+
export interface UpdateCommandSurface {
|
|
12626
|
+
/** Objects types on which a command can be invoked */
|
|
12627
|
+
object_types?: CommandSurfaceObjectTypes[];
|
|
12628
|
+
/** Surfaces from where this command can be invoked. */
|
|
12629
|
+
surface?: CommandSurfaceSurface;
|
|
12630
|
+
}
|
|
12143
12631
|
/** update-impacted-customer-details */
|
|
12144
12632
|
export interface UpdateImpactedCustomerDetails {
|
|
12145
12633
|
/**
|
|
@@ -12395,6 +12883,7 @@ export interface WebhookEventRequest {
|
|
|
12395
12883
|
account_created?: EventAccountCreated;
|
|
12396
12884
|
account_deleted?: EventAccountDeleted;
|
|
12397
12885
|
account_updated?: EventAccountUpdated;
|
|
12886
|
+
ai_agent_response?: EventAiAgentResponse;
|
|
12398
12887
|
conversation_created?: EventConversationCreated;
|
|
12399
12888
|
conversation_deleted?: EventConversationDeleted;
|
|
12400
12889
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -12826,6 +13315,10 @@ export declare enum WorkType {
|
|
|
12826
13315
|
Task = "task",
|
|
12827
13316
|
Ticket = "ticket"
|
|
12828
13317
|
}
|
|
13318
|
+
/** workflow-run-summary */
|
|
13319
|
+
export type WorkflowRunSummary = AtomBaseSummary;
|
|
13320
|
+
/** workflow-summary */
|
|
13321
|
+
export type WorkflowSummary = AtomBaseSummary;
|
|
12829
13322
|
/** works-create-request */
|
|
12830
13323
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
|
|
12831
13324
|
type: WorkType;
|
|
@@ -12919,6 +13412,8 @@ export interface WorksCreateRequestOpportunity {
|
|
|
12919
13412
|
* @format double
|
|
12920
13413
|
*/
|
|
12921
13414
|
amount?: number;
|
|
13415
|
+
/** The money value to create. */
|
|
13416
|
+
annual_contract_value?: SetMoney;
|
|
12922
13417
|
/** Contacts involved in the opportunity. */
|
|
12923
13418
|
contacts?: string[];
|
|
12924
13419
|
/**
|
|
@@ -12940,6 +13435,8 @@ export interface WorksCreateRequestOpportunity {
|
|
|
12940
13435
|
* @format double
|
|
12941
13436
|
*/
|
|
12942
13437
|
probability?: number;
|
|
13438
|
+
/** The money value to create. */
|
|
13439
|
+
value?: SetMoney;
|
|
12943
13440
|
}
|
|
12944
13441
|
/** works-create-request-task */
|
|
12945
13442
|
export interface WorksCreateRequestTask {
|
|
@@ -13326,6 +13823,8 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
13326
13823
|
* @format double
|
|
13327
13824
|
*/
|
|
13328
13825
|
amount?: number | null;
|
|
13826
|
+
/** The money value to create. */
|
|
13827
|
+
annual_contract_value?: SetMoney;
|
|
13329
13828
|
contacts?: WorksUpdateRequestOpportunityContacts;
|
|
13330
13829
|
/**
|
|
13331
13830
|
* Updates the customer budget.
|
|
@@ -13343,6 +13842,8 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
13343
13842
|
* @format double
|
|
13344
13843
|
*/
|
|
13345
13844
|
probability?: number | null;
|
|
13845
|
+
/** The money value to create. */
|
|
13846
|
+
value?: SetMoney;
|
|
13346
13847
|
}
|
|
13347
13848
|
/** works-update-request-opportunity-contacts */
|
|
13348
13849
|
export interface WorksUpdateRequestOpportunityContacts {
|
|
@@ -14245,6 +14746,90 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14245
14746
|
* @secure
|
|
14246
14747
|
*/
|
|
14247
14748
|
codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any>>;
|
|
14749
|
+
/**
|
|
14750
|
+
* @description Creates a command.
|
|
14751
|
+
*
|
|
14752
|
+
* @tags command
|
|
14753
|
+
* @name CommandsCreate
|
|
14754
|
+
* @request POST:/commands.create
|
|
14755
|
+
* @secure
|
|
14756
|
+
*/
|
|
14757
|
+
commandsCreate: (data: CommandCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandCreateResponse, any>>;
|
|
14758
|
+
/**
|
|
14759
|
+
* @description Gets a command.
|
|
14760
|
+
*
|
|
14761
|
+
* @tags command
|
|
14762
|
+
* @name CommandsGet
|
|
14763
|
+
* @request GET:/commands.get
|
|
14764
|
+
* @secure
|
|
14765
|
+
*/
|
|
14766
|
+
commandsGet: (query: {
|
|
14767
|
+
/** The command's ID. */
|
|
14768
|
+
id: string;
|
|
14769
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any>>;
|
|
14770
|
+
/**
|
|
14771
|
+
* @description Gets a command.
|
|
14772
|
+
*
|
|
14773
|
+
* @tags command
|
|
14774
|
+
* @name CommandsGetPost
|
|
14775
|
+
* @request POST:/commands.get
|
|
14776
|
+
* @secure
|
|
14777
|
+
*/
|
|
14778
|
+
commandsGetPost: (data: CommandGetRequest, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any>>;
|
|
14779
|
+
/**
|
|
14780
|
+
* @description Lists commands for a Dev organization.
|
|
14781
|
+
*
|
|
14782
|
+
* @tags command
|
|
14783
|
+
* @name CommandsList
|
|
14784
|
+
* @request GET:/commands.list
|
|
14785
|
+
* @secure
|
|
14786
|
+
*/
|
|
14787
|
+
commandsList: (query?: {
|
|
14788
|
+
/**
|
|
14789
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
14790
|
+
* starts from the beginning.
|
|
14791
|
+
*/
|
|
14792
|
+
cursor?: string;
|
|
14793
|
+
/** Filtering based on executor_type. */
|
|
14794
|
+
executor_type?: CommandActionExecutorType[];
|
|
14795
|
+
/**
|
|
14796
|
+
* The maximum number of commands to return per page. The default is
|
|
14797
|
+
* '50'.
|
|
14798
|
+
* @format int32
|
|
14799
|
+
*/
|
|
14800
|
+
limit?: number;
|
|
14801
|
+
/**
|
|
14802
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
14803
|
+
* used.
|
|
14804
|
+
*/
|
|
14805
|
+
mode?: ListMode;
|
|
14806
|
+
/** Filter commands based on namespace. */
|
|
14807
|
+
namespace?: string[];
|
|
14808
|
+
/** List of fields to sort the commands items by and how to sort them. */
|
|
14809
|
+
sort_by?: string[];
|
|
14810
|
+
/** ID of the object where command is invoked (work/part/conversation). */
|
|
14811
|
+
source_object_id?: string;
|
|
14812
|
+
/** Filter commands based on status. */
|
|
14813
|
+
status?: CommandStatus[];
|
|
14814
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any>>;
|
|
14815
|
+
/**
|
|
14816
|
+
* @description Lists commands for a Dev organization.
|
|
14817
|
+
*
|
|
14818
|
+
* @tags command
|
|
14819
|
+
* @name CommandsListPost
|
|
14820
|
+
* @request POST:/commands.list
|
|
14821
|
+
* @secure
|
|
14822
|
+
*/
|
|
14823
|
+
commandsListPost: (data: CommandsListRequest, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any>>;
|
|
14824
|
+
/**
|
|
14825
|
+
* @description Updates a command.
|
|
14826
|
+
*
|
|
14827
|
+
* @tags command
|
|
14828
|
+
* @name CommandsUpdate
|
|
14829
|
+
* @request POST:/commands.update
|
|
14830
|
+
* @secure
|
|
14831
|
+
*/
|
|
14832
|
+
commandsUpdate: (data: CommandUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandUpdateResponse, any>>;
|
|
14248
14833
|
/**
|
|
14249
14834
|
* @description Create the content template.
|
|
14250
14835
|
*
|
|
@@ -16404,6 +16989,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16404
16989
|
* @secure
|
|
16405
16990
|
*/
|
|
16406
16991
|
updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any>>;
|
|
16992
|
+
/**
|
|
16993
|
+
* @description Returns a response for the chat conversation.
|
|
16994
|
+
*
|
|
16995
|
+
* @tags recommendations
|
|
16996
|
+
* @name ChatCompletions
|
|
16997
|
+
* @request POST:/recommendations.chat.completions
|
|
16998
|
+
* @secure
|
|
16999
|
+
*/
|
|
17000
|
+
chatCompletions: (data: ChatCompletionsRequest, params?: RequestParams) => Promise<AxiosResponse<ChatCompletionsResponse, any>>;
|
|
17001
|
+
/**
|
|
17002
|
+
* @description Gets a reply for a user query.
|
|
17003
|
+
*
|
|
17004
|
+
* @tags recommendations
|
|
17005
|
+
* @name GetReply
|
|
17006
|
+
* @request POST:/recommendations.get-reply
|
|
17007
|
+
* @secure
|
|
17008
|
+
*/
|
|
17009
|
+
getReply: (data: GetReplyRequest, params?: RequestParams) => Promise<AxiosResponse<GetReplyResponse, any>>;
|
|
16407
17010
|
/**
|
|
16408
17011
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
16409
17012
|
*
|
|
@@ -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.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.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = 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.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 = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = 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 = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = 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) {
|
|
@@ -204,6 +211,47 @@ var CodeChangeSource;
|
|
|
204
211
|
CodeChangeSource["Bitbucket"] = "bitbucket";
|
|
205
212
|
CodeChangeSource["Github"] = "github";
|
|
206
213
|
})(CodeChangeSource = exports.CodeChangeSource || (exports.CodeChangeSource = {}));
|
|
214
|
+
/** Specifies how the action is defined. */
|
|
215
|
+
var CommandActionExecutorType;
|
|
216
|
+
(function (CommandActionExecutorType) {
|
|
217
|
+
CommandActionExecutorType["Rego"] = "rego";
|
|
218
|
+
CommandActionExecutorType["Workflow"] = "workflow";
|
|
219
|
+
})(CommandActionExecutorType = exports.CommandActionExecutorType || (exports.CommandActionExecutorType = {}));
|
|
220
|
+
/** The template engine for resolving message. */
|
|
221
|
+
var CommandActionTemplateType;
|
|
222
|
+
(function (CommandActionTemplateType) {
|
|
223
|
+
CommandActionTemplateType["DevrevV1"] = "devrev_v1";
|
|
224
|
+
})(CommandActionTemplateType = exports.CommandActionTemplateType || (exports.CommandActionTemplateType = {}));
|
|
225
|
+
/** Status of the command. */
|
|
226
|
+
var CommandStatus;
|
|
227
|
+
(function (CommandStatus) {
|
|
228
|
+
CommandStatus["Disabled"] = "disabled";
|
|
229
|
+
CommandStatus["Draft"] = "draft";
|
|
230
|
+
CommandStatus["Enabled"] = "enabled";
|
|
231
|
+
})(CommandStatus = exports.CommandStatus || (exports.CommandStatus = {}));
|
|
232
|
+
/** Objects types on which a command can be invoked. */
|
|
233
|
+
var CommandSurfaceObjectTypes;
|
|
234
|
+
(function (CommandSurfaceObjectTypes) {
|
|
235
|
+
CommandSurfaceObjectTypes["Account"] = "account";
|
|
236
|
+
CommandSurfaceObjectTypes["Article"] = "article";
|
|
237
|
+
CommandSurfaceObjectTypes["Conversation"] = "conversation";
|
|
238
|
+
CommandSurfaceObjectTypes["Engagement"] = "engagement";
|
|
239
|
+
CommandSurfaceObjectTypes["Flow"] = "flow";
|
|
240
|
+
CommandSurfaceObjectTypes["Incident"] = "incident";
|
|
241
|
+
CommandSurfaceObjectTypes["Issue"] = "issue";
|
|
242
|
+
CommandSurfaceObjectTypes["Opportunity"] = "opportunity";
|
|
243
|
+
CommandSurfaceObjectTypes["Part"] = "part";
|
|
244
|
+
CommandSurfaceObjectTypes["RevOrg"] = "rev_org";
|
|
245
|
+
CommandSurfaceObjectTypes["RevUser"] = "rev_user";
|
|
246
|
+
CommandSurfaceObjectTypes["SnapIn"] = "snap_in";
|
|
247
|
+
CommandSurfaceObjectTypes["Ticket"] = "ticket";
|
|
248
|
+
})(CommandSurfaceObjectTypes = exports.CommandSurfaceObjectTypes || (exports.CommandSurfaceObjectTypes = {}));
|
|
249
|
+
/** Surfaces from where this command can be invoked. */
|
|
250
|
+
var CommandSurfaceSurface;
|
|
251
|
+
(function (CommandSurfaceSurface) {
|
|
252
|
+
CommandSurfaceSurface["CustomerChat"] = "customer_chat";
|
|
253
|
+
CommandSurfaceSurface["Discussions"] = "discussions";
|
|
254
|
+
})(CommandSurfaceSurface = exports.CommandSurfaceSurface || (exports.CommandSurfaceSurface = {}));
|
|
207
255
|
var ConversationsCreateRequestTypeValue;
|
|
208
256
|
(function (ConversationsCreateRequestTypeValue) {
|
|
209
257
|
ConversationsCreateRequestTypeValue["Support"] = "support";
|
|
@@ -1073,6 +1121,11 @@ var TimelineEntryVisibility;
|
|
|
1073
1121
|
TimelineEntryVisibility["Private"] = "private";
|
|
1074
1122
|
TimelineEntryVisibility["Public"] = "public";
|
|
1075
1123
|
})(TimelineEntryVisibility = exports.TimelineEntryVisibility || (exports.TimelineEntryVisibility = {}));
|
|
1124
|
+
var TuringSourcesType;
|
|
1125
|
+
(function (TuringSourcesType) {
|
|
1126
|
+
TuringSourcesType["Article"] = "article";
|
|
1127
|
+
TuringSourcesType["QuestionAnswer"] = "question_answer";
|
|
1128
|
+
})(TuringSourcesType = exports.TuringSourcesType || (exports.TuringSourcesType = {}));
|
|
1076
1129
|
/**
|
|
1077
1130
|
* This defines the UOM unit type. For example, for 'number of video
|
|
1078
1131
|
* calls', unit type will be a number.
|
|
@@ -1730,6 +1783,60 @@ class Api extends HttpClient {
|
|
|
1730
1783
|
* @secure
|
|
1731
1784
|
*/
|
|
1732
1785
|
this.codeChangesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1786
|
+
/**
|
|
1787
|
+
* @description Creates a command.
|
|
1788
|
+
*
|
|
1789
|
+
* @tags command
|
|
1790
|
+
* @name CommandsCreate
|
|
1791
|
+
* @request POST:/commands.create
|
|
1792
|
+
* @secure
|
|
1793
|
+
*/
|
|
1794
|
+
this.commandsCreate = (data, params = {}) => this.request(Object.assign({ path: `/commands.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1795
|
+
/**
|
|
1796
|
+
* @description Gets a command.
|
|
1797
|
+
*
|
|
1798
|
+
* @tags command
|
|
1799
|
+
* @name CommandsGet
|
|
1800
|
+
* @request GET:/commands.get
|
|
1801
|
+
* @secure
|
|
1802
|
+
*/
|
|
1803
|
+
this.commandsGet = (query, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1804
|
+
/**
|
|
1805
|
+
* @description Gets a command.
|
|
1806
|
+
*
|
|
1807
|
+
* @tags command
|
|
1808
|
+
* @name CommandsGetPost
|
|
1809
|
+
* @request POST:/commands.get
|
|
1810
|
+
* @secure
|
|
1811
|
+
*/
|
|
1812
|
+
this.commandsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1813
|
+
/**
|
|
1814
|
+
* @description Lists commands for a Dev organization.
|
|
1815
|
+
*
|
|
1816
|
+
* @tags command
|
|
1817
|
+
* @name CommandsList
|
|
1818
|
+
* @request GET:/commands.list
|
|
1819
|
+
* @secure
|
|
1820
|
+
*/
|
|
1821
|
+
this.commandsList = (query, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1822
|
+
/**
|
|
1823
|
+
* @description Lists commands for a Dev organization.
|
|
1824
|
+
*
|
|
1825
|
+
* @tags command
|
|
1826
|
+
* @name CommandsListPost
|
|
1827
|
+
* @request POST:/commands.list
|
|
1828
|
+
* @secure
|
|
1829
|
+
*/
|
|
1830
|
+
this.commandsListPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1831
|
+
/**
|
|
1832
|
+
* @description Updates a command.
|
|
1833
|
+
*
|
|
1834
|
+
* @tags command
|
|
1835
|
+
* @name CommandsUpdate
|
|
1836
|
+
* @request POST:/commands.update
|
|
1837
|
+
* @secure
|
|
1838
|
+
*/
|
|
1839
|
+
this.commandsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/commands.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1733
1840
|
/**
|
|
1734
1841
|
* @description Create the content template.
|
|
1735
1842
|
*
|
|
@@ -3052,6 +3159,24 @@ class Api extends HttpClient {
|
|
|
3052
3159
|
* @secure
|
|
3053
3160
|
*/
|
|
3054
3161
|
this.updateQuestionAnswer = (data, params = {}) => this.request(Object.assign({ path: `/question-answers.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3162
|
+
/**
|
|
3163
|
+
* @description Returns a response for the chat conversation.
|
|
3164
|
+
*
|
|
3165
|
+
* @tags recommendations
|
|
3166
|
+
* @name ChatCompletions
|
|
3167
|
+
* @request POST:/recommendations.chat.completions
|
|
3168
|
+
* @secure
|
|
3169
|
+
*/
|
|
3170
|
+
this.chatCompletions = (data, params = {}) => this.request(Object.assign({ path: `/recommendations.chat.completions`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3171
|
+
/**
|
|
3172
|
+
* @description Gets a reply for a user query.
|
|
3173
|
+
*
|
|
3174
|
+
* @tags recommendations
|
|
3175
|
+
* @name GetReply
|
|
3176
|
+
* @request POST:/recommendations.get-reply
|
|
3177
|
+
* @secure
|
|
3178
|
+
*/
|
|
3179
|
+
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
3180
|
/**
|
|
3056
3181
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
3057
3182
|
*
|
|
@@ -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;
|