@devrev/typescript-sdk 1.1.34 → 1.1.36
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.
|
|
@@ -322,7 +379,10 @@ export interface AddTagWithValue {
|
|
|
322
379
|
* aggregated-schema
|
|
323
380
|
* List of custom fields from multiple source fragments.
|
|
324
381
|
*/
|
|
325
|
-
export
|
|
382
|
+
export interface AggregatedSchema {
|
|
383
|
+
/** The stock field overrides. */
|
|
384
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
385
|
+
}
|
|
326
386
|
/** aggregated-schema-get-request */
|
|
327
387
|
export interface AggregatedSchemaGetRequest {
|
|
328
388
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
@@ -408,6 +468,79 @@ export declare enum AggregationDetailAggregationType {
|
|
|
408
468
|
Sum = "sum",
|
|
409
469
|
UniqueCount = "unique_count"
|
|
410
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
* airdrop-sync-units-get-request
|
|
473
|
+
* Request to get a sync unit.
|
|
474
|
+
*/
|
|
475
|
+
export interface AirdropSyncUnitsGetRequest {
|
|
476
|
+
/** Requested sync unit ID. */
|
|
477
|
+
id: string;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* airdrop-sync-units-get-response
|
|
481
|
+
* Response containing the requested sync unit.
|
|
482
|
+
*/
|
|
483
|
+
export interface AirdropSyncUnitsGetResponse {
|
|
484
|
+
sync_unit: SyncUnit;
|
|
485
|
+
}
|
|
486
|
+
/** airdrop-sync-units-history-filter */
|
|
487
|
+
export interface AirdropSyncUnitsHistoryFilter {
|
|
488
|
+
/** Provides ways to specify date ranges on objects. */
|
|
489
|
+
ended_at?: DateFilter;
|
|
490
|
+
/** Filter for sync runs that have errors. */
|
|
491
|
+
has_errors_or_warnings?: boolean;
|
|
492
|
+
/** Mode of the sync run. */
|
|
493
|
+
mode?: SyncRunMode[];
|
|
494
|
+
/** User who started the sync run. */
|
|
495
|
+
started_by?: SyncRunStartedBy[];
|
|
496
|
+
/** State of the sync run. */
|
|
497
|
+
state?: SyncRunProgressState[];
|
|
498
|
+
}
|
|
499
|
+
/**
|
|
500
|
+
* airdrop-sync-units-history-request
|
|
501
|
+
* Request to list sync unit history.
|
|
502
|
+
*/
|
|
503
|
+
export interface AirdropSyncUnitsHistoryRequest {
|
|
504
|
+
/**
|
|
505
|
+
* The cursor to resume iteration from. If not provided, then
|
|
506
|
+
* iteration starts from the beginning.
|
|
507
|
+
*/
|
|
508
|
+
cursor?: string;
|
|
509
|
+
filter?: AirdropSyncUnitsHistoryFilter;
|
|
510
|
+
/** Sync unit that will be used for sync history listing. */
|
|
511
|
+
id: string;
|
|
512
|
+
/**
|
|
513
|
+
* The maximum number of items to return. The default is '50'.
|
|
514
|
+
* @format int32
|
|
515
|
+
*/
|
|
516
|
+
limit?: number;
|
|
517
|
+
/**
|
|
518
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
519
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
520
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
521
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
522
|
+
* always be returned in the specified sort-by order.
|
|
523
|
+
*/
|
|
524
|
+
mode?: ListMode;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* airdrop-sync-units-history-response
|
|
528
|
+
* List sync history response.
|
|
529
|
+
*/
|
|
530
|
+
export interface AirdropSyncUnitsHistoryResponse {
|
|
531
|
+
/**
|
|
532
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
533
|
+
* sort order. If not set, then no later elements exist.
|
|
534
|
+
*/
|
|
535
|
+
next_cursor?: string;
|
|
536
|
+
/**
|
|
537
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
538
|
+
* sort order. If not set, then no prior elements exist.
|
|
539
|
+
*/
|
|
540
|
+
prev_cursor?: string;
|
|
541
|
+
/** Historical records of syncs. */
|
|
542
|
+
sync_history: SyncHistory[];
|
|
543
|
+
}
|
|
411
544
|
/** app-fragment */
|
|
412
545
|
export type AppFragment = CustomSchemaFragmentBase & {
|
|
413
546
|
/** App this fragment applies to. */
|
|
@@ -477,7 +610,7 @@ export interface ArchetypeMetricTarget {
|
|
|
477
610
|
}
|
|
478
611
|
/** article */
|
|
479
612
|
export type Article = AtomBase & {
|
|
480
|
-
/**
|
|
613
|
+
/** Parts relevant to the article. */
|
|
481
614
|
applies_to_parts: PartSummary[];
|
|
482
615
|
/** Type of the article. */
|
|
483
616
|
article_type?: ArticleType;
|
|
@@ -485,7 +618,7 @@ export type Article = AtomBase & {
|
|
|
485
618
|
authored_by?: UserSummary[];
|
|
486
619
|
/** Description of the article. */
|
|
487
620
|
description?: string;
|
|
488
|
-
/**
|
|
621
|
+
/** Extracted content of the article. */
|
|
489
622
|
extracted_content?: ArtifactSummary[];
|
|
490
623
|
/**
|
|
491
624
|
* Number of downvotes on the article.
|
|
@@ -497,7 +630,7 @@ export type Article = AtomBase & {
|
|
|
497
630
|
* @format int32
|
|
498
631
|
*/
|
|
499
632
|
num_upvotes?: number;
|
|
500
|
-
/**
|
|
633
|
+
/** Users that own the article. */
|
|
501
634
|
owned_by: UserSummary[];
|
|
502
635
|
parent?: DirectorySummary;
|
|
503
636
|
/** Rank of the article. */
|
|
@@ -568,10 +701,7 @@ export interface ArticlesCountRequest {
|
|
|
568
701
|
* @example ["DEVU-12345"]
|
|
569
702
|
*/
|
|
570
703
|
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
|
-
*/
|
|
704
|
+
/** Filter for the scope of the articles. */
|
|
575
705
|
scope?: number[];
|
|
576
706
|
/** Filter for articles based on intended audience. */
|
|
577
707
|
shared_with?: SharedWithMembershipFilter[];
|
|
@@ -590,6 +720,11 @@ export interface ArticlesCountResponse {
|
|
|
590
720
|
*/
|
|
591
721
|
export interface ArticlesCreateRequest {
|
|
592
722
|
access_level?: AccessLevel;
|
|
723
|
+
/**
|
|
724
|
+
* The aliases of the article.
|
|
725
|
+
* @maxItems 5
|
|
726
|
+
*/
|
|
727
|
+
aliases?: string[];
|
|
593
728
|
/**
|
|
594
729
|
* The parts that the article applies to.
|
|
595
730
|
* @minItems 1
|
|
@@ -657,6 +792,11 @@ export interface ArticlesCreateRequestResource {
|
|
|
657
792
|
* @example ["ARTIFACT-12345"]
|
|
658
793
|
*/
|
|
659
794
|
artifacts?: string[];
|
|
795
|
+
/**
|
|
796
|
+
* List of content blocks used in the article.
|
|
797
|
+
* @example ["ARTICLE-12345"]
|
|
798
|
+
*/
|
|
799
|
+
content_blocks?: string[];
|
|
660
800
|
/** The latest published version. */
|
|
661
801
|
published_version?: string;
|
|
662
802
|
/** URL of the external article. */
|
|
@@ -753,10 +893,7 @@ export interface ArticlesListRequest {
|
|
|
753
893
|
* @example ["DEVU-12345"]
|
|
754
894
|
*/
|
|
755
895
|
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
|
-
*/
|
|
896
|
+
/** Filter for the scope of the articles. */
|
|
760
897
|
scope?: number[];
|
|
761
898
|
/** Filter for articles based on intended audience. */
|
|
762
899
|
shared_with?: SharedWithMembershipFilter[];
|
|
@@ -790,9 +927,11 @@ export interface ArticlesListResponse {
|
|
|
790
927
|
*/
|
|
791
928
|
export interface ArticlesUpdateRequest {
|
|
792
929
|
access_level?: AccessLevel;
|
|
930
|
+
aliases?: ArticlesUpdateRequestAliases;
|
|
793
931
|
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
794
932
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
795
933
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
934
|
+
content_blocks?: ArticlesUpdateRequestContentBlocks;
|
|
796
935
|
/** Application-defined custom fields. */
|
|
797
936
|
custom_fields?: object;
|
|
798
937
|
/**
|
|
@@ -831,6 +970,14 @@ export interface ArticlesUpdateRequest {
|
|
|
831
970
|
/** Updates the URL of the external article. */
|
|
832
971
|
url?: string;
|
|
833
972
|
}
|
|
973
|
+
/** articles-update-request-aliases */
|
|
974
|
+
export interface ArticlesUpdateRequestAliases {
|
|
975
|
+
/**
|
|
976
|
+
* Updates the aliases of the article.
|
|
977
|
+
* @maxItems 5
|
|
978
|
+
*/
|
|
979
|
+
set: string[];
|
|
980
|
+
}
|
|
834
981
|
/** articles-update-request-applies-to-parts */
|
|
835
982
|
export interface ArticlesUpdateRequestAppliesToParts {
|
|
836
983
|
/**
|
|
@@ -855,6 +1002,14 @@ export interface ArticlesUpdateRequestAuthoredBy {
|
|
|
855
1002
|
*/
|
|
856
1003
|
set?: string[];
|
|
857
1004
|
}
|
|
1005
|
+
/** articles-update-request-content-blocks */
|
|
1006
|
+
export interface ArticlesUpdateRequestContentBlocks {
|
|
1007
|
+
/**
|
|
1008
|
+
* Updates IDs of the content blocks.
|
|
1009
|
+
* @example ["ARTICLE-12345"]
|
|
1010
|
+
*/
|
|
1011
|
+
set: string[];
|
|
1012
|
+
}
|
|
858
1013
|
/** articles-update-request-extracted-content */
|
|
859
1014
|
export interface ArticlesUpdateRequestExtractedContent {
|
|
860
1015
|
/**
|
|
@@ -1076,7 +1231,7 @@ export interface AtomBaseSummary {
|
|
|
1076
1231
|
id: string;
|
|
1077
1232
|
}
|
|
1078
1233
|
/** 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) & {
|
|
1234
|
+
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
1235
|
type: AtomType;
|
|
1081
1236
|
};
|
|
1082
1237
|
export declare enum AtomType {
|
|
@@ -1089,6 +1244,7 @@ export declare enum AtomType {
|
|
|
1089
1244
|
Engagement = "engagement",
|
|
1090
1245
|
Enhancement = "enhancement",
|
|
1091
1246
|
Feature = "feature",
|
|
1247
|
+
Incident = "incident",
|
|
1092
1248
|
Issue = "issue",
|
|
1093
1249
|
Meeting = "meeting",
|
|
1094
1250
|
Opportunity = "opportunity",
|
|
@@ -1111,7 +1267,7 @@ export declare enum AtomType {
|
|
|
1111
1267
|
* Connection object that specifies the configuration for an
|
|
1112
1268
|
* authentication connection that is set up for a Dev organization.
|
|
1113
1269
|
*/
|
|
1114
|
-
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1270
|
+
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsOkta | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1115
1271
|
/**
|
|
1116
1272
|
* Defines the type for the authentication connection. The configuration
|
|
1117
1273
|
* for each authentication connection will depend on the type value.
|
|
@@ -1123,13 +1279,13 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1123
1279
|
* organization. For example, if the display_name is 'abclogin', then
|
|
1124
1280
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
1125
1281
|
*/
|
|
1126
|
-
display_name
|
|
1282
|
+
display_name: string;
|
|
1127
1283
|
/**
|
|
1128
1284
|
* Whether the authentication connection is enabled or disabled. If
|
|
1129
1285
|
* set to false, the authentication connection will not show up on the
|
|
1130
1286
|
* login screen as a login option.
|
|
1131
1287
|
*/
|
|
1132
|
-
enabled
|
|
1288
|
+
enabled: boolean;
|
|
1133
1289
|
/** ID of the authentication connection. */
|
|
1134
1290
|
id: string;
|
|
1135
1291
|
};
|
|
@@ -1137,27 +1293,25 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1137
1293
|
* auth-connection-options-azure-ad
|
|
1138
1294
|
* Object encapsulating the configuration parameters for an Azure AD
|
|
1139
1295
|
* authentication connection.
|
|
1296
|
+
* @deprecated
|
|
1140
1297
|
*/
|
|
1141
1298
|
export interface AuthConnectionOptionsAzureAd {
|
|
1142
1299
|
/** Client ID for the Azure authentication connection. */
|
|
1143
|
-
client_id
|
|
1144
|
-
/** Client secret for the Azure authentication connection. */
|
|
1145
|
-
client_secret?: string;
|
|
1300
|
+
client_id: string;
|
|
1146
1301
|
/** Domain URL of the Azure authentication connection. */
|
|
1147
|
-
domain
|
|
1302
|
+
domain: string;
|
|
1148
1303
|
}
|
|
1149
1304
|
/**
|
|
1150
1305
|
* auth-connection-options-google-apps
|
|
1151
1306
|
* Object encapsulating the configuration parameters for a Google Apps
|
|
1152
1307
|
* authentication connection.
|
|
1308
|
+
* @deprecated
|
|
1153
1309
|
*/
|
|
1154
1310
|
export interface AuthConnectionOptionsGoogleApps {
|
|
1155
1311
|
/** Client ID for the Google Apps authentication connection. */
|
|
1156
|
-
client_id
|
|
1157
|
-
/** Client secret for the Google Apps authentication connection. */
|
|
1158
|
-
client_secret?: string;
|
|
1312
|
+
client_id: string;
|
|
1159
1313
|
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
1160
|
-
tenant_domain
|
|
1314
|
+
tenant_domain: string;
|
|
1161
1315
|
}
|
|
1162
1316
|
/**
|
|
1163
1317
|
* auth-connection-options-oidc
|
|
@@ -1166,11 +1320,21 @@ export interface AuthConnectionOptionsGoogleApps {
|
|
|
1166
1320
|
*/
|
|
1167
1321
|
export interface AuthConnectionOptionsOidc {
|
|
1168
1322
|
/** Client ID for the OIDC authentication connection. */
|
|
1169
|
-
client_id
|
|
1170
|
-
/** Client secret for the OIDC authentication connection. */
|
|
1171
|
-
client_secret?: string;
|
|
1323
|
+
client_id: string;
|
|
1172
1324
|
/** Issuer URL of the OIDC authentication connection. */
|
|
1173
|
-
issuer
|
|
1325
|
+
issuer: string;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* auth-connection-options-okta
|
|
1329
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
1330
|
+
* authentication connection.
|
|
1331
|
+
* @deprecated
|
|
1332
|
+
*/
|
|
1333
|
+
export interface AuthConnectionOptionsOkta {
|
|
1334
|
+
/** Client ID for the Okta authentication connection. */
|
|
1335
|
+
client_id: string;
|
|
1336
|
+
/** Domain URL of the Okta authentication connection. */
|
|
1337
|
+
domain: string;
|
|
1174
1338
|
}
|
|
1175
1339
|
/**
|
|
1176
1340
|
* auth-connection-options-saml
|
|
@@ -1178,10 +1342,15 @@ export interface AuthConnectionOptionsOidc {
|
|
|
1178
1342
|
* authentication connection.
|
|
1179
1343
|
*/
|
|
1180
1344
|
export interface AuthConnectionOptionsSaml {
|
|
1345
|
+
/**
|
|
1346
|
+
* Connection name for the SAML authentication connection.
|
|
1347
|
+
* @minLength 1
|
|
1348
|
+
* @maxLength 128
|
|
1349
|
+
*/
|
|
1350
|
+
connection_name?: string;
|
|
1351
|
+
fields_map: SamlConnectionFieldsMap;
|
|
1181
1352
|
/** Sign In endpoint for the SAML authentication connection. */
|
|
1182
|
-
sign_in_endpoint
|
|
1183
|
-
/** Signing certificate for the SAML authentication connection. */
|
|
1184
|
-
signing_cert?: string;
|
|
1353
|
+
sign_in_endpoint: string;
|
|
1185
1354
|
}
|
|
1186
1355
|
/** auth-connection-options-social */
|
|
1187
1356
|
export type AuthConnectionOptionsSocial = object;
|
|
@@ -1196,6 +1365,7 @@ export declare enum AuthConnectionToggle {
|
|
|
1196
1365
|
export declare enum AuthConnectionType {
|
|
1197
1366
|
GoogleApps = "google_apps",
|
|
1198
1367
|
Oidc = "oidc",
|
|
1368
|
+
Okta = "okta",
|
|
1199
1369
|
Samlp = "samlp",
|
|
1200
1370
|
Social = "social",
|
|
1201
1371
|
Waad = "waad"
|
|
@@ -2053,6 +2223,16 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
2053
2223
|
*/
|
|
2054
2224
|
export interface ConversationsCreateRequest {
|
|
2055
2225
|
type: ConversationsCreateRequestTypeValue;
|
|
2226
|
+
/** Application-defined custom fields. */
|
|
2227
|
+
custom_fields?: object;
|
|
2228
|
+
/**
|
|
2229
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2230
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2231
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2232
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2233
|
+
* specifier, it remains unmodified.
|
|
2234
|
+
*/
|
|
2235
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2056
2236
|
/** Description for the conversation. */
|
|
2057
2237
|
description?: string;
|
|
2058
2238
|
/** The group that the conversation is associated with. */
|
|
@@ -2124,6 +2304,8 @@ export interface ConversationsExportRequest {
|
|
|
2124
2304
|
* @example ["PROD-12345"]
|
|
2125
2305
|
*/
|
|
2126
2306
|
applies_to_parts?: string[];
|
|
2307
|
+
/** Filters for custom fields. */
|
|
2308
|
+
custom_fields?: object;
|
|
2127
2309
|
/**
|
|
2128
2310
|
* The number of conversation items to return. The default is '50',
|
|
2129
2311
|
* the maximum is '5000'.
|
|
@@ -2149,15 +2331,29 @@ export interface ConversationsExportRequest {
|
|
|
2149
2331
|
/**
|
|
2150
2332
|
* Filters for conversations that are associated with any of the
|
|
2151
2333
|
* provided Rev organizations.
|
|
2334
|
+
* @deprecated
|
|
2152
2335
|
* @example ["REV-AbCdEfGh"]
|
|
2153
2336
|
*/
|
|
2154
2337
|
rev_org?: string[];
|
|
2338
|
+
/**
|
|
2339
|
+
* Filters for conversations that are associated with any of the
|
|
2340
|
+
* provided Rev organizations.
|
|
2341
|
+
* @example ["REV-AbCdEfGh"]
|
|
2342
|
+
*/
|
|
2343
|
+
rev_orgs?: string[];
|
|
2155
2344
|
/** The filter for SLA summary. */
|
|
2156
2345
|
sla_summary?: SlaSummaryFilter;
|
|
2157
2346
|
/** Filters for conversations with any of the provided source channels. */
|
|
2347
|
+
source_channel?: string[];
|
|
2348
|
+
/**
|
|
2349
|
+
* Filters for conversations with any of the provided source channels.
|
|
2350
|
+
* @deprecated
|
|
2351
|
+
*/
|
|
2158
2352
|
source_channels?: string[];
|
|
2159
2353
|
/** The filter for stages. */
|
|
2160
2354
|
stage?: StageFilter;
|
|
2355
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2356
|
+
subtype?: string[];
|
|
2161
2357
|
/**
|
|
2162
2358
|
* Filters for conversations with any of the provided tags.
|
|
2163
2359
|
* @deprecated
|
|
@@ -2202,6 +2398,8 @@ export interface ConversationsListRequest {
|
|
|
2202
2398
|
* iteration starts from the beginning.
|
|
2203
2399
|
*/
|
|
2204
2400
|
cursor?: string;
|
|
2401
|
+
/** Filters for custom fields. */
|
|
2402
|
+
custom_fields?: object;
|
|
2205
2403
|
/** Filters for conversation that belong to the given groups. */
|
|
2206
2404
|
group?: string[];
|
|
2207
2405
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -2234,15 +2432,29 @@ export interface ConversationsListRequest {
|
|
|
2234
2432
|
/**
|
|
2235
2433
|
* Filters for conversations that are associated with any of the
|
|
2236
2434
|
* provided Rev organizations.
|
|
2435
|
+
* @deprecated
|
|
2237
2436
|
* @example ["REV-AbCdEfGh"]
|
|
2238
2437
|
*/
|
|
2239
2438
|
rev_org?: string[];
|
|
2439
|
+
/**
|
|
2440
|
+
* Filters for conversations that are associated with any of the
|
|
2441
|
+
* provided Rev organizations.
|
|
2442
|
+
* @example ["REV-AbCdEfGh"]
|
|
2443
|
+
*/
|
|
2444
|
+
rev_orgs?: string[];
|
|
2240
2445
|
/** The filter for SLA summary. */
|
|
2241
2446
|
sla_summary?: SlaSummaryFilter;
|
|
2242
2447
|
/** Filters for conversations with any of the provided source channels. */
|
|
2448
|
+
source_channel?: string[];
|
|
2449
|
+
/**
|
|
2450
|
+
* Filters for conversations with any of the provided source channels.
|
|
2451
|
+
* @deprecated
|
|
2452
|
+
*/
|
|
2243
2453
|
source_channels?: string[];
|
|
2244
2454
|
/** The filter for stages. */
|
|
2245
2455
|
stage?: StageFilter;
|
|
2456
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
2457
|
+
subtype?: string[];
|
|
2246
2458
|
/**
|
|
2247
2459
|
* Filters for conversations with any of the provided tags.
|
|
2248
2460
|
* @deprecated
|
|
@@ -2276,6 +2488,16 @@ export interface ConversationsListResponse {
|
|
|
2276
2488
|
*/
|
|
2277
2489
|
export interface ConversationsUpdateRequest {
|
|
2278
2490
|
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
2491
|
+
/** Application-defined custom fields. */
|
|
2492
|
+
custom_fields?: object;
|
|
2493
|
+
/**
|
|
2494
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2495
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2496
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2497
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2498
|
+
* specifier, it remains unmodified.
|
|
2499
|
+
*/
|
|
2500
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2279
2501
|
/** The updated description for the conversation. */
|
|
2280
2502
|
description?: string;
|
|
2281
2503
|
/** The group that the conversation is associated with. */
|
|
@@ -2861,6 +3083,8 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2861
3083
|
/** custom-schema-fragments-set-request */
|
|
2862
3084
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2863
3085
|
type: CustomSchemaFragmentsSetRequestType;
|
|
3086
|
+
/** List of all composite schemas used in this fragment. */
|
|
3087
|
+
composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
|
|
2864
3088
|
/** List of conditions for this fragment. */
|
|
2865
3089
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2866
3090
|
/** List of field names which are being dropped. */
|
|
@@ -2881,6 +3105,15 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
2881
3105
|
/** The app this fragment applies to. */
|
|
2882
3106
|
app: string;
|
|
2883
3107
|
}
|
|
3108
|
+
/** custom-schema-fragments-set-request-composite-schema */
|
|
3109
|
+
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
3110
|
+
/** Description of this composite type. */
|
|
3111
|
+
description?: string;
|
|
3112
|
+
/** List of fields in this composite type. */
|
|
3113
|
+
fields: SchemaFieldDescriptor[];
|
|
3114
|
+
/** The name of this composite type. */
|
|
3115
|
+
name?: string;
|
|
3116
|
+
}
|
|
2884
3117
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
2885
3118
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
2886
3119
|
/**
|
|
@@ -3121,6 +3354,8 @@ export interface CustomStatesUpdateResponse {
|
|
|
3121
3354
|
/** custom-type-fragment */
|
|
3122
3355
|
export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
3123
3356
|
stage_diagram?: StageDiagramSummary;
|
|
3357
|
+
/** The stock field overrides. */
|
|
3358
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
3124
3359
|
/** The string used to populate the subtype in the leaf type. */
|
|
3125
3360
|
subtype?: string;
|
|
3126
3361
|
/**
|
|
@@ -3205,6 +3440,12 @@ export declare enum DateTimePresetType {
|
|
|
3205
3440
|
LastNDays = "last_n_days",
|
|
3206
3441
|
NextNDays = "next_n_days"
|
|
3207
3442
|
}
|
|
3443
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
3444
|
+
export declare enum Definedness {
|
|
3445
|
+
Immutable = "immutable",
|
|
3446
|
+
Mutable = "mutable",
|
|
3447
|
+
Undefined = "undefined"
|
|
3448
|
+
}
|
|
3208
3449
|
/**
|
|
3209
3450
|
* delete-rev-users-personal-data-request
|
|
3210
3451
|
* Request object to delete a contact's information.
|
|
@@ -3215,7 +3456,7 @@ export interface DeleteRevUsersPersonalDataRequest {
|
|
|
3215
3456
|
}
|
|
3216
3457
|
/**
|
|
3217
3458
|
* delete-rev-users-personal-data-response
|
|
3218
|
-
* Response for the contacts personal data
|
|
3459
|
+
* Response for the contacts personal data delete request. Response is
|
|
3219
3460
|
* empty as the process is asynchronous. Upon completion, the user will be
|
|
3220
3461
|
* notified.
|
|
3221
3462
|
*/
|
|
@@ -3224,7 +3465,7 @@ export type DeleteRevUsersPersonalDataResponse = object;
|
|
|
3224
3465
|
* dev-org-auth-connections-create-request
|
|
3225
3466
|
* Request to create a new enterprise authentication connection.
|
|
3226
3467
|
*/
|
|
3227
|
-
export type DevOrgAuthConnectionsCreateRequest = (
|
|
3468
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
3228
3469
|
/**
|
|
3229
3470
|
* Defines the type for the authentication connection. Different types of
|
|
3230
3471
|
* authentication connections have different configuration parameters.
|
|
@@ -3235,9 +3476,84 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3235
3476
|
* visible to all the users when they sign in to this Dev
|
|
3236
3477
|
* organization. For example, if the display_name is 'abclogin', then
|
|
3237
3478
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
3479
|
+
* @minLength 1
|
|
3480
|
+
* @maxLength 128
|
|
3238
3481
|
*/
|
|
3239
3482
|
display_name?: string;
|
|
3240
3483
|
};
|
|
3484
|
+
/**
|
|
3485
|
+
* dev-org-auth-connections-create-request-azure-ad-options
|
|
3486
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
3487
|
+
* authentication connection.
|
|
3488
|
+
* @deprecated
|
|
3489
|
+
*/
|
|
3490
|
+
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
3491
|
+
/** Client ID for the Azure authentication connection. */
|
|
3492
|
+
client_id: string;
|
|
3493
|
+
/** Client secret for the Azure authentication connection. */
|
|
3494
|
+
client_secret: string;
|
|
3495
|
+
/** Domain URL of the Azure authentication connection. */
|
|
3496
|
+
domain: string;
|
|
3497
|
+
}
|
|
3498
|
+
/**
|
|
3499
|
+
* dev-org-auth-connections-create-request-google-apps-options
|
|
3500
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
3501
|
+
* authentication connection.
|
|
3502
|
+
* @deprecated
|
|
3503
|
+
*/
|
|
3504
|
+
export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
|
|
3505
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
3506
|
+
client_id: string;
|
|
3507
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
3508
|
+
client_secret: string;
|
|
3509
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
3510
|
+
tenant_domain: string;
|
|
3511
|
+
}
|
|
3512
|
+
/**
|
|
3513
|
+
* dev-org-auth-connections-create-request-oidc-options
|
|
3514
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
3515
|
+
* authentication connection.
|
|
3516
|
+
*/
|
|
3517
|
+
export interface DevOrgAuthConnectionsCreateRequestOidcOptions {
|
|
3518
|
+
/** Client ID for the OIDC authentication connection. */
|
|
3519
|
+
client_id: string;
|
|
3520
|
+
/** Client secret for the OIDC authentication connection. */
|
|
3521
|
+
client_secret: string;
|
|
3522
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
3523
|
+
issuer: string;
|
|
3524
|
+
}
|
|
3525
|
+
/**
|
|
3526
|
+
* dev-org-auth-connections-create-request-okta-options
|
|
3527
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
3528
|
+
* authentication connection.
|
|
3529
|
+
* @deprecated
|
|
3530
|
+
*/
|
|
3531
|
+
export interface DevOrgAuthConnectionsCreateRequestOktaOptions {
|
|
3532
|
+
/** Client ID for the Okta authentication connection. */
|
|
3533
|
+
client_id: string;
|
|
3534
|
+
/** Client secret for the Okta authentication connection. */
|
|
3535
|
+
client_secret: string;
|
|
3536
|
+
/** Domain URL of the Okta authentication connection. */
|
|
3537
|
+
domain: string;
|
|
3538
|
+
}
|
|
3539
|
+
/**
|
|
3540
|
+
* dev-org-auth-connections-create-request-saml-options
|
|
3541
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
3542
|
+
* authentication connection.
|
|
3543
|
+
*/
|
|
3544
|
+
export interface DevOrgAuthConnectionsCreateRequestSamlOptions {
|
|
3545
|
+
/**
|
|
3546
|
+
* Connection name for the SAML authentication connection.
|
|
3547
|
+
* @minLength 1
|
|
3548
|
+
* @maxLength 128
|
|
3549
|
+
*/
|
|
3550
|
+
connection_name?: string;
|
|
3551
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
3552
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
3553
|
+
sign_in_endpoint: string;
|
|
3554
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
3555
|
+
signing_cert: string;
|
|
3556
|
+
}
|
|
3241
3557
|
/**
|
|
3242
3558
|
* Defines the type for the authentication connection. Different types of
|
|
3243
3559
|
* authentication connections have different configuration parameters.
|
|
@@ -3245,6 +3561,7 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3245
3561
|
export declare enum DevOrgAuthConnectionsCreateRequestType {
|
|
3246
3562
|
GoogleApps = "google_apps",
|
|
3247
3563
|
Oidc = "oidc",
|
|
3564
|
+
Okta = "okta",
|
|
3248
3565
|
Samlp = "samlp",
|
|
3249
3566
|
Waad = "waad"
|
|
3250
3567
|
}
|
|
@@ -3318,7 +3635,7 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
3318
3635
|
* Request to update an enterprise authentication connection for a Dev
|
|
3319
3636
|
* organization.
|
|
3320
3637
|
*/
|
|
3321
|
-
export type DevOrgAuthConnectionsUpdateRequest = (
|
|
3638
|
+
export type DevOrgAuthConnectionsUpdateRequest = (DevOrgAuthConnectionsUpdateRequestAzureAdOptions | DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions | DevOrgAuthConnectionsUpdateRequestOidcOptions | DevOrgAuthConnectionsUpdateRequestOktaOptions | DevOrgAuthConnectionsUpdateRequestSamlOptions | Empty) & {
|
|
3322
3639
|
/**
|
|
3323
3640
|
* Specifies the type for the authentication connection. Different types
|
|
3324
3641
|
* of authentication connections have different configuration parameters
|
|
@@ -3335,6 +3652,72 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
3335
3652
|
/** ID of the authentication connection which is to be updated. */
|
|
3336
3653
|
id: string;
|
|
3337
3654
|
};
|
|
3655
|
+
/**
|
|
3656
|
+
* dev-org-auth-connections-update-request-azure-ad-options
|
|
3657
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
3658
|
+
* authentication connection.
|
|
3659
|
+
* @deprecated
|
|
3660
|
+
*/
|
|
3661
|
+
export interface DevOrgAuthConnectionsUpdateRequestAzureAdOptions {
|
|
3662
|
+
/** Client ID for the Azure authentication connection. */
|
|
3663
|
+
client_id?: string;
|
|
3664
|
+
/** Client secret for the Azure authentication connection. */
|
|
3665
|
+
client_secret?: string;
|
|
3666
|
+
/** Domain URL of the Azure authentication connection. */
|
|
3667
|
+
domain?: string;
|
|
3668
|
+
}
|
|
3669
|
+
/**
|
|
3670
|
+
* dev-org-auth-connections-update-request-google-apps-options
|
|
3671
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
3672
|
+
* authentication connection.
|
|
3673
|
+
* @deprecated
|
|
3674
|
+
*/
|
|
3675
|
+
export interface DevOrgAuthConnectionsUpdateRequestGoogleAppsOptions {
|
|
3676
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
3677
|
+
client_id?: string;
|
|
3678
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
3679
|
+
client_secret?: string;
|
|
3680
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
3681
|
+
tenant_domain?: string;
|
|
3682
|
+
}
|
|
3683
|
+
/**
|
|
3684
|
+
* dev-org-auth-connections-update-request-oidc-options
|
|
3685
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
3686
|
+
* authentication connection.
|
|
3687
|
+
*/
|
|
3688
|
+
export interface DevOrgAuthConnectionsUpdateRequestOidcOptions {
|
|
3689
|
+
/** Client ID for the OIDC authentication connection. */
|
|
3690
|
+
client_id?: string;
|
|
3691
|
+
/** Client secret for the OIDC authentication connection. */
|
|
3692
|
+
client_secret?: string;
|
|
3693
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
3694
|
+
issuer?: string;
|
|
3695
|
+
}
|
|
3696
|
+
/**
|
|
3697
|
+
* dev-org-auth-connections-update-request-okta-options
|
|
3698
|
+
* Object encapsulating the configuration parameters for an Okta
|
|
3699
|
+
* authentication connection.
|
|
3700
|
+
*/
|
|
3701
|
+
export interface DevOrgAuthConnectionsUpdateRequestOktaOptions {
|
|
3702
|
+
/** Client ID for the Okta authentication connection. */
|
|
3703
|
+
client_id?: string;
|
|
3704
|
+
/** Client secret for the Okta authentication connection. */
|
|
3705
|
+
client_secret?: string;
|
|
3706
|
+
/** Domain URL of the Okta authentication connection. */
|
|
3707
|
+
domain?: string;
|
|
3708
|
+
}
|
|
3709
|
+
/**
|
|
3710
|
+
* dev-org-auth-connections-update-request-saml-options
|
|
3711
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
3712
|
+
* authentication connection.
|
|
3713
|
+
*/
|
|
3714
|
+
export interface DevOrgAuthConnectionsUpdateRequestSamlOptions {
|
|
3715
|
+
fields_map?: SamlConnectionFieldsMap;
|
|
3716
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
3717
|
+
sign_in_endpoint?: string;
|
|
3718
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
3719
|
+
signing_cert?: string;
|
|
3720
|
+
}
|
|
3338
3721
|
/**
|
|
3339
3722
|
* Specifies the type for the authentication connection. Different types
|
|
3340
3723
|
* of authentication connections have different configuration parameters
|
|
@@ -3344,6 +3727,7 @@ export declare enum DevOrgAuthConnectionsUpdateRequestType {
|
|
|
3344
3727
|
GoogleApps = "google_apps",
|
|
3345
3728
|
None = "none",
|
|
3346
3729
|
Oidc = "oidc",
|
|
3730
|
+
Okta = "okta",
|
|
3347
3731
|
Samlp = "samlp",
|
|
3348
3732
|
Waad = "waad"
|
|
3349
3733
|
}
|
|
@@ -3412,6 +3796,37 @@ export declare enum DevUserJobTitle {
|
|
|
3412
3796
|
}
|
|
3413
3797
|
/** dev-user-summary */
|
|
3414
3798
|
export type DevUserSummary = UserBaseSummary;
|
|
3799
|
+
/**
|
|
3800
|
+
* dev-users-activate-request
|
|
3801
|
+
* A request to activate the Dev user.
|
|
3802
|
+
*/
|
|
3803
|
+
export interface DevUsersActivateRequest {
|
|
3804
|
+
/** IDs of the groups assigned to user during activation. */
|
|
3805
|
+
groups?: string[];
|
|
3806
|
+
/** The ID for the Dev User. */
|
|
3807
|
+
id: string;
|
|
3808
|
+
}
|
|
3809
|
+
/**
|
|
3810
|
+
* dev-users-activate-response
|
|
3811
|
+
* The response to activate the Dev user.
|
|
3812
|
+
*/
|
|
3813
|
+
export interface DevUsersActivateResponse {
|
|
3814
|
+
/** Whether an invitation has been sent to the Dev user. */
|
|
3815
|
+
invite_sent: boolean;
|
|
3816
|
+
}
|
|
3817
|
+
/**
|
|
3818
|
+
* dev-users-deactivate-request
|
|
3819
|
+
* A request to deactivate the Dev user.
|
|
3820
|
+
*/
|
|
3821
|
+
export interface DevUsersDeactivateRequest {
|
|
3822
|
+
/** The ID for the Dev User. */
|
|
3823
|
+
id: string;
|
|
3824
|
+
}
|
|
3825
|
+
/**
|
|
3826
|
+
* dev-users-deactivate-response
|
|
3827
|
+
* The response to deactivate the Dev user.
|
|
3828
|
+
*/
|
|
3829
|
+
export type DevUsersDeactivateResponse = object;
|
|
3415
3830
|
/**
|
|
3416
3831
|
* dev-users-get-request
|
|
3417
3832
|
* A request to get a Dev user's information.
|
|
@@ -4136,6 +4551,24 @@ export interface EnumValue {
|
|
|
4136
4551
|
*/
|
|
4137
4552
|
ordinal: number;
|
|
4138
4553
|
}
|
|
4554
|
+
/**
|
|
4555
|
+
* enum-value-summary
|
|
4556
|
+
* The properties of an enum value.
|
|
4557
|
+
*/
|
|
4558
|
+
export interface EnumValueSummary {
|
|
4559
|
+
/**
|
|
4560
|
+
* The unique ID of the enum value.
|
|
4561
|
+
* @format int64
|
|
4562
|
+
*/
|
|
4563
|
+
id: number;
|
|
4564
|
+
/** The display label of the enum value. */
|
|
4565
|
+
label: string;
|
|
4566
|
+
/**
|
|
4567
|
+
* Used for determining the relative order of the enum value.
|
|
4568
|
+
* @format int64
|
|
4569
|
+
*/
|
|
4570
|
+
ordinal: number;
|
|
4571
|
+
}
|
|
4139
4572
|
/** error */
|
|
4140
4573
|
export interface Error {
|
|
4141
4574
|
/** The error type. */
|
|
@@ -4477,6 +4910,21 @@ export interface EventGroupUpdated {
|
|
|
4477
4910
|
group: Group;
|
|
4478
4911
|
old_group?: Group;
|
|
4479
4912
|
}
|
|
4913
|
+
/** event-incident-created */
|
|
4914
|
+
export interface EventIncidentCreated {
|
|
4915
|
+
incident: Incident;
|
|
4916
|
+
}
|
|
4917
|
+
/** event-incident-deleted */
|
|
4918
|
+
export interface EventIncidentDeleted {
|
|
4919
|
+
/** The ID of the incident that was deleted. */
|
|
4920
|
+
id: string;
|
|
4921
|
+
old_incident?: Incident;
|
|
4922
|
+
}
|
|
4923
|
+
/** event-incident-updated */
|
|
4924
|
+
export interface EventIncidentUpdated {
|
|
4925
|
+
incident: Incident;
|
|
4926
|
+
old_incident?: Incident;
|
|
4927
|
+
}
|
|
4480
4928
|
/** event-link-created */
|
|
4481
4929
|
export interface EventLinkCreated {
|
|
4482
4930
|
link: Link;
|
|
@@ -4680,6 +5128,20 @@ export interface EventSurveyUpdated {
|
|
|
4680
5128
|
old_survey?: Survey;
|
|
4681
5129
|
survey: Survey;
|
|
4682
5130
|
}
|
|
5131
|
+
/** event-sync-history-created */
|
|
5132
|
+
export interface EventSyncHistoryCreated {
|
|
5133
|
+
sync_history: SyncHistory;
|
|
5134
|
+
}
|
|
5135
|
+
/** event-sync-history-deleted */
|
|
5136
|
+
export interface EventSyncHistoryDeleted {
|
|
5137
|
+
/** The ID of the sync history that was deleted. */
|
|
5138
|
+
id: string;
|
|
5139
|
+
}
|
|
5140
|
+
/** event-sync-history-updated */
|
|
5141
|
+
export interface EventSyncHistoryUpdated {
|
|
5142
|
+
old_sync_history?: SyncHistory;
|
|
5143
|
+
sync_history: SyncHistory;
|
|
5144
|
+
}
|
|
4683
5145
|
/** event-tag-created */
|
|
4684
5146
|
export interface EventTagCreated {
|
|
4685
5147
|
tag: Tag;
|
|
@@ -4709,10 +5171,12 @@ export interface EventTimelineEntryDeleted {
|
|
|
4709
5171
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
4710
5172
|
*/
|
|
4711
5173
|
id: string;
|
|
5174
|
+
old_entry?: TimelineEntry;
|
|
4712
5175
|
}
|
|
4713
5176
|
/** event-timeline-entry-updated */
|
|
4714
5177
|
export interface EventTimelineEntryUpdated {
|
|
4715
5178
|
entry: TimelineEntry;
|
|
5179
|
+
old_entry?: TimelineEntry;
|
|
4716
5180
|
}
|
|
4717
5181
|
/** event-webhook-created */
|
|
4718
5182
|
export interface EventWebhookCreated {
|
|
@@ -4799,6 +5263,19 @@ export interface ExternalIdentity {
|
|
|
4799
5263
|
/** Issuer of the external identity of the user. */
|
|
4800
5264
|
issuer?: string;
|
|
4801
5265
|
}
|
|
5266
|
+
export declare enum ExternalSystemType {
|
|
5267
|
+
Adaas = "adaas",
|
|
5268
|
+
Confluence = "confluence",
|
|
5269
|
+
Github = "github",
|
|
5270
|
+
Hubspot = "hubspot",
|
|
5271
|
+
Jira = "jira",
|
|
5272
|
+
Linear = "linear",
|
|
5273
|
+
Rocketlane = "rocketlane",
|
|
5274
|
+
SalesforceSales = "salesforce_sales",
|
|
5275
|
+
SalesforceService = "salesforce_service",
|
|
5276
|
+
Servicenow = "servicenow",
|
|
5277
|
+
Zendesk = "zendesk"
|
|
5278
|
+
}
|
|
4802
5279
|
/** feature */
|
|
4803
5280
|
export type Feature = PartBase;
|
|
4804
5281
|
/** feature-summary */
|
|
@@ -5314,6 +5791,17 @@ export type Incident = AtomBase & {
|
|
|
5314
5791
|
/** Title of the incident. */
|
|
5315
5792
|
title: string;
|
|
5316
5793
|
};
|
|
5794
|
+
/** incident-summary */
|
|
5795
|
+
export type IncidentSummary = AtomBaseSummary & {
|
|
5796
|
+
/** The users that own the incident. */
|
|
5797
|
+
owned_by?: UserSummary[];
|
|
5798
|
+
/** The properties of an enum value. */
|
|
5799
|
+
severity?: EnumValueSummary;
|
|
5800
|
+
/** Describes the current stage of a object. */
|
|
5801
|
+
stage?: StageSummary;
|
|
5802
|
+
/** Title of the incident. */
|
|
5803
|
+
title: string;
|
|
5804
|
+
};
|
|
5317
5805
|
/** incidents-create-request */
|
|
5318
5806
|
export interface IncidentsCreateRequest {
|
|
5319
5807
|
/**
|
|
@@ -5700,6 +6188,27 @@ export interface IncidentsUpdateRequest {
|
|
|
5700
6188
|
export interface IncidentsUpdateResponse {
|
|
5701
6189
|
incident: Incident;
|
|
5702
6190
|
}
|
|
6191
|
+
/** instant-evaluation */
|
|
6192
|
+
export interface InstantEvaluation {
|
|
6193
|
+
/**
|
|
6194
|
+
* The time instant evaluated.
|
|
6195
|
+
* @format date-time
|
|
6196
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6197
|
+
*/
|
|
6198
|
+
at: string;
|
|
6199
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
6200
|
+
definedness: Definedness;
|
|
6201
|
+
/** Active state of the organization schedule at the time instant. */
|
|
6202
|
+
is_active?: boolean;
|
|
6203
|
+
/**
|
|
6204
|
+
* Next instant at which the active state of the organization schedule
|
|
6205
|
+
* changes, for example, if the schedule is currently off, the next
|
|
6206
|
+
* instant at which it will be on.
|
|
6207
|
+
* @format date-time
|
|
6208
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6209
|
+
*/
|
|
6210
|
+
next_transition?: string;
|
|
6211
|
+
}
|
|
5703
6212
|
/** issue */
|
|
5704
6213
|
export type Issue = WorkBase & {
|
|
5705
6214
|
/**
|
|
@@ -5834,7 +6343,7 @@ export interface LinkDescriptorFilter {
|
|
|
5834
6343
|
link_descriptors: LinkTargetDescriptor[];
|
|
5835
6344
|
}
|
|
5836
6345
|
/** link-endpoint-summary */
|
|
5837
|
-
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
6346
|
+
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary) & {
|
|
5838
6347
|
type: LinkEndpointType;
|
|
5839
6348
|
};
|
|
5840
6349
|
export declare enum LinkEndpointType {
|
|
@@ -5844,6 +6353,7 @@ export declare enum LinkEndpointType {
|
|
|
5844
6353
|
DevUser = "dev_user",
|
|
5845
6354
|
Enhancement = "enhancement",
|
|
5846
6355
|
Feature = "feature",
|
|
6356
|
+
Incident = "incident",
|
|
5847
6357
|
Issue = "issue",
|
|
5848
6358
|
Opportunity = "opportunity",
|
|
5849
6359
|
Product = "product",
|
|
@@ -6051,8 +6561,324 @@ export declare enum ListMode {
|
|
|
6051
6561
|
After = "after",
|
|
6052
6562
|
Before = "before"
|
|
6053
6563
|
}
|
|
6564
|
+
/** meeting */
|
|
6565
|
+
export type Meeting = AtomBase & {
|
|
6566
|
+
/** The artifacts attached to the meeting. */
|
|
6567
|
+
artifacts?: ArtifactSummary[];
|
|
6568
|
+
/** The channel of meeting. */
|
|
6569
|
+
channel?: MeetingChannel;
|
|
6570
|
+
/** Custom fields. */
|
|
6571
|
+
custom_fields?: object;
|
|
6572
|
+
/**
|
|
6573
|
+
* Custom schema fragments.
|
|
6574
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6575
|
+
*/
|
|
6576
|
+
custom_schema_fragments?: string[];
|
|
6577
|
+
/** Description of the meeting. */
|
|
6578
|
+
description?: string;
|
|
6579
|
+
/**
|
|
6580
|
+
* Time at which meeting ended.
|
|
6581
|
+
* @format date-time
|
|
6582
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6583
|
+
*/
|
|
6584
|
+
ended_date?: string;
|
|
6585
|
+
/**
|
|
6586
|
+
* External reference of the meeting. This is the identifier from the
|
|
6587
|
+
* meeting channel/provider.
|
|
6588
|
+
*/
|
|
6589
|
+
external_ref?: string;
|
|
6590
|
+
/** External URL associated with the meeting. */
|
|
6591
|
+
external_url?: string;
|
|
6592
|
+
/** The members in the meeting. */
|
|
6593
|
+
members: UserSummary[];
|
|
6594
|
+
organizer?: UserSummary;
|
|
6595
|
+
parent?: AtomSummary;
|
|
6596
|
+
/** Recording URL of the meeting. */
|
|
6597
|
+
recording_url?: string;
|
|
6598
|
+
/**
|
|
6599
|
+
* Time at which meeting was scheduled to start.
|
|
6600
|
+
* @format date-time
|
|
6601
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6602
|
+
*/
|
|
6603
|
+
scheduled_date?: string;
|
|
6604
|
+
/** The state of meeting. */
|
|
6605
|
+
state?: MeetingState;
|
|
6606
|
+
/**
|
|
6607
|
+
* Stock schema fragment.
|
|
6608
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
6609
|
+
*/
|
|
6610
|
+
stock_schema_fragment?: string;
|
|
6611
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
6612
|
+
subtype?: string;
|
|
6613
|
+
/** Tags associated with the meeting. */
|
|
6614
|
+
tags?: TagWithValue[];
|
|
6615
|
+
/** Title of the meeting object. */
|
|
6616
|
+
title?: string;
|
|
6617
|
+
};
|
|
6618
|
+
/** The channel of meeting. */
|
|
6619
|
+
export declare enum MeetingChannel {
|
|
6620
|
+
GoogleMeet = "google_meet",
|
|
6621
|
+
Offline = "offline",
|
|
6622
|
+
Other = "other",
|
|
6623
|
+
Teams = "teams",
|
|
6624
|
+
Zoom = "zoom"
|
|
6625
|
+
}
|
|
6626
|
+
/** The state of meeting. */
|
|
6627
|
+
export declare enum MeetingState {
|
|
6628
|
+
Canceled = "canceled",
|
|
6629
|
+
Completed = "completed",
|
|
6630
|
+
NoShow = "no_show",
|
|
6631
|
+
Rescheduled = "rescheduled",
|
|
6632
|
+
Scheduled = "scheduled"
|
|
6633
|
+
}
|
|
6054
6634
|
/** meeting-summary */
|
|
6055
6635
|
export type MeetingSummary = AtomBaseSummary;
|
|
6636
|
+
/** meetings-count-request */
|
|
6637
|
+
export interface MeetingsCountRequest {
|
|
6638
|
+
/** Filters for meeting on specified channels. */
|
|
6639
|
+
channel?: MeetingChannel[];
|
|
6640
|
+
/** Filters for meetings created by the specified user(s). */
|
|
6641
|
+
created_by?: string[];
|
|
6642
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6643
|
+
created_date?: DateFilter;
|
|
6644
|
+
/** Filters for meeting on custom fields. */
|
|
6645
|
+
custom_fields?: object;
|
|
6646
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
6647
|
+
external_ref?: string[];
|
|
6648
|
+
/** Filters for links associated with the meeting. */
|
|
6649
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
6650
|
+
/** Filter for meeting on specified Member Ids. */
|
|
6651
|
+
members?: string[];
|
|
6652
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6653
|
+
modified_date?: DateFilter;
|
|
6654
|
+
/** Filter for meeting on specified organizers. */
|
|
6655
|
+
organizer?: string[];
|
|
6656
|
+
/**
|
|
6657
|
+
* Filters for meetings with the provided parent.
|
|
6658
|
+
* @example ["ACC-12345"]
|
|
6659
|
+
*/
|
|
6660
|
+
parent?: string[];
|
|
6661
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
6662
|
+
state?: MeetingState[];
|
|
6663
|
+
/** Filters for meeting by tags. */
|
|
6664
|
+
tags?: string[];
|
|
6665
|
+
}
|
|
6666
|
+
/** meetings-count-response */
|
|
6667
|
+
export interface MeetingsCountResponse {
|
|
6668
|
+
/**
|
|
6669
|
+
* The number of meetings matching the filter.
|
|
6670
|
+
* @format int64
|
|
6671
|
+
*/
|
|
6672
|
+
count: number;
|
|
6673
|
+
}
|
|
6674
|
+
/** meetings-create-request */
|
|
6675
|
+
export interface MeetingsCreateRequest {
|
|
6676
|
+
/** The channel of meeting. */
|
|
6677
|
+
channel: MeetingChannel;
|
|
6678
|
+
/** Application-defined custom fields. */
|
|
6679
|
+
custom_fields?: object;
|
|
6680
|
+
/** The description of the meeting. */
|
|
6681
|
+
description?: string;
|
|
6682
|
+
/**
|
|
6683
|
+
* Time at which meeting ended.
|
|
6684
|
+
* @format date-time
|
|
6685
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6686
|
+
*/
|
|
6687
|
+
ended_date: string;
|
|
6688
|
+
/** External reference for the meeting. */
|
|
6689
|
+
external_ref?: string;
|
|
6690
|
+
/** External URL for the meeting. */
|
|
6691
|
+
external_url?: string;
|
|
6692
|
+
/**
|
|
6693
|
+
* IDs of the users that were part of the meeting.
|
|
6694
|
+
* @maxItems 800
|
|
6695
|
+
* @minItems 1
|
|
6696
|
+
* @example ["DEVU-12345"]
|
|
6697
|
+
*/
|
|
6698
|
+
members: string[];
|
|
6699
|
+
/**
|
|
6700
|
+
* The ID of the user who organized the meeting. If not provided, the
|
|
6701
|
+
* creator is set as the organizer.
|
|
6702
|
+
* @example "DEVU-12345"
|
|
6703
|
+
*/
|
|
6704
|
+
organizer?: string;
|
|
6705
|
+
/**
|
|
6706
|
+
* The parent object ID in which the meeting was created.
|
|
6707
|
+
* @example "ACC-12345"
|
|
6708
|
+
*/
|
|
6709
|
+
parent?: string;
|
|
6710
|
+
/** The recording URL of the meeting. */
|
|
6711
|
+
recording_url?: string;
|
|
6712
|
+
/**
|
|
6713
|
+
* The date and time when the meeting was scheduled.
|
|
6714
|
+
* @format date-time
|
|
6715
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6716
|
+
*/
|
|
6717
|
+
scheduled_date: string;
|
|
6718
|
+
/** The state of meeting. */
|
|
6719
|
+
state: MeetingState;
|
|
6720
|
+
/** Tags associated with the meeting. */
|
|
6721
|
+
tags?: SetTagWithValue[];
|
|
6722
|
+
/** The title of the meeting. */
|
|
6723
|
+
title: string;
|
|
6724
|
+
}
|
|
6725
|
+
/** meetings-create-response */
|
|
6726
|
+
export interface MeetingsCreateResponse {
|
|
6727
|
+
meeting: Meeting;
|
|
6728
|
+
}
|
|
6729
|
+
/** meetings-delete-request */
|
|
6730
|
+
export interface MeetingsDeleteRequest {
|
|
6731
|
+
/** The meeting's ID. */
|
|
6732
|
+
id: string;
|
|
6733
|
+
}
|
|
6734
|
+
/** meetings-delete-response */
|
|
6735
|
+
export type MeetingsDeleteResponse = object;
|
|
6736
|
+
/**
|
|
6737
|
+
* meetings-filter-link-summary-filter
|
|
6738
|
+
* The filter for the link summary.
|
|
6739
|
+
*/
|
|
6740
|
+
export interface MeetingsFilterLinkSummaryFilter {
|
|
6741
|
+
/** Filters for link type in links associated with the meeting. */
|
|
6742
|
+
link_type?: string;
|
|
6743
|
+
/** Filters for target id in links associated with the meeting. */
|
|
6744
|
+
target?: string;
|
|
6745
|
+
/**
|
|
6746
|
+
* Filters for target object type in links associated with the
|
|
6747
|
+
* meeting.
|
|
6748
|
+
*/
|
|
6749
|
+
target_object_type?: string;
|
|
6750
|
+
}
|
|
6751
|
+
/** meetings-get-request */
|
|
6752
|
+
export interface MeetingsGetRequest {
|
|
6753
|
+
/** The meeting's ID. */
|
|
6754
|
+
id: string;
|
|
6755
|
+
}
|
|
6756
|
+
/** meetings-get-response */
|
|
6757
|
+
export interface MeetingsGetResponse {
|
|
6758
|
+
meeting: Meeting;
|
|
6759
|
+
}
|
|
6760
|
+
/** meetings-list-request */
|
|
6761
|
+
export interface MeetingsListRequest {
|
|
6762
|
+
/** Filters for meeting on specified channels. */
|
|
6763
|
+
channel?: MeetingChannel[];
|
|
6764
|
+
/** Filters for meetings created by the specified user(s). */
|
|
6765
|
+
created_by?: string[];
|
|
6766
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6767
|
+
created_date?: DateFilter;
|
|
6768
|
+
/**
|
|
6769
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6770
|
+
* iteration starts from the beginning.
|
|
6771
|
+
*/
|
|
6772
|
+
cursor?: string;
|
|
6773
|
+
/** Filters for meeting on custom fields. */
|
|
6774
|
+
custom_fields?: object;
|
|
6775
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
6776
|
+
external_ref?: string[];
|
|
6777
|
+
/**
|
|
6778
|
+
* The maximum number of meetings to return.
|
|
6779
|
+
* @format int32
|
|
6780
|
+
*/
|
|
6781
|
+
limit?: number;
|
|
6782
|
+
/** Filters for links associated with the meeting. */
|
|
6783
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
6784
|
+
/** Filter for meeting on specified Member Ids. */
|
|
6785
|
+
members?: string[];
|
|
6786
|
+
/**
|
|
6787
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
6788
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
6789
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
6790
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
6791
|
+
* always be returned in the specified sort-by order.
|
|
6792
|
+
*/
|
|
6793
|
+
mode?: ListMode;
|
|
6794
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6795
|
+
modified_date?: DateFilter;
|
|
6796
|
+
/** Filter for meeting on specified organizers. */
|
|
6797
|
+
organizer?: string[];
|
|
6798
|
+
/**
|
|
6799
|
+
* Filters for meetings with the provided parent.
|
|
6800
|
+
* @example ["ACC-12345"]
|
|
6801
|
+
*/
|
|
6802
|
+
parent?: string[];
|
|
6803
|
+
/** Fields to sort the meetings by and the direction to sort them. */
|
|
6804
|
+
sort_by?: string[];
|
|
6805
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
6806
|
+
state?: MeetingState[];
|
|
6807
|
+
/** Filters for meeting by tags. */
|
|
6808
|
+
tags?: string[];
|
|
6809
|
+
}
|
|
6810
|
+
/** meetings-list-response */
|
|
6811
|
+
export interface MeetingsListResponse {
|
|
6812
|
+
/** The list of meetings. */
|
|
6813
|
+
meetings: Meeting[];
|
|
6814
|
+
/**
|
|
6815
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
6816
|
+
* sort order. If not set, then no later elements exist.
|
|
6817
|
+
*/
|
|
6818
|
+
next_cursor?: string;
|
|
6819
|
+
/**
|
|
6820
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
6821
|
+
* sort order. If not set, then no prior elements exist.
|
|
6822
|
+
*/
|
|
6823
|
+
prev_cursor?: string;
|
|
6824
|
+
}
|
|
6825
|
+
/** meetings-update-request */
|
|
6826
|
+
export interface MeetingsUpdateRequest {
|
|
6827
|
+
/** The channel of meeting. */
|
|
6828
|
+
channel?: MeetingChannel;
|
|
6829
|
+
/** Application-defined custom fields. */
|
|
6830
|
+
custom_fields?: object;
|
|
6831
|
+
/** The description of the meeting. */
|
|
6832
|
+
description?: string;
|
|
6833
|
+
/**
|
|
6834
|
+
* Updates the date and time when the meeting ended.
|
|
6835
|
+
* @format date-time
|
|
6836
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6837
|
+
*/
|
|
6838
|
+
ended_date?: string | null;
|
|
6839
|
+
/** External Reference for the meeting. */
|
|
6840
|
+
external_ref?: string;
|
|
6841
|
+
/** External URL for the meeting. */
|
|
6842
|
+
external_url?: string;
|
|
6843
|
+
/** The meetings ID. */
|
|
6844
|
+
id: string;
|
|
6845
|
+
members?: MeetingsUpdateRequestMembers;
|
|
6846
|
+
/**
|
|
6847
|
+
* The ID of the user who organized the meeting.
|
|
6848
|
+
* @example "DEVU-12345"
|
|
6849
|
+
*/
|
|
6850
|
+
organizer?: string;
|
|
6851
|
+
/** The recording URL of the meeting. */
|
|
6852
|
+
recording_url?: string;
|
|
6853
|
+
/**
|
|
6854
|
+
* Updates the date and time when the meeting was scheduled.
|
|
6855
|
+
* @format date-time
|
|
6856
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6857
|
+
*/
|
|
6858
|
+
scheduled_date?: string | null;
|
|
6859
|
+
/** The state of meeting. */
|
|
6860
|
+
state?: MeetingState;
|
|
6861
|
+
tags?: MeetingsUpdateRequestTags;
|
|
6862
|
+
/** The title of the meeting. */
|
|
6863
|
+
title?: string;
|
|
6864
|
+
}
|
|
6865
|
+
/** meetings-update-request-members */
|
|
6866
|
+
export interface MeetingsUpdateRequestMembers {
|
|
6867
|
+
/**
|
|
6868
|
+
* Sets the members to the provided user IDs. This must not be empty.
|
|
6869
|
+
* @example ["DEVU-12345"]
|
|
6870
|
+
*/
|
|
6871
|
+
set?: string[];
|
|
6872
|
+
}
|
|
6873
|
+
/** meetings-update-request-tags */
|
|
6874
|
+
export interface MeetingsUpdateRequestTags {
|
|
6875
|
+
/** Sets the provided tags on the meeting item. */
|
|
6876
|
+
set?: SetTagWithValue[];
|
|
6877
|
+
}
|
|
6878
|
+
/** meetings-update-response */
|
|
6879
|
+
export interface MeetingsUpdateResponse {
|
|
6880
|
+
meeting: Meeting;
|
|
6881
|
+
}
|
|
6056
6882
|
/** member-summary */
|
|
6057
6883
|
export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
6058
6884
|
type: MemberType;
|
|
@@ -6332,6 +7158,16 @@ export interface MetricsDataIngestRequest {
|
|
|
6332
7158
|
*/
|
|
6333
7159
|
metrics: MetricsData[];
|
|
6334
7160
|
}
|
|
7161
|
+
/**
|
|
7162
|
+
* money
|
|
7163
|
+
* Money.
|
|
7164
|
+
*/
|
|
7165
|
+
export interface Money {
|
|
7166
|
+
/** Amount of the money. */
|
|
7167
|
+
amount?: string;
|
|
7168
|
+
/** Currency of the money. */
|
|
7169
|
+
currency?: string;
|
|
7170
|
+
}
|
|
6335
7171
|
/** notifications-send-request */
|
|
6336
7172
|
export interface NotificationsSendRequest {
|
|
6337
7173
|
/**
|
|
@@ -6350,7 +7186,15 @@ export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
|
6350
7186
|
/** object-member-summary */
|
|
6351
7187
|
export type ObjectMemberSummary = AtomBaseSummary;
|
|
6352
7188
|
/** opportunity */
|
|
6353
|
-
export type Opportunity = WorkBase
|
|
7189
|
+
export type Opportunity = WorkBase & {
|
|
7190
|
+
account?: AccountSummary;
|
|
7191
|
+
/** Money. */
|
|
7192
|
+
annual_contract_value?: Money;
|
|
7193
|
+
/** The properties of an enum value. */
|
|
7194
|
+
forecast_category_v2?: EnumValue;
|
|
7195
|
+
/** Money. */
|
|
7196
|
+
value?: Money;
|
|
7197
|
+
};
|
|
6354
7198
|
/** Forecast category of the opportunity. */
|
|
6355
7199
|
export declare enum OpportunityForecastCategory {
|
|
6356
7200
|
Commit = "commit",
|
|
@@ -6368,7 +7212,9 @@ export declare enum OpportunityPriority {
|
|
|
6368
7212
|
P3 = "p3"
|
|
6369
7213
|
}
|
|
6370
7214
|
/** opportunity-summary */
|
|
6371
|
-
export type OpportunitySummary = WorkBaseSummary
|
|
7215
|
+
export type OpportunitySummary = WorkBaseSummary & {
|
|
7216
|
+
account?: AccountSummary;
|
|
7217
|
+
};
|
|
6372
7218
|
/** org-base */
|
|
6373
7219
|
export type OrgBase = AtomBase & {
|
|
6374
7220
|
/** Name of the Organization. */
|
|
@@ -6612,6 +7458,22 @@ export interface OrgSchedulesCreateRequest {
|
|
|
6612
7458
|
export interface OrgSchedulesCreateResponse {
|
|
6613
7459
|
org_schedule: OrgSchedule;
|
|
6614
7460
|
}
|
|
7461
|
+
/** org-schedules-evaluate-request */
|
|
7462
|
+
export interface OrgSchedulesEvaluateRequest {
|
|
7463
|
+
/** Organization schedule ID. */
|
|
7464
|
+
id: string;
|
|
7465
|
+
/**
|
|
7466
|
+
* Time instants to evaluate the organization schedule for.
|
|
7467
|
+
* @minItems 1
|
|
7468
|
+
* @example ["2023-01-01T12:00:00.000Z"]
|
|
7469
|
+
*/
|
|
7470
|
+
instants: string[];
|
|
7471
|
+
}
|
|
7472
|
+
/** org-schedules-evaluate-response */
|
|
7473
|
+
export interface OrgSchedulesEvaluateResponse {
|
|
7474
|
+
/** The evaluations for the given time instants in the requested order. */
|
|
7475
|
+
instant_evaluations: InstantEvaluation[];
|
|
7476
|
+
}
|
|
6615
7477
|
/** org-schedules-get-request */
|
|
6616
7478
|
export interface OrgSchedulesGetRequest {
|
|
6617
7479
|
/** Organization schedule ID. */
|
|
@@ -6824,6 +7686,14 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
6824
7686
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6825
7687
|
*/
|
|
6826
7688
|
custom_schema_fragments?: string[];
|
|
7689
|
+
/**
|
|
7690
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7691
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7692
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7693
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7694
|
+
* specifier, it remains unmodified.
|
|
7695
|
+
*/
|
|
7696
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6827
7697
|
/** Description of the part. */
|
|
6828
7698
|
description?: string;
|
|
6829
7699
|
/** Name of the part. */
|
|
@@ -6965,6 +7835,14 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
6965
7835
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6966
7836
|
*/
|
|
6967
7837
|
custom_schema_fragments?: string[];
|
|
7838
|
+
/**
|
|
7839
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7840
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7841
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7842
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7843
|
+
* specifier, it remains unmodified.
|
|
7844
|
+
*/
|
|
7845
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6968
7846
|
/** The updated description of the part. */
|
|
6969
7847
|
description?: string;
|
|
6970
7848
|
/**
|
|
@@ -7348,9 +8226,9 @@ export type RemovedSlaMetricHistory = object;
|
|
|
7348
8226
|
* Resource details.
|
|
7349
8227
|
*/
|
|
7350
8228
|
export interface Resource {
|
|
7351
|
-
/**
|
|
8229
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7352
8230
|
artifacts?: ArtifactSummary[];
|
|
7353
|
-
/** URL of the
|
|
8231
|
+
/** URL of the resource (relevant only for type url). */
|
|
7354
8232
|
url?: string;
|
|
7355
8233
|
}
|
|
7356
8234
|
/**
|
|
@@ -7358,9 +8236,9 @@ export interface Resource {
|
|
|
7358
8236
|
* Resource details.
|
|
7359
8237
|
*/
|
|
7360
8238
|
export interface ResourceSummary {
|
|
7361
|
-
/**
|
|
8239
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
7362
8240
|
artifacts?: ArtifactSummary[];
|
|
7363
|
-
/** URL of the
|
|
8241
|
+
/** URL of the resource (relevant only for type url). */
|
|
7364
8242
|
url?: string;
|
|
7365
8243
|
}
|
|
7366
8244
|
/** rev-org */
|
|
@@ -7683,9 +8561,18 @@ export interface RevUsersCreateRequest {
|
|
|
7683
8561
|
custom_fields?: object;
|
|
7684
8562
|
/**
|
|
7685
8563
|
* The schema fragment IDs associated with the Rev user.
|
|
8564
|
+
* @deprecated
|
|
7686
8565
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
7687
8566
|
*/
|
|
7688
8567
|
custom_schema_fragments?: string[];
|
|
8568
|
+
/**
|
|
8569
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8570
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8571
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8572
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8573
|
+
* specifier, it remains unmodified.
|
|
8574
|
+
*/
|
|
8575
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7689
8576
|
/** Description of the Rev user. */
|
|
7690
8577
|
description?: string;
|
|
7691
8578
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -7885,6 +8772,14 @@ export interface RevUsersUpdateRequest {
|
|
|
7885
8772
|
/** Application-defined custom fields. */
|
|
7886
8773
|
custom_fields?: object;
|
|
7887
8774
|
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
8775
|
+
/**
|
|
8776
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8777
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8778
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8779
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8780
|
+
* specifier, it remains unmodified.
|
|
8781
|
+
*/
|
|
8782
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7888
8783
|
/** Updated description of the Rev user. */
|
|
7889
8784
|
description?: string;
|
|
7890
8785
|
/** Updated display name of the Rev user. */
|
|
@@ -7923,6 +8818,19 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
|
7923
8818
|
export interface RevUsersUpdateResponse {
|
|
7924
8819
|
rev_user: RevUser;
|
|
7925
8820
|
}
|
|
8821
|
+
/** saml-connection-fields-map */
|
|
8822
|
+
export interface SamlConnectionFieldsMap {
|
|
8823
|
+
/**
|
|
8824
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
8825
|
+
* map to the email address of the user.
|
|
8826
|
+
*/
|
|
8827
|
+
email?: string;
|
|
8828
|
+
/**
|
|
8829
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
8830
|
+
* map to the user ID of the user.
|
|
8831
|
+
*/
|
|
8832
|
+
user_id?: string;
|
|
8833
|
+
}
|
|
7926
8834
|
/** schema-bool-field-descriptor */
|
|
7927
8835
|
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
7928
8836
|
/** Default value. */
|
|
@@ -8118,7 +9026,24 @@ export interface SchemaFieldSummaryViewUiMetadata {
|
|
|
8118
9026
|
* schema-field-uenum-value
|
|
8119
9027
|
* A unified enum value.
|
|
8120
9028
|
*/
|
|
8121
|
-
export
|
|
9029
|
+
export interface SchemaFieldUenumValue {
|
|
9030
|
+
/**
|
|
9031
|
+
* The immutable id of the enum value.
|
|
9032
|
+
* @format int64
|
|
9033
|
+
*/
|
|
9034
|
+
id: number;
|
|
9035
|
+
/** True if this value is deprecated. */
|
|
9036
|
+
is_deprecated?: boolean;
|
|
9037
|
+
/** The human readable name of the enum value. */
|
|
9038
|
+
label: string;
|
|
9039
|
+
/**
|
|
9040
|
+
* The order value of the enum.
|
|
9041
|
+
* @format int64
|
|
9042
|
+
*/
|
|
9043
|
+
ordinal: number;
|
|
9044
|
+
/** Tooltip shown in the UI for this value. */
|
|
9045
|
+
tooltip?: string;
|
|
9046
|
+
}
|
|
8122
9047
|
/**
|
|
8123
9048
|
* schema-field-ui-metadata
|
|
8124
9049
|
* The schema of ui specific fields.
|
|
@@ -8138,6 +9063,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
8138
9063
|
is_active_in_detail_view?: boolean;
|
|
8139
9064
|
/** Whether the field supports bulk action. */
|
|
8140
9065
|
is_bulk_action_enabled?: boolean;
|
|
9066
|
+
/** Indicates if the field holds a currency value in USD. */
|
|
9067
|
+
is_currency_field?: boolean;
|
|
8141
9068
|
/** Whether the field is groupable in the UI. */
|
|
8142
9069
|
is_groupable?: boolean;
|
|
8143
9070
|
/** Whether the field is hidden in the UI. */
|
|
@@ -8154,12 +9081,19 @@ export interface SchemaFieldUiMetadata {
|
|
|
8154
9081
|
is_sortable?: boolean;
|
|
8155
9082
|
/** List view UI hint overrides. */
|
|
8156
9083
|
list_view?: SchemaFieldListViewUiMetadata;
|
|
9084
|
+
/**
|
|
9085
|
+
* Order in which field is shown.
|
|
9086
|
+
* @format int32
|
|
9087
|
+
*/
|
|
9088
|
+
order?: number;
|
|
8157
9089
|
/** A placeholder for the field. */
|
|
8158
9090
|
placeholder?: string;
|
|
8159
9091
|
/** Summary view UI hint overrides. */
|
|
8160
9092
|
summary_view?: SchemaFieldSummaryViewUiMetadata;
|
|
8161
9093
|
/** Tooltip for the field. */
|
|
8162
9094
|
tooltip?: string;
|
|
9095
|
+
/** Unit of measurment. */
|
|
9096
|
+
unit?: string;
|
|
8163
9097
|
}
|
|
8164
9098
|
/** schema-id-field-descriptor */
|
|
8165
9099
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
@@ -9332,6 +10266,13 @@ export interface StageInit {
|
|
|
9332
10266
|
/** The name of the stage. */
|
|
9333
10267
|
name?: string;
|
|
9334
10268
|
}
|
|
10269
|
+
/**
|
|
10270
|
+
* stage-summary
|
|
10271
|
+
* Describes the current stage of a object.
|
|
10272
|
+
*/
|
|
10273
|
+
export interface StageSummary {
|
|
10274
|
+
stage?: CustomStageSummary;
|
|
10275
|
+
}
|
|
9335
10276
|
/**
|
|
9336
10277
|
* stage-update
|
|
9337
10278
|
* Updates an object's stage.
|
|
@@ -9358,11 +10299,20 @@ export interface StagedInfoFilter {
|
|
|
9358
10299
|
/** Filters for issues that are staged. */
|
|
9359
10300
|
is_staged?: boolean;
|
|
9360
10301
|
}
|
|
9361
|
-
/**
|
|
9362
|
-
* stock-field-override
|
|
9363
|
-
* A stock field override.
|
|
9364
|
-
*/
|
|
9365
|
-
export
|
|
10302
|
+
/**
|
|
10303
|
+
* stock-field-override
|
|
10304
|
+
* A stock field override.
|
|
10305
|
+
*/
|
|
10306
|
+
export interface StockFieldOverride {
|
|
10307
|
+
/** Whether the field is required. */
|
|
10308
|
+
is_required?: boolean;
|
|
10309
|
+
/** Name of the stock field to be overridden. */
|
|
10310
|
+
name?: string;
|
|
10311
|
+
/** Overridden allowed values for a unified enum. */
|
|
10312
|
+
uenum_values?: SchemaFieldUenumValue[];
|
|
10313
|
+
/** The schema of ui specific fields. */
|
|
10314
|
+
ui?: SchemaFieldUiMetadata;
|
|
10315
|
+
}
|
|
9366
10316
|
/** stock-schema-fragment */
|
|
9367
10317
|
export type StockSchemaFragment = AtomBase & {
|
|
9368
10318
|
/** Description of the schema. */
|
|
@@ -9526,21 +10476,40 @@ export type SurveyResponse = AtomBase & {
|
|
|
9526
10476
|
};
|
|
9527
10477
|
/** surveys-create-request */
|
|
9528
10478
|
export interface SurveysCreateRequest {
|
|
9529
|
-
/**
|
|
10479
|
+
/**
|
|
10480
|
+
* Description about the survey.
|
|
10481
|
+
* @maxLength 1000
|
|
10482
|
+
*/
|
|
9530
10483
|
description?: string;
|
|
9531
|
-
/**
|
|
10484
|
+
/**
|
|
10485
|
+
* Header of the survey.
|
|
10486
|
+
* @maxLength 1000
|
|
10487
|
+
*/
|
|
9532
10488
|
header?: string;
|
|
9533
|
-
/**
|
|
10489
|
+
/**
|
|
10490
|
+
* Text posted when introducing the survey to the responder.
|
|
10491
|
+
* @maxLength 1000
|
|
10492
|
+
*/
|
|
9534
10493
|
introductory_text?: string;
|
|
9535
|
-
/**
|
|
10494
|
+
/**
|
|
10495
|
+
* The survey's name.
|
|
10496
|
+
* @minLength 1
|
|
10497
|
+
* @maxLength 100
|
|
10498
|
+
*/
|
|
9536
10499
|
name: string;
|
|
9537
|
-
/**
|
|
10500
|
+
/**
|
|
10501
|
+
* Text posted after the response is collected.
|
|
10502
|
+
* @maxLength 1000
|
|
10503
|
+
*/
|
|
9538
10504
|
response_text?: string;
|
|
9539
10505
|
/** Schema for the survey. */
|
|
9540
10506
|
schema?: FieldDescriptor[];
|
|
9541
10507
|
/** The schema with metadata for the survey. */
|
|
9542
10508
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
9543
|
-
/**
|
|
10509
|
+
/**
|
|
10510
|
+
* Title of the survey.
|
|
10511
|
+
* @maxLength 1000
|
|
10512
|
+
*/
|
|
9544
10513
|
title?: string;
|
|
9545
10514
|
}
|
|
9546
10515
|
/** surveys-create-response */
|
|
@@ -9723,6 +10692,61 @@ export interface SurveysSubmitRequest {
|
|
|
9723
10692
|
}
|
|
9724
10693
|
/** surveys-submit-response */
|
|
9725
10694
|
export type SurveysSubmitResponse = object;
|
|
10695
|
+
/** surveys-update-request */
|
|
10696
|
+
export interface SurveysUpdateRequest {
|
|
10697
|
+
/**
|
|
10698
|
+
* The updated description about the survey.
|
|
10699
|
+
* @maxLength 1000
|
|
10700
|
+
*/
|
|
10701
|
+
description?: string;
|
|
10702
|
+
/**
|
|
10703
|
+
* Header of the survey.
|
|
10704
|
+
* @maxLength 1000
|
|
10705
|
+
*/
|
|
10706
|
+
header?: string;
|
|
10707
|
+
/** The ID of the survey to update. */
|
|
10708
|
+
id: string;
|
|
10709
|
+
/**
|
|
10710
|
+
* The updated text posted when introducing the survey to the
|
|
10711
|
+
* responder.
|
|
10712
|
+
* @maxLength 1000
|
|
10713
|
+
*/
|
|
10714
|
+
introductory_text?: string;
|
|
10715
|
+
/**
|
|
10716
|
+
* The survey's updated name.
|
|
10717
|
+
* @minLength 1
|
|
10718
|
+
* @maxLength 100
|
|
10719
|
+
*/
|
|
10720
|
+
name?: string;
|
|
10721
|
+
/**
|
|
10722
|
+
* Text posted after the response is collected.
|
|
10723
|
+
* @maxLength 1000
|
|
10724
|
+
*/
|
|
10725
|
+
response_text?: string;
|
|
10726
|
+
/** The updated schema with metadata for the survey. */
|
|
10727
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
10728
|
+
/**
|
|
10729
|
+
* The ID of the survey to update.
|
|
10730
|
+
* @deprecated
|
|
10731
|
+
*/
|
|
10732
|
+
survey?: string;
|
|
10733
|
+
/**
|
|
10734
|
+
* Title of the survey.
|
|
10735
|
+
* @maxLength 1000
|
|
10736
|
+
*/
|
|
10737
|
+
title?: string;
|
|
10738
|
+
}
|
|
10739
|
+
/** surveys-update-response */
|
|
10740
|
+
export interface SurveysUpdateResponse {
|
|
10741
|
+
survey: Survey;
|
|
10742
|
+
}
|
|
10743
|
+
/** sync-history */
|
|
10744
|
+
export type SyncHistory = AtomBase & {
|
|
10745
|
+
/** Object for holding run-specific data. */
|
|
10746
|
+
sync_run?: SyncRun;
|
|
10747
|
+
/** SyncUnit ID associated with this historical entry. */
|
|
10748
|
+
sync_unit?: string;
|
|
10749
|
+
};
|
|
9726
10750
|
/**
|
|
9727
10751
|
* sync-in
|
|
9728
10752
|
* Information about the sync to DevRev.
|
|
@@ -9818,8 +10842,120 @@ export declare enum SyncOutStatus {
|
|
|
9818
10842
|
Modified = "modified",
|
|
9819
10843
|
Succeeded = "succeeded"
|
|
9820
10844
|
}
|
|
10845
|
+
/**
|
|
10846
|
+
* sync-progress
|
|
10847
|
+
* Progress.
|
|
10848
|
+
*/
|
|
10849
|
+
export interface SyncProgress {
|
|
10850
|
+
/** The state of a sync progress. */
|
|
10851
|
+
state?: SyncProgressState;
|
|
10852
|
+
}
|
|
10853
|
+
/** The state of a sync progress. */
|
|
10854
|
+
export declare enum SyncProgressState {
|
|
10855
|
+
Completed = "completed",
|
|
10856
|
+
DeleteInProgress = "delete_in_progress",
|
|
10857
|
+
Deleted = "deleted",
|
|
10858
|
+
DeletionError = "deletion_error",
|
|
10859
|
+
ExtractAttachments = "extract_attachments",
|
|
10860
|
+
ExtractAttachmentsError = "extract_attachments_error",
|
|
10861
|
+
Extraction = "extraction",
|
|
10862
|
+
ExtractionError = "extraction_error",
|
|
10863
|
+
Loading = "loading",
|
|
10864
|
+
LoadingAttachments = "loading_attachments",
|
|
10865
|
+
LoadingAttachmentsError = "loading_attachments_error",
|
|
10866
|
+
LoadingError = "loading_error",
|
|
10867
|
+
RecipeDiscovery = "recipe_discovery",
|
|
10868
|
+
RecipeDiscoveryError = "recipe_discovery_error",
|
|
10869
|
+
RecipeDiscoveryWaitingForUserInput = "recipe_discovery_waiting_for_user_input",
|
|
10870
|
+
Starting = "starting",
|
|
10871
|
+
Transformation = "transformation",
|
|
10872
|
+
TransformationError = "transformation_error"
|
|
10873
|
+
}
|
|
10874
|
+
/**
|
|
10875
|
+
* sync-progress-summary
|
|
10876
|
+
* Progress.
|
|
10877
|
+
*/
|
|
10878
|
+
export interface SyncProgressSummary {
|
|
10879
|
+
/** The state of a sync progress. */
|
|
10880
|
+
state?: SyncProgressState;
|
|
10881
|
+
}
|
|
10882
|
+
/**
|
|
10883
|
+
* sync-run
|
|
10884
|
+
* Object for holding run-specific data.
|
|
10885
|
+
*/
|
|
10886
|
+
export interface SyncRun {
|
|
10887
|
+
/**
|
|
10888
|
+
* The time when a sync was ended.
|
|
10889
|
+
* @format date-time
|
|
10890
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10891
|
+
*/
|
|
10892
|
+
ended_at?: string;
|
|
10893
|
+
/** The direction/mode of a sync run. */
|
|
10894
|
+
mode?: SyncRunMode;
|
|
10895
|
+
/** Progress. */
|
|
10896
|
+
progress?: SyncProgress;
|
|
10897
|
+
/**
|
|
10898
|
+
* The time when a sync was started.
|
|
10899
|
+
* @format date-time
|
|
10900
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10901
|
+
*/
|
|
10902
|
+
started_at?: string;
|
|
10903
|
+
}
|
|
10904
|
+
/** The direction/mode of a sync run. */
|
|
10905
|
+
export declare enum SyncRunMode {
|
|
10906
|
+
Initial = "initial",
|
|
10907
|
+
SyncFromDevrev = "sync_from_devrev",
|
|
10908
|
+
SyncToDevrev = "sync_to_devrev"
|
|
10909
|
+
}
|
|
10910
|
+
/** The state of a sync progress. */
|
|
10911
|
+
export declare enum SyncRunProgressState {
|
|
10912
|
+
Completed = "completed",
|
|
10913
|
+
Failed = "failed"
|
|
10914
|
+
}
|
|
10915
|
+
/** Describes how the sync was initiated. */
|
|
10916
|
+
export declare enum SyncRunStartedBy {
|
|
10917
|
+
PeriodicSyncScheduler = "periodic_sync_scheduler",
|
|
10918
|
+
User = "user"
|
|
10919
|
+
}
|
|
10920
|
+
/**
|
|
10921
|
+
* sync-run-summary
|
|
10922
|
+
* Object for holding run-specific data.
|
|
10923
|
+
*/
|
|
10924
|
+
export interface SyncRunSummary {
|
|
10925
|
+
/** The direction/mode of a sync run. */
|
|
10926
|
+
mode?: SyncRunMode;
|
|
10927
|
+
/** Progress. */
|
|
10928
|
+
progress?: SyncProgressSummary;
|
|
10929
|
+
}
|
|
10930
|
+
/** sync-unit */
|
|
10931
|
+
export type SyncUnit = AtomBase & {
|
|
10932
|
+
external_system_type?: ExternalSystemType;
|
|
10933
|
+
/** The flag signaling if sync unit is archived. */
|
|
10934
|
+
is_archived?: boolean;
|
|
10935
|
+
/** The name of the sync unit. */
|
|
10936
|
+
name?: string;
|
|
10937
|
+
/** Object for holding run-specific data. */
|
|
10938
|
+
sync_run?: SyncRun;
|
|
10939
|
+
/** Type of sync preferences. */
|
|
10940
|
+
sync_type?: SyncUnitSyncType;
|
|
10941
|
+
};
|
|
9821
10942
|
/** sync-unit-summary */
|
|
9822
|
-
export type SyncUnitSummary = AtomBaseSummary
|
|
10943
|
+
export type SyncUnitSummary = AtomBaseSummary & {
|
|
10944
|
+
external_system_type?: ExternalSystemType;
|
|
10945
|
+
/** The flag signaling if sync unit is archived. */
|
|
10946
|
+
is_archived?: boolean;
|
|
10947
|
+
/** The name of the sync unit. */
|
|
10948
|
+
name?: string;
|
|
10949
|
+
/** Object for holding run-specific data. */
|
|
10950
|
+
sync_run?: SyncRunSummary;
|
|
10951
|
+
/** Type of sync preferences. */
|
|
10952
|
+
sync_type?: SyncUnitSyncType;
|
|
10953
|
+
};
|
|
10954
|
+
/** Type of sync preferences. */
|
|
10955
|
+
export declare enum SyncUnitSyncType {
|
|
10956
|
+
Manual = "manual",
|
|
10957
|
+
Periodic = "periodic"
|
|
10958
|
+
}
|
|
9823
10959
|
/** sys-user */
|
|
9824
10960
|
export type SysUser = UserBase;
|
|
9825
10961
|
/** sys-user-summary */
|
|
@@ -10094,7 +11230,10 @@ export declare enum TaskPriority {
|
|
|
10094
11230
|
/** task-summary */
|
|
10095
11231
|
export type TaskSummary = WorkBaseSummary;
|
|
10096
11232
|
/** tenant-fragment */
|
|
10097
|
-
export type TenantFragment = CustomSchemaFragmentBase
|
|
11233
|
+
export type TenantFragment = CustomSchemaFragmentBase & {
|
|
11234
|
+
/** The stock field overrides. */
|
|
11235
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
11236
|
+
};
|
|
10098
11237
|
/** tenant-fragment-summary */
|
|
10099
11238
|
export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
10100
11239
|
/** ticket */
|
|
@@ -10563,6 +11702,7 @@ export declare enum TimelineEntryObjectType {
|
|
|
10563
11702
|
Engagement = "engagement",
|
|
10564
11703
|
Enhancement = "enhancement",
|
|
10565
11704
|
Feature = "feature",
|
|
11705
|
+
Incident = "incident",
|
|
10566
11706
|
Issue = "issue",
|
|
10567
11707
|
Meeting = "meeting",
|
|
10568
11708
|
Opportunity = "opportunity",
|
|
@@ -11268,6 +12408,9 @@ export interface WebhookEventRequest {
|
|
|
11268
12408
|
group_updated?: EventGroupUpdated;
|
|
11269
12409
|
/** The event's ID. */
|
|
11270
12410
|
id: string;
|
|
12411
|
+
incident_created?: EventIncidentCreated;
|
|
12412
|
+
incident_deleted?: EventIncidentDeleted;
|
|
12413
|
+
incident_updated?: EventIncidentUpdated;
|
|
11271
12414
|
link_created?: EventLinkCreated;
|
|
11272
12415
|
link_deleted?: EventLinkDeleted;
|
|
11273
12416
|
link_updated?: EventLinkUpdated;
|
|
@@ -11289,6 +12432,9 @@ export interface WebhookEventRequest {
|
|
|
11289
12432
|
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
11290
12433
|
survey_response_updated?: EventSurveyResponseUpdated;
|
|
11291
12434
|
survey_updated?: EventSurveyUpdated;
|
|
12435
|
+
sync_history_created?: EventSyncHistoryCreated;
|
|
12436
|
+
sync_history_deleted?: EventSyncHistoryDeleted;
|
|
12437
|
+
sync_history_updated?: EventSyncHistoryUpdated;
|
|
11292
12438
|
tag_created?: EventTagCreated;
|
|
11293
12439
|
tag_deleted?: EventTagDeleted;
|
|
11294
12440
|
tag_updated?: EventTagUpdated;
|
|
@@ -11343,6 +12489,9 @@ export declare enum WebhookEventType {
|
|
|
11343
12489
|
GroupMemberAdded = "group_member_added",
|
|
11344
12490
|
GroupMemberRemoved = "group_member_removed",
|
|
11345
12491
|
GroupUpdated = "group_updated",
|
|
12492
|
+
IncidentCreated = "incident_created",
|
|
12493
|
+
IncidentDeleted = "incident_deleted",
|
|
12494
|
+
IncidentUpdated = "incident_updated",
|
|
11346
12495
|
LinkCreated = "link_created",
|
|
11347
12496
|
LinkDeleted = "link_deleted",
|
|
11348
12497
|
LinkUpdated = "link_updated",
|
|
@@ -11364,6 +12513,10 @@ export declare enum WebhookEventType {
|
|
|
11364
12513
|
SurveyResponseDeleted = "survey_response_deleted",
|
|
11365
12514
|
SurveyResponseUpdated = "survey_response_updated",
|
|
11366
12515
|
SurveyUpdated = "survey_updated",
|
|
12516
|
+
SyncHistoryCreated = "sync_history_created",
|
|
12517
|
+
SyncHistoryDeleted = "sync_history_deleted",
|
|
12518
|
+
SyncHistoryUpdated = "sync_history_updated",
|
|
12519
|
+
SyncUnitUpdated = "sync_unit_updated",
|
|
11367
12520
|
TagCreated = "tag_created",
|
|
11368
12521
|
TagDeleted = "tag_deleted",
|
|
11369
12522
|
TagUpdated = "tag_updated",
|
|
@@ -12101,7 +13254,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
12101
13254
|
* object.
|
|
12102
13255
|
*/
|
|
12103
13256
|
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
12104
|
-
staged_info?:
|
|
13257
|
+
staged_info?: WorksUpdateRequestStagedInfoUpdate;
|
|
12105
13258
|
tags?: WorksUpdateRequestTags;
|
|
12106
13259
|
/**
|
|
12107
13260
|
* Updates the timestamp for when the work is expected to be complete.
|
|
@@ -12213,10 +13366,23 @@ export interface WorksUpdateRequestReportedBy {
|
|
|
12213
13366
|
*/
|
|
12214
13367
|
set?: string[];
|
|
12215
13368
|
}
|
|
12216
|
-
/** works-update-request-staged-info-
|
|
12217
|
-
export interface
|
|
13369
|
+
/** works-update-request-staged-info-update */
|
|
13370
|
+
export interface WorksUpdateRequestStagedInfoUpdate {
|
|
13371
|
+
/** Updates the sync in unresolved fields of the staged work. */
|
|
13372
|
+
sync_in_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
13373
|
+
/** Updates the sync out unresolved fields of the staged work. */
|
|
13374
|
+
sync_out_unresolved_fields?: WorksUpdateRequestStagedInfoUpdateUnresolvedField[];
|
|
12218
13375
|
/** Updates the unresolved fields of the staged work. */
|
|
12219
|
-
unresolved_fields
|
|
13376
|
+
unresolved_fields?: string[];
|
|
13377
|
+
}
|
|
13378
|
+
/** works-update-request-staged-info-update-unresolved-field */
|
|
13379
|
+
export interface WorksUpdateRequestStagedInfoUpdateUnresolvedField {
|
|
13380
|
+
/** DevRev field name of the object's attribute. */
|
|
13381
|
+
devrev_field_name?: string;
|
|
13382
|
+
/** External field name as seen by the end user. */
|
|
13383
|
+
external_display_name?: string;
|
|
13384
|
+
/** Api name of the external object's field. */
|
|
13385
|
+
external_field_name?: string;
|
|
12220
13386
|
}
|
|
12221
13387
|
/** works-update-request-tags */
|
|
12222
13388
|
export interface WorksUpdateRequestTags {
|
|
@@ -12245,6 +13411,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
12245
13411
|
channels?: WorksUpdateRequestTicketChannels;
|
|
12246
13412
|
/** Updates the group that the ticket is associated with. */
|
|
12247
13413
|
group?: string | null;
|
|
13414
|
+
/** Whether the ticket is archived. */
|
|
13415
|
+
is_archived?: boolean;
|
|
12248
13416
|
/** Updates whether the ticket is spam. */
|
|
12249
13417
|
is_spam?: boolean;
|
|
12250
13418
|
/** Updates whether the ticket needs a response. */
|
|
@@ -12406,6 +13574,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12406
13574
|
stage?: string[];
|
|
12407
13575
|
/** List of tags to be filtered. */
|
|
12408
13576
|
tags?: string[];
|
|
13577
|
+
/** Array of websites of accounts to be filtered. */
|
|
13578
|
+
websites?: string[];
|
|
12409
13579
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
12410
13580
|
/**
|
|
12411
13581
|
* @description Exports a collection of accounts.
|
|
@@ -12509,6 +13679,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12509
13679
|
stage?: string[];
|
|
12510
13680
|
/** List of tags to be filtered. */
|
|
12511
13681
|
tags?: string[];
|
|
13682
|
+
/** Array of websites of accounts to be filtered. */
|
|
13683
|
+
websites?: string[];
|
|
12512
13684
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
12513
13685
|
/**
|
|
12514
13686
|
* @description Gets a list of accounts.
|
|
@@ -12519,6 +13691,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12519
13691
|
* @secure
|
|
12520
13692
|
*/
|
|
12521
13693
|
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
13694
|
+
/**
|
|
13695
|
+
* @description Merges two accounts.
|
|
13696
|
+
*
|
|
13697
|
+
* @tags accounts
|
|
13698
|
+
* @name AccountsMerge
|
|
13699
|
+
* @request POST:/accounts.merge
|
|
13700
|
+
* @secure
|
|
13701
|
+
*/
|
|
13702
|
+
accountsMerge: (data: AccountsMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12522
13703
|
/**
|
|
12523
13704
|
* @description Updates an account's information.
|
|
12524
13705
|
*
|
|
@@ -12528,6 +13709,71 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12528
13709
|
* @secure
|
|
12529
13710
|
*/
|
|
12530
13711
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
13712
|
+
/**
|
|
13713
|
+
* @description Gets a single sync unit's information.
|
|
13714
|
+
*
|
|
13715
|
+
* @tags airdrop
|
|
13716
|
+
* @name AirdropSyncUnitsGet
|
|
13717
|
+
* @request GET:/airdrop.sync-units.get
|
|
13718
|
+
* @secure
|
|
13719
|
+
*/
|
|
13720
|
+
airdropSyncUnitsGet: (query: {
|
|
13721
|
+
/** Requested sync unit ID. */
|
|
13722
|
+
id: string;
|
|
13723
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsGetResponse, any>>;
|
|
13724
|
+
/**
|
|
13725
|
+
* @description Gets a single sync unit's information.
|
|
13726
|
+
*
|
|
13727
|
+
* @tags airdrop
|
|
13728
|
+
* @name AirdropSyncUnitsGetPost
|
|
13729
|
+
* @request POST:/airdrop.sync-units.get
|
|
13730
|
+
* @secure
|
|
13731
|
+
*/
|
|
13732
|
+
airdropSyncUnitsGetPost: (data: AirdropSyncUnitsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsGetResponse, any>>;
|
|
13733
|
+
/**
|
|
13734
|
+
* @description Gets a list of sync unit historical records.
|
|
13735
|
+
*
|
|
13736
|
+
* @tags airdrop
|
|
13737
|
+
* @name AirdropSyncUnitsHistory
|
|
13738
|
+
* @request GET:/airdrop.sync-units.history
|
|
13739
|
+
* @secure
|
|
13740
|
+
*/
|
|
13741
|
+
airdropSyncUnitsHistory: (query: {
|
|
13742
|
+
/** Sync unit that will be used for sync history listing. */
|
|
13743
|
+
id: string;
|
|
13744
|
+
/**
|
|
13745
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13746
|
+
* starts from the beginning.
|
|
13747
|
+
*/
|
|
13748
|
+
cursor?: string;
|
|
13749
|
+
/** Filter for sync runs that have errors. */
|
|
13750
|
+
'filter.has_errors_or_warnings'?: boolean;
|
|
13751
|
+
/** Mode of the sync run. */
|
|
13752
|
+
'filter.mode'?: SyncRunMode[];
|
|
13753
|
+
/** User who started the sync run. */
|
|
13754
|
+
'filter.started_by'?: SyncRunStartedBy[];
|
|
13755
|
+
/** State of the sync run. */
|
|
13756
|
+
'filter.state'?: SyncRunProgressState[];
|
|
13757
|
+
/**
|
|
13758
|
+
* The maximum number of items to return. The default is '50'.
|
|
13759
|
+
* @format int32
|
|
13760
|
+
*/
|
|
13761
|
+
limit?: number;
|
|
13762
|
+
/**
|
|
13763
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13764
|
+
* used.
|
|
13765
|
+
*/
|
|
13766
|
+
mode?: ListMode;
|
|
13767
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsHistoryResponse, any>>;
|
|
13768
|
+
/**
|
|
13769
|
+
* @description Gets a list of sync unit historical records.
|
|
13770
|
+
*
|
|
13771
|
+
* @tags airdrop
|
|
13772
|
+
* @name AirdropSyncUnitsHistoryPost
|
|
13773
|
+
* @request POST:/airdrop.sync-units.history
|
|
13774
|
+
* @secure
|
|
13775
|
+
*/
|
|
13776
|
+
airdropSyncUnitsHistoryPost: (data: AirdropSyncUnitsHistoryRequest, params?: RequestParams) => Promise<AxiosResponse<AirdropSyncUnitsHistoryResponse, any>>;
|
|
12531
13777
|
/**
|
|
12532
13778
|
* @description Get count of articles matching given filter.
|
|
12533
13779
|
*
|
|
@@ -12569,10 +13815,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12569
13815
|
* @example ["DEVU-12345"]
|
|
12570
13816
|
*/
|
|
12571
13817
|
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
|
-
*/
|
|
13818
|
+
/** Filter for the scope of the articles. */
|
|
12576
13819
|
scope?: number[];
|
|
12577
13820
|
/** ID of the group/member with whom the item is shared. */
|
|
12578
13821
|
'shared_with.member'?: string;
|
|
@@ -12684,10 +13927,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12684
13927
|
* @example ["DEVU-12345"]
|
|
12685
13928
|
*/
|
|
12686
13929
|
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
|
-
*/
|
|
13930
|
+
/** Filter for the scope of the articles. */
|
|
12691
13931
|
scope?: number[];
|
|
12692
13932
|
/** ID of the group/member with whom the item is shared. */
|
|
12693
13933
|
'shared_with.member'?: string;
|
|
@@ -13116,6 +14356,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13116
14356
|
* @example ["PROD-12345"]
|
|
13117
14357
|
*/
|
|
13118
14358
|
applies_to_parts?: string[];
|
|
14359
|
+
/** Filters for custom fields. */
|
|
14360
|
+
custom_fields?: object;
|
|
13119
14361
|
/**
|
|
13120
14362
|
* The number of conversation items to return. The default is '50', the
|
|
13121
14363
|
* maximum is '5000'.
|
|
@@ -13141,15 +14383,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13141
14383
|
/**
|
|
13142
14384
|
* Filters for conversations that are associated with any of the
|
|
13143
14385
|
* provided Rev organizations.
|
|
14386
|
+
* @deprecated
|
|
13144
14387
|
* @example ["REV-AbCdEfGh"]
|
|
13145
14388
|
*/
|
|
13146
14389
|
rev_org?: string[];
|
|
14390
|
+
/**
|
|
14391
|
+
* Filters for conversations that are associated with any of the
|
|
14392
|
+
* provided Rev organizations.
|
|
14393
|
+
* @example ["REV-AbCdEfGh"]
|
|
14394
|
+
*/
|
|
14395
|
+
rev_orgs?: string[];
|
|
13147
14396
|
/** Filters for records with any of the provided SLA stages. */
|
|
13148
14397
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13149
14398
|
/** Filters for conversations with any of the provided source channels. */
|
|
14399
|
+
source_channel?: string[];
|
|
14400
|
+
/**
|
|
14401
|
+
* Filters for conversations with any of the provided source channels.
|
|
14402
|
+
* @deprecated
|
|
14403
|
+
*/
|
|
13150
14404
|
source_channels?: string[];
|
|
13151
14405
|
/** Filters for records in the provided stage(s) by name. */
|
|
13152
14406
|
'stage.name'?: string[];
|
|
14407
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14408
|
+
subtype?: string[];
|
|
13153
14409
|
/**
|
|
13154
14410
|
* Filters for conversations with any of the provided tags.
|
|
13155
14411
|
* @deprecated
|
|
@@ -13216,6 +14472,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13216
14472
|
* starts from the beginning.
|
|
13217
14473
|
*/
|
|
13218
14474
|
cursor?: string;
|
|
14475
|
+
/** Filters for custom fields. */
|
|
14476
|
+
custom_fields?: object;
|
|
13219
14477
|
/** Filters for conversation that belong to the given groups. */
|
|
13220
14478
|
group?: string[];
|
|
13221
14479
|
/** Filters for conversations that are created by verified users. */
|
|
@@ -13245,15 +14503,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13245
14503
|
/**
|
|
13246
14504
|
* Filters for conversations that are associated with any of the
|
|
13247
14505
|
* provided Rev organizations.
|
|
14506
|
+
* @deprecated
|
|
13248
14507
|
* @example ["REV-AbCdEfGh"]
|
|
13249
14508
|
*/
|
|
13250
14509
|
rev_org?: string[];
|
|
14510
|
+
/**
|
|
14511
|
+
* Filters for conversations that are associated with any of the
|
|
14512
|
+
* provided Rev organizations.
|
|
14513
|
+
* @example ["REV-AbCdEfGh"]
|
|
14514
|
+
*/
|
|
14515
|
+
rev_orgs?: string[];
|
|
13251
14516
|
/** Filters for records with any of the provided SLA stages. */
|
|
13252
14517
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13253
14518
|
/** Filters for conversations with any of the provided source channels. */
|
|
14519
|
+
source_channel?: string[];
|
|
14520
|
+
/**
|
|
14521
|
+
* Filters for conversations with any of the provided source channels.
|
|
14522
|
+
* @deprecated
|
|
14523
|
+
*/
|
|
13254
14524
|
source_channels?: string[];
|
|
13255
14525
|
/** Filters for records in the provided stage(s) by name. */
|
|
13256
14526
|
'stage.name'?: string[];
|
|
14527
|
+
/** Filters for conversation with any of the provided subtypes. */
|
|
14528
|
+
subtype?: string[];
|
|
13257
14529
|
/**
|
|
13258
14530
|
* Filters for conversations with any of the provided tags.
|
|
13259
14531
|
* @deprecated
|
|
@@ -13475,6 +14747,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13475
14747
|
* @secure
|
|
13476
14748
|
*/
|
|
13477
14749
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
14750
|
+
/**
|
|
14751
|
+
* @description Activates the requested user.
|
|
14752
|
+
*
|
|
14753
|
+
* @tags dev-users
|
|
14754
|
+
* @name DevUsersActivate
|
|
14755
|
+
* @request POST:/dev-users.activate
|
|
14756
|
+
* @secure
|
|
14757
|
+
*/
|
|
14758
|
+
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any>>;
|
|
14759
|
+
/**
|
|
14760
|
+
* @description Deactivates the requested user.
|
|
14761
|
+
*
|
|
14762
|
+
* @tags dev-users
|
|
14763
|
+
* @name DevUsersDeactivate
|
|
14764
|
+
* @request POST:/dev-users.deactivate
|
|
14765
|
+
* @secure
|
|
14766
|
+
*/
|
|
14767
|
+
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
13478
14768
|
/**
|
|
13479
14769
|
* @description Gets the requested user's information.
|
|
13480
14770
|
*
|
|
@@ -14424,6 +15714,163 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14424
15714
|
* @secure
|
|
14425
15715
|
*/
|
|
14426
15716
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
15717
|
+
/**
|
|
15718
|
+
* @description Counts the meeting records.
|
|
15719
|
+
*
|
|
15720
|
+
* @tags meetings
|
|
15721
|
+
* @name MeetingsCount
|
|
15722
|
+
* @request GET:/meetings.count
|
|
15723
|
+
* @secure
|
|
15724
|
+
*/
|
|
15725
|
+
meetingsCount: (query?: {
|
|
15726
|
+
/** Filters for meeting on specified channels. */
|
|
15727
|
+
channel?: MeetingChannel[];
|
|
15728
|
+
/** Filters for meetings created by the specified user(s). */
|
|
15729
|
+
created_by?: string[];
|
|
15730
|
+
/** Filters for meeting on custom fields. */
|
|
15731
|
+
custom_fields?: object;
|
|
15732
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
15733
|
+
external_ref?: string[];
|
|
15734
|
+
/** Filters for link type in links associated with the meeting. */
|
|
15735
|
+
'links.link_type'?: string;
|
|
15736
|
+
/** Filters for target id in links associated with the meeting. */
|
|
15737
|
+
'links.target'?: string;
|
|
15738
|
+
/** Filters for target object type in links associated with the meeting. */
|
|
15739
|
+
'links.target_object_type'?: string;
|
|
15740
|
+
/** Filter for meeting on specified Member Ids. */
|
|
15741
|
+
members?: string[];
|
|
15742
|
+
/** Filter for meeting on specified organizers. */
|
|
15743
|
+
organizer?: string[];
|
|
15744
|
+
/**
|
|
15745
|
+
* Filters for meetings with the provided parent.
|
|
15746
|
+
* @example ["ACC-12345"]
|
|
15747
|
+
*/
|
|
15748
|
+
parent?: string[];
|
|
15749
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
15750
|
+
state?: MeetingState[];
|
|
15751
|
+
/** Filters for meeting by tags. */
|
|
15752
|
+
tags?: string[];
|
|
15753
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
|
|
15754
|
+
/**
|
|
15755
|
+
* @description Counts the meeting records.
|
|
15756
|
+
*
|
|
15757
|
+
* @tags meetings
|
|
15758
|
+
* @name MeetingsCountPost
|
|
15759
|
+
* @request POST:/meetings.count
|
|
15760
|
+
* @secure
|
|
15761
|
+
*/
|
|
15762
|
+
meetingsCountPost: (data: MeetingsCountRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
|
|
15763
|
+
/**
|
|
15764
|
+
* @description Creates a new meeting record.
|
|
15765
|
+
*
|
|
15766
|
+
* @tags meetings
|
|
15767
|
+
* @name MeetingsCreate
|
|
15768
|
+
* @request POST:/meetings.create
|
|
15769
|
+
* @secure
|
|
15770
|
+
*/
|
|
15771
|
+
meetingsCreate: (data: MeetingsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCreateResponse, any>>;
|
|
15772
|
+
/**
|
|
15773
|
+
* @description Deletes the meeting record.
|
|
15774
|
+
*
|
|
15775
|
+
* @tags meetings
|
|
15776
|
+
* @name MeetingsDelete
|
|
15777
|
+
* @request POST:/meetings.delete
|
|
15778
|
+
* @secure
|
|
15779
|
+
*/
|
|
15780
|
+
meetingsDelete: (data: MeetingsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15781
|
+
/**
|
|
15782
|
+
* @description Gets the meeting record.
|
|
15783
|
+
*
|
|
15784
|
+
* @tags meetings
|
|
15785
|
+
* @name MeetingsGet
|
|
15786
|
+
* @request GET:/meetings.get
|
|
15787
|
+
* @secure
|
|
15788
|
+
*/
|
|
15789
|
+
meetingsGet: (query: {
|
|
15790
|
+
/** The meeting's ID. */
|
|
15791
|
+
id: string;
|
|
15792
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any>>;
|
|
15793
|
+
/**
|
|
15794
|
+
* @description Gets the meeting record.
|
|
15795
|
+
*
|
|
15796
|
+
* @tags meetings
|
|
15797
|
+
* @name MeetingsGetPost
|
|
15798
|
+
* @request POST:/meetings.get
|
|
15799
|
+
* @secure
|
|
15800
|
+
*/
|
|
15801
|
+
meetingsGetPost: (data: MeetingsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any>>;
|
|
15802
|
+
/**
|
|
15803
|
+
* @description Lists the meeting records.
|
|
15804
|
+
*
|
|
15805
|
+
* @tags meetings
|
|
15806
|
+
* @name MeetingsList
|
|
15807
|
+
* @request GET:/meetings.list
|
|
15808
|
+
* @secure
|
|
15809
|
+
*/
|
|
15810
|
+
meetingsList: (query?: {
|
|
15811
|
+
/** Filters for meeting on specified channels. */
|
|
15812
|
+
channel?: MeetingChannel[];
|
|
15813
|
+
/** Filters for meetings created by the specified user(s). */
|
|
15814
|
+
created_by?: string[];
|
|
15815
|
+
/**
|
|
15816
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
15817
|
+
* starts from the beginning.
|
|
15818
|
+
*/
|
|
15819
|
+
cursor?: string;
|
|
15820
|
+
/** Filters for meeting on custom fields. */
|
|
15821
|
+
custom_fields?: object;
|
|
15822
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
15823
|
+
external_ref?: string[];
|
|
15824
|
+
/**
|
|
15825
|
+
* The maximum number of meetings to return.
|
|
15826
|
+
* @format int32
|
|
15827
|
+
*/
|
|
15828
|
+
limit?: number;
|
|
15829
|
+
/** Filters for link type in links associated with the meeting. */
|
|
15830
|
+
'links.link_type'?: string;
|
|
15831
|
+
/** Filters for target id in links associated with the meeting. */
|
|
15832
|
+
'links.target'?: string;
|
|
15833
|
+
/** Filters for target object type in links associated with the meeting. */
|
|
15834
|
+
'links.target_object_type'?: string;
|
|
15835
|
+
/** Filter for meeting on specified Member Ids. */
|
|
15836
|
+
members?: string[];
|
|
15837
|
+
/**
|
|
15838
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
15839
|
+
* used.
|
|
15840
|
+
*/
|
|
15841
|
+
mode?: ListMode;
|
|
15842
|
+
/** Filter for meeting on specified organizers. */
|
|
15843
|
+
organizer?: string[];
|
|
15844
|
+
/**
|
|
15845
|
+
* Filters for meetings with the provided parent.
|
|
15846
|
+
* @example ["ACC-12345"]
|
|
15847
|
+
*/
|
|
15848
|
+
parent?: string[];
|
|
15849
|
+
/** Fields to sort the meetings by and the direction to sort them. */
|
|
15850
|
+
sort_by?: string[];
|
|
15851
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
15852
|
+
state?: MeetingState[];
|
|
15853
|
+
/** Filters for meeting by tags. */
|
|
15854
|
+
tags?: string[];
|
|
15855
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
|
|
15856
|
+
/**
|
|
15857
|
+
* @description Lists the meeting records.
|
|
15858
|
+
*
|
|
15859
|
+
* @tags meetings
|
|
15860
|
+
* @name MeetingsListPost
|
|
15861
|
+
* @request POST:/meetings.list
|
|
15862
|
+
* @secure
|
|
15863
|
+
*/
|
|
15864
|
+
meetingsListPost: (data: MeetingsListRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
|
|
15865
|
+
/**
|
|
15866
|
+
* @description Updates the meeting record.
|
|
15867
|
+
*
|
|
15868
|
+
* @tags meetings
|
|
15869
|
+
* @name MeetingsUpdate
|
|
15870
|
+
* @request POST:/meetings.update
|
|
15871
|
+
* @secure
|
|
15872
|
+
*/
|
|
15873
|
+
meetingsUpdate: (data: MeetingsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsUpdateResponse, any>>;
|
|
14427
15874
|
/**
|
|
14428
15875
|
* @description Executes the metric action on the given object.
|
|
14429
15876
|
*
|
|
@@ -14600,6 +16047,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14600
16047
|
* @secure
|
|
14601
16048
|
*/
|
|
14602
16049
|
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any>>;
|
|
16050
|
+
/**
|
|
16051
|
+
* @description Evaluates an organization's schedule at specified instants.
|
|
16052
|
+
*
|
|
16053
|
+
* @tags schedules
|
|
16054
|
+
* @name OrgSchedulesEvaluate
|
|
16055
|
+
* @request GET:/org-schedules.evaluate
|
|
16056
|
+
* @secure
|
|
16057
|
+
*/
|
|
16058
|
+
orgSchedulesEvaluate: (query: {
|
|
16059
|
+
/** Organization schedule ID. */
|
|
16060
|
+
id: string;
|
|
16061
|
+
/**
|
|
16062
|
+
* Time instants to evaluate the organization schedule for.
|
|
16063
|
+
* @minItems 1
|
|
16064
|
+
* @example ["2023-01-01T12:00:00.000Z"]
|
|
16065
|
+
*/
|
|
16066
|
+
instants: string[];
|
|
16067
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any>>;
|
|
16068
|
+
/**
|
|
16069
|
+
* @description Evaluates an organization's schedule at specified instants.
|
|
16070
|
+
*
|
|
16071
|
+
* @tags schedules
|
|
16072
|
+
* @name OrgSchedulesEvaluatePost
|
|
16073
|
+
* @request POST:/org-schedules.evaluate
|
|
16074
|
+
* @secure
|
|
16075
|
+
*/
|
|
16076
|
+
orgSchedulesEvaluatePost: (data: OrgSchedulesEvaluateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any>>;
|
|
14603
16077
|
/**
|
|
14604
16078
|
* @description Gets an organization schedule.
|
|
14605
16079
|
*
|
|
@@ -16150,6 +17624,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16150
17624
|
* @secure
|
|
16151
17625
|
*/
|
|
16152
17626
|
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
17627
|
+
/**
|
|
17628
|
+
* @description Updates a survey's metadata.
|
|
17629
|
+
*
|
|
17630
|
+
* @tags surveys
|
|
17631
|
+
* @name SurveysUpdate
|
|
17632
|
+
* @request POST:/surveys.update
|
|
17633
|
+
* @secure
|
|
17634
|
+
*/
|
|
17635
|
+
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any>>;
|
|
16153
17636
|
/**
|
|
16154
17637
|
* @description Lists system users within your organization.
|
|
16155
17638
|
*
|
|
@@ -16577,6 +18060,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16577
18060
|
* @secure
|
|
16578
18061
|
*/
|
|
16579
18062
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
18063
|
+
/**
|
|
18064
|
+
* @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.
|
|
18065
|
+
*
|
|
18066
|
+
* @tags webhooks
|
|
18067
|
+
* @name WebhooksEvent
|
|
18068
|
+
* @request POST:/webhooks.event
|
|
18069
|
+
* @secure
|
|
18070
|
+
*/
|
|
18071
|
+
webhooksEvent: (data: WebhookEventRequest, params?: RequestParams) => Promise<AxiosResponse<WebhookEventResponse, any>>;
|
|
16580
18072
|
/**
|
|
16581
18073
|
* @description Fetches an object via webhook.
|
|
16582
18074
|
*
|