@devrev/typescript-sdk 1.1.32 → 1.1.34
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
|
};
|
|
@@ -1400,6 +1402,25 @@ export interface AuthTokensGetRequest {
|
|
|
1400
1402
|
export interface AuthTokensGetResponse {
|
|
1401
1403
|
token: AuthToken;
|
|
1402
1404
|
}
|
|
1405
|
+
/**
|
|
1406
|
+
* auth-tokens-info-request
|
|
1407
|
+
* The request to get the Dev organization, user and token attributes
|
|
1408
|
+
* extracted from the auth token.
|
|
1409
|
+
*/
|
|
1410
|
+
export type AuthTokensInfoRequest = object;
|
|
1411
|
+
/**
|
|
1412
|
+
* auth-tokens-info-response
|
|
1413
|
+
* The Dev organization, user and token attributes extracted from the auth
|
|
1414
|
+
* token.
|
|
1415
|
+
*/
|
|
1416
|
+
export interface AuthTokensInfoResponse {
|
|
1417
|
+
/** The Dev organization attributes extracted from the auth token. */
|
|
1418
|
+
organization: AuthTokensOrgAttributes;
|
|
1419
|
+
/** The token attributes extracted from the auth token. */
|
|
1420
|
+
token: AuthTokensTokenAttributes;
|
|
1421
|
+
/** The user attributes extracted from the auth token. */
|
|
1422
|
+
user: AuthTokensUserAttributes;
|
|
1423
|
+
}
|
|
1403
1424
|
/**
|
|
1404
1425
|
* auth-tokens-list-request
|
|
1405
1426
|
* A request to list the token metadata.
|
|
@@ -1427,6 +1448,21 @@ export interface AuthTokensListResponse {
|
|
|
1427
1448
|
/** The list of token metadata. */
|
|
1428
1449
|
tokens: AuthToken[];
|
|
1429
1450
|
}
|
|
1451
|
+
/**
|
|
1452
|
+
* auth-tokens-org-attributes
|
|
1453
|
+
* The Dev organization attributes extracted from the auth token.
|
|
1454
|
+
*/
|
|
1455
|
+
export interface AuthTokensOrgAttributes {
|
|
1456
|
+
/** The display ID of the Dev organization. */
|
|
1457
|
+
display_id: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* The ID of the the Dev organization.
|
|
1460
|
+
* @example "DEV-AbCdEfGh"
|
|
1461
|
+
*/
|
|
1462
|
+
id: string;
|
|
1463
|
+
/** The slug of the Dev organization. */
|
|
1464
|
+
slug?: string;
|
|
1465
|
+
}
|
|
1430
1466
|
/**
|
|
1431
1467
|
* auth-tokens-org-traits
|
|
1432
1468
|
* Carries Rev org info.
|
|
@@ -1485,6 +1521,26 @@ export interface AuthTokensSelfDeleteRequest {
|
|
|
1485
1521
|
/** The type of the requested token. */
|
|
1486
1522
|
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1487
1523
|
}
|
|
1524
|
+
/**
|
|
1525
|
+
* auth-tokens-token-attributes
|
|
1526
|
+
* The token attributes extracted from the auth token.
|
|
1527
|
+
*/
|
|
1528
|
+
export interface AuthTokensTokenAttributes {
|
|
1529
|
+
/**
|
|
1530
|
+
* The expiry (exp) of the token in seconds from Unix epoch.
|
|
1531
|
+
* @format int64
|
|
1532
|
+
*/
|
|
1533
|
+
expiry: number;
|
|
1534
|
+
/**
|
|
1535
|
+
* The issued at (iat) time of the token in seconds from Unix epoch.
|
|
1536
|
+
* @format int64
|
|
1537
|
+
*/
|
|
1538
|
+
issued_at: number;
|
|
1539
|
+
/** The issuer ID (iss) of the token. */
|
|
1540
|
+
issuer: string;
|
|
1541
|
+
/** The subject (sub) of the token. */
|
|
1542
|
+
subject: string;
|
|
1543
|
+
}
|
|
1488
1544
|
/**
|
|
1489
1545
|
* auth-tokens-update-request
|
|
1490
1546
|
* A request to update the token metadata.
|
|
@@ -1502,6 +1558,23 @@ export interface AuthTokensUpdateRequest {
|
|
|
1502
1558
|
export interface AuthTokensUpdateResponse {
|
|
1503
1559
|
token: AuthToken;
|
|
1504
1560
|
}
|
|
1561
|
+
/**
|
|
1562
|
+
* auth-tokens-user-attributes
|
|
1563
|
+
* The user attributes extracted from the auth token.
|
|
1564
|
+
*/
|
|
1565
|
+
export interface AuthTokensUserAttributes {
|
|
1566
|
+
type: UserType;
|
|
1567
|
+
/** The display ID of the user. */
|
|
1568
|
+
display_id: string;
|
|
1569
|
+
/** The display name of the user. */
|
|
1570
|
+
display_name?: string;
|
|
1571
|
+
/** The email address of the user. */
|
|
1572
|
+
email?: string;
|
|
1573
|
+
/** The full name of the user. */
|
|
1574
|
+
full_name?: string;
|
|
1575
|
+
/** The ID of the user. */
|
|
1576
|
+
id: string;
|
|
1577
|
+
}
|
|
1505
1578
|
/**
|
|
1506
1579
|
* auth-tokens-user-traits
|
|
1507
1580
|
* Carries Rev user info.
|
|
@@ -1994,6 +2067,8 @@ export interface ConversationsCreateRequest {
|
|
|
1994
2067
|
/** Initial messages on the conversation. */
|
|
1995
2068
|
messages?: ConversationsCreateRequestMessage[];
|
|
1996
2069
|
metadata?: ConversationsCreateRequestMetadata;
|
|
2070
|
+
/** The users that own the conversation. */
|
|
2071
|
+
owned_by?: string[];
|
|
1997
2072
|
/** Whether the conversation is from a source channel. */
|
|
1998
2073
|
source_channel?: string;
|
|
1999
2074
|
/** Sets an object's initial stage. */
|
|
@@ -2210,6 +2285,7 @@ export interface ConversationsUpdateRequest {
|
|
|
2210
2285
|
/** Whether the conversation is spam. */
|
|
2211
2286
|
is_spam?: boolean;
|
|
2212
2287
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
2288
|
+
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
2213
2289
|
/** Updates an object's stage. */
|
|
2214
2290
|
stage?: StageUpdate;
|
|
2215
2291
|
/** The updated status of the conversation. */
|
|
@@ -2231,8 +2307,22 @@ export interface ConversationsUpdateRequestAppliesToParts {
|
|
|
2231
2307
|
export interface ConversationsUpdateRequestMetadata {
|
|
2232
2308
|
url_context?: string;
|
|
2233
2309
|
}
|
|
2310
|
+
/** conversations-update-request-owned-by */
|
|
2311
|
+
export interface ConversationsUpdateRequestOwnedBy {
|
|
2312
|
+
/**
|
|
2313
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2314
|
+
* empty.
|
|
2315
|
+
* @minItems 1
|
|
2316
|
+
* @example ["DEVU-12345"]
|
|
2317
|
+
*/
|
|
2318
|
+
set?: string[];
|
|
2319
|
+
}
|
|
2234
2320
|
/** conversations-update-request-tags */
|
|
2235
2321
|
export interface ConversationsUpdateRequestTags {
|
|
2322
|
+
/** Adds the provided tags on the conversation. */
|
|
2323
|
+
add?: AddTagWithValue[];
|
|
2324
|
+
/** Removes the provided tags on the conversation. */
|
|
2325
|
+
remove?: RemoveTagWithValue[];
|
|
2236
2326
|
/** Sets the tag IDs to the provided tags. */
|
|
2237
2327
|
set?: SetTagWithValue[];
|
|
2238
2328
|
}
|
|
@@ -2493,12 +2583,167 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
2493
2583
|
export interface CustomLinkTypeUpdateResponse {
|
|
2494
2584
|
custom_link_type: CustomLinkType;
|
|
2495
2585
|
}
|
|
2586
|
+
/** custom-object */
|
|
2587
|
+
export type CustomObject = AtomBase & {
|
|
2588
|
+
/** Custom fields. */
|
|
2589
|
+
custom_fields?: object;
|
|
2590
|
+
/**
|
|
2591
|
+
* Custom schema fragments.
|
|
2592
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2593
|
+
*/
|
|
2594
|
+
custom_schema_fragments?: string[];
|
|
2595
|
+
/**
|
|
2596
|
+
* Stock schema fragment.
|
|
2597
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
2598
|
+
*/
|
|
2599
|
+
stock_schema_fragment?: string;
|
|
2600
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
2601
|
+
subtype?: string;
|
|
2602
|
+
};
|
|
2496
2603
|
/** custom-object-search-summary */
|
|
2497
2604
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2498
2605
|
custom_object: CustomObjectSummary;
|
|
2499
2606
|
};
|
|
2500
2607
|
/** custom-object-summary */
|
|
2501
2608
|
export type CustomObjectSummary = AtomBaseSummary;
|
|
2609
|
+
/** custom-objects-count-request */
|
|
2610
|
+
export interface CustomObjectsCountRequest {
|
|
2611
|
+
/** List of filters to apply. */
|
|
2612
|
+
filters?: any[];
|
|
2613
|
+
/** Leaf type to filter. */
|
|
2614
|
+
leaf_type: string;
|
|
2615
|
+
}
|
|
2616
|
+
/** custom-objects-count-response */
|
|
2617
|
+
export interface CustomObjectsCountResponse {
|
|
2618
|
+
/**
|
|
2619
|
+
* The count of custom objects.
|
|
2620
|
+
* @format int64
|
|
2621
|
+
*/
|
|
2622
|
+
count: number;
|
|
2623
|
+
}
|
|
2624
|
+
/** custom-objects-create-request */
|
|
2625
|
+
export interface CustomObjectsCreateRequest {
|
|
2626
|
+
/** Custom fields of the custom object. */
|
|
2627
|
+
custom_fields?: object;
|
|
2628
|
+
/**
|
|
2629
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2630
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2631
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2632
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2633
|
+
* specifier, it remains unmodified.
|
|
2634
|
+
*/
|
|
2635
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2636
|
+
/** Leaf type of the custom object. */
|
|
2637
|
+
leaf_type: string;
|
|
2638
|
+
/** The stage of the custom object. */
|
|
2639
|
+
stage?: string;
|
|
2640
|
+
/**
|
|
2641
|
+
* The type of stage validations options when creating a custom
|
|
2642
|
+
* object.
|
|
2643
|
+
*/
|
|
2644
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
2645
|
+
/** Title of the custom object. */
|
|
2646
|
+
title?: string;
|
|
2647
|
+
/**
|
|
2648
|
+
* The unique key of the custom object.This can be used to hold an
|
|
2649
|
+
* external reference to another object.
|
|
2650
|
+
*/
|
|
2651
|
+
unique_key: string;
|
|
2652
|
+
}
|
|
2653
|
+
/** custom-objects-create-response */
|
|
2654
|
+
export interface CustomObjectsCreateResponse {
|
|
2655
|
+
custom_object: CustomObject;
|
|
2656
|
+
}
|
|
2657
|
+
/** custom-objects-delete-request */
|
|
2658
|
+
export interface CustomObjectsDeleteRequest {
|
|
2659
|
+
/** The ID of the custom object to get. */
|
|
2660
|
+
id: string;
|
|
2661
|
+
}
|
|
2662
|
+
/** custom-objects-delete-response */
|
|
2663
|
+
export type CustomObjectsDeleteResponse = object;
|
|
2664
|
+
/** custom-objects-get-request */
|
|
2665
|
+
export interface CustomObjectsGetRequest {
|
|
2666
|
+
/** The ID of the custom object to get. */
|
|
2667
|
+
id?: string;
|
|
2668
|
+
}
|
|
2669
|
+
/** custom-objects-get-response */
|
|
2670
|
+
export interface CustomObjectsGetResponse {
|
|
2671
|
+
custom_object: CustomObject;
|
|
2672
|
+
}
|
|
2673
|
+
/** custom-objects-list-request */
|
|
2674
|
+
export interface CustomObjectsListRequest {
|
|
2675
|
+
/**
|
|
2676
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2677
|
+
* iteration starts from the beginning.
|
|
2678
|
+
*/
|
|
2679
|
+
cursor?: string;
|
|
2680
|
+
/** List of filters to apply. */
|
|
2681
|
+
filter?: any[];
|
|
2682
|
+
/** Leaf type to filter. */
|
|
2683
|
+
leaf_type: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* The maximum number of items.
|
|
2686
|
+
* @format int32
|
|
2687
|
+
*/
|
|
2688
|
+
limit?: number;
|
|
2689
|
+
/**
|
|
2690
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2691
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2692
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2693
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2694
|
+
* always be returned in the specified sort-by order.
|
|
2695
|
+
*/
|
|
2696
|
+
mode?: ListMode;
|
|
2697
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2698
|
+
sort_by?: string[];
|
|
2699
|
+
}
|
|
2700
|
+
/**
|
|
2701
|
+
* custom-objects-list-response
|
|
2702
|
+
* The response to listing all custom objects matching the filter
|
|
2703
|
+
* criteria.
|
|
2704
|
+
*/
|
|
2705
|
+
export interface CustomObjectsListResponse {
|
|
2706
|
+
/**
|
|
2707
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2708
|
+
* sort order. If not set, then no later elements exist.
|
|
2709
|
+
*/
|
|
2710
|
+
next_cursor?: string;
|
|
2711
|
+
/**
|
|
2712
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2713
|
+
* sort order. If not set, then no prior elements exist.
|
|
2714
|
+
*/
|
|
2715
|
+
prev_cursor?: string;
|
|
2716
|
+
/** The custom objects. */
|
|
2717
|
+
result: CustomObject[];
|
|
2718
|
+
}
|
|
2719
|
+
/** custom-objects-update-request */
|
|
2720
|
+
export interface CustomObjectsUpdateRequest {
|
|
2721
|
+
/** Custom fields of the custom object. */
|
|
2722
|
+
custom_fields?: object;
|
|
2723
|
+
/**
|
|
2724
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2725
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2726
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2727
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2728
|
+
* specifier, it remains unmodified.
|
|
2729
|
+
*/
|
|
2730
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2731
|
+
/** The ID of the custom object to update. */
|
|
2732
|
+
id: string;
|
|
2733
|
+
/** Updates the stage of the custom object. */
|
|
2734
|
+
stage?: string | null;
|
|
2735
|
+
/**
|
|
2736
|
+
* The type of stage validations options when updating the stage of a
|
|
2737
|
+
* custom object.
|
|
2738
|
+
*/
|
|
2739
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
2740
|
+
/** Updates the title of the custom object. */
|
|
2741
|
+
title?: string | null;
|
|
2742
|
+
}
|
|
2743
|
+
/** custom-objects-update-response */
|
|
2744
|
+
export interface CustomObjectsUpdateResponse {
|
|
2745
|
+
custom_object: CustomObject;
|
|
2746
|
+
}
|
|
2502
2747
|
/** custom-schema-fragment */
|
|
2503
2748
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
2504
2749
|
type: CustomSchemaFragmentType;
|
|
@@ -2566,6 +2811,8 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
2566
2811
|
cursor?: string;
|
|
2567
2812
|
/** Whether only deprecated fragments should be filtered. */
|
|
2568
2813
|
deprecated?: boolean;
|
|
2814
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
2815
|
+
is_custom_leaf_type?: boolean;
|
|
2569
2816
|
/** The list of leaf types. */
|
|
2570
2817
|
leaf_type?: string[];
|
|
2571
2818
|
/**
|
|
@@ -2792,6 +3039,8 @@ export type CustomState = AtomBase & {
|
|
|
2792
3039
|
};
|
|
2793
3040
|
/** custom-state-summary */
|
|
2794
3041
|
export type CustomStateSummary = AtomBaseSummary & {
|
|
3042
|
+
/** True if this is a final state. */
|
|
3043
|
+
is_final?: boolean;
|
|
2795
3044
|
/** The human readable name of the state. */
|
|
2796
3045
|
name?: string;
|
|
2797
3046
|
};
|
|
@@ -2956,6 +3205,21 @@ export declare enum DateTimePresetType {
|
|
|
2956
3205
|
LastNDays = "last_n_days",
|
|
2957
3206
|
NextNDays = "next_n_days"
|
|
2958
3207
|
}
|
|
3208
|
+
/**
|
|
3209
|
+
* delete-rev-users-personal-data-request
|
|
3210
|
+
* Request object to delete a contact's information.
|
|
3211
|
+
*/
|
|
3212
|
+
export interface DeleteRevUsersPersonalDataRequest {
|
|
3213
|
+
/** Email of the contact. */
|
|
3214
|
+
email: string;
|
|
3215
|
+
}
|
|
3216
|
+
/**
|
|
3217
|
+
* delete-rev-users-personal-data-response
|
|
3218
|
+
* Response for the contacts personal data detete request. Response is
|
|
3219
|
+
* empty as the process is asynchronous. Upon completion, the user will be
|
|
3220
|
+
* notified.
|
|
3221
|
+
*/
|
|
3222
|
+
export type DeleteRevUsersPersonalDataResponse = object;
|
|
2959
3223
|
/**
|
|
2960
3224
|
* dev-org-auth-connections-create-request
|
|
2961
3225
|
* Request to create a new enterprise authentication connection.
|
|
@@ -3367,6 +3631,196 @@ export interface DevUsersUpdateRequest {
|
|
|
3367
3631
|
export interface DevUsersUpdateResponse {
|
|
3368
3632
|
dev_user: DevUser;
|
|
3369
3633
|
}
|
|
3634
|
+
/** directories-count-request */
|
|
3635
|
+
export interface DirectoriesCountRequest {
|
|
3636
|
+
/**
|
|
3637
|
+
* Filters for directories created by any of the provided users.
|
|
3638
|
+
* @example ["DEVU-12345"]
|
|
3639
|
+
*/
|
|
3640
|
+
created_by?: string[];
|
|
3641
|
+
/**
|
|
3642
|
+
* Filters for directories modified by any of the provided users.
|
|
3643
|
+
* @example ["DEVU-12345"]
|
|
3644
|
+
*/
|
|
3645
|
+
modified_by?: string[];
|
|
3646
|
+
}
|
|
3647
|
+
/** directories-count-response */
|
|
3648
|
+
export interface DirectoriesCountResponse {
|
|
3649
|
+
/**
|
|
3650
|
+
* The total number of directories matching the filter.
|
|
3651
|
+
* @format int32
|
|
3652
|
+
*/
|
|
3653
|
+
count: number;
|
|
3654
|
+
}
|
|
3655
|
+
/**
|
|
3656
|
+
* directories-create-request
|
|
3657
|
+
* The request to create a directory.
|
|
3658
|
+
*/
|
|
3659
|
+
export interface DirectoriesCreateRequest {
|
|
3660
|
+
/** Description for the directory. */
|
|
3661
|
+
description?: string;
|
|
3662
|
+
/** Icon for the directory. */
|
|
3663
|
+
icon?: string;
|
|
3664
|
+
/** Parent directory of the directory. */
|
|
3665
|
+
parent?: string;
|
|
3666
|
+
/** Whether the directory is published. */
|
|
3667
|
+
published?: boolean;
|
|
3668
|
+
/** Tags associated with the directory. */
|
|
3669
|
+
tags?: SetTagWithValue[];
|
|
3670
|
+
/**
|
|
3671
|
+
* ID of the thumbnail artifact.
|
|
3672
|
+
* @example "ARTIFACT-12345"
|
|
3673
|
+
*/
|
|
3674
|
+
thumbnail?: string;
|
|
3675
|
+
/** Title of the directory. */
|
|
3676
|
+
title: string;
|
|
3677
|
+
}
|
|
3678
|
+
/**
|
|
3679
|
+
* directories-create-response
|
|
3680
|
+
* Create directory response.
|
|
3681
|
+
*/
|
|
3682
|
+
export interface DirectoriesCreateResponse {
|
|
3683
|
+
directory: Directory;
|
|
3684
|
+
}
|
|
3685
|
+
/**
|
|
3686
|
+
* directories-delete-request
|
|
3687
|
+
* The request to delete a directory.
|
|
3688
|
+
*/
|
|
3689
|
+
export interface DirectoriesDeleteRequest {
|
|
3690
|
+
/** The ID of the directory to delete. */
|
|
3691
|
+
id: string;
|
|
3692
|
+
}
|
|
3693
|
+
/** directories-delete-response */
|
|
3694
|
+
export type DirectoriesDeleteResponse = object;
|
|
3695
|
+
/**
|
|
3696
|
+
* directories-get-request
|
|
3697
|
+
* The request to get a directory.
|
|
3698
|
+
*/
|
|
3699
|
+
export interface DirectoriesGetRequest {
|
|
3700
|
+
/** The ID of the requested directory. */
|
|
3701
|
+
id: string;
|
|
3702
|
+
}
|
|
3703
|
+
/**
|
|
3704
|
+
* directories-get-response
|
|
3705
|
+
* Get directory response.
|
|
3706
|
+
*/
|
|
3707
|
+
export interface DirectoriesGetResponse {
|
|
3708
|
+
directory: Directory;
|
|
3709
|
+
}
|
|
3710
|
+
/**
|
|
3711
|
+
* directories-list-request
|
|
3712
|
+
* The request to list directories.
|
|
3713
|
+
*/
|
|
3714
|
+
export interface DirectoriesListRequest {
|
|
3715
|
+
/**
|
|
3716
|
+
* Filters for directories created by any of the provided users.
|
|
3717
|
+
* @example ["DEVU-12345"]
|
|
3718
|
+
*/
|
|
3719
|
+
created_by?: string[];
|
|
3720
|
+
/**
|
|
3721
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3722
|
+
* iteration starts from the beginning.
|
|
3723
|
+
*/
|
|
3724
|
+
cursor?: string;
|
|
3725
|
+
/**
|
|
3726
|
+
* The maximum number of directories to return. The default is '50'.
|
|
3727
|
+
* @format int32
|
|
3728
|
+
*/
|
|
3729
|
+
limit?: number;
|
|
3730
|
+
/**
|
|
3731
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3732
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3733
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3734
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3735
|
+
* always be returned in the specified sort-by order.
|
|
3736
|
+
*/
|
|
3737
|
+
mode?: ListMode;
|
|
3738
|
+
/**
|
|
3739
|
+
* Filters for directories modified by any of the provided users.
|
|
3740
|
+
* @example ["DEVU-12345"]
|
|
3741
|
+
*/
|
|
3742
|
+
modified_by?: string[];
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* directories-list-response
|
|
3746
|
+
* List directory response.
|
|
3747
|
+
*/
|
|
3748
|
+
export interface DirectoriesListResponse {
|
|
3749
|
+
/** The list of directories. */
|
|
3750
|
+
directories: Directory[];
|
|
3751
|
+
/**
|
|
3752
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3753
|
+
* sort order. If not set, then no later elements exist.
|
|
3754
|
+
*/
|
|
3755
|
+
next_cursor?: string;
|
|
3756
|
+
/**
|
|
3757
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3758
|
+
* sort order. If not set, then no prior elements exist.
|
|
3759
|
+
*/
|
|
3760
|
+
prev_cursor?: string;
|
|
3761
|
+
}
|
|
3762
|
+
/**
|
|
3763
|
+
* directories-update-request
|
|
3764
|
+
* The request to update a directory.
|
|
3765
|
+
*/
|
|
3766
|
+
export interface DirectoriesUpdateRequest {
|
|
3767
|
+
/** The updated description for the directory. */
|
|
3768
|
+
description?: string;
|
|
3769
|
+
/** The updated icon for the directory. */
|
|
3770
|
+
icon?: string;
|
|
3771
|
+
/** The ID of the directory to update. */
|
|
3772
|
+
id: string;
|
|
3773
|
+
/** The updated parent directory for the directory. */
|
|
3774
|
+
parent?: string | null;
|
|
3775
|
+
/** Whether the directory is published. */
|
|
3776
|
+
published?: boolean;
|
|
3777
|
+
reorder?: DirectoriesUpdateRequestReorder;
|
|
3778
|
+
tags?: DirectoriesUpdateRequestTags;
|
|
3779
|
+
/**
|
|
3780
|
+
* ID of the thumbnail artifact.
|
|
3781
|
+
* @example "ARTIFACT-12345"
|
|
3782
|
+
*/
|
|
3783
|
+
thumbnail?: string;
|
|
3784
|
+
/** The updated title for the directory. */
|
|
3785
|
+
title?: string;
|
|
3786
|
+
}
|
|
3787
|
+
/** directories-update-request-reorder */
|
|
3788
|
+
export interface DirectoriesUpdateRequestReorder {
|
|
3789
|
+
/** The directory after which the reordered directory is placed. */
|
|
3790
|
+
after?: string;
|
|
3791
|
+
/** The directory before which the reordered directory is placed. */
|
|
3792
|
+
before?: string;
|
|
3793
|
+
}
|
|
3794
|
+
/** directories-update-request-tags */
|
|
3795
|
+
export interface DirectoriesUpdateRequestTags {
|
|
3796
|
+
/** Sets the provided tags on the directory. */
|
|
3797
|
+
set?: SetTagWithValue[];
|
|
3798
|
+
}
|
|
3799
|
+
/**
|
|
3800
|
+
* directories-update-response
|
|
3801
|
+
* Update directory response.
|
|
3802
|
+
*/
|
|
3803
|
+
export interface DirectoriesUpdateResponse {
|
|
3804
|
+
directory: Directory;
|
|
3805
|
+
}
|
|
3806
|
+
/** directory */
|
|
3807
|
+
export type Directory = AtomBase & {
|
|
3808
|
+
body?: ArtifactSummary;
|
|
3809
|
+
/** Description of the directory. */
|
|
3810
|
+
description?: string;
|
|
3811
|
+
/** Icon of the directory. */
|
|
3812
|
+
icon?: string;
|
|
3813
|
+
parent?: DirectorySummary;
|
|
3814
|
+
/** Whether the directory is published. */
|
|
3815
|
+
published?: boolean;
|
|
3816
|
+
/** Rank of the directory. */
|
|
3817
|
+
rank?: string;
|
|
3818
|
+
/** Tags associated with the directory. */
|
|
3819
|
+
tags?: TagWithValue[];
|
|
3820
|
+
thumbnail?: ArtifactSummary;
|
|
3821
|
+
/** Title of the directory. */
|
|
3822
|
+
title?: string;
|
|
3823
|
+
};
|
|
3370
3824
|
/** directory-summary */
|
|
3371
3825
|
export type DirectorySummary = AtomBaseSummary;
|
|
3372
3826
|
/**
|
|
@@ -3503,7 +3957,13 @@ export interface EngagementsCreateRequest {
|
|
|
3503
3957
|
* Currently, only accounts and opportunities are supported.
|
|
3504
3958
|
* @example "ACC-12345"
|
|
3505
3959
|
*/
|
|
3506
|
-
parent
|
|
3960
|
+
parent?: string;
|
|
3961
|
+
/**
|
|
3962
|
+
* The parent object IDs to which the engagement is associated.
|
|
3963
|
+
* Currently, only accounts and opportunities are supported.
|
|
3964
|
+
* @example ["ACC-12345"]
|
|
3965
|
+
*/
|
|
3966
|
+
parents?: string[];
|
|
3507
3967
|
/**
|
|
3508
3968
|
* The date and time when the engagement was scheduled.
|
|
3509
3969
|
* @format date-time
|
|
@@ -3607,6 +4067,7 @@ export interface EngagementsUpdateRequest {
|
|
|
3607
4067
|
/** The engagement ID. */
|
|
3608
4068
|
id: string;
|
|
3609
4069
|
members?: EngagementsUpdateRequestMembers;
|
|
4070
|
+
parents?: EngagementsUpdateRequestParents;
|
|
3610
4071
|
/**
|
|
3611
4072
|
* Updates the date and time when the engagement was scheduled.
|
|
3612
4073
|
* @format date-time
|
|
@@ -3635,6 +4096,15 @@ export interface EngagementsUpdateRequestMembers {
|
|
|
3635
4096
|
*/
|
|
3636
4097
|
set?: string[];
|
|
3637
4098
|
}
|
|
4099
|
+
/** engagements-update-request-parents */
|
|
4100
|
+
export interface EngagementsUpdateRequestParents {
|
|
4101
|
+
/**
|
|
4102
|
+
* Sets the parent IDs.
|
|
4103
|
+
* @maxItems 50
|
|
4104
|
+
* @example ["ACC-12345"]
|
|
4105
|
+
*/
|
|
4106
|
+
set?: string[];
|
|
4107
|
+
}
|
|
3638
4108
|
/** engagements-update-request-tags */
|
|
3639
4109
|
export interface EngagementsUpdateRequestTags {
|
|
3640
4110
|
/** Sets the provided tags on the engagement item. */
|
|
@@ -4221,9 +4691,11 @@ export interface EventTagDeleted {
|
|
|
4221
4691
|
* @example "TAG-12345"
|
|
4222
4692
|
*/
|
|
4223
4693
|
id: string;
|
|
4694
|
+
old_tag?: Tag;
|
|
4224
4695
|
}
|
|
4225
4696
|
/** event-tag-updated */
|
|
4226
4697
|
export interface EventTagUpdated {
|
|
4698
|
+
old_tag?: Tag;
|
|
4227
4699
|
tag: Tag;
|
|
4228
4700
|
}
|
|
4229
4701
|
/** event-timeline-entry-created */
|
|
@@ -4289,6 +4761,30 @@ export interface EventWorkUpdated {
|
|
|
4289
4761
|
old_work?: Work;
|
|
4290
4762
|
work: Work;
|
|
4291
4763
|
}
|
|
4764
|
+
/**
|
|
4765
|
+
* export-audit-logs-request
|
|
4766
|
+
* Request object to get a log's information.
|
|
4767
|
+
*/
|
|
4768
|
+
export interface ExportAuditLogsRequest {
|
|
4769
|
+
/**
|
|
4770
|
+
* Time from which logs are to be retrieved.
|
|
4771
|
+
* @format date-time
|
|
4772
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4773
|
+
*/
|
|
4774
|
+
from: string;
|
|
4775
|
+
/**
|
|
4776
|
+
* Time till which logs are to be retrieved.
|
|
4777
|
+
* @format date-time
|
|
4778
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4779
|
+
*/
|
|
4780
|
+
to: string;
|
|
4781
|
+
}
|
|
4782
|
+
/**
|
|
4783
|
+
* export-audit-logs-response
|
|
4784
|
+
* Response for the audit logs export request. Response is empty as the
|
|
4785
|
+
* process is asynchronous. Upon completion, the user will be notified.
|
|
4786
|
+
*/
|
|
4787
|
+
export type ExportAuditLogsResponse = object;
|
|
4292
4788
|
/**
|
|
4293
4789
|
* external-identity
|
|
4294
4790
|
* External identity of a user.
|
|
@@ -4448,12 +4944,7 @@ export interface GeneralPreferencesGroup {
|
|
|
4448
4944
|
/** Preferences group for Availability. */
|
|
4449
4945
|
availability?: AvailabilityPreferencesGroup;
|
|
4450
4946
|
/** Preferred locale of the user. */
|
|
4451
|
-
preferred_locale?:
|
|
4452
|
-
}
|
|
4453
|
-
/** Preferred locale of the user. */
|
|
4454
|
-
export declare enum GeneralPreferencesGroupPreferredLocale {
|
|
4455
|
-
EnUs = "en_us",
|
|
4456
|
-
JaJp = "ja_jp"
|
|
4947
|
+
preferred_locale?: string;
|
|
4457
4948
|
}
|
|
4458
4949
|
/** Event type of the notification. */
|
|
4459
4950
|
export declare enum GenericNotificationEventType {
|
|
@@ -4463,6 +4954,21 @@ export declare enum GenericNotificationEventType {
|
|
|
4463
4954
|
Reminder = "reminder",
|
|
4464
4955
|
Update = "update"
|
|
4465
4956
|
}
|
|
4957
|
+
/**
|
|
4958
|
+
* get-rev-users-personal-data-request
|
|
4959
|
+
* Request object to get a contact's information.
|
|
4960
|
+
*/
|
|
4961
|
+
export interface GetRevUsersPersonalDataRequest {
|
|
4962
|
+
/** Email of the contact. */
|
|
4963
|
+
email: string;
|
|
4964
|
+
}
|
|
4965
|
+
/**
|
|
4966
|
+
* get-rev-users-personal-data-response
|
|
4967
|
+
* Response for the contacts personal data export request. Response is
|
|
4968
|
+
* empty as the process is asynchronous. Upon completion, the user will be
|
|
4969
|
+
* notified.
|
|
4970
|
+
*/
|
|
4971
|
+
export type GetRevUsersPersonalDataResponse = object;
|
|
4466
4972
|
/** group */
|
|
4467
4973
|
export type Group = AtomBase & {
|
|
4468
4974
|
/** Description of the group. */
|
|
@@ -4474,6 +4980,8 @@ export type Group = AtomBase & {
|
|
|
4474
4980
|
/** Name of the group. */
|
|
4475
4981
|
name?: string;
|
|
4476
4982
|
owner?: UserSummary;
|
|
4983
|
+
/** Mixin for storing sync metadata. */
|
|
4984
|
+
sync_metadata?: SyncMetadata;
|
|
4477
4985
|
};
|
|
4478
4986
|
/** Creation source of the group. */
|
|
4479
4987
|
export declare enum GroupIngestionSource {
|
|
@@ -4734,6 +5242,12 @@ export type Incident = AtomBase & {
|
|
|
4734
5242
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4735
5243
|
*/
|
|
4736
5244
|
acknowledged_date?: string;
|
|
5245
|
+
/**
|
|
5246
|
+
* Timestamp when the incident was actually resolved.
|
|
5247
|
+
* @format date-time
|
|
5248
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5249
|
+
*/
|
|
5250
|
+
actual_close_date?: string;
|
|
4737
5251
|
/** Parts to which the incident is applicable to. */
|
|
4738
5252
|
applies_to_parts?: PartSummary[];
|
|
4739
5253
|
/** Artifacts attached to the incident. */
|
|
@@ -4765,6 +5279,10 @@ export type Incident = AtomBase & {
|
|
|
4765
5279
|
mitigated_date?: string;
|
|
4766
5280
|
/** The users that own the incident. */
|
|
4767
5281
|
owned_by?: UserSummary[];
|
|
5282
|
+
/** The article ids of the Post-Incident Analysis(PIA) of the incident. */
|
|
5283
|
+
pia?: ArticleSummary[];
|
|
5284
|
+
/** The article ids of the playbook(s) associated with the incident. */
|
|
5285
|
+
playbooks?: ArticleSummary[];
|
|
4768
5286
|
/** The properties of an enum value. */
|
|
4769
5287
|
reported_by?: EnumValue;
|
|
4770
5288
|
/** The properties of an enum value. */
|
|
@@ -4997,6 +5515,8 @@ export interface IncidentsGroupRequest {
|
|
|
4997
5515
|
source?: number[];
|
|
4998
5516
|
/** Filters for incidents in any of the provided stages. */
|
|
4999
5517
|
stage?: string[];
|
|
5518
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
5519
|
+
subtype?: string[];
|
|
5000
5520
|
/** Provides ways to specify date ranges on objects. */
|
|
5001
5521
|
target_close_date?: DateFilter;
|
|
5002
5522
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5083,6 +5603,8 @@ export interface IncidentsListRequest {
|
|
|
5083
5603
|
source?: number[];
|
|
5084
5604
|
/** Filters for incidents in any of the provided stages. */
|
|
5085
5605
|
stage?: string[];
|
|
5606
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
5607
|
+
subtype?: string[];
|
|
5086
5608
|
/** Provides ways to specify date ranges on objects. */
|
|
5087
5609
|
target_close_date?: DateFilter;
|
|
5088
5610
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5312,17 +5834,21 @@ export interface LinkDescriptorFilter {
|
|
|
5312
5834
|
link_descriptors: LinkTargetDescriptor[];
|
|
5313
5835
|
}
|
|
5314
5836
|
/** link-endpoint-summary */
|
|
5315
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
5837
|
+
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
5316
5838
|
type: LinkEndpointType;
|
|
5317
5839
|
};
|
|
5318
5840
|
export declare enum LinkEndpointType {
|
|
5841
|
+
Account = "account",
|
|
5319
5842
|
Capability = "capability",
|
|
5320
5843
|
Conversation = "conversation",
|
|
5844
|
+
DevUser = "dev_user",
|
|
5321
5845
|
Enhancement = "enhancement",
|
|
5322
5846
|
Feature = "feature",
|
|
5323
5847
|
Issue = "issue",
|
|
5324
5848
|
Opportunity = "opportunity",
|
|
5325
5849
|
Product = "product",
|
|
5850
|
+
RevOrg = "rev_org",
|
|
5851
|
+
RevUser = "rev_user",
|
|
5326
5852
|
Task = "task",
|
|
5327
5853
|
Ticket = "ticket"
|
|
5328
5854
|
}
|
|
@@ -5384,6 +5910,7 @@ export declare enum LinkType {
|
|
|
5384
5910
|
IsConvertedTo = "is_converted_to",
|
|
5385
5911
|
IsDependentOn = "is_dependent_on",
|
|
5386
5912
|
IsDuplicateOf = "is_duplicate_of",
|
|
5913
|
+
IsFollowUpOf = "is_follow_up_of",
|
|
5387
5914
|
IsMergedInto = "is_merged_into",
|
|
5388
5915
|
IsParentOf = "is_parent_of",
|
|
5389
5916
|
IsPartOf = "is_part_of",
|
|
@@ -5535,6 +6062,32 @@ export declare enum MemberType {
|
|
|
5535
6062
|
RevUser = "rev_user",
|
|
5536
6063
|
SysUser = "sys_user"
|
|
5537
6064
|
}
|
|
6065
|
+
/** metric-action-execute-request */
|
|
6066
|
+
export interface MetricActionExecuteRequest {
|
|
6067
|
+
action: MetricActionExecuteRequestAction;
|
|
6068
|
+
/**
|
|
6069
|
+
* Timestamp of the event.
|
|
6070
|
+
* @format date-time
|
|
6071
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6072
|
+
*/
|
|
6073
|
+
event_date: string;
|
|
6074
|
+
/** The metric's ID for which the metric action is to be executed. */
|
|
6075
|
+
metric: string;
|
|
6076
|
+
/**
|
|
6077
|
+
* The underlying object's ID on which the metric action is to be
|
|
6078
|
+
* executed.
|
|
6079
|
+
*/
|
|
6080
|
+
object: string;
|
|
6081
|
+
}
|
|
6082
|
+
export declare enum MetricActionExecuteRequestAction {
|
|
6083
|
+
Complete = "complete",
|
|
6084
|
+
Pause = "pause",
|
|
6085
|
+
Restart = "restart",
|
|
6086
|
+
Resume = "resume",
|
|
6087
|
+
Start = "start"
|
|
6088
|
+
}
|
|
6089
|
+
/** metric-action-execute-response */
|
|
6090
|
+
export type MetricActionExecuteResponse = object;
|
|
5538
6091
|
/** metric-data-point */
|
|
5539
6092
|
export interface MetricDataPoint {
|
|
5540
6093
|
/**
|
|
@@ -5614,6 +6167,51 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
5614
6167
|
/** Human readable name of the metric. */
|
|
5615
6168
|
name?: string;
|
|
5616
6169
|
};
|
|
6170
|
+
/** metric-definitions-create-request */
|
|
6171
|
+
export interface MetricDefinitionsCreateRequest {
|
|
6172
|
+
/** The list of object types on which the metric can be applied. */
|
|
6173
|
+
applies_to: MetricDefinitionAppliesTo[];
|
|
6174
|
+
/**
|
|
6175
|
+
* Description of the purpose and operation of the metric.
|
|
6176
|
+
* @maxLength 1024
|
|
6177
|
+
*/
|
|
6178
|
+
description?: string;
|
|
6179
|
+
/**
|
|
6180
|
+
* A unique human readable name of the metric.
|
|
6181
|
+
* @minLength 1
|
|
6182
|
+
* @maxLength 64
|
|
6183
|
+
*/
|
|
6184
|
+
name: string;
|
|
6185
|
+
}
|
|
6186
|
+
/** metric-definitions-create-response */
|
|
6187
|
+
export interface MetricDefinitionsCreateResponse {
|
|
6188
|
+
metric_definition: MetricDefinition;
|
|
6189
|
+
}
|
|
6190
|
+
/** metric-definitions-delete-request */
|
|
6191
|
+
export interface MetricDefinitionsDeleteRequest {
|
|
6192
|
+
/** The ID of the metric definition to be deleted. */
|
|
6193
|
+
id: string;
|
|
6194
|
+
}
|
|
6195
|
+
/**
|
|
6196
|
+
* metric-definitions-delete-response
|
|
6197
|
+
* The response to deleting a metric definition.
|
|
6198
|
+
*/
|
|
6199
|
+
export type MetricDefinitionsDeleteResponse = object;
|
|
6200
|
+
/** metric-definitions-get-request */
|
|
6201
|
+
export interface MetricDefinitionsGetRequest {
|
|
6202
|
+
/** The ID of the metric definition to get. */
|
|
6203
|
+
id?: string;
|
|
6204
|
+
/**
|
|
6205
|
+
* The unique human readable name of the metric.
|
|
6206
|
+
* @minLength 1
|
|
6207
|
+
* @maxLength 64
|
|
6208
|
+
*/
|
|
6209
|
+
name?: string;
|
|
6210
|
+
}
|
|
6211
|
+
/** metric-definitions-get-response */
|
|
6212
|
+
export interface MetricDefinitionsGetResponse {
|
|
6213
|
+
metric_definition: MetricDefinition;
|
|
6214
|
+
}
|
|
5617
6215
|
/** metric-definitions-list-request */
|
|
5618
6216
|
export interface MetricDefinitionsListRequest {
|
|
5619
6217
|
/** The type of metric definitions sought. */
|
|
@@ -5643,6 +6241,8 @@ export interface MetricDefinitionsListRequest {
|
|
|
5643
6241
|
* always be returned in the specified sort-by order.
|
|
5644
6242
|
*/
|
|
5645
6243
|
mode?: ListMode;
|
|
6244
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
6245
|
+
sort_by?: string[];
|
|
5646
6246
|
/** The status of the metric definition. */
|
|
5647
6247
|
status?: MetricDefinitionStatus[];
|
|
5648
6248
|
}
|
|
@@ -5661,6 +6261,32 @@ export interface MetricDefinitionsListResponse {
|
|
|
5661
6261
|
*/
|
|
5662
6262
|
prev_cursor?: string;
|
|
5663
6263
|
}
|
|
6264
|
+
/** metric-definitions-update-request */
|
|
6265
|
+
export interface MetricDefinitionsUpdateRequest {
|
|
6266
|
+
/**
|
|
6267
|
+
* The updated description of the purpose and operation of the metric.
|
|
6268
|
+
* @maxLength 1024
|
|
6269
|
+
*/
|
|
6270
|
+
description?: string;
|
|
6271
|
+
/** The ID of the metric definition to update. */
|
|
6272
|
+
id: string;
|
|
6273
|
+
/**
|
|
6274
|
+
* The updated unique human readable name of the metric.
|
|
6275
|
+
* @minLength 1
|
|
6276
|
+
* @maxLength 64
|
|
6277
|
+
*/
|
|
6278
|
+
name?: string;
|
|
6279
|
+
/**
|
|
6280
|
+
* The status of the metric. 'active' metrics can be used to create new
|
|
6281
|
+
* SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
|
|
6282
|
+
* be updated between 'active' and 'inactive' states.
|
|
6283
|
+
*/
|
|
6284
|
+
status?: MetricDefinitionStatus;
|
|
6285
|
+
}
|
|
6286
|
+
/** metric-definitions-update-response */
|
|
6287
|
+
export interface MetricDefinitionsUpdateResponse {
|
|
6288
|
+
metric_definition: MetricDefinition;
|
|
6289
|
+
}
|
|
5664
6290
|
/** metrics-data */
|
|
5665
6291
|
export interface MetricsData {
|
|
5666
6292
|
/**
|
|
@@ -7186,6 +7812,25 @@ export interface RevUsersListResponse {
|
|
|
7186
7812
|
/** List containing all the Rev users. */
|
|
7187
7813
|
rev_users: RevUser[];
|
|
7188
7814
|
}
|
|
7815
|
+
/**
|
|
7816
|
+
* rev-users-merge-request
|
|
7817
|
+
* Request to merge two Rev users, retaining the primary user.
|
|
7818
|
+
*/
|
|
7819
|
+
export interface RevUsersMergeRequest {
|
|
7820
|
+
/** The ID of the primary Rev user, which will be retained. */
|
|
7821
|
+
primary_user: string;
|
|
7822
|
+
/**
|
|
7823
|
+
* The ID of the secondary Rev user, which will be merged into the
|
|
7824
|
+
* Primary Rev user.
|
|
7825
|
+
*/
|
|
7826
|
+
secondary_user: string;
|
|
7827
|
+
}
|
|
7828
|
+
/**
|
|
7829
|
+
* rev-users-merge-response
|
|
7830
|
+
* Acknowledgment response indicating that the merge request has been
|
|
7831
|
+
* received for processing asynchronously.
|
|
7832
|
+
*/
|
|
7833
|
+
export type RevUsersMergeResponse = object;
|
|
7189
7834
|
/**
|
|
7190
7835
|
* rev-users-scan-request
|
|
7191
7836
|
* Scans the list of Rev users.
|
|
@@ -8070,7 +8715,15 @@ export interface SetOrgScheduleFragmentSummary {
|
|
|
8070
8715
|
* set-shared-with-membership
|
|
8071
8716
|
* Information about the role the member receives due to the share.
|
|
8072
8717
|
*/
|
|
8073
|
-
export
|
|
8718
|
+
export interface SetSharedWithMembership {
|
|
8719
|
+
/** ID of the member the object is shared with. */
|
|
8720
|
+
member?: string;
|
|
8721
|
+
/**
|
|
8722
|
+
* ID of the role that describes what privileges the membership
|
|
8723
|
+
* entails.
|
|
8724
|
+
*/
|
|
8725
|
+
role?: string;
|
|
8726
|
+
}
|
|
8074
8727
|
/** set-sla-policy */
|
|
8075
8728
|
export interface SetSlaPolicy {
|
|
8076
8729
|
/** Metrics to apply to the selected items. */
|
|
@@ -8179,7 +8832,12 @@ export interface SetWeeklyOrgSchedule {
|
|
|
8179
8832
|
* shared-with-membership-filter
|
|
8180
8833
|
* Filter on target item based on intended audience.
|
|
8181
8834
|
*/
|
|
8182
|
-
export
|
|
8835
|
+
export interface SharedWithMembershipFilter {
|
|
8836
|
+
/** ID of the group/member with whom the item is shared. */
|
|
8837
|
+
member?: string;
|
|
8838
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
8839
|
+
role?: string;
|
|
8840
|
+
}
|
|
8183
8841
|
/** sla */
|
|
8184
8842
|
export type Sla = AtomBase & {
|
|
8185
8843
|
/**
|
|
@@ -8355,6 +9013,50 @@ export interface SlaTrackersGetRequest {
|
|
|
8355
9013
|
export interface SlaTrackersGetResponse {
|
|
8356
9014
|
sla_tracker: SlaTracker;
|
|
8357
9015
|
}
|
|
9016
|
+
/** sla-trackers-list-request */
|
|
9017
|
+
export interface SlaTrackersListRequest {
|
|
9018
|
+
created_date?: DateTimeFilter;
|
|
9019
|
+
/**
|
|
9020
|
+
* The cursor to resume iteration from. If not provided, then
|
|
9021
|
+
* iteration starts from the beginning.
|
|
9022
|
+
*/
|
|
9023
|
+
cursor?: string;
|
|
9024
|
+
/**
|
|
9025
|
+
* The maximum number of SLA trackers to return. The default is '50'.
|
|
9026
|
+
* @format int32
|
|
9027
|
+
*/
|
|
9028
|
+
limit?: number;
|
|
9029
|
+
/**
|
|
9030
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
9031
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
9032
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
9033
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
9034
|
+
* always be returned in the specified sort-by order.
|
|
9035
|
+
*/
|
|
9036
|
+
mode?: ListMode;
|
|
9037
|
+
modified_date?: DateTimeFilter;
|
|
9038
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
9039
|
+
sort_by?: string[];
|
|
9040
|
+
/** The SLA tracker stages the filter matches. */
|
|
9041
|
+
stage?: string[];
|
|
9042
|
+
/** The SLA tracker statuses the filter matches. */
|
|
9043
|
+
status?: string[];
|
|
9044
|
+
}
|
|
9045
|
+
/** sla-trackers-list-response */
|
|
9046
|
+
export interface SlaTrackersListResponse {
|
|
9047
|
+
/**
|
|
9048
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
9049
|
+
* sort order. If not set, then no later elements exist.
|
|
9050
|
+
*/
|
|
9051
|
+
next_cursor?: string;
|
|
9052
|
+
/**
|
|
9053
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
9054
|
+
* sort order. If not set, then no prior elements exist.
|
|
9055
|
+
*/
|
|
9056
|
+
prev_cursor?: string;
|
|
9057
|
+
/** The list of SLA trackers. */
|
|
9058
|
+
sla_trackers: SlaTracker[];
|
|
9059
|
+
}
|
|
8358
9060
|
/** Type of the SLA. */
|
|
8359
9061
|
export declare enum SlaType {
|
|
8360
9062
|
External = "external",
|
|
@@ -8447,6 +9149,8 @@ export interface SlasListRequest {
|
|
|
8447
9149
|
mode?: ListMode;
|
|
8448
9150
|
/** The SLA types the filter matches. */
|
|
8449
9151
|
sla_type?: SlaType[];
|
|
9152
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
9153
|
+
sort_by?: string[];
|
|
8450
9154
|
/** The SLA statuses the filter matches. */
|
|
8451
9155
|
status?: SlaStatus[];
|
|
8452
9156
|
}
|
|
@@ -9019,6 +9723,42 @@ export interface SurveysSubmitRequest {
|
|
|
9019
9723
|
}
|
|
9020
9724
|
/** surveys-submit-response */
|
|
9021
9725
|
export type SurveysSubmitResponse = object;
|
|
9726
|
+
/**
|
|
9727
|
+
* sync-in
|
|
9728
|
+
* Information about the sync to DevRev.
|
|
9729
|
+
*/
|
|
9730
|
+
export interface SyncIn {
|
|
9731
|
+
/** Status of the sync for the object. */
|
|
9732
|
+
status?: SyncInStatus;
|
|
9733
|
+
/**
|
|
9734
|
+
* Timestamp when the object was synced in/from DevRev.
|
|
9735
|
+
* @format date-time
|
|
9736
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9737
|
+
*/
|
|
9738
|
+
sync_date?: string;
|
|
9739
|
+
sync_unit?: SyncUnitSummary;
|
|
9740
|
+
}
|
|
9741
|
+
/** Status of the sync for the object. */
|
|
9742
|
+
export declare enum SyncInStatus {
|
|
9743
|
+
Failed = "failed",
|
|
9744
|
+
Modified = "modified",
|
|
9745
|
+
Staged = "staged",
|
|
9746
|
+
Succeeded = "succeeded"
|
|
9747
|
+
}
|
|
9748
|
+
/**
|
|
9749
|
+
* sync-metadata
|
|
9750
|
+
* Mixin for storing sync metadata.
|
|
9751
|
+
*/
|
|
9752
|
+
export interface SyncMetadata {
|
|
9753
|
+
/** External record URL. */
|
|
9754
|
+
external_reference?: string;
|
|
9755
|
+
/** Information about the sync to DevRev. */
|
|
9756
|
+
last_sync_in?: SyncIn;
|
|
9757
|
+
/** Information about the sync to DevRev. */
|
|
9758
|
+
last_sync_out?: SyncOut;
|
|
9759
|
+
/** Where the record was first created. */
|
|
9760
|
+
origin_system?: string;
|
|
9761
|
+
}
|
|
9022
9762
|
/** sync-metadata-filter */
|
|
9023
9763
|
export interface SyncMetadataFilter {
|
|
9024
9764
|
/** Filters for issues with this specific external reference. */
|
|
@@ -9054,8 +9794,32 @@ export interface SyncMetadataFilterSyncOutFilter {
|
|
|
9054
9794
|
}
|
|
9055
9795
|
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
9056
9796
|
Failed = "failed",
|
|
9797
|
+
Modified = "modified",
|
|
9798
|
+
Succeeded = "succeeded"
|
|
9799
|
+
}
|
|
9800
|
+
/**
|
|
9801
|
+
* sync-out
|
|
9802
|
+
* Information about the sync to DevRev.
|
|
9803
|
+
*/
|
|
9804
|
+
export interface SyncOut {
|
|
9805
|
+
/** Status of the sync for the object. */
|
|
9806
|
+
status?: SyncOutStatus;
|
|
9807
|
+
/**
|
|
9808
|
+
* Timestamp when the object was synced in/from DevRev.
|
|
9809
|
+
* @format date-time
|
|
9810
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9811
|
+
*/
|
|
9812
|
+
sync_date?: string;
|
|
9813
|
+
sync_unit?: SyncUnitSummary;
|
|
9814
|
+
}
|
|
9815
|
+
/** Status of the sync for the object. */
|
|
9816
|
+
export declare enum SyncOutStatus {
|
|
9817
|
+
Failed = "failed",
|
|
9818
|
+
Modified = "modified",
|
|
9057
9819
|
Succeeded = "succeeded"
|
|
9058
9820
|
}
|
|
9821
|
+
/** sync-unit-summary */
|
|
9822
|
+
export type SyncUnitSummary = AtomBaseSummary;
|
|
9059
9823
|
/** sys-user */
|
|
9060
9824
|
export type SysUser = UserBase;
|
|
9061
9825
|
/** sys-user-summary */
|
|
@@ -9774,6 +10538,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
9774
10538
|
object_display_id: string;
|
|
9775
10539
|
/** The type of object that the Timeline entry belongs to. */
|
|
9776
10540
|
object_type?: TimelineEntryObjectType;
|
|
10541
|
+
/** Display panels for the Timeline entry. */
|
|
10542
|
+
panels?: TimelineEntryPanel[];
|
|
9777
10543
|
/** The reactions to the entry. */
|
|
9778
10544
|
reactions?: TimelineReaction[];
|
|
9779
10545
|
/** Thread. */
|
|
@@ -10866,6 +11632,8 @@ export type WorkBase = AtomBase & {
|
|
|
10866
11632
|
stock_schema_fragment?: string;
|
|
10867
11633
|
/** Subtype corresponding to the custom type fragment. */
|
|
10868
11634
|
subtype?: string;
|
|
11635
|
+
/** Mixin for storing sync metadata. */
|
|
11636
|
+
sync_metadata?: SyncMetadata;
|
|
10869
11637
|
/** Tags associated with the object. */
|
|
10870
11638
|
tags?: TagWithValue[];
|
|
10871
11639
|
/**
|
|
@@ -11007,6 +11775,11 @@ export interface WorksCreateRequestOpportunity {
|
|
|
11007
11775
|
customer_budget?: number;
|
|
11008
11776
|
/** Forecast category of the opportunity. */
|
|
11009
11777
|
forecast_category?: OpportunityForecastCategory;
|
|
11778
|
+
/**
|
|
11779
|
+
* Forecast category enum ID of an opportunity.
|
|
11780
|
+
* @format int64
|
|
11781
|
+
*/
|
|
11782
|
+
forecast_category_v2?: number;
|
|
11010
11783
|
/** Priority of the opportunity. */
|
|
11011
11784
|
priority?: OpportunityPriority;
|
|
11012
11785
|
/**
|
|
@@ -11159,6 +11932,11 @@ export interface WorksFilterOpportunity {
|
|
|
11159
11932
|
account?: string[];
|
|
11160
11933
|
/** Filters for opportunities with any of the provided contacts. */
|
|
11161
11934
|
contacts?: string[];
|
|
11935
|
+
/**
|
|
11936
|
+
* Filters for opportunities with any of the provided forecast
|
|
11937
|
+
* category enum IDs.
|
|
11938
|
+
*/
|
|
11939
|
+
forecast_category_v2?: number[];
|
|
11162
11940
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
11163
11941
|
subtype?: string[];
|
|
11164
11942
|
}
|
|
@@ -11401,6 +12179,11 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
11401
12179
|
* @format double
|
|
11402
12180
|
*/
|
|
11403
12181
|
customer_budget?: number | null;
|
|
12182
|
+
/**
|
|
12183
|
+
* Forecast category enum ID of an opportunity.
|
|
12184
|
+
* @format int64
|
|
12185
|
+
*/
|
|
12186
|
+
forecast_category_v2?: number;
|
|
11404
12187
|
/**
|
|
11405
12188
|
* Updates the probability of winning the deal, lies between 0.0 and
|
|
11406
12189
|
* 1.0.
|
|
@@ -11791,6 +12574,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11791
12574
|
* only external articles are returned.
|
|
11792
12575
|
*/
|
|
11793
12576
|
scope?: number[];
|
|
12577
|
+
/** ID of the group/member with whom the item is shared. */
|
|
12578
|
+
'shared_with.member'?: string;
|
|
12579
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
12580
|
+
'shared_with.role'?: string;
|
|
11794
12581
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
11795
12582
|
/**
|
|
11796
12583
|
* @description Get count of articles matching given filter.
|
|
@@ -11902,6 +12689,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11902
12689
|
* only external articles are returned.
|
|
11903
12690
|
*/
|
|
11904
12691
|
scope?: number[];
|
|
12692
|
+
/** ID of the group/member with whom the item is shared. */
|
|
12693
|
+
'shared_with.member'?: string;
|
|
12694
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
12695
|
+
'shared_with.role'?: string;
|
|
11905
12696
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
11906
12697
|
/**
|
|
11907
12698
|
* @description Lists a collection of articles.
|
|
@@ -12012,6 +12803,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12012
12803
|
* @secure
|
|
12013
12804
|
*/
|
|
12014
12805
|
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
|
|
12806
|
+
/**
|
|
12807
|
+
* @description Retrieves audit logs.
|
|
12808
|
+
*
|
|
12809
|
+
* @tags compliance
|
|
12810
|
+
* @name ExportAuditLogs
|
|
12811
|
+
* @request POST:/audit-logs.fetch
|
|
12812
|
+
* @secure
|
|
12813
|
+
*/
|
|
12814
|
+
exportAuditLogs: (data: ExportAuditLogsRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12015
12815
|
/**
|
|
12016
12816
|
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
12017
12817
|
*
|
|
@@ -12051,6 +12851,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12051
12851
|
* @secure
|
|
12052
12852
|
*/
|
|
12053
12853
|
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
12854
|
+
/**
|
|
12855
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
12856
|
+
*
|
|
12857
|
+
* @tags auth-tokens
|
|
12858
|
+
* @name AuthTokensInfo
|
|
12859
|
+
* @request GET:/auth-tokens.info
|
|
12860
|
+
* @secure
|
|
12861
|
+
*/
|
|
12862
|
+
authTokensInfo: (params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any>>;
|
|
12863
|
+
/**
|
|
12864
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
12865
|
+
*
|
|
12866
|
+
* @tags auth-tokens
|
|
12867
|
+
* @name AuthTokensInfoPost
|
|
12868
|
+
* @request POST:/auth-tokens.info
|
|
12869
|
+
* @secure
|
|
12870
|
+
*/
|
|
12871
|
+
authTokensInfoPost: (data: AuthTokensInfoRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any>>;
|
|
12054
12872
|
/**
|
|
12055
12873
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
12056
12874
|
*
|
|
@@ -12471,6 +13289,117 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12471
13289
|
* @secure
|
|
12472
13290
|
*/
|
|
12473
13291
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
13292
|
+
/**
|
|
13293
|
+
* @description Counts custom objects.
|
|
13294
|
+
*
|
|
13295
|
+
* @tags customization
|
|
13296
|
+
* @name CustomObjectsCount
|
|
13297
|
+
* @request GET:/custom-objects.count
|
|
13298
|
+
* @secure
|
|
13299
|
+
*/
|
|
13300
|
+
customObjectsCount: (query: {
|
|
13301
|
+
/** Leaf type to filter. */
|
|
13302
|
+
leaf_type: string;
|
|
13303
|
+
/** List of filters to apply. */
|
|
13304
|
+
filters?: any[];
|
|
13305
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
13306
|
+
/**
|
|
13307
|
+
* @description Counts custom objects.
|
|
13308
|
+
*
|
|
13309
|
+
* @tags customization
|
|
13310
|
+
* @name CustomObjectsCountPost
|
|
13311
|
+
* @request POST:/custom-objects.count
|
|
13312
|
+
* @secure
|
|
13313
|
+
*/
|
|
13314
|
+
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
13315
|
+
/**
|
|
13316
|
+
* @description Creates a custom object.
|
|
13317
|
+
*
|
|
13318
|
+
* @tags customization
|
|
13319
|
+
* @name CustomObjectsCreate
|
|
13320
|
+
* @request POST:/custom-objects.create
|
|
13321
|
+
* @secure
|
|
13322
|
+
*/
|
|
13323
|
+
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any>>;
|
|
13324
|
+
/**
|
|
13325
|
+
* @description Deletes a custom object.
|
|
13326
|
+
*
|
|
13327
|
+
* @tags customization
|
|
13328
|
+
* @name CustomObjectsDelete
|
|
13329
|
+
* @request POST:/custom-objects.delete
|
|
13330
|
+
* @secure
|
|
13331
|
+
*/
|
|
13332
|
+
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13333
|
+
/**
|
|
13334
|
+
* @description Gets a custom object.
|
|
13335
|
+
*
|
|
13336
|
+
* @tags customization
|
|
13337
|
+
* @name CustomObjectsGet
|
|
13338
|
+
* @request GET:/custom-objects.get
|
|
13339
|
+
* @secure
|
|
13340
|
+
*/
|
|
13341
|
+
customObjectsGet: (query?: {
|
|
13342
|
+
/** The ID of the custom object to get. */
|
|
13343
|
+
id?: string;
|
|
13344
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
13345
|
+
/**
|
|
13346
|
+
* @description Gets a custom object.
|
|
13347
|
+
*
|
|
13348
|
+
* @tags customization
|
|
13349
|
+
* @name CustomObjectsGetPost
|
|
13350
|
+
* @request POST:/custom-objects.get
|
|
13351
|
+
* @secure
|
|
13352
|
+
*/
|
|
13353
|
+
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
13354
|
+
/**
|
|
13355
|
+
* @description Lists custom objects.
|
|
13356
|
+
*
|
|
13357
|
+
* @tags customization
|
|
13358
|
+
* @name CustomObjectsList
|
|
13359
|
+
* @request GET:/custom-objects.list
|
|
13360
|
+
* @secure
|
|
13361
|
+
*/
|
|
13362
|
+
customObjectsList: (query: {
|
|
13363
|
+
/** Leaf type to filter. */
|
|
13364
|
+
leaf_type: string;
|
|
13365
|
+
/**
|
|
13366
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13367
|
+
* starts from the beginning.
|
|
13368
|
+
*/
|
|
13369
|
+
cursor?: string;
|
|
13370
|
+
/** List of filters to apply. */
|
|
13371
|
+
filter?: any[];
|
|
13372
|
+
/**
|
|
13373
|
+
* The maximum number of items.
|
|
13374
|
+
* @format int32
|
|
13375
|
+
*/
|
|
13376
|
+
limit?: number;
|
|
13377
|
+
/**
|
|
13378
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13379
|
+
* used.
|
|
13380
|
+
*/
|
|
13381
|
+
mode?: ListMode;
|
|
13382
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
13383
|
+
sort_by?: string[];
|
|
13384
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
13385
|
+
/**
|
|
13386
|
+
* @description Lists custom objects.
|
|
13387
|
+
*
|
|
13388
|
+
* @tags customization
|
|
13389
|
+
* @name CustomObjectsListPost
|
|
13390
|
+
* @request POST:/custom-objects.list
|
|
13391
|
+
* @secure
|
|
13392
|
+
*/
|
|
13393
|
+
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
13394
|
+
/**
|
|
13395
|
+
* @description Updates a custom object.
|
|
13396
|
+
*
|
|
13397
|
+
* @tags customization
|
|
13398
|
+
* @name CustomObjectsUpdate
|
|
13399
|
+
* @request POST:/custom-objects.update
|
|
13400
|
+
* @secure
|
|
13401
|
+
*/
|
|
13402
|
+
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any>>;
|
|
12474
13403
|
/**
|
|
12475
13404
|
* @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
13405
|
*
|
|
@@ -12667,6 +13596,127 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12667
13596
|
* @secure
|
|
12668
13597
|
*/
|
|
12669
13598
|
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
13599
|
+
/**
|
|
13600
|
+
* @description Get count of directories matching given filter.
|
|
13601
|
+
*
|
|
13602
|
+
* @tags directory
|
|
13603
|
+
* @name DirectoriesCount
|
|
13604
|
+
* @request GET:/directories.count
|
|
13605
|
+
* @secure
|
|
13606
|
+
*/
|
|
13607
|
+
directoriesCount: (query?: {
|
|
13608
|
+
/**
|
|
13609
|
+
* Filters for directories created by any of the provided users.
|
|
13610
|
+
* @example ["DEVU-12345"]
|
|
13611
|
+
*/
|
|
13612
|
+
created_by?: string[];
|
|
13613
|
+
/**
|
|
13614
|
+
* Filters for directories modified by any of the provided users.
|
|
13615
|
+
* @example ["DEVU-12345"]
|
|
13616
|
+
*/
|
|
13617
|
+
modified_by?: string[];
|
|
13618
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any>>;
|
|
13619
|
+
/**
|
|
13620
|
+
* @description Get count of directories matching given filter.
|
|
13621
|
+
*
|
|
13622
|
+
* @tags directory
|
|
13623
|
+
* @name DirectoriesCountPost
|
|
13624
|
+
* @request POST:/directories.count
|
|
13625
|
+
* @secure
|
|
13626
|
+
*/
|
|
13627
|
+
directoriesCountPost: (data: DirectoriesCountRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any>>;
|
|
13628
|
+
/**
|
|
13629
|
+
* @description Creates a directory for the specified inputs.
|
|
13630
|
+
*
|
|
13631
|
+
* @tags directory
|
|
13632
|
+
* @name DirectoriesCreate
|
|
13633
|
+
* @request POST:/directories.create
|
|
13634
|
+
* @secure
|
|
13635
|
+
*/
|
|
13636
|
+
directoriesCreate: (data: DirectoriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCreateResponse, any>>;
|
|
13637
|
+
/**
|
|
13638
|
+
* @description Delete the specified directory.
|
|
13639
|
+
*
|
|
13640
|
+
* @tags directory
|
|
13641
|
+
* @name DirectoriesDelete
|
|
13642
|
+
* @request POST:/directories.delete
|
|
13643
|
+
* @secure
|
|
13644
|
+
*/
|
|
13645
|
+
directoriesDelete: (data: DirectoriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13646
|
+
/**
|
|
13647
|
+
* @description Gets the specified directory.
|
|
13648
|
+
*
|
|
13649
|
+
* @tags directory
|
|
13650
|
+
* @name DirectoriesGet
|
|
13651
|
+
* @request GET:/directories.get
|
|
13652
|
+
* @secure
|
|
13653
|
+
*/
|
|
13654
|
+
directoriesGet: (query: {
|
|
13655
|
+
/** The ID of the requested directory. */
|
|
13656
|
+
id: string;
|
|
13657
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13658
|
+
/**
|
|
13659
|
+
* @description Gets the specified directory.
|
|
13660
|
+
*
|
|
13661
|
+
* @tags directory
|
|
13662
|
+
* @name DirectoriesGetPost
|
|
13663
|
+
* @request POST:/directories.get
|
|
13664
|
+
* @secure
|
|
13665
|
+
*/
|
|
13666
|
+
directoriesGetPost: (data: DirectoriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13667
|
+
/**
|
|
13668
|
+
* @description Lists directories matching the request.
|
|
13669
|
+
*
|
|
13670
|
+
* @tags directory
|
|
13671
|
+
* @name DirectoriesList
|
|
13672
|
+
* @request GET:/directories.list
|
|
13673
|
+
* @secure
|
|
13674
|
+
*/
|
|
13675
|
+
directoriesList: (query?: {
|
|
13676
|
+
/**
|
|
13677
|
+
* Filters for directories created by any of the provided users.
|
|
13678
|
+
* @example ["DEVU-12345"]
|
|
13679
|
+
*/
|
|
13680
|
+
created_by?: string[];
|
|
13681
|
+
/**
|
|
13682
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13683
|
+
* starts from the beginning.
|
|
13684
|
+
*/
|
|
13685
|
+
cursor?: string;
|
|
13686
|
+
/**
|
|
13687
|
+
* The maximum number of directories to return. The default is '50'.
|
|
13688
|
+
* @format int32
|
|
13689
|
+
*/
|
|
13690
|
+
limit?: number;
|
|
13691
|
+
/**
|
|
13692
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13693
|
+
* used.
|
|
13694
|
+
*/
|
|
13695
|
+
mode?: ListMode;
|
|
13696
|
+
/**
|
|
13697
|
+
* Filters for directories modified by any of the provided users.
|
|
13698
|
+
* @example ["DEVU-12345"]
|
|
13699
|
+
*/
|
|
13700
|
+
modified_by?: string[];
|
|
13701
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any>>;
|
|
13702
|
+
/**
|
|
13703
|
+
* @description Lists directories matching the request.
|
|
13704
|
+
*
|
|
13705
|
+
* @tags directory
|
|
13706
|
+
* @name DirectoriesListPost
|
|
13707
|
+
* @request POST:/directories.list
|
|
13708
|
+
* @secure
|
|
13709
|
+
*/
|
|
13710
|
+
directoriesListPost: (data: DirectoriesListRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any>>;
|
|
13711
|
+
/**
|
|
13712
|
+
* @description Updates the specified directory.
|
|
13713
|
+
*
|
|
13714
|
+
* @tags directory
|
|
13715
|
+
* @name DirectoriesUpdate
|
|
13716
|
+
* @request POST:/directories.update
|
|
13717
|
+
* @secure
|
|
13718
|
+
*/
|
|
13719
|
+
directoriesUpdate: (data: DirectoriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesUpdateResponse, any>>;
|
|
12670
13720
|
/**
|
|
12671
13721
|
* @description Counts the engagement records.
|
|
12672
13722
|
*
|
|
@@ -13081,6 +14131,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13081
14131
|
source?: number[];
|
|
13082
14132
|
/** Filters for incidents in any of the provided stages. */
|
|
13083
14133
|
stage?: string[];
|
|
14134
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
14135
|
+
subtype?: string[];
|
|
13084
14136
|
/** Filters for incidents by the provided titles. */
|
|
13085
14137
|
title?: string[];
|
|
13086
14138
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
@@ -13151,6 +14203,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13151
14203
|
source?: number[];
|
|
13152
14204
|
/** Filters for incidents in any of the provided stages. */
|
|
13153
14205
|
stage?: string[];
|
|
14206
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
14207
|
+
subtype?: string[];
|
|
13154
14208
|
/** Filters for incidents by the provided titles. */
|
|
13155
14209
|
title?: string[];
|
|
13156
14210
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
@@ -13370,6 +14424,60 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13370
14424
|
* @secure
|
|
13371
14425
|
*/
|
|
13372
14426
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
14427
|
+
/**
|
|
14428
|
+
* @description Executes the metric action on the given object.
|
|
14429
|
+
*
|
|
14430
|
+
* @tags slas
|
|
14431
|
+
* @name MetricActionExecute
|
|
14432
|
+
* @request POST:/metric-action.execute
|
|
14433
|
+
* @secure
|
|
14434
|
+
*/
|
|
14435
|
+
metricActionExecute: (data: MetricActionExecuteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14436
|
+
/**
|
|
14437
|
+
* @description Creates a custom metric definition
|
|
14438
|
+
*
|
|
14439
|
+
* @tags slas
|
|
14440
|
+
* @name MetricDefinitionsCreate
|
|
14441
|
+
* @request POST:/metric-definitions.create
|
|
14442
|
+
* @secure
|
|
14443
|
+
*/
|
|
14444
|
+
metricDefinitionsCreate: (data: MetricDefinitionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsCreateResponse, any>>;
|
|
14445
|
+
/**
|
|
14446
|
+
* @description Deletes a custom metric definition
|
|
14447
|
+
*
|
|
14448
|
+
* @tags slas
|
|
14449
|
+
* @name MetricDefinitionsDelete
|
|
14450
|
+
* @request POST:/metric-definitions.delete
|
|
14451
|
+
* @secure
|
|
14452
|
+
*/
|
|
14453
|
+
metricDefinitionsDelete: (data: MetricDefinitionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14454
|
+
/**
|
|
14455
|
+
* @description Gets a custom metric definition
|
|
14456
|
+
*
|
|
14457
|
+
* @tags slas
|
|
14458
|
+
* @name MetricDefinitionsGet
|
|
14459
|
+
* @request GET:/metric-definitions.get
|
|
14460
|
+
* @secure
|
|
14461
|
+
*/
|
|
14462
|
+
metricDefinitionsGet: (query?: {
|
|
14463
|
+
/** The ID of the metric definition to get. */
|
|
14464
|
+
id?: string;
|
|
14465
|
+
/**
|
|
14466
|
+
* The unique human readable name of the metric.
|
|
14467
|
+
* @minLength 1
|
|
14468
|
+
* @maxLength 64
|
|
14469
|
+
*/
|
|
14470
|
+
name?: string;
|
|
14471
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any>>;
|
|
14472
|
+
/**
|
|
14473
|
+
* @description Gets a custom metric definition
|
|
14474
|
+
*
|
|
14475
|
+
* @tags slas
|
|
14476
|
+
* @name MetricDefinitionsGetPost
|
|
14477
|
+
* @request POST:/metric-definitions.get
|
|
14478
|
+
* @secure
|
|
14479
|
+
*/
|
|
14480
|
+
metricDefinitionsGetPost: (data: MetricDefinitionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any>>;
|
|
13373
14481
|
/**
|
|
13374
14482
|
* @description Lists metric definitions matching a filter.
|
|
13375
14483
|
*
|
|
@@ -13401,6 +14509,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13401
14509
|
* used.
|
|
13402
14510
|
*/
|
|
13403
14511
|
mode?: ListMode;
|
|
14512
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
14513
|
+
sort_by?: string[];
|
|
13404
14514
|
/** The status of the metric definition. */
|
|
13405
14515
|
status?: MetricDefinitionStatus[];
|
|
13406
14516
|
/** The type of metric definitions sought. */
|
|
@@ -13415,6 +14525,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13415
14525
|
* @secure
|
|
13416
14526
|
*/
|
|
13417
14527
|
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
14528
|
+
/**
|
|
14529
|
+
* @description Updates a custom metric definition
|
|
14530
|
+
*
|
|
14531
|
+
* @tags slas
|
|
14532
|
+
* @name MetricDefinitionsUpdate
|
|
14533
|
+
* @request POST:/metric-definitions.update
|
|
14534
|
+
* @secure
|
|
14535
|
+
*/
|
|
14536
|
+
metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any>>;
|
|
13418
14537
|
/**
|
|
13419
14538
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
13420
14539
|
*
|
|
@@ -13971,6 +15090,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13971
15090
|
* @secure
|
|
13972
15091
|
*/
|
|
13973
15092
|
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15093
|
+
/**
|
|
15094
|
+
* @description Deletes data of a contact.
|
|
15095
|
+
*
|
|
15096
|
+
* @tags compliance
|
|
15097
|
+
* @name DeleteRevUsersPersonalData
|
|
15098
|
+
* @request POST:/rev-users.delete-personal-data
|
|
15099
|
+
* @secure
|
|
15100
|
+
*/
|
|
15101
|
+
deleteRevUsersPersonalData: (data: DeleteRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13974
15102
|
/**
|
|
13975
15103
|
* @description Returns the Rev user of a Rev organization by its ID.
|
|
13976
15104
|
*
|
|
@@ -14082,6 +15210,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14082
15210
|
* @secure
|
|
14083
15211
|
*/
|
|
14084
15212
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
15213
|
+
/**
|
|
15214
|
+
* @description Merges the secondary Rev user into the primary Rev user.
|
|
15215
|
+
*
|
|
15216
|
+
* @tags rev-users
|
|
15217
|
+
* @name RevUsersMerge
|
|
15218
|
+
* @request POST:/rev-users.merge
|
|
15219
|
+
* @secure
|
|
15220
|
+
*/
|
|
15221
|
+
revUsersMerge: (data: RevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15222
|
+
/**
|
|
15223
|
+
* @description Retrieves data of a contact.
|
|
15224
|
+
*
|
|
15225
|
+
* @tags compliance
|
|
15226
|
+
* @name GetRevUsersPersonalData
|
|
15227
|
+
* @request POST:/rev-users.personal-data
|
|
15228
|
+
* @secure
|
|
15229
|
+
*/
|
|
15230
|
+
getRevUsersPersonalData: (data: GetRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14085
15231
|
/**
|
|
14086
15232
|
* @description Scans through all Rev users.
|
|
14087
15233
|
*
|
|
@@ -14236,6 +15382,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14236
15382
|
cursor?: string;
|
|
14237
15383
|
/** Whether only deprecated fragments should be filtered. */
|
|
14238
15384
|
deprecated?: boolean;
|
|
15385
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
15386
|
+
is_custom_leaf_type?: boolean;
|
|
14239
15387
|
/** The list of leaf types. */
|
|
14240
15388
|
leaf_type?: string[];
|
|
14241
15389
|
/**
|
|
@@ -14502,6 +15650,72 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14502
15650
|
* @secure
|
|
14503
15651
|
*/
|
|
14504
15652
|
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
15653
|
+
/**
|
|
15654
|
+
* @description Lists SLA trackers matching a filter.
|
|
15655
|
+
*
|
|
15656
|
+
* @tags slas
|
|
15657
|
+
* @name SlaTrackersList
|
|
15658
|
+
* @request GET:/sla-trackers.list
|
|
15659
|
+
* @secure
|
|
15660
|
+
*/
|
|
15661
|
+
slaTrackersList: (query?: {
|
|
15662
|
+
/**
|
|
15663
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
15664
|
+
* @format date-time
|
|
15665
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15666
|
+
*/
|
|
15667
|
+
'created_date.after'?: string;
|
|
15668
|
+
/**
|
|
15669
|
+
* Filters for objects created before the provided timestamp
|
|
15670
|
+
* (inclusive).
|
|
15671
|
+
* @format date-time
|
|
15672
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15673
|
+
*/
|
|
15674
|
+
'created_date.before'?: string;
|
|
15675
|
+
/**
|
|
15676
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
15677
|
+
* starts from the beginning.
|
|
15678
|
+
*/
|
|
15679
|
+
cursor?: string;
|
|
15680
|
+
/**
|
|
15681
|
+
* The maximum number of SLA trackers to return. The default is '50'.
|
|
15682
|
+
* @format int32
|
|
15683
|
+
*/
|
|
15684
|
+
limit?: number;
|
|
15685
|
+
/**
|
|
15686
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
15687
|
+
* used.
|
|
15688
|
+
*/
|
|
15689
|
+
mode?: ListMode;
|
|
15690
|
+
/**
|
|
15691
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
15692
|
+
* @format date-time
|
|
15693
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15694
|
+
*/
|
|
15695
|
+
'modified_date.after'?: string;
|
|
15696
|
+
/**
|
|
15697
|
+
* Filters for objects created before the provided timestamp
|
|
15698
|
+
* (inclusive).
|
|
15699
|
+
* @format date-time
|
|
15700
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
15701
|
+
*/
|
|
15702
|
+
'modified_date.before'?: string;
|
|
15703
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
15704
|
+
sort_by?: string[];
|
|
15705
|
+
/** The SLA tracker stages the filter matches. */
|
|
15706
|
+
stage?: string[];
|
|
15707
|
+
/** The SLA tracker statuses the filter matches. */
|
|
15708
|
+
status?: string[];
|
|
15709
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any>>;
|
|
15710
|
+
/**
|
|
15711
|
+
* @description Lists SLA trackers matching a filter.
|
|
15712
|
+
*
|
|
15713
|
+
* @tags slas
|
|
15714
|
+
* @name SlaTrackersListPost
|
|
15715
|
+
* @request POST:/sla-trackers.list
|
|
15716
|
+
* @secure
|
|
15717
|
+
*/
|
|
15718
|
+
slaTrackersListPost: (data: SlaTrackersListRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any>>;
|
|
14505
15719
|
/**
|
|
14506
15720
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
14507
15721
|
*
|
|
@@ -14574,6 +15788,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14574
15788
|
mode?: ListMode;
|
|
14575
15789
|
/** The SLA types the filter matches. */
|
|
14576
15790
|
sla_type?: SlaType[];
|
|
15791
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
15792
|
+
sort_by?: string[];
|
|
14577
15793
|
/** The SLA statuses the filter matches. */
|
|
14578
15794
|
status?: SlaStatus[];
|
|
14579
15795
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
@@ -15493,6 +16709,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15493
16709
|
'opportunity.account'?: string[];
|
|
15494
16710
|
/** Filters for opportunities with any of the provided contacts. */
|
|
15495
16711
|
'opportunity.contacts'?: string[];
|
|
16712
|
+
/**
|
|
16713
|
+
* Filters for opportunities with any of the provided forecast category
|
|
16714
|
+
* enum IDs.
|
|
16715
|
+
*/
|
|
16716
|
+
'opportunity.forecast_category_v2'?: number[];
|
|
15496
16717
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
15497
16718
|
'opportunity.subtype'?: string[];
|
|
15498
16719
|
/**
|
|
@@ -15649,6 +16870,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15649
16870
|
'opportunity.account'?: string[];
|
|
15650
16871
|
/** Filters for opportunities with any of the provided contacts. */
|
|
15651
16872
|
'opportunity.contacts'?: string[];
|
|
16873
|
+
/**
|
|
16874
|
+
* Filters for opportunities with any of the provided forecast category
|
|
16875
|
+
* enum IDs.
|
|
16876
|
+
*/
|
|
16877
|
+
'opportunity.forecast_category_v2'?: number[];
|
|
15652
16878
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
15653
16879
|
'opportunity.subtype'?: string[];
|
|
15654
16880
|
/**
|