@devrev/typescript-sdk 1.1.52 → 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.
|
@@ -380,6 +380,8 @@ export interface AddTagWithValue {
|
|
|
380
380
|
* List of custom fields from multiple source fragments.
|
|
381
381
|
*/
|
|
382
382
|
export interface AggregatedSchema {
|
|
383
|
+
/** The conditions associated with the fields. */
|
|
384
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
383
385
|
/** The stock field overrides. */
|
|
384
386
|
stock_field_overrides?: StockFieldOverride[];
|
|
385
387
|
}
|
|
@@ -387,6 +389,8 @@ export interface AggregatedSchema {
|
|
|
387
389
|
export interface AggregatedSchemaGetRequest {
|
|
388
390
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
389
391
|
custom_schema_fragment_ids: string[];
|
|
392
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
393
|
+
is_custom_leaf_type?: boolean;
|
|
390
394
|
/**
|
|
391
395
|
* The leaf type. Used for inferring the default stage diagram and
|
|
392
396
|
* tenant fragment ID.
|
|
@@ -468,6 +472,35 @@ export declare enum AggregationDetailAggregationType {
|
|
|
468
472
|
Sum = "sum",
|
|
469
473
|
UniqueCount = "unique_count"
|
|
470
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
|
+
}
|
|
471
504
|
/**
|
|
472
505
|
* ai-agent-event-execute-error
|
|
473
506
|
* An error object providing the error message for the AI agent event
|
|
@@ -531,6 +564,79 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
531
564
|
workflow?: WorkflowSummary;
|
|
532
565
|
workflow_run?: WorkflowRunSummary;
|
|
533
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
|
+
}
|
|
534
640
|
/**
|
|
535
641
|
* airdrop-sync-units-get-request
|
|
536
642
|
* Request to get a sync unit.
|
|
@@ -608,6 +714,8 @@ export interface AirdropSyncUnitsHistoryResponse {
|
|
|
608
714
|
export type AppFragment = CustomSchemaFragmentBase & {
|
|
609
715
|
/** App this fragment applies to. */
|
|
610
716
|
app?: string;
|
|
717
|
+
/** The display name of the app. */
|
|
718
|
+
app_display_name?: string;
|
|
611
719
|
};
|
|
612
720
|
/** app-fragment-summary */
|
|
613
721
|
export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
@@ -803,6 +911,11 @@ export interface ArticlesCountRequest {
|
|
|
803
911
|
scope?: number[];
|
|
804
912
|
/** Filter for articles based on intended audience. */
|
|
805
913
|
shared_with?: SharedWithMembershipFilter[];
|
|
914
|
+
/**
|
|
915
|
+
* Filters for article with any of the provided tags.
|
|
916
|
+
* @example ["TAG-12345"]
|
|
917
|
+
*/
|
|
918
|
+
tags?: string[];
|
|
806
919
|
}
|
|
807
920
|
/** articles-count-response */
|
|
808
921
|
export interface ArticlesCountResponse {
|
|
@@ -995,6 +1108,11 @@ export interface ArticlesListRequest {
|
|
|
995
1108
|
scope?: number[];
|
|
996
1109
|
/** Filter for articles based on intended audience. */
|
|
997
1110
|
shared_with?: SharedWithMembershipFilter[];
|
|
1111
|
+
/**
|
|
1112
|
+
* Filters for article with any of the provided tags.
|
|
1113
|
+
* @example ["TAG-12345"]
|
|
1114
|
+
*/
|
|
1115
|
+
tags?: string[];
|
|
998
1116
|
}
|
|
999
1117
|
/**
|
|
1000
1118
|
* articles-list-response
|
|
@@ -2123,6 +2241,26 @@ export interface ClientContextPage {
|
|
|
2123
2241
|
/** Page URL, example: https://devrev.ai/pricing */
|
|
2124
2242
|
url?: string;
|
|
2125
2243
|
}
|
|
2244
|
+
/**
|
|
2245
|
+
* client-override
|
|
2246
|
+
* UI hint overrides for a client.
|
|
2247
|
+
*/
|
|
2248
|
+
export interface ClientOverride {
|
|
2249
|
+
/** The name of the client. */
|
|
2250
|
+
client_name?: string;
|
|
2251
|
+
/** The display name of the field. */
|
|
2252
|
+
display_name?: string;
|
|
2253
|
+
/** Whether the field is hidden in the UI. */
|
|
2254
|
+
is_hidden?: boolean;
|
|
2255
|
+
/** Whether the field is mandatory. */
|
|
2256
|
+
is_required?: boolean;
|
|
2257
|
+
/** A placeholder for the field. */
|
|
2258
|
+
placeholder?: string;
|
|
2259
|
+
/** Tooltip for the field. */
|
|
2260
|
+
tooltip?: string;
|
|
2261
|
+
/** The view overrides for the client. */
|
|
2262
|
+
view_overrides?: ViewOverride[];
|
|
2263
|
+
}
|
|
2126
2264
|
/** code-change */
|
|
2127
2265
|
export type CodeChange = AtomBase & {
|
|
2128
2266
|
/** Name of the code branch in the repo. */
|
|
@@ -2355,6 +2493,7 @@ export declare enum CommandSurfaceObjectTypes {
|
|
|
2355
2493
|
Account = "account",
|
|
2356
2494
|
Article = "article",
|
|
2357
2495
|
Conversation = "conversation",
|
|
2496
|
+
CustomObject = "custom_object",
|
|
2358
2497
|
Engagement = "engagement",
|
|
2359
2498
|
Flow = "flow",
|
|
2360
2499
|
Incident = "incident",
|
|
@@ -2482,7 +2621,7 @@ export interface ContentTemplate {
|
|
|
2482
2621
|
* content-template-create-request
|
|
2483
2622
|
* The request to create a new content template.
|
|
2484
2623
|
*/
|
|
2485
|
-
export type ContentTemplateCreateRequest = ContentTemplateCreateRequestNotificationContentTemplate & {
|
|
2624
|
+
export type ContentTemplateCreateRequest = (ContentTemplateCreateRequestNotificationContentTemplate | ContentTemplateCreateRequestNotificationContentTemplateTranslation) & {
|
|
2486
2625
|
type: ContentTemplateType;
|
|
2487
2626
|
/**
|
|
2488
2627
|
* Input fields schema. The fields will be used to replace variables
|
|
@@ -2518,6 +2657,19 @@ export interface ContentTemplateCreateRequestNotificationContentTemplateDefaultN
|
|
|
2518
2657
|
*/
|
|
2519
2658
|
title: string;
|
|
2520
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
|
+
}
|
|
2521
2673
|
/** content-template-create-response */
|
|
2522
2674
|
export interface ContentTemplateCreateResponse {
|
|
2523
2675
|
content_template: ContentTemplate;
|
|
@@ -2585,6 +2737,8 @@ export interface ContentTemplateListResponse {
|
|
|
2585
2737
|
export type ContentTemplateType = string;
|
|
2586
2738
|
/** conversation */
|
|
2587
2739
|
export type Conversation = AtomBase & {
|
|
2740
|
+
/** Channel IDs of the conversation. */
|
|
2741
|
+
channels?: ExternalCommunicationChannelSummary[];
|
|
2588
2742
|
/** Custom fields. */
|
|
2589
2743
|
custom_fields?: object;
|
|
2590
2744
|
/**
|
|
@@ -2744,6 +2898,8 @@ export interface ConversationsExportRequest {
|
|
|
2744
2898
|
group?: string[];
|
|
2745
2899
|
/** Filters for conversations that are created by verified users. */
|
|
2746
2900
|
is_creator_verified?: boolean;
|
|
2901
|
+
/** Filters for conversations that are frozen. */
|
|
2902
|
+
is_frozen?: boolean;
|
|
2747
2903
|
/** Filters for conversations that are spam. */
|
|
2748
2904
|
is_spam?: boolean;
|
|
2749
2905
|
/**
|
|
@@ -2833,6 +2989,8 @@ export interface ConversationsListRequest {
|
|
|
2833
2989
|
group?: string[];
|
|
2834
2990
|
/** Filters for conversations that are created by verified users. */
|
|
2835
2991
|
is_creator_verified?: boolean;
|
|
2992
|
+
/** Filters for conversations that are frozen. */
|
|
2993
|
+
is_frozen?: boolean;
|
|
2836
2994
|
/** Filters for conversations that are spam. */
|
|
2837
2995
|
is_spam?: boolean;
|
|
2838
2996
|
/**
|
|
@@ -2934,6 +3092,8 @@ export interface ConversationsUpdateRequest {
|
|
|
2934
3092
|
group?: string;
|
|
2935
3093
|
/** The ID of the conversation to update. */
|
|
2936
3094
|
id: string;
|
|
3095
|
+
/** Whether the conversation is frozen. */
|
|
3096
|
+
is_frozen?: boolean;
|
|
2937
3097
|
/** Whether the conversation is spam. */
|
|
2938
3098
|
is_spam?: boolean;
|
|
2939
3099
|
members?: ConversationsUpdateRequestMembers;
|
|
@@ -2999,6 +3159,19 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
2999
3159
|
export interface ConversationsUpdateResponse {
|
|
3000
3160
|
conversation: Conversation;
|
|
3001
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
|
+
}
|
|
3002
3175
|
/** create-command-action */
|
|
3003
3176
|
export interface CreateCommandAction {
|
|
3004
3177
|
action_details?: CreateCommandActionDetails;
|
|
@@ -3171,7 +3344,21 @@ export interface CreateStageNode {
|
|
|
3171
3344
|
export interface CreateStageTransition {
|
|
3172
3345
|
/** The ID of the target stage. */
|
|
3173
3346
|
target_stage_id: string;
|
|
3347
|
+
ui?: CreateStageUiMetadata;
|
|
3174
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;
|
|
3360
|
+
}
|
|
3361
|
+
export type CreateStarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
3175
3362
|
/**
|
|
3176
3363
|
* create-tag-with-value
|
|
3177
3364
|
* Create object for tag_summary.
|
|
@@ -3319,6 +3506,8 @@ export type CustomObject = AtomBase & {
|
|
|
3319
3506
|
stock_schema_fragment?: string;
|
|
3320
3507
|
/** Subtype corresponding to the custom type fragment. */
|
|
3321
3508
|
subtype?: string;
|
|
3509
|
+
/** Mixin for storing sync metadata. */
|
|
3510
|
+
sync_metadata?: SyncMetadata;
|
|
3322
3511
|
};
|
|
3323
3512
|
/** custom-object-search-summary */
|
|
3324
3513
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
@@ -3453,8 +3642,8 @@ export interface CustomObjectsUpdateRequest {
|
|
|
3453
3642
|
/** Updates the stage of the custom object. */
|
|
3454
3643
|
stage?: string | null;
|
|
3455
3644
|
/**
|
|
3456
|
-
* The type of stage validations options when updating the stage
|
|
3457
|
-
* custom object.
|
|
3645
|
+
* The type of stage validations options when updating the stage or
|
|
3646
|
+
* the stage diagram of a custom object.
|
|
3458
3647
|
*/
|
|
3459
3648
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
3460
3649
|
/** Updates the title of the custom object. */
|
|
@@ -3495,7 +3684,39 @@ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
|
|
|
3495
3684
|
* custom-schema-fragment-condition
|
|
3496
3685
|
* The condition associated with a field.
|
|
3497
3686
|
*/
|
|
3498
|
-
export
|
|
3687
|
+
export interface CustomSchemaFragmentCondition {
|
|
3688
|
+
/** The linked effects when the expression evaluates to true. */
|
|
3689
|
+
effects?: CustomSchemaFragmentEffect[];
|
|
3690
|
+
/** The expression to evaluate. */
|
|
3691
|
+
expression?: string;
|
|
3692
|
+
}
|
|
3693
|
+
/**
|
|
3694
|
+
* custom-schema-fragment-effect
|
|
3695
|
+
* An effect associated with a condition.
|
|
3696
|
+
*/
|
|
3697
|
+
export interface CustomSchemaFragmentEffect {
|
|
3698
|
+
/**
|
|
3699
|
+
* Allowed values for the fields based on the condition. This takes
|
|
3700
|
+
* precedence over allowed_values in field_descriptor.
|
|
3701
|
+
*/
|
|
3702
|
+
allowed_values?: string[];
|
|
3703
|
+
/** The fields which are affected by the condition. */
|
|
3704
|
+
fields: string[];
|
|
3705
|
+
/**
|
|
3706
|
+
* Whether the fields should be made immutable or not based on the
|
|
3707
|
+
* condition.
|
|
3708
|
+
*/
|
|
3709
|
+
immutable?: boolean;
|
|
3710
|
+
/** Whether the field values are invalid based on the condition. */
|
|
3711
|
+
invalid?: boolean;
|
|
3712
|
+
/**
|
|
3713
|
+
* Whether the fields are required or not based on the condition. This
|
|
3714
|
+
* takes precedence over is_required in field_descriptor.
|
|
3715
|
+
*/
|
|
3716
|
+
require?: boolean;
|
|
3717
|
+
/** Whether the fields are shown or not based on the condition. */
|
|
3718
|
+
show?: boolean;
|
|
3719
|
+
}
|
|
3499
3720
|
/** Type of the custom schema fragment. */
|
|
3500
3721
|
export declare enum CustomSchemaFragmentFragmentType {
|
|
3501
3722
|
App = "app",
|
|
@@ -3602,6 +3823,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
3602
3823
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
3603
3824
|
/** The app this fragment applies to. */
|
|
3604
3825
|
app: string;
|
|
3826
|
+
/** The display name of the app. */
|
|
3827
|
+
app_display_name?: string;
|
|
3605
3828
|
}
|
|
3606
3829
|
/** custom-schema-fragments-set-request-composite-schema */
|
|
3607
3830
|
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
@@ -3665,7 +3888,7 @@ export interface CustomSchemaSpec {
|
|
|
3665
3888
|
}
|
|
3666
3889
|
/** custom-stage */
|
|
3667
3890
|
export type CustomStage = AtomBase & {
|
|
3668
|
-
/** The human readable name of the
|
|
3891
|
+
/** The human readable name of the stage. */
|
|
3669
3892
|
name?: string;
|
|
3670
3893
|
/**
|
|
3671
3894
|
* Ordinal used to sort/group stages.
|
|
@@ -3676,7 +3899,7 @@ export type CustomStage = AtomBase & {
|
|
|
3676
3899
|
};
|
|
3677
3900
|
/** custom-stage-summary */
|
|
3678
3901
|
export type CustomStageSummary = AtomBaseSummary & {
|
|
3679
|
-
/** The human readable name of the
|
|
3902
|
+
/** The human readable name of the stage. */
|
|
3680
3903
|
name?: string;
|
|
3681
3904
|
};
|
|
3682
3905
|
/** custom-stages-create-request */
|
|
@@ -5432,6 +5655,8 @@ export interface EventAccountUpdated {
|
|
|
5432
5655
|
}
|
|
5433
5656
|
/** event-ai-agent-response */
|
|
5434
5657
|
export interface EventAiAgentResponse {
|
|
5658
|
+
/** The ID of the AI agent that consumed the event. */
|
|
5659
|
+
agent: string;
|
|
5435
5660
|
agent_response?: 'error' | 'message' | 'progress';
|
|
5436
5661
|
/** The metadata given by client to be passed to the event source. */
|
|
5437
5662
|
client_metadata?: object;
|
|
@@ -5444,6 +5669,13 @@ export interface EventAiAgentResponse {
|
|
|
5444
5669
|
message?: string;
|
|
5445
5670
|
/** A progress object providing the status of the AI agent event execution. */
|
|
5446
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;
|
|
5447
5679
|
}
|
|
5448
5680
|
/** event-conversation-created */
|
|
5449
5681
|
export interface EventConversationCreated {
|
|
@@ -5788,6 +6020,22 @@ export interface EventTimelineEntryDeleted {
|
|
|
5788
6020
|
export interface EventTimelineEntryUpdated {
|
|
5789
6021
|
entry: TimelineEntry;
|
|
5790
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"
|
|
5791
6039
|
}
|
|
5792
6040
|
/** event-webhook-created */
|
|
5793
6041
|
export interface EventWebhookCreated {
|
|
@@ -5860,6 +6108,8 @@ export interface ExportAuditLogsRequest {
|
|
|
5860
6108
|
* process is asynchronous. Upon completion, the user will be notified.
|
|
5861
6109
|
*/
|
|
5862
6110
|
export type ExportAuditLogsResponse = object;
|
|
6111
|
+
/** external-communication-channel-summary */
|
|
6112
|
+
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
5863
6113
|
/**
|
|
5864
6114
|
* external-identity
|
|
5865
6115
|
* External identity of a user.
|
|
@@ -6380,8 +6630,6 @@ export type Incident = AtomBase & {
|
|
|
6380
6630
|
identified_date?: string;
|
|
6381
6631
|
/** Details of the impact due to the incident. */
|
|
6382
6632
|
impact?: ImpactedCustomerDetails;
|
|
6383
|
-
/** List of customers impacted due to the incident. */
|
|
6384
|
-
impacted_customers?: AccountSummary[];
|
|
6385
6633
|
/**
|
|
6386
6634
|
* Timestamp when the incident was mitigated.
|
|
6387
6635
|
* @format date-time
|
|
@@ -6402,11 +6650,6 @@ export type Incident = AtomBase & {
|
|
|
6402
6650
|
source?: EnumValue;
|
|
6403
6651
|
/** Describes the current stage of a object. */
|
|
6404
6652
|
stage?: Stage;
|
|
6405
|
-
/**
|
|
6406
|
-
* Users, along with the incident commander, involved in resolving
|
|
6407
|
-
* incidents and handling communication.
|
|
6408
|
-
*/
|
|
6409
|
-
stakeholders?: UserSummary[];
|
|
6410
6653
|
/**
|
|
6411
6654
|
* Stock schema fragment.
|
|
6412
6655
|
* @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
|
|
@@ -6470,8 +6713,6 @@ export interface IncidentsCreateRequest {
|
|
|
6470
6713
|
*/
|
|
6471
6714
|
identified_date?: string;
|
|
6472
6715
|
impact?: CreateImpactedCustomerDetails;
|
|
6473
|
-
/** List of customers impacted due to the incident. */
|
|
6474
|
-
impacted_customers?: string[];
|
|
6475
6716
|
/**
|
|
6476
6717
|
* Timestamp when the incident was mitigated.
|
|
6477
6718
|
* @format date-time
|
|
@@ -6506,11 +6747,6 @@ export interface IncidentsCreateRequest {
|
|
|
6506
6747
|
stage?: CreateStage;
|
|
6507
6748
|
/** The type of stage validations options when creating an incident. */
|
|
6508
6749
|
stage_validation_options?: StageValidationOptionForCreate[];
|
|
6509
|
-
/**
|
|
6510
|
-
* Users, along with the incident commander, involved in resolving
|
|
6511
|
-
* incidents and handling communication.
|
|
6512
|
-
*/
|
|
6513
|
-
stakeholders?: string[];
|
|
6514
6750
|
/** Tags associated with the object. */
|
|
6515
6751
|
tags?: CreateTagWithValue[];
|
|
6516
6752
|
/**
|
|
@@ -6625,7 +6861,7 @@ export interface IncidentsGroupRequest {
|
|
|
6625
6861
|
* Filters for incidents with any of the provided playbooks.
|
|
6626
6862
|
* @example ["ARTICLE-12345"]
|
|
6627
6863
|
*/
|
|
6628
|
-
|
|
6864
|
+
playbooks?: string[];
|
|
6629
6865
|
/**
|
|
6630
6866
|
* Filters for incidents with any of the provided related docs.
|
|
6631
6867
|
* @example ["ARTICLE-12345"]
|
|
@@ -6715,7 +6951,7 @@ export interface IncidentsListRequest {
|
|
|
6715
6951
|
* Filters for incidents with any of the provided playbooks.
|
|
6716
6952
|
* @example ["ARTICLE-12345"]
|
|
6717
6953
|
*/
|
|
6718
|
-
|
|
6954
|
+
playbooks?: string[];
|
|
6719
6955
|
/**
|
|
6720
6956
|
* Filters for incidents with any of the provided related docs.
|
|
6721
6957
|
* @example ["ARTICLE-12345"]
|
|
@@ -6784,7 +7020,6 @@ export interface IncidentsUpdateRequest {
|
|
|
6784
7020
|
*/
|
|
6785
7021
|
identified_date?: string;
|
|
6786
7022
|
impact?: UpdateImpactedCustomerDetails;
|
|
6787
|
-
impacted_customers?: UpdateIncidentImpactedCustomers;
|
|
6788
7023
|
/**
|
|
6789
7024
|
* Timestamp when the incident was mitigated.
|
|
6790
7025
|
* @format date-time
|
|
@@ -6814,11 +7049,10 @@ export interface IncidentsUpdateRequest {
|
|
|
6814
7049
|
/** Update object for Stage. */
|
|
6815
7050
|
stage?: UpdateStage;
|
|
6816
7051
|
/**
|
|
6817
|
-
* The type of stage validations options when updating the stage
|
|
6818
|
-
* incident.
|
|
7052
|
+
* The type of stage validations options when updating the stage or
|
|
7053
|
+
* the stage diagram of an incident.
|
|
6819
7054
|
*/
|
|
6820
7055
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
6821
|
-
stakeholders?: UpdateIncidentStakeholders;
|
|
6822
7056
|
tags?: UpdateIncidentTags;
|
|
6823
7057
|
/**
|
|
6824
7058
|
* Timestamp when the incident is expected to be resolved.
|
|
@@ -7245,6 +7479,7 @@ export type Meeting = AtomBase & {
|
|
|
7245
7479
|
members: UserSummary[];
|
|
7246
7480
|
organizer?: UserSummary;
|
|
7247
7481
|
parent?: AtomSummary;
|
|
7482
|
+
recording?: ArtifactSummary;
|
|
7248
7483
|
/** Recording URL of the meeting. */
|
|
7249
7484
|
recording_url?: string;
|
|
7250
7485
|
/**
|
|
@@ -7266,6 +7501,7 @@ export type Meeting = AtomBase & {
|
|
|
7266
7501
|
tags?: TagWithValue[];
|
|
7267
7502
|
/** Title of the meeting object. */
|
|
7268
7503
|
title?: string;
|
|
7504
|
+
transcript?: ArtifactSummary;
|
|
7269
7505
|
};
|
|
7270
7506
|
/** The channel of meeting. */
|
|
7271
7507
|
export declare enum MeetingChannel {
|
|
@@ -7375,6 +7611,11 @@ export interface MeetingsCreateRequest {
|
|
|
7375
7611
|
* @example "ACC-12345"
|
|
7376
7612
|
*/
|
|
7377
7613
|
parent?: string;
|
|
7614
|
+
/**
|
|
7615
|
+
* The ID of the meeting's recording artifact.
|
|
7616
|
+
* @example "ARTIFACT-12345"
|
|
7617
|
+
*/
|
|
7618
|
+
recording?: string;
|
|
7378
7619
|
/** The recording URL of the meeting. */
|
|
7379
7620
|
recording_url?: string;
|
|
7380
7621
|
/**
|
|
@@ -7389,6 +7630,11 @@ export interface MeetingsCreateRequest {
|
|
|
7389
7630
|
tags?: SetTagWithValue[];
|
|
7390
7631
|
/** The title of the meeting. */
|
|
7391
7632
|
title: string;
|
|
7633
|
+
/**
|
|
7634
|
+
* The ID of the artifact for the transcript of the meeting.
|
|
7635
|
+
* @example "ARTIFACT-12345"
|
|
7636
|
+
*/
|
|
7637
|
+
transcript?: string;
|
|
7392
7638
|
}
|
|
7393
7639
|
/** meetings-create-response */
|
|
7394
7640
|
export interface MeetingsCreateResponse {
|
|
@@ -8393,6 +8639,8 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
8393
8639
|
* @example ["DEVU-12345"]
|
|
8394
8640
|
*/
|
|
8395
8641
|
owned_by: string[];
|
|
8642
|
+
/** Tags associated with the part. */
|
|
8643
|
+
tags?: SetTagWithValue[];
|
|
8396
8644
|
};
|
|
8397
8645
|
/** parts-create-request-capability */
|
|
8398
8646
|
export interface PartsCreateRequestCapability {
|
|
@@ -8498,6 +8746,11 @@ export interface PartsListRequest {
|
|
|
8498
8746
|
owned_by?: string[];
|
|
8499
8747
|
/** The filter for specifying parent part. */
|
|
8500
8748
|
parent_part?: ParentPartFilter;
|
|
8749
|
+
/**
|
|
8750
|
+
* Filters for part with any of the provided tags.
|
|
8751
|
+
* @example ["TAG-12345"]
|
|
8752
|
+
*/
|
|
8753
|
+
tags?: string[];
|
|
8501
8754
|
}
|
|
8502
8755
|
/** parts-list-response */
|
|
8503
8756
|
export interface PartsListResponse {
|
|
@@ -8543,6 +8796,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
8543
8796
|
/** The updated name of the part. */
|
|
8544
8797
|
name?: string;
|
|
8545
8798
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
8799
|
+
tags?: PartsUpdateRequestTags;
|
|
8546
8800
|
};
|
|
8547
8801
|
/** parts-update-request-artifacts */
|
|
8548
8802
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -8583,6 +8837,11 @@ export interface PartsUpdateRequestOwnedBy {
|
|
|
8583
8837
|
}
|
|
8584
8838
|
/** parts-update-request-product */
|
|
8585
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
|
+
}
|
|
8586
8845
|
/** parts-update-response */
|
|
8587
8846
|
export interface PartsUpdateResponse {
|
|
8588
8847
|
part: Part;
|
|
@@ -8633,8 +8892,12 @@ export type ProductSummary = PartBaseSummary;
|
|
|
8633
8892
|
export type QuestionAnswer = AtomBase & {
|
|
8634
8893
|
/** The Answer. */
|
|
8635
8894
|
answer?: string;
|
|
8895
|
+
/** Details of the parts relevant to the question_answer. */
|
|
8896
|
+
applies_to_parts?: PartSummary[];
|
|
8636
8897
|
/** The Question. */
|
|
8637
8898
|
question?: string;
|
|
8899
|
+
/** Status of the question answer. */
|
|
8900
|
+
status?: QuestionAnswerStatus;
|
|
8638
8901
|
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
8639
8902
|
suggested_answer?: string;
|
|
8640
8903
|
/**
|
|
@@ -9273,6 +9536,19 @@ export type RevUser = UserBase & {
|
|
|
9273
9536
|
* system-generated identifier will be assigned to the user.
|
|
9274
9537
|
*/
|
|
9275
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[];
|
|
9276
9552
|
/** Whether the Rev user is verified or not. */
|
|
9277
9553
|
is_verified?: boolean;
|
|
9278
9554
|
rev_org?: OrgSummary;
|
|
@@ -9307,6 +9583,22 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
9307
9583
|
external_ref?: string;
|
|
9308
9584
|
rev_org?: OrgSummary;
|
|
9309
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;
|
|
9310
9602
|
/**
|
|
9311
9603
|
* rev-users-associations-list-request
|
|
9312
9604
|
* Gets the list of Rev user associations.
|
|
@@ -9352,6 +9644,24 @@ export interface RevUsersAssociationsListResponse {
|
|
|
9352
9644
|
*/
|
|
9353
9645
|
prev_cursor?: string;
|
|
9354
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;
|
|
9355
9665
|
/**
|
|
9356
9666
|
* rev-users-create-request
|
|
9357
9667
|
* Request object to create a new Rev user for a Rev organization.
|
|
@@ -9402,6 +9712,19 @@ export interface RevUsersCreateRequest {
|
|
|
9402
9712
|
* system-generated identifier will be assigned to the user.
|
|
9403
9713
|
*/
|
|
9404
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[];
|
|
9405
9728
|
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
9406
9729
|
phone_numbers?: string[];
|
|
9407
9730
|
/**
|
|
@@ -9473,6 +9796,8 @@ export interface RevUsersListRequest {
|
|
|
9473
9796
|
email?: string[];
|
|
9474
9797
|
/** List of external refs to filter Rev users for. */
|
|
9475
9798
|
external_ref?: string[];
|
|
9799
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
9800
|
+
external_refs?: string[];
|
|
9476
9801
|
/** Value of is_verified field to filter the Rev users. */
|
|
9477
9802
|
is_verified?: boolean;
|
|
9478
9803
|
/**
|
|
@@ -9562,6 +9887,8 @@ export interface RevUsersScanRequest {
|
|
|
9562
9887
|
email?: string[];
|
|
9563
9888
|
/** List of external refs to filter Rev users for. */
|
|
9564
9889
|
external_ref?: string[];
|
|
9890
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
9891
|
+
external_refs?: string[];
|
|
9565
9892
|
/** Value of is_verified field to filter the Rev users. */
|
|
9566
9893
|
is_verified?: boolean;
|
|
9567
9894
|
modified_date?: DateTimeFilter;
|
|
@@ -9618,6 +9945,19 @@ export interface RevUsersUpdateRequest {
|
|
|
9618
9945
|
email?: string;
|
|
9619
9946
|
/** Updated external ref value of the Rev user. */
|
|
9620
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[];
|
|
9621
9961
|
/** The ID of Rev user to update. */
|
|
9622
9962
|
id: string;
|
|
9623
9963
|
/** The phone numbers, in E.164 format, of the Rev user. */
|
|
@@ -9813,11 +10153,11 @@ export interface SchemaFieldCreateViewUiMetadata {
|
|
|
9813
10153
|
* schema-field-descriptor
|
|
9814
10154
|
* Set of field attributes.
|
|
9815
10155
|
*/
|
|
9816
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
10156
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaJsonValueFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
9817
10157
|
field_type: SchemaFieldDescriptorFieldType;
|
|
9818
10158
|
};
|
|
9819
10159
|
/** schema-field-descriptor-array-type */
|
|
9820
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
10160
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaJsonValueListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
9821
10161
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
9822
10162
|
/**
|
|
9823
10163
|
* The exact array length.
|
|
@@ -9843,6 +10183,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
9843
10183
|
Enum = "enum",
|
|
9844
10184
|
Id = "id",
|
|
9845
10185
|
Int = "int",
|
|
10186
|
+
JsonValue = "json_value",
|
|
9846
10187
|
RichText = "rich_text",
|
|
9847
10188
|
Struct = "struct",
|
|
9848
10189
|
Text = "text",
|
|
@@ -9885,6 +10226,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
9885
10226
|
Enum = "enum",
|
|
9886
10227
|
Id = "id",
|
|
9887
10228
|
Int = "int",
|
|
10229
|
+
JsonValue = "json_value",
|
|
9888
10230
|
RichText = "rich_text",
|
|
9889
10231
|
Struct = "struct",
|
|
9890
10232
|
Text = "text",
|
|
@@ -9962,6 +10304,8 @@ export interface SchemaFieldUenumValue {
|
|
|
9962
10304
|
* The schema of ui specific fields.
|
|
9963
10305
|
*/
|
|
9964
10306
|
export interface SchemaFieldUiMetadata {
|
|
10307
|
+
/** The client overrides for the field. */
|
|
10308
|
+
client_overrides?: ClientOverride[];
|
|
9965
10309
|
/** Create view UI hint overrides. */
|
|
9966
10310
|
create_view?: SchemaFieldCreateViewUiMetadata;
|
|
9967
10311
|
/** Detail view UI hint overrides. */
|
|
@@ -10075,6 +10419,16 @@ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
10075
10419
|
*/
|
|
10076
10420
|
lte?: number;
|
|
10077
10421
|
};
|
|
10422
|
+
/** schema-json-value-field-descriptor */
|
|
10423
|
+
export type SchemaJsonValueFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10424
|
+
/** Default value. */
|
|
10425
|
+
default_value?: any;
|
|
10426
|
+
};
|
|
10427
|
+
/** schema-json-value-list-field-descriptor */
|
|
10428
|
+
export type SchemaJsonValueListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10429
|
+
/** Default value. */
|
|
10430
|
+
default_value?: any[];
|
|
10431
|
+
};
|
|
10078
10432
|
/** schema-rich-text-field-descriptor */
|
|
10079
10433
|
export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10080
10434
|
/** The contained substring. */
|
|
@@ -11229,6 +11583,54 @@ export interface SnapInsUpdateRequest {
|
|
|
11229
11583
|
export interface SnapInsUpdateResponse {
|
|
11230
11584
|
snap_in: SnapIn;
|
|
11231
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
|
+
}
|
|
11232
11634
|
/**
|
|
11233
11635
|
* snap-kit-base-widget
|
|
11234
11636
|
* A SnapKit based widget.
|
|
@@ -11237,7 +11639,7 @@ export interface SnapKitBaseWidget {
|
|
|
11237
11639
|
snap_kit_execution?: string;
|
|
11238
11640
|
}
|
|
11239
11641
|
/** snap-widget */
|
|
11240
|
-
export type SnapWidget = EmailPreviewWidget & {
|
|
11642
|
+
export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
|
|
11241
11643
|
type: SnapWidgetType;
|
|
11242
11644
|
};
|
|
11243
11645
|
/** snap-widget-base */
|
|
@@ -11263,13 +11665,11 @@ export declare enum SnapWidgetClickInteractionClickAction {
|
|
|
11263
11665
|
OpenUrl = "open_url",
|
|
11264
11666
|
StartConversation = "start_conversation"
|
|
11265
11667
|
}
|
|
11266
|
-
/** snap-widget-display-interaction-base */
|
|
11267
|
-
export type SnapWidgetDisplayInteractionBase = object;
|
|
11268
11668
|
/**
|
|
11269
11669
|
* snap-widget-email-input-interaction
|
|
11270
11670
|
* An interaction supported by a widget.
|
|
11271
11671
|
*/
|
|
11272
|
-
export type SnapWidgetEmailInputInteraction =
|
|
11672
|
+
export type SnapWidgetEmailInputInteraction = object;
|
|
11273
11673
|
/**
|
|
11274
11674
|
* snap-widget-interaction
|
|
11275
11675
|
* An interaction supported by a widget.
|
|
@@ -11294,20 +11694,20 @@ export declare enum SnapWidgetNamespace {
|
|
|
11294
11694
|
* snap-widget-open-plug-widget-action
|
|
11295
11695
|
* Details of open plug widget action.
|
|
11296
11696
|
*/
|
|
11297
|
-
export type SnapWidgetOpenPlugWidgetAction =
|
|
11697
|
+
export type SnapWidgetOpenPlugWidgetAction = object;
|
|
11298
11698
|
/**
|
|
11299
11699
|
* snap-widget-open-url-action
|
|
11300
11700
|
* Details of open url widget action.
|
|
11301
11701
|
*/
|
|
11302
|
-
export
|
|
11702
|
+
export interface SnapWidgetOpenUrlAction {
|
|
11303
11703
|
/** The url to open when the widget is clicked. */
|
|
11304
11704
|
url: string;
|
|
11305
|
-
}
|
|
11705
|
+
}
|
|
11306
11706
|
/**
|
|
11307
11707
|
* snap-widget-start-conversation-action
|
|
11308
11708
|
* Details of start conversation action.
|
|
11309
11709
|
*/
|
|
11310
|
-
export
|
|
11710
|
+
export interface SnapWidgetStartConversationAction {
|
|
11311
11711
|
/**
|
|
11312
11712
|
* Whether the rich text editor is enabled on the object. Default is
|
|
11313
11713
|
* false.
|
|
@@ -11315,18 +11715,21 @@ export type SnapWidgetStartConversationAction = SnapWidgetDisplayInteractionBase
|
|
|
11315
11715
|
rte_enabled?: boolean;
|
|
11316
11716
|
/** A SnapKit based widget. */
|
|
11317
11717
|
starter_message?: SnapKitBaseWidget;
|
|
11318
|
-
}
|
|
11718
|
+
}
|
|
11319
11719
|
/** The status of the snap widget. */
|
|
11320
11720
|
export declare enum SnapWidgetStatus {
|
|
11321
11721
|
Draft = "draft",
|
|
11322
11722
|
Published = "published"
|
|
11323
11723
|
}
|
|
11324
11724
|
export declare enum SnapWidgetType {
|
|
11325
|
-
EmailPreview = "email_preview"
|
|
11725
|
+
EmailPreview = "email_preview",
|
|
11726
|
+
StarterMessageNudge = "starter_message_nudge"
|
|
11326
11727
|
}
|
|
11327
11728
|
/** snap-widgets-create-request */
|
|
11328
|
-
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
11729
|
+
export type SnapWidgetsCreateRequest = (CreateEmailPreviewWidget | CreateStarterMessageNudgeWidget) & {
|
|
11329
11730
|
type: SnapWidgetsCreateRequestType;
|
|
11731
|
+
/** The list of interactions supported by the widget. */
|
|
11732
|
+
interactions?: SnapWidgetInteraction[];
|
|
11330
11733
|
/** A human readable name for the snap widget. */
|
|
11331
11734
|
name: string;
|
|
11332
11735
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
@@ -11335,7 +11738,8 @@ export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
|
11335
11738
|
status?: SnapWidgetStatus;
|
|
11336
11739
|
};
|
|
11337
11740
|
export declare enum SnapWidgetsCreateRequestType {
|
|
11338
|
-
EmailPreview = "email_preview"
|
|
11741
|
+
EmailPreview = "email_preview",
|
|
11742
|
+
StarterMessageNudge = "starter_message_nudge"
|
|
11339
11743
|
}
|
|
11340
11744
|
/** snap-widgets-create-response */
|
|
11341
11745
|
export interface SnapWidgetsCreateResponse {
|
|
@@ -11525,6 +11929,11 @@ export interface StagedInfoFilter {
|
|
|
11525
11929
|
/** Filters for issues that are staged. */
|
|
11526
11930
|
is_staged?: boolean;
|
|
11527
11931
|
}
|
|
11932
|
+
/** starter-message-nudge-widget */
|
|
11933
|
+
export interface StarterMessageNudgeWidget {
|
|
11934
|
+
starter_message_nudge_type: StarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
11935
|
+
}
|
|
11936
|
+
export type StarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
11528
11937
|
/**
|
|
11529
11938
|
* stock-field-override
|
|
11530
11939
|
* A stock field override.
|
|
@@ -11866,6 +12275,33 @@ export interface SurveysResponsesListResponse {
|
|
|
11866
12275
|
/** The list of the survey responses. */
|
|
11867
12276
|
survey_responses: SurveyResponse[];
|
|
11868
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;
|
|
11869
12305
|
/** surveys-send-request */
|
|
11870
12306
|
export interface SurveysSendRequest {
|
|
11871
12307
|
email: SurveysSendRequestEmail;
|
|
@@ -12276,11 +12712,22 @@ export type Tag = AtomBase & {
|
|
|
12276
12712
|
* unique.
|
|
12277
12713
|
*/
|
|
12278
12714
|
name: string;
|
|
12715
|
+
style_new?: TagStyle;
|
|
12279
12716
|
};
|
|
12280
12717
|
/** tag-search-summary */
|
|
12281
12718
|
export type TagSearchSummary = SearchSummaryBase & {
|
|
12282
12719
|
tag: TagSummary;
|
|
12283
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
|
+
}
|
|
12284
12731
|
/** tag-summary */
|
|
12285
12732
|
export type TagSummary = AtomBaseSummary & {
|
|
12286
12733
|
/**
|
|
@@ -12289,6 +12736,7 @@ export type TagSummary = AtomBaseSummary & {
|
|
|
12289
12736
|
* unique.
|
|
12290
12737
|
*/
|
|
12291
12738
|
name: string;
|
|
12739
|
+
style_new?: TagStyleSummary;
|
|
12292
12740
|
};
|
|
12293
12741
|
/** tag-with-value */
|
|
12294
12742
|
export interface TagWithValue {
|
|
@@ -12323,6 +12771,7 @@ export interface TagsCreateRequest {
|
|
|
12323
12771
|
description?: string;
|
|
12324
12772
|
/** The name for the tag, which must be unique across all tags. */
|
|
12325
12773
|
name: string;
|
|
12774
|
+
style_new?: TagStyle;
|
|
12326
12775
|
}
|
|
12327
12776
|
/**
|
|
12328
12777
|
* tags-create-response
|
|
@@ -12438,6 +12887,7 @@ export interface TagsUpdateRequest {
|
|
|
12438
12887
|
* tags.
|
|
12439
12888
|
*/
|
|
12440
12889
|
name?: string;
|
|
12890
|
+
style_new?: TagStyle;
|
|
12441
12891
|
}
|
|
12442
12892
|
/**
|
|
12443
12893
|
* tags-update-response
|
|
@@ -12466,8 +12916,11 @@ export type TenantFragment = CustomSchemaFragmentBase & {
|
|
|
12466
12916
|
export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
12467
12917
|
/** ticket */
|
|
12468
12918
|
export type Ticket = WorkBase & {
|
|
12919
|
+
account?: AccountSummary;
|
|
12469
12920
|
/** Channels of the ticket. */
|
|
12470
12921
|
channels?: TicketChannels[];
|
|
12922
|
+
/** Channel IDs of the ticket. */
|
|
12923
|
+
channels_v2?: ExternalCommunicationChannelSummary[];
|
|
12471
12924
|
group?: GroupSummary;
|
|
12472
12925
|
/** Whether the ticket needs a response. */
|
|
12473
12926
|
needs_response?: boolean;
|
|
@@ -12489,6 +12942,9 @@ export type Ticket = WorkBase & {
|
|
|
12489
12942
|
sla_tracker?: SlaTrackerSummary;
|
|
12490
12943
|
/** Source channel of the ticket. */
|
|
12491
12944
|
source_channel?: string;
|
|
12945
|
+
source_channel_v2?: ExternalCommunicationChannelSummary;
|
|
12946
|
+
/** The properties of an enum value. */
|
|
12947
|
+
visibility?: EnumValue;
|
|
12492
12948
|
};
|
|
12493
12949
|
/** Channels of the ticket. */
|
|
12494
12950
|
export declare enum TicketChannels {
|
|
@@ -12507,6 +12963,7 @@ export declare enum TicketSeverity {
|
|
|
12507
12963
|
}
|
|
12508
12964
|
/** ticket-summary */
|
|
12509
12965
|
export type TicketSummary = WorkBaseSummary & {
|
|
12966
|
+
account?: AccountSummary;
|
|
12510
12967
|
rev_org?: OrgSummary;
|
|
12511
12968
|
/** Severity of the ticket. */
|
|
12512
12969
|
severity?: TicketSeverity;
|
|
@@ -12911,6 +13368,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
12911
13368
|
panels?: TimelineEntryPanel[];
|
|
12912
13369
|
/** The reactions to the entry. */
|
|
12913
13370
|
reactions?: TimelineReaction[];
|
|
13371
|
+
/** Mixin for storing sync metadata. */
|
|
13372
|
+
sync_metadata?: SyncMetadata;
|
|
12914
13373
|
/** Thread. */
|
|
12915
13374
|
thread?: TimelineThread;
|
|
12916
13375
|
/**
|
|
@@ -13464,11 +13923,6 @@ export interface UpdateIncidentArtifacts {
|
|
|
13464
13923
|
*/
|
|
13465
13924
|
set?: string[];
|
|
13466
13925
|
}
|
|
13467
|
-
/** update-incident-impacted-customers */
|
|
13468
|
-
export interface UpdateIncidentImpactedCustomers {
|
|
13469
|
-
/** Sets the list of customers impacted due to the incident. */
|
|
13470
|
-
set?: string[];
|
|
13471
|
-
}
|
|
13472
13926
|
/** update-incident-owned-by */
|
|
13473
13927
|
export interface UpdateIncidentOwnedBy {
|
|
13474
13928
|
/** Sets the user IDs of the users that own the incident. */
|
|
@@ -13498,14 +13952,6 @@ export interface UpdateIncidentRelatedDocs {
|
|
|
13498
13952
|
*/
|
|
13499
13953
|
set?: string[];
|
|
13500
13954
|
}
|
|
13501
|
-
/** update-incident-stakeholders */
|
|
13502
|
-
export interface UpdateIncidentStakeholders {
|
|
13503
|
-
/**
|
|
13504
|
-
* Sets the users, along with the incident commander, involved in
|
|
13505
|
-
* resolving incidents and handling communication.
|
|
13506
|
-
*/
|
|
13507
|
-
set?: string[];
|
|
13508
|
-
}
|
|
13509
13955
|
/** update-incident-tags */
|
|
13510
13956
|
export interface UpdateIncidentTags {
|
|
13511
13957
|
/** Sets the tags associated with the object. */
|
|
@@ -13541,6 +13987,12 @@ export interface UpdateStageNode {
|
|
|
13541
13987
|
export interface UpdateStageTransition {
|
|
13542
13988
|
/** The ID of the target stage. */
|
|
13543
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;
|
|
13544
13996
|
}
|
|
13545
13997
|
/**
|
|
13546
13998
|
* update-tag-with-value
|
|
@@ -13632,6 +14084,24 @@ export declare enum UserType {
|
|
|
13632
14084
|
ServiceAccount = "service_account",
|
|
13633
14085
|
SysUser = "sys_user"
|
|
13634
14086
|
}
|
|
14087
|
+
/**
|
|
14088
|
+
* view-override
|
|
14089
|
+
* UI hint overrides for a view.
|
|
14090
|
+
*/
|
|
14091
|
+
export interface ViewOverride {
|
|
14092
|
+
/** The display name of the field. */
|
|
14093
|
+
display_name?: string;
|
|
14094
|
+
/** Whether the field is hidden in the UI. */
|
|
14095
|
+
is_hidden?: boolean;
|
|
14096
|
+
/** Whether the field is mandatory. */
|
|
14097
|
+
is_required?: boolean;
|
|
14098
|
+
/** A placeholder for the field. */
|
|
14099
|
+
placeholder?: string;
|
|
14100
|
+
/** Tooltip for the field. */
|
|
14101
|
+
tooltip?: string;
|
|
14102
|
+
/** The name of the view. */
|
|
14103
|
+
view_name?: string;
|
|
14104
|
+
}
|
|
13635
14105
|
/** vista-base-summary */
|
|
13636
14106
|
export type VistaBaseSummary = AtomBaseSummary & {
|
|
13637
14107
|
/** Name of the vista. */
|
|
@@ -14299,6 +14769,11 @@ export interface WorksCreateRequestTask {
|
|
|
14299
14769
|
}
|
|
14300
14770
|
/** works-create-request-ticket */
|
|
14301
14771
|
export interface WorksCreateRequestTicket {
|
|
14772
|
+
/**
|
|
14773
|
+
* The account that the ticket is associated with.
|
|
14774
|
+
* @example "ACC-12345"
|
|
14775
|
+
*/
|
|
14776
|
+
account?: string;
|
|
14302
14777
|
/** Channels of the ticket. */
|
|
14303
14778
|
channels?: TicketChannels[];
|
|
14304
14779
|
/** The group that the ticket is associated with. */
|
|
@@ -14396,7 +14871,7 @@ export interface WorksExportResponse {
|
|
|
14396
14871
|
/** works-filter-issue */
|
|
14397
14872
|
export interface WorksFilterIssue {
|
|
14398
14873
|
/**
|
|
14399
|
-
* Filters for issues with any of the provided
|
|
14874
|
+
* Filters for issues with any of the provided accounts.
|
|
14400
14875
|
* @example ["ACC-12345"]
|
|
14401
14876
|
*/
|
|
14402
14877
|
accounts?: string[];
|
|
@@ -14602,8 +15077,8 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
14602
15077
|
/** Updates an object's stage. */
|
|
14603
15078
|
stage?: StageUpdate;
|
|
14604
15079
|
/**
|
|
14605
|
-
* The type of stage validations options when updating the stage
|
|
14606
|
-
* object.
|
|
15080
|
+
* The type of stage validations options when updating the stage or
|
|
15081
|
+
* the stage diagram of an object.
|
|
14607
15082
|
*/
|
|
14608
15083
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
14609
15084
|
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
@@ -14768,6 +15243,11 @@ export interface WorksUpdateRequestTask {
|
|
|
14768
15243
|
}
|
|
14769
15244
|
/** works-update-request-ticket */
|
|
14770
15245
|
export interface WorksUpdateRequestTicket {
|
|
15246
|
+
/**
|
|
15247
|
+
* Updates the account that the ticket is associated with.
|
|
15248
|
+
* @example "ACC-12345"
|
|
15249
|
+
*/
|
|
15250
|
+
account?: string | null;
|
|
14771
15251
|
channels?: WorksUpdateRequestTicketChannels;
|
|
14772
15252
|
/** Updates the group that the ticket is associated with. */
|
|
14773
15253
|
group?: string | null;
|
|
@@ -15081,6 +15561,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15081
15561
|
* @secure
|
|
15082
15562
|
*/
|
|
15083
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>>;
|
|
15084
15574
|
/**
|
|
15085
15575
|
* @description Gets a single sync unit's information.
|
|
15086
15576
|
*
|
|
@@ -15198,6 +15688,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15198
15688
|
'shared_with.member'?: string;
|
|
15199
15689
|
/** Role ID of the group/member with whom the item is shared. */
|
|
15200
15690
|
'shared_with.role'?: string;
|
|
15691
|
+
/**
|
|
15692
|
+
* Filters for article with any of the provided tags.
|
|
15693
|
+
* @example ["TAG-12345"]
|
|
15694
|
+
*/
|
|
15695
|
+
tags?: string[];
|
|
15201
15696
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
15202
15697
|
/**
|
|
15203
15698
|
* @description Get count of articles matching given filter.
|
|
@@ -15316,6 +15811,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15316
15811
|
'shared_with.member'?: string;
|
|
15317
15812
|
/** Role ID of the group/member with whom the item is shared. */
|
|
15318
15813
|
'shared_with.role'?: string;
|
|
15814
|
+
/**
|
|
15815
|
+
* Filters for article with any of the provided tags.
|
|
15816
|
+
* @example ["TAG-12345"]
|
|
15817
|
+
*/
|
|
15818
|
+
tags?: string[];
|
|
15319
15819
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
15320
15820
|
/**
|
|
15321
15821
|
* @description Lists a collection of articles.
|
|
@@ -15900,6 +16400,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15900
16400
|
group?: string[];
|
|
15901
16401
|
/** Filters for conversations that are created by verified users. */
|
|
15902
16402
|
is_creator_verified?: boolean;
|
|
16403
|
+
/** Filters for conversations that are frozen. */
|
|
16404
|
+
is_frozen?: boolean;
|
|
15903
16405
|
/** Filters for conversations that are spam. */
|
|
15904
16406
|
is_spam?: boolean;
|
|
15905
16407
|
/**
|
|
@@ -16027,6 +16529,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16027
16529
|
group?: string[];
|
|
16028
16530
|
/** Filters for conversations that are created by verified users. */
|
|
16029
16531
|
is_creator_verified?: boolean;
|
|
16532
|
+
/** Filters for conversations that are frozen. */
|
|
16533
|
+
is_frozen?: boolean;
|
|
16030
16534
|
/** Filters for conversations that are spam. */
|
|
16031
16535
|
is_spam?: boolean;
|
|
16032
16536
|
/**
|
|
@@ -17067,7 +17571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17067
17571
|
* Filters for incidents with any of the provided playbooks.
|
|
17068
17572
|
* @example ["ARTICLE-12345"]
|
|
17069
17573
|
*/
|
|
17070
|
-
|
|
17574
|
+
playbooks?: string[];
|
|
17071
17575
|
/**
|
|
17072
17576
|
* Filters for incidents with any of the provided related docs.
|
|
17073
17577
|
* @example ["ARTICLE-12345"]
|
|
@@ -17143,7 +17647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17143
17647
|
* Filters for incidents with any of the provided playbooks.
|
|
17144
17648
|
* @example ["ARTICLE-12345"]
|
|
17145
17649
|
*/
|
|
17146
|
-
|
|
17650
|
+
playbooks?: string[];
|
|
17147
17651
|
/**
|
|
17148
17652
|
* Filters for incidents with any of the provided related docs.
|
|
17149
17653
|
* @example ["ARTICLE-12345"]
|
|
@@ -17972,6 +18476,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17972
18476
|
* @example ["PROD-12345"]
|
|
17973
18477
|
*/
|
|
17974
18478
|
'parent_part.parts'?: string[];
|
|
18479
|
+
/**
|
|
18480
|
+
* Filters for part with any of the provided tags.
|
|
18481
|
+
* @example ["TAG-12345"]
|
|
18482
|
+
*/
|
|
18483
|
+
tags?: string[];
|
|
17975
18484
|
/** Filters for parts of the provided type(s). */
|
|
17976
18485
|
type?: PartType[];
|
|
17977
18486
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
@@ -18365,6 +18874,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18365
18874
|
* @secure
|
|
18366
18875
|
*/
|
|
18367
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>>;
|
|
18368
18887
|
/**
|
|
18369
18888
|
* @description Returns a list of associations on a Rev user.
|
|
18370
18889
|
*
|
|
@@ -18404,6 +18923,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18404
18923
|
* @secure
|
|
18405
18924
|
*/
|
|
18406
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>>;
|
|
18407
18936
|
/**
|
|
18408
18937
|
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
18409
18938
|
*
|
|
@@ -18508,6 +19037,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18508
19037
|
email?: string[];
|
|
18509
19038
|
/** List of external refs to filter Rev users for. */
|
|
18510
19039
|
external_ref?: string[];
|
|
19040
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
19041
|
+
external_refs?: string[];
|
|
18511
19042
|
/** Value of is_verified field to filter the Rev users. */
|
|
18512
19043
|
is_verified?: boolean;
|
|
18513
19044
|
/**
|
|
@@ -18616,6 +19147,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18616
19147
|
email?: string[];
|
|
18617
19148
|
/** List of external refs to filter Rev users for. */
|
|
18618
19149
|
external_ref?: string[];
|
|
19150
|
+
/** Filters for Rev users with the provided external_refs. */
|
|
19151
|
+
external_refs?: string[];
|
|
18619
19152
|
/** Value of is_verified field to filter the Rev users. */
|
|
18620
19153
|
is_verified?: boolean;
|
|
18621
19154
|
/**
|
|
@@ -18703,6 +19236,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18703
19236
|
aggregatedSchemaGet: (query: {
|
|
18704
19237
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
18705
19238
|
custom_schema_fragment_ids: string[];
|
|
19239
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
19240
|
+
is_custom_leaf_type?: boolean;
|
|
18706
19241
|
/**
|
|
18707
19242
|
* The leaf type. Used for inferring the default stage diagram and
|
|
18708
19243
|
* tenant fragment ID.
|
|
@@ -19277,6 +19812,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19277
19812
|
* @secure
|
|
19278
19813
|
*/
|
|
19279
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>>;
|
|
19280
19825
|
/**
|
|
19281
19826
|
* @description Create a snap widget object.
|
|
19282
19827
|
*
|
|
@@ -19670,6 +20215,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19670
20215
|
* @secure
|
|
19671
20216
|
*/
|
|
19672
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>>;
|
|
19673
20228
|
/**
|
|
19674
20229
|
* @description Sends a survey on the specified channels.
|
|
19675
20230
|
*
|
|
@@ -20281,7 +20836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20281
20836
|
*/
|
|
20282
20837
|
first?: number;
|
|
20283
20838
|
/**
|
|
20284
|
-
* Filters for issues with any of the provided
|
|
20839
|
+
* Filters for issues with any of the provided accounts.
|
|
20285
20840
|
* @example ["ACC-12345"]
|
|
20286
20841
|
*/
|
|
20287
20842
|
'issue.accounts'?: string[];
|
|
@@ -20440,7 +20995,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20440
20995
|
/** Filters for custom fields. */
|
|
20441
20996
|
custom_fields?: object;
|
|
20442
20997
|
/**
|
|
20443
|
-
* Filters for issues with any of the provided
|
|
20998
|
+
* Filters for issues with any of the provided accounts.
|
|
20444
20999
|
* @example ["ACC-12345"]
|
|
20445
21000
|
*/
|
|
20446
21001
|
'issue.accounts'?: string[];
|