@devrev/typescript-sdk 1.1.27 → 1.1.29
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.
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +950 -70
- package/dist/auto-generated/beta/beta-devrev-sdk.js +140 -4
- package/dist/auto-generated/public-devrev-sdk.d.ts +247 -44
- package/dist/auto-generated/public-devrev-sdk.js +45 -2
- package/dist/snap-ins/types.d.ts +4 -0
- package/dist/snap-ins/types.test.js +4 -0
- package/package.json +1 -1
|
@@ -42,6 +42,11 @@ export type Account = OrgBase & {
|
|
|
42
42
|
/** account-search-summary */
|
|
43
43
|
export type AccountSearchSummary = SearchSummaryBase & {
|
|
44
44
|
account: AccountSummary;
|
|
45
|
+
/**
|
|
46
|
+
* Comments on the work.
|
|
47
|
+
* @maxItems 5
|
|
48
|
+
*/
|
|
49
|
+
comments?: CommentSearchSummary[];
|
|
45
50
|
};
|
|
46
51
|
/** account-summary */
|
|
47
52
|
export type AccountSummary = OrgBaseSummary;
|
|
@@ -432,6 +437,10 @@ export interface ArchetypeMetricTarget {
|
|
|
432
437
|
export type Article = AtomBase & {
|
|
433
438
|
/** Details of the parts relevant to the article. */
|
|
434
439
|
applies_to_parts: PartSummary[];
|
|
440
|
+
/** Type of the article. */
|
|
441
|
+
article_type?: ArticleType;
|
|
442
|
+
/** Users that authored the article. */
|
|
443
|
+
authored_by?: UserSummary[];
|
|
435
444
|
/** Description of the article. */
|
|
436
445
|
description?: string;
|
|
437
446
|
/** Artifacts containing the extracted content. */
|
|
@@ -446,11 +455,15 @@ export type Article = AtomBase & {
|
|
|
446
455
|
* @format int32
|
|
447
456
|
*/
|
|
448
457
|
num_upvotes?: number;
|
|
458
|
+
/** The users that own the article. */
|
|
459
|
+
owned_by: UserSummary[];
|
|
449
460
|
parent?: DirectorySummary;
|
|
450
461
|
/** Rank of the article. */
|
|
451
462
|
rank?: string;
|
|
452
463
|
/** Resource details. */
|
|
453
464
|
resource?: Resource;
|
|
465
|
+
/** The properties of an enum value. */
|
|
466
|
+
scope?: EnumValue;
|
|
454
467
|
/** Title of the article. */
|
|
455
468
|
title?: string;
|
|
456
469
|
};
|
|
@@ -472,6 +485,11 @@ export type ArticleSummary = AtomBaseSummary & {
|
|
|
472
485
|
/** Title of the article. */
|
|
473
486
|
title?: string;
|
|
474
487
|
};
|
|
488
|
+
/** Type of the article. */
|
|
489
|
+
export declare enum ArticleType {
|
|
490
|
+
Article = "article",
|
|
491
|
+
ContentBlock = "content_block"
|
|
492
|
+
}
|
|
475
493
|
/** articles-count-request */
|
|
476
494
|
export interface ArticlesCountRequest {
|
|
477
495
|
/** The ancestor directory of the articles. */
|
|
@@ -481,6 +499,11 @@ export interface ArticlesCountRequest {
|
|
|
481
499
|
* @example ["PROD-12345"]
|
|
482
500
|
*/
|
|
483
501
|
applies_to_parts?: string[];
|
|
502
|
+
/**
|
|
503
|
+
* Filter for the type of articles. If this is not provided, then
|
|
504
|
+
* articles that are not content blocks are returned.
|
|
505
|
+
*/
|
|
506
|
+
article_type?: ArticleType[];
|
|
484
507
|
/**
|
|
485
508
|
* Filters for articles authored by any of the provided users.
|
|
486
509
|
* @example ["DEVU-12345"]
|
|
@@ -501,6 +524,11 @@ export interface ArticlesCountRequest {
|
|
|
501
524
|
* @example ["DEVU-12345"]
|
|
502
525
|
*/
|
|
503
526
|
owned_by?: string[];
|
|
527
|
+
/**
|
|
528
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
529
|
+
* only external articles are returned.
|
|
530
|
+
*/
|
|
531
|
+
scope?: number[];
|
|
504
532
|
/** Filter for articles based on intended audience. */
|
|
505
533
|
shared_with?: SharedWithMembershipFilter[];
|
|
506
534
|
}
|
|
@@ -524,6 +552,8 @@ export interface ArticlesCreateRequest {
|
|
|
524
552
|
* @example ["PROD-12345"]
|
|
525
553
|
*/
|
|
526
554
|
applies_to_parts: string[];
|
|
555
|
+
/** Type of the article. */
|
|
556
|
+
article_type?: ArticleType;
|
|
527
557
|
/**
|
|
528
558
|
* The authors of the article.
|
|
529
559
|
* @example ["DEVU-12345"]
|
|
@@ -552,6 +582,11 @@ export interface ArticlesCreateRequest {
|
|
|
552
582
|
*/
|
|
553
583
|
published_at?: string;
|
|
554
584
|
resource: ArticlesCreateRequestResource;
|
|
585
|
+
/**
|
|
586
|
+
* The scope of the article.
|
|
587
|
+
* @format int64
|
|
588
|
+
*/
|
|
589
|
+
scope?: number;
|
|
555
590
|
/** Information about the role the member receives due to the share. */
|
|
556
591
|
shared_with?: SetSharedWithMembership[];
|
|
557
592
|
/** Status of the article. */
|
|
@@ -621,6 +656,11 @@ export interface ArticlesListRequest {
|
|
|
621
656
|
* @example ["PROD-12345"]
|
|
622
657
|
*/
|
|
623
658
|
applies_to_parts?: string[];
|
|
659
|
+
/**
|
|
660
|
+
* Filter for the type of articles. If this is not provided, then
|
|
661
|
+
* articles that are not content blocks are returned.
|
|
662
|
+
*/
|
|
663
|
+
article_type?: ArticleType[];
|
|
624
664
|
/**
|
|
625
665
|
* Filters for articles authored by any of the provided users.
|
|
626
666
|
* @example ["DEVU-12345"]
|
|
@@ -659,6 +699,11 @@ export interface ArticlesListRequest {
|
|
|
659
699
|
* @example ["DEVU-12345"]
|
|
660
700
|
*/
|
|
661
701
|
owned_by?: string[];
|
|
702
|
+
/**
|
|
703
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
704
|
+
* only external articles are returned.
|
|
705
|
+
*/
|
|
706
|
+
scope?: number[];
|
|
662
707
|
/** Filter for articles based on intended audience. */
|
|
663
708
|
shared_with?: SharedWithMembershipFilter[];
|
|
664
709
|
}
|
|
@@ -1001,6 +1046,11 @@ export declare enum AtomType {
|
|
|
1001
1046
|
* authentication connection that is set up for a Dev organization.
|
|
1002
1047
|
*/
|
|
1003
1048
|
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
1049
|
+
/**
|
|
1050
|
+
* Defines the type for the authentication connection. The configuration
|
|
1051
|
+
* for each authentication connection will depend on the type value.
|
|
1052
|
+
*/
|
|
1053
|
+
type: AuthConnectionType;
|
|
1004
1054
|
/**
|
|
1005
1055
|
* Display name of the authentication connection. This name will be
|
|
1006
1056
|
* visible to all the users when they sign in to this Dev
|
|
@@ -1016,11 +1066,6 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1016
1066
|
enabled?: boolean;
|
|
1017
1067
|
/** ID of the authentication connection. */
|
|
1018
1068
|
id: string;
|
|
1019
|
-
/**
|
|
1020
|
-
* Defines the type for the authentication connection. The configuration
|
|
1021
|
-
* for each authentication connection will depend on the type value.
|
|
1022
|
-
*/
|
|
1023
|
-
type: AuthConnectionType;
|
|
1024
1069
|
};
|
|
1025
1070
|
/**
|
|
1026
1071
|
* auth-connection-options-azure-ad
|
|
@@ -1155,17 +1200,25 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
1155
1200
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
1156
1201
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
1157
1202
|
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
1203
|
+
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
1158
1204
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
1159
1205
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
1160
1206
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
1161
1207
|
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
1162
|
-
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
1163
1208
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
1164
1209
|
}
|
|
1165
1210
|
/** The type of the issued token. Bearer is the only supported token type. */
|
|
1166
1211
|
export declare enum AuthTokenTokenType {
|
|
1167
1212
|
Bearer = "bearer"
|
|
1168
1213
|
}
|
|
1214
|
+
/**
|
|
1215
|
+
* auth-tokens-account-traits
|
|
1216
|
+
* Carries account info.
|
|
1217
|
+
*/
|
|
1218
|
+
export interface AuthTokensAccountTraits {
|
|
1219
|
+
/** The display name of the account. */
|
|
1220
|
+
display_name?: string;
|
|
1221
|
+
}
|
|
1169
1222
|
/**
|
|
1170
1223
|
* auth-tokens-create-request
|
|
1171
1224
|
* A request to create a new token corresponding to the requested token
|
|
@@ -1329,7 +1382,14 @@ export interface AuthTokensOrgTraits {
|
|
|
1329
1382
|
* issue a Rev session token.
|
|
1330
1383
|
*/
|
|
1331
1384
|
export interface AuthTokensRevInfo {
|
|
1332
|
-
/** An identifier which uniquely identifies
|
|
1385
|
+
/** An identifier which uniquely identifies an account. */
|
|
1386
|
+
account_ref?: string;
|
|
1387
|
+
/** Carries account info. */
|
|
1388
|
+
account_traits?: AuthTokensAccountTraits;
|
|
1389
|
+
/**
|
|
1390
|
+
* An identifier which uniquely identifies a Rev org.
|
|
1391
|
+
* @deprecated
|
|
1392
|
+
*/
|
|
1333
1393
|
org_ref?: string;
|
|
1334
1394
|
/** Carries Rev org info. */
|
|
1335
1395
|
org_traits?: AuthTokensOrgTraits;
|
|
@@ -1339,6 +1399,10 @@ export interface AuthTokensRevInfo {
|
|
|
1339
1399
|
user_ref?: string;
|
|
1340
1400
|
/** Carries Rev user info. */
|
|
1341
1401
|
user_traits?: AuthTokensUserTraits;
|
|
1402
|
+
/** An identifier which uniquely identifies a workspace. */
|
|
1403
|
+
workspace_ref?: string;
|
|
1404
|
+
/** Carries Rev org info. */
|
|
1405
|
+
workspace_traits?: AuthTokensOrgTraits;
|
|
1342
1406
|
}
|
|
1343
1407
|
/**
|
|
1344
1408
|
* auth-tokens-self-delete-request
|
|
@@ -1483,12 +1547,12 @@ export interface ClientContextCpu {
|
|
|
1483
1547
|
* Properties of client's device to be used in track API.
|
|
1484
1548
|
*/
|
|
1485
1549
|
export interface ClientContextDevice {
|
|
1550
|
+
/** Device type, example: mobile, tablet, desktop. */
|
|
1551
|
+
type?: string;
|
|
1486
1552
|
/** Device manufacturer, example: Apple. */
|
|
1487
1553
|
manufacturer?: string;
|
|
1488
1554
|
/** Device model, example: iphone 6s. */
|
|
1489
1555
|
model?: string;
|
|
1490
|
-
/** Device type, example: mobile, tablet, desktop. */
|
|
1491
|
-
type?: string;
|
|
1492
1556
|
}
|
|
1493
1557
|
/**
|
|
1494
1558
|
* client-context-engine
|
|
@@ -1530,6 +1594,16 @@ export interface ClientContextPage {
|
|
|
1530
1594
|
export type CodeChange = AtomBase & {
|
|
1531
1595
|
/** Name of the code branch in the repo. */
|
|
1532
1596
|
branch?: string;
|
|
1597
|
+
/**
|
|
1598
|
+
* Time at which the code change corresponding to this object reached
|
|
1599
|
+
* a closed or merged stage. For example, the time at which a Pull
|
|
1600
|
+
* Request was either closed without merging or successfully merged.
|
|
1601
|
+
* @format date-time
|
|
1602
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1603
|
+
*/
|
|
1604
|
+
closed_date?: string;
|
|
1605
|
+
/** Commit ID of the merged commit in the target branch. */
|
|
1606
|
+
commit_id?: string;
|
|
1533
1607
|
/** Detailed description of the contents of this change. */
|
|
1534
1608
|
description?: string;
|
|
1535
1609
|
/** Unique external identifier for this change.e.g Pull Request URL. */
|
|
@@ -1540,6 +1614,8 @@ export type CodeChange = AtomBase & {
|
|
|
1540
1614
|
repo_url?: string;
|
|
1541
1615
|
/** Source of the code change object. */
|
|
1542
1616
|
source?: CodeChangeSource;
|
|
1617
|
+
/** Name of the target branch in the repo. */
|
|
1618
|
+
target_branch?: string;
|
|
1543
1619
|
/** Title describing in brief the contents of this change. */
|
|
1544
1620
|
title?: string;
|
|
1545
1621
|
/** Details of lines of code in this code change. */
|
|
@@ -1547,6 +1623,7 @@ export type CodeChange = AtomBase & {
|
|
|
1547
1623
|
};
|
|
1548
1624
|
/** Source of the code change object. */
|
|
1549
1625
|
export declare enum CodeChangeSource {
|
|
1626
|
+
Bitbucket = "bitbucket",
|
|
1550
1627
|
Github = "github"
|
|
1551
1628
|
}
|
|
1552
1629
|
/** code-changes-create-request */
|
|
@@ -1621,6 +1698,25 @@ export interface CodeChangesUpdateRequest {
|
|
|
1621
1698
|
export interface CodeChangesUpdateResponse {
|
|
1622
1699
|
code_change: CodeChange;
|
|
1623
1700
|
}
|
|
1701
|
+
/** comment-search-summary */
|
|
1702
|
+
export interface CommentSearchSummary {
|
|
1703
|
+
comment?: TimelineCommentSummary;
|
|
1704
|
+
created_by?: UserSummary;
|
|
1705
|
+
/**
|
|
1706
|
+
* Timestamp when the comment was created.
|
|
1707
|
+
* @format date-time
|
|
1708
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1709
|
+
*/
|
|
1710
|
+
created_date?: string;
|
|
1711
|
+
/** The object that the Timeline entry belongs to. */
|
|
1712
|
+
object?: string;
|
|
1713
|
+
/** Display panels for the comment entry. */
|
|
1714
|
+
panels?: TimelineEntryPanel[];
|
|
1715
|
+
/** The objects referenced in the comment. */
|
|
1716
|
+
references?: AtomSummary[];
|
|
1717
|
+
/** Text snippet where the search hit occurred. */
|
|
1718
|
+
snippet?: string;
|
|
1719
|
+
}
|
|
1624
1720
|
/** conversation */
|
|
1625
1721
|
export type Conversation = AtomBase & {
|
|
1626
1722
|
/** Description of the conversation object. */
|
|
@@ -1655,6 +1751,11 @@ export interface ConversationMetadata {
|
|
|
1655
1751
|
}
|
|
1656
1752
|
/** conversation-search-summary */
|
|
1657
1753
|
export type ConversationSearchSummary = SearchSummaryBase & {
|
|
1754
|
+
/**
|
|
1755
|
+
* Comments on the work.
|
|
1756
|
+
* @maxItems 5
|
|
1757
|
+
*/
|
|
1758
|
+
comments?: CommentSearchSummary[];
|
|
1658
1759
|
conversation: ConversationSummary;
|
|
1659
1760
|
};
|
|
1660
1761
|
/** conversation-summary */
|
|
@@ -1667,6 +1768,7 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
1667
1768
|
* The request to create a new conversation.
|
|
1668
1769
|
*/
|
|
1669
1770
|
export interface ConversationsCreateRequest {
|
|
1771
|
+
type: ConversationsCreateRequestTypeValue;
|
|
1670
1772
|
/** Description for the conversation. */
|
|
1671
1773
|
description?: string;
|
|
1672
1774
|
/** The group that the conversation is associated with. */
|
|
@@ -1689,7 +1791,6 @@ export interface ConversationsCreateRequest {
|
|
|
1689
1791
|
tags?: SetTagWithValue[];
|
|
1690
1792
|
/** The title for the conversation. */
|
|
1691
1793
|
title?: string;
|
|
1692
|
-
type: ConversationsCreateRequestTypeValue;
|
|
1693
1794
|
/** The IDs of user sessions associated with the conversation. */
|
|
1694
1795
|
user_sessions?: string[];
|
|
1695
1796
|
}
|
|
@@ -1978,6 +2079,8 @@ export interface CreateEmailPreviewWidget {
|
|
|
1978
2079
|
in_reply_to?: string;
|
|
1979
2080
|
/** The list of inline attachments. */
|
|
1980
2081
|
inlines?: CreateEmailInlineAttachment[];
|
|
2082
|
+
/** Whether the email is spam. */
|
|
2083
|
+
is_spam?: boolean;
|
|
1981
2084
|
/** The message id of the email. */
|
|
1982
2085
|
message_id?: string;
|
|
1983
2086
|
/**
|
|
@@ -2049,6 +2152,12 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
2049
2152
|
* Static collection of Devrev objects.
|
|
2050
2153
|
*/
|
|
2051
2154
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
2155
|
+
/** custom-object-search-summary */
|
|
2156
|
+
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2157
|
+
custom_object: CustomObjectSummary;
|
|
2158
|
+
};
|
|
2159
|
+
/** custom-object-summary */
|
|
2160
|
+
export type CustomObjectSummary = AtomBaseSummary;
|
|
2052
2161
|
/** custom-schema-fragment */
|
|
2053
2162
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
2054
2163
|
type: CustomSchemaFragmentType;
|
|
@@ -2163,6 +2272,7 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2163
2272
|
}
|
|
2164
2273
|
/** custom-schema-fragments-set-request */
|
|
2165
2274
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2275
|
+
type: CustomSchemaFragmentsSetRequestType;
|
|
2166
2276
|
/** List of conditions for this fragment. */
|
|
2167
2277
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2168
2278
|
/** List of field names which are being dropped. */
|
|
@@ -2177,7 +2287,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
2177
2287
|
is_custom_leaf_type?: boolean;
|
|
2178
2288
|
/** The leaf type this fragment applies to. */
|
|
2179
2289
|
leaf_type: string;
|
|
2180
|
-
type: CustomSchemaFragmentsSetRequestType;
|
|
2181
2290
|
};
|
|
2182
2291
|
/** custom-schema-fragments-set-request-app-fragment */
|
|
2183
2292
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
@@ -2237,6 +2346,8 @@ export interface CustomSchemaSpec {
|
|
|
2237
2346
|
}
|
|
2238
2347
|
/** custom-stage */
|
|
2239
2348
|
export type CustomStage = AtomBase;
|
|
2349
|
+
/** custom-stage-summary */
|
|
2350
|
+
export type CustomStageSummary = AtomBaseSummary;
|
|
2240
2351
|
/** custom-stages-create-request */
|
|
2241
2352
|
export interface CustomStagesCreateRequest {
|
|
2242
2353
|
/**
|
|
@@ -2482,6 +2593,11 @@ export declare enum DateTimePresetType {
|
|
|
2482
2593
|
* Request to create a new enterprise authentication connection.
|
|
2483
2594
|
*/
|
|
2484
2595
|
export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
|
|
2596
|
+
/**
|
|
2597
|
+
* Defines the type for the authentication connection. Different types of
|
|
2598
|
+
* authentication connections have different configuration parameters.
|
|
2599
|
+
*/
|
|
2600
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
2485
2601
|
/**
|
|
2486
2602
|
* Display name of the authentication connection. This name will be
|
|
2487
2603
|
* visible to all the users when they sign in to this Dev
|
|
@@ -2489,11 +2605,6 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2489
2605
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
2490
2606
|
*/
|
|
2491
2607
|
display_name?: string;
|
|
2492
|
-
/**
|
|
2493
|
-
* Defines the type for the authentication connection. Different types of
|
|
2494
|
-
* authentication connections have different configuration parameters.
|
|
2495
|
-
*/
|
|
2496
|
-
type: DevOrgAuthConnectionsCreateRequestType;
|
|
2497
2608
|
};
|
|
2498
2609
|
/**
|
|
2499
2610
|
* Defines the type for the authentication connection. Different types of
|
|
@@ -2576,6 +2687,12 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
2576
2687
|
* organization.
|
|
2577
2688
|
*/
|
|
2578
2689
|
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
|
|
2690
|
+
/**
|
|
2691
|
+
* Specifies the type for the authentication connection. Different types
|
|
2692
|
+
* of authentication connections have different configuration parameters
|
|
2693
|
+
* that can be updated.
|
|
2694
|
+
*/
|
|
2695
|
+
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
2579
2696
|
/**
|
|
2580
2697
|
* New display name of the authentication connection. This name will
|
|
2581
2698
|
* be visible to all the users when they sign in to this Dev
|
|
@@ -2585,12 +2702,6 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2585
2702
|
display_name?: string;
|
|
2586
2703
|
/** ID of the authentication connection which is to be updated. */
|
|
2587
2704
|
id: string;
|
|
2588
|
-
/**
|
|
2589
|
-
* Specifies the type for the authentication connection. Different types
|
|
2590
|
-
* of authentication connections have different configuration parameters
|
|
2591
|
-
* that can be updated.
|
|
2592
|
-
*/
|
|
2593
|
-
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
2594
2705
|
};
|
|
2595
2706
|
/**
|
|
2596
2707
|
* Specifies the type for the authentication connection. Different types
|
|
@@ -2675,6 +2786,8 @@ export interface DevUsersGetResponse {
|
|
|
2675
2786
|
* Request to link external identity to a Dev user.
|
|
2676
2787
|
*/
|
|
2677
2788
|
export interface DevUsersIdentitiesLinkRequest {
|
|
2789
|
+
/** The ID of the Dev user to link the external identity to. */
|
|
2790
|
+
dev_user: string;
|
|
2678
2791
|
/** Display name of the Dev user in the external source. */
|
|
2679
2792
|
display_name?: string;
|
|
2680
2793
|
/** Unique ID of the Dev user in the external source. */
|
|
@@ -2694,6 +2807,8 @@ export interface DevUsersIdentitiesLinkResponse {
|
|
|
2694
2807
|
* Request to unlink an external identity from a Dev user.
|
|
2695
2808
|
*/
|
|
2696
2809
|
export interface DevUsersIdentitiesUnlinkRequest {
|
|
2810
|
+
/** The ID of the Dev user to unlink the external identity from. */
|
|
2811
|
+
dev_user: string;
|
|
2697
2812
|
/** Issuer that needs to be unlinked from a Dev user. */
|
|
2698
2813
|
issuer: string;
|
|
2699
2814
|
}
|
|
@@ -2710,6 +2825,8 @@ export interface DevUsersIdentitiesUnlinkResponse {
|
|
|
2710
2825
|
* A request to get the list of Dev user's information.
|
|
2711
2826
|
*/
|
|
2712
2827
|
export interface DevUsersListRequest {
|
|
2828
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2829
|
+
created_date?: DateFilter;
|
|
2713
2830
|
/**
|
|
2714
2831
|
* The cursor to resume iteration from. If not provided, then
|
|
2715
2832
|
* iteration starts from the beginning.
|
|
@@ -2732,6 +2849,8 @@ export interface DevUsersListRequest {
|
|
|
2732
2849
|
* always be returned in the specified sort-by order.
|
|
2733
2850
|
*/
|
|
2734
2851
|
mode?: ListMode;
|
|
2852
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2853
|
+
modified_date?: DateFilter;
|
|
2735
2854
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
2736
2855
|
sort_by?: string[];
|
|
2737
2856
|
/** Filters Dev users based on state. */
|
|
@@ -2843,6 +2962,8 @@ export type EmailPreviewWidget = SnapWidgetBase & {
|
|
|
2843
2962
|
in_reply_to?: string;
|
|
2844
2963
|
/** The list of inline attachments. */
|
|
2845
2964
|
inlines: EmailInlineAttachment[];
|
|
2965
|
+
/** Whether the email is spam. */
|
|
2966
|
+
is_spam?: boolean;
|
|
2846
2967
|
/** The message id of the email. */
|
|
2847
2968
|
message_id?: string;
|
|
2848
2969
|
raw_email_artifact?: ArtifactSummary;
|
|
@@ -2884,6 +3005,8 @@ export declare enum EngagementType {
|
|
|
2884
3005
|
}
|
|
2885
3006
|
/** engagements-count-request */
|
|
2886
3007
|
export interface EngagementsCountRequest {
|
|
3008
|
+
/** Filters for engagement of the provided types. */
|
|
3009
|
+
type?: EngagementType[];
|
|
2887
3010
|
/** Filters for meetings with the provided external_refs. */
|
|
2888
3011
|
external_ref?: string[];
|
|
2889
3012
|
/**
|
|
@@ -2896,8 +3019,6 @@ export interface EngagementsCountRequest {
|
|
|
2896
3019
|
* @example ["ACC-12345"]
|
|
2897
3020
|
*/
|
|
2898
3021
|
parent?: string[];
|
|
2899
|
-
/** Filters for engagement of the provided types. */
|
|
2900
|
-
type?: EngagementType[];
|
|
2901
3022
|
}
|
|
2902
3023
|
/** engagements-count-response */
|
|
2903
3024
|
export interface EngagementsCountResponse {
|
|
@@ -2976,6 +3097,8 @@ export interface EngagementsGetResponse {
|
|
|
2976
3097
|
}
|
|
2977
3098
|
/** engagements-list-request */
|
|
2978
3099
|
export interface EngagementsListRequest {
|
|
3100
|
+
/** Filters for engagement of the provided types. */
|
|
3101
|
+
type?: EngagementType[];
|
|
2979
3102
|
/**
|
|
2980
3103
|
* The cursor to resume iteration from. If not provided, then
|
|
2981
3104
|
* iteration starts from the beginning.
|
|
@@ -3008,8 +3131,6 @@ export interface EngagementsListRequest {
|
|
|
3008
3131
|
parent?: string[];
|
|
3009
3132
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
3010
3133
|
sort_by?: string[];
|
|
3011
|
-
/** Filters for engagement of the provided types. */
|
|
3012
|
-
type?: EngagementType[];
|
|
3013
3134
|
}
|
|
3014
3135
|
/** engagements-list-response */
|
|
3015
3136
|
export interface EngagementsListResponse {
|
|
@@ -3081,24 +3202,26 @@ export type Enhancement = PartBase;
|
|
|
3081
3202
|
export type EnhancementSummary = PartBaseSummary;
|
|
3082
3203
|
/**
|
|
3083
3204
|
* enum-value
|
|
3084
|
-
*
|
|
3205
|
+
* The properties of an enum value.
|
|
3085
3206
|
*/
|
|
3086
3207
|
export interface EnumValue {
|
|
3087
3208
|
/**
|
|
3088
|
-
*
|
|
3209
|
+
* The uiique ID of the enum value.
|
|
3089
3210
|
* @format int64
|
|
3090
3211
|
*/
|
|
3091
3212
|
id: number;
|
|
3092
|
-
/**
|
|
3213
|
+
/** The display label of the enum value. */
|
|
3093
3214
|
label: string;
|
|
3094
3215
|
/**
|
|
3095
|
-
*
|
|
3216
|
+
* Used for determining the relative order of the enum value.
|
|
3096
3217
|
* @format int64
|
|
3097
3218
|
*/
|
|
3098
3219
|
ordinal: number;
|
|
3099
3220
|
}
|
|
3100
3221
|
/** error */
|
|
3101
3222
|
export interface Error {
|
|
3223
|
+
/** The error type. */
|
|
3224
|
+
type?: string;
|
|
3102
3225
|
/** Information about the error. */
|
|
3103
3226
|
message: string;
|
|
3104
3227
|
/**
|
|
@@ -3106,11 +3229,9 @@ export interface Error {
|
|
|
3106
3229
|
* @format int32
|
|
3107
3230
|
*/
|
|
3108
3231
|
status: number;
|
|
3109
|
-
/** The error type. */
|
|
3110
|
-
type?: string;
|
|
3111
3232
|
}
|
|
3112
3233
|
/** error-bad-request */
|
|
3113
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3234
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3114
3235
|
type: ErrorBadRequestType;
|
|
3115
3236
|
};
|
|
3116
3237
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -3141,6 +3262,49 @@ export interface ErrorBadRequestInvalidField {
|
|
|
3141
3262
|
/** The field name that's invalid. */
|
|
3142
3263
|
field_name: string;
|
|
3143
3264
|
}
|
|
3265
|
+
/** error-bad-request-invalid-id */
|
|
3266
|
+
export interface ErrorBadRequestInvalidId {
|
|
3267
|
+
/** The field whose ID is invalid. */
|
|
3268
|
+
field_name: string;
|
|
3269
|
+
}
|
|
3270
|
+
/** error-bad-request-merge-works-error */
|
|
3271
|
+
export interface ErrorBadRequestMergeWorksError {
|
|
3272
|
+
/** The errors encountered during the validation of the merge. */
|
|
3273
|
+
errors?: ErrorBadRequestMergeWorksErrorError[];
|
|
3274
|
+
}
|
|
3275
|
+
/** error-bad-request-merge-works-error-error */
|
|
3276
|
+
export interface ErrorBadRequestMergeWorksErrorError {
|
|
3277
|
+
already_merged?: ErrorBadRequestMergeWorksErrorErrorAlreadyMerged;
|
|
3278
|
+
closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
|
|
3279
|
+
/** The details of the error. */
|
|
3280
|
+
details: string;
|
|
3281
|
+
different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
|
|
3282
|
+
invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
|
|
3283
|
+
subtype?: 'already_merged' | 'closed' | 'different_workspace' | 'invalid_stage_transition';
|
|
3284
|
+
/** The ID of the work which failed the validation. */
|
|
3285
|
+
work: string;
|
|
3286
|
+
}
|
|
3287
|
+
/** error-bad-request-merge-works-error-error-already-merged */
|
|
3288
|
+
export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
|
|
3289
|
+
/** ID of the work into which the work was merged. */
|
|
3290
|
+
merged_into: string;
|
|
3291
|
+
}
|
|
3292
|
+
/** error-bad-request-merge-works-error-error-closed */
|
|
3293
|
+
export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
|
|
3294
|
+
/** error-bad-request-merge-works-error-error-different-workspace */
|
|
3295
|
+
export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
|
|
3296
|
+
/** The workspace of the primary work. */
|
|
3297
|
+
primary_workspace: string;
|
|
3298
|
+
/** The workspace of the secondary work. */
|
|
3299
|
+
secondary_workspace: string;
|
|
3300
|
+
}
|
|
3301
|
+
/** error-bad-request-merge-works-error-error-invalid-stage-transition */
|
|
3302
|
+
export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
3303
|
+
/** The current stage of the work. */
|
|
3304
|
+
current_stage: string;
|
|
3305
|
+
/** The stage to which the transition isn't allowed. */
|
|
3306
|
+
requested_stage: string;
|
|
3307
|
+
}
|
|
3144
3308
|
/** error-bad-request-missing-dependency */
|
|
3145
3309
|
export interface ErrorBadRequestMissingDependency {
|
|
3146
3310
|
/** The dependent fields. */
|
|
@@ -3183,13 +3347,21 @@ export declare enum ErrorBadRequestType {
|
|
|
3183
3347
|
InvalidApiVersion = "invalid_api_version",
|
|
3184
3348
|
InvalidEnumValue = "invalid_enum_value",
|
|
3185
3349
|
InvalidField = "invalid_field",
|
|
3350
|
+
InvalidId = "invalid_id",
|
|
3351
|
+
MergeWorksError = "merge_works_error",
|
|
3186
3352
|
MissingDependency = "missing_dependency",
|
|
3187
3353
|
MissingRequiredField = "missing_required_field",
|
|
3188
3354
|
ParseError = "parse_error",
|
|
3189
3355
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
3356
|
+
UnexpectedIdType = "unexpected_id_type",
|
|
3190
3357
|
UnexpectedJsonType = "unexpected_json_type",
|
|
3191
3358
|
ValueNotPermitted = "value_not_permitted"
|
|
3192
3359
|
}
|
|
3360
|
+
/** error-bad-request-unexpected-id-type */
|
|
3361
|
+
export interface ErrorBadRequestUnexpectedIdType {
|
|
3362
|
+
/** The field whose ID type is unexpected. */
|
|
3363
|
+
field_name: string;
|
|
3364
|
+
}
|
|
3193
3365
|
/** error-bad-request-unexpected-json-type */
|
|
3194
3366
|
export interface ErrorBadRequestUnexpectedJsonType {
|
|
3195
3367
|
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
@@ -3241,12 +3413,12 @@ export declare enum ErrorForbiddenType {
|
|
|
3241
3413
|
}
|
|
3242
3414
|
/** error-internal-server-error */
|
|
3243
3415
|
export type ErrorInternalServerError = ErrorBase & ErrorInternalServerErrorInternalError & {
|
|
3416
|
+
type: ErrorInternalServerErrorType;
|
|
3244
3417
|
/**
|
|
3245
3418
|
* A unique ID that's generated for the error that can be used for
|
|
3246
3419
|
* inquiry.
|
|
3247
3420
|
*/
|
|
3248
3421
|
reference_id?: string;
|
|
3249
|
-
type: ErrorInternalServerErrorType;
|
|
3250
3422
|
};
|
|
3251
3423
|
/** error-internal-server-error-internal-error */
|
|
3252
3424
|
export type ErrorInternalServerErrorInternalError = object;
|
|
@@ -3273,12 +3445,12 @@ export declare enum ErrorServiceUnavailableType {
|
|
|
3273
3445
|
}
|
|
3274
3446
|
/** error-too-many-requests */
|
|
3275
3447
|
export type ErrorTooManyRequests = ErrorBase & ErrorTooManyRequestsTooManyRequests & {
|
|
3448
|
+
type: ErrorTooManyRequestsType;
|
|
3276
3449
|
/**
|
|
3277
3450
|
* The number of seconds after which the client should retry.
|
|
3278
3451
|
* @format int64
|
|
3279
3452
|
*/
|
|
3280
3453
|
retry_after?: number;
|
|
3281
|
-
type: ErrorTooManyRequestsType;
|
|
3282
3454
|
};
|
|
3283
3455
|
/** error-too-many-requests-too-many-requests */
|
|
3284
3456
|
export type ErrorTooManyRequestsTooManyRequests = object;
|
|
@@ -3305,10 +3477,12 @@ export interface EventAccountDeleted {
|
|
|
3305
3477
|
* @example "ACC-12345"
|
|
3306
3478
|
*/
|
|
3307
3479
|
id: string;
|
|
3480
|
+
old_account?: Account;
|
|
3308
3481
|
}
|
|
3309
3482
|
/** event-account-updated */
|
|
3310
3483
|
export interface EventAccountUpdated {
|
|
3311
3484
|
account: Account;
|
|
3485
|
+
old_account?: Account;
|
|
3312
3486
|
}
|
|
3313
3487
|
/** event-conversation-created */
|
|
3314
3488
|
export interface EventConversationCreated {
|
|
@@ -3331,10 +3505,25 @@ export interface EventDevUserCreated {
|
|
|
3331
3505
|
export interface EventDevUserDeleted {
|
|
3332
3506
|
/** The ID of the Dev user that was deleted. */
|
|
3333
3507
|
id: string;
|
|
3508
|
+
old_dev_user?: DevUser;
|
|
3334
3509
|
}
|
|
3335
3510
|
/** event-dev-user-updated */
|
|
3336
3511
|
export interface EventDevUserUpdated {
|
|
3337
3512
|
dev_user: DevUser;
|
|
3513
|
+
old_dev_user?: DevUser;
|
|
3514
|
+
}
|
|
3515
|
+
/** event-group-created */
|
|
3516
|
+
export interface EventGroupCreated {
|
|
3517
|
+
group: Group;
|
|
3518
|
+
}
|
|
3519
|
+
/** event-group-deleted */
|
|
3520
|
+
export interface EventGroupDeleted {
|
|
3521
|
+
/** The ID of the group that was deleted. */
|
|
3522
|
+
id: string;
|
|
3523
|
+
}
|
|
3524
|
+
/** event-group-updated */
|
|
3525
|
+
export interface EventGroupUpdated {
|
|
3526
|
+
group: Group;
|
|
3338
3527
|
}
|
|
3339
3528
|
/** event-part-created */
|
|
3340
3529
|
export interface EventPartCreated {
|
|
@@ -3347,9 +3536,11 @@ export interface EventPartDeleted {
|
|
|
3347
3536
|
* @example "PROD-12345"
|
|
3348
3537
|
*/
|
|
3349
3538
|
id: string;
|
|
3539
|
+
old_part?: Part;
|
|
3350
3540
|
}
|
|
3351
3541
|
/** event-part-updated */
|
|
3352
3542
|
export interface EventPartUpdated {
|
|
3543
|
+
old_part?: Part;
|
|
3353
3544
|
part: Part;
|
|
3354
3545
|
}
|
|
3355
3546
|
/** event-rev-org-created */
|
|
@@ -3363,9 +3554,11 @@ export interface EventRevOrgDeleted {
|
|
|
3363
3554
|
* @example "REV-AbCdEfGh"
|
|
3364
3555
|
*/
|
|
3365
3556
|
id: string;
|
|
3557
|
+
old_rev_org?: RevOrg;
|
|
3366
3558
|
}
|
|
3367
3559
|
/** event-rev-org-updated */
|
|
3368
3560
|
export interface EventRevOrgUpdated {
|
|
3561
|
+
old_rev_org?: RevOrg;
|
|
3369
3562
|
rev_org: RevOrg;
|
|
3370
3563
|
}
|
|
3371
3564
|
/** event-rev-user-created */
|
|
@@ -3376,9 +3569,11 @@ export interface EventRevUserCreated {
|
|
|
3376
3569
|
export interface EventRevUserDeleted {
|
|
3377
3570
|
/** The ID of the Rev user that was deleted. */
|
|
3378
3571
|
id: string;
|
|
3572
|
+
old_rev_user?: RevUser;
|
|
3379
3573
|
}
|
|
3380
3574
|
/** event-rev-user-updated */
|
|
3381
3575
|
export interface EventRevUserUpdated {
|
|
3576
|
+
old_rev_user?: RevUser;
|
|
3382
3577
|
rev_user: RevUser;
|
|
3383
3578
|
}
|
|
3384
3579
|
/** event-sla-tracker-created */
|
|
@@ -3561,16 +3756,27 @@ export interface EventWorkDeleted {
|
|
|
3561
3756
|
* @example "ISS-12345"
|
|
3562
3757
|
*/
|
|
3563
3758
|
id: string;
|
|
3759
|
+
old_work?: Work;
|
|
3564
3760
|
}
|
|
3565
3761
|
/** event-work-updated */
|
|
3566
3762
|
export interface EventWorkUpdated {
|
|
3763
|
+
old_work?: Work;
|
|
3567
3764
|
work: Work;
|
|
3568
3765
|
}
|
|
3569
3766
|
/**
|
|
3570
3767
|
* external-identity
|
|
3571
3768
|
* External identity of a user.
|
|
3572
3769
|
*/
|
|
3573
|
-
export
|
|
3770
|
+
export interface ExternalIdentity {
|
|
3771
|
+
/** Display name of the user in the external source. */
|
|
3772
|
+
display_name?: string;
|
|
3773
|
+
/** Unique ID of the user in the external source. */
|
|
3774
|
+
id?: string;
|
|
3775
|
+
/** Whether the external identity is verified or not. */
|
|
3776
|
+
is_verified?: boolean;
|
|
3777
|
+
/** Issuer of the external identity of the user. */
|
|
3778
|
+
issuer?: string;
|
|
3779
|
+
}
|
|
3574
3780
|
/** feature */
|
|
3575
3781
|
export type Feature = PartBase;
|
|
3576
3782
|
/** feature-summary */
|
|
@@ -3580,6 +3786,14 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
3580
3786
|
* Set of field attributes.
|
|
3581
3787
|
*/
|
|
3582
3788
|
export type FieldDescriptor = object;
|
|
3789
|
+
/** Event type of the notification. */
|
|
3790
|
+
export declare enum GenericNotificationEventType {
|
|
3791
|
+
Alert = "alert",
|
|
3792
|
+
Assignment = "assignment",
|
|
3793
|
+
Mention = "mention",
|
|
3794
|
+
Reminder = "reminder",
|
|
3795
|
+
Update = "update"
|
|
3796
|
+
}
|
|
3583
3797
|
/** group */
|
|
3584
3798
|
export type Group = AtomBase & {
|
|
3585
3799
|
/** Description of the group. */
|
|
@@ -3714,6 +3928,8 @@ export type GroupedVistaSummary = VistaBaseSummary & {
|
|
|
3714
3928
|
* A request to create a new group.
|
|
3715
3929
|
*/
|
|
3716
3930
|
export interface GroupsCreateRequest {
|
|
3931
|
+
/** Type of the group. */
|
|
3932
|
+
type?: GroupType;
|
|
3717
3933
|
/** Description of the group. */
|
|
3718
3934
|
description: string;
|
|
3719
3935
|
/** Information to define dynamic groups. */
|
|
@@ -3724,8 +3940,6 @@ export interface GroupsCreateRequest {
|
|
|
3724
3940
|
name: string;
|
|
3725
3941
|
/** Owner of the group. */
|
|
3726
3942
|
owner?: string;
|
|
3727
|
-
/** Type of the group. */
|
|
3728
|
-
type?: GroupType;
|
|
3729
3943
|
}
|
|
3730
3944
|
/**
|
|
3731
3945
|
* groups-create-response
|
|
@@ -3761,6 +3975,8 @@ export interface GroupsListRequest {
|
|
|
3761
3975
|
cursor?: string;
|
|
3762
3976
|
/** Filters the groups based on the group type. */
|
|
3763
3977
|
group_type?: GroupType[];
|
|
3978
|
+
/** Whether to fetch default or custom groups. */
|
|
3979
|
+
is_default?: boolean;
|
|
3764
3980
|
/**
|
|
3765
3981
|
* The maximum number of groups to return. The default is '50'.
|
|
3766
3982
|
* @format int32
|
|
@@ -3824,12 +4040,220 @@ export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
|
3824
4040
|
export interface GroupsUpdateResponse {
|
|
3825
4041
|
group: Group;
|
|
3826
4042
|
}
|
|
4043
|
+
/** incident */
|
|
4044
|
+
export type Incident = AtomBase & {
|
|
4045
|
+
/** Parts to which the incident is applicable to. */
|
|
4046
|
+
applies_to_parts?: PartSummary[];
|
|
4047
|
+
/** The artifacts attached to the incident. */
|
|
4048
|
+
artifacts?: ArtifactSummary[];
|
|
4049
|
+
/** Body of the incident. */
|
|
4050
|
+
body?: string;
|
|
4051
|
+
/** Custom fields. */
|
|
4052
|
+
custom_fields?: object;
|
|
4053
|
+
/**
|
|
4054
|
+
* Custom schema fragments.
|
|
4055
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
4056
|
+
*/
|
|
4057
|
+
custom_schema_fragments?: string[];
|
|
4058
|
+
/**
|
|
4059
|
+
* Time when the incident was identified/reported.
|
|
4060
|
+
* @format date-time
|
|
4061
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4062
|
+
*/
|
|
4063
|
+
identified_at?: string;
|
|
4064
|
+
/** List of customers impacted due to the Incident. */
|
|
4065
|
+
impacted_customers?: AccountSummary[];
|
|
4066
|
+
/** The users that own the incident. */
|
|
4067
|
+
owned_by?: UserSummary[];
|
|
4068
|
+
/**
|
|
4069
|
+
* Timestamp when the incident was resolved.
|
|
4070
|
+
* @format date-time
|
|
4071
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4072
|
+
*/
|
|
4073
|
+
resolved_at?: string;
|
|
4074
|
+
/** The properties of an enum value. */
|
|
4075
|
+
severity?: EnumValue;
|
|
4076
|
+
/** Describes the current stage of a object. */
|
|
4077
|
+
stage?: Stage;
|
|
4078
|
+
/**
|
|
4079
|
+
* Users, along with the incident commander, involved in resolving
|
|
4080
|
+
* incidents and handling communication.
|
|
4081
|
+
*/
|
|
4082
|
+
stakeholders?: UserSummary[];
|
|
4083
|
+
/**
|
|
4084
|
+
* Stock schema fragment.
|
|
4085
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
4086
|
+
*/
|
|
4087
|
+
stock_schema_fragment?: string;
|
|
4088
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
4089
|
+
subtype?: string;
|
|
4090
|
+
/** Tags associated with the object. */
|
|
4091
|
+
tags?: TagWithValue[];
|
|
4092
|
+
/**
|
|
4093
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4094
|
+
* @format date-time
|
|
4095
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4096
|
+
*/
|
|
4097
|
+
target_close_date?: string;
|
|
4098
|
+
/** Title of the incident. */
|
|
4099
|
+
title: string;
|
|
4100
|
+
};
|
|
4101
|
+
/** incidents-get-request */
|
|
4102
|
+
export interface IncidentsGetRequest {
|
|
4103
|
+
/** The ID of the incident to get. */
|
|
4104
|
+
id: string;
|
|
4105
|
+
}
|
|
4106
|
+
/** incidents-get-response */
|
|
4107
|
+
export interface IncidentsGetResponse {
|
|
4108
|
+
incident: Incident;
|
|
4109
|
+
}
|
|
4110
|
+
/** incidents-group */
|
|
4111
|
+
export interface IncidentsGroup {
|
|
4112
|
+
/** The group of incidents. */
|
|
4113
|
+
incidents: Incident[];
|
|
4114
|
+
/** Unique key according to which the items are grouped. */
|
|
4115
|
+
key: string;
|
|
4116
|
+
/**
|
|
4117
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4118
|
+
* sort order. If not set, then no later elements exist.
|
|
4119
|
+
*/
|
|
4120
|
+
next_cursor?: string;
|
|
4121
|
+
/**
|
|
4122
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4123
|
+
* sort order. If not set, then no prior elements exist.
|
|
4124
|
+
*/
|
|
4125
|
+
prev_cursor?: string;
|
|
4126
|
+
}
|
|
4127
|
+
/** incidents-group-request */
|
|
4128
|
+
export interface IncidentsGroupRequest {
|
|
4129
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
4130
|
+
applies_to_parts?: string[];
|
|
4131
|
+
/**
|
|
4132
|
+
* Filters for incidents created by any of the provided users.
|
|
4133
|
+
* @example ["DEVU-12345"]
|
|
4134
|
+
*/
|
|
4135
|
+
created_by?: string[];
|
|
4136
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4137
|
+
created_date?: DateFilter;
|
|
4138
|
+
/**
|
|
4139
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4140
|
+
* iteration starts from the beginning.
|
|
4141
|
+
*/
|
|
4142
|
+
cursor?: string;
|
|
4143
|
+
/** The field to group the incidents by. */
|
|
4144
|
+
group_by: string;
|
|
4145
|
+
/**
|
|
4146
|
+
* The maximum number of groups to return. If not set, then the
|
|
4147
|
+
* default is '10'.
|
|
4148
|
+
* @format int32
|
|
4149
|
+
*/
|
|
4150
|
+
limit?: number;
|
|
4151
|
+
/**
|
|
4152
|
+
* The maximum number of incidents to return for an individual group.
|
|
4153
|
+
* The default is '50'.
|
|
4154
|
+
* @format int32
|
|
4155
|
+
*/
|
|
4156
|
+
limit_per_group?: number;
|
|
4157
|
+
/**
|
|
4158
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4159
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4160
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4161
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4162
|
+
* always be returned in the specified sort-by order.
|
|
4163
|
+
*/
|
|
4164
|
+
mode?: ListMode;
|
|
4165
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4166
|
+
modified_date?: DateFilter;
|
|
4167
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
4168
|
+
owned_by?: string[];
|
|
4169
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
4170
|
+
severity?: number[];
|
|
4171
|
+
/** Comma-separated fields to sort the incidents by. */
|
|
4172
|
+
sort_by?: string[];
|
|
4173
|
+
/** Filters for incidents in any of the provided stages. */
|
|
4174
|
+
stage?: string[];
|
|
4175
|
+
/** Filters for incidents by the provided titles. */
|
|
4176
|
+
title?: string[];
|
|
4177
|
+
}
|
|
4178
|
+
/** incidents-group-response */
|
|
4179
|
+
export interface IncidentsGroupResponse {
|
|
4180
|
+
/** The list of groups. */
|
|
4181
|
+
groups: IncidentsGroup[];
|
|
4182
|
+
/**
|
|
4183
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4184
|
+
* sort order. If not set, then no later elements exist.
|
|
4185
|
+
*/
|
|
4186
|
+
next_cursor?: string;
|
|
4187
|
+
/**
|
|
4188
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4189
|
+
* sort order. If not set, then no prior elements exist.
|
|
4190
|
+
*/
|
|
4191
|
+
prev_cursor?: string;
|
|
4192
|
+
}
|
|
4193
|
+
/** incidents-list-request */
|
|
4194
|
+
export interface IncidentsListRequest {
|
|
4195
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
4196
|
+
applies_to_parts?: string[];
|
|
4197
|
+
/**
|
|
4198
|
+
* Filters for incidents created by any of the provided users.
|
|
4199
|
+
* @example ["DEVU-12345"]
|
|
4200
|
+
*/
|
|
4201
|
+
created_by?: string[];
|
|
4202
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4203
|
+
created_date?: DateFilter;
|
|
4204
|
+
/**
|
|
4205
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4206
|
+
* iteration starts from the beginning.
|
|
4207
|
+
*/
|
|
4208
|
+
cursor?: string;
|
|
4209
|
+
/**
|
|
4210
|
+
* The maximum number of items.
|
|
4211
|
+
* @format int32
|
|
4212
|
+
*/
|
|
4213
|
+
limit?: number;
|
|
4214
|
+
/**
|
|
4215
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4216
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4217
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4218
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4219
|
+
* always be returned in the specified sort-by order.
|
|
4220
|
+
*/
|
|
4221
|
+
mode?: ListMode;
|
|
4222
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4223
|
+
modified_date?: DateFilter;
|
|
4224
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
4225
|
+
owned_by?: string[];
|
|
4226
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
4227
|
+
severity?: number[];
|
|
4228
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
4229
|
+
sort_by?: string[];
|
|
4230
|
+
/** Filters for incidents in any of the provided stages. */
|
|
4231
|
+
stage?: string[];
|
|
4232
|
+
/** Filters for incidents by the provided titles. */
|
|
4233
|
+
title?: string[];
|
|
4234
|
+
}
|
|
4235
|
+
/** incidents-list-response */
|
|
4236
|
+
export interface IncidentsListResponse {
|
|
4237
|
+
/** The matching incidents. */
|
|
4238
|
+
incidents: Incident[];
|
|
4239
|
+
/**
|
|
4240
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4241
|
+
* sort order. If not set, then no later elements exist.
|
|
4242
|
+
*/
|
|
4243
|
+
next_cursor?: string;
|
|
4244
|
+
/**
|
|
4245
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4246
|
+
* sort order. If not set, then no prior elements exist.
|
|
4247
|
+
*/
|
|
4248
|
+
prev_cursor?: string;
|
|
4249
|
+
}
|
|
3827
4250
|
/** issue */
|
|
3828
4251
|
export type Issue = WorkBase & {
|
|
3829
4252
|
/** Parts associated based on git events. */
|
|
3830
4253
|
developed_with?: PartSummary[];
|
|
3831
4254
|
/** Priority of the work based upon impact and criticality. */
|
|
3832
4255
|
priority?: IssuePriority;
|
|
4256
|
+
sla_tracker?: SlaTrackerSummary;
|
|
3833
4257
|
/** Vista group item. */
|
|
3834
4258
|
sprint?: VistaGroupItemSummary;
|
|
3835
4259
|
/**
|
|
@@ -3856,7 +4280,7 @@ export type IssueSummary = WorkBaseSummary & {
|
|
|
3856
4280
|
* Defines a job history line item.
|
|
3857
4281
|
*/
|
|
3858
4282
|
export interface JobHistoryItem {
|
|
3859
|
-
/**
|
|
4283
|
+
/** The properties of an enum value. */
|
|
3860
4284
|
employment_status?: EnumValue;
|
|
3861
4285
|
/**
|
|
3862
4286
|
* The end date of the job, or not specified if current.
|
|
@@ -3877,6 +4301,13 @@ export interface JobHistoryItem {
|
|
|
3877
4301
|
/** The job title for the user. */
|
|
3878
4302
|
title?: string;
|
|
3879
4303
|
}
|
|
4304
|
+
/** keyrings-create-callback-request */
|
|
4305
|
+
export interface KeyringsCreateCallbackRequest {
|
|
4306
|
+
/** Code to exchange for an access token. */
|
|
4307
|
+
code: string;
|
|
4308
|
+
/** State value given to the authorization request. */
|
|
4309
|
+
state: string;
|
|
4310
|
+
}
|
|
3880
4311
|
/**
|
|
3881
4312
|
* legacy-stage
|
|
3882
4313
|
* Describes the current stage of a work item.
|
|
@@ -3884,6 +4315,7 @@ export interface JobHistoryItem {
|
|
|
3884
4315
|
export interface LegacyStage {
|
|
3885
4316
|
/** Current stage name of the work item. */
|
|
3886
4317
|
name: string;
|
|
4318
|
+
stage?: CustomStageSummary;
|
|
3887
4319
|
}
|
|
3888
4320
|
/**
|
|
3889
4321
|
* legacy-stage-summary
|
|
@@ -3987,10 +4419,13 @@ export type LinkSummary = AtomBaseSummary & {
|
|
|
3987
4419
|
};
|
|
3988
4420
|
/** Type of link used to define the relationship. */
|
|
3989
4421
|
export declare enum LinkType {
|
|
4422
|
+
CustomLink = "custom_link",
|
|
3990
4423
|
DevelopedWith = "developed_with",
|
|
3991
4424
|
Imports = "imports",
|
|
4425
|
+
IsAnalyzedBy = "is_analyzed_by",
|
|
3992
4426
|
IsDependentOn = "is_dependent_on",
|
|
3993
4427
|
IsDuplicateOf = "is_duplicate_of",
|
|
4428
|
+
IsMergedInto = "is_merged_into",
|
|
3994
4429
|
IsParentOf = "is_parent_of",
|
|
3995
4430
|
IsPartOf = "is_part_of",
|
|
3996
4431
|
IsRelatedTo = "is_related_to",
|
|
@@ -4089,6 +4524,11 @@ export interface LinksListRequest {
|
|
|
4089
4524
|
mode?: ListMode;
|
|
4090
4525
|
/** The ID of the object to list the links for. */
|
|
4091
4526
|
object: string;
|
|
4527
|
+
/**
|
|
4528
|
+
* The object types to filter for, otherwise if not present, all
|
|
4529
|
+
* object types are included.
|
|
4530
|
+
*/
|
|
4531
|
+
object_types?: LinkEndpointType[];
|
|
4092
4532
|
/**
|
|
4093
4533
|
* The link types to filter for, otherwise if not present, all link
|
|
4094
4534
|
* types are included.
|
|
@@ -4217,6 +4657,8 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
4217
4657
|
};
|
|
4218
4658
|
/** metric-definitions-list-request */
|
|
4219
4659
|
export interface MetricDefinitionsListRequest {
|
|
4660
|
+
/** The type of metric definitions sought. */
|
|
4661
|
+
type?: MetricDefinitionMetricType[];
|
|
4220
4662
|
/** The type of objects the metric definition applies to. */
|
|
4221
4663
|
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
4222
4664
|
/**
|
|
@@ -4244,8 +4686,6 @@ export interface MetricDefinitionsListRequest {
|
|
|
4244
4686
|
mode?: ListMode;
|
|
4245
4687
|
/** The status of the metric definition. */
|
|
4246
4688
|
status?: MetricDefinitionStatus[];
|
|
4247
|
-
/** The type of metric definitions sought. */
|
|
4248
|
-
type?: MetricDefinitionMetricType[];
|
|
4249
4689
|
}
|
|
4250
4690
|
/** metric-definitions-list-response */
|
|
4251
4691
|
export interface MetricDefinitionsListResponse {
|
|
@@ -4264,6 +4704,16 @@ export interface MetricDefinitionsListResponse {
|
|
|
4264
4704
|
}
|
|
4265
4705
|
/** metrics-data */
|
|
4266
4706
|
export interface MetricsData {
|
|
4707
|
+
/**
|
|
4708
|
+
* Account ID or external_ref of the account for which metric is being
|
|
4709
|
+
* published. Account ID is DevRev DON ID. For example,
|
|
4710
|
+
* don:identity:dvrv-us-1:devo/0:account/156. External_ref is the
|
|
4711
|
+
* identification of DevRev customer's customers. Devrev will
|
|
4712
|
+
* internally resolve external_ref to Account ID and use it for
|
|
4713
|
+
* further processing. For example, external_ref=customer_1 may
|
|
4714
|
+
* resolve to don:identity:dvrv-us-1:devo/0:account/155.
|
|
4715
|
+
*/
|
|
4716
|
+
account_ref: string;
|
|
4267
4717
|
/**
|
|
4268
4718
|
* One or more data points collected for a given metric such as object
|
|
4269
4719
|
* usage, object state etc.
|
|
@@ -4285,7 +4735,7 @@ export interface MetricsData {
|
|
|
4285
4735
|
* external_ref=org_customer_1 may resolve to
|
|
4286
4736
|
* don:identity:dvrv-us-1:devo/0:revo/155.
|
|
4287
4737
|
*/
|
|
4288
|
-
org_ref
|
|
4738
|
+
org_ref?: string;
|
|
4289
4739
|
/** Rev User ID or user ref for which metric is being published. */
|
|
4290
4740
|
user_ref?: string;
|
|
4291
4741
|
}
|
|
@@ -4297,6 +4747,17 @@ export interface MetricsDataIngestRequest {
|
|
|
4297
4747
|
*/
|
|
4298
4748
|
metrics: MetricsData[];
|
|
4299
4749
|
}
|
|
4750
|
+
/** notifications-send-request */
|
|
4751
|
+
export interface NotificationsSendRequest {
|
|
4752
|
+
/**
|
|
4753
|
+
* The list of notifications to send.
|
|
4754
|
+
* @maxItems 10
|
|
4755
|
+
* @minItems 1
|
|
4756
|
+
*/
|
|
4757
|
+
notifications: SendNotification[];
|
|
4758
|
+
}
|
|
4759
|
+
/** notifications-send-response */
|
|
4760
|
+
export type NotificationsSendResponse = object;
|
|
4300
4761
|
/** object-member-search-summary */
|
|
4301
4762
|
export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
4302
4763
|
object_member: ObjectMemberSummary;
|
|
@@ -4741,9 +5202,16 @@ export type PartBase = AtomBase & {
|
|
|
4741
5202
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
4742
5203
|
/** Name of the part. */
|
|
4743
5204
|
name: string;
|
|
5205
|
+
/** The users that own the part. */
|
|
5206
|
+
owned_by: UserSummary[];
|
|
4744
5207
|
};
|
|
4745
5208
|
/** part-search-summary */
|
|
4746
5209
|
export type PartSearchSummary = SearchSummaryBase & {
|
|
5210
|
+
/**
|
|
5211
|
+
* Comments on the work.
|
|
5212
|
+
* @maxItems 5
|
|
5213
|
+
*/
|
|
5214
|
+
comments?: CommentSearchSummary[];
|
|
4747
5215
|
part: PartSummary;
|
|
4748
5216
|
};
|
|
4749
5217
|
/** part-summary */
|
|
@@ -4758,6 +5226,7 @@ export declare enum PartType {
|
|
|
4758
5226
|
}
|
|
4759
5227
|
/** parts-create-request */
|
|
4760
5228
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
5229
|
+
type: PartType;
|
|
4761
5230
|
/**
|
|
4762
5231
|
* The IDs of the artifacts.
|
|
4763
5232
|
* @example ["ARTIFACT-12345"]
|
|
@@ -4779,7 +5248,6 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
4779
5248
|
* @example ["DEVU-12345"]
|
|
4780
5249
|
*/
|
|
4781
5250
|
owned_by: string[];
|
|
4782
|
-
type: PartType;
|
|
4783
5251
|
};
|
|
4784
5252
|
/** parts-create-request-capability */
|
|
4785
5253
|
export interface PartsCreateRequestCapability {
|
|
@@ -4851,6 +5319,8 @@ export interface PartsGetResponse {
|
|
|
4851
5319
|
}
|
|
4852
5320
|
/** parts-list-request */
|
|
4853
5321
|
export interface PartsListRequest {
|
|
5322
|
+
/** Filters for parts of the provided type(s). */
|
|
5323
|
+
type?: PartType[];
|
|
4854
5324
|
/**
|
|
4855
5325
|
* Filters for parts created by any of these users.
|
|
4856
5326
|
* @example ["DEVU-12345"]
|
|
@@ -4883,8 +5353,6 @@ export interface PartsListRequest {
|
|
|
4883
5353
|
owned_by?: string[];
|
|
4884
5354
|
/** The filter for specifying parent part. */
|
|
4885
5355
|
parent_part?: ParentPartFilter;
|
|
4886
|
-
/** Filters for parts of the provided type(s). */
|
|
4887
|
-
type?: PartType[];
|
|
4888
5356
|
}
|
|
4889
5357
|
/** parts-list-response */
|
|
4890
5358
|
export interface PartsListResponse {
|
|
@@ -4903,6 +5371,7 @@ export interface PartsListResponse {
|
|
|
4903
5371
|
}
|
|
4904
5372
|
/** parts-update-request */
|
|
4905
5373
|
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
5374
|
+
type?: PartType;
|
|
4906
5375
|
artifacts?: PartsUpdateRequestArtifacts;
|
|
4907
5376
|
/** Custom fields. */
|
|
4908
5377
|
custom_fields?: object;
|
|
@@ -4921,7 +5390,6 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
4921
5390
|
/** The updated name of the part. */
|
|
4922
5391
|
name?: string;
|
|
4923
5392
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
4924
|
-
type?: PartType;
|
|
4925
5393
|
};
|
|
4926
5394
|
/** parts-update-request-artifacts */
|
|
4927
5395
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -4940,14 +5408,14 @@ export interface PartsUpdateRequestEnhancement {
|
|
|
4940
5408
|
* @format date-time
|
|
4941
5409
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4942
5410
|
*/
|
|
4943
|
-
target_close_date?: string;
|
|
5411
|
+
target_close_date?: string | null;
|
|
4944
5412
|
/**
|
|
4945
5413
|
* Updates the target start date of the enhancement. Example Date
|
|
4946
5414
|
* Format: 2000-11-01T01:01:01Z
|
|
4947
5415
|
* @format date-time
|
|
4948
5416
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4949
5417
|
*/
|
|
4950
|
-
target_start_date?: string;
|
|
5418
|
+
target_start_date?: string | null;
|
|
4951
5419
|
}
|
|
4952
5420
|
/** parts-update-request-feature */
|
|
4953
5421
|
export type PartsUpdateRequestFeature = object;
|
|
@@ -5572,6 +6040,11 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
5572
6040
|
* Request object to create a new Rev user for a Rev organization.
|
|
5573
6041
|
*/
|
|
5574
6042
|
export interface RevUsersCreateRequest {
|
|
6043
|
+
/**
|
|
6044
|
+
* The ID of the account to which the created Rev user is associated.
|
|
6045
|
+
* @example "ACC-12345"
|
|
6046
|
+
*/
|
|
6047
|
+
account?: string;
|
|
5575
6048
|
/**
|
|
5576
6049
|
* The IDs of the artifacts to associate with the Rev user.
|
|
5577
6050
|
* @example ["ARTIFACT-12345"]
|
|
@@ -5826,11 +6299,11 @@ export interface SchemaFieldCreateViewUiMetadata {
|
|
|
5826
6299
|
* schema-field-descriptor
|
|
5827
6300
|
* Set of field attributes.
|
|
5828
6301
|
*/
|
|
5829
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
6302
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
5830
6303
|
field_type: SchemaFieldDescriptorFieldType;
|
|
5831
6304
|
};
|
|
5832
6305
|
/** schema-field-descriptor-array-type */
|
|
5833
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
6306
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
5834
6307
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
5835
6308
|
/**
|
|
5836
6309
|
* The exact array length.
|
|
@@ -5857,6 +6330,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
5857
6330
|
Id = "id",
|
|
5858
6331
|
Int = "int",
|
|
5859
6332
|
RichText = "rich_text",
|
|
6333
|
+
Struct = "struct",
|
|
5860
6334
|
Text = "text",
|
|
5861
6335
|
Timestamp = "timestamp",
|
|
5862
6336
|
Tokens = "tokens",
|
|
@@ -5898,6 +6372,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
5898
6372
|
Id = "id",
|
|
5899
6373
|
Int = "int",
|
|
5900
6374
|
RichText = "rich_text",
|
|
6375
|
+
Struct = "struct",
|
|
5901
6376
|
Text = "text",
|
|
5902
6377
|
Timestamp = "timestamp",
|
|
5903
6378
|
Tokens = "tokens",
|
|
@@ -5978,6 +6453,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
5978
6453
|
is_hidden_during_create?: boolean;
|
|
5979
6454
|
/** Whether the field is read-only in the UI. */
|
|
5980
6455
|
is_read_only?: boolean;
|
|
6456
|
+
/** Whether the field is mandatory in the UI. */
|
|
6457
|
+
is_required?: boolean;
|
|
5981
6458
|
/** Whether the field is shown in the UI summary view. */
|
|
5982
6459
|
is_shown_in_summary?: boolean;
|
|
5983
6460
|
/** Whether the field is sortable in the UI. */
|
|
@@ -6114,6 +6591,16 @@ export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
6114
6591
|
/** The string suffix. */
|
|
6115
6592
|
suffix?: string;
|
|
6116
6593
|
};
|
|
6594
|
+
/** schema-struct-field-descriptor */
|
|
6595
|
+
export type SchemaStructFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
6596
|
+
/** Default value. */
|
|
6597
|
+
default_value?: object;
|
|
6598
|
+
};
|
|
6599
|
+
/** schema-struct-list-field-descriptor */
|
|
6600
|
+
export type SchemaStructListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
6601
|
+
/** Default value. */
|
|
6602
|
+
default_value?: object[];
|
|
6603
|
+
};
|
|
6117
6604
|
/** schema-text-field-descriptor */
|
|
6118
6605
|
export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
6119
6606
|
/** The contained substring. */
|
|
@@ -6300,10 +6787,13 @@ export interface SearchCoreResponse {
|
|
|
6300
6787
|
export declare enum SearchHybridNamespace {
|
|
6301
6788
|
Article = "article",
|
|
6302
6789
|
Conversation = "conversation",
|
|
6790
|
+
Dataset = "dataset",
|
|
6791
|
+
Incident = "incident",
|
|
6303
6792
|
Issue = "issue",
|
|
6304
6793
|
Part = "part",
|
|
6305
6794
|
QuestionAnswer = "question_answer",
|
|
6306
6795
|
Ticket = "ticket",
|
|
6796
|
+
Widget = "widget",
|
|
6307
6797
|
Work = "work"
|
|
6308
6798
|
}
|
|
6309
6799
|
/**
|
|
@@ -6351,6 +6841,7 @@ export declare enum SearchNamespace {
|
|
|
6351
6841
|
Capability = "capability",
|
|
6352
6842
|
Component = "component",
|
|
6353
6843
|
Conversation = "conversation",
|
|
6844
|
+
CustomObject = "custom_object",
|
|
6354
6845
|
CustomPart = "custom_part",
|
|
6355
6846
|
CustomWork = "custom_work",
|
|
6356
6847
|
Dashboard = "dashboard",
|
|
@@ -6377,7 +6868,7 @@ export declare enum SearchNamespace {
|
|
|
6377
6868
|
Vista = "vista"
|
|
6378
6869
|
}
|
|
6379
6870
|
/** search-result */
|
|
6380
|
-
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
6871
|
+
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
6381
6872
|
type: SearchResultType;
|
|
6382
6873
|
};
|
|
6383
6874
|
export declare enum SearchResultType {
|
|
@@ -6385,6 +6876,7 @@ export declare enum SearchResultType {
|
|
|
6385
6876
|
Article = "article",
|
|
6386
6877
|
Artifact = "artifact",
|
|
6387
6878
|
Conversation = "conversation",
|
|
6879
|
+
CustomObject = "custom_object",
|
|
6388
6880
|
Dashboard = "dashboard",
|
|
6389
6881
|
Group = "group",
|
|
6390
6882
|
Link = "link",
|
|
@@ -6419,6 +6911,56 @@ export interface SearchSummaryBase {
|
|
|
6419
6911
|
/** Text snippet where the search hit occurred. */
|
|
6420
6912
|
snippet?: string;
|
|
6421
6913
|
}
|
|
6914
|
+
/** send-notification */
|
|
6915
|
+
export type SendNotification = SendNotificationGenericNotificationEntry & {
|
|
6916
|
+
type: SendNotificationType;
|
|
6917
|
+
/** The ID of the parent object associated with the notification. */
|
|
6918
|
+
parent?: string;
|
|
6919
|
+
/** The ID of the user for whom the notification was generated. */
|
|
6920
|
+
receiver: string;
|
|
6921
|
+
/**
|
|
6922
|
+
* Timestamp of the event that triggered the notification.
|
|
6923
|
+
* @format date-time
|
|
6924
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6925
|
+
*/
|
|
6926
|
+
timestamp?: string;
|
|
6927
|
+
};
|
|
6928
|
+
/** send-notification-generic-notification-entry */
|
|
6929
|
+
export interface SendNotificationGenericNotificationEntry {
|
|
6930
|
+
/** ID used to group notifications in the inbox for the same parent. */
|
|
6931
|
+
event_id?: string;
|
|
6932
|
+
/** Event type of the notification. */
|
|
6933
|
+
event_type: GenericNotificationEventType;
|
|
6934
|
+
/** Metadata for the objects that triggered the notification. */
|
|
6935
|
+
metadata: SendNotificationGenericNotificationEntryMetadata[];
|
|
6936
|
+
}
|
|
6937
|
+
/** send-notification-generic-notification-entry-metadata */
|
|
6938
|
+
export interface SendNotificationGenericNotificationEntryMetadata {
|
|
6939
|
+
action?: SendNotificationGenericNotificationEntryNotificationAction;
|
|
6940
|
+
/** The ID of the content template for the content of the notification. */
|
|
6941
|
+
content_template: string;
|
|
6942
|
+
/** Inputs required for the template. */
|
|
6943
|
+
inputs?: object;
|
|
6944
|
+
}
|
|
6945
|
+
/** send-notification-generic-notification-entry-notification-action */
|
|
6946
|
+
export interface SendNotificationGenericNotificationEntryNotificationAction {
|
|
6947
|
+
type?: 'clickable_action';
|
|
6948
|
+
clickable_action?: SendNotificationGenericNotificationEntryNotificationActionClickableAction;
|
|
6949
|
+
}
|
|
6950
|
+
/** send-notification-generic-notification-entry-notification-action-clickable-action */
|
|
6951
|
+
export interface SendNotificationGenericNotificationEntryNotificationActionClickableAction {
|
|
6952
|
+
type?: 'object' | 'url';
|
|
6953
|
+
/**
|
|
6954
|
+
* The ID of the object that the notification should redirect the user
|
|
6955
|
+
* to when selected.
|
|
6956
|
+
*/
|
|
6957
|
+
object?: string;
|
|
6958
|
+
/** The URL to redirect the user to. */
|
|
6959
|
+
url?: string;
|
|
6960
|
+
}
|
|
6961
|
+
export declare enum SendNotificationType {
|
|
6962
|
+
GenericNotification = "generic_notification"
|
|
6963
|
+
}
|
|
6422
6964
|
/** service-account */
|
|
6423
6965
|
export type ServiceAccount = UserBase;
|
|
6424
6966
|
/** service-account-summary */
|
|
@@ -6687,6 +7229,8 @@ export declare enum SlaStatus {
|
|
|
6687
7229
|
export type SlaSummary = AtomBaseSummary & {
|
|
6688
7230
|
/** Human-readable name. */
|
|
6689
7231
|
name: string;
|
|
7232
|
+
/** Type of the SLA. */
|
|
7233
|
+
sla_type?: SlaType;
|
|
6690
7234
|
/**
|
|
6691
7235
|
* Status determines how an item can be used. In 'draft' status an item
|
|
6692
7236
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -6957,13 +7501,13 @@ export declare enum SnapWidgetType {
|
|
|
6957
7501
|
}
|
|
6958
7502
|
/** snap-widgets-create-request */
|
|
6959
7503
|
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
7504
|
+
type: SnapWidgetsCreateRequestType;
|
|
6960
7505
|
/** A human readable name for the snap widget. */
|
|
6961
7506
|
name: string;
|
|
6962
7507
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6963
7508
|
namespace?: SnapWidgetNamespace;
|
|
6964
7509
|
/** The status of the snap widget. */
|
|
6965
7510
|
status?: SnapWidgetStatus;
|
|
6966
|
-
type: SnapWidgetsCreateRequestType;
|
|
6967
7511
|
};
|
|
6968
7512
|
export declare enum SnapWidgetsCreateRequestType {
|
|
6969
7513
|
EmailPreview = "email_preview"
|
|
@@ -6972,6 +7516,11 @@ export declare enum SnapWidgetsCreateRequestType {
|
|
|
6972
7516
|
export interface SnapWidgetsCreateResponse {
|
|
6973
7517
|
snap_widget: SnapWidget;
|
|
6974
7518
|
}
|
|
7519
|
+
/**
|
|
7520
|
+
* stage
|
|
7521
|
+
* Describes the current stage of a object.
|
|
7522
|
+
*/
|
|
7523
|
+
export type Stage = object;
|
|
6975
7524
|
/** stage-diagram-summary */
|
|
6976
7525
|
export type StageDiagramSummary = AtomBaseSummary;
|
|
6977
7526
|
/**
|
|
@@ -6987,6 +7536,11 @@ export interface StageFilter {
|
|
|
6987
7536
|
* Sets an object's initial stage.
|
|
6988
7537
|
*/
|
|
6989
7538
|
export interface StageInit {
|
|
7539
|
+
/**
|
|
7540
|
+
* The ID of the custom stage. If this is set, the name field is
|
|
7541
|
+
* ignored.
|
|
7542
|
+
*/
|
|
7543
|
+
id?: string;
|
|
6990
7544
|
/** The name of the stage. */
|
|
6991
7545
|
name?: string;
|
|
6992
7546
|
}
|
|
@@ -6997,6 +7551,11 @@ export interface StageInit {
|
|
|
6997
7551
|
export interface StageUpdate {
|
|
6998
7552
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
6999
7553
|
name?: string;
|
|
7554
|
+
/**
|
|
7555
|
+
* The ID of the updated custom stage, otherwise unchanged if not set.
|
|
7556
|
+
* If this is set, the name field is ignored.
|
|
7557
|
+
*/
|
|
7558
|
+
stage?: string;
|
|
7000
7559
|
}
|
|
7001
7560
|
/** Type of stage validation options when creating an object. */
|
|
7002
7561
|
export declare enum StageValidationOptionForCreate {
|
|
@@ -7124,28 +7683,52 @@ export interface SubtypesListResponse {
|
|
|
7124
7683
|
export type Survey = AtomBase & {
|
|
7125
7684
|
/** Description of the survey. */
|
|
7126
7685
|
description?: string;
|
|
7686
|
+
/** Text posted when introducing the survey to the responder. */
|
|
7687
|
+
introductory_text?: string;
|
|
7127
7688
|
/**
|
|
7128
7689
|
* Survey name associated with schema. This name would be unique per
|
|
7129
7690
|
* dev org.
|
|
7130
7691
|
*/
|
|
7131
7692
|
name?: string;
|
|
7693
|
+
/** Text posted after the response is collected. */
|
|
7694
|
+
response_text?: string;
|
|
7132
7695
|
/** List of all fields in the schema. */
|
|
7133
|
-
schema
|
|
7696
|
+
schema?: SchemaFieldDescriptor[];
|
|
7697
|
+
/** List of all the fields and their respective metadata in the schema. */
|
|
7698
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
7134
7699
|
};
|
|
7135
7700
|
/**
|
|
7136
7701
|
* survey-aggregation-filter
|
|
7137
7702
|
* The filter for survey aggregation.
|
|
7138
7703
|
*/
|
|
7139
7704
|
export type SurveyAggregationFilter = object;
|
|
7705
|
+
/**
|
|
7706
|
+
* survey-field-with-metadata
|
|
7707
|
+
* Field descriptors with additional metadata for surveys.
|
|
7708
|
+
*/
|
|
7709
|
+
export interface SurveyFieldWithMetadata {
|
|
7710
|
+
/** Set of field attributes. */
|
|
7711
|
+
field?: SchemaFieldDescriptor;
|
|
7712
|
+
/** Additional metadata for the input field. */
|
|
7713
|
+
metadata?: object;
|
|
7714
|
+
/** The question linked to the input field. */
|
|
7715
|
+
question?: string;
|
|
7716
|
+
}
|
|
7140
7717
|
/** survey-response */
|
|
7141
7718
|
export type SurveyResponse = AtomBase & {
|
|
7142
7719
|
/** The unique ID associated with the dispatched survey. */
|
|
7143
7720
|
dispatch_id?: string;
|
|
7721
|
+
/** Source channels on which the survey is sent. */
|
|
7722
|
+
dispatched_channels?: EnumValue[];
|
|
7144
7723
|
/** The ID of the object for which survey is taken. */
|
|
7145
7724
|
object?: string;
|
|
7146
7725
|
recipient?: UserSummary;
|
|
7147
7726
|
/** Response for the survey. */
|
|
7148
7727
|
response?: object;
|
|
7728
|
+
/** The properties of an enum value. */
|
|
7729
|
+
response_channel?: EnumValue;
|
|
7730
|
+
/** The properties of an enum value. */
|
|
7731
|
+
stage?: EnumValue;
|
|
7149
7732
|
/** The ID of the survey for which response is taken. */
|
|
7150
7733
|
survey?: string;
|
|
7151
7734
|
};
|
|
@@ -7153,10 +7736,16 @@ export type SurveyResponse = AtomBase & {
|
|
|
7153
7736
|
export interface SurveysCreateRequest {
|
|
7154
7737
|
/** Description about the survey. */
|
|
7155
7738
|
description?: string;
|
|
7739
|
+
/** Text posted when introducing the survey to the responder. */
|
|
7740
|
+
introductory_text?: string;
|
|
7156
7741
|
/** The survey's name. */
|
|
7157
7742
|
name: string;
|
|
7743
|
+
/** Text posted after the response is collected. */
|
|
7744
|
+
response_text?: string;
|
|
7158
7745
|
/** Schema for the survey. */
|
|
7159
|
-
schema
|
|
7746
|
+
schema?: FieldDescriptor[];
|
|
7747
|
+
/** The schema with metadata for the survey. */
|
|
7748
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
7160
7749
|
}
|
|
7161
7750
|
/** surveys-create-response */
|
|
7162
7751
|
export interface SurveysCreateResponse {
|
|
@@ -7254,6 +7843,11 @@ export interface SurveysResponsesListRequest {
|
|
|
7254
7843
|
* @example ["ACC-12345"]
|
|
7255
7844
|
*/
|
|
7256
7845
|
objects?: string[];
|
|
7846
|
+
/**
|
|
7847
|
+
* Filters for survey responses dispatched to any of these users.
|
|
7848
|
+
* @example ["DEVU-12345"]
|
|
7849
|
+
*/
|
|
7850
|
+
recipient?: string[];
|
|
7257
7851
|
/**
|
|
7258
7852
|
* Fields to sort the survey responses by and the direction to sort
|
|
7259
7853
|
* them.
|
|
@@ -7650,7 +8244,11 @@ export type Ticket = WorkBase & {
|
|
|
7650
8244
|
/** Channels of the ticket. */
|
|
7651
8245
|
channels?: TicketChannels[];
|
|
7652
8246
|
group?: GroupSummary;
|
|
8247
|
+
/** Whether the ticket needs a response. */
|
|
8248
|
+
needs_response?: boolean;
|
|
7653
8249
|
rev_org?: OrgSummary;
|
|
8250
|
+
/** The properties of an enum value. */
|
|
8251
|
+
sentiment?: EnumValue;
|
|
7654
8252
|
/** Severity of the ticket. */
|
|
7655
8253
|
severity?: TicketSeverity;
|
|
7656
8254
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -7711,6 +8309,7 @@ export declare enum TimelineEntriesCollection {
|
|
|
7711
8309
|
* The request to create a timeline entry for an object.
|
|
7712
8310
|
*/
|
|
7713
8311
|
export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineComment & {
|
|
8312
|
+
type: TimelineEntriesCreateRequestType;
|
|
7714
8313
|
/**
|
|
7715
8314
|
* The collection(s) that the entry belongs to, otherwise if not
|
|
7716
8315
|
* provided, then the entry's default collection is used.
|
|
@@ -7743,7 +8342,6 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
7743
8342
|
* @example ["DEVU-12345"]
|
|
7744
8343
|
*/
|
|
7745
8344
|
private_to?: string[];
|
|
7746
|
-
type: TimelineEntriesCreateRequestType;
|
|
7747
8345
|
/**
|
|
7748
8346
|
* The visibility of the entry. If 'private', then the entry is only
|
|
7749
8347
|
* visible to the creator, 'internal' is visible with the Dev
|
|
@@ -7904,12 +8502,12 @@ export interface TimelineEntriesListResponse {
|
|
|
7904
8502
|
* The request to update a timeline entry.
|
|
7905
8503
|
*/
|
|
7906
8504
|
export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
|
|
8505
|
+
type: TimelineEntriesUpdateRequestType;
|
|
7907
8506
|
/**
|
|
7908
8507
|
* The ID of the timeline entry to update.
|
|
7909
8508
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
7910
8509
|
*/
|
|
7911
8510
|
id: string;
|
|
7912
|
-
type: TimelineEntriesUpdateRequestType;
|
|
7913
8511
|
};
|
|
7914
8512
|
/** timeline-entries-update-request-timeline-comment */
|
|
7915
8513
|
export interface TimelineEntriesUpdateRequestTimelineComment {
|
|
@@ -8030,6 +8628,12 @@ export declare enum TimelineEntryObjectType {
|
|
|
8030
8628
|
Ticket = "ticket",
|
|
8031
8629
|
TimelineComment = "timeline_comment"
|
|
8032
8630
|
}
|
|
8631
|
+
/** Display panels for the Timeline entry. */
|
|
8632
|
+
export declare enum TimelineEntryPanel {
|
|
8633
|
+
CustomerChat = "customer_chat",
|
|
8634
|
+
Discussions = "discussions",
|
|
8635
|
+
Events = "events"
|
|
8636
|
+
}
|
|
8033
8637
|
export declare enum TimelineEntryType {
|
|
8034
8638
|
TimelineComment = "timeline_comment"
|
|
8035
8639
|
}
|
|
@@ -8119,16 +8723,16 @@ export type TrackEventsPublishResponse = object;
|
|
|
8119
8723
|
* type is 'number'.
|
|
8120
8724
|
*/
|
|
8121
8725
|
export interface Unit {
|
|
8122
|
-
/**
|
|
8123
|
-
* This represents human readable unit name of the UOM For example,
|
|
8124
|
-
* number of API calls.
|
|
8125
|
-
*/
|
|
8126
|
-
name: string;
|
|
8127
8726
|
/**
|
|
8128
8727
|
* This defines the UOM unit type. For example, for 'number of video
|
|
8129
8728
|
* calls', unit type will be a number.
|
|
8130
8729
|
*/
|
|
8131
8730
|
type: UnitType;
|
|
8731
|
+
/**
|
|
8732
|
+
* This represents human readable unit name of the UOM For example,
|
|
8733
|
+
* number of API calls.
|
|
8734
|
+
*/
|
|
8735
|
+
name: string;
|
|
8132
8736
|
}
|
|
8133
8737
|
/**
|
|
8134
8738
|
* This defines the UOM unit type. For example, for 'number of video
|
|
@@ -8475,6 +9079,11 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
8475
9079
|
};
|
|
8476
9080
|
/** user-search-summary */
|
|
8477
9081
|
export type UserSearchSummary = SearchSummaryBase & {
|
|
9082
|
+
/**
|
|
9083
|
+
* Comments on the work.
|
|
9084
|
+
* @maxItems 5
|
|
9085
|
+
*/
|
|
9086
|
+
comments?: CommentSearchSummary[];
|
|
8478
9087
|
user: UserSummary;
|
|
8479
9088
|
};
|
|
8480
9089
|
/**
|
|
@@ -8509,11 +9118,43 @@ export type VistaBaseSummary = AtomBaseSummary & {
|
|
|
8509
9118
|
/** Name of the vista. */
|
|
8510
9119
|
name: string;
|
|
8511
9120
|
};
|
|
9121
|
+
/** Defines the state of the group item. */
|
|
9122
|
+
export declare enum VistaGroupItemState {
|
|
9123
|
+
Active = "active",
|
|
9124
|
+
Completed = "completed",
|
|
9125
|
+
Planned = "planned"
|
|
9126
|
+
}
|
|
8512
9127
|
/**
|
|
8513
9128
|
* vista-group-item-summary
|
|
8514
9129
|
* Vista group item.
|
|
8515
9130
|
*/
|
|
8516
|
-
export
|
|
9131
|
+
export interface VistaGroupItemSummary {
|
|
9132
|
+
/** Type of the group object. */
|
|
9133
|
+
type: VistaGroupItemType;
|
|
9134
|
+
/**
|
|
9135
|
+
* Timestamp when the vista ends.
|
|
9136
|
+
* @format date-time
|
|
9137
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9138
|
+
*/
|
|
9139
|
+
end_date?: string;
|
|
9140
|
+
/** ID of the group item in don v2 format. */
|
|
9141
|
+
id: string;
|
|
9142
|
+
/** Name of the group. */
|
|
9143
|
+
name: string;
|
|
9144
|
+
/**
|
|
9145
|
+
* Timestamp when the vista starts.
|
|
9146
|
+
* @format date-time
|
|
9147
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9148
|
+
*/
|
|
9149
|
+
start_date?: string;
|
|
9150
|
+
/** Defines the state of the group item. */
|
|
9151
|
+
state?: VistaGroupItemState;
|
|
9152
|
+
}
|
|
9153
|
+
/** Type of the group object. */
|
|
9154
|
+
export declare enum VistaGroupItemType {
|
|
9155
|
+
Curated = "curated",
|
|
9156
|
+
Dynamic = "dynamic"
|
|
9157
|
+
}
|
|
8517
9158
|
/** vista-search-summary */
|
|
8518
9159
|
export type VistaSearchSummary = SearchSummaryBase & {
|
|
8519
9160
|
/** Represents a collection of DevRev objects. */
|
|
@@ -8537,6 +9178,8 @@ export declare enum VistaType {
|
|
|
8537
9178
|
export type Webhook = AtomBase & {
|
|
8538
9179
|
/** The event types that the webhook will receive. */
|
|
8539
9180
|
event_types?: WebhookEventType[];
|
|
9181
|
+
/** Headers that are provided with every webhook invocation. */
|
|
9182
|
+
headers?: WebhookHeader[];
|
|
8540
9183
|
/**
|
|
8541
9184
|
* The secret to use for verifying webhook events.
|
|
8542
9185
|
* @format byte
|
|
@@ -8549,6 +9192,8 @@ export type Webhook = AtomBase & {
|
|
|
8549
9192
|
};
|
|
8550
9193
|
/** webhook-event-request */
|
|
8551
9194
|
export interface WebhookEventRequest {
|
|
9195
|
+
/** The event types that the webhook will receive. */
|
|
9196
|
+
type?: WebhookEventType;
|
|
8552
9197
|
account_created?: EventAccountCreated;
|
|
8553
9198
|
account_deleted?: EventAccountDeleted;
|
|
8554
9199
|
account_updated?: EventAccountUpdated;
|
|
@@ -8558,6 +9203,9 @@ export interface WebhookEventRequest {
|
|
|
8558
9203
|
dev_user_created?: EventDevUserCreated;
|
|
8559
9204
|
dev_user_deleted?: EventDevUserDeleted;
|
|
8560
9205
|
dev_user_updated?: EventDevUserUpdated;
|
|
9206
|
+
group_created?: EventGroupCreated;
|
|
9207
|
+
group_deleted?: EventGroupDeleted;
|
|
9208
|
+
group_updated?: EventGroupUpdated;
|
|
8561
9209
|
/** The event's ID. */
|
|
8562
9210
|
id: string;
|
|
8563
9211
|
part_created?: EventPartCreated;
|
|
@@ -8590,8 +9238,6 @@ export interface WebhookEventRequest {
|
|
|
8590
9238
|
* @example "2023-01-01T12:00:00.000Z"
|
|
8591
9239
|
*/
|
|
8592
9240
|
timestamp?: string;
|
|
8593
|
-
/** The event types that the webhook will receive. */
|
|
8594
|
-
type?: WebhookEventType;
|
|
8595
9241
|
verify?: WebhookEventVerify;
|
|
8596
9242
|
webhook_created?: EventWebhookCreated;
|
|
8597
9243
|
webhook_deleted?: EventWebhookDeleted;
|
|
@@ -8625,6 +9271,9 @@ export declare enum WebhookEventType {
|
|
|
8625
9271
|
DevUserCreated = "dev_user_created",
|
|
8626
9272
|
DevUserDeleted = "dev_user_deleted",
|
|
8627
9273
|
DevUserUpdated = "dev_user_updated",
|
|
9274
|
+
GroupCreated = "group_created",
|
|
9275
|
+
GroupDeleted = "group_deleted",
|
|
9276
|
+
GroupUpdated = "group_updated",
|
|
8628
9277
|
PartCreated = "part_created",
|
|
8629
9278
|
PartDeleted = "part_deleted",
|
|
8630
9279
|
PartUpdated = "part_updated",
|
|
@@ -8659,6 +9308,19 @@ export interface WebhookEventVerify {
|
|
|
8659
9308
|
*/
|
|
8660
9309
|
challenge: string;
|
|
8661
9310
|
}
|
|
9311
|
+
/**
|
|
9312
|
+
* webhook-header
|
|
9313
|
+
* Defines a header that's provided with every webhook invocation.
|
|
9314
|
+
*/
|
|
9315
|
+
export interface WebhookHeader {
|
|
9316
|
+
/**
|
|
9317
|
+
* The name of the header. Only alphanumeric ASCII characters,
|
|
9318
|
+
* hyphens, and underscores are permitted.
|
|
9319
|
+
*/
|
|
9320
|
+
name: string;
|
|
9321
|
+
/** The header's value. */
|
|
9322
|
+
value: string;
|
|
9323
|
+
}
|
|
8662
9324
|
/** The status of the webhook. */
|
|
8663
9325
|
export declare enum WebhookStatus {
|
|
8664
9326
|
Active = "active",
|
|
@@ -8674,6 +9336,8 @@ export type WebhookSummary = AtomBaseSummary;
|
|
|
8674
9336
|
export interface WebhooksCreateRequest {
|
|
8675
9337
|
/** The event types that the webhook endpoint will receive. */
|
|
8676
9338
|
event_types?: WebhookEventType[];
|
|
9339
|
+
/** @maxItems 8 */
|
|
9340
|
+
headers?: WebhookHeader[];
|
|
8677
9341
|
/**
|
|
8678
9342
|
* The secret to use when verifying webhook events. If provided, the
|
|
8679
9343
|
* secret must be between 8 and 32 bytes (inclusive). If not set, a
|
|
@@ -8752,6 +9416,7 @@ export interface WebhooksUpdateRequest {
|
|
|
8752
9416
|
/** The action to update the webhook's status. */
|
|
8753
9417
|
action?: WebhooksUpdateAction;
|
|
8754
9418
|
event_types?: WebhooksUpdateRequestEventTypes;
|
|
9419
|
+
headers?: WebhooksUpdateRequestHeaders;
|
|
8755
9420
|
/**
|
|
8756
9421
|
* ID for the webhook.
|
|
8757
9422
|
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
@@ -8794,6 +9459,15 @@ export interface WebhooksUpdateRequestEventTypes {
|
|
|
8794
9459
|
*/
|
|
8795
9460
|
set?: WebhookEventType[];
|
|
8796
9461
|
}
|
|
9462
|
+
/** webhooks-update-request-headers */
|
|
9463
|
+
export interface WebhooksUpdateRequestHeaders {
|
|
9464
|
+
/** @maxItems 8 */
|
|
9465
|
+
add?: WebhookHeader[];
|
|
9466
|
+
/** @maxItems 8 */
|
|
9467
|
+
remove?: string[];
|
|
9468
|
+
/** @maxItems 8 */
|
|
9469
|
+
set?: WebhookHeader[];
|
|
9470
|
+
}
|
|
8797
9471
|
/**
|
|
8798
9472
|
* webhooks-update-response
|
|
8799
9473
|
* The response to updating the webhook.
|
|
@@ -8859,6 +9533,11 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
8859
9533
|
};
|
|
8860
9534
|
/** work-search-summary */
|
|
8861
9535
|
export type WorkSearchSummary = SearchSummaryBase & {
|
|
9536
|
+
/**
|
|
9537
|
+
* Comments on the work.
|
|
9538
|
+
* @maxItems 5
|
|
9539
|
+
*/
|
|
9540
|
+
comments?: CommentSearchSummary[];
|
|
8862
9541
|
work: WorkSummary;
|
|
8863
9542
|
};
|
|
8864
9543
|
/** work-summary */
|
|
@@ -8873,6 +9552,7 @@ export declare enum WorkType {
|
|
|
8873
9552
|
}
|
|
8874
9553
|
/** works-create-request */
|
|
8875
9554
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
|
|
9555
|
+
type: WorkType;
|
|
8876
9556
|
/**
|
|
8877
9557
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
8878
9558
|
* applies to. Specifying a part is required when creating tickets and
|
|
@@ -8926,7 +9606,6 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
8926
9606
|
target_close_date?: string;
|
|
8927
9607
|
/** Title of the work object. */
|
|
8928
9608
|
title: string;
|
|
8929
|
-
type: WorkType;
|
|
8930
9609
|
};
|
|
8931
9610
|
/** works-create-request-issue */
|
|
8932
9611
|
export interface WorksCreateRequestIssue {
|
|
@@ -9030,6 +9709,8 @@ export interface WorksDeleteRequest {
|
|
|
9030
9709
|
export type WorksDeleteResponse = object;
|
|
9031
9710
|
/** works-export-request */
|
|
9032
9711
|
export interface WorksExportRequest {
|
|
9712
|
+
/** Filters for work of the provided types. */
|
|
9713
|
+
type?: WorkType[];
|
|
9033
9714
|
/** Provides ways to specify date ranges on objects. */
|
|
9034
9715
|
actual_close_date?: DateFilter;
|
|
9035
9716
|
/**
|
|
@@ -9080,8 +9761,6 @@ export interface WorksExportRequest {
|
|
|
9080
9761
|
/** Provides ways to specify date ranges on objects. */
|
|
9081
9762
|
target_close_date?: DateFilter;
|
|
9082
9763
|
ticket?: WorksFilterTicket;
|
|
9083
|
-
/** Filters for work of the provided types. */
|
|
9084
|
-
type?: WorkType[];
|
|
9085
9764
|
}
|
|
9086
9765
|
/** works-export-response */
|
|
9087
9766
|
export interface WorksExportResponse {
|
|
@@ -9106,6 +9785,8 @@ export interface WorksFilterIssue {
|
|
|
9106
9785
|
* @example ["REV-AbCdEfGh"]
|
|
9107
9786
|
*/
|
|
9108
9787
|
rev_orgs?: string[];
|
|
9788
|
+
/** The filter for SLA summary. */
|
|
9789
|
+
sla_summary?: SlaSummaryFilter;
|
|
9109
9790
|
/** Filters for issues with any of the sprint. */
|
|
9110
9791
|
sprint?: string[];
|
|
9111
9792
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -9167,6 +9848,8 @@ export interface WorksGetResponse {
|
|
|
9167
9848
|
}
|
|
9168
9849
|
/** works-list-request */
|
|
9169
9850
|
export interface WorksListRequest {
|
|
9851
|
+
/** Filters for work of the provided types. */
|
|
9852
|
+
type?: WorkType[];
|
|
9170
9853
|
/** Provides ways to specify date ranges on objects. */
|
|
9171
9854
|
actual_close_date?: DateFilter;
|
|
9172
9855
|
/**
|
|
@@ -9229,8 +9912,6 @@ export interface WorksListRequest {
|
|
|
9229
9912
|
/** Provides ways to specify date ranges on objects. */
|
|
9230
9913
|
target_close_date?: DateFilter;
|
|
9231
9914
|
ticket?: WorksFilterTicket;
|
|
9232
|
-
/** Filters for work of the provided types. */
|
|
9233
|
-
type?: WorkType[];
|
|
9234
9915
|
}
|
|
9235
9916
|
/** works-list-response */
|
|
9236
9917
|
export interface WorksListResponse {
|
|
@@ -9249,6 +9930,7 @@ export interface WorksListResponse {
|
|
|
9249
9930
|
}
|
|
9250
9931
|
/** works-update-request */
|
|
9251
9932
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
9933
|
+
type?: WorkType;
|
|
9252
9934
|
/**
|
|
9253
9935
|
* Updates the part that the work item applies to.
|
|
9254
9936
|
* @example "PROD-12345"
|
|
@@ -9296,7 +9978,6 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
9296
9978
|
target_close_date?: string | null;
|
|
9297
9979
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
9298
9980
|
title?: string;
|
|
9299
|
-
type?: WorkType;
|
|
9300
9981
|
};
|
|
9301
9982
|
/** works-update-request-artifacts */
|
|
9302
9983
|
export interface WorksUpdateRequestArtifacts {
|
|
@@ -9708,6 +10389,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9708
10389
|
* @example ["PROD-12345"]
|
|
9709
10390
|
*/
|
|
9710
10391
|
applies_to_parts?: string[];
|
|
10392
|
+
/**
|
|
10393
|
+
* Filter for the type of articles. If this is not provided, then
|
|
10394
|
+
* articles that are not content blocks are returned.
|
|
10395
|
+
*/
|
|
10396
|
+
article_type?: ArticleType[];
|
|
9711
10397
|
/**
|
|
9712
10398
|
* Filters for articles authored by any of the provided users.
|
|
9713
10399
|
* @example ["DEVU-12345"]
|
|
@@ -9728,6 +10414,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9728
10414
|
* @example ["DEVU-12345"]
|
|
9729
10415
|
*/
|
|
9730
10416
|
owned_by?: string[];
|
|
10417
|
+
/**
|
|
10418
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
10419
|
+
* only external articles are returned.
|
|
10420
|
+
*/
|
|
10421
|
+
scope?: number[];
|
|
9731
10422
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
9732
10423
|
/**
|
|
9733
10424
|
* @description Get count of articles matching given filter.
|
|
@@ -9794,6 +10485,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9794
10485
|
* @example ["PROD-12345"]
|
|
9795
10486
|
*/
|
|
9796
10487
|
applies_to_parts?: string[];
|
|
10488
|
+
/**
|
|
10489
|
+
* Filter for the type of articles. If this is not provided, then
|
|
10490
|
+
* articles that are not content blocks are returned.
|
|
10491
|
+
*/
|
|
10492
|
+
article_type?: ArticleType[];
|
|
9797
10493
|
/**
|
|
9798
10494
|
* Filters for articles authored by any of the provided users.
|
|
9799
10495
|
* @example ["DEVU-12345"]
|
|
@@ -9829,6 +10525,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9829
10525
|
* @example ["DEVU-12345"]
|
|
9830
10526
|
*/
|
|
9831
10527
|
owned_by?: string[];
|
|
10528
|
+
/**
|
|
10529
|
+
* Filter for the scope of the articles. If this is not provided, then
|
|
10530
|
+
* only external articles are returned.
|
|
10531
|
+
*/
|
|
10532
|
+
scope?: number[];
|
|
9832
10533
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
9833
10534
|
/**
|
|
9834
10535
|
* @description Lists a collection of articles.
|
|
@@ -10729,6 +11430,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10729
11430
|
cursor?: string;
|
|
10730
11431
|
/** Filters the groups based on the group type. */
|
|
10731
11432
|
group_type?: GroupType[];
|
|
11433
|
+
/** Whether to fetch default or custom groups. */
|
|
11434
|
+
is_default?: boolean;
|
|
10732
11435
|
/**
|
|
10733
11436
|
* The maximum number of groups to return. The default is '50'.
|
|
10734
11437
|
* @format int32
|
|
@@ -10817,6 +11520,160 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10817
11520
|
* @secure
|
|
10818
11521
|
*/
|
|
10819
11522
|
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
11523
|
+
/**
|
|
11524
|
+
* @description Gets an incident.
|
|
11525
|
+
*
|
|
11526
|
+
* @tags operate
|
|
11527
|
+
* @name IncidentsGet
|
|
11528
|
+
* @request GET:/incidents.get
|
|
11529
|
+
* @secure
|
|
11530
|
+
*/
|
|
11531
|
+
incidentsGet: (query: {
|
|
11532
|
+
/** The ID of the incident to get. */
|
|
11533
|
+
id: string;
|
|
11534
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGetResponse, any>>;
|
|
11535
|
+
/**
|
|
11536
|
+
* @description Gets an incident.
|
|
11537
|
+
*
|
|
11538
|
+
* @tags operate
|
|
11539
|
+
* @name IncidentsGetPost
|
|
11540
|
+
* @request POST:/incidents.get
|
|
11541
|
+
* @secure
|
|
11542
|
+
*/
|
|
11543
|
+
incidentsGetPost: (data: IncidentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsGetResponse, any>>;
|
|
11544
|
+
/**
|
|
11545
|
+
* @description Lists collections of incidents by groups.
|
|
11546
|
+
*
|
|
11547
|
+
* @tags operate
|
|
11548
|
+
* @name IncidentsGroup
|
|
11549
|
+
* @request GET:/incidents.group
|
|
11550
|
+
* @secure
|
|
11551
|
+
*/
|
|
11552
|
+
incidentsGroup: (query: {
|
|
11553
|
+
/** The field to group the incidents by. */
|
|
11554
|
+
group_by: string;
|
|
11555
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
11556
|
+
applies_to_parts?: string[];
|
|
11557
|
+
/**
|
|
11558
|
+
* Filters for incidents created by any of the provided users.
|
|
11559
|
+
* @example ["DEVU-12345"]
|
|
11560
|
+
*/
|
|
11561
|
+
created_by?: string[];
|
|
11562
|
+
/**
|
|
11563
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11564
|
+
* starts from the beginning.
|
|
11565
|
+
*/
|
|
11566
|
+
cursor?: string;
|
|
11567
|
+
/**
|
|
11568
|
+
* The maximum number of groups to return. If not set, then the default
|
|
11569
|
+
* is '10'.
|
|
11570
|
+
* @format int32
|
|
11571
|
+
*/
|
|
11572
|
+
limit?: number;
|
|
11573
|
+
/**
|
|
11574
|
+
* The maximum number of incidents to return for an individual group.
|
|
11575
|
+
* The default is '50'.
|
|
11576
|
+
* @format int32
|
|
11577
|
+
*/
|
|
11578
|
+
limit_per_group?: number;
|
|
11579
|
+
/**
|
|
11580
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11581
|
+
* used.
|
|
11582
|
+
*/
|
|
11583
|
+
mode?: ListMode;
|
|
11584
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
11585
|
+
owned_by?: string[];
|
|
11586
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
11587
|
+
severity?: number[];
|
|
11588
|
+
/** Comma-separated fields to sort the incidents by. */
|
|
11589
|
+
sort_by?: string[];
|
|
11590
|
+
/** Filters for incidents in any of the provided stages. */
|
|
11591
|
+
stage?: string[];
|
|
11592
|
+
/** Filters for incidents by the provided titles. */
|
|
11593
|
+
title?: string[];
|
|
11594
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
11595
|
+
/**
|
|
11596
|
+
* @description Lists collections of incidents by groups.
|
|
11597
|
+
*
|
|
11598
|
+
* @tags operate
|
|
11599
|
+
* @name IncidentsGroupPost
|
|
11600
|
+
* @request POST:/incidents.group
|
|
11601
|
+
* @secure
|
|
11602
|
+
*/
|
|
11603
|
+
incidentsGroupPost: (data: IncidentsGroupRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsGroupResponse, any>>;
|
|
11604
|
+
/**
|
|
11605
|
+
* @description Lists incidents.
|
|
11606
|
+
*
|
|
11607
|
+
* @tags operate
|
|
11608
|
+
* @name IncidentsList
|
|
11609
|
+
* @request GET:/incidents.list
|
|
11610
|
+
* @secure
|
|
11611
|
+
*/
|
|
11612
|
+
incidentsList: (query?: {
|
|
11613
|
+
/** Filters for incidents that apply to any of the provided parts. */
|
|
11614
|
+
applies_to_parts?: string[];
|
|
11615
|
+
/**
|
|
11616
|
+
* Filters for incidents created by any of the provided users.
|
|
11617
|
+
* @example ["DEVU-12345"]
|
|
11618
|
+
*/
|
|
11619
|
+
created_by?: string[];
|
|
11620
|
+
/**
|
|
11621
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11622
|
+
* starts from the beginning.
|
|
11623
|
+
*/
|
|
11624
|
+
cursor?: string;
|
|
11625
|
+
/**
|
|
11626
|
+
* The maximum number of items.
|
|
11627
|
+
* @format int32
|
|
11628
|
+
*/
|
|
11629
|
+
limit?: number;
|
|
11630
|
+
/**
|
|
11631
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11632
|
+
* used.
|
|
11633
|
+
*/
|
|
11634
|
+
mode?: ListMode;
|
|
11635
|
+
/** Filters for incidents owned by any of the provided users. */
|
|
11636
|
+
owned_by?: string[];
|
|
11637
|
+
/** Filters for incidents containing any of the provided severities. */
|
|
11638
|
+
severity?: number[];
|
|
11639
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11640
|
+
sort_by?: string[];
|
|
11641
|
+
/** Filters for incidents in any of the provided stages. */
|
|
11642
|
+
stage?: string[];
|
|
11643
|
+
/** Filters for incidents by the provided titles. */
|
|
11644
|
+
title?: string[];
|
|
11645
|
+
}, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
11646
|
+
/**
|
|
11647
|
+
* @description Lists incidents.
|
|
11648
|
+
*
|
|
11649
|
+
* @tags operate
|
|
11650
|
+
* @name IncidentsListPost
|
|
11651
|
+
* @request POST:/incidents.list
|
|
11652
|
+
* @secure
|
|
11653
|
+
*/
|
|
11654
|
+
incidentsListPost: (data: IncidentsListRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
11655
|
+
/**
|
|
11656
|
+
* @description OAuth2 authorization callback.
|
|
11657
|
+
*
|
|
11658
|
+
* @tags keyring
|
|
11659
|
+
* @name KeyringsCreateCallback
|
|
11660
|
+
* @request GET:/keyrings.authorize
|
|
11661
|
+
*/
|
|
11662
|
+
keyringsCreateCallback: (query: {
|
|
11663
|
+
/** Code to exchange for an access token. */
|
|
11664
|
+
code: string;
|
|
11665
|
+
/** State value given to the authorization request. */
|
|
11666
|
+
state: string;
|
|
11667
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
11668
|
+
/**
|
|
11669
|
+
* @description OAuth2 authorization callback.
|
|
11670
|
+
*
|
|
11671
|
+
* @tags keyring
|
|
11672
|
+
* @name KeyringsCreateCallbackPost
|
|
11673
|
+
* @request POST:/keyrings.authorize
|
|
11674
|
+
* @secure
|
|
11675
|
+
*/
|
|
11676
|
+
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
10820
11677
|
/**
|
|
10821
11678
|
* @description Creates a link between two objects to indicate a relationship.
|
|
10822
11679
|
*
|
|
@@ -10893,6 +11750,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10893
11750
|
* used.
|
|
10894
11751
|
*/
|
|
10895
11752
|
mode?: ListMode;
|
|
11753
|
+
/**
|
|
11754
|
+
* The object types to filter for, otherwise if not present, all object
|
|
11755
|
+
* types are included.
|
|
11756
|
+
*/
|
|
11757
|
+
object_types?: LinkEndpointType[];
|
|
10896
11758
|
/**
|
|
10897
11759
|
* The link types to filter for, otherwise if not present, all link
|
|
10898
11760
|
* types are included.
|
|
@@ -10963,6 +11825,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10963
11825
|
* @secure
|
|
10964
11826
|
*/
|
|
10965
11827
|
metricsDevrevIngest: (data: MetricsDataIngestRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
11828
|
+
/**
|
|
11829
|
+
* @description Generate a notification.
|
|
11830
|
+
*
|
|
11831
|
+
* @tags notifications
|
|
11832
|
+
* @name NotificationsSend
|
|
11833
|
+
* @request POST:/notifications.send
|
|
11834
|
+
* @secure
|
|
11835
|
+
*/
|
|
11836
|
+
notificationsSend: (data: NotificationsSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
10966
11837
|
/**
|
|
10967
11838
|
* @description Creates an organization schedule fragment.
|
|
10968
11839
|
*
|
|
@@ -12317,6 +13188,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12317
13188
|
* @example ["ACC-12345"]
|
|
12318
13189
|
*/
|
|
12319
13190
|
objects?: string[];
|
|
13191
|
+
/**
|
|
13192
|
+
* Filters for survey responses dispatched to any of these users.
|
|
13193
|
+
* @example ["DEVU-12345"]
|
|
13194
|
+
*/
|
|
13195
|
+
recipient?: string[];
|
|
12320
13196
|
/**
|
|
12321
13197
|
* Fields to sort the survey responses by and the direction to sort
|
|
12322
13198
|
* them.
|
|
@@ -12889,6 +13765,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12889
13765
|
* @example ["REV-AbCdEfGh"]
|
|
12890
13766
|
*/
|
|
12891
13767
|
'issue.rev_orgs'?: string[];
|
|
13768
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
13769
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
12892
13770
|
/** Filters for issues with any of the sprint. */
|
|
12893
13771
|
'issue.sprint'?: string[];
|
|
12894
13772
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -13031,6 +13909,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13031
13909
|
* @example ["REV-AbCdEfGh"]
|
|
13032
13910
|
*/
|
|
13033
13911
|
'issue.rev_orgs'?: string[];
|
|
13912
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
13913
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
13034
13914
|
/** Filters for issues with any of the sprint. */
|
|
13035
13915
|
'issue.sprint'?: string[];
|
|
13036
13916
|
/** Filters for issues with any of the provided subtypes. */
|