@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.
|
@@ -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"
|
|
@@ -2053,6 +2220,16 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
2053
2220
|
*/
|
|
2054
2221
|
export interface ConversationsCreateRequest {
|
|
2055
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;
|
|
2056
2233
|
/** Description for the conversation. */
|
|
2057
2234
|
description?: string;
|
|
2058
2235
|
/** The group that the conversation is associated with. */
|
|
@@ -2124,6 +2301,8 @@ export interface ConversationsExportRequest {
|
|
|
2124
2301
|
* @example ["PROD-12345"]
|
|
2125
2302
|
*/
|
|
2126
2303
|
applies_to_parts?: string[];
|
|
2304
|
+
/** Filters for custom fields. */
|
|
2305
|
+
custom_fields?: object;
|
|
2127
2306
|
/**
|
|
2128
2307
|
* The number of conversation items to return. The default is '50',
|
|
2129
2308
|
* the maximum is '5000'.
|
|
@@ -2149,15 +2328,29 @@ export interface ConversationsExportRequest {
|
|
|
2149
2328
|
/**
|
|
2150
2329
|
* Filters for conversations that are associated with any of the
|
|
2151
2330
|
* provided Rev organizations.
|
|
2331
|
+
* @deprecated
|
|
2152
2332
|
* @example ["REV-AbCdEfGh"]
|
|
2153
2333
|
*/
|
|
2154
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[];
|
|
2155
2341
|
/** The filter for SLA summary. */
|
|
2156
2342
|
sla_summary?: SlaSummaryFilter;
|
|
2157
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
|
+
*/
|
|
2158
2349
|
source_channels?: string[];
|
|
2159
2350
|
/** The filter for stages. */
|
|
2160
2351
|
stage?: StageFilter;
|
|
2352
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2353
|
+
subtype?: string[];
|
|
2161
2354
|
/**
|
|
2162
2355
|
* Filters for conversations with any of the provided tags.
|
|
2163
2356
|
* @deprecated
|
|
@@ -2202,6 +2395,8 @@ export interface ConversationsListRequest {
|
|
|
2202
2395
|
* iteration starts from the beginning.
|
|
2203
2396
|
*/
|
|
2204
2397
|
cursor?: string;
|
|
2398
|
+
/** Filters for custom fields. */
|
|
2399
|
+
custom_fields?: object;
|
|
2205
2400
|
/** Filters for conversation that belong to the given groups. */
|
|
2206
2401
|
group?: string[];
|
|
2207
2402
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -2234,15 +2429,29 @@ export interface ConversationsListRequest {
|
|
|
2234
2429
|
/**
|
|
2235
2430
|
* Filters for conversations that are associated with any of the
|
|
2236
2431
|
* provided Rev organizations.
|
|
2432
|
+
* @deprecated
|
|
2237
2433
|
* @example ["REV-AbCdEfGh"]
|
|
2238
2434
|
*/
|
|
2239
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[];
|
|
2240
2442
|
/** The filter for SLA summary. */
|
|
2241
2443
|
sla_summary?: SlaSummaryFilter;
|
|
2242
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
|
+
*/
|
|
2243
2450
|
source_channels?: string[];
|
|
2244
2451
|
/** The filter for stages. */
|
|
2245
2452
|
stage?: StageFilter;
|
|
2453
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2454
|
+
subtype?: string[];
|
|
2246
2455
|
/**
|
|
2247
2456
|
* Filters for conversations with any of the provided tags.
|
|
2248
2457
|
* @deprecated
|
|
@@ -2276,6 +2485,16 @@ export interface ConversationsListResponse {
|
|
|
2276
2485
|
*/
|
|
2277
2486
|
export interface ConversationsUpdateRequest {
|
|
2278
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;
|
|
2279
2498
|
/** The updated description for the conversation. */
|
|
2280
2499
|
description?: string;
|
|
2281
2500
|
/** The group that the conversation is associated with. */
|
|
@@ -2861,6 +3080,8 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2861
3080
|
/** custom-schema-fragments-set-request */
|
|
2862
3081
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2863
3082
|
type: CustomSchemaFragmentsSetRequestType;
|
|
3083
|
+
/** List of all composite schemas used in this fragment. */
|
|
3084
|
+
composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
|
|
2864
3085
|
/** List of conditions for this fragment. */
|
|
2865
3086
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2866
3087
|
/** List of field names which are being dropped. */
|
|
@@ -2881,6 +3102,15 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
2881
3102
|
/** The app this fragment applies to. */
|
|
2882
3103
|
app: string;
|
|
2883
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
|
+
}
|
|
2884
3114
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
2885
3115
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
2886
3116
|
/**
|
|
@@ -3205,6 +3435,12 @@ export declare enum DateTimePresetType {
|
|
|
3205
3435
|
LastNDays = "last_n_days",
|
|
3206
3436
|
NextNDays = "next_n_days"
|
|
3207
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
|
+
}
|
|
3208
3444
|
/**
|
|
3209
3445
|
* delete-rev-users-personal-data-request
|
|
3210
3446
|
* Request object to delete a contact's information.
|
|
@@ -3215,7 +3451,7 @@ export interface DeleteRevUsersPersonalDataRequest {
|
|
|
3215
3451
|
}
|
|
3216
3452
|
/**
|
|
3217
3453
|
* delete-rev-users-personal-data-response
|
|
3218
|
-
* Response for the contacts personal data
|
|
3454
|
+
* Response for the contacts personal data delete request. Response is
|
|
3219
3455
|
* empty as the process is asynchronous. Upon completion, the user will be
|
|
3220
3456
|
* notified.
|
|
3221
3457
|
*/
|
|
@@ -3224,7 +3460,7 @@ export type DeleteRevUsersPersonalDataResponse = object;
|
|
|
3224
3460
|
* dev-org-auth-connections-create-request
|
|
3225
3461
|
* Request to create a new enterprise authentication connection.
|
|
3226
3462
|
*/
|
|
3227
|
-
export type DevOrgAuthConnectionsCreateRequest = (
|
|
3463
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
3228
3464
|
/**
|
|
3229
3465
|
* Defines the type for the authentication connection. Different types of
|
|
3230
3466
|
* authentication connections have different configuration parameters.
|
|
@@ -3235,9 +3471,84 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3235
3471
|
* visible to all the users when they sign in to this Dev
|
|
3236
3472
|
* organization. For example, if the display_name is 'abclogin', then
|
|
3237
3473
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
3474
|
+
* @minLength 1
|
|
3475
|
+
* @maxLength 128
|
|
3238
3476
|
*/
|
|
3239
3477
|
display_name?: string;
|
|
3240
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
|
+
}
|
|
3241
3552
|
/**
|
|
3242
3553
|
* Defines the type for the authentication connection. Different types of
|
|
3243
3554
|
* authentication connections have different configuration parameters.
|
|
@@ -3245,6 +3556,7 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3245
3556
|
export declare enum DevOrgAuthConnectionsCreateRequestType {
|
|
3246
3557
|
GoogleApps = "google_apps",
|
|
3247
3558
|
Oidc = "oidc",
|
|
3559
|
+
Okta = "okta",
|
|
3248
3560
|
Samlp = "samlp",
|
|
3249
3561
|
Waad = "waad"
|
|
3250
3562
|
}
|
|
@@ -3318,7 +3630,7 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
3318
3630
|
* Request to update an enterprise authentication connection for a Dev
|
|
3319
3631
|
* organization.
|
|
3320
3632
|
*/
|
|
3321
|
-
export type DevOrgAuthConnectionsUpdateRequest = (
|
|
3633
|
+
export type DevOrgAuthConnectionsUpdateRequest = (DevOrgAuthConnectionsUpdateRequestAzureAdOptions | DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions | DevOrgAuthConnectionsUpdateRequestOidcOptions | DevOrgAuthConnectionsUpdateRequestOktaOptions | DevOrgAuthConnectionsUpdateRequestSamlOptions | Empty) & {
|
|
3322
3634
|
/**
|
|
3323
3635
|
* Specifies the type for the authentication connection. Different types
|
|
3324
3636
|
* of authentication connections have different configuration parameters
|
|
@@ -3335,6 +3647,72 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3335
3647
|
/** ID of the authentication connection which is to be updated. */
|
|
3336
3648
|
id: string;
|
|
3337
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
|
+
}
|
|
3338
3716
|
/**
|
|
3339
3717
|
* Specifies the type for the authentication connection. Different types
|
|
3340
3718
|
* of authentication connections have different configuration parameters
|
|
@@ -3344,6 +3722,7 @@ export declare enum DevOrgAuthConnectionsUpdateRequestType {
|
|
|
3344
3722
|
GoogleApps = "google_apps",
|
|
3345
3723
|
None = "none",
|
|
3346
3724
|
Oidc = "oidc",
|
|
3725
|
+
Okta = "okta",
|
|
3347
3726
|
Samlp = "samlp",
|
|
3348
3727
|
Waad = "waad"
|
|
3349
3728
|
}
|
|
@@ -3412,6 +3791,37 @@ export declare enum DevUserJobTitle {
|
|
|
3412
3791
|
}
|
|
3413
3792
|
/** dev-user-summary */
|
|
3414
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;
|
|
3415
3825
|
/**
|
|
3416
3826
|
* dev-users-get-request
|
|
3417
3827
|
* A request to get a Dev user's information.
|
|
@@ -4136,6 +4546,24 @@ export interface EnumValue {
|
|
|
4136
4546
|
*/
|
|
4137
4547
|
ordinal: number;
|
|
4138
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
|
+
}
|
|
4139
4567
|
/** error */
|
|
4140
4568
|
export interface Error {
|
|
4141
4569
|
/** The error type. */
|
|
@@ -4477,6 +4905,21 @@ export interface EventGroupUpdated {
|
|
|
4477
4905
|
group: Group;
|
|
4478
4906
|
old_group?: Group;
|
|
4479
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
|
+
}
|
|
4480
4923
|
/** event-link-created */
|
|
4481
4924
|
export interface EventLinkCreated {
|
|
4482
4925
|
link: Link;
|
|
@@ -4680,6 +5123,20 @@ export interface EventSurveyUpdated {
|
|
|
4680
5123
|
old_survey?: Survey;
|
|
4681
5124
|
survey: Survey;
|
|
4682
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
|
+
}
|
|
4683
5140
|
/** event-tag-created */
|
|
4684
5141
|
export interface EventTagCreated {
|
|
4685
5142
|
tag: Tag;
|
|
@@ -4709,10 +5166,12 @@ export interface EventTimelineEntryDeleted {
|
|
|
4709
5166
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
4710
5167
|
*/
|
|
4711
5168
|
id: string;
|
|
5169
|
+
old_entry?: TimelineEntry;
|
|
4712
5170
|
}
|
|
4713
5171
|
/** event-timeline-entry-updated */
|
|
4714
5172
|
export interface EventTimelineEntryUpdated {
|
|
4715
5173
|
entry: TimelineEntry;
|
|
5174
|
+
old_entry?: TimelineEntry;
|
|
4716
5175
|
}
|
|
4717
5176
|
/** event-webhook-created */
|
|
4718
5177
|
export interface EventWebhookCreated {
|
|
@@ -4799,6 +5258,19 @@ export interface ExternalIdentity {
|
|
|
4799
5258
|
/** Issuer of the external identity of the user. */
|
|
4800
5259
|
issuer?: string;
|
|
4801
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
|
+
}
|
|
4802
5274
|
/** feature */
|
|
4803
5275
|
export type Feature = PartBase;
|
|
4804
5276
|
/** feature-summary */
|
|
@@ -5314,6 +5786,17 @@ export type Incident = AtomBase & {
|
|
|
5314
5786
|
/** Title of the incident. */
|
|
5315
5787
|
title: string;
|
|
5316
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
|
+
};
|
|
5317
5800
|
/** incidents-create-request */
|
|
5318
5801
|
export interface IncidentsCreateRequest {
|
|
5319
5802
|
/**
|
|
@@ -5700,6 +6183,27 @@ export interface IncidentsUpdateRequest {
|
|
|
5700
6183
|
export interface IncidentsUpdateResponse {
|
|
5701
6184
|
incident: Incident;
|
|
5702
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
|
+
}
|
|
5703
6207
|
/** issue */
|
|
5704
6208
|
export type Issue = WorkBase & {
|
|
5705
6209
|
/**
|
|
@@ -5834,7 +6338,7 @@ export interface LinkDescriptorFilter {
|
|
|
5834
6338
|
link_descriptors: LinkTargetDescriptor[];
|
|
5835
6339
|
}
|
|
5836
6340
|
/** link-endpoint-summary */
|
|
5837
|
-
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
6341
|
+
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
5838
6342
|
type: LinkEndpointType;
|
|
5839
6343
|
};
|
|
5840
6344
|
export declare enum LinkEndpointType {
|
|
@@ -5844,6 +6348,7 @@ export declare enum LinkEndpointType {
|
|
|
5844
6348
|
DevUser = "dev_user",
|
|
5845
6349
|
Enhancement = "enhancement",
|
|
5846
6350
|
Feature = "feature",
|
|
6351
|
+
Incident = "incident",
|
|
5847
6352
|
Issue = "issue",
|
|
5848
6353
|
Opportunity = "opportunity",
|
|
5849
6354
|
Product = "product",
|
|
@@ -6612,6 +7117,22 @@ export interface OrgSchedulesCreateRequest {
|
|
|
6612
7117
|
export interface OrgSchedulesCreateResponse {
|
|
6613
7118
|
org_schedule: OrgSchedule;
|
|
6614
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
|
+
}
|
|
6615
7136
|
/** org-schedules-get-request */
|
|
6616
7137
|
export interface OrgSchedulesGetRequest {
|
|
6617
7138
|
/** Organization schedule ID. */
|
|
@@ -6824,6 +7345,14 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
6824
7345
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6825
7346
|
*/
|
|
6826
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;
|
|
6827
7356
|
/** Description of the part. */
|
|
6828
7357
|
description?: string;
|
|
6829
7358
|
/** Name of the part. */
|
|
@@ -6965,6 +7494,14 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
6965
7494
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6966
7495
|
*/
|
|
6967
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;
|
|
6968
7505
|
/** The updated description of the part. */
|
|
6969
7506
|
description?: string;
|
|
6970
7507
|
/**
|
|
@@ -7348,9 +7885,9 @@ export type RemovedSlaMetricHistory = object;
|
|
|
7348
7885
|
* Resource details.
|
|
7349
7886
|
*/
|
|
7350
7887
|
export interface Resource {
|
|
7351
|
-
/**
|
|
7888
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7352
7889
|
artifacts?: ArtifactSummary[];
|
|
7353
|
-
/** URL of the
|
|
7890
|
+
/** URL of the resource (relevant only for type url). */
|
|
7354
7891
|
url?: string;
|
|
7355
7892
|
}
|
|
7356
7893
|
/**
|
|
@@ -7358,9 +7895,9 @@ export interface Resource {
|
|
|
7358
7895
|
* Resource details.
|
|
7359
7896
|
*/
|
|
7360
7897
|
export interface ResourceSummary {
|
|
7361
|
-
/**
|
|
7898
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7362
7899
|
artifacts?: ArtifactSummary[];
|
|
7363
|
-
/** URL of the
|
|
7900
|
+
/** URL of the resource (relevant only for type url). */
|
|
7364
7901
|
url?: string;
|
|
7365
7902
|
}
|
|
7366
7903
|
/** rev-org */
|
|
@@ -7683,9 +8220,18 @@ export interface RevUsersCreateRequest {
|
|
|
7683
8220
|
custom_fields?: object;
|
|
7684
8221
|
/**
|
|
7685
8222
|
* The schema fragment IDs associated with the Rev user.
|
|
8223
|
+
* @deprecated
|
|
7686
8224
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
7687
8225
|
*/
|
|
7688
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;
|
|
7689
8235
|
/** Description of the Rev user. */
|
|
7690
8236
|
description?: string;
|
|
7691
8237
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -7885,6 +8431,14 @@ export interface RevUsersUpdateRequest {
|
|
|
7885
8431
|
/** Application-defined custom fields. */
|
|
7886
8432
|
custom_fields?: object;
|
|
7887
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;
|
|
7888
8442
|
/** Updated description of the Rev user. */
|
|
7889
8443
|
description?: string;
|
|
7890
8444
|
/** Updated display name of the Rev user. */
|
|
@@ -7923,6 +8477,19 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
|
7923
8477
|
export interface RevUsersUpdateResponse {
|
|
7924
8478
|
rev_user: RevUser;
|
|
7925
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
|
+
}
|
|
7926
8493
|
/** schema-bool-field-descriptor */
|
|
7927
8494
|
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
7928
8495
|
/** Default value. */
|
|
@@ -8118,7 +8685,24 @@ export interface SchemaFieldSummaryViewUiMetadata {
|
|
|
8118
8685
|
* schema-field-uenum-value
|
|
8119
8686
|
* A unified enum value.
|
|
8120
8687
|
*/
|
|
8121
|
-
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
|
+
}
|
|
8122
8706
|
/**
|
|
8123
8707
|
* schema-field-ui-metadata
|
|
8124
8708
|
* The schema of ui specific fields.
|
|
@@ -8138,6 +8722,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
8138
8722
|
is_active_in_detail_view?: boolean;
|
|
8139
8723
|
/** Whether the field supports bulk action. */
|
|
8140
8724
|
is_bulk_action_enabled?: boolean;
|
|
8725
|
+
/** Indicates if the field holds a currency value in USD. */
|
|
8726
|
+
is_currency_field?: boolean;
|
|
8141
8727
|
/** Whether the field is groupable in the UI. */
|
|
8142
8728
|
is_groupable?: boolean;
|
|
8143
8729
|
/** Whether the field is hidden in the UI. */
|
|
@@ -8154,12 +8740,19 @@ export interface SchemaFieldUiMetadata {
|
|
|
8154
8740
|
is_sortable?: boolean;
|
|
8155
8741
|
/** List view UI hint overrides. */
|
|
8156
8742
|
list_view?: SchemaFieldListViewUiMetadata;
|
|
8743
|
+
/**
|
|
8744
|
+
* Order in which field is shown.
|
|
8745
|
+
* @format int32
|
|
8746
|
+
*/
|
|
8747
|
+
order?: number;
|
|
8157
8748
|
/** A placeholder for the field. */
|
|
8158
8749
|
placeholder?: string;
|
|
8159
8750
|
/** Summary view UI hint overrides. */
|
|
8160
8751
|
summary_view?: SchemaFieldSummaryViewUiMetadata;
|
|
8161
8752
|
/** Tooltip for the field. */
|
|
8162
8753
|
tooltip?: string;
|
|
8754
|
+
/** Unit of measurment. */
|
|
8755
|
+
unit?: string;
|
|
8163
8756
|
}
|
|
8164
8757
|
/** schema-id-field-descriptor */
|
|
8165
8758
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
@@ -9332,6 +9925,13 @@ export interface StageInit {
|
|
|
9332
9925
|
/** The name of the stage. */
|
|
9333
9926
|
name?: string;
|
|
9334
9927
|
}
|
|
9928
|
+
/**
|
|
9929
|
+
* stage-summary
|
|
9930
|
+
* Describes the current stage of a object.
|
|
9931
|
+
*/
|
|
9932
|
+
export interface StageSummary {
|
|
9933
|
+
stage?: CustomStageSummary;
|
|
9934
|
+
}
|
|
9335
9935
|
/**
|
|
9336
9936
|
* stage-update
|
|
9337
9937
|
* Updates an object's stage.
|
|
@@ -9526,21 +10126,40 @@ export type SurveyResponse = AtomBase & {
|
|
|
9526
10126
|
};
|
|
9527
10127
|
/** surveys-create-request */
|
|
9528
10128
|
export interface SurveysCreateRequest {
|
|
9529
|
-
/**
|
|
10129
|
+
/**
|
|
10130
|
+
* Description about the survey.
|
|
10131
|
+
* @maxLength 1000
|
|
10132
|
+
*/
|
|
9530
10133
|
description?: string;
|
|
9531
|
-
/**
|
|
10134
|
+
/**
|
|
10135
|
+
* Header of the survey.
|
|
10136
|
+
* @maxLength 1000
|
|
10137
|
+
*/
|
|
9532
10138
|
header?: string;
|
|
9533
|
-
/**
|
|
10139
|
+
/**
|
|
10140
|
+
* Text posted when introducing the survey to the responder.
|
|
10141
|
+
* @maxLength 1000
|
|
10142
|
+
*/
|
|
9534
10143
|
introductory_text?: string;
|
|
9535
|
-
/**
|
|
10144
|
+
/**
|
|
10145
|
+
* The survey's name.
|
|
10146
|
+
* @minLength 1
|
|
10147
|
+
* @maxLength 100
|
|
10148
|
+
*/
|
|
9536
10149
|
name: string;
|
|
9537
|
-
/**
|
|
10150
|
+
/**
|
|
10151
|
+
* Text posted after the response is collected.
|
|
10152
|
+
* @maxLength 1000
|
|
10153
|
+
*/
|
|
9538
10154
|
response_text?: string;
|
|
9539
10155
|
/** Schema for the survey. */
|
|
9540
10156
|
schema?: FieldDescriptor[];
|
|
9541
10157
|
/** The schema with metadata for the survey. */
|
|
9542
10158
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
9543
|
-
/**
|
|
10159
|
+
/**
|
|
10160
|
+
* Title of the survey.
|
|
10161
|
+
* @maxLength 1000
|
|
10162
|
+
*/
|
|
9544
10163
|
title?: string;
|
|
9545
10164
|
}
|
|
9546
10165
|
/** surveys-create-response */
|
|
@@ -9723,6 +10342,61 @@ export interface SurveysSubmitRequest {
|
|
|
9723
10342
|
}
|
|
9724
10343
|
/** surveys-submit-response */
|
|
9725
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
|
+
};
|
|
9726
10400
|
/**
|
|
9727
10401
|
* sync-in
|
|
9728
10402
|
* Information about the sync to DevRev.
|
|
@@ -9818,8 +10492,120 @@ export declare enum SyncOutStatus {
|
|
|
9818
10492
|
Modified = "modified",
|
|
9819
10493
|
Succeeded = "succeeded"
|
|
9820
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
|
+
};
|
|
9821
10592
|
/** sync-unit-summary */
|
|
9822
|
-
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
|
+
}
|
|
9823
10609
|
/** sys-user */
|
|
9824
10610
|
export type SysUser = UserBase;
|
|
9825
10611
|
/** sys-user-summary */
|
|
@@ -10563,6 +11349,7 @@ export declare enum TimelineEntryObjectType {
|
|
|
10563
11349
|
Engagement = "engagement",
|
|
10564
11350
|
Enhancement = "enhancement",
|
|
10565
11351
|
Feature = "feature",
|
|
11352
|
+
Incident = "incident",
|
|
10566
11353
|
Issue = "issue",
|
|
10567
11354
|
Meeting = "meeting",
|
|
10568
11355
|
Opportunity = "opportunity",
|
|
@@ -11268,6 +12055,9 @@ export interface WebhookEventRequest {
|
|
|
11268
12055
|
group_updated?: EventGroupUpdated;
|
|
11269
12056
|
/** The event's ID. */
|
|
11270
12057
|
id: string;
|
|
12058
|
+
incident_created?: EventIncidentCreated;
|
|
12059
|
+
incident_deleted?: EventIncidentDeleted;
|
|
12060
|
+
incident_updated?: EventIncidentUpdated;
|
|
11271
12061
|
link_created?: EventLinkCreated;
|
|
11272
12062
|
link_deleted?: EventLinkDeleted;
|
|
11273
12063
|
link_updated?: EventLinkUpdated;
|
|
@@ -11289,6 +12079,9 @@ export interface WebhookEventRequest {
|
|
|
11289
12079
|
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
11290
12080
|
survey_response_updated?: EventSurveyResponseUpdated;
|
|
11291
12081
|
survey_updated?: EventSurveyUpdated;
|
|
12082
|
+
sync_history_created?: EventSyncHistoryCreated;
|
|
12083
|
+
sync_history_deleted?: EventSyncHistoryDeleted;
|
|
12084
|
+
sync_history_updated?: EventSyncHistoryUpdated;
|
|
11292
12085
|
tag_created?: EventTagCreated;
|
|
11293
12086
|
tag_deleted?: EventTagDeleted;
|
|
11294
12087
|
tag_updated?: EventTagUpdated;
|
|
@@ -11343,6 +12136,9 @@ export declare enum WebhookEventType {
|
|
|
11343
12136
|
GroupMemberAdded = "group_member_added",
|
|
11344
12137
|
GroupMemberRemoved = "group_member_removed",
|
|
11345
12138
|
GroupUpdated = "group_updated",
|
|
12139
|
+
IncidentCreated = "incident_created",
|
|
12140
|
+
IncidentDeleted = "incident_deleted",
|
|
12141
|
+
IncidentUpdated = "incident_updated",
|
|
11346
12142
|
LinkCreated = "link_created",
|
|
11347
12143
|
LinkDeleted = "link_deleted",
|
|
11348
12144
|
LinkUpdated = "link_updated",
|
|
@@ -11364,6 +12160,9 @@ export declare enum WebhookEventType {
|
|
|
11364
12160
|
SurveyResponseDeleted = "survey_response_deleted",
|
|
11365
12161
|
SurveyResponseUpdated = "survey_response_updated",
|
|
11366
12162
|
SurveyUpdated = "survey_updated",
|
|
12163
|
+
SyncHistoryCreated = "sync_history_created",
|
|
12164
|
+
SyncHistoryDeleted = "sync_history_deleted",
|
|
12165
|
+
SyncHistoryUpdated = "sync_history_updated",
|
|
11367
12166
|
TagCreated = "tag_created",
|
|
11368
12167
|
TagDeleted = "tag_deleted",
|
|
11369
12168
|
TagUpdated = "tag_updated",
|
|
@@ -12101,7 +12900,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
12101
12900
|
* object.
|
|
12102
12901
|
*/
|
|
12103
12902
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
12104
|
-
staged_info?:
|
|
12903
|
+
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
12105
12904
|
tags?: WorksUpdateRequestTags;
|
|
12106
12905
|
/**
|
|
12107
12906
|
* Updates the timestamp for when the work is expected to be complete.
|
|
@@ -12213,10 +13012,23 @@ export interface WorksUpdateRequestReportedBy {
|
|
|
12213
13012
|
*/
|
|
12214
13013
|
set?: string[];
|
|
12215
13014
|
}
|
|
12216
|
-
/** works-update-request-staged-info-
|
|
12217
|
-
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[];
|
|
12218
13021
|
/** Updates the unresolved fields of the staged work. */
|
|
12219
|
-
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;
|
|
12220
13032
|
}
|
|
12221
13033
|
/** works-update-request-tags */
|
|
12222
13034
|
export interface WorksUpdateRequestTags {
|
|
@@ -12245,6 +13057,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
12245
13057
|
channels?: WorksUpdateRequestTicketChannels;
|
|
12246
13058
|
/** Updates the group that the ticket is associated with. */
|
|
12247
13059
|
group?: string | null;
|
|
13060
|
+
/** Whether the ticket is archived. */
|
|
13061
|
+
is_archived?: boolean;
|
|
12248
13062
|
/** Updates whether the ticket is spam. */
|
|
12249
13063
|
is_spam?: boolean;
|
|
12250
13064
|
/** Updates whether the ticket needs a response. */
|
|
@@ -12406,6 +13220,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12406
13220
|
stage?: string[];
|
|
12407
13221
|
/** List of tags to be filtered. */
|
|
12408
13222
|
tags?: string[];
|
|
13223
|
+
/** Array of websites of accounts to be filtered. */
|
|
13224
|
+
websites?: string[];
|
|
12409
13225
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
12410
13226
|
/**
|
|
12411
13227
|
* @description Exports a collection of accounts.
|
|
@@ -12509,6 +13325,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12509
13325
|
stage?: string[];
|
|
12510
13326
|
/** List of tags to be filtered. */
|
|
12511
13327
|
tags?: string[];
|
|
13328
|
+
/** Array of websites of accounts to be filtered. */
|
|
13329
|
+
websites?: string[];
|
|
12512
13330
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
12513
13331
|
/**
|
|
12514
13332
|
* @description Gets a list of accounts.
|
|
@@ -12519,6 +13337,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12519
13337
|
* @secure
|
|
12520
13338
|
*/
|
|
12521
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>>;
|
|
12522
13349
|
/**
|
|
12523
13350
|
* @description Updates an account's information.
|
|
12524
13351
|
*
|
|
@@ -12528,6 +13355,71 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12528
13355
|
* @secure
|
|
12529
13356
|
*/
|
|
12530
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>>;
|
|
12531
13423
|
/**
|
|
12532
13424
|
* @description Get count of articles matching given filter.
|
|
12533
13425
|
*
|
|
@@ -12569,10 +13461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12569
13461
|
* @example ["DEVU-12345"]
|
|
12570
13462
|
*/
|
|
12571
13463
|
owned_by?: string[];
|
|
12572
|
-
/**
|
|
12573
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
12574
|
-
* only external articles are returned.
|
|
12575
|
-
*/
|
|
13464
|
+
/** Filter for the scope of the articles. */
|
|
12576
13465
|
scope?: number[];
|
|
12577
13466
|
/** ID of the group/member with whom the item is shared. */
|
|
12578
13467
|
'shared_with.member'?: string;
|
|
@@ -12684,10 +13573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12684
13573
|
* @example ["DEVU-12345"]
|
|
12685
13574
|
*/
|
|
12686
13575
|
owned_by?: string[];
|
|
12687
|
-
/**
|
|
12688
|
-
* Filter for the scope of the articles. If this is not provided, then
|
|
12689
|
-
* only external articles are returned.
|
|
12690
|
-
*/
|
|
13576
|
+
/** Filter for the scope of the articles. */
|
|
12691
13577
|
scope?: number[];
|
|
12692
13578
|
/** ID of the group/member with whom the item is shared. */
|
|
12693
13579
|
'shared_with.member'?: string;
|
|
@@ -13116,6 +14002,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13116
14002
|
* @example ["PROD-12345"]
|
|
13117
14003
|
*/
|
|
13118
14004
|
applies_to_parts?: string[];
|
|
14005
|
+
/** Filters for custom fields. */
|
|
14006
|
+
custom_fields?: object;
|
|
13119
14007
|
/**
|
|
13120
14008
|
* The number of conversation items to return. The default is '50', the
|
|
13121
14009
|
* maximum is '5000'.
|
|
@@ -13141,15 +14029,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13141
14029
|
/**
|
|
13142
14030
|
* Filters for conversations that are associated with any of the
|
|
13143
14031
|
* provided Rev organizations.
|
|
14032
|
+
* @deprecated
|
|
13144
14033
|
* @example ["REV-AbCdEfGh"]
|
|
13145
14034
|
*/
|
|
13146
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[];
|
|
13147
14042
|
/** Filters for records with any of the provided SLA stages. */
|
|
13148
14043
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13149
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
|
+
*/
|
|
13150
14050
|
source_channels?: string[];
|
|
13151
14051
|
/** Filters for records in the provided stage(s) by name. */
|
|
13152
14052
|
'stage.name'?: string[];
|
|
14053
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14054
|
+
subtype?: string[];
|
|
13153
14055
|
/**
|
|
13154
14056
|
* Filters for conversations with any of the provided tags.
|
|
13155
14057
|
* @deprecated
|
|
@@ -13216,6 +14118,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13216
14118
|
* starts from the beginning.
|
|
13217
14119
|
*/
|
|
13218
14120
|
cursor?: string;
|
|
14121
|
+
/** Filters for custom fields. */
|
|
14122
|
+
custom_fields?: object;
|
|
13219
14123
|
/** Filters for conversation that belong to the given groups. */
|
|
13220
14124
|
group?: string[];
|
|
13221
14125
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -13245,15 +14149,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13245
14149
|
/**
|
|
13246
14150
|
* Filters for conversations that are associated with any of the
|
|
13247
14151
|
* provided Rev organizations.
|
|
14152
|
+
* @deprecated
|
|
13248
14153
|
* @example ["REV-AbCdEfGh"]
|
|
13249
14154
|
*/
|
|
13250
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[];
|
|
13251
14162
|
/** Filters for records with any of the provided SLA stages. */
|
|
13252
14163
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13253
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
|
+
*/
|
|
13254
14170
|
source_channels?: string[];
|
|
13255
14171
|
/** Filters for records in the provided stage(s) by name. */
|
|
13256
14172
|
'stage.name'?: string[];
|
|
14173
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14174
|
+
subtype?: string[];
|
|
13257
14175
|
/**
|
|
13258
14176
|
* Filters for conversations with any of the provided tags.
|
|
13259
14177
|
* @deprecated
|
|
@@ -13475,6 +14393,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13475
14393
|
* @secure
|
|
13476
14394
|
*/
|
|
13477
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>>;
|
|
13478
14414
|
/**
|
|
13479
14415
|
* @description Gets the requested user's information.
|
|
13480
14416
|
*
|
|
@@ -14600,6 +15536,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14600
15536
|
* @secure
|
|
14601
15537
|
*/
|
|
14602
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>>;
|
|
14603
15566
|
/**
|
|
14604
15567
|
* @description Gets an organization schedule.
|
|
14605
15568
|
*
|
|
@@ -16150,6 +17113,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16150
17113
|
* @secure
|
|
16151
17114
|
*/
|
|
16152
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>>;
|
|
16153
17125
|
/**
|
|
16154
17126
|
* @description Lists system users within your organization.
|
|
16155
17127
|
*
|
|
@@ -16577,6 +17549,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16577
17549
|
* @secure
|
|
16578
17550
|
*/
|
|
16579
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>>;
|
|
16580
17561
|
/**
|
|
16581
17562
|
* @description Fetches an object via webhook.
|
|
16582
17563
|
*
|