@devrev/typescript-sdk 1.1.28 → 1.1.30
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.
|
@@ -305,6 +305,19 @@ export interface AccountsUpdateRequestArtifacts {
|
|
|
305
305
|
export interface AccountsUpdateResponse {
|
|
306
306
|
account: Account;
|
|
307
307
|
}
|
|
308
|
+
/** add-tag-with-value */
|
|
309
|
+
export interface AddTagWithValue {
|
|
310
|
+
/**
|
|
311
|
+
* The ID of the tag.
|
|
312
|
+
* @example "TAG-12345"
|
|
313
|
+
*/
|
|
314
|
+
id: string;
|
|
315
|
+
/**
|
|
316
|
+
* The value for the object's association with the tag. If specified,
|
|
317
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
318
|
+
*/
|
|
319
|
+
value?: string;
|
|
320
|
+
}
|
|
308
321
|
/**
|
|
309
322
|
* aggregated-schema
|
|
310
323
|
* List of custom fields from multiple source fragments.
|
|
@@ -409,7 +422,8 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
409
422
|
export interface ArchetypeMetricTarget {
|
|
410
423
|
/**
|
|
411
424
|
* If true, the schedule attached to this metric is out of schedule at
|
|
412
|
-
* the time of the query.
|
|
425
|
+
* the time of the query. It is not set for metrics in *completed*
|
|
426
|
+
* stage.
|
|
413
427
|
*/
|
|
414
428
|
is_out_of_schedule?: boolean;
|
|
415
429
|
metric_definition: MetricDefinitionSummary;
|
|
@@ -437,6 +451,10 @@ export interface ArchetypeMetricTarget {
|
|
|
437
451
|
export type Article = AtomBase & {
|
|
438
452
|
/** Details of the parts relevant to the article. */
|
|
439
453
|
applies_to_parts: PartSummary[];
|
|
454
|
+
/** Type of the article. */
|
|
455
|
+
article_type?: ArticleType;
|
|
456
|
+
/** Users that authored the article. */
|
|
457
|
+
authored_by?: UserSummary[];
|
|
440
458
|
/** Description of the article. */
|
|
441
459
|
description?: string;
|
|
442
460
|
/** Artifacts containing the extracted content. */
|
|
@@ -451,11 +469,15 @@ export type Article = AtomBase & {
|
|
|
451
469
|
* @format int32
|
|
452
470
|
*/
|
|
453
471
|
num_upvotes?: number;
|
|
472
|
+
/** The users that own the article. */
|
|
473
|
+
owned_by: UserSummary[];
|
|
454
474
|
parent?: DirectorySummary;
|
|
455
475
|
/** Rank of the article. */
|
|
456
476
|
rank?: string;
|
|
457
477
|
/** Resource details. */
|
|
458
478
|
resource?: Resource;
|
|
479
|
+
/** The properties of an enum value. */
|
|
480
|
+
scope?: EnumValue;
|
|
459
481
|
/** Title of the article. */
|
|
460
482
|
title?: string;
|
|
461
483
|
};
|
|
@@ -477,6 +499,11 @@ export type ArticleSummary = AtomBaseSummary & {
|
|
|
477
499
|
/** Title of the article. */
|
|
478
500
|
title?: string;
|
|
479
501
|
};
|
|
502
|
+
/** Type of the article. */
|
|
503
|
+
export declare enum ArticleType {
|
|
504
|
+
Article = "article",
|
|
505
|
+
ContentBlock = "content_block"
|
|
506
|
+
}
|
|
480
507
|
/** articles-count-request */
|
|
481
508
|
export interface ArticlesCountRequest {
|
|
482
509
|
/** The ancestor directory of the articles. */
|
|
@@ -486,6 +513,11 @@ export interface ArticlesCountRequest {
|
|
|
486
513
|
* @example ["PROD-12345"]
|
|
487
514
|
*/
|
|
488
515
|
applies_to_parts?: string[];
|
|
516
|
+
/**
|
|
517
|
+
* Filter for the type of articles. If this is not provided, then
|
|
518
|
+
* articles that are not content blocks are returned.
|
|
519
|
+
*/
|
|
520
|
+
article_type?: ArticleType[];
|
|
489
521
|
/**
|
|
490
522
|
* Filters for articles authored by any of the provided users.
|
|
491
523
|
* @example ["DEVU-12345"]
|
|
@@ -506,6 +538,11 @@ export interface ArticlesCountRequest {
|
|
|
506
538
|
* @example ["DEVU-12345"]
|
|
507
539
|
*/
|
|
508
540
|
owned_by?: string[];
|
|
541
|
+
/**
|
|
542
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
543
|
+
* only external articles are returned.
|
|
544
|
+
*/
|
|
545
|
+
scope?: number[];
|
|
509
546
|
/** Filter for articles based on intended audience. */
|
|
510
547
|
shared_with?: SharedWithMembershipFilter[];
|
|
511
548
|
}
|
|
@@ -529,11 +566,23 @@ export interface ArticlesCreateRequest {
|
|
|
529
566
|
* @example ["PROD-12345"]
|
|
530
567
|
*/
|
|
531
568
|
applies_to_parts: string[];
|
|
569
|
+
/** Type of the article. */
|
|
570
|
+
article_type?: ArticleType;
|
|
532
571
|
/**
|
|
533
572
|
* The authors of the article.
|
|
534
573
|
* @example ["DEVU-12345"]
|
|
535
574
|
*/
|
|
536
575
|
authored_by?: string[];
|
|
576
|
+
/** Application-defined custom fields. */
|
|
577
|
+
custom_fields?: object;
|
|
578
|
+
/**
|
|
579
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
580
|
+
* custom field must be specified, otherwise a bad request error is
|
|
581
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
582
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
583
|
+
* specifier, it remains unmodified.
|
|
584
|
+
*/
|
|
585
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
537
586
|
/** Description for the article. */
|
|
538
587
|
description?: string;
|
|
539
588
|
/**
|
|
@@ -557,6 +606,11 @@ export interface ArticlesCreateRequest {
|
|
|
557
606
|
*/
|
|
558
607
|
published_at?: string;
|
|
559
608
|
resource: ArticlesCreateRequestResource;
|
|
609
|
+
/**
|
|
610
|
+
* The scope of the article.
|
|
611
|
+
* @format int64
|
|
612
|
+
*/
|
|
613
|
+
scope?: number;
|
|
560
614
|
/** Information about the role the member receives due to the share. */
|
|
561
615
|
shared_with?: SetSharedWithMembership[];
|
|
562
616
|
/** Status of the article. */
|
|
@@ -626,6 +680,11 @@ export interface ArticlesListRequest {
|
|
|
626
680
|
* @example ["PROD-12345"]
|
|
627
681
|
*/
|
|
628
682
|
applies_to_parts?: string[];
|
|
683
|
+
/**
|
|
684
|
+
* Filter for the type of articles. If this is not provided, then
|
|
685
|
+
* articles that are not content blocks are returned.
|
|
686
|
+
*/
|
|
687
|
+
article_type?: ArticleType[];
|
|
629
688
|
/**
|
|
630
689
|
* Filters for articles authored by any of the provided users.
|
|
631
690
|
* @example ["DEVU-12345"]
|
|
@@ -664,6 +723,11 @@ export interface ArticlesListRequest {
|
|
|
664
723
|
* @example ["DEVU-12345"]
|
|
665
724
|
*/
|
|
666
725
|
owned_by?: string[];
|
|
726
|
+
/**
|
|
727
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
728
|
+
* only external articles are returned.
|
|
729
|
+
*/
|
|
730
|
+
scope?: number[];
|
|
667
731
|
/** Filter for articles based on intended audience. */
|
|
668
732
|
shared_with?: SharedWithMembershipFilter[];
|
|
669
733
|
}
|
|
@@ -699,6 +763,16 @@ export interface ArticlesUpdateRequest {
|
|
|
699
763
|
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
700
764
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
701
765
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
766
|
+
/** Application-defined custom fields. */
|
|
767
|
+
custom_fields?: object;
|
|
768
|
+
/**
|
|
769
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
770
|
+
* custom field must be specified, otherwise a bad request error is
|
|
771
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
772
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
773
|
+
* specifier, it remains unmodified.
|
|
774
|
+
*/
|
|
775
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
702
776
|
/**
|
|
703
777
|
* Updated description of the article object, or unchanged if not
|
|
704
778
|
* provided.
|
|
@@ -972,7 +1046,7 @@ export interface AtomBaseSummary {
|
|
|
972
1046
|
id: string;
|
|
973
1047
|
}
|
|
974
1048
|
/** atom-summary */
|
|
975
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1049
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
976
1050
|
type: AtomType;
|
|
977
1051
|
};
|
|
978
1052
|
export declare enum AtomType {
|
|
@@ -997,6 +1071,7 @@ export declare enum AtomType {
|
|
|
997
1071
|
Task = "task",
|
|
998
1072
|
TenantFragment = "tenant_fragment",
|
|
999
1073
|
Ticket = "ticket",
|
|
1074
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
1000
1075
|
TimelineComment = "timeline_comment",
|
|
1001
1076
|
Webhook = "webhook"
|
|
1002
1077
|
}
|
|
@@ -1006,6 +1081,11 @@ export declare enum AtomType {
|
|
|
1006
1081
|
* authentication connection that is set up for a Dev organization.
|
|
1007
1082
|
*/
|
|
1008
1083
|
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1084
|
+
/**
|
|
1085
|
+
* Defines the type for the authentication connection. The configuration
|
|
1086
|
+
* for each authentication connection will depend on the type value.
|
|
1087
|
+
*/
|
|
1088
|
+
type: AuthConnectionType;
|
|
1009
1089
|
/**
|
|
1010
1090
|
* Display name of the authentication connection. This name will be
|
|
1011
1091
|
* visible to all the users when they sign in to this Dev
|
|
@@ -1021,11 +1101,6 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1021
1101
|
enabled?: boolean;
|
|
1022
1102
|
/** ID of the authentication connection. */
|
|
1023
1103
|
id: string;
|
|
1024
|
-
/**
|
|
1025
|
-
* Defines the type for the authentication connection. The configuration
|
|
1026
|
-
* for each authentication connection will depend on the type value.
|
|
1027
|
-
*/
|
|
1028
|
-
type: AuthConnectionType;
|
|
1029
1104
|
};
|
|
1030
1105
|
/**
|
|
1031
1106
|
* auth-connection-options-azure-ad
|
|
@@ -1160,11 +1235,11 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
1160
1235
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
1161
1236
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
1162
1237
|
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
1238
|
+
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
1163
1239
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
1164
1240
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
1165
1241
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
1166
1242
|
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
1167
|
-
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
1168
1243
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
1169
1244
|
}
|
|
1170
1245
|
/** The type of the issued token. Bearer is the only supported token type. */
|
|
@@ -1178,6 +1253,11 @@ export declare enum AuthTokenTokenType {
|
|
|
1178
1253
|
export interface AuthTokensAccountTraits {
|
|
1179
1254
|
/** The display name of the account. */
|
|
1180
1255
|
display_name?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* List of company's domain names on accounts. Example -
|
|
1258
|
+
* ['devrev.ai'].
|
|
1259
|
+
*/
|
|
1260
|
+
domains?: string[];
|
|
1181
1261
|
}
|
|
1182
1262
|
/**
|
|
1183
1263
|
* auth-tokens-create-request
|
|
@@ -1329,7 +1409,10 @@ export interface AuthTokensOrgTraits {
|
|
|
1329
1409
|
description?: string;
|
|
1330
1410
|
/** The display name of the Rev org. */
|
|
1331
1411
|
display_name?: string;
|
|
1332
|
-
/**
|
|
1412
|
+
/**
|
|
1413
|
+
* The domain of the Rev org.
|
|
1414
|
+
* @deprecated
|
|
1415
|
+
*/
|
|
1333
1416
|
domain?: string;
|
|
1334
1417
|
/** Phone numbers of the Rev org. */
|
|
1335
1418
|
phone_numbers?: string[];
|
|
@@ -1346,7 +1429,10 @@ export interface AuthTokensRevInfo {
|
|
|
1346
1429
|
account_ref?: string;
|
|
1347
1430
|
/** Carries account info. */
|
|
1348
1431
|
account_traits?: AuthTokensAccountTraits;
|
|
1349
|
-
/**
|
|
1432
|
+
/**
|
|
1433
|
+
* An identifier which uniquely identifies a Rev org.
|
|
1434
|
+
* @deprecated
|
|
1435
|
+
*/
|
|
1350
1436
|
org_ref?: string;
|
|
1351
1437
|
/** Carries Rev org info. */
|
|
1352
1438
|
org_traits?: AuthTokensOrgTraits;
|
|
@@ -1504,12 +1590,12 @@ export interface ClientContextCpu {
|
|
|
1504
1590
|
* Properties of client's device to be used in track API.
|
|
1505
1591
|
*/
|
|
1506
1592
|
export interface ClientContextDevice {
|
|
1593
|
+
/** Device type, example: mobile, tablet, desktop. */
|
|
1594
|
+
type?: string;
|
|
1507
1595
|
/** Device manufacturer, example: Apple. */
|
|
1508
1596
|
manufacturer?: string;
|
|
1509
1597
|
/** Device model, example: iphone 6s. */
|
|
1510
1598
|
model?: string;
|
|
1511
|
-
/** Device type, example: mobile, tablet, desktop. */
|
|
1512
|
-
type?: string;
|
|
1513
1599
|
}
|
|
1514
1600
|
/**
|
|
1515
1601
|
* client-context-engine
|
|
@@ -1551,6 +1637,16 @@ export interface ClientContextPage {
|
|
|
1551
1637
|
export type CodeChange = AtomBase & {
|
|
1552
1638
|
/** Name of the code branch in the repo. */
|
|
1553
1639
|
branch?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Time at which the code change corresponding to this object reached
|
|
1642
|
+
* a closed or merged stage. For example, the time at which a Pull
|
|
1643
|
+
* Request was either closed without merging or successfully merged.
|
|
1644
|
+
* @format date-time
|
|
1645
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1646
|
+
*/
|
|
1647
|
+
closed_date?: string;
|
|
1648
|
+
/** Commit ID of the merged commit in the target branch. */
|
|
1649
|
+
commit_id?: string;
|
|
1554
1650
|
/** Detailed description of the contents of this change. */
|
|
1555
1651
|
description?: string;
|
|
1556
1652
|
/** Unique external identifier for this change.e.g Pull Request URL. */
|
|
@@ -1561,6 +1657,8 @@ export type CodeChange = AtomBase & {
|
|
|
1561
1657
|
repo_url?: string;
|
|
1562
1658
|
/** Source of the code change object. */
|
|
1563
1659
|
source?: CodeChangeSource;
|
|
1660
|
+
/** Name of the target branch in the repo. */
|
|
1661
|
+
target_branch?: string;
|
|
1564
1662
|
/** Title describing in brief the contents of this change. */
|
|
1565
1663
|
title?: string;
|
|
1566
1664
|
/** Details of lines of code in this code change. */
|
|
@@ -1572,7 +1670,18 @@ export declare enum CodeChangeSource {
|
|
|
1572
1670
|
Github = "github"
|
|
1573
1671
|
}
|
|
1574
1672
|
/** code-changes-create-request */
|
|
1575
|
-
export
|
|
1673
|
+
export interface CodeChangesCreateRequest {
|
|
1674
|
+
/** Application-defined custom fields. */
|
|
1675
|
+
custom_fields?: object;
|
|
1676
|
+
/**
|
|
1677
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1678
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1679
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1680
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1681
|
+
* specifier, it remains unmodified.
|
|
1682
|
+
*/
|
|
1683
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1684
|
+
}
|
|
1576
1685
|
/** code-changes-create-response */
|
|
1577
1686
|
export interface CodeChangesCreateResponse {
|
|
1578
1687
|
code_change: CodeChange;
|
|
@@ -1636,6 +1745,16 @@ export interface CodeChangesListResponse {
|
|
|
1636
1745
|
}
|
|
1637
1746
|
/** code-changes-update-request */
|
|
1638
1747
|
export interface CodeChangesUpdateRequest {
|
|
1748
|
+
/** Application-defined custom fields. */
|
|
1749
|
+
custom_fields?: object;
|
|
1750
|
+
/**
|
|
1751
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1752
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1753
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1754
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1755
|
+
* specifier, it remains unmodified.
|
|
1756
|
+
*/
|
|
1757
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1639
1758
|
/** The ID of the code change object to be updated. */
|
|
1640
1759
|
id: string;
|
|
1641
1760
|
}
|
|
@@ -1646,9 +1765,131 @@ export interface CodeChangesUpdateResponse {
|
|
|
1646
1765
|
/** comment-search-summary */
|
|
1647
1766
|
export interface CommentSearchSummary {
|
|
1648
1767
|
comment?: TimelineCommentSummary;
|
|
1768
|
+
created_by?: UserSummary;
|
|
1769
|
+
/**
|
|
1770
|
+
* Timestamp when the comment was created.
|
|
1771
|
+
* @format date-time
|
|
1772
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1773
|
+
*/
|
|
1774
|
+
created_date?: string;
|
|
1775
|
+
/** The object that the Timeline entry belongs to. */
|
|
1776
|
+
object?: string;
|
|
1777
|
+
/** Display panels for the comment entry. */
|
|
1778
|
+
panels?: TimelineEntryPanel[];
|
|
1779
|
+
/** The objects referenced in the comment. */
|
|
1780
|
+
references?: AtomSummary[];
|
|
1649
1781
|
/** Text snippet where the search hit occurred. */
|
|
1650
1782
|
snippet?: string;
|
|
1651
1783
|
}
|
|
1784
|
+
/** content-template */
|
|
1785
|
+
export interface ContentTemplate {
|
|
1786
|
+
type: ContentTemplateType;
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* content-template-create-request
|
|
1790
|
+
* The request to create a new content template.
|
|
1791
|
+
*/
|
|
1792
|
+
export type ContentTemplateCreateRequest = ContentTemplateCreateRequestNotificationContentTemplate & {
|
|
1793
|
+
type: ContentTemplateType;
|
|
1794
|
+
/**
|
|
1795
|
+
* Input fields schema. The fields will be used to replace variables
|
|
1796
|
+
* present in the content template.
|
|
1797
|
+
*/
|
|
1798
|
+
input_fields_schema?: SchemaFieldDescriptor[];
|
|
1799
|
+
/**
|
|
1800
|
+
* The name of the content template. The name must be unique for each
|
|
1801
|
+
* creator of the content template.
|
|
1802
|
+
*/
|
|
1803
|
+
name: string;
|
|
1804
|
+
};
|
|
1805
|
+
/** content-template-create-request-notification-content-template */
|
|
1806
|
+
export interface ContentTemplateCreateRequestNotificationContentTemplate {
|
|
1807
|
+
/**
|
|
1808
|
+
* Default notification template per language. Only one is permitted
|
|
1809
|
+
* per language. These will be used to replace the notification
|
|
1810
|
+
* content on basis of language preferences of the user. Default is
|
|
1811
|
+
* EN(US).
|
|
1812
|
+
*/
|
|
1813
|
+
defaults: ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate[];
|
|
1814
|
+
}
|
|
1815
|
+
/** content-template-create-request-notification-content-template-default-notification-content-template */
|
|
1816
|
+
export interface ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate {
|
|
1817
|
+
/**
|
|
1818
|
+
* Body for the notification. In order to use fields from input fields
|
|
1819
|
+
* schema, use {field_name} in the body.
|
|
1820
|
+
*/
|
|
1821
|
+
body: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* Title for the notification. In order to use fields from input
|
|
1824
|
+
* fields schema, use {field_name} in the title.
|
|
1825
|
+
*/
|
|
1826
|
+
title: string;
|
|
1827
|
+
}
|
|
1828
|
+
/** content-template-create-response */
|
|
1829
|
+
export interface ContentTemplateCreateResponse {
|
|
1830
|
+
content_template: ContentTemplate;
|
|
1831
|
+
}
|
|
1832
|
+
/** content-template-get-request */
|
|
1833
|
+
export interface ContentTemplateGetRequest {
|
|
1834
|
+
/** The content template's ID. */
|
|
1835
|
+
id: string;
|
|
1836
|
+
}
|
|
1837
|
+
/** content-template-get-response */
|
|
1838
|
+
export interface ContentTemplateGetResponse {
|
|
1839
|
+
content_template: ContentTemplate;
|
|
1840
|
+
}
|
|
1841
|
+
/** content-template-list-request */
|
|
1842
|
+
export interface ContentTemplateListRequest {
|
|
1843
|
+
/** Filters for content template of the provided types. */
|
|
1844
|
+
type?: ContentTemplateType[];
|
|
1845
|
+
/**
|
|
1846
|
+
* Filters for content template created by any of these users.
|
|
1847
|
+
* @example ["DEVU-12345"]
|
|
1848
|
+
*/
|
|
1849
|
+
created_by?: string[];
|
|
1850
|
+
/**
|
|
1851
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1852
|
+
* iteration starts from the beginning.
|
|
1853
|
+
*/
|
|
1854
|
+
cursor?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The maximum number of content template to return. The default is
|
|
1857
|
+
* '50'.
|
|
1858
|
+
* @format int32
|
|
1859
|
+
*/
|
|
1860
|
+
limit?: number;
|
|
1861
|
+
/**
|
|
1862
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1863
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1864
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1865
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1866
|
+
* always be returned in the specified sort-by order.
|
|
1867
|
+
*/
|
|
1868
|
+
mode?: ListMode;
|
|
1869
|
+
/** Filters for content template based on name. */
|
|
1870
|
+
name?: string[];
|
|
1871
|
+
/**
|
|
1872
|
+
* Fields to sort the content template by and the direction to sort
|
|
1873
|
+
* them.
|
|
1874
|
+
*/
|
|
1875
|
+
sort_by?: string[];
|
|
1876
|
+
}
|
|
1877
|
+
/** content-template-list-response */
|
|
1878
|
+
export interface ContentTemplateListResponse {
|
|
1879
|
+
/** The list of content templates. */
|
|
1880
|
+
content_template: ContentTemplate[];
|
|
1881
|
+
/**
|
|
1882
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1883
|
+
* sort order. If not set, then no later elements exist.
|
|
1884
|
+
*/
|
|
1885
|
+
next_cursor?: string;
|
|
1886
|
+
/**
|
|
1887
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1888
|
+
* sort order. If not set, then no prior elements exist.
|
|
1889
|
+
*/
|
|
1890
|
+
prev_cursor?: string;
|
|
1891
|
+
}
|
|
1892
|
+
export type ContentTemplateType = string;
|
|
1652
1893
|
/** conversation */
|
|
1653
1894
|
export type Conversation = AtomBase & {
|
|
1654
1895
|
/** Description of the conversation object. */
|
|
@@ -1700,6 +1941,7 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
1700
1941
|
* The request to create a new conversation.
|
|
1701
1942
|
*/
|
|
1702
1943
|
export interface ConversationsCreateRequest {
|
|
1944
|
+
type: ConversationsCreateRequestTypeValue;
|
|
1703
1945
|
/** Description for the conversation. */
|
|
1704
1946
|
description?: string;
|
|
1705
1947
|
/** The group that the conversation is associated with. */
|
|
@@ -1722,7 +1964,6 @@ export interface ConversationsCreateRequest {
|
|
|
1722
1964
|
tags?: SetTagWithValue[];
|
|
1723
1965
|
/** The title for the conversation. */
|
|
1724
1966
|
title?: string;
|
|
1725
|
-
type: ConversationsCreateRequestTypeValue;
|
|
1726
1967
|
/** The IDs of user sessions associated with the conversation. */
|
|
1727
1968
|
user_sessions?: string[];
|
|
1728
1969
|
}
|
|
@@ -2063,6 +2304,29 @@ export interface CreateOrgScheduleInterval {
|
|
|
2063
2304
|
*/
|
|
2064
2305
|
to?: string;
|
|
2065
2306
|
}
|
|
2307
|
+
/**
|
|
2308
|
+
* create-stage
|
|
2309
|
+
* Create object for stage.
|
|
2310
|
+
*/
|
|
2311
|
+
export interface CreateStage {
|
|
2312
|
+
/** Notes relevant to the stage */
|
|
2313
|
+
notes?: string;
|
|
2314
|
+
/** DON of the stage. */
|
|
2315
|
+
stage: string;
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* create-tag-with-value
|
|
2319
|
+
* Create object for tag_summary.
|
|
2320
|
+
*/
|
|
2321
|
+
export interface CreateTagWithValue {
|
|
2322
|
+
/**
|
|
2323
|
+
* ID of the referenced tag
|
|
2324
|
+
* @example "TAG-12345"
|
|
2325
|
+
*/
|
|
2326
|
+
tag_id: string;
|
|
2327
|
+
/** Value associated with the tag for the object. */
|
|
2328
|
+
value?: string;
|
|
2329
|
+
}
|
|
2066
2330
|
/** create-weekly-org-schedule-interval */
|
|
2067
2331
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
2068
2332
|
/**
|
|
@@ -2204,6 +2468,7 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2204
2468
|
}
|
|
2205
2469
|
/** custom-schema-fragments-set-request */
|
|
2206
2470
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2471
|
+
type: CustomSchemaFragmentsSetRequestType;
|
|
2207
2472
|
/** List of conditions for this fragment. */
|
|
2208
2473
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2209
2474
|
/** List of field names which are being dropped. */
|
|
@@ -2218,7 +2483,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
2218
2483
|
is_custom_leaf_type?: boolean;
|
|
2219
2484
|
/** The leaf type this fragment applies to. */
|
|
2220
2485
|
leaf_type: string;
|
|
2221
|
-
type: CustomSchemaFragmentsSetRequestType;
|
|
2222
2486
|
};
|
|
2223
2487
|
/** custom-schema-fragments-set-request-app-fragment */
|
|
2224
2488
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
@@ -2277,7 +2541,21 @@ export interface CustomSchemaSpec {
|
|
|
2277
2541
|
validate_required_fields?: boolean;
|
|
2278
2542
|
}
|
|
2279
2543
|
/** custom-stage */
|
|
2280
|
-
export type CustomStage = AtomBase
|
|
2544
|
+
export type CustomStage = AtomBase & {
|
|
2545
|
+
/** The human readable name of the state. */
|
|
2546
|
+
name?: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Ordinal used to sort/group stages.
|
|
2549
|
+
* @format int32
|
|
2550
|
+
*/
|
|
2551
|
+
ordinal?: number;
|
|
2552
|
+
state?: CustomStateSummary;
|
|
2553
|
+
};
|
|
2554
|
+
/** custom-stage-summary */
|
|
2555
|
+
export type CustomStageSummary = AtomBaseSummary & {
|
|
2556
|
+
/** The human readable name of the state. */
|
|
2557
|
+
name?: string;
|
|
2558
|
+
};
|
|
2281
2559
|
/** custom-stages-create-request */
|
|
2282
2560
|
export interface CustomStagesCreateRequest {
|
|
2283
2561
|
/**
|
|
@@ -2356,7 +2634,22 @@ export interface CustomStagesUpdateResponse {
|
|
|
2356
2634
|
custom_stage: CustomStage;
|
|
2357
2635
|
}
|
|
2358
2636
|
/** custom-state */
|
|
2359
|
-
export type CustomState = AtomBase
|
|
2637
|
+
export type CustomState = AtomBase & {
|
|
2638
|
+
/** True if this is a final state. */
|
|
2639
|
+
is_final?: boolean;
|
|
2640
|
+
/** The human readable name of the state. */
|
|
2641
|
+
name?: string;
|
|
2642
|
+
/**
|
|
2643
|
+
* Ordinal used to identify system states.
|
|
2644
|
+
* @format int32
|
|
2645
|
+
*/
|
|
2646
|
+
ordinal?: number;
|
|
2647
|
+
};
|
|
2648
|
+
/** custom-state-summary */
|
|
2649
|
+
export type CustomStateSummary = AtomBaseSummary & {
|
|
2650
|
+
/** The human readable name of the state. */
|
|
2651
|
+
name?: string;
|
|
2652
|
+
};
|
|
2360
2653
|
/** custom-states-create-request */
|
|
2361
2654
|
export interface CustomStatesCreateRequest {
|
|
2362
2655
|
/** Whether this is a final state. */
|
|
@@ -2523,6 +2816,11 @@ export declare enum DateTimePresetType {
|
|
|
2523
2816
|
* Request to create a new enterprise authentication connection.
|
|
2524
2817
|
*/
|
|
2525
2818
|
export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
|
|
2819
|
+
/**
|
|
2820
|
+
* Defines the type for the authentication connection. Different types of
|
|
2821
|
+
* authentication connections have different configuration parameters.
|
|
2822
|
+
*/
|
|
2823
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
2526
2824
|
/**
|
|
2527
2825
|
* Display name of the authentication connection. This name will be
|
|
2528
2826
|
* visible to all the users when they sign in to this Dev
|
|
@@ -2530,11 +2828,6 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2530
2828
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
2531
2829
|
*/
|
|
2532
2830
|
display_name?: string;
|
|
2533
|
-
/**
|
|
2534
|
-
* Defines the type for the authentication connection. Different types of
|
|
2535
|
-
* authentication connections have different configuration parameters.
|
|
2536
|
-
*/
|
|
2537
|
-
type: DevOrgAuthConnectionsCreateRequestType;
|
|
2538
2831
|
};
|
|
2539
2832
|
/**
|
|
2540
2833
|
* Defines the type for the authentication connection. Different types of
|
|
@@ -2617,6 +2910,12 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
2617
2910
|
* organization.
|
|
2618
2911
|
*/
|
|
2619
2912
|
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
|
|
2913
|
+
/**
|
|
2914
|
+
* Specifies the type for the authentication connection. Different types
|
|
2915
|
+
* of authentication connections have different configuration parameters
|
|
2916
|
+
* that can be updated.
|
|
2917
|
+
*/
|
|
2918
|
+
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
2620
2919
|
/**
|
|
2621
2920
|
* New display name of the authentication connection. This name will
|
|
2622
2921
|
* be visible to all the users when they sign in to this Dev
|
|
@@ -2626,12 +2925,6 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2626
2925
|
display_name?: string;
|
|
2627
2926
|
/** ID of the authentication connection which is to be updated. */
|
|
2628
2927
|
id: string;
|
|
2629
|
-
/**
|
|
2630
|
-
* Specifies the type for the authentication connection. Different types
|
|
2631
|
-
* of authentication connections have different configuration parameters
|
|
2632
|
-
* that can be updated.
|
|
2633
|
-
*/
|
|
2634
|
-
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
2635
2928
|
};
|
|
2636
2929
|
/**
|
|
2637
2930
|
* Specifies the type for the authentication connection. Different types
|
|
@@ -2824,11 +3117,45 @@ export interface DevUsersSelfResponse {
|
|
|
2824
3117
|
export interface DevUsersSelfUpdateRequest {
|
|
2825
3118
|
/** The updated display name of the Dev user. */
|
|
2826
3119
|
display_name?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* Start date of Dev user's experience.
|
|
3122
|
+
* @format date-time
|
|
3123
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3124
|
+
*/
|
|
3125
|
+
experience_start_date?: string;
|
|
2827
3126
|
/** The updated full name of the Dev user. */
|
|
2828
3127
|
full_name?: string;
|
|
3128
|
+
/** Job history of the Dev user. */
|
|
3129
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2829
3130
|
/** Job title of the Dev User. */
|
|
2830
3131
|
job_title?: DevUserJobTitle;
|
|
2831
3132
|
}
|
|
3133
|
+
/** dev-users-update-job-history-item */
|
|
3134
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
3135
|
+
/**
|
|
3136
|
+
* Enum for the employment status of the user.
|
|
3137
|
+
* @format int64
|
|
3138
|
+
*/
|
|
3139
|
+
employment_status?: number;
|
|
3140
|
+
/**
|
|
3141
|
+
* End date of the job.
|
|
3142
|
+
* @format date-time
|
|
3143
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3144
|
+
*/
|
|
3145
|
+
end_date?: string;
|
|
3146
|
+
/** Is this the current active job for the user. */
|
|
3147
|
+
is_current?: boolean;
|
|
3148
|
+
/** The job location for the user. */
|
|
3149
|
+
location?: string;
|
|
3150
|
+
/**
|
|
3151
|
+
* Start date of the job.
|
|
3152
|
+
* @format date-time
|
|
3153
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3154
|
+
*/
|
|
3155
|
+
start_date?: string;
|
|
3156
|
+
/** The job title for the user. */
|
|
3157
|
+
title?: string;
|
|
3158
|
+
}
|
|
2832
3159
|
/**
|
|
2833
3160
|
* dev-users-update-request
|
|
2834
3161
|
* A request to update the user's information corresponding to the
|
|
@@ -2837,10 +3164,18 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
2837
3164
|
export interface DevUsersUpdateRequest {
|
|
2838
3165
|
/** The updated display name of the Dev user. */
|
|
2839
3166
|
display_name?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* Start date of Dev user's experience.
|
|
3169
|
+
* @format date-time
|
|
3170
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3171
|
+
*/
|
|
3172
|
+
experience_start_date?: string;
|
|
2840
3173
|
/** The updated full name of the Dev user. */
|
|
2841
3174
|
full_name?: string;
|
|
2842
3175
|
/** The ID for the Dev user to be updated. */
|
|
2843
3176
|
id: string;
|
|
3177
|
+
/** Job history of the Dev user. */
|
|
3178
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2844
3179
|
/** Job title of the Dev User. */
|
|
2845
3180
|
job_title?: DevUserJobTitle;
|
|
2846
3181
|
}
|
|
@@ -2926,6 +3261,8 @@ export type EngagementSummary = AtomBaseSummary;
|
|
|
2926
3261
|
/** Type of engagement. */
|
|
2927
3262
|
export declare enum EngagementType {
|
|
2928
3263
|
Call = "call",
|
|
3264
|
+
Conversation = "conversation",
|
|
3265
|
+
Custom = "custom",
|
|
2929
3266
|
Default = "default",
|
|
2930
3267
|
Email = "email",
|
|
2931
3268
|
LinkedIn = "linked_in",
|
|
@@ -2935,6 +3272,8 @@ export declare enum EngagementType {
|
|
|
2935
3272
|
}
|
|
2936
3273
|
/** engagements-count-request */
|
|
2937
3274
|
export interface EngagementsCountRequest {
|
|
3275
|
+
/** Filters for engagement of the provided types. */
|
|
3276
|
+
type?: EngagementType[];
|
|
2938
3277
|
/** Filters for meetings with the provided external_refs. */
|
|
2939
3278
|
external_ref?: string[];
|
|
2940
3279
|
/**
|
|
@@ -2947,8 +3286,6 @@ export interface EngagementsCountRequest {
|
|
|
2947
3286
|
* @example ["ACC-12345"]
|
|
2948
3287
|
*/
|
|
2949
3288
|
parent?: string[];
|
|
2950
|
-
/** Filters for engagement of the provided types. */
|
|
2951
|
-
type?: EngagementType[];
|
|
2952
3289
|
}
|
|
2953
3290
|
/** engagements-count-response */
|
|
2954
3291
|
export interface EngagementsCountResponse {
|
|
@@ -3027,6 +3364,8 @@ export interface EngagementsGetResponse {
|
|
|
3027
3364
|
}
|
|
3028
3365
|
/** engagements-list-request */
|
|
3029
3366
|
export interface EngagementsListRequest {
|
|
3367
|
+
/** Filters for engagement of the provided types. */
|
|
3368
|
+
type?: EngagementType[];
|
|
3030
3369
|
/**
|
|
3031
3370
|
* The cursor to resume iteration from. If not provided, then
|
|
3032
3371
|
* iteration starts from the beginning.
|
|
@@ -3059,8 +3398,6 @@ export interface EngagementsListRequest {
|
|
|
3059
3398
|
parent?: string[];
|
|
3060
3399
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
3061
3400
|
sort_by?: string[];
|
|
3062
|
-
/** Filters for engagement of the provided types. */
|
|
3063
|
-
type?: EngagementType[];
|
|
3064
3401
|
}
|
|
3065
3402
|
/** engagements-list-response */
|
|
3066
3403
|
export interface EngagementsListResponse {
|
|
@@ -3132,24 +3469,26 @@ export type Enhancement = PartBase;
|
|
|
3132
3469
|
export type EnhancementSummary = PartBaseSummary;
|
|
3133
3470
|
/**
|
|
3134
3471
|
* enum-value
|
|
3135
|
-
*
|
|
3472
|
+
* The properties of an enum value.
|
|
3136
3473
|
*/
|
|
3137
3474
|
export interface EnumValue {
|
|
3138
3475
|
/**
|
|
3139
|
-
*
|
|
3476
|
+
* The unique ID of the enum value.
|
|
3140
3477
|
* @format int64
|
|
3141
3478
|
*/
|
|
3142
3479
|
id: number;
|
|
3143
|
-
/**
|
|
3480
|
+
/** The display label of the enum value. */
|
|
3144
3481
|
label: string;
|
|
3145
3482
|
/**
|
|
3146
|
-
*
|
|
3483
|
+
* Used for determining the relative order of the enum value.
|
|
3147
3484
|
* @format int64
|
|
3148
3485
|
*/
|
|
3149
3486
|
ordinal: number;
|
|
3150
3487
|
}
|
|
3151
3488
|
/** error */
|
|
3152
3489
|
export interface Error {
|
|
3490
|
+
/** The error type. */
|
|
3491
|
+
type?: string;
|
|
3153
3492
|
/** Information about the error. */
|
|
3154
3493
|
message: string;
|
|
3155
3494
|
/**
|
|
@@ -3157,11 +3496,9 @@ export interface Error {
|
|
|
3157
3496
|
* @format int32
|
|
3158
3497
|
*/
|
|
3159
3498
|
status: number;
|
|
3160
|
-
/** The error type. */
|
|
3161
|
-
type?: string;
|
|
3162
3499
|
}
|
|
3163
3500
|
/** error-bad-request */
|
|
3164
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3501
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3165
3502
|
type: ErrorBadRequestType;
|
|
3166
3503
|
};
|
|
3167
3504
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -3197,6 +3534,55 @@ export interface ErrorBadRequestInvalidId {
|
|
|
3197
3534
|
/** The field whose ID is invalid. */
|
|
3198
3535
|
field_name: string;
|
|
3199
3536
|
}
|
|
3537
|
+
/** error-bad-request-merge-works-error */
|
|
3538
|
+
export interface ErrorBadRequestMergeWorksError {
|
|
3539
|
+
/** The errors encountered during the validation of the merge. */
|
|
3540
|
+
errors?: ErrorBadRequestMergeWorksErrorError[];
|
|
3541
|
+
}
|
|
3542
|
+
/** error-bad-request-merge-works-error-error */
|
|
3543
|
+
export interface ErrorBadRequestMergeWorksErrorError {
|
|
3544
|
+
already_merged?: ErrorBadRequestMergeWorksErrorErrorAlreadyMerged;
|
|
3545
|
+
closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
|
|
3546
|
+
/** The details of the error. */
|
|
3547
|
+
details: string;
|
|
3548
|
+
different_reporters?: ErrorBadRequestMergeWorksErrorErrorDifferentReporters;
|
|
3549
|
+
different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
|
|
3550
|
+
invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
|
|
3551
|
+
locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
|
|
3552
|
+
subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked';
|
|
3553
|
+
/** The ID of the work which failed the validation. */
|
|
3554
|
+
work: string;
|
|
3555
|
+
}
|
|
3556
|
+
/** error-bad-request-merge-works-error-error-already-merged */
|
|
3557
|
+
export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
|
|
3558
|
+
/** ID of the work into which the work was merged. */
|
|
3559
|
+
merged_into: string;
|
|
3560
|
+
}
|
|
3561
|
+
/** error-bad-request-merge-works-error-error-closed */
|
|
3562
|
+
export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
|
|
3563
|
+
/** error-bad-request-merge-works-error-error-different-reporters */
|
|
3564
|
+
export interface ErrorBadRequestMergeWorksErrorErrorDifferentReporters {
|
|
3565
|
+
/** The reporters of the primary work. */
|
|
3566
|
+
primary_reporters?: string[];
|
|
3567
|
+
/** The reporters of the secondary work. */
|
|
3568
|
+
secondary_reporters?: string[];
|
|
3569
|
+
}
|
|
3570
|
+
/** error-bad-request-merge-works-error-error-different-workspace */
|
|
3571
|
+
export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
|
|
3572
|
+
/** The workspace of the primary work. */
|
|
3573
|
+
primary_workspace?: string;
|
|
3574
|
+
/** The workspace of the secondary work. */
|
|
3575
|
+
secondary_workspace?: string;
|
|
3576
|
+
}
|
|
3577
|
+
/** error-bad-request-merge-works-error-error-invalid-stage-transition */
|
|
3578
|
+
export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
3579
|
+
/** The current stage of the work. */
|
|
3580
|
+
current_stage: string;
|
|
3581
|
+
/** The stage to which the transition isn't allowed. */
|
|
3582
|
+
requested_stage: string;
|
|
3583
|
+
}
|
|
3584
|
+
/** error-bad-request-merge-works-error-error-locked */
|
|
3585
|
+
export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
|
|
3200
3586
|
/** error-bad-request-missing-dependency */
|
|
3201
3587
|
export interface ErrorBadRequestMissingDependency {
|
|
3202
3588
|
/** The dependent fields. */
|
|
@@ -3240,6 +3626,7 @@ export declare enum ErrorBadRequestType {
|
|
|
3240
3626
|
InvalidEnumValue = "invalid_enum_value",
|
|
3241
3627
|
InvalidField = "invalid_field",
|
|
3242
3628
|
InvalidId = "invalid_id",
|
|
3629
|
+
MergeWorksError = "merge_works_error",
|
|
3243
3630
|
MissingDependency = "missing_dependency",
|
|
3244
3631
|
MissingRequiredField = "missing_required_field",
|
|
3245
3632
|
ParseError = "parse_error",
|
|
@@ -3304,12 +3691,12 @@ export declare enum ErrorForbiddenType {
|
|
|
3304
3691
|
}
|
|
3305
3692
|
/** error-internal-server-error */
|
|
3306
3693
|
export type ErrorInternalServerError = ErrorBase & ErrorInternalServerErrorInternalError & {
|
|
3694
|
+
type: ErrorInternalServerErrorType;
|
|
3307
3695
|
/**
|
|
3308
3696
|
* A unique ID that's generated for the error that can be used for
|
|
3309
3697
|
* inquiry.
|
|
3310
3698
|
*/
|
|
3311
3699
|
reference_id?: string;
|
|
3312
|
-
type: ErrorInternalServerErrorType;
|
|
3313
3700
|
};
|
|
3314
3701
|
/** error-internal-server-error-internal-error */
|
|
3315
3702
|
export type ErrorInternalServerErrorInternalError = object;
|
|
@@ -3336,12 +3723,12 @@ export declare enum ErrorServiceUnavailableType {
|
|
|
3336
3723
|
}
|
|
3337
3724
|
/** error-too-many-requests */
|
|
3338
3725
|
export type ErrorTooManyRequests = ErrorBase & ErrorTooManyRequestsTooManyRequests & {
|
|
3726
|
+
type: ErrorTooManyRequestsType;
|
|
3339
3727
|
/**
|
|
3340
3728
|
* The number of seconds after which the client should retry.
|
|
3341
3729
|
* @format int64
|
|
3342
3730
|
*/
|
|
3343
3731
|
retry_after?: number;
|
|
3344
|
-
type: ErrorTooManyRequestsType;
|
|
3345
3732
|
};
|
|
3346
3733
|
/** error-too-many-requests-too-many-requests */
|
|
3347
3734
|
export type ErrorTooManyRequestsTooManyRequests = object;
|
|
@@ -3368,10 +3755,12 @@ export interface EventAccountDeleted {
|
|
|
3368
3755
|
* @example "ACC-12345"
|
|
3369
3756
|
*/
|
|
3370
3757
|
id: string;
|
|
3758
|
+
old_account?: Account;
|
|
3371
3759
|
}
|
|
3372
3760
|
/** event-account-updated */
|
|
3373
3761
|
export interface EventAccountUpdated {
|
|
3374
3762
|
account: Account;
|
|
3763
|
+
old_account?: Account;
|
|
3375
3764
|
}
|
|
3376
3765
|
/** event-conversation-created */
|
|
3377
3766
|
export interface EventConversationCreated {
|
|
@@ -3394,10 +3783,51 @@ export interface EventDevUserCreated {
|
|
|
3394
3783
|
export interface EventDevUserDeleted {
|
|
3395
3784
|
/** The ID of the Dev user that was deleted. */
|
|
3396
3785
|
id: string;
|
|
3786
|
+
old_dev_user?: DevUser;
|
|
3397
3787
|
}
|
|
3398
3788
|
/** event-dev-user-updated */
|
|
3399
3789
|
export interface EventDevUserUpdated {
|
|
3400
3790
|
dev_user: DevUser;
|
|
3791
|
+
old_dev_user?: DevUser;
|
|
3792
|
+
}
|
|
3793
|
+
/** event-group-created */
|
|
3794
|
+
export interface EventGroupCreated {
|
|
3795
|
+
group: Group;
|
|
3796
|
+
}
|
|
3797
|
+
/** event-group-deleted */
|
|
3798
|
+
export interface EventGroupDeleted {
|
|
3799
|
+
/** The ID of the group that was deleted. */
|
|
3800
|
+
id: string;
|
|
3801
|
+
old_group?: Group;
|
|
3802
|
+
}
|
|
3803
|
+
/** event-group-member-added */
|
|
3804
|
+
export interface EventGroupMemberAdded {
|
|
3805
|
+
group: GroupSummary;
|
|
3806
|
+
member: UserSummary;
|
|
3807
|
+
}
|
|
3808
|
+
/** event-group-member-removed */
|
|
3809
|
+
export interface EventGroupMemberRemoved {
|
|
3810
|
+
group: GroupSummary;
|
|
3811
|
+
member: UserSummary;
|
|
3812
|
+
}
|
|
3813
|
+
/** event-group-updated */
|
|
3814
|
+
export interface EventGroupUpdated {
|
|
3815
|
+
group: Group;
|
|
3816
|
+
old_group?: Group;
|
|
3817
|
+
}
|
|
3818
|
+
/** event-link-created */
|
|
3819
|
+
export interface EventLinkCreated {
|
|
3820
|
+
link: Link;
|
|
3821
|
+
}
|
|
3822
|
+
/** event-link-deleted */
|
|
3823
|
+
export interface EventLinkDeleted {
|
|
3824
|
+
/** The ID of the link that was deleted. */
|
|
3825
|
+
id: string;
|
|
3826
|
+
}
|
|
3827
|
+
/** event-link-updated */
|
|
3828
|
+
export interface EventLinkUpdated {
|
|
3829
|
+
link: Link;
|
|
3830
|
+
old_link?: Link;
|
|
3401
3831
|
}
|
|
3402
3832
|
/** event-part-created */
|
|
3403
3833
|
export interface EventPartCreated {
|
|
@@ -3410,9 +3840,11 @@ export interface EventPartDeleted {
|
|
|
3410
3840
|
* @example "PROD-12345"
|
|
3411
3841
|
*/
|
|
3412
3842
|
id: string;
|
|
3843
|
+
old_part?: Part;
|
|
3413
3844
|
}
|
|
3414
3845
|
/** event-part-updated */
|
|
3415
3846
|
export interface EventPartUpdated {
|
|
3847
|
+
old_part?: Part;
|
|
3416
3848
|
part: Part;
|
|
3417
3849
|
}
|
|
3418
3850
|
/** event-rev-org-created */
|
|
@@ -3426,9 +3858,11 @@ export interface EventRevOrgDeleted {
|
|
|
3426
3858
|
* @example "REV-AbCdEfGh"
|
|
3427
3859
|
*/
|
|
3428
3860
|
id: string;
|
|
3861
|
+
old_rev_org?: RevOrg;
|
|
3429
3862
|
}
|
|
3430
3863
|
/** event-rev-org-updated */
|
|
3431
3864
|
export interface EventRevOrgUpdated {
|
|
3865
|
+
old_rev_org?: RevOrg;
|
|
3432
3866
|
rev_org: RevOrg;
|
|
3433
3867
|
}
|
|
3434
3868
|
/** event-rev-user-created */
|
|
@@ -3439,9 +3873,11 @@ export interface EventRevUserCreated {
|
|
|
3439
3873
|
export interface EventRevUserDeleted {
|
|
3440
3874
|
/** The ID of the Rev user that was deleted. */
|
|
3441
3875
|
id: string;
|
|
3876
|
+
old_rev_user?: RevUser;
|
|
3442
3877
|
}
|
|
3443
3878
|
/** event-rev-user-updated */
|
|
3444
3879
|
export interface EventRevUserUpdated {
|
|
3880
|
+
old_rev_user?: RevUser;
|
|
3445
3881
|
rev_user: RevUser;
|
|
3446
3882
|
}
|
|
3447
3883
|
/** event-sla-tracker-created */
|
|
@@ -3624,9 +4060,11 @@ export interface EventWorkDeleted {
|
|
|
3624
4060
|
* @example "ISS-12345"
|
|
3625
4061
|
*/
|
|
3626
4062
|
id: string;
|
|
4063
|
+
old_work?: Work;
|
|
3627
4064
|
}
|
|
3628
4065
|
/** event-work-updated */
|
|
3629
4066
|
export interface EventWorkUpdated {
|
|
4067
|
+
old_work?: Work;
|
|
3630
4068
|
work: Work;
|
|
3631
4069
|
}
|
|
3632
4070
|
/**
|
|
@@ -3647,11 +4085,147 @@ export interface ExternalIdentity {
|
|
|
3647
4085
|
export type Feature = PartBase;
|
|
3648
4086
|
/** feature-summary */
|
|
3649
4087
|
export type FeatureSummary = PartBaseSummary;
|
|
4088
|
+
/**
|
|
4089
|
+
* field-delta
|
|
4090
|
+
* A field change.
|
|
4091
|
+
*/
|
|
4092
|
+
export interface FieldDelta {
|
|
4093
|
+
/** Set of field attributes. */
|
|
4094
|
+
field_descriptor?: SchemaFieldDescriptor;
|
|
4095
|
+
/** The name of the field. */
|
|
4096
|
+
name?: string;
|
|
4097
|
+
new_value?: FieldValue;
|
|
4098
|
+
old_value?: FieldValue;
|
|
4099
|
+
}
|
|
3650
4100
|
/**
|
|
3651
4101
|
* field-descriptor
|
|
3652
4102
|
* Set of field attributes.
|
|
3653
4103
|
*/
|
|
3654
4104
|
export type FieldDescriptor = object;
|
|
4105
|
+
/** field-value */
|
|
4106
|
+
export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
|
|
4107
|
+
type: FieldValueType;
|
|
4108
|
+
};
|
|
4109
|
+
/** field-value-bool */
|
|
4110
|
+
export interface FieldValueBool {
|
|
4111
|
+
value: boolean;
|
|
4112
|
+
}
|
|
4113
|
+
/** field-value-bool-list */
|
|
4114
|
+
export interface FieldValueBoolList {
|
|
4115
|
+
values: boolean[];
|
|
4116
|
+
}
|
|
4117
|
+
/** field-value-composite */
|
|
4118
|
+
export interface FieldValueComposite {
|
|
4119
|
+
fields: Record<string, FieldValue>;
|
|
4120
|
+
}
|
|
4121
|
+
/** field-value-composite-list */
|
|
4122
|
+
export interface FieldValueCompositeList {
|
|
4123
|
+
values: FieldValueComposite[];
|
|
4124
|
+
}
|
|
4125
|
+
/** field-value-date-list */
|
|
4126
|
+
export interface FieldValueDateList {
|
|
4127
|
+
/** @example ["2023-01-01"] */
|
|
4128
|
+
values: string[];
|
|
4129
|
+
}
|
|
4130
|
+
/** field-value-date-time-list */
|
|
4131
|
+
export interface FieldValueDateTimeList {
|
|
4132
|
+
/** @example ["2023-01-01T12:00:00.000Z"] */
|
|
4133
|
+
values: string[];
|
|
4134
|
+
}
|
|
4135
|
+
/** field-value-date-time-value */
|
|
4136
|
+
export interface FieldValueDateTimeValue {
|
|
4137
|
+
/**
|
|
4138
|
+
* @format date-time
|
|
4139
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4140
|
+
*/
|
|
4141
|
+
value: string;
|
|
4142
|
+
}
|
|
4143
|
+
/** field-value-date-value */
|
|
4144
|
+
export interface FieldValueDateValue {
|
|
4145
|
+
/**
|
|
4146
|
+
* @format date
|
|
4147
|
+
* @example "2023-01-01"
|
|
4148
|
+
*/
|
|
4149
|
+
value: string;
|
|
4150
|
+
}
|
|
4151
|
+
/** field-value-double */
|
|
4152
|
+
export interface FieldValueDouble {
|
|
4153
|
+
/** @format double */
|
|
4154
|
+
value: number;
|
|
4155
|
+
}
|
|
4156
|
+
/** field-value-double-list */
|
|
4157
|
+
export interface FieldValueDoubleList {
|
|
4158
|
+
values: number[];
|
|
4159
|
+
}
|
|
4160
|
+
/** field-value-id */
|
|
4161
|
+
export interface FieldValueId {
|
|
4162
|
+
value: string;
|
|
4163
|
+
}
|
|
4164
|
+
/** field-value-id-list */
|
|
4165
|
+
export interface FieldValueIdList {
|
|
4166
|
+
values: string[];
|
|
4167
|
+
}
|
|
4168
|
+
/** field-value-int64 */
|
|
4169
|
+
export interface FieldValueInt64 {
|
|
4170
|
+
/** @format int64 */
|
|
4171
|
+
value: number;
|
|
4172
|
+
}
|
|
4173
|
+
/** field-value-int64-list */
|
|
4174
|
+
export interface FieldValueInt64List {
|
|
4175
|
+
values: number[];
|
|
4176
|
+
}
|
|
4177
|
+
/** field-value-stage */
|
|
4178
|
+
export interface FieldValueStage {
|
|
4179
|
+
name?: string;
|
|
4180
|
+
notes?: string;
|
|
4181
|
+
}
|
|
4182
|
+
/** field-value-string */
|
|
4183
|
+
export interface FieldValueString {
|
|
4184
|
+
value: string;
|
|
4185
|
+
}
|
|
4186
|
+
/** field-value-string-list */
|
|
4187
|
+
export interface FieldValueStringList {
|
|
4188
|
+
values: string[];
|
|
4189
|
+
}
|
|
4190
|
+
/** field-value-tag-summary */
|
|
4191
|
+
export interface FieldValueTagSummary {
|
|
4192
|
+
name?: string;
|
|
4193
|
+
style?: string;
|
|
4194
|
+
tag_id: string;
|
|
4195
|
+
}
|
|
4196
|
+
/** field-value-tag-summary-list */
|
|
4197
|
+
export interface FieldValueTagSummaryList {
|
|
4198
|
+
values: FieldValueTagSummary[];
|
|
4199
|
+
}
|
|
4200
|
+
export declare enum FieldValueType {
|
|
4201
|
+
Bool = "bool",
|
|
4202
|
+
BoolList = "bool_list",
|
|
4203
|
+
Composite = "composite",
|
|
4204
|
+
CompositeList = "composite_list",
|
|
4205
|
+
Date = "date",
|
|
4206
|
+
DateList = "date_list",
|
|
4207
|
+
DateTime = "date_time",
|
|
4208
|
+
DateTimeList = "date_time_list",
|
|
4209
|
+
Double = "double",
|
|
4210
|
+
DoubleList = "double_list",
|
|
4211
|
+
Id = "id",
|
|
4212
|
+
IdList = "id_list",
|
|
4213
|
+
Int = "int",
|
|
4214
|
+
IntList = "int_list",
|
|
4215
|
+
Stage = "stage",
|
|
4216
|
+
String = "string",
|
|
4217
|
+
StringList = "string_list",
|
|
4218
|
+
TagSummary = "tag_summary",
|
|
4219
|
+
TagSummaryList = "tag_summary_list"
|
|
4220
|
+
}
|
|
4221
|
+
/** Event type of the notification. */
|
|
4222
|
+
export declare enum GenericNotificationEventType {
|
|
4223
|
+
Alert = "alert",
|
|
4224
|
+
Assignment = "assignment",
|
|
4225
|
+
Mention = "mention",
|
|
4226
|
+
Reminder = "reminder",
|
|
4227
|
+
Update = "update"
|
|
4228
|
+
}
|
|
3655
4229
|
/** group */
|
|
3656
4230
|
export type Group = AtomBase & {
|
|
3657
4231
|
/** Description of the group. */
|
|
@@ -3786,6 +4360,8 @@ export type GroupedVistaSummary = VistaBaseSummary & {
|
|
|
3786
4360
|
* A request to create a new group.
|
|
3787
4361
|
*/
|
|
3788
4362
|
export interface GroupsCreateRequest {
|
|
4363
|
+
/** Type of the group. */
|
|
4364
|
+
type?: GroupType;
|
|
3789
4365
|
/** Description of the group. */
|
|
3790
4366
|
description: string;
|
|
3791
4367
|
/** Information to define dynamic groups. */
|
|
@@ -3796,8 +4372,6 @@ export interface GroupsCreateRequest {
|
|
|
3796
4372
|
name: string;
|
|
3797
4373
|
/** Owner of the group. */
|
|
3798
4374
|
owner?: string;
|
|
3799
|
-
/** Type of the group. */
|
|
3800
|
-
type?: GroupType;
|
|
3801
4375
|
}
|
|
3802
4376
|
/**
|
|
3803
4377
|
* groups-create-response
|
|
@@ -3833,6 +4407,8 @@ export interface GroupsListRequest {
|
|
|
3833
4407
|
cursor?: string;
|
|
3834
4408
|
/** Filters the groups based on the group type. */
|
|
3835
4409
|
group_type?: GroupType[];
|
|
4410
|
+
/** Whether to fetch default or custom groups. */
|
|
4411
|
+
is_default?: boolean;
|
|
3836
4412
|
/**
|
|
3837
4413
|
* The maximum number of groups to return. The default is '50'.
|
|
3838
4414
|
* @format int32
|
|
@@ -3859,49 +4435,394 @@ export interface GroupsListResponse {
|
|
|
3859
4435
|
/** The list of groups. */
|
|
3860
4436
|
groups: Group[];
|
|
3861
4437
|
/**
|
|
3862
|
-
* The cursor used to iterate subsequent results in accordance to the
|
|
3863
|
-
* sort order. If not set, then no later elements exist.
|
|
4438
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4439
|
+
* sort order. If not set, then no later elements exist.
|
|
4440
|
+
*/
|
|
4441
|
+
next_cursor?: string;
|
|
4442
|
+
/**
|
|
4443
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4444
|
+
* sort order. If not set, then no prior elements exist.
|
|
4445
|
+
*/
|
|
4446
|
+
prev_cursor?: string;
|
|
4447
|
+
}
|
|
4448
|
+
/**
|
|
4449
|
+
* groups-update-request
|
|
4450
|
+
* A request to update a group.
|
|
4451
|
+
*/
|
|
4452
|
+
export interface GroupsUpdateRequest {
|
|
4453
|
+
/** The updated group's description. */
|
|
4454
|
+
description?: string;
|
|
4455
|
+
dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
|
|
4456
|
+
/** The ID of the group to update. */
|
|
4457
|
+
id: string;
|
|
4458
|
+
/** The updated group's name. */
|
|
4459
|
+
name?: string;
|
|
4460
|
+
/** The updated group's owner. */
|
|
4461
|
+
owner?: string;
|
|
4462
|
+
}
|
|
4463
|
+
/** groups-update-request-dynamic-group-info */
|
|
4464
|
+
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
4465
|
+
/** Boolean expression. */
|
|
4466
|
+
membership_expression: BooleanExpression;
|
|
4467
|
+
}
|
|
4468
|
+
/**
|
|
4469
|
+
* groups-update-response
|
|
4470
|
+
* The response to group update.
|
|
4471
|
+
*/
|
|
4472
|
+
export interface GroupsUpdateResponse {
|
|
4473
|
+
group: Group;
|
|
4474
|
+
}
|
|
4475
|
+
/** incident */
|
|
4476
|
+
export type Incident = AtomBase & {
|
|
4477
|
+
/** Parts to which the incident is applicable to. */
|
|
4478
|
+
applies_to_parts?: PartSummary[];
|
|
4479
|
+
/** Artifacts attached to the incident. */
|
|
4480
|
+
artifacts?: ArtifactSummary[];
|
|
4481
|
+
/** Body of the incident. */
|
|
4482
|
+
body?: string;
|
|
4483
|
+
/** Custom fields. */
|
|
4484
|
+
custom_fields?: object;
|
|
4485
|
+
/**
|
|
4486
|
+
* Custom schema fragments.
|
|
4487
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
4488
|
+
*/
|
|
4489
|
+
custom_schema_fragments?: string[];
|
|
4490
|
+
/**
|
|
4491
|
+
* Time when the incident was identified/reported.
|
|
4492
|
+
* @format date-time
|
|
4493
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4494
|
+
*/
|
|
4495
|
+
identified_date?: string;
|
|
4496
|
+
/** List of customers impacted due to the incident. */
|
|
4497
|
+
impacted_customers?: AccountSummary[];
|
|
4498
|
+
/**
|
|
4499
|
+
* Timestamp when the incident was mitigated.
|
|
4500
|
+
* @format date-time
|
|
4501
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4502
|
+
*/
|
|
4503
|
+
mitigated_date?: string;
|
|
4504
|
+
/** The users that own the incident. */
|
|
4505
|
+
owned_by?: UserSummary[];
|
|
4506
|
+
/** The properties of an enum value. */
|
|
4507
|
+
severity?: EnumValue;
|
|
4508
|
+
/** Describes the current stage of a object. */
|
|
4509
|
+
stage?: Stage;
|
|
4510
|
+
/**
|
|
4511
|
+
* Users, along with the incident commander, involved in resolving
|
|
4512
|
+
* incidents and handling communication.
|
|
4513
|
+
*/
|
|
4514
|
+
stakeholders?: UserSummary[];
|
|
4515
|
+
/**
|
|
4516
|
+
* Stock schema fragment.
|
|
4517
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4518
|
+
*/
|
|
4519
|
+
stock_schema_fragment?: string;
|
|
4520
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
4521
|
+
subtype?: string;
|
|
4522
|
+
/** Tags associated with the object. */
|
|
4523
|
+
tags?: TagWithValue[];
|
|
4524
|
+
/**
|
|
4525
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4526
|
+
* @format date-time
|
|
4527
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4528
|
+
*/
|
|
4529
|
+
target_close_date?: string;
|
|
4530
|
+
/** Title of the incident. */
|
|
4531
|
+
title: string;
|
|
4532
|
+
};
|
|
4533
|
+
/** incidents-create-request */
|
|
4534
|
+
export interface IncidentsCreateRequest {
|
|
4535
|
+
/** Parts to which the incident is applicable to. */
|
|
4536
|
+
applies_to_parts?: string[];
|
|
4537
|
+
/**
|
|
4538
|
+
* Artifacts attached to the incident.
|
|
4539
|
+
* @example ["ARTIFACT-12345"]
|
|
4540
|
+
*/
|
|
4541
|
+
artifacts?: string[];
|
|
4542
|
+
/** Body of the incident. */
|
|
4543
|
+
body?: string;
|
|
4544
|
+
/** Application-defined custom fields. */
|
|
4545
|
+
custom_fields?: object;
|
|
4546
|
+
/**
|
|
4547
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4548
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4549
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4550
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4551
|
+
* specifier, it remains unmodified.
|
|
4552
|
+
*/
|
|
4553
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4554
|
+
/**
|
|
4555
|
+
* Time when the incident was identified/reported.
|
|
4556
|
+
* @format date-time
|
|
4557
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4558
|
+
*/
|
|
4559
|
+
identified_date?: string;
|
|
4560
|
+
/** List of customers impacted due to the incident. */
|
|
4561
|
+
impacted_customers?: string[];
|
|
4562
|
+
/**
|
|
4563
|
+
* Timestamp when the incident was mitigated.
|
|
4564
|
+
* @format date-time
|
|
4565
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4566
|
+
*/
|
|
4567
|
+
mitigated_date?: string;
|
|
4568
|
+
/** User IDs of the users that own the incident. */
|
|
4569
|
+
owned_by?: string[];
|
|
4570
|
+
/**
|
|
4571
|
+
* Severity of the incident.
|
|
4572
|
+
* @format int64
|
|
4573
|
+
*/
|
|
4574
|
+
severity?: number;
|
|
4575
|
+
/** Create object for stage. */
|
|
4576
|
+
stage?: CreateStage;
|
|
4577
|
+
/**
|
|
4578
|
+
* Users, along with the incident commander, involved in resolving
|
|
4579
|
+
* incidents and handling communication.
|
|
4580
|
+
*/
|
|
4581
|
+
stakeholders?: string[];
|
|
4582
|
+
/** Tags associated with the object. */
|
|
4583
|
+
tags?: CreateTagWithValue[];
|
|
4584
|
+
/**
|
|
4585
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4586
|
+
* @format date-time
|
|
4587
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4588
|
+
*/
|
|
4589
|
+
target_close_date?: string;
|
|
4590
|
+
/** Title of the incident. */
|
|
4591
|
+
title: string;
|
|
4592
|
+
}
|
|
4593
|
+
/** incidents-create-response */
|
|
4594
|
+
export interface IncidentsCreateResponse {
|
|
4595
|
+
incident: Incident;
|
|
4596
|
+
}
|
|
4597
|
+
/**
|
|
4598
|
+
* incidents-delete-request
|
|
4599
|
+
* A request to delete an incident.
|
|
4600
|
+
*/
|
|
4601
|
+
export interface IncidentsDeleteRequest {
|
|
4602
|
+
/** ID for the incident. */
|
|
4603
|
+
id: string;
|
|
4604
|
+
}
|
|
4605
|
+
/**
|
|
4606
|
+
* incidents-delete-response
|
|
4607
|
+
* The response to deleting the incident.
|
|
4608
|
+
*/
|
|
4609
|
+
export type IncidentsDeleteResponse = object;
|
|
4610
|
+
/** incidents-get-request */
|
|
4611
|
+
export interface IncidentsGetRequest {
|
|
4612
|
+
/** The ID of the incident to get. */
|
|
4613
|
+
id: string;
|
|
4614
|
+
}
|
|
4615
|
+
/** incidents-get-response */
|
|
4616
|
+
export interface IncidentsGetResponse {
|
|
4617
|
+
incident: Incident;
|
|
4618
|
+
}
|
|
4619
|
+
/** incidents-group */
|
|
4620
|
+
export interface IncidentsGroup {
|
|
4621
|
+
/** The group of incidents. */
|
|
4622
|
+
incidents: Incident[];
|
|
4623
|
+
/** Unique key according to which the items are grouped. */
|
|
4624
|
+
key: string;
|
|
4625
|
+
/**
|
|
4626
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4627
|
+
* sort order. If not set, then no later elements exist.
|
|
4628
|
+
*/
|
|
4629
|
+
next_cursor?: string;
|
|
4630
|
+
/**
|
|
4631
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4632
|
+
* sort order. If not set, then no prior elements exist.
|
|
4633
|
+
*/
|
|
4634
|
+
prev_cursor?: string;
|
|
4635
|
+
}
|
|
4636
|
+
/** incidents-group-request */
|
|
4637
|
+
export interface IncidentsGroupRequest {
|
|
4638
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
4639
|
+
applies_to_parts?: string[];
|
|
4640
|
+
/**
|
|
4641
|
+
* Filters for incidents created by any of the provided users.
|
|
4642
|
+
* @example ["DEVU-12345"]
|
|
4643
|
+
*/
|
|
4644
|
+
created_by?: string[];
|
|
4645
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4646
|
+
created_date?: DateFilter;
|
|
4647
|
+
/**
|
|
4648
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4649
|
+
* iteration starts from the beginning.
|
|
4650
|
+
*/
|
|
4651
|
+
cursor?: string;
|
|
4652
|
+
/** The field to group the incidents by. */
|
|
4653
|
+
group_by: string;
|
|
4654
|
+
/**
|
|
4655
|
+
* The maximum number of groups to return. If not set, then the
|
|
4656
|
+
* default is '10'.
|
|
4657
|
+
* @format int32
|
|
4658
|
+
*/
|
|
4659
|
+
limit?: number;
|
|
4660
|
+
/**
|
|
4661
|
+
* The maximum number of incidents to return for an individual group.
|
|
4662
|
+
* The default is '50'.
|
|
4663
|
+
* @format int32
|
|
4664
|
+
*/
|
|
4665
|
+
limit_per_group?: number;
|
|
4666
|
+
/**
|
|
4667
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4668
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4669
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4670
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4671
|
+
* always be returned in the specified sort-by order.
|
|
4672
|
+
*/
|
|
4673
|
+
mode?: ListMode;
|
|
4674
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4675
|
+
modified_date?: DateFilter;
|
|
4676
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
4677
|
+
owned_by?: string[];
|
|
4678
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
4679
|
+
severity?: number[];
|
|
4680
|
+
/** Comma-separated fields to sort the incidents by. */
|
|
4681
|
+
sort_by?: string[];
|
|
4682
|
+
/** Filters for incidents in any of the provided stages. */
|
|
4683
|
+
stage?: string[];
|
|
4684
|
+
/** Filters for incidents by the provided titles. */
|
|
4685
|
+
title?: string[];
|
|
4686
|
+
}
|
|
4687
|
+
/** incidents-group-response */
|
|
4688
|
+
export interface IncidentsGroupResponse {
|
|
4689
|
+
/** The list of groups. */
|
|
4690
|
+
groups: IncidentsGroup[];
|
|
4691
|
+
/**
|
|
4692
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4693
|
+
* sort order. If not set, then no later elements exist.
|
|
4694
|
+
*/
|
|
4695
|
+
next_cursor?: string;
|
|
4696
|
+
/**
|
|
4697
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4698
|
+
* sort order. If not set, then no prior elements exist.
|
|
4699
|
+
*/
|
|
4700
|
+
prev_cursor?: string;
|
|
4701
|
+
}
|
|
4702
|
+
/** incidents-list-request */
|
|
4703
|
+
export interface IncidentsListRequest {
|
|
4704
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
4705
|
+
applies_to_parts?: string[];
|
|
4706
|
+
/**
|
|
4707
|
+
* Filters for incidents created by any of the provided users.
|
|
4708
|
+
* @example ["DEVU-12345"]
|
|
4709
|
+
*/
|
|
4710
|
+
created_by?: string[];
|
|
4711
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4712
|
+
created_date?: DateFilter;
|
|
4713
|
+
/**
|
|
4714
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4715
|
+
* iteration starts from the beginning.
|
|
4716
|
+
*/
|
|
4717
|
+
cursor?: string;
|
|
4718
|
+
/**
|
|
4719
|
+
* The maximum number of items.
|
|
4720
|
+
* @format int32
|
|
4721
|
+
*/
|
|
4722
|
+
limit?: number;
|
|
4723
|
+
/**
|
|
4724
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4725
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4726
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4727
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4728
|
+
* always be returned in the specified sort-by order.
|
|
4729
|
+
*/
|
|
4730
|
+
mode?: ListMode;
|
|
4731
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4732
|
+
modified_date?: DateFilter;
|
|
4733
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
4734
|
+
owned_by?: string[];
|
|
4735
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
4736
|
+
severity?: number[];
|
|
4737
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
4738
|
+
sort_by?: string[];
|
|
4739
|
+
/** Filters for incidents in any of the provided stages. */
|
|
4740
|
+
stage?: string[];
|
|
4741
|
+
/** Filters for incidents by the provided titles. */
|
|
4742
|
+
title?: string[];
|
|
4743
|
+
}
|
|
4744
|
+
/** incidents-list-response */
|
|
4745
|
+
export interface IncidentsListResponse {
|
|
4746
|
+
/** The matching incidents. */
|
|
4747
|
+
incidents: Incident[];
|
|
4748
|
+
/**
|
|
4749
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4750
|
+
* sort order. If not set, then no later elements exist.
|
|
4751
|
+
*/
|
|
4752
|
+
next_cursor?: string;
|
|
4753
|
+
/**
|
|
4754
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4755
|
+
* sort order. If not set, then no prior elements exist.
|
|
4756
|
+
*/
|
|
4757
|
+
prev_cursor?: string;
|
|
4758
|
+
}
|
|
4759
|
+
/** incidents-update-request */
|
|
4760
|
+
export interface IncidentsUpdateRequest {
|
|
4761
|
+
applies_to_parts?: UpdateIncidentAppliesToParts;
|
|
4762
|
+
artifacts?: UpdateIncidentArtifacts;
|
|
4763
|
+
/** Body of the incident. */
|
|
4764
|
+
body?: string;
|
|
4765
|
+
/** Application-defined custom fields. */
|
|
4766
|
+
custom_fields?: object;
|
|
4767
|
+
/**
|
|
4768
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4769
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4770
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4771
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4772
|
+
* specifier, it remains unmodified.
|
|
4773
|
+
*/
|
|
4774
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4775
|
+
/** The ID of the incident to be updated. */
|
|
4776
|
+
id: string;
|
|
4777
|
+
/**
|
|
4778
|
+
* Time when the incident was identified/reported.
|
|
4779
|
+
* @format date-time
|
|
4780
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4781
|
+
*/
|
|
4782
|
+
identified_date?: string;
|
|
4783
|
+
impacted_customers?: UpdateIncidentImpactedCustomers;
|
|
4784
|
+
/**
|
|
4785
|
+
* Timestamp when the incident was mitigated.
|
|
4786
|
+
* @format date-time
|
|
4787
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3864
4788
|
*/
|
|
3865
|
-
|
|
4789
|
+
mitigated_date?: string;
|
|
4790
|
+
owned_by?: UpdateIncidentOwnedBy;
|
|
3866
4791
|
/**
|
|
3867
|
-
*
|
|
3868
|
-
*
|
|
4792
|
+
* Severity of the incident.
|
|
4793
|
+
* @format int64
|
|
3869
4794
|
*/
|
|
3870
|
-
|
|
3871
|
-
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
|
|
3875
|
-
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
name?: string;
|
|
3884
|
-
/** The updated group's owner. */
|
|
3885
|
-
owner?: string;
|
|
3886
|
-
}
|
|
3887
|
-
/** groups-update-request-dynamic-group-info */
|
|
3888
|
-
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
3889
|
-
/** Boolean expression. */
|
|
3890
|
-
membership_expression: BooleanExpression;
|
|
4795
|
+
severity?: number;
|
|
4796
|
+
/** Update object for Stage. */
|
|
4797
|
+
stage?: UpdateStage;
|
|
4798
|
+
stakeholders?: UpdateIncidentStakeholders;
|
|
4799
|
+
tags?: UpdateIncidentTags;
|
|
4800
|
+
/**
|
|
4801
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4802
|
+
* @format date-time
|
|
4803
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4804
|
+
*/
|
|
4805
|
+
target_close_date?: string;
|
|
4806
|
+
/** Title of the incident. */
|
|
4807
|
+
title?: string;
|
|
3891
4808
|
}
|
|
3892
|
-
/**
|
|
3893
|
-
|
|
3894
|
-
|
|
3895
|
-
*/
|
|
3896
|
-
export interface GroupsUpdateResponse {
|
|
3897
|
-
group: Group;
|
|
4809
|
+
/** incidents-update-response */
|
|
4810
|
+
export interface IncidentsUpdateResponse {
|
|
4811
|
+
incident: Incident;
|
|
3898
4812
|
}
|
|
3899
4813
|
/** issue */
|
|
3900
4814
|
export type Issue = WorkBase & {
|
|
4815
|
+
/**
|
|
4816
|
+
* Actual start date for the object.
|
|
4817
|
+
* @format date-time
|
|
4818
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4819
|
+
*/
|
|
4820
|
+
actual_start_date?: string;
|
|
3901
4821
|
/** Parts associated based on git events. */
|
|
3902
4822
|
developed_with?: PartSummary[];
|
|
3903
4823
|
/** Priority of the work based upon impact and criticality. */
|
|
3904
4824
|
priority?: IssuePriority;
|
|
4825
|
+
sla_tracker?: SlaTrackerSummary;
|
|
3905
4826
|
/** Vista group item. */
|
|
3906
4827
|
sprint?: VistaGroupItemSummary;
|
|
3907
4828
|
/**
|
|
@@ -3922,13 +4843,15 @@ export declare enum IssuePriority {
|
|
|
3922
4843
|
export type IssueSummary = WorkBaseSummary & {
|
|
3923
4844
|
/** Priority of the work based upon impact and criticality. */
|
|
3924
4845
|
priority?: IssuePriority;
|
|
4846
|
+
/** Vista group item. */
|
|
4847
|
+
sprint?: VistaGroupItemSummary;
|
|
3925
4848
|
};
|
|
3926
4849
|
/**
|
|
3927
4850
|
* job-history-item
|
|
3928
4851
|
* Defines a job history line item.
|
|
3929
4852
|
*/
|
|
3930
4853
|
export interface JobHistoryItem {
|
|
3931
|
-
/**
|
|
4854
|
+
/** The properties of an enum value. */
|
|
3932
4855
|
employment_status?: EnumValue;
|
|
3933
4856
|
/**
|
|
3934
4857
|
* The end date of the job, or not specified if current.
|
|
@@ -3949,6 +4872,13 @@ export interface JobHistoryItem {
|
|
|
3949
4872
|
/** The job title for the user. */
|
|
3950
4873
|
title?: string;
|
|
3951
4874
|
}
|
|
4875
|
+
/** keyrings-create-callback-request */
|
|
4876
|
+
export interface KeyringsCreateCallbackRequest {
|
|
4877
|
+
/** Code to exchange for an access token. */
|
|
4878
|
+
code: string;
|
|
4879
|
+
/** State value given to the authorization request. */
|
|
4880
|
+
state: string;
|
|
4881
|
+
}
|
|
3952
4882
|
/**
|
|
3953
4883
|
* legacy-stage
|
|
3954
4884
|
* Describes the current stage of a work item.
|
|
@@ -3956,6 +4886,15 @@ export interface JobHistoryItem {
|
|
|
3956
4886
|
export interface LegacyStage {
|
|
3957
4887
|
/** Current stage name of the work item. */
|
|
3958
4888
|
name: string;
|
|
4889
|
+
/** Notes relevant to the stage. */
|
|
4890
|
+
notes?: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Current stage number of the work item (sortable).
|
|
4893
|
+
* @format int32
|
|
4894
|
+
*/
|
|
4895
|
+
ordinal?: number;
|
|
4896
|
+
stage?: CustomStageSummary;
|
|
4897
|
+
state?: CustomStateSummary;
|
|
3959
4898
|
}
|
|
3960
4899
|
/**
|
|
3961
4900
|
* legacy-stage-summary
|
|
@@ -3964,6 +4903,7 @@ export interface LegacyStage {
|
|
|
3964
4903
|
export interface LegacyStageSummary {
|
|
3965
4904
|
/** Current stage name of the work item. */
|
|
3966
4905
|
name: string;
|
|
4906
|
+
stage?: CustomStageSummary;
|
|
3967
4907
|
}
|
|
3968
4908
|
/**
|
|
3969
4909
|
* lines-of-code
|
|
@@ -4059,10 +4999,14 @@ export type LinkSummary = AtomBaseSummary & {
|
|
|
4059
4999
|
};
|
|
4060
5000
|
/** Type of link used to define the relationship. */
|
|
4061
5001
|
export declare enum LinkType {
|
|
5002
|
+
CustomLink = "custom_link",
|
|
4062
5003
|
DevelopedWith = "developed_with",
|
|
4063
5004
|
Imports = "imports",
|
|
5005
|
+
IsAnalyzedBy = "is_analyzed_by",
|
|
5006
|
+
IsConvertedTo = "is_converted_to",
|
|
4064
5007
|
IsDependentOn = "is_dependent_on",
|
|
4065
5008
|
IsDuplicateOf = "is_duplicate_of",
|
|
5009
|
+
IsMergedInto = "is_merged_into",
|
|
4066
5010
|
IsParentOf = "is_parent_of",
|
|
4067
5011
|
IsPartOf = "is_part_of",
|
|
4068
5012
|
IsRelatedTo = "is_related_to",
|
|
@@ -4161,6 +5105,11 @@ export interface LinksListRequest {
|
|
|
4161
5105
|
mode?: ListMode;
|
|
4162
5106
|
/** The ID of the object to list the links for. */
|
|
4163
5107
|
object: string;
|
|
5108
|
+
/**
|
|
5109
|
+
* The object types to filter for, otherwise if not present, all
|
|
5110
|
+
* object types are included.
|
|
5111
|
+
*/
|
|
5112
|
+
object_types?: LinkEndpointType[];
|
|
4164
5113
|
/**
|
|
4165
5114
|
* The link types to filter for, otherwise if not present, all link
|
|
4166
5115
|
* types are included.
|
|
@@ -4289,6 +5238,8 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
4289
5238
|
};
|
|
4290
5239
|
/** metric-definitions-list-request */
|
|
4291
5240
|
export interface MetricDefinitionsListRequest {
|
|
5241
|
+
/** The type of metric definitions sought. */
|
|
5242
|
+
type?: MetricDefinitionMetricType[];
|
|
4292
5243
|
/** The type of objects the metric definition applies to. */
|
|
4293
5244
|
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
4294
5245
|
/**
|
|
@@ -4316,8 +5267,6 @@ export interface MetricDefinitionsListRequest {
|
|
|
4316
5267
|
mode?: ListMode;
|
|
4317
5268
|
/** The status of the metric definition. */
|
|
4318
5269
|
status?: MetricDefinitionStatus[];
|
|
4319
|
-
/** The type of metric definitions sought. */
|
|
4320
|
-
type?: MetricDefinitionMetricType[];
|
|
4321
5270
|
}
|
|
4322
5271
|
/** metric-definitions-list-response */
|
|
4323
5272
|
export interface MetricDefinitionsListResponse {
|
|
@@ -4336,6 +5285,16 @@ export interface MetricDefinitionsListResponse {
|
|
|
4336
5285
|
}
|
|
4337
5286
|
/** metrics-data */
|
|
4338
5287
|
export interface MetricsData {
|
|
5288
|
+
/**
|
|
5289
|
+
* Account ID or external_ref of the account for which metric is being
|
|
5290
|
+
* published. Account ID is DevRev DON ID. For example,
|
|
5291
|
+
* don:identity:dvrv-us-1:devo/0:account/156. External_ref is the
|
|
5292
|
+
* identification of DevRev customer's customers. Devrev will
|
|
5293
|
+
* internally resolve external_ref to Account ID and use it for
|
|
5294
|
+
* further processing. For example, external_ref=customer_1 may
|
|
5295
|
+
* resolve to don:identity:dvrv-us-1:devo/0:account/155.
|
|
5296
|
+
*/
|
|
5297
|
+
account_ref: string;
|
|
4339
5298
|
/**
|
|
4340
5299
|
* One or more data points collected for a given metric such as object
|
|
4341
5300
|
* usage, object state etc.
|
|
@@ -4357,7 +5316,7 @@ export interface MetricsData {
|
|
|
4357
5316
|
* external_ref=org_customer_1 may resolve to
|
|
4358
5317
|
* don:identity:dvrv-us-1:devo/0:revo/155.
|
|
4359
5318
|
*/
|
|
4360
|
-
org_ref
|
|
5319
|
+
org_ref?: string;
|
|
4361
5320
|
/** Rev User ID or user ref for which metric is being published. */
|
|
4362
5321
|
user_ref?: string;
|
|
4363
5322
|
}
|
|
@@ -4369,6 +5328,17 @@ export interface MetricsDataIngestRequest {
|
|
|
4369
5328
|
*/
|
|
4370
5329
|
metrics: MetricsData[];
|
|
4371
5330
|
}
|
|
5331
|
+
/** notifications-send-request */
|
|
5332
|
+
export interface NotificationsSendRequest {
|
|
5333
|
+
/**
|
|
5334
|
+
* The list of notifications to send.
|
|
5335
|
+
* @maxItems 10
|
|
5336
|
+
* @minItems 1
|
|
5337
|
+
*/
|
|
5338
|
+
notifications: SendNotification[];
|
|
5339
|
+
}
|
|
5340
|
+
/** notifications-send-response */
|
|
5341
|
+
export type NotificationsSendResponse = object;
|
|
4372
5342
|
/** object-member-search-summary */
|
|
4373
5343
|
export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
4374
5344
|
object_member: ObjectMemberSummary;
|
|
@@ -4813,6 +5783,8 @@ export type PartBase = AtomBase & {
|
|
|
4813
5783
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
4814
5784
|
/** Name of the part. */
|
|
4815
5785
|
name: string;
|
|
5786
|
+
/** The users that own the part. */
|
|
5787
|
+
owned_by: UserSummary[];
|
|
4816
5788
|
};
|
|
4817
5789
|
/** part-search-summary */
|
|
4818
5790
|
export type PartSearchSummary = SearchSummaryBase & {
|
|
@@ -4835,6 +5807,7 @@ export declare enum PartType {
|
|
|
4835
5807
|
}
|
|
4836
5808
|
/** parts-create-request */
|
|
4837
5809
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
5810
|
+
type: PartType;
|
|
4838
5811
|
/**
|
|
4839
5812
|
* The IDs of the artifacts.
|
|
4840
5813
|
* @example ["ARTIFACT-12345"]
|
|
@@ -4856,7 +5829,6 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
4856
5829
|
* @example ["DEVU-12345"]
|
|
4857
5830
|
*/
|
|
4858
5831
|
owned_by: string[];
|
|
4859
|
-
type: PartType;
|
|
4860
5832
|
};
|
|
4861
5833
|
/** parts-create-request-capability */
|
|
4862
5834
|
export interface PartsCreateRequestCapability {
|
|
@@ -4928,6 +5900,8 @@ export interface PartsGetResponse {
|
|
|
4928
5900
|
}
|
|
4929
5901
|
/** parts-list-request */
|
|
4930
5902
|
export interface PartsListRequest {
|
|
5903
|
+
/** Filters for parts of the provided type(s). */
|
|
5904
|
+
type?: PartType[];
|
|
4931
5905
|
/**
|
|
4932
5906
|
* Filters for parts created by any of these users.
|
|
4933
5907
|
* @example ["DEVU-12345"]
|
|
@@ -4960,8 +5934,6 @@ export interface PartsListRequest {
|
|
|
4960
5934
|
owned_by?: string[];
|
|
4961
5935
|
/** The filter for specifying parent part. */
|
|
4962
5936
|
parent_part?: ParentPartFilter;
|
|
4963
|
-
/** Filters for parts of the provided type(s). */
|
|
4964
|
-
type?: PartType[];
|
|
4965
5937
|
}
|
|
4966
5938
|
/** parts-list-response */
|
|
4967
5939
|
export interface PartsListResponse {
|
|
@@ -4980,6 +5952,7 @@ export interface PartsListResponse {
|
|
|
4980
5952
|
}
|
|
4981
5953
|
/** parts-update-request */
|
|
4982
5954
|
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
5955
|
+
type?: PartType;
|
|
4983
5956
|
artifacts?: PartsUpdateRequestArtifacts;
|
|
4984
5957
|
/** Custom fields. */
|
|
4985
5958
|
custom_fields?: object;
|
|
@@ -4998,7 +5971,6 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
4998
5971
|
/** The updated name of the part. */
|
|
4999
5972
|
name?: string;
|
|
5000
5973
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
5001
|
-
type?: PartType;
|
|
5002
5974
|
};
|
|
5003
5975
|
/** parts-update-request-artifacts */
|
|
5004
5976
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -5329,6 +6301,19 @@ export interface QuestionAnswersUpdateRequestTags {
|
|
|
5329
6301
|
export interface QuestionAnswersUpdateResponse {
|
|
5330
6302
|
question_answer: QuestionAnswer;
|
|
5331
6303
|
}
|
|
6304
|
+
/** remove-tag-with-value */
|
|
6305
|
+
export interface RemoveTagWithValue {
|
|
6306
|
+
/**
|
|
6307
|
+
* The ID of the tag.
|
|
6308
|
+
* @example "TAG-12345"
|
|
6309
|
+
*/
|
|
6310
|
+
id: string;
|
|
6311
|
+
}
|
|
6312
|
+
/**
|
|
6313
|
+
* removed-sla-metric-history
|
|
6314
|
+
* User, timestamp and metric id of removed metrics.
|
|
6315
|
+
*/
|
|
6316
|
+
export type RemovedSlaMetricHistory = object;
|
|
5332
6317
|
/**
|
|
5333
6318
|
* resource
|
|
5334
6319
|
* Resource details.
|
|
@@ -5411,7 +6396,10 @@ export interface RevOrgsCreateRequest {
|
|
|
5411
6396
|
description?: string;
|
|
5412
6397
|
/** Name of the Rev organization. */
|
|
5413
6398
|
display_name: string;
|
|
5414
|
-
/**
|
|
6399
|
+
/**
|
|
6400
|
+
* Company's domain name. Example - 'devrev.ai'.
|
|
6401
|
+
* @deprecated
|
|
6402
|
+
*/
|
|
5415
6403
|
domain?: string;
|
|
5416
6404
|
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
5417
6405
|
environment?: OrgEnvironment;
|
|
@@ -5563,7 +6551,10 @@ export interface RevOrgsUpdateRequest {
|
|
|
5563
6551
|
description?: string;
|
|
5564
6552
|
/** Customer chosen name for the Rev organization. */
|
|
5565
6553
|
display_name?: string;
|
|
5566
|
-
/**
|
|
6554
|
+
/**
|
|
6555
|
+
* Company's domain name. Example - 'devrev.ai'.
|
|
6556
|
+
* @deprecated
|
|
6557
|
+
*/
|
|
5567
6558
|
domain?: string;
|
|
5568
6559
|
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
5569
6560
|
environment?: OrgEnvironment;
|
|
@@ -5649,6 +6640,11 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
5649
6640
|
* Request object to create a new Rev user for a Rev organization.
|
|
5650
6641
|
*/
|
|
5651
6642
|
export interface RevUsersCreateRequest {
|
|
6643
|
+
/**
|
|
6644
|
+
* The ID of the account to which the created Rev user is associated.
|
|
6645
|
+
* @example "ACC-12345"
|
|
6646
|
+
*/
|
|
6647
|
+
account?: string;
|
|
5652
6648
|
/**
|
|
5653
6649
|
* The IDs of the artifacts to associate with the Rev user.
|
|
5654
6650
|
* @example ["ARTIFACT-12345"]
|
|
@@ -5787,6 +6783,51 @@ export interface RevUsersListResponse {
|
|
|
5787
6783
|
/** List containing all the Rev users. */
|
|
5788
6784
|
rev_users: RevUser[];
|
|
5789
6785
|
}
|
|
6786
|
+
/**
|
|
6787
|
+
* rev-users-scan-request
|
|
6788
|
+
* Scans the list of Rev users.
|
|
6789
|
+
*/
|
|
6790
|
+
export interface RevUsersScanRequest {
|
|
6791
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
6792
|
+
created_by?: string[];
|
|
6793
|
+
created_date?: DateTimeFilter;
|
|
6794
|
+
/**
|
|
6795
|
+
* The cursor to resume iteration, otherwise the beginning if not
|
|
6796
|
+
* provided.
|
|
6797
|
+
*/
|
|
6798
|
+
cursor?: string;
|
|
6799
|
+
/** Filters for custom fields. */
|
|
6800
|
+
custom_fields?: object;
|
|
6801
|
+
/** List of emails of Rev users to be filtered. */
|
|
6802
|
+
email?: string[];
|
|
6803
|
+
/** List of external refs to filter Rev users for. */
|
|
6804
|
+
external_ref?: string[];
|
|
6805
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
6806
|
+
is_verified?: boolean;
|
|
6807
|
+
modified_date?: DateTimeFilter;
|
|
6808
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
6809
|
+
phone_numbers?: string[];
|
|
6810
|
+
/**
|
|
6811
|
+
* List of IDs of Rev organizations to be filtered.
|
|
6812
|
+
* @example ["REV-AbCdEfGh"]
|
|
6813
|
+
*/
|
|
6814
|
+
rev_org?: string[];
|
|
6815
|
+
/** List of tags to be filtered. */
|
|
6816
|
+
tags?: string[];
|
|
6817
|
+
}
|
|
6818
|
+
/**
|
|
6819
|
+
* rev-users-scan-response
|
|
6820
|
+
* The response to scanning Rev users.
|
|
6821
|
+
*/
|
|
6822
|
+
export interface RevUsersScanResponse {
|
|
6823
|
+
/**
|
|
6824
|
+
* The cursor that should be used to resume iteration, otherwise if
|
|
6825
|
+
* not provided, then iteration has completed.
|
|
6826
|
+
*/
|
|
6827
|
+
next_cursor?: string;
|
|
6828
|
+
/** The iterated Rev users. */
|
|
6829
|
+
rev_users: RevUser[];
|
|
6830
|
+
}
|
|
5790
6831
|
/**
|
|
5791
6832
|
* rev-users-update-request
|
|
5792
6833
|
* Request to update details of a Rev user.
|
|
@@ -5903,11 +6944,11 @@ export interface SchemaFieldCreateViewUiMetadata {
|
|
|
5903
6944
|
* schema-field-descriptor
|
|
5904
6945
|
* Set of field attributes.
|
|
5905
6946
|
*/
|
|
5906
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
6947
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
5907
6948
|
field_type: SchemaFieldDescriptorFieldType;
|
|
5908
6949
|
};
|
|
5909
6950
|
/** schema-field-descriptor-array-type */
|
|
5910
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
6951
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
5911
6952
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
5912
6953
|
/**
|
|
5913
6954
|
* The exact array length.
|
|
@@ -5934,6 +6975,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
5934
6975
|
Id = "id",
|
|
5935
6976
|
Int = "int",
|
|
5936
6977
|
RichText = "rich_text",
|
|
6978
|
+
Struct = "struct",
|
|
5937
6979
|
Text = "text",
|
|
5938
6980
|
Timestamp = "timestamp",
|
|
5939
6981
|
Tokens = "tokens",
|
|
@@ -5975,6 +7017,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
5975
7017
|
Id = "id",
|
|
5976
7018
|
Int = "int",
|
|
5977
7019
|
RichText = "rich_text",
|
|
7020
|
+
Struct = "struct",
|
|
5978
7021
|
Text = "text",
|
|
5979
7022
|
Timestamp = "timestamp",
|
|
5980
7023
|
Tokens = "tokens",
|
|
@@ -6055,6 +7098,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
6055
7098
|
is_hidden_during_create?: boolean;
|
|
6056
7099
|
/** Whether the field is read-only in the UI. */
|
|
6057
7100
|
is_read_only?: boolean;
|
|
7101
|
+
/** Whether the field is mandatory in the UI. */
|
|
7102
|
+
is_required?: boolean;
|
|
6058
7103
|
/** Whether the field is shown in the UI summary view. */
|
|
6059
7104
|
is_shown_in_summary?: boolean;
|
|
6060
7105
|
/** Whether the field is sortable in the UI. */
|
|
@@ -6191,6 +7236,16 @@ export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
6191
7236
|
/** The string suffix. */
|
|
6192
7237
|
suffix?: string;
|
|
6193
7238
|
};
|
|
7239
|
+
/** schema-struct-field-descriptor */
|
|
7240
|
+
export type SchemaStructFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
7241
|
+
/** Default value. */
|
|
7242
|
+
default_value?: object;
|
|
7243
|
+
};
|
|
7244
|
+
/** schema-struct-list-field-descriptor */
|
|
7245
|
+
export type SchemaStructListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
7246
|
+
/** Default value. */
|
|
7247
|
+
default_value?: object[];
|
|
7248
|
+
};
|
|
6194
7249
|
/** schema-text-field-descriptor */
|
|
6195
7250
|
export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
6196
7251
|
/** The contained substring. */
|
|
@@ -6377,10 +7432,13 @@ export interface SearchCoreResponse {
|
|
|
6377
7432
|
export declare enum SearchHybridNamespace {
|
|
6378
7433
|
Article = "article",
|
|
6379
7434
|
Conversation = "conversation",
|
|
7435
|
+
Dataset = "dataset",
|
|
7436
|
+
Incident = "incident",
|
|
6380
7437
|
Issue = "issue",
|
|
6381
7438
|
Part = "part",
|
|
6382
7439
|
QuestionAnswer = "question_answer",
|
|
6383
7440
|
Ticket = "ticket",
|
|
7441
|
+
Widget = "widget",
|
|
6384
7442
|
Work = "work"
|
|
6385
7443
|
}
|
|
6386
7444
|
/**
|
|
@@ -6498,6 +7556,56 @@ export interface SearchSummaryBase {
|
|
|
6498
7556
|
/** Text snippet where the search hit occurred. */
|
|
6499
7557
|
snippet?: string;
|
|
6500
7558
|
}
|
|
7559
|
+
/** send-notification */
|
|
7560
|
+
export type SendNotification = SendNotificationGenericNotificationEntry & {
|
|
7561
|
+
type: SendNotificationType;
|
|
7562
|
+
/** The ID of the parent object associated with the notification. */
|
|
7563
|
+
parent?: string;
|
|
7564
|
+
/** The ID of the user for whom the notification was generated. */
|
|
7565
|
+
receiver: string;
|
|
7566
|
+
/**
|
|
7567
|
+
* Timestamp of the event that triggered the notification.
|
|
7568
|
+
* @format date-time
|
|
7569
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7570
|
+
*/
|
|
7571
|
+
timestamp?: string;
|
|
7572
|
+
};
|
|
7573
|
+
/** send-notification-generic-notification-entry */
|
|
7574
|
+
export interface SendNotificationGenericNotificationEntry {
|
|
7575
|
+
/** ID used to group notifications in the inbox for the same parent. */
|
|
7576
|
+
event_id?: string;
|
|
7577
|
+
/** Event type of the notification. */
|
|
7578
|
+
event_type: GenericNotificationEventType;
|
|
7579
|
+
/** Metadata for the objects that triggered the notification. */
|
|
7580
|
+
metadata: SendNotificationGenericNotificationEntryMetadata[];
|
|
7581
|
+
}
|
|
7582
|
+
/** send-notification-generic-notification-entry-metadata */
|
|
7583
|
+
export interface SendNotificationGenericNotificationEntryMetadata {
|
|
7584
|
+
action?: SendNotificationGenericNotificationEntryNotificationAction;
|
|
7585
|
+
/** The ID of the content template for the content of the notification. */
|
|
7586
|
+
content_template: string;
|
|
7587
|
+
/** Inputs required for the template. */
|
|
7588
|
+
inputs?: object;
|
|
7589
|
+
}
|
|
7590
|
+
/** send-notification-generic-notification-entry-notification-action */
|
|
7591
|
+
export interface SendNotificationGenericNotificationEntryNotificationAction {
|
|
7592
|
+
type?: 'clickable_action';
|
|
7593
|
+
clickable_action?: SendNotificationGenericNotificationEntryNotificationActionClickableAction;
|
|
7594
|
+
}
|
|
7595
|
+
/** send-notification-generic-notification-entry-notification-action-clickable-action */
|
|
7596
|
+
export interface SendNotificationGenericNotificationEntryNotificationActionClickableAction {
|
|
7597
|
+
type?: 'object' | 'url';
|
|
7598
|
+
/**
|
|
7599
|
+
* The ID of the object that the notification should redirect the user
|
|
7600
|
+
* to when selected.
|
|
7601
|
+
*/
|
|
7602
|
+
object?: string;
|
|
7603
|
+
/** The URL to redirect the user to. */
|
|
7604
|
+
url?: string;
|
|
7605
|
+
}
|
|
7606
|
+
export declare enum SendNotificationType {
|
|
7607
|
+
GenericNotification = "generic_notification"
|
|
7608
|
+
}
|
|
6501
7609
|
/** service-account */
|
|
6502
7610
|
export type ServiceAccount = UserBase;
|
|
6503
7611
|
/** service-account-summary */
|
|
@@ -6527,6 +7635,8 @@ export interface SetIssueSelector {
|
|
|
6527
7635
|
* values.
|
|
6528
7636
|
*/
|
|
6529
7637
|
custom_fields?: object;
|
|
7638
|
+
/** The SLA policy applies to the issues of these owners. */
|
|
7639
|
+
owners?: string[];
|
|
6530
7640
|
/**
|
|
6531
7641
|
* The SLA policy applies to the issues of these parts.
|
|
6532
7642
|
* @example ["PROD-12345"]
|
|
@@ -6577,7 +7687,17 @@ export interface SetSlaSelector {
|
|
|
6577
7687
|
* value is null, the field must have null value or not be present.
|
|
6578
7688
|
*/
|
|
6579
7689
|
custom_fields?: object;
|
|
7690
|
+
/**
|
|
7691
|
+
* The SLA policy applies to the tickets or conversations of these
|
|
7692
|
+
* groups.
|
|
7693
|
+
*/
|
|
7694
|
+
groups?: string[];
|
|
6580
7695
|
issue_selector?: SetIssueSelector;
|
|
7696
|
+
/**
|
|
7697
|
+
* The SLA policy applies to the tickets or conversations of these
|
|
7698
|
+
* owners.
|
|
7699
|
+
*/
|
|
7700
|
+
owners?: string[];
|
|
6581
7701
|
/**
|
|
6582
7702
|
* The SLA policy applies to the tickets of these parts.
|
|
6583
7703
|
* @example ["PROD-12345"]
|
|
@@ -6596,6 +7716,8 @@ export interface SetSlaSelector {
|
|
|
6596
7716
|
* @example ["TAG-12345"]
|
|
6597
7717
|
*/
|
|
6598
7718
|
tags?: string[];
|
|
7719
|
+
/** The SLA policy applies to tickets with these source channels. */
|
|
7720
|
+
ticket_source_channel?: string[];
|
|
6599
7721
|
}
|
|
6600
7722
|
/** set-support-metric-target */
|
|
6601
7723
|
export interface SetSupportMetricTarget {
|
|
@@ -6802,6 +7924,8 @@ export type SlaTracker = AtomBase & {
|
|
|
6802
7924
|
applies_to_id?: string;
|
|
6803
7925
|
/** Summary of the metrics target being tracked in the SLA tracker. */
|
|
6804
7926
|
metric_target_summaries: ArchetypeMetricTarget[];
|
|
7927
|
+
/** User, timestamp and metric Id of removed metrics. */
|
|
7928
|
+
removed_sla_metric_history?: RemovedSlaMetricHistory[];
|
|
6805
7929
|
sla?: SlaSummary;
|
|
6806
7930
|
/**
|
|
6807
7931
|
* Details of the applicable SLA policy. Can be omitted if no sla
|
|
@@ -6982,6 +8106,11 @@ export interface SlasUpdateRequest {
|
|
|
6982
8106
|
export interface SlasUpdateResponse {
|
|
6983
8107
|
sla: Sla;
|
|
6984
8108
|
}
|
|
8109
|
+
/** snap-in */
|
|
8110
|
+
export type SnapIn = AtomBase & {
|
|
8111
|
+
/** Values of the inputs. */
|
|
8112
|
+
inputs_values?: object;
|
|
8113
|
+
};
|
|
6985
8114
|
/** snap-in-version-summary */
|
|
6986
8115
|
export type SnapInVersionSummary = AtomBaseSummary;
|
|
6987
8116
|
/** snap-ins-resources-request */
|
|
@@ -7008,6 +8137,17 @@ export interface SnapInsResourcesResponseKeyringData {
|
|
|
7008
8137
|
/** The secret value of the keyring. This must be handled with caution. */
|
|
7009
8138
|
secret: string;
|
|
7010
8139
|
}
|
|
8140
|
+
/** snap-ins-update-request */
|
|
8141
|
+
export interface SnapInsUpdateRequest {
|
|
8142
|
+
/** The ID of the snap-in to update. */
|
|
8143
|
+
id: string;
|
|
8144
|
+
/** The updated values of the inputs. */
|
|
8145
|
+
inputs_values?: object;
|
|
8146
|
+
}
|
|
8147
|
+
/** snap-ins-update-response */
|
|
8148
|
+
export interface SnapInsUpdateResponse {
|
|
8149
|
+
snap_in: SnapIn;
|
|
8150
|
+
}
|
|
7011
8151
|
/** snap-widget */
|
|
7012
8152
|
export type SnapWidget = EmailPreviewWidget & {
|
|
7013
8153
|
type: SnapWidgetType;
|
|
@@ -7038,13 +8178,13 @@ export declare enum SnapWidgetType {
|
|
|
7038
8178
|
}
|
|
7039
8179
|
/** snap-widgets-create-request */
|
|
7040
8180
|
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
8181
|
+
type: SnapWidgetsCreateRequestType;
|
|
7041
8182
|
/** A human readable name for the snap widget. */
|
|
7042
8183
|
name: string;
|
|
7043
8184
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
7044
8185
|
namespace?: SnapWidgetNamespace;
|
|
7045
8186
|
/** The status of the snap widget. */
|
|
7046
8187
|
status?: SnapWidgetStatus;
|
|
7047
|
-
type: SnapWidgetsCreateRequestType;
|
|
7048
8188
|
};
|
|
7049
8189
|
export declare enum SnapWidgetsCreateRequestType {
|
|
7050
8190
|
EmailPreview = "email_preview"
|
|
@@ -7053,6 +8193,11 @@ export declare enum SnapWidgetsCreateRequestType {
|
|
|
7053
8193
|
export interface SnapWidgetsCreateResponse {
|
|
7054
8194
|
snap_widget: SnapWidget;
|
|
7055
8195
|
}
|
|
8196
|
+
/**
|
|
8197
|
+
* stage
|
|
8198
|
+
* Describes the current stage of a object.
|
|
8199
|
+
*/
|
|
8200
|
+
export type Stage = object;
|
|
7056
8201
|
/** stage-diagram-summary */
|
|
7057
8202
|
export type StageDiagramSummary = AtomBaseSummary;
|
|
7058
8203
|
/**
|
|
@@ -7068,6 +8213,11 @@ export interface StageFilter {
|
|
|
7068
8213
|
* Sets an object's initial stage.
|
|
7069
8214
|
*/
|
|
7070
8215
|
export interface StageInit {
|
|
8216
|
+
/**
|
|
8217
|
+
* The ID of the custom stage. If this is set, the name field is
|
|
8218
|
+
* ignored.
|
|
8219
|
+
*/
|
|
8220
|
+
id?: string;
|
|
7071
8221
|
/** The name of the stage. */
|
|
7072
8222
|
name?: string;
|
|
7073
8223
|
}
|
|
@@ -7078,6 +8228,11 @@ export interface StageInit {
|
|
|
7078
8228
|
export interface StageUpdate {
|
|
7079
8229
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
7080
8230
|
name?: string;
|
|
8231
|
+
/**
|
|
8232
|
+
* The ID of the updated custom stage, otherwise unchanged if not set.
|
|
8233
|
+
* If this is set, the name field is ignored.
|
|
8234
|
+
*/
|
|
8235
|
+
stage?: string;
|
|
7081
8236
|
}
|
|
7082
8237
|
/** Type of stage validation options when creating an object. */
|
|
7083
8238
|
export declare enum StageValidationOptionForCreate {
|
|
@@ -7247,9 +8402,9 @@ export type SurveyResponse = AtomBase & {
|
|
|
7247
8402
|
recipient?: UserSummary;
|
|
7248
8403
|
/** Response for the survey. */
|
|
7249
8404
|
response?: object;
|
|
7250
|
-
/**
|
|
8405
|
+
/** The properties of an enum value. */
|
|
7251
8406
|
response_channel?: EnumValue;
|
|
7252
|
-
/**
|
|
8407
|
+
/** The properties of an enum value. */
|
|
7253
8408
|
stage?: EnumValue;
|
|
7254
8409
|
/** The ID of the survey for which response is taken. */
|
|
7255
8410
|
survey?: string;
|
|
@@ -7365,6 +8520,11 @@ export interface SurveysResponsesListRequest {
|
|
|
7365
8520
|
* @example ["ACC-12345"]
|
|
7366
8521
|
*/
|
|
7367
8522
|
objects?: string[];
|
|
8523
|
+
/**
|
|
8524
|
+
* Filters for survey responses dispatched to any of these users.
|
|
8525
|
+
* @example ["DEVU-12345"]
|
|
8526
|
+
*/
|
|
8527
|
+
recipient?: string[];
|
|
7368
8528
|
/**
|
|
7369
8529
|
* Fields to sort the survey responses by and the direction to sort
|
|
7370
8530
|
* them.
|
|
@@ -7764,6 +8924,8 @@ export type Ticket = WorkBase & {
|
|
|
7764
8924
|
/** Whether the ticket needs a response. */
|
|
7765
8925
|
needs_response?: boolean;
|
|
7766
8926
|
rev_org?: OrgSummary;
|
|
8927
|
+
/** The properties of an enum value. */
|
|
8928
|
+
sentiment?: EnumValue;
|
|
7767
8929
|
/** Severity of the ticket. */
|
|
7768
8930
|
severity?: TicketSeverity;
|
|
7769
8931
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -7775,7 +8937,8 @@ export declare enum TicketChannels {
|
|
|
7775
8937
|
Email = "email",
|
|
7776
8938
|
Plug = "plug",
|
|
7777
8939
|
Slack = "slack",
|
|
7778
|
-
Twilio = "twilio"
|
|
8940
|
+
Twilio = "twilio",
|
|
8941
|
+
TwilioSms = "twilio_sms"
|
|
7779
8942
|
}
|
|
7780
8943
|
/** Severity of the ticket. */
|
|
7781
8944
|
export declare enum TicketSeverity {
|
|
@@ -7790,6 +8953,69 @@ export type TicketSummary = WorkBaseSummary & {
|
|
|
7790
8953
|
/** Severity of the ticket. */
|
|
7791
8954
|
severity?: TicketSeverity;
|
|
7792
8955
|
};
|
|
8956
|
+
/** timeline-change-event */
|
|
8957
|
+
export type TimelineChangeEvent = TimelineEntryBase & {
|
|
8958
|
+
/** A timeline change event. */
|
|
8959
|
+
event?: TimelineChangeEventEvent;
|
|
8960
|
+
};
|
|
8961
|
+
/**
|
|
8962
|
+
* timeline-change-event-created
|
|
8963
|
+
* A creation event.
|
|
8964
|
+
*/
|
|
8965
|
+
export interface TimelineChangeEventCreated {
|
|
8966
|
+
object?: AtomSummary;
|
|
8967
|
+
}
|
|
8968
|
+
/**
|
|
8969
|
+
* timeline-change-event-deleted
|
|
8970
|
+
* A deletion event.
|
|
8971
|
+
*/
|
|
8972
|
+
export interface TimelineChangeEventDeleted {
|
|
8973
|
+
/** The ID correspending to the deleted object. */
|
|
8974
|
+
object_id?: string;
|
|
8975
|
+
}
|
|
8976
|
+
/**
|
|
8977
|
+
* timeline-change-event-event
|
|
8978
|
+
* A timeline change event.
|
|
8979
|
+
*/
|
|
8980
|
+
export interface TimelineChangeEventEvent {
|
|
8981
|
+
/** The type of the event. */
|
|
8982
|
+
type?: TimelineChangeEventEventType;
|
|
8983
|
+
/** A creation event. */
|
|
8984
|
+
created?: TimelineChangeEventCreated;
|
|
8985
|
+
/** A deletion event. */
|
|
8986
|
+
deleted?: TimelineChangeEventDeleted;
|
|
8987
|
+
/** A linking event. */
|
|
8988
|
+
linked?: TimelineChangeEventLinked;
|
|
8989
|
+
/** An update event. */
|
|
8990
|
+
updated?: TimelineChangeEventUpdated;
|
|
8991
|
+
}
|
|
8992
|
+
/** The type of the event. */
|
|
8993
|
+
export declare enum TimelineChangeEventEventType {
|
|
8994
|
+
Annotated = "annotated",
|
|
8995
|
+
Created = "created",
|
|
8996
|
+
Deleted = "deleted",
|
|
8997
|
+
Linked = "linked",
|
|
8998
|
+
Updated = "updated"
|
|
8999
|
+
}
|
|
9000
|
+
/**
|
|
9001
|
+
* timeline-change-event-linked
|
|
9002
|
+
* A linking event.
|
|
9003
|
+
*/
|
|
9004
|
+
export interface TimelineChangeEventLinked {
|
|
9005
|
+
link?: LinkSummary;
|
|
9006
|
+
}
|
|
9007
|
+
/** timeline-change-event-summary */
|
|
9008
|
+
export type TimelineChangeEventSummary = TimelineEntryBaseSummary;
|
|
9009
|
+
/**
|
|
9010
|
+
* timeline-change-event-updated
|
|
9011
|
+
* An update event.
|
|
9012
|
+
*/
|
|
9013
|
+
export interface TimelineChangeEventUpdated {
|
|
9014
|
+
/** List of field changes. */
|
|
9015
|
+
field_deltas?: FieldDelta[];
|
|
9016
|
+
/** Type of DevRev object. */
|
|
9017
|
+
object_type?: string;
|
|
9018
|
+
}
|
|
7793
9019
|
/** timeline-comment */
|
|
7794
9020
|
export type TimelineComment = TimelineEntryBase & {
|
|
7795
9021
|
/** The artifacts for the comment. */
|
|
@@ -7824,6 +9050,7 @@ export declare enum TimelineEntriesCollection {
|
|
|
7824
9050
|
* The request to create a timeline entry for an object.
|
|
7825
9051
|
*/
|
|
7826
9052
|
export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineComment & {
|
|
9053
|
+
type: TimelineEntriesCreateRequestType;
|
|
7827
9054
|
/**
|
|
7828
9055
|
* The collection(s) that the entry belongs to, otherwise if not
|
|
7829
9056
|
* provided, then the entry's default collection is used.
|
|
@@ -7856,7 +9083,6 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
7856
9083
|
* @example ["DEVU-12345"]
|
|
7857
9084
|
*/
|
|
7858
9085
|
private_to?: string[];
|
|
7859
|
-
type: TimelineEntriesCreateRequestType;
|
|
7860
9086
|
/**
|
|
7861
9087
|
* The visibility of the entry. If 'private', then the entry is only
|
|
7862
9088
|
* visible to the creator, 'internal' is visible with the Dev
|
|
@@ -8017,12 +9243,12 @@ export interface TimelineEntriesListResponse {
|
|
|
8017
9243
|
* The request to update a timeline entry.
|
|
8018
9244
|
*/
|
|
8019
9245
|
export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
|
|
9246
|
+
type: TimelineEntriesUpdateRequestType;
|
|
8020
9247
|
/**
|
|
8021
9248
|
* The ID of the timeline entry to update.
|
|
8022
9249
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
8023
9250
|
*/
|
|
8024
9251
|
id: string;
|
|
8025
|
-
type: TimelineEntriesUpdateRequestType;
|
|
8026
9252
|
};
|
|
8027
9253
|
/** timeline-entries-update-request-timeline-comment */
|
|
8028
9254
|
export interface TimelineEntriesUpdateRequestTimelineComment {
|
|
@@ -8092,7 +9318,7 @@ export interface TimelineEntriesUpdateResponse {
|
|
|
8092
9318
|
timeline_entry: TimelineEntry;
|
|
8093
9319
|
}
|
|
8094
9320
|
/** timeline-entry */
|
|
8095
|
-
export type TimelineEntry = TimelineComment & {
|
|
9321
|
+
export type TimelineEntry = (TimelineChangeEvent | TimelineComment) & {
|
|
8096
9322
|
type: TimelineEntryType;
|
|
8097
9323
|
};
|
|
8098
9324
|
/** timeline-entry-base */
|
|
@@ -8141,9 +9367,17 @@ export declare enum TimelineEntryObjectType {
|
|
|
8141
9367
|
RevUser = "rev_user",
|
|
8142
9368
|
Task = "task",
|
|
8143
9369
|
Ticket = "ticket",
|
|
9370
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
8144
9371
|
TimelineComment = "timeline_comment"
|
|
8145
9372
|
}
|
|
9373
|
+
/** Display panels for the Timeline entry. */
|
|
9374
|
+
export declare enum TimelineEntryPanel {
|
|
9375
|
+
CustomerChat = "customer_chat",
|
|
9376
|
+
Discussions = "discussions",
|
|
9377
|
+
Events = "events"
|
|
9378
|
+
}
|
|
8146
9379
|
export declare enum TimelineEntryType {
|
|
9380
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
8147
9381
|
TimelineComment = "timeline_comment"
|
|
8148
9382
|
}
|
|
8149
9383
|
/**
|
|
@@ -8232,16 +9466,16 @@ export type TrackEventsPublishResponse = object;
|
|
|
8232
9466
|
* type is 'number'.
|
|
8233
9467
|
*/
|
|
8234
9468
|
export interface Unit {
|
|
8235
|
-
/**
|
|
8236
|
-
* This represents human readable unit name of the UOM For example,
|
|
8237
|
-
* number of API calls.
|
|
8238
|
-
*/
|
|
8239
|
-
name: string;
|
|
8240
9469
|
/**
|
|
8241
9470
|
* This defines the UOM unit type. For example, for 'number of video
|
|
8242
9471
|
* calls', unit type will be a number.
|
|
8243
9472
|
*/
|
|
8244
9473
|
type: UnitType;
|
|
9474
|
+
/**
|
|
9475
|
+
* This represents human readable unit name of the UOM For example,
|
|
9476
|
+
* number of API calls.
|
|
9477
|
+
*/
|
|
9478
|
+
name: string;
|
|
8245
9479
|
}
|
|
8246
9480
|
/**
|
|
8247
9481
|
* This defines the UOM unit type. For example, for 'number of video
|
|
@@ -8560,6 +9794,65 @@ export interface UomsUpdateRequestDimensions {
|
|
|
8560
9794
|
export interface UomsUpdateResponse {
|
|
8561
9795
|
uom: Uom;
|
|
8562
9796
|
}
|
|
9797
|
+
/** update-incident-applies-to-parts */
|
|
9798
|
+
export interface UpdateIncidentAppliesToParts {
|
|
9799
|
+
/** Sets the parts to which the incident is applicable to. */
|
|
9800
|
+
set?: string[];
|
|
9801
|
+
}
|
|
9802
|
+
/** update-incident-artifacts */
|
|
9803
|
+
export interface UpdateIncidentArtifacts {
|
|
9804
|
+
/**
|
|
9805
|
+
* Sets the artifacts attached to the incident.
|
|
9806
|
+
* @example ["ARTIFACT-12345"]
|
|
9807
|
+
*/
|
|
9808
|
+
set?: string[];
|
|
9809
|
+
}
|
|
9810
|
+
/** update-incident-impacted-customers */
|
|
9811
|
+
export interface UpdateIncidentImpactedCustomers {
|
|
9812
|
+
/** Sets the list of customers impacted due to the incident. */
|
|
9813
|
+
set?: string[];
|
|
9814
|
+
}
|
|
9815
|
+
/** update-incident-owned-by */
|
|
9816
|
+
export interface UpdateIncidentOwnedBy {
|
|
9817
|
+
/** Sets the user IDs of the users that own the incident. */
|
|
9818
|
+
set?: string[];
|
|
9819
|
+
}
|
|
9820
|
+
/** update-incident-stakeholders */
|
|
9821
|
+
export interface UpdateIncidentStakeholders {
|
|
9822
|
+
/**
|
|
9823
|
+
* Sets the users, along with the incident commander, involved in
|
|
9824
|
+
* resolving incidents and handling communication.
|
|
9825
|
+
*/
|
|
9826
|
+
set?: string[];
|
|
9827
|
+
}
|
|
9828
|
+
/** update-incident-tags */
|
|
9829
|
+
export interface UpdateIncidentTags {
|
|
9830
|
+
/** Sets the tags associated with the object. */
|
|
9831
|
+
set?: UpdateTagWithValue[];
|
|
9832
|
+
}
|
|
9833
|
+
/**
|
|
9834
|
+
* update-stage
|
|
9835
|
+
* Update object for Stage.
|
|
9836
|
+
*/
|
|
9837
|
+
export interface UpdateStage {
|
|
9838
|
+
/** Notes relevant to the stage */
|
|
9839
|
+
notes?: string;
|
|
9840
|
+
/** DON of the stage. */
|
|
9841
|
+
stage?: string;
|
|
9842
|
+
}
|
|
9843
|
+
/**
|
|
9844
|
+
* update-tag-with-value
|
|
9845
|
+
* Update object for TagWithValue.
|
|
9846
|
+
*/
|
|
9847
|
+
export interface UpdateTagWithValue {
|
|
9848
|
+
/**
|
|
9849
|
+
* ID of the referenced tag
|
|
9850
|
+
* @example "TAG-12345"
|
|
9851
|
+
*/
|
|
9852
|
+
tag_id?: string;
|
|
9853
|
+
/** Value associated with the tag for the object. */
|
|
9854
|
+
value?: string;
|
|
9855
|
+
}
|
|
8563
9856
|
/** user-base */
|
|
8564
9857
|
export type UserBase = AtomBase & {
|
|
8565
9858
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -8638,6 +9931,8 @@ export declare enum VistaGroupItemState {
|
|
|
8638
9931
|
* Vista group item.
|
|
8639
9932
|
*/
|
|
8640
9933
|
export interface VistaGroupItemSummary {
|
|
9934
|
+
/** Type of the group object. */
|
|
9935
|
+
type: VistaGroupItemType;
|
|
8641
9936
|
/**
|
|
8642
9937
|
* Timestamp when the vista ends.
|
|
8643
9938
|
* @format date-time
|
|
@@ -8656,8 +9951,6 @@ export interface VistaGroupItemSummary {
|
|
|
8656
9951
|
start_date?: string;
|
|
8657
9952
|
/** Defines the state of the group item. */
|
|
8658
9953
|
state?: VistaGroupItemState;
|
|
8659
|
-
/** Type of the group object. */
|
|
8660
|
-
type: VistaGroupItemType;
|
|
8661
9954
|
}
|
|
8662
9955
|
/** Type of the group object. */
|
|
8663
9956
|
export declare enum VistaGroupItemType {
|
|
@@ -8687,6 +9980,8 @@ export declare enum VistaType {
|
|
|
8687
9980
|
export type Webhook = AtomBase & {
|
|
8688
9981
|
/** The event types that the webhook will receive. */
|
|
8689
9982
|
event_types?: WebhookEventType[];
|
|
9983
|
+
/** Headers that are provided with every webhook invocation. */
|
|
9984
|
+
headers?: WebhookHeader[];
|
|
8690
9985
|
/**
|
|
8691
9986
|
* The secret to use for verifying webhook events.
|
|
8692
9987
|
* @format byte
|
|
@@ -8699,6 +9994,8 @@ export type Webhook = AtomBase & {
|
|
|
8699
9994
|
};
|
|
8700
9995
|
/** webhook-event-request */
|
|
8701
9996
|
export interface WebhookEventRequest {
|
|
9997
|
+
/** The event types that the webhook will receive. */
|
|
9998
|
+
type?: WebhookEventType;
|
|
8702
9999
|
account_created?: EventAccountCreated;
|
|
8703
10000
|
account_deleted?: EventAccountDeleted;
|
|
8704
10001
|
account_updated?: EventAccountUpdated;
|
|
@@ -8708,8 +10005,16 @@ export interface WebhookEventRequest {
|
|
|
8708
10005
|
dev_user_created?: EventDevUserCreated;
|
|
8709
10006
|
dev_user_deleted?: EventDevUserDeleted;
|
|
8710
10007
|
dev_user_updated?: EventDevUserUpdated;
|
|
10008
|
+
group_created?: EventGroupCreated;
|
|
10009
|
+
group_deleted?: EventGroupDeleted;
|
|
10010
|
+
group_member_added?: EventGroupMemberAdded;
|
|
10011
|
+
group_member_removed?: EventGroupMemberRemoved;
|
|
10012
|
+
group_updated?: EventGroupUpdated;
|
|
8711
10013
|
/** The event's ID. */
|
|
8712
10014
|
id: string;
|
|
10015
|
+
link_created?: EventLinkCreated;
|
|
10016
|
+
link_deleted?: EventLinkDeleted;
|
|
10017
|
+
link_updated?: EventLinkUpdated;
|
|
8713
10018
|
part_created?: EventPartCreated;
|
|
8714
10019
|
part_deleted?: EventPartDeleted;
|
|
8715
10020
|
part_updated?: EventPartUpdated;
|
|
@@ -8740,8 +10045,6 @@ export interface WebhookEventRequest {
|
|
|
8740
10045
|
* @example "2023-01-01T12:00:00.000Z"
|
|
8741
10046
|
*/
|
|
8742
10047
|
timestamp?: string;
|
|
8743
|
-
/** The event types that the webhook will receive. */
|
|
8744
|
-
type?: WebhookEventType;
|
|
8745
10048
|
verify?: WebhookEventVerify;
|
|
8746
10049
|
webhook_created?: EventWebhookCreated;
|
|
8747
10050
|
webhook_deleted?: EventWebhookDeleted;
|
|
@@ -8775,6 +10078,14 @@ export declare enum WebhookEventType {
|
|
|
8775
10078
|
DevUserCreated = "dev_user_created",
|
|
8776
10079
|
DevUserDeleted = "dev_user_deleted",
|
|
8777
10080
|
DevUserUpdated = "dev_user_updated",
|
|
10081
|
+
GroupCreated = "group_created",
|
|
10082
|
+
GroupDeleted = "group_deleted",
|
|
10083
|
+
GroupMemberAdded = "group_member_added",
|
|
10084
|
+
GroupMemberRemoved = "group_member_removed",
|
|
10085
|
+
GroupUpdated = "group_updated",
|
|
10086
|
+
LinkCreated = "link_created",
|
|
10087
|
+
LinkDeleted = "link_deleted",
|
|
10088
|
+
LinkUpdated = "link_updated",
|
|
8778
10089
|
PartCreated = "part_created",
|
|
8779
10090
|
PartDeleted = "part_deleted",
|
|
8780
10091
|
PartUpdated = "part_updated",
|
|
@@ -8809,6 +10120,19 @@ export interface WebhookEventVerify {
|
|
|
8809
10120
|
*/
|
|
8810
10121
|
challenge: string;
|
|
8811
10122
|
}
|
|
10123
|
+
/**
|
|
10124
|
+
* webhook-header
|
|
10125
|
+
* Defines a header that's provided with every webhook invocation.
|
|
10126
|
+
*/
|
|
10127
|
+
export interface WebhookHeader {
|
|
10128
|
+
/**
|
|
10129
|
+
* The name of the header. Only alphanumeric ASCII characters,
|
|
10130
|
+
* hyphens, and underscores are permitted.
|
|
10131
|
+
*/
|
|
10132
|
+
name: string;
|
|
10133
|
+
/** The header's value. */
|
|
10134
|
+
value: string;
|
|
10135
|
+
}
|
|
8812
10136
|
/** The status of the webhook. */
|
|
8813
10137
|
export declare enum WebhookStatus {
|
|
8814
10138
|
Active = "active",
|
|
@@ -8824,6 +10148,11 @@ export type WebhookSummary = AtomBaseSummary;
|
|
|
8824
10148
|
export interface WebhooksCreateRequest {
|
|
8825
10149
|
/** The event types that the webhook endpoint will receive. */
|
|
8826
10150
|
event_types?: WebhookEventType[];
|
|
10151
|
+
/**
|
|
10152
|
+
* The headers to include in every webhook invocation.
|
|
10153
|
+
* @maxItems 8
|
|
10154
|
+
*/
|
|
10155
|
+
headers?: WebhookHeader[];
|
|
8827
10156
|
/**
|
|
8828
10157
|
* The secret to use when verifying webhook events. If provided, the
|
|
8829
10158
|
* secret must be between 8 and 32 bytes (inclusive). If not set, a
|
|
@@ -8902,6 +10231,7 @@ export interface WebhooksUpdateRequest {
|
|
|
8902
10231
|
/** The action to update the webhook's status. */
|
|
8903
10232
|
action?: WebhooksUpdateAction;
|
|
8904
10233
|
event_types?: WebhooksUpdateRequestEventTypes;
|
|
10234
|
+
headers?: WebhooksUpdateRequestHeaders;
|
|
8905
10235
|
/**
|
|
8906
10236
|
* ID for the webhook.
|
|
8907
10237
|
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
@@ -8944,6 +10274,27 @@ export interface WebhooksUpdateRequestEventTypes {
|
|
|
8944
10274
|
*/
|
|
8945
10275
|
set?: WebhookEventType[];
|
|
8946
10276
|
}
|
|
10277
|
+
/** webhooks-update-request-headers */
|
|
10278
|
+
export interface WebhooksUpdateRequestHeaders {
|
|
10279
|
+
/**
|
|
10280
|
+
* The headers to be added to every webhook invocation. If a provided
|
|
10281
|
+
* header is already specified for the webhook, its value is replaced.
|
|
10282
|
+
* @maxItems 8
|
|
10283
|
+
*/
|
|
10284
|
+
add?: WebhookHeader[];
|
|
10285
|
+
/**
|
|
10286
|
+
* The headers to be removed from every webhook invocation. If a
|
|
10287
|
+
* provided header is not specified for the webhook, then it's
|
|
10288
|
+
* ignored.
|
|
10289
|
+
* @maxItems 8
|
|
10290
|
+
*/
|
|
10291
|
+
remove?: string[];
|
|
10292
|
+
/**
|
|
10293
|
+
* Sets the headers to include in every webhook invocation.
|
|
10294
|
+
* @maxItems 8
|
|
10295
|
+
*/
|
|
10296
|
+
set?: WebhookHeader[];
|
|
10297
|
+
}
|
|
8947
10298
|
/**
|
|
8948
10299
|
* webhooks-update-response
|
|
8949
10300
|
* The response to updating the webhook.
|
|
@@ -8962,6 +10313,12 @@ export type Work = (Issue | Opportunity | Task | Ticket) & {
|
|
|
8962
10313
|
};
|
|
8963
10314
|
/** work-base */
|
|
8964
10315
|
export type WorkBase = AtomBase & {
|
|
10316
|
+
/**
|
|
10317
|
+
* Timestamp when the work was actually completed.
|
|
10318
|
+
* @format date-time
|
|
10319
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10320
|
+
*/
|
|
10321
|
+
actual_close_date?: string;
|
|
8965
10322
|
applies_to_part?: PartSummary;
|
|
8966
10323
|
/** The artifacts attached to the work item. */
|
|
8967
10324
|
artifacts?: ArtifactSummary[];
|
|
@@ -9028,6 +10385,7 @@ export declare enum WorkType {
|
|
|
9028
10385
|
}
|
|
9029
10386
|
/** works-create-request */
|
|
9030
10387
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
|
|
10388
|
+
type: WorkType;
|
|
9031
10389
|
/**
|
|
9032
10390
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
9033
10391
|
* applies to. Specifying a part is required when creating tickets and
|
|
@@ -9081,7 +10439,6 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
9081
10439
|
target_close_date?: string;
|
|
9082
10440
|
/** Title of the work object. */
|
|
9083
10441
|
title: string;
|
|
9084
|
-
type: WorkType;
|
|
9085
10442
|
};
|
|
9086
10443
|
/** works-create-request-issue */
|
|
9087
10444
|
export interface WorksCreateRequestIssue {
|
|
@@ -9185,6 +10542,8 @@ export interface WorksDeleteRequest {
|
|
|
9185
10542
|
export type WorksDeleteResponse = object;
|
|
9186
10543
|
/** works-export-request */
|
|
9187
10544
|
export interface WorksExportRequest {
|
|
10545
|
+
/** Filters for work of the provided types. */
|
|
10546
|
+
type?: WorkType[];
|
|
9188
10547
|
/** Provides ways to specify date ranges on objects. */
|
|
9189
10548
|
actual_close_date?: DateFilter;
|
|
9190
10549
|
/**
|
|
@@ -9235,8 +10594,6 @@ export interface WorksExportRequest {
|
|
|
9235
10594
|
/** Provides ways to specify date ranges on objects. */
|
|
9236
10595
|
target_close_date?: DateFilter;
|
|
9237
10596
|
ticket?: WorksFilterTicket;
|
|
9238
|
-
/** Filters for work of the provided types. */
|
|
9239
|
-
type?: WorkType[];
|
|
9240
10597
|
}
|
|
9241
10598
|
/** works-export-response */
|
|
9242
10599
|
export interface WorksExportResponse {
|
|
@@ -9261,6 +10618,8 @@ export interface WorksFilterIssue {
|
|
|
9261
10618
|
* @example ["REV-AbCdEfGh"]
|
|
9262
10619
|
*/
|
|
9263
10620
|
rev_orgs?: string[];
|
|
10621
|
+
/** The filter for SLA summary. */
|
|
10622
|
+
sla_summary?: SlaSummaryFilter;
|
|
9264
10623
|
/** Filters for issues with any of the sprint. */
|
|
9265
10624
|
sprint?: string[];
|
|
9266
10625
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -9322,6 +10681,8 @@ export interface WorksGetResponse {
|
|
|
9322
10681
|
}
|
|
9323
10682
|
/** works-list-request */
|
|
9324
10683
|
export interface WorksListRequest {
|
|
10684
|
+
/** Filters for work of the provided types. */
|
|
10685
|
+
type?: WorkType[];
|
|
9325
10686
|
/** Provides ways to specify date ranges on objects. */
|
|
9326
10687
|
actual_close_date?: DateFilter;
|
|
9327
10688
|
/**
|
|
@@ -9384,8 +10745,6 @@ export interface WorksListRequest {
|
|
|
9384
10745
|
/** Provides ways to specify date ranges on objects. */
|
|
9385
10746
|
target_close_date?: DateFilter;
|
|
9386
10747
|
ticket?: WorksFilterTicket;
|
|
9387
|
-
/** Filters for work of the provided types. */
|
|
9388
|
-
type?: WorkType[];
|
|
9389
10748
|
}
|
|
9390
10749
|
/** works-list-response */
|
|
9391
10750
|
export interface WorksListResponse {
|
|
@@ -9404,6 +10763,7 @@ export interface WorksListResponse {
|
|
|
9404
10763
|
}
|
|
9405
10764
|
/** works-update-request */
|
|
9406
10765
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
10766
|
+
type?: WorkType;
|
|
9407
10767
|
/**
|
|
9408
10768
|
* Updates the part that the work item applies to.
|
|
9409
10769
|
* @example "PROD-12345"
|
|
@@ -9451,7 +10811,6 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
9451
10811
|
target_close_date?: string | null;
|
|
9452
10812
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
9453
10813
|
title?: string;
|
|
9454
|
-
type?: WorkType;
|
|
9455
10814
|
};
|
|
9456
10815
|
/** works-update-request-artifacts */
|
|
9457
10816
|
export interface WorksUpdateRequestArtifacts {
|
|
@@ -9556,6 +10915,10 @@ export interface WorksUpdateRequestStagedInfoStagedInfoUpdate {
|
|
|
9556
10915
|
}
|
|
9557
10916
|
/** works-update-request-tags */
|
|
9558
10917
|
export interface WorksUpdateRequestTags {
|
|
10918
|
+
/** Adds the provided tags on the work item. */
|
|
10919
|
+
add?: AddTagWithValue[];
|
|
10920
|
+
/** Removes the provided tags on the work item. */
|
|
10921
|
+
remove?: RemoveTagWithValue[];
|
|
9559
10922
|
/** Sets the provided tags on the work item. */
|
|
9560
10923
|
set?: SetTagWithValue[];
|
|
9561
10924
|
}
|
|
@@ -9586,6 +10949,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
9586
10949
|
* @example "REV-AbCdEfGh"
|
|
9587
10950
|
*/
|
|
9588
10951
|
rev_org?: string | null;
|
|
10952
|
+
/**
|
|
10953
|
+
* The enum ID for the sentiment of the ticket.
|
|
10954
|
+
* @format int64
|
|
10955
|
+
*/
|
|
10956
|
+
sentiment?: number;
|
|
9589
10957
|
/** Severity of the ticket. */
|
|
9590
10958
|
severity?: TicketSeverity;
|
|
9591
10959
|
}
|
|
@@ -9863,6 +11231,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9863
11231
|
* @example ["PROD-12345"]
|
|
9864
11232
|
*/
|
|
9865
11233
|
applies_to_parts?: string[];
|
|
11234
|
+
/**
|
|
11235
|
+
* Filter for the type of articles. If this is not provided, then
|
|
11236
|
+
* articles that are not content blocks are returned.
|
|
11237
|
+
*/
|
|
11238
|
+
article_type?: ArticleType[];
|
|
9866
11239
|
/**
|
|
9867
11240
|
* Filters for articles authored by any of the provided users.
|
|
9868
11241
|
* @example ["DEVU-12345"]
|
|
@@ -9883,6 +11256,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9883
11256
|
* @example ["DEVU-12345"]
|
|
9884
11257
|
*/
|
|
9885
11258
|
owned_by?: string[];
|
|
11259
|
+
/**
|
|
11260
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
11261
|
+
* only external articles are returned.
|
|
11262
|
+
*/
|
|
11263
|
+
scope?: number[];
|
|
9886
11264
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
9887
11265
|
/**
|
|
9888
11266
|
* @description Get count of articles matching given filter.
|
|
@@ -9949,6 +11327,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9949
11327
|
* @example ["PROD-12345"]
|
|
9950
11328
|
*/
|
|
9951
11329
|
applies_to_parts?: string[];
|
|
11330
|
+
/**
|
|
11331
|
+
* Filter for the type of articles. If this is not provided, then
|
|
11332
|
+
* articles that are not content blocks are returned.
|
|
11333
|
+
*/
|
|
11334
|
+
article_type?: ArticleType[];
|
|
9952
11335
|
/**
|
|
9953
11336
|
* Filters for articles authored by any of the provided users.
|
|
9954
11337
|
* @example ["DEVU-12345"]
|
|
@@ -9984,6 +11367,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9984
11367
|
* @example ["DEVU-12345"]
|
|
9985
11368
|
*/
|
|
9986
11369
|
owned_by?: string[];
|
|
11370
|
+
/**
|
|
11371
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
11372
|
+
* only external articles are returned.
|
|
11373
|
+
*/
|
|
11374
|
+
scope?: number[];
|
|
9987
11375
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
9988
11376
|
/**
|
|
9989
11377
|
* @description Lists a collection of articles.
|
|
@@ -10269,6 +11657,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10269
11657
|
* @secure
|
|
10270
11658
|
*/
|
|
10271
11659
|
codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any>>;
|
|
11660
|
+
/**
|
|
11661
|
+
* @description Create the content template.
|
|
11662
|
+
*
|
|
11663
|
+
* @tags notifications
|
|
11664
|
+
* @name ContentTemplateCreate
|
|
11665
|
+
* @request POST:/content-template.create
|
|
11666
|
+
* @secure
|
|
11667
|
+
*/
|
|
11668
|
+
contentTemplateCreate: (data: ContentTemplateCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateCreateResponse, any>>;
|
|
11669
|
+
/**
|
|
11670
|
+
* @description Get the content template.
|
|
11671
|
+
*
|
|
11672
|
+
* @tags notifications
|
|
11673
|
+
* @name ContentTemplateGet
|
|
11674
|
+
* @request GET:/content-template.get
|
|
11675
|
+
* @secure
|
|
11676
|
+
*/
|
|
11677
|
+
contentTemplateGet: (query: {
|
|
11678
|
+
/** The content template's ID. */
|
|
11679
|
+
id: string;
|
|
11680
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
|
|
11681
|
+
/**
|
|
11682
|
+
* @description Get the content template.
|
|
11683
|
+
*
|
|
11684
|
+
* @tags notifications
|
|
11685
|
+
* @name ContentTemplateGetPost
|
|
11686
|
+
* @request POST:/content-template.get
|
|
11687
|
+
* @secure
|
|
11688
|
+
*/
|
|
11689
|
+
contentTemplateGetPost: (data: ContentTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
|
|
11690
|
+
/**
|
|
11691
|
+
* @description Lists the content templates.
|
|
11692
|
+
*
|
|
11693
|
+
* @tags notifications
|
|
11694
|
+
* @name ContentTemplateList
|
|
11695
|
+
* @request GET:/content-template.list
|
|
11696
|
+
* @secure
|
|
11697
|
+
*/
|
|
11698
|
+
contentTemplateList: (query?: {
|
|
11699
|
+
/**
|
|
11700
|
+
* Filters for content template created by any of these users.
|
|
11701
|
+
* @example ["DEVU-12345"]
|
|
11702
|
+
*/
|
|
11703
|
+
created_by?: string[];
|
|
11704
|
+
/**
|
|
11705
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11706
|
+
* starts from the beginning.
|
|
11707
|
+
*/
|
|
11708
|
+
cursor?: string;
|
|
11709
|
+
/**
|
|
11710
|
+
* The maximum number of content template to return. The default is
|
|
11711
|
+
* '50'.
|
|
11712
|
+
* @format int32
|
|
11713
|
+
*/
|
|
11714
|
+
limit?: number;
|
|
11715
|
+
/**
|
|
11716
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11717
|
+
* used.
|
|
11718
|
+
*/
|
|
11719
|
+
mode?: ListMode;
|
|
11720
|
+
/** Filters for content template based on name. */
|
|
11721
|
+
name?: string[];
|
|
11722
|
+
/**
|
|
11723
|
+
* Fields to sort the content template by and the direction to sort
|
|
11724
|
+
* them.
|
|
11725
|
+
*/
|
|
11726
|
+
sort_by?: string[];
|
|
11727
|
+
/** Filters for content template of the provided types. */
|
|
11728
|
+
type?: ContentTemplateType[];
|
|
11729
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
|
|
11730
|
+
/**
|
|
11731
|
+
* @description Lists the content templates.
|
|
11732
|
+
*
|
|
11733
|
+
* @tags notifications
|
|
11734
|
+
* @name ContentTemplateListPost
|
|
11735
|
+
* @request POST:/content-template.list
|
|
11736
|
+
* @secure
|
|
11737
|
+
*/
|
|
11738
|
+
contentTemplateListPost: (data: ContentTemplateListRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
|
|
10272
11739
|
/**
|
|
10273
11740
|
* @description Creates a conversation.
|
|
10274
11741
|
*
|
|
@@ -10884,6 +12351,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10884
12351
|
cursor?: string;
|
|
10885
12352
|
/** Filters the groups based on the group type. */
|
|
10886
12353
|
group_type?: GroupType[];
|
|
12354
|
+
/** Whether to fetch default or custom groups. */
|
|
12355
|
+
is_default?: boolean;
|
|
10887
12356
|
/**
|
|
10888
12357
|
* The maximum number of groups to return. The default is '50'.
|
|
10889
12358
|
* @format int32
|
|
@@ -10972,6 +12441,187 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10972
12441
|
* @secure
|
|
10973
12442
|
*/
|
|
10974
12443
|
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
12444
|
+
/**
|
|
12445
|
+
* @description Creates an incident.
|
|
12446
|
+
*
|
|
12447
|
+
* @tags operate
|
|
12448
|
+
* @name IncidentsCreate
|
|
12449
|
+
* @request POST:/incidents.create
|
|
12450
|
+
* @secure
|
|
12451
|
+
*/
|
|
12452
|
+
incidentsCreate: (data: IncidentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsCreateResponse, any>>;
|
|
12453
|
+
/**
|
|
12454
|
+
* @description Deletes an incident.
|
|
12455
|
+
*
|
|
12456
|
+
* @tags operate
|
|
12457
|
+
* @name IncidentsDelete
|
|
12458
|
+
* @request POST:/incidents.delete
|
|
12459
|
+
* @secure
|
|
12460
|
+
*/
|
|
12461
|
+
incidentsDelete: (data: IncidentsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
12462
|
+
/**
|
|
12463
|
+
* @description Gets an incident.
|
|
12464
|
+
*
|
|
12465
|
+
* @tags operate
|
|
12466
|
+
* @name IncidentsGet
|
|
12467
|
+
* @request GET:/incidents.get
|
|
12468
|
+
* @secure
|
|
12469
|
+
*/
|
|
12470
|
+
incidentsGet: (query: {
|
|
12471
|
+
/** The ID of the incident to get. */
|
|
12472
|
+
id: string;
|
|
12473
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGetResponse, any>>;
|
|
12474
|
+
/**
|
|
12475
|
+
* @description Gets an incident.
|
|
12476
|
+
*
|
|
12477
|
+
* @tags operate
|
|
12478
|
+
* @name IncidentsGetPost
|
|
12479
|
+
* @request POST:/incidents.get
|
|
12480
|
+
* @secure
|
|
12481
|
+
*/
|
|
12482
|
+
incidentsGetPost: (data: IncidentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsGetResponse, any>>;
|
|
12483
|
+
/**
|
|
12484
|
+
* @description Lists collections of incidents by groups.
|
|
12485
|
+
*
|
|
12486
|
+
* @tags operate
|
|
12487
|
+
* @name IncidentsGroup
|
|
12488
|
+
* @request GET:/incidents.group
|
|
12489
|
+
* @secure
|
|
12490
|
+
*/
|
|
12491
|
+
incidentsGroup: (query: {
|
|
12492
|
+
/** The field to group the incidents by. */
|
|
12493
|
+
group_by: string;
|
|
12494
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
12495
|
+
applies_to_parts?: string[];
|
|
12496
|
+
/**
|
|
12497
|
+
* Filters for incidents created by any of the provided users.
|
|
12498
|
+
* @example ["DEVU-12345"]
|
|
12499
|
+
*/
|
|
12500
|
+
created_by?: string[];
|
|
12501
|
+
/**
|
|
12502
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
12503
|
+
* starts from the beginning.
|
|
12504
|
+
*/
|
|
12505
|
+
cursor?: string;
|
|
12506
|
+
/**
|
|
12507
|
+
* The maximum number of groups to return. If not set, then the default
|
|
12508
|
+
* is '10'.
|
|
12509
|
+
* @format int32
|
|
12510
|
+
*/
|
|
12511
|
+
limit?: number;
|
|
12512
|
+
/**
|
|
12513
|
+
* The maximum number of incidents to return for an individual group.
|
|
12514
|
+
* The default is '50'.
|
|
12515
|
+
* @format int32
|
|
12516
|
+
*/
|
|
12517
|
+
limit_per_group?: number;
|
|
12518
|
+
/**
|
|
12519
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
12520
|
+
* used.
|
|
12521
|
+
*/
|
|
12522
|
+
mode?: ListMode;
|
|
12523
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
12524
|
+
owned_by?: string[];
|
|
12525
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
12526
|
+
severity?: number[];
|
|
12527
|
+
/** Comma-separated fields to sort the incidents by. */
|
|
12528
|
+
sort_by?: string[];
|
|
12529
|
+
/** Filters for incidents in any of the provided stages. */
|
|
12530
|
+
stage?: string[];
|
|
12531
|
+
/** Filters for incidents by the provided titles. */
|
|
12532
|
+
title?: string[];
|
|
12533
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
12534
|
+
/**
|
|
12535
|
+
* @description Lists collections of incidents by groups.
|
|
12536
|
+
*
|
|
12537
|
+
* @tags operate
|
|
12538
|
+
* @name IncidentsGroupPost
|
|
12539
|
+
* @request POST:/incidents.group
|
|
12540
|
+
* @secure
|
|
12541
|
+
*/
|
|
12542
|
+
incidentsGroupPost: (data: IncidentsGroupRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
12543
|
+
/**
|
|
12544
|
+
* @description Lists incidents.
|
|
12545
|
+
*
|
|
12546
|
+
* @tags operate
|
|
12547
|
+
* @name IncidentsList
|
|
12548
|
+
* @request GET:/incidents.list
|
|
12549
|
+
* @secure
|
|
12550
|
+
*/
|
|
12551
|
+
incidentsList: (query?: {
|
|
12552
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
12553
|
+
applies_to_parts?: string[];
|
|
12554
|
+
/**
|
|
12555
|
+
* Filters for incidents created by any of the provided users.
|
|
12556
|
+
* @example ["DEVU-12345"]
|
|
12557
|
+
*/
|
|
12558
|
+
created_by?: string[];
|
|
12559
|
+
/**
|
|
12560
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
12561
|
+
* starts from the beginning.
|
|
12562
|
+
*/
|
|
12563
|
+
cursor?: string;
|
|
12564
|
+
/**
|
|
12565
|
+
* The maximum number of items.
|
|
12566
|
+
* @format int32
|
|
12567
|
+
*/
|
|
12568
|
+
limit?: number;
|
|
12569
|
+
/**
|
|
12570
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
12571
|
+
* used.
|
|
12572
|
+
*/
|
|
12573
|
+
mode?: ListMode;
|
|
12574
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
12575
|
+
owned_by?: string[];
|
|
12576
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
12577
|
+
severity?: number[];
|
|
12578
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
12579
|
+
sort_by?: string[];
|
|
12580
|
+
/** Filters for incidents in any of the provided stages. */
|
|
12581
|
+
stage?: string[];
|
|
12582
|
+
/** Filters for incidents by the provided titles. */
|
|
12583
|
+
title?: string[];
|
|
12584
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
12585
|
+
/**
|
|
12586
|
+
* @description Lists incidents.
|
|
12587
|
+
*
|
|
12588
|
+
* @tags operate
|
|
12589
|
+
* @name IncidentsListPost
|
|
12590
|
+
* @request POST:/incidents.list
|
|
12591
|
+
* @secure
|
|
12592
|
+
*/
|
|
12593
|
+
incidentsListPost: (data: IncidentsListRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
12594
|
+
/**
|
|
12595
|
+
* @description Updates an incident.
|
|
12596
|
+
*
|
|
12597
|
+
* @tags operate
|
|
12598
|
+
* @name IncidentsUpdate
|
|
12599
|
+
* @request POST:/incidents.update
|
|
12600
|
+
* @secure
|
|
12601
|
+
*/
|
|
12602
|
+
incidentsUpdate: (data: IncidentsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsUpdateResponse, any>>;
|
|
12603
|
+
/**
|
|
12604
|
+
* @description OAuth2 authorization callback.
|
|
12605
|
+
*
|
|
12606
|
+
* @tags keyring
|
|
12607
|
+
* @name KeyringsCreateCallback
|
|
12608
|
+
* @request GET:/keyrings.authorize
|
|
12609
|
+
*/
|
|
12610
|
+
keyringsCreateCallback: (query: {
|
|
12611
|
+
/** Code to exchange for an access token. */
|
|
12612
|
+
code: string;
|
|
12613
|
+
/** State value given to the authorization request. */
|
|
12614
|
+
state: string;
|
|
12615
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
12616
|
+
/**
|
|
12617
|
+
* @description OAuth2 authorization callback.
|
|
12618
|
+
*
|
|
12619
|
+
* @tags keyring
|
|
12620
|
+
* @name KeyringsCreateCallbackPost
|
|
12621
|
+
* @request POST:/keyrings.authorize
|
|
12622
|
+
* @secure
|
|
12623
|
+
*/
|
|
12624
|
+
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
10975
12625
|
/**
|
|
10976
12626
|
* @description Creates a link between two objects to indicate a relationship.
|
|
10977
12627
|
*
|
|
@@ -11048,6 +12698,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11048
12698
|
* used.
|
|
11049
12699
|
*/
|
|
11050
12700
|
mode?: ListMode;
|
|
12701
|
+
/**
|
|
12702
|
+
* The object types to filter for, otherwise if not present, all object
|
|
12703
|
+
* types are included.
|
|
12704
|
+
*/
|
|
12705
|
+
object_types?: LinkEndpointType[];
|
|
11051
12706
|
/**
|
|
11052
12707
|
* The link types to filter for, otherwise if not present, all link
|
|
11053
12708
|
* types are included.
|
|
@@ -11118,6 +12773,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11118
12773
|
* @secure
|
|
11119
12774
|
*/
|
|
11120
12775
|
metricsDevrevIngest: (data: MetricsDataIngestRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
12776
|
+
/**
|
|
12777
|
+
* @description Generate a notification.
|
|
12778
|
+
*
|
|
12779
|
+
* @tags notifications
|
|
12780
|
+
* @name NotificationsSend
|
|
12781
|
+
* @request POST:/notifications.send
|
|
12782
|
+
* @secure
|
|
12783
|
+
*/
|
|
12784
|
+
notificationsSend: (data: NotificationsSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11121
12785
|
/**
|
|
11122
12786
|
* @description Creates an organization schedule fragment.
|
|
11123
12787
|
*
|
|
@@ -11740,6 +13404,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11740
13404
|
* @secure
|
|
11741
13405
|
*/
|
|
11742
13406
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
13407
|
+
/**
|
|
13408
|
+
* @description Scans through all Rev users.
|
|
13409
|
+
*
|
|
13410
|
+
* @tags rev-users
|
|
13411
|
+
* @name RevUsersScan
|
|
13412
|
+
* @request GET:/rev-users.scan
|
|
13413
|
+
* @secure
|
|
13414
|
+
*/
|
|
13415
|
+
revUsersScan: (query?: {
|
|
13416
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
13417
|
+
created_by?: string[];
|
|
13418
|
+
/**
|
|
13419
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
13420
|
+
* @format date-time
|
|
13421
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13422
|
+
*/
|
|
13423
|
+
'created_date.after'?: string;
|
|
13424
|
+
/**
|
|
13425
|
+
* Filters for objects created before the provided timestamp
|
|
13426
|
+
* (inclusive).
|
|
13427
|
+
* @format date-time
|
|
13428
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13429
|
+
*/
|
|
13430
|
+
'created_date.before'?: string;
|
|
13431
|
+
/**
|
|
13432
|
+
* The cursor to resume iteration, otherwise the beginning if not
|
|
13433
|
+
* provided.
|
|
13434
|
+
*/
|
|
13435
|
+
cursor?: string;
|
|
13436
|
+
/** Filters for custom fields. */
|
|
13437
|
+
custom_fields?: object;
|
|
13438
|
+
/** List of emails of Rev users to be filtered. */
|
|
13439
|
+
email?: string[];
|
|
13440
|
+
/** List of external refs to filter Rev users for. */
|
|
13441
|
+
external_ref?: string[];
|
|
13442
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
13443
|
+
is_verified?: boolean;
|
|
13444
|
+
/**
|
|
13445
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
13446
|
+
* @format date-time
|
|
13447
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13448
|
+
*/
|
|
13449
|
+
'modified_date.after'?: string;
|
|
13450
|
+
/**
|
|
13451
|
+
* Filters for objects created before the provided timestamp
|
|
13452
|
+
* (inclusive).
|
|
13453
|
+
* @format date-time
|
|
13454
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13455
|
+
*/
|
|
13456
|
+
'modified_date.before'?: string;
|
|
13457
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
13458
|
+
phone_numbers?: string[];
|
|
13459
|
+
/**
|
|
13460
|
+
* List of IDs of Rev organizations to be filtered.
|
|
13461
|
+
* @example ["REV-AbCdEfGh"]
|
|
13462
|
+
*/
|
|
13463
|
+
rev_org?: string[];
|
|
13464
|
+
/** List of tags to be filtered. */
|
|
13465
|
+
tags?: string[];
|
|
13466
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
|
|
13467
|
+
/**
|
|
13468
|
+
* @description Scans through all Rev users.
|
|
13469
|
+
*
|
|
13470
|
+
* @tags rev-users
|
|
13471
|
+
* @name RevUsersScanPost
|
|
13472
|
+
* @request POST:/rev-users.scan
|
|
13473
|
+
* @secure
|
|
13474
|
+
*/
|
|
13475
|
+
revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
|
|
11743
13476
|
/**
|
|
11744
13477
|
* @description Unlinks a rev user from a rev org.
|
|
11745
13478
|
*
|
|
@@ -12216,6 +13949,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12216
13949
|
* @secure
|
|
12217
13950
|
*/
|
|
12218
13951
|
snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
13952
|
+
/**
|
|
13953
|
+
* @description Updates a snap-in.
|
|
13954
|
+
*
|
|
13955
|
+
* @tags snap-ins
|
|
13956
|
+
* @name SnapInsUpdate
|
|
13957
|
+
* @request POST:/snap-ins.update
|
|
13958
|
+
* @secure
|
|
13959
|
+
*/
|
|
13960
|
+
snapInsUpdate: (data: SnapInsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsUpdateResponse, any>>;
|
|
12219
13961
|
/**
|
|
12220
13962
|
* @description Create a snap widget object.
|
|
12221
13963
|
*
|
|
@@ -12472,6 +14214,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12472
14214
|
* @example ["ACC-12345"]
|
|
12473
14215
|
*/
|
|
12474
14216
|
objects?: string[];
|
|
14217
|
+
/**
|
|
14218
|
+
* Filters for survey responses dispatched to any of these users.
|
|
14219
|
+
* @example ["DEVU-12345"]
|
|
14220
|
+
*/
|
|
14221
|
+
recipient?: string[];
|
|
12475
14222
|
/**
|
|
12476
14223
|
* Fields to sort the survey responses by and the direction to sort
|
|
12477
14224
|
* them.
|
|
@@ -13044,6 +14791,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13044
14791
|
* @example ["REV-AbCdEfGh"]
|
|
13045
14792
|
*/
|
|
13046
14793
|
'issue.rev_orgs'?: string[];
|
|
14794
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
14795
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
13047
14796
|
/** Filters for issues with any of the sprint. */
|
|
13048
14797
|
'issue.sprint'?: string[];
|
|
13049
14798
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -13186,6 +14935,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13186
14935
|
* @example ["REV-AbCdEfGh"]
|
|
13187
14936
|
*/
|
|
13188
14937
|
'issue.rev_orgs'?: string[];
|
|
14938
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
14939
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
13189
14940
|
/** Filters for issues with any of the sprint. */
|
|
13190
14941
|
'issue.sprint'?: string[];
|
|
13191
14942
|
/** Filters for issues with any of the provided subtypes. */
|