@devrev/typescript-sdk 1.1.23 → 1.1.25
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,8 +465,17 @@ 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 {
|
|
477
|
+
/** The ancestor directory of the articles. */
|
|
478
|
+
ancestor?: string;
|
|
413
479
|
/**
|
|
414
480
|
* Filters for articles belonging to any of the provided parts.
|
|
415
481
|
* @example ["PROD-12345"]
|
|
@@ -482,7 +548,7 @@ export interface ArticlesCreateRequest {
|
|
|
482
548
|
published_at?: string;
|
|
483
549
|
resource: ArticlesCreateRequestResource;
|
|
484
550
|
/** Information about the role the member receives due to the share. */
|
|
485
|
-
shared_with?:
|
|
551
|
+
shared_with?: SetSharedWithMembership[];
|
|
486
552
|
/** Status of the article. */
|
|
487
553
|
status?: ArticleStatus;
|
|
488
554
|
/** Tags associated with the article. */
|
|
@@ -703,7 +769,7 @@ export interface ArticlesUpdateRequestReorder {
|
|
|
703
769
|
/** articles-update-request-shared-with */
|
|
704
770
|
export interface ArticlesUpdateRequestSharedWith {
|
|
705
771
|
/** Sets the field to the provided membership list. */
|
|
706
|
-
set?:
|
|
772
|
+
set?: SetSharedWithMembership[];
|
|
707
773
|
}
|
|
708
774
|
/** articles-update-request-tags */
|
|
709
775
|
export interface ArticlesUpdateRequestTags {
|
|
@@ -716,6 +782,10 @@ export interface ArticlesUpdateResponse {
|
|
|
716
782
|
}
|
|
717
783
|
/** artifact */
|
|
718
784
|
export type Artifact = AtomBase;
|
|
785
|
+
/** artifact-search-summary */
|
|
786
|
+
export type ArtifactSearchSummary = SearchSummaryBase & {
|
|
787
|
+
artifact: ArtifactSummary;
|
|
788
|
+
};
|
|
719
789
|
/** artifact-summary */
|
|
720
790
|
export type ArtifactSummary = AtomBaseSummary;
|
|
721
791
|
/**
|
|
@@ -761,7 +831,7 @@ export interface ArtifactsGetResponse {
|
|
|
761
831
|
*/
|
|
762
832
|
export interface ArtifactsListRequest {
|
|
763
833
|
/** The ID of the object to filter artifacts. */
|
|
764
|
-
parent_id
|
|
834
|
+
parent_id?: string;
|
|
765
835
|
}
|
|
766
836
|
/**
|
|
767
837
|
* artifacts-list-response
|
|
@@ -1047,8 +1117,10 @@ export declare enum AuthTokenGrantType {
|
|
|
1047
1117
|
/** The type of the requested token. */
|
|
1048
1118
|
export declare enum AuthTokenRequestedTokenType {
|
|
1049
1119
|
UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
|
|
1120
|
+
UrnDevrevParamsOauthTokenTypeAatActAs = "urn:devrev:params:oauth:token-type:aat:act-as",
|
|
1050
1121
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
1051
1122
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
1123
|
+
UrnDevrevParamsOauthTokenTypeDevConnect = "urn:devrev:params:oauth:token-type:dev:connect",
|
|
1052
1124
|
UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
|
|
1053
1125
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
1054
1126
|
UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
|
|
@@ -1057,6 +1129,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
1057
1129
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
1058
1130
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
1059
1131
|
UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
|
|
1132
|
+
UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
|
|
1060
1133
|
UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
|
|
1061
1134
|
UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
|
|
1062
1135
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
@@ -1089,7 +1162,10 @@ export declare enum AuthTokenTokenType {
|
|
|
1089
1162
|
* type.
|
|
1090
1163
|
*/
|
|
1091
1164
|
export interface AuthTokensCreateRequest {
|
|
1092
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* The unique ID of the Dev user or the service account to
|
|
1167
|
+
* impersonate.
|
|
1168
|
+
*/
|
|
1093
1169
|
act_as?: string;
|
|
1094
1170
|
/** The expected audience values with respect to the token. */
|
|
1095
1171
|
aud?: string[];
|
|
@@ -1301,10 +1377,145 @@ export interface AuthTokensUserTraits {
|
|
|
1301
1377
|
/** Phone numbers of the Rev user. */
|
|
1302
1378
|
phone_numbers?: string[];
|
|
1303
1379
|
}
|
|
1380
|
+
/**
|
|
1381
|
+
* boolean-expression
|
|
1382
|
+
* Boolean expression.
|
|
1383
|
+
*/
|
|
1384
|
+
export type BooleanExpression = (BooleanExpressionAndExpression | BooleanExpressionNotExpression | BooleanExpressionOrExpression | BooleanExpressionPrimitiveExpression) & {
|
|
1385
|
+
type: BooleanExpressionType;
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* boolean-expression-and-expression
|
|
1389
|
+
* All the expressions would be 'and'ed together.
|
|
1390
|
+
*/
|
|
1391
|
+
export interface BooleanExpressionAndExpression {
|
|
1392
|
+
expressions: BooleanExpression[];
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* boolean-expression-not-expression
|
|
1396
|
+
* The expression would be negated.
|
|
1397
|
+
*/
|
|
1398
|
+
export interface BooleanExpressionNotExpression {
|
|
1399
|
+
/** Boolean expression. */
|
|
1400
|
+
expression: BooleanExpression;
|
|
1401
|
+
}
|
|
1402
|
+
/**
|
|
1403
|
+
* boolean-expression-or-expression
|
|
1404
|
+
* All the expressions would be 'or'ed together.
|
|
1405
|
+
*/
|
|
1406
|
+
export interface BooleanExpressionOrExpression {
|
|
1407
|
+
expressions: BooleanExpression[];
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* boolean-expression-primitive-expression
|
|
1411
|
+
* The primitive expression type.
|
|
1412
|
+
*/
|
|
1413
|
+
export type BooleanExpressionPrimitiveExpression = object;
|
|
1414
|
+
export declare enum BooleanExpressionType {
|
|
1415
|
+
And = "and",
|
|
1416
|
+
Not = "not",
|
|
1417
|
+
Or = "or",
|
|
1418
|
+
Primitive = "primitive"
|
|
1419
|
+
}
|
|
1304
1420
|
/** capability */
|
|
1305
1421
|
export type Capability = PartBase;
|
|
1306
1422
|
/** capability-summary */
|
|
1307
1423
|
export type CapabilitySummary = PartBaseSummary;
|
|
1424
|
+
/**
|
|
1425
|
+
* client-context
|
|
1426
|
+
* Properties of client to be used in track API.
|
|
1427
|
+
*/
|
|
1428
|
+
export interface ClientContext {
|
|
1429
|
+
/** Properties of client's browser to be used in track API. */
|
|
1430
|
+
browser?: ClientContextBrowser;
|
|
1431
|
+
/** Properties of client's CPU to be used in track API. */
|
|
1432
|
+
cpu?: ClientContextCpu;
|
|
1433
|
+
/** Properties of client's device to be used in track API. */
|
|
1434
|
+
device?: ClientContextDevice;
|
|
1435
|
+
/** Properties of client's engine to be used in track API. */
|
|
1436
|
+
engine?: ClientContextEngine;
|
|
1437
|
+
/** IP address of the client. */
|
|
1438
|
+
ip?: string;
|
|
1439
|
+
/** The client's locale, example: en-US. */
|
|
1440
|
+
locale?: string;
|
|
1441
|
+
/** Properties of client's OS to be used in track API. */
|
|
1442
|
+
os?: ClientContextOs;
|
|
1443
|
+
/** Properties of client's page to be used in track API. */
|
|
1444
|
+
page?: ClientContextPage;
|
|
1445
|
+
/** The client's timezone, example: Asia/Kolkata. */
|
|
1446
|
+
timezone?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* User agent of the client, example: Mozilla/5.0 (Macintosh; Intel
|
|
1449
|
+
* Mac OS X.
|
|
1450
|
+
*/
|
|
1451
|
+
user_agent?: string;
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* client-context-browser
|
|
1455
|
+
* Properties of client's browser to be used in track API.
|
|
1456
|
+
*/
|
|
1457
|
+
export interface ClientContextBrowser {
|
|
1458
|
+
/** The browser's name, example: Chrome, Safari. */
|
|
1459
|
+
name?: string;
|
|
1460
|
+
/** The browser's version, example: 53.0.2785.143. */
|
|
1461
|
+
version?: string;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* client-context-cpu
|
|
1465
|
+
* Properties of client's CPU to be used in track API.
|
|
1466
|
+
*/
|
|
1467
|
+
export interface ClientContextCpu {
|
|
1468
|
+
/** CPU architecture, example: amd64. */
|
|
1469
|
+
architecture?: string;
|
|
1470
|
+
}
|
|
1471
|
+
/**
|
|
1472
|
+
* client-context-device
|
|
1473
|
+
* Properties of client's device to be used in track API.
|
|
1474
|
+
*/
|
|
1475
|
+
export interface ClientContextDevice {
|
|
1476
|
+
/** Device manufacturer, example: Apple. */
|
|
1477
|
+
manufacturer?: string;
|
|
1478
|
+
/** Device model, example: iphone 6s. */
|
|
1479
|
+
model?: string;
|
|
1480
|
+
/** Device type, example: mobile, tablet, desktop. */
|
|
1481
|
+
type?: string;
|
|
1482
|
+
}
|
|
1483
|
+
/**
|
|
1484
|
+
* client-context-engine
|
|
1485
|
+
* Properties of client's engine to be used in track API.
|
|
1486
|
+
*/
|
|
1487
|
+
export interface ClientContextEngine {
|
|
1488
|
+
/** The engine's name, example: Blink, WebKit. */
|
|
1489
|
+
name?: string;
|
|
1490
|
+
/** The engine's version, example: 537.36. */
|
|
1491
|
+
version?: string;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* client-context-os
|
|
1495
|
+
* Properties of client's OS to be used in track API.
|
|
1496
|
+
*/
|
|
1497
|
+
export interface ClientContextOs {
|
|
1498
|
+
/** The OS's name, example : Windows, Mac OS X. */
|
|
1499
|
+
name?: string;
|
|
1500
|
+
/** The OS's version, example : 10.11.1. */
|
|
1501
|
+
version?: string;
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* client-context-page
|
|
1505
|
+
* Properties of client's page to be used in track API.
|
|
1506
|
+
*/
|
|
1507
|
+
export interface ClientContextPage {
|
|
1508
|
+
/** Page domain, example: devrev.ai */
|
|
1509
|
+
domain?: string;
|
|
1510
|
+
/** Page path, example: /pricing */
|
|
1511
|
+
path?: string;
|
|
1512
|
+
/** Page referrer, example: https://devrev.ai */
|
|
1513
|
+
referrer?: string;
|
|
1514
|
+
/** Page title, example: Pricing */
|
|
1515
|
+
title?: string;
|
|
1516
|
+
/** Page URL, example: https://devrev.ai/pricing */
|
|
1517
|
+
url?: string;
|
|
1518
|
+
}
|
|
1308
1519
|
/** code-change */
|
|
1309
1520
|
export type CodeChange = AtomBase & {
|
|
1310
1521
|
/** Name of the code branch in the repo. */
|
|
@@ -1413,6 +1624,7 @@ export type Conversation = AtomBase & {
|
|
|
1413
1624
|
metadata?: ConversationMetadata;
|
|
1414
1625
|
/** Owner IDs for the conversation. */
|
|
1415
1626
|
owned_by?: UserSummary[];
|
|
1627
|
+
sla_tracker?: SlaTrackerSummary;
|
|
1416
1628
|
/** Describes the current stage of a work item. */
|
|
1417
1629
|
stage?: LegacyStage;
|
|
1418
1630
|
/** Tags associated with the object. */
|
|
@@ -1431,6 +1643,10 @@ export interface ConversationMetadata {
|
|
|
1431
1643
|
*/
|
|
1432
1644
|
url_context?: string;
|
|
1433
1645
|
}
|
|
1646
|
+
/** conversation-search-summary */
|
|
1647
|
+
export type ConversationSearchSummary = SearchSummaryBase & {
|
|
1648
|
+
conversation: ConversationSummary;
|
|
1649
|
+
};
|
|
1434
1650
|
/** conversation-summary */
|
|
1435
1651
|
export type ConversationSummary = AtomBaseSummary & {
|
|
1436
1652
|
/** Title of the conversation object. */
|
|
@@ -1710,6 +1926,72 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
1710
1926
|
export interface ConversationsUpdateResponse {
|
|
1711
1927
|
conversation: Conversation;
|
|
1712
1928
|
}
|
|
1929
|
+
/**
|
|
1930
|
+
* create-email-info
|
|
1931
|
+
* Information related to an email.
|
|
1932
|
+
*/
|
|
1933
|
+
export interface CreateEmailInfo {
|
|
1934
|
+
/** The address of the email address. */
|
|
1935
|
+
address: string;
|
|
1936
|
+
/** The name of the email address. */
|
|
1937
|
+
name?: string;
|
|
1938
|
+
/** The ID of the user associated with the email address. */
|
|
1939
|
+
user?: string;
|
|
1940
|
+
}
|
|
1941
|
+
/**
|
|
1942
|
+
* create-email-inline-attachment
|
|
1943
|
+
* An inline attachment.
|
|
1944
|
+
*/
|
|
1945
|
+
export interface CreateEmailInlineAttachment {
|
|
1946
|
+
/**
|
|
1947
|
+
* The artifact of the attachment.
|
|
1948
|
+
* @example "ARTIFACT-12345"
|
|
1949
|
+
*/
|
|
1950
|
+
artifact?: string;
|
|
1951
|
+
/** The content id of the attachment. */
|
|
1952
|
+
content_id?: string;
|
|
1953
|
+
}
|
|
1954
|
+
/**
|
|
1955
|
+
* create-email-preview-widget
|
|
1956
|
+
* An email preview widget.
|
|
1957
|
+
*/
|
|
1958
|
+
export interface CreateEmailPreviewWidget {
|
|
1959
|
+
/** The list of bcc addresses. */
|
|
1960
|
+
bcc?: CreateEmailInfo[];
|
|
1961
|
+
/** The list of cc addresses. */
|
|
1962
|
+
cc?: CreateEmailInfo[];
|
|
1963
|
+
/** The list of from addresses. */
|
|
1964
|
+
from?: CreateEmailInfo[];
|
|
1965
|
+
/** The html body of the email. */
|
|
1966
|
+
html_body?: string;
|
|
1967
|
+
/** The in reply to of the email. */
|
|
1968
|
+
in_reply_to?: string;
|
|
1969
|
+
/** The list of inline attachments. */
|
|
1970
|
+
inlines?: CreateEmailInlineAttachment[];
|
|
1971
|
+
/** The message id of the email. */
|
|
1972
|
+
message_id?: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* The raw email artifact.
|
|
1975
|
+
* @example "ARTIFACT-12345"
|
|
1976
|
+
*/
|
|
1977
|
+
raw_email_artifact?: string;
|
|
1978
|
+
/** The list of references in the email. */
|
|
1979
|
+
references?: string[];
|
|
1980
|
+
/** The list of reply to addresses. */
|
|
1981
|
+
reply_to?: CreateEmailInfo[];
|
|
1982
|
+
/**
|
|
1983
|
+
* The time the email was sent.
|
|
1984
|
+
* @format date-time
|
|
1985
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1986
|
+
*/
|
|
1987
|
+
sent_timestamp?: string;
|
|
1988
|
+
/** The subject of the email. */
|
|
1989
|
+
subject?: string;
|
|
1990
|
+
/** The text body of the email. */
|
|
1991
|
+
text_body?: string;
|
|
1992
|
+
/** The list of to addresses. */
|
|
1993
|
+
to?: CreateEmailInfo[];
|
|
1994
|
+
}
|
|
1713
1995
|
/** create-org-schedule-interval */
|
|
1714
1996
|
export interface CreateOrgScheduleInterval {
|
|
1715
1997
|
/**
|
|
@@ -1752,6 +2034,11 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
1752
2034
|
*/
|
|
1753
2035
|
to: number;
|
|
1754
2036
|
}
|
|
2037
|
+
/**
|
|
2038
|
+
* curated-vista-summary
|
|
2039
|
+
* Static collection of Devrev objects.
|
|
2040
|
+
*/
|
|
2041
|
+
export type CuratedVistaSummary = VistaBaseSummary;
|
|
1755
2042
|
/** custom-schema-fragment */
|
|
1756
2043
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
1757
2044
|
type: CustomSchemaFragmentType;
|
|
@@ -1813,8 +2100,8 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1813
2100
|
/** The list of app names. */
|
|
1814
2101
|
app?: string[];
|
|
1815
2102
|
/**
|
|
1816
|
-
* The cursor to resume iteration from
|
|
1817
|
-
*
|
|
2103
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2104
|
+
* iteration starts from the beginning.
|
|
1818
2105
|
*/
|
|
1819
2106
|
cursor?: string;
|
|
1820
2107
|
/** Whether only deprecated fragments should be filtered. */
|
|
@@ -1826,6 +2113,19 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1826
2113
|
* @format int32
|
|
1827
2114
|
*/
|
|
1828
2115
|
limit?: number;
|
|
2116
|
+
/**
|
|
2117
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2118
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2119
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2120
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2121
|
+
* always be returned in the specified sort-by order.
|
|
2122
|
+
*/
|
|
2123
|
+
mode?: ListMode;
|
|
2124
|
+
/**
|
|
2125
|
+
* List of fields which are not required in the payload and can be
|
|
2126
|
+
* pruned away.
|
|
2127
|
+
*/
|
|
2128
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
1829
2129
|
/** The list of fields to sort the items by and how to sort them. */
|
|
1830
2130
|
sort_by?: string[];
|
|
1831
2131
|
/** The list of subtypes. */
|
|
@@ -1833,13 +2133,21 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
1833
2133
|
/** Filters for custom schema fragment of the provided types. */
|
|
1834
2134
|
types?: CustomSchemaFragmentType[];
|
|
1835
2135
|
}
|
|
2136
|
+
export declare enum CustomSchemaFragmentsListRequestPrune {
|
|
2137
|
+
Fields = "fields"
|
|
2138
|
+
}
|
|
1836
2139
|
/** custom-schema-fragments-list-response */
|
|
1837
2140
|
export interface CustomSchemaFragmentsListResponse {
|
|
1838
2141
|
/**
|
|
1839
|
-
* The cursor to
|
|
1840
|
-
* then
|
|
2142
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2143
|
+
* sort order. If not set, then no later elements exist.
|
|
1841
2144
|
*/
|
|
1842
|
-
|
|
2145
|
+
next_cursor?: string;
|
|
2146
|
+
/**
|
|
2147
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2148
|
+
* sort order. If not set, then no prior elements exist.
|
|
2149
|
+
*/
|
|
2150
|
+
prev_cursor?: string;
|
|
1843
2151
|
/** The custom schema fragments. */
|
|
1844
2152
|
result: CustomSchemaFragment[];
|
|
1845
2153
|
}
|
|
@@ -1855,6 +2163,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
1855
2163
|
description: string;
|
|
1856
2164
|
/** List of all fields in this fragment. */
|
|
1857
2165
|
fields?: SchemaFieldDescriptor[];
|
|
2166
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
2167
|
+
is_custom_leaf_type?: boolean;
|
|
1858
2168
|
/** The leaf type this fragment applies to. */
|
|
1859
2169
|
leaf_type: string;
|
|
1860
2170
|
type: CustomSchemaFragmentsSetRequestType;
|
|
@@ -1873,6 +2183,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1873
2183
|
path?: CustomTypePathComponent[];
|
|
1874
2184
|
/** The ID of the associated custom stage diagram. */
|
|
1875
2185
|
stage_diagram?: string;
|
|
2186
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
2187
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
1876
2188
|
/** The string used to populate the subtype in the leaf type. */
|
|
1877
2189
|
subtype: string;
|
|
1878
2190
|
/** The display name of the subtype. */
|
|
@@ -1880,6 +2192,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1880
2192
|
}
|
|
1881
2193
|
/** custom-schema-fragments-set-request-tenant-fragment */
|
|
1882
2194
|
export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
2195
|
+
/** The display ID prefix for the custom object. */
|
|
2196
|
+
id_prefix?: string;
|
|
1883
2197
|
/** List of Per-DevOrg stock field overrides. */
|
|
1884
2198
|
stock_field_overrides?: StockFieldOverride[];
|
|
1885
2199
|
}
|
|
@@ -1893,6 +2207,179 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
1893
2207
|
/** The ID of the custom schema fragment. */
|
|
1894
2208
|
id: string;
|
|
1895
2209
|
}
|
|
2210
|
+
/**
|
|
2211
|
+
* custom-schema-spec
|
|
2212
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2213
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2214
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2215
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2216
|
+
* specifier, it remains unmodified.
|
|
2217
|
+
*/
|
|
2218
|
+
export interface CustomSchemaSpec {
|
|
2219
|
+
/** List of apps that are requested. */
|
|
2220
|
+
apps?: string[];
|
|
2221
|
+
/** Name of the subtype requested. */
|
|
2222
|
+
subtype?: string;
|
|
2223
|
+
/** Whether the tenant schema is requested. */
|
|
2224
|
+
tenant_fragment?: boolean;
|
|
2225
|
+
/** Whether to enforce required fields validation. */
|
|
2226
|
+
validate_required_fields?: boolean;
|
|
2227
|
+
}
|
|
2228
|
+
/** custom-stage */
|
|
2229
|
+
export type CustomStage = AtomBase;
|
|
2230
|
+
/** custom-stages-create-request */
|
|
2231
|
+
export interface CustomStagesCreateRequest {
|
|
2232
|
+
/**
|
|
2233
|
+
* A reference to the marketplace item from which this stage was
|
|
2234
|
+
* imported.
|
|
2235
|
+
*/
|
|
2236
|
+
marketplace_ref?: string;
|
|
2237
|
+
/** The name of the custom stage. */
|
|
2238
|
+
name: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* The ordinal of the custom stage used for ordering.
|
|
2241
|
+
* @format int32
|
|
2242
|
+
*/
|
|
2243
|
+
ordinal: number;
|
|
2244
|
+
/** The state ID. */
|
|
2245
|
+
state: string;
|
|
2246
|
+
}
|
|
2247
|
+
/** custom-stages-create-response */
|
|
2248
|
+
export interface CustomStagesCreateResponse {
|
|
2249
|
+
custom_stage: CustomStage;
|
|
2250
|
+
}
|
|
2251
|
+
/** custom-stages-get-request */
|
|
2252
|
+
export interface CustomStagesGetRequest {
|
|
2253
|
+
/** The ID of the custom stage to get. */
|
|
2254
|
+
id: string;
|
|
2255
|
+
}
|
|
2256
|
+
/** custom-stages-get-response */
|
|
2257
|
+
export interface CustomStagesGetResponse {
|
|
2258
|
+
custom_stage: CustomStage;
|
|
2259
|
+
}
|
|
2260
|
+
/** custom-stages-list-request */
|
|
2261
|
+
export interface CustomStagesListRequest {
|
|
2262
|
+
/**
|
|
2263
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2264
|
+
* then iteration starts from the beginning.
|
|
2265
|
+
*/
|
|
2266
|
+
cursor?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* The maximum number of items.
|
|
2269
|
+
* @format int32
|
|
2270
|
+
*/
|
|
2271
|
+
limit?: number;
|
|
2272
|
+
/** The list of stage names. */
|
|
2273
|
+
name?: string[];
|
|
2274
|
+
/** The list of stage ordinals. */
|
|
2275
|
+
ordinal?: number[];
|
|
2276
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2277
|
+
sort_by?: string[];
|
|
2278
|
+
}
|
|
2279
|
+
/** custom-stages-list-response */
|
|
2280
|
+
export interface CustomStagesListResponse {
|
|
2281
|
+
/**
|
|
2282
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2283
|
+
* then iteration starts from the beginning.
|
|
2284
|
+
*/
|
|
2285
|
+
cursor?: string;
|
|
2286
|
+
/** The custom stages. */
|
|
2287
|
+
result: CustomStage[];
|
|
2288
|
+
}
|
|
2289
|
+
/** custom-stages-update-request */
|
|
2290
|
+
export interface CustomStagesUpdateRequest {
|
|
2291
|
+
/** The ID of the custom stage to update. */
|
|
2292
|
+
id: string;
|
|
2293
|
+
/** The updated name of the custom stage. */
|
|
2294
|
+
name?: string;
|
|
2295
|
+
/**
|
|
2296
|
+
* The ordinal of the custom stage.
|
|
2297
|
+
* @format int32
|
|
2298
|
+
*/
|
|
2299
|
+
ordinal?: number;
|
|
2300
|
+
/** The state ID. */
|
|
2301
|
+
state_id?: string;
|
|
2302
|
+
}
|
|
2303
|
+
/** custom-stages-update-response */
|
|
2304
|
+
export interface CustomStagesUpdateResponse {
|
|
2305
|
+
custom_stage: CustomStage;
|
|
2306
|
+
}
|
|
2307
|
+
/** custom-state */
|
|
2308
|
+
export type CustomState = AtomBase;
|
|
2309
|
+
/** custom-states-create-request */
|
|
2310
|
+
export interface CustomStatesCreateRequest {
|
|
2311
|
+
/** Whether this is a final state. */
|
|
2312
|
+
is_final?: boolean;
|
|
2313
|
+
/** The name of the custom state. */
|
|
2314
|
+
name: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Ordinal of the custom state used to identify system states.
|
|
2317
|
+
* @format int32
|
|
2318
|
+
*/
|
|
2319
|
+
ordinal: number;
|
|
2320
|
+
}
|
|
2321
|
+
/** custom-states-create-response */
|
|
2322
|
+
export interface CustomStatesCreateResponse {
|
|
2323
|
+
custom_state: CustomState;
|
|
2324
|
+
}
|
|
2325
|
+
/** custom-states-get-request */
|
|
2326
|
+
export interface CustomStatesGetRequest {
|
|
2327
|
+
/** The ID of the custom state to get. */
|
|
2328
|
+
id: string;
|
|
2329
|
+
}
|
|
2330
|
+
/** custom-states-get-response */
|
|
2331
|
+
export interface CustomStatesGetResponse {
|
|
2332
|
+
custom_state: CustomState;
|
|
2333
|
+
}
|
|
2334
|
+
/** custom-states-list-request */
|
|
2335
|
+
export interface CustomStatesListRequest {
|
|
2336
|
+
/**
|
|
2337
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2338
|
+
* then iteration starts from the beginning.
|
|
2339
|
+
*/
|
|
2340
|
+
cursor?: string;
|
|
2341
|
+
/** Whether only final states should be filtered. */
|
|
2342
|
+
is_final?: boolean;
|
|
2343
|
+
/**
|
|
2344
|
+
* The maximum number of items.
|
|
2345
|
+
* @format int32
|
|
2346
|
+
*/
|
|
2347
|
+
limit?: number;
|
|
2348
|
+
/** The list of state names. */
|
|
2349
|
+
name?: string[];
|
|
2350
|
+
/** The list of state ordinals. */
|
|
2351
|
+
ordinal?: number[];
|
|
2352
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2353
|
+
sort_by?: string[];
|
|
2354
|
+
}
|
|
2355
|
+
/** custom-states-list-response */
|
|
2356
|
+
export interface CustomStatesListResponse {
|
|
2357
|
+
/**
|
|
2358
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2359
|
+
* then iteration starts from the beginning.
|
|
2360
|
+
*/
|
|
2361
|
+
cursor?: string;
|
|
2362
|
+
/** The custom states. */
|
|
2363
|
+
result: CustomState[];
|
|
2364
|
+
}
|
|
2365
|
+
/** custom-states-update-request */
|
|
2366
|
+
export interface CustomStatesUpdateRequest {
|
|
2367
|
+
/** The ID of the custom state to update. */
|
|
2368
|
+
id: string;
|
|
2369
|
+
/** Whether this is a final state. */
|
|
2370
|
+
is_final?: boolean;
|
|
2371
|
+
/** The name of the custom state. */
|
|
2372
|
+
name?: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* Ordinal of the custom state used to identify system states.
|
|
2375
|
+
* @format int32
|
|
2376
|
+
*/
|
|
2377
|
+
ordinal?: number;
|
|
2378
|
+
}
|
|
2379
|
+
/** custom-states-update-response */
|
|
2380
|
+
export interface CustomStatesUpdateResponse {
|
|
2381
|
+
custom_state: CustomState;
|
|
2382
|
+
}
|
|
1896
2383
|
/** custom-type-fragment */
|
|
1897
2384
|
export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
1898
2385
|
stage_diagram?: StageDiagramSummary;
|
|
@@ -1911,6 +2398,12 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
1911
2398
|
* Path component for rendering custom type lists in tree form.
|
|
1912
2399
|
*/
|
|
1913
2400
|
export type CustomTypePathComponent = object;
|
|
2401
|
+
/** dashboard-search-summary */
|
|
2402
|
+
export type DashboardSearchSummary = SearchSummaryBase & {
|
|
2403
|
+
dashboard: DashboardSummary;
|
|
2404
|
+
};
|
|
2405
|
+
/** dashboard-summary */
|
|
2406
|
+
export type DashboardSummary = AtomBaseSummary;
|
|
1914
2407
|
/**
|
|
1915
2408
|
* date-filter
|
|
1916
2409
|
* Provides ways to specify date ranges on objects.
|
|
@@ -2125,6 +2618,21 @@ export interface DevUserExternalIdentityFilter {
|
|
|
2125
2618
|
/** Issuer of the external identity of the user. */
|
|
2126
2619
|
issuer?: string;
|
|
2127
2620
|
}
|
|
2621
|
+
/** Job title of the Dev User. */
|
|
2622
|
+
export declare enum DevUserJobTitle {
|
|
2623
|
+
CustomerSuccessManager = "customer_success_manager",
|
|
2624
|
+
Cxo = "cxo",
|
|
2625
|
+
Designer = "designer",
|
|
2626
|
+
Developer = "developer",
|
|
2627
|
+
HeadOfSupport = "head_of_support",
|
|
2628
|
+
Operations = "operations",
|
|
2629
|
+
Others = "others",
|
|
2630
|
+
ProductManager = "product_manager",
|
|
2631
|
+
Qa = "qa",
|
|
2632
|
+
RevenueLeader = "revenue_leader",
|
|
2633
|
+
Support = "support",
|
|
2634
|
+
TechLead = "tech_lead"
|
|
2635
|
+
}
|
|
2128
2636
|
/** dev-user-summary */
|
|
2129
2637
|
export type DevUserSummary = UserBaseSummary;
|
|
2130
2638
|
/**
|
|
@@ -2204,6 +2712,41 @@ export type DevUsersSelfRequest = object;
|
|
|
2204
2712
|
export interface DevUsersSelfResponse {
|
|
2205
2713
|
dev_user: DevUser;
|
|
2206
2714
|
}
|
|
2715
|
+
/**
|
|
2716
|
+
* dev-users-self-update-request
|
|
2717
|
+
* A request to update the user's information for the authenticated Dev
|
|
2718
|
+
* user.
|
|
2719
|
+
*/
|
|
2720
|
+
export interface DevUsersSelfUpdateRequest {
|
|
2721
|
+
/** The updated display name of the Dev user. */
|
|
2722
|
+
display_name?: string;
|
|
2723
|
+
/** The updated full name of the Dev user. */
|
|
2724
|
+
full_name?: string;
|
|
2725
|
+
/** Job title of the Dev User. */
|
|
2726
|
+
job_title?: DevUserJobTitle;
|
|
2727
|
+
}
|
|
2728
|
+
/**
|
|
2729
|
+
* dev-users-update-request
|
|
2730
|
+
* A request to update the user's information corresponding to the
|
|
2731
|
+
* provided Dev user.
|
|
2732
|
+
*/
|
|
2733
|
+
export interface DevUsersUpdateRequest {
|
|
2734
|
+
/** The updated display name of the Dev user. */
|
|
2735
|
+
display_name?: string;
|
|
2736
|
+
/** The updated full name of the Dev user. */
|
|
2737
|
+
full_name?: string;
|
|
2738
|
+
/** The ID for the Dev user to be updated. */
|
|
2739
|
+
id: string;
|
|
2740
|
+
/** Job title of the Dev User. */
|
|
2741
|
+
job_title?: DevUserJobTitle;
|
|
2742
|
+
}
|
|
2743
|
+
/**
|
|
2744
|
+
* dev-users-update-response
|
|
2745
|
+
* The response to update a Dev user.
|
|
2746
|
+
*/
|
|
2747
|
+
export interface DevUsersUpdateResponse {
|
|
2748
|
+
dev_user: DevUser;
|
|
2749
|
+
}
|
|
2207
2750
|
/** directory-summary */
|
|
2208
2751
|
export type DirectorySummary = AtomBaseSummary;
|
|
2209
2752
|
/**
|
|
@@ -2211,6 +2754,60 @@ export type DirectorySummary = AtomBaseSummary;
|
|
|
2211
2754
|
* Information to define dynamic groups.
|
|
2212
2755
|
*/
|
|
2213
2756
|
export type DynamicGroupInfo = object;
|
|
2757
|
+
/**
|
|
2758
|
+
* dynamic-vista-summary
|
|
2759
|
+
* Dynamic collection of Devrev objects, all adhering to a specific
|
|
2760
|
+
* filter.
|
|
2761
|
+
*/
|
|
2762
|
+
export type DynamicVistaSummary = VistaBaseSummary;
|
|
2763
|
+
/** email-info */
|
|
2764
|
+
export interface EmailInfo {
|
|
2765
|
+
/** The email address. */
|
|
2766
|
+
address: string;
|
|
2767
|
+
/** The email recipient's name. */
|
|
2768
|
+
name?: string;
|
|
2769
|
+
user?: UserSummary;
|
|
2770
|
+
}
|
|
2771
|
+
/** email-inline-attachment */
|
|
2772
|
+
export interface EmailInlineAttachment {
|
|
2773
|
+
artifact?: ArtifactSummary;
|
|
2774
|
+
/** The content id of the attachment. */
|
|
2775
|
+
content_id?: string;
|
|
2776
|
+
}
|
|
2777
|
+
/** email-preview-widget */
|
|
2778
|
+
export type EmailPreviewWidget = SnapWidgetBase & {
|
|
2779
|
+
/** The list of bcc addresses. */
|
|
2780
|
+
bcc: EmailInfo[];
|
|
2781
|
+
/** The list of cc addresses. */
|
|
2782
|
+
cc: EmailInfo[];
|
|
2783
|
+
/** The list of from addresses. */
|
|
2784
|
+
from: EmailInfo[];
|
|
2785
|
+
/** The html body of the email. */
|
|
2786
|
+
html_body?: string;
|
|
2787
|
+
/** The in-reply-to header of the email. */
|
|
2788
|
+
in_reply_to?: string;
|
|
2789
|
+
/** The list of inline attachments. */
|
|
2790
|
+
inlines: EmailInlineAttachment[];
|
|
2791
|
+
/** The message id of the email. */
|
|
2792
|
+
message_id?: string;
|
|
2793
|
+
raw_email_artifact?: ArtifactSummary;
|
|
2794
|
+
/** The references header in the email. */
|
|
2795
|
+
references: string[];
|
|
2796
|
+
/** The list of reply to addresses. */
|
|
2797
|
+
reply_to: EmailInfo[];
|
|
2798
|
+
/**
|
|
2799
|
+
* The time the email was sent.
|
|
2800
|
+
* @format date-time
|
|
2801
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2802
|
+
*/
|
|
2803
|
+
sent_timestamp?: string;
|
|
2804
|
+
/** The subject of the email. */
|
|
2805
|
+
subject?: string;
|
|
2806
|
+
/** The text body of the email. */
|
|
2807
|
+
text_body?: string;
|
|
2808
|
+
/** The list of to addresses. */
|
|
2809
|
+
to: EmailInfo[];
|
|
2810
|
+
};
|
|
2214
2811
|
/** empty */
|
|
2215
2812
|
export type Empty = object;
|
|
2216
2813
|
/** engagement */
|
|
@@ -2273,9 +2870,10 @@ export interface EngagementsCreateRequest {
|
|
|
2273
2870
|
/**
|
|
2274
2871
|
* IDs of the users that were part of the engagement.
|
|
2275
2872
|
* @maxItems 50
|
|
2873
|
+
* @minItems 1
|
|
2276
2874
|
* @example ["DEVU-12345"]
|
|
2277
2875
|
*/
|
|
2278
|
-
members
|
|
2876
|
+
members: string[];
|
|
2279
2877
|
/**
|
|
2280
2878
|
* The parent object ID in which the engagement was created.
|
|
2281
2879
|
* Currently, only accounts and opportunities are supported.
|
|
@@ -2287,7 +2885,7 @@ export interface EngagementsCreateRequest {
|
|
|
2287
2885
|
* @format date-time
|
|
2288
2886
|
* @example "2023-01-01T12:00:00.000Z"
|
|
2289
2887
|
*/
|
|
2290
|
-
scheduled_date
|
|
2888
|
+
scheduled_date: string;
|
|
2291
2889
|
/** Tags associated with the engagement. */
|
|
2292
2890
|
tags?: SetTagWithValue[];
|
|
2293
2891
|
/** The title of the engagement. */
|
|
@@ -2439,7 +3037,7 @@ export interface Error {
|
|
|
2439
3037
|
type?: string;
|
|
2440
3038
|
}
|
|
2441
3039
|
/** error-bad-request */
|
|
2442
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
|
|
3040
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
2443
3041
|
type: ErrorBadRequestType;
|
|
2444
3042
|
};
|
|
2445
3043
|
/** error-bad-request-bad-request */
|
|
@@ -2465,6 +3063,8 @@ export interface ErrorBadRequestInvalidField {
|
|
|
2465
3063
|
}
|
|
2466
3064
|
/** error-bad-request-missing-dependency */
|
|
2467
3065
|
export interface ErrorBadRequestMissingDependency {
|
|
3066
|
+
/** The dependent fields. */
|
|
3067
|
+
dependencies?: ErrorBadRequestMissingDependencyDependency[];
|
|
2468
3068
|
/** The field on which the value depends. */
|
|
2469
3069
|
dependent_field_name?: string;
|
|
2470
3070
|
/** The value which needs to be set of the dependent field. */
|
|
@@ -2474,6 +3074,13 @@ export interface ErrorBadRequestMissingDependency {
|
|
|
2474
3074
|
/** The value that was received. */
|
|
2475
3075
|
provided_field_value?: string;
|
|
2476
3076
|
}
|
|
3077
|
+
/** error-bad-request-missing-dependency-dependency */
|
|
3078
|
+
export interface ErrorBadRequestMissingDependencyDependency {
|
|
3079
|
+
/** The dependent field name. */
|
|
3080
|
+
field_name: string;
|
|
3081
|
+
/** The dependent field value. */
|
|
3082
|
+
field_value: string;
|
|
3083
|
+
}
|
|
2477
3084
|
/** error-bad-request-missing-required-field */
|
|
2478
3085
|
export interface ErrorBadRequestMissingRequiredField {
|
|
2479
3086
|
/** The missing field's name. */
|
|
@@ -2499,10 +3106,28 @@ export declare enum ErrorBadRequestType {
|
|
|
2499
3106
|
MissingRequiredField = "missing_required_field",
|
|
2500
3107
|
ParseError = "parse_error",
|
|
2501
3108
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
3109
|
+
UnexpectedJsonType = "unexpected_json_type",
|
|
2502
3110
|
ValueNotPermitted = "value_not_permitted"
|
|
2503
3111
|
}
|
|
3112
|
+
/** error-bad-request-unexpected-json-type */
|
|
3113
|
+
export interface ErrorBadRequestUnexpectedJsonType {
|
|
3114
|
+
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
3115
|
+
expected: ErrorBadRequestUnexpectedJsonTypeType;
|
|
3116
|
+
/** The field name that's invalid. */
|
|
3117
|
+
field_name: string;
|
|
3118
|
+
}
|
|
3119
|
+
export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
3120
|
+
Array = "array",
|
|
3121
|
+
Bool = "bool",
|
|
3122
|
+
Null = "null",
|
|
3123
|
+
Number = "number",
|
|
3124
|
+
Object = "object",
|
|
3125
|
+
String = "string"
|
|
3126
|
+
}
|
|
2504
3127
|
/** error-bad-request-value-not-permitted */
|
|
2505
3128
|
export interface ErrorBadRequestValueNotPermitted {
|
|
3129
|
+
/** The allowed values for the field. */
|
|
3130
|
+
allowed_values?: string[];
|
|
2506
3131
|
/** The field whose value is not permitted. */
|
|
2507
3132
|
field_name: string;
|
|
2508
3133
|
/** The reason the value isn't permitted. */
|
|
@@ -2515,6 +3140,15 @@ export interface ErrorBase {
|
|
|
2515
3140
|
/** The message associated with the error. */
|
|
2516
3141
|
message?: string;
|
|
2517
3142
|
}
|
|
3143
|
+
/** error-conflict */
|
|
3144
|
+
export type ErrorConflict = ErrorBase & ErrorConflictConflict & {
|
|
3145
|
+
type: ErrorConflictType;
|
|
3146
|
+
};
|
|
3147
|
+
/** error-conflict-conflict */
|
|
3148
|
+
export type ErrorConflictConflict = object;
|
|
3149
|
+
export declare enum ErrorConflictType {
|
|
3150
|
+
Conflict = "conflict"
|
|
3151
|
+
}
|
|
2518
3152
|
/** error-forbidden */
|
|
2519
3153
|
export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
|
|
2520
3154
|
type: ErrorForbiddenType;
|
|
@@ -2774,6 +3408,19 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
2774
3408
|
*/
|
|
2775
3409
|
event_key?: string;
|
|
2776
3410
|
}
|
|
3411
|
+
/** event-survey-response-created */
|
|
3412
|
+
export interface EventSurveyResponseCreated {
|
|
3413
|
+
survey_response: SurveyResponse;
|
|
3414
|
+
}
|
|
3415
|
+
/** event-survey-response-deleted */
|
|
3416
|
+
export interface EventSurveyResponseDeleted {
|
|
3417
|
+
/** The ID of the survey response that was deleted. */
|
|
3418
|
+
id: string;
|
|
3419
|
+
}
|
|
3420
|
+
/** event-survey-response-updated */
|
|
3421
|
+
export interface EventSurveyResponseUpdated {
|
|
3422
|
+
survey_response: SurveyResponse;
|
|
3423
|
+
}
|
|
2777
3424
|
/** event-tag-created */
|
|
2778
3425
|
export interface EventTagCreated {
|
|
2779
3426
|
tag: Tag;
|
|
@@ -2951,6 +3598,10 @@ export interface GroupMembersRemoveRequest {
|
|
|
2951
3598
|
}
|
|
2952
3599
|
/** group-members-remove-response */
|
|
2953
3600
|
export type GroupMembersRemoveResponse = object;
|
|
3601
|
+
/** group-search-summary */
|
|
3602
|
+
export type GroupSearchSummary = SearchSummaryBase & {
|
|
3603
|
+
group: GroupSummary;
|
|
3604
|
+
};
|
|
2954
3605
|
/** group-summary */
|
|
2955
3606
|
export type GroupSummary = AtomBaseSummary & {
|
|
2956
3607
|
/** Name of the group. */
|
|
@@ -2961,6 +3612,20 @@ export declare enum GroupType {
|
|
|
2961
3612
|
Dynamic = "dynamic",
|
|
2962
3613
|
Static = "static"
|
|
2963
3614
|
}
|
|
3615
|
+
/** Denotes the use case of the grouped vista. */
|
|
3616
|
+
export declare enum GroupedVistaFlavor {
|
|
3617
|
+
Nnl = "nnl",
|
|
3618
|
+
SprintBoard = "sprint_board",
|
|
3619
|
+
SupportInbox = "support_inbox"
|
|
3620
|
+
}
|
|
3621
|
+
/**
|
|
3622
|
+
* grouped-vista-summary
|
|
3623
|
+
* Represents a group of multiple vistas as a single unit.
|
|
3624
|
+
*/
|
|
3625
|
+
export type GroupedVistaSummary = VistaBaseSummary & {
|
|
3626
|
+
/** Denotes the use case of the grouped vista. */
|
|
3627
|
+
flavor?: GroupedVistaFlavor;
|
|
3628
|
+
};
|
|
2964
3629
|
/**
|
|
2965
3630
|
* groups-create-request
|
|
2966
3631
|
* A request to create a new group.
|
|
@@ -3056,6 +3721,7 @@ export interface GroupsListResponse {
|
|
|
3056
3721
|
export interface GroupsUpdateRequest {
|
|
3057
3722
|
/** The updated group's description. */
|
|
3058
3723
|
description?: string;
|
|
3724
|
+
dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
|
|
3059
3725
|
/** The ID of the group to update. */
|
|
3060
3726
|
id: string;
|
|
3061
3727
|
/** The updated group's name. */
|
|
@@ -3063,6 +3729,11 @@ export interface GroupsUpdateRequest {
|
|
|
3063
3729
|
/** The updated group's owner. */
|
|
3064
3730
|
owner?: string;
|
|
3065
3731
|
}
|
|
3732
|
+
/** groups-update-request-dynamic-group-info */
|
|
3733
|
+
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
3734
|
+
/** Boolean expression. */
|
|
3735
|
+
membership_expression: BooleanExpression;
|
|
3736
|
+
}
|
|
3066
3737
|
/**
|
|
3067
3738
|
* groups-update-response
|
|
3068
3739
|
* The response to group update.
|
|
@@ -3076,6 +3747,12 @@ export type Issue = WorkBase & {
|
|
|
3076
3747
|
developed_with?: PartSummary[];
|
|
3077
3748
|
/** Priority of the work based upon impact and criticality. */
|
|
3078
3749
|
priority?: IssuePriority;
|
|
3750
|
+
/**
|
|
3751
|
+
* Target start date for the object.
|
|
3752
|
+
* @format date-time
|
|
3753
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3754
|
+
*/
|
|
3755
|
+
target_start_date?: string;
|
|
3079
3756
|
};
|
|
3080
3757
|
/** Priority of the work based upon impact and criticality. */
|
|
3081
3758
|
export declare enum IssuePriority {
|
|
@@ -3097,6 +3774,14 @@ export interface LegacyStage {
|
|
|
3097
3774
|
/** Current stage name of the work item. */
|
|
3098
3775
|
name: string;
|
|
3099
3776
|
}
|
|
3777
|
+
/**
|
|
3778
|
+
* legacy-stage-summary
|
|
3779
|
+
* Describes the current stage of a work item.
|
|
3780
|
+
*/
|
|
3781
|
+
export interface LegacyStageSummary {
|
|
3782
|
+
/** Current stage name of the work item. */
|
|
3783
|
+
name: string;
|
|
3784
|
+
}
|
|
3100
3785
|
/**
|
|
3101
3786
|
* lines-of-code
|
|
3102
3787
|
* Details of lines of code in this code change.
|
|
@@ -3147,24 +3832,48 @@ export declare enum LinkEndpointType {
|
|
|
3147
3832
|
}
|
|
3148
3833
|
/**
|
|
3149
3834
|
* link-rev-user-to-rev-org-request
|
|
3150
|
-
*
|
|
3835
|
+
* Request to link a Rev user to an existing Rev organization.
|
|
3151
3836
|
*/
|
|
3152
3837
|
export interface LinkRevUserToRevOrgRequest {
|
|
3838
|
+
/** The ID of the Rev user. */
|
|
3839
|
+
id?: string;
|
|
3840
|
+
/**
|
|
3841
|
+
* The ID of the Rev organization to link the Rev user to.
|
|
3842
|
+
* @example "REV-AbCdEfGh"
|
|
3843
|
+
*/
|
|
3844
|
+
rev_org?: string;
|
|
3153
3845
|
/**
|
|
3154
|
-
* The don of the rev org to link the rev user to.
|
|
3846
|
+
* The don of the rev org to link the rev user to. This is deprecated,
|
|
3847
|
+
* use rev_org instead.
|
|
3848
|
+
* @deprecated
|
|
3155
3849
|
* @example "REV-AbCdEfGh"
|
|
3156
3850
|
*/
|
|
3157
|
-
rev_org_don
|
|
3158
|
-
/**
|
|
3159
|
-
|
|
3851
|
+
rev_org_don?: string;
|
|
3852
|
+
/**
|
|
3853
|
+
* The don of the rev user to link. This is deprecated, use id
|
|
3854
|
+
* instead.
|
|
3855
|
+
* @deprecated
|
|
3856
|
+
*/
|
|
3857
|
+
user_don?: string;
|
|
3160
3858
|
}
|
|
3161
3859
|
/**
|
|
3162
3860
|
* link-rev-user-to-rev-org-response
|
|
3163
|
-
*
|
|
3861
|
+
* Response for linking a Rev user to an existing Rev organization.
|
|
3164
3862
|
*/
|
|
3165
3863
|
export interface LinkRevUserToRevOrgResponse {
|
|
3166
3864
|
rev_user: RevUser;
|
|
3167
3865
|
}
|
|
3866
|
+
/** link-search-summary */
|
|
3867
|
+
export type LinkSearchSummary = SearchSummaryBase & {
|
|
3868
|
+
link: LinkSummary;
|
|
3869
|
+
};
|
|
3870
|
+
/** link-summary */
|
|
3871
|
+
export type LinkSummary = AtomBaseSummary & {
|
|
3872
|
+
/** Type of link used to define the relationship. */
|
|
3873
|
+
link_type: LinkType;
|
|
3874
|
+
source: LinkEndpointSummary;
|
|
3875
|
+
target: LinkEndpointSummary;
|
|
3876
|
+
};
|
|
3168
3877
|
/** Type of link used to define the relationship. */
|
|
3169
3878
|
export declare enum LinkType {
|
|
3170
3879
|
DevelopedWith = "developed_with",
|
|
@@ -3361,7 +4070,10 @@ export interface MetricDataPointDimension {
|
|
|
3361
4070
|
value: string;
|
|
3362
4071
|
}
|
|
3363
4072
|
/** metric-definition */
|
|
3364
|
-
export type MetricDefinition = AtomBase
|
|
4073
|
+
export type MetricDefinition = AtomBase & {
|
|
4074
|
+
/** Human readable name of the metric. */
|
|
4075
|
+
name?: string;
|
|
4076
|
+
};
|
|
3365
4077
|
/** The list of item types on which the metric might be applied. */
|
|
3366
4078
|
export declare enum MetricDefinitionAppliesTo {
|
|
3367
4079
|
Conversation = "conversation",
|
|
@@ -3377,6 +4089,11 @@ export declare enum MetricDefinitionMetricType {
|
|
|
3377
4089
|
Time = "time",
|
|
3378
4090
|
Value = "value"
|
|
3379
4091
|
}
|
|
4092
|
+
/** metric-definition-summary */
|
|
4093
|
+
export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
4094
|
+
/** Human readable name of the metric. */
|
|
4095
|
+
name?: string;
|
|
4096
|
+
};
|
|
3380
4097
|
/** metric-definitions-list-request */
|
|
3381
4098
|
export interface MetricDefinitionsListRequest {
|
|
3382
4099
|
/** The type of objects the metric definition applies to. */
|
|
@@ -3386,6 +4103,11 @@ export interface MetricDefinitionsListRequest {
|
|
|
3386
4103
|
* iteration starts from the beginning.
|
|
3387
4104
|
*/
|
|
3388
4105
|
cursor?: string;
|
|
4106
|
+
/**
|
|
4107
|
+
* Whether to include custom metrics in the response. If not set, then
|
|
4108
|
+
* custom metrics are excluded.
|
|
4109
|
+
*/
|
|
4110
|
+
include_custom_metrics?: boolean;
|
|
3389
4111
|
/**
|
|
3390
4112
|
* The maximum number of records to return. The default is '50'.
|
|
3391
4113
|
* @format int32
|
|
@@ -3452,6 +4174,12 @@ export interface MetricsDataIngestRequest {
|
|
|
3452
4174
|
*/
|
|
3453
4175
|
metrics: MetricsData[];
|
|
3454
4176
|
}
|
|
4177
|
+
/** object-member-search-summary */
|
|
4178
|
+
export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
4179
|
+
object_member: ObjectMemberSummary;
|
|
4180
|
+
};
|
|
4181
|
+
/** object-member-summary */
|
|
4182
|
+
export type ObjectMemberSummary = AtomBaseSummary;
|
|
3455
4183
|
/** opportunity */
|
|
3456
4184
|
export type Opportunity = WorkBase;
|
|
3457
4185
|
/** Forecast category of the opportunity. */
|
|
@@ -3659,6 +4387,32 @@ export declare enum OrgScheduleStatus {
|
|
|
3659
4387
|
Draft = "draft",
|
|
3660
4388
|
Published = "published"
|
|
3661
4389
|
}
|
|
4390
|
+
/** org-schedule-summary */
|
|
4391
|
+
export type OrgScheduleSummary = AtomBaseSummary & {
|
|
4392
|
+
/** Human-readable name. */
|
|
4393
|
+
name?: string;
|
|
4394
|
+
/**
|
|
4395
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
4396
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
4397
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
4398
|
+
*/
|
|
4399
|
+
status: OrgScheduleStatus;
|
|
4400
|
+
/**
|
|
4401
|
+
* Timezone in which this is defined. Only organization schedules in
|
|
4402
|
+
* the same timezone can be directly combined.
|
|
4403
|
+
*/
|
|
4404
|
+
timezone?: string;
|
|
4405
|
+
/**
|
|
4406
|
+
* Derived field indicating when a valid organization schedule will
|
|
4407
|
+
* become invalid. If omitted, the schedule is already invalid. A
|
|
4408
|
+
* schedule is valid if it has a weekly schedule for all named periods
|
|
4409
|
+
* for all its schedule fragments, and if it has a schedule fragment
|
|
4410
|
+
* for the time period in question.
|
|
4411
|
+
* @format date-time
|
|
4412
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4413
|
+
*/
|
|
4414
|
+
valid_until?: string;
|
|
4415
|
+
};
|
|
3662
4416
|
/** org-schedules-create-request */
|
|
3663
4417
|
export interface OrgSchedulesCreateRequest {
|
|
3664
4418
|
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
@@ -3799,6 +4553,10 @@ export interface OrgSchedulesUpdateRequest {
|
|
|
3799
4553
|
export interface OrgSchedulesUpdateResponse {
|
|
3800
4554
|
org_schedule: OrgSchedule;
|
|
3801
4555
|
}
|
|
4556
|
+
/** org-search-summary */
|
|
4557
|
+
export type OrgSearchSummary = SearchSummaryBase & {
|
|
4558
|
+
org: OrgSummary;
|
|
4559
|
+
};
|
|
3802
4560
|
/** org-summary */
|
|
3803
4561
|
export type OrgSummary = (AccountSummary | RevOrgSummary) & {
|
|
3804
4562
|
type: OrgType;
|
|
@@ -3851,6 +4609,8 @@ export type PartBase = AtomBase & {
|
|
|
3851
4609
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
3852
4610
|
*/
|
|
3853
4611
|
stock_schema_fragment?: string;
|
|
4612
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
4613
|
+
subtype?: string;
|
|
3854
4614
|
/** Tags associated with the object. */
|
|
3855
4615
|
tags?: TagWithValue[];
|
|
3856
4616
|
};
|
|
@@ -3859,6 +4619,10 @@ export type PartBaseSummary = AtomBaseSummary & {
|
|
|
3859
4619
|
/** Name of the part. */
|
|
3860
4620
|
name: string;
|
|
3861
4621
|
};
|
|
4622
|
+
/** part-search-summary */
|
|
4623
|
+
export type PartSearchSummary = SearchSummaryBase & {
|
|
4624
|
+
part: PartSummary;
|
|
4625
|
+
};
|
|
3862
4626
|
/** part-summary */
|
|
3863
4627
|
export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
|
|
3864
4628
|
type: PartType;
|
|
@@ -4083,6 +4847,287 @@ export interface PartsUpdateResponse {
|
|
|
4083
4847
|
export type Product = PartBase;
|
|
4084
4848
|
/** product-summary */
|
|
4085
4849
|
export type ProductSummary = PartBaseSummary;
|
|
4850
|
+
/** question-answer */
|
|
4851
|
+
export type QuestionAnswer = AtomBase & {
|
|
4852
|
+
/** The Answer. */
|
|
4853
|
+
answer?: string;
|
|
4854
|
+
/** The Question. */
|
|
4855
|
+
question?: string;
|
|
4856
|
+
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
4857
|
+
suggested_answer?: string;
|
|
4858
|
+
/**
|
|
4859
|
+
* Whether the Q/A was marked for deletion by the Q/A generation
|
|
4860
|
+
* algorithm.
|
|
4861
|
+
*/
|
|
4862
|
+
suggested_for_deletion?: boolean;
|
|
4863
|
+
/** The topic to which the QA belongs. */
|
|
4864
|
+
topic?: string;
|
|
4865
|
+
/** Whether the Q/A was verified. */
|
|
4866
|
+
verified?: boolean;
|
|
4867
|
+
};
|
|
4868
|
+
/** question-answer-search-summary */
|
|
4869
|
+
export type QuestionAnswerSearchSummary = SearchSummaryBase & {
|
|
4870
|
+
question_answer: QuestionAnswerSummary;
|
|
4871
|
+
};
|
|
4872
|
+
/** Status of the question answer. */
|
|
4873
|
+
export declare enum QuestionAnswerStatus {
|
|
4874
|
+
Archived = "archived",
|
|
4875
|
+
Draft = "draft",
|
|
4876
|
+
Published = "published",
|
|
4877
|
+
ReviewNeeded = "review_needed"
|
|
4878
|
+
}
|
|
4879
|
+
/** question-answer-summary */
|
|
4880
|
+
export type QuestionAnswerSummary = AtomBaseSummary & {
|
|
4881
|
+
/** The Question. */
|
|
4882
|
+
question?: string;
|
|
4883
|
+
};
|
|
4884
|
+
/**
|
|
4885
|
+
* question-answers-create-request
|
|
4886
|
+
* The request to create a question-answer.
|
|
4887
|
+
*/
|
|
4888
|
+
export interface QuestionAnswersCreateRequest {
|
|
4889
|
+
access_level?: AccessLevel;
|
|
4890
|
+
/** Answer of the question-answer. */
|
|
4891
|
+
answer: string;
|
|
4892
|
+
/**
|
|
4893
|
+
* The articles that the question-answer applies to.
|
|
4894
|
+
* @example ["ARTICLE-12345"]
|
|
4895
|
+
*/
|
|
4896
|
+
applies_to_articles?: string[];
|
|
4897
|
+
/**
|
|
4898
|
+
* The parts that the question-answer applies to.
|
|
4899
|
+
* @minItems 1
|
|
4900
|
+
* @example ["PROD-12345"]
|
|
4901
|
+
*/
|
|
4902
|
+
applies_to_parts: string[];
|
|
4903
|
+
/**
|
|
4904
|
+
* The users that own the question-answer.
|
|
4905
|
+
* @example ["DEVU-12345"]
|
|
4906
|
+
*/
|
|
4907
|
+
owned_by: string[];
|
|
4908
|
+
/** Question of the question-answer. */
|
|
4909
|
+
question: string;
|
|
4910
|
+
/** Information about the role the member receives due to the share. */
|
|
4911
|
+
shared_with?: SetSharedWithMembership[];
|
|
4912
|
+
/**
|
|
4913
|
+
* The source of the question-answer.
|
|
4914
|
+
* @example ["ARTICLE-12345"]
|
|
4915
|
+
*/
|
|
4916
|
+
sources?: string[];
|
|
4917
|
+
/** Status of the question answer. */
|
|
4918
|
+
status: QuestionAnswerStatus;
|
|
4919
|
+
/**
|
|
4920
|
+
* Alternative answer for the question-answer sugested by Q/A
|
|
4921
|
+
* Discovery.
|
|
4922
|
+
*/
|
|
4923
|
+
suggested_answer?: string;
|
|
4924
|
+
/**
|
|
4925
|
+
* Whether the question-answer was suggeste to be deleted by Q/A
|
|
4926
|
+
* Discovery.
|
|
4927
|
+
*/
|
|
4928
|
+
suggested_for_deletion?: boolean;
|
|
4929
|
+
/** Tags associated with the question-answer. */
|
|
4930
|
+
tags?: SetTagWithValue[];
|
|
4931
|
+
/** Topic of the question-answer. */
|
|
4932
|
+
topic?: string;
|
|
4933
|
+
/** Whether the question-answer was verified by a user or not. */
|
|
4934
|
+
verified?: boolean;
|
|
4935
|
+
}
|
|
4936
|
+
/**
|
|
4937
|
+
* question-answers-create-response
|
|
4938
|
+
* Create question-answer response.
|
|
4939
|
+
*/
|
|
4940
|
+
export interface QuestionAnswersCreateResponse {
|
|
4941
|
+
question_answer: QuestionAnswer;
|
|
4942
|
+
}
|
|
4943
|
+
/**
|
|
4944
|
+
* question-answers-delete-request
|
|
4945
|
+
* The request to delete a question-answer.
|
|
4946
|
+
*/
|
|
4947
|
+
export interface QuestionAnswersDeleteRequest {
|
|
4948
|
+
/** The ID of the question-answer. */
|
|
4949
|
+
id: string;
|
|
4950
|
+
/**
|
|
4951
|
+
* The ID of the question-answer.
|
|
4952
|
+
* @deprecated
|
|
4953
|
+
*/
|
|
4954
|
+
question_answer_id?: string;
|
|
4955
|
+
}
|
|
4956
|
+
/**
|
|
4957
|
+
* question-answers-get-request
|
|
4958
|
+
* The request to get a question-answer.
|
|
4959
|
+
*/
|
|
4960
|
+
export interface QuestionAnswersGetRequest {
|
|
4961
|
+
/** The ID of the required question-answer. */
|
|
4962
|
+
id: string;
|
|
4963
|
+
}
|
|
4964
|
+
/**
|
|
4965
|
+
* question-answers-get-response
|
|
4966
|
+
* Get question-answer response.
|
|
4967
|
+
*/
|
|
4968
|
+
export interface QuestionAnswersGetResponse {
|
|
4969
|
+
question_answer: QuestionAnswer;
|
|
4970
|
+
}
|
|
4971
|
+
/**
|
|
4972
|
+
* question-answers-list-request
|
|
4973
|
+
* The request to list question-answers.
|
|
4974
|
+
*/
|
|
4975
|
+
export interface QuestionAnswersListRequest {
|
|
4976
|
+
/**
|
|
4977
|
+
* Filters for question-answer belonging to any of the provided
|
|
4978
|
+
* articles.
|
|
4979
|
+
* @example ["ARTICLE-12345"]
|
|
4980
|
+
*/
|
|
4981
|
+
applies_to_articles?: string[];
|
|
4982
|
+
/**
|
|
4983
|
+
* Filters for question-answer belonging to any of the provided parts.
|
|
4984
|
+
* @example ["PROD-12345"]
|
|
4985
|
+
*/
|
|
4986
|
+
applies_to_parts?: string[];
|
|
4987
|
+
/**
|
|
4988
|
+
* Filters for question-answers created by any of the provided users.
|
|
4989
|
+
* @example ["DEVU-12345"]
|
|
4990
|
+
*/
|
|
4991
|
+
created_by?: string[];
|
|
4992
|
+
/**
|
|
4993
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4994
|
+
* iteration starts from the beginning.
|
|
4995
|
+
*/
|
|
4996
|
+
cursor?: string;
|
|
4997
|
+
/**
|
|
4998
|
+
* The maximum number of question-answers to return. The default is
|
|
4999
|
+
* '50'.
|
|
5000
|
+
* @format int32
|
|
5001
|
+
*/
|
|
5002
|
+
limit?: number;
|
|
5003
|
+
/**
|
|
5004
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
5005
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
5006
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
5007
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
5008
|
+
* always be returned in the specified sort-by order.
|
|
5009
|
+
*/
|
|
5010
|
+
mode?: ListMode;
|
|
5011
|
+
/**
|
|
5012
|
+
* Filters for question-answers owned by any of the provided users.
|
|
5013
|
+
* @example ["DEVU-12345"]
|
|
5014
|
+
*/
|
|
5015
|
+
owned_by?: string[];
|
|
5016
|
+
}
|
|
5017
|
+
/**
|
|
5018
|
+
* question-answers-list-response
|
|
5019
|
+
* List question-answers response.
|
|
5020
|
+
*/
|
|
5021
|
+
export interface QuestionAnswersListResponse {
|
|
5022
|
+
/**
|
|
5023
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
5024
|
+
* sort order. If not set, then no later elements exist.
|
|
5025
|
+
*/
|
|
5026
|
+
next_cursor?: string;
|
|
5027
|
+
/**
|
|
5028
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
5029
|
+
* sort order. If not set, then no prior elements exist.
|
|
5030
|
+
*/
|
|
5031
|
+
prev_cursor?: string;
|
|
5032
|
+
/** The question-answers entries matching the request. */
|
|
5033
|
+
question_answers: QuestionAnswer[];
|
|
5034
|
+
/**
|
|
5035
|
+
* Total number of question-answer items for the request.
|
|
5036
|
+
* @format int32
|
|
5037
|
+
*/
|
|
5038
|
+
total: number;
|
|
5039
|
+
}
|
|
5040
|
+
/**
|
|
5041
|
+
* question-answers-update-request
|
|
5042
|
+
* The request to update a question-answer.
|
|
5043
|
+
*/
|
|
5044
|
+
export interface QuestionAnswersUpdateRequest {
|
|
5045
|
+
access_level?: AccessLevel;
|
|
5046
|
+
/**
|
|
5047
|
+
* Updated answer of the question-answer object, or unchanged if not
|
|
5048
|
+
* provided.
|
|
5049
|
+
*/
|
|
5050
|
+
answer?: string;
|
|
5051
|
+
applies_to_articles?: QuestionAnswersUpdateRequestAppliesToArticles;
|
|
5052
|
+
applies_to_parts?: QuestionAnswersUpdateRequestAppliesToParts;
|
|
5053
|
+
/** The question-answer's ID. */
|
|
5054
|
+
id: string;
|
|
5055
|
+
owned_by?: QuestionAnswersUpdateRequestOwnedBy;
|
|
5056
|
+
/**
|
|
5057
|
+
* Updated question of the question-answer object, or unchanged if not
|
|
5058
|
+
* provided.
|
|
5059
|
+
*/
|
|
5060
|
+
question?: string;
|
|
5061
|
+
shared_with?: QuestionAnswersUpdateRequestSharedWith;
|
|
5062
|
+
sources?: QuestionAnswersUpdateRequestSources;
|
|
5063
|
+
/** Status of the question answer. */
|
|
5064
|
+
status?: QuestionAnswerStatus;
|
|
5065
|
+
/**
|
|
5066
|
+
* Updated suggested_answer of the question-answer object, or
|
|
5067
|
+
* unchanged if not provided.
|
|
5068
|
+
*/
|
|
5069
|
+
suggested_answer?: string;
|
|
5070
|
+
/**
|
|
5071
|
+
* Updated suggested_for_deletion of the question-answer object, or
|
|
5072
|
+
* unchanged if not provided.
|
|
5073
|
+
*/
|
|
5074
|
+
suggested_for_deletion?: boolean;
|
|
5075
|
+
tags?: QuestionAnswersUpdateRequestTags;
|
|
5076
|
+
/**
|
|
5077
|
+
* Updated topic of the question-answer object, or unchanged if not
|
|
5078
|
+
* provided.
|
|
5079
|
+
*/
|
|
5080
|
+
topic?: string;
|
|
5081
|
+
/** Updates whether the question-answer was verified by a user or not. */
|
|
5082
|
+
verified?: boolean;
|
|
5083
|
+
}
|
|
5084
|
+
/** question-answers-update-request-applies-to-articles */
|
|
5085
|
+
export interface QuestionAnswersUpdateRequestAppliesToArticles {
|
|
5086
|
+
/**
|
|
5087
|
+
* Updates the article that the question-answer applies to.
|
|
5088
|
+
* @example ["ARTICLE-12345"]
|
|
5089
|
+
*/
|
|
5090
|
+
set?: string[];
|
|
5091
|
+
}
|
|
5092
|
+
/** question-answers-update-request-applies-to-parts */
|
|
5093
|
+
export interface QuestionAnswersUpdateRequestAppliesToParts {
|
|
5094
|
+
/**
|
|
5095
|
+
* Updates the parts that the question-answer applies to.
|
|
5096
|
+
* @example ["PROD-12345"]
|
|
5097
|
+
*/
|
|
5098
|
+
set?: string[];
|
|
5099
|
+
}
|
|
5100
|
+
/** question-answers-update-request-owned-by */
|
|
5101
|
+
export interface QuestionAnswersUpdateRequestOwnedBy {
|
|
5102
|
+
/**
|
|
5103
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
5104
|
+
* empty.
|
|
5105
|
+
* @example ["DEVU-12345"]
|
|
5106
|
+
*/
|
|
5107
|
+
set?: string[];
|
|
5108
|
+
}
|
|
5109
|
+
/** question-answers-update-request-shared-with */
|
|
5110
|
+
export interface QuestionAnswersUpdateRequestSharedWith {
|
|
5111
|
+
/** Sets the field to the provided membership list. */
|
|
5112
|
+
set?: SetSharedWithMembership[];
|
|
5113
|
+
}
|
|
5114
|
+
/** question-answers-update-request-sources */
|
|
5115
|
+
export interface QuestionAnswersUpdateRequestSources {
|
|
5116
|
+
/**
|
|
5117
|
+
* Sets the sources that generated the question-answer.
|
|
5118
|
+
* @example ["ARTICLE-12345"]
|
|
5119
|
+
*/
|
|
5120
|
+
set?: string[];
|
|
5121
|
+
}
|
|
5122
|
+
/** question-answers-update-request-tags */
|
|
5123
|
+
export interface QuestionAnswersUpdateRequestTags {
|
|
5124
|
+
/** Sets the provided tags on the question-answer. */
|
|
5125
|
+
set?: SetTagWithValue[];
|
|
5126
|
+
}
|
|
5127
|
+
/** question-answers-update-response */
|
|
5128
|
+
export interface QuestionAnswersUpdateResponse {
|
|
5129
|
+
question_answer: QuestionAnswer;
|
|
5130
|
+
}
|
|
4086
5131
|
/**
|
|
4087
5132
|
* resource
|
|
4088
5133
|
* Resource details.
|
|
@@ -4093,6 +5138,16 @@ export interface Resource {
|
|
|
4093
5138
|
/** URL of the external article. */
|
|
4094
5139
|
url?: string;
|
|
4095
5140
|
}
|
|
5141
|
+
/**
|
|
5142
|
+
* resource-summary
|
|
5143
|
+
* Resource details.
|
|
5144
|
+
*/
|
|
5145
|
+
export interface ResourceSummary {
|
|
5146
|
+
/** Ids of the artifacts. */
|
|
5147
|
+
artifacts?: ArtifactSummary[];
|
|
5148
|
+
/** URL of the external article. */
|
|
5149
|
+
url?: string;
|
|
5150
|
+
}
|
|
4096
5151
|
/** rev-org */
|
|
4097
5152
|
export type RevOrg = OrgBase & {
|
|
4098
5153
|
account?: AccountSummary;
|
|
@@ -4121,6 +5176,8 @@ export type RevOrg = OrgBase & {
|
|
|
4121
5176
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4122
5177
|
*/
|
|
4123
5178
|
stock_schema_fragment?: string;
|
|
5179
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
5180
|
+
subtype?: string;
|
|
4124
5181
|
/** Tags associated with an object. */
|
|
4125
5182
|
tags?: TagWithValue[];
|
|
4126
5183
|
};
|
|
@@ -4241,6 +5298,8 @@ export interface RevOrgsListRequest {
|
|
|
4241
5298
|
custom_field_filter?: string[];
|
|
4242
5299
|
/** Filters for custom fields. */
|
|
4243
5300
|
custom_fields?: object;
|
|
5301
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
5302
|
+
display_name?: string[];
|
|
4244
5303
|
/** List of external refs to filter Rev organizations for. */
|
|
4245
5304
|
external_ref?: string[];
|
|
4246
5305
|
/**
|
|
@@ -4367,6 +5426,8 @@ export type RevUser = UserBase & {
|
|
|
4367
5426
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4368
5427
|
*/
|
|
4369
5428
|
stock_schema_fragment?: string;
|
|
5429
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
5430
|
+
subtype?: string;
|
|
4370
5431
|
/** Tags associated with the object. */
|
|
4371
5432
|
tags?: TagWithValue[];
|
|
4372
5433
|
};
|
|
@@ -4416,7 +5477,8 @@ export interface RevUsersCreateRequest {
|
|
|
4416
5477
|
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
4417
5478
|
phone_numbers?: string[];
|
|
4418
5479
|
/**
|
|
4419
|
-
* The ID of Rev organization
|
|
5480
|
+
* The ID of the Rev organization to which the created Rev user is
|
|
5481
|
+
* associated.
|
|
4420
5482
|
* @example "REV-AbCdEfGh"
|
|
4421
5483
|
*/
|
|
4422
5484
|
rev_org?: string;
|
|
@@ -4682,6 +5744,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
4682
5744
|
description?: string;
|
|
4683
5745
|
/** Whether this field is filterable, groupable and sortable. */
|
|
4684
5746
|
is_filterable?: boolean;
|
|
5747
|
+
/** Whether this field is immutable or not. */
|
|
5748
|
+
is_immutable?: boolean;
|
|
4685
5749
|
/**
|
|
4686
5750
|
* Whether this field can hold Personally Identifiable Information
|
|
4687
5751
|
* (PII).
|
|
@@ -4693,6 +5757,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
4693
5757
|
mfz?: SchemaFieldMfzMetadata;
|
|
4694
5758
|
/** Name of the field. */
|
|
4695
5759
|
name: string;
|
|
5760
|
+
/** The schema of oasis specific fields. */
|
|
5761
|
+
oasis?: SchemaFieldOasisMetadata;
|
|
4696
5762
|
/** Type this field is from. */
|
|
4697
5763
|
origin?: string;
|
|
4698
5764
|
/** The schema of ui specific fields. */
|
|
@@ -4743,6 +5809,11 @@ export interface SchemaFieldListViewUiMetadata {
|
|
|
4743
5809
|
* The schema of MFZ specific fields.
|
|
4744
5810
|
*/
|
|
4745
5811
|
export type SchemaFieldMfzMetadata = object;
|
|
5812
|
+
/**
|
|
5813
|
+
* schema-field-oasis-metadata
|
|
5814
|
+
* The schema of oasis specific fields.
|
|
5815
|
+
*/
|
|
5816
|
+
export type SchemaFieldOasisMetadata = object;
|
|
4746
5817
|
/**
|
|
4747
5818
|
* schema-field-summary-view-ui-metadata
|
|
4748
5819
|
* Summary view UI hint overrides.
|
|
@@ -5060,32 +6131,201 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
5060
6131
|
};
|
|
5061
6132
|
/** schema-unknown-field-descriptor */
|
|
5062
6133
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
5063
|
-
/** service-account */
|
|
5064
|
-
export type ServiceAccount = UserBase;
|
|
5065
|
-
/** service-account-summary */
|
|
5066
|
-
export type ServiceAccountSummary = UserBaseSummary;
|
|
5067
6134
|
/**
|
|
5068
|
-
*
|
|
5069
|
-
*
|
|
6135
|
+
* search-core-request
|
|
6136
|
+
* Search request.
|
|
5070
6137
|
*/
|
|
5071
|
-
export interface
|
|
5072
|
-
/**
|
|
5073
|
-
|
|
6138
|
+
export interface SearchCoreRequest {
|
|
6139
|
+
/**
|
|
6140
|
+
* The cursor from where to begin iteration. Start from beginning if
|
|
6141
|
+
* not provided.
|
|
6142
|
+
*/
|
|
6143
|
+
cursor?: string;
|
|
6144
|
+
/**
|
|
6145
|
+
* The maximum number of items to return in a page. The default is
|
|
6146
|
+
* '10'.
|
|
6147
|
+
* @format int32
|
|
6148
|
+
*/
|
|
6149
|
+
limit?: number;
|
|
6150
|
+
/** The namespaces to search in. */
|
|
6151
|
+
namespaces?: SearchNamespace[];
|
|
6152
|
+
/**
|
|
6153
|
+
* The query string. Search query language:
|
|
6154
|
+
* https://docs.devrev.ai/product/search#fields
|
|
6155
|
+
*/
|
|
6156
|
+
query: string;
|
|
6157
|
+
/** Search sort by parameters. */
|
|
6158
|
+
sort_by?: SearchSortByParam;
|
|
6159
|
+
/** Search sort order parameters. */
|
|
6160
|
+
sort_order?: SearchSortOrderParam;
|
|
5074
6161
|
}
|
|
5075
6162
|
/**
|
|
5076
|
-
*
|
|
5077
|
-
*
|
|
5078
|
-
* corresponding to the request.
|
|
6163
|
+
* search-core-response
|
|
6164
|
+
* Search response.
|
|
5079
6165
|
*/
|
|
5080
|
-
export interface
|
|
5081
|
-
|
|
6166
|
+
export interface SearchCoreResponse {
|
|
6167
|
+
/**
|
|
6168
|
+
* The cursor from where to begin iteration. Start from beginning if
|
|
6169
|
+
* not provided.
|
|
6170
|
+
*/
|
|
6171
|
+
cursor?: string;
|
|
6172
|
+
/** The search results. */
|
|
6173
|
+
results: SearchResult[];
|
|
5082
6174
|
}
|
|
5083
|
-
/**
|
|
5084
|
-
export
|
|
5085
|
-
|
|
5086
|
-
|
|
6175
|
+
/** The namespaces for hybrid search. */
|
|
6176
|
+
export declare enum SearchHybridNamespace {
|
|
6177
|
+
Article = "article",
|
|
6178
|
+
Conversation = "conversation",
|
|
6179
|
+
Issue = "issue",
|
|
6180
|
+
Part = "part",
|
|
6181
|
+
QuestionAnswer = "question_answer",
|
|
6182
|
+
Ticket = "ticket",
|
|
6183
|
+
Work = "work"
|
|
5087
6184
|
}
|
|
5088
|
-
/**
|
|
6185
|
+
/**
|
|
6186
|
+
* search-hybrid-request
|
|
6187
|
+
* Request for search with exact, prefix and infix matches.
|
|
6188
|
+
*/
|
|
6189
|
+
export interface SearchHybridRequest {
|
|
6190
|
+
/**
|
|
6191
|
+
* The maximum number of items to return in a page. The default is
|
|
6192
|
+
* '10'.
|
|
6193
|
+
* @format int32
|
|
6194
|
+
* @min 0
|
|
6195
|
+
* @max 50
|
|
6196
|
+
*/
|
|
6197
|
+
limit?: number;
|
|
6198
|
+
/** The namespaces for hybrid search. */
|
|
6199
|
+
namespace: SearchHybridNamespace;
|
|
6200
|
+
/**
|
|
6201
|
+
* The query string.
|
|
6202
|
+
* @minLength 1
|
|
6203
|
+
* @maxLength 400
|
|
6204
|
+
*/
|
|
6205
|
+
query: string;
|
|
6206
|
+
/**
|
|
6207
|
+
* The weightage for semantic search. Values between 0 and 1 are
|
|
6208
|
+
* accepted.
|
|
6209
|
+
* @format float
|
|
6210
|
+
* @min 0
|
|
6211
|
+
* @max 1
|
|
6212
|
+
*/
|
|
6213
|
+
semantic_weight?: number;
|
|
6214
|
+
}
|
|
6215
|
+
/**
|
|
6216
|
+
* search-hybrid-response
|
|
6217
|
+
* Hybrid search response.
|
|
6218
|
+
*/
|
|
6219
|
+
export interface SearchHybridResponse {
|
|
6220
|
+
/** The search results. */
|
|
6221
|
+
results: SearchResult[];
|
|
6222
|
+
}
|
|
6223
|
+
/** The namespaces to search in. */
|
|
6224
|
+
export declare enum SearchNamespace {
|
|
6225
|
+
Account = "account",
|
|
6226
|
+
Article = "article",
|
|
6227
|
+
Capability = "capability",
|
|
6228
|
+
Component = "component",
|
|
6229
|
+
Conversation = "conversation",
|
|
6230
|
+
CustomPart = "custom_part",
|
|
6231
|
+
CustomWork = "custom_work",
|
|
6232
|
+
Dashboard = "dashboard",
|
|
6233
|
+
DevUser = "dev_user",
|
|
6234
|
+
Enhancement = "enhancement",
|
|
6235
|
+
Feature = "feature",
|
|
6236
|
+
Group = "group",
|
|
6237
|
+
Issue = "issue",
|
|
6238
|
+
Linkable = "linkable",
|
|
6239
|
+
Microservice = "microservice",
|
|
6240
|
+
ObjectMember = "object_member",
|
|
6241
|
+
Opportunity = "opportunity",
|
|
6242
|
+
Product = "product",
|
|
6243
|
+
Project = "project",
|
|
6244
|
+
QuestionAnswer = "question_answer",
|
|
6245
|
+
RevOrg = "rev_org",
|
|
6246
|
+
RevUser = "rev_user",
|
|
6247
|
+
Runnable = "runnable",
|
|
6248
|
+
ServiceAccount = "service_account",
|
|
6249
|
+
SysUser = "sys_user",
|
|
6250
|
+
Tag = "tag",
|
|
6251
|
+
Task = "task",
|
|
6252
|
+
Ticket = "ticket",
|
|
6253
|
+
Vista = "vista"
|
|
6254
|
+
}
|
|
6255
|
+
/** search-result */
|
|
6256
|
+
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
6257
|
+
type: SearchResultType;
|
|
6258
|
+
};
|
|
6259
|
+
export declare enum SearchResultType {
|
|
6260
|
+
Account = "account",
|
|
6261
|
+
Article = "article",
|
|
6262
|
+
Artifact = "artifact",
|
|
6263
|
+
Conversation = "conversation",
|
|
6264
|
+
Dashboard = "dashboard",
|
|
6265
|
+
Group = "group",
|
|
6266
|
+
Link = "link",
|
|
6267
|
+
ObjectMember = "object_member",
|
|
6268
|
+
Org = "org",
|
|
6269
|
+
Part = "part",
|
|
6270
|
+
QuestionAnswer = "question_answer",
|
|
6271
|
+
Tag = "tag",
|
|
6272
|
+
User = "user",
|
|
6273
|
+
Vista = "vista",
|
|
6274
|
+
Work = "work"
|
|
6275
|
+
}
|
|
6276
|
+
/** Search sort by parameters. */
|
|
6277
|
+
export declare enum SearchSortByParam {
|
|
6278
|
+
CreatedDate = "created_date",
|
|
6279
|
+
ModifiedDate = "modified_date",
|
|
6280
|
+
Relevance = "relevance"
|
|
6281
|
+
}
|
|
6282
|
+
/** Search sort order parameters. */
|
|
6283
|
+
export declare enum SearchSortOrderParam {
|
|
6284
|
+
Asc = "asc",
|
|
6285
|
+
Desc = "desc"
|
|
6286
|
+
}
|
|
6287
|
+
/** search-summary-base */
|
|
6288
|
+
export interface SearchSummaryBase {
|
|
6289
|
+
/**
|
|
6290
|
+
* Timestamp when the object was last modified.
|
|
6291
|
+
* @format date-time
|
|
6292
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6293
|
+
*/
|
|
6294
|
+
modified_date?: string;
|
|
6295
|
+
/** Text snippet where the search hit occurred. */
|
|
6296
|
+
snippet?: string;
|
|
6297
|
+
}
|
|
6298
|
+
/** service-account */
|
|
6299
|
+
export type ServiceAccount = UserBase;
|
|
6300
|
+
/** service-account-summary */
|
|
6301
|
+
export type ServiceAccountSummary = UserBaseSummary;
|
|
6302
|
+
/**
|
|
6303
|
+
* service-accounts-get-request
|
|
6304
|
+
* The request object to get a service account's information.
|
|
6305
|
+
*/
|
|
6306
|
+
export interface ServiceAccountsGetRequest {
|
|
6307
|
+
/** The ID of the requested service account. */
|
|
6308
|
+
id: string;
|
|
6309
|
+
}
|
|
6310
|
+
/**
|
|
6311
|
+
* service-accounts-get-response
|
|
6312
|
+
* The response object that carries the service account's information
|
|
6313
|
+
* corresponding to the request.
|
|
6314
|
+
*/
|
|
6315
|
+
export interface ServiceAccountsGetResponse {
|
|
6316
|
+
service_account: ServiceAccount;
|
|
6317
|
+
}
|
|
6318
|
+
/** set-org-schedule-fragment-summary */
|
|
6319
|
+
export interface SetOrgScheduleFragmentSummary {
|
|
6320
|
+
/** Organization schedule fragment ID. */
|
|
6321
|
+
id: string;
|
|
6322
|
+
}
|
|
6323
|
+
/**
|
|
6324
|
+
* set-shared-with-membership
|
|
6325
|
+
* Information about the role the member receives due to the share.
|
|
6326
|
+
*/
|
|
6327
|
+
export type SetSharedWithMembership = object;
|
|
6328
|
+
/** set-sla-policy */
|
|
5089
6329
|
export interface SetSlaPolicy {
|
|
5090
6330
|
/** Metrics to apply to the selected items. */
|
|
5091
6331
|
metrics?: SetSupportMetricTarget[];
|
|
@@ -5176,11 +6416,6 @@ export interface SetWeeklyOrgSchedule {
|
|
|
5176
6416
|
*/
|
|
5177
6417
|
period_name: string;
|
|
5178
6418
|
}
|
|
5179
|
-
/**
|
|
5180
|
-
* shared-with-membership
|
|
5181
|
-
* Information about the role the member receives due to the share.
|
|
5182
|
-
*/
|
|
5183
|
-
export type SharedWithMembership = object;
|
|
5184
6419
|
/**
|
|
5185
6420
|
* shared-with-membership-filter
|
|
5186
6421
|
* Filter on target item based on intended audience.
|
|
@@ -5280,6 +6515,17 @@ export declare enum SlaStatus {
|
|
|
5280
6515
|
Draft = "draft",
|
|
5281
6516
|
Published = "published"
|
|
5282
6517
|
}
|
|
6518
|
+
/** sla-summary */
|
|
6519
|
+
export type SlaSummary = AtomBaseSummary & {
|
|
6520
|
+
/** Human-readable name. */
|
|
6521
|
+
name: string;
|
|
6522
|
+
/**
|
|
6523
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
6524
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
6525
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
6526
|
+
*/
|
|
6527
|
+
status: SlaStatus;
|
|
6528
|
+
};
|
|
5283
6529
|
/**
|
|
5284
6530
|
* sla-summary-filter
|
|
5285
6531
|
* The filter for SLA summary.
|
|
@@ -5302,7 +6548,37 @@ export declare enum SlaSummaryStage {
|
|
|
5302
6548
|
Warning = "warning"
|
|
5303
6549
|
}
|
|
5304
6550
|
/** sla-tracker */
|
|
5305
|
-
export type SlaTracker = AtomBase
|
|
6551
|
+
export type SlaTracker = AtomBase & {
|
|
6552
|
+
/** Details of the object on which the SLA is being tracked. */
|
|
6553
|
+
applies_to_id?: string;
|
|
6554
|
+
/** Summary of the metrics target being tracked in the SLA tracker. */
|
|
6555
|
+
metric_target_summaries: ArchetypeMetricTarget[];
|
|
6556
|
+
sla?: SlaSummary;
|
|
6557
|
+
/**
|
|
6558
|
+
* Details of the applicable SLA policy. Can be omitted if no sla
|
|
6559
|
+
* applies, or if no policy of the sla applies at the moment.
|
|
6560
|
+
*/
|
|
6561
|
+
sla_policy_id?: string;
|
|
6562
|
+
/** SLA stage of the object being tracked. */
|
|
6563
|
+
stage?: string;
|
|
6564
|
+
/**
|
|
6565
|
+
* It is an indicator of whether the SLA has ever been breached
|
|
6566
|
+
* (missed). If not, it shows whether the SLA is completed, in
|
|
6567
|
+
* progress, or nil - if no policy is applied.
|
|
6568
|
+
*/
|
|
6569
|
+
status?: string;
|
|
6570
|
+
};
|
|
6571
|
+
/** sla-tracker-summary */
|
|
6572
|
+
export type SlaTrackerSummary = AtomBaseSummary;
|
|
6573
|
+
/** sla-trackers-get-request */
|
|
6574
|
+
export interface SlaTrackersGetRequest {
|
|
6575
|
+
/** The ID of the SLA tracker to get. */
|
|
6576
|
+
id: string;
|
|
6577
|
+
}
|
|
6578
|
+
/** sla-trackers-get-response */
|
|
6579
|
+
export interface SlaTrackersGetResponse {
|
|
6580
|
+
sla_tracker: SlaTracker;
|
|
6581
|
+
}
|
|
5306
6582
|
/** slas-assign-request */
|
|
5307
6583
|
export interface SlasAssignRequest {
|
|
5308
6584
|
/**
|
|
@@ -5450,17 +6726,14 @@ export interface SnapInsResourcesRequest {
|
|
|
5450
6726
|
}
|
|
5451
6727
|
/** snap-ins-resources-response */
|
|
5452
6728
|
export interface SnapInsResourcesResponse {
|
|
5453
|
-
|
|
6729
|
+
/** The event sources for the snap-in. */
|
|
6730
|
+
event_sources?: Record<string, string>;
|
|
5454
6731
|
/** The inputs for the snap-in. */
|
|
5455
6732
|
inputs?: object;
|
|
5456
|
-
|
|
6733
|
+
/** Map of keyring names and its data. */
|
|
6734
|
+
keyrings?: Record<string, SnapInsResourcesResponseKeyringData>;
|
|
5457
6735
|
snap_in_version: SnapInVersionSummary;
|
|
5458
6736
|
}
|
|
5459
|
-
/** snap-ins-resources-response-event-sources-entry */
|
|
5460
|
-
export interface SnapInsResourcesResponseEventSourcesEntry {
|
|
5461
|
-
key: string;
|
|
5462
|
-
value: string;
|
|
5463
|
-
}
|
|
5464
6737
|
/** snap-ins-resources-response-keyring-data */
|
|
5465
6738
|
export interface SnapInsResourcesResponseKeyringData {
|
|
5466
6739
|
/** The ID of the keyring. */
|
|
@@ -5468,16 +6741,51 @@ export interface SnapInsResourcesResponseKeyringData {
|
|
|
5468
6741
|
/** The secret value of the keyring. This must be handled with caution. */
|
|
5469
6742
|
secret: string;
|
|
5470
6743
|
}
|
|
5471
|
-
/** snap-ins-resources-response-keyrings-entry */
|
|
5472
|
-
export interface SnapInsResourcesResponseKeyringsEntry {
|
|
5473
|
-
key: string;
|
|
5474
|
-
value: SnapInsResourcesResponseKeyringData;
|
|
5475
|
-
}
|
|
5476
6744
|
/** snap-widget */
|
|
5477
|
-
export
|
|
6745
|
+
export type SnapWidget = EmailPreviewWidget & {
|
|
5478
6746
|
type: SnapWidgetType;
|
|
6747
|
+
};
|
|
6748
|
+
/** snap-widget-base */
|
|
6749
|
+
export type SnapWidgetBase = AtomBase & {
|
|
6750
|
+
/** A human readable name for the snap widget. */
|
|
6751
|
+
name: string;
|
|
6752
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6753
|
+
namespace?: SnapWidgetNamespace;
|
|
6754
|
+
/** The status of the snap widget. */
|
|
6755
|
+
status: SnapWidgetStatus;
|
|
6756
|
+
};
|
|
6757
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6758
|
+
export declare enum SnapWidgetNamespace {
|
|
6759
|
+
CommentSuggestionReplies = "comment_suggestion_replies",
|
|
6760
|
+
EmailPreview = "email_preview",
|
|
6761
|
+
LinkPreview = "link_preview",
|
|
6762
|
+
PlugNudge = "plug_nudge"
|
|
6763
|
+
}
|
|
6764
|
+
/** The status of the snap widget. */
|
|
6765
|
+
export declare enum SnapWidgetStatus {
|
|
6766
|
+
Draft = "draft",
|
|
6767
|
+
Published = "published"
|
|
6768
|
+
}
|
|
6769
|
+
export declare enum SnapWidgetType {
|
|
6770
|
+
EmailPreview = "email_preview"
|
|
6771
|
+
}
|
|
6772
|
+
/** snap-widgets-create-request */
|
|
6773
|
+
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
6774
|
+
/** A human readable name for the snap widget. */
|
|
6775
|
+
name: string;
|
|
6776
|
+
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6777
|
+
namespace?: SnapWidgetNamespace;
|
|
6778
|
+
/** The status of the snap widget. */
|
|
6779
|
+
status?: SnapWidgetStatus;
|
|
6780
|
+
type: SnapWidgetsCreateRequestType;
|
|
6781
|
+
};
|
|
6782
|
+
export declare enum SnapWidgetsCreateRequestType {
|
|
6783
|
+
EmailPreview = "email_preview"
|
|
6784
|
+
}
|
|
6785
|
+
/** snap-widgets-create-response */
|
|
6786
|
+
export interface SnapWidgetsCreateResponse {
|
|
6787
|
+
snap_widget: SnapWidget;
|
|
5479
6788
|
}
|
|
5480
|
-
export type SnapWidgetType = string;
|
|
5481
6789
|
/** stage-diagram-summary */
|
|
5482
6790
|
export type StageDiagramSummary = AtomBaseSummary;
|
|
5483
6791
|
/**
|
|
@@ -5504,6 +6812,19 @@ export interface StageUpdate {
|
|
|
5504
6812
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
5505
6813
|
name?: string;
|
|
5506
6814
|
}
|
|
6815
|
+
/** Type of stage validation options when creating an object. */
|
|
6816
|
+
export declare enum StageValidationOptionForCreate {
|
|
6817
|
+
AllowNonStart = "allow_non_start"
|
|
6818
|
+
}
|
|
6819
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
6820
|
+
export declare enum StageValidationOptionForUpdate {
|
|
6821
|
+
AllowInvalidTransition = "allow_invalid_transition"
|
|
6822
|
+
}
|
|
6823
|
+
/** staged-info-filter */
|
|
6824
|
+
export interface StagedInfoFilter {
|
|
6825
|
+
/** Filters for issues that are staged. */
|
|
6826
|
+
is_staged?: boolean;
|
|
6827
|
+
}
|
|
5507
6828
|
/**
|
|
5508
6829
|
* stock-field-override
|
|
5509
6830
|
* A stock field override.
|
|
@@ -5536,10 +6857,11 @@ export interface StockSchemaFragmentsGetResponse {
|
|
|
5536
6857
|
/** stock-schema-fragments-list-request */
|
|
5537
6858
|
export interface StockSchemaFragmentsListRequest {
|
|
5538
6859
|
/**
|
|
5539
|
-
* The cursor to resume iteration from
|
|
5540
|
-
*
|
|
6860
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6861
|
+
* iteration starts from the beginning.
|
|
5541
6862
|
*/
|
|
5542
6863
|
cursor?: string;
|
|
6864
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
5543
6865
|
/** The list of leaf types. */
|
|
5544
6866
|
leaf_type?: string[];
|
|
5545
6867
|
/**
|
|
@@ -5547,16 +6869,42 @@ export interface StockSchemaFragmentsListRequest {
|
|
|
5547
6869
|
* @format int32
|
|
5548
6870
|
*/
|
|
5549
6871
|
limit?: number;
|
|
6872
|
+
/**
|
|
6873
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
6874
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
6875
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
6876
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
6877
|
+
* always be returned in the specified sort-by order.
|
|
6878
|
+
*/
|
|
6879
|
+
mode?: ListMode;
|
|
6880
|
+
/**
|
|
6881
|
+
* List of fields which are not required in the payload and can be
|
|
6882
|
+
* pruned away.
|
|
6883
|
+
*/
|
|
6884
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
5550
6885
|
/** The list of fields to sort the items by and how to sort them. */
|
|
5551
6886
|
sort_by?: string[];
|
|
5552
6887
|
}
|
|
6888
|
+
export declare enum StockSchemaFragmentsListRequestFilterPreset {
|
|
6889
|
+
CustomizableTypesPreset = "customizable_types_preset",
|
|
6890
|
+
NoPreset = "no_preset"
|
|
6891
|
+
}
|
|
6892
|
+
export declare enum StockSchemaFragmentsListRequestPrune {
|
|
6893
|
+
CompositeSchemas = "composite_schemas",
|
|
6894
|
+
Fields = "fields"
|
|
6895
|
+
}
|
|
5553
6896
|
/** stock-schema-fragments-list-response */
|
|
5554
6897
|
export interface StockSchemaFragmentsListResponse {
|
|
5555
6898
|
/**
|
|
5556
|
-
* The cursor to
|
|
5557
|
-
* then
|
|
6899
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
6900
|
+
* sort order. If not set, then no later elements exist.
|
|
5558
6901
|
*/
|
|
5559
|
-
|
|
6902
|
+
next_cursor?: string;
|
|
6903
|
+
/**
|
|
6904
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
6905
|
+
* sort order. If not set, then no prior elements exist.
|
|
6906
|
+
*/
|
|
6907
|
+
prev_cursor?: string;
|
|
5560
6908
|
/** The stock schema fragments. */
|
|
5561
6909
|
result: StockSchemaFragment[];
|
|
5562
6910
|
}
|
|
@@ -5586,11 +6934,239 @@ export interface SubtypesListResponse {
|
|
|
5586
6934
|
/** List of subtypes. */
|
|
5587
6935
|
subtypes: Subtype[];
|
|
5588
6936
|
}
|
|
6937
|
+
/** survey */
|
|
6938
|
+
export type Survey = AtomBase & {
|
|
6939
|
+
/** Description of the survey. */
|
|
6940
|
+
description?: string;
|
|
6941
|
+
/**
|
|
6942
|
+
* Survey name associated with schema. This name would be unique per
|
|
6943
|
+
* dev org.
|
|
6944
|
+
*/
|
|
6945
|
+
name?: string;
|
|
6946
|
+
/** List of all fields in the schema. */
|
|
6947
|
+
schema: SchemaFieldDescriptor[];
|
|
6948
|
+
};
|
|
5589
6949
|
/**
|
|
5590
6950
|
* survey-aggregation-filter
|
|
5591
6951
|
* The filter for survey aggregation.
|
|
5592
6952
|
*/
|
|
5593
6953
|
export type SurveyAggregationFilter = object;
|
|
6954
|
+
/** survey-response */
|
|
6955
|
+
export type SurveyResponse = AtomBase & {
|
|
6956
|
+
/** The unique ID associated with the dispatched survey. */
|
|
6957
|
+
dispatch_id?: string;
|
|
6958
|
+
/** The ID of the object for which survey is taken. */
|
|
6959
|
+
object?: string;
|
|
6960
|
+
/** Response for the survey. */
|
|
6961
|
+
response?: object;
|
|
6962
|
+
/** The ID of the survey for which response is taken. */
|
|
6963
|
+
survey?: string;
|
|
6964
|
+
};
|
|
6965
|
+
/** surveys-create-request */
|
|
6966
|
+
export interface SurveysCreateRequest {
|
|
6967
|
+
/** Description about the survey. */
|
|
6968
|
+
description?: string;
|
|
6969
|
+
/** The survey's name. */
|
|
6970
|
+
name: string;
|
|
6971
|
+
/** Schema for the survey. */
|
|
6972
|
+
schema: FieldDescriptor[];
|
|
6973
|
+
}
|
|
6974
|
+
/** surveys-create-response */
|
|
6975
|
+
export interface SurveysCreateResponse {
|
|
6976
|
+
survey: Survey;
|
|
6977
|
+
}
|
|
6978
|
+
/** surveys-delete-request */
|
|
6979
|
+
export interface SurveysDeleteRequest {
|
|
6980
|
+
/** ID of the survey being deleted. */
|
|
6981
|
+
id: string;
|
|
6982
|
+
}
|
|
6983
|
+
/** surveys-delete-response */
|
|
6984
|
+
export type SurveysDeleteResponse = object;
|
|
6985
|
+
/** surveys-list-request */
|
|
6986
|
+
export interface SurveysListRequest {
|
|
6987
|
+
/**
|
|
6988
|
+
* Filters for surveys created by any of these users.
|
|
6989
|
+
* @example ["DEVU-12345"]
|
|
6990
|
+
*/
|
|
6991
|
+
created_by?: string[];
|
|
6992
|
+
/** Provides ways to specify date ranges on objects. */
|
|
6993
|
+
created_date?: DateFilter;
|
|
6994
|
+
/**
|
|
6995
|
+
* The cursor to resume iteration from. If not provided, then
|
|
6996
|
+
* iteration starts from the beginning.
|
|
6997
|
+
*/
|
|
6998
|
+
cursor?: string;
|
|
6999
|
+
/**
|
|
7000
|
+
* The maximum number of surveys to return. If not set, then the
|
|
7001
|
+
* default is '50'.
|
|
7002
|
+
* @format int32
|
|
7003
|
+
*/
|
|
7004
|
+
limit?: number;
|
|
7005
|
+
/**
|
|
7006
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
7007
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
7008
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
7009
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
7010
|
+
* always be returned in the specified sort-by order.
|
|
7011
|
+
*/
|
|
7012
|
+
mode?: ListMode;
|
|
7013
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7014
|
+
modified_date?: DateFilter;
|
|
7015
|
+
/** Filters for surveys by name(s). */
|
|
7016
|
+
name?: string[];
|
|
7017
|
+
/** Fields to sort the surveys by and the direction to sort them. */
|
|
7018
|
+
sort_by?: string[];
|
|
7019
|
+
}
|
|
7020
|
+
/** surveys-list-response */
|
|
7021
|
+
export interface SurveysListResponse {
|
|
7022
|
+
/**
|
|
7023
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
7024
|
+
* sort order. If not set, then no later elements exist.
|
|
7025
|
+
*/
|
|
7026
|
+
next_cursor?: string;
|
|
7027
|
+
/**
|
|
7028
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
7029
|
+
* sort order. If not set, then no prior elements exist.
|
|
7030
|
+
*/
|
|
7031
|
+
prev_cursor?: string;
|
|
7032
|
+
/** The list of the surveys. */
|
|
7033
|
+
surveys: Survey[];
|
|
7034
|
+
}
|
|
7035
|
+
/** surveys-responses-list-request */
|
|
7036
|
+
export interface SurveysResponsesListRequest {
|
|
7037
|
+
/**
|
|
7038
|
+
* Filters for survey responses created by any of these users.
|
|
7039
|
+
* @example ["DEVU-12345"]
|
|
7040
|
+
*/
|
|
7041
|
+
created_by?: string[];
|
|
7042
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7043
|
+
created_date?: DateFilter;
|
|
7044
|
+
/**
|
|
7045
|
+
* The cursor to resume iteration from. If not provided, then
|
|
7046
|
+
* iteration starts from the beginning.
|
|
7047
|
+
*/
|
|
7048
|
+
cursor?: string;
|
|
7049
|
+
/**
|
|
7050
|
+
* The maximum number of survey responses to return. If not set, then
|
|
7051
|
+
* the default is '50'.
|
|
7052
|
+
* @format int32
|
|
7053
|
+
*/
|
|
7054
|
+
limit?: number;
|
|
7055
|
+
/**
|
|
7056
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
7057
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
7058
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
7059
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
7060
|
+
* always be returned in the specified sort-by order.
|
|
7061
|
+
*/
|
|
7062
|
+
mode?: ListMode;
|
|
7063
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7064
|
+
modified_date?: DateFilter;
|
|
7065
|
+
/**
|
|
7066
|
+
* Filters for survey responses created for the objects.
|
|
7067
|
+
* @example ["ACC-12345"]
|
|
7068
|
+
*/
|
|
7069
|
+
objects?: string[];
|
|
7070
|
+
/**
|
|
7071
|
+
* Fields to sort the survey responses by and the direction to sort
|
|
7072
|
+
* them.
|
|
7073
|
+
*/
|
|
7074
|
+
sort_by?: string[];
|
|
7075
|
+
/** Filters for survey responses for the provided survey IDs. */
|
|
7076
|
+
surveys?: string[];
|
|
7077
|
+
}
|
|
7078
|
+
/** surveys-responses-list-response */
|
|
7079
|
+
export interface SurveysResponsesListResponse {
|
|
7080
|
+
/**
|
|
7081
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
7082
|
+
* sort order. If not set, then no later elements exist.
|
|
7083
|
+
*/
|
|
7084
|
+
next_cursor?: string;
|
|
7085
|
+
/**
|
|
7086
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
7087
|
+
* sort order. If not set, then no prior elements exist.
|
|
7088
|
+
*/
|
|
7089
|
+
prev_cursor?: string;
|
|
7090
|
+
/** The list of the survey responses. */
|
|
7091
|
+
survey_responses: SurveyResponse[];
|
|
7092
|
+
}
|
|
7093
|
+
/** surveys-send-request */
|
|
7094
|
+
export interface SurveysSendRequest {
|
|
7095
|
+
email: SurveysSendRequestEmail;
|
|
7096
|
+
}
|
|
7097
|
+
/** surveys-send-request-email */
|
|
7098
|
+
export interface SurveysSendRequestEmail {
|
|
7099
|
+
/** Message body for a survey email. */
|
|
7100
|
+
body: string;
|
|
7101
|
+
/** Recipients list for a survey email. */
|
|
7102
|
+
recipients: string[];
|
|
7103
|
+
/** Sender email address from which an email is sent. */
|
|
7104
|
+
sender: string;
|
|
7105
|
+
/** Subject for an email where survey is sent. */
|
|
7106
|
+
subject: string;
|
|
7107
|
+
}
|
|
7108
|
+
/** surveys-send-response */
|
|
7109
|
+
export type SurveysSendResponse = object;
|
|
7110
|
+
/** surveys-submit-request */
|
|
7111
|
+
export interface SurveysSubmitRequest {
|
|
7112
|
+
/** The unique ID associated with the dispatched survey. */
|
|
7113
|
+
dispatch_id?: string;
|
|
7114
|
+
/**
|
|
7115
|
+
* The ID of the object this survey is on (e.g. ticket, conversation,
|
|
7116
|
+
* etc).
|
|
7117
|
+
* @example "ACC-12345"
|
|
7118
|
+
*/
|
|
7119
|
+
object: string;
|
|
7120
|
+
/** Survey response submitted for the object. */
|
|
7121
|
+
response: object;
|
|
7122
|
+
/**
|
|
7123
|
+
* The response score for the survey. Only applicable for CSAT and
|
|
7124
|
+
* NPS.
|
|
7125
|
+
* @format int32
|
|
7126
|
+
*/
|
|
7127
|
+
response_score?: number;
|
|
7128
|
+
/** The source channel from which survey response is submitted. */
|
|
7129
|
+
source_channel?: string;
|
|
7130
|
+
/** The ID of the survey to submit the response to. */
|
|
7131
|
+
survey: string;
|
|
7132
|
+
}
|
|
7133
|
+
/** surveys-submit-response */
|
|
7134
|
+
export type SurveysSubmitResponse = object;
|
|
7135
|
+
/** sync-metadata-filter */
|
|
7136
|
+
export interface SyncMetadataFilter {
|
|
7137
|
+
last_sync_in?: SyncMetadataFilterSyncInFilter;
|
|
7138
|
+
last_sync_out?: SyncMetadataFilterSyncOutFilter;
|
|
7139
|
+
/** Filters for issues synced from this specific origin system. */
|
|
7140
|
+
origin_system?: string[];
|
|
7141
|
+
}
|
|
7142
|
+
/** sync-metadata-filter-sync-in-filter */
|
|
7143
|
+
export interface SyncMetadataFilterSyncInFilter {
|
|
7144
|
+
/** Filters for works with selected sync statuses. */
|
|
7145
|
+
status?: SyncMetadataFilterSyncInFilterStatus[];
|
|
7146
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7147
|
+
sync_date?: DateFilter;
|
|
7148
|
+
/** Filters for works modified with selected sync units. */
|
|
7149
|
+
sync_unit?: string[];
|
|
7150
|
+
}
|
|
7151
|
+
export declare enum SyncMetadataFilterSyncInFilterStatus {
|
|
7152
|
+
Failed = "failed",
|
|
7153
|
+
Modified = "modified",
|
|
7154
|
+
Staged = "staged",
|
|
7155
|
+
Succeeded = "succeeded"
|
|
7156
|
+
}
|
|
7157
|
+
/** sync-metadata-filter-sync-out-filter */
|
|
7158
|
+
export interface SyncMetadataFilterSyncOutFilter {
|
|
7159
|
+
/** Filters for works with selected sync statuses. */
|
|
7160
|
+
status?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
7161
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7162
|
+
sync_date?: DateFilter;
|
|
7163
|
+
/** Filters for works modified with selected sync units. */
|
|
7164
|
+
sync_unit?: string[];
|
|
7165
|
+
}
|
|
7166
|
+
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
7167
|
+
Failed = "failed",
|
|
7168
|
+
Succeeded = "succeeded"
|
|
7169
|
+
}
|
|
5594
7170
|
/** sys-user */
|
|
5595
7171
|
export type SysUser = UserBase;
|
|
5596
7172
|
/** sys-user-summary */
|
|
@@ -5684,6 +7260,10 @@ export type Tag = AtomBase & {
|
|
|
5684
7260
|
*/
|
|
5685
7261
|
name: string;
|
|
5686
7262
|
};
|
|
7263
|
+
/** tag-search-summary */
|
|
7264
|
+
export type TagSearchSummary = SearchSummaryBase & {
|
|
7265
|
+
tag: TagSummary;
|
|
7266
|
+
};
|
|
5687
7267
|
/** tag-summary */
|
|
5688
7268
|
export type TagSummary = AtomBaseSummary & {
|
|
5689
7269
|
/**
|
|
@@ -5872,6 +7452,7 @@ export type Ticket = WorkBase & {
|
|
|
5872
7452
|
rev_org?: OrgSummary;
|
|
5873
7453
|
/** Severity of the ticket. */
|
|
5874
7454
|
severity?: TicketSeverity;
|
|
7455
|
+
sla_tracker?: SlaTrackerSummary;
|
|
5875
7456
|
/** Source channel of the ticket. */
|
|
5876
7457
|
source_channel?: string;
|
|
5877
7458
|
};
|
|
@@ -5974,7 +7555,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
5974
7555
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
5975
7556
|
/**
|
|
5976
7557
|
* The IDs of the artifacts attached to the comment.
|
|
5977
|
-
* @maxItems
|
|
7558
|
+
* @maxItems 50
|
|
5978
7559
|
* @example ["ARTIFACT-12345"]
|
|
5979
7560
|
*/
|
|
5980
7561
|
artifacts?: string[];
|
|
@@ -5983,12 +7564,22 @@ export interface TimelineEntriesCreateRequestTimelineComment {
|
|
|
5983
7564
|
/** The type of the body to use for the comment. */
|
|
5984
7565
|
body_type?: TimelineCommentBodyType;
|
|
5985
7566
|
/**
|
|
5986
|
-
* The
|
|
7567
|
+
* The external reference for the comment. This must be unique within
|
|
7568
|
+
* the object's timeline.
|
|
7569
|
+
*/
|
|
7570
|
+
external_ref?: string;
|
|
7571
|
+
/**
|
|
7572
|
+
* The IDs of the previews of the links posted in the comment.
|
|
5987
7573
|
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
5988
7574
|
*/
|
|
5989
7575
|
link_previews?: string[];
|
|
5990
7576
|
/** Snap Kit Body of the comment. */
|
|
5991
7577
|
snap_kit_body?: TimelineSnapKitBody;
|
|
7578
|
+
/**
|
|
7579
|
+
* The snap widget body of the comment.
|
|
7580
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
7581
|
+
*/
|
|
7582
|
+
snap_widget_body?: string[];
|
|
5992
7583
|
}
|
|
5993
7584
|
export declare enum TimelineEntriesCreateRequestType {
|
|
5994
7585
|
TimelineComment = "timeline_comment"
|
|
@@ -6021,6 +7612,11 @@ export type TimelineEntriesDeleteResponse = object;
|
|
|
6021
7612
|
* The request to get a timeline entry.
|
|
6022
7613
|
*/
|
|
6023
7614
|
export interface TimelineEntriesGetRequest {
|
|
7615
|
+
/**
|
|
7616
|
+
* If set, then gets the entry with the given external reference for
|
|
7617
|
+
* the provided entry ID's timeline.
|
|
7618
|
+
*/
|
|
7619
|
+
external_ref?: string;
|
|
6024
7620
|
/**
|
|
6025
7621
|
* The ID of the timeline entry to get.
|
|
6026
7622
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
@@ -6143,7 +7739,7 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
6143
7739
|
remove?: string[];
|
|
6144
7740
|
/**
|
|
6145
7741
|
* Sets the field to the provided artifacts.
|
|
6146
|
-
* @maxItems
|
|
7742
|
+
* @maxItems 50
|
|
6147
7743
|
* @example ["ARTIFACT-12345"]
|
|
6148
7744
|
*/
|
|
6149
7745
|
set?: string[];
|
|
@@ -6186,6 +7782,11 @@ export type TimelineEntry = TimelineComment & {
|
|
|
6186
7782
|
};
|
|
6187
7783
|
/** timeline-entry-base */
|
|
6188
7784
|
export type TimelineEntryBase = AtomBase & {
|
|
7785
|
+
/**
|
|
7786
|
+
* An external reference that's associated with the Timeline entry
|
|
7787
|
+
* that's guaranteed to be unique among its siblings.
|
|
7788
|
+
*/
|
|
7789
|
+
external_ref?: string;
|
|
6189
7790
|
/** Labels that are associated with the Timeline entry. */
|
|
6190
7791
|
labels?: string[];
|
|
6191
7792
|
/** The object that the Timeline entry belongs to. */
|
|
@@ -6286,6 +7887,29 @@ export interface TimelineThread {
|
|
|
6286
7887
|
*/
|
|
6287
7888
|
total_replies?: number;
|
|
6288
7889
|
}
|
|
7890
|
+
/** track-event */
|
|
7891
|
+
export interface TrackEvent {
|
|
7892
|
+
/** Properties of client to be used in track API. */
|
|
7893
|
+
client_context?: ClientContext;
|
|
7894
|
+
/** Unique ID for the event. */
|
|
7895
|
+
event_id?: string;
|
|
7896
|
+
/**
|
|
7897
|
+
* The timestamp at which the event occurred.
|
|
7898
|
+
* @format date-time
|
|
7899
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7900
|
+
*/
|
|
7901
|
+
event_time?: string;
|
|
7902
|
+
/** Name of the event. */
|
|
7903
|
+
name: string;
|
|
7904
|
+
/** Payload of the event */
|
|
7905
|
+
payload: object;
|
|
7906
|
+
}
|
|
7907
|
+
/** track-events-publish-request */
|
|
7908
|
+
export interface TrackEventsPublishRequest {
|
|
7909
|
+
events_list: TrackEvent[];
|
|
7910
|
+
}
|
|
7911
|
+
/** track-events-publish-response */
|
|
7912
|
+
export type TrackEventsPublishResponse = object;
|
|
6289
7913
|
/**
|
|
6290
7914
|
* unit
|
|
6291
7915
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -6314,20 +7938,33 @@ export declare enum UnitType {
|
|
|
6314
7938
|
}
|
|
6315
7939
|
/**
|
|
6316
7940
|
* unlink-rev-user-from-rev-org-request
|
|
6317
|
-
*
|
|
7941
|
+
* Request to unlink/remove a Rev user from a Rev organization.
|
|
6318
7942
|
*/
|
|
6319
7943
|
export interface UnlinkRevUserFromRevOrgRequest {
|
|
7944
|
+
/** The ID of the Rev user. */
|
|
7945
|
+
id?: string;
|
|
6320
7946
|
/**
|
|
6321
|
-
* The
|
|
7947
|
+
* The ID of the Rev organization to unlink the Rev user from.
|
|
6322
7948
|
* @example "REV-AbCdEfGh"
|
|
6323
7949
|
*/
|
|
6324
|
-
|
|
6325
|
-
/**
|
|
6326
|
-
|
|
7950
|
+
rev_org?: string;
|
|
7951
|
+
/**
|
|
7952
|
+
* The don of the rev org to unlink the rev user from. This is
|
|
7953
|
+
* deprecated, use rev_org instead.
|
|
7954
|
+
* @deprecated
|
|
7955
|
+
* @example "REV-AbCdEfGh"
|
|
7956
|
+
*/
|
|
7957
|
+
rev_org_don?: string;
|
|
7958
|
+
/**
|
|
7959
|
+
* The don of the rev user to unlink. This is deprecated, use id
|
|
7960
|
+
* instead.
|
|
7961
|
+
* @deprecated
|
|
7962
|
+
*/
|
|
7963
|
+
user_don?: string;
|
|
6327
7964
|
}
|
|
6328
7965
|
/**
|
|
6329
7966
|
* unlink-rev-user-from-rev-org-response
|
|
6330
|
-
*
|
|
7967
|
+
* Response for unlinking/removing a Rev user from a Rev organization.
|
|
6331
7968
|
*/
|
|
6332
7969
|
export interface UnlinkRevUserFromRevOrgResponse {
|
|
6333
7970
|
rev_user: RevUser;
|
|
@@ -6375,6 +8012,38 @@ export declare enum UomMetricScope {
|
|
|
6375
8012
|
Org = "org",
|
|
6376
8013
|
User = "user"
|
|
6377
8014
|
}
|
|
8015
|
+
/** uoms-count-request */
|
|
8016
|
+
export interface UomsCountRequest {
|
|
8017
|
+
/** List of aggregation types for filtering list of UOMs. */
|
|
8018
|
+
aggregation_types?: AggregationDetailAggregationType[];
|
|
8019
|
+
/**
|
|
8020
|
+
* List of Unit of Measurement (UOM) DONs to be used in filtering
|
|
8021
|
+
* complete list of UOMs defined in a Dev Org.
|
|
8022
|
+
*/
|
|
8023
|
+
ids?: string[];
|
|
8024
|
+
/** List of metric names for filtering list of UOMs. */
|
|
8025
|
+
metric_names?: string[];
|
|
8026
|
+
/**
|
|
8027
|
+
* List of part IDs for filtering list of UOMs.
|
|
8028
|
+
* @example ["PROD-12345"]
|
|
8029
|
+
*/
|
|
8030
|
+
part_ids?: string[];
|
|
8031
|
+
/**
|
|
8032
|
+
* List of product IDs for filtering list of UOMs.
|
|
8033
|
+
* @example ["PROD-12345"]
|
|
8034
|
+
*/
|
|
8035
|
+
product_ids?: string[];
|
|
8036
|
+
/** List of unit types for filtering list of UOMs. */
|
|
8037
|
+
unit_types?: UnitType[];
|
|
8038
|
+
}
|
|
8039
|
+
/** uoms-count-response */
|
|
8040
|
+
export interface UomsCountResponse {
|
|
8041
|
+
/**
|
|
8042
|
+
* Count of Unit of Measurements matching the filter.
|
|
8043
|
+
* @format int32
|
|
8044
|
+
*/
|
|
8045
|
+
count: number;
|
|
8046
|
+
}
|
|
6378
8047
|
/** uoms-create-request */
|
|
6379
8048
|
export interface UomsCreateRequest {
|
|
6380
8049
|
/** Stores aggregation type and dimension information. */
|
|
@@ -6602,6 +8271,10 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
6602
8271
|
/** State of the user. */
|
|
6603
8272
|
state?: UserState;
|
|
6604
8273
|
};
|
|
8274
|
+
/** user-search-summary */
|
|
8275
|
+
export type UserSearchSummary = SearchSummaryBase & {
|
|
8276
|
+
user: UserSummary;
|
|
8277
|
+
};
|
|
6605
8278
|
/** State of the user. */
|
|
6606
8279
|
export declare enum UserState {
|
|
6607
8280
|
Active = "active",
|
|
@@ -6621,6 +8294,30 @@ export declare enum UserType {
|
|
|
6621
8294
|
ServiceAccount = "service_account",
|
|
6622
8295
|
SysUser = "sys_user"
|
|
6623
8296
|
}
|
|
8297
|
+
/** vista-base-summary */
|
|
8298
|
+
export type VistaBaseSummary = AtomBaseSummary & {
|
|
8299
|
+
/** Name of the vista. */
|
|
8300
|
+
name: string;
|
|
8301
|
+
};
|
|
8302
|
+
/** vista-search-summary */
|
|
8303
|
+
export type VistaSearchSummary = SearchSummaryBase & {
|
|
8304
|
+
/** Represents a collection of DevRev objects. */
|
|
8305
|
+
vista: VistaSummary;
|
|
8306
|
+
};
|
|
8307
|
+
/**
|
|
8308
|
+
* vista-summary
|
|
8309
|
+
* Represents a collection of DevRev objects.
|
|
8310
|
+
*/
|
|
8311
|
+
export type VistaSummary = (CuratedVistaSummary | DynamicVistaSummary | GroupedVistaSummary) & {
|
|
8312
|
+
/** Type of vista object. */
|
|
8313
|
+
type: VistaType;
|
|
8314
|
+
};
|
|
8315
|
+
/** Type of vista object. */
|
|
8316
|
+
export declare enum VistaType {
|
|
8317
|
+
Curated = "curated",
|
|
8318
|
+
Dynamic = "dynamic",
|
|
8319
|
+
Grouped = "grouped"
|
|
8320
|
+
}
|
|
6624
8321
|
/** webhook */
|
|
6625
8322
|
export type Webhook = AtomBase & {
|
|
6626
8323
|
/** The event types that the webhook will receive. */
|
|
@@ -6660,6 +8357,9 @@ export interface WebhookEventRequest {
|
|
|
6660
8357
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
6661
8358
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
6662
8359
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
8360
|
+
survey_response_created?: EventSurveyResponseCreated;
|
|
8361
|
+
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
8362
|
+
survey_response_updated?: EventSurveyResponseUpdated;
|
|
6663
8363
|
tag_created?: EventTagCreated;
|
|
6664
8364
|
tag_deleted?: EventTagDeleted;
|
|
6665
8365
|
tag_updated?: EventTagUpdated;
|
|
@@ -6719,6 +8419,9 @@ export declare enum WebhookEventType {
|
|
|
6719
8419
|
RevUserCreated = "rev_user_created",
|
|
6720
8420
|
RevUserDeleted = "rev_user_deleted",
|
|
6721
8421
|
RevUserUpdated = "rev_user_updated",
|
|
8422
|
+
SlaTrackerCreated = "sla_tracker_created",
|
|
8423
|
+
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
8424
|
+
SlaTrackerUpdated = "sla_tracker_updated",
|
|
6722
8425
|
TagCreated = "tag_created",
|
|
6723
8426
|
TagDeleted = "tag_deleted",
|
|
6724
8427
|
TagUpdated = "tag_updated",
|
|
@@ -6917,6 +8620,8 @@ export type WorkBase = AtomBase & {
|
|
|
6917
8620
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
6918
8621
|
*/
|
|
6919
8622
|
stock_schema_fragment?: string;
|
|
8623
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
8624
|
+
subtype?: string;
|
|
6920
8625
|
/** Tags associated with the object. */
|
|
6921
8626
|
tags?: TagWithValue[];
|
|
6922
8627
|
/**
|
|
@@ -6930,9 +8635,21 @@ export type WorkBase = AtomBase & {
|
|
|
6930
8635
|
};
|
|
6931
8636
|
/** work-base-summary */
|
|
6932
8637
|
export type WorkBaseSummary = AtomBaseSummary & {
|
|
8638
|
+
/** The users that own the work. */
|
|
8639
|
+
owned_by: UserSummary[];
|
|
8640
|
+
/** Describes the current stage of a work item. */
|
|
8641
|
+
stage?: LegacyStageSummary;
|
|
6933
8642
|
/** Title of the work object. */
|
|
6934
8643
|
title: string;
|
|
6935
8644
|
};
|
|
8645
|
+
/** work-search-summary */
|
|
8646
|
+
export type WorkSearchSummary = SearchSummaryBase & {
|
|
8647
|
+
work: WorkSummary;
|
|
8648
|
+
};
|
|
8649
|
+
/** work-summary */
|
|
8650
|
+
export type WorkSummary = (IssueSummary | OpportunitySummary | TaskSummary | TicketSummary) & {
|
|
8651
|
+
type: WorkType;
|
|
8652
|
+
};
|
|
6936
8653
|
export declare enum WorkType {
|
|
6937
8654
|
Issue = "issue",
|
|
6938
8655
|
Opportunity = "opportunity",
|
|
@@ -6962,6 +8679,14 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
6962
8679
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
6963
8680
|
*/
|
|
6964
8681
|
custom_schema_fragments?: string[];
|
|
8682
|
+
/**
|
|
8683
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
8684
|
+
* custom field must be specified, otherwise a bad request error is
|
|
8685
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
8686
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
8687
|
+
* specifier, it remains unmodified.
|
|
8688
|
+
*/
|
|
8689
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
6965
8690
|
/**
|
|
6966
8691
|
* The users that own the work.
|
|
6967
8692
|
* @example ["DEVU-12345"]
|
|
@@ -6974,6 +8699,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
6974
8699
|
reported_by?: string[];
|
|
6975
8700
|
/** Sets an object's initial stage. */
|
|
6976
8701
|
stage?: StageInit;
|
|
8702
|
+
/** The type of stage validations options when creating a work item. */
|
|
8703
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
6977
8704
|
/** Tags associated with the work item. */
|
|
6978
8705
|
tags?: SetTagWithValue[];
|
|
6979
8706
|
/**
|
|
@@ -7003,6 +8730,12 @@ export interface WorksCreateRequestIssue {
|
|
|
7003
8730
|
priority_v2?: number;
|
|
7004
8731
|
/** The sprint that the issue belongs to. */
|
|
7005
8732
|
sprint?: string;
|
|
8733
|
+
/**
|
|
8734
|
+
* Timestamp for when the work is expected to start.
|
|
8735
|
+
* @format date-time
|
|
8736
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8737
|
+
*/
|
|
8738
|
+
target_start_date?: string;
|
|
7006
8739
|
}
|
|
7007
8740
|
/** works-create-request-opportunity */
|
|
7008
8741
|
export interface WorksCreateRequestOpportunity {
|
|
@@ -7054,6 +8787,8 @@ export interface WorksCreateRequestTicket {
|
|
|
7054
8787
|
group?: string;
|
|
7055
8788
|
/** Whether the ticket is spam. */
|
|
7056
8789
|
is_spam?: boolean;
|
|
8790
|
+
/** Whether the ticket needs a response. */
|
|
8791
|
+
needs_response?: boolean;
|
|
7057
8792
|
/**
|
|
7058
8793
|
* The Rev organization that the ticket is associated with.
|
|
7059
8794
|
* @example "REV-AbCdEfGh"
|
|
@@ -7120,6 +8855,8 @@ export interface WorksExportRequest {
|
|
|
7120
8855
|
sort_by?: string[];
|
|
7121
8856
|
/** The filter for stages. */
|
|
7122
8857
|
stage?: StageFilter;
|
|
8858
|
+
staged_info?: StagedInfoFilter;
|
|
8859
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7123
8860
|
/**
|
|
7124
8861
|
* Filters for work with any of the provided tags.
|
|
7125
8862
|
* @example ["TAG-12345"]
|
|
@@ -7143,6 +8880,8 @@ export interface WorksFilterIssue {
|
|
|
7143
8880
|
* @example ["ACC-12345"]
|
|
7144
8881
|
*/
|
|
7145
8882
|
accounts?: string[];
|
|
8883
|
+
/** Provides ways to specify date ranges on objects. */
|
|
8884
|
+
actual_start_date?: DateFilter;
|
|
7146
8885
|
/** Filters for issues with any of the provided priorities. */
|
|
7147
8886
|
priority?: IssuePriority[];
|
|
7148
8887
|
/** Filters for issues with any of the provided priority enum ids. */
|
|
@@ -7152,6 +8891,10 @@ export interface WorksFilterIssue {
|
|
|
7152
8891
|
* @example ["REV-AbCdEfGh"]
|
|
7153
8892
|
*/
|
|
7154
8893
|
rev_orgs?: string[];
|
|
8894
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
8895
|
+
subtype?: string[];
|
|
8896
|
+
/** Provides ways to specify date ranges on objects. */
|
|
8897
|
+
target_start_date?: DateFilter;
|
|
7155
8898
|
}
|
|
7156
8899
|
/** works-filter-opportunity */
|
|
7157
8900
|
export interface WorksFilterOpportunity {
|
|
@@ -7163,6 +8906,8 @@ export interface WorksFilterOpportunity {
|
|
|
7163
8906
|
account?: string[];
|
|
7164
8907
|
/** Filters for opportunities with any of the provided contacts. */
|
|
7165
8908
|
contacts?: string[];
|
|
8909
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
8910
|
+
subtype?: string[];
|
|
7166
8911
|
}
|
|
7167
8912
|
/** works-filter-ticket */
|
|
7168
8913
|
export interface WorksFilterTicket {
|
|
@@ -7186,6 +8931,8 @@ export interface WorksFilterTicket {
|
|
|
7186
8931
|
sla_summary?: SlaSummaryFilter;
|
|
7187
8932
|
/** Filters for tickets with any of the provided source channels. */
|
|
7188
8933
|
source_channel?: string[];
|
|
8934
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
8935
|
+
subtype?: string[];
|
|
7189
8936
|
/** The filter for survey aggregation. */
|
|
7190
8937
|
surveys?: SurveyAggregationFilter;
|
|
7191
8938
|
}
|
|
@@ -7255,6 +9002,8 @@ export interface WorksListRequest {
|
|
|
7255
9002
|
sort_by?: string[];
|
|
7256
9003
|
/** The filter for stages. */
|
|
7257
9004
|
stage?: StageFilter;
|
|
9005
|
+
staged_info?: StagedInfoFilter;
|
|
9006
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7258
9007
|
/**
|
|
7259
9008
|
* Filters for work with any of the provided tags.
|
|
7260
9009
|
* @example ["TAG-12345"]
|
|
@@ -7288,7 +9037,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7288
9037
|
* @example "PROD-12345"
|
|
7289
9038
|
*/
|
|
7290
9039
|
applies_to_part?: string;
|
|
7291
|
-
artifacts?:
|
|
9040
|
+
artifacts?: WorksUpdateRequestArtifacts;
|
|
7292
9041
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
7293
9042
|
body?: string;
|
|
7294
9043
|
/** Custom fields. */
|
|
@@ -7298,6 +9047,14 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7298
9047
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
7299
9048
|
*/
|
|
7300
9049
|
custom_schema_fragments?: string[];
|
|
9050
|
+
/**
|
|
9051
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
9052
|
+
* custom field must be specified, otherwise a bad request error is
|
|
9053
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
9054
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
9055
|
+
* specifier, it remains unmodified.
|
|
9056
|
+
*/
|
|
9057
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7301
9058
|
/**
|
|
7302
9059
|
* The work's ID.
|
|
7303
9060
|
* @example "ISS-12345"
|
|
@@ -7307,6 +9064,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7307
9064
|
reported_by?: WorksUpdateRequestReportedBy;
|
|
7308
9065
|
/** Updates an object's stage. */
|
|
7309
9066
|
stage?: StageUpdate;
|
|
9067
|
+
/**
|
|
9068
|
+
* The type of stage validations options when updating the stage of an
|
|
9069
|
+
* object.
|
|
9070
|
+
*/
|
|
9071
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
7310
9072
|
staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
|
|
7311
9073
|
tags?: WorksUpdateRequestTags;
|
|
7312
9074
|
/**
|
|
@@ -7319,10 +9081,23 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
7319
9081
|
title?: string;
|
|
7320
9082
|
type?: WorkType;
|
|
7321
9083
|
};
|
|
7322
|
-
/** works-update-request-
|
|
7323
|
-
export interface
|
|
9084
|
+
/** works-update-request-artifacts */
|
|
9085
|
+
export interface WorksUpdateRequestArtifacts {
|
|
7324
9086
|
/**
|
|
7325
|
-
*
|
|
9087
|
+
* Adds the provided artifacts (if not already present) to the field.
|
|
9088
|
+
* @maxItems 50
|
|
9089
|
+
* @example ["ARTIFACT-12345"]
|
|
9090
|
+
*/
|
|
9091
|
+
add?: string[];
|
|
9092
|
+
/**
|
|
9093
|
+
* Removes the provided artifacts (if they exist) from the field.
|
|
9094
|
+
* @maxItems 50
|
|
9095
|
+
* @example ["ARTIFACT-12345"]
|
|
9096
|
+
*/
|
|
9097
|
+
remove?: string[];
|
|
9098
|
+
/**
|
|
9099
|
+
* Sets the field to the provided artifacts.
|
|
9100
|
+
* @maxItems 50
|
|
7326
9101
|
* @example ["ARTIFACT-12345"]
|
|
7327
9102
|
*/
|
|
7328
9103
|
set?: string[];
|
|
@@ -7339,6 +9114,12 @@ export interface WorksUpdateRequestIssue {
|
|
|
7339
9114
|
priority_v2?: number;
|
|
7340
9115
|
/** Updates the sprint that the issue belongs to. */
|
|
7341
9116
|
sprint?: string | null;
|
|
9117
|
+
/**
|
|
9118
|
+
* Updates the timestamp for when the work is expected to start.
|
|
9119
|
+
* @format date-time
|
|
9120
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9121
|
+
*/
|
|
9122
|
+
target_start_date?: string | null;
|
|
7342
9123
|
}
|
|
7343
9124
|
/** works-update-request-issue-developed-with */
|
|
7344
9125
|
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
@@ -7426,6 +9207,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
7426
9207
|
group?: string | null;
|
|
7427
9208
|
/** Updates whether the ticket is spam. */
|
|
7428
9209
|
is_spam?: boolean;
|
|
9210
|
+
/** Updates whether the ticket needs a response. */
|
|
9211
|
+
needs_response?: boolean;
|
|
7429
9212
|
/**
|
|
7430
9213
|
* Updates the Rev organization that the ticket is associated with.
|
|
7431
9214
|
* @example "REV-AbCdEfGh"
|
|
@@ -7701,6 +9484,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7701
9484
|
* @secure
|
|
7702
9485
|
*/
|
|
7703
9486
|
articlesCount: (query?: {
|
|
9487
|
+
/** The ancestor directory of the articles. */
|
|
9488
|
+
ancestor?: string;
|
|
7704
9489
|
/**
|
|
7705
9490
|
* Filters for articles belonging to any of the provided parts.
|
|
7706
9491
|
* @example ["PROD-12345"]
|
|
@@ -7870,9 +9655,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7870
9655
|
* @request GET:/artifacts.list
|
|
7871
9656
|
* @secure
|
|
7872
9657
|
*/
|
|
7873
|
-
artifactsList: (query
|
|
9658
|
+
artifactsList: (query?: {
|
|
7874
9659
|
/** The ID of the object to filter artifacts. */
|
|
7875
|
-
parent_id
|
|
9660
|
+
parent_id?: string;
|
|
7876
9661
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
7877
9662
|
/**
|
|
7878
9663
|
* @description List the artifacts attached to an object.
|
|
@@ -8020,27 +9805,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8020
9805
|
*/
|
|
8021
9806
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
8022
9807
|
/**
|
|
8023
|
-
* @description
|
|
9808
|
+
* @description Creates a code change object.
|
|
8024
9809
|
*
|
|
8025
|
-
* @tags
|
|
9810
|
+
* @tags code-changes
|
|
8026
9811
|
* @name CodeChangesCreate
|
|
8027
9812
|
* @request POST:/code-changes.create
|
|
8028
9813
|
* @secure
|
|
8029
9814
|
*/
|
|
8030
9815
|
codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any>>;
|
|
8031
9816
|
/**
|
|
8032
|
-
* @description
|
|
9817
|
+
* @description Deletes a code change object.
|
|
8033
9818
|
*
|
|
8034
|
-
* @tags
|
|
9819
|
+
* @tags code-changes
|
|
8035
9820
|
* @name CodeChangesDelete
|
|
8036
9821
|
* @request POST:/code-changes.delete
|
|
8037
9822
|
* @secure
|
|
8038
9823
|
*/
|
|
8039
9824
|
codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8040
9825
|
/**
|
|
8041
|
-
* @description
|
|
9826
|
+
* @description Gets a code change object.
|
|
8042
9827
|
*
|
|
8043
|
-
* @tags
|
|
9828
|
+
* @tags code-changes
|
|
8044
9829
|
* @name CodeChangesGet
|
|
8045
9830
|
* @request GET:/code-changes.get
|
|
8046
9831
|
* @secure
|
|
@@ -8050,18 +9835,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8050
9835
|
id: string;
|
|
8051
9836
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
|
|
8052
9837
|
/**
|
|
8053
|
-
* @description
|
|
9838
|
+
* @description Gets a code change object.
|
|
8054
9839
|
*
|
|
8055
|
-
* @tags
|
|
9840
|
+
* @tags code-changes
|
|
8056
9841
|
* @name CodeChangesGetPost
|
|
8057
9842
|
* @request POST:/code-changes.get
|
|
8058
9843
|
* @secure
|
|
8059
9844
|
*/
|
|
8060
9845
|
codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
|
|
8061
9846
|
/**
|
|
8062
|
-
* @description
|
|
9847
|
+
* @description Lists code change objects.
|
|
8063
9848
|
*
|
|
8064
|
-
* @tags
|
|
9849
|
+
* @tags code-changes
|
|
8065
9850
|
* @name CodeChangesList
|
|
8066
9851
|
* @request GET:/code-changes.list
|
|
8067
9852
|
* @secure
|
|
@@ -8085,18 +9870,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8085
9870
|
mode?: ListMode;
|
|
8086
9871
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
|
|
8087
9872
|
/**
|
|
8088
|
-
* @description
|
|
9873
|
+
* @description Lists code change objects.
|
|
8089
9874
|
*
|
|
8090
|
-
* @tags
|
|
9875
|
+
* @tags code-changes
|
|
8091
9876
|
* @name CodeChangesListPost
|
|
8092
9877
|
* @request POST:/code-changes.list
|
|
8093
9878
|
* @secure
|
|
8094
9879
|
*/
|
|
8095
9880
|
codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
|
|
8096
9881
|
/**
|
|
8097
|
-
* @description
|
|
9882
|
+
* @description Updates a code change object.
|
|
8098
9883
|
*
|
|
8099
|
-
* @tags
|
|
9884
|
+
* @tags code-changes
|
|
8100
9885
|
* @name CodeChangesUpdate
|
|
8101
9886
|
* @request POST:/code-changes.update
|
|
8102
9887
|
* @secure
|
|
@@ -8465,6 +10250,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8465
10250
|
* @secure
|
|
8466
10251
|
*/
|
|
8467
10252
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
10253
|
+
/**
|
|
10254
|
+
* @description Updates the authenticated user.
|
|
10255
|
+
*
|
|
10256
|
+
* @tags dev-users
|
|
10257
|
+
* @name DevUsersSelfUpdate
|
|
10258
|
+
* @request POST:/dev-users.self.update
|
|
10259
|
+
* @secure
|
|
10260
|
+
*/
|
|
10261
|
+
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
10262
|
+
/**
|
|
10263
|
+
* @description Updates the user corresponding to the input Id.
|
|
10264
|
+
*
|
|
10265
|
+
* @tags dev-users
|
|
10266
|
+
* @name DevUsersUpdate
|
|
10267
|
+
* @request POST:/dev-users.update
|
|
10268
|
+
* @secure
|
|
10269
|
+
*/
|
|
10270
|
+
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
8468
10271
|
/**
|
|
8469
10272
|
* @description Counts the engagement records.
|
|
8470
10273
|
*
|
|
@@ -8877,6 +10680,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8877
10680
|
* starts from the beginning.
|
|
8878
10681
|
*/
|
|
8879
10682
|
cursor?: string;
|
|
10683
|
+
/**
|
|
10684
|
+
* Whether to include custom metrics in the response. If not set, then
|
|
10685
|
+
* custom metrics are excluded.
|
|
10686
|
+
*/
|
|
10687
|
+
include_custom_metrics?: boolean;
|
|
8880
10688
|
/**
|
|
8881
10689
|
* The maximum number of records to return. The default is '50'.
|
|
8882
10690
|
* @format int32
|
|
@@ -9155,6 +10963,110 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9155
10963
|
* @secure
|
|
9156
10964
|
*/
|
|
9157
10965
|
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
|
|
10966
|
+
/**
|
|
10967
|
+
* @description Creates a question-answer.
|
|
10968
|
+
*
|
|
10969
|
+
* @tags question-answers
|
|
10970
|
+
* @name CreateQuestionAnswer
|
|
10971
|
+
* @request POST:/question-answers.create
|
|
10972
|
+
* @secure
|
|
10973
|
+
*/
|
|
10974
|
+
createQuestionAnswer: (data: QuestionAnswersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersCreateResponse, any>>;
|
|
10975
|
+
/**
|
|
10976
|
+
* @description Deletes a question-answer.
|
|
10977
|
+
*
|
|
10978
|
+
* @tags question-answers
|
|
10979
|
+
* @name DeleteQuestionAnswer
|
|
10980
|
+
* @request POST:/question-answers.delete
|
|
10981
|
+
* @secure
|
|
10982
|
+
*/
|
|
10983
|
+
deleteQuestionAnswer: (data: QuestionAnswersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
10984
|
+
/**
|
|
10985
|
+
* @description Gets a question-answer.
|
|
10986
|
+
*
|
|
10987
|
+
* @tags question-answers
|
|
10988
|
+
* @name GetQuestionAnswer
|
|
10989
|
+
* @request GET:/question-answers.get
|
|
10990
|
+
* @secure
|
|
10991
|
+
*/
|
|
10992
|
+
getQuestionAnswer: (query: {
|
|
10993
|
+
/** The ID of the required question-answer. */
|
|
10994
|
+
id: string;
|
|
10995
|
+
}, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
|
|
10996
|
+
/**
|
|
10997
|
+
* @description Gets a question-answer.
|
|
10998
|
+
*
|
|
10999
|
+
* @tags question-answers
|
|
11000
|
+
* @name GetQuestionAnswerPost
|
|
11001
|
+
* @request POST:/question-answers.get
|
|
11002
|
+
* @secure
|
|
11003
|
+
*/
|
|
11004
|
+
getQuestionAnswerPost: (data: QuestionAnswersGetRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
|
|
11005
|
+
/**
|
|
11006
|
+
* @description Lists a collection of question-answers.
|
|
11007
|
+
*
|
|
11008
|
+
* @tags question-answers
|
|
11009
|
+
* @name ListQuestionAnswers
|
|
11010
|
+
* @request GET:/question-answers.list
|
|
11011
|
+
* @secure
|
|
11012
|
+
*/
|
|
11013
|
+
listQuestionAnswers: (query?: {
|
|
11014
|
+
/**
|
|
11015
|
+
* Filters for question-answer belonging to any of the provided
|
|
11016
|
+
* articles.
|
|
11017
|
+
* @example ["ARTICLE-12345"]
|
|
11018
|
+
*/
|
|
11019
|
+
applies_to_articles?: string[];
|
|
11020
|
+
/**
|
|
11021
|
+
* Filters for question-answer belonging to any of the provided parts.
|
|
11022
|
+
* @example ["PROD-12345"]
|
|
11023
|
+
*/
|
|
11024
|
+
applies_to_parts?: string[];
|
|
11025
|
+
/**
|
|
11026
|
+
* Filters for question-answers created by any of the provided users.
|
|
11027
|
+
* @example ["DEVU-12345"]
|
|
11028
|
+
*/
|
|
11029
|
+
created_by?: string[];
|
|
11030
|
+
/**
|
|
11031
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11032
|
+
* starts from the beginning.
|
|
11033
|
+
*/
|
|
11034
|
+
cursor?: string;
|
|
11035
|
+
/**
|
|
11036
|
+
* The maximum number of question-answers to return. The default is
|
|
11037
|
+
* '50'.
|
|
11038
|
+
* @format int32
|
|
11039
|
+
*/
|
|
11040
|
+
limit?: number;
|
|
11041
|
+
/**
|
|
11042
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11043
|
+
* used.
|
|
11044
|
+
*/
|
|
11045
|
+
mode?: ListMode;
|
|
11046
|
+
/**
|
|
11047
|
+
* Filters for question-answers owned by any of the provided users.
|
|
11048
|
+
* @example ["DEVU-12345"]
|
|
11049
|
+
*/
|
|
11050
|
+
owned_by?: string[];
|
|
11051
|
+
}, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
|
|
11052
|
+
/**
|
|
11053
|
+
* @description Lists a collection of question-answers.
|
|
11054
|
+
*
|
|
11055
|
+
* @tags question-answers
|
|
11056
|
+
* @name ListQuestionAnswersPost
|
|
11057
|
+
* @request POST:/question-answers.list
|
|
11058
|
+
* @secure
|
|
11059
|
+
*/
|
|
11060
|
+
listQuestionAnswersPost: (data: QuestionAnswersListRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
|
|
11061
|
+
/**
|
|
11062
|
+
* @description Updates a question-answer.
|
|
11063
|
+
*
|
|
11064
|
+
* @tags question-answers
|
|
11065
|
+
* @name UpdateQuestionAnswer
|
|
11066
|
+
* @request POST:/question-answers.update
|
|
11067
|
+
* @secure
|
|
11068
|
+
*/
|
|
11069
|
+
updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any>>;
|
|
9158
11070
|
/**
|
|
9159
11071
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
9160
11072
|
*
|
|
@@ -9244,6 +11156,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9244
11156
|
custom_field_filter?: string[];
|
|
9245
11157
|
/** Filters for custom fields. */
|
|
9246
11158
|
custom_fields?: object;
|
|
11159
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
11160
|
+
display_name?: string[];
|
|
9247
11161
|
/** List of external refs to filter Rev organizations for. */
|
|
9248
11162
|
external_ref?: string[];
|
|
9249
11163
|
/**
|
|
@@ -9453,6 +11367,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9453
11367
|
aggregatedSchemaGet: (query: {
|
|
9454
11368
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
9455
11369
|
custom_schema_fragment_ids: string[];
|
|
11370
|
+
/**
|
|
11371
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
11372
|
+
* tenant fragment ID.
|
|
11373
|
+
*/
|
|
11374
|
+
leaf_type?: string;
|
|
9456
11375
|
/** The stock schema fragment which is to be aggregated. */
|
|
9457
11376
|
stock_schema_fragment_id?: string;
|
|
9458
11377
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
@@ -9498,8 +11417,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9498
11417
|
/** The list of app names. */
|
|
9499
11418
|
app?: string[];
|
|
9500
11419
|
/**
|
|
9501
|
-
* The cursor to resume iteration from
|
|
9502
|
-
*
|
|
11420
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11421
|
+
* starts from the beginning.
|
|
9503
11422
|
*/
|
|
9504
11423
|
cursor?: string;
|
|
9505
11424
|
/** Whether only deprecated fragments should be filtered. */
|
|
@@ -9511,6 +11430,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9511
11430
|
* @format int32
|
|
9512
11431
|
*/
|
|
9513
11432
|
limit?: number;
|
|
11433
|
+
/**
|
|
11434
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11435
|
+
* used.
|
|
11436
|
+
*/
|
|
11437
|
+
mode?: ListMode;
|
|
11438
|
+
/**
|
|
11439
|
+
* List of fields which are not required in the payload and can be
|
|
11440
|
+
* pruned away.
|
|
11441
|
+
*/
|
|
11442
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
9514
11443
|
/** The list of fields to sort the items by and how to sort them. */
|
|
9515
11444
|
sort_by?: string[];
|
|
9516
11445
|
/** The list of subtypes. */
|
|
@@ -9569,10 +11498,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9569
11498
|
*/
|
|
9570
11499
|
stockSchemaFragmentsList: (query?: {
|
|
9571
11500
|
/**
|
|
9572
|
-
* The cursor to resume iteration from
|
|
9573
|
-
*
|
|
11501
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11502
|
+
* starts from the beginning.
|
|
9574
11503
|
*/
|
|
9575
11504
|
cursor?: string;
|
|
11505
|
+
/**
|
|
11506
|
+
* Filter preset to specify whether to filter only customization enabled
|
|
11507
|
+
* leaf types.
|
|
11508
|
+
*/
|
|
11509
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
9576
11510
|
/** The list of leaf types. */
|
|
9577
11511
|
leaf_type?: string[];
|
|
9578
11512
|
/**
|
|
@@ -9580,6 +11514,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9580
11514
|
* @format int32
|
|
9581
11515
|
*/
|
|
9582
11516
|
limit?: number;
|
|
11517
|
+
/**
|
|
11518
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11519
|
+
* used.
|
|
11520
|
+
*/
|
|
11521
|
+
mode?: ListMode;
|
|
11522
|
+
/**
|
|
11523
|
+
* List of fields which are not required in the payload and can be
|
|
11524
|
+
* pruned away.
|
|
11525
|
+
*/
|
|
11526
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
9583
11527
|
/** The list of fields to sort the items by and how to sort them. */
|
|
9584
11528
|
sort_by?: string[];
|
|
9585
11529
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
@@ -9618,6 +11562,91 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9618
11562
|
* @secure
|
|
9619
11563
|
*/
|
|
9620
11564
|
subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
11565
|
+
/**
|
|
11566
|
+
* @description Searches for records based on a given query.
|
|
11567
|
+
*
|
|
11568
|
+
* @tags search
|
|
11569
|
+
* @name SearchCore
|
|
11570
|
+
* @request GET:/search.core
|
|
11571
|
+
* @secure
|
|
11572
|
+
*/
|
|
11573
|
+
searchCore: (query: {
|
|
11574
|
+
/**
|
|
11575
|
+
* The query string. Search query language:
|
|
11576
|
+
* https://docs.devrev.ai/product/search#fields
|
|
11577
|
+
*/
|
|
11578
|
+
query: string;
|
|
11579
|
+
/**
|
|
11580
|
+
* The cursor from where to begin iteration. Start from beginning if not
|
|
11581
|
+
* provided.
|
|
11582
|
+
*/
|
|
11583
|
+
cursor?: string | undefined;
|
|
11584
|
+
/**
|
|
11585
|
+
* The maximum number of items to return in a page. The default is '10'.
|
|
11586
|
+
* @format int32
|
|
11587
|
+
*/
|
|
11588
|
+
limit?: number | undefined;
|
|
11589
|
+
/** The namespaces to search in. */
|
|
11590
|
+
namespaces?: SearchNamespace[] | undefined;
|
|
11591
|
+
/**
|
|
11592
|
+
* The property on which to sort the search results. The default is
|
|
11593
|
+
* RELEVANCE.
|
|
11594
|
+
*/
|
|
11595
|
+
sort_by?: SearchSortByParam | undefined;
|
|
11596
|
+
/** Sorting order. The default is DESCENDING. */
|
|
11597
|
+
sort_order?: SearchSortOrderParam | undefined;
|
|
11598
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
|
|
11599
|
+
/**
|
|
11600
|
+
* @description Searches for records based on a given query.
|
|
11601
|
+
*
|
|
11602
|
+
* @tags search
|
|
11603
|
+
* @name SearchCorePost
|
|
11604
|
+
* @request POST:/search.core
|
|
11605
|
+
* @secure
|
|
11606
|
+
*/
|
|
11607
|
+
searchCorePost: (data: SearchCoreRequest, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
|
|
11608
|
+
/**
|
|
11609
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
11610
|
+
*
|
|
11611
|
+
* @tags search
|
|
11612
|
+
* @name SearchHybrid
|
|
11613
|
+
* @request GET:/search.hybrid
|
|
11614
|
+
* @secure
|
|
11615
|
+
*/
|
|
11616
|
+
searchHybrid: (query: {
|
|
11617
|
+
/** The hybrid namespace to search in. */
|
|
11618
|
+
namespace: SearchHybridNamespace;
|
|
11619
|
+
/**
|
|
11620
|
+
* The query string.
|
|
11621
|
+
* @minLength 1
|
|
11622
|
+
* @maxLength 400
|
|
11623
|
+
*/
|
|
11624
|
+
query: string;
|
|
11625
|
+
/**
|
|
11626
|
+
* The maximum number of items to return in a page. The default is '10'.
|
|
11627
|
+
* @format int32
|
|
11628
|
+
* @min 0
|
|
11629
|
+
* @max 50
|
|
11630
|
+
*/
|
|
11631
|
+
limit?: number | undefined;
|
|
11632
|
+
/**
|
|
11633
|
+
* The weightage for semantic search. Values between 0 and 1 are
|
|
11634
|
+
* accepted.
|
|
11635
|
+
* @format float
|
|
11636
|
+
* @min 0
|
|
11637
|
+
* @max 1
|
|
11638
|
+
*/
|
|
11639
|
+
semantic_weight?: number | undefined;
|
|
11640
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
|
|
11641
|
+
/**
|
|
11642
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
11643
|
+
*
|
|
11644
|
+
* @tags search
|
|
11645
|
+
* @name SearchHybridPost
|
|
11646
|
+
* @request POST:/search.hybrid
|
|
11647
|
+
* @secure
|
|
11648
|
+
*/
|
|
11649
|
+
searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
|
|
9621
11650
|
/**
|
|
9622
11651
|
* @description Gets a service account.
|
|
9623
11652
|
*
|
|
@@ -9639,6 +11668,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9639
11668
|
* @secure
|
|
9640
11669
|
*/
|
|
9641
11670
|
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
11671
|
+
/**
|
|
11672
|
+
* @description Gets an SLA tracker.
|
|
11673
|
+
*
|
|
11674
|
+
* @tags slas
|
|
11675
|
+
* @name SlaTrackersGet
|
|
11676
|
+
* @request GET:/sla-trackers.get
|
|
11677
|
+
* @secure
|
|
11678
|
+
*/
|
|
11679
|
+
slaTrackersGet: (query: {
|
|
11680
|
+
/** The ID of the SLA tracker to get. */
|
|
11681
|
+
id: string;
|
|
11682
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
11683
|
+
/**
|
|
11684
|
+
* @description Gets an SLA tracker.
|
|
11685
|
+
*
|
|
11686
|
+
* @tags slas
|
|
11687
|
+
* @name SlaTrackersGetPost
|
|
11688
|
+
* @request POST:/sla-trackers.get
|
|
11689
|
+
* @secure
|
|
11690
|
+
*/
|
|
11691
|
+
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
9642
11692
|
/**
|
|
9643
11693
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
9644
11694
|
*
|
|
@@ -9755,6 +11805,297 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9755
11805
|
* @secure
|
|
9756
11806
|
*/
|
|
9757
11807
|
snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
11808
|
+
/**
|
|
11809
|
+
* @description Create a snap widget object.
|
|
11810
|
+
*
|
|
11811
|
+
* @tags snap-widgets
|
|
11812
|
+
* @name SnapWidgetsCreate
|
|
11813
|
+
* @request POST:/snap-widgets.create
|
|
11814
|
+
* @secure
|
|
11815
|
+
*/
|
|
11816
|
+
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
|
|
11817
|
+
/**
|
|
11818
|
+
* @description Creates a custom stage.
|
|
11819
|
+
*
|
|
11820
|
+
* @tags customization
|
|
11821
|
+
* @name CustomStagesCreate
|
|
11822
|
+
* @request POST:/stages.custom.create
|
|
11823
|
+
* @secure
|
|
11824
|
+
*/
|
|
11825
|
+
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
|
|
11826
|
+
/**
|
|
11827
|
+
* @description Gets a custom stage.
|
|
11828
|
+
*
|
|
11829
|
+
* @tags customization
|
|
11830
|
+
* @name CustomStagesGet
|
|
11831
|
+
* @request GET:/stages.custom.get
|
|
11832
|
+
* @secure
|
|
11833
|
+
*/
|
|
11834
|
+
customStagesGet: (query: {
|
|
11835
|
+
/** The ID of the custom stage to get. */
|
|
11836
|
+
id: string;
|
|
11837
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
11838
|
+
/**
|
|
11839
|
+
* @description Gets a custom stage.
|
|
11840
|
+
*
|
|
11841
|
+
* @tags customization
|
|
11842
|
+
* @name CustomStagesGetPost
|
|
11843
|
+
* @request POST:/stages.custom.get
|
|
11844
|
+
* @secure
|
|
11845
|
+
*/
|
|
11846
|
+
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
11847
|
+
/**
|
|
11848
|
+
* @description Lists custom stages.
|
|
11849
|
+
*
|
|
11850
|
+
* @tags customization
|
|
11851
|
+
* @name CustomStagesList
|
|
11852
|
+
* @request GET:/stages.custom.list
|
|
11853
|
+
* @secure
|
|
11854
|
+
*/
|
|
11855
|
+
customStagesList: (query?: {
|
|
11856
|
+
/**
|
|
11857
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
11858
|
+
* iteration starts from the beginning.
|
|
11859
|
+
*/
|
|
11860
|
+
cursor?: string;
|
|
11861
|
+
/**
|
|
11862
|
+
* The maximum number of items.
|
|
11863
|
+
* @format int32
|
|
11864
|
+
*/
|
|
11865
|
+
limit?: number;
|
|
11866
|
+
/** The list of stage names. */
|
|
11867
|
+
name?: string[];
|
|
11868
|
+
/** The list of stage ordinals. */
|
|
11869
|
+
ordinal?: number[];
|
|
11870
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11871
|
+
sort_by?: string[];
|
|
11872
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
11873
|
+
/**
|
|
11874
|
+
* @description Lists custom stages.
|
|
11875
|
+
*
|
|
11876
|
+
* @tags customization
|
|
11877
|
+
* @name CustomStagesListPost
|
|
11878
|
+
* @request POST:/stages.custom.list
|
|
11879
|
+
* @secure
|
|
11880
|
+
*/
|
|
11881
|
+
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
11882
|
+
/**
|
|
11883
|
+
* @description Updates a custom stage.
|
|
11884
|
+
*
|
|
11885
|
+
* @tags customization
|
|
11886
|
+
* @name CustomStagesUpdate
|
|
11887
|
+
* @request POST:/stages.custom.update
|
|
11888
|
+
* @secure
|
|
11889
|
+
*/
|
|
11890
|
+
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
|
|
11891
|
+
/**
|
|
11892
|
+
* @description Creates a custom state.
|
|
11893
|
+
*
|
|
11894
|
+
* @tags customization
|
|
11895
|
+
* @name CustomStatesCreate
|
|
11896
|
+
* @request POST:/states.custom.create
|
|
11897
|
+
* @secure
|
|
11898
|
+
*/
|
|
11899
|
+
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
|
|
11900
|
+
/**
|
|
11901
|
+
* @description Gets a custom state.
|
|
11902
|
+
*
|
|
11903
|
+
* @tags customization
|
|
11904
|
+
* @name CustomStatesGet
|
|
11905
|
+
* @request GET:/states.custom.get
|
|
11906
|
+
* @secure
|
|
11907
|
+
*/
|
|
11908
|
+
customStatesGet: (query: {
|
|
11909
|
+
/** The ID of the custom state to get. */
|
|
11910
|
+
id: string;
|
|
11911
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
11912
|
+
/**
|
|
11913
|
+
* @description Gets a custom state.
|
|
11914
|
+
*
|
|
11915
|
+
* @tags customization
|
|
11916
|
+
* @name CustomStatesGetPost
|
|
11917
|
+
* @request POST:/states.custom.get
|
|
11918
|
+
* @secure
|
|
11919
|
+
*/
|
|
11920
|
+
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
11921
|
+
/**
|
|
11922
|
+
* @description Lists custom states.
|
|
11923
|
+
*
|
|
11924
|
+
* @tags customization
|
|
11925
|
+
* @name CustomStatesList
|
|
11926
|
+
* @request GET:/states.custom.list
|
|
11927
|
+
* @secure
|
|
11928
|
+
*/
|
|
11929
|
+
customStatesList: (query?: {
|
|
11930
|
+
/**
|
|
11931
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
11932
|
+
* iteration starts from the beginning.
|
|
11933
|
+
*/
|
|
11934
|
+
cursor?: string;
|
|
11935
|
+
/** Whether only final states should be filtered. */
|
|
11936
|
+
is_final?: boolean;
|
|
11937
|
+
/**
|
|
11938
|
+
* The maximum number of items.
|
|
11939
|
+
* @format int32
|
|
11940
|
+
*/
|
|
11941
|
+
limit?: number;
|
|
11942
|
+
/** The list of state names. */
|
|
11943
|
+
name?: string[];
|
|
11944
|
+
/** The list of state ordinals. */
|
|
11945
|
+
ordinal?: number[];
|
|
11946
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11947
|
+
sort_by?: string[];
|
|
11948
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
11949
|
+
/**
|
|
11950
|
+
* @description Lists custom states.
|
|
11951
|
+
*
|
|
11952
|
+
* @tags customization
|
|
11953
|
+
* @name CustomStatesListPost
|
|
11954
|
+
* @request POST:/states.custom.list
|
|
11955
|
+
* @secure
|
|
11956
|
+
*/
|
|
11957
|
+
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
11958
|
+
/**
|
|
11959
|
+
* @description Updates a custom state.
|
|
11960
|
+
*
|
|
11961
|
+
* @tags customization
|
|
11962
|
+
* @name CustomStatesUpdate
|
|
11963
|
+
* @request POST:/states.custom.update
|
|
11964
|
+
* @secure
|
|
11965
|
+
*/
|
|
11966
|
+
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
|
|
11967
|
+
/**
|
|
11968
|
+
* @description Creates a schema for survey, which includes name and description of schema.
|
|
11969
|
+
*
|
|
11970
|
+
* @tags surveys
|
|
11971
|
+
* @name SurveysCreate
|
|
11972
|
+
* @request POST:/surveys.create
|
|
11973
|
+
* @secure
|
|
11974
|
+
*/
|
|
11975
|
+
surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any>>;
|
|
11976
|
+
/**
|
|
11977
|
+
* @description Deletes the specified survey.
|
|
11978
|
+
*
|
|
11979
|
+
* @tags surveys
|
|
11980
|
+
* @name SurveysDelete
|
|
11981
|
+
* @request POST:/surveys.delete
|
|
11982
|
+
* @secure
|
|
11983
|
+
*/
|
|
11984
|
+
surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11985
|
+
/**
|
|
11986
|
+
* @description List surveys requested by the user.
|
|
11987
|
+
*
|
|
11988
|
+
* @tags surveys
|
|
11989
|
+
* @name SurveysList
|
|
11990
|
+
* @request GET:/surveys.list
|
|
11991
|
+
* @secure
|
|
11992
|
+
*/
|
|
11993
|
+
surveysList: (query?: {
|
|
11994
|
+
/**
|
|
11995
|
+
* Filters for surveys created by any of these users.
|
|
11996
|
+
* @example ["DEVU-12345"]
|
|
11997
|
+
*/
|
|
11998
|
+
created_by?: string[];
|
|
11999
|
+
/**
|
|
12000
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
12001
|
+
* starts from the beginning.
|
|
12002
|
+
*/
|
|
12003
|
+
cursor?: string;
|
|
12004
|
+
/**
|
|
12005
|
+
* The maximum number of surveys to return. If not set, then the default
|
|
12006
|
+
* is '50'.
|
|
12007
|
+
* @format int32
|
|
12008
|
+
*/
|
|
12009
|
+
limit?: number;
|
|
12010
|
+
/**
|
|
12011
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
12012
|
+
* used.
|
|
12013
|
+
*/
|
|
12014
|
+
mode?: ListMode;
|
|
12015
|
+
/** Filters for surveys by name(s). */
|
|
12016
|
+
name?: string[];
|
|
12017
|
+
/** Fields to sort the surveys by and the direction to sort them. */
|
|
12018
|
+
sort_by?: string[];
|
|
12019
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
|
|
12020
|
+
/**
|
|
12021
|
+
* @description List surveys requested by the user.
|
|
12022
|
+
*
|
|
12023
|
+
* @tags surveys
|
|
12024
|
+
* @name SurveysListPost
|
|
12025
|
+
* @request POST:/surveys.list
|
|
12026
|
+
* @secure
|
|
12027
|
+
*/
|
|
12028
|
+
surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
|
|
12029
|
+
/**
|
|
12030
|
+
* @description List survey responses requested by the user.
|
|
12031
|
+
*
|
|
12032
|
+
* @tags surveys
|
|
12033
|
+
* @name SurveysResponsesList
|
|
12034
|
+
* @request GET:/surveys.responses.list
|
|
12035
|
+
* @secure
|
|
12036
|
+
*/
|
|
12037
|
+
surveysResponsesList: (query?: {
|
|
12038
|
+
/**
|
|
12039
|
+
* Filters for survey responses created by any of these users.
|
|
12040
|
+
* @example ["DEVU-12345"]
|
|
12041
|
+
*/
|
|
12042
|
+
created_by?: string[];
|
|
12043
|
+
/**
|
|
12044
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
12045
|
+
* starts from the beginning.
|
|
12046
|
+
*/
|
|
12047
|
+
cursor?: string;
|
|
12048
|
+
/**
|
|
12049
|
+
* The maximum number of survey responses to return. If not set, then
|
|
12050
|
+
* the default is '50'.
|
|
12051
|
+
* @format int32
|
|
12052
|
+
*/
|
|
12053
|
+
limit?: number;
|
|
12054
|
+
/**
|
|
12055
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
12056
|
+
* used.
|
|
12057
|
+
*/
|
|
12058
|
+
mode?: ListMode;
|
|
12059
|
+
/**
|
|
12060
|
+
* Filters for survey responses created for the objects.
|
|
12061
|
+
* @example ["ACC-12345"]
|
|
12062
|
+
*/
|
|
12063
|
+
objects?: string[];
|
|
12064
|
+
/**
|
|
12065
|
+
* Fields to sort the survey responses by and the direction to sort
|
|
12066
|
+
* them.
|
|
12067
|
+
*/
|
|
12068
|
+
sort_by?: string[];
|
|
12069
|
+
/** Filters for survey responses for the provided survey IDs. */
|
|
12070
|
+
surveys?: string[];
|
|
12071
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
|
|
12072
|
+
/**
|
|
12073
|
+
* @description List survey responses requested by the user.
|
|
12074
|
+
*
|
|
12075
|
+
* @tags surveys
|
|
12076
|
+
* @name SurveysResponsesListPost
|
|
12077
|
+
* @request POST:/surveys.responses.list
|
|
12078
|
+
* @secure
|
|
12079
|
+
*/
|
|
12080
|
+
surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
|
|
12081
|
+
/**
|
|
12082
|
+
* @description Sends a survey on the specified channels.
|
|
12083
|
+
*
|
|
12084
|
+
* @tags surveys
|
|
12085
|
+
* @name SurveysSend
|
|
12086
|
+
* @request POST:/surveys.send
|
|
12087
|
+
* @secure
|
|
12088
|
+
*/
|
|
12089
|
+
surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12090
|
+
/**
|
|
12091
|
+
* @description Submits a user response to a survey, which is defined by the survey ID.
|
|
12092
|
+
*
|
|
12093
|
+
* @tags surveys
|
|
12094
|
+
* @name SurveysSubmit
|
|
12095
|
+
* @request POST:/surveys.submit
|
|
12096
|
+
* @secure
|
|
12097
|
+
*/
|
|
12098
|
+
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
9758
12099
|
/**
|
|
9759
12100
|
* @description Lists system users within your organization.
|
|
9760
12101
|
*
|
|
@@ -9922,6 +12263,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9922
12263
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
9923
12264
|
*/
|
|
9924
12265
|
id: string;
|
|
12266
|
+
/**
|
|
12267
|
+
* If set, then gets the entry with the given external reference for the
|
|
12268
|
+
* provided entry ID's timeline.
|
|
12269
|
+
*/
|
|
12270
|
+
external_ref?: string;
|
|
9925
12271
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
9926
12272
|
/**
|
|
9927
12273
|
* @description Gets an entry on an object's timeline.
|
|
@@ -9999,6 +12345,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9999
12345
|
* @secure
|
|
10000
12346
|
*/
|
|
10001
12347
|
timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
|
|
12348
|
+
/**
|
|
12349
|
+
* @description Allows publishing of events (example from plug widget).
|
|
12350
|
+
*
|
|
12351
|
+
* @tags event-source
|
|
12352
|
+
* @name TrackEventsPublish
|
|
12353
|
+
* @request POST:/track-events.publish
|
|
12354
|
+
* @secure
|
|
12355
|
+
*/
|
|
12356
|
+
trackEventsPublish: (data: TrackEventsPublishRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12357
|
+
/**
|
|
12358
|
+
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
12359
|
+
*
|
|
12360
|
+
* @tags product-usage
|
|
12361
|
+
* @name UomsCount
|
|
12362
|
+
* @request GET:/uoms.count
|
|
12363
|
+
* @secure
|
|
12364
|
+
*/
|
|
12365
|
+
uomsCount: (query?: {
|
|
12366
|
+
/** List of aggregation types for filtering list of UOMs. */
|
|
12367
|
+
aggregation_types?: AggregationDetailAggregationType[];
|
|
12368
|
+
/**
|
|
12369
|
+
* List of Unit of Measurement (UOM) DONs to be used in filtering
|
|
12370
|
+
* complete list of UOMs defined in a Dev Org.
|
|
12371
|
+
*/
|
|
12372
|
+
ids?: string[];
|
|
12373
|
+
/** List of metric names for filtering list of UOMs. */
|
|
12374
|
+
metric_names?: string[];
|
|
12375
|
+
/**
|
|
12376
|
+
* List of part IDs for filtering list of UOMs.
|
|
12377
|
+
* @example ["PROD-12345"]
|
|
12378
|
+
*/
|
|
12379
|
+
part_ids?: string[];
|
|
12380
|
+
/**
|
|
12381
|
+
* List of product IDs for filtering list of UOMs.
|
|
12382
|
+
* @example ["PROD-12345"]
|
|
12383
|
+
*/
|
|
12384
|
+
product_ids?: string[];
|
|
12385
|
+
/** List of unit types for filtering list of UOMs. */
|
|
12386
|
+
unit_types?: UnitType[];
|
|
12387
|
+
}, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
|
|
12388
|
+
/**
|
|
12389
|
+
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
12390
|
+
*
|
|
12391
|
+
* @tags product-usage
|
|
12392
|
+
* @name UomsCountPost
|
|
12393
|
+
* @request POST:/uoms.count
|
|
12394
|
+
* @secure
|
|
12395
|
+
*/
|
|
12396
|
+
uomsCountPost: (data: UomsCountRequest, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
|
|
10002
12397
|
/**
|
|
10003
12398
|
* @description Creates a Unit of Measurement on a part.
|
|
10004
12399
|
*
|
|
@@ -10236,6 +12631,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10236
12631
|
* @example ["REV-AbCdEfGh"]
|
|
10237
12632
|
*/
|
|
10238
12633
|
'issue.rev_orgs'?: string[];
|
|
12634
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
12635
|
+
'issue.subtype'?: string[];
|
|
10239
12636
|
/**
|
|
10240
12637
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
10241
12638
|
* @example ["ACC-12345"]
|
|
@@ -10243,6 +12640,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10243
12640
|
'opportunity.account'?: string[];
|
|
10244
12641
|
/** Filters for opportunities with any of the provided contacts. */
|
|
10245
12642
|
'opportunity.contacts'?: string[];
|
|
12643
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
12644
|
+
'opportunity.subtype'?: string[];
|
|
10246
12645
|
/**
|
|
10247
12646
|
* Filters for work owned by any of these users.
|
|
10248
12647
|
* @example ["DEVU-12345"]
|
|
@@ -10257,6 +12656,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10257
12656
|
sort_by?: string[];
|
|
10258
12657
|
/** Filters for records in the provided stage(s) by name. */
|
|
10259
12658
|
'stage.name'?: string[];
|
|
12659
|
+
/** Filters for issues that are staged. */
|
|
12660
|
+
'staged_info.is_staged'?: boolean;
|
|
12661
|
+
/** Filters for works with selected sync statuses. */
|
|
12662
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
12663
|
+
/** Filters for works modified with selected sync units. */
|
|
12664
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
12665
|
+
/** Filters for works with selected sync statuses. */
|
|
12666
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
12667
|
+
/** Filters for works modified with selected sync units. */
|
|
12668
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
12669
|
+
/** Filters for issues synced from this specific origin system. */
|
|
12670
|
+
'sync_metadata.origin_system'?: string[];
|
|
10260
12671
|
/**
|
|
10261
12672
|
* Filters for work with any of the provided tags.
|
|
10262
12673
|
* @example ["TAG-12345"]
|
|
@@ -10282,6 +12693,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10282
12693
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
10283
12694
|
/** Filters for tickets with any of the provided source channels. */
|
|
10284
12695
|
'ticket.source_channel'?: string[];
|
|
12696
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
12697
|
+
'ticket.subtype'?: string[];
|
|
10285
12698
|
/** Filters for work of the provided types. */
|
|
10286
12699
|
type?: WorkType[];
|
|
10287
12700
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
@@ -10358,6 +12771,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10358
12771
|
* @example ["REV-AbCdEfGh"]
|
|
10359
12772
|
*/
|
|
10360
12773
|
'issue.rev_orgs'?: string[];
|
|
12774
|
+
/** Filters for issues with any of the provided subtypes. */
|
|
12775
|
+
'issue.subtype'?: string[];
|
|
10361
12776
|
/**
|
|
10362
12777
|
* The maximum number of works to return. The default is '50'.
|
|
10363
12778
|
* @format int32
|
|
@@ -10375,6 +12790,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10375
12790
|
'opportunity.account'?: string[];
|
|
10376
12791
|
/** Filters for opportunities with any of the provided contacts. */
|
|
10377
12792
|
'opportunity.contacts'?: string[];
|
|
12793
|
+
/** Filters for opportunity with any of the provided subtypes. */
|
|
12794
|
+
'opportunity.subtype'?: string[];
|
|
10378
12795
|
/**
|
|
10379
12796
|
* Filters for work owned by any of these users.
|
|
10380
12797
|
* @example ["DEVU-12345"]
|
|
@@ -10389,6 +12806,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10389
12806
|
sort_by?: string[];
|
|
10390
12807
|
/** Filters for records in the provided stage(s) by name. */
|
|
10391
12808
|
'stage.name'?: string[];
|
|
12809
|
+
/** Filters for issues that are staged. */
|
|
12810
|
+
'staged_info.is_staged'?: boolean;
|
|
12811
|
+
/** Filters for works with selected sync statuses. */
|
|
12812
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
12813
|
+
/** Filters for works modified with selected sync units. */
|
|
12814
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
12815
|
+
/** Filters for works with selected sync statuses. */
|
|
12816
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
12817
|
+
/** Filters for works modified with selected sync units. */
|
|
12818
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
12819
|
+
/** Filters for issues synced from this specific origin system. */
|
|
12820
|
+
'sync_metadata.origin_system'?: string[];
|
|
10392
12821
|
/**
|
|
10393
12822
|
* Filters for work with any of the provided tags.
|
|
10394
12823
|
* @example ["TAG-12345"]
|
|
@@ -10414,6 +12843,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10414
12843
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
10415
12844
|
/** Filters for tickets with any of the provided source channels. */
|
|
10416
12845
|
'ticket.source_channel'?: string[];
|
|
12846
|
+
/** Filters for tickets with any of the provided subtypes. */
|
|
12847
|
+
'ticket.subtype'?: string[];
|
|
10417
12848
|
/** Filters for work of the provided types. */
|
|
10418
12849
|
type?: WorkType[];
|
|
10419
12850
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|