@devrev/typescript-sdk 1.1.33 → 1.1.35
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.
|
@@ -38,6 +38,11 @@ export type Account = OrgBase & {
|
|
|
38
38
|
tags?: TagWithValue[];
|
|
39
39
|
/** The Tier of the corresponding Account. */
|
|
40
40
|
tier?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Company's website links. Filling in this property will also fill in
|
|
43
|
+
* domain. Example - 'www.devrev.ai'.
|
|
44
|
+
*/
|
|
45
|
+
websites?: string[];
|
|
41
46
|
};
|
|
42
47
|
/** account-search-summary */
|
|
43
48
|
export type AccountSearchSummary = SearchSummaryBase & {
|
|
@@ -62,6 +67,14 @@ export interface AccountsCreateRequest {
|
|
|
62
67
|
artifacts?: string[];
|
|
63
68
|
/** Application-defined custom fields. */
|
|
64
69
|
custom_fields?: object;
|
|
70
|
+
/**
|
|
71
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
72
|
+
* custom field must be specified, otherwise a bad request error is
|
|
73
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
74
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
75
|
+
* specifier, it remains unmodified.
|
|
76
|
+
*/
|
|
77
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
65
78
|
/** Description of the account. */
|
|
66
79
|
description?: string;
|
|
67
80
|
/** Name of the account. */
|
|
@@ -77,6 +90,7 @@ export interface AccountsCreateRequest {
|
|
|
77
90
|
owned_by?: string[];
|
|
78
91
|
/**
|
|
79
92
|
* Schema fragment IDs associated with this account SOR.
|
|
93
|
+
* @deprecated
|
|
80
94
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
81
95
|
*/
|
|
82
96
|
schema_fragment_ids?: string[];
|
|
@@ -146,6 +160,8 @@ export interface AccountsExportRequest {
|
|
|
146
160
|
stage?: string[];
|
|
147
161
|
/** List of tags to be filtered. */
|
|
148
162
|
tags?: string[];
|
|
163
|
+
/** Array of websites of accounts to be filtered. */
|
|
164
|
+
websites?: string[];
|
|
149
165
|
}
|
|
150
166
|
/**
|
|
151
167
|
* accounts-export-response
|
|
@@ -175,6 +191,8 @@ export interface AccountsFilters {
|
|
|
175
191
|
stage?: string[];
|
|
176
192
|
/** List of tags to be filtered. */
|
|
177
193
|
tags?: string[];
|
|
194
|
+
/** Array of websites of accounts to be filtered. */
|
|
195
|
+
websites?: string[];
|
|
178
196
|
}
|
|
179
197
|
/**
|
|
180
198
|
* accounts-get-request
|
|
@@ -238,6 +256,8 @@ export interface AccountsListRequest {
|
|
|
238
256
|
stage?: string[];
|
|
239
257
|
/** List of tags to be filtered. */
|
|
240
258
|
tags?: string[];
|
|
259
|
+
/** Array of websites of accounts to be filtered. */
|
|
260
|
+
websites?: string[];
|
|
241
261
|
}
|
|
242
262
|
/**
|
|
243
263
|
* accounts-list-response
|
|
@@ -257,6 +277,28 @@ export interface AccountsListResponse {
|
|
|
257
277
|
*/
|
|
258
278
|
prev_cursor?: string;
|
|
259
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
* accounts-merge-request
|
|
282
|
+
* Request object to merge two accounts.
|
|
283
|
+
*/
|
|
284
|
+
export interface AccountsMergeRequest {
|
|
285
|
+
/**
|
|
286
|
+
* The ID of the primary account, which will be retained post merge.
|
|
287
|
+
* @example "ACC-12345"
|
|
288
|
+
*/
|
|
289
|
+
primary_account: string;
|
|
290
|
+
/**
|
|
291
|
+
* The ID of the secondary account, which will be merged into the
|
|
292
|
+
* primary account.
|
|
293
|
+
* @example "ACC-12345"
|
|
294
|
+
*/
|
|
295
|
+
secondary_account: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* accounts-merge-response
|
|
299
|
+
* The response to merging an account.
|
|
300
|
+
*/
|
|
301
|
+
export type AccountsMergeResponse = object;
|
|
260
302
|
/**
|
|
261
303
|
* accounts-update-request
|
|
262
304
|
* Request to update details of the account.
|
|
@@ -265,6 +307,14 @@ export interface AccountsUpdateRequest {
|
|
|
265
307
|
artifacts?: AccountsUpdateRequestArtifacts;
|
|
266
308
|
/** Application-defined custom fields. */
|
|
267
309
|
custom_fields?: object;
|
|
310
|
+
/**
|
|
311
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
312
|
+
* custom field must be specified, otherwise a bad request error is
|
|
313
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
314
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
315
|
+
* specifier, it remains unmodified.
|
|
316
|
+
*/
|
|
317
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
268
318
|
/** Updated description of the account. */
|
|
269
319
|
description?: string;
|
|
270
320
|
/** Updated display name for the account. */
|
|
@@ -282,6 +332,7 @@ export interface AccountsUpdateRequest {
|
|
|
282
332
|
owned_by?: string[];
|
|
283
333
|
/**
|
|
284
334
|
* Schema fragment IDs associated with this account SOR.
|
|
335
|
+
* @deprecated
|
|
285
336
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
286
337
|
*/
|
|
287
338
|
schema_fragment_ids?: string[];
|
|
@@ -289,6 +340,7 @@ export interface AccountsUpdateRequest {
|
|
|
289
340
|
tags?: SetTagWithValue[];
|
|
290
341
|
/** Updated tier of the account. */
|
|
291
342
|
tier?: string | null;
|
|
343
|
+
websites?: AccountsUpdateRequestWebsites;
|
|
292
344
|
}
|
|
293
345
|
/** accounts-update-request-artifacts */
|
|
294
346
|
export interface AccountsUpdateRequestArtifacts {
|
|
@@ -298,6 +350,11 @@ export interface AccountsUpdateRequestArtifacts {
|
|
|
298
350
|
*/
|
|
299
351
|
set?: string[];
|
|
300
352
|
}
|
|
353
|
+
/** accounts-update-request-websites */
|
|
354
|
+
export interface AccountsUpdateRequestWebsites {
|
|
355
|
+
/** Sets the websites field of the account. */
|
|
356
|
+
set?: string[];
|
|
357
|
+
}
|
|
301
358
|
/**
|
|
302
359
|
* accounts-update-response
|
|
303
360
|
* Updated account object.
|
|
@@ -408,6 +465,79 @@ export declare enum AggregationDetailAggregationType {
|
|
|
408
465
|
Sum = "sum",
|
|
409
466
|
UniqueCount = "unique_count"
|
|
410
467
|
}
|
|
468
|
+
/**
|
|
469
|
+
* airdrop-sync-units-get-request
|
|
470
|
+
* Request to get a sync unit.
|
|
471
|
+
*/
|
|
472
|
+
export interface AirdropSyncUnitsGetRequest {
|
|
473
|
+
/** Requested sync unit ID. */
|
|
474
|
+
id: string;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* airdrop-sync-units-get-response
|
|
478
|
+
* Response containing the requested sync unit.
|
|
479
|
+
*/
|
|
480
|
+
export interface AirdropSyncUnitsGetResponse {
|
|
481
|
+
sync_unit: SyncUnit;
|
|
482
|
+
}
|
|
483
|
+
/** airdrop-sync-units-history-filter */
|
|
484
|
+
export interface AirdropSyncUnitsHistoryFilter {
|
|
485
|
+
/** Provides ways to specify date ranges on objects. */
|
|
486
|
+
ended_at?: DateFilter;
|
|
487
|
+
/** Filter for sync runs that have errors. */
|
|
488
|
+
has_errors_or_warnings?: boolean;
|
|
489
|
+
/** Mode of the sync run. */
|
|
490
|
+
mode?: SyncRunMode[];
|
|
491
|
+
/** User who started the sync run. */
|
|
492
|
+
started_by?: SyncRunStartedBy[];
|
|
493
|
+
/** State of the sync run. */
|
|
494
|
+
state?: SyncRunProgressState[];
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* airdrop-sync-units-history-request
|
|
498
|
+
* Request to list sync unit history.
|
|
499
|
+
*/
|
|
500
|
+
export interface AirdropSyncUnitsHistoryRequest {
|
|
501
|
+
/**
|
|
502
|
+
* The cursor to resume iteration from. If not provided, then
|
|
503
|
+
* iteration starts from the beginning.
|
|
504
|
+
*/
|
|
505
|
+
cursor?: string;
|
|
506
|
+
filter?: AirdropSyncUnitsHistoryFilter;
|
|
507
|
+
/** Sync unit that will be used for sync history listing. */
|
|
508
|
+
id: string;
|
|
509
|
+
/**
|
|
510
|
+
* The maximum number of items to return. The default is '50'.
|
|
511
|
+
* @format int32
|
|
512
|
+
*/
|
|
513
|
+
limit?: number;
|
|
514
|
+
/**
|
|
515
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
516
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
517
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
518
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
519
|
+
* always be returned in the specified sort-by order.
|
|
520
|
+
*/
|
|
521
|
+
mode?: ListMode;
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* airdrop-sync-units-history-response
|
|
525
|
+
* List sync history response.
|
|
526
|
+
*/
|
|
527
|
+
export interface AirdropSyncUnitsHistoryResponse {
|
|
528
|
+
/**
|
|
529
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
530
|
+
* sort order. If not set, then no later elements exist.
|
|
531
|
+
*/
|
|
532
|
+
next_cursor?: string;
|
|
533
|
+
/**
|
|
534
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
535
|
+
* sort order. If not set, then no prior elements exist.
|
|
536
|
+
*/
|
|
537
|
+
prev_cursor?: string;
|
|
538
|
+
/** Historical records of syncs. */
|
|
539
|
+
sync_history: SyncHistory[];
|
|
540
|
+
}
|
|
411
541
|
/** app-fragment */
|
|
412
542
|
export type AppFragment = CustomSchemaFragmentBase & {
|
|
413
543
|
/** App this fragment applies to. */
|
|
@@ -477,7 +607,7 @@ export interface ArchetypeMetricTarget {
|
|
|
477
607
|
}
|
|
478
608
|
/** article */
|
|
479
609
|
export type Article = AtomBase & {
|
|
480
|
-
/**
|
|
610
|
+
/** Parts relevant to the article. */
|
|
481
611
|
applies_to_parts: PartSummary[];
|
|
482
612
|
/** Type of the article. */
|
|
483
613
|
article_type?: ArticleType;
|
|
@@ -485,7 +615,7 @@ export type Article = AtomBase & {
|
|
|
485
615
|
authored_by?: UserSummary[];
|
|
486
616
|
/** Description of the article. */
|
|
487
617
|
description?: string;
|
|
488
|
-
/**
|
|
618
|
+
/** Extracted content of the article. */
|
|
489
619
|
extracted_content?: ArtifactSummary[];
|
|
490
620
|
/**
|
|
491
621
|
* Number of downvotes on the article.
|
|
@@ -497,7 +627,7 @@ export type Article = AtomBase & {
|
|
|
497
627
|
* @format int32
|
|
498
628
|
*/
|
|
499
629
|
num_upvotes?: number;
|
|
500
|
-
/**
|
|
630
|
+
/** Users that own the article. */
|
|
501
631
|
owned_by: UserSummary[];
|
|
502
632
|
parent?: DirectorySummary;
|
|
503
633
|
/** Rank of the article. */
|
|
@@ -568,10 +698,7 @@ export interface ArticlesCountRequest {
|
|
|
568
698
|
* @example ["DEVU-12345"]
|
|
569
699
|
*/
|
|
570
700
|
owned_by?: string[];
|
|
571
|
-
/**
|
|
572
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
573
|
-
* only external articles are returned.
|
|
574
|
-
*/
|
|
701
|
+
/** Filter for the scope of the articles. */
|
|
575
702
|
scope?: number[];
|
|
576
703
|
/** Filter for articles based on intended audience. */
|
|
577
704
|
shared_with?: SharedWithMembershipFilter[];
|
|
@@ -590,6 +717,11 @@ export interface ArticlesCountResponse {
|
|
|
590
717
|
*/
|
|
591
718
|
export interface ArticlesCreateRequest {
|
|
592
719
|
access_level?: AccessLevel;
|
|
720
|
+
/**
|
|
721
|
+
* The aliases of the article.
|
|
722
|
+
* @maxItems 5
|
|
723
|
+
*/
|
|
724
|
+
aliases?: string[];
|
|
593
725
|
/**
|
|
594
726
|
* The parts that the article applies to.
|
|
595
727
|
* @minItems 1
|
|
@@ -657,6 +789,11 @@ export interface ArticlesCreateRequestResource {
|
|
|
657
789
|
* @example ["ARTIFACT-12345"]
|
|
658
790
|
*/
|
|
659
791
|
artifacts?: string[];
|
|
792
|
+
/**
|
|
793
|
+
* List of content blocks used in the article.
|
|
794
|
+
* @example ["ARTICLE-12345"]
|
|
795
|
+
*/
|
|
796
|
+
content_blocks?: string[];
|
|
660
797
|
/** The latest published version. */
|
|
661
798
|
published_version?: string;
|
|
662
799
|
/** URL of the external article. */
|
|
@@ -753,10 +890,7 @@ export interface ArticlesListRequest {
|
|
|
753
890
|
* @example ["DEVU-12345"]
|
|
754
891
|
*/
|
|
755
892
|
owned_by?: string[];
|
|
756
|
-
/**
|
|
757
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
758
|
-
* only external articles are returned.
|
|
759
|
-
*/
|
|
893
|
+
/** Filter for the scope of the articles. */
|
|
760
894
|
scope?: number[];
|
|
761
895
|
/** Filter for articles based on intended audience. */
|
|
762
896
|
shared_with?: SharedWithMembershipFilter[];
|
|
@@ -790,9 +924,11 @@ export interface ArticlesListResponse {
|
|
|
790
924
|
*/
|
|
791
925
|
export interface ArticlesUpdateRequest {
|
|
792
926
|
access_level?: AccessLevel;
|
|
927
|
+
aliases?: ArticlesUpdateRequestAliases;
|
|
793
928
|
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
794
929
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
795
930
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
931
|
+
content_blocks?: ArticlesUpdateRequestContentBlocks;
|
|
796
932
|
/** Application-defined custom fields. */
|
|
797
933
|
custom_fields?: object;
|
|
798
934
|
/**
|
|
@@ -831,6 +967,14 @@ export interface ArticlesUpdateRequest {
|
|
|
831
967
|
/** Updates the URL of the external article. */
|
|
832
968
|
url?: string;
|
|
833
969
|
}
|
|
970
|
+
/** articles-update-request-aliases */
|
|
971
|
+
export interface ArticlesUpdateRequestAliases {
|
|
972
|
+
/**
|
|
973
|
+
* Updates the aliases of the article.
|
|
974
|
+
* @maxItems 5
|
|
975
|
+
*/
|
|
976
|
+
set: string[];
|
|
977
|
+
}
|
|
834
978
|
/** articles-update-request-applies-to-parts */
|
|
835
979
|
export interface ArticlesUpdateRequestAppliesToParts {
|
|
836
980
|
/**
|
|
@@ -855,6 +999,14 @@ export interface ArticlesUpdateRequestAuthoredBy {
|
|
|
855
999
|
*/
|
|
856
1000
|
set?: string[];
|
|
857
1001
|
}
|
|
1002
|
+
/** articles-update-request-content-blocks */
|
|
1003
|
+
export interface ArticlesUpdateRequestContentBlocks {
|
|
1004
|
+
/**
|
|
1005
|
+
* Updates IDs of the content blocks.
|
|
1006
|
+
* @example ["ARTICLE-12345"]
|
|
1007
|
+
*/
|
|
1008
|
+
set: string[];
|
|
1009
|
+
}
|
|
858
1010
|
/** articles-update-request-extracted-content */
|
|
859
1011
|
export interface ArticlesUpdateRequestExtractedContent {
|
|
860
1012
|
/**
|
|
@@ -1076,7 +1228,7 @@ export interface AtomBaseSummary {
|
|
|
1076
1228
|
id: string;
|
|
1077
1229
|
}
|
|
1078
1230
|
/** atom-summary */
|
|
1079
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UserPreferencesSummary | WebhookSummary) & {
|
|
1231
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UserPreferencesSummary | WebhookSummary) & {
|
|
1080
1232
|
type: AtomType;
|
|
1081
1233
|
};
|
|
1082
1234
|
export declare enum AtomType {
|
|
@@ -1089,6 +1241,7 @@ export declare enum AtomType {
|
|
|
1089
1241
|
Engagement = "engagement",
|
|
1090
1242
|
Enhancement = "enhancement",
|
|
1091
1243
|
Feature = "feature",
|
|
1244
|
+
Incident = "incident",
|
|
1092
1245
|
Issue = "issue",
|
|
1093
1246
|
Meeting = "meeting",
|
|
1094
1247
|
Opportunity = "opportunity",
|
|
@@ -1111,7 +1264,7 @@ export declare enum AtomType {
|
|
|
1111
1264
|
* Connection object that specifies the configuration for an
|
|
1112
1265
|
* authentication connection that is set up for a Dev organization.
|
|
1113
1266
|
*/
|
|
1114
|
-
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1267
|
+
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsOkta | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1115
1268
|
/**
|
|
1116
1269
|
* Defines the type for the authentication connection. The configuration
|
|
1117
1270
|
* for each authentication connection will depend on the type value.
|
|
@@ -1123,13 +1276,13 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1123
1276
|
* organization. For example, if the display_name is 'abclogin', then
|
|
1124
1277
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
1125
1278
|
*/
|
|
1126
|
-
display_name
|
|
1279
|
+
display_name: string;
|
|
1127
1280
|
/**
|
|
1128
1281
|
* Whether the authentication connection is enabled or disabled. If
|
|
1129
1282
|
* set to false, the authentication connection will not show up on the
|
|
1130
1283
|
* login screen as a login option.
|
|
1131
1284
|
*/
|
|
1132
|
-
enabled
|
|
1285
|
+
enabled: boolean;
|
|
1133
1286
|
/** ID of the authentication connection. */
|
|
1134
1287
|
id: string;
|
|
1135
1288
|
};
|
|
@@ -1137,27 +1290,25 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1137
1290
|
* auth-connection-options-azure-ad
|
|
1138
1291
|
* Object encapsulating the configuration parameters for an Azure AD
|
|
1139
1292
|
* authentication connection.
|
|
1293
|
+
* @deprecated
|
|
1140
1294
|
*/
|
|
1141
1295
|
export interface AuthConnectionOptionsAzureAd {
|
|
1142
1296
|
/** Client ID for the Azure authentication connection. */
|
|
1143
|
-
client_id
|
|
1144
|
-
/** Client secret for the Azure authentication connection. */
|
|
1145
|
-
client_secret?: string;
|
|
1297
|
+
client_id: string;
|
|
1146
1298
|
/** Domain URL of the Azure authentication connection. */
|
|
1147
|
-
domain
|
|
1299
|
+
domain: string;
|
|
1148
1300
|
}
|
|
1149
1301
|
/**
|
|
1150
1302
|
* auth-connection-options-google-apps
|
|
1151
1303
|
* Object encapsulating the configuration parameters for a Google Apps
|
|
1152
1304
|
* authentication connection.
|
|
1305
|
+
* @deprecated
|
|
1153
1306
|
*/
|
|
1154
1307
|
export interface AuthConnectionOptionsGoogleApps {
|
|
1155
1308
|
/** Client ID for the Google Apps authentication connection. */
|
|
1156
|
-
client_id
|
|
1157
|
-
/** Client secret for the Google Apps authentication connection. */
|
|
1158
|
-
client_secret?: string;
|
|
1309
|
+
client_id: string;
|
|
1159
1310
|
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
1160
|
-
tenant_domain
|
|
1311
|
+
tenant_domain: string;
|
|
1161
1312
|
}
|
|
1162
1313
|
/**
|
|
1163
1314
|
* auth-connection-options-oidc
|
|
@@ -1166,11 +1317,21 @@ export interface AuthConnectionOptionsGoogleApps {
|
|
|
1166
1317
|
*/
|
|
1167
1318
|
export interface AuthConnectionOptionsOidc {
|
|
1168
1319
|
/** Client ID for the OIDC authentication connection. */
|
|
1169
|
-
client_id
|
|
1170
|
-
/** Client secret for the OIDC authentication connection. */
|
|
1171
|
-
client_secret?: string;
|
|
1320
|
+
client_id: string;
|
|
1172
1321
|
/** Issuer URL of the OIDC authentication connection. */
|
|
1173
|
-
issuer
|
|
1322
|
+
issuer: string;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* auth-connection-options-okta
|
|
1326
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
1327
|
+
* authentication connection.
|
|
1328
|
+
* @deprecated
|
|
1329
|
+
*/
|
|
1330
|
+
export interface AuthConnectionOptionsOkta {
|
|
1331
|
+
/** Client ID for the Okta authentication connection. */
|
|
1332
|
+
client_id: string;
|
|
1333
|
+
/** Domain URL of the Okta authentication connection. */
|
|
1334
|
+
domain: string;
|
|
1174
1335
|
}
|
|
1175
1336
|
/**
|
|
1176
1337
|
* auth-connection-options-saml
|
|
@@ -1178,10 +1339,15 @@ export interface AuthConnectionOptionsOidc {
|
|
|
1178
1339
|
* authentication connection.
|
|
1179
1340
|
*/
|
|
1180
1341
|
export interface AuthConnectionOptionsSaml {
|
|
1342
|
+
/**
|
|
1343
|
+
* Connection name for the SAML authentication connection.
|
|
1344
|
+
* @minLength 1
|
|
1345
|
+
* @maxLength 128
|
|
1346
|
+
*/
|
|
1347
|
+
connection_name?: string;
|
|
1348
|
+
fields_map: SamlConnectionFieldsMap;
|
|
1181
1349
|
/** Sign In endpoint for the SAML authentication connection. */
|
|
1182
|
-
sign_in_endpoint
|
|
1183
|
-
/** Signing certificate for the SAML authentication connection. */
|
|
1184
|
-
signing_cert?: string;
|
|
1350
|
+
sign_in_endpoint: string;
|
|
1185
1351
|
}
|
|
1186
1352
|
/** auth-connection-options-social */
|
|
1187
1353
|
export type AuthConnectionOptionsSocial = object;
|
|
@@ -1196,6 +1362,7 @@ export declare enum AuthConnectionToggle {
|
|
|
1196
1362
|
export declare enum AuthConnectionType {
|
|
1197
1363
|
GoogleApps = "google_apps",
|
|
1198
1364
|
Oidc = "oidc",
|
|
1365
|
+
Okta = "okta",
|
|
1199
1366
|
Samlp = "samlp",
|
|
1200
1367
|
Social = "social",
|
|
1201
1368
|
Waad = "waad"
|
|
@@ -1402,6 +1569,25 @@ export interface AuthTokensGetRequest {
|
|
|
1402
1569
|
export interface AuthTokensGetResponse {
|
|
1403
1570
|
token: AuthToken;
|
|
1404
1571
|
}
|
|
1572
|
+
/**
|
|
1573
|
+
* auth-tokens-info-request
|
|
1574
|
+
* The request to get the Dev organization, user and token attributes
|
|
1575
|
+
* extracted from the auth token.
|
|
1576
|
+
*/
|
|
1577
|
+
export type AuthTokensInfoRequest = object;
|
|
1578
|
+
/**
|
|
1579
|
+
* auth-tokens-info-response
|
|
1580
|
+
* The Dev organization, user and token attributes extracted from the auth
|
|
1581
|
+
* token.
|
|
1582
|
+
*/
|
|
1583
|
+
export interface AuthTokensInfoResponse {
|
|
1584
|
+
/** The Dev organization attributes extracted from the auth token. */
|
|
1585
|
+
organization: AuthTokensOrgAttributes;
|
|
1586
|
+
/** The token attributes extracted from the auth token. */
|
|
1587
|
+
token: AuthTokensTokenAttributes;
|
|
1588
|
+
/** The user attributes extracted from the auth token. */
|
|
1589
|
+
user: AuthTokensUserAttributes;
|
|
1590
|
+
}
|
|
1405
1591
|
/**
|
|
1406
1592
|
* auth-tokens-list-request
|
|
1407
1593
|
* A request to list the token metadata.
|
|
@@ -1429,6 +1615,21 @@ export interface AuthTokensListResponse {
|
|
|
1429
1615
|
/** The list of token metadata. */
|
|
1430
1616
|
tokens: AuthToken[];
|
|
1431
1617
|
}
|
|
1618
|
+
/**
|
|
1619
|
+
* auth-tokens-org-attributes
|
|
1620
|
+
* The Dev organization attributes extracted from the auth token.
|
|
1621
|
+
*/
|
|
1622
|
+
export interface AuthTokensOrgAttributes {
|
|
1623
|
+
/** The display ID of the Dev organization. */
|
|
1624
|
+
display_id: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* The ID of the the Dev organization.
|
|
1627
|
+
* @example "DEV-AbCdEfGh"
|
|
1628
|
+
*/
|
|
1629
|
+
id: string;
|
|
1630
|
+
/** The slug of the Dev organization. */
|
|
1631
|
+
slug?: string;
|
|
1632
|
+
}
|
|
1432
1633
|
/**
|
|
1433
1634
|
* auth-tokens-org-traits
|
|
1434
1635
|
* Carries Rev org info.
|
|
@@ -1487,6 +1688,26 @@ export interface AuthTokensSelfDeleteRequest {
|
|
|
1487
1688
|
/** The type of the requested token. */
|
|
1488
1689
|
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1489
1690
|
}
|
|
1691
|
+
/**
|
|
1692
|
+
* auth-tokens-token-attributes
|
|
1693
|
+
* The token attributes extracted from the auth token.
|
|
1694
|
+
*/
|
|
1695
|
+
export interface AuthTokensTokenAttributes {
|
|
1696
|
+
/**
|
|
1697
|
+
* The expiry (exp) of the token in seconds from Unix epoch.
|
|
1698
|
+
* @format int64
|
|
1699
|
+
*/
|
|
1700
|
+
expiry: number;
|
|
1701
|
+
/**
|
|
1702
|
+
* The issued at (iat) time of the token in seconds from Unix epoch.
|
|
1703
|
+
* @format int64
|
|
1704
|
+
*/
|
|
1705
|
+
issued_at: number;
|
|
1706
|
+
/** The issuer ID (iss) of the token. */
|
|
1707
|
+
issuer: string;
|
|
1708
|
+
/** The subject (sub) of the token. */
|
|
1709
|
+
subject: string;
|
|
1710
|
+
}
|
|
1490
1711
|
/**
|
|
1491
1712
|
* auth-tokens-update-request
|
|
1492
1713
|
* A request to update the token metadata.
|
|
@@ -1504,6 +1725,23 @@ export interface AuthTokensUpdateRequest {
|
|
|
1504
1725
|
export interface AuthTokensUpdateResponse {
|
|
1505
1726
|
token: AuthToken;
|
|
1506
1727
|
}
|
|
1728
|
+
/**
|
|
1729
|
+
* auth-tokens-user-attributes
|
|
1730
|
+
* The user attributes extracted from the auth token.
|
|
1731
|
+
*/
|
|
1732
|
+
export interface AuthTokensUserAttributes {
|
|
1733
|
+
type: UserType;
|
|
1734
|
+
/** The display ID of the user. */
|
|
1735
|
+
display_id: string;
|
|
1736
|
+
/** The display name of the user. */
|
|
1737
|
+
display_name?: string;
|
|
1738
|
+
/** The email address of the user. */
|
|
1739
|
+
email?: string;
|
|
1740
|
+
/** The full name of the user. */
|
|
1741
|
+
full_name?: string;
|
|
1742
|
+
/** The ID of the user. */
|
|
1743
|
+
id: string;
|
|
1744
|
+
}
|
|
1507
1745
|
/**
|
|
1508
1746
|
* auth-tokens-user-traits
|
|
1509
1747
|
* Carries Rev user info.
|
|
@@ -1982,6 +2220,16 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
1982
2220
|
*/
|
|
1983
2221
|
export interface ConversationsCreateRequest {
|
|
1984
2222
|
type: ConversationsCreateRequestTypeValue;
|
|
2223
|
+
/** Application-defined custom fields. */
|
|
2224
|
+
custom_fields?: object;
|
|
2225
|
+
/**
|
|
2226
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2227
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2228
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2229
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2230
|
+
* specifier, it remains unmodified.
|
|
2231
|
+
*/
|
|
2232
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1985
2233
|
/** Description for the conversation. */
|
|
1986
2234
|
description?: string;
|
|
1987
2235
|
/** The group that the conversation is associated with. */
|
|
@@ -2053,6 +2301,8 @@ export interface ConversationsExportRequest {
|
|
|
2053
2301
|
* @example ["PROD-12345"]
|
|
2054
2302
|
*/
|
|
2055
2303
|
applies_to_parts?: string[];
|
|
2304
|
+
/** Filters for custom fields. */
|
|
2305
|
+
custom_fields?: object;
|
|
2056
2306
|
/**
|
|
2057
2307
|
* The number of conversation items to return. The default is '50',
|
|
2058
2308
|
* the maximum is '5000'.
|
|
@@ -2078,15 +2328,29 @@ export interface ConversationsExportRequest {
|
|
|
2078
2328
|
/**
|
|
2079
2329
|
* Filters for conversations that are associated with any of the
|
|
2080
2330
|
* provided Rev organizations.
|
|
2331
|
+
* @deprecated
|
|
2081
2332
|
* @example ["REV-AbCdEfGh"]
|
|
2082
2333
|
*/
|
|
2083
2334
|
rev_org?: string[];
|
|
2335
|
+
/**
|
|
2336
|
+
* Filters for conversations that are associated with any of the
|
|
2337
|
+
* provided Rev organizations.
|
|
2338
|
+
* @example ["REV-AbCdEfGh"]
|
|
2339
|
+
*/
|
|
2340
|
+
rev_orgs?: string[];
|
|
2084
2341
|
/** The filter for SLA summary. */
|
|
2085
2342
|
sla_summary?: SlaSummaryFilter;
|
|
2086
2343
|
/** Filters for conversations with any of the provided source channels. */
|
|
2344
|
+
source_channel?: string[];
|
|
2345
|
+
/**
|
|
2346
|
+
* Filters for conversations with any of the provided source channels.
|
|
2347
|
+
* @deprecated
|
|
2348
|
+
*/
|
|
2087
2349
|
source_channels?: string[];
|
|
2088
2350
|
/** The filter for stages. */
|
|
2089
2351
|
stage?: StageFilter;
|
|
2352
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2353
|
+
subtype?: string[];
|
|
2090
2354
|
/**
|
|
2091
2355
|
* Filters for conversations with any of the provided tags.
|
|
2092
2356
|
* @deprecated
|
|
@@ -2131,6 +2395,8 @@ export interface ConversationsListRequest {
|
|
|
2131
2395
|
* iteration starts from the beginning.
|
|
2132
2396
|
*/
|
|
2133
2397
|
cursor?: string;
|
|
2398
|
+
/** Filters for custom fields. */
|
|
2399
|
+
custom_fields?: object;
|
|
2134
2400
|
/** Filters for conversation that belong to the given groups. */
|
|
2135
2401
|
group?: string[];
|
|
2136
2402
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -2163,15 +2429,29 @@ export interface ConversationsListRequest {
|
|
|
2163
2429
|
/**
|
|
2164
2430
|
* Filters for conversations that are associated with any of the
|
|
2165
2431
|
* provided Rev organizations.
|
|
2432
|
+
* @deprecated
|
|
2166
2433
|
* @example ["REV-AbCdEfGh"]
|
|
2167
2434
|
*/
|
|
2168
2435
|
rev_org?: string[];
|
|
2436
|
+
/**
|
|
2437
|
+
* Filters for conversations that are associated with any of the
|
|
2438
|
+
* provided Rev organizations.
|
|
2439
|
+
* @example ["REV-AbCdEfGh"]
|
|
2440
|
+
*/
|
|
2441
|
+
rev_orgs?: string[];
|
|
2169
2442
|
/** The filter for SLA summary. */
|
|
2170
2443
|
sla_summary?: SlaSummaryFilter;
|
|
2171
2444
|
/** Filters for conversations with any of the provided source channels. */
|
|
2445
|
+
source_channel?: string[];
|
|
2446
|
+
/**
|
|
2447
|
+
* Filters for conversations with any of the provided source channels.
|
|
2448
|
+
* @deprecated
|
|
2449
|
+
*/
|
|
2172
2450
|
source_channels?: string[];
|
|
2173
2451
|
/** The filter for stages. */
|
|
2174
2452
|
stage?: StageFilter;
|
|
2453
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2454
|
+
subtype?: string[];
|
|
2175
2455
|
/**
|
|
2176
2456
|
* Filters for conversations with any of the provided tags.
|
|
2177
2457
|
* @deprecated
|
|
@@ -2205,6 +2485,16 @@ export interface ConversationsListResponse {
|
|
|
2205
2485
|
*/
|
|
2206
2486
|
export interface ConversationsUpdateRequest {
|
|
2207
2487
|
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
2488
|
+
/** Application-defined custom fields. */
|
|
2489
|
+
custom_fields?: object;
|
|
2490
|
+
/**
|
|
2491
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2492
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2493
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2494
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2495
|
+
* specifier, it remains unmodified.
|
|
2496
|
+
*/
|
|
2497
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2208
2498
|
/** The updated description for the conversation. */
|
|
2209
2499
|
description?: string;
|
|
2210
2500
|
/** The group that the conversation is associated with. */
|
|
@@ -2248,6 +2538,10 @@ export interface ConversationsUpdateRequestOwnedBy {
|
|
|
2248
2538
|
}
|
|
2249
2539
|
/** conversations-update-request-tags */
|
|
2250
2540
|
export interface ConversationsUpdateRequestTags {
|
|
2541
|
+
/** Adds the provided tags on the conversation. */
|
|
2542
|
+
add?: AddTagWithValue[];
|
|
2543
|
+
/** Removes the provided tags on the conversation. */
|
|
2544
|
+
remove?: RemoveTagWithValue[];
|
|
2251
2545
|
/** Sets the tag IDs to the provided tags. */
|
|
2252
2546
|
set?: SetTagWithValue[];
|
|
2253
2547
|
}
|
|
@@ -2622,7 +2916,11 @@ export interface CustomObjectsListRequest {
|
|
|
2622
2916
|
/** The list of fields to sort the items by and how to sort them. */
|
|
2623
2917
|
sort_by?: string[];
|
|
2624
2918
|
}
|
|
2625
|
-
/**
|
|
2919
|
+
/**
|
|
2920
|
+
* custom-objects-list-response
|
|
2921
|
+
* The response to listing all custom objects matching the filter
|
|
2922
|
+
* criteria.
|
|
2923
|
+
*/
|
|
2626
2924
|
export interface CustomObjectsListResponse {
|
|
2627
2925
|
/**
|
|
2628
2926
|
* The cursor used to iterate subsequent results in accordance to the
|
|
@@ -2782,6 +3080,8 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2782
3080
|
/** custom-schema-fragments-set-request */
|
|
2783
3081
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2784
3082
|
type: CustomSchemaFragmentsSetRequestType;
|
|
3083
|
+
/** List of all composite schemas used in this fragment. */
|
|
3084
|
+
composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
|
|
2785
3085
|
/** List of conditions for this fragment. */
|
|
2786
3086
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2787
3087
|
/** List of field names which are being dropped. */
|
|
@@ -2802,6 +3102,15 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
2802
3102
|
/** The app this fragment applies to. */
|
|
2803
3103
|
app: string;
|
|
2804
3104
|
}
|
|
3105
|
+
/** custom-schema-fragments-set-request-composite-schema */
|
|
3106
|
+
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
3107
|
+
/** Description of this composite type. */
|
|
3108
|
+
description?: string;
|
|
3109
|
+
/** List of fields in this composite type. */
|
|
3110
|
+
fields: SchemaFieldDescriptor[];
|
|
3111
|
+
/** The name of this composite type. */
|
|
3112
|
+
name?: string;
|
|
3113
|
+
}
|
|
2805
3114
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
2806
3115
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
2807
3116
|
/**
|
|
@@ -2960,6 +3269,8 @@ export type CustomState = AtomBase & {
|
|
|
2960
3269
|
};
|
|
2961
3270
|
/** custom-state-summary */
|
|
2962
3271
|
export type CustomStateSummary = AtomBaseSummary & {
|
|
3272
|
+
/** True if this is a final state. */
|
|
3273
|
+
is_final?: boolean;
|
|
2963
3274
|
/** The human readable name of the state. */
|
|
2964
3275
|
name?: string;
|
|
2965
3276
|
};
|
|
@@ -3124,6 +3435,12 @@ export declare enum DateTimePresetType {
|
|
|
3124
3435
|
LastNDays = "last_n_days",
|
|
3125
3436
|
NextNDays = "next_n_days"
|
|
3126
3437
|
}
|
|
3438
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
3439
|
+
export declare enum Definedness {
|
|
3440
|
+
Immutable = "immutable",
|
|
3441
|
+
Mutable = "mutable",
|
|
3442
|
+
Undefined = "undefined"
|
|
3443
|
+
}
|
|
3127
3444
|
/**
|
|
3128
3445
|
* delete-rev-users-personal-data-request
|
|
3129
3446
|
* Request object to delete a contact's information.
|
|
@@ -3134,7 +3451,7 @@ export interface DeleteRevUsersPersonalDataRequest {
|
|
|
3134
3451
|
}
|
|
3135
3452
|
/**
|
|
3136
3453
|
* delete-rev-users-personal-data-response
|
|
3137
|
-
* Response for the contacts personal data
|
|
3454
|
+
* Response for the contacts personal data delete request. Response is
|
|
3138
3455
|
* empty as the process is asynchronous. Upon completion, the user will be
|
|
3139
3456
|
* notified.
|
|
3140
3457
|
*/
|
|
@@ -3143,7 +3460,7 @@ export type DeleteRevUsersPersonalDataResponse = object;
|
|
|
3143
3460
|
* dev-org-auth-connections-create-request
|
|
3144
3461
|
* Request to create a new enterprise authentication connection.
|
|
3145
3462
|
*/
|
|
3146
|
-
export type DevOrgAuthConnectionsCreateRequest = (
|
|
3463
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
3147
3464
|
/**
|
|
3148
3465
|
* Defines the type for the authentication connection. Different types of
|
|
3149
3466
|
* authentication connections have different configuration parameters.
|
|
@@ -3154,9 +3471,84 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3154
3471
|
* visible to all the users when they sign in to this Dev
|
|
3155
3472
|
* organization. For example, if the display_name is 'abclogin', then
|
|
3156
3473
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
3474
|
+
* @minLength 1
|
|
3475
|
+
* @maxLength 128
|
|
3157
3476
|
*/
|
|
3158
3477
|
display_name?: string;
|
|
3159
3478
|
};
|
|
3479
|
+
/**
|
|
3480
|
+
* dev-org-auth-connections-create-request-azure-ad-options
|
|
3481
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
3482
|
+
* authentication connection.
|
|
3483
|
+
* @deprecated
|
|
3484
|
+
*/
|
|
3485
|
+
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
3486
|
+
/** Client ID for the Azure authentication connection. */
|
|
3487
|
+
client_id: string;
|
|
3488
|
+
/** Client secret for the Azure authentication connection. */
|
|
3489
|
+
client_secret: string;
|
|
3490
|
+
/** Domain URL of the Azure authentication connection. */
|
|
3491
|
+
domain: string;
|
|
3492
|
+
}
|
|
3493
|
+
/**
|
|
3494
|
+
* dev-org-auth-connections-create-request-google-apps-options
|
|
3495
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
3496
|
+
* authentication connection.
|
|
3497
|
+
* @deprecated
|
|
3498
|
+
*/
|
|
3499
|
+
export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
|
|
3500
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
3501
|
+
client_id: string;
|
|
3502
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
3503
|
+
client_secret: string;
|
|
3504
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
3505
|
+
tenant_domain: string;
|
|
3506
|
+
}
|
|
3507
|
+
/**
|
|
3508
|
+
* dev-org-auth-connections-create-request-oidc-options
|
|
3509
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
3510
|
+
* authentication connection.
|
|
3511
|
+
*/
|
|
3512
|
+
export interface DevOrgAuthConnectionsCreateRequestOidcOptions {
|
|
3513
|
+
/** Client ID for the OIDC authentication connection. */
|
|
3514
|
+
client_id: string;
|
|
3515
|
+
/** Client secret for the OIDC authentication connection. */
|
|
3516
|
+
client_secret: string;
|
|
3517
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
3518
|
+
issuer: string;
|
|
3519
|
+
}
|
|
3520
|
+
/**
|
|
3521
|
+
* dev-org-auth-connections-create-request-okta-options
|
|
3522
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
3523
|
+
* authentication connection.
|
|
3524
|
+
* @deprecated
|
|
3525
|
+
*/
|
|
3526
|
+
export interface DevOrgAuthConnectionsCreateRequestOktaOptions {
|
|
3527
|
+
/** Client ID for the Okta authentication connection. */
|
|
3528
|
+
client_id: string;
|
|
3529
|
+
/** Client secret for the Okta authentication connection. */
|
|
3530
|
+
client_secret: string;
|
|
3531
|
+
/** Domain URL of the Okta authentication connection. */
|
|
3532
|
+
domain: string;
|
|
3533
|
+
}
|
|
3534
|
+
/**
|
|
3535
|
+
* dev-org-auth-connections-create-request-saml-options
|
|
3536
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
3537
|
+
* authentication connection.
|
|
3538
|
+
*/
|
|
3539
|
+
export interface DevOrgAuthConnectionsCreateRequestSamlOptions {
|
|
3540
|
+
/**
|
|
3541
|
+
* Connection name for the SAML authentication connection.
|
|
3542
|
+
* @minLength 1
|
|
3543
|
+
* @maxLength 128
|
|
3544
|
+
*/
|
|
3545
|
+
connection_name?: string;
|
|
3546
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
3547
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
3548
|
+
sign_in_endpoint: string;
|
|
3549
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
3550
|
+
signing_cert: string;
|
|
3551
|
+
}
|
|
3160
3552
|
/**
|
|
3161
3553
|
* Defines the type for the authentication connection. Different types of
|
|
3162
3554
|
* authentication connections have different configuration parameters.
|
|
@@ -3164,6 +3556,7 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3164
3556
|
export declare enum DevOrgAuthConnectionsCreateRequestType {
|
|
3165
3557
|
GoogleApps = "google_apps",
|
|
3166
3558
|
Oidc = "oidc",
|
|
3559
|
+
Okta = "okta",
|
|
3167
3560
|
Samlp = "samlp",
|
|
3168
3561
|
Waad = "waad"
|
|
3169
3562
|
}
|
|
@@ -3237,7 +3630,7 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
3237
3630
|
* Request to update an enterprise authentication connection for a Dev
|
|
3238
3631
|
* organization.
|
|
3239
3632
|
*/
|
|
3240
|
-
export type DevOrgAuthConnectionsUpdateRequest = (
|
|
3633
|
+
export type DevOrgAuthConnectionsUpdateRequest = (DevOrgAuthConnectionsUpdateRequestAzureAdOptions | DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions | DevOrgAuthConnectionsUpdateRequestOidcOptions | DevOrgAuthConnectionsUpdateRequestOktaOptions | DevOrgAuthConnectionsUpdateRequestSamlOptions | Empty) & {
|
|
3241
3634
|
/**
|
|
3242
3635
|
* Specifies the type for the authentication connection. Different types
|
|
3243
3636
|
* of authentication connections have different configuration parameters
|
|
@@ -3254,6 +3647,72 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3254
3647
|
/** ID of the authentication connection which is to be updated. */
|
|
3255
3648
|
id: string;
|
|
3256
3649
|
};
|
|
3650
|
+
/**
|
|
3651
|
+
* dev-org-auth-connections-update-request-azure-ad-options
|
|
3652
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
3653
|
+
* authentication connection.
|
|
3654
|
+
* @deprecated
|
|
3655
|
+
*/
|
|
3656
|
+
export interface DevOrgAuthConnectionsUpdateRequestAzureAdOptions {
|
|
3657
|
+
/** Client ID for the Azure authentication connection. */
|
|
3658
|
+
client_id?: string;
|
|
3659
|
+
/** Client secret for the Azure authentication connection. */
|
|
3660
|
+
client_secret?: string;
|
|
3661
|
+
/** Domain URL of the Azure authentication connection. */
|
|
3662
|
+
domain?: string;
|
|
3663
|
+
}
|
|
3664
|
+
/**
|
|
3665
|
+
* dev-org-auth-connections-update-request-google-apps-options
|
|
3666
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
3667
|
+
* authentication connection.
|
|
3668
|
+
* @deprecated
|
|
3669
|
+
*/
|
|
3670
|
+
export interface DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions {
|
|
3671
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
3672
|
+
client_id?: string;
|
|
3673
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
3674
|
+
client_secret?: string;
|
|
3675
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
3676
|
+
tenant_domain?: string;
|
|
3677
|
+
}
|
|
3678
|
+
/**
|
|
3679
|
+
* dev-org-auth-connections-update-request-oidc-options
|
|
3680
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
3681
|
+
* authentication connection.
|
|
3682
|
+
*/
|
|
3683
|
+
export interface DevOrgAuthConnectionsUpdateRequestOidcOptions {
|
|
3684
|
+
/** Client ID for the OIDC authentication connection. */
|
|
3685
|
+
client_id?: string;
|
|
3686
|
+
/** Client secret for the OIDC authentication connection. */
|
|
3687
|
+
client_secret?: string;
|
|
3688
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
3689
|
+
issuer?: string;
|
|
3690
|
+
}
|
|
3691
|
+
/**
|
|
3692
|
+
* dev-org-auth-connections-update-request-okta-options
|
|
3693
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
3694
|
+
* authentication connection.
|
|
3695
|
+
*/
|
|
3696
|
+
export interface DevOrgAuthConnectionsUpdateRequestOktaOptions {
|
|
3697
|
+
/** Client ID for the Okta authentication connection. */
|
|
3698
|
+
client_id?: string;
|
|
3699
|
+
/** Client secret for the Okta authentication connection. */
|
|
3700
|
+
client_secret?: string;
|
|
3701
|
+
/** Domain URL of the Okta authentication connection. */
|
|
3702
|
+
domain?: string;
|
|
3703
|
+
}
|
|
3704
|
+
/**
|
|
3705
|
+
* dev-org-auth-connections-update-request-saml-options
|
|
3706
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
3707
|
+
* authentication connection.
|
|
3708
|
+
*/
|
|
3709
|
+
export interface DevOrgAuthConnectionsUpdateRequestSamlOptions {
|
|
3710
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
3711
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
3712
|
+
sign_in_endpoint?: string;
|
|
3713
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
3714
|
+
signing_cert?: string;
|
|
3715
|
+
}
|
|
3257
3716
|
/**
|
|
3258
3717
|
* Specifies the type for the authentication connection. Different types
|
|
3259
3718
|
* of authentication connections have different configuration parameters
|
|
@@ -3263,6 +3722,7 @@ export declare enum DevOrgAuthConnectionsUpdateRequestType {
|
|
|
3263
3722
|
GoogleApps = "google_apps",
|
|
3264
3723
|
None = "none",
|
|
3265
3724
|
Oidc = "oidc",
|
|
3725
|
+
Okta = "okta",
|
|
3266
3726
|
Samlp = "samlp",
|
|
3267
3727
|
Waad = "waad"
|
|
3268
3728
|
}
|
|
@@ -3331,6 +3791,37 @@ export declare enum DevUserJobTitle {
|
|
|
3331
3791
|
}
|
|
3332
3792
|
/** dev-user-summary */
|
|
3333
3793
|
export type DevUserSummary = UserBaseSummary;
|
|
3794
|
+
/**
|
|
3795
|
+
* dev-users-activate-request
|
|
3796
|
+
* A request to activate the Dev user.
|
|
3797
|
+
*/
|
|
3798
|
+
export interface DevUsersActivateRequest {
|
|
3799
|
+
/** IDs of the groups assigned to user during activation. */
|
|
3800
|
+
groups?: string[];
|
|
3801
|
+
/** The ID for the Dev User. */
|
|
3802
|
+
id: string;
|
|
3803
|
+
}
|
|
3804
|
+
/**
|
|
3805
|
+
* dev-users-activate-response
|
|
3806
|
+
* The response to activate the Dev user.
|
|
3807
|
+
*/
|
|
3808
|
+
export interface DevUsersActivateResponse {
|
|
3809
|
+
/** Whether an invitation has been sent to the Dev user. */
|
|
3810
|
+
invite_sent: boolean;
|
|
3811
|
+
}
|
|
3812
|
+
/**
|
|
3813
|
+
* dev-users-deactivate-request
|
|
3814
|
+
* A request to deactivate the Dev user.
|
|
3815
|
+
*/
|
|
3816
|
+
export interface DevUsersDeactivateRequest {
|
|
3817
|
+
/** The ID for the Dev User. */
|
|
3818
|
+
id: string;
|
|
3819
|
+
}
|
|
3820
|
+
/**
|
|
3821
|
+
* dev-users-deactivate-response
|
|
3822
|
+
* The response to deactivate the Dev user.
|
|
3823
|
+
*/
|
|
3824
|
+
export type DevUsersDeactivateResponse = object;
|
|
3334
3825
|
/**
|
|
3335
3826
|
* dev-users-get-request
|
|
3336
3827
|
* A request to get a Dev user's information.
|
|
@@ -4055,6 +4546,24 @@ export interface EnumValue {
|
|
|
4055
4546
|
*/
|
|
4056
4547
|
ordinal: number;
|
|
4057
4548
|
}
|
|
4549
|
+
/**
|
|
4550
|
+
* enum-value-summary
|
|
4551
|
+
* The properties of an enum value.
|
|
4552
|
+
*/
|
|
4553
|
+
export interface EnumValueSummary {
|
|
4554
|
+
/**
|
|
4555
|
+
* The unique ID of the enum value.
|
|
4556
|
+
* @format int64
|
|
4557
|
+
*/
|
|
4558
|
+
id: number;
|
|
4559
|
+
/** The display label of the enum value. */
|
|
4560
|
+
label: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* Used for determining the relative order of the enum value.
|
|
4563
|
+
* @format int64
|
|
4564
|
+
*/
|
|
4565
|
+
ordinal: number;
|
|
4566
|
+
}
|
|
4058
4567
|
/** error */
|
|
4059
4568
|
export interface Error {
|
|
4060
4569
|
/** The error type. */
|
|
@@ -4396,6 +4905,21 @@ export interface EventGroupUpdated {
|
|
|
4396
4905
|
group: Group;
|
|
4397
4906
|
old_group?: Group;
|
|
4398
4907
|
}
|
|
4908
|
+
/** event-incident-created */
|
|
4909
|
+
export interface EventIncidentCreated {
|
|
4910
|
+
incident: Incident;
|
|
4911
|
+
}
|
|
4912
|
+
/** event-incident-deleted */
|
|
4913
|
+
export interface EventIncidentDeleted {
|
|
4914
|
+
/** The ID of the incident that was deleted. */
|
|
4915
|
+
id: string;
|
|
4916
|
+
old_incident?: Incident;
|
|
4917
|
+
}
|
|
4918
|
+
/** event-incident-updated */
|
|
4919
|
+
export interface EventIncidentUpdated {
|
|
4920
|
+
incident: Incident;
|
|
4921
|
+
old_incident?: Incident;
|
|
4922
|
+
}
|
|
4399
4923
|
/** event-link-created */
|
|
4400
4924
|
export interface EventLinkCreated {
|
|
4401
4925
|
link: Link;
|
|
@@ -4599,6 +5123,20 @@ export interface EventSurveyUpdated {
|
|
|
4599
5123
|
old_survey?: Survey;
|
|
4600
5124
|
survey: Survey;
|
|
4601
5125
|
}
|
|
5126
|
+
/** event-sync-history-created */
|
|
5127
|
+
export interface EventSyncHistoryCreated {
|
|
5128
|
+
sync_history: SyncHistory;
|
|
5129
|
+
}
|
|
5130
|
+
/** event-sync-history-deleted */
|
|
5131
|
+
export interface EventSyncHistoryDeleted {
|
|
5132
|
+
/** The ID of the sync history that was deleted. */
|
|
5133
|
+
id: string;
|
|
5134
|
+
}
|
|
5135
|
+
/** event-sync-history-updated */
|
|
5136
|
+
export interface EventSyncHistoryUpdated {
|
|
5137
|
+
old_sync_history?: SyncHistory;
|
|
5138
|
+
sync_history: SyncHistory;
|
|
5139
|
+
}
|
|
4602
5140
|
/** event-tag-created */
|
|
4603
5141
|
export interface EventTagCreated {
|
|
4604
5142
|
tag: Tag;
|
|
@@ -4610,9 +5148,11 @@ export interface EventTagDeleted {
|
|
|
4610
5148
|
* @example "TAG-12345"
|
|
4611
5149
|
*/
|
|
4612
5150
|
id: string;
|
|
5151
|
+
old_tag?: Tag;
|
|
4613
5152
|
}
|
|
4614
5153
|
/** event-tag-updated */
|
|
4615
5154
|
export interface EventTagUpdated {
|
|
5155
|
+
old_tag?: Tag;
|
|
4616
5156
|
tag: Tag;
|
|
4617
5157
|
}
|
|
4618
5158
|
/** event-timeline-entry-created */
|
|
@@ -4626,10 +5166,12 @@ export interface EventTimelineEntryDeleted {
|
|
|
4626
5166
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
4627
5167
|
*/
|
|
4628
5168
|
id: string;
|
|
5169
|
+
old_entry?: TimelineEntry;
|
|
4629
5170
|
}
|
|
4630
5171
|
/** event-timeline-entry-updated */
|
|
4631
5172
|
export interface EventTimelineEntryUpdated {
|
|
4632
5173
|
entry: TimelineEntry;
|
|
5174
|
+
old_entry?: TimelineEntry;
|
|
4633
5175
|
}
|
|
4634
5176
|
/** event-webhook-created */
|
|
4635
5177
|
export interface EventWebhookCreated {
|
|
@@ -4716,6 +5258,19 @@ export interface ExternalIdentity {
|
|
|
4716
5258
|
/** Issuer of the external identity of the user. */
|
|
4717
5259
|
issuer?: string;
|
|
4718
5260
|
}
|
|
5261
|
+
export declare enum ExternalSystemType {
|
|
5262
|
+
Adaas = "adaas",
|
|
5263
|
+
Confluence = "confluence",
|
|
5264
|
+
Github = "github",
|
|
5265
|
+
Hubspot = "hubspot",
|
|
5266
|
+
Jira = "jira",
|
|
5267
|
+
Linear = "linear",
|
|
5268
|
+
Rocketlane = "rocketlane",
|
|
5269
|
+
SalesforceSales = "salesforce_sales",
|
|
5270
|
+
SalesforceService = "salesforce_service",
|
|
5271
|
+
Servicenow = "servicenow",
|
|
5272
|
+
Zendesk = "zendesk"
|
|
5273
|
+
}
|
|
4719
5274
|
/** feature */
|
|
4720
5275
|
export type Feature = PartBase;
|
|
4721
5276
|
/** feature-summary */
|
|
@@ -4861,15 +5416,7 @@ export interface GeneralPreferencesGroup {
|
|
|
4861
5416
|
/** Preferences group for Availability. */
|
|
4862
5417
|
availability?: AvailabilityPreferencesGroup;
|
|
4863
5418
|
/** 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"
|
|
5419
|
+
preferred_locale?: string;
|
|
4873
5420
|
}
|
|
4874
5421
|
/** Event type of the notification. */
|
|
4875
5422
|
export declare enum GenericNotificationEventType {
|
|
@@ -5239,6 +5786,17 @@ export type Incident = AtomBase & {
|
|
|
5239
5786
|
/** Title of the incident. */
|
|
5240
5787
|
title: string;
|
|
5241
5788
|
};
|
|
5789
|
+
/** incident-summary */
|
|
5790
|
+
export type IncidentSummary = AtomBaseSummary & {
|
|
5791
|
+
/** The users that own the incident. */
|
|
5792
|
+
owned_by?: UserSummary[];
|
|
5793
|
+
/** The properties of an enum value. */
|
|
5794
|
+
severity?: EnumValueSummary;
|
|
5795
|
+
/** Describes the current stage of a object. */
|
|
5796
|
+
stage?: StageSummary;
|
|
5797
|
+
/** Title of the incident. */
|
|
5798
|
+
title: string;
|
|
5799
|
+
};
|
|
5242
5800
|
/** incidents-create-request */
|
|
5243
5801
|
export interface IncidentsCreateRequest {
|
|
5244
5802
|
/**
|
|
@@ -5440,6 +5998,8 @@ export interface IncidentsGroupRequest {
|
|
|
5440
5998
|
source?: number[];
|
|
5441
5999
|
/** Filters for incidents in any of the provided stages. */
|
|
5442
6000
|
stage?: string[];
|
|
6001
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
6002
|
+
subtype?: string[];
|
|
5443
6003
|
/** Provides ways to specify date ranges on objects. */
|
|
5444
6004
|
target_close_date?: DateFilter;
|
|
5445
6005
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5526,6 +6086,8 @@ export interface IncidentsListRequest {
|
|
|
5526
6086
|
source?: number[];
|
|
5527
6087
|
/** Filters for incidents in any of the provided stages. */
|
|
5528
6088
|
stage?: string[];
|
|
6089
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
6090
|
+
subtype?: string[];
|
|
5529
6091
|
/** Provides ways to specify date ranges on objects. */
|
|
5530
6092
|
target_close_date?: DateFilter;
|
|
5531
6093
|
/** Filters for incidents by the provided titles. */
|
|
@@ -5621,6 +6183,27 @@ export interface IncidentsUpdateRequest {
|
|
|
5621
6183
|
export interface IncidentsUpdateResponse {
|
|
5622
6184
|
incident: Incident;
|
|
5623
6185
|
}
|
|
6186
|
+
/** instant-evaluation */
|
|
6187
|
+
export interface InstantEvaluation {
|
|
6188
|
+
/**
|
|
6189
|
+
* The time instant evaluated.
|
|
6190
|
+
* @format date-time
|
|
6191
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6192
|
+
*/
|
|
6193
|
+
at: string;
|
|
6194
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
6195
|
+
definedness: Definedness;
|
|
6196
|
+
/** Active state of the organization schedule at the time instant. */
|
|
6197
|
+
is_active?: boolean;
|
|
6198
|
+
/**
|
|
6199
|
+
* Next instant at which the active state of the organization schedule
|
|
6200
|
+
* changes, for example, if the schedule is currently off, the next
|
|
6201
|
+
* instant at which it will be on.
|
|
6202
|
+
* @format date-time
|
|
6203
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6204
|
+
*/
|
|
6205
|
+
next_transition?: string;
|
|
6206
|
+
}
|
|
5624
6207
|
/** issue */
|
|
5625
6208
|
export type Issue = WorkBase & {
|
|
5626
6209
|
/**
|
|
@@ -5755,17 +6338,22 @@ export interface LinkDescriptorFilter {
|
|
|
5755
6338
|
link_descriptors: LinkTargetDescriptor[];
|
|
5756
6339
|
}
|
|
5757
6340
|
/** link-endpoint-summary */
|
|
5758
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
6341
|
+
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
5759
6342
|
type: LinkEndpointType;
|
|
5760
6343
|
};
|
|
5761
6344
|
export declare enum LinkEndpointType {
|
|
6345
|
+
Account = "account",
|
|
5762
6346
|
Capability = "capability",
|
|
5763
6347
|
Conversation = "conversation",
|
|
6348
|
+
DevUser = "dev_user",
|
|
5764
6349
|
Enhancement = "enhancement",
|
|
5765
6350
|
Feature = "feature",
|
|
6351
|
+
Incident = "incident",
|
|
5766
6352
|
Issue = "issue",
|
|
5767
6353
|
Opportunity = "opportunity",
|
|
5768
6354
|
Product = "product",
|
|
6355
|
+
RevOrg = "rev_org",
|
|
6356
|
+
RevUser = "rev_user",
|
|
5769
6357
|
Task = "task",
|
|
5770
6358
|
Ticket = "ticket"
|
|
5771
6359
|
}
|
|
@@ -6158,6 +6746,8 @@ export interface MetricDefinitionsListRequest {
|
|
|
6158
6746
|
* always be returned in the specified sort-by order.
|
|
6159
6747
|
*/
|
|
6160
6748
|
mode?: ListMode;
|
|
6749
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
6750
|
+
sort_by?: string[];
|
|
6161
6751
|
/** The status of the metric definition. */
|
|
6162
6752
|
status?: MetricDefinitionStatus[];
|
|
6163
6753
|
}
|
|
@@ -6527,6 +7117,22 @@ export interface OrgSchedulesCreateRequest {
|
|
|
6527
7117
|
export interface OrgSchedulesCreateResponse {
|
|
6528
7118
|
org_schedule: OrgSchedule;
|
|
6529
7119
|
}
|
|
7120
|
+
/** org-schedules-evaluate-request */
|
|
7121
|
+
export interface OrgSchedulesEvaluateRequest {
|
|
7122
|
+
/** Organization schedule ID. */
|
|
7123
|
+
id: string;
|
|
7124
|
+
/**
|
|
7125
|
+
* Time instants to evaluate the organization schedule for.
|
|
7126
|
+
* @minItems 1
|
|
7127
|
+
* @example ["2023-01-01T12:00:00.000Z"]
|
|
7128
|
+
*/
|
|
7129
|
+
instants: string[];
|
|
7130
|
+
}
|
|
7131
|
+
/** org-schedules-evaluate-response */
|
|
7132
|
+
export interface OrgSchedulesEvaluateResponse {
|
|
7133
|
+
/** The evaluations for the given time instants in the requested order. */
|
|
7134
|
+
instant_evaluations: InstantEvaluation[];
|
|
7135
|
+
}
|
|
6530
7136
|
/** org-schedules-get-request */
|
|
6531
7137
|
export interface OrgSchedulesGetRequest {
|
|
6532
7138
|
/** Organization schedule ID. */
|
|
@@ -6739,6 +7345,14 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
6739
7345
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6740
7346
|
*/
|
|
6741
7347
|
custom_schema_fragments?: string[];
|
|
7348
|
+
/**
|
|
7349
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7350
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7351
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7352
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7353
|
+
* specifier, it remains unmodified.
|
|
7354
|
+
*/
|
|
7355
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6742
7356
|
/** Description of the part. */
|
|
6743
7357
|
description?: string;
|
|
6744
7358
|
/** Name of the part. */
|
|
@@ -6880,6 +7494,14 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
6880
7494
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6881
7495
|
*/
|
|
6882
7496
|
custom_schema_fragments?: string[];
|
|
7497
|
+
/**
|
|
7498
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7499
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7500
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7501
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7502
|
+
* specifier, it remains unmodified.
|
|
7503
|
+
*/
|
|
7504
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6883
7505
|
/** The updated description of the part. */
|
|
6884
7506
|
description?: string;
|
|
6885
7507
|
/**
|
|
@@ -7263,9 +7885,9 @@ export type RemovedSlaMetricHistory = object;
|
|
|
7263
7885
|
* Resource details.
|
|
7264
7886
|
*/
|
|
7265
7887
|
export interface Resource {
|
|
7266
|
-
/**
|
|
7888
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7267
7889
|
artifacts?: ArtifactSummary[];
|
|
7268
|
-
/** URL of the
|
|
7890
|
+
/** URL of the resource (relevant only for type url). */
|
|
7269
7891
|
url?: string;
|
|
7270
7892
|
}
|
|
7271
7893
|
/**
|
|
@@ -7273,9 +7895,9 @@ export interface Resource {
|
|
|
7273
7895
|
* Resource details.
|
|
7274
7896
|
*/
|
|
7275
7897
|
export interface ResourceSummary {
|
|
7276
|
-
/**
|
|
7898
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7277
7899
|
artifacts?: ArtifactSummary[];
|
|
7278
|
-
/** URL of the
|
|
7900
|
+
/** URL of the resource (relevant only for type url). */
|
|
7279
7901
|
url?: string;
|
|
7280
7902
|
}
|
|
7281
7903
|
/** rev-org */
|
|
@@ -7598,9 +8220,18 @@ export interface RevUsersCreateRequest {
|
|
|
7598
8220
|
custom_fields?: object;
|
|
7599
8221
|
/**
|
|
7600
8222
|
* The schema fragment IDs associated with the Rev user.
|
|
8223
|
+
* @deprecated
|
|
7601
8224
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
7602
8225
|
*/
|
|
7603
8226
|
custom_schema_fragments?: string[];
|
|
8227
|
+
/**
|
|
8228
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8229
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8230
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8231
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8232
|
+
* specifier, it remains unmodified.
|
|
8233
|
+
*/
|
|
8234
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7604
8235
|
/** Description of the Rev user. */
|
|
7605
8236
|
description?: string;
|
|
7606
8237
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -7800,6 +8431,14 @@ export interface RevUsersUpdateRequest {
|
|
|
7800
8431
|
/** Application-defined custom fields. */
|
|
7801
8432
|
custom_fields?: object;
|
|
7802
8433
|
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
8434
|
+
/**
|
|
8435
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8436
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8437
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8438
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8439
|
+
* specifier, it remains unmodified.
|
|
8440
|
+
*/
|
|
8441
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7803
8442
|
/** Updated description of the Rev user. */
|
|
7804
8443
|
description?: string;
|
|
7805
8444
|
/** Updated display name of the Rev user. */
|
|
@@ -7838,6 +8477,19 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
|
7838
8477
|
export interface RevUsersUpdateResponse {
|
|
7839
8478
|
rev_user: RevUser;
|
|
7840
8479
|
}
|
|
8480
|
+
/** saml-connection-fields-map */
|
|
8481
|
+
export interface SamlConnectionFieldsMap {
|
|
8482
|
+
/**
|
|
8483
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
8484
|
+
* map to the email address of the user.
|
|
8485
|
+
*/
|
|
8486
|
+
email?: string;
|
|
8487
|
+
/**
|
|
8488
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
8489
|
+
* map to the user ID of the user.
|
|
8490
|
+
*/
|
|
8491
|
+
user_id?: string;
|
|
8492
|
+
}
|
|
7841
8493
|
/** schema-bool-field-descriptor */
|
|
7842
8494
|
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
7843
8495
|
/** Default value. */
|
|
@@ -8033,7 +8685,24 @@ export interface SchemaFieldSummaryViewUiMetadata {
|
|
|
8033
8685
|
* schema-field-uenum-value
|
|
8034
8686
|
* A unified enum value.
|
|
8035
8687
|
*/
|
|
8036
|
-
export
|
|
8688
|
+
export interface SchemaFieldUenumValue {
|
|
8689
|
+
/**
|
|
8690
|
+
* The immutable id of the enum value.
|
|
8691
|
+
* @format int64
|
|
8692
|
+
*/
|
|
8693
|
+
id: number;
|
|
8694
|
+
/** True if this value is deprecated. */
|
|
8695
|
+
is_deprecated?: boolean;
|
|
8696
|
+
/** The human readable name of the enum value. */
|
|
8697
|
+
label: string;
|
|
8698
|
+
/**
|
|
8699
|
+
* The order value of the enum.
|
|
8700
|
+
* @format int64
|
|
8701
|
+
*/
|
|
8702
|
+
ordinal: number;
|
|
8703
|
+
/** Tooltip shown in the UI for this value. */
|
|
8704
|
+
tooltip?: string;
|
|
8705
|
+
}
|
|
8037
8706
|
/**
|
|
8038
8707
|
* schema-field-ui-metadata
|
|
8039
8708
|
* The schema of ui specific fields.
|
|
@@ -8053,6 +8722,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
8053
8722
|
is_active_in_detail_view?: boolean;
|
|
8054
8723
|
/** Whether the field supports bulk action. */
|
|
8055
8724
|
is_bulk_action_enabled?: boolean;
|
|
8725
|
+
/** Indicates if the field holds a currency value in USD. */
|
|
8726
|
+
is_currency_field?: boolean;
|
|
8056
8727
|
/** Whether the field is groupable in the UI. */
|
|
8057
8728
|
is_groupable?: boolean;
|
|
8058
8729
|
/** Whether the field is hidden in the UI. */
|
|
@@ -8069,12 +8740,19 @@ export interface SchemaFieldUiMetadata {
|
|
|
8069
8740
|
is_sortable?: boolean;
|
|
8070
8741
|
/** List view UI hint overrides. */
|
|
8071
8742
|
list_view?: SchemaFieldListViewUiMetadata;
|
|
8743
|
+
/**
|
|
8744
|
+
* Order in which field is shown.
|
|
8745
|
+
* @format int32
|
|
8746
|
+
*/
|
|
8747
|
+
order?: number;
|
|
8072
8748
|
/** A placeholder for the field. */
|
|
8073
8749
|
placeholder?: string;
|
|
8074
8750
|
/** Summary view UI hint overrides. */
|
|
8075
8751
|
summary_view?: SchemaFieldSummaryViewUiMetadata;
|
|
8076
8752
|
/** Tooltip for the field. */
|
|
8077
8753
|
tooltip?: string;
|
|
8754
|
+
/** Unit of measurment. */
|
|
8755
|
+
unit?: string;
|
|
8078
8756
|
}
|
|
8079
8757
|
/** schema-id-field-descriptor */
|
|
8080
8758
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
@@ -8950,6 +9628,8 @@ export interface SlaTrackersListRequest {
|
|
|
8950
9628
|
*/
|
|
8951
9629
|
mode?: ListMode;
|
|
8952
9630
|
modified_date?: DateTimeFilter;
|
|
9631
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
9632
|
+
sort_by?: string[];
|
|
8953
9633
|
/** The SLA tracker stages the filter matches. */
|
|
8954
9634
|
stage?: string[];
|
|
8955
9635
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -9062,6 +9742,8 @@ export interface SlasListRequest {
|
|
|
9062
9742
|
mode?: ListMode;
|
|
9063
9743
|
/** The SLA types the filter matches. */
|
|
9064
9744
|
sla_type?: SlaType[];
|
|
9745
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
9746
|
+
sort_by?: string[];
|
|
9065
9747
|
/** The SLA statuses the filter matches. */
|
|
9066
9748
|
status?: SlaStatus[];
|
|
9067
9749
|
}
|
|
@@ -9243,6 +9925,13 @@ export interface StageInit {
|
|
|
9243
9925
|
/** The name of the stage. */
|
|
9244
9926
|
name?: string;
|
|
9245
9927
|
}
|
|
9928
|
+
/**
|
|
9929
|
+
* stage-summary
|
|
9930
|
+
* Describes the current stage of a object.
|
|
9931
|
+
*/
|
|
9932
|
+
export interface StageSummary {
|
|
9933
|
+
stage?: CustomStageSummary;
|
|
9934
|
+
}
|
|
9246
9935
|
/**
|
|
9247
9936
|
* stage-update
|
|
9248
9937
|
* Updates an object's stage.
|
|
@@ -9437,21 +10126,40 @@ export type SurveyResponse = AtomBase & {
|
|
|
9437
10126
|
};
|
|
9438
10127
|
/** surveys-create-request */
|
|
9439
10128
|
export interface SurveysCreateRequest {
|
|
9440
|
-
/**
|
|
10129
|
+
/**
|
|
10130
|
+
* Description about the survey.
|
|
10131
|
+
* @maxLength 1000
|
|
10132
|
+
*/
|
|
9441
10133
|
description?: string;
|
|
9442
|
-
/**
|
|
10134
|
+
/**
|
|
10135
|
+
* Header of the survey.
|
|
10136
|
+
* @maxLength 1000
|
|
10137
|
+
*/
|
|
9443
10138
|
header?: string;
|
|
9444
|
-
/**
|
|
10139
|
+
/**
|
|
10140
|
+
* Text posted when introducing the survey to the responder.
|
|
10141
|
+
* @maxLength 1000
|
|
10142
|
+
*/
|
|
9445
10143
|
introductory_text?: string;
|
|
9446
|
-
/**
|
|
10144
|
+
/**
|
|
10145
|
+
* The survey's name.
|
|
10146
|
+
* @minLength 1
|
|
10147
|
+
* @maxLength 100
|
|
10148
|
+
*/
|
|
9447
10149
|
name: string;
|
|
9448
|
-
/**
|
|
10150
|
+
/**
|
|
10151
|
+
* Text posted after the response is collected.
|
|
10152
|
+
* @maxLength 1000
|
|
10153
|
+
*/
|
|
9449
10154
|
response_text?: string;
|
|
9450
10155
|
/** Schema for the survey. */
|
|
9451
10156
|
schema?: FieldDescriptor[];
|
|
9452
10157
|
/** The schema with metadata for the survey. */
|
|
9453
10158
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
9454
|
-
/**
|
|
10159
|
+
/**
|
|
10160
|
+
* Title of the survey.
|
|
10161
|
+
* @maxLength 1000
|
|
10162
|
+
*/
|
|
9455
10163
|
title?: string;
|
|
9456
10164
|
}
|
|
9457
10165
|
/** surveys-create-response */
|
|
@@ -9634,6 +10342,61 @@ export interface SurveysSubmitRequest {
|
|
|
9634
10342
|
}
|
|
9635
10343
|
/** surveys-submit-response */
|
|
9636
10344
|
export type SurveysSubmitResponse = object;
|
|
10345
|
+
/** surveys-update-request */
|
|
10346
|
+
export interface SurveysUpdateRequest {
|
|
10347
|
+
/**
|
|
10348
|
+
* The updated description about the survey.
|
|
10349
|
+
* @maxLength 1000
|
|
10350
|
+
*/
|
|
10351
|
+
description?: string;
|
|
10352
|
+
/**
|
|
10353
|
+
* Header of the survey.
|
|
10354
|
+
* @maxLength 1000
|
|
10355
|
+
*/
|
|
10356
|
+
header?: string;
|
|
10357
|
+
/** The ID of the survey to update. */
|
|
10358
|
+
id: string;
|
|
10359
|
+
/**
|
|
10360
|
+
* The updated text posted when introducing the survey to the
|
|
10361
|
+
* responder.
|
|
10362
|
+
* @maxLength 1000
|
|
10363
|
+
*/
|
|
10364
|
+
introductory_text?: string;
|
|
10365
|
+
/**
|
|
10366
|
+
* The survey's updated name.
|
|
10367
|
+
* @minLength 1
|
|
10368
|
+
* @maxLength 100
|
|
10369
|
+
*/
|
|
10370
|
+
name?: string;
|
|
10371
|
+
/**
|
|
10372
|
+
* Text posted after the response is collected.
|
|
10373
|
+
* @maxLength 1000
|
|
10374
|
+
*/
|
|
10375
|
+
response_text?: string;
|
|
10376
|
+
/** The updated schema with metadata for the survey. */
|
|
10377
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
10378
|
+
/**
|
|
10379
|
+
* The ID of the survey to update.
|
|
10380
|
+
* @deprecated
|
|
10381
|
+
*/
|
|
10382
|
+
survey?: string;
|
|
10383
|
+
/**
|
|
10384
|
+
* Title of the survey.
|
|
10385
|
+
* @maxLength 1000
|
|
10386
|
+
*/
|
|
10387
|
+
title?: string;
|
|
10388
|
+
}
|
|
10389
|
+
/** surveys-update-response */
|
|
10390
|
+
export interface SurveysUpdateResponse {
|
|
10391
|
+
survey: Survey;
|
|
10392
|
+
}
|
|
10393
|
+
/** sync-history */
|
|
10394
|
+
export type SyncHistory = AtomBase & {
|
|
10395
|
+
/** Object for holding run-specific data. */
|
|
10396
|
+
sync_run?: SyncRun;
|
|
10397
|
+
/** SyncUnit ID associated with this historical entry. */
|
|
10398
|
+
sync_unit?: string;
|
|
10399
|
+
};
|
|
9637
10400
|
/**
|
|
9638
10401
|
* sync-in
|
|
9639
10402
|
* Information about the sync to DevRev.
|
|
@@ -9705,6 +10468,7 @@ export interface SyncMetadataFilterSyncOutFilter {
|
|
|
9705
10468
|
}
|
|
9706
10469
|
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
9707
10470
|
Failed = "failed",
|
|
10471
|
+
Modified = "modified",
|
|
9708
10472
|
Succeeded = "succeeded"
|
|
9709
10473
|
}
|
|
9710
10474
|
/**
|
|
@@ -9728,8 +10492,120 @@ export declare enum SyncOutStatus {
|
|
|
9728
10492
|
Modified = "modified",
|
|
9729
10493
|
Succeeded = "succeeded"
|
|
9730
10494
|
}
|
|
10495
|
+
/**
|
|
10496
|
+
* sync-progress
|
|
10497
|
+
* Progress.
|
|
10498
|
+
*/
|
|
10499
|
+
export interface SyncProgress {
|
|
10500
|
+
/** The state of a sync progress. */
|
|
10501
|
+
state?: SyncProgressState;
|
|
10502
|
+
}
|
|
10503
|
+
/** The state of a sync progress. */
|
|
10504
|
+
export declare enum SyncProgressState {
|
|
10505
|
+
Completed = "completed",
|
|
10506
|
+
DeleteInProgress = "delete_in_progress",
|
|
10507
|
+
Deleted = "deleted",
|
|
10508
|
+
DeletionError = "deletion_error",
|
|
10509
|
+
ExtractAttachments = "extract_attachments",
|
|
10510
|
+
ExtractAttachmentsError = "extract_attachments_error",
|
|
10511
|
+
Extraction = "extraction",
|
|
10512
|
+
ExtractionError = "extraction_error",
|
|
10513
|
+
Loading = "loading",
|
|
10514
|
+
LoadingAttachments = "loading_attachments",
|
|
10515
|
+
LoadingAttachmentsError = "loading_attachments_error",
|
|
10516
|
+
LoadingError = "loading_error",
|
|
10517
|
+
RecipeDiscovery = "recipe_discovery",
|
|
10518
|
+
RecipeDiscoveryError = "recipe_discovery_error",
|
|
10519
|
+
RecipeDiscoveryWaitingForUserInput = "recipe_discovery_waiting_for_user_input",
|
|
10520
|
+
Starting = "starting",
|
|
10521
|
+
Transformation = "transformation",
|
|
10522
|
+
TransformationError = "transformation_error"
|
|
10523
|
+
}
|
|
10524
|
+
/**
|
|
10525
|
+
* sync-progress-summary
|
|
10526
|
+
* Progress.
|
|
10527
|
+
*/
|
|
10528
|
+
export interface SyncProgressSummary {
|
|
10529
|
+
/** The state of a sync progress. */
|
|
10530
|
+
state?: SyncProgressState;
|
|
10531
|
+
}
|
|
10532
|
+
/**
|
|
10533
|
+
* sync-run
|
|
10534
|
+
* Object for holding run-specific data.
|
|
10535
|
+
*/
|
|
10536
|
+
export interface SyncRun {
|
|
10537
|
+
/**
|
|
10538
|
+
* The time when a sync was ended.
|
|
10539
|
+
* @format date-time
|
|
10540
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10541
|
+
*/
|
|
10542
|
+
ended_at?: string;
|
|
10543
|
+
/** The direction/mode of a sync run. */
|
|
10544
|
+
mode?: SyncRunMode;
|
|
10545
|
+
/** Progress. */
|
|
10546
|
+
progress?: SyncProgress;
|
|
10547
|
+
/**
|
|
10548
|
+
* The time when a sync was started.
|
|
10549
|
+
* @format date-time
|
|
10550
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10551
|
+
*/
|
|
10552
|
+
started_at?: string;
|
|
10553
|
+
}
|
|
10554
|
+
/** The direction/mode of a sync run. */
|
|
10555
|
+
export declare enum SyncRunMode {
|
|
10556
|
+
Initial = "initial",
|
|
10557
|
+
SyncFromDevrev = "sync_from_devrev",
|
|
10558
|
+
SyncToDevrev = "sync_to_devrev"
|
|
10559
|
+
}
|
|
10560
|
+
/** The state of a sync progress. */
|
|
10561
|
+
export declare enum SyncRunProgressState {
|
|
10562
|
+
Completed = "completed",
|
|
10563
|
+
Failed = "failed"
|
|
10564
|
+
}
|
|
10565
|
+
/** Describes how the sync was initiated. */
|
|
10566
|
+
export declare enum SyncRunStartedBy {
|
|
10567
|
+
PeriodicSyncScheduler = "periodic_sync_scheduler",
|
|
10568
|
+
User = "user"
|
|
10569
|
+
}
|
|
10570
|
+
/**
|
|
10571
|
+
* sync-run-summary
|
|
10572
|
+
* Object for holding run-specific data.
|
|
10573
|
+
*/
|
|
10574
|
+
export interface SyncRunSummary {
|
|
10575
|
+
/** The direction/mode of a sync run. */
|
|
10576
|
+
mode?: SyncRunMode;
|
|
10577
|
+
/** Progress. */
|
|
10578
|
+
progress?: SyncProgressSummary;
|
|
10579
|
+
}
|
|
10580
|
+
/** sync-unit */
|
|
10581
|
+
export type SyncUnit = AtomBase & {
|
|
10582
|
+
external_system_type?: ExternalSystemType;
|
|
10583
|
+
/** The flag signaling if sync unit is archived. */
|
|
10584
|
+
is_archived?: boolean;
|
|
10585
|
+
/** The name of the sync unit. */
|
|
10586
|
+
name?: string;
|
|
10587
|
+
/** Object for holding run-specific data. */
|
|
10588
|
+
sync_run?: SyncRun;
|
|
10589
|
+
/** Type of sync preferences. */
|
|
10590
|
+
sync_type?: SyncUnitSyncType;
|
|
10591
|
+
};
|
|
9731
10592
|
/** sync-unit-summary */
|
|
9732
|
-
export type SyncUnitSummary = AtomBaseSummary
|
|
10593
|
+
export type SyncUnitSummary = AtomBaseSummary & {
|
|
10594
|
+
external_system_type?: ExternalSystemType;
|
|
10595
|
+
/** The flag signaling if sync unit is archived. */
|
|
10596
|
+
is_archived?: boolean;
|
|
10597
|
+
/** The name of the sync unit. */
|
|
10598
|
+
name?: string;
|
|
10599
|
+
/** Object for holding run-specific data. */
|
|
10600
|
+
sync_run?: SyncRunSummary;
|
|
10601
|
+
/** Type of sync preferences. */
|
|
10602
|
+
sync_type?: SyncUnitSyncType;
|
|
10603
|
+
};
|
|
10604
|
+
/** Type of sync preferences. */
|
|
10605
|
+
export declare enum SyncUnitSyncType {
|
|
10606
|
+
Manual = "manual",
|
|
10607
|
+
Periodic = "periodic"
|
|
10608
|
+
}
|
|
9733
10609
|
/** sys-user */
|
|
9734
10610
|
export type SysUser = UserBase;
|
|
9735
10611
|
/** sys-user-summary */
|
|
@@ -10473,6 +11349,7 @@ export declare enum TimelineEntryObjectType {
|
|
|
10473
11349
|
Engagement = "engagement",
|
|
10474
11350
|
Enhancement = "enhancement",
|
|
10475
11351
|
Feature = "feature",
|
|
11352
|
+
Incident = "incident",
|
|
10476
11353
|
Issue = "issue",
|
|
10477
11354
|
Meeting = "meeting",
|
|
10478
11355
|
Opportunity = "opportunity",
|
|
@@ -11178,6 +12055,9 @@ export interface WebhookEventRequest {
|
|
|
11178
12055
|
group_updated?: EventGroupUpdated;
|
|
11179
12056
|
/** The event's ID. */
|
|
11180
12057
|
id: string;
|
|
12058
|
+
incident_created?: EventIncidentCreated;
|
|
12059
|
+
incident_deleted?: EventIncidentDeleted;
|
|
12060
|
+
incident_updated?: EventIncidentUpdated;
|
|
11181
12061
|
link_created?: EventLinkCreated;
|
|
11182
12062
|
link_deleted?: EventLinkDeleted;
|
|
11183
12063
|
link_updated?: EventLinkUpdated;
|
|
@@ -11199,6 +12079,9 @@ export interface WebhookEventRequest {
|
|
|
11199
12079
|
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
11200
12080
|
survey_response_updated?: EventSurveyResponseUpdated;
|
|
11201
12081
|
survey_updated?: EventSurveyUpdated;
|
|
12082
|
+
sync_history_created?: EventSyncHistoryCreated;
|
|
12083
|
+
sync_history_deleted?: EventSyncHistoryDeleted;
|
|
12084
|
+
sync_history_updated?: EventSyncHistoryUpdated;
|
|
11202
12085
|
tag_created?: EventTagCreated;
|
|
11203
12086
|
tag_deleted?: EventTagDeleted;
|
|
11204
12087
|
tag_updated?: EventTagUpdated;
|
|
@@ -11253,6 +12136,9 @@ export declare enum WebhookEventType {
|
|
|
11253
12136
|
GroupMemberAdded = "group_member_added",
|
|
11254
12137
|
GroupMemberRemoved = "group_member_removed",
|
|
11255
12138
|
GroupUpdated = "group_updated",
|
|
12139
|
+
IncidentCreated = "incident_created",
|
|
12140
|
+
IncidentDeleted = "incident_deleted",
|
|
12141
|
+
IncidentUpdated = "incident_updated",
|
|
11256
12142
|
LinkCreated = "link_created",
|
|
11257
12143
|
LinkDeleted = "link_deleted",
|
|
11258
12144
|
LinkUpdated = "link_updated",
|
|
@@ -11274,6 +12160,9 @@ export declare enum WebhookEventType {
|
|
|
11274
12160
|
SurveyResponseDeleted = "survey_response_deleted",
|
|
11275
12161
|
SurveyResponseUpdated = "survey_response_updated",
|
|
11276
12162
|
SurveyUpdated = "survey_updated",
|
|
12163
|
+
SyncHistoryCreated = "sync_history_created",
|
|
12164
|
+
SyncHistoryDeleted = "sync_history_deleted",
|
|
12165
|
+
SyncHistoryUpdated = "sync_history_updated",
|
|
11277
12166
|
TagCreated = "tag_created",
|
|
11278
12167
|
TagDeleted = "tag_deleted",
|
|
11279
12168
|
TagUpdated = "tag_updated",
|
|
@@ -11685,6 +12574,11 @@ export interface WorksCreateRequestOpportunity {
|
|
|
11685
12574
|
customer_budget?: number;
|
|
11686
12575
|
/** Forecast category of the opportunity. */
|
|
11687
12576
|
forecast_category?: OpportunityForecastCategory;
|
|
12577
|
+
/**
|
|
12578
|
+
* Forecast category enum ID of an opportunity.
|
|
12579
|
+
* @format int64
|
|
12580
|
+
*/
|
|
12581
|
+
forecast_category_v2?: number;
|
|
11688
12582
|
/** Priority of the opportunity. */
|
|
11689
12583
|
priority?: OpportunityPriority;
|
|
11690
12584
|
/**
|
|
@@ -11837,6 +12731,11 @@ export interface WorksFilterOpportunity {
|
|
|
11837
12731
|
account?: string[];
|
|
11838
12732
|
/** Filters for opportunities with any of the provided contacts. */
|
|
11839
12733
|
contacts?: string[];
|
|
12734
|
+
/**
|
|
12735
|
+
* Filters for opportunities with any of the provided forecast
|
|
12736
|
+
* category enum IDs.
|
|
12737
|
+
*/
|
|
12738
|
+
forecast_category_v2?: number[];
|
|
11840
12739
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
11841
12740
|
subtype?: string[];
|
|
11842
12741
|
}
|
|
@@ -12001,7 +12900,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
12001
12900
|
* object.
|
|
12002
12901
|
*/
|
|
12003
12902
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
12004
|
-
staged_info?:
|
|
12903
|
+
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
12005
12904
|
tags?: WorksUpdateRequestTags;
|
|
12006
12905
|
/**
|
|
12007
12906
|
* Updates the timestamp for when the work is expected to be complete.
|
|
@@ -12079,6 +12978,11 @@ export interface WorksUpdateRequestOpportunity {
|
|
|
12079
12978
|
* @format double
|
|
12080
12979
|
*/
|
|
12081
12980
|
customer_budget?: number | null;
|
|
12981
|
+
/**
|
|
12982
|
+
* Forecast category enum ID of an opportunity.
|
|
12983
|
+
* @format int64
|
|
12984
|
+
*/
|
|
12985
|
+
forecast_category_v2?: number;
|
|
12082
12986
|
/**
|
|
12083
12987
|
* Updates the probability of winning the deal, lies between 0.0 and
|
|
12084
12988
|
* 1.0.
|
|
@@ -12108,10 +13012,23 @@ export interface WorksUpdateRequestReportedBy {
|
|
|
12108
13012
|
*/
|
|
12109
13013
|
set?: string[];
|
|
12110
13014
|
}
|
|
12111
|
-
/** works-update-request-staged-info-
|
|
12112
|
-
export interface
|
|
13015
|
+
/** works-update-request-staged-info-update */
|
|
13016
|
+
export interface WorksUpdateRequestStagedInfoUpdate {
|
|
13017
|
+
/** Updates the sync in unresolved fields of the staged work. */
|
|
13018
|
+
sync_in_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
13019
|
+
/** Updates the sync out unresolved fields of the staged work. */
|
|
13020
|
+
sync_out_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
12113
13021
|
/** Updates the unresolved fields of the staged work. */
|
|
12114
|
-
unresolved_fields
|
|
13022
|
+
unresolved_fields?: string[];
|
|
13023
|
+
}
|
|
13024
|
+
/** works-update-request-staged-info-update-unresolved-field */
|
|
13025
|
+
export interface WorksUpdateRequestStagedInfoUpdateUnresolvedField {
|
|
13026
|
+
/** DevRev field name of the object's attribute. */
|
|
13027
|
+
devrev_field_name?: string;
|
|
13028
|
+
/** External field name as seen by the end user. */
|
|
13029
|
+
external_display_name?: string;
|
|
13030
|
+
/** Api name of the external object's field. */
|
|
13031
|
+
external_field_name?: string;
|
|
12115
13032
|
}
|
|
12116
13033
|
/** works-update-request-tags */
|
|
12117
13034
|
export interface WorksUpdateRequestTags {
|
|
@@ -12140,6 +13057,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
12140
13057
|
channels?: WorksUpdateRequestTicketChannels;
|
|
12141
13058
|
/** Updates the group that the ticket is associated with. */
|
|
12142
13059
|
group?: string | null;
|
|
13060
|
+
/** Whether the ticket is archived. */
|
|
13061
|
+
is_archived?: boolean;
|
|
12143
13062
|
/** Updates whether the ticket is spam. */
|
|
12144
13063
|
is_spam?: boolean;
|
|
12145
13064
|
/** Updates whether the ticket needs a response. */
|
|
@@ -12301,6 +13220,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12301
13220
|
stage?: string[];
|
|
12302
13221
|
/** List of tags to be filtered. */
|
|
12303
13222
|
tags?: string[];
|
|
13223
|
+
/** Array of websites of accounts to be filtered. */
|
|
13224
|
+
websites?: string[];
|
|
12304
13225
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
12305
13226
|
/**
|
|
12306
13227
|
* @description Exports a collection of accounts.
|
|
@@ -12404,6 +13325,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12404
13325
|
stage?: string[];
|
|
12405
13326
|
/** List of tags to be filtered. */
|
|
12406
13327
|
tags?: string[];
|
|
13328
|
+
/** Array of websites of accounts to be filtered. */
|
|
13329
|
+
websites?: string[];
|
|
12407
13330
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
12408
13331
|
/**
|
|
12409
13332
|
* @description Gets a list of accounts.
|
|
@@ -12414,6 +13337,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12414
13337
|
* @secure
|
|
12415
13338
|
*/
|
|
12416
13339
|
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
13340
|
+
/**
|
|
13341
|
+
* @description Merges two accounts.
|
|
13342
|
+
*
|
|
13343
|
+
* @tags accounts
|
|
13344
|
+
* @name AccountsMerge
|
|
13345
|
+
* @request POST:/accounts.merge
|
|
13346
|
+
* @secure
|
|
13347
|
+
*/
|
|
13348
|
+
accountsMerge: (data: AccountsMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12417
13349
|
/**
|
|
12418
13350
|
* @description Updates an account's information.
|
|
12419
13351
|
*
|
|
@@ -12423,6 +13355,71 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12423
13355
|
* @secure
|
|
12424
13356
|
*/
|
|
12425
13357
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
13358
|
+
/**
|
|
13359
|
+
* @description Gets a single sync unit's information.
|
|
13360
|
+
*
|
|
13361
|
+
* @tags airdrop
|
|
13362
|
+
* @name AirdropSyncUnitsGet
|
|
13363
|
+
* @request GET:/airdrop.sync-units.get
|
|
13364
|
+
* @secure
|
|
13365
|
+
*/
|
|
13366
|
+
airdropSyncUnitsGet: (query: {
|
|
13367
|
+
/** Requested sync unit ID. */
|
|
13368
|
+
id: string;
|
|
13369
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsGetResponse, any>>;
|
|
13370
|
+
/**
|
|
13371
|
+
* @description Gets a single sync unit's information.
|
|
13372
|
+
*
|
|
13373
|
+
* @tags airdrop
|
|
13374
|
+
* @name AirdropSyncUnitsGetPost
|
|
13375
|
+
* @request POST:/airdrop.sync-units.get
|
|
13376
|
+
* @secure
|
|
13377
|
+
*/
|
|
13378
|
+
airdropSyncUnitsGetPost: (data: AirdropSyncUnitsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsGetResponse, any>>;
|
|
13379
|
+
/**
|
|
13380
|
+
* @description Gets a list of sync unit historical records.
|
|
13381
|
+
*
|
|
13382
|
+
* @tags airdrop
|
|
13383
|
+
* @name AirdropSyncUnitsHistory
|
|
13384
|
+
* @request GET:/airdrop.sync-units.history
|
|
13385
|
+
* @secure
|
|
13386
|
+
*/
|
|
13387
|
+
airdropSyncUnitsHistory: (query: {
|
|
13388
|
+
/** Sync unit that will be used for sync history listing. */
|
|
13389
|
+
id: string;
|
|
13390
|
+
/**
|
|
13391
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13392
|
+
* starts from the beginning.
|
|
13393
|
+
*/
|
|
13394
|
+
cursor?: string;
|
|
13395
|
+
/** Filter for sync runs that have errors. */
|
|
13396
|
+
'filter.has_errors_or_warnings'?: boolean;
|
|
13397
|
+
/** Mode of the sync run. */
|
|
13398
|
+
'filter.mode'?: SyncRunMode[];
|
|
13399
|
+
/** User who started the sync run. */
|
|
13400
|
+
'filter.started_by'?: SyncRunStartedBy[];
|
|
13401
|
+
/** State of the sync run. */
|
|
13402
|
+
'filter.state'?: SyncRunProgressState[];
|
|
13403
|
+
/**
|
|
13404
|
+
* The maximum number of items to return. The default is '50'.
|
|
13405
|
+
* @format int32
|
|
13406
|
+
*/
|
|
13407
|
+
limit?: number;
|
|
13408
|
+
/**
|
|
13409
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13410
|
+
* used.
|
|
13411
|
+
*/
|
|
13412
|
+
mode?: ListMode;
|
|
13413
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsHistoryResponse, any>>;
|
|
13414
|
+
/**
|
|
13415
|
+
* @description Gets a list of sync unit historical records.
|
|
13416
|
+
*
|
|
13417
|
+
* @tags airdrop
|
|
13418
|
+
* @name AirdropSyncUnitsHistoryPost
|
|
13419
|
+
* @request POST:/airdrop.sync-units.history
|
|
13420
|
+
* @secure
|
|
13421
|
+
*/
|
|
13422
|
+
airdropSyncUnitsHistoryPost: (data: AirdropSyncUnitsHistoryRequest, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsHistoryResponse, any>>;
|
|
12426
13423
|
/**
|
|
12427
13424
|
* @description Get count of articles matching given filter.
|
|
12428
13425
|
*
|
|
@@ -12464,10 +13461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12464
13461
|
* @example ["DEVU-12345"]
|
|
12465
13462
|
*/
|
|
12466
13463
|
owned_by?: string[];
|
|
12467
|
-
/**
|
|
12468
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
12469
|
-
* only external articles are returned.
|
|
12470
|
-
*/
|
|
13464
|
+
/** Filter for the scope of the articles. */
|
|
12471
13465
|
scope?: number[];
|
|
12472
13466
|
/** ID of the group/member with whom the item is shared. */
|
|
12473
13467
|
'shared_with.member'?: string;
|
|
@@ -12579,10 +13573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12579
13573
|
* @example ["DEVU-12345"]
|
|
12580
13574
|
*/
|
|
12581
13575
|
owned_by?: string[];
|
|
12582
|
-
/**
|
|
12583
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
12584
|
-
* only external articles are returned.
|
|
12585
|
-
*/
|
|
13576
|
+
/** Filter for the scope of the articles. */
|
|
12586
13577
|
scope?: number[];
|
|
12587
13578
|
/** ID of the group/member with whom the item is shared. */
|
|
12588
13579
|
'shared_with.member'?: string;
|
|
@@ -12746,6 +13737,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12746
13737
|
* @secure
|
|
12747
13738
|
*/
|
|
12748
13739
|
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
13740
|
+
/**
|
|
13741
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
13742
|
+
*
|
|
13743
|
+
* @tags auth-tokens
|
|
13744
|
+
* @name AuthTokensInfo
|
|
13745
|
+
* @request GET:/auth-tokens.info
|
|
13746
|
+
* @secure
|
|
13747
|
+
*/
|
|
13748
|
+
authTokensInfo: (params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any>>;
|
|
13749
|
+
/**
|
|
13750
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
13751
|
+
*
|
|
13752
|
+
* @tags auth-tokens
|
|
13753
|
+
* @name AuthTokensInfoPost
|
|
13754
|
+
* @request POST:/auth-tokens.info
|
|
13755
|
+
* @secure
|
|
13756
|
+
*/
|
|
13757
|
+
authTokensInfoPost: (data: AuthTokensInfoRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any>>;
|
|
12749
13758
|
/**
|
|
12750
13759
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
12751
13760
|
*
|
|
@@ -12993,6 +14002,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12993
14002
|
* @example ["PROD-12345"]
|
|
12994
14003
|
*/
|
|
12995
14004
|
applies_to_parts?: string[];
|
|
14005
|
+
/** Filters for custom fields. */
|
|
14006
|
+
custom_fields?: object;
|
|
12996
14007
|
/**
|
|
12997
14008
|
* The number of conversation items to return. The default is '50', the
|
|
12998
14009
|
* maximum is '5000'.
|
|
@@ -13018,15 +14029,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13018
14029
|
/**
|
|
13019
14030
|
* Filters for conversations that are associated with any of the
|
|
13020
14031
|
* provided Rev organizations.
|
|
14032
|
+
* @deprecated
|
|
13021
14033
|
* @example ["REV-AbCdEfGh"]
|
|
13022
14034
|
*/
|
|
13023
14035
|
rev_org?: string[];
|
|
14036
|
+
/**
|
|
14037
|
+
* Filters for conversations that are associated with any of the
|
|
14038
|
+
* provided Rev organizations.
|
|
14039
|
+
* @example ["REV-AbCdEfGh"]
|
|
14040
|
+
*/
|
|
14041
|
+
rev_orgs?: string[];
|
|
13024
14042
|
/** Filters for records with any of the provided SLA stages. */
|
|
13025
14043
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13026
14044
|
/** Filters for conversations with any of the provided source channels. */
|
|
14045
|
+
source_channel?: string[];
|
|
14046
|
+
/**
|
|
14047
|
+
* Filters for conversations with any of the provided source channels.
|
|
14048
|
+
* @deprecated
|
|
14049
|
+
*/
|
|
13027
14050
|
source_channels?: string[];
|
|
13028
14051
|
/** Filters for records in the provided stage(s) by name. */
|
|
13029
14052
|
'stage.name'?: string[];
|
|
14053
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14054
|
+
subtype?: string[];
|
|
13030
14055
|
/**
|
|
13031
14056
|
* Filters for conversations with any of the provided tags.
|
|
13032
14057
|
* @deprecated
|
|
@@ -13093,6 +14118,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13093
14118
|
* starts from the beginning.
|
|
13094
14119
|
*/
|
|
13095
14120
|
cursor?: string;
|
|
14121
|
+
/** Filters for custom fields. */
|
|
14122
|
+
custom_fields?: object;
|
|
13096
14123
|
/** Filters for conversation that belong to the given groups. */
|
|
13097
14124
|
group?: string[];
|
|
13098
14125
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -13122,15 +14149,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13122
14149
|
/**
|
|
13123
14150
|
* Filters for conversations that are associated with any of the
|
|
13124
14151
|
* provided Rev organizations.
|
|
14152
|
+
* @deprecated
|
|
13125
14153
|
* @example ["REV-AbCdEfGh"]
|
|
13126
14154
|
*/
|
|
13127
14155
|
rev_org?: string[];
|
|
14156
|
+
/**
|
|
14157
|
+
* Filters for conversations that are associated with any of the
|
|
14158
|
+
* provided Rev organizations.
|
|
14159
|
+
* @example ["REV-AbCdEfGh"]
|
|
14160
|
+
*/
|
|
14161
|
+
rev_orgs?: string[];
|
|
13128
14162
|
/** Filters for records with any of the provided SLA stages. */
|
|
13129
14163
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13130
14164
|
/** Filters for conversations with any of the provided source channels. */
|
|
14165
|
+
source_channel?: string[];
|
|
14166
|
+
/**
|
|
14167
|
+
* Filters for conversations with any of the provided source channels.
|
|
14168
|
+
* @deprecated
|
|
14169
|
+
*/
|
|
13131
14170
|
source_channels?: string[];
|
|
13132
14171
|
/** Filters for records in the provided stage(s) by name. */
|
|
13133
14172
|
'stage.name'?: string[];
|
|
14173
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14174
|
+
subtype?: string[];
|
|
13134
14175
|
/**
|
|
13135
14176
|
* Filters for conversations with any of the provided tags.
|
|
13136
14177
|
* @deprecated
|
|
@@ -13352,6 +14393,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13352
14393
|
* @secure
|
|
13353
14394
|
*/
|
|
13354
14395
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
14396
|
+
/**
|
|
14397
|
+
* @description Activates the requested user.
|
|
14398
|
+
*
|
|
14399
|
+
* @tags dev-users
|
|
14400
|
+
* @name DevUsersActivate
|
|
14401
|
+
* @request POST:/dev-users.activate
|
|
14402
|
+
* @secure
|
|
14403
|
+
*/
|
|
14404
|
+
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any>>;
|
|
14405
|
+
/**
|
|
14406
|
+
* @description Deactivates the requested user.
|
|
14407
|
+
*
|
|
14408
|
+
* @tags dev-users
|
|
14409
|
+
* @name DevUsersDeactivate
|
|
14410
|
+
* @request POST:/dev-users.deactivate
|
|
14411
|
+
* @secure
|
|
14412
|
+
*/
|
|
14413
|
+
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13355
14414
|
/**
|
|
13356
14415
|
* @description Gets the requested user's information.
|
|
13357
14416
|
*
|
|
@@ -14008,6 +15067,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14008
15067
|
source?: number[];
|
|
14009
15068
|
/** Filters for incidents in any of the provided stages. */
|
|
14010
15069
|
stage?: string[];
|
|
15070
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
15071
|
+
subtype?: string[];
|
|
14011
15072
|
/** Filters for incidents by the provided titles. */
|
|
14012
15073
|
title?: string[];
|
|
14013
15074
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
@@ -14078,6 +15139,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14078
15139
|
source?: number[];
|
|
14079
15140
|
/** Filters for incidents in any of the provided stages. */
|
|
14080
15141
|
stage?: string[];
|
|
15142
|
+
/** Filters for incidents with any of the provided subtypes. */
|
|
15143
|
+
subtype?: string[];
|
|
14081
15144
|
/** Filters for incidents by the provided titles. */
|
|
14082
15145
|
title?: string[];
|
|
14083
15146
|
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
@@ -14382,6 +15445,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14382
15445
|
* used.
|
|
14383
15446
|
*/
|
|
14384
15447
|
mode?: ListMode;
|
|
15448
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
15449
|
+
sort_by?: string[];
|
|
14385
15450
|
/** The status of the metric definition. */
|
|
14386
15451
|
status?: MetricDefinitionStatus[];
|
|
14387
15452
|
/** The type of metric definitions sought. */
|
|
@@ -14471,6 +15536,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14471
15536
|
* @secure
|
|
14472
15537
|
*/
|
|
14473
15538
|
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any>>;
|
|
15539
|
+
/**
|
|
15540
|
+
* @description Evaluates an organization's schedule at specified instants.
|
|
15541
|
+
*
|
|
15542
|
+
* @tags schedules
|
|
15543
|
+
* @name OrgSchedulesEvaluate
|
|
15544
|
+
* @request GET:/org-schedules.evaluate
|
|
15545
|
+
* @secure
|
|
15546
|
+
*/
|
|
15547
|
+
orgSchedulesEvaluate: (query: {
|
|
15548
|
+
/** Organization schedule ID. */
|
|
15549
|
+
id: string;
|
|
15550
|
+
/**
|
|
15551
|
+
* Time instants to evaluate the organization schedule for.
|
|
15552
|
+
* @minItems 1
|
|
15553
|
+
* @example ["2023-01-01T12:00:00.000Z"]
|
|
15554
|
+
*/
|
|
15555
|
+
instants: string[];
|
|
15556
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any>>;
|
|
15557
|
+
/**
|
|
15558
|
+
* @description Evaluates an organization's schedule at specified instants.
|
|
15559
|
+
*
|
|
15560
|
+
* @tags schedules
|
|
15561
|
+
* @name OrgSchedulesEvaluatePost
|
|
15562
|
+
* @request POST:/org-schedules.evaluate
|
|
15563
|
+
* @secure
|
|
15564
|
+
*/
|
|
15565
|
+
orgSchedulesEvaluatePost: (data: OrgSchedulesEvaluateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any>>;
|
|
14474
15566
|
/**
|
|
14475
15567
|
* @description Gets an organization schedule.
|
|
14476
15568
|
*
|
|
@@ -15571,6 +16663,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15571
16663
|
* @example "2023-01-01T12:00:00.000Z"
|
|
15572
16664
|
*/
|
|
15573
16665
|
'modified_date.before'?: string;
|
|
16666
|
+
/** Fields to sort the SLA Trackers by and the direction to sort them. */
|
|
16667
|
+
sort_by?: string[];
|
|
15574
16668
|
/** The SLA tracker stages the filter matches. */
|
|
15575
16669
|
stage?: string[];
|
|
15576
16670
|
/** The SLA tracker statuses the filter matches. */
|
|
@@ -15657,6 +16751,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15657
16751
|
mode?: ListMode;
|
|
15658
16752
|
/** The SLA types the filter matches. */
|
|
15659
16753
|
sla_type?: SlaType[];
|
|
16754
|
+
/** Fields to sort the SLAs by and the direction to sort them. */
|
|
16755
|
+
sort_by?: string[];
|
|
15660
16756
|
/** The SLA statuses the filter matches. */
|
|
15661
16757
|
status?: SlaStatus[];
|
|
15662
16758
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
@@ -16017,6 +17113,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16017
17113
|
* @secure
|
|
16018
17114
|
*/
|
|
16019
17115
|
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
17116
|
+
/**
|
|
17117
|
+
* @description Updates a survey's metadata.
|
|
17118
|
+
*
|
|
17119
|
+
* @tags surveys
|
|
17120
|
+
* @name SurveysUpdate
|
|
17121
|
+
* @request POST:/surveys.update
|
|
17122
|
+
* @secure
|
|
17123
|
+
*/
|
|
17124
|
+
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any>>;
|
|
16020
17125
|
/**
|
|
16021
17126
|
* @description Lists system users within your organization.
|
|
16022
17127
|
*
|
|
@@ -16444,6 +17549,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16444
17549
|
* @secure
|
|
16445
17550
|
*/
|
|
16446
17551
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
17552
|
+
/**
|
|
17553
|
+
* @description Describes a webhook invocation for an event from DevRev to a webhook's target URL, where the receiving handler must implement the specified protocol. Note the documented endpoint is for exposition and not provided by DevRev.
|
|
17554
|
+
*
|
|
17555
|
+
* @tags webhooks
|
|
17556
|
+
* @name WebhooksEvent
|
|
17557
|
+
* @request POST:/webhooks.event
|
|
17558
|
+
* @secure
|
|
17559
|
+
*/
|
|
17560
|
+
webhooksEvent: (data: WebhookEventRequest, params?: RequestParams) => Promise<AxiosResponse<WebhookEventResponse, any>>;
|
|
16447
17561
|
/**
|
|
16448
17562
|
* @description Fetches an object via webhook.
|
|
16449
17563
|
*
|
|
@@ -16576,6 +17690,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16576
17690
|
'opportunity.account'?: string[];
|
|
16577
17691
|
/** Filters for opportunities with any of the provided contacts. */
|
|
16578
17692
|
'opportunity.contacts'?: string[];
|
|
17693
|
+
/**
|
|
17694
|
+
* Filters for opportunities with any of the provided forecast category
|
|
17695
|
+
* enum IDs.
|
|
17696
|
+
*/
|
|
17697
|
+
'opportunity.forecast_category_v2'?: number[];
|
|
16579
17698
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
16580
17699
|
'opportunity.subtype'?: string[];
|
|
16581
17700
|
/**
|
|
@@ -16732,6 +17851,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16732
17851
|
'opportunity.account'?: string[];
|
|
16733
17852
|
/** Filters for opportunities with any of the provided contacts. */
|
|
16734
17853
|
'opportunity.contacts'?: string[];
|
|
17854
|
+
/**
|
|
17855
|
+
* Filters for opportunities with any of the provided forecast category
|
|
17856
|
+
* enum IDs.
|
|
17857
|
+
*/
|
|
17858
|
+
'opportunity.forecast_category_v2'?: number[];
|
|
16735
17859
|
/** Filters for opportunity with any of the provided subtypes. */
|
|
16736
17860
|
'opportunity.subtype'?: string[];
|
|
16737
17861
|
/**
|