@devrev/typescript-sdk 1.1.23 → 1.1.24
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.
|
@@ -32,11 +32,17 @@ export type Account = OrgBase & {
|
|
|
32
32
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
33
33
|
*/
|
|
34
34
|
stock_schema_fragment?: string;
|
|
35
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
36
|
+
subtype?: string;
|
|
35
37
|
/** Tags associated with an object. */
|
|
36
38
|
tags?: TagWithValue[];
|
|
37
39
|
/** The Tier of the corresponding Account. */
|
|
38
40
|
tier?: string;
|
|
39
41
|
};
|
|
42
|
+
/** account-search-summary */
|
|
43
|
+
export type AccountSearchSummary = SearchSummaryBase & {
|
|
44
|
+
account: AccountSummary;
|
|
45
|
+
};
|
|
40
46
|
/** account-summary */
|
|
41
47
|
export type AccountSummary = OrgBaseSummary;
|
|
42
48
|
/**
|
|
@@ -59,8 +65,7 @@ export interface AccountsCreateRequest {
|
|
|
59
65
|
domains?: string[];
|
|
60
66
|
/**
|
|
61
67
|
* External refs are unique identifiers from your customer system of
|
|
62
|
-
* records, stored as a list.
|
|
63
|
-
* limited to 1.
|
|
68
|
+
* records, stored as a list.
|
|
64
69
|
*/
|
|
65
70
|
external_refs?: string[];
|
|
66
71
|
/** List of Dev users owning this account. */
|
|
@@ -74,6 +79,11 @@ export interface AccountsCreateRequest {
|
|
|
74
79
|
tags?: SetTagWithValue[];
|
|
75
80
|
/** The tier of the account. */
|
|
76
81
|
tier?: string;
|
|
82
|
+
/**
|
|
83
|
+
* List of company websites. Example - ['www.devrev.ai',
|
|
84
|
+
* 'www.marketplace.devrev.ai'].
|
|
85
|
+
*/
|
|
86
|
+
websites?: string[];
|
|
77
87
|
}
|
|
78
88
|
/**
|
|
79
89
|
* accounts-create-response
|
|
@@ -256,10 +266,7 @@ export interface AccountsUpdateRequest {
|
|
|
256
266
|
display_name?: string;
|
|
257
267
|
/** Updated list of company's domain names. Example - ['devrev.ai']. */
|
|
258
268
|
domains?: string[];
|
|
259
|
-
/**
|
|
260
|
-
* Updated External Refs of account. Currently the length of this
|
|
261
|
-
* field is limited to 1.
|
|
262
|
-
*/
|
|
269
|
+
/** Updated External Refs of account. */
|
|
263
270
|
external_refs?: string[];
|
|
264
271
|
/**
|
|
265
272
|
* The ID of account to update.
|
|
@@ -276,7 +283,7 @@ export interface AccountsUpdateRequest {
|
|
|
276
283
|
/** Updated tags list associated with the account. */
|
|
277
284
|
tags?: SetTagWithValue[];
|
|
278
285
|
/** Updated tier of the account. */
|
|
279
|
-
tier?: string;
|
|
286
|
+
tier?: string | null;
|
|
280
287
|
}
|
|
281
288
|
/** accounts-update-request-artifacts */
|
|
282
289
|
export interface AccountsUpdateRequestArtifacts {
|
|
@@ -302,6 +309,11 @@ export type AggregatedSchema = object;
|
|
|
302
309
|
export interface AggregatedSchemaGetRequest {
|
|
303
310
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
304
311
|
custom_schema_fragment_ids: string[];
|
|
312
|
+
/**
|
|
313
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
314
|
+
* tenant fragment ID.
|
|
315
|
+
*/
|
|
316
|
+
leaf_type?: string;
|
|
305
317
|
/** Per object schema, if associated with the leaf type. */
|
|
306
318
|
per_object_schema?: FieldDescriptor[];
|
|
307
319
|
/** The stock schema fragment which is to be aggregated. */
|
|
@@ -385,6 +397,37 @@ export type AppFragment = CustomSchemaFragmentBase & {
|
|
|
385
397
|
};
|
|
386
398
|
/** app-fragment-summary */
|
|
387
399
|
export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
400
|
+
/**
|
|
401
|
+
* archetype-metric-target
|
|
402
|
+
* Metric with corresponding target values.
|
|
403
|
+
*/
|
|
404
|
+
export interface ArchetypeMetricTarget {
|
|
405
|
+
/**
|
|
406
|
+
* If true, the schedule attached to this metric is out of schedule at
|
|
407
|
+
* the time of the query.
|
|
408
|
+
*/
|
|
409
|
+
is_out_of_schedule?: boolean;
|
|
410
|
+
metric_definition: MetricDefinitionSummary;
|
|
411
|
+
org_schedule?: OrgScheduleSummary;
|
|
412
|
+
/**
|
|
413
|
+
* Time in minutes that remains on a paused metric.
|
|
414
|
+
* @format int32
|
|
415
|
+
*/
|
|
416
|
+
remaining_time?: number;
|
|
417
|
+
/**
|
|
418
|
+
* Time at which the metric would breach SLA if no action taken.
|
|
419
|
+
* @format date-time
|
|
420
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
421
|
+
*/
|
|
422
|
+
target_time?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Time at which the metric would reach the SLA warning limit if no
|
|
425
|
+
* action taken.
|
|
426
|
+
* @format date-time
|
|
427
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
428
|
+
*/
|
|
429
|
+
warning_target_time?: string;
|
|
430
|
+
}
|
|
388
431
|
/** article */
|
|
389
432
|
export type Article = AtomBase & {
|
|
390
433
|
/** Details of the parts relevant to the article. */
|
|
@@ -393,6 +436,16 @@ export type Article = AtomBase & {
|
|
|
393
436
|
description?: string;
|
|
394
437
|
/** Artifacts containing the extracted content. */
|
|
395
438
|
extracted_content?: ArtifactSummary[];
|
|
439
|
+
/**
|
|
440
|
+
* Number of downvotes on the article.
|
|
441
|
+
* @format int32
|
|
442
|
+
*/
|
|
443
|
+
num_downvotes?: number;
|
|
444
|
+
/**
|
|
445
|
+
* Number of upvotes on the article.
|
|
446
|
+
* @format int32
|
|
447
|
+
*/
|
|
448
|
+
num_upvotes?: number;
|
|
396
449
|
parent?: DirectorySummary;
|
|
397
450
|
/** Rank of the article. */
|
|
398
451
|
rank?: string;
|
|
@@ -401,6 +454,10 @@ export type Article = AtomBase & {
|
|
|
401
454
|
/** Title of the article. */
|
|
402
455
|
title?: string;
|
|
403
456
|
};
|
|
457
|
+
/** article-search-summary */
|
|
458
|
+
export type ArticleSearchSummary = SearchSummaryBase & {
|
|
459
|
+
article: ArticleSummary;
|
|
460
|
+
};
|
|
404
461
|
/** Status of the article. */
|
|
405
462
|
export declare enum ArticleStatus {
|
|
406
463
|
Archived = "archived",
|
|
@@ -408,6 +465,13 @@ export declare enum ArticleStatus {
|
|
|
408
465
|
Published = "published",
|
|
409
466
|
ReviewNeeded = "review_needed"
|
|
410
467
|
}
|
|
468
|
+
/** article-summary */
|
|
469
|
+
export type ArticleSummary = AtomBaseSummary & {
|
|
470
|
+
/** Resource details. */
|
|
471
|
+
resource?: ResourceSummary;
|
|
472
|
+
/** Title of the article. */
|
|
473
|
+
title?: string;
|
|
474
|
+
};
|
|
411
475
|
/** articles-count-request */
|
|
412
476
|
export interface ArticlesCountRequest {
|
|
413
477
|
/**
|
|
@@ -482,7 +546,7 @@ export interface ArticlesCreateRequest {
|
|
|
482
546
|
published_at?: string;
|
|
483
547
|
resource: ArticlesCreateRequestResource;
|
|
484
548
|
/** Information about the role the member receives due to the share. */
|
|
485
|
-
shared_with?:
|
|
549
|
+
shared_with?: SetSharedWithMembership[];
|
|
486
550
|
/** Status of the article. */
|
|
487
551
|
status?: ArticleStatus;
|
|
488
552
|
/** Tags associated with the article. */
|
|
@@ -703,7 +767,7 @@ export interface ArticlesUpdateRequestReorder {
|
|
|
703
767
|
/** articles-update-request-shared-with */
|
|
704
768
|
export interface ArticlesUpdateRequestSharedWith {
|
|
705
769
|
/** Sets the field to the provided membership list. */
|
|
706
|
-
set?:
|
|
770
|
+
set?: SetSharedWithMembership[];
|
|
707
771
|
}
|
|
708
772
|
/** articles-update-request-tags */
|
|
709
773
|
export interface ArticlesUpdateRequestTags {
|
|
@@ -716,6 +780,10 @@ export interface ArticlesUpdateResponse {
|
|
|
716
780
|
}
|
|
717
781
|
/** artifact */
|
|
718
782
|
export type Artifact = AtomBase;
|
|
783
|
+
/** artifact-search-summary */
|
|
784
|
+
export type ArtifactSearchSummary = SearchSummaryBase & {
|
|
785
|
+
artifact: ArtifactSummary;
|
|
786
|
+
};
|
|
719
787
|
/** artifact-summary */
|
|
720
788
|
export type ArtifactSummary = AtomBaseSummary;
|
|
721
789
|
/**
|
|
@@ -761,7 +829,7 @@ export interface ArtifactsGetResponse {
|
|
|
761
829
|
*/
|
|
762
830
|
export interface ArtifactsListRequest {
|
|
763
831
|
/** The ID of the object to filter artifacts. */
|
|
764
|
-
parent_id
|
|
832
|
+
parent_id?: string;
|
|
765
833
|
}
|
|
766
834
|
/**
|
|
767
835
|
* artifacts-list-response
|
|
@@ -1047,8 +1115,10 @@ export declare enum AuthTokenGrantType {
|
|
|
1047
1115
|
/** The type of the requested token. */
|
|
1048
1116
|
export declare enum AuthTokenRequestedTokenType {
|
|
1049
1117
|
UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
|
|
1118
|
+
UrnDevrevParamsOauthTokenTypeAatActAs = "urn:devrev:params:oauth:token-type:aat:act-as",
|
|
1050
1119
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
1051
1120
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
1121
|
+
UrnDevrevParamsOauthTokenTypeDevConnect = "urn:devrev:params:oauth:token-type:dev:connect",
|
|
1052
1122
|
UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
|
|
1053
1123
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
1054
1124
|
UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
|
|
@@ -1089,7 +1159,10 @@ export declare enum AuthTokenTokenType {
|
|
|
1089
1159
|
* type.
|
|
1090
1160
|
*/
|
|
1091
1161
|
export interface AuthTokensCreateRequest {
|
|
1092
|
-
/**
|
|
1162
|
+
/**
|
|
1163
|
+
* The unique ID of the Dev user or the service account to
|
|
1164
|
+
* impersonate.
|
|
1165
|
+
*/
|
|
1093
1166
|
act_as?: string;
|
|
1094
1167
|
/** The expected audience values with respect to the token. */
|
|
1095
1168
|
aud?: string[];
|
|
@@ -1305,6 +1378,101 @@ export interface AuthTokensUserTraits {
|
|
|
1305
1378
|
export type Capability = PartBase;
|
|
1306
1379
|
/** capability-summary */
|
|
1307
1380
|
export type CapabilitySummary = PartBaseSummary;
|
|
1381
|
+
/**
|
|
1382
|
+
* client-context
|
|
1383
|
+
* Properties of client to be used in track API.
|
|
1384
|
+
*/
|
|
1385
|
+
export interface ClientContext {
|
|
1386
|
+
/** Properties of client's browser to be used in track API. */
|
|
1387
|
+
browser?: ClientContextBrowser;
|
|
1388
|
+
/** Properties of client's CPU to be used in track API. */
|
|
1389
|
+
cpu?: ClientContextCpu;
|
|
1390
|
+
/** Properties of client's device to be used in track API. */
|
|
1391
|
+
device?: ClientContextDevice;
|
|
1392
|
+
/** Properties of client's engine to be used in track API. */
|
|
1393
|
+
engine?: ClientContextEngine;
|
|
1394
|
+
/** IP address of the client. */
|
|
1395
|
+
ip?: string;
|
|
1396
|
+
/** The client's locale, example: en-US. */
|
|
1397
|
+
locale?: string;
|
|
1398
|
+
/** Properties of client's OS to be used in track API. */
|
|
1399
|
+
os?: ClientContextOs;
|
|
1400
|
+
/** Properties of client's page to be used in track API. */
|
|
1401
|
+
page?: ClientContextPage;
|
|
1402
|
+
/** The client's timezone, example: Asia/Kolkata. */
|
|
1403
|
+
timezone?: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* User agent of the client, example: Mozilla/5.0 (Macintosh; Intel
|
|
1406
|
+
* Mac OS X.
|
|
1407
|
+
*/
|
|
1408
|
+
user_agent?: string;
|
|
1409
|
+
}
|
|
1410
|
+
/**
|
|
1411
|
+
* client-context-browser
|
|
1412
|
+
* Properties of client's browser to be used in track API.
|
|
1413
|
+
*/
|
|
1414
|
+
export interface ClientContextBrowser {
|
|
1415
|
+
/** The browser's name, example: Chrome, Safari. */
|
|
1416
|
+
name?: string;
|
|
1417
|
+
/** The browser's version, example: 53.0.2785.143. */
|
|
1418
|
+
version?: string;
|
|
1419
|
+
}
|
|
1420
|
+
/**
|
|
1421
|
+
* client-context-cpu
|
|
1422
|
+
* Properties of client's CPU to be used in track API.
|
|
1423
|
+
*/
|
|
1424
|
+
export interface ClientContextCpu {
|
|
1425
|
+
/** CPU architecture, example: amd64. */
|
|
1426
|
+
architecture?: string;
|
|
1427
|
+
}
|
|
1428
|
+
/**
|
|
1429
|
+
* client-context-device
|
|
1430
|
+
* Properties of client's device to be used in track API.
|
|
1431
|
+
*/
|
|
1432
|
+
export interface ClientContextDevice {
|
|
1433
|
+
/** Device manufacturer, example: Apple. */
|
|
1434
|
+
manufacturer?: string;
|
|
1435
|
+
/** Device model, example: iphone 6s. */
|
|
1436
|
+
model?: string;
|
|
1437
|
+
/** Device type, example: mobile, tablet, desktop. */
|
|
1438
|
+
type?: string;
|
|
1439
|
+
}
|
|
1440
|
+
/**
|
|
1441
|
+
* client-context-engine
|
|
1442
|
+
* Properties of client's engine to be used in track API.
|
|
1443
|
+
*/
|
|
1444
|
+
export interface ClientContextEngine {
|
|
1445
|
+
/** The engine's name, example: Blink, WebKit. */
|
|
1446
|
+
name?: string;
|
|
1447
|
+
/** The engine's version, example: 537.36. */
|
|
1448
|
+
version?: string;
|
|
1449
|
+
}
|
|
1450
|
+
/**
|
|
1451
|
+
* client-context-os
|
|
1452
|
+
* Properties of client's OS to be used in track API.
|
|
1453
|
+
*/
|
|
1454
|
+
export interface ClientContextOs {
|
|
1455
|
+
/** The OS's name, example : Windows, Mac OS X. */
|
|
1456
|
+
name?: string;
|
|
1457
|
+
/** The OS's version, example : 10.11.1. */
|
|
1458
|
+
version?: string;
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* client-context-page
|
|
1462
|
+
* Properties of client's page to be used in track API.
|
|
1463
|
+
*/
|
|
1464
|
+
export interface ClientContextPage {
|
|
1465
|
+
/** Page domain, example: devrev.ai */
|
|
1466
|
+
domain?: string;
|
|
1467
|
+
/** Page path, example: /pricing */
|
|
1468
|
+
path?: string;
|
|
1469
|
+
/** Page referrer, example: https://devrev.ai */
|
|
1470
|
+
referrer?: string;
|
|
1471
|
+
/** Page title, example: Pricing */
|
|
1472
|
+
title?: string;
|
|
1473
|
+
/** Page URL, example: https://devrev.ai/pricing */
|
|
1474
|
+
url?: string;
|
|
1475
|
+
}
|
|
1308
1476
|
/** code-change */
|
|
1309
1477
|
export type CodeChange = AtomBase & {
|
|
1310
1478
|
/** Name of the code branch in the repo. */
|
|
@@ -1413,6 +1581,7 @@ export type Conversation = AtomBase & {
|
|
|
1413
1581
|
metadata?: ConversationMetadata;
|
|
1414
1582
|
/** Owner IDs for the conversation. */
|
|
1415
1583
|
owned_by?: UserSummary[];
|
|
1584
|
+
sla_tracker?: SlaTrackerSummary;
|
|
1416
1585
|
/** Describes the current stage of a work item. */
|
|
1417
1586
|
stage?: LegacyStage;
|
|
1418
1587
|
/** Tags associated with the object. */
|
|
@@ -1431,6 +1600,10 @@ export interface ConversationMetadata {
|
|
|
1431
1600
|
*/
|
|
1432
1601
|
url_context?: string;
|
|
1433
1602
|
}
|
|
1603
|
+
/** conversation-search-summary */
|
|
1604
|
+
export type ConversationSearchSummary = SearchSummaryBase & {
|
|
1605
|
+
conversation: ConversationSummary;
|
|
1606
|
+
};
|
|
1434
1607
|
/** conversation-summary */
|
|
1435
1608
|
export type ConversationSummary = AtomBaseSummary & {
|
|
1436
1609
|
/** Title of the conversation object. */
|
|
@@ -1710,6 +1883,72 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
1710
1883
|
export interface ConversationsUpdateResponse {
|
|
1711
1884
|
conversation: Conversation;
|
|
1712
1885
|
}
|
|
1886
|
+
/**
|
|
1887
|
+
* create-email-info
|
|
1888
|
+
* Information related to an email.
|
|
1889
|
+
*/
|
|
1890
|
+
export interface CreateEmailInfo {
|
|
1891
|
+
/** The address of the email address. */
|
|
1892
|
+
address: string;
|
|
1893
|
+
/** The name of the email address. */
|
|
1894
|
+
name?: string;
|
|
1895
|
+
/** The ID of the user associated with the email address. */
|
|
1896
|
+
user?: string;
|
|
1897
|
+
}
|
|
1898
|
+
/**
|
|
1899
|
+
* create-email-inline-attachment
|
|
1900
|
+
* An inline attachment.
|
|
1901
|
+
*/
|
|
1902
|
+
export interface CreateEmailInlineAttachment {
|
|
1903
|
+
/**
|
|
1904
|
+
* The artifact of the attachment.
|
|
1905
|
+
* @example "ARTIFACT-12345"
|
|
1906
|
+
*/
|
|
1907
|
+
artifact?: string;
|
|
1908
|
+
/** The content id of the attachment. */
|
|
1909
|
+
content_id?: string;
|
|
1910
|
+
}
|
|
1911
|
+
/**
|
|
1912
|
+
* create-email-preview-widget
|
|
1913
|
+
* An email preview widget.
|
|
1914
|
+
*/
|
|
1915
|
+
export interface CreateEmailPreviewWidget {
|
|
1916
|
+
/** The list of bcc addresses. */
|
|
1917
|
+
bcc?: CreateEmailInfo[];
|
|
1918
|
+
/** The list of cc addresses. */
|
|
1919
|
+
cc?: CreateEmailInfo[];
|
|
1920
|
+
/** The list of from addresses. */
|
|
1921
|
+
from?: CreateEmailInfo[];
|
|
1922
|
+
/** The html body of the email. */
|
|
1923
|
+
html_body?: string;
|
|
1924
|
+
/** The in reply to of the email. */
|
|
1925
|
+
in_reply_to?: string;
|
|
1926
|
+
/** The list of inline attachments. */
|
|
1927
|
+
inlines?: CreateEmailInlineAttachment[];
|
|
1928
|
+
/** The message id of the email. */
|
|
1929
|
+
message_id?: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* The raw email artifact.
|
|
1932
|
+
* @example "ARTIFACT-12345"
|
|
1933
|
+
*/
|
|
1934
|
+
raw_email_artifact?: string;
|
|
1935
|
+
/** The list of references in the email. */
|
|
1936
|
+
references?: string[];
|
|
1937
|
+
/** The list of reply to addresses. */
|
|
1938
|
+
reply_to?: CreateEmailInfo[];
|
|
1939
|
+
/**
|
|
1940
|
+
* The time the email was sent.
|
|
1941
|
+
* @format date-time
|
|
1942
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1943
|
+
*/
|
|
1944
|
+
sent_timestamp?: string;
|
|
1945
|
+
/** The subject of the email. */
|
|
1946
|
+
subject?: string;
|
|
1947
|
+
/** The text body of the email. */
|
|
1948
|
+
text_body?: string;
|
|
1949
|
+
/** The list of to addresses. */
|
|
1950
|
+
to?: CreateEmailInfo[];
|
|
1951
|
+
}
|
|
1713
1952
|
/** create-org-schedule-interval */
|
|
1714
1953
|
export interface CreateOrgScheduleInterval {
|
|
1715
1954
|
/**
|
|
@@ -1752,6 +1991,11 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
1752
1991
|
*/
|
|
1753
1992
|
to: number;
|
|
1754
1993
|
}
|
|
1994
|
+
/**
|
|
1995
|
+
* curated-vista-summary
|
|
1996
|
+
* Static collection of Devrev objects.
|
|
1997
|
+
*/
|
|
1998
|
+
export type CuratedVistaSummary = VistaBaseSummary;
|
|
1755
1999
|
/** custom-schema-fragment */
|
|
1756
2000
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
1757
2001
|
type: CustomSchemaFragmentType;
|
|
@@ -1813,8 +2057,8 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1813
2057
|
/** The list of app names. */
|
|
1814
2058
|
app?: string[];
|
|
1815
2059
|
/**
|
|
1816
|
-
* The cursor to resume iteration from
|
|
1817
|
-
*
|
|
2060
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2061
|
+
* iteration starts from the beginning.
|
|
1818
2062
|
*/
|
|
1819
2063
|
cursor?: string;
|
|
1820
2064
|
/** Whether only deprecated fragments should be filtered. */
|
|
@@ -1826,6 +2070,19 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1826
2070
|
* @format int32
|
|
1827
2071
|
*/
|
|
1828
2072
|
limit?: number;
|
|
2073
|
+
/**
|
|
2074
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2075
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2076
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2077
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2078
|
+
* always be returned in the specified sort-by order.
|
|
2079
|
+
*/
|
|
2080
|
+
mode?: ListMode;
|
|
2081
|
+
/**
|
|
2082
|
+
* List of fields which are not required in the payload and can be
|
|
2083
|
+
* pruned away.
|
|
2084
|
+
*/
|
|
2085
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
1829
2086
|
/** The list of fields to sort the items by and how to sort them. */
|
|
1830
2087
|
sort_by?: string[];
|
|
1831
2088
|
/** The list of subtypes. */
|
|
@@ -1833,13 +2090,21 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1833
2090
|
/** Filters for custom schema fragment of the provided types. */
|
|
1834
2091
|
types?: CustomSchemaFragmentType[];
|
|
1835
2092
|
}
|
|
2093
|
+
export declare enum CustomSchemaFragmentsListRequestPrune {
|
|
2094
|
+
Fields = "fields"
|
|
2095
|
+
}
|
|
1836
2096
|
/** custom-schema-fragments-list-response */
|
|
1837
2097
|
export interface CustomSchemaFragmentsListResponse {
|
|
1838
2098
|
/**
|
|
1839
|
-
* The cursor to
|
|
1840
|
-
* then
|
|
2099
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2100
|
+
* sort order. If not set, then no later elements exist.
|
|
1841
2101
|
*/
|
|
1842
|
-
|
|
2102
|
+
next_cursor?: string;
|
|
2103
|
+
/**
|
|
2104
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2105
|
+
* sort order. If not set, then no prior elements exist.
|
|
2106
|
+
*/
|
|
2107
|
+
prev_cursor?: string;
|
|
1843
2108
|
/** The custom schema fragments. */
|
|
1844
2109
|
result: CustomSchemaFragment[];
|
|
1845
2110
|
}
|
|
@@ -1855,6 +2120,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
1855
2120
|
description: string;
|
|
1856
2121
|
/** List of all fields in this fragment. */
|
|
1857
2122
|
fields?: SchemaFieldDescriptor[];
|
|
2123
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
2124
|
+
is_custom_leaf_type?: boolean;
|
|
1858
2125
|
/** The leaf type this fragment applies to. */
|
|
1859
2126
|
leaf_type: string;
|
|
1860
2127
|
type: CustomSchemaFragmentsSetRequestType;
|
|
@@ -1873,6 +2140,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1873
2140
|
path?: CustomTypePathComponent[];
|
|
1874
2141
|
/** The ID of the associated custom stage diagram. */
|
|
1875
2142
|
stage_diagram?: string;
|
|
2143
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
2144
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
1876
2145
|
/** The string used to populate the subtype in the leaf type. */
|
|
1877
2146
|
subtype: string;
|
|
1878
2147
|
/** The display name of the subtype. */
|
|
@@ -1880,6 +2149,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1880
2149
|
}
|
|
1881
2150
|
/** custom-schema-fragments-set-request-tenant-fragment */
|
|
1882
2151
|
export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
2152
|
+
/** The display ID prefix for the custom object. */
|
|
2153
|
+
id_prefix?: string;
|
|
1883
2154
|
/** List of Per-DevOrg stock field overrides. */
|
|
1884
2155
|
stock_field_overrides?: StockFieldOverride[];
|
|
1885
2156
|
}
|
|
@@ -1893,6 +2164,24 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
1893
2164
|
/** The ID of the custom schema fragment. */
|
|
1894
2165
|
id: string;
|
|
1895
2166
|
}
|
|
2167
|
+
/**
|
|
2168
|
+
* custom-schema-spec
|
|
2169
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2170
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2171
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2172
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2173
|
+
* specifier, it remains unmodified.
|
|
2174
|
+
*/
|
|
2175
|
+
export interface CustomSchemaSpec {
|
|
2176
|
+
/** List of apps that are requested. */
|
|
2177
|
+
apps?: string[];
|
|
2178
|
+
/** Name of the subtype requested. */
|
|
2179
|
+
subtype?: string;
|
|
2180
|
+
/** Whether the tenant schema is requested. */
|
|
2181
|
+
tenant_fragment?: boolean;
|
|
2182
|
+
/** Whether to enforce required fields validation. */
|
|
2183
|
+
validate_required_fields?: boolean;
|
|
2184
|
+
}
|
|
1896
2185
|
/** custom-type-fragment */
|
|
1897
2186
|
export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
1898
2187
|
stage_diagram?: StageDiagramSummary;
|
|
@@ -1911,6 +2200,12 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
1911
2200
|
* Path component for rendering custom type lists in tree form.
|
|
1912
2201
|
*/
|
|
1913
2202
|
export type CustomTypePathComponent = object;
|
|
2203
|
+
/** dashboard-search-summary */
|
|
2204
|
+
export type DashboardSearchSummary = SearchSummaryBase & {
|
|
2205
|
+
dashboard: DashboardSummary;
|
|
2206
|
+
};
|
|
2207
|
+
/** dashboard-summary */
|
|
2208
|
+
export type DashboardSummary = AtomBaseSummary;
|
|
1914
2209
|
/**
|
|
1915
2210
|
* date-filter
|
|
1916
2211
|
* Provides ways to specify date ranges on objects.
|
|
@@ -2211,6 +2506,60 @@ export type DirectorySummary = AtomBaseSummary;
|
|
|
2211
2506
|
* Information to define dynamic groups.
|
|
2212
2507
|
*/
|
|
2213
2508
|
export type DynamicGroupInfo = object;
|
|
2509
|
+
/**
|
|
2510
|
+
* dynamic-vista-summary
|
|
2511
|
+
* Dynamic collection of Devrev objects, all adhering to a specific
|
|
2512
|
+
* filter.
|
|
2513
|
+
*/
|
|
2514
|
+
export type DynamicVistaSummary = VistaBaseSummary;
|
|
2515
|
+
/** email-info */
|
|
2516
|
+
export interface EmailInfo {
|
|
2517
|
+
/** The email address. */
|
|
2518
|
+
address: string;
|
|
2519
|
+
/** The email recipient's name. */
|
|
2520
|
+
name?: string;
|
|
2521
|
+
user?: UserSummary;
|
|
2522
|
+
}
|
|
2523
|
+
/** email-inline-attachment */
|
|
2524
|
+
export interface EmailInlineAttachment {
|
|
2525
|
+
artifact?: ArtifactSummary;
|
|
2526
|
+
/** The content id of the attachment. */
|
|
2527
|
+
content_id?: string;
|
|
2528
|
+
}
|
|
2529
|
+
/** email-preview-widget */
|
|
2530
|
+
export type EmailPreviewWidget = SnapWidgetBase & {
|
|
2531
|
+
/** The list of bcc addresses. */
|
|
2532
|
+
bcc: EmailInfo[];
|
|
2533
|
+
/** The list of cc addresses. */
|
|
2534
|
+
cc: EmailInfo[];
|
|
2535
|
+
/** The list of from addresses. */
|
|
2536
|
+
from: EmailInfo[];
|
|
2537
|
+
/** The html body of the email. */
|
|
2538
|
+
html_body?: string;
|
|
2539
|
+
/** The in-reply-to header of the email. */
|
|
2540
|
+
in_reply_to?: string;
|
|
2541
|
+
/** The list of inline attachments. */
|
|
2542
|
+
inlines: EmailInlineAttachment[];
|
|
2543
|
+
/** The message id of the email. */
|
|
2544
|
+
message_id?: string;
|
|
2545
|
+
raw_email_artifact?: ArtifactSummary;
|
|
2546
|
+
/** The references header in the email. */
|
|
2547
|
+
references: string[];
|
|
2548
|
+
/** The list of reply to addresses. */
|
|
2549
|
+
reply_to: EmailInfo[];
|
|
2550
|
+
/**
|
|
2551
|
+
* The time the email was sent.
|
|
2552
|
+
* @format date-time
|
|
2553
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2554
|
+
*/
|
|
2555
|
+
sent_timestamp?: string;
|
|
2556
|
+
/** The subject of the email. */
|
|
2557
|
+
subject?: string;
|
|
2558
|
+
/** The text body of the email. */
|
|
2559
|
+
text_body?: string;
|
|
2560
|
+
/** The list of to addresses. */
|
|
2561
|
+
to: EmailInfo[];
|
|
2562
|
+
};
|
|
2214
2563
|
/** empty */
|
|
2215
2564
|
export type Empty = object;
|
|
2216
2565
|
/** engagement */
|
|
@@ -2273,9 +2622,10 @@ export interface EngagementsCreateRequest {
|
|
|
2273
2622
|
/**
|
|
2274
2623
|
* IDs of the users that were part of the engagement.
|
|
2275
2624
|
* @maxItems 50
|
|
2625
|
+
* @minItems 1
|
|
2276
2626
|
* @example ["DEVU-12345"]
|
|
2277
2627
|
*/
|
|
2278
|
-
members
|
|
2628
|
+
members: string[];
|
|
2279
2629
|
/**
|
|
2280
2630
|
* The parent object ID in which the engagement was created.
|
|
2281
2631
|
* Currently, only accounts and opportunities are supported.
|
|
@@ -2287,7 +2637,7 @@ export interface EngagementsCreateRequest {
|
|
|
2287
2637
|
* @format date-time
|
|
2288
2638
|
* @example "2023-01-01T12:00:00.000Z"
|
|
2289
2639
|
*/
|
|
2290
|
-
scheduled_date
|
|
2640
|
+
scheduled_date: string;
|
|
2291
2641
|
/** Tags associated with the engagement. */
|
|
2292
2642
|
tags?: SetTagWithValue[];
|
|
2293
2643
|
/** The title of the engagement. */
|
|
@@ -2439,7 +2789,7 @@ export interface Error {
|
|
|
2439
2789
|
type?: string;
|
|
2440
2790
|
}
|
|
2441
2791
|
/** error-bad-request */
|
|
2442
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
|
|
2792
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
2443
2793
|
type: ErrorBadRequestType;
|
|
2444
2794
|
};
|
|
2445
2795
|
/** error-bad-request-bad-request */
|
|
@@ -2465,6 +2815,8 @@ export interface ErrorBadRequestInvalidField {
|
|
|
2465
2815
|
}
|
|
2466
2816
|
/** error-bad-request-missing-dependency */
|
|
2467
2817
|
export interface ErrorBadRequestMissingDependency {
|
|
2818
|
+
/** The dependent fields. */
|
|
2819
|
+
dependencies?: ErrorBadRequestMissingDependencyDependency[];
|
|
2468
2820
|
/** The field on which the value depends. */
|
|
2469
2821
|
dependent_field_name?: string;
|
|
2470
2822
|
/** The value which needs to be set of the dependent field. */
|
|
@@ -2474,6 +2826,13 @@ export interface ErrorBadRequestMissingDependency {
|
|
|
2474
2826
|
/** The value that was received. */
|
|
2475
2827
|
provided_field_value?: string;
|
|
2476
2828
|
}
|
|
2829
|
+
/** error-bad-request-missing-dependency-dependency */
|
|
2830
|
+
export interface ErrorBadRequestMissingDependencyDependency {
|
|
2831
|
+
/** The dependent field name. */
|
|
2832
|
+
field_name: string;
|
|
2833
|
+
/** The dependent field value. */
|
|
2834
|
+
field_value: string;
|
|
2835
|
+
}
|
|
2477
2836
|
/** error-bad-request-missing-required-field */
|
|
2478
2837
|
export interface ErrorBadRequestMissingRequiredField {
|
|
2479
2838
|
/** The missing field's name. */
|
|
@@ -2499,10 +2858,28 @@ export declare enum ErrorBadRequestType {
|
|
|
2499
2858
|
MissingRequiredField = "missing_required_field",
|
|
2500
2859
|
ParseError = "parse_error",
|
|
2501
2860
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
2861
|
+
UnexpectedJsonType = "unexpected_json_type",
|
|
2502
2862
|
ValueNotPermitted = "value_not_permitted"
|
|
2503
2863
|
}
|
|
2864
|
+
/** error-bad-request-unexpected-json-type */
|
|
2865
|
+
export interface ErrorBadRequestUnexpectedJsonType {
|
|
2866
|
+
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
2867
|
+
expected: ErrorBadRequestUnexpectedJsonTypeType;
|
|
2868
|
+
/** The field name that's invalid. */
|
|
2869
|
+
field_name: string;
|
|
2870
|
+
}
|
|
2871
|
+
export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
2872
|
+
Array = "array",
|
|
2873
|
+
Bool = "bool",
|
|
2874
|
+
Null = "null",
|
|
2875
|
+
Number = "number",
|
|
2876
|
+
Object = "object",
|
|
2877
|
+
String = "string"
|
|
2878
|
+
}
|
|
2504
2879
|
/** error-bad-request-value-not-permitted */
|
|
2505
2880
|
export interface ErrorBadRequestValueNotPermitted {
|
|
2881
|
+
/** The allowed values for the field. */
|
|
2882
|
+
allowed_values?: string[];
|
|
2506
2883
|
/** The field whose value is not permitted. */
|
|
2507
2884
|
field_name: string;
|
|
2508
2885
|
/** The reason the value isn't permitted. */
|
|
@@ -2515,6 +2892,15 @@ export interface ErrorBase {
|
|
|
2515
2892
|
/** The message associated with the error. */
|
|
2516
2893
|
message?: string;
|
|
2517
2894
|
}
|
|
2895
|
+
/** error-conflict */
|
|
2896
|
+
export type ErrorConflict = ErrorBase & ErrorConflictConflict & {
|
|
2897
|
+
type: ErrorConflictType;
|
|
2898
|
+
};
|
|
2899
|
+
/** error-conflict-conflict */
|
|
2900
|
+
export type ErrorConflictConflict = object;
|
|
2901
|
+
export declare enum ErrorConflictType {
|
|
2902
|
+
Conflict = "conflict"
|
|
2903
|
+
}
|
|
2518
2904
|
/** error-forbidden */
|
|
2519
2905
|
export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
|
|
2520
2906
|
type: ErrorForbiddenType;
|
|
@@ -2774,6 +3160,19 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
2774
3160
|
*/
|
|
2775
3161
|
event_key?: string;
|
|
2776
3162
|
}
|
|
3163
|
+
/** event-survey-response-created */
|
|
3164
|
+
export interface EventSurveyResponseCreated {
|
|
3165
|
+
survey_response: SurveyResponse;
|
|
3166
|
+
}
|
|
3167
|
+
/** event-survey-response-deleted */
|
|
3168
|
+
export interface EventSurveyResponseDeleted {
|
|
3169
|
+
/** The ID of the survey response that was deleted. */
|
|
3170
|
+
id: string;
|
|
3171
|
+
}
|
|
3172
|
+
/** event-survey-response-updated */
|
|
3173
|
+
export interface EventSurveyResponseUpdated {
|
|
3174
|
+
survey_response: SurveyResponse;
|
|
3175
|
+
}
|
|
2777
3176
|
/** event-tag-created */
|
|
2778
3177
|
export interface EventTagCreated {
|
|
2779
3178
|
tag: Tag;
|
|
@@ -2951,6 +3350,10 @@ export interface GroupMembersRemoveRequest {
|
|
|
2951
3350
|
}
|
|
2952
3351
|
/** group-members-remove-response */
|
|
2953
3352
|
export type GroupMembersRemoveResponse = object;
|
|
3353
|
+
/** group-search-summary */
|
|
3354
|
+
export type GroupSearchSummary = SearchSummaryBase & {
|
|
3355
|
+
group: GroupSummary;
|
|
3356
|
+
};
|
|
2954
3357
|
/** group-summary */
|
|
2955
3358
|
export type GroupSummary = AtomBaseSummary & {
|
|
2956
3359
|
/** Name of the group. */
|
|
@@ -2961,6 +3364,20 @@ export declare enum GroupType {
|
|
|
2961
3364
|
Dynamic = "dynamic",
|
|
2962
3365
|
Static = "static"
|
|
2963
3366
|
}
|
|
3367
|
+
/** Denotes the use case of the grouped vista. */
|
|
3368
|
+
export declare enum GroupedVistaFlavor {
|
|
3369
|
+
Nnl = "nnl",
|
|
3370
|
+
SprintBoard = "sprint_board",
|
|
3371
|
+
SupportInbox = "support_inbox"
|
|
3372
|
+
}
|
|
3373
|
+
/**
|
|
3374
|
+
* grouped-vista-summary
|
|
3375
|
+
* Represents a group of multiple vistas as a single unit.
|
|
3376
|
+
*/
|
|
3377
|
+
export type GroupedVistaSummary = VistaBaseSummary & {
|
|
3378
|
+
/** Denotes the use case of the grouped vista. */
|
|
3379
|
+
flavor?: GroupedVistaFlavor;
|
|
3380
|
+
};
|
|
2964
3381
|
/**
|
|
2965
3382
|
* groups-create-request
|
|
2966
3383
|
* A request to create a new group.
|
|
@@ -3076,6 +3493,12 @@ export type Issue = WorkBase & {
|
|
|
3076
3493
|
developed_with?: PartSummary[];
|
|
3077
3494
|
/** Priority of the work based upon impact and criticality. */
|
|
3078
3495
|
priority?: IssuePriority;
|
|
3496
|
+
/**
|
|
3497
|
+
* Target start date for the object.
|
|
3498
|
+
* @format date-time
|
|
3499
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3500
|
+
*/
|
|
3501
|
+
target_start_date?: string;
|
|
3079
3502
|
};
|
|
3080
3503
|
/** Priority of the work based upon impact and criticality. */
|
|
3081
3504
|
export declare enum IssuePriority {
|
|
@@ -3097,6 +3520,14 @@ export interface LegacyStage {
|
|
|
3097
3520
|
/** Current stage name of the work item. */
|
|
3098
3521
|
name: string;
|
|
3099
3522
|
}
|
|
3523
|
+
/**
|
|
3524
|
+
* legacy-stage-summary
|
|
3525
|
+
* Describes the current stage of a work item.
|
|
3526
|
+
*/
|
|
3527
|
+
export interface LegacyStageSummary {
|
|
3528
|
+
/** Current stage name of the work item. */
|
|
3529
|
+
name: string;
|
|
3530
|
+
}
|
|
3100
3531
|
/**
|
|
3101
3532
|
* lines-of-code
|
|
3102
3533
|
* Details of lines of code in this code change.
|
|
@@ -3165,6 +3596,17 @@ export interface LinkRevUserToRevOrgRequest {
|
|
|
3165
3596
|
export interface LinkRevUserToRevOrgResponse {
|
|
3166
3597
|
rev_user: RevUser;
|
|
3167
3598
|
}
|
|
3599
|
+
/** link-search-summary */
|
|
3600
|
+
export type LinkSearchSummary = SearchSummaryBase & {
|
|
3601
|
+
link: LinkSummary;
|
|
3602
|
+
};
|
|
3603
|
+
/** link-summary */
|
|
3604
|
+
export type LinkSummary = AtomBaseSummary & {
|
|
3605
|
+
/** Type of link used to define the relationship. */
|
|
3606
|
+
link_type: LinkType;
|
|
3607
|
+
source: LinkEndpointSummary;
|
|
3608
|
+
target: LinkEndpointSummary;
|
|
3609
|
+
};
|
|
3168
3610
|
/** Type of link used to define the relationship. */
|
|
3169
3611
|
export declare enum LinkType {
|
|
3170
3612
|
DevelopedWith = "developed_with",
|
|
@@ -3361,7 +3803,10 @@ export interface MetricDataPointDimension {
|
|
|
3361
3803
|
value: string;
|
|
3362
3804
|
}
|
|
3363
3805
|
/** metric-definition */
|
|
3364
|
-
export type MetricDefinition = AtomBase
|
|
3806
|
+
export type MetricDefinition = AtomBase & {
|
|
3807
|
+
/** Human readable name of the metric. */
|
|
3808
|
+
name?: string;
|
|
3809
|
+
};
|
|
3365
3810
|
/** The list of item types on which the metric might be applied. */
|
|
3366
3811
|
export declare enum MetricDefinitionAppliesTo {
|
|
3367
3812
|
Conversation = "conversation",
|
|
@@ -3377,6 +3822,11 @@ export declare enum MetricDefinitionMetricType {
|
|
|
3377
3822
|
Time = "time",
|
|
3378
3823
|
Value = "value"
|
|
3379
3824
|
}
|
|
3825
|
+
/** metric-definition-summary */
|
|
3826
|
+
export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
3827
|
+
/** Human readable name of the metric. */
|
|
3828
|
+
name?: string;
|
|
3829
|
+
};
|
|
3380
3830
|
/** metric-definitions-list-request */
|
|
3381
3831
|
export interface MetricDefinitionsListRequest {
|
|
3382
3832
|
/** The type of objects the metric definition applies to. */
|
|
@@ -3386,6 +3836,11 @@ export interface MetricDefinitionsListRequest {
|
|
|
3386
3836
|
* iteration starts from the beginning.
|
|
3387
3837
|
*/
|
|
3388
3838
|
cursor?: string;
|
|
3839
|
+
/**
|
|
3840
|
+
* Whether to include custom metrics in the response. If not set, then
|
|
3841
|
+
* custom metrics are excluded.
|
|
3842
|
+
*/
|
|
3843
|
+
include_custom_metrics?: boolean;
|
|
3389
3844
|
/**
|
|
3390
3845
|
* The maximum number of records to return. The default is '50'.
|
|
3391
3846
|
* @format int32
|
|
@@ -3452,6 +3907,12 @@ export interface MetricsDataIngestRequest {
|
|
|
3452
3907
|
*/
|
|
3453
3908
|
metrics: MetricsData[];
|
|
3454
3909
|
}
|
|
3910
|
+
/** object-member-search-summary */
|
|
3911
|
+
export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
3912
|
+
object_member: ObjectMemberSummary;
|
|
3913
|
+
};
|
|
3914
|
+
/** object-member-summary */
|
|
3915
|
+
export type ObjectMemberSummary = AtomBaseSummary;
|
|
3455
3916
|
/** opportunity */
|
|
3456
3917
|
export type Opportunity = WorkBase;
|
|
3457
3918
|
/** Forecast category of the opportunity. */
|
|
@@ -3659,6 +4120,32 @@ export declare enum OrgScheduleStatus {
|
|
|
3659
4120
|
Draft = "draft",
|
|
3660
4121
|
Published = "published"
|
|
3661
4122
|
}
|
|
4123
|
+
/** org-schedule-summary */
|
|
4124
|
+
export type OrgScheduleSummary = AtomBaseSummary & {
|
|
4125
|
+
/** Human-readable name. */
|
|
4126
|
+
name?: string;
|
|
4127
|
+
/**
|
|
4128
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
4129
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
4130
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
4131
|
+
*/
|
|
4132
|
+
status: OrgScheduleStatus;
|
|
4133
|
+
/**
|
|
4134
|
+
* Timezone in which this is defined. Only organization schedules in
|
|
4135
|
+
* the same timezone can be directly combined.
|
|
4136
|
+
*/
|
|
4137
|
+
timezone?: string;
|
|
4138
|
+
/**
|
|
4139
|
+
* Derived field indicating when a valid organization schedule will
|
|
4140
|
+
* become invalid. If omitted, the schedule is already invalid. A
|
|
4141
|
+
* schedule is valid if it has a weekly schedule for all named periods
|
|
4142
|
+
* for all its schedule fragments, and if it has a schedule fragment
|
|
4143
|
+
* for the time period in question.
|
|
4144
|
+
* @format date-time
|
|
4145
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4146
|
+
*/
|
|
4147
|
+
valid_until?: string;
|
|
4148
|
+
};
|
|
3662
4149
|
/** org-schedules-create-request */
|
|
3663
4150
|
export interface OrgSchedulesCreateRequest {
|
|
3664
4151
|
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
@@ -3799,6 +4286,10 @@ export interface OrgSchedulesUpdateRequest {
|
|
|
3799
4286
|
export interface OrgSchedulesUpdateResponse {
|
|
3800
4287
|
org_schedule: OrgSchedule;
|
|
3801
4288
|
}
|
|
4289
|
+
/** org-search-summary */
|
|
4290
|
+
export type OrgSearchSummary = SearchSummaryBase & {
|
|
4291
|
+
org: OrgSummary;
|
|
4292
|
+
};
|
|
3802
4293
|
/** org-summary */
|
|
3803
4294
|
export type OrgSummary = (AccountSummary | RevOrgSummary) & {
|
|
3804
4295
|
type: OrgType;
|
|
@@ -3851,6 +4342,8 @@ export type PartBase = AtomBase & {
|
|
|
3851
4342
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
3852
4343
|
*/
|
|
3853
4344
|
stock_schema_fragment?: string;
|
|
4345
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
4346
|
+
subtype?: string;
|
|
3854
4347
|
/** Tags associated with the object. */
|
|
3855
4348
|
tags?: TagWithValue[];
|
|
3856
4349
|
};
|
|
@@ -3859,6 +4352,10 @@ export type PartBaseSummary = AtomBaseSummary & {
|
|
|
3859
4352
|
/** Name of the part. */
|
|
3860
4353
|
name: string;
|
|
3861
4354
|
};
|
|
4355
|
+
/** part-search-summary */
|
|
4356
|
+
export type PartSearchSummary = SearchSummaryBase & {
|
|
4357
|
+
part: PartSummary;
|
|
4358
|
+
};
|
|
3862
4359
|
/** part-summary */
|
|
3863
4360
|
export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
|
|
3864
4361
|
type: PartType;
|
|
@@ -4083,52 +4580,345 @@ export interface PartsUpdateResponse {
|
|
|
4083
4580
|
export type Product = PartBase;
|
|
4084
4581
|
/** product-summary */
|
|
4085
4582
|
export type ProductSummary = PartBaseSummary;
|
|
4583
|
+
/** question-answer */
|
|
4584
|
+
export type QuestionAnswer = AtomBase & {
|
|
4585
|
+
/** The Answer. */
|
|
4586
|
+
answer?: string;
|
|
4587
|
+
/** The Question. */
|
|
4588
|
+
question?: string;
|
|
4589
|
+
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
4590
|
+
suggested_answer?: string;
|
|
4591
|
+
/**
|
|
4592
|
+
* Whether the Q/A was marked for deletion by the Q/A generation
|
|
4593
|
+
* algorithm.
|
|
4594
|
+
*/
|
|
4595
|
+
suggested_for_deletion?: boolean;
|
|
4596
|
+
/** The topic to which the QA belongs. */
|
|
4597
|
+
topic?: string;
|
|
4598
|
+
/** Whether the Q/A was verified. */
|
|
4599
|
+
verified?: boolean;
|
|
4600
|
+
};
|
|
4601
|
+
/** question-answer-search-summary */
|
|
4602
|
+
export type QuestionAnswerSearchSummary = SearchSummaryBase & {
|
|
4603
|
+
question_answer: QuestionAnswerSummary;
|
|
4604
|
+
};
|
|
4605
|
+
/** Status of the question answer. */
|
|
4606
|
+
export declare enum QuestionAnswerStatus {
|
|
4607
|
+
Archived = "archived",
|
|
4608
|
+
Draft = "draft",
|
|
4609
|
+
Published = "published",
|
|
4610
|
+
ReviewNeeded = "review_needed"
|
|
4611
|
+
}
|
|
4612
|
+
/** question-answer-summary */
|
|
4613
|
+
export type QuestionAnswerSummary = AtomBaseSummary & {
|
|
4614
|
+
/** The Question. */
|
|
4615
|
+
question?: string;
|
|
4616
|
+
};
|
|
4086
4617
|
/**
|
|
4087
|
-
*
|
|
4088
|
-
*
|
|
4618
|
+
* question-answers-create-request
|
|
4619
|
+
* The request to create a question-answer.
|
|
4089
4620
|
*/
|
|
4090
|
-
export interface
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
url?: string;
|
|
4095
|
-
}
|
|
4096
|
-
/** rev-org */
|
|
4097
|
-
export type RevOrg = OrgBase & {
|
|
4098
|
-
account?: AccountSummary;
|
|
4099
|
-
/** The artifacts attached to the Rev organization. */
|
|
4100
|
-
artifacts?: ArtifactSummary[];
|
|
4101
|
-
/** Custom fields. */
|
|
4102
|
-
custom_fields?: object;
|
|
4621
|
+
export interface QuestionAnswersCreateRequest {
|
|
4622
|
+
access_level?: AccessLevel;
|
|
4623
|
+
/** Answer of the question-answer. */
|
|
4624
|
+
answer: string;
|
|
4103
4625
|
/**
|
|
4104
|
-
*
|
|
4105
|
-
* @example ["
|
|
4626
|
+
* The articles that the question-answer applies to.
|
|
4627
|
+
* @example ["ARTICLE-12345"]
|
|
4106
4628
|
*/
|
|
4107
|
-
|
|
4108
|
-
/** Description of the Rev organization. */
|
|
4109
|
-
description?: string;
|
|
4110
|
-
/** Company's domain name. Example - 'devrev.ai'. */
|
|
4111
|
-
domain?: string;
|
|
4629
|
+
applies_to_articles?: string[];
|
|
4112
4630
|
/**
|
|
4113
|
-
*
|
|
4114
|
-
*
|
|
4115
|
-
*
|
|
4116
|
-
* organization.
|
|
4631
|
+
* The parts that the question-answer applies to.
|
|
4632
|
+
* @minItems 1
|
|
4633
|
+
* @example ["PROD-12345"]
|
|
4117
4634
|
*/
|
|
4118
|
-
|
|
4635
|
+
applies_to_parts: string[];
|
|
4119
4636
|
/**
|
|
4120
|
-
*
|
|
4121
|
-
* @example "
|
|
4637
|
+
* The users that own the question-answer.
|
|
4638
|
+
* @example ["DEVU-12345"]
|
|
4122
4639
|
*/
|
|
4123
|
-
|
|
4124
|
-
/**
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4640
|
+
owned_by: string[];
|
|
4641
|
+
/** Question of the question-answer. */
|
|
4642
|
+
question: string;
|
|
4643
|
+
/** Information about the role the member receives due to the share. */
|
|
4644
|
+
shared_with?: SetSharedWithMembership[];
|
|
4645
|
+
/**
|
|
4646
|
+
* The source of the question-answer.
|
|
4647
|
+
* @example ["ARTICLE-12345"]
|
|
4648
|
+
*/
|
|
4649
|
+
sources?: string[];
|
|
4650
|
+
/** Status of the question answer. */
|
|
4651
|
+
status: QuestionAnswerStatus;
|
|
4652
|
+
/**
|
|
4653
|
+
* Alternative answer for the question-answer sugested by Q/A
|
|
4654
|
+
* Discovery.
|
|
4655
|
+
*/
|
|
4656
|
+
suggested_answer?: string;
|
|
4657
|
+
/**
|
|
4658
|
+
* Whether the question-answer was suggeste to be deleted by Q/A
|
|
4659
|
+
* Discovery.
|
|
4660
|
+
*/
|
|
4661
|
+
suggested_for_deletion?: boolean;
|
|
4662
|
+
/** Tags associated with the question-answer. */
|
|
4663
|
+
tags?: SetTagWithValue[];
|
|
4664
|
+
/** Topic of the question-answer. */
|
|
4665
|
+
topic?: string;
|
|
4666
|
+
/** Whether the question-answer was verified by a user or not. */
|
|
4667
|
+
verified?: boolean;
|
|
4668
|
+
}
|
|
4669
|
+
/**
|
|
4670
|
+
* question-answers-create-response
|
|
4671
|
+
* Create question-answer response.
|
|
4672
|
+
*/
|
|
4673
|
+
export interface QuestionAnswersCreateResponse {
|
|
4674
|
+
question_answer: QuestionAnswer;
|
|
4675
|
+
}
|
|
4676
|
+
/**
|
|
4677
|
+
* question-answers-delete-request
|
|
4678
|
+
* The request to delete a question-answer.
|
|
4679
|
+
*/
|
|
4680
|
+
export interface QuestionAnswersDeleteRequest {
|
|
4681
|
+
/** The ID of the question-answer. */
|
|
4682
|
+
id: string;
|
|
4683
|
+
/**
|
|
4684
|
+
* The ID of the question-answer.
|
|
4685
|
+
* @deprecated
|
|
4686
|
+
*/
|
|
4687
|
+
question_answer_id?: string;
|
|
4688
|
+
}
|
|
4689
|
+
/**
|
|
4690
|
+
* question-answers-get-request
|
|
4691
|
+
* The request to get a question-answer.
|
|
4692
|
+
*/
|
|
4693
|
+
export interface QuestionAnswersGetRequest {
|
|
4694
|
+
/** The ID of the required question-answer. */
|
|
4695
|
+
id: string;
|
|
4696
|
+
}
|
|
4697
|
+
/**
|
|
4698
|
+
* question-answers-get-response
|
|
4699
|
+
* Get question-answer response.
|
|
4700
|
+
*/
|
|
4701
|
+
export interface QuestionAnswersGetResponse {
|
|
4702
|
+
question_answer: QuestionAnswer;
|
|
4703
|
+
}
|
|
4704
|
+
/**
|
|
4705
|
+
* question-answers-list-request
|
|
4706
|
+
* The request to list question-answers.
|
|
4707
|
+
*/
|
|
4708
|
+
export interface QuestionAnswersListRequest {
|
|
4709
|
+
/**
|
|
4710
|
+
* Filters for question-answer belonging to any of the provided
|
|
4711
|
+
* articles.
|
|
4712
|
+
* @example ["ARTICLE-12345"]
|
|
4713
|
+
*/
|
|
4714
|
+
applies_to_articles?: string[];
|
|
4715
|
+
/**
|
|
4716
|
+
* Filters for question-answer belonging to any of the provided parts.
|
|
4717
|
+
* @example ["PROD-12345"]
|
|
4718
|
+
*/
|
|
4719
|
+
applies_to_parts?: string[];
|
|
4720
|
+
/**
|
|
4721
|
+
* Filters for question-answers created by any of the provided users.
|
|
4722
|
+
* @example ["DEVU-12345"]
|
|
4723
|
+
*/
|
|
4724
|
+
created_by?: string[];
|
|
4725
|
+
/**
|
|
4726
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4727
|
+
* iteration starts from the beginning.
|
|
4728
|
+
*/
|
|
4729
|
+
cursor?: string;
|
|
4730
|
+
/**
|
|
4731
|
+
* The maximum number of question-answers to return. The default is
|
|
4732
|
+
* '50'.
|
|
4733
|
+
* @format int32
|
|
4734
|
+
*/
|
|
4735
|
+
limit?: number;
|
|
4736
|
+
/**
|
|
4737
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4738
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4739
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4740
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4741
|
+
* always be returned in the specified sort-by order.
|
|
4742
|
+
*/
|
|
4743
|
+
mode?: ListMode;
|
|
4744
|
+
/**
|
|
4745
|
+
* Filters for question-answers owned by any of the provided users.
|
|
4746
|
+
* @example ["DEVU-12345"]
|
|
4747
|
+
*/
|
|
4748
|
+
owned_by?: string[];
|
|
4749
|
+
}
|
|
4750
|
+
/**
|
|
4751
|
+
* question-answers-list-response
|
|
4752
|
+
* List question-answers response.
|
|
4753
|
+
*/
|
|
4754
|
+
export interface QuestionAnswersListResponse {
|
|
4755
|
+
/**
|
|
4756
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4757
|
+
* sort order. If not set, then no later elements exist.
|
|
4758
|
+
*/
|
|
4759
|
+
next_cursor?: string;
|
|
4760
|
+
/**
|
|
4761
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4762
|
+
* sort order. If not set, then no prior elements exist.
|
|
4763
|
+
*/
|
|
4764
|
+
prev_cursor?: string;
|
|
4765
|
+
/** The question-answers entries matching the request. */
|
|
4766
|
+
question_answers: QuestionAnswer[];
|
|
4767
|
+
/**
|
|
4768
|
+
* Total number of question-answer items for the request.
|
|
4769
|
+
* @format int32
|
|
4770
|
+
*/
|
|
4771
|
+
total: number;
|
|
4772
|
+
}
|
|
4773
|
+
/**
|
|
4774
|
+
* question-answers-update-request
|
|
4775
|
+
* The request to update a question-answer.
|
|
4776
|
+
*/
|
|
4777
|
+
export interface QuestionAnswersUpdateRequest {
|
|
4778
|
+
access_level?: AccessLevel;
|
|
4779
|
+
/**
|
|
4780
|
+
* Updated answer of the question-answer object, or unchanged if not
|
|
4781
|
+
* provided.
|
|
4782
|
+
*/
|
|
4783
|
+
answer?: string;
|
|
4784
|
+
applies_to_articles?: QuestionAnswersUpdateRequestAppliesToArticles;
|
|
4785
|
+
applies_to_parts?: QuestionAnswersUpdateRequestAppliesToParts;
|
|
4786
|
+
/** The question-answer's ID. */
|
|
4787
|
+
id: string;
|
|
4788
|
+
owned_by?: QuestionAnswersUpdateRequestOwnedBy;
|
|
4789
|
+
/**
|
|
4790
|
+
* Updated question of the question-answer object, or unchanged if not
|
|
4791
|
+
* provided.
|
|
4792
|
+
*/
|
|
4793
|
+
question?: string;
|
|
4794
|
+
shared_with?: QuestionAnswersUpdateRequestSharedWith;
|
|
4795
|
+
sources?: QuestionAnswersUpdateRequestSources;
|
|
4796
|
+
/** Status of the question answer. */
|
|
4797
|
+
status?: QuestionAnswerStatus;
|
|
4798
|
+
/**
|
|
4799
|
+
* Updated suggested_answer of the question-answer object, or
|
|
4800
|
+
* unchanged if not provided.
|
|
4801
|
+
*/
|
|
4802
|
+
suggested_answer?: string;
|
|
4803
|
+
/**
|
|
4804
|
+
* Updated suggested_for_deletion of the question-answer object, or
|
|
4805
|
+
* unchanged if not provided.
|
|
4806
|
+
*/
|
|
4807
|
+
suggested_for_deletion?: boolean;
|
|
4808
|
+
tags?: QuestionAnswersUpdateRequestTags;
|
|
4809
|
+
/**
|
|
4810
|
+
* Updated topic of the question-answer object, or unchanged if not
|
|
4811
|
+
* provided.
|
|
4812
|
+
*/
|
|
4813
|
+
topic?: string;
|
|
4814
|
+
/** Updates whether the question-answer was verified by a user or not. */
|
|
4815
|
+
verified?: boolean;
|
|
4816
|
+
}
|
|
4817
|
+
/** question-answers-update-request-applies-to-articles */
|
|
4818
|
+
export interface QuestionAnswersUpdateRequestAppliesToArticles {
|
|
4819
|
+
/**
|
|
4820
|
+
* Updates the article that the question-answer applies to.
|
|
4821
|
+
* @example ["ARTICLE-12345"]
|
|
4822
|
+
*/
|
|
4823
|
+
set?: string[];
|
|
4824
|
+
}
|
|
4825
|
+
/** question-answers-update-request-applies-to-parts */
|
|
4826
|
+
export interface QuestionAnswersUpdateRequestAppliesToParts {
|
|
4827
|
+
/**
|
|
4828
|
+
* Updates the parts that the question-answer applies to.
|
|
4829
|
+
* @example ["PROD-12345"]
|
|
4830
|
+
*/
|
|
4831
|
+
set?: string[];
|
|
4832
|
+
}
|
|
4833
|
+
/** question-answers-update-request-owned-by */
|
|
4834
|
+
export interface QuestionAnswersUpdateRequestOwnedBy {
|
|
4835
|
+
/**
|
|
4836
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
4837
|
+
* empty.
|
|
4838
|
+
* @example ["DEVU-12345"]
|
|
4839
|
+
*/
|
|
4840
|
+
set?: string[];
|
|
4841
|
+
}
|
|
4842
|
+
/** question-answers-update-request-shared-with */
|
|
4843
|
+
export interface QuestionAnswersUpdateRequestSharedWith {
|
|
4844
|
+
/** Sets the field to the provided membership list. */
|
|
4845
|
+
set?: SetSharedWithMembership[];
|
|
4846
|
+
}
|
|
4847
|
+
/** question-answers-update-request-sources */
|
|
4848
|
+
export interface QuestionAnswersUpdateRequestSources {
|
|
4849
|
+
/**
|
|
4850
|
+
* Sets the sources that generated the question-answer.
|
|
4851
|
+
* @example ["ARTICLE-12345"]
|
|
4852
|
+
*/
|
|
4853
|
+
set?: string[];
|
|
4854
|
+
}
|
|
4855
|
+
/** question-answers-update-request-tags */
|
|
4856
|
+
export interface QuestionAnswersUpdateRequestTags {
|
|
4857
|
+
/** Sets the provided tags on the question-answer. */
|
|
4858
|
+
set?: SetTagWithValue[];
|
|
4859
|
+
}
|
|
4860
|
+
/** question-answers-update-response */
|
|
4861
|
+
export interface QuestionAnswersUpdateResponse {
|
|
4862
|
+
question_answer: QuestionAnswer;
|
|
4863
|
+
}
|
|
4864
|
+
/**
|
|
4865
|
+
* resource
|
|
4866
|
+
* Resource details.
|
|
4867
|
+
*/
|
|
4868
|
+
export interface Resource {
|
|
4869
|
+
/** Ids of the artifacts. */
|
|
4870
|
+
artifacts?: ArtifactSummary[];
|
|
4871
|
+
/** URL of the external article. */
|
|
4872
|
+
url?: string;
|
|
4873
|
+
}
|
|
4874
|
+
/**
|
|
4875
|
+
* resource-summary
|
|
4876
|
+
* Resource details.
|
|
4877
|
+
*/
|
|
4878
|
+
export interface ResourceSummary {
|
|
4879
|
+
/** Ids of the artifacts. */
|
|
4880
|
+
artifacts?: ArtifactSummary[];
|
|
4881
|
+
/** URL of the external article. */
|
|
4882
|
+
url?: string;
|
|
4883
|
+
}
|
|
4884
|
+
/** rev-org */
|
|
4885
|
+
export type RevOrg = OrgBase & {
|
|
4886
|
+
account?: AccountSummary;
|
|
4887
|
+
/** The artifacts attached to the Rev organization. */
|
|
4888
|
+
artifacts?: ArtifactSummary[];
|
|
4889
|
+
/** Custom fields. */
|
|
4890
|
+
custom_fields?: object;
|
|
4891
|
+
/**
|
|
4892
|
+
* Custom schema fragments.
|
|
4893
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
4894
|
+
*/
|
|
4895
|
+
custom_schema_fragments?: string[];
|
|
4896
|
+
/** Description of the Rev organization. */
|
|
4897
|
+
description?: string;
|
|
4898
|
+
/** Company's domain name. Example - 'devrev.ai'. */
|
|
4899
|
+
domain?: string;
|
|
4900
|
+
/**
|
|
4901
|
+
* External ref is a unique identifier for the Rev (customer)
|
|
4902
|
+
* organization from your primary customer system of records. If none
|
|
4903
|
+
* is specified, a system-generated identifier will be assigned to the
|
|
4904
|
+
* organization.
|
|
4905
|
+
*/
|
|
4906
|
+
external_ref?: string;
|
|
4907
|
+
/**
|
|
4908
|
+
* Stock schema fragment.
|
|
4909
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4910
|
+
*/
|
|
4911
|
+
stock_schema_fragment?: string;
|
|
4912
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
4913
|
+
subtype?: string;
|
|
4914
|
+
/** Tags associated with an object. */
|
|
4915
|
+
tags?: TagWithValue[];
|
|
4916
|
+
};
|
|
4917
|
+
/** rev-org-summary */
|
|
4918
|
+
export type RevOrgSummary = OrgBaseSummary;
|
|
4919
|
+
/**
|
|
4920
|
+
* rev-orgs-create-request
|
|
4921
|
+
* Request object to create a new Rev organization in the Dev
|
|
4132
4922
|
* organization.
|
|
4133
4923
|
*/
|
|
4134
4924
|
export interface RevOrgsCreateRequest {
|
|
@@ -4241,6 +5031,8 @@ export interface RevOrgsListRequest {
|
|
|
4241
5031
|
custom_field_filter?: string[];
|
|
4242
5032
|
/** Filters for custom fields. */
|
|
4243
5033
|
custom_fields?: object;
|
|
5034
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
5035
|
+
display_name?: string[];
|
|
4244
5036
|
/** List of external refs to filter Rev organizations for. */
|
|
4245
5037
|
external_ref?: string[];
|
|
4246
5038
|
/**
|
|
@@ -4367,6 +5159,8 @@ export type RevUser = UserBase & {
|
|
|
4367
5159
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4368
5160
|
*/
|
|
4369
5161
|
stock_schema_fragment?: string;
|
|
5162
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
5163
|
+
subtype?: string;
|
|
4370
5164
|
/** Tags associated with the object. */
|
|
4371
5165
|
tags?: TagWithValue[];
|
|
4372
5166
|
};
|
|
@@ -4416,7 +5210,8 @@ export interface RevUsersCreateRequest {
|
|
|
4416
5210
|
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
4417
5211
|
phone_numbers?: string[];
|
|
4418
5212
|
/**
|
|
4419
|
-
* The ID of Rev organization
|
|
5213
|
+
* The ID of the Rev organization to which the created Rev user is
|
|
5214
|
+
* associated.
|
|
4420
5215
|
* @example "REV-AbCdEfGh"
|
|
4421
5216
|
*/
|
|
4422
5217
|
rev_org?: string;
|
|
@@ -4682,6 +5477,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
4682
5477
|
description?: string;
|
|
4683
5478
|
/** Whether this field is filterable, groupable and sortable. */
|
|
4684
5479
|
is_filterable?: boolean;
|
|
5480
|
+
/** Whether this field is immutable or not. */
|
|
5481
|
+
is_immutable?: boolean;
|
|
4685
5482
|
/**
|
|
4686
5483
|
* Whether this field can hold Personally Identifiable Information
|
|
4687
5484
|
* (PII).
|
|
@@ -5060,6 +5857,122 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
5060
5857
|
};
|
|
5061
5858
|
/** schema-unknown-field-descriptor */
|
|
5062
5859
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
5860
|
+
/**
|
|
5861
|
+
* search-core-request
|
|
5862
|
+
* Search request.
|
|
5863
|
+
*/
|
|
5864
|
+
export interface SearchCoreRequest {
|
|
5865
|
+
/**
|
|
5866
|
+
* The cursor from where to begin iteration. Start from beginning if
|
|
5867
|
+
* not provided.
|
|
5868
|
+
*/
|
|
5869
|
+
cursor?: string;
|
|
5870
|
+
/**
|
|
5871
|
+
* The maximum number of items to return in a page. The default is
|
|
5872
|
+
* '10'.
|
|
5873
|
+
* @format int32
|
|
5874
|
+
*/
|
|
5875
|
+
limit?: number;
|
|
5876
|
+
/** The namespaces to search in. */
|
|
5877
|
+
namespaces?: SearchNamespace[];
|
|
5878
|
+
/**
|
|
5879
|
+
* The query string. Search query language:
|
|
5880
|
+
* https://docs.devrev.ai/product/search#fields
|
|
5881
|
+
*/
|
|
5882
|
+
query: string;
|
|
5883
|
+
/** Search sort by parameters. */
|
|
5884
|
+
sort_by?: SearchSortByParam;
|
|
5885
|
+
/** Search sort order parameters. */
|
|
5886
|
+
sort_order?: SearchSortOrderParam;
|
|
5887
|
+
}
|
|
5888
|
+
/**
|
|
5889
|
+
* search-core-response
|
|
5890
|
+
* Search response.
|
|
5891
|
+
*/
|
|
5892
|
+
export interface SearchCoreResponse {
|
|
5893
|
+
/**
|
|
5894
|
+
* The cursor from where to begin iteration. Start from beginning if
|
|
5895
|
+
* not provided.
|
|
5896
|
+
*/
|
|
5897
|
+
cursor?: string;
|
|
5898
|
+
/** The search results. */
|
|
5899
|
+
results: SearchResult[];
|
|
5900
|
+
}
|
|
5901
|
+
/** The namespaces to search in. */
|
|
5902
|
+
export declare enum SearchNamespace {
|
|
5903
|
+
Account = "account",
|
|
5904
|
+
Article = "article",
|
|
5905
|
+
Capability = "capability",
|
|
5906
|
+
Component = "component",
|
|
5907
|
+
Conversation = "conversation",
|
|
5908
|
+
CustomPart = "custom_part",
|
|
5909
|
+
CustomWork = "custom_work",
|
|
5910
|
+
Dashboard = "dashboard",
|
|
5911
|
+
DevUser = "dev_user",
|
|
5912
|
+
Enhancement = "enhancement",
|
|
5913
|
+
Feature = "feature",
|
|
5914
|
+
Group = "group",
|
|
5915
|
+
Issue = "issue",
|
|
5916
|
+
Linkable = "linkable",
|
|
5917
|
+
Microservice = "microservice",
|
|
5918
|
+
ObjectMember = "object_member",
|
|
5919
|
+
Opportunity = "opportunity",
|
|
5920
|
+
Product = "product",
|
|
5921
|
+
Project = "project",
|
|
5922
|
+
QuestionAnswer = "question_answer",
|
|
5923
|
+
RevOrg = "rev_org",
|
|
5924
|
+
RevUser = "rev_user",
|
|
5925
|
+
Runnable = "runnable",
|
|
5926
|
+
ServiceAccount = "service_account",
|
|
5927
|
+
SysUser = "sys_user",
|
|
5928
|
+
Tag = "tag",
|
|
5929
|
+
Task = "task",
|
|
5930
|
+
Ticket = "ticket",
|
|
5931
|
+
Vista = "vista"
|
|
5932
|
+
}
|
|
5933
|
+
/** search-result */
|
|
5934
|
+
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
5935
|
+
type: SearchResultType;
|
|
5936
|
+
};
|
|
5937
|
+
export declare enum SearchResultType {
|
|
5938
|
+
Account = "account",
|
|
5939
|
+
Article = "article",
|
|
5940
|
+
Artifact = "artifact",
|
|
5941
|
+
Conversation = "conversation",
|
|
5942
|
+
Dashboard = "dashboard",
|
|
5943
|
+
Group = "group",
|
|
5944
|
+
Link = "link",
|
|
5945
|
+
ObjectMember = "object_member",
|
|
5946
|
+
Org = "org",
|
|
5947
|
+
Part = "part",
|
|
5948
|
+
QuestionAnswer = "question_answer",
|
|
5949
|
+
Tag = "tag",
|
|
5950
|
+
User = "user",
|
|
5951
|
+
Vista = "vista",
|
|
5952
|
+
Work = "work"
|
|
5953
|
+
}
|
|
5954
|
+
/** Search sort by parameters. */
|
|
5955
|
+
export declare enum SearchSortByParam {
|
|
5956
|
+
CreatedDate = "created_date",
|
|
5957
|
+
ModifiedDate = "modified_date",
|
|
5958
|
+
Relevance = "relevance"
|
|
5959
|
+
}
|
|
5960
|
+
/** Search sort order parameters. */
|
|
5961
|
+
export declare enum SearchSortOrderParam {
|
|
5962
|
+
Asc = "asc",
|
|
5963
|
+
Desc = "desc"
|
|
5964
|
+
}
|
|
5965
|
+
/** search-summary-base */
|
|
5966
|
+
export interface SearchSummaryBase {
|
|
5967
|
+
/**
|
|
5968
|
+
* Timestamp when the object was last modified.
|
|
5969
|
+
* @format date-time
|
|
5970
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5971
|
+
*/
|
|
5972
|
+
modified_date?: string;
|
|
5973
|
+
/** Text snippet where the search hit occurred. */
|
|
5974
|
+
snippet?: string;
|
|
5975
|
+
}
|
|
5063
5976
|
/** service-account */
|
|
5064
5977
|
export type ServiceAccount = UserBase;
|
|
5065
5978
|
/** service-account-summary */
|
|
@@ -5085,6 +5998,11 @@ export interface SetOrgScheduleFragmentSummary {
|
|
|
5085
5998
|
/** Organization schedule fragment ID. */
|
|
5086
5999
|
id: string;
|
|
5087
6000
|
}
|
|
6001
|
+
/**
|
|
6002
|
+
* set-shared-with-membership
|
|
6003
|
+
* Information about the role the member receives due to the share.
|
|
6004
|
+
*/
|
|
6005
|
+
export type SetSharedWithMembership = object;
|
|
5088
6006
|
/** set-sla-policy */
|
|
5089
6007
|
export interface SetSlaPolicy {
|
|
5090
6008
|
/** Metrics to apply to the selected items. */
|
|
@@ -5176,11 +6094,6 @@ export interface SetWeeklyOrgSchedule {
|
|
|
5176
6094
|
*/
|
|
5177
6095
|
period_name: string;
|
|
5178
6096
|
}
|
|
5179
|
-
/**
|
|
5180
|
-
* shared-with-membership
|
|
5181
|
-
* Information about the role the member receives due to the share.
|
|
5182
|
-
*/
|
|
5183
|
-
export type SharedWithMembership = object;
|
|
5184
6097
|
/**
|
|
5185
6098
|
* shared-with-membership-filter
|
|
5186
6099
|
* Filter on target item based on intended audience.
|
|
@@ -5280,6 +6193,17 @@ export declare enum SlaStatus {
|
|
|
5280
6193
|
Draft = "draft",
|
|
5281
6194
|
Published = "published"
|
|
5282
6195
|
}
|
|
6196
|
+
/** sla-summary */
|
|
6197
|
+
export type SlaSummary = AtomBaseSummary & {
|
|
6198
|
+
/** Human-readable name. */
|
|
6199
|
+
name: string;
|
|
6200
|
+
/**
|
|
6201
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
6202
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
6203
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
6204
|
+
*/
|
|
6205
|
+
status: SlaStatus;
|
|
6206
|
+
};
|
|
5283
6207
|
/**
|
|
5284
6208
|
* sla-summary-filter
|
|
5285
6209
|
* The filter for SLA summary.
|
|
@@ -5302,7 +6226,37 @@ export declare enum SlaSummaryStage {
|
|
|
5302
6226
|
Warning = "warning"
|
|
5303
6227
|
}
|
|
5304
6228
|
/** sla-tracker */
|
|
5305
|
-
export type SlaTracker = AtomBase
|
|
6229
|
+
export type SlaTracker = AtomBase & {
|
|
6230
|
+
/** Details of the object on which the SLA is being tracked. */
|
|
6231
|
+
applies_to_id?: string;
|
|
6232
|
+
/** Summary of the metrics target being tracked in the SLA tracker. */
|
|
6233
|
+
metric_target_summaries: ArchetypeMetricTarget[];
|
|
6234
|
+
sla?: SlaSummary;
|
|
6235
|
+
/**
|
|
6236
|
+
* Details of the applicable SLA policy. Can be omitted if no sla
|
|
6237
|
+
* applies, or if no policy of the sla applies at the moment.
|
|
6238
|
+
*/
|
|
6239
|
+
sla_policy_id?: string;
|
|
6240
|
+
/** SLA stage of the object being tracked. */
|
|
6241
|
+
stage?: string;
|
|
6242
|
+
/**
|
|
6243
|
+
* It is an indicator of whether the SLA has ever been breached
|
|
6244
|
+
* (missed). If not, it shows whether the SLA is completed, in
|
|
6245
|
+
* progress, or nil - if no policy is applied.
|
|
6246
|
+
*/
|
|
6247
|
+
status?: string;
|
|
6248
|
+
};
|
|
6249
|
+
/** sla-tracker-summary */
|
|
6250
|
+
export type SlaTrackerSummary = AtomBaseSummary;
|
|
6251
|
+
/** sla-trackers-get-request */
|
|
6252
|
+
export interface SlaTrackersGetRequest {
|
|
6253
|
+
/** The ID of the SLA tracker to get. */
|
|
6254
|
+
id: string;
|
|
6255
|
+
}
|
|
6256
|
+
/** sla-trackers-get-response */
|
|
6257
|
+
export interface SlaTrackersGetResponse {
|
|
6258
|
+
sla_tracker: SlaTracker;
|
|
6259
|
+
}
|
|
5306
6260
|
/** slas-assign-request */
|
|
5307
6261
|
export interface SlasAssignRequest {
|
|
5308
6262
|
/**
|
|
@@ -5474,10 +6428,49 @@ export interface SnapInsResourcesResponseKeyringsEntry {
|
|
|
5474
6428
|
value: SnapInsResourcesResponseKeyringData;
|
|
5475
6429
|
}
|
|
5476
6430
|
/** snap-widget */
|
|
5477
|
-
export
|
|
6431
|
+
export type SnapWidget = EmailPreviewWidget & {
|
|
5478
6432
|
type: SnapWidgetType;
|
|
6433
|
+
};
|
|
6434
|
+
/** snap-widget-base */
|
|
6435
|
+
export type SnapWidgetBase = AtomBase & {
|
|
6436
|
+
/** A human readable name for the snap widget. */
|
|
6437
|
+
name: string;
|
|
6438
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6439
|
+
namespace?: SnapWidgetNamespace;
|
|
6440
|
+
/** The status of the snap widget. */
|
|
6441
|
+
status: SnapWidgetStatus;
|
|
6442
|
+
};
|
|
6443
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6444
|
+
export declare enum SnapWidgetNamespace {
|
|
6445
|
+
EmailPreview = "email_preview",
|
|
6446
|
+
LinkPreview = "link_preview",
|
|
6447
|
+
PlugNudge = "plug_nudge"
|
|
6448
|
+
}
|
|
6449
|
+
/** The status of the snap widget. */
|
|
6450
|
+
export declare enum SnapWidgetStatus {
|
|
6451
|
+
Draft = "draft",
|
|
6452
|
+
Published = "published"
|
|
6453
|
+
}
|
|
6454
|
+
export declare enum SnapWidgetType {
|
|
6455
|
+
EmailPreview = "email_preview"
|
|
6456
|
+
}
|
|
6457
|
+
/** snap-widgets-create-request */
|
|
6458
|
+
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
6459
|
+
/** A human readable name for the snap widget. */
|
|
6460
|
+
name: string;
|
|
6461
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6462
|
+
namespace?: SnapWidgetNamespace;
|
|
6463
|
+
/** The status of the snap widget. */
|
|
6464
|
+
status?: SnapWidgetStatus;
|
|
6465
|
+
type: SnapWidgetsCreateRequestType;
|
|
6466
|
+
};
|
|
6467
|
+
export declare enum SnapWidgetsCreateRequestType {
|
|
6468
|
+
EmailPreview = "email_preview"
|
|
6469
|
+
}
|
|
6470
|
+
/** snap-widgets-create-response */
|
|
6471
|
+
export interface SnapWidgetsCreateResponse {
|
|
6472
|
+
snap_widget: SnapWidget;
|
|
5479
6473
|
}
|
|
5480
|
-
export type SnapWidgetType = string;
|
|
5481
6474
|
/** stage-diagram-summary */
|
|
5482
6475
|
export type StageDiagramSummary = AtomBaseSummary;
|
|
5483
6476
|
/**
|
|
@@ -5504,6 +6497,11 @@ export interface StageUpdate {
|
|
|
5504
6497
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
5505
6498
|
name?: string;
|
|
5506
6499
|
}
|
|
6500
|
+
/** staged-info-filter */
|
|
6501
|
+
export interface StagedInfoFilter {
|
|
6502
|
+
/** Filters for issues that are staged. */
|
|
6503
|
+
is_staged?: boolean;
|
|
6504
|
+
}
|
|
5507
6505
|
/**
|
|
5508
6506
|
* stock-field-override
|
|
5509
6507
|
* A stock field override.
|
|
@@ -5536,10 +6534,11 @@ export interface StockSchemaFragmentsGetResponse {
|
|
|
5536
6534
|
/** stock-schema-fragments-list-request */
|
|
5537
6535
|
export interface StockSchemaFragmentsListRequest {
|
|
5538
6536
|
/**
|
|
5539
|
-
* The cursor to resume iteration from
|
|
5540
|
-
*
|
|
6537
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6538
|
+
* iteration starts from the beginning.
|
|
5541
6539
|
*/
|
|
5542
6540
|
cursor?: string;
|
|
6541
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
5543
6542
|
/** The list of leaf types. */
|
|
5544
6543
|
leaf_type?: string[];
|
|
5545
6544
|
/**
|
|
@@ -5547,16 +6546,42 @@ export interface StockSchemaFragmentsListRequest {
|
|
|
5547
6546
|
* @format int32
|
|
5548
6547
|
*/
|
|
5549
6548
|
limit?: number;
|
|
6549
|
+
/**
|
|
6550
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
6551
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
6552
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
6553
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
6554
|
+
* always be returned in the specified sort-by order.
|
|
6555
|
+
*/
|
|
6556
|
+
mode?: ListMode;
|
|
6557
|
+
/**
|
|
6558
|
+
* List of fields which are not required in the payload and can be
|
|
6559
|
+
* pruned away.
|
|
6560
|
+
*/
|
|
6561
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
5550
6562
|
/** The list of fields to sort the items by and how to sort them. */
|
|
5551
6563
|
sort_by?: string[];
|
|
5552
6564
|
}
|
|
6565
|
+
export declare enum StockSchemaFragmentsListRequestFilterPreset {
|
|
6566
|
+
CustomizableTypesPreset = "customizable_types_preset",
|
|
6567
|
+
NoPreset = "no_preset"
|
|
6568
|
+
}
|
|
6569
|
+
export declare enum StockSchemaFragmentsListRequestPrune {
|
|
6570
|
+
CompositeSchemas = "composite_schemas",
|
|
6571
|
+
Fields = "fields"
|
|
6572
|
+
}
|
|
5553
6573
|
/** stock-schema-fragments-list-response */
|
|
5554
6574
|
export interface StockSchemaFragmentsListResponse {
|
|
5555
6575
|
/**
|
|
5556
|
-
* The cursor to
|
|
5557
|
-
* then
|
|
6576
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
6577
|
+
* sort order. If not set, then no later elements exist.
|
|
5558
6578
|
*/
|
|
5559
|
-
|
|
6579
|
+
next_cursor?: string;
|
|
6580
|
+
/**
|
|
6581
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
6582
|
+
* sort order. If not set, then no prior elements exist.
|
|
6583
|
+
*/
|
|
6584
|
+
prev_cursor?: string;
|
|
5560
6585
|
/** The stock schema fragments. */
|
|
5561
6586
|
result: StockSchemaFragment[];
|
|
5562
6587
|
}
|
|
@@ -5586,11 +6611,239 @@ export interface SubtypesListResponse {
|
|
|
5586
6611
|
/** List of subtypes. */
|
|
5587
6612
|
subtypes: Subtype[];
|
|
5588
6613
|
}
|
|
6614
|
+
/** survey */
|
|
6615
|
+
export type Survey = AtomBase & {
|
|
6616
|
+
/** Description of the survey. */
|
|
6617
|
+
description?: string;
|
|
6618
|
+
/**
|
|
6619
|
+
* Survey name associated with schema. This name would be unique per
|
|
6620
|
+
* dev org.
|
|
6621
|
+
*/
|
|
6622
|
+
name?: string;
|
|
6623
|
+
/** List of all fields in the schema. */
|
|
6624
|
+
schema: SchemaFieldDescriptor[];
|
|
6625
|
+
};
|
|
5589
6626
|
/**
|
|
5590
6627
|
* survey-aggregation-filter
|
|
5591
6628
|
* The filter for survey aggregation.
|
|
5592
6629
|
*/
|
|
5593
6630
|
export type SurveyAggregationFilter = object;
|
|
6631
|
+
/** survey-response */
|
|
6632
|
+
export type SurveyResponse = AtomBase & {
|
|
6633
|
+
/** The unique ID associated with the dispatched survey. */
|
|
6634
|
+
dispatch_id?: string;
|
|
6635
|
+
/** The ID of the object for which survey is taken. */
|
|
6636
|
+
object?: string;
|
|
6637
|
+
/** Response for the survey. */
|
|
6638
|
+
response?: object;
|
|
6639
|
+
/** The ID of the survey for which response is taken. */
|
|
6640
|
+
survey?: string;
|
|
6641
|
+
};
|
|
6642
|
+
/** surveys-create-request */
|
|
6643
|
+
export interface SurveysCreateRequest {
|
|
6644
|
+
/** Description about the survey. */
|
|
6645
|
+
description?: string;
|
|
6646
|
+
/** The survey's name. */
|
|
6647
|
+
name: string;
|
|
6648
|
+
/** Schema for the survey. */
|
|
6649
|
+
schema: FieldDescriptor[];
|
|
6650
|
+
}
|
|
6651
|
+
/** surveys-create-response */
|
|
6652
|
+
export interface SurveysCreateResponse {
|
|
6653
|
+
survey: Survey;
|
|
6654
|
+
}
|
|
6655
|
+
/** surveys-delete-request */
|
|
6656
|
+
export interface SurveysDeleteRequest {
|
|
6657
|
+
/** ID of the survey being deleted. */
|
|
6658
|
+
id: string;
|
|
6659
|
+
}
|
|
6660
|
+
/** surveys-delete-response */
|
|
6661
|
+
export type SurveysDeleteResponse = object;
|
|
6662
|
+
/** surveys-list-request */
|
|
6663
|
+
export interface SurveysListRequest {
|
|
6664
|
+
/**
|
|
6665
|
+
* Filters for surveys created by any of these users.
|
|
6666
|
+
* @example ["DEVU-12345"]
|
|
6667
|
+
*/
|
|
6668
|
+
created_by?: string[];
|
|
6669
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6670
|
+
created_date?: DateFilter;
|
|
6671
|
+
/**
|
|
6672
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6673
|
+
* iteration starts from the beginning.
|
|
6674
|
+
*/
|
|
6675
|
+
cursor?: string;
|
|
6676
|
+
/**
|
|
6677
|
+
* The maximum number of surveys to return. If not set, then the
|
|
6678
|
+
* default is '50'.
|
|
6679
|
+
* @format int32
|
|
6680
|
+
*/
|
|
6681
|
+
limit?: number;
|
|
6682
|
+
/**
|
|
6683
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
6684
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
6685
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
6686
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
6687
|
+
* always be returned in the specified sort-by order.
|
|
6688
|
+
*/
|
|
6689
|
+
mode?: ListMode;
|
|
6690
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6691
|
+
modified_date?: DateFilter;
|
|
6692
|
+
/** Filters for surveys by name(s). */
|
|
6693
|
+
name?: string[];
|
|
6694
|
+
/** Fields to sort the surveys by and the direction to sort them. */
|
|
6695
|
+
sort_by?: string[];
|
|
6696
|
+
}
|
|
6697
|
+
/** surveys-list-response */
|
|
6698
|
+
export interface SurveysListResponse {
|
|
6699
|
+
/**
|
|
6700
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
6701
|
+
* sort order. If not set, then no later elements exist.
|
|
6702
|
+
*/
|
|
6703
|
+
next_cursor?: string;
|
|
6704
|
+
/**
|
|
6705
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
6706
|
+
* sort order. If not set, then no prior elements exist.
|
|
6707
|
+
*/
|
|
6708
|
+
prev_cursor?: string;
|
|
6709
|
+
/** The list of the surveys. */
|
|
6710
|
+
surveys: Survey[];
|
|
6711
|
+
}
|
|
6712
|
+
/** surveys-responses-list-request */
|
|
6713
|
+
export interface SurveysResponsesListRequest {
|
|
6714
|
+
/**
|
|
6715
|
+
* Filters for survey responses created by any of these users.
|
|
6716
|
+
* @example ["DEVU-12345"]
|
|
6717
|
+
*/
|
|
6718
|
+
created_by?: string[];
|
|
6719
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6720
|
+
created_date?: DateFilter;
|
|
6721
|
+
/**
|
|
6722
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6723
|
+
* iteration starts from the beginning.
|
|
6724
|
+
*/
|
|
6725
|
+
cursor?: string;
|
|
6726
|
+
/**
|
|
6727
|
+
* The maximum number of survey responses to return. If not set, then
|
|
6728
|
+
* the default is '50'.
|
|
6729
|
+
* @format int32
|
|
6730
|
+
*/
|
|
6731
|
+
limit?: number;
|
|
6732
|
+
/**
|
|
6733
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
6734
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
6735
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
6736
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
6737
|
+
* always be returned in the specified sort-by order.
|
|
6738
|
+
*/
|
|
6739
|
+
mode?: ListMode;
|
|
6740
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6741
|
+
modified_date?: DateFilter;
|
|
6742
|
+
/**
|
|
6743
|
+
* Filters for survey responses created for the objects.
|
|
6744
|
+
* @example ["ACC-12345"]
|
|
6745
|
+
*/
|
|
6746
|
+
objects?: string[];
|
|
6747
|
+
/**
|
|
6748
|
+
* Fields to sort the survey responses by and the direction to sort
|
|
6749
|
+
* them.
|
|
6750
|
+
*/
|
|
6751
|
+
sort_by?: string[];
|
|
6752
|
+
/** Filters for survey responses for the provided survey IDs. */
|
|
6753
|
+
surveys?: string[];
|
|
6754
|
+
}
|
|
6755
|
+
/** surveys-responses-list-response */
|
|
6756
|
+
export interface SurveysResponsesListResponse {
|
|
6757
|
+
/**
|
|
6758
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
6759
|
+
* sort order. If not set, then no later elements exist.
|
|
6760
|
+
*/
|
|
6761
|
+
next_cursor?: string;
|
|
6762
|
+
/**
|
|
6763
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
6764
|
+
* sort order. If not set, then no prior elements exist.
|
|
6765
|
+
*/
|
|
6766
|
+
prev_cursor?: string;
|
|
6767
|
+
/** The list of the survey responses. */
|
|
6768
|
+
survey_responses: SurveyResponse[];
|
|
6769
|
+
}
|
|
6770
|
+
/** surveys-send-request */
|
|
6771
|
+
export interface SurveysSendRequest {
|
|
6772
|
+
email: SurveysSendRequestEmail;
|
|
6773
|
+
}
|
|
6774
|
+
/** surveys-send-request-email */
|
|
6775
|
+
export interface SurveysSendRequestEmail {
|
|
6776
|
+
/** Message body for a survey email. */
|
|
6777
|
+
body: string;
|
|
6778
|
+
/** Recipients list for a survey email. */
|
|
6779
|
+
recipients: string[];
|
|
6780
|
+
/** Sender email address from which an email is sent. */
|
|
6781
|
+
sender: string;
|
|
6782
|
+
/** Subject for an email where survey is sent. */
|
|
6783
|
+
subject: string;
|
|
6784
|
+
}
|
|
6785
|
+
/** surveys-send-response */
|
|
6786
|
+
export type SurveysSendResponse = object;
|
|
6787
|
+
/** surveys-submit-request */
|
|
6788
|
+
export interface SurveysSubmitRequest {
|
|
6789
|
+
/** The unique ID associated with the dispatched survey. */
|
|
6790
|
+
dispatch_id?: string;
|
|
6791
|
+
/**
|
|
6792
|
+
* The ID of the object this survey is on (e.g. ticket, conversation,
|
|
6793
|
+
* etc).
|
|
6794
|
+
* @example "ACC-12345"
|
|
6795
|
+
*/
|
|
6796
|
+
object: string;
|
|
6797
|
+
/** Survey response submitted for the object. */
|
|
6798
|
+
response: object;
|
|
6799
|
+
/**
|
|
6800
|
+
* The response score for the survey. Only applicable for CSAT and
|
|
6801
|
+
* NPS.
|
|
6802
|
+
* @format int32
|
|
6803
|
+
*/
|
|
6804
|
+
response_score?: number;
|
|
6805
|
+
/** The source channel from which survey response is submitted. */
|
|
6806
|
+
source_channel?: string;
|
|
6807
|
+
/** The ID of the survey to submit the response to. */
|
|
6808
|
+
survey: string;
|
|
6809
|
+
}
|
|
6810
|
+
/** surveys-submit-response */
|
|
6811
|
+
export type SurveysSubmitResponse = object;
|
|
6812
|
+
/** sync-metadata-filter */
|
|
6813
|
+
export interface SyncMetadataFilter {
|
|
6814
|
+
last_sync_in?: SyncMetadataFilterSyncInFilter;
|
|
6815
|
+
last_sync_out?: SyncMetadataFilterSyncOutFilter;
|
|
6816
|
+
/** Filters for issues synced from this specific origin system. */
|
|
6817
|
+
origin_system?: string[];
|
|
6818
|
+
}
|
|
6819
|
+
/** sync-metadata-filter-sync-in-filter */
|
|
6820
|
+
export interface SyncMetadataFilterSyncInFilter {
|
|
6821
|
+
/** Filters for works with selected sync statuses. */
|
|
6822
|
+
status?: SyncMetadataFilterSyncInFilterStatus[];
|
|
6823
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6824
|
+
sync_date?: DateFilter;
|
|
6825
|
+
/** Filters for works modified with selected sync units. */
|
|
6826
|
+
sync_unit?: string[];
|
|
6827
|
+
}
|
|
6828
|
+
export declare enum SyncMetadataFilterSyncInFilterStatus {
|
|
6829
|
+
Failed = "failed",
|
|
6830
|
+
Modified = "modified",
|
|
6831
|
+
Staged = "staged",
|
|
6832
|
+
Succeeded = "succeeded"
|
|
6833
|
+
}
|
|
6834
|
+
/** sync-metadata-filter-sync-out-filter */
|
|
6835
|
+
export interface SyncMetadataFilterSyncOutFilter {
|
|
6836
|
+
/** Filters for works with selected sync statuses. */
|
|
6837
|
+
status?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
6838
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6839
|
+
sync_date?: DateFilter;
|
|
6840
|
+
/** Filters for works modified with selected sync units. */
|
|
6841
|
+
sync_unit?: string[];
|
|
6842
|
+
}
|
|
6843
|
+
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
6844
|
+
Failed = "failed",
|
|
6845
|
+
Succeeded = "succeeded"
|
|
6846
|
+
}
|
|
5594
6847
|
/** sys-user */
|
|
5595
6848
|
export type SysUser = UserBase;
|
|
5596
6849
|
/** sys-user-summary */
|
|
@@ -5684,6 +6937,10 @@ export type Tag = AtomBase & {
|
|
|
5684
6937
|
*/
|
|
5685
6938
|
name: string;
|
|
5686
6939
|
};
|
|
6940
|
+
/** tag-search-summary */
|
|
6941
|
+
export type TagSearchSummary = SearchSummaryBase & {
|
|
6942
|
+
tag: TagSummary;
|
|
6943
|
+
};
|
|
5687
6944
|
/** tag-summary */
|
|
5688
6945
|
export type TagSummary = AtomBaseSummary & {
|
|
5689
6946
|
/**
|
|
@@ -5872,6 +7129,7 @@ export type Ticket = WorkBase & {
|
|
|
5872
7129
|
rev_org?: OrgSummary;
|
|
5873
7130
|
/** Severity of the ticket. */
|
|
5874
7131
|
severity?: TicketSeverity;
|
|
7132
|
+
sla_tracker?: SlaTrackerSummary;
|
|
5875
7133
|
/** Source channel of the ticket. */
|
|
5876
7134
|
source_channel?: string;
|
|
5877
7135
|
};
|
|
@@ -5974,7 +7232,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
5974
7232
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
5975
7233
|
/**
|
|
5976
7234
|
* The IDs of the artifacts attached to the comment.
|
|
5977
|
-
* @maxItems
|
|
7235
|
+
* @maxItems 50
|
|
5978
7236
|
* @example ["ARTIFACT-12345"]
|
|
5979
7237
|
*/
|
|
5980
7238
|
artifacts?: string[];
|
|
@@ -5989,6 +7247,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
|
|
|
5989
7247
|
link_previews?: string[];
|
|
5990
7248
|
/** Snap Kit Body of the comment. */
|
|
5991
7249
|
snap_kit_body?: TimelineSnapKitBody;
|
|
7250
|
+
/**
|
|
7251
|
+
* The snap widget body of the comment.
|
|
7252
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
7253
|
+
*/
|
|
7254
|
+
snap_widget_body?: string[];
|
|
5992
7255
|
}
|
|
5993
7256
|
export declare enum TimelineEntriesCreateRequestType {
|
|
5994
7257
|
TimelineComment = "timeline_comment"
|
|
@@ -6143,7 +7406,7 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
6143
7406
|
remove?: string[];
|
|
6144
7407
|
/**
|
|
6145
7408
|
* Sets the field to the provided artifacts.
|
|
6146
|
-
* @maxItems
|
|
7409
|
+
* @maxItems 50
|
|
6147
7410
|
* @example ["ARTIFACT-12345"]
|
|
6148
7411
|
*/
|
|
6149
7412
|
set?: string[];
|
|
@@ -6286,6 +7549,29 @@ export interface TimelineThread {
|
|
|
6286
7549
|
*/
|
|
6287
7550
|
total_replies?: number;
|
|
6288
7551
|
}
|
|
7552
|
+
/** track-event */
|
|
7553
|
+
export interface TrackEvent {
|
|
7554
|
+
/** Properties of client to be used in track API. */
|
|
7555
|
+
client_context?: ClientContext;
|
|
7556
|
+
/** Unique ID for the event. */
|
|
7557
|
+
event_id?: string;
|
|
7558
|
+
/**
|
|
7559
|
+
* The timestamp at which the event occurred.
|
|
7560
|
+
* @format date-time
|
|
7561
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7562
|
+
*/
|
|
7563
|
+
event_time?: string;
|
|
7564
|
+
/** Name of the event. */
|
|
7565
|
+
name: string;
|
|
7566
|
+
/** Payload of the event */
|
|
7567
|
+
payload: object;
|
|
7568
|
+
}
|
|
7569
|
+
/** track-events-publish-request */
|
|
7570
|
+
export interface TrackEventsPublishRequest {
|
|
7571
|
+
events_list: TrackEvent[];
|
|
7572
|
+
}
|
|
7573
|
+
/** track-events-publish-response */
|
|
7574
|
+
export type TrackEventsPublishResponse = object;
|
|
6289
7575
|
/**
|
|
6290
7576
|
* unit
|
|
6291
7577
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -6375,6 +7661,38 @@ export declare enum UomMetricScope {
|
|
|
6375
7661
|
Org = "org",
|
|
6376
7662
|
User = "user"
|
|
6377
7663
|
}
|
|
7664
|
+
/** uoms-count-request */
|
|
7665
|
+
export interface UomsCountRequest {
|
|
7666
|
+
/** List of aggregation types for filtering list of UOMs. */
|
|
7667
|
+
aggregation_types?: AggregationDetailAggregationType[];
|
|
7668
|
+
/**
|
|
7669
|
+
* List of Unit of Measurement (UOM) DONs to be used in filtering
|
|
7670
|
+
* complete list of UOMs defined in a Dev Org.
|
|
7671
|
+
*/
|
|
7672
|
+
ids?: string[];
|
|
7673
|
+
/** List of metric names for filtering list of UOMs. */
|
|
7674
|
+
metric_names?: string[];
|
|
7675
|
+
/**
|
|
7676
|
+
* List of part IDs for filtering list of UOMs.
|
|
7677
|
+
* @example ["PROD-12345"]
|
|
7678
|
+
*/
|
|
7679
|
+
part_ids?: string[];
|
|
7680
|
+
/**
|
|
7681
|
+
* List of product IDs for filtering list of UOMs.
|
|
7682
|
+
* @example ["PROD-12345"]
|
|
7683
|
+
*/
|
|
7684
|
+
product_ids?: string[];
|
|
7685
|
+
/** List of unit types for filtering list of UOMs. */
|
|
7686
|
+
unit_types?: UnitType[];
|
|
7687
|
+
}
|
|
7688
|
+
/** uoms-count-response */
|
|
7689
|
+
export interface UomsCountResponse {
|
|
7690
|
+
/**
|
|
7691
|
+
* Count of Unit of Measurements matching the filter.
|
|
7692
|
+
* @format int32
|
|
7693
|
+
*/
|
|
7694
|
+
count: number;
|
|
7695
|
+
}
|
|
6378
7696
|
/** uoms-create-request */
|
|
6379
7697
|
export interface UomsCreateRequest {
|
|
6380
7698
|
/** Stores aggregation type and dimension information. */
|
|
@@ -6602,6 +7920,10 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
6602
7920
|
/** State of the user. */
|
|
6603
7921
|
state?: UserState;
|
|
6604
7922
|
};
|
|
7923
|
+
/** user-search-summary */
|
|
7924
|
+
export type UserSearchSummary = SearchSummaryBase & {
|
|
7925
|
+
user: UserSummary;
|
|
7926
|
+
};
|
|
6605
7927
|
/** State of the user. */
|
|
6606
7928
|
export declare enum UserState {
|
|
6607
7929
|
Active = "active",
|
|
@@ -6621,6 +7943,30 @@ export declare enum UserType {
|
|
|
6621
7943
|
ServiceAccount = "service_account",
|
|
6622
7944
|
SysUser = "sys_user"
|
|
6623
7945
|
}
|
|
7946
|
+
/** vista-base-summary */
|
|
7947
|
+
export type VistaBaseSummary = AtomBaseSummary & {
|
|
7948
|
+
/** Name of the vista. */
|
|
7949
|
+
name: string;
|
|
7950
|
+
};
|
|
7951
|
+
/** vista-search-summary */
|
|
7952
|
+
export type VistaSearchSummary = SearchSummaryBase & {
|
|
7953
|
+
/** Represents a collection of DevRev objects. */
|
|
7954
|
+
vista: VistaSummary;
|
|
7955
|
+
};
|
|
7956
|
+
/**
|
|
7957
|
+
* vista-summary
|
|
7958
|
+
* Represents a collection of DevRev objects.
|
|
7959
|
+
*/
|
|
7960
|
+
export type VistaSummary = (CuratedVistaSummary | DynamicVistaSummary | GroupedVistaSummary) & {
|
|
7961
|
+
/** Type of vista object. */
|
|
7962
|
+
type: VistaType;
|
|
7963
|
+
};
|
|
7964
|
+
/** Type of vista object. */
|
|
7965
|
+
export declare enum VistaType {
|
|
7966
|
+
Curated = "curated",
|
|
7967
|
+
Dynamic = "dynamic",
|
|
7968
|
+
Grouped = "grouped"
|
|
7969
|
+
}
|
|
6624
7970
|
/** webhook */
|
|
6625
7971
|
export type Webhook = AtomBase & {
|
|
6626
7972
|
/** The event types that the webhook will receive. */
|
|
@@ -6660,6 +8006,9 @@ export interface WebhookEventRequest {
|
|
|
6660
8006
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
6661
8007
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
6662
8008
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
8009
|
+
survey_response_created?: EventSurveyResponseCreated;
|
|
8010
|
+
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
8011
|
+
survey_response_updated?: EventSurveyResponseUpdated;
|
|
6663
8012
|
tag_created?: EventTagCreated;
|
|
6664
8013
|
tag_deleted?: EventTagDeleted;
|
|
6665
8014
|
tag_updated?: EventTagUpdated;
|
|
@@ -6719,6 +8068,9 @@ export declare enum WebhookEventType {
|
|
|
6719
8068
|
RevUserCreated = "rev_user_created",
|
|
6720
8069
|
RevUserDeleted = "rev_user_deleted",
|
|
6721
8070
|
RevUserUpdated = "rev_user_updated",
|
|
8071
|
+
SlaTrackerCreated = "sla_tracker_created",
|
|
8072
|
+
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
8073
|
+
SlaTrackerUpdated = "sla_tracker_updated",
|
|
6722
8074
|
TagCreated = "tag_created",
|
|
6723
8075
|
TagDeleted = "tag_deleted",
|
|
6724
8076
|
TagUpdated = "tag_updated",
|
|
@@ -6917,6 +8269,8 @@ export type WorkBase = AtomBase & {
|
|
|
6917
8269
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
6918
8270
|
*/
|
|
6919
8271
|
stock_schema_fragment?: string;
|
|
8272
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
8273
|
+
subtype?: string;
|
|
6920
8274
|
/** Tags associated with the object. */
|
|
6921
8275
|
tags?: TagWithValue[];
|
|
6922
8276
|
/**
|
|
@@ -6930,9 +8284,21 @@ export type WorkBase = AtomBase & {
|
|
|
6930
8284
|
};
|
|
6931
8285
|
/** work-base-summary */
|
|
6932
8286
|
export type WorkBaseSummary = AtomBaseSummary & {
|
|
8287
|
+
/** The users that own the work. */
|
|
8288
|
+
owned_by: UserSummary[];
|
|
8289
|
+
/** Describes the current stage of a work item. */
|
|
8290
|
+
stage?: LegacyStageSummary;
|
|
6933
8291
|
/** Title of the work object. */
|
|
6934
8292
|
title: string;
|
|
6935
8293
|
};
|
|
8294
|
+
/** work-search-summary */
|
|
8295
|
+
export type WorkSearchSummary = SearchSummaryBase & {
|
|
8296
|
+
work: WorkSummary;
|
|
8297
|
+
};
|
|
8298
|
+
/** work-summary */
|
|
8299
|
+
export type WorkSummary = (IssueSummary | OpportunitySummary | TaskSummary | TicketSummary) & {
|
|
8300
|
+
type: WorkType;
|
|
8301
|
+
};
|
|
6936
8302
|
export declare enum WorkType {
|
|
6937
8303
|
Issue = "issue",
|
|
6938
8304
|
Opportunity = "opportunity",
|
|
@@ -6962,6 +8328,14 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
6962
8328
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6963
8329
|
*/
|
|
6964
8330
|
custom_schema_fragments?: string[];
|
|
8331
|
+
/**
|
|
8332
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8333
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8334
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8335
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8336
|
+
* specifier, it remains unmodified.
|
|
8337
|
+
*/
|
|
8338
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6965
8339
|
/**
|
|
6966
8340
|
* The users that own the work.
|
|
6967
8341
|
* @example ["DEVU-12345"]
|
|
@@ -7003,6 +8377,12 @@ export interface WorksCreateRequestIssue {
|
|
|
7003
8377
|
priority_v2?: number;
|
|
7004
8378
|
/** The sprint that the issue belongs to. */
|
|
7005
8379
|
sprint?: string;
|
|
8380
|
+
/**
|
|
8381
|
+
* Timestamp for when the work is expected to start.
|
|
8382
|
+
* @format date-time
|
|
8383
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8384
|
+
*/
|
|
8385
|
+
target_start_date?: string;
|
|
7006
8386
|
}
|
|
7007
8387
|
/** works-create-request-opportunity */
|
|
7008
8388
|
export interface WorksCreateRequestOpportunity {
|
|
@@ -7120,6 +8500,8 @@ export interface WorksExportRequest {
|
|
|
7120
8500
|
sort_by?: string[];
|
|
7121
8501
|
/** The filter for stages. */
|
|
7122
8502
|
stage?: StageFilter;
|
|
8503
|
+
staged_info?: StagedInfoFilter;
|
|
8504
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7123
8505
|
/**
|
|
7124
8506
|
* Filters for work with any of the provided tags.
|
|
7125
8507
|
* @example ["TAG-12345"]
|
|
@@ -7143,6 +8525,8 @@ export interface WorksFilterIssue {
|
|
|
7143
8525
|
* @example ["ACC-12345"]
|
|
7144
8526
|
*/
|
|
7145
8527
|
accounts?: string[];
|
|
8528
|
+
/** Provides ways to specify date ranges on objects. */
|
|
8529
|
+
actual_start_date?: DateFilter;
|
|
7146
8530
|
/** Filters for issues with any of the provided priorities. */
|
|
7147
8531
|
priority?: IssuePriority[];
|
|
7148
8532
|
/** Filters for issues with any of the provided priority enum ids. */
|
|
@@ -7152,6 +8536,10 @@ export interface WorksFilterIssue {
|
|
|
7152
8536
|
* @example ["REV-AbCdEfGh"]
|
|
7153
8537
|
*/
|
|
7154
8538
|
rev_orgs?: string[];
|
|
8539
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
8540
|
+
subtype?: string[];
|
|
8541
|
+
/** Provides ways to specify date ranges on objects. */
|
|
8542
|
+
target_start_date?: DateFilter;
|
|
7155
8543
|
}
|
|
7156
8544
|
/** works-filter-opportunity */
|
|
7157
8545
|
export interface WorksFilterOpportunity {
|
|
@@ -7163,6 +8551,8 @@ export interface WorksFilterOpportunity {
|
|
|
7163
8551
|
account?: string[];
|
|
7164
8552
|
/** Filters for opportunities with any of the provided contacts. */
|
|
7165
8553
|
contacts?: string[];
|
|
8554
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
8555
|
+
subtype?: string[];
|
|
7166
8556
|
}
|
|
7167
8557
|
/** works-filter-ticket */
|
|
7168
8558
|
export interface WorksFilterTicket {
|
|
@@ -7186,6 +8576,8 @@ export interface WorksFilterTicket {
|
|
|
7186
8576
|
sla_summary?: SlaSummaryFilter;
|
|
7187
8577
|
/** Filters for tickets with any of the provided source channels. */
|
|
7188
8578
|
source_channel?: string[];
|
|
8579
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
8580
|
+
subtype?: string[];
|
|
7189
8581
|
/** The filter for survey aggregation. */
|
|
7190
8582
|
surveys?: SurveyAggregationFilter;
|
|
7191
8583
|
}
|
|
@@ -7255,6 +8647,8 @@ export interface WorksListRequest {
|
|
|
7255
8647
|
sort_by?: string[];
|
|
7256
8648
|
/** The filter for stages. */
|
|
7257
8649
|
stage?: StageFilter;
|
|
8650
|
+
staged_info?: StagedInfoFilter;
|
|
8651
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7258
8652
|
/**
|
|
7259
8653
|
* Filters for work with any of the provided tags.
|
|
7260
8654
|
* @example ["TAG-12345"]
|
|
@@ -7288,7 +8682,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7288
8682
|
* @example "PROD-12345"
|
|
7289
8683
|
*/
|
|
7290
8684
|
applies_to_part?: string;
|
|
7291
|
-
artifacts?:
|
|
8685
|
+
artifacts?: WorksUpdateRequestArtifacts;
|
|
7292
8686
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
7293
8687
|
body?: string;
|
|
7294
8688
|
/** Custom fields. */
|
|
@@ -7298,6 +8692,14 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7298
8692
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
7299
8693
|
*/
|
|
7300
8694
|
custom_schema_fragments?: string[];
|
|
8695
|
+
/**
|
|
8696
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8697
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8698
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8699
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8700
|
+
* specifier, it remains unmodified.
|
|
8701
|
+
*/
|
|
8702
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7301
8703
|
/**
|
|
7302
8704
|
* The work's ID.
|
|
7303
8705
|
* @example "ISS-12345"
|
|
@@ -7319,10 +8721,23 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7319
8721
|
title?: string;
|
|
7320
8722
|
type?: WorkType;
|
|
7321
8723
|
};
|
|
7322
|
-
/** works-update-request-
|
|
7323
|
-
export interface
|
|
8724
|
+
/** works-update-request-artifacts */
|
|
8725
|
+
export interface WorksUpdateRequestArtifacts {
|
|
7324
8726
|
/**
|
|
7325
|
-
*
|
|
8727
|
+
* Adds the provided artifacts (if not already present) to the field.
|
|
8728
|
+
* @maxItems 50
|
|
8729
|
+
* @example ["ARTIFACT-12345"]
|
|
8730
|
+
*/
|
|
8731
|
+
add?: string[];
|
|
8732
|
+
/**
|
|
8733
|
+
* Removes the provided artifacts (if they exist) from the field.
|
|
8734
|
+
* @maxItems 50
|
|
8735
|
+
* @example ["ARTIFACT-12345"]
|
|
8736
|
+
*/
|
|
8737
|
+
remove?: string[];
|
|
8738
|
+
/**
|
|
8739
|
+
* Sets the field to the provided artifacts.
|
|
8740
|
+
* @maxItems 50
|
|
7326
8741
|
* @example ["ARTIFACT-12345"]
|
|
7327
8742
|
*/
|
|
7328
8743
|
set?: string[];
|
|
@@ -7339,6 +8754,12 @@ export interface WorksUpdateRequestIssue {
|
|
|
7339
8754
|
priority_v2?: number;
|
|
7340
8755
|
/** Updates the sprint that the issue belongs to. */
|
|
7341
8756
|
sprint?: string | null;
|
|
8757
|
+
/**
|
|
8758
|
+
* Updates the timestamp for when the work is expected to start.
|
|
8759
|
+
* @format date-time
|
|
8760
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8761
|
+
*/
|
|
8762
|
+
target_start_date?: string | null;
|
|
7342
8763
|
}
|
|
7343
8764
|
/** works-update-request-issue-developed-with */
|
|
7344
8765
|
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
@@ -7870,9 +9291,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7870
9291
|
* @request GET:/artifacts.list
|
|
7871
9292
|
* @secure
|
|
7872
9293
|
*/
|
|
7873
|
-
artifactsList: (query
|
|
9294
|
+
artifactsList: (query?: {
|
|
7874
9295
|
/** The ID of the object to filter artifacts. */
|
|
7875
|
-
parent_id
|
|
9296
|
+
parent_id?: string;
|
|
7876
9297
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
7877
9298
|
/**
|
|
7878
9299
|
* @description List the artifacts attached to an object.
|
|
@@ -8020,27 +9441,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8020
9441
|
*/
|
|
8021
9442
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
8022
9443
|
/**
|
|
8023
|
-
* @description
|
|
9444
|
+
* @description Creates a code change object.
|
|
8024
9445
|
*
|
|
8025
|
-
* @tags
|
|
9446
|
+
* @tags code-changes
|
|
8026
9447
|
* @name CodeChangesCreate
|
|
8027
9448
|
* @request POST:/code-changes.create
|
|
8028
9449
|
* @secure
|
|
8029
9450
|
*/
|
|
8030
9451
|
codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any>>;
|
|
8031
9452
|
/**
|
|
8032
|
-
* @description
|
|
9453
|
+
* @description Deletes a code change object.
|
|
8033
9454
|
*
|
|
8034
|
-
* @tags
|
|
9455
|
+
* @tags code-changes
|
|
8035
9456
|
* @name CodeChangesDelete
|
|
8036
9457
|
* @request POST:/code-changes.delete
|
|
8037
9458
|
* @secure
|
|
8038
9459
|
*/
|
|
8039
9460
|
codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8040
9461
|
/**
|
|
8041
|
-
* @description
|
|
9462
|
+
* @description Gets a code change object.
|
|
8042
9463
|
*
|
|
8043
|
-
* @tags
|
|
9464
|
+
* @tags code-changes
|
|
8044
9465
|
* @name CodeChangesGet
|
|
8045
9466
|
* @request GET:/code-changes.get
|
|
8046
9467
|
* @secure
|
|
@@ -8050,18 +9471,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8050
9471
|
id: string;
|
|
8051
9472
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
|
|
8052
9473
|
/**
|
|
8053
|
-
* @description
|
|
9474
|
+
* @description Gets a code change object.
|
|
8054
9475
|
*
|
|
8055
|
-
* @tags
|
|
9476
|
+
* @tags code-changes
|
|
8056
9477
|
* @name CodeChangesGetPost
|
|
8057
9478
|
* @request POST:/code-changes.get
|
|
8058
9479
|
* @secure
|
|
8059
9480
|
*/
|
|
8060
9481
|
codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
|
|
8061
9482
|
/**
|
|
8062
|
-
* @description
|
|
9483
|
+
* @description Lists code change objects.
|
|
8063
9484
|
*
|
|
8064
|
-
* @tags
|
|
9485
|
+
* @tags code-changes
|
|
8065
9486
|
* @name CodeChangesList
|
|
8066
9487
|
* @request GET:/code-changes.list
|
|
8067
9488
|
* @secure
|
|
@@ -8085,18 +9506,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8085
9506
|
mode?: ListMode;
|
|
8086
9507
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
|
|
8087
9508
|
/**
|
|
8088
|
-
* @description
|
|
9509
|
+
* @description Lists code change objects.
|
|
8089
9510
|
*
|
|
8090
|
-
* @tags
|
|
9511
|
+
* @tags code-changes
|
|
8091
9512
|
* @name CodeChangesListPost
|
|
8092
9513
|
* @request POST:/code-changes.list
|
|
8093
9514
|
* @secure
|
|
8094
9515
|
*/
|
|
8095
9516
|
codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
|
|
8096
9517
|
/**
|
|
8097
|
-
* @description
|
|
9518
|
+
* @description Updates a code change object.
|
|
8098
9519
|
*
|
|
8099
|
-
* @tags
|
|
9520
|
+
* @tags code-changes
|
|
8100
9521
|
* @name CodeChangesUpdate
|
|
8101
9522
|
* @request POST:/code-changes.update
|
|
8102
9523
|
* @secure
|
|
@@ -8877,6 +10298,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8877
10298
|
* starts from the beginning.
|
|
8878
10299
|
*/
|
|
8879
10300
|
cursor?: string;
|
|
10301
|
+
/**
|
|
10302
|
+
* Whether to include custom metrics in the response. If not set, then
|
|
10303
|
+
* custom metrics are excluded.
|
|
10304
|
+
*/
|
|
10305
|
+
include_custom_metrics?: boolean;
|
|
8880
10306
|
/**
|
|
8881
10307
|
* The maximum number of records to return. The default is '50'.
|
|
8882
10308
|
* @format int32
|
|
@@ -9155,6 +10581,110 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9155
10581
|
* @secure
|
|
9156
10582
|
*/
|
|
9157
10583
|
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
|
|
10584
|
+
/**
|
|
10585
|
+
* @description Creates a question-answer.
|
|
10586
|
+
*
|
|
10587
|
+
* @tags question-answers
|
|
10588
|
+
* @name CreateQuestionAnswer
|
|
10589
|
+
* @request POST:/question-answers.create
|
|
10590
|
+
* @secure
|
|
10591
|
+
*/
|
|
10592
|
+
createQuestionAnswer: (data: QuestionAnswersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersCreateResponse, any>>;
|
|
10593
|
+
/**
|
|
10594
|
+
* @description Deletes a question-answer.
|
|
10595
|
+
*
|
|
10596
|
+
* @tags question-answers
|
|
10597
|
+
* @name DeleteQuestionAnswer
|
|
10598
|
+
* @request POST:/question-answers.delete
|
|
10599
|
+
* @secure
|
|
10600
|
+
*/
|
|
10601
|
+
deleteQuestionAnswer: (data: QuestionAnswersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
10602
|
+
/**
|
|
10603
|
+
* @description Gets a question-answer.
|
|
10604
|
+
*
|
|
10605
|
+
* @tags question-answers
|
|
10606
|
+
* @name GetQuestionAnswer
|
|
10607
|
+
* @request GET:/question-answers.get
|
|
10608
|
+
* @secure
|
|
10609
|
+
*/
|
|
10610
|
+
getQuestionAnswer: (query: {
|
|
10611
|
+
/** The ID of the required question-answer. */
|
|
10612
|
+
id: string;
|
|
10613
|
+
}, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
|
|
10614
|
+
/**
|
|
10615
|
+
* @description Gets a question-answer.
|
|
10616
|
+
*
|
|
10617
|
+
* @tags question-answers
|
|
10618
|
+
* @name GetQuestionAnswerPost
|
|
10619
|
+
* @request POST:/question-answers.get
|
|
10620
|
+
* @secure
|
|
10621
|
+
*/
|
|
10622
|
+
getQuestionAnswerPost: (data: QuestionAnswersGetRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
|
|
10623
|
+
/**
|
|
10624
|
+
* @description Lists a collection of question-answers.
|
|
10625
|
+
*
|
|
10626
|
+
* @tags question-answers
|
|
10627
|
+
* @name ListQuestionAnswers
|
|
10628
|
+
* @request GET:/question-answers.list
|
|
10629
|
+
* @secure
|
|
10630
|
+
*/
|
|
10631
|
+
listQuestionAnswers: (query?: {
|
|
10632
|
+
/**
|
|
10633
|
+
* Filters for question-answer belonging to any of the provided
|
|
10634
|
+
* articles.
|
|
10635
|
+
* @example ["ARTICLE-12345"]
|
|
10636
|
+
*/
|
|
10637
|
+
applies_to_articles?: string[];
|
|
10638
|
+
/**
|
|
10639
|
+
* Filters for question-answer belonging to any of the provided parts.
|
|
10640
|
+
* @example ["PROD-12345"]
|
|
10641
|
+
*/
|
|
10642
|
+
applies_to_parts?: string[];
|
|
10643
|
+
/**
|
|
10644
|
+
* Filters for question-answers created by any of the provided users.
|
|
10645
|
+
* @example ["DEVU-12345"]
|
|
10646
|
+
*/
|
|
10647
|
+
created_by?: string[];
|
|
10648
|
+
/**
|
|
10649
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
10650
|
+
* starts from the beginning.
|
|
10651
|
+
*/
|
|
10652
|
+
cursor?: string;
|
|
10653
|
+
/**
|
|
10654
|
+
* The maximum number of question-answers to return. The default is
|
|
10655
|
+
* '50'.
|
|
10656
|
+
* @format int32
|
|
10657
|
+
*/
|
|
10658
|
+
limit?: number;
|
|
10659
|
+
/**
|
|
10660
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
10661
|
+
* used.
|
|
10662
|
+
*/
|
|
10663
|
+
mode?: ListMode;
|
|
10664
|
+
/**
|
|
10665
|
+
* Filters for question-answers owned by any of the provided users.
|
|
10666
|
+
* @example ["DEVU-12345"]
|
|
10667
|
+
*/
|
|
10668
|
+
owned_by?: string[];
|
|
10669
|
+
}, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
|
|
10670
|
+
/**
|
|
10671
|
+
* @description Lists a collection of question-answers.
|
|
10672
|
+
*
|
|
10673
|
+
* @tags question-answers
|
|
10674
|
+
* @name ListQuestionAnswersPost
|
|
10675
|
+
* @request POST:/question-answers.list
|
|
10676
|
+
* @secure
|
|
10677
|
+
*/
|
|
10678
|
+
listQuestionAnswersPost: (data: QuestionAnswersListRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
|
|
10679
|
+
/**
|
|
10680
|
+
* @description Updates a question-answer.
|
|
10681
|
+
*
|
|
10682
|
+
* @tags question-answers
|
|
10683
|
+
* @name UpdateQuestionAnswer
|
|
10684
|
+
* @request POST:/question-answers.update
|
|
10685
|
+
* @secure
|
|
10686
|
+
*/
|
|
10687
|
+
updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any>>;
|
|
9158
10688
|
/**
|
|
9159
10689
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
9160
10690
|
*
|
|
@@ -9244,6 +10774,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9244
10774
|
custom_field_filter?: string[];
|
|
9245
10775
|
/** Filters for custom fields. */
|
|
9246
10776
|
custom_fields?: object;
|
|
10777
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
10778
|
+
display_name?: string[];
|
|
9247
10779
|
/** List of external refs to filter Rev organizations for. */
|
|
9248
10780
|
external_ref?: string[];
|
|
9249
10781
|
/**
|
|
@@ -9453,6 +10985,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9453
10985
|
aggregatedSchemaGet: (query: {
|
|
9454
10986
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
9455
10987
|
custom_schema_fragment_ids: string[];
|
|
10988
|
+
/**
|
|
10989
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
10990
|
+
* tenant fragment ID.
|
|
10991
|
+
*/
|
|
10992
|
+
leaf_type?: string;
|
|
9456
10993
|
/** The stock schema fragment which is to be aggregated. */
|
|
9457
10994
|
stock_schema_fragment_id?: string;
|
|
9458
10995
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
@@ -9498,8 +11035,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9498
11035
|
/** The list of app names. */
|
|
9499
11036
|
app?: string[];
|
|
9500
11037
|
/**
|
|
9501
|
-
* The cursor to resume iteration from
|
|
9502
|
-
*
|
|
11038
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11039
|
+
* starts from the beginning.
|
|
9503
11040
|
*/
|
|
9504
11041
|
cursor?: string;
|
|
9505
11042
|
/** Whether only deprecated fragments should be filtered. */
|
|
@@ -9511,6 +11048,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9511
11048
|
* @format int32
|
|
9512
11049
|
*/
|
|
9513
11050
|
limit?: number;
|
|
11051
|
+
/**
|
|
11052
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11053
|
+
* used.
|
|
11054
|
+
*/
|
|
11055
|
+
mode?: ListMode;
|
|
11056
|
+
/**
|
|
11057
|
+
* List of fields which are not required in the payload and can be
|
|
11058
|
+
* pruned away.
|
|
11059
|
+
*/
|
|
11060
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
9514
11061
|
/** The list of fields to sort the items by and how to sort them. */
|
|
9515
11062
|
sort_by?: string[];
|
|
9516
11063
|
/** The list of subtypes. */
|
|
@@ -9569,10 +11116,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9569
11116
|
*/
|
|
9570
11117
|
stockSchemaFragmentsList: (query?: {
|
|
9571
11118
|
/**
|
|
9572
|
-
* The cursor to resume iteration from
|
|
9573
|
-
*
|
|
11119
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11120
|
+
* starts from the beginning.
|
|
9574
11121
|
*/
|
|
9575
11122
|
cursor?: string;
|
|
11123
|
+
/**
|
|
11124
|
+
* Filter preset to specify whether to filter only customization enabled
|
|
11125
|
+
* leaf types.
|
|
11126
|
+
*/
|
|
11127
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
9576
11128
|
/** The list of leaf types. */
|
|
9577
11129
|
leaf_type?: string[];
|
|
9578
11130
|
/**
|
|
@@ -9580,6 +11132,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9580
11132
|
* @format int32
|
|
9581
11133
|
*/
|
|
9582
11134
|
limit?: number;
|
|
11135
|
+
/**
|
|
11136
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11137
|
+
* used.
|
|
11138
|
+
*/
|
|
11139
|
+
mode?: ListMode;
|
|
11140
|
+
/**
|
|
11141
|
+
* List of fields which are not required in the payload and can be
|
|
11142
|
+
* pruned away.
|
|
11143
|
+
*/
|
|
11144
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
9583
11145
|
/** The list of fields to sort the items by and how to sort them. */
|
|
9584
11146
|
sort_by?: string[];
|
|
9585
11147
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
@@ -9618,6 +11180,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9618
11180
|
* @secure
|
|
9619
11181
|
*/
|
|
9620
11182
|
subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
11183
|
+
/**
|
|
11184
|
+
* @description Searches for records based on a given query.
|
|
11185
|
+
*
|
|
11186
|
+
* @tags search
|
|
11187
|
+
* @name SearchCore
|
|
11188
|
+
* @request GET:/search.core
|
|
11189
|
+
* @secure
|
|
11190
|
+
*/
|
|
11191
|
+
searchCore: (query: {
|
|
11192
|
+
/**
|
|
11193
|
+
* The query string. Search query language:
|
|
11194
|
+
* https://docs.devrev.ai/product/search#fields
|
|
11195
|
+
*/
|
|
11196
|
+
query: string;
|
|
11197
|
+
/**
|
|
11198
|
+
* The cursor from where to begin iteration. Start from beginning if not
|
|
11199
|
+
* provided.
|
|
11200
|
+
*/
|
|
11201
|
+
cursor?: string | undefined;
|
|
11202
|
+
/**
|
|
11203
|
+
* The maximum number of items to return in a page. The default is '10'.
|
|
11204
|
+
* @format int32
|
|
11205
|
+
*/
|
|
11206
|
+
limit?: number | undefined;
|
|
11207
|
+
/** The namespaces to search in. */
|
|
11208
|
+
namespaces?: SearchNamespace[] | undefined;
|
|
11209
|
+
/**
|
|
11210
|
+
* The property on which to sort the search results. The default is
|
|
11211
|
+
* RELEVANCE.
|
|
11212
|
+
*/
|
|
11213
|
+
sort_by?: SearchSortByParam | undefined;
|
|
11214
|
+
/** Sorting order. The default is DESCENDING. */
|
|
11215
|
+
sort_order?: SearchSortOrderParam | undefined;
|
|
11216
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
|
|
11217
|
+
/**
|
|
11218
|
+
* @description Searches for records based on a given query.
|
|
11219
|
+
*
|
|
11220
|
+
* @tags search
|
|
11221
|
+
* @name SearchCorePost
|
|
11222
|
+
* @request POST:/search.core
|
|
11223
|
+
* @secure
|
|
11224
|
+
*/
|
|
11225
|
+
searchCorePost: (data: SearchCoreRequest, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
|
|
9621
11226
|
/**
|
|
9622
11227
|
* @description Gets a service account.
|
|
9623
11228
|
*
|
|
@@ -9639,6 +11244,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9639
11244
|
* @secure
|
|
9640
11245
|
*/
|
|
9641
11246
|
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
11247
|
+
/**
|
|
11248
|
+
* @description Gets an SLA tracker.
|
|
11249
|
+
*
|
|
11250
|
+
* @tags slas
|
|
11251
|
+
* @name SlaTrackersGet
|
|
11252
|
+
* @request GET:/sla-trackers.get
|
|
11253
|
+
* @secure
|
|
11254
|
+
*/
|
|
11255
|
+
slaTrackersGet: (query: {
|
|
11256
|
+
/** The ID of the SLA tracker to get. */
|
|
11257
|
+
id: string;
|
|
11258
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
11259
|
+
/**
|
|
11260
|
+
* @description Gets an SLA tracker.
|
|
11261
|
+
*
|
|
11262
|
+
* @tags slas
|
|
11263
|
+
* @name SlaTrackersGetPost
|
|
11264
|
+
* @request POST:/sla-trackers.get
|
|
11265
|
+
* @secure
|
|
11266
|
+
*/
|
|
11267
|
+
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
9642
11268
|
/**
|
|
9643
11269
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
9644
11270
|
*
|
|
@@ -9755,6 +11381,147 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9755
11381
|
* @secure
|
|
9756
11382
|
*/
|
|
9757
11383
|
snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
11384
|
+
/**
|
|
11385
|
+
* @description Create a snap widget object.
|
|
11386
|
+
*
|
|
11387
|
+
* @tags snap-widgets
|
|
11388
|
+
* @name SnapWidgetsCreate
|
|
11389
|
+
* @request POST:/snap-widgets.create
|
|
11390
|
+
* @secure
|
|
11391
|
+
*/
|
|
11392
|
+
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
|
|
11393
|
+
/**
|
|
11394
|
+
* @description Creates a schema for survey, which includes name and description of schema.
|
|
11395
|
+
*
|
|
11396
|
+
* @tags surveys
|
|
11397
|
+
* @name SurveysCreate
|
|
11398
|
+
* @request POST:/surveys.create
|
|
11399
|
+
* @secure
|
|
11400
|
+
*/
|
|
11401
|
+
surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any>>;
|
|
11402
|
+
/**
|
|
11403
|
+
* @description Deletes the specified survey.
|
|
11404
|
+
*
|
|
11405
|
+
* @tags surveys
|
|
11406
|
+
* @name SurveysDelete
|
|
11407
|
+
* @request POST:/surveys.delete
|
|
11408
|
+
* @secure
|
|
11409
|
+
*/
|
|
11410
|
+
surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11411
|
+
/**
|
|
11412
|
+
* @description List surveys requested by the user.
|
|
11413
|
+
*
|
|
11414
|
+
* @tags surveys
|
|
11415
|
+
* @name SurveysList
|
|
11416
|
+
* @request GET:/surveys.list
|
|
11417
|
+
* @secure
|
|
11418
|
+
*/
|
|
11419
|
+
surveysList: (query?: {
|
|
11420
|
+
/**
|
|
11421
|
+
* Filters for surveys created by any of these users.
|
|
11422
|
+
* @example ["DEVU-12345"]
|
|
11423
|
+
*/
|
|
11424
|
+
created_by?: string[];
|
|
11425
|
+
/**
|
|
11426
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11427
|
+
* starts from the beginning.
|
|
11428
|
+
*/
|
|
11429
|
+
cursor?: string;
|
|
11430
|
+
/**
|
|
11431
|
+
* The maximum number of surveys to return. If not set, then the default
|
|
11432
|
+
* is '50'.
|
|
11433
|
+
* @format int32
|
|
11434
|
+
*/
|
|
11435
|
+
limit?: number;
|
|
11436
|
+
/**
|
|
11437
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11438
|
+
* used.
|
|
11439
|
+
*/
|
|
11440
|
+
mode?: ListMode;
|
|
11441
|
+
/** Filters for surveys by name(s). */
|
|
11442
|
+
name?: string[];
|
|
11443
|
+
/** Fields to sort the surveys by and the direction to sort them. */
|
|
11444
|
+
sort_by?: string[];
|
|
11445
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
|
|
11446
|
+
/**
|
|
11447
|
+
* @description List surveys requested by the user.
|
|
11448
|
+
*
|
|
11449
|
+
* @tags surveys
|
|
11450
|
+
* @name SurveysListPost
|
|
11451
|
+
* @request POST:/surveys.list
|
|
11452
|
+
* @secure
|
|
11453
|
+
*/
|
|
11454
|
+
surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
|
|
11455
|
+
/**
|
|
11456
|
+
* @description List survey responses requested by the user.
|
|
11457
|
+
*
|
|
11458
|
+
* @tags surveys
|
|
11459
|
+
* @name SurveysResponsesList
|
|
11460
|
+
* @request GET:/surveys.responses.list
|
|
11461
|
+
* @secure
|
|
11462
|
+
*/
|
|
11463
|
+
surveysResponsesList: (query?: {
|
|
11464
|
+
/**
|
|
11465
|
+
* Filters for survey responses created by any of these users.
|
|
11466
|
+
* @example ["DEVU-12345"]
|
|
11467
|
+
*/
|
|
11468
|
+
created_by?: string[];
|
|
11469
|
+
/**
|
|
11470
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11471
|
+
* starts from the beginning.
|
|
11472
|
+
*/
|
|
11473
|
+
cursor?: string;
|
|
11474
|
+
/**
|
|
11475
|
+
* The maximum number of survey responses to return. If not set, then
|
|
11476
|
+
* the default is '50'.
|
|
11477
|
+
* @format int32
|
|
11478
|
+
*/
|
|
11479
|
+
limit?: number;
|
|
11480
|
+
/**
|
|
11481
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11482
|
+
* used.
|
|
11483
|
+
*/
|
|
11484
|
+
mode?: ListMode;
|
|
11485
|
+
/**
|
|
11486
|
+
* Filters for survey responses created for the objects.
|
|
11487
|
+
* @example ["ACC-12345"]
|
|
11488
|
+
*/
|
|
11489
|
+
objects?: string[];
|
|
11490
|
+
/**
|
|
11491
|
+
* Fields to sort the survey responses by and the direction to sort
|
|
11492
|
+
* them.
|
|
11493
|
+
*/
|
|
11494
|
+
sort_by?: string[];
|
|
11495
|
+
/** Filters for survey responses for the provided survey IDs. */
|
|
11496
|
+
surveys?: string[];
|
|
11497
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
|
|
11498
|
+
/**
|
|
11499
|
+
* @description List survey responses requested by the user.
|
|
11500
|
+
*
|
|
11501
|
+
* @tags surveys
|
|
11502
|
+
* @name SurveysResponsesListPost
|
|
11503
|
+
* @request POST:/surveys.responses.list
|
|
11504
|
+
* @secure
|
|
11505
|
+
*/
|
|
11506
|
+
surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
|
|
11507
|
+
/**
|
|
11508
|
+
* @description Sends a survey on the specified channels.
|
|
11509
|
+
*
|
|
11510
|
+
* @tags surveys
|
|
11511
|
+
* @name SurveysSend
|
|
11512
|
+
* @request POST:/surveys.send
|
|
11513
|
+
* @secure
|
|
11514
|
+
*/
|
|
11515
|
+
surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11516
|
+
/**
|
|
11517
|
+
* @description Submits a user response to a survey, which is defined by the survey ID.
|
|
11518
|
+
*
|
|
11519
|
+
* @tags surveys
|
|
11520
|
+
* @name SurveysSubmit
|
|
11521
|
+
* @request POST:/surveys.submit
|
|
11522
|
+
* @secure
|
|
11523
|
+
*/
|
|
11524
|
+
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
9758
11525
|
/**
|
|
9759
11526
|
* @description Lists system users within your organization.
|
|
9760
11527
|
*
|
|
@@ -9999,6 +11766,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9999
11766
|
* @secure
|
|
10000
11767
|
*/
|
|
10001
11768
|
timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
|
|
11769
|
+
/**
|
|
11770
|
+
* @description Allows publishing of events (example from plug widget).
|
|
11771
|
+
*
|
|
11772
|
+
* @tags event-source
|
|
11773
|
+
* @name TrackEventsPublish
|
|
11774
|
+
* @request POST:/track-events.publish
|
|
11775
|
+
* @secure
|
|
11776
|
+
*/
|
|
11777
|
+
trackEventsPublish: (data: TrackEventsPublishRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11778
|
+
/**
|
|
11779
|
+
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
11780
|
+
*
|
|
11781
|
+
* @tags product-usage
|
|
11782
|
+
* @name UomsCount
|
|
11783
|
+
* @request GET:/uoms.count
|
|
11784
|
+
* @secure
|
|
11785
|
+
*/
|
|
11786
|
+
uomsCount: (query?: {
|
|
11787
|
+
/** List of aggregation types for filtering list of UOMs. */
|
|
11788
|
+
aggregation_types?: AggregationDetailAggregationType[];
|
|
11789
|
+
/**
|
|
11790
|
+
* List of Unit of Measurement (UOM) DONs to be used in filtering
|
|
11791
|
+
* complete list of UOMs defined in a Dev Org.
|
|
11792
|
+
*/
|
|
11793
|
+
ids?: string[];
|
|
11794
|
+
/** List of metric names for filtering list of UOMs. */
|
|
11795
|
+
metric_names?: string[];
|
|
11796
|
+
/**
|
|
11797
|
+
* List of part IDs for filtering list of UOMs.
|
|
11798
|
+
* @example ["PROD-12345"]
|
|
11799
|
+
*/
|
|
11800
|
+
part_ids?: string[];
|
|
11801
|
+
/**
|
|
11802
|
+
* List of product IDs for filtering list of UOMs.
|
|
11803
|
+
* @example ["PROD-12345"]
|
|
11804
|
+
*/
|
|
11805
|
+
product_ids?: string[];
|
|
11806
|
+
/** List of unit types for filtering list of UOMs. */
|
|
11807
|
+
unit_types?: UnitType[];
|
|
11808
|
+
}, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
|
|
11809
|
+
/**
|
|
11810
|
+
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
11811
|
+
*
|
|
11812
|
+
* @tags product-usage
|
|
11813
|
+
* @name UomsCountPost
|
|
11814
|
+
* @request POST:/uoms.count
|
|
11815
|
+
* @secure
|
|
11816
|
+
*/
|
|
11817
|
+
uomsCountPost: (data: UomsCountRequest, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
|
|
10002
11818
|
/**
|
|
10003
11819
|
* @description Creates a Unit of Measurement on a part.
|
|
10004
11820
|
*
|
|
@@ -10236,6 +12052,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10236
12052
|
* @example ["REV-AbCdEfGh"]
|
|
10237
12053
|
*/
|
|
10238
12054
|
'issue.rev_orgs'?: string[];
|
|
12055
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
12056
|
+
'issue.subtype'?: string[];
|
|
10239
12057
|
/**
|
|
10240
12058
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
10241
12059
|
* @example ["ACC-12345"]
|
|
@@ -10243,6 +12061,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10243
12061
|
'opportunity.account'?: string[];
|
|
10244
12062
|
/** Filters for opportunities with any of the provided contacts. */
|
|
10245
12063
|
'opportunity.contacts'?: string[];
|
|
12064
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
12065
|
+
'opportunity.subtype'?: string[];
|
|
10246
12066
|
/**
|
|
10247
12067
|
* Filters for work owned by any of these users.
|
|
10248
12068
|
* @example ["DEVU-12345"]
|
|
@@ -10257,6 +12077,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10257
12077
|
sort_by?: string[];
|
|
10258
12078
|
/** Filters for records in the provided stage(s) by name. */
|
|
10259
12079
|
'stage.name'?: string[];
|
|
12080
|
+
/** Filters for issues that are staged. */
|
|
12081
|
+
'staged_info.is_staged'?: boolean;
|
|
12082
|
+
/** Filters for works with selected sync statuses. */
|
|
12083
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
12084
|
+
/** Filters for works modified with selected sync units. */
|
|
12085
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
12086
|
+
/** Filters for works with selected sync statuses. */
|
|
12087
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
12088
|
+
/** Filters for works modified with selected sync units. */
|
|
12089
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
12090
|
+
/** Filters for issues synced from this specific origin system. */
|
|
12091
|
+
'sync_metadata.origin_system'?: string[];
|
|
10260
12092
|
/**
|
|
10261
12093
|
* Filters for work with any of the provided tags.
|
|
10262
12094
|
* @example ["TAG-12345"]
|
|
@@ -10282,6 +12114,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10282
12114
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
10283
12115
|
/** Filters for tickets with any of the provided source channels. */
|
|
10284
12116
|
'ticket.source_channel'?: string[];
|
|
12117
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
12118
|
+
'ticket.subtype'?: string[];
|
|
10285
12119
|
/** Filters for work of the provided types. */
|
|
10286
12120
|
type?: WorkType[];
|
|
10287
12121
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
@@ -10358,6 +12192,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10358
12192
|
* @example ["REV-AbCdEfGh"]
|
|
10359
12193
|
*/
|
|
10360
12194
|
'issue.rev_orgs'?: string[];
|
|
12195
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
12196
|
+
'issue.subtype'?: string[];
|
|
10361
12197
|
/**
|
|
10362
12198
|
* The maximum number of works to return. The default is '50'.
|
|
10363
12199
|
* @format int32
|
|
@@ -10375,6 +12211,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10375
12211
|
'opportunity.account'?: string[];
|
|
10376
12212
|
/** Filters for opportunities with any of the provided contacts. */
|
|
10377
12213
|
'opportunity.contacts'?: string[];
|
|
12214
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
12215
|
+
'opportunity.subtype'?: string[];
|
|
10378
12216
|
/**
|
|
10379
12217
|
* Filters for work owned by any of these users.
|
|
10380
12218
|
* @example ["DEVU-12345"]
|
|
@@ -10389,6 +12227,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10389
12227
|
sort_by?: string[];
|
|
10390
12228
|
/** Filters for records in the provided stage(s) by name. */
|
|
10391
12229
|
'stage.name'?: string[];
|
|
12230
|
+
/** Filters for issues that are staged. */
|
|
12231
|
+
'staged_info.is_staged'?: boolean;
|
|
12232
|
+
/** Filters for works with selected sync statuses. */
|
|
12233
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
12234
|
+
/** Filters for works modified with selected sync units. */
|
|
12235
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
12236
|
+
/** Filters for works with selected sync statuses. */
|
|
12237
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
12238
|
+
/** Filters for works modified with selected sync units. */
|
|
12239
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
12240
|
+
/** Filters for issues synced from this specific origin system. */
|
|
12241
|
+
'sync_metadata.origin_system'?: string[];
|
|
10392
12242
|
/**
|
|
10393
12243
|
* Filters for work with any of the provided tags.
|
|
10394
12244
|
* @example ["TAG-12345"]
|
|
@@ -10414,6 +12264,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10414
12264
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
10415
12265
|
/** Filters for tickets with any of the provided source channels. */
|
|
10416
12266
|
'ticket.source_channel'?: string[];
|
|
12267
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
12268
|
+
'ticket.subtype'?: string[];
|
|
10417
12269
|
/** Filters for work of the provided types. */
|
|
10418
12270
|
type?: WorkType[];
|
|
10419
12271
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|