@devrev/typescript-sdk 1.1.53 → 1.1.54
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.
|
@@ -389,6 +389,8 @@ export interface AggregatedSchema {
|
|
|
389
389
|
export interface AggregatedSchemaGetRequest {
|
|
390
390
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
391
391
|
custom_schema_fragment_ids: string[];
|
|
392
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
393
|
+
is_custom_leaf_type?: boolean;
|
|
392
394
|
/**
|
|
393
395
|
* The leaf type. Used for inferring the default stage diagram and
|
|
394
396
|
* tenant fragment ID.
|
|
@@ -470,6 +472,35 @@ export declare enum AggregationDetailAggregationType {
|
|
|
470
472
|
Sum = "sum",
|
|
471
473
|
UniqueCount = "unique_count"
|
|
472
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* ai-agent-event
|
|
477
|
+
* An event to be processed by an AI agent.
|
|
478
|
+
*/
|
|
479
|
+
export interface AiAgentEvent {
|
|
480
|
+
/**
|
|
481
|
+
* Text input message for the AI agent event. Could be human or agent
|
|
482
|
+
* message.
|
|
483
|
+
*/
|
|
484
|
+
input_message: AiAgentEventInputMessage;
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* ai-agent-event-context
|
|
488
|
+
* Additional metadata to be used by the AI agent for the event.
|
|
489
|
+
*/
|
|
490
|
+
export interface AiAgentEventContext {
|
|
491
|
+
/**
|
|
492
|
+
* The additional context for the AI agent event. This will be used on
|
|
493
|
+
* per event basis.
|
|
494
|
+
* @maxLength 1024
|
|
495
|
+
*/
|
|
496
|
+
additional?: string;
|
|
497
|
+
/**
|
|
498
|
+
* The initial context for the AI agent event. This will be used at
|
|
499
|
+
* the start of Agent Session
|
|
500
|
+
* @maxLength 4096
|
|
501
|
+
*/
|
|
502
|
+
initial?: string;
|
|
503
|
+
}
|
|
473
504
|
/**
|
|
474
505
|
* ai-agent-event-execute-error
|
|
475
506
|
* An error object providing the error message for the AI agent event
|
|
@@ -533,6 +564,79 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
533
564
|
workflow?: WorkflowSummary;
|
|
534
565
|
workflow_run?: WorkflowRunSummary;
|
|
535
566
|
}
|
|
567
|
+
/**
|
|
568
|
+
* ai-agent-event-input-message
|
|
569
|
+
* Text input message for the AI agent event. Could be human or agent
|
|
570
|
+
* message.
|
|
571
|
+
*/
|
|
572
|
+
export interface AiAgentEventInputMessage {
|
|
573
|
+
/**
|
|
574
|
+
* The text message of the AI agent event.
|
|
575
|
+
* @maxLength 8192
|
|
576
|
+
*/
|
|
577
|
+
message: string;
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* ai-agent-event-source-target
|
|
581
|
+
* The source of the event to send notifications to, of asynchronous
|
|
582
|
+
* execution progress.
|
|
583
|
+
*/
|
|
584
|
+
export interface AiAgentEventSourceTarget {
|
|
585
|
+
/** The ID of the target to send the events to. */
|
|
586
|
+
event_source: string;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* ai-agent-events-execute-async-request
|
|
590
|
+
* Request object to consume an input event and execute asynchronously.
|
|
591
|
+
*/
|
|
592
|
+
export interface AiAgentEventsExecuteAsyncRequest {
|
|
593
|
+
/** The ID of the AI agent that will consume the event. */
|
|
594
|
+
agent: string;
|
|
595
|
+
/**
|
|
596
|
+
* The metadata to be sent to the client with the notifications of
|
|
597
|
+
* execution progress.
|
|
598
|
+
*/
|
|
599
|
+
client_metadata?: object;
|
|
600
|
+
/** Additional metadata to be used by the AI agent for the event. */
|
|
601
|
+
context?: AiAgentEventContext;
|
|
602
|
+
/** An event to be processed by an AI agent. */
|
|
603
|
+
event: AiAgentEvent;
|
|
604
|
+
/**
|
|
605
|
+
* The source of the event to send notifications to, of asynchronous
|
|
606
|
+
* execution progress.
|
|
607
|
+
*/
|
|
608
|
+
event_source_target?: AiAgentEventSourceTarget;
|
|
609
|
+
/** An identifier of a session with an AI agent. */
|
|
610
|
+
session_object: string;
|
|
611
|
+
target?: 'event_source_target' | 'webhook_target';
|
|
612
|
+
/**
|
|
613
|
+
* The source of the event to send notifications to, of asynchronous
|
|
614
|
+
* execution progress.
|
|
615
|
+
*/
|
|
616
|
+
webhook_target?: AiAgentWebhookTarget;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* ai-agent-events-execute-async-response
|
|
620
|
+
* Response object to provide final response after asynchronous execution
|
|
621
|
+
* of input event to AI agent.
|
|
622
|
+
*/
|
|
623
|
+
export interface AiAgentEventsExecuteAsyncResponse {
|
|
624
|
+
session: AiAgentSessionSummary;
|
|
625
|
+
}
|
|
626
|
+
/** ai-agent-session-summary */
|
|
627
|
+
export type AiAgentSessionSummary = AtomBaseSummary;
|
|
628
|
+
/**
|
|
629
|
+
* ai-agent-webhook-target
|
|
630
|
+
* The source of the event to send notifications to, of asynchronous
|
|
631
|
+
* execution progress.
|
|
632
|
+
*/
|
|
633
|
+
export interface AiAgentWebhookTarget {
|
|
634
|
+
/**
|
|
635
|
+
* The ID of the webhook to send the events to.
|
|
636
|
+
* @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
|
|
637
|
+
*/
|
|
638
|
+
webhook: string;
|
|
639
|
+
}
|
|
536
640
|
/**
|
|
537
641
|
* airdrop-sync-units-get-request
|
|
538
642
|
* Request to get a sync unit.
|
|
@@ -807,6 +911,11 @@ export interface ArticlesCountRequest {
|
|
|
807
911
|
scope?: number[];
|
|
808
912
|
/** Filter for articles based on intended audience. */
|
|
809
913
|
shared_with?: SharedWithMembershipFilter[];
|
|
914
|
+
/**
|
|
915
|
+
* Filters for article with any of the provided tags.
|
|
916
|
+
* @example ["TAG-12345"]
|
|
917
|
+
*/
|
|
918
|
+
tags?: string[];
|
|
810
919
|
}
|
|
811
920
|
/** articles-count-response */
|
|
812
921
|
export interface ArticlesCountResponse {
|
|
@@ -999,6 +1108,11 @@ export interface ArticlesListRequest {
|
|
|
999
1108
|
scope?: number[];
|
|
1000
1109
|
/** Filter for articles based on intended audience. */
|
|
1001
1110
|
shared_with?: SharedWithMembershipFilter[];
|
|
1111
|
+
/**
|
|
1112
|
+
* Filters for article with any of the provided tags.
|
|
1113
|
+
* @example ["TAG-12345"]
|
|
1114
|
+
*/
|
|
1115
|
+
tags?: string[];
|
|
1002
1116
|
}
|
|
1003
1117
|
/**
|
|
1004
1118
|
* articles-list-response
|
|
@@ -2379,6 +2493,7 @@ export declare enum CommandSurfaceObjectTypes {
|
|
|
2379
2493
|
Account = "account",
|
|
2380
2494
|
Article = "article",
|
|
2381
2495
|
Conversation = "conversation",
|
|
2496
|
+
CustomObject = "custom_object",
|
|
2382
2497
|
Engagement = "engagement",
|
|
2383
2498
|
Flow = "flow",
|
|
2384
2499
|
Incident = "incident",
|
|
@@ -2506,7 +2621,7 @@ export interface ContentTemplate {
|
|
|
2506
2621
|
* content-template-create-request
|
|
2507
2622
|
* The request to create a new content template.
|
|
2508
2623
|
*/
|
|
2509
|
-
export type ContentTemplateCreateRequest = ContentTemplateCreateRequestNotificationContentTemplate & {
|
|
2624
|
+
export type ContentTemplateCreateRequest = (ContentTemplateCreateRequestNotificationContentTemplate | ContentTemplateCreateRequestNotificationContentTemplateTranslation) & {
|
|
2510
2625
|
type: ContentTemplateType;
|
|
2511
2626
|
/**
|
|
2512
2627
|
* Input fields schema. The fields will be used to replace variables
|
|
@@ -2542,6 +2657,19 @@ export interface ContentTemplateCreateRequestNotificationContentTemplateDefaultN
|
|
|
2542
2657
|
*/
|
|
2543
2658
|
title: string;
|
|
2544
2659
|
}
|
|
2660
|
+
/** content-template-create-request-notification-content-template-translation */
|
|
2661
|
+
export interface ContentTemplateCreateRequestNotificationContentTemplateTranslation {
|
|
2662
|
+
/**
|
|
2663
|
+
* Content data for the notification. The key is the language code and
|
|
2664
|
+
* the value is the content.
|
|
2665
|
+
*/
|
|
2666
|
+
body_translations: Record<string, string>;
|
|
2667
|
+
/**
|
|
2668
|
+
* Content data for the notification. The key is the language code and
|
|
2669
|
+
* the value is the content.
|
|
2670
|
+
*/
|
|
2671
|
+
title_translations: Record<string, string>;
|
|
2672
|
+
}
|
|
2545
2673
|
/** content-template-create-response */
|
|
2546
2674
|
export interface ContentTemplateCreateResponse {
|
|
2547
2675
|
content_template: ContentTemplate;
|
|
@@ -2609,6 +2737,8 @@ export interface ContentTemplateListResponse {
|
|
|
2609
2737
|
export type ContentTemplateType = string;
|
|
2610
2738
|
/** conversation */
|
|
2611
2739
|
export type Conversation = AtomBase & {
|
|
2740
|
+
/** Channel IDs of the conversation. */
|
|
2741
|
+
channels?: ExternalCommunicationChannelSummary[];
|
|
2612
2742
|
/** Custom fields. */
|
|
2613
2743
|
custom_fields?: object;
|
|
2614
2744
|
/**
|
|
@@ -3029,6 +3159,19 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
3029
3159
|
export interface ConversationsUpdateResponse {
|
|
3030
3160
|
conversation: Conversation;
|
|
3031
3161
|
}
|
|
3162
|
+
/**
|
|
3163
|
+
* create-association
|
|
3164
|
+
* Association of Rev users with Rev orgs or accounts. A Rev user can be
|
|
3165
|
+
* associated with 0 or more accounts and Rev orgs. A Rev org association
|
|
3166
|
+
* automatically adds an account association.
|
|
3167
|
+
*/
|
|
3168
|
+
export interface CreateAssociation {
|
|
3169
|
+
/**
|
|
3170
|
+
* ID of the Rev org or account to which Rev user is to be associated.
|
|
3171
|
+
* @example "REV-AbCdEfGh"
|
|
3172
|
+
*/
|
|
3173
|
+
associated_to?: string;
|
|
3174
|
+
}
|
|
3032
3175
|
/** create-command-action */
|
|
3033
3176
|
export interface CreateCommandAction {
|
|
3034
3177
|
action_details?: CreateCommandActionDetails;
|
|
@@ -3201,7 +3344,21 @@ export interface CreateStageNode {
|
|
|
3201
3344
|
export interface CreateStageTransition {
|
|
3202
3345
|
/** The ID of the target stage. */
|
|
3203
3346
|
target_stage_id: string;
|
|
3347
|
+
ui?: CreateStageUiMetadata;
|
|
3348
|
+
}
|
|
3349
|
+
/** create-stage-ui-metadata */
|
|
3350
|
+
export interface CreateStageUiMetadata {
|
|
3351
|
+
/** Whether the stage is hidden. */
|
|
3352
|
+
is_hidden?: boolean;
|
|
3353
|
+
}
|
|
3354
|
+
/**
|
|
3355
|
+
* create-starter-message-nudge-widget
|
|
3356
|
+
* A starter message nudge widget.
|
|
3357
|
+
*/
|
|
3358
|
+
export interface CreateStarterMessageNudgeWidget {
|
|
3359
|
+
starter_message_nudge_type: CreateStarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
3204
3360
|
}
|
|
3361
|
+
export type CreateStarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
3205
3362
|
/**
|
|
3206
3363
|
* create-tag-with-value
|
|
3207
3364
|
* Create object for tag_summary.
|
|
@@ -3349,6 +3506,8 @@ export type CustomObject = AtomBase & {
|
|
|
3349
3506
|
stock_schema_fragment?: string;
|
|
3350
3507
|
/** Subtype corresponding to the custom type fragment. */
|
|
3351
3508
|
subtype?: string;
|
|
3509
|
+
/** Mixin for storing sync metadata. */
|
|
3510
|
+
sync_metadata?: SyncMetadata;
|
|
3352
3511
|
};
|
|
3353
3512
|
/** custom-object-search-summary */
|
|
3354
3513
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
@@ -3483,8 +3642,8 @@ export interface CustomObjectsUpdateRequest {
|
|
|
3483
3642
|
/** Updates the stage of the custom object. */
|
|
3484
3643
|
stage?: string | null;
|
|
3485
3644
|
/**
|
|
3486
|
-
* The type of stage validations options when updating the stage
|
|
3487
|
-
* custom object.
|
|
3645
|
+
* The type of stage validations options when updating the stage or
|
|
3646
|
+
* the stage diagram of a custom object.
|
|
3488
3647
|
*/
|
|
3489
3648
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
3490
3649
|
/** Updates the title of the custom object. */
|
|
@@ -5496,6 +5655,8 @@ export interface EventAccountUpdated {
|
|
|
5496
5655
|
}
|
|
5497
5656
|
/** event-ai-agent-response */
|
|
5498
5657
|
export interface EventAiAgentResponse {
|
|
5658
|
+
/** The ID of the AI agent that consumed the event. */
|
|
5659
|
+
agent: string;
|
|
5499
5660
|
agent_response?: 'error' | 'message' | 'progress';
|
|
5500
5661
|
/** The metadata given by client to be passed to the event source. */
|
|
5501
5662
|
client_metadata?: object;
|
|
@@ -5508,6 +5669,13 @@ export interface EventAiAgentResponse {
|
|
|
5508
5669
|
message?: string;
|
|
5509
5670
|
/** A progress object providing the status of the AI agent event execution. */
|
|
5510
5671
|
progress?: AiAgentEventExecuteProgress;
|
|
5672
|
+
/**
|
|
5673
|
+
* The agent session ID to track the asynchronous execution of this
|
|
5674
|
+
* session.
|
|
5675
|
+
*/
|
|
5676
|
+
session: string;
|
|
5677
|
+
/** An identifier of the session with the AI agent. */
|
|
5678
|
+
session_object: string;
|
|
5511
5679
|
}
|
|
5512
5680
|
/** event-conversation-created */
|
|
5513
5681
|
export interface EventConversationCreated {
|
|
@@ -5852,6 +6020,22 @@ export interface EventTimelineEntryDeleted {
|
|
|
5852
6020
|
export interface EventTimelineEntryUpdated {
|
|
5853
6021
|
entry: TimelineEntry;
|
|
5854
6022
|
old_entry?: TimelineEntry;
|
|
6023
|
+
/**
|
|
6024
|
+
* The reactions that were performed.
|
|
6025
|
+
* @maxItems 16
|
|
6026
|
+
*/
|
|
6027
|
+
reactions?: EventTimelineEntryUpdatedReaction[];
|
|
6028
|
+
}
|
|
6029
|
+
/** event-timeline-entry-updated-reaction */
|
|
6030
|
+
export interface EventTimelineEntryUpdatedReaction {
|
|
6031
|
+
action: EventTimelineEntryUpdatedReactionAction;
|
|
6032
|
+
/** The emoji for the reaction. */
|
|
6033
|
+
emoji: string;
|
|
6034
|
+
reactor?: UserSummary;
|
|
6035
|
+
}
|
|
6036
|
+
export declare enum EventTimelineEntryUpdatedReactionAction {
|
|
6037
|
+
Added = "added",
|
|
6038
|
+
Removed = "removed"
|
|
5855
6039
|
}
|
|
5856
6040
|
/** event-webhook-created */
|
|
5857
6041
|
export interface EventWebhookCreated {
|
|
@@ -5924,6 +6108,8 @@ export interface ExportAuditLogsRequest {
|
|
|
5924
6108
|
* process is asynchronous. Upon completion, the user will be notified.
|
|
5925
6109
|
*/
|
|
5926
6110
|
export type ExportAuditLogsResponse = object;
|
|
6111
|
+
/** external-communication-channel-summary */
|
|
6112
|
+
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
5927
6113
|
/**
|
|
5928
6114
|
* external-identity
|
|
5929
6115
|
* External identity of a user.
|
|
@@ -6675,7 +6861,7 @@ export interface IncidentsGroupRequest {
|
|
|
6675
6861
|
* Filters for incidents with any of the provided playbooks.
|
|
6676
6862
|
* @example ["ARTICLE-12345"]
|
|
6677
6863
|
*/
|
|
6678
|
-
|
|
6864
|
+
playbooks?: string[];
|
|
6679
6865
|
/**
|
|
6680
6866
|
* Filters for incidents with any of the provided related docs.
|
|
6681
6867
|
* @example ["ARTICLE-12345"]
|
|
@@ -6765,7 +6951,7 @@ export interface IncidentsListRequest {
|
|
|
6765
6951
|
* Filters for incidents with any of the provided playbooks.
|
|
6766
6952
|
* @example ["ARTICLE-12345"]
|
|
6767
6953
|
*/
|
|
6768
|
-
|
|
6954
|
+
playbooks?: string[];
|
|
6769
6955
|
/**
|
|
6770
6956
|
* Filters for incidents with any of the provided related docs.
|
|
6771
6957
|
* @example ["ARTICLE-12345"]
|
|
@@ -6863,8 +7049,8 @@ export interface IncidentsUpdateRequest {
|
|
|
6863
7049
|
/** Update object for Stage. */
|
|
6864
7050
|
stage?: UpdateStage;
|
|
6865
7051
|
/**
|
|
6866
|
-
* The type of stage validations options when updating the stage
|
|
6867
|
-
* incident.
|
|
7052
|
+
* The type of stage validations options when updating the stage or
|
|
7053
|
+
* the stage diagram of an incident.
|
|
6868
7054
|
*/
|
|
6869
7055
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
6870
7056
|
tags?: UpdateIncidentTags;
|
|
@@ -7293,6 +7479,7 @@ export type Meeting = AtomBase & {
|
|
|
7293
7479
|
members: UserSummary[];
|
|
7294
7480
|
organizer?: UserSummary;
|
|
7295
7481
|
parent?: AtomSummary;
|
|
7482
|
+
recording?: ArtifactSummary;
|
|
7296
7483
|
/** Recording URL of the meeting. */
|
|
7297
7484
|
recording_url?: string;
|
|
7298
7485
|
/**
|
|
@@ -7314,6 +7501,7 @@ export type Meeting = AtomBase & {
|
|
|
7314
7501
|
tags?: TagWithValue[];
|
|
7315
7502
|
/** Title of the meeting object. */
|
|
7316
7503
|
title?: string;
|
|
7504
|
+
transcript?: ArtifactSummary;
|
|
7317
7505
|
};
|
|
7318
7506
|
/** The channel of meeting. */
|
|
7319
7507
|
export declare enum MeetingChannel {
|
|
@@ -7423,6 +7611,11 @@ export interface MeetingsCreateRequest {
|
|
|
7423
7611
|
* @example "ACC-12345"
|
|
7424
7612
|
*/
|
|
7425
7613
|
parent?: string;
|
|
7614
|
+
/**
|
|
7615
|
+
* The ID of the meeting's recording artifact.
|
|
7616
|
+
* @example "ARTIFACT-12345"
|
|
7617
|
+
*/
|
|
7618
|
+
recording?: string;
|
|
7426
7619
|
/** The recording URL of the meeting. */
|
|
7427
7620
|
recording_url?: string;
|
|
7428
7621
|
/**
|
|
@@ -7437,6 +7630,11 @@ export interface MeetingsCreateRequest {
|
|
|
7437
7630
|
tags?: SetTagWithValue[];
|
|
7438
7631
|
/** The title of the meeting. */
|
|
7439
7632
|
title: string;
|
|
7633
|
+
/**
|
|
7634
|
+
* The ID of the artifact for the transcript of the meeting.
|
|
7635
|
+
* @example "ARTIFACT-12345"
|
|
7636
|
+
*/
|
|
7637
|
+
transcript?: string;
|
|
7440
7638
|
}
|
|
7441
7639
|
/** meetings-create-response */
|
|
7442
7640
|
export interface MeetingsCreateResponse {
|
|
@@ -8441,6 +8639,8 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
8441
8639
|
* @example ["DEVU-12345"]
|
|
8442
8640
|
*/
|
|
8443
8641
|
owned_by: string[];
|
|
8642
|
+
/** Tags associated with the part. */
|
|
8643
|
+
tags?: SetTagWithValue[];
|
|
8444
8644
|
};
|
|
8445
8645
|
/** parts-create-request-capability */
|
|
8446
8646
|
export interface PartsCreateRequestCapability {
|
|
@@ -8546,6 +8746,11 @@ export interface PartsListRequest {
|
|
|
8546
8746
|
owned_by?: string[];
|
|
8547
8747
|
/** The filter for specifying parent part. */
|
|
8548
8748
|
parent_part?: ParentPartFilter;
|
|
8749
|
+
/**
|
|
8750
|
+
* Filters for part with any of the provided tags.
|
|
8751
|
+
* @example ["TAG-12345"]
|
|
8752
|
+
*/
|
|
8753
|
+
tags?: string[];
|
|
8549
8754
|
}
|
|
8550
8755
|
/** parts-list-response */
|
|
8551
8756
|
export interface PartsListResponse {
|
|
@@ -8591,6 +8796,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
8591
8796
|
/** The updated name of the part. */
|
|
8592
8797
|
name?: string;
|
|
8593
8798
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
8799
|
+
tags?: PartsUpdateRequestTags;
|
|
8594
8800
|
};
|
|
8595
8801
|
/** parts-update-request-artifacts */
|
|
8596
8802
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -8631,6 +8837,11 @@ export interface PartsUpdateRequestOwnedBy {
|
|
|
8631
8837
|
}
|
|
8632
8838
|
/** parts-update-request-product */
|
|
8633
8839
|
export type PartsUpdateRequestProduct = object;
|
|
8840
|
+
/** parts-update-request-tags */
|
|
8841
|
+
export interface PartsUpdateRequestTags {
|
|
8842
|
+
/** Sets the tags to the provided tags. */
|
|
8843
|
+
set?: SetTagWithValue[];
|
|
8844
|
+
}
|
|
8634
8845
|
/** parts-update-response */
|
|
8635
8846
|
export interface PartsUpdateResponse {
|
|
8636
8847
|
part: Part;
|
|
@@ -9325,6 +9536,19 @@ export type RevUser = UserBase & {
|
|
|
9325
9536
|
* system-generated identifier will be assigned to the user.
|
|
9326
9537
|
*/
|
|
9327
9538
|
external_ref?: string;
|
|
9539
|
+
/**
|
|
9540
|
+
* External refs are mutable unique identifiers for a contact record.
|
|
9541
|
+
* If none are available, a good alternative is the email
|
|
9542
|
+
* address(es)/phone number(s) which could uniquely identify the
|
|
9543
|
+
* contact. If no identifier is specified, a system-generated
|
|
9544
|
+
* identifier will be assigned to the contact. For organizations with
|
|
9545
|
+
* multi-association contacts support enabled, this field accepts
|
|
9546
|
+
* multiple identifiers, where each identifier must be unique across
|
|
9547
|
+
* your DevOrg. For organizations without multi-association contacts
|
|
9548
|
+
* support, this field accepts a single identifier, maintaining
|
|
9549
|
+
* functionality consistent with the existing external_uid field.
|
|
9550
|
+
*/
|
|
9551
|
+
external_refs?: string[];
|
|
9328
9552
|
/** Whether the Rev user is verified or not. */
|
|
9329
9553
|
is_verified?: boolean;
|
|
9330
9554
|
rev_org?: OrgSummary;
|
|
@@ -9359,6 +9583,22 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
9359
9583
|
external_ref?: string;
|
|
9360
9584
|
rev_org?: OrgSummary;
|
|
9361
9585
|
};
|
|
9586
|
+
/**
|
|
9587
|
+
* rev-users-associations-add-request
|
|
9588
|
+
* Request to add associations of Rev users to Rev orgs or accounts. Rev
|
|
9589
|
+
* org association automatically adds an account association.
|
|
9590
|
+
*/
|
|
9591
|
+
export interface RevUsersAssociationsAddRequest {
|
|
9592
|
+
/** Associations of the Rev user to Rev orgs/accounts. */
|
|
9593
|
+
associations: CreateAssociation[];
|
|
9594
|
+
/** ID of the Rev user to associate to. */
|
|
9595
|
+
rev_user_id: string;
|
|
9596
|
+
}
|
|
9597
|
+
/**
|
|
9598
|
+
* rev-users-associations-add-response
|
|
9599
|
+
* Response for adding associations to a Rev user.
|
|
9600
|
+
*/
|
|
9601
|
+
export type RevUsersAssociationsAddResponse = object;
|
|
9362
9602
|
/**
|
|
9363
9603
|
* rev-users-associations-list-request
|
|
9364
9604
|
* Gets the list of Rev user associations.
|
|
@@ -9404,6 +9644,24 @@ export interface RevUsersAssociationsListResponse {
|
|
|
9404
9644
|
*/
|
|
9405
9645
|
prev_cursor?: string;
|
|
9406
9646
|
}
|
|
9647
|
+
/**
|
|
9648
|
+
* rev-users-associations-remove-request
|
|
9649
|
+
* Request to remove associations of a Rev user.
|
|
9650
|
+
*/
|
|
9651
|
+
export interface RevUsersAssociationsRemoveRequest {
|
|
9652
|
+
/**
|
|
9653
|
+
* Associations of the Rev user to remove.
|
|
9654
|
+
* @example ["REV-AbCdEfGh"]
|
|
9655
|
+
*/
|
|
9656
|
+
associations: string[];
|
|
9657
|
+
/** ID of the Rev user whose associations are to be removed. */
|
|
9658
|
+
rev_user_id: string;
|
|
9659
|
+
}
|
|
9660
|
+
/**
|
|
9661
|
+
* rev-users-associations-remove-response
|
|
9662
|
+
* Response for removing associations from a Rev user.
|
|
9663
|
+
*/
|
|
9664
|
+
export type RevUsersAssociationsRemoveResponse = object;
|
|
9407
9665
|
/**
|
|
9408
9666
|
* rev-users-create-request
|
|
9409
9667
|
* Request object to create a new Rev user for a Rev organization.
|
|
@@ -9454,6 +9712,19 @@ export interface RevUsersCreateRequest {
|
|
|
9454
9712
|
* system-generated identifier will be assigned to the user.
|
|
9455
9713
|
*/
|
|
9456
9714
|
external_ref?: string;
|
|
9715
|
+
/**
|
|
9716
|
+
* External refs are mutable unique identifiers for a contact record.
|
|
9717
|
+
* If none are available, a good alternative is the email
|
|
9718
|
+
* address(es)/phone number(s) which could uniquely identify the
|
|
9719
|
+
* contact. If no identifier is specified, a system-generated
|
|
9720
|
+
* identifier will be assigned to the contact. For organizations with
|
|
9721
|
+
* multi-association contacts support enabled, this field accepts
|
|
9722
|
+
* multiple identifiers, where each identifier must be unique across
|
|
9723
|
+
* your DevOrg. For organizations without multi-association contacts
|
|
9724
|
+
* support, this field accepts a single identifier, maintaining
|
|
9725
|
+
* functionality consistent with the existing external_uid field.
|
|
9726
|
+
*/
|
|
9727
|
+
external_refs?: string[];
|
|
9457
9728
|
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
9458
9729
|
phone_numbers?: string[];
|
|
9459
9730
|
/**
|
|
@@ -9525,6 +9796,8 @@ export interface RevUsersListRequest {
|
|
|
9525
9796
|
email?: string[];
|
|
9526
9797
|
/** List of external refs to filter Rev users for. */
|
|
9527
9798
|
external_ref?: string[];
|
|
9799
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
9800
|
+
external_refs?: string[];
|
|
9528
9801
|
/** Value of is_verified field to filter the Rev users. */
|
|
9529
9802
|
is_verified?: boolean;
|
|
9530
9803
|
/**
|
|
@@ -9614,6 +9887,8 @@ export interface RevUsersScanRequest {
|
|
|
9614
9887
|
email?: string[];
|
|
9615
9888
|
/** List of external refs to filter Rev users for. */
|
|
9616
9889
|
external_ref?: string[];
|
|
9890
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
9891
|
+
external_refs?: string[];
|
|
9617
9892
|
/** Value of is_verified field to filter the Rev users. */
|
|
9618
9893
|
is_verified?: boolean;
|
|
9619
9894
|
modified_date?: DateTimeFilter;
|
|
@@ -9670,6 +9945,19 @@ export interface RevUsersUpdateRequest {
|
|
|
9670
9945
|
email?: string;
|
|
9671
9946
|
/** Updated external ref value of the Rev user. */
|
|
9672
9947
|
external_ref?: string;
|
|
9948
|
+
/**
|
|
9949
|
+
* External refs are mutable unique identifiers for a contact record.
|
|
9950
|
+
* If none are available, a good alternative is the email
|
|
9951
|
+
* address(es)/phone number(s) which could uniquely identify the
|
|
9952
|
+
* contact. If no identifier is specified, a system-generated
|
|
9953
|
+
* identifier will be assigned to the contact. For organizations with
|
|
9954
|
+
* multi-association contacts support enabled, this field accepts
|
|
9955
|
+
* multiple identifiers, where each identifier must be unique across
|
|
9956
|
+
* your DevOrg. For organizations without multi-association contacts
|
|
9957
|
+
* support, this field accepts a single identifier, maintaining
|
|
9958
|
+
* functionality consistent with the existing external_uid field.
|
|
9959
|
+
*/
|
|
9960
|
+
external_refs?: string[];
|
|
9673
9961
|
/** The ID of Rev user to update. */
|
|
9674
9962
|
id: string;
|
|
9675
9963
|
/** The phone numbers, in E.164 format, of the Rev user. */
|
|
@@ -11295,6 +11583,54 @@ export interface SnapInsUpdateRequest {
|
|
|
11295
11583
|
export interface SnapInsUpdateResponse {
|
|
11296
11584
|
snap_in: SnapIn;
|
|
11297
11585
|
}
|
|
11586
|
+
/** snap-kit-action-execute-deferred-request */
|
|
11587
|
+
export interface SnapKitActionExecuteDeferredRequest {
|
|
11588
|
+
/**
|
|
11589
|
+
* List of actions triggered in the request.
|
|
11590
|
+
* @maxItems 5
|
|
11591
|
+
*/
|
|
11592
|
+
actions: SnapKitActionRequest[];
|
|
11593
|
+
/** ID of the deferred snap-kit action to be executed. */
|
|
11594
|
+
id: string;
|
|
11595
|
+
}
|
|
11596
|
+
/** snap-kit-action-execute-deferred-response */
|
|
11597
|
+
export type SnapKitActionExecuteDeferredResponse = object;
|
|
11598
|
+
/** snap-kit-action-request */
|
|
11599
|
+
export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
|
|
11600
|
+
type: SnapKitActionRequestElementTypeValue;
|
|
11601
|
+
/**
|
|
11602
|
+
* Id of the interactive element specified by developer in a snap-kit
|
|
11603
|
+
* object.
|
|
11604
|
+
*/
|
|
11605
|
+
action_id: string;
|
|
11606
|
+
/** Action interaction type. */
|
|
11607
|
+
action_type?: string;
|
|
11608
|
+
/**
|
|
11609
|
+
* Id of the block within the surface which is the container for the
|
|
11610
|
+
* interactive element.
|
|
11611
|
+
*/
|
|
11612
|
+
block_id?: string;
|
|
11613
|
+
/**
|
|
11614
|
+
* Timestamp when the action was originated.
|
|
11615
|
+
* @format date-time
|
|
11616
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11617
|
+
*/
|
|
11618
|
+
timestamp: string;
|
|
11619
|
+
};
|
|
11620
|
+
/** snap-kit-action-request-button */
|
|
11621
|
+
export interface SnapKitActionRequestButton {
|
|
11622
|
+
/** Value for the button interactive element. */
|
|
11623
|
+
value: string;
|
|
11624
|
+
}
|
|
11625
|
+
export declare enum SnapKitActionRequestElementTypeValue {
|
|
11626
|
+
Button = "button",
|
|
11627
|
+
Form = "form"
|
|
11628
|
+
}
|
|
11629
|
+
/** snap-kit-action-request-form */
|
|
11630
|
+
export interface SnapKitActionRequestForm {
|
|
11631
|
+
/** Value for the form interactive element. */
|
|
11632
|
+
value: object;
|
|
11633
|
+
}
|
|
11298
11634
|
/**
|
|
11299
11635
|
* snap-kit-base-widget
|
|
11300
11636
|
* A SnapKit based widget.
|
|
@@ -11303,7 +11639,7 @@ export interface SnapKitBaseWidget {
|
|
|
11303
11639
|
snap_kit_execution?: string;
|
|
11304
11640
|
}
|
|
11305
11641
|
/** snap-widget */
|
|
11306
|
-
export type SnapWidget = EmailPreviewWidget & {
|
|
11642
|
+
export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
|
|
11307
11643
|
type: SnapWidgetType;
|
|
11308
11644
|
};
|
|
11309
11645
|
/** snap-widget-base */
|
|
@@ -11386,11 +11722,14 @@ export declare enum SnapWidgetStatus {
|
|
|
11386
11722
|
Published = "published"
|
|
11387
11723
|
}
|
|
11388
11724
|
export declare enum SnapWidgetType {
|
|
11389
|
-
EmailPreview = "email_preview"
|
|
11725
|
+
EmailPreview = "email_preview",
|
|
11726
|
+
StarterMessageNudge = "starter_message_nudge"
|
|
11390
11727
|
}
|
|
11391
11728
|
/** snap-widgets-create-request */
|
|
11392
|
-
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
11729
|
+
export type SnapWidgetsCreateRequest = (CreateEmailPreviewWidget | CreateStarterMessageNudgeWidget) & {
|
|
11393
11730
|
type: SnapWidgetsCreateRequestType;
|
|
11731
|
+
/** The list of interactions supported by the widget. */
|
|
11732
|
+
interactions?: SnapWidgetInteraction[];
|
|
11394
11733
|
/** A human readable name for the snap widget. */
|
|
11395
11734
|
name: string;
|
|
11396
11735
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
@@ -11399,7 +11738,8 @@ export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
|
11399
11738
|
status?: SnapWidgetStatus;
|
|
11400
11739
|
};
|
|
11401
11740
|
export declare enum SnapWidgetsCreateRequestType {
|
|
11402
|
-
EmailPreview = "email_preview"
|
|
11741
|
+
EmailPreview = "email_preview",
|
|
11742
|
+
StarterMessageNudge = "starter_message_nudge"
|
|
11403
11743
|
}
|
|
11404
11744
|
/** snap-widgets-create-response */
|
|
11405
11745
|
export interface SnapWidgetsCreateResponse {
|
|
@@ -11589,6 +11929,11 @@ export interface StagedInfoFilter {
|
|
|
11589
11929
|
/** Filters for issues that are staged. */
|
|
11590
11930
|
is_staged?: boolean;
|
|
11591
11931
|
}
|
|
11932
|
+
/** starter-message-nudge-widget */
|
|
11933
|
+
export interface StarterMessageNudgeWidget {
|
|
11934
|
+
starter_message_nudge_type: StarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
11935
|
+
}
|
|
11936
|
+
export type StarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
11592
11937
|
/**
|
|
11593
11938
|
* stock-field-override
|
|
11594
11939
|
* A stock field override.
|
|
@@ -11930,6 +12275,33 @@ export interface SurveysResponsesListResponse {
|
|
|
11930
12275
|
/** The list of the survey responses. */
|
|
11931
12276
|
survey_responses: SurveyResponse[];
|
|
11932
12277
|
}
|
|
12278
|
+
/** surveys-responses-update-request */
|
|
12279
|
+
export interface SurveysResponsesUpdateRequest {
|
|
12280
|
+
/** The unique ID associated with the dispatched survey. */
|
|
12281
|
+
dispatch_id: string;
|
|
12282
|
+
/** Survey response submitted for the object. */
|
|
12283
|
+
response?: object;
|
|
12284
|
+
/**
|
|
12285
|
+
* The source channel ordinal which recorded the survey response.
|
|
12286
|
+
* @format int64
|
|
12287
|
+
*/
|
|
12288
|
+
response_channel?: number;
|
|
12289
|
+
/**
|
|
12290
|
+
* The response score for the survey. Only applicable for CSAT and
|
|
12291
|
+
* NPS.
|
|
12292
|
+
* @format int32
|
|
12293
|
+
* @min 1
|
|
12294
|
+
* @max 10
|
|
12295
|
+
*/
|
|
12296
|
+
response_score?: number;
|
|
12297
|
+
/**
|
|
12298
|
+
* The stage ordinal of the survey response object.
|
|
12299
|
+
* @format int64
|
|
12300
|
+
*/
|
|
12301
|
+
stage?: number;
|
|
12302
|
+
}
|
|
12303
|
+
/** surveys-responses-update-response */
|
|
12304
|
+
export type SurveysResponsesUpdateResponse = object;
|
|
11933
12305
|
/** surveys-send-request */
|
|
11934
12306
|
export interface SurveysSendRequest {
|
|
11935
12307
|
email: SurveysSendRequestEmail;
|
|
@@ -12340,11 +12712,22 @@ export type Tag = AtomBase & {
|
|
|
12340
12712
|
* unique.
|
|
12341
12713
|
*/
|
|
12342
12714
|
name: string;
|
|
12715
|
+
style_new?: TagStyle;
|
|
12343
12716
|
};
|
|
12344
12717
|
/** tag-search-summary */
|
|
12345
12718
|
export type TagSearchSummary = SearchSummaryBase & {
|
|
12346
12719
|
tag: TagSummary;
|
|
12347
12720
|
};
|
|
12721
|
+
/** tag-style */
|
|
12722
|
+
export interface TagStyle {
|
|
12723
|
+
/** The hex color code in "#RRGGBB" format. */
|
|
12724
|
+
color?: string;
|
|
12725
|
+
}
|
|
12726
|
+
/** tag-style-summary */
|
|
12727
|
+
export interface TagStyleSummary {
|
|
12728
|
+
/** The hex color code in "#RRGGBB" format. */
|
|
12729
|
+
color?: string;
|
|
12730
|
+
}
|
|
12348
12731
|
/** tag-summary */
|
|
12349
12732
|
export type TagSummary = AtomBaseSummary & {
|
|
12350
12733
|
/**
|
|
@@ -12353,6 +12736,7 @@ export type TagSummary = AtomBaseSummary & {
|
|
|
12353
12736
|
* unique.
|
|
12354
12737
|
*/
|
|
12355
12738
|
name: string;
|
|
12739
|
+
style_new?: TagStyleSummary;
|
|
12356
12740
|
};
|
|
12357
12741
|
/** tag-with-value */
|
|
12358
12742
|
export interface TagWithValue {
|
|
@@ -12387,6 +12771,7 @@ export interface TagsCreateRequest {
|
|
|
12387
12771
|
description?: string;
|
|
12388
12772
|
/** The name for the tag, which must be unique across all tags. */
|
|
12389
12773
|
name: string;
|
|
12774
|
+
style_new?: TagStyle;
|
|
12390
12775
|
}
|
|
12391
12776
|
/**
|
|
12392
12777
|
* tags-create-response
|
|
@@ -12502,6 +12887,7 @@ export interface TagsUpdateRequest {
|
|
|
12502
12887
|
* tags.
|
|
12503
12888
|
*/
|
|
12504
12889
|
name?: string;
|
|
12890
|
+
style_new?: TagStyle;
|
|
12505
12891
|
}
|
|
12506
12892
|
/**
|
|
12507
12893
|
* tags-update-response
|
|
@@ -12530,8 +12916,11 @@ export type TenantFragment = CustomSchemaFragmentBase & {
|
|
|
12530
12916
|
export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
12531
12917
|
/** ticket */
|
|
12532
12918
|
export type Ticket = WorkBase & {
|
|
12919
|
+
account?: AccountSummary;
|
|
12533
12920
|
/** Channels of the ticket. */
|
|
12534
12921
|
channels?: TicketChannels[];
|
|
12922
|
+
/** Channel IDs of the ticket. */
|
|
12923
|
+
channels_v2?: ExternalCommunicationChannelSummary[];
|
|
12535
12924
|
group?: GroupSummary;
|
|
12536
12925
|
/** Whether the ticket needs a response. */
|
|
12537
12926
|
needs_response?: boolean;
|
|
@@ -12553,6 +12942,7 @@ export type Ticket = WorkBase & {
|
|
|
12553
12942
|
sla_tracker?: SlaTrackerSummary;
|
|
12554
12943
|
/** Source channel of the ticket. */
|
|
12555
12944
|
source_channel?: string;
|
|
12945
|
+
source_channel_v2?: ExternalCommunicationChannelSummary;
|
|
12556
12946
|
/** The properties of an enum value. */
|
|
12557
12947
|
visibility?: EnumValue;
|
|
12558
12948
|
};
|
|
@@ -12573,6 +12963,7 @@ export declare enum TicketSeverity {
|
|
|
12573
12963
|
}
|
|
12574
12964
|
/** ticket-summary */
|
|
12575
12965
|
export type TicketSummary = WorkBaseSummary & {
|
|
12966
|
+
account?: AccountSummary;
|
|
12576
12967
|
rev_org?: OrgSummary;
|
|
12577
12968
|
/** Severity of the ticket. */
|
|
12578
12969
|
severity?: TicketSeverity;
|
|
@@ -12977,6 +13368,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
12977
13368
|
panels?: TimelineEntryPanel[];
|
|
12978
13369
|
/** The reactions to the entry. */
|
|
12979
13370
|
reactions?: TimelineReaction[];
|
|
13371
|
+
/** Mixin for storing sync metadata. */
|
|
13372
|
+
sync_metadata?: SyncMetadata;
|
|
12980
13373
|
/** Thread. */
|
|
12981
13374
|
thread?: TimelineThread;
|
|
12982
13375
|
/**
|
|
@@ -13594,6 +13987,12 @@ export interface UpdateStageNode {
|
|
|
13594
13987
|
export interface UpdateStageTransition {
|
|
13595
13988
|
/** The ID of the target stage. */
|
|
13596
13989
|
target_stage_id: string;
|
|
13990
|
+
ui?: UpdateStageUiMetadata;
|
|
13991
|
+
}
|
|
13992
|
+
/** update-stage-ui-metadata */
|
|
13993
|
+
export interface UpdateStageUiMetadata {
|
|
13994
|
+
/** Whether the stage is hidden. */
|
|
13995
|
+
is_hidden?: boolean;
|
|
13597
13996
|
}
|
|
13598
13997
|
/**
|
|
13599
13998
|
* update-tag-with-value
|
|
@@ -14370,6 +14769,11 @@ export interface WorksCreateRequestTask {
|
|
|
14370
14769
|
}
|
|
14371
14770
|
/** works-create-request-ticket */
|
|
14372
14771
|
export interface WorksCreateRequestTicket {
|
|
14772
|
+
/**
|
|
14773
|
+
* The account that the ticket is associated with.
|
|
14774
|
+
* @example "ACC-12345"
|
|
14775
|
+
*/
|
|
14776
|
+
account?: string;
|
|
14373
14777
|
/** Channels of the ticket. */
|
|
14374
14778
|
channels?: TicketChannels[];
|
|
14375
14779
|
/** The group that the ticket is associated with. */
|
|
@@ -14467,7 +14871,7 @@ export interface WorksExportResponse {
|
|
|
14467
14871
|
/** works-filter-issue */
|
|
14468
14872
|
export interface WorksFilterIssue {
|
|
14469
14873
|
/**
|
|
14470
|
-
* Filters for issues with any of the provided
|
|
14874
|
+
* Filters for issues with any of the provided accounts.
|
|
14471
14875
|
* @example ["ACC-12345"]
|
|
14472
14876
|
*/
|
|
14473
14877
|
accounts?: string[];
|
|
@@ -14673,8 +15077,8 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
14673
15077
|
/** Updates an object's stage. */
|
|
14674
15078
|
stage?: StageUpdate;
|
|
14675
15079
|
/**
|
|
14676
|
-
* The type of stage validations options when updating the stage
|
|
14677
|
-
* object.
|
|
15080
|
+
* The type of stage validations options when updating the stage or
|
|
15081
|
+
* the stage diagram of an object.
|
|
14678
15082
|
*/
|
|
14679
15083
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
14680
15084
|
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
@@ -14839,6 +15243,11 @@ export interface WorksUpdateRequestTask {
|
|
|
14839
15243
|
}
|
|
14840
15244
|
/** works-update-request-ticket */
|
|
14841
15245
|
export interface WorksUpdateRequestTicket {
|
|
15246
|
+
/**
|
|
15247
|
+
* Updates the account that the ticket is associated with.
|
|
15248
|
+
* @example "ACC-12345"
|
|
15249
|
+
*/
|
|
15250
|
+
account?: string | null;
|
|
14842
15251
|
channels?: WorksUpdateRequestTicketChannels;
|
|
14843
15252
|
/** Updates the group that the ticket is associated with. */
|
|
14844
15253
|
group?: string | null;
|
|
@@ -15152,6 +15561,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15152
15561
|
* @secure
|
|
15153
15562
|
*/
|
|
15154
15563
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
15564
|
+
/**
|
|
15565
|
+
* @description Execute an AI agent input event asynchronously.
|
|
15566
|
+
*
|
|
15567
|
+
* @tags ai-agents
|
|
15568
|
+
* @name AiAgentEventsExecuteAsync
|
|
15569
|
+
* @summary Execute-Async Ai Agents Events
|
|
15570
|
+
* @request POST:/ai-agents.events.execute-async
|
|
15571
|
+
* @secure
|
|
15572
|
+
*/
|
|
15573
|
+
aiAgentEventsExecuteAsync: (data: AiAgentEventsExecuteAsyncRequest, params?: RequestParams) => Promise<AxiosResponse<AiAgentEventsExecuteAsyncResponse, any>>;
|
|
15155
15574
|
/**
|
|
15156
15575
|
* @description Gets a single sync unit's information.
|
|
15157
15576
|
*
|
|
@@ -15269,6 +15688,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15269
15688
|
'shared_with.member'?: string;
|
|
15270
15689
|
/** Role ID of the group/member with whom the item is shared. */
|
|
15271
15690
|
'shared_with.role'?: string;
|
|
15691
|
+
/**
|
|
15692
|
+
* Filters for article with any of the provided tags.
|
|
15693
|
+
* @example ["TAG-12345"]
|
|
15694
|
+
*/
|
|
15695
|
+
tags?: string[];
|
|
15272
15696
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
15273
15697
|
/**
|
|
15274
15698
|
* @description Get count of articles matching given filter.
|
|
@@ -15387,6 +15811,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15387
15811
|
'shared_with.member'?: string;
|
|
15388
15812
|
/** Role ID of the group/member with whom the item is shared. */
|
|
15389
15813
|
'shared_with.role'?: string;
|
|
15814
|
+
/**
|
|
15815
|
+
* Filters for article with any of the provided tags.
|
|
15816
|
+
* @example ["TAG-12345"]
|
|
15817
|
+
*/
|
|
15818
|
+
tags?: string[];
|
|
15390
15819
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
15391
15820
|
/**
|
|
15392
15821
|
* @description Lists a collection of articles.
|
|
@@ -17142,7 +17571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17142
17571
|
* Filters for incidents with any of the provided playbooks.
|
|
17143
17572
|
* @example ["ARTICLE-12345"]
|
|
17144
17573
|
*/
|
|
17145
|
-
|
|
17574
|
+
playbooks?: string[];
|
|
17146
17575
|
/**
|
|
17147
17576
|
* Filters for incidents with any of the provided related docs.
|
|
17148
17577
|
* @example ["ARTICLE-12345"]
|
|
@@ -17218,7 +17647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17218
17647
|
* Filters for incidents with any of the provided playbooks.
|
|
17219
17648
|
* @example ["ARTICLE-12345"]
|
|
17220
17649
|
*/
|
|
17221
|
-
|
|
17650
|
+
playbooks?: string[];
|
|
17222
17651
|
/**
|
|
17223
17652
|
* Filters for incidents with any of the provided related docs.
|
|
17224
17653
|
* @example ["ARTICLE-12345"]
|
|
@@ -18047,6 +18476,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18047
18476
|
* @example ["PROD-12345"]
|
|
18048
18477
|
*/
|
|
18049
18478
|
'parent_part.parts'?: string[];
|
|
18479
|
+
/**
|
|
18480
|
+
* Filters for part with any of the provided tags.
|
|
18481
|
+
* @example ["TAG-12345"]
|
|
18482
|
+
*/
|
|
18483
|
+
tags?: string[];
|
|
18050
18484
|
/** Filters for parts of the provided type(s). */
|
|
18051
18485
|
type?: PartType[];
|
|
18052
18486
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
@@ -18440,6 +18874,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18440
18874
|
* @secure
|
|
18441
18875
|
*/
|
|
18442
18876
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any>>;
|
|
18877
|
+
/**
|
|
18878
|
+
* @description Adds an association to a Rev user. This API is only available when the multi-association contact feature is enabled.
|
|
18879
|
+
*
|
|
18880
|
+
* @tags rev-users
|
|
18881
|
+
* @name RevUsersAssociationsAdd
|
|
18882
|
+
* @summary Add Rev Users Associations
|
|
18883
|
+
* @request POST:/rev-users.associations.add
|
|
18884
|
+
* @secure
|
|
18885
|
+
*/
|
|
18886
|
+
revUsersAssociationsAdd: (data: RevUsersAssociationsAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
18443
18887
|
/**
|
|
18444
18888
|
* @description Returns a list of associations on a Rev user.
|
|
18445
18889
|
*
|
|
@@ -18479,6 +18923,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18479
18923
|
* @secure
|
|
18480
18924
|
*/
|
|
18481
18925
|
revUsersAssociationsListPost: (data: RevUsersAssociationsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersAssociationsListResponse, any>>;
|
|
18926
|
+
/**
|
|
18927
|
+
* @description Removes an association from a Rev user. This API is only available when the multi-association contact feature is enabled.
|
|
18928
|
+
*
|
|
18929
|
+
* @tags rev-users
|
|
18930
|
+
* @name RevUsersAssociationsRemove
|
|
18931
|
+
* @summary Remove Rev Users Associations
|
|
18932
|
+
* @request POST:/rev-users.associations.remove
|
|
18933
|
+
* @secure
|
|
18934
|
+
*/
|
|
18935
|
+
revUsersAssociationsRemove: (data: RevUsersAssociationsRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
18482
18936
|
/**
|
|
18483
18937
|
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
18484
18938
|
*
|
|
@@ -18583,6 +19037,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18583
19037
|
email?: string[];
|
|
18584
19038
|
/** List of external refs to filter Rev users for. */
|
|
18585
19039
|
external_ref?: string[];
|
|
19040
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
19041
|
+
external_refs?: string[];
|
|
18586
19042
|
/** Value of is_verified field to filter the Rev users. */
|
|
18587
19043
|
is_verified?: boolean;
|
|
18588
19044
|
/**
|
|
@@ -18691,6 +19147,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18691
19147
|
email?: string[];
|
|
18692
19148
|
/** List of external refs to filter Rev users for. */
|
|
18693
19149
|
external_ref?: string[];
|
|
19150
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
19151
|
+
external_refs?: string[];
|
|
18694
19152
|
/** Value of is_verified field to filter the Rev users. */
|
|
18695
19153
|
is_verified?: boolean;
|
|
18696
19154
|
/**
|
|
@@ -18778,6 +19236,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18778
19236
|
aggregatedSchemaGet: (query: {
|
|
18779
19237
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
18780
19238
|
custom_schema_fragment_ids: string[];
|
|
19239
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
19240
|
+
is_custom_leaf_type?: boolean;
|
|
18781
19241
|
/**
|
|
18782
19242
|
* The leaf type. Used for inferring the default stage diagram and
|
|
18783
19243
|
* tenant fragment ID.
|
|
@@ -19352,6 +19812,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19352
19812
|
* @secure
|
|
19353
19813
|
*/
|
|
19354
19814
|
snapInsUpdate: (data: SnapInsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsUpdateResponse, any>>;
|
|
19815
|
+
/**
|
|
19816
|
+
* @description Executes deferred snap-kit actions.
|
|
19817
|
+
*
|
|
19818
|
+
* @tags snap-kit-execution
|
|
19819
|
+
* @name SnapKitActionExecuteDeferred
|
|
19820
|
+
* @summary Deferred Snap Kit Action Execute
|
|
19821
|
+
* @request POST:/snap-kit-action.execute.deferred
|
|
19822
|
+
* @secure
|
|
19823
|
+
*/
|
|
19824
|
+
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
19355
19825
|
/**
|
|
19356
19826
|
* @description Create a snap widget object.
|
|
19357
19827
|
*
|
|
@@ -19745,6 +20215,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19745
20215
|
* @secure
|
|
19746
20216
|
*/
|
|
19747
20217
|
surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
|
|
20218
|
+
/**
|
|
20219
|
+
* @description Updates a user's survey response for the provided dispatch ID.
|
|
20220
|
+
*
|
|
20221
|
+
* @tags surveys
|
|
20222
|
+
* @name SurveysResponsesUpdate
|
|
20223
|
+
* @summary Update Surveys Response
|
|
20224
|
+
* @request POST:/surveys.responses.update
|
|
20225
|
+
* @secure
|
|
20226
|
+
*/
|
|
20227
|
+
surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
19748
20228
|
/**
|
|
19749
20229
|
* @description Sends a survey on the specified channels.
|
|
19750
20230
|
*
|
|
@@ -20356,7 +20836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20356
20836
|
*/
|
|
20357
20837
|
first?: number;
|
|
20358
20838
|
/**
|
|
20359
|
-
* Filters for issues with any of the provided
|
|
20839
|
+
* Filters for issues with any of the provided accounts.
|
|
20360
20840
|
* @example ["ACC-12345"]
|
|
20361
20841
|
*/
|
|
20362
20842
|
'issue.accounts'?: string[];
|
|
@@ -20515,7 +20995,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20515
20995
|
/** Filters for custom fields. */
|
|
20516
20996
|
custom_fields?: object;
|
|
20517
20997
|
/**
|
|
20518
|
-
* Filters for issues with any of the provided
|
|
20998
|
+
* Filters for issues with any of the provided accounts.
|
|
20519
20999
|
* @example ["ACC-12345"]
|
|
20520
21000
|
*/
|
|
20521
21001
|
'issue.accounts'?: string[];
|