@devrev/typescript-sdk 1.1.34 → 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.
|
@@ -13,7 +13,14 @@ export type Account = OrgBase & {
|
|
|
13
13
|
owned_by: UserSummary[];
|
|
14
14
|
/** The Tier of the corresponding Account. */
|
|
15
15
|
tier?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Company's website links. Filling in this property will also fill in
|
|
18
|
+
* domain. Example - 'www.devrev.ai'.
|
|
19
|
+
*/
|
|
20
|
+
websites?: string[];
|
|
16
21
|
};
|
|
22
|
+
/** account-summary */
|
|
23
|
+
export type AccountSummary = OrgBaseSummary;
|
|
17
24
|
/**
|
|
18
25
|
* accounts-create-request
|
|
19
26
|
* Request object to create a new account in the Dev organization.
|
|
@@ -87,6 +94,8 @@ export interface AccountsExportRequest {
|
|
|
87
94
|
sort_by?: string[];
|
|
88
95
|
/** Filters for accounts on specified stages. */
|
|
89
96
|
stage?: string[];
|
|
97
|
+
/** Array of websites of accounts to be filtered. */
|
|
98
|
+
websites?: string[];
|
|
90
99
|
}
|
|
91
100
|
/**
|
|
92
101
|
* accounts-export-response
|
|
@@ -108,6 +117,8 @@ export interface AccountsFilters {
|
|
|
108
117
|
modified_date?: DateTimeFilter;
|
|
109
118
|
/** Filters for accounts on specified stages. */
|
|
110
119
|
stage?: string[];
|
|
120
|
+
/** Array of websites of accounts to be filtered. */
|
|
121
|
+
websites?: string[];
|
|
111
122
|
}
|
|
112
123
|
/**
|
|
113
124
|
* accounts-get-request
|
|
@@ -163,6 +174,8 @@ export interface AccountsListRequest {
|
|
|
163
174
|
sort_by?: string[];
|
|
164
175
|
/** Filters for accounts on specified stages. */
|
|
165
176
|
stage?: string[];
|
|
177
|
+
/** Array of websites of accounts to be filtered. */
|
|
178
|
+
websites?: string[];
|
|
166
179
|
}
|
|
167
180
|
/**
|
|
168
181
|
* accounts-list-response
|
|
@@ -204,6 +217,12 @@ export interface AccountsUpdateRequest {
|
|
|
204
217
|
owned_by?: string[];
|
|
205
218
|
/** Updated tier of the account. */
|
|
206
219
|
tier?: string | null;
|
|
220
|
+
websites?: AccountsUpdateRequestWebsites;
|
|
221
|
+
}
|
|
222
|
+
/** accounts-update-request-websites */
|
|
223
|
+
export interface AccountsUpdateRequestWebsites {
|
|
224
|
+
/** Sets the websites field of the account. */
|
|
225
|
+
set?: string[];
|
|
207
226
|
}
|
|
208
227
|
/**
|
|
209
228
|
* accounts-update-response
|
|
@@ -421,7 +440,7 @@ export interface AtomBaseSummary {
|
|
|
421
440
|
* Connection object that specifies the configuration for an
|
|
422
441
|
* authentication connection that is set up for a Dev organization.
|
|
423
442
|
*/
|
|
424
|
-
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
443
|
+
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsOkta | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
425
444
|
/**
|
|
426
445
|
* Defines the type for the authentication connection. The configuration
|
|
427
446
|
* for each authentication connection will depend on the type value.
|
|
@@ -433,13 +452,13 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
433
452
|
* organization. For example, if the display_name is 'abclogin', then
|
|
434
453
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
435
454
|
*/
|
|
436
|
-
display_name
|
|
455
|
+
display_name: string;
|
|
437
456
|
/**
|
|
438
457
|
* Whether the authentication connection is enabled or disabled. If
|
|
439
458
|
* set to false, the authentication connection will not show up on the
|
|
440
459
|
* login screen as a login option.
|
|
441
460
|
*/
|
|
442
|
-
enabled
|
|
461
|
+
enabled: boolean;
|
|
443
462
|
/** ID of the authentication connection. */
|
|
444
463
|
id: string;
|
|
445
464
|
};
|
|
@@ -447,27 +466,25 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
447
466
|
* auth-connection-options-azure-ad
|
|
448
467
|
* Object encapsulating the configuration parameters for an Azure AD
|
|
449
468
|
* authentication connection.
|
|
469
|
+
* @deprecated
|
|
450
470
|
*/
|
|
451
471
|
export interface AuthConnectionOptionsAzureAd {
|
|
452
472
|
/** Client ID for the Azure authentication connection. */
|
|
453
|
-
client_id
|
|
454
|
-
/** Client secret for the Azure authentication connection. */
|
|
455
|
-
client_secret?: string;
|
|
473
|
+
client_id: string;
|
|
456
474
|
/** Domain URL of the Azure authentication connection. */
|
|
457
|
-
domain
|
|
475
|
+
domain: string;
|
|
458
476
|
}
|
|
459
477
|
/**
|
|
460
478
|
* auth-connection-options-google-apps
|
|
461
479
|
* Object encapsulating the configuration parameters for a Google Apps
|
|
462
480
|
* authentication connection.
|
|
481
|
+
* @deprecated
|
|
463
482
|
*/
|
|
464
483
|
export interface AuthConnectionOptionsGoogleApps {
|
|
465
484
|
/** Client ID for the Google Apps authentication connection. */
|
|
466
|
-
client_id
|
|
467
|
-
/** Client secret for the Google Apps authentication connection. */
|
|
468
|
-
client_secret?: string;
|
|
485
|
+
client_id: string;
|
|
469
486
|
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
470
|
-
tenant_domain
|
|
487
|
+
tenant_domain: string;
|
|
471
488
|
}
|
|
472
489
|
/**
|
|
473
490
|
* auth-connection-options-oidc
|
|
@@ -476,11 +493,21 @@ export interface AuthConnectionOptionsGoogleApps {
|
|
|
476
493
|
*/
|
|
477
494
|
export interface AuthConnectionOptionsOidc {
|
|
478
495
|
/** Client ID for the OIDC authentication connection. */
|
|
479
|
-
client_id
|
|
480
|
-
/** Client secret for the OIDC authentication connection. */
|
|
481
|
-
client_secret?: string;
|
|
496
|
+
client_id: string;
|
|
482
497
|
/** Issuer URL of the OIDC authentication connection. */
|
|
483
|
-
issuer
|
|
498
|
+
issuer: string;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* auth-connection-options-okta
|
|
502
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
503
|
+
* authentication connection.
|
|
504
|
+
* @deprecated
|
|
505
|
+
*/
|
|
506
|
+
export interface AuthConnectionOptionsOkta {
|
|
507
|
+
/** Client ID for the Okta authentication connection. */
|
|
508
|
+
client_id: string;
|
|
509
|
+
/** Domain URL of the Okta authentication connection. */
|
|
510
|
+
domain: string;
|
|
484
511
|
}
|
|
485
512
|
/**
|
|
486
513
|
* auth-connection-options-saml
|
|
@@ -488,10 +515,15 @@ export interface AuthConnectionOptionsOidc {
|
|
|
488
515
|
* authentication connection.
|
|
489
516
|
*/
|
|
490
517
|
export interface AuthConnectionOptionsSaml {
|
|
518
|
+
/**
|
|
519
|
+
* Connection name for the SAML authentication connection.
|
|
520
|
+
* @minLength 1
|
|
521
|
+
* @maxLength 128
|
|
522
|
+
*/
|
|
523
|
+
connection_name?: string;
|
|
524
|
+
fields_map: SamlConnectionFieldsMap;
|
|
491
525
|
/** Sign In endpoint for the SAML authentication connection. */
|
|
492
|
-
sign_in_endpoint
|
|
493
|
-
/** Signing certificate for the SAML authentication connection. */
|
|
494
|
-
signing_cert?: string;
|
|
526
|
+
sign_in_endpoint: string;
|
|
495
527
|
}
|
|
496
528
|
/** auth-connection-options-social */
|
|
497
529
|
export type AuthConnectionOptionsSocial = object;
|
|
@@ -506,6 +538,7 @@ export declare enum AuthConnectionToggle {
|
|
|
506
538
|
export declare enum AuthConnectionType {
|
|
507
539
|
GoogleApps = "google_apps",
|
|
508
540
|
Oidc = "oidc",
|
|
541
|
+
Okta = "okta",
|
|
509
542
|
Samlp = "samlp",
|
|
510
543
|
Social = "social",
|
|
511
544
|
Waad = "waad"
|
|
@@ -943,7 +976,7 @@ export declare enum DateTimePresetType {
|
|
|
943
976
|
* dev-org-auth-connections-create-request
|
|
944
977
|
* Request to create a new enterprise authentication connection.
|
|
945
978
|
*/
|
|
946
|
-
export type DevOrgAuthConnectionsCreateRequest = (
|
|
979
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
947
980
|
/**
|
|
948
981
|
* Defines the type for the authentication connection. Different types of
|
|
949
982
|
* authentication connections have different configuration parameters.
|
|
@@ -954,9 +987,84 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
954
987
|
* visible to all the users when they sign in to this Dev
|
|
955
988
|
* organization. For example, if the display_name is 'abclogin', then
|
|
956
989
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
990
|
+
* @minLength 1
|
|
991
|
+
* @maxLength 128
|
|
957
992
|
*/
|
|
958
993
|
display_name?: string;
|
|
959
994
|
};
|
|
995
|
+
/**
|
|
996
|
+
* dev-org-auth-connections-create-request-azure-ad-options
|
|
997
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
998
|
+
* authentication connection.
|
|
999
|
+
* @deprecated
|
|
1000
|
+
*/
|
|
1001
|
+
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
1002
|
+
/** Client ID for the Azure authentication connection. */
|
|
1003
|
+
client_id: string;
|
|
1004
|
+
/** Client secret for the Azure authentication connection. */
|
|
1005
|
+
client_secret: string;
|
|
1006
|
+
/** Domain URL of the Azure authentication connection. */
|
|
1007
|
+
domain: string;
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* dev-org-auth-connections-create-request-google-apps-options
|
|
1011
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
1012
|
+
* authentication connection.
|
|
1013
|
+
* @deprecated
|
|
1014
|
+
*/
|
|
1015
|
+
export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
|
|
1016
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
1017
|
+
client_id: string;
|
|
1018
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
1019
|
+
client_secret: string;
|
|
1020
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
1021
|
+
tenant_domain: string;
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* dev-org-auth-connections-create-request-oidc-options
|
|
1025
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
1026
|
+
* authentication connection.
|
|
1027
|
+
*/
|
|
1028
|
+
export interface DevOrgAuthConnectionsCreateRequestOidcOptions {
|
|
1029
|
+
/** Client ID for the OIDC authentication connection. */
|
|
1030
|
+
client_id: string;
|
|
1031
|
+
/** Client secret for the OIDC authentication connection. */
|
|
1032
|
+
client_secret: string;
|
|
1033
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
1034
|
+
issuer: string;
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* dev-org-auth-connections-create-request-okta-options
|
|
1038
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
1039
|
+
* authentication connection.
|
|
1040
|
+
* @deprecated
|
|
1041
|
+
*/
|
|
1042
|
+
export interface DevOrgAuthConnectionsCreateRequestOktaOptions {
|
|
1043
|
+
/** Client ID for the Okta authentication connection. */
|
|
1044
|
+
client_id: string;
|
|
1045
|
+
/** Client secret for the Okta authentication connection. */
|
|
1046
|
+
client_secret: string;
|
|
1047
|
+
/** Domain URL of the Okta authentication connection. */
|
|
1048
|
+
domain: string;
|
|
1049
|
+
}
|
|
1050
|
+
/**
|
|
1051
|
+
* dev-org-auth-connections-create-request-saml-options
|
|
1052
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
1053
|
+
* authentication connection.
|
|
1054
|
+
*/
|
|
1055
|
+
export interface DevOrgAuthConnectionsCreateRequestSamlOptions {
|
|
1056
|
+
/**
|
|
1057
|
+
* Connection name for the SAML authentication connection.
|
|
1058
|
+
* @minLength 1
|
|
1059
|
+
* @maxLength 128
|
|
1060
|
+
*/
|
|
1061
|
+
connection_name?: string;
|
|
1062
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
1063
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
1064
|
+
sign_in_endpoint: string;
|
|
1065
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
1066
|
+
signing_cert: string;
|
|
1067
|
+
}
|
|
960
1068
|
/**
|
|
961
1069
|
* Defines the type for the authentication connection. Different types of
|
|
962
1070
|
* authentication connections have different configuration parameters.
|
|
@@ -964,6 +1072,7 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
964
1072
|
export declare enum DevOrgAuthConnectionsCreateRequestType {
|
|
965
1073
|
GoogleApps = "google_apps",
|
|
966
1074
|
Oidc = "oidc",
|
|
1075
|
+
Okta = "okta",
|
|
967
1076
|
Samlp = "samlp",
|
|
968
1077
|
Waad = "waad"
|
|
969
1078
|
}
|
|
@@ -1037,7 +1146,7 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
1037
1146
|
* Request to update an enterprise authentication connection for a Dev
|
|
1038
1147
|
* organization.
|
|
1039
1148
|
*/
|
|
1040
|
-
export type DevOrgAuthConnectionsUpdateRequest = (
|
|
1149
|
+
export type DevOrgAuthConnectionsUpdateRequest = (DevOrgAuthConnectionsUpdateRequestAzureAdOptions | DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions | DevOrgAuthConnectionsUpdateRequestOidcOptions | DevOrgAuthConnectionsUpdateRequestOktaOptions | DevOrgAuthConnectionsUpdateRequestSamlOptions | Empty) & {
|
|
1041
1150
|
/**
|
|
1042
1151
|
* Specifies the type for the authentication connection. Different types
|
|
1043
1152
|
* of authentication connections have different configuration parameters
|
|
@@ -1054,6 +1163,72 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
1054
1163
|
/** ID of the authentication connection which is to be updated. */
|
|
1055
1164
|
id: string;
|
|
1056
1165
|
};
|
|
1166
|
+
/**
|
|
1167
|
+
* dev-org-auth-connections-update-request-azure-ad-options
|
|
1168
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
1169
|
+
* authentication connection.
|
|
1170
|
+
* @deprecated
|
|
1171
|
+
*/
|
|
1172
|
+
export interface DevOrgAuthConnectionsUpdateRequestAzureAdOptions {
|
|
1173
|
+
/** Client ID for the Azure authentication connection. */
|
|
1174
|
+
client_id?: string;
|
|
1175
|
+
/** Client secret for the Azure authentication connection. */
|
|
1176
|
+
client_secret?: string;
|
|
1177
|
+
/** Domain URL of the Azure authentication connection. */
|
|
1178
|
+
domain?: string;
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* dev-org-auth-connections-update-request-google-apps-options
|
|
1182
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
1183
|
+
* authentication connection.
|
|
1184
|
+
* @deprecated
|
|
1185
|
+
*/
|
|
1186
|
+
export interface DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions {
|
|
1187
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
1188
|
+
client_id?: string;
|
|
1189
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
1190
|
+
client_secret?: string;
|
|
1191
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
1192
|
+
tenant_domain?: string;
|
|
1193
|
+
}
|
|
1194
|
+
/**
|
|
1195
|
+
* dev-org-auth-connections-update-request-oidc-options
|
|
1196
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
1197
|
+
* authentication connection.
|
|
1198
|
+
*/
|
|
1199
|
+
export interface DevOrgAuthConnectionsUpdateRequestOidcOptions {
|
|
1200
|
+
/** Client ID for the OIDC authentication connection. */
|
|
1201
|
+
client_id?: string;
|
|
1202
|
+
/** Client secret for the OIDC authentication connection. */
|
|
1203
|
+
client_secret?: string;
|
|
1204
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
1205
|
+
issuer?: string;
|
|
1206
|
+
}
|
|
1207
|
+
/**
|
|
1208
|
+
* dev-org-auth-connections-update-request-okta-options
|
|
1209
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
1210
|
+
* authentication connection.
|
|
1211
|
+
*/
|
|
1212
|
+
export interface DevOrgAuthConnectionsUpdateRequestOktaOptions {
|
|
1213
|
+
/** Client ID for the Okta authentication connection. */
|
|
1214
|
+
client_id?: string;
|
|
1215
|
+
/** Client secret for the Okta authentication connection. */
|
|
1216
|
+
client_secret?: string;
|
|
1217
|
+
/** Domain URL of the Okta authentication connection. */
|
|
1218
|
+
domain?: string;
|
|
1219
|
+
}
|
|
1220
|
+
/**
|
|
1221
|
+
* dev-org-auth-connections-update-request-saml-options
|
|
1222
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
1223
|
+
* authentication connection.
|
|
1224
|
+
*/
|
|
1225
|
+
export interface DevOrgAuthConnectionsUpdateRequestSamlOptions {
|
|
1226
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
1227
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
1228
|
+
sign_in_endpoint?: string;
|
|
1229
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
1230
|
+
signing_cert?: string;
|
|
1231
|
+
}
|
|
1057
1232
|
/**
|
|
1058
1233
|
* Specifies the type for the authentication connection. Different types
|
|
1059
1234
|
* of authentication connections have different configuration parameters
|
|
@@ -1063,6 +1238,7 @@ export declare enum DevOrgAuthConnectionsUpdateRequestType {
|
|
|
1063
1238
|
GoogleApps = "google_apps",
|
|
1064
1239
|
None = "none",
|
|
1065
1240
|
Oidc = "oidc",
|
|
1241
|
+
Okta = "okta",
|
|
1066
1242
|
Samlp = "samlp",
|
|
1067
1243
|
Waad = "waad"
|
|
1068
1244
|
}
|
|
@@ -1548,6 +1724,21 @@ export interface EventGroupUpdated {
|
|
|
1548
1724
|
group: Group;
|
|
1549
1725
|
old_group?: Group;
|
|
1550
1726
|
}
|
|
1727
|
+
/** event-incident-created */
|
|
1728
|
+
export interface EventIncidentCreated {
|
|
1729
|
+
incident: Incident;
|
|
1730
|
+
}
|
|
1731
|
+
/** event-incident-deleted */
|
|
1732
|
+
export interface EventIncidentDeleted {
|
|
1733
|
+
/** The ID of the incident that was deleted. */
|
|
1734
|
+
id: string;
|
|
1735
|
+
old_incident?: Incident;
|
|
1736
|
+
}
|
|
1737
|
+
/** event-incident-updated */
|
|
1738
|
+
export interface EventIncidentUpdated {
|
|
1739
|
+
incident: Incident;
|
|
1740
|
+
old_incident?: Incident;
|
|
1741
|
+
}
|
|
1551
1742
|
/** event-link-created */
|
|
1552
1743
|
export interface EventLinkCreated {
|
|
1553
1744
|
link: Link;
|
|
@@ -1656,6 +1847,20 @@ export interface EventSurveyUpdated {
|
|
|
1656
1847
|
old_survey?: Survey;
|
|
1657
1848
|
survey: Survey;
|
|
1658
1849
|
}
|
|
1850
|
+
/** event-sync-history-created */
|
|
1851
|
+
export interface EventSyncHistoryCreated {
|
|
1852
|
+
sync_history: SyncHistory;
|
|
1853
|
+
}
|
|
1854
|
+
/** event-sync-history-deleted */
|
|
1855
|
+
export interface EventSyncHistoryDeleted {
|
|
1856
|
+
/** The ID of the sync history that was deleted. */
|
|
1857
|
+
id: string;
|
|
1858
|
+
}
|
|
1859
|
+
/** event-sync-history-updated */
|
|
1860
|
+
export interface EventSyncHistoryUpdated {
|
|
1861
|
+
old_sync_history?: SyncHistory;
|
|
1862
|
+
sync_history: SyncHistory;
|
|
1863
|
+
}
|
|
1659
1864
|
/** event-tag-created */
|
|
1660
1865
|
export interface EventTagCreated {
|
|
1661
1866
|
tag: Tag;
|
|
@@ -1685,10 +1890,12 @@ export interface EventTimelineEntryDeleted {
|
|
|
1685
1890
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
1686
1891
|
*/
|
|
1687
1892
|
id: string;
|
|
1893
|
+
old_entry?: TimelineEntry;
|
|
1688
1894
|
}
|
|
1689
1895
|
/** event-timeline-entry-updated */
|
|
1690
1896
|
export interface EventTimelineEntryUpdated {
|
|
1691
1897
|
entry: TimelineEntry;
|
|
1898
|
+
old_entry?: TimelineEntry;
|
|
1692
1899
|
}
|
|
1693
1900
|
/** event-webhook-created */
|
|
1694
1901
|
export interface EventWebhookCreated {
|
|
@@ -1759,6 +1966,72 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
1759
1966
|
export type Group = AtomBase;
|
|
1760
1967
|
/** group-summary */
|
|
1761
1968
|
export type GroupSummary = AtomBaseSummary;
|
|
1969
|
+
/**
|
|
1970
|
+
* impacted-customer-details
|
|
1971
|
+
* Details of the impact due to the incident.
|
|
1972
|
+
*/
|
|
1973
|
+
export interface ImpactedCustomerDetails {
|
|
1974
|
+
/** The properties of an enum value. */
|
|
1975
|
+
count?: EnumValue;
|
|
1976
|
+
/** List of customers impacted due to the incident. */
|
|
1977
|
+
customer_ids?: AccountSummary[];
|
|
1978
|
+
}
|
|
1979
|
+
/** incident */
|
|
1980
|
+
export type Incident = AtomBase & {
|
|
1981
|
+
/**
|
|
1982
|
+
* Timestamp when the incident was acknowledged.
|
|
1983
|
+
* @format date-time
|
|
1984
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1985
|
+
*/
|
|
1986
|
+
acknowledged_date?: string;
|
|
1987
|
+
/** Parts to which the incident is applicable to. */
|
|
1988
|
+
applies_to_parts?: PartSummary[];
|
|
1989
|
+
/** Artifacts attached to the incident. */
|
|
1990
|
+
artifacts?: ArtifactSummary[];
|
|
1991
|
+
/** Body of the incident. */
|
|
1992
|
+
body?: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Time when the incident was identified/reported.
|
|
1995
|
+
* @format date-time
|
|
1996
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1997
|
+
*/
|
|
1998
|
+
identified_date?: string;
|
|
1999
|
+
/** Details of the impact due to the incident. */
|
|
2000
|
+
impact?: ImpactedCustomerDetails;
|
|
2001
|
+
/** List of customers impacted due to the incident. */
|
|
2002
|
+
impacted_customers?: AccountSummary[];
|
|
2003
|
+
/**
|
|
2004
|
+
* Timestamp when the incident was mitigated.
|
|
2005
|
+
* @format date-time
|
|
2006
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2007
|
+
*/
|
|
2008
|
+
mitigated_date?: string;
|
|
2009
|
+
/** The users that own the incident. */
|
|
2010
|
+
owned_by?: UserSummary[];
|
|
2011
|
+
/** The properties of an enum value. */
|
|
2012
|
+
reported_by?: EnumValue;
|
|
2013
|
+
/** The properties of an enum value. */
|
|
2014
|
+
severity?: EnumValue;
|
|
2015
|
+
/** The properties of an enum value. */
|
|
2016
|
+
source?: EnumValue;
|
|
2017
|
+
/** Describes the current stage of a object. */
|
|
2018
|
+
stage?: Stage;
|
|
2019
|
+
/**
|
|
2020
|
+
* Users, along with the incident commander, involved in resolving
|
|
2021
|
+
* incidents and handling communication.
|
|
2022
|
+
*/
|
|
2023
|
+
stakeholders?: UserSummary[];
|
|
2024
|
+
/** Tags associated with the object. */
|
|
2025
|
+
tags?: TagWithValue[];
|
|
2026
|
+
/**
|
|
2027
|
+
* Timestamp when the incident is expected to be resolved.
|
|
2028
|
+
* @format date-time
|
|
2029
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2030
|
+
*/
|
|
2031
|
+
target_close_date?: string;
|
|
2032
|
+
/** Title of the incident. */
|
|
2033
|
+
title: string;
|
|
2034
|
+
};
|
|
1762
2035
|
/** issue */
|
|
1763
2036
|
export type Issue = WorkBase & {
|
|
1764
2037
|
/** Parts associated based on git events. */
|
|
@@ -2496,6 +2769,19 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2496
2769
|
external_ref?: string;
|
|
2497
2770
|
rev_org?: OrgSummary;
|
|
2498
2771
|
};
|
|
2772
|
+
/** saml-connection-fields-map */
|
|
2773
|
+
export interface SamlConnectionFieldsMap {
|
|
2774
|
+
/**
|
|
2775
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
2776
|
+
* map to the email address of the user.
|
|
2777
|
+
*/
|
|
2778
|
+
email?: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
2781
|
+
* map to the user ID of the user.
|
|
2782
|
+
*/
|
|
2783
|
+
user_id?: string;
|
|
2784
|
+
}
|
|
2499
2785
|
/** schema-bool-field-descriptor */
|
|
2500
2786
|
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2501
2787
|
/** Default value. */
|
|
@@ -3437,6 +3723,11 @@ export interface SnapWidget {
|
|
|
3437
3723
|
type: SnapWidgetType;
|
|
3438
3724
|
}
|
|
3439
3725
|
export type SnapWidgetType = string;
|
|
3726
|
+
/**
|
|
3727
|
+
* stage
|
|
3728
|
+
* Describes the current stage of a object.
|
|
3729
|
+
*/
|
|
3730
|
+
export type Stage = object;
|
|
3440
3731
|
/**
|
|
3441
3732
|
* stage-filter
|
|
3442
3733
|
* The filter for stages.
|
|
@@ -3531,6 +3822,13 @@ export type SurveyResponse = AtomBase & {
|
|
|
3531
3822
|
/** The ID of the survey for which response is taken. */
|
|
3532
3823
|
survey?: string;
|
|
3533
3824
|
};
|
|
3825
|
+
/** sync-history */
|
|
3826
|
+
export type SyncHistory = AtomBase & {
|
|
3827
|
+
/** Object for holding run-specific data. */
|
|
3828
|
+
sync_run?: SyncRun;
|
|
3829
|
+
/** SyncUnit ID associated with this historical entry. */
|
|
3830
|
+
sync_unit?: string;
|
|
3831
|
+
};
|
|
3534
3832
|
/** sync-metadata-filter */
|
|
3535
3833
|
export interface SyncMetadataFilter {
|
|
3536
3834
|
/** Filters for issues with this specific external reference. */
|
|
@@ -3569,6 +3867,63 @@ export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
|
3569
3867
|
Modified = "modified",
|
|
3570
3868
|
Succeeded = "succeeded"
|
|
3571
3869
|
}
|
|
3870
|
+
/**
|
|
3871
|
+
* sync-progress
|
|
3872
|
+
* Progress.
|
|
3873
|
+
*/
|
|
3874
|
+
export interface SyncProgress {
|
|
3875
|
+
/** The state of a sync progress. */
|
|
3876
|
+
state?: SyncProgressState;
|
|
3877
|
+
}
|
|
3878
|
+
/** The state of a sync progress. */
|
|
3879
|
+
export declare enum SyncProgressState {
|
|
3880
|
+
Completed = "completed",
|
|
3881
|
+
DeleteInProgress = "delete_in_progress",
|
|
3882
|
+
Deleted = "deleted",
|
|
3883
|
+
DeletionError = "deletion_error",
|
|
3884
|
+
ExtractAttachments = "extract_attachments",
|
|
3885
|
+
ExtractAttachmentsError = "extract_attachments_error",
|
|
3886
|
+
Extraction = "extraction",
|
|
3887
|
+
ExtractionError = "extraction_error",
|
|
3888
|
+
Loading = "loading",
|
|
3889
|
+
LoadingAttachments = "loading_attachments",
|
|
3890
|
+
LoadingAttachmentsError = "loading_attachments_error",
|
|
3891
|
+
LoadingError = "loading_error",
|
|
3892
|
+
RecipeDiscovery = "recipe_discovery",
|
|
3893
|
+
RecipeDiscoveryError = "recipe_discovery_error",
|
|
3894
|
+
RecipeDiscoveryWaitingForUserInput = "recipe_discovery_waiting_for_user_input",
|
|
3895
|
+
Starting = "starting",
|
|
3896
|
+
Transformation = "transformation",
|
|
3897
|
+
TransformationError = "transformation_error"
|
|
3898
|
+
}
|
|
3899
|
+
/**
|
|
3900
|
+
* sync-run
|
|
3901
|
+
* Object for holding run-specific data.
|
|
3902
|
+
*/
|
|
3903
|
+
export interface SyncRun {
|
|
3904
|
+
/**
|
|
3905
|
+
* The time when a sync was ended.
|
|
3906
|
+
* @format date-time
|
|
3907
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3908
|
+
*/
|
|
3909
|
+
ended_at?: string;
|
|
3910
|
+
/** The direction/mode of a sync run. */
|
|
3911
|
+
mode?: SyncRunMode;
|
|
3912
|
+
/** Progress. */
|
|
3913
|
+
progress?: SyncProgress;
|
|
3914
|
+
/**
|
|
3915
|
+
* The time when a sync was started.
|
|
3916
|
+
* @format date-time
|
|
3917
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3918
|
+
*/
|
|
3919
|
+
started_at?: string;
|
|
3920
|
+
}
|
|
3921
|
+
/** The direction/mode of a sync run. */
|
|
3922
|
+
export declare enum SyncRunMode {
|
|
3923
|
+
Initial = "initial",
|
|
3924
|
+
SyncFromDevrev = "sync_from_devrev",
|
|
3925
|
+
SyncToDevrev = "sync_to_devrev"
|
|
3926
|
+
}
|
|
3572
3927
|
/** sys-user-summary */
|
|
3573
3928
|
export type SysUserSummary = UserBaseSummary;
|
|
3574
3929
|
/** tag */
|
|
@@ -4205,6 +4560,9 @@ export interface WebhookEventRequest {
|
|
|
4205
4560
|
group_updated?: EventGroupUpdated;
|
|
4206
4561
|
/** The event's ID. */
|
|
4207
4562
|
id: string;
|
|
4563
|
+
incident_created?: EventIncidentCreated;
|
|
4564
|
+
incident_deleted?: EventIncidentDeleted;
|
|
4565
|
+
incident_updated?: EventIncidentUpdated;
|
|
4208
4566
|
link_created?: EventLinkCreated;
|
|
4209
4567
|
link_deleted?: EventLinkDeleted;
|
|
4210
4568
|
link_updated?: EventLinkUpdated;
|
|
@@ -4226,6 +4584,9 @@ export interface WebhookEventRequest {
|
|
|
4226
4584
|
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
4227
4585
|
survey_response_updated?: EventSurveyResponseUpdated;
|
|
4228
4586
|
survey_updated?: EventSurveyUpdated;
|
|
4587
|
+
sync_history_created?: EventSyncHistoryCreated;
|
|
4588
|
+
sync_history_deleted?: EventSyncHistoryDeleted;
|
|
4589
|
+
sync_history_updated?: EventSyncHistoryUpdated;
|
|
4229
4590
|
tag_created?: EventTagCreated;
|
|
4230
4591
|
tag_deleted?: EventTagDeleted;
|
|
4231
4592
|
tag_updated?: EventTagUpdated;
|
|
@@ -4280,6 +4641,9 @@ export declare enum WebhookEventType {
|
|
|
4280
4641
|
GroupMemberAdded = "group_member_added",
|
|
4281
4642
|
GroupMemberRemoved = "group_member_removed",
|
|
4282
4643
|
GroupUpdated = "group_updated",
|
|
4644
|
+
IncidentCreated = "incident_created",
|
|
4645
|
+
IncidentDeleted = "incident_deleted",
|
|
4646
|
+
IncidentUpdated = "incident_updated",
|
|
4283
4647
|
LinkCreated = "link_created",
|
|
4284
4648
|
LinkDeleted = "link_deleted",
|
|
4285
4649
|
LinkUpdated = "link_updated",
|
|
@@ -4301,6 +4665,9 @@ export declare enum WebhookEventType {
|
|
|
4301
4665
|
SurveyResponseDeleted = "survey_response_deleted",
|
|
4302
4666
|
SurveyResponseUpdated = "survey_response_updated",
|
|
4303
4667
|
SurveyUpdated = "survey_updated",
|
|
4668
|
+
SyncHistoryCreated = "sync_history_created",
|
|
4669
|
+
SyncHistoryDeleted = "sync_history_deleted",
|
|
4670
|
+
SyncHistoryUpdated = "sync_history_updated",
|
|
4304
4671
|
TagCreated = "tag_created",
|
|
4305
4672
|
TagDeleted = "tag_deleted",
|
|
4306
4673
|
TagUpdated = "tag_updated",
|
|
@@ -4824,7 +5191,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
4824
5191
|
* object.
|
|
4825
5192
|
*/
|
|
4826
5193
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
4827
|
-
staged_info?:
|
|
5194
|
+
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
4828
5195
|
tags?: WorksUpdateRequestTags;
|
|
4829
5196
|
/**
|
|
4830
5197
|
* Updates the timestamp for when the work is expected to be complete.
|
|
@@ -4901,10 +5268,23 @@ export interface WorksUpdateRequestReportedBy {
|
|
|
4901
5268
|
*/
|
|
4902
5269
|
set?: string[];
|
|
4903
5270
|
}
|
|
4904
|
-
/** works-update-request-staged-info-
|
|
4905
|
-
export interface
|
|
5271
|
+
/** works-update-request-staged-info-update */
|
|
5272
|
+
export interface WorksUpdateRequestStagedInfoUpdate {
|
|
5273
|
+
/** Updates the sync in unresolved fields of the staged work. */
|
|
5274
|
+
sync_in_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
5275
|
+
/** Updates the sync out unresolved fields of the staged work. */
|
|
5276
|
+
sync_out_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
4906
5277
|
/** Updates the unresolved fields of the staged work. */
|
|
4907
|
-
unresolved_fields
|
|
5278
|
+
unresolved_fields?: string[];
|
|
5279
|
+
}
|
|
5280
|
+
/** works-update-request-staged-info-update-unresolved-field */
|
|
5281
|
+
export interface WorksUpdateRequestStagedInfoUpdateUnresolvedField {
|
|
5282
|
+
/** DevRev field name of the object's attribute. */
|
|
5283
|
+
devrev_field_name?: string;
|
|
5284
|
+
/** External field name as seen by the end user. */
|
|
5285
|
+
external_display_name?: string;
|
|
5286
|
+
/** Api name of the external object's field. */
|
|
5287
|
+
external_field_name?: string;
|
|
4908
5288
|
}
|
|
4909
5289
|
/** works-update-request-tags */
|
|
4910
5290
|
export interface WorksUpdateRequestTags {
|
|
@@ -4916,6 +5296,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
4916
5296
|
channels?: WorksUpdateRequestTicketChannels;
|
|
4917
5297
|
/** Updates the group that the ticket is associated with. */
|
|
4918
5298
|
group?: string | null;
|
|
5299
|
+
/** Whether the ticket is archived. */
|
|
5300
|
+
is_archived?: boolean;
|
|
4919
5301
|
/** Updates whether the ticket is spam. */
|
|
4920
5302
|
is_spam?: boolean;
|
|
4921
5303
|
/** Updates whether the ticket needs a response. */
|
|
@@ -5069,6 +5451,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5069
5451
|
sort_by?: string[];
|
|
5070
5452
|
/** Filters for accounts on specified stages. */
|
|
5071
5453
|
stage?: string[];
|
|
5454
|
+
/** Array of websites of accounts to be filtered. */
|
|
5455
|
+
websites?: string[];
|
|
5072
5456
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
5073
5457
|
/**
|
|
5074
5458
|
* @description Exports a collection of accounts.
|
|
@@ -5164,6 +5548,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5164
5548
|
sort_by?: string[];
|
|
5165
5549
|
/** Filters for accounts on specified stages. */
|
|
5166
5550
|
stage?: string[];
|
|
5551
|
+
/** Array of websites of accounts to be filtered. */
|
|
5552
|
+
websites?: string[];
|
|
5167
5553
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
5168
5554
|
/**
|
|
5169
5555
|
* @description Gets a list of accounts.
|
|
@@ -6219,6 +6605,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6219
6605
|
* @secure
|
|
6220
6606
|
*/
|
|
6221
6607
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
6608
|
+
/**
|
|
6609
|
+
* @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.
|
|
6610
|
+
*
|
|
6611
|
+
* @tags webhooks
|
|
6612
|
+
* @name WebhooksEvent
|
|
6613
|
+
* @request POST:/webhooks.event
|
|
6614
|
+
* @secure
|
|
6615
|
+
*/
|
|
6616
|
+
webhooksEvent: (data: WebhookEventRequest, params?: RequestParams) => Promise<AxiosResponse<WebhookEventResponse, any>>;
|
|
6222
6617
|
/**
|
|
6223
6618
|
* @description Gets the requested webhook's information.
|
|
6224
6619
|
*
|