@devrev/typescript-sdk 1.1.32 → 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.
|
@@ -506,6 +506,8 @@ export type Article = AtomBase & {
|
|
|
506
506
|
resource?: Resource;
|
|
507
507
|
/** The properties of an enum value. */
|
|
508
508
|
scope?: EnumValue;
|
|
509
|
+
/** Mixin for storing sync metadata. */
|
|
510
|
+
sync_metadata?: SyncMetadata;
|
|
509
511
|
/** Title of the article. */
|
|
510
512
|
title?: string;
|
|
511
513
|
};
|
|
@@ -1994,6 +1996,8 @@ export interface ConversationsCreateRequest {
|
|
|
1994
1996
|
/** Initial messages on the conversation. */
|
|
1995
1997
|
messages?: ConversationsCreateRequestMessage[];
|
|
1996
1998
|
metadata?: ConversationsCreateRequestMetadata;
|
|
1999
|
+
/** The users that own the conversation. */
|
|
2000
|
+
owned_by?: string[];
|
|
1997
2001
|
/** Whether the conversation is from a source channel. */
|
|
1998
2002
|
source_channel?: string;
|
|
1999
2003
|
/** Sets an object's initial stage. */
|
|
@@ -2210,6 +2214,7 @@ export interface ConversationsUpdateRequest {
|
|
|
2210
2214
|
/** Whether the conversation is spam. */
|
|
2211
2215
|
is_spam?: boolean;
|
|
2212
2216
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
2217
|
+
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
2213
2218
|
/** Updates an object's stage. */
|
|
2214
2219
|
stage?: StageUpdate;
|
|
2215
2220
|
/** The updated status of the conversation. */
|
|
@@ -2231,6 +2236,16 @@ export interface ConversationsUpdateRequestAppliesToParts {
|
|
|
2231
2236
|
export interface ConversationsUpdateRequestMetadata {
|
|
2232
2237
|
url_context?: string;
|
|
2233
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
|
+
}
|
|
2234
2249
|
/** conversations-update-request-tags */
|
|
2235
2250
|
export interface ConversationsUpdateRequestTags {
|
|
2236
2251
|
/** Sets the tag IDs to the provided tags. */
|
|
@@ -2493,12 +2508,163 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
2493
2508
|
export interface CustomLinkTypeUpdateResponse {
|
|
2494
2509
|
custom_link_type: CustomLinkType;
|
|
2495
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
|
+
};
|
|
2496
2528
|
/** custom-object-search-summary */
|
|
2497
2529
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2498
2530
|
custom_object: CustomObjectSummary;
|
|
2499
2531
|
};
|
|
2500
2532
|
/** custom-object-summary */
|
|
2501
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
|
+
}
|
|
2502
2668
|
/** custom-schema-fragment */
|
|
2503
2669
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
2504
2670
|
type: CustomSchemaFragmentType;
|
|
@@ -2566,6 +2732,8 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
2566
2732
|
cursor?: string;
|
|
2567
2733
|
/** Whether only deprecated fragments should be filtered. */
|
|
2568
2734
|
deprecated?: boolean;
|
|
2735
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
2736
|
+
is_custom_leaf_type?: boolean;
|
|
2569
2737
|
/** The list of leaf types. */
|
|
2570
2738
|
leaf_type?: string[];
|
|
2571
2739
|
/**
|
|
@@ -2956,6 +3124,21 @@ export declare enum DateTimePresetType {
|
|
|
2956
3124
|
LastNDays = "last_n_days",
|
|
2957
3125
|
NextNDays = "next_n_days"
|
|
2958
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;
|
|
2959
3142
|
/**
|
|
2960
3143
|
* dev-org-auth-connections-create-request
|
|
2961
3144
|
* Request to create a new enterprise authentication connection.
|
|
@@ -3367,6 +3550,196 @@ export interface DevUsersUpdateRequest {
|
|
|
3367
3550
|
export interface DevUsersUpdateResponse {
|
|
3368
3551
|
dev_user: DevUser;
|
|
3369
3552
|
}
|
|
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
|
+
}
|
|
3574
|
+
/**
|
|
3575
|
+
* directories-create-request
|
|
3576
|
+
* The request to create a directory.
|
|
3577
|
+
*/
|
|
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
|
+
}
|
|
3597
|
+
/**
|
|
3598
|
+
* directories-create-response
|
|
3599
|
+
* Create directory response.
|
|
3600
|
+
*/
|
|
3601
|
+
export interface DirectoriesCreateResponse {
|
|
3602
|
+
directory: Directory;
|
|
3603
|
+
}
|
|
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;
|
|
3611
|
+
}
|
|
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
|
+
};
|
|
3370
3743
|
/** directory-summary */
|
|
3371
3744
|
export type DirectorySummary = AtomBaseSummary;
|
|
3372
3745
|
/**
|
|
@@ -3503,7 +3876,13 @@ export interface EngagementsCreateRequest {
|
|
|
3503
3876
|
* Currently, only accounts and opportunities are supported.
|
|
3504
3877
|
* @example "ACC-12345"
|
|
3505
3878
|
*/
|
|
3506
|
-
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[];
|
|
3507
3886
|
/**
|
|
3508
3887
|
* The date and time when the engagement was scheduled.
|
|
3509
3888
|
* @format date-time
|
|
@@ -3607,6 +3986,7 @@ export interface EngagementsUpdateRequest {
|
|
|
3607
3986
|
/** The engagement ID. */
|
|
3608
3987
|
id: string;
|
|
3609
3988
|
members?: EngagementsUpdateRequestMembers;
|
|
3989
|
+
parents?: EngagementsUpdateRequestParents;
|
|
3610
3990
|
/**
|
|
3611
3991
|
* Updates the date and time when the engagement was scheduled.
|
|
3612
3992
|
* @format date-time
|
|
@@ -3635,6 +4015,15 @@ export interface EngagementsUpdateRequestMembers {
|
|
|
3635
4015
|
*/
|
|
3636
4016
|
set?: string[];
|
|
3637
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
|
+
}
|
|
3638
4027
|
/** engagements-update-request-tags */
|
|
3639
4028
|
export interface EngagementsUpdateRequestTags {
|
|
3640
4029
|
/** Sets the provided tags on the engagement item. */
|
|
@@ -4289,6 +4678,30 @@ export interface EventWorkUpdated {
|
|
|
4289
4678
|
old_work?: Work;
|
|
4290
4679
|
work: Work;
|
|
4291
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;
|
|
4292
4705
|
/**
|
|
4293
4706
|
* external-identity
|
|
4294
4707
|
* External identity of a user.
|
|
@@ -4453,7 +4866,10 @@ export interface GeneralPreferencesGroup {
|
|
|
4453
4866
|
/** Preferred locale of the user. */
|
|
4454
4867
|
export declare enum GeneralPreferencesGroupPreferredLocale {
|
|
4455
4868
|
EnUs = "en_us",
|
|
4456
|
-
|
|
4869
|
+
EsAr = "es_ar",
|
|
4870
|
+
JaJp = "ja_jp",
|
|
4871
|
+
NlAw = "nl_aw",
|
|
4872
|
+
NlSx = "nl_sx"
|
|
4457
4873
|
}
|
|
4458
4874
|
/** Event type of the notification. */
|
|
4459
4875
|
export declare enum GenericNotificationEventType {
|
|
@@ -4463,6 +4879,21 @@ export declare enum GenericNotificationEventType {
|
|
|
4463
4879
|
Reminder = "reminder",
|
|
4464
4880
|
Update = "update"
|
|
4465
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;
|
|
4466
4897
|
/** group */
|
|
4467
4898
|
export type Group = AtomBase & {
|
|
4468
4899
|
/** Description of the group. */
|
|
@@ -4474,6 +4905,8 @@ export type Group = AtomBase & {
|
|
|
4474
4905
|
/** Name of the group. */
|
|
4475
4906
|
name?: string;
|
|
4476
4907
|
owner?: UserSummary;
|
|
4908
|
+
/** Mixin for storing sync metadata. */
|
|
4909
|
+
sync_metadata?: SyncMetadata;
|
|
4477
4910
|
};
|
|
4478
4911
|
/** Creation source of the group. */
|
|
4479
4912
|
export declare enum GroupIngestionSource {
|
|
@@ -4734,6 +5167,12 @@ export type Incident = AtomBase & {
|
|
|
4734
5167
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4735
5168
|
*/
|
|
4736
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;
|
|
4737
5176
|
/** Parts to which the incident is applicable to. */
|
|
4738
5177
|
applies_to_parts?: PartSummary[];
|
|
4739
5178
|
/** Artifacts attached to the incident. */
|
|
@@ -4765,6 +5204,10 @@ export type Incident = AtomBase & {
|
|
|
4765
5204
|
mitigated_date?: string;
|
|
4766
5205
|
/** The users that own the incident. */
|
|
4767
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[];
|
|
4768
5211
|
/** The properties of an enum value. */
|
|
4769
5212
|
reported_by?: EnumValue;
|
|
4770
5213
|
/** The properties of an enum value. */
|
|
@@ -5384,6 +5827,7 @@ export declare enum LinkType {
|
|
|
5384
5827
|
IsConvertedTo = "is_converted_to",
|
|
5385
5828
|
IsDependentOn = "is_dependent_on",
|
|
5386
5829
|
IsDuplicateOf = "is_duplicate_of",
|
|
5830
|
+
IsFollowUpOf = "is_follow_up_of",
|
|
5387
5831
|
IsMergedInto = "is_merged_into",
|
|
5388
5832
|
IsParentOf = "is_parent_of",
|
|
5389
5833
|
IsPartOf = "is_part_of",
|
|
@@ -5535,6 +5979,32 @@ export declare enum MemberType {
|
|
|
5535
5979
|
RevUser = "rev_user",
|
|
5536
5980
|
SysUser = "sys_user"
|
|
5537
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;
|
|
5538
6008
|
/** metric-data-point */
|
|
5539
6009
|
export interface MetricDataPoint {
|
|
5540
6010
|
/**
|
|
@@ -5614,6 +6084,51 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
5614
6084
|
/** Human readable name of the metric. */
|
|
5615
6085
|
name?: string;
|
|
5616
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
|
+
}
|
|
5617
6132
|
/** metric-definitions-list-request */
|
|
5618
6133
|
export interface MetricDefinitionsListRequest {
|
|
5619
6134
|
/** The type of metric definitions sought. */
|
|
@@ -5661,6 +6176,32 @@ export interface MetricDefinitionsListResponse {
|
|
|
5661
6176
|
*/
|
|
5662
6177
|
prev_cursor?: string;
|
|
5663
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
|
+
}
|
|
5664
6205
|
/** metrics-data */
|
|
5665
6206
|
export interface MetricsData {
|
|
5666
6207
|
/**
|
|
@@ -7186,6 +7727,25 @@ export interface RevUsersListResponse {
|
|
|
7186
7727
|
/** List containing all the Rev users. */
|
|
7187
7728
|
rev_users: RevUser[];
|
|
7188
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;
|
|
7189
7749
|
/**
|
|
7190
7750
|
* rev-users-scan-request
|
|
7191
7751
|
* Scans the list of Rev users.
|
|
@@ -8070,7 +8630,15 @@ export interface SetOrgScheduleFragmentSummary {
|
|
|
8070
8630
|
* set-shared-with-membership
|
|
8071
8631
|
* Information about the role the member receives due to the share.
|
|
8072
8632
|
*/
|
|
8073
|
-
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
|
+
}
|
|
8074
8642
|
/** set-sla-policy */
|
|
8075
8643
|
export interface SetSlaPolicy {
|
|
8076
8644
|
/** Metrics to apply to the selected items. */
|
|
@@ -8179,7 +8747,12 @@ export interface SetWeeklyOrgSchedule {
|
|
|
8179
8747
|
* shared-with-membership-filter
|
|
8180
8748
|
* Filter on target item based on intended audience.
|
|
8181
8749
|
*/
|
|
8182
|
-
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
|
+
}
|
|
8183
8756
|
/** sla */
|
|
8184
8757
|
export type Sla = AtomBase & {
|
|
8185
8758
|
/**
|
|
@@ -8355,6 +8928,48 @@ export interface SlaTrackersGetRequest {
|
|
|
8355
8928
|
export interface SlaTrackersGetResponse {
|
|
8356
8929
|
sla_tracker: SlaTracker;
|
|
8357
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
|
+
}
|
|
8358
8973
|
/** Type of the SLA. */
|
|
8359
8974
|
export declare enum SlaType {
|
|
8360
8975
|
External = "external",
|
|
@@ -9017,8 +9632,44 @@ export interface SurveysSubmitRequest {
|
|
|
9017
9632
|
/** The ID of the survey to submit the response to. */
|
|
9018
9633
|
survey: string;
|
|
9019
9634
|
}
|
|
9020
|
-
/** surveys-submit-response */
|
|
9021
|
-
export type SurveysSubmitResponse = object;
|
|
9635
|
+
/** surveys-submit-response */
|
|
9636
|
+
export type SurveysSubmitResponse = object;
|
|
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
|
+
}
|
|
9022
9673
|
/** sync-metadata-filter */
|
|
9023
9674
|
export interface SyncMetadataFilter {
|
|
9024
9675
|
/** Filters for issues with this specific external reference. */
|
|
@@ -9056,6 +9707,29 @@ export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
|
9056
9707
|
Failed = "failed",
|
|
9057
9708
|
Succeeded = "succeeded"
|
|
9058
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;
|
|
9059
9733
|
/** sys-user */
|
|
9060
9734
|
export type SysUser = UserBase;
|
|
9061
9735
|
/** sys-user-summary */
|
|
@@ -9774,6 +10448,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
9774
10448
|
object_display_id: string;
|
|
9775
10449
|
/** The type of object that the Timeline entry belongs to. */
|
|
9776
10450
|
object_type?: TimelineEntryObjectType;
|
|
10451
|
+
/** Display panels for the Timeline entry. */
|
|
10452
|
+
panels?: TimelineEntryPanel[];
|
|
9777
10453
|
/** The reactions to the entry. */
|
|
9778
10454
|
reactions?: TimelineReaction[];
|
|
9779
10455
|
/** Thread. */
|
|
@@ -10866,6 +11542,8 @@ export type WorkBase = AtomBase & {
|
|
|
10866
11542
|
stock_schema_fragment?: string;
|
|
10867
11543
|
/** Subtype corresponding to the custom type fragment. */
|
|
10868
11544
|
subtype?: string;
|
|
11545
|
+
/** Mixin for storing sync metadata. */
|
|
11546
|
+
sync_metadata?: SyncMetadata;
|
|
10869
11547
|
/** Tags associated with the object. */
|
|
10870
11548
|
tags?: TagWithValue[];
|
|
10871
11549
|
/**
|
|
@@ -11791,6 +12469,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11791
12469
|
* only external articles are returned.
|
|
11792
12470
|
*/
|
|
11793
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;
|
|
11794
12476
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
11795
12477
|
/**
|
|
11796
12478
|
* @description Get count of articles matching given filter.
|
|
@@ -11902,6 +12584,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11902
12584
|
* only external articles are returned.
|
|
11903
12585
|
*/
|
|
11904
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;
|
|
11905
12591
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
11906
12592
|
/**
|
|
11907
12593
|
* @description Lists a collection of articles.
|
|
@@ -12012,6 +12698,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12012
12698
|
* @secure
|
|
12013
12699
|
*/
|
|
12014
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>>;
|
|
12015
12710
|
/**
|
|
12016
12711
|
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
12017
12712
|
*
|
|
@@ -12471,6 +13166,117 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12471
13166
|
* @secure
|
|
12472
13167
|
*/
|
|
12473
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>>;
|
|
12474
13280
|
/**
|
|
12475
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.
|
|
12476
13282
|
*
|
|
@@ -12667,6 +13473,127 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12667
13473
|
* @secure
|
|
12668
13474
|
*/
|
|
12669
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>>;
|
|
12670
13597
|
/**
|
|
12671
13598
|
* @description Counts the engagement records.
|
|
12672
13599
|
*
|
|
@@ -13370,6 +14297,60 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13370
14297
|
* @secure
|
|
13371
14298
|
*/
|
|
13372
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>>;
|
|
13373
14354
|
/**
|
|
13374
14355
|
* @description Lists metric definitions matching a filter.
|
|
13375
14356
|
*
|
|
@@ -13415,6 +14396,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13415
14396
|
* @secure
|
|
13416
14397
|
*/
|
|
13417
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>>;
|
|
13418
14408
|
/**
|
|
13419
14409
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
13420
14410
|
*
|
|
@@ -13971,6 +14961,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13971
14961
|
* @secure
|
|
13972
14962
|
*/
|
|
13973
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>>;
|
|
13974
14973
|
/**
|
|
13975
14974
|
* @description Returns the Rev user of a Rev organization by its ID.
|
|
13976
14975
|
*
|
|
@@ -14082,6 +15081,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14082
15081
|
* @secure
|
|
14083
15082
|
*/
|
|
14084
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>>;
|
|
14085
15102
|
/**
|
|
14086
15103
|
* @description Scans through all Rev users.
|
|
14087
15104
|
*
|
|
@@ -14236,6 +15253,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14236
15253
|
cursor?: string;
|
|
14237
15254
|
/** Whether only deprecated fragments should be filtered. */
|
|
14238
15255
|
deprecated?: boolean;
|
|
15256
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
15257
|
+
is_custom_leaf_type?: boolean;
|
|
14239
15258
|
/** The list of leaf types. */
|
|
14240
15259
|
leaf_type?: string[];
|
|
14241
15260
|
/**
|
|
@@ -14502,6 +15521,70 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14502
15521
|
* @secure
|
|
14503
15522
|
*/
|
|
14504
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>>;
|
|
14505
15588
|
/**
|
|
14506
15589
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
14507
15590
|
*
|