@devrev/typescript-sdk 1.1.31 → 1.1.33
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.
|
@@ -420,6 +420,20 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
420
420
|
* Metric with corresponding target values.
|
|
421
421
|
*/
|
|
422
422
|
export interface ArchetypeMetricTarget {
|
|
423
|
+
/**
|
|
424
|
+
* For breached metrics the time they entered into breach. This is the
|
|
425
|
+
* same as what the target date was, unless the breach happened due to
|
|
426
|
+
* a different policy starting to apply.
|
|
427
|
+
* @format date-time
|
|
428
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
429
|
+
*/
|
|
430
|
+
breached_at?: string;
|
|
431
|
+
/**
|
|
432
|
+
* For completed metrics the time (in minutes) it took to complete
|
|
433
|
+
* them. (Taking into account the schedule if any).
|
|
434
|
+
* @format int32
|
|
435
|
+
*/
|
|
436
|
+
completed_in?: number;
|
|
423
437
|
/**
|
|
424
438
|
* If true, the schedule attached to this metric is out of schedule at
|
|
425
439
|
* the time of the query. It is not set for metrics in *completed*
|
|
@@ -427,12 +441,26 @@ export interface ArchetypeMetricTarget {
|
|
|
427
441
|
*/
|
|
428
442
|
is_out_of_schedule?: boolean;
|
|
429
443
|
metric_definition: MetricDefinitionSummary;
|
|
444
|
+
/**
|
|
445
|
+
* The next time the schedule will change its state, if such is known.
|
|
446
|
+
* @format date-time
|
|
447
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
448
|
+
*/
|
|
449
|
+
next_schedule_transition?: string;
|
|
430
450
|
org_schedule?: OrgScheduleSummary;
|
|
431
451
|
/**
|
|
432
452
|
* Time in minutes that remains on a paused metric.
|
|
433
453
|
* @format int32
|
|
434
454
|
*/
|
|
435
455
|
remaining_time?: number;
|
|
456
|
+
/** Metric stage corresponding to the applicable SLA. */
|
|
457
|
+
stage: string;
|
|
458
|
+
/**
|
|
459
|
+
* It is an indicator of whether the metric has ever been breached
|
|
460
|
+
* (missed). If not, it shows whether the metric is completed, in
|
|
461
|
+
* progress, or not part of the applied policy.
|
|
462
|
+
*/
|
|
463
|
+
status?: string;
|
|
436
464
|
/**
|
|
437
465
|
* Time at which the metric would breach SLA if no action taken.
|
|
438
466
|
* @format date-time
|
|
@@ -478,6 +506,8 @@ export type Article = AtomBase & {
|
|
|
478
506
|
resource?: Resource;
|
|
479
507
|
/** The properties of an enum value. */
|
|
480
508
|
scope?: EnumValue;
|
|
509
|
+
/** Mixin for storing sync metadata. */
|
|
510
|
+
sync_metadata?: SyncMetadata;
|
|
481
511
|
/** Title of the article. */
|
|
482
512
|
title?: string;
|
|
483
513
|
};
|
|
@@ -1966,6 +1996,8 @@ export interface ConversationsCreateRequest {
|
|
|
1966
1996
|
/** Initial messages on the conversation. */
|
|
1967
1997
|
messages?: ConversationsCreateRequestMessage[];
|
|
1968
1998
|
metadata?: ConversationsCreateRequestMetadata;
|
|
1999
|
+
/** The users that own the conversation. */
|
|
2000
|
+
owned_by?: string[];
|
|
1969
2001
|
/** Whether the conversation is from a source channel. */
|
|
1970
2002
|
source_channel?: string;
|
|
1971
2003
|
/** Sets an object's initial stage. */
|
|
@@ -2182,6 +2214,7 @@ export interface ConversationsUpdateRequest {
|
|
|
2182
2214
|
/** Whether the conversation is spam. */
|
|
2183
2215
|
is_spam?: boolean;
|
|
2184
2216
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
2217
|
+
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
2185
2218
|
/** Updates an object's stage. */
|
|
2186
2219
|
stage?: StageUpdate;
|
|
2187
2220
|
/** The updated status of the conversation. */
|
|
@@ -2203,6 +2236,16 @@ export interface ConversationsUpdateRequestAppliesToParts {
|
|
|
2203
2236
|
export interface ConversationsUpdateRequestMetadata {
|
|
2204
2237
|
url_context?: string;
|
|
2205
2238
|
}
|
|
2239
|
+
/** conversations-update-request-owned-by */
|
|
2240
|
+
export interface ConversationsUpdateRequestOwnedBy {
|
|
2241
|
+
/**
|
|
2242
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2243
|
+
* empty.
|
|
2244
|
+
* @minItems 1
|
|
2245
|
+
* @example ["DEVU-12345"]
|
|
2246
|
+
*/
|
|
2247
|
+
set?: string[];
|
|
2248
|
+
}
|
|
2206
2249
|
/** conversations-update-request-tags */
|
|
2207
2250
|
export interface ConversationsUpdateRequestTags {
|
|
2208
2251
|
/** Sets the tag IDs to the provided tags. */
|
|
@@ -2368,12 +2411,260 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
2368
2411
|
* Static collection of Devrev objects.
|
|
2369
2412
|
*/
|
|
2370
2413
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
2414
|
+
/** custom-link-type */
|
|
2415
|
+
export type CustomLinkType = AtomBase;
|
|
2416
|
+
/** custom-link-type-create-request */
|
|
2417
|
+
export interface CustomLinkTypeCreateRequest {
|
|
2418
|
+
/** The name of the link in the backward direction. */
|
|
2419
|
+
backward_name: string;
|
|
2420
|
+
/** Whether the link type is deprecated. */
|
|
2421
|
+
deprecated?: boolean;
|
|
2422
|
+
/** The name of the link in the forward direction. */
|
|
2423
|
+
forward_name: string;
|
|
2424
|
+
/** The name of the custom link type. */
|
|
2425
|
+
name: string;
|
|
2426
|
+
/** Types from which the link can be made from. */
|
|
2427
|
+
source_types: LinkTargetDescriptor[];
|
|
2428
|
+
/** Types to which the link can be made to. */
|
|
2429
|
+
target_types: LinkTargetDescriptor[];
|
|
2430
|
+
/** The tooltip of the custom link type. */
|
|
2431
|
+
tooltip?: string;
|
|
2432
|
+
}
|
|
2433
|
+
/** custom-link-type-create-response */
|
|
2434
|
+
export interface CustomLinkTypeCreateResponse {
|
|
2435
|
+
custom_link_type: CustomLinkType;
|
|
2436
|
+
}
|
|
2437
|
+
/** custom-link-type-get-request */
|
|
2438
|
+
export interface CustomLinkTypeGetRequest {
|
|
2439
|
+
/** The ID of the custom link type to get. */
|
|
2440
|
+
id: string;
|
|
2441
|
+
}
|
|
2442
|
+
/** custom-link-type-get-response */
|
|
2443
|
+
export interface CustomLinkTypeGetResponse {
|
|
2444
|
+
custom_link_type: CustomLinkType;
|
|
2445
|
+
}
|
|
2446
|
+
/** custom-link-type-list-request */
|
|
2447
|
+
export interface CustomLinkTypeListRequest {
|
|
2448
|
+
/**
|
|
2449
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2450
|
+
* iteration starts from the beginning.
|
|
2451
|
+
*/
|
|
2452
|
+
cursor?: string;
|
|
2453
|
+
/** Whether only deprecated link types should be filtered. */
|
|
2454
|
+
deprecated?: boolean;
|
|
2455
|
+
/**
|
|
2456
|
+
* The maximum number of items.
|
|
2457
|
+
* @format int32
|
|
2458
|
+
*/
|
|
2459
|
+
limit?: number;
|
|
2460
|
+
/**
|
|
2461
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2462
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2463
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2464
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2465
|
+
* always be returned in the specified sort-by order.
|
|
2466
|
+
*/
|
|
2467
|
+
mode?: ListMode;
|
|
2468
|
+
/** The list of link type names. */
|
|
2469
|
+
name?: string[];
|
|
2470
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2471
|
+
sort_by?: string[];
|
|
2472
|
+
source_types?: LinkDescriptorFilter;
|
|
2473
|
+
target_types?: LinkDescriptorFilter;
|
|
2474
|
+
}
|
|
2475
|
+
/** custom-link-type-list-response */
|
|
2476
|
+
export interface CustomLinkTypeListResponse {
|
|
2477
|
+
/**
|
|
2478
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2479
|
+
* sort order. If not set, then no later elements exist.
|
|
2480
|
+
*/
|
|
2481
|
+
next_cursor?: string;
|
|
2482
|
+
/**
|
|
2483
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2484
|
+
* sort order. If not set, then no prior elements exist.
|
|
2485
|
+
*/
|
|
2486
|
+
prev_cursor?: string;
|
|
2487
|
+
/** The custom link types. */
|
|
2488
|
+
result: CustomLinkType[];
|
|
2489
|
+
}
|
|
2490
|
+
/** custom-link-type-update-request */
|
|
2491
|
+
export interface CustomLinkTypeUpdateRequest {
|
|
2492
|
+
/** The updated name of the link in the backward direction. */
|
|
2493
|
+
backward_name?: string;
|
|
2494
|
+
/** Whether the link type is deprecated. */
|
|
2495
|
+
deprecated?: boolean;
|
|
2496
|
+
/** The updated name of the link in the forward direction. */
|
|
2497
|
+
forward_name?: string;
|
|
2498
|
+
/** The ID of the custom link type to update. */
|
|
2499
|
+
id: string;
|
|
2500
|
+
/** The updated name of the custom link type. */
|
|
2501
|
+
name?: string;
|
|
2502
|
+
source_types?: UpdateLinkTargetDescriptorList;
|
|
2503
|
+
target_types?: UpdateLinkTargetDescriptorList;
|
|
2504
|
+
/** The updated tooltip of the custom link type. */
|
|
2505
|
+
tooltip?: string;
|
|
2506
|
+
}
|
|
2507
|
+
/** custom-link-type-update-response */
|
|
2508
|
+
export interface CustomLinkTypeUpdateResponse {
|
|
2509
|
+
custom_link_type: CustomLinkType;
|
|
2510
|
+
}
|
|
2511
|
+
/** custom-object */
|
|
2512
|
+
export type CustomObject = AtomBase & {
|
|
2513
|
+
/** Custom fields. */
|
|
2514
|
+
custom_fields?: object;
|
|
2515
|
+
/**
|
|
2516
|
+
* Custom schema fragments.
|
|
2517
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2518
|
+
*/
|
|
2519
|
+
custom_schema_fragments?: string[];
|
|
2520
|
+
/**
|
|
2521
|
+
* Stock schema fragment.
|
|
2522
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
2523
|
+
*/
|
|
2524
|
+
stock_schema_fragment?: string;
|
|
2525
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
2526
|
+
subtype?: string;
|
|
2527
|
+
};
|
|
2371
2528
|
/** custom-object-search-summary */
|
|
2372
2529
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2373
2530
|
custom_object: CustomObjectSummary;
|
|
2374
2531
|
};
|
|
2375
2532
|
/** custom-object-summary */
|
|
2376
2533
|
export type CustomObjectSummary = AtomBaseSummary;
|
|
2534
|
+
/** custom-objects-count-request */
|
|
2535
|
+
export interface CustomObjectsCountRequest {
|
|
2536
|
+
/** List of filters to apply. */
|
|
2537
|
+
filters?: any[];
|
|
2538
|
+
/** Leaf type to filter. */
|
|
2539
|
+
leaf_type: string;
|
|
2540
|
+
}
|
|
2541
|
+
/** custom-objects-count-response */
|
|
2542
|
+
export interface CustomObjectsCountResponse {
|
|
2543
|
+
/**
|
|
2544
|
+
* The count of custom objects.
|
|
2545
|
+
* @format int64
|
|
2546
|
+
*/
|
|
2547
|
+
count: number;
|
|
2548
|
+
}
|
|
2549
|
+
/** custom-objects-create-request */
|
|
2550
|
+
export interface CustomObjectsCreateRequest {
|
|
2551
|
+
/** Custom fields of the custom object. */
|
|
2552
|
+
custom_fields?: object;
|
|
2553
|
+
/**
|
|
2554
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2555
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2556
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2557
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2558
|
+
* specifier, it remains unmodified.
|
|
2559
|
+
*/
|
|
2560
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2561
|
+
/** Leaf type of the custom object. */
|
|
2562
|
+
leaf_type: string;
|
|
2563
|
+
/** The stage of the custom object. */
|
|
2564
|
+
stage?: string;
|
|
2565
|
+
/**
|
|
2566
|
+
* The type of stage validations options when creating a custom
|
|
2567
|
+
* object.
|
|
2568
|
+
*/
|
|
2569
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
2570
|
+
/** Title of the custom object. */
|
|
2571
|
+
title?: string;
|
|
2572
|
+
/**
|
|
2573
|
+
* The unique key of the custom object.This can be used to hold an
|
|
2574
|
+
* external reference to another object.
|
|
2575
|
+
*/
|
|
2576
|
+
unique_key: string;
|
|
2577
|
+
}
|
|
2578
|
+
/** custom-objects-create-response */
|
|
2579
|
+
export interface CustomObjectsCreateResponse {
|
|
2580
|
+
custom_object: CustomObject;
|
|
2581
|
+
}
|
|
2582
|
+
/** custom-objects-delete-request */
|
|
2583
|
+
export interface CustomObjectsDeleteRequest {
|
|
2584
|
+
/** The ID of the custom object to get. */
|
|
2585
|
+
id: string;
|
|
2586
|
+
}
|
|
2587
|
+
/** custom-objects-delete-response */
|
|
2588
|
+
export type CustomObjectsDeleteResponse = object;
|
|
2589
|
+
/** custom-objects-get-request */
|
|
2590
|
+
export interface CustomObjectsGetRequest {
|
|
2591
|
+
/** The ID of the custom object to get. */
|
|
2592
|
+
id?: string;
|
|
2593
|
+
}
|
|
2594
|
+
/** custom-objects-get-response */
|
|
2595
|
+
export interface CustomObjectsGetResponse {
|
|
2596
|
+
custom_object: CustomObject;
|
|
2597
|
+
}
|
|
2598
|
+
/** custom-objects-list-request */
|
|
2599
|
+
export interface CustomObjectsListRequest {
|
|
2600
|
+
/**
|
|
2601
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2602
|
+
* iteration starts from the beginning.
|
|
2603
|
+
*/
|
|
2604
|
+
cursor?: string;
|
|
2605
|
+
/** List of filters to apply. */
|
|
2606
|
+
filter?: any[];
|
|
2607
|
+
/** Leaf type to filter. */
|
|
2608
|
+
leaf_type: string;
|
|
2609
|
+
/**
|
|
2610
|
+
* The maximum number of items.
|
|
2611
|
+
* @format int32
|
|
2612
|
+
*/
|
|
2613
|
+
limit?: number;
|
|
2614
|
+
/**
|
|
2615
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2616
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2617
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2618
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2619
|
+
* always be returned in the specified sort-by order.
|
|
2620
|
+
*/
|
|
2621
|
+
mode?: ListMode;
|
|
2622
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2623
|
+
sort_by?: string[];
|
|
2624
|
+
}
|
|
2625
|
+
/** custom-objects-list-response */
|
|
2626
|
+
export interface CustomObjectsListResponse {
|
|
2627
|
+
/**
|
|
2628
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2629
|
+
* sort order. If not set, then no later elements exist.
|
|
2630
|
+
*/
|
|
2631
|
+
next_cursor?: string;
|
|
2632
|
+
/**
|
|
2633
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2634
|
+
* sort order. If not set, then no prior elements exist.
|
|
2635
|
+
*/
|
|
2636
|
+
prev_cursor?: string;
|
|
2637
|
+
/** The custom objects. */
|
|
2638
|
+
result: CustomObject[];
|
|
2639
|
+
}
|
|
2640
|
+
/** custom-objects-update-request */
|
|
2641
|
+
export interface CustomObjectsUpdateRequest {
|
|
2642
|
+
/** Custom fields of the custom object. */
|
|
2643
|
+
custom_fields?: object;
|
|
2644
|
+
/**
|
|
2645
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2646
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2647
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2648
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2649
|
+
* specifier, it remains unmodified.
|
|
2650
|
+
*/
|
|
2651
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2652
|
+
/** The ID of the custom object to update. */
|
|
2653
|
+
id: string;
|
|
2654
|
+
/** Updates the stage of the custom object. */
|
|
2655
|
+
stage?: string | null;
|
|
2656
|
+
/**
|
|
2657
|
+
* The type of stage validations options when updating the stage of a
|
|
2658
|
+
* custom object.
|
|
2659
|
+
*/
|
|
2660
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
2661
|
+
/** Updates the title of the custom object. */
|
|
2662
|
+
title?: string | null;
|
|
2663
|
+
}
|
|
2664
|
+
/** custom-objects-update-response */
|
|
2665
|
+
export interface CustomObjectsUpdateResponse {
|
|
2666
|
+
custom_object: CustomObject;
|
|
2667
|
+
}
|
|
2377
2668
|
/** custom-schema-fragment */
|
|
2378
2669
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
2379
2670
|
type: CustomSchemaFragmentType;
|
|
@@ -2441,6 +2732,8 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
2441
2732
|
cursor?: string;
|
|
2442
2733
|
/** Whether only deprecated fragments should be filtered. */
|
|
2443
2734
|
deprecated?: boolean;
|
|
2735
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
2736
|
+
is_custom_leaf_type?: boolean;
|
|
2444
2737
|
/** The list of leaf types. */
|
|
2445
2738
|
leaf_type?: string[];
|
|
2446
2739
|
/**
|
|
@@ -2831,6 +3124,21 @@ export declare enum DateTimePresetType {
|
|
|
2831
3124
|
LastNDays = "last_n_days",
|
|
2832
3125
|
NextNDays = "next_n_days"
|
|
2833
3126
|
}
|
|
3127
|
+
/**
|
|
3128
|
+
* delete-rev-users-personal-data-request
|
|
3129
|
+
* Request object to delete a contact's information.
|
|
3130
|
+
*/
|
|
3131
|
+
export interface DeleteRevUsersPersonalDataRequest {
|
|
3132
|
+
/** Email of the contact. */
|
|
3133
|
+
email: string;
|
|
3134
|
+
}
|
|
3135
|
+
/**
|
|
3136
|
+
* delete-rev-users-personal-data-response
|
|
3137
|
+
* Response for the contacts personal data detete request. Response is
|
|
3138
|
+
* empty as the process is asynchronous. Upon completion, the user will be
|
|
3139
|
+
* notified.
|
|
3140
|
+
*/
|
|
3141
|
+
export type DeleteRevUsersPersonalDataResponse = object;
|
|
2834
3142
|
/**
|
|
2835
3143
|
* dev-org-auth-connections-create-request
|
|
2836
3144
|
* Request to create a new enterprise authentication connection.
|
|
@@ -2972,6 +3280,13 @@ export interface DevOrgAuthConnectionsUpdateResponse {
|
|
|
2972
3280
|
}
|
|
2973
3281
|
/** dev-user */
|
|
2974
3282
|
export type DevUser = UserBase & {
|
|
3283
|
+
/** Custom fields. */
|
|
3284
|
+
custom_fields?: object;
|
|
3285
|
+
/**
|
|
3286
|
+
* Custom schema fragments.
|
|
3287
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
3288
|
+
*/
|
|
3289
|
+
custom_schema_fragments?: string[];
|
|
2975
3290
|
/**
|
|
2976
3291
|
* Start date of the user's employment.
|
|
2977
3292
|
* @format date-time
|
|
@@ -2984,6 +3299,13 @@ export type DevUser = UserBase & {
|
|
|
2984
3299
|
job_history?: JobHistoryItem[];
|
|
2985
3300
|
/** Array of skills of the user. */
|
|
2986
3301
|
skills?: UserSkill[];
|
|
3302
|
+
/**
|
|
3303
|
+
* Stock schema fragment.
|
|
3304
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
3305
|
+
*/
|
|
3306
|
+
stock_schema_fragment?: string;
|
|
3307
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
3308
|
+
subtype?: string;
|
|
2987
3309
|
};
|
|
2988
3310
|
/** dev-user-external-identity-filter */
|
|
2989
3311
|
export interface DevUserExternalIdentityFilter {
|
|
@@ -3075,6 +3397,8 @@ export interface DevUsersListRequest {
|
|
|
3075
3397
|
* iteration starts from the beginning.
|
|
3076
3398
|
*/
|
|
3077
3399
|
cursor?: string;
|
|
3400
|
+
/** Filters for custom fields. */
|
|
3401
|
+
custom_fields?: object;
|
|
3078
3402
|
/** Filters Dev users based on email addresses. */
|
|
3079
3403
|
email?: string[];
|
|
3080
3404
|
/** Filters Dev users based on external identity. */
|
|
@@ -3135,6 +3459,16 @@ export interface DevUsersSelfResponse {
|
|
|
3135
3459
|
* user.
|
|
3136
3460
|
*/
|
|
3137
3461
|
export interface DevUsersSelfUpdateRequest {
|
|
3462
|
+
/** Application-defined custom fields. */
|
|
3463
|
+
custom_fields?: object;
|
|
3464
|
+
/**
|
|
3465
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
3466
|
+
* custom field must be specified, otherwise a bad request error is
|
|
3467
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
3468
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
3469
|
+
* specifier, it remains unmodified.
|
|
3470
|
+
*/
|
|
3471
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3138
3472
|
/** The updated display name of the Dev user. */
|
|
3139
3473
|
display_name?: string;
|
|
3140
3474
|
/**
|
|
@@ -3182,6 +3516,16 @@ export interface DevUsersUpdateJobHistoryItem {
|
|
|
3182
3516
|
* provided Dev user.
|
|
3183
3517
|
*/
|
|
3184
3518
|
export interface DevUsersUpdateRequest {
|
|
3519
|
+
/** Application-defined custom fields. */
|
|
3520
|
+
custom_fields?: object;
|
|
3521
|
+
/**
|
|
3522
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
3523
|
+
* custom field must be specified, otherwise a bad request error is
|
|
3524
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
3525
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
3526
|
+
* specifier, it remains unmodified.
|
|
3527
|
+
*/
|
|
3528
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3185
3529
|
/** The updated display name of the Dev user. */
|
|
3186
3530
|
display_name?: string;
|
|
3187
3531
|
/**
|
|
@@ -3206,34 +3550,224 @@ export interface DevUsersUpdateRequest {
|
|
|
3206
3550
|
export interface DevUsersUpdateResponse {
|
|
3207
3551
|
dev_user: DevUser;
|
|
3208
3552
|
}
|
|
3209
|
-
/**
|
|
3210
|
-
export
|
|
3553
|
+
/** directories-count-request */
|
|
3554
|
+
export interface DirectoriesCountRequest {
|
|
3555
|
+
/**
|
|
3556
|
+
* Filters for directories created by any of the provided users.
|
|
3557
|
+
* @example ["DEVU-12345"]
|
|
3558
|
+
*/
|
|
3559
|
+
created_by?: string[];
|
|
3560
|
+
/**
|
|
3561
|
+
* Filters for directories modified by any of the provided users.
|
|
3562
|
+
* @example ["DEVU-12345"]
|
|
3563
|
+
*/
|
|
3564
|
+
modified_by?: string[];
|
|
3565
|
+
}
|
|
3566
|
+
/** directories-count-response */
|
|
3567
|
+
export interface DirectoriesCountResponse {
|
|
3568
|
+
/**
|
|
3569
|
+
* The total number of directories matching the filter.
|
|
3570
|
+
* @format int32
|
|
3571
|
+
*/
|
|
3572
|
+
count: number;
|
|
3573
|
+
}
|
|
3211
3574
|
/**
|
|
3212
|
-
*
|
|
3213
|
-
*
|
|
3575
|
+
* directories-create-request
|
|
3576
|
+
* The request to create a directory.
|
|
3214
3577
|
*/
|
|
3215
|
-
export
|
|
3578
|
+
export interface DirectoriesCreateRequest {
|
|
3579
|
+
/** Description for the directory. */
|
|
3580
|
+
description?: string;
|
|
3581
|
+
/** Icon for the directory. */
|
|
3582
|
+
icon?: string;
|
|
3583
|
+
/** Parent directory of the directory. */
|
|
3584
|
+
parent?: string;
|
|
3585
|
+
/** Whether the directory is published. */
|
|
3586
|
+
published?: boolean;
|
|
3587
|
+
/** Tags associated with the directory. */
|
|
3588
|
+
tags?: SetTagWithValue[];
|
|
3589
|
+
/**
|
|
3590
|
+
* ID of the thumbnail artifact.
|
|
3591
|
+
* @example "ARTIFACT-12345"
|
|
3592
|
+
*/
|
|
3593
|
+
thumbnail?: string;
|
|
3594
|
+
/** Title of the directory. */
|
|
3595
|
+
title: string;
|
|
3596
|
+
}
|
|
3216
3597
|
/**
|
|
3217
|
-
*
|
|
3218
|
-
*
|
|
3219
|
-
* filter.
|
|
3598
|
+
* directories-create-response
|
|
3599
|
+
* Create directory response.
|
|
3220
3600
|
*/
|
|
3221
|
-
export
|
|
3222
|
-
|
|
3223
|
-
export interface EmailInfo {
|
|
3224
|
-
/** The email address. */
|
|
3225
|
-
address: string;
|
|
3226
|
-
/** The email recipient's name. */
|
|
3227
|
-
name?: string;
|
|
3228
|
-
user?: UserSummary;
|
|
3601
|
+
export interface DirectoriesCreateResponse {
|
|
3602
|
+
directory: Directory;
|
|
3229
3603
|
}
|
|
3230
|
-
/**
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3604
|
+
/**
|
|
3605
|
+
* directories-delete-request
|
|
3606
|
+
* The request to delete a directory.
|
|
3607
|
+
*/
|
|
3608
|
+
export interface DirectoriesDeleteRequest {
|
|
3609
|
+
/** The ID of the directory to delete. */
|
|
3610
|
+
id: string;
|
|
3235
3611
|
}
|
|
3236
|
-
/**
|
|
3612
|
+
/** directories-delete-response */
|
|
3613
|
+
export type DirectoriesDeleteResponse = object;
|
|
3614
|
+
/**
|
|
3615
|
+
* directories-get-request
|
|
3616
|
+
* The request to get a directory.
|
|
3617
|
+
*/
|
|
3618
|
+
export interface DirectoriesGetRequest {
|
|
3619
|
+
/** The ID of the requested directory. */
|
|
3620
|
+
id: string;
|
|
3621
|
+
}
|
|
3622
|
+
/**
|
|
3623
|
+
* directories-get-response
|
|
3624
|
+
* Get directory response.
|
|
3625
|
+
*/
|
|
3626
|
+
export interface DirectoriesGetResponse {
|
|
3627
|
+
directory: Directory;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
* directories-list-request
|
|
3631
|
+
* The request to list directories.
|
|
3632
|
+
*/
|
|
3633
|
+
export interface DirectoriesListRequest {
|
|
3634
|
+
/**
|
|
3635
|
+
* Filters for directories created by any of the provided users.
|
|
3636
|
+
* @example ["DEVU-12345"]
|
|
3637
|
+
*/
|
|
3638
|
+
created_by?: string[];
|
|
3639
|
+
/**
|
|
3640
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3641
|
+
* iteration starts from the beginning.
|
|
3642
|
+
*/
|
|
3643
|
+
cursor?: string;
|
|
3644
|
+
/**
|
|
3645
|
+
* The maximum number of directories to return. The default is '50'.
|
|
3646
|
+
* @format int32
|
|
3647
|
+
*/
|
|
3648
|
+
limit?: number;
|
|
3649
|
+
/**
|
|
3650
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3651
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3652
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3653
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3654
|
+
* always be returned in the specified sort-by order.
|
|
3655
|
+
*/
|
|
3656
|
+
mode?: ListMode;
|
|
3657
|
+
/**
|
|
3658
|
+
* Filters for directories modified by any of the provided users.
|
|
3659
|
+
* @example ["DEVU-12345"]
|
|
3660
|
+
*/
|
|
3661
|
+
modified_by?: string[];
|
|
3662
|
+
}
|
|
3663
|
+
/**
|
|
3664
|
+
* directories-list-response
|
|
3665
|
+
* List directory response.
|
|
3666
|
+
*/
|
|
3667
|
+
export interface DirectoriesListResponse {
|
|
3668
|
+
/** The list of directories. */
|
|
3669
|
+
directories: Directory[];
|
|
3670
|
+
/**
|
|
3671
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3672
|
+
* sort order. If not set, then no later elements exist.
|
|
3673
|
+
*/
|
|
3674
|
+
next_cursor?: string;
|
|
3675
|
+
/**
|
|
3676
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3677
|
+
* sort order. If not set, then no prior elements exist.
|
|
3678
|
+
*/
|
|
3679
|
+
prev_cursor?: string;
|
|
3680
|
+
}
|
|
3681
|
+
/**
|
|
3682
|
+
* directories-update-request
|
|
3683
|
+
* The request to update a directory.
|
|
3684
|
+
*/
|
|
3685
|
+
export interface DirectoriesUpdateRequest {
|
|
3686
|
+
/** The updated description for the directory. */
|
|
3687
|
+
description?: string;
|
|
3688
|
+
/** The updated icon for the directory. */
|
|
3689
|
+
icon?: string;
|
|
3690
|
+
/** The ID of the directory to update. */
|
|
3691
|
+
id: string;
|
|
3692
|
+
/** The updated parent directory for the directory. */
|
|
3693
|
+
parent?: string | null;
|
|
3694
|
+
/** Whether the directory is published. */
|
|
3695
|
+
published?: boolean;
|
|
3696
|
+
reorder?: DirectoriesUpdateRequestReorder;
|
|
3697
|
+
tags?: DirectoriesUpdateRequestTags;
|
|
3698
|
+
/**
|
|
3699
|
+
* ID of the thumbnail artifact.
|
|
3700
|
+
* @example "ARTIFACT-12345"
|
|
3701
|
+
*/
|
|
3702
|
+
thumbnail?: string;
|
|
3703
|
+
/** The updated title for the directory. */
|
|
3704
|
+
title?: string;
|
|
3705
|
+
}
|
|
3706
|
+
/** directories-update-request-reorder */
|
|
3707
|
+
export interface DirectoriesUpdateRequestReorder {
|
|
3708
|
+
/** The directory after which the reordered directory is placed. */
|
|
3709
|
+
after?: string;
|
|
3710
|
+
/** The directory before which the reordered directory is placed. */
|
|
3711
|
+
before?: string;
|
|
3712
|
+
}
|
|
3713
|
+
/** directories-update-request-tags */
|
|
3714
|
+
export interface DirectoriesUpdateRequestTags {
|
|
3715
|
+
/** Sets the provided tags on the directory. */
|
|
3716
|
+
set?: SetTagWithValue[];
|
|
3717
|
+
}
|
|
3718
|
+
/**
|
|
3719
|
+
* directories-update-response
|
|
3720
|
+
* Update directory response.
|
|
3721
|
+
*/
|
|
3722
|
+
export interface DirectoriesUpdateResponse {
|
|
3723
|
+
directory: Directory;
|
|
3724
|
+
}
|
|
3725
|
+
/** directory */
|
|
3726
|
+
export type Directory = AtomBase & {
|
|
3727
|
+
body?: ArtifactSummary;
|
|
3728
|
+
/** Description of the directory. */
|
|
3729
|
+
description?: string;
|
|
3730
|
+
/** Icon of the directory. */
|
|
3731
|
+
icon?: string;
|
|
3732
|
+
parent?: DirectorySummary;
|
|
3733
|
+
/** Whether the directory is published. */
|
|
3734
|
+
published?: boolean;
|
|
3735
|
+
/** Rank of the directory. */
|
|
3736
|
+
rank?: string;
|
|
3737
|
+
/** Tags associated with the directory. */
|
|
3738
|
+
tags?: TagWithValue[];
|
|
3739
|
+
thumbnail?: ArtifactSummary;
|
|
3740
|
+
/** Title of the directory. */
|
|
3741
|
+
title?: string;
|
|
3742
|
+
};
|
|
3743
|
+
/** directory-summary */
|
|
3744
|
+
export type DirectorySummary = AtomBaseSummary;
|
|
3745
|
+
/**
|
|
3746
|
+
* dynamic-group-info
|
|
3747
|
+
* Information to define dynamic groups.
|
|
3748
|
+
*/
|
|
3749
|
+
export type DynamicGroupInfo = object;
|
|
3750
|
+
/**
|
|
3751
|
+
* dynamic-vista-summary
|
|
3752
|
+
* Dynamic collection of Devrev objects, all adhering to a specific
|
|
3753
|
+
* filter.
|
|
3754
|
+
*/
|
|
3755
|
+
export type DynamicVistaSummary = VistaBaseSummary;
|
|
3756
|
+
/** email-info */
|
|
3757
|
+
export interface EmailInfo {
|
|
3758
|
+
/** The email address. */
|
|
3759
|
+
address: string;
|
|
3760
|
+
/** The email recipient's name. */
|
|
3761
|
+
name?: string;
|
|
3762
|
+
user?: UserSummary;
|
|
3763
|
+
}
|
|
3764
|
+
/** email-inline-attachment */
|
|
3765
|
+
export interface EmailInlineAttachment {
|
|
3766
|
+
artifact?: ArtifactSummary;
|
|
3767
|
+
/** The content id of the attachment. */
|
|
3768
|
+
content_id?: string;
|
|
3769
|
+
}
|
|
3770
|
+
/** email-preview-widget */
|
|
3237
3771
|
export type EmailPreviewWidget = SnapWidgetBase & {
|
|
3238
3772
|
/** The list of bcc addresses. */
|
|
3239
3773
|
bcc: EmailInfo[];
|
|
@@ -3342,7 +3876,13 @@ export interface EngagementsCreateRequest {
|
|
|
3342
3876
|
* Currently, only accounts and opportunities are supported.
|
|
3343
3877
|
* @example "ACC-12345"
|
|
3344
3878
|
*/
|
|
3345
|
-
parent
|
|
3879
|
+
parent?: string;
|
|
3880
|
+
/**
|
|
3881
|
+
* The parent object IDs to which the engagement is associated.
|
|
3882
|
+
* Currently, only accounts and opportunities are supported.
|
|
3883
|
+
* @example ["ACC-12345"]
|
|
3884
|
+
*/
|
|
3885
|
+
parents?: string[];
|
|
3346
3886
|
/**
|
|
3347
3887
|
* The date and time when the engagement was scheduled.
|
|
3348
3888
|
* @format date-time
|
|
@@ -3446,6 +3986,7 @@ export interface EngagementsUpdateRequest {
|
|
|
3446
3986
|
/** The engagement ID. */
|
|
3447
3987
|
id: string;
|
|
3448
3988
|
members?: EngagementsUpdateRequestMembers;
|
|
3989
|
+
parents?: EngagementsUpdateRequestParents;
|
|
3449
3990
|
/**
|
|
3450
3991
|
* Updates the date and time when the engagement was scheduled.
|
|
3451
3992
|
* @format date-time
|
|
@@ -3474,6 +4015,15 @@ export interface EngagementsUpdateRequestMembers {
|
|
|
3474
4015
|
*/
|
|
3475
4016
|
set?: string[];
|
|
3476
4017
|
}
|
|
4018
|
+
/** engagements-update-request-parents */
|
|
4019
|
+
export interface EngagementsUpdateRequestParents {
|
|
4020
|
+
/**
|
|
4021
|
+
* Sets the parent IDs.
|
|
4022
|
+
* @maxItems 50
|
|
4023
|
+
* @example ["ACC-12345"]
|
|
4024
|
+
*/
|
|
4025
|
+
set?: string[];
|
|
4026
|
+
}
|
|
3477
4027
|
/** engagements-update-request-tags */
|
|
3478
4028
|
export interface EngagementsUpdateRequestTags {
|
|
3479
4029
|
/** Sets the provided tags on the engagement item. */
|
|
@@ -3816,6 +4366,11 @@ export interface EventDevUserUpdated {
|
|
|
3816
4366
|
dev_user: DevUser;
|
|
3817
4367
|
old_dev_user?: DevUser;
|
|
3818
4368
|
}
|
|
4369
|
+
export declare enum EventFetchedResult {
|
|
4370
|
+
Forbidden = "forbidden",
|
|
4371
|
+
NotFound = "not_found",
|
|
4372
|
+
Ok = "ok"
|
|
4373
|
+
}
|
|
3819
4374
|
/** event-group-created */
|
|
3820
4375
|
export interface EventGroupCreated {
|
|
3821
4376
|
group: Group;
|
|
@@ -4105,11 +4660,48 @@ export interface EventWorkDeleted {
|
|
|
4105
4660
|
id: string;
|
|
4106
4661
|
old_work?: Work;
|
|
4107
4662
|
}
|
|
4663
|
+
/** event-work-fetched */
|
|
4664
|
+
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
4665
|
+
/**
|
|
4666
|
+
* The ID of the work that was fetched.
|
|
4667
|
+
* @example "ISS-12345"
|
|
4668
|
+
*/
|
|
4669
|
+
id: string;
|
|
4670
|
+
result: EventFetchedResult;
|
|
4671
|
+
};
|
|
4672
|
+
/** event-work-fetched-ok */
|
|
4673
|
+
export interface EventWorkFetchedOk {
|
|
4674
|
+
work?: Work;
|
|
4675
|
+
}
|
|
4108
4676
|
/** event-work-updated */
|
|
4109
4677
|
export interface EventWorkUpdated {
|
|
4110
4678
|
old_work?: Work;
|
|
4111
4679
|
work: Work;
|
|
4112
4680
|
}
|
|
4681
|
+
/**
|
|
4682
|
+
* export-audit-logs-request
|
|
4683
|
+
* Request object to get a log's information.
|
|
4684
|
+
*/
|
|
4685
|
+
export interface ExportAuditLogsRequest {
|
|
4686
|
+
/**
|
|
4687
|
+
* Time from which logs are to be retrieved.
|
|
4688
|
+
* @format date-time
|
|
4689
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4690
|
+
*/
|
|
4691
|
+
from: string;
|
|
4692
|
+
/**
|
|
4693
|
+
* Time till which logs are to be retrieved.
|
|
4694
|
+
* @format date-time
|
|
4695
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4696
|
+
*/
|
|
4697
|
+
to: string;
|
|
4698
|
+
}
|
|
4699
|
+
/**
|
|
4700
|
+
* export-audit-logs-response
|
|
4701
|
+
* Response for the audit logs export request. Response is empty as the
|
|
4702
|
+
* process is asynchronous. Upon completion, the user will be notified.
|
|
4703
|
+
*/
|
|
4704
|
+
export type ExportAuditLogsResponse = object;
|
|
4113
4705
|
/**
|
|
4114
4706
|
* external-identity
|
|
4115
4707
|
* External identity of a user.
|
|
@@ -4274,7 +4866,10 @@ export interface GeneralPreferencesGroup {
|
|
|
4274
4866
|
/** Preferred locale of the user. */
|
|
4275
4867
|
export declare enum GeneralPreferencesGroupPreferredLocale {
|
|
4276
4868
|
EnUs = "en_us",
|
|
4277
|
-
|
|
4869
|
+
EsAr = "es_ar",
|
|
4870
|
+
JaJp = "ja_jp",
|
|
4871
|
+
NlAw = "nl_aw",
|
|
4872
|
+
NlSx = "nl_sx"
|
|
4278
4873
|
}
|
|
4279
4874
|
/** Event type of the notification. */
|
|
4280
4875
|
export declare enum GenericNotificationEventType {
|
|
@@ -4284,6 +4879,21 @@ export declare enum GenericNotificationEventType {
|
|
|
4284
4879
|
Reminder = "reminder",
|
|
4285
4880
|
Update = "update"
|
|
4286
4881
|
}
|
|
4882
|
+
/**
|
|
4883
|
+
* get-rev-users-personal-data-request
|
|
4884
|
+
* Request object to get a contact's information.
|
|
4885
|
+
*/
|
|
4886
|
+
export interface GetRevUsersPersonalDataRequest {
|
|
4887
|
+
/** Email of the contact. */
|
|
4888
|
+
email: string;
|
|
4889
|
+
}
|
|
4890
|
+
/**
|
|
4891
|
+
* get-rev-users-personal-data-response
|
|
4892
|
+
* Response for the contacts personal data export request. Response is
|
|
4893
|
+
* empty as the process is asynchronous. Upon completion, the user will be
|
|
4894
|
+
* notified.
|
|
4895
|
+
*/
|
|
4896
|
+
export type GetRevUsersPersonalDataResponse = object;
|
|
4287
4897
|
/** group */
|
|
4288
4898
|
export type Group = AtomBase & {
|
|
4289
4899
|
/** Description of the group. */
|
|
@@ -4295,6 +4905,8 @@ export type Group = AtomBase & {
|
|
|
4295
4905
|
/** Name of the group. */
|
|
4296
4906
|
name?: string;
|
|
4297
4907
|
owner?: UserSummary;
|
|
4908
|
+
/** Mixin for storing sync metadata. */
|
|
4909
|
+
sync_metadata?: SyncMetadata;
|
|
4298
4910
|
};
|
|
4299
4911
|
/** Creation source of the group. */
|
|
4300
4912
|
export declare enum GroupIngestionSource {
|
|
@@ -4555,6 +5167,12 @@ export type Incident = AtomBase & {
|
|
|
4555
5167
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4556
5168
|
*/
|
|
4557
5169
|
acknowledged_date?: string;
|
|
5170
|
+
/**
|
|
5171
|
+
* Timestamp when the incident was actually resolved.
|
|
5172
|
+
* @format date-time
|
|
5173
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5174
|
+
*/
|
|
5175
|
+
actual_close_date?: string;
|
|
4558
5176
|
/** Parts to which the incident is applicable to. */
|
|
4559
5177
|
applies_to_parts?: PartSummary[];
|
|
4560
5178
|
/** Artifacts attached to the incident. */
|
|
@@ -4586,6 +5204,10 @@ export type Incident = AtomBase & {
|
|
|
4586
5204
|
mitigated_date?: string;
|
|
4587
5205
|
/** The users that own the incident. */
|
|
4588
5206
|
owned_by?: UserSummary[];
|
|
5207
|
+
/** The article ids of the Post-Incident Analysis(PIA) of the incident. */
|
|
5208
|
+
pia?: ArticleSummary[];
|
|
5209
|
+
/** The article ids of the playbook(s) associated with the incident. */
|
|
5210
|
+
playbooks?: ArticleSummary[];
|
|
4589
5211
|
/** The properties of an enum value. */
|
|
4590
5212
|
reported_by?: EnumValue;
|
|
4591
5213
|
/** The properties of an enum value. */
|
|
@@ -4661,6 +5283,12 @@ export interface IncidentsCreateRequest {
|
|
|
4661
5283
|
mitigated_date?: string;
|
|
4662
5284
|
/** User IDs of the users that own the incident. */
|
|
4663
5285
|
owned_by?: string[];
|
|
5286
|
+
/** The article ids of the Post-Incident Analysis(PIA) of the incident. */
|
|
5287
|
+
pia?: string[];
|
|
5288
|
+
/** The article ids of the playbook(s) associated with the incident. */
|
|
5289
|
+
playbooks?: string[];
|
|
5290
|
+
/** The article ids of other documents associated with the incident. */
|
|
5291
|
+
related_docs?: string[];
|
|
4664
5292
|
/**
|
|
4665
5293
|
* The entity that first reported the incident.
|
|
4666
5294
|
* @format int64
|
|
@@ -4725,8 +5353,7 @@ export interface IncidentsGetResponse {
|
|
|
4725
5353
|
export interface IncidentsGroup {
|
|
4726
5354
|
/** The group of incidents. */
|
|
4727
5355
|
incidents: Incident[];
|
|
4728
|
-
|
|
4729
|
-
key: string;
|
|
5356
|
+
key: FieldValue;
|
|
4730
5357
|
/**
|
|
4731
5358
|
* The cursor used to iterate subsequent results in accordance to the
|
|
4732
5359
|
* sort order. If not set, then no later elements exist.
|
|
@@ -4788,6 +5415,21 @@ export interface IncidentsGroupRequest {
|
|
|
4788
5415
|
modified_date?: DateFilter;
|
|
4789
5416
|
/** Filters for incidents owned by any of the provided users. */
|
|
4790
5417
|
owned_by?: string[];
|
|
5418
|
+
/**
|
|
5419
|
+
* Filters for incidents with any of the provided PIAs.
|
|
5420
|
+
* @example ["ARTICLE-12345"]
|
|
5421
|
+
*/
|
|
5422
|
+
pia?: string[];
|
|
5423
|
+
/**
|
|
5424
|
+
* Filters for incidents with any of the provided playbooks.
|
|
5425
|
+
* @example ["ARTICLE-12345"]
|
|
5426
|
+
*/
|
|
5427
|
+
playbook?: string[];
|
|
5428
|
+
/**
|
|
5429
|
+
* Filters for incidents with any of the provided related docs.
|
|
5430
|
+
* @example ["ARTICLE-12345"]
|
|
5431
|
+
*/
|
|
5432
|
+
related_docs?: string[];
|
|
4791
5433
|
/** Filters for incidents with any of the provided reporters. */
|
|
4792
5434
|
reported_by?: number[];
|
|
4793
5435
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -4859,6 +5501,21 @@ export interface IncidentsListRequest {
|
|
|
4859
5501
|
modified_date?: DateFilter;
|
|
4860
5502
|
/** Filters for incidents owned by any of the provided users. */
|
|
4861
5503
|
owned_by?: string[];
|
|
5504
|
+
/**
|
|
5505
|
+
* Filters for incidents with any of the provided PIAs.
|
|
5506
|
+
* @example ["ARTICLE-12345"]
|
|
5507
|
+
*/
|
|
5508
|
+
pia?: string[];
|
|
5509
|
+
/**
|
|
5510
|
+
* Filters for incidents with any of the provided playbooks.
|
|
5511
|
+
* @example ["ARTICLE-12345"]
|
|
5512
|
+
*/
|
|
5513
|
+
playbook?: string[];
|
|
5514
|
+
/**
|
|
5515
|
+
* Filters for incidents with any of the provided related docs.
|
|
5516
|
+
* @example ["ARTICLE-12345"]
|
|
5517
|
+
*/
|
|
5518
|
+
related_docs?: string[];
|
|
4862
5519
|
/** Filters for incidents with any of the provided reporters. */
|
|
4863
5520
|
reported_by?: number[];
|
|
4864
5521
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -4928,6 +5585,9 @@ export interface IncidentsUpdateRequest {
|
|
|
4928
5585
|
*/
|
|
4929
5586
|
mitigated_date?: string;
|
|
4930
5587
|
owned_by?: UpdateIncidentOwnedBy;
|
|
5588
|
+
pia?: UpdateIncidentPia;
|
|
5589
|
+
playbooks?: UpdateIncidentPlaybooks;
|
|
5590
|
+
related_docs?: UpdateIncidentRelatedDocs;
|
|
4931
5591
|
/**
|
|
4932
5592
|
* The entity that first reported the incident.
|
|
4933
5593
|
* @format int64
|
|
@@ -5089,6 +5749,11 @@ export type Link = AtomBase & {
|
|
|
5089
5749
|
source: LinkEndpointSummary;
|
|
5090
5750
|
target: LinkEndpointSummary;
|
|
5091
5751
|
};
|
|
5752
|
+
/** link-descriptor-filter */
|
|
5753
|
+
export interface LinkDescriptorFilter {
|
|
5754
|
+
/** List of link descriptors. */
|
|
5755
|
+
link_descriptors: LinkTargetDescriptor[];
|
|
5756
|
+
}
|
|
5092
5757
|
/** link-endpoint-summary */
|
|
5093
5758
|
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
5094
5759
|
type: LinkEndpointType;
|
|
@@ -5148,6 +5813,11 @@ export type LinkSummary = AtomBaseSummary & {
|
|
|
5148
5813
|
source: LinkEndpointSummary;
|
|
5149
5814
|
target: LinkEndpointSummary;
|
|
5150
5815
|
};
|
|
5816
|
+
/**
|
|
5817
|
+
* link-target-descriptor
|
|
5818
|
+
* A link target descriptor.
|
|
5819
|
+
*/
|
|
5820
|
+
export type LinkTargetDescriptor = object;
|
|
5151
5821
|
/** Type of link used to define the relationship. */
|
|
5152
5822
|
export declare enum LinkType {
|
|
5153
5823
|
CustomLink = "custom_link",
|
|
@@ -5157,6 +5827,7 @@ export declare enum LinkType {
|
|
|
5157
5827
|
IsConvertedTo = "is_converted_to",
|
|
5158
5828
|
IsDependentOn = "is_dependent_on",
|
|
5159
5829
|
IsDuplicateOf = "is_duplicate_of",
|
|
5830
|
+
IsFollowUpOf = "is_follow_up_of",
|
|
5160
5831
|
IsMergedInto = "is_merged_into",
|
|
5161
5832
|
IsParentOf = "is_parent_of",
|
|
5162
5833
|
IsPartOf = "is_part_of",
|
|
@@ -5308,6 +5979,32 @@ export declare enum MemberType {
|
|
|
5308
5979
|
RevUser = "rev_user",
|
|
5309
5980
|
SysUser = "sys_user"
|
|
5310
5981
|
}
|
|
5982
|
+
/** metric-action-execute-request */
|
|
5983
|
+
export interface MetricActionExecuteRequest {
|
|
5984
|
+
action: MetricActionExecuteRequestAction;
|
|
5985
|
+
/**
|
|
5986
|
+
* Timestamp of the event.
|
|
5987
|
+
* @format date-time
|
|
5988
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5989
|
+
*/
|
|
5990
|
+
event_date: string;
|
|
5991
|
+
/** The metric's ID for which the metric action is to be executed. */
|
|
5992
|
+
metric: string;
|
|
5993
|
+
/**
|
|
5994
|
+
* The underlying object's ID on which the metric action is to be
|
|
5995
|
+
* executed.
|
|
5996
|
+
*/
|
|
5997
|
+
object: string;
|
|
5998
|
+
}
|
|
5999
|
+
export declare enum MetricActionExecuteRequestAction {
|
|
6000
|
+
Complete = "complete",
|
|
6001
|
+
Pause = "pause",
|
|
6002
|
+
Restart = "restart",
|
|
6003
|
+
Resume = "resume",
|
|
6004
|
+
Start = "start"
|
|
6005
|
+
}
|
|
6006
|
+
/** metric-action-execute-response */
|
|
6007
|
+
export type MetricActionExecuteResponse = object;
|
|
5311
6008
|
/** metric-data-point */
|
|
5312
6009
|
export interface MetricDataPoint {
|
|
5313
6010
|
/**
|
|
@@ -5387,6 +6084,51 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
5387
6084
|
/** Human readable name of the metric. */
|
|
5388
6085
|
name?: string;
|
|
5389
6086
|
};
|
|
6087
|
+
/** metric-definitions-create-request */
|
|
6088
|
+
export interface MetricDefinitionsCreateRequest {
|
|
6089
|
+
/** The list of object types on which the metric can be applied. */
|
|
6090
|
+
applies_to: MetricDefinitionAppliesTo[];
|
|
6091
|
+
/**
|
|
6092
|
+
* Description of the purpose and operation of the metric.
|
|
6093
|
+
* @maxLength 1024
|
|
6094
|
+
*/
|
|
6095
|
+
description?: string;
|
|
6096
|
+
/**
|
|
6097
|
+
* A unique human readable name of the metric.
|
|
6098
|
+
* @minLength 1
|
|
6099
|
+
* @maxLength 64
|
|
6100
|
+
*/
|
|
6101
|
+
name: string;
|
|
6102
|
+
}
|
|
6103
|
+
/** metric-definitions-create-response */
|
|
6104
|
+
export interface MetricDefinitionsCreateResponse {
|
|
6105
|
+
metric_definition: MetricDefinition;
|
|
6106
|
+
}
|
|
6107
|
+
/** metric-definitions-delete-request */
|
|
6108
|
+
export interface MetricDefinitionsDeleteRequest {
|
|
6109
|
+
/** The ID of the metric definition to be deleted. */
|
|
6110
|
+
id: string;
|
|
6111
|
+
}
|
|
6112
|
+
/**
|
|
6113
|
+
* metric-definitions-delete-response
|
|
6114
|
+
* The response to deleting a metric definition.
|
|
6115
|
+
*/
|
|
6116
|
+
export type MetricDefinitionsDeleteResponse = object;
|
|
6117
|
+
/** metric-definitions-get-request */
|
|
6118
|
+
export interface MetricDefinitionsGetRequest {
|
|
6119
|
+
/** The ID of the metric definition to get. */
|
|
6120
|
+
id?: string;
|
|
6121
|
+
/**
|
|
6122
|
+
* The unique human readable name of the metric.
|
|
6123
|
+
* @minLength 1
|
|
6124
|
+
* @maxLength 64
|
|
6125
|
+
*/
|
|
6126
|
+
name?: string;
|
|
6127
|
+
}
|
|
6128
|
+
/** metric-definitions-get-response */
|
|
6129
|
+
export interface MetricDefinitionsGetResponse {
|
|
6130
|
+
metric_definition: MetricDefinition;
|
|
6131
|
+
}
|
|
5390
6132
|
/** metric-definitions-list-request */
|
|
5391
6133
|
export interface MetricDefinitionsListRequest {
|
|
5392
6134
|
/** The type of metric definitions sought. */
|
|
@@ -5434,6 +6176,32 @@ export interface MetricDefinitionsListResponse {
|
|
|
5434
6176
|
*/
|
|
5435
6177
|
prev_cursor?: string;
|
|
5436
6178
|
}
|
|
6179
|
+
/** metric-definitions-update-request */
|
|
6180
|
+
export interface MetricDefinitionsUpdateRequest {
|
|
6181
|
+
/**
|
|
6182
|
+
* The updated description of the purpose and operation of the metric.
|
|
6183
|
+
* @maxLength 1024
|
|
6184
|
+
*/
|
|
6185
|
+
description?: string;
|
|
6186
|
+
/** The ID of the metric definition to update. */
|
|
6187
|
+
id: string;
|
|
6188
|
+
/**
|
|
6189
|
+
* The updated unique human readable name of the metric.
|
|
6190
|
+
* @minLength 1
|
|
6191
|
+
* @maxLength 64
|
|
6192
|
+
*/
|
|
6193
|
+
name?: string;
|
|
6194
|
+
/**
|
|
6195
|
+
* The status of the metric. 'active' metrics can be used to create new
|
|
6196
|
+
* SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
|
|
6197
|
+
* be updated between 'active' and 'inactive' states.
|
|
6198
|
+
*/
|
|
6199
|
+
status?: MetricDefinitionStatus;
|
|
6200
|
+
}
|
|
6201
|
+
/** metric-definitions-update-response */
|
|
6202
|
+
export interface MetricDefinitionsUpdateResponse {
|
|
6203
|
+
metric_definition: MetricDefinition;
|
|
6204
|
+
}
|
|
5437
6205
|
/** metrics-data */
|
|
5438
6206
|
export interface MetricsData {
|
|
5439
6207
|
/**
|
|
@@ -6959,6 +7727,25 @@ export interface RevUsersListResponse {
|
|
|
6959
7727
|
/** List containing all the Rev users. */
|
|
6960
7728
|
rev_users: RevUser[];
|
|
6961
7729
|
}
|
|
7730
|
+
/**
|
|
7731
|
+
* rev-users-merge-request
|
|
7732
|
+
* Request to merge two Rev users, retaining the primary user.
|
|
7733
|
+
*/
|
|
7734
|
+
export interface RevUsersMergeRequest {
|
|
7735
|
+
/** The ID of the primary Rev user, which will be retained. */
|
|
7736
|
+
primary_user: string;
|
|
7737
|
+
/**
|
|
7738
|
+
* The ID of the secondary Rev user, which will be merged into the
|
|
7739
|
+
* Primary Rev user.
|
|
7740
|
+
*/
|
|
7741
|
+
secondary_user: string;
|
|
7742
|
+
}
|
|
7743
|
+
/**
|
|
7744
|
+
* rev-users-merge-response
|
|
7745
|
+
* Acknowledgment response indicating that the merge request has been
|
|
7746
|
+
* received for processing asynchronously.
|
|
7747
|
+
*/
|
|
7748
|
+
export type RevUsersMergeResponse = object;
|
|
6962
7749
|
/**
|
|
6963
7750
|
* rev-users-scan-request
|
|
6964
7751
|
* Scans the list of Rev users.
|
|
@@ -7843,7 +8630,15 @@ export interface SetOrgScheduleFragmentSummary {
|
|
|
7843
8630
|
* set-shared-with-membership
|
|
7844
8631
|
* Information about the role the member receives due to the share.
|
|
7845
8632
|
*/
|
|
7846
|
-
export
|
|
8633
|
+
export interface SetSharedWithMembership {
|
|
8634
|
+
/** ID of the member the object is shared with. */
|
|
8635
|
+
member?: string;
|
|
8636
|
+
/**
|
|
8637
|
+
* ID of the role that describes what privileges the membership
|
|
8638
|
+
* entails.
|
|
8639
|
+
*/
|
|
8640
|
+
role?: string;
|
|
8641
|
+
}
|
|
7847
8642
|
/** set-sla-policy */
|
|
7848
8643
|
export interface SetSlaPolicy {
|
|
7849
8644
|
/** Metrics to apply to the selected items. */
|
|
@@ -7952,7 +8747,12 @@ export interface SetWeeklyOrgSchedule {
|
|
|
7952
8747
|
* shared-with-membership-filter
|
|
7953
8748
|
* Filter on target item based on intended audience.
|
|
7954
8749
|
*/
|
|
7955
|
-
export
|
|
8750
|
+
export interface SharedWithMembershipFilter {
|
|
8751
|
+
/** ID of the group/member with whom the item is shared. */
|
|
8752
|
+
member?: string;
|
|
8753
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
8754
|
+
role?: string;
|
|
8755
|
+
}
|
|
7956
8756
|
/** sla */
|
|
7957
8757
|
export type Sla = AtomBase & {
|
|
7958
8758
|
/**
|
|
@@ -8128,6 +8928,48 @@ export interface SlaTrackersGetRequest {
|
|
|
8128
8928
|
export interface SlaTrackersGetResponse {
|
|
8129
8929
|
sla_tracker: SlaTracker;
|
|
8130
8930
|
}
|
|
8931
|
+
/** sla-trackers-list-request */
|
|
8932
|
+
export interface SlaTrackersListRequest {
|
|
8933
|
+
created_date?: DateTimeFilter;
|
|
8934
|
+
/**
|
|
8935
|
+
* The cursor to resume iteration from. If not provided, then
|
|
8936
|
+
* iteration starts from the beginning.
|
|
8937
|
+
*/
|
|
8938
|
+
cursor?: string;
|
|
8939
|
+
/**
|
|
8940
|
+
* The maximum number of SLA trackers to return. The default is '50'.
|
|
8941
|
+
* @format int32
|
|
8942
|
+
*/
|
|
8943
|
+
limit?: number;
|
|
8944
|
+
/**
|
|
8945
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
8946
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
8947
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
8948
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
8949
|
+
* always be returned in the specified sort-by order.
|
|
8950
|
+
*/
|
|
8951
|
+
mode?: ListMode;
|
|
8952
|
+
modified_date?: DateTimeFilter;
|
|
8953
|
+
/** The SLA tracker stages the filter matches. */
|
|
8954
|
+
stage?: string[];
|
|
8955
|
+
/** The SLA tracker statuses the filter matches. */
|
|
8956
|
+
status?: string[];
|
|
8957
|
+
}
|
|
8958
|
+
/** sla-trackers-list-response */
|
|
8959
|
+
export interface SlaTrackersListResponse {
|
|
8960
|
+
/**
|
|
8961
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
8962
|
+
* sort order. If not set, then no later elements exist.
|
|
8963
|
+
*/
|
|
8964
|
+
next_cursor?: string;
|
|
8965
|
+
/**
|
|
8966
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
8967
|
+
* sort order. If not set, then no prior elements exist.
|
|
8968
|
+
*/
|
|
8969
|
+
prev_cursor?: string;
|
|
8970
|
+
/** The list of SLA trackers. */
|
|
8971
|
+
sla_trackers: SlaTracker[];
|
|
8972
|
+
}
|
|
8131
8973
|
/** Type of the SLA. */
|
|
8132
8974
|
export declare enum SlaType {
|
|
8133
8975
|
External = "external",
|
|
@@ -8540,6 +9382,8 @@ export interface SubtypesListResponse {
|
|
|
8540
9382
|
export type Survey = AtomBase & {
|
|
8541
9383
|
/** Description of the survey. */
|
|
8542
9384
|
description?: string;
|
|
9385
|
+
/** Header of the survey. */
|
|
9386
|
+
header?: string;
|
|
8543
9387
|
/** Text posted when introducing the survey to the responder. */
|
|
8544
9388
|
introductory_text?: string;
|
|
8545
9389
|
/**
|
|
@@ -8553,6 +9397,8 @@ export type Survey = AtomBase & {
|
|
|
8553
9397
|
schema?: SchemaFieldDescriptor[];
|
|
8554
9398
|
/** List of all the fields and their respective metadata in the schema. */
|
|
8555
9399
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
9400
|
+
/** Title of the survey. */
|
|
9401
|
+
title?: string;
|
|
8556
9402
|
};
|
|
8557
9403
|
/**
|
|
8558
9404
|
* survey-aggregation-filter
|
|
@@ -8593,6 +9439,8 @@ export type SurveyResponse = AtomBase & {
|
|
|
8593
9439
|
export interface SurveysCreateRequest {
|
|
8594
9440
|
/** Description about the survey. */
|
|
8595
9441
|
description?: string;
|
|
9442
|
+
/** Header of the survey. */
|
|
9443
|
+
header?: string;
|
|
8596
9444
|
/** Text posted when introducing the survey to the responder. */
|
|
8597
9445
|
introductory_text?: string;
|
|
8598
9446
|
/** The survey's name. */
|
|
@@ -8603,6 +9451,8 @@ export interface SurveysCreateRequest {
|
|
|
8603
9451
|
schema?: FieldDescriptor[];
|
|
8604
9452
|
/** The schema with metadata for the survey. */
|
|
8605
9453
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
9454
|
+
/** Title of the survey. */
|
|
9455
|
+
title?: string;
|
|
8606
9456
|
}
|
|
8607
9457
|
/** surveys-create-response */
|
|
8608
9458
|
export interface SurveysCreateResponse {
|
|
@@ -8784,7 +9634,43 @@ export interface SurveysSubmitRequest {
|
|
|
8784
9634
|
}
|
|
8785
9635
|
/** surveys-submit-response */
|
|
8786
9636
|
export type SurveysSubmitResponse = object;
|
|
8787
|
-
/**
|
|
9637
|
+
/**
|
|
9638
|
+
* sync-in
|
|
9639
|
+
* Information about the sync to DevRev.
|
|
9640
|
+
*/
|
|
9641
|
+
export interface SyncIn {
|
|
9642
|
+
/** Status of the sync for the object. */
|
|
9643
|
+
status?: SyncInStatus;
|
|
9644
|
+
/**
|
|
9645
|
+
* Timestamp when the object was synced in/from DevRev.
|
|
9646
|
+
* @format date-time
|
|
9647
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9648
|
+
*/
|
|
9649
|
+
sync_date?: string;
|
|
9650
|
+
sync_unit?: SyncUnitSummary;
|
|
9651
|
+
}
|
|
9652
|
+
/** Status of the sync for the object. */
|
|
9653
|
+
export declare enum SyncInStatus {
|
|
9654
|
+
Failed = "failed",
|
|
9655
|
+
Modified = "modified",
|
|
9656
|
+
Staged = "staged",
|
|
9657
|
+
Succeeded = "succeeded"
|
|
9658
|
+
}
|
|
9659
|
+
/**
|
|
9660
|
+
* sync-metadata
|
|
9661
|
+
* Mixin for storing sync metadata.
|
|
9662
|
+
*/
|
|
9663
|
+
export interface SyncMetadata {
|
|
9664
|
+
/** External record URL. */
|
|
9665
|
+
external_reference?: string;
|
|
9666
|
+
/** Information about the sync to DevRev. */
|
|
9667
|
+
last_sync_in?: SyncIn;
|
|
9668
|
+
/** Information about the sync to DevRev. */
|
|
9669
|
+
last_sync_out?: SyncOut;
|
|
9670
|
+
/** Where the record was first created. */
|
|
9671
|
+
origin_system?: string;
|
|
9672
|
+
}
|
|
9673
|
+
/** sync-metadata-filter */
|
|
8788
9674
|
export interface SyncMetadataFilter {
|
|
8789
9675
|
/** Filters for issues with this specific external reference. */
|
|
8790
9676
|
external_reference?: string[];
|
|
@@ -8821,6 +9707,29 @@ export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
|
8821
9707
|
Failed = "failed",
|
|
8822
9708
|
Succeeded = "succeeded"
|
|
8823
9709
|
}
|
|
9710
|
+
/**
|
|
9711
|
+
* sync-out
|
|
9712
|
+
* Information about the sync to DevRev.
|
|
9713
|
+
*/
|
|
9714
|
+
export interface SyncOut {
|
|
9715
|
+
/** Status of the sync for the object. */
|
|
9716
|
+
status?: SyncOutStatus;
|
|
9717
|
+
/**
|
|
9718
|
+
* Timestamp when the object was synced in/from DevRev.
|
|
9719
|
+
* @format date-time
|
|
9720
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9721
|
+
*/
|
|
9722
|
+
sync_date?: string;
|
|
9723
|
+
sync_unit?: SyncUnitSummary;
|
|
9724
|
+
}
|
|
9725
|
+
/** Status of the sync for the object. */
|
|
9726
|
+
export declare enum SyncOutStatus {
|
|
9727
|
+
Failed = "failed",
|
|
9728
|
+
Modified = "modified",
|
|
9729
|
+
Succeeded = "succeeded"
|
|
9730
|
+
}
|
|
9731
|
+
/** sync-unit-summary */
|
|
9732
|
+
export type SyncUnitSummary = AtomBaseSummary;
|
|
8824
9733
|
/** sys-user */
|
|
8825
9734
|
export type SysUser = UserBase;
|
|
8826
9735
|
/** sys-user-summary */
|
|
@@ -9108,6 +10017,14 @@ export type Ticket = WorkBase & {
|
|
|
9108
10017
|
rev_org?: OrgSummary;
|
|
9109
10018
|
/** The properties of an enum value. */
|
|
9110
10019
|
sentiment?: EnumValue;
|
|
10020
|
+
/**
|
|
10021
|
+
* Timestamp when the sentiment was last modified.
|
|
10022
|
+
* @format date-time
|
|
10023
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10024
|
+
*/
|
|
10025
|
+
sentiment_modified_date?: string;
|
|
10026
|
+
/** Summary justifying the sentiment. */
|
|
10027
|
+
sentiment_summary?: string;
|
|
9111
10028
|
/** Severity of the ticket. */
|
|
9112
10029
|
severity?: TicketSeverity;
|
|
9113
10030
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -9216,6 +10133,7 @@ export type TimelineComment = TimelineEntryBase & {
|
|
|
9216
10133
|
};
|
|
9217
10134
|
/** The type of the body to use for the comment. */
|
|
9218
10135
|
export declare enum TimelineCommentBodyType {
|
|
10136
|
+
Data = "data",
|
|
9219
10137
|
SnapKit = "snap_kit",
|
|
9220
10138
|
SnapWidget = "snap_widget",
|
|
9221
10139
|
Text = "text"
|
|
@@ -9530,6 +10448,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
9530
10448
|
object_display_id: string;
|
|
9531
10449
|
/** The type of object that the Timeline entry belongs to. */
|
|
9532
10450
|
object_type?: TimelineEntryObjectType;
|
|
10451
|
+
/** Display panels for the Timeline entry. */
|
|
10452
|
+
panels?: TimelineEntryPanel[];
|
|
9533
10453
|
/** The reactions to the entry. */
|
|
9534
10454
|
reactions?: TimelineReaction[];
|
|
9535
10455
|
/** Thread. */
|
|
@@ -9566,6 +10486,8 @@ export declare enum TimelineEntryObjectType {
|
|
|
9566
10486
|
}
|
|
9567
10487
|
/** Display panels for the Timeline entry. */
|
|
9568
10488
|
export declare enum TimelineEntryPanel {
|
|
10489
|
+
Alerts = "alerts",
|
|
10490
|
+
Broadcasts = "broadcasts",
|
|
9569
10491
|
CustomerChat = "customer_chat",
|
|
9570
10492
|
Discussions = "discussions",
|
|
9571
10493
|
Events = "events"
|
|
@@ -10025,6 +10947,30 @@ export interface UpdateIncidentOwnedBy {
|
|
|
10025
10947
|
/** Sets the user IDs of the users that own the incident. */
|
|
10026
10948
|
set?: string[];
|
|
10027
10949
|
}
|
|
10950
|
+
/** update-incident-pia */
|
|
10951
|
+
export interface UpdateIncidentPia {
|
|
10952
|
+
/**
|
|
10953
|
+
* Sets the the article ids of the Post-Incident Analysis(PIA) of the
|
|
10954
|
+
* incident.
|
|
10955
|
+
*/
|
|
10956
|
+
set?: string[];
|
|
10957
|
+
}
|
|
10958
|
+
/** update-incident-playbooks */
|
|
10959
|
+
export interface UpdateIncidentPlaybooks {
|
|
10960
|
+
/**
|
|
10961
|
+
* Sets the the article ids of the playbook(s) associated with the
|
|
10962
|
+
* incident.
|
|
10963
|
+
*/
|
|
10964
|
+
set?: string[];
|
|
10965
|
+
}
|
|
10966
|
+
/** update-incident-related-docs */
|
|
10967
|
+
export interface UpdateIncidentRelatedDocs {
|
|
10968
|
+
/**
|
|
10969
|
+
* Sets the the article ids of other documents associated with the
|
|
10970
|
+
* incident.
|
|
10971
|
+
*/
|
|
10972
|
+
set?: string[];
|
|
10973
|
+
}
|
|
10028
10974
|
/** update-incident-stakeholders */
|
|
10029
10975
|
export interface UpdateIncidentStakeholders {
|
|
10030
10976
|
/**
|
|
@@ -10038,6 +10984,11 @@ export interface UpdateIncidentTags {
|
|
|
10038
10984
|
/** Sets the tags associated with the object. */
|
|
10039
10985
|
set?: UpdateTagWithValue[];
|
|
10040
10986
|
}
|
|
10987
|
+
/** update-link-target-descriptor-list */
|
|
10988
|
+
export interface UpdateLinkTargetDescriptorList {
|
|
10989
|
+
/** List of link descriptors. */
|
|
10990
|
+
link_descriptors: LinkTargetDescriptor[];
|
|
10991
|
+
}
|
|
10041
10992
|
/**
|
|
10042
10993
|
* update-stage
|
|
10043
10994
|
* Update object for Stage.
|
|
@@ -10274,6 +11225,7 @@ export interface WebhookEventRequest {
|
|
|
10274
11225
|
webhook_updated?: EventWebhookUpdated;
|
|
10275
11226
|
work_created?: EventWorkCreated;
|
|
10276
11227
|
work_deleted?: EventWorkDeleted;
|
|
11228
|
+
work_fetched?: EventWorkFetched;
|
|
10277
11229
|
work_updated?: EventWorkUpdated;
|
|
10278
11230
|
}
|
|
10279
11231
|
/** webhook-event-response */
|
|
@@ -10334,6 +11286,7 @@ export declare enum WebhookEventType {
|
|
|
10334
11286
|
WebhookUpdated = "webhook_updated",
|
|
10335
11287
|
WorkCreated = "work_created",
|
|
10336
11288
|
WorkDeleted = "work_deleted",
|
|
11289
|
+
WorkFetched = "work_fetched",
|
|
10337
11290
|
WorkUpdated = "work_updated"
|
|
10338
11291
|
}
|
|
10339
11292
|
/** webhook-event-verify */
|
|
@@ -10411,6 +11364,27 @@ export interface WebhooksDeleteRequest {
|
|
|
10411
11364
|
* The response to deleting the webhook.
|
|
10412
11365
|
*/
|
|
10413
11366
|
export type WebhooksDeleteResponse = object;
|
|
11367
|
+
/**
|
|
11368
|
+
* webhooks-fetch-request
|
|
11369
|
+
* The request to fetch an object for a webhook.
|
|
11370
|
+
*/
|
|
11371
|
+
export interface WebhooksFetchRequest {
|
|
11372
|
+
/**
|
|
11373
|
+
* The ID of the webhook to fetch the object for.
|
|
11374
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
11375
|
+
*/
|
|
11376
|
+
id: string;
|
|
11377
|
+
/**
|
|
11378
|
+
* The ID of the object to fetch for the webhook.
|
|
11379
|
+
* @example "ISS-12345"
|
|
11380
|
+
*/
|
|
11381
|
+
object: string;
|
|
11382
|
+
}
|
|
11383
|
+
/**
|
|
11384
|
+
* webhooks-fetch-response
|
|
11385
|
+
* The response to fetching an object for a webhook.
|
|
11386
|
+
*/
|
|
11387
|
+
export type WebhooksFetchResponse = object;
|
|
10414
11388
|
/**
|
|
10415
11389
|
* webhooks-get-request
|
|
10416
11390
|
* The request to get a webhook's information.
|
|
@@ -10568,6 +11542,8 @@ export type WorkBase = AtomBase & {
|
|
|
10568
11542
|
stock_schema_fragment?: string;
|
|
10569
11543
|
/** Subtype corresponding to the custom type fragment. */
|
|
10570
11544
|
subtype?: string;
|
|
11545
|
+
/** Mixin for storing sync metadata. */
|
|
11546
|
+
sync_metadata?: SyncMetadata;
|
|
10571
11547
|
/** Tags associated with the object. */
|
|
10572
11548
|
tags?: TagWithValue[];
|
|
10573
11549
|
/**
|
|
@@ -11178,6 +12154,14 @@ export interface WorksUpdateRequestTicket {
|
|
|
11178
12154
|
* @format int64
|
|
11179
12155
|
*/
|
|
11180
12156
|
sentiment?: number;
|
|
12157
|
+
/**
|
|
12158
|
+
* Timestamp at which sentiment was last modified.
|
|
12159
|
+
* @format date-time
|
|
12160
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12161
|
+
*/
|
|
12162
|
+
sentiment_modified_date?: string;
|
|
12163
|
+
/** Summary justifying the current sentiment. */
|
|
12164
|
+
sentiment_summary?: string;
|
|
11181
12165
|
/** Severity of the ticket. */
|
|
11182
12166
|
severity?: TicketSeverity;
|
|
11183
12167
|
}
|
|
@@ -11485,6 +12469,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11485
12469
|
* only external articles are returned.
|
|
11486
12470
|
*/
|
|
11487
12471
|
scope?: number[];
|
|
12472
|
+
/** ID of the group/member with whom the item is shared. */
|
|
12473
|
+
'shared_with.member'?: string;
|
|
12474
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
12475
|
+
'shared_with.role'?: string;
|
|
11488
12476
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
11489
12477
|
/**
|
|
11490
12478
|
* @description Get count of articles matching given filter.
|
|
@@ -11596,6 +12584,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11596
12584
|
* only external articles are returned.
|
|
11597
12585
|
*/
|
|
11598
12586
|
scope?: number[];
|
|
12587
|
+
/** ID of the group/member with whom the item is shared. */
|
|
12588
|
+
'shared_with.member'?: string;
|
|
12589
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
12590
|
+
'shared_with.role'?: string;
|
|
11599
12591
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
11600
12592
|
/**
|
|
11601
12593
|
* @description Lists a collection of articles.
|
|
@@ -11706,6 +12698,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11706
12698
|
* @secure
|
|
11707
12699
|
*/
|
|
11708
12700
|
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
|
|
12701
|
+
/**
|
|
12702
|
+
* @description Retrieves audit logs.
|
|
12703
|
+
*
|
|
12704
|
+
* @tags compliance
|
|
12705
|
+
* @name ExportAuditLogs
|
|
12706
|
+
* @request POST:/audit-logs.fetch
|
|
12707
|
+
* @secure
|
|
12708
|
+
*/
|
|
12709
|
+
exportAuditLogs: (data: ExportAuditLogsRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11709
12710
|
/**
|
|
11710
12711
|
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
11711
12712
|
*
|
|
@@ -12165,6 +13166,117 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12165
13166
|
* @secure
|
|
12166
13167
|
*/
|
|
12167
13168
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
13169
|
+
/**
|
|
13170
|
+
* @description Counts custom objects.
|
|
13171
|
+
*
|
|
13172
|
+
* @tags customization
|
|
13173
|
+
* @name CustomObjectsCount
|
|
13174
|
+
* @request GET:/custom-objects.count
|
|
13175
|
+
* @secure
|
|
13176
|
+
*/
|
|
13177
|
+
customObjectsCount: (query: {
|
|
13178
|
+
/** Leaf type to filter. */
|
|
13179
|
+
leaf_type: string;
|
|
13180
|
+
/** List of filters to apply. */
|
|
13181
|
+
filters?: any[];
|
|
13182
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
13183
|
+
/**
|
|
13184
|
+
* @description Counts custom objects.
|
|
13185
|
+
*
|
|
13186
|
+
* @tags customization
|
|
13187
|
+
* @name CustomObjectsCountPost
|
|
13188
|
+
* @request POST:/custom-objects.count
|
|
13189
|
+
* @secure
|
|
13190
|
+
*/
|
|
13191
|
+
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
13192
|
+
/**
|
|
13193
|
+
* @description Creates a custom object.
|
|
13194
|
+
*
|
|
13195
|
+
* @tags customization
|
|
13196
|
+
* @name CustomObjectsCreate
|
|
13197
|
+
* @request POST:/custom-objects.create
|
|
13198
|
+
* @secure
|
|
13199
|
+
*/
|
|
13200
|
+
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any>>;
|
|
13201
|
+
/**
|
|
13202
|
+
* @description Deletes a custom object.
|
|
13203
|
+
*
|
|
13204
|
+
* @tags customization
|
|
13205
|
+
* @name CustomObjectsDelete
|
|
13206
|
+
* @request POST:/custom-objects.delete
|
|
13207
|
+
* @secure
|
|
13208
|
+
*/
|
|
13209
|
+
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13210
|
+
/**
|
|
13211
|
+
* @description Gets a custom object.
|
|
13212
|
+
*
|
|
13213
|
+
* @tags customization
|
|
13214
|
+
* @name CustomObjectsGet
|
|
13215
|
+
* @request GET:/custom-objects.get
|
|
13216
|
+
* @secure
|
|
13217
|
+
*/
|
|
13218
|
+
customObjectsGet: (query?: {
|
|
13219
|
+
/** The ID of the custom object to get. */
|
|
13220
|
+
id?: string;
|
|
13221
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
13222
|
+
/**
|
|
13223
|
+
* @description Gets a custom object.
|
|
13224
|
+
*
|
|
13225
|
+
* @tags customization
|
|
13226
|
+
* @name CustomObjectsGetPost
|
|
13227
|
+
* @request POST:/custom-objects.get
|
|
13228
|
+
* @secure
|
|
13229
|
+
*/
|
|
13230
|
+
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
13231
|
+
/**
|
|
13232
|
+
* @description Lists custom objects.
|
|
13233
|
+
*
|
|
13234
|
+
* @tags customization
|
|
13235
|
+
* @name CustomObjectsList
|
|
13236
|
+
* @request GET:/custom-objects.list
|
|
13237
|
+
* @secure
|
|
13238
|
+
*/
|
|
13239
|
+
customObjectsList: (query: {
|
|
13240
|
+
/** Leaf type to filter. */
|
|
13241
|
+
leaf_type: string;
|
|
13242
|
+
/**
|
|
13243
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13244
|
+
* starts from the beginning.
|
|
13245
|
+
*/
|
|
13246
|
+
cursor?: string;
|
|
13247
|
+
/** List of filters to apply. */
|
|
13248
|
+
filter?: any[];
|
|
13249
|
+
/**
|
|
13250
|
+
* The maximum number of items.
|
|
13251
|
+
* @format int32
|
|
13252
|
+
*/
|
|
13253
|
+
limit?: number;
|
|
13254
|
+
/**
|
|
13255
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13256
|
+
* used.
|
|
13257
|
+
*/
|
|
13258
|
+
mode?: ListMode;
|
|
13259
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
13260
|
+
sort_by?: string[];
|
|
13261
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
13262
|
+
/**
|
|
13263
|
+
* @description Lists custom objects.
|
|
13264
|
+
*
|
|
13265
|
+
* @tags customization
|
|
13266
|
+
* @name CustomObjectsListPost
|
|
13267
|
+
* @request POST:/custom-objects.list
|
|
13268
|
+
* @secure
|
|
13269
|
+
*/
|
|
13270
|
+
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
13271
|
+
/**
|
|
13272
|
+
* @description Updates a custom object.
|
|
13273
|
+
*
|
|
13274
|
+
* @tags customization
|
|
13275
|
+
* @name CustomObjectsUpdate
|
|
13276
|
+
* @request POST:/custom-objects.update
|
|
13277
|
+
* @secure
|
|
13278
|
+
*/
|
|
13279
|
+
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any>>;
|
|
12168
13280
|
/**
|
|
12169
13281
|
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Keep in mind that at a time, only one authentication connection can be enabled for a Dev organization. At present, only 5 enterprise connections can be created by an organization.
|
|
12170
13282
|
*
|
|
@@ -12293,6 +13405,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12293
13405
|
* starts from the beginning.
|
|
12294
13406
|
*/
|
|
12295
13407
|
cursor?: string;
|
|
13408
|
+
/** Filters for custom fields. */
|
|
13409
|
+
custom_fields?: object;
|
|
12296
13410
|
/** Filters Dev users based on email addresses. */
|
|
12297
13411
|
email?: string[];
|
|
12298
13412
|
/** Unique ID of the user in the external source. */
|
|
@@ -12359,6 +13473,127 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12359
13473
|
* @secure
|
|
12360
13474
|
*/
|
|
12361
13475
|
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
13476
|
+
/**
|
|
13477
|
+
* @description Get count of directories matching given filter.
|
|
13478
|
+
*
|
|
13479
|
+
* @tags directory
|
|
13480
|
+
* @name DirectoriesCount
|
|
13481
|
+
* @request GET:/directories.count
|
|
13482
|
+
* @secure
|
|
13483
|
+
*/
|
|
13484
|
+
directoriesCount: (query?: {
|
|
13485
|
+
/**
|
|
13486
|
+
* Filters for directories created by any of the provided users.
|
|
13487
|
+
* @example ["DEVU-12345"]
|
|
13488
|
+
*/
|
|
13489
|
+
created_by?: string[];
|
|
13490
|
+
/**
|
|
13491
|
+
* Filters for directories modified by any of the provided users.
|
|
13492
|
+
* @example ["DEVU-12345"]
|
|
13493
|
+
*/
|
|
13494
|
+
modified_by?: string[];
|
|
13495
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any>>;
|
|
13496
|
+
/**
|
|
13497
|
+
* @description Get count of directories matching given filter.
|
|
13498
|
+
*
|
|
13499
|
+
* @tags directory
|
|
13500
|
+
* @name DirectoriesCountPost
|
|
13501
|
+
* @request POST:/directories.count
|
|
13502
|
+
* @secure
|
|
13503
|
+
*/
|
|
13504
|
+
directoriesCountPost: (data: DirectoriesCountRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any>>;
|
|
13505
|
+
/**
|
|
13506
|
+
* @description Creates a directory for the specified inputs.
|
|
13507
|
+
*
|
|
13508
|
+
* @tags directory
|
|
13509
|
+
* @name DirectoriesCreate
|
|
13510
|
+
* @request POST:/directories.create
|
|
13511
|
+
* @secure
|
|
13512
|
+
*/
|
|
13513
|
+
directoriesCreate: (data: DirectoriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCreateResponse, any>>;
|
|
13514
|
+
/**
|
|
13515
|
+
* @description Delete the specified directory.
|
|
13516
|
+
*
|
|
13517
|
+
* @tags directory
|
|
13518
|
+
* @name DirectoriesDelete
|
|
13519
|
+
* @request POST:/directories.delete
|
|
13520
|
+
* @secure
|
|
13521
|
+
*/
|
|
13522
|
+
directoriesDelete: (data: DirectoriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13523
|
+
/**
|
|
13524
|
+
* @description Gets the specified directory.
|
|
13525
|
+
*
|
|
13526
|
+
* @tags directory
|
|
13527
|
+
* @name DirectoriesGet
|
|
13528
|
+
* @request GET:/directories.get
|
|
13529
|
+
* @secure
|
|
13530
|
+
*/
|
|
13531
|
+
directoriesGet: (query: {
|
|
13532
|
+
/** The ID of the requested directory. */
|
|
13533
|
+
id: string;
|
|
13534
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13535
|
+
/**
|
|
13536
|
+
* @description Gets the specified directory.
|
|
13537
|
+
*
|
|
13538
|
+
* @tags directory
|
|
13539
|
+
* @name DirectoriesGetPost
|
|
13540
|
+
* @request POST:/directories.get
|
|
13541
|
+
* @secure
|
|
13542
|
+
*/
|
|
13543
|
+
directoriesGetPost: (data: DirectoriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13544
|
+
/**
|
|
13545
|
+
* @description Lists directories matching the request.
|
|
13546
|
+
*
|
|
13547
|
+
* @tags directory
|
|
13548
|
+
* @name DirectoriesList
|
|
13549
|
+
* @request GET:/directories.list
|
|
13550
|
+
* @secure
|
|
13551
|
+
*/
|
|
13552
|
+
directoriesList: (query?: {
|
|
13553
|
+
/**
|
|
13554
|
+
* Filters for directories created by any of the provided users.
|
|
13555
|
+
* @example ["DEVU-12345"]
|
|
13556
|
+
*/
|
|
13557
|
+
created_by?: string[];
|
|
13558
|
+
/**
|
|
13559
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13560
|
+
* starts from the beginning.
|
|
13561
|
+
*/
|
|
13562
|
+
cursor?: string;
|
|
13563
|
+
/**
|
|
13564
|
+
* The maximum number of directories to return. The default is '50'.
|
|
13565
|
+
* @format int32
|
|
13566
|
+
*/
|
|
13567
|
+
limit?: number;
|
|
13568
|
+
/**
|
|
13569
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13570
|
+
* used.
|
|
13571
|
+
*/
|
|
13572
|
+
mode?: ListMode;
|
|
13573
|
+
/**
|
|
13574
|
+
* Filters for directories modified by any of the provided users.
|
|
13575
|
+
* @example ["DEVU-12345"]
|
|
13576
|
+
*/
|
|
13577
|
+
modified_by?: string[];
|
|
13578
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any>>;
|
|
13579
|
+
/**
|
|
13580
|
+
* @description Lists directories matching the request.
|
|
13581
|
+
*
|
|
13582
|
+
* @tags directory
|
|
13583
|
+
* @name DirectoriesListPost
|
|
13584
|
+
* @request POST:/directories.list
|
|
13585
|
+
* @secure
|
|
13586
|
+
*/
|
|
13587
|
+
directoriesListPost: (data: DirectoriesListRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any>>;
|
|
13588
|
+
/**
|
|
13589
|
+
* @description Updates the specified directory.
|
|
13590
|
+
*
|
|
13591
|
+
* @tags directory
|
|
13592
|
+
* @name DirectoriesUpdate
|
|
13593
|
+
* @request POST:/directories.update
|
|
13594
|
+
* @secure
|
|
13595
|
+
*/
|
|
13596
|
+
directoriesUpdate: (data: DirectoriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesUpdateResponse, any>>;
|
|
12362
13597
|
/**
|
|
12363
13598
|
* @description Counts the engagement records.
|
|
12364
13599
|
*
|
|
@@ -12748,6 +13983,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12748
13983
|
mode?: ListMode;
|
|
12749
13984
|
/** Filters for incidents owned by any of the provided users. */
|
|
12750
13985
|
owned_by?: string[];
|
|
13986
|
+
/**
|
|
13987
|
+
* Filters for incidents with any of the provided PIAs.
|
|
13988
|
+
* @example ["ARTICLE-12345"]
|
|
13989
|
+
*/
|
|
13990
|
+
pia?: string[];
|
|
13991
|
+
/**
|
|
13992
|
+
* Filters for incidents with any of the provided playbooks.
|
|
13993
|
+
* @example ["ARTICLE-12345"]
|
|
13994
|
+
*/
|
|
13995
|
+
playbook?: string[];
|
|
13996
|
+
/**
|
|
13997
|
+
* Filters for incidents with any of the provided related docs.
|
|
13998
|
+
* @example ["ARTICLE-12345"]
|
|
13999
|
+
*/
|
|
14000
|
+
related_docs?: string[];
|
|
12751
14001
|
/** Filters for incidents with any of the provided reporters. */
|
|
12752
14002
|
reported_by?: number[];
|
|
12753
14003
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -12803,6 +14053,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12803
14053
|
mode?: ListMode;
|
|
12804
14054
|
/** Filters for incidents owned by any of the provided users. */
|
|
12805
14055
|
owned_by?: string[];
|
|
14056
|
+
/**
|
|
14057
|
+
* Filters for incidents with any of the provided PIAs.
|
|
14058
|
+
* @example ["ARTICLE-12345"]
|
|
14059
|
+
*/
|
|
14060
|
+
pia?: string[];
|
|
14061
|
+
/**
|
|
14062
|
+
* Filters for incidents with any of the provided playbooks.
|
|
14063
|
+
* @example ["ARTICLE-12345"]
|
|
14064
|
+
*/
|
|
14065
|
+
playbook?: string[];
|
|
14066
|
+
/**
|
|
14067
|
+
* Filters for incidents with any of the provided related docs.
|
|
14068
|
+
* @example ["ARTICLE-12345"]
|
|
14069
|
+
*/
|
|
14070
|
+
related_docs?: string[];
|
|
12806
14071
|
/** Filters for incidents with any of the provided reporters. */
|
|
12807
14072
|
reported_by?: number[];
|
|
12808
14073
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -12856,6 +14121,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12856
14121
|
* @secure
|
|
12857
14122
|
*/
|
|
12858
14123
|
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
14124
|
+
/**
|
|
14125
|
+
* @description Creates a custom link type.
|
|
14126
|
+
*
|
|
14127
|
+
* @tags customization
|
|
14128
|
+
* @name CustomLinkTypeCreate
|
|
14129
|
+
* @request POST:/link-types.custom.create
|
|
14130
|
+
* @secure
|
|
14131
|
+
*/
|
|
14132
|
+
customLinkTypeCreate: (data: CustomLinkTypeCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeCreateResponse, any>>;
|
|
14133
|
+
/**
|
|
14134
|
+
* @description Gets a custom link type.
|
|
14135
|
+
*
|
|
14136
|
+
* @tags customization
|
|
14137
|
+
* @name CustomLinkTypeGet
|
|
14138
|
+
* @request GET:/link-types.custom.get
|
|
14139
|
+
* @secure
|
|
14140
|
+
*/
|
|
14141
|
+
customLinkTypeGet: (query: {
|
|
14142
|
+
/** The ID of the custom link type to get. */
|
|
14143
|
+
id: string;
|
|
14144
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
|
|
14145
|
+
/**
|
|
14146
|
+
* @description Gets a custom link type.
|
|
14147
|
+
*
|
|
14148
|
+
* @tags customization
|
|
14149
|
+
* @name CustomLinkTypeGetPost
|
|
14150
|
+
* @request POST:/link-types.custom.get
|
|
14151
|
+
* @secure
|
|
14152
|
+
*/
|
|
14153
|
+
customLinkTypeGetPost: (data: CustomLinkTypeGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
|
|
14154
|
+
/**
|
|
14155
|
+
* @description Lists custom link types.
|
|
14156
|
+
*
|
|
14157
|
+
* @tags customization
|
|
14158
|
+
* @name CustomLinkTypeList
|
|
14159
|
+
* @request GET:/link-types.custom.list
|
|
14160
|
+
* @secure
|
|
14161
|
+
*/
|
|
14162
|
+
customLinkTypeList: (query?: {
|
|
14163
|
+
/**
|
|
14164
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
14165
|
+
* starts from the beginning.
|
|
14166
|
+
*/
|
|
14167
|
+
cursor?: string;
|
|
14168
|
+
/** Whether only deprecated link types should be filtered. */
|
|
14169
|
+
deprecated?: boolean;
|
|
14170
|
+
/**
|
|
14171
|
+
* The maximum number of items.
|
|
14172
|
+
* @format int32
|
|
14173
|
+
*/
|
|
14174
|
+
limit?: number;
|
|
14175
|
+
/**
|
|
14176
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
14177
|
+
* used.
|
|
14178
|
+
*/
|
|
14179
|
+
mode?: ListMode;
|
|
14180
|
+
/** The list of link type names. */
|
|
14181
|
+
name?: string[];
|
|
14182
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
14183
|
+
sort_by?: string[];
|
|
14184
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
14185
|
+
/**
|
|
14186
|
+
* @description Lists custom link types.
|
|
14187
|
+
*
|
|
14188
|
+
* @tags customization
|
|
14189
|
+
* @name CustomLinkTypeListPost
|
|
14190
|
+
* @request POST:/link-types.custom.list
|
|
14191
|
+
* @secure
|
|
14192
|
+
*/
|
|
14193
|
+
customLinkTypeListPost: (data: CustomLinkTypeListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
14194
|
+
/**
|
|
14195
|
+
* @description Updates a custom link type.
|
|
14196
|
+
*
|
|
14197
|
+
* @tags customization
|
|
14198
|
+
* @name CustomLinkTypeUpdate
|
|
14199
|
+
* @request POST:/link-types.custom.update
|
|
14200
|
+
* @secure
|
|
14201
|
+
*/
|
|
14202
|
+
customLinkTypeUpdate: (data: CustomLinkTypeUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeUpdateResponse, any>>;
|
|
12859
14203
|
/**
|
|
12860
14204
|
* @description Creates a link between two objects to indicate a relationship.
|
|
12861
14205
|
*
|
|
@@ -12953,6 +14297,60 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12953
14297
|
* @secure
|
|
12954
14298
|
*/
|
|
12955
14299
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
14300
|
+
/**
|
|
14301
|
+
* @description Executes the metric action on the given object.
|
|
14302
|
+
*
|
|
14303
|
+
* @tags slas
|
|
14304
|
+
* @name MetricActionExecute
|
|
14305
|
+
* @request POST:/metric-action.execute
|
|
14306
|
+
* @secure
|
|
14307
|
+
*/
|
|
14308
|
+
metricActionExecute: (data: MetricActionExecuteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14309
|
+
/**
|
|
14310
|
+
* @description Creates a custom metric definition
|
|
14311
|
+
*
|
|
14312
|
+
* @tags slas
|
|
14313
|
+
* @name MetricDefinitionsCreate
|
|
14314
|
+
* @request POST:/metric-definitions.create
|
|
14315
|
+
* @secure
|
|
14316
|
+
*/
|
|
14317
|
+
metricDefinitionsCreate: (data: MetricDefinitionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsCreateResponse, any>>;
|
|
14318
|
+
/**
|
|
14319
|
+
* @description Deletes a custom metric definition
|
|
14320
|
+
*
|
|
14321
|
+
* @tags slas
|
|
14322
|
+
* @name MetricDefinitionsDelete
|
|
14323
|
+
* @request POST:/metric-definitions.delete
|
|
14324
|
+
* @secure
|
|
14325
|
+
*/
|
|
14326
|
+
metricDefinitionsDelete: (data: MetricDefinitionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14327
|
+
/**
|
|
14328
|
+
* @description Gets a custom metric definition
|
|
14329
|
+
*
|
|
14330
|
+
* @tags slas
|
|
14331
|
+
* @name MetricDefinitionsGet
|
|
14332
|
+
* @request GET:/metric-definitions.get
|
|
14333
|
+
* @secure
|
|
14334
|
+
*/
|
|
14335
|
+
metricDefinitionsGet: (query?: {
|
|
14336
|
+
/** The ID of the metric definition to get. */
|
|
14337
|
+
id?: string;
|
|
14338
|
+
/**
|
|
14339
|
+
* The unique human readable name of the metric.
|
|
14340
|
+
* @minLength 1
|
|
14341
|
+
* @maxLength 64
|
|
14342
|
+
*/
|
|
14343
|
+
name?: string;
|
|
14344
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any>>;
|
|
14345
|
+
/**
|
|
14346
|
+
* @description Gets a custom metric definition
|
|
14347
|
+
*
|
|
14348
|
+
* @tags slas
|
|
14349
|
+
* @name MetricDefinitionsGetPost
|
|
14350
|
+
* @request POST:/metric-definitions.get
|
|
14351
|
+
* @secure
|
|
14352
|
+
*/
|
|
14353
|
+
metricDefinitionsGetPost: (data: MetricDefinitionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any>>;
|
|
12956
14354
|
/**
|
|
12957
14355
|
* @description Lists metric definitions matching a filter.
|
|
12958
14356
|
*
|
|
@@ -12998,6 +14396,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12998
14396
|
* @secure
|
|
12999
14397
|
*/
|
|
13000
14398
|
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
14399
|
+
/**
|
|
14400
|
+
* @description Updates a custom metric definition
|
|
14401
|
+
*
|
|
14402
|
+
* @tags slas
|
|
14403
|
+
* @name MetricDefinitionsUpdate
|
|
14404
|
+
* @request POST:/metric-definitions.update
|
|
14405
|
+
* @secure
|
|
14406
|
+
*/
|
|
14407
|
+
metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any>>;
|
|
13001
14408
|
/**
|
|
13002
14409
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
13003
14410
|
*
|
|
@@ -13554,6 +14961,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13554
14961
|
* @secure
|
|
13555
14962
|
*/
|
|
13556
14963
|
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14964
|
+
/**
|
|
14965
|
+
* @description Deletes data of a contact.
|
|
14966
|
+
*
|
|
14967
|
+
* @tags compliance
|
|
14968
|
+
* @name DeleteRevUsersPersonalData
|
|
14969
|
+
* @request POST:/rev-users.delete-personal-data
|
|
14970
|
+
* @secure
|
|
14971
|
+
*/
|
|
14972
|
+
deleteRevUsersPersonalData: (data: DeleteRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13557
14973
|
/**
|
|
13558
14974
|
* @description Returns the Rev user of a Rev organization by its ID.
|
|
13559
14975
|
*
|
|
@@ -13665,6 +15081,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13665
15081
|
* @secure
|
|
13666
15082
|
*/
|
|
13667
15083
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
15084
|
+
/**
|
|
15085
|
+
* @description Merges the secondary Rev user into the primary Rev user.
|
|
15086
|
+
*
|
|
15087
|
+
* @tags rev-users
|
|
15088
|
+
* @name RevUsersMerge
|
|
15089
|
+
* @request POST:/rev-users.merge
|
|
15090
|
+
* @secure
|
|
15091
|
+
*/
|
|
15092
|
+
revUsersMerge: (data: RevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15093
|
+
/**
|
|
15094
|
+
* @description Retrieves data of a contact.
|
|
15095
|
+
*
|
|
15096
|
+
* @tags compliance
|
|
15097
|
+
* @name GetRevUsersPersonalData
|
|
15098
|
+
* @request POST:/rev-users.personal-data
|
|
15099
|
+
* @secure
|
|
15100
|
+
*/
|
|
15101
|
+
getRevUsersPersonalData: (data: GetRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13668
15102
|
/**
|
|
13669
15103
|
* @description Scans through all Rev users.
|
|
13670
15104
|
*
|
|
@@ -13819,6 +15253,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13819
15253
|
cursor?: string;
|
|
13820
15254
|
/** Whether only deprecated fragments should be filtered. */
|
|
13821
15255
|
deprecated?: boolean;
|
|
15256
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
15257
|
+
is_custom_leaf_type?: boolean;
|
|
13822
15258
|
/** The list of leaf types. */
|
|
13823
15259
|
leaf_type?: string[];
|
|
13824
15260
|
/**
|
|
@@ -14085,6 +15521,70 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14085
15521
|
* @secure
|
|
14086
15522
|
*/
|
|
14087
15523
|
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
15524
|
+
/**
|
|
15525
|
+
* @description Lists SLA trackers matching a filter.
|
|
15526
|
+
*
|
|
15527
|
+
* @tags slas
|
|
15528
|
+
* @name SlaTrackersList
|
|
15529
|
+
* @request GET:/sla-trackers.list
|
|
15530
|
+
* @secure
|
|
15531
|
+
*/
|
|
15532
|
+
slaTrackersList: (query?: {
|
|
15533
|
+
/**
|
|
15534
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
15535
|
+
* @format date-time
|
|
15536
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15537
|
+
*/
|
|
15538
|
+
'created_date.after'?: string;
|
|
15539
|
+
/**
|
|
15540
|
+
* Filters for objects created before the provided timestamp
|
|
15541
|
+
* (inclusive).
|
|
15542
|
+
* @format date-time
|
|
15543
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15544
|
+
*/
|
|
15545
|
+
'created_date.before'?: string;
|
|
15546
|
+
/**
|
|
15547
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
15548
|
+
* starts from the beginning.
|
|
15549
|
+
*/
|
|
15550
|
+
cursor?: string;
|
|
15551
|
+
/**
|
|
15552
|
+
* The maximum number of SLA trackers to return. The default is '50'.
|
|
15553
|
+
* @format int32
|
|
15554
|
+
*/
|
|
15555
|
+
limit?: number;
|
|
15556
|
+
/**
|
|
15557
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
15558
|
+
* used.
|
|
15559
|
+
*/
|
|
15560
|
+
mode?: ListMode;
|
|
15561
|
+
/**
|
|
15562
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
15563
|
+
* @format date-time
|
|
15564
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15565
|
+
*/
|
|
15566
|
+
'modified_date.after'?: string;
|
|
15567
|
+
/**
|
|
15568
|
+
* Filters for objects created before the provided timestamp
|
|
15569
|
+
* (inclusive).
|
|
15570
|
+
* @format date-time
|
|
15571
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15572
|
+
*/
|
|
15573
|
+
'modified_date.before'?: string;
|
|
15574
|
+
/** The SLA tracker stages the filter matches. */
|
|
15575
|
+
stage?: string[];
|
|
15576
|
+
/** The SLA tracker statuses the filter matches. */
|
|
15577
|
+
status?: string[];
|
|
15578
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any>>;
|
|
15579
|
+
/**
|
|
15580
|
+
* @description Lists SLA trackers matching a filter.
|
|
15581
|
+
*
|
|
15582
|
+
* @tags slas
|
|
15583
|
+
* @name SlaTrackersListPost
|
|
15584
|
+
* @request POST:/sla-trackers.list
|
|
15585
|
+
* @secure
|
|
15586
|
+
*/
|
|
15587
|
+
slaTrackersListPost: (data: SlaTrackersListRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any>>;
|
|
14088
15588
|
/**
|
|
14089
15589
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
14090
15590
|
*
|
|
@@ -14944,6 +16444,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14944
16444
|
* @secure
|
|
14945
16445
|
*/
|
|
14946
16446
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
16447
|
+
/**
|
|
16448
|
+
* @description Fetches an object via webhook.
|
|
16449
|
+
*
|
|
16450
|
+
* @tags webhooks
|
|
16451
|
+
* @name WebhooksFetch
|
|
16452
|
+
* @request POST:/webhooks.fetch
|
|
16453
|
+
* @secure
|
|
16454
|
+
*/
|
|
16455
|
+
webhooksFetch: (data: WebhooksFetchRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14947
16456
|
/**
|
|
14948
16457
|
* @description Gets the requested webhook's information.
|
|
14949
16458
|
*
|