@devrev/typescript-sdk 1.1.33 → 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.
|
@@ -1402,6 +1402,25 @@ export interface AuthTokensGetRequest {
|
|
|
1402
1402
|
export interface AuthTokensGetResponse {
|
|
1403
1403
|
token: AuthToken;
|
|
1404
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
|
+
}
|
|
1405
1424
|
/**
|
|
1406
1425
|
* auth-tokens-list-request
|
|
1407
1426
|
* A request to list the token metadata.
|
|
@@ -1429,6 +1448,21 @@ export interface AuthTokensListResponse {
|
|
|
1429
1448
|
/** The list of token metadata. */
|
|
1430
1449
|
tokens: AuthToken[];
|
|
1431
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
|
+
}
|
|
1432
1466
|
/**
|
|
1433
1467
|
* auth-tokens-org-traits
|
|
1434
1468
|
* Carries Rev org info.
|
|
@@ -1487,6 +1521,26 @@ export interface AuthTokensSelfDeleteRequest {
|
|
|
1487
1521
|
/** The type of the requested token. */
|
|
1488
1522
|
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1489
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
|
+
}
|
|
1490
1544
|
/**
|
|
1491
1545
|
* auth-tokens-update-request
|
|
1492
1546
|
* A request to update the token metadata.
|
|
@@ -1504,6 +1558,23 @@ export interface AuthTokensUpdateRequest {
|
|
|
1504
1558
|
export interface AuthTokensUpdateResponse {
|
|
1505
1559
|
token: AuthToken;
|
|
1506
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
|
+
}
|
|
1507
1578
|
/**
|
|
1508
1579
|
* auth-tokens-user-traits
|
|
1509
1580
|
* Carries Rev user info.
|
|
@@ -2248,6 +2319,10 @@ export interface ConversationsUpdateRequestOwnedBy {
|
|
|
2248
2319
|
}
|
|
2249
2320
|
/** conversations-update-request-tags */
|
|
2250
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[];
|
|
2251
2326
|
/** Sets the tag IDs to the provided tags. */
|
|
2252
2327
|
set?: SetTagWithValue[];
|
|
2253
2328
|
}
|
|
@@ -2622,7 +2697,11 @@ export interface CustomObjectsListRequest {
|
|
|
2622
2697
|
/** The list of fields to sort the items by and how to sort them. */
|
|
2623
2698
|
sort_by?: string[];
|
|
2624
2699
|
}
|
|
2625
|
-
/**
|
|
2700
|
+
/**
|
|
2701
|
+
* custom-objects-list-response
|
|
2702
|
+
* The response to listing all custom objects matching the filter
|
|
2703
|
+
* criteria.
|
|
2704
|
+
*/
|
|
2626
2705
|
export interface CustomObjectsListResponse {
|
|
2627
2706
|
/**
|
|
2628
2707
|
* The cursor used to iterate subsequent results in accordance to the
|
|
@@ -2960,6 +3039,8 @@ export type CustomState = AtomBase & {
|
|
|
2960
3039
|
};
|
|
2961
3040
|
/** custom-state-summary */
|
|
2962
3041
|
export type CustomStateSummary = AtomBaseSummary & {
|
|
3042
|
+
/** True if this is a final state. */
|
|
3043
|
+
is_final?: boolean;
|
|
2963
3044
|
/** The human readable name of the state. */
|
|
2964
3045
|
name?: string;
|
|
2965
3046
|
};
|
|
@@ -4610,9 +4691,11 @@ export interface EventTagDeleted {
|
|
|
4610
4691
|
* @example "TAG-12345"
|
|
4611
4692
|
*/
|
|
4612
4693
|
id: string;
|
|
4694
|
+
old_tag?: Tag;
|
|
4613
4695
|
}
|
|
4614
4696
|
/** event-tag-updated */
|
|
4615
4697
|
export interface EventTagUpdated {
|
|
4698
|
+
old_tag?: Tag;
|
|
4616
4699
|
tag: Tag;
|
|
4617
4700
|
}
|
|
4618
4701
|
/** event-timeline-entry-created */
|
|
@@ -4861,15 +4944,7 @@ export interface GeneralPreferencesGroup {
|
|
|
4861
4944
|
/** Preferences group for Availability. */
|
|
4862
4945
|
availability?: AvailabilityPreferencesGroup;
|
|
4863
4946
|
/** Preferred locale of the user. */
|
|
4864
|
-
preferred_locale?:
|
|
4865
|
-
}
|
|
4866
|
-
/** Preferred locale of the user. */
|
|
4867
|
-
export declare enum GeneralPreferencesGroupPreferredLocale {
|
|
4868
|
-
EnUs = "en_us",
|
|
4869
|
-
EsAr = "es_ar",
|
|
4870
|
-
JaJp = "ja_jp",
|
|
4871
|
-
NlAw = "nl_aw",
|
|
4872
|
-
NlSx = "nl_sx"
|
|
4947
|
+
preferred_locale?: string;
|
|
4873
4948
|
}
|
|
4874
4949
|
/** Event type of the notification. */
|
|
4875
4950
|
export declare enum GenericNotificationEventType {
|
|
@@ -5440,6 +5515,8 @@ export interface IncidentsGroupRequest {
|
|
|
5440
5515
|
source?: number[];
|
|
5441
5516
|
/** Filters for incidents in any of the provided stages. */
|
|
5442
5517
|
stage?: string[];
|
|
5518
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
5519
|
+
subtype?: string[];
|
|
5443
5520
|
/** Provides ways to specify date ranges on objects. */
|
|
5444
5521
|
target_close_date?: DateFilter;
|
|
5445
5522
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5526,6 +5603,8 @@ export interface IncidentsListRequest {
|
|
|
5526
5603
|
source?: number[];
|
|
5527
5604
|
/** Filters for incidents in any of the provided stages. */
|
|
5528
5605
|
stage?: string[];
|
|
5606
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
5607
|
+
subtype?: string[];
|
|
5529
5608
|
/** Provides ways to specify date ranges on objects. */
|
|
5530
5609
|
target_close_date?: DateFilter;
|
|
5531
5610
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5755,17 +5834,21 @@ export interface LinkDescriptorFilter {
|
|
|
5755
5834
|
link_descriptors: LinkTargetDescriptor[];
|
|
5756
5835
|
}
|
|
5757
5836
|
/** link-endpoint-summary */
|
|
5758
|
-
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) & {
|
|
5759
5838
|
type: LinkEndpointType;
|
|
5760
5839
|
};
|
|
5761
5840
|
export declare enum LinkEndpointType {
|
|
5841
|
+
Account = "account",
|
|
5762
5842
|
Capability = "capability",
|
|
5763
5843
|
Conversation = "conversation",
|
|
5844
|
+
DevUser = "dev_user",
|
|
5764
5845
|
Enhancement = "enhancement",
|
|
5765
5846
|
Feature = "feature",
|
|
5766
5847
|
Issue = "issue",
|
|
5767
5848
|
Opportunity = "opportunity",
|
|
5768
5849
|
Product = "product",
|
|
5850
|
+
RevOrg = "rev_org",
|
|
5851
|
+
RevUser = "rev_user",
|
|
5769
5852
|
Task = "task",
|
|
5770
5853
|
Ticket = "ticket"
|
|
5771
5854
|
}
|
|
@@ -6158,6 +6241,8 @@ export interface MetricDefinitionsListRequest {
|
|
|
6158
6241
|
* always be returned in the specified sort-by order.
|
|
6159
6242
|
*/
|
|
6160
6243
|
mode?: ListMode;
|
|
6244
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
6245
|
+
sort_by?: string[];
|
|
6161
6246
|
/** The status of the metric definition. */
|
|
6162
6247
|
status?: MetricDefinitionStatus[];
|
|
6163
6248
|
}
|
|
@@ -8950,6 +9035,8 @@ export interface SlaTrackersListRequest {
|
|
|
8950
9035
|
*/
|
|
8951
9036
|
mode?: ListMode;
|
|
8952
9037
|
modified_date?: DateTimeFilter;
|
|
9038
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
9039
|
+
sort_by?: string[];
|
|
8953
9040
|
/** The SLA tracker stages the filter matches. */
|
|
8954
9041
|
stage?: string[];
|
|
8955
9042
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -9062,6 +9149,8 @@ export interface SlasListRequest {
|
|
|
9062
9149
|
mode?: ListMode;
|
|
9063
9150
|
/** The SLA types the filter matches. */
|
|
9064
9151
|
sla_type?: SlaType[];
|
|
9152
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
9153
|
+
sort_by?: string[];
|
|
9065
9154
|
/** The SLA statuses the filter matches. */
|
|
9066
9155
|
status?: SlaStatus[];
|
|
9067
9156
|
}
|
|
@@ -9705,6 +9794,7 @@ export interface SyncMetadataFilterSyncOutFilter {
|
|
|
9705
9794
|
}
|
|
9706
9795
|
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
9707
9796
|
Failed = "failed",
|
|
9797
|
+
Modified = "modified",
|
|
9708
9798
|
Succeeded = "succeeded"
|
|
9709
9799
|
}
|
|
9710
9800
|
/**
|
|
@@ -11685,6 +11775,11 @@ export interface WorksCreateRequestOpportunity {
|
|
|
11685
11775
|
customer_budget?: number;
|
|
11686
11776
|
/** Forecast category of the opportunity. */
|
|
11687
11777
|
forecast_category?: OpportunityForecastCategory;
|
|
11778
|
+
/**
|
|
11779
|
+
* Forecast category enum ID of an opportunity.
|
|
11780
|
+
* @format int64
|
|
11781
|
+
*/
|
|
11782
|
+
forecast_category_v2?: number;
|
|
11688
11783
|
/** Priority of the opportunity. */
|
|
11689
11784
|
priority?: OpportunityPriority;
|
|
11690
11785
|
/**
|
|
@@ -11837,6 +11932,11 @@ export interface WorksFilterOpportunity {
|
|
|
11837
11932
|
account?: string[];
|
|
11838
11933
|
/** Filters for opportunities with any of the provided contacts. */
|
|
11839
11934
|
contacts?: string[];
|
|
11935
|
+
/**
|
|
11936
|
+
* Filters for opportunities with any of the provided forecast
|
|
11937
|
+
* category enum IDs.
|
|
11938
|
+
*/
|
|
11939
|
+
forecast_category_v2?: number[];
|
|
11840
11940
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
11841
11941
|
subtype?: string[];
|
|
11842
11942
|
}
|
|
@@ -12079,6 +12179,11 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
12079
12179
|
* @format double
|
|
12080
12180
|
*/
|
|
12081
12181
|
customer_budget?: number | null;
|
|
12182
|
+
/**
|
|
12183
|
+
* Forecast category enum ID of an opportunity.
|
|
12184
|
+
* @format int64
|
|
12185
|
+
*/
|
|
12186
|
+
forecast_category_v2?: number;
|
|
12082
12187
|
/**
|
|
12083
12188
|
* Updates the probability of winning the deal, lies between 0.0 and
|
|
12084
12189
|
* 1.0.
|
|
@@ -12746,6 +12851,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12746
12851
|
* @secure
|
|
12747
12852
|
*/
|
|
12748
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>>;
|
|
12749
12872
|
/**
|
|
12750
12873
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
12751
12874
|
*
|
|
@@ -14008,6 +14131,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14008
14131
|
source?: number[];
|
|
14009
14132
|
/** Filters for incidents in any of the provided stages. */
|
|
14010
14133
|
stage?: string[];
|
|
14134
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
14135
|
+
subtype?: string[];
|
|
14011
14136
|
/** Filters for incidents by the provided titles. */
|
|
14012
14137
|
title?: string[];
|
|
14013
14138
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
@@ -14078,6 +14203,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14078
14203
|
source?: number[];
|
|
14079
14204
|
/** Filters for incidents in any of the provided stages. */
|
|
14080
14205
|
stage?: string[];
|
|
14206
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
14207
|
+
subtype?: string[];
|
|
14081
14208
|
/** Filters for incidents by the provided titles. */
|
|
14082
14209
|
title?: string[];
|
|
14083
14210
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
@@ -14382,6 +14509,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14382
14509
|
* used.
|
|
14383
14510
|
*/
|
|
14384
14511
|
mode?: ListMode;
|
|
14512
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
14513
|
+
sort_by?: string[];
|
|
14385
14514
|
/** The status of the metric definition. */
|
|
14386
14515
|
status?: MetricDefinitionStatus[];
|
|
14387
14516
|
/** The type of metric definitions sought. */
|
|
@@ -15571,6 +15700,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15571
15700
|
* @example "2023-01-01T12:00:00.000Z"
|
|
15572
15701
|
*/
|
|
15573
15702
|
'modified_date.before'?: string;
|
|
15703
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
15704
|
+
sort_by?: string[];
|
|
15574
15705
|
/** The SLA tracker stages the filter matches. */
|
|
15575
15706
|
stage?: string[];
|
|
15576
15707
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -15657,6 +15788,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15657
15788
|
mode?: ListMode;
|
|
15658
15789
|
/** The SLA types the filter matches. */
|
|
15659
15790
|
sla_type?: SlaType[];
|
|
15791
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
15792
|
+
sort_by?: string[];
|
|
15660
15793
|
/** The SLA statuses the filter matches. */
|
|
15661
15794
|
status?: SlaStatus[];
|
|
15662
15795
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
@@ -16576,6 +16709,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16576
16709
|
'opportunity.account'?: string[];
|
|
16577
16710
|
/** Filters for opportunities with any of the provided contacts. */
|
|
16578
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[];
|
|
16579
16717
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
16580
16718
|
'opportunity.subtype'?: string[];
|
|
16581
16719
|
/**
|
|
@@ -16732,6 +16870,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16732
16870
|
'opportunity.account'?: string[];
|
|
16733
16871
|
/** Filters for opportunities with any of the provided contacts. */
|
|
16734
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[];
|
|
16735
16878
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
16736
16879
|
'opportunity.subtype'?: string[];
|
|
16737
16880
|
/**
|
|
@@ -33,9 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.
|
|
37
|
-
exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo =
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel =
|
|
36
|
+
exports.MetricActionExecuteRequestAction = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -395,15 +395,6 @@ var FieldValueType;
|
|
|
395
395
|
FieldValueType["TagSummary"] = "tag_summary";
|
|
396
396
|
FieldValueType["TagSummaryList"] = "tag_summary_list";
|
|
397
397
|
})(FieldValueType = exports.FieldValueType || (exports.FieldValueType = {}));
|
|
398
|
-
/** Preferred locale of the user. */
|
|
399
|
-
var GeneralPreferencesGroupPreferredLocale;
|
|
400
|
-
(function (GeneralPreferencesGroupPreferredLocale) {
|
|
401
|
-
GeneralPreferencesGroupPreferredLocale["EnUs"] = "en_us";
|
|
402
|
-
GeneralPreferencesGroupPreferredLocale["EsAr"] = "es_ar";
|
|
403
|
-
GeneralPreferencesGroupPreferredLocale["JaJp"] = "ja_jp";
|
|
404
|
-
GeneralPreferencesGroupPreferredLocale["NlAw"] = "nl_aw";
|
|
405
|
-
GeneralPreferencesGroupPreferredLocale["NlSx"] = "nl_sx";
|
|
406
|
-
})(GeneralPreferencesGroupPreferredLocale = exports.GeneralPreferencesGroupPreferredLocale || (exports.GeneralPreferencesGroupPreferredLocale = {}));
|
|
407
398
|
/** Event type of the notification. */
|
|
408
399
|
var GenericNotificationEventType;
|
|
409
400
|
(function (GenericNotificationEventType) {
|
|
@@ -448,13 +439,17 @@ var IssuePriority;
|
|
|
448
439
|
})(IssuePriority = exports.IssuePriority || (exports.IssuePriority = {}));
|
|
449
440
|
var LinkEndpointType;
|
|
450
441
|
(function (LinkEndpointType) {
|
|
442
|
+
LinkEndpointType["Account"] = "account";
|
|
451
443
|
LinkEndpointType["Capability"] = "capability";
|
|
452
444
|
LinkEndpointType["Conversation"] = "conversation";
|
|
445
|
+
LinkEndpointType["DevUser"] = "dev_user";
|
|
453
446
|
LinkEndpointType["Enhancement"] = "enhancement";
|
|
454
447
|
LinkEndpointType["Feature"] = "feature";
|
|
455
448
|
LinkEndpointType["Issue"] = "issue";
|
|
456
449
|
LinkEndpointType["Opportunity"] = "opportunity";
|
|
457
450
|
LinkEndpointType["Product"] = "product";
|
|
451
|
+
LinkEndpointType["RevOrg"] = "rev_org";
|
|
452
|
+
LinkEndpointType["RevUser"] = "rev_user";
|
|
458
453
|
LinkEndpointType["Task"] = "task";
|
|
459
454
|
LinkEndpointType["Ticket"] = "ticket";
|
|
460
455
|
})(LinkEndpointType = exports.LinkEndpointType || (exports.LinkEndpointType = {}));
|
|
@@ -872,6 +867,7 @@ var SyncMetadataFilterSyncInFilterStatus;
|
|
|
872
867
|
var SyncMetadataFilterSyncOutFilterStatus;
|
|
873
868
|
(function (SyncMetadataFilterSyncOutFilterStatus) {
|
|
874
869
|
SyncMetadataFilterSyncOutFilterStatus["Failed"] = "failed";
|
|
870
|
+
SyncMetadataFilterSyncOutFilterStatus["Modified"] = "modified";
|
|
875
871
|
SyncMetadataFilterSyncOutFilterStatus["Succeeded"] = "succeeded";
|
|
876
872
|
})(SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncOutFilterStatus || (exports.SyncMetadataFilterSyncOutFilterStatus = {}));
|
|
877
873
|
/** Status of the sync for the object. */
|
|
@@ -1473,6 +1469,24 @@ class Api extends HttpClient {
|
|
|
1473
1469
|
* @secure
|
|
1474
1470
|
*/
|
|
1475
1471
|
this.authTokensGetPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1472
|
+
/**
|
|
1473
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
1474
|
+
*
|
|
1475
|
+
* @tags auth-tokens
|
|
1476
|
+
* @name AuthTokensInfo
|
|
1477
|
+
* @request GET:/auth-tokens.info
|
|
1478
|
+
* @secure
|
|
1479
|
+
*/
|
|
1480
|
+
this.authTokensInfo = (params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'GET', secure: true, format: 'json' }, params));
|
|
1481
|
+
/**
|
|
1482
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
1483
|
+
*
|
|
1484
|
+
* @tags auth-tokens
|
|
1485
|
+
* @name AuthTokensInfoPost
|
|
1486
|
+
* @request POST:/auth-tokens.info
|
|
1487
|
+
* @secure
|
|
1488
|
+
*/
|
|
1489
|
+
this.authTokensInfoPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1476
1490
|
/**
|
|
1477
1491
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
1478
1492
|
*
|
|
@@ -1667,9 +1667,11 @@ export interface EventTagDeleted {
|
|
|
1667
1667
|
* @example "TAG-12345"
|
|
1668
1668
|
*/
|
|
1669
1669
|
id: string;
|
|
1670
|
+
old_tag?: Tag;
|
|
1670
1671
|
}
|
|
1671
1672
|
/** event-tag-updated */
|
|
1672
1673
|
export interface EventTagUpdated {
|
|
1674
|
+
old_tag?: Tag;
|
|
1673
1675
|
tag: Tag;
|
|
1674
1676
|
}
|
|
1675
1677
|
/** event-timeline-entry-created */
|
|
@@ -1844,16 +1846,19 @@ export type Link = AtomBase & {
|
|
|
1844
1846
|
target: LinkEndpointSummary;
|
|
1845
1847
|
};
|
|
1846
1848
|
/** link-endpoint-summary */
|
|
1847
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | TicketSummary) & {
|
|
1849
|
+
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
|
|
1848
1850
|
type: LinkEndpointType;
|
|
1849
1851
|
};
|
|
1850
1852
|
export declare enum LinkEndpointType {
|
|
1851
1853
|
Capability = "capability",
|
|
1852
1854
|
Conversation = "conversation",
|
|
1855
|
+
DevUser = "dev_user",
|
|
1853
1856
|
Enhancement = "enhancement",
|
|
1854
1857
|
Feature = "feature",
|
|
1855
1858
|
Issue = "issue",
|
|
1856
1859
|
Product = "product",
|
|
1860
|
+
RevOrg = "rev_org",
|
|
1861
|
+
RevUser = "rev_user",
|
|
1857
1862
|
Ticket = "ticket"
|
|
1858
1863
|
}
|
|
1859
1864
|
/** Type of link used to define the relationship. */
|
|
@@ -1947,6 +1952,8 @@ export interface MetricDefinitionsListRequest {
|
|
|
1947
1952
|
* always be returned in the specified sort-by order.
|
|
1948
1953
|
*/
|
|
1949
1954
|
mode?: ListMode;
|
|
1955
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
1956
|
+
sort_by?: string[];
|
|
1950
1957
|
/** The status of the metric definition. */
|
|
1951
1958
|
status?: MetricDefinitionStatus[];
|
|
1952
1959
|
}
|
|
@@ -3247,6 +3254,8 @@ export interface SlaTrackersListRequest {
|
|
|
3247
3254
|
*/
|
|
3248
3255
|
mode?: ListMode;
|
|
3249
3256
|
modified_date?: DateTimeFilter;
|
|
3257
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
3258
|
+
sort_by?: string[];
|
|
3250
3259
|
/** The SLA tracker stages the filter matches. */
|
|
3251
3260
|
stage?: string[];
|
|
3252
3261
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -3359,6 +3368,8 @@ export interface SlasListRequest {
|
|
|
3359
3368
|
mode?: ListMode;
|
|
3360
3369
|
/** The SLA types the filter matches. */
|
|
3361
3370
|
sla_type?: SlaType[];
|
|
3371
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
3372
|
+
sort_by?: string[];
|
|
3362
3373
|
/** The SLA statuses the filter matches. */
|
|
3363
3374
|
status?: SlaStatus[];
|
|
3364
3375
|
}
|
|
@@ -3555,6 +3566,7 @@ export interface SyncMetadataFilterSyncOutFilter {
|
|
|
3555
3566
|
}
|
|
3556
3567
|
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
3557
3568
|
Failed = "failed",
|
|
3569
|
+
Modified = "modified",
|
|
3558
3570
|
Succeeded = "succeeded"
|
|
3559
3571
|
}
|
|
3560
3572
|
/** sys-user-summary */
|
|
@@ -5556,6 +5568,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5556
5568
|
* used.
|
|
5557
5569
|
*/
|
|
5558
5570
|
mode?: ListMode;
|
|
5571
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
5572
|
+
sort_by?: string[];
|
|
5559
5573
|
/** The status of the metric definition. */
|
|
5560
5574
|
status?: MetricDefinitionStatus[];
|
|
5561
5575
|
/** The type of metric definitions sought. */
|
|
@@ -5881,6 +5895,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5881
5895
|
* @example "2023-01-01T12:00:00.000Z"
|
|
5882
5896
|
*/
|
|
5883
5897
|
'modified_date.before'?: string;
|
|
5898
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
5899
|
+
sort_by?: string[];
|
|
5884
5900
|
/** The SLA tracker stages the filter matches. */
|
|
5885
5901
|
stage?: string[];
|
|
5886
5902
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -5967,6 +5983,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5967
5983
|
mode?: ListMode;
|
|
5968
5984
|
/** The SLA types the filter matches. */
|
|
5969
5985
|
sla_type?: SlaType[];
|
|
5986
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
5987
|
+
sort_by?: string[];
|
|
5970
5988
|
/** The SLA statuses the filter matches. */
|
|
5971
5989
|
status?: SlaStatus[];
|
|
5972
5990
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
@@ -212,10 +212,13 @@ var LinkEndpointType;
|
|
|
212
212
|
(function (LinkEndpointType) {
|
|
213
213
|
LinkEndpointType["Capability"] = "capability";
|
|
214
214
|
LinkEndpointType["Conversation"] = "conversation";
|
|
215
|
+
LinkEndpointType["DevUser"] = "dev_user";
|
|
215
216
|
LinkEndpointType["Enhancement"] = "enhancement";
|
|
216
217
|
LinkEndpointType["Feature"] = "feature";
|
|
217
218
|
LinkEndpointType["Issue"] = "issue";
|
|
218
219
|
LinkEndpointType["Product"] = "product";
|
|
220
|
+
LinkEndpointType["RevOrg"] = "rev_org";
|
|
221
|
+
LinkEndpointType["RevUser"] = "rev_user";
|
|
219
222
|
LinkEndpointType["Ticket"] = "ticket";
|
|
220
223
|
})(LinkEndpointType = exports.LinkEndpointType || (exports.LinkEndpointType = {}));
|
|
221
224
|
/** Type of link used to define the relationship. */
|
|
@@ -440,6 +443,7 @@ var SyncMetadataFilterSyncInFilterStatus;
|
|
|
440
443
|
var SyncMetadataFilterSyncOutFilterStatus;
|
|
441
444
|
(function (SyncMetadataFilterSyncOutFilterStatus) {
|
|
442
445
|
SyncMetadataFilterSyncOutFilterStatus["Failed"] = "failed";
|
|
446
|
+
SyncMetadataFilterSyncOutFilterStatus["Modified"] = "modified";
|
|
443
447
|
SyncMetadataFilterSyncOutFilterStatus["Succeeded"] = "succeeded";
|
|
444
448
|
})(SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncOutFilterStatus || (exports.SyncMetadataFilterSyncOutFilterStatus = {}));
|
|
445
449
|
/** Channels of the ticket. */
|