@devrev/typescript-sdk 1.1.28 → 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.
|
@@ -437,6 +437,10 @@ export interface ArchetypeMetricTarget {
|
|
|
437
437
|
export type Article = AtomBase & {
|
|
438
438
|
/** Details of the parts relevant to the article. */
|
|
439
439
|
applies_to_parts: PartSummary[];
|
|
440
|
+
/** Type of the article. */
|
|
441
|
+
article_type?: ArticleType;
|
|
442
|
+
/** Users that authored the article. */
|
|
443
|
+
authored_by?: UserSummary[];
|
|
440
444
|
/** Description of the article. */
|
|
441
445
|
description?: string;
|
|
442
446
|
/** Artifacts containing the extracted content. */
|
|
@@ -451,11 +455,15 @@ export type Article = AtomBase & {
|
|
|
451
455
|
* @format int32
|
|
452
456
|
*/
|
|
453
457
|
num_upvotes?: number;
|
|
458
|
+
/** The users that own the article. */
|
|
459
|
+
owned_by: UserSummary[];
|
|
454
460
|
parent?: DirectorySummary;
|
|
455
461
|
/** Rank of the article. */
|
|
456
462
|
rank?: string;
|
|
457
463
|
/** Resource details. */
|
|
458
464
|
resource?: Resource;
|
|
465
|
+
/** The properties of an enum value. */
|
|
466
|
+
scope?: EnumValue;
|
|
459
467
|
/** Title of the article. */
|
|
460
468
|
title?: string;
|
|
461
469
|
};
|
|
@@ -477,6 +485,11 @@ export type ArticleSummary = AtomBaseSummary & {
|
|
|
477
485
|
/** Title of the article. */
|
|
478
486
|
title?: string;
|
|
479
487
|
};
|
|
488
|
+
/** Type of the article. */
|
|
489
|
+
export declare enum ArticleType {
|
|
490
|
+
Article = "article",
|
|
491
|
+
ContentBlock = "content_block"
|
|
492
|
+
}
|
|
480
493
|
/** articles-count-request */
|
|
481
494
|
export interface ArticlesCountRequest {
|
|
482
495
|
/** The ancestor directory of the articles. */
|
|
@@ -486,6 +499,11 @@ export interface ArticlesCountRequest {
|
|
|
486
499
|
* @example ["PROD-12345"]
|
|
487
500
|
*/
|
|
488
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[];
|
|
489
507
|
/**
|
|
490
508
|
* Filters for articles authored by any of the provided users.
|
|
491
509
|
* @example ["DEVU-12345"]
|
|
@@ -506,6 +524,11 @@ export interface ArticlesCountRequest {
|
|
|
506
524
|
* @example ["DEVU-12345"]
|
|
507
525
|
*/
|
|
508
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[];
|
|
509
532
|
/** Filter for articles based on intended audience. */
|
|
510
533
|
shared_with?: SharedWithMembershipFilter[];
|
|
511
534
|
}
|
|
@@ -529,6 +552,8 @@ export interface ArticlesCreateRequest {
|
|
|
529
552
|
* @example ["PROD-12345"]
|
|
530
553
|
*/
|
|
531
554
|
applies_to_parts: string[];
|
|
555
|
+
/** Type of the article. */
|
|
556
|
+
article_type?: ArticleType;
|
|
532
557
|
/**
|
|
533
558
|
* The authors of the article.
|
|
534
559
|
* @example ["DEVU-12345"]
|
|
@@ -557,6 +582,11 @@ export interface ArticlesCreateRequest {
|
|
|
557
582
|
*/
|
|
558
583
|
published_at?: string;
|
|
559
584
|
resource: ArticlesCreateRequestResource;
|
|
585
|
+
/**
|
|
586
|
+
* The scope of the article.
|
|
587
|
+
* @format int64
|
|
588
|
+
*/
|
|
589
|
+
scope?: number;
|
|
560
590
|
/** Information about the role the member receives due to the share. */
|
|
561
591
|
shared_with?: SetSharedWithMembership[];
|
|
562
592
|
/** Status of the article. */
|
|
@@ -626,6 +656,11 @@ export interface ArticlesListRequest {
|
|
|
626
656
|
* @example ["PROD-12345"]
|
|
627
657
|
*/
|
|
628
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[];
|
|
629
664
|
/**
|
|
630
665
|
* Filters for articles authored by any of the provided users.
|
|
631
666
|
* @example ["DEVU-12345"]
|
|
@@ -664,6 +699,11 @@ export interface ArticlesListRequest {
|
|
|
664
699
|
* @example ["DEVU-12345"]
|
|
665
700
|
*/
|
|
666
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[];
|
|
667
707
|
/** Filter for articles based on intended audience. */
|
|
668
708
|
shared_with?: SharedWithMembershipFilter[];
|
|
669
709
|
}
|
|
@@ -1006,6 +1046,11 @@ export declare enum AtomType {
|
|
|
1006
1046
|
* authentication connection that is set up for a Dev organization.
|
|
1007
1047
|
*/
|
|
1008
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;
|
|
1009
1054
|
/**
|
|
1010
1055
|
* Display name of the authentication connection. This name will be
|
|
1011
1056
|
* visible to all the users when they sign in to this Dev
|
|
@@ -1021,11 +1066,6 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
1021
1066
|
enabled?: boolean;
|
|
1022
1067
|
/** ID of the authentication connection. */
|
|
1023
1068
|
id: string;
|
|
1024
|
-
/**
|
|
1025
|
-
* Defines the type for the authentication connection. The configuration
|
|
1026
|
-
* for each authentication connection will depend on the type value.
|
|
1027
|
-
*/
|
|
1028
|
-
type: AuthConnectionType;
|
|
1029
1069
|
};
|
|
1030
1070
|
/**
|
|
1031
1071
|
* auth-connection-options-azure-ad
|
|
@@ -1160,11 +1200,11 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
1160
1200
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
1161
1201
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
1162
1202
|
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
1203
|
+
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
1163
1204
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
1164
1205
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
1165
1206
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
1166
1207
|
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
1167
|
-
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
1168
1208
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
1169
1209
|
}
|
|
1170
1210
|
/** The type of the issued token. Bearer is the only supported token type. */
|
|
@@ -1346,7 +1386,10 @@ export interface AuthTokensRevInfo {
|
|
|
1346
1386
|
account_ref?: string;
|
|
1347
1387
|
/** Carries account info. */
|
|
1348
1388
|
account_traits?: AuthTokensAccountTraits;
|
|
1349
|
-
/**
|
|
1389
|
+
/**
|
|
1390
|
+
* An identifier which uniquely identifies a Rev org.
|
|
1391
|
+
* @deprecated
|
|
1392
|
+
*/
|
|
1350
1393
|
org_ref?: string;
|
|
1351
1394
|
/** Carries Rev org info. */
|
|
1352
1395
|
org_traits?: AuthTokensOrgTraits;
|
|
@@ -1504,12 +1547,12 @@ export interface ClientContextCpu {
|
|
|
1504
1547
|
* Properties of client's device to be used in track API.
|
|
1505
1548
|
*/
|
|
1506
1549
|
export interface ClientContextDevice {
|
|
1550
|
+
/** Device type, example: mobile, tablet, desktop. */
|
|
1551
|
+
type?: string;
|
|
1507
1552
|
/** Device manufacturer, example: Apple. */
|
|
1508
1553
|
manufacturer?: string;
|
|
1509
1554
|
/** Device model, example: iphone 6s. */
|
|
1510
1555
|
model?: string;
|
|
1511
|
-
/** Device type, example: mobile, tablet, desktop. */
|
|
1512
|
-
type?: string;
|
|
1513
1556
|
}
|
|
1514
1557
|
/**
|
|
1515
1558
|
* client-context-engine
|
|
@@ -1551,6 +1594,16 @@ export interface ClientContextPage {
|
|
|
1551
1594
|
export type CodeChange = AtomBase & {
|
|
1552
1595
|
/** Name of the code branch in the repo. */
|
|
1553
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;
|
|
1554
1607
|
/** Detailed description of the contents of this change. */
|
|
1555
1608
|
description?: string;
|
|
1556
1609
|
/** Unique external identifier for this change.e.g Pull Request URL. */
|
|
@@ -1561,6 +1614,8 @@ export type CodeChange = AtomBase & {
|
|
|
1561
1614
|
repo_url?: string;
|
|
1562
1615
|
/** Source of the code change object. */
|
|
1563
1616
|
source?: CodeChangeSource;
|
|
1617
|
+
/** Name of the target branch in the repo. */
|
|
1618
|
+
target_branch?: string;
|
|
1564
1619
|
/** Title describing in brief the contents of this change. */
|
|
1565
1620
|
title?: string;
|
|
1566
1621
|
/** Details of lines of code in this code change. */
|
|
@@ -1646,6 +1701,19 @@ export interface CodeChangesUpdateResponse {
|
|
|
1646
1701
|
/** comment-search-summary */
|
|
1647
1702
|
export interface CommentSearchSummary {
|
|
1648
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[];
|
|
1649
1717
|
/** Text snippet where the search hit occurred. */
|
|
1650
1718
|
snippet?: string;
|
|
1651
1719
|
}
|
|
@@ -1700,6 +1768,7 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
1700
1768
|
* The request to create a new conversation.
|
|
1701
1769
|
*/
|
|
1702
1770
|
export interface ConversationsCreateRequest {
|
|
1771
|
+
type: ConversationsCreateRequestTypeValue;
|
|
1703
1772
|
/** Description for the conversation. */
|
|
1704
1773
|
description?: string;
|
|
1705
1774
|
/** The group that the conversation is associated with. */
|
|
@@ -1722,7 +1791,6 @@ export interface ConversationsCreateRequest {
|
|
|
1722
1791
|
tags?: SetTagWithValue[];
|
|
1723
1792
|
/** The title for the conversation. */
|
|
1724
1793
|
title?: string;
|
|
1725
|
-
type: ConversationsCreateRequestTypeValue;
|
|
1726
1794
|
/** The IDs of user sessions associated with the conversation. */
|
|
1727
1795
|
user_sessions?: string[];
|
|
1728
1796
|
}
|
|
@@ -2204,6 +2272,7 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
2204
2272
|
}
|
|
2205
2273
|
/** custom-schema-fragments-set-request */
|
|
2206
2274
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
2275
|
+
type: CustomSchemaFragmentsSetRequestType;
|
|
2207
2276
|
/** List of conditions for this fragment. */
|
|
2208
2277
|
conditions?: CustomSchemaFragmentCondition[];
|
|
2209
2278
|
/** List of field names which are being dropped. */
|
|
@@ -2218,7 +2287,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
2218
2287
|
is_custom_leaf_type?: boolean;
|
|
2219
2288
|
/** The leaf type this fragment applies to. */
|
|
2220
2289
|
leaf_type: string;
|
|
2221
|
-
type: CustomSchemaFragmentsSetRequestType;
|
|
2222
2290
|
};
|
|
2223
2291
|
/** custom-schema-fragments-set-request-app-fragment */
|
|
2224
2292
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
@@ -2278,6 +2346,8 @@ export interface CustomSchemaSpec {
|
|
|
2278
2346
|
}
|
|
2279
2347
|
/** custom-stage */
|
|
2280
2348
|
export type CustomStage = AtomBase;
|
|
2349
|
+
/** custom-stage-summary */
|
|
2350
|
+
export type CustomStageSummary = AtomBaseSummary;
|
|
2281
2351
|
/** custom-stages-create-request */
|
|
2282
2352
|
export interface CustomStagesCreateRequest {
|
|
2283
2353
|
/**
|
|
@@ -2523,6 +2593,11 @@ export declare enum DateTimePresetType {
|
|
|
2523
2593
|
* Request to create a new enterprise authentication connection.
|
|
2524
2594
|
*/
|
|
2525
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;
|
|
2526
2601
|
/**
|
|
2527
2602
|
* Display name of the authentication connection. This name will be
|
|
2528
2603
|
* visible to all the users when they sign in to this Dev
|
|
@@ -2530,11 +2605,6 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2530
2605
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
2531
2606
|
*/
|
|
2532
2607
|
display_name?: string;
|
|
2533
|
-
/**
|
|
2534
|
-
* Defines the type for the authentication connection. Different types of
|
|
2535
|
-
* authentication connections have different configuration parameters.
|
|
2536
|
-
*/
|
|
2537
|
-
type: DevOrgAuthConnectionsCreateRequestType;
|
|
2538
2608
|
};
|
|
2539
2609
|
/**
|
|
2540
2610
|
* Defines the type for the authentication connection. Different types of
|
|
@@ -2617,6 +2687,12 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
2617
2687
|
* organization.
|
|
2618
2688
|
*/
|
|
2619
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;
|
|
2620
2696
|
/**
|
|
2621
2697
|
* New display name of the authentication connection. This name will
|
|
2622
2698
|
* be visible to all the users when they sign in to this Dev
|
|
@@ -2626,12 +2702,6 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
2626
2702
|
display_name?: string;
|
|
2627
2703
|
/** ID of the authentication connection which is to be updated. */
|
|
2628
2704
|
id: string;
|
|
2629
|
-
/**
|
|
2630
|
-
* Specifies the type for the authentication connection. Different types
|
|
2631
|
-
* of authentication connections have different configuration parameters
|
|
2632
|
-
* that can be updated.
|
|
2633
|
-
*/
|
|
2634
|
-
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
2635
2705
|
};
|
|
2636
2706
|
/**
|
|
2637
2707
|
* Specifies the type for the authentication connection. Different types
|
|
@@ -2935,6 +3005,8 @@ export declare enum EngagementType {
|
|
|
2935
3005
|
}
|
|
2936
3006
|
/** engagements-count-request */
|
|
2937
3007
|
export interface EngagementsCountRequest {
|
|
3008
|
+
/** Filters for engagement of the provided types. */
|
|
3009
|
+
type?: EngagementType[];
|
|
2938
3010
|
/** Filters for meetings with the provided external_refs. */
|
|
2939
3011
|
external_ref?: string[];
|
|
2940
3012
|
/**
|
|
@@ -2947,8 +3019,6 @@ export interface EngagementsCountRequest {
|
|
|
2947
3019
|
* @example ["ACC-12345"]
|
|
2948
3020
|
*/
|
|
2949
3021
|
parent?: string[];
|
|
2950
|
-
/** Filters for engagement of the provided types. */
|
|
2951
|
-
type?: EngagementType[];
|
|
2952
3022
|
}
|
|
2953
3023
|
/** engagements-count-response */
|
|
2954
3024
|
export interface EngagementsCountResponse {
|
|
@@ -3027,6 +3097,8 @@ export interface EngagementsGetResponse {
|
|
|
3027
3097
|
}
|
|
3028
3098
|
/** engagements-list-request */
|
|
3029
3099
|
export interface EngagementsListRequest {
|
|
3100
|
+
/** Filters for engagement of the provided types. */
|
|
3101
|
+
type?: EngagementType[];
|
|
3030
3102
|
/**
|
|
3031
3103
|
* The cursor to resume iteration from. If not provided, then
|
|
3032
3104
|
* iteration starts from the beginning.
|
|
@@ -3059,8 +3131,6 @@ export interface EngagementsListRequest {
|
|
|
3059
3131
|
parent?: string[];
|
|
3060
3132
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
3061
3133
|
sort_by?: string[];
|
|
3062
|
-
/** Filters for engagement of the provided types. */
|
|
3063
|
-
type?: EngagementType[];
|
|
3064
3134
|
}
|
|
3065
3135
|
/** engagements-list-response */
|
|
3066
3136
|
export interface EngagementsListResponse {
|
|
@@ -3132,24 +3202,26 @@ export type Enhancement = PartBase;
|
|
|
3132
3202
|
export type EnhancementSummary = PartBaseSummary;
|
|
3133
3203
|
/**
|
|
3134
3204
|
* enum-value
|
|
3135
|
-
*
|
|
3205
|
+
* The properties of an enum value.
|
|
3136
3206
|
*/
|
|
3137
3207
|
export interface EnumValue {
|
|
3138
3208
|
/**
|
|
3139
|
-
*
|
|
3209
|
+
* The uiique ID of the enum value.
|
|
3140
3210
|
* @format int64
|
|
3141
3211
|
*/
|
|
3142
3212
|
id: number;
|
|
3143
|
-
/**
|
|
3213
|
+
/** The display label of the enum value. */
|
|
3144
3214
|
label: string;
|
|
3145
3215
|
/**
|
|
3146
|
-
*
|
|
3216
|
+
* Used for determining the relative order of the enum value.
|
|
3147
3217
|
* @format int64
|
|
3148
3218
|
*/
|
|
3149
3219
|
ordinal: number;
|
|
3150
3220
|
}
|
|
3151
3221
|
/** error */
|
|
3152
3222
|
export interface Error {
|
|
3223
|
+
/** The error type. */
|
|
3224
|
+
type?: string;
|
|
3153
3225
|
/** Information about the error. */
|
|
3154
3226
|
message: string;
|
|
3155
3227
|
/**
|
|
@@ -3157,11 +3229,9 @@ export interface Error {
|
|
|
3157
3229
|
* @format int32
|
|
3158
3230
|
*/
|
|
3159
3231
|
status: number;
|
|
3160
|
-
/** The error type. */
|
|
3161
|
-
type?: string;
|
|
3162
3232
|
}
|
|
3163
3233
|
/** error-bad-request */
|
|
3164
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3234
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3165
3235
|
type: ErrorBadRequestType;
|
|
3166
3236
|
};
|
|
3167
3237
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -3197,6 +3267,44 @@ export interface ErrorBadRequestInvalidId {
|
|
|
3197
3267
|
/** The field whose ID is invalid. */
|
|
3198
3268
|
field_name: string;
|
|
3199
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
|
+
}
|
|
3200
3308
|
/** error-bad-request-missing-dependency */
|
|
3201
3309
|
export interface ErrorBadRequestMissingDependency {
|
|
3202
3310
|
/** The dependent fields. */
|
|
@@ -3240,6 +3348,7 @@ export declare enum ErrorBadRequestType {
|
|
|
3240
3348
|
InvalidEnumValue = "invalid_enum_value",
|
|
3241
3349
|
InvalidField = "invalid_field",
|
|
3242
3350
|
InvalidId = "invalid_id",
|
|
3351
|
+
MergeWorksError = "merge_works_error",
|
|
3243
3352
|
MissingDependency = "missing_dependency",
|
|
3244
3353
|
MissingRequiredField = "missing_required_field",
|
|
3245
3354
|
ParseError = "parse_error",
|
|
@@ -3304,12 +3413,12 @@ export declare enum ErrorForbiddenType {
|
|
|
3304
3413
|
}
|
|
3305
3414
|
/** error-internal-server-error */
|
|
3306
3415
|
export type ErrorInternalServerError = ErrorBase & ErrorInternalServerErrorInternalError & {
|
|
3416
|
+
type: ErrorInternalServerErrorType;
|
|
3307
3417
|
/**
|
|
3308
3418
|
* A unique ID that's generated for the error that can be used for
|
|
3309
3419
|
* inquiry.
|
|
3310
3420
|
*/
|
|
3311
3421
|
reference_id?: string;
|
|
3312
|
-
type: ErrorInternalServerErrorType;
|
|
3313
3422
|
};
|
|
3314
3423
|
/** error-internal-server-error-internal-error */
|
|
3315
3424
|
export type ErrorInternalServerErrorInternalError = object;
|
|
@@ -3336,12 +3445,12 @@ export declare enum ErrorServiceUnavailableType {
|
|
|
3336
3445
|
}
|
|
3337
3446
|
/** error-too-many-requests */
|
|
3338
3447
|
export type ErrorTooManyRequests = ErrorBase & ErrorTooManyRequestsTooManyRequests & {
|
|
3448
|
+
type: ErrorTooManyRequestsType;
|
|
3339
3449
|
/**
|
|
3340
3450
|
* The number of seconds after which the client should retry.
|
|
3341
3451
|
* @format int64
|
|
3342
3452
|
*/
|
|
3343
3453
|
retry_after?: number;
|
|
3344
|
-
type: ErrorTooManyRequestsType;
|
|
3345
3454
|
};
|
|
3346
3455
|
/** error-too-many-requests-too-many-requests */
|
|
3347
3456
|
export type ErrorTooManyRequestsTooManyRequests = object;
|
|
@@ -3368,10 +3477,12 @@ export interface EventAccountDeleted {
|
|
|
3368
3477
|
* @example "ACC-12345"
|
|
3369
3478
|
*/
|
|
3370
3479
|
id: string;
|
|
3480
|
+
old_account?: Account;
|
|
3371
3481
|
}
|
|
3372
3482
|
/** event-account-updated */
|
|
3373
3483
|
export interface EventAccountUpdated {
|
|
3374
3484
|
account: Account;
|
|
3485
|
+
old_account?: Account;
|
|
3375
3486
|
}
|
|
3376
3487
|
/** event-conversation-created */
|
|
3377
3488
|
export interface EventConversationCreated {
|
|
@@ -3394,10 +3505,25 @@ export interface EventDevUserCreated {
|
|
|
3394
3505
|
export interface EventDevUserDeleted {
|
|
3395
3506
|
/** The ID of the Dev user that was deleted. */
|
|
3396
3507
|
id: string;
|
|
3508
|
+
old_dev_user?: DevUser;
|
|
3397
3509
|
}
|
|
3398
3510
|
/** event-dev-user-updated */
|
|
3399
3511
|
export interface EventDevUserUpdated {
|
|
3400
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;
|
|
3401
3527
|
}
|
|
3402
3528
|
/** event-part-created */
|
|
3403
3529
|
export interface EventPartCreated {
|
|
@@ -3410,9 +3536,11 @@ export interface EventPartDeleted {
|
|
|
3410
3536
|
* @example "PROD-12345"
|
|
3411
3537
|
*/
|
|
3412
3538
|
id: string;
|
|
3539
|
+
old_part?: Part;
|
|
3413
3540
|
}
|
|
3414
3541
|
/** event-part-updated */
|
|
3415
3542
|
export interface EventPartUpdated {
|
|
3543
|
+
old_part?: Part;
|
|
3416
3544
|
part: Part;
|
|
3417
3545
|
}
|
|
3418
3546
|
/** event-rev-org-created */
|
|
@@ -3426,9 +3554,11 @@ export interface EventRevOrgDeleted {
|
|
|
3426
3554
|
* @example "REV-AbCdEfGh"
|
|
3427
3555
|
*/
|
|
3428
3556
|
id: string;
|
|
3557
|
+
old_rev_org?: RevOrg;
|
|
3429
3558
|
}
|
|
3430
3559
|
/** event-rev-org-updated */
|
|
3431
3560
|
export interface EventRevOrgUpdated {
|
|
3561
|
+
old_rev_org?: RevOrg;
|
|
3432
3562
|
rev_org: RevOrg;
|
|
3433
3563
|
}
|
|
3434
3564
|
/** event-rev-user-created */
|
|
@@ -3439,9 +3569,11 @@ export interface EventRevUserCreated {
|
|
|
3439
3569
|
export interface EventRevUserDeleted {
|
|
3440
3570
|
/** The ID of the Rev user that was deleted. */
|
|
3441
3571
|
id: string;
|
|
3572
|
+
old_rev_user?: RevUser;
|
|
3442
3573
|
}
|
|
3443
3574
|
/** event-rev-user-updated */
|
|
3444
3575
|
export interface EventRevUserUpdated {
|
|
3576
|
+
old_rev_user?: RevUser;
|
|
3445
3577
|
rev_user: RevUser;
|
|
3446
3578
|
}
|
|
3447
3579
|
/** event-sla-tracker-created */
|
|
@@ -3624,9 +3756,11 @@ export interface EventWorkDeleted {
|
|
|
3624
3756
|
* @example "ISS-12345"
|
|
3625
3757
|
*/
|
|
3626
3758
|
id: string;
|
|
3759
|
+
old_work?: Work;
|
|
3627
3760
|
}
|
|
3628
3761
|
/** event-work-updated */
|
|
3629
3762
|
export interface EventWorkUpdated {
|
|
3763
|
+
old_work?: Work;
|
|
3630
3764
|
work: Work;
|
|
3631
3765
|
}
|
|
3632
3766
|
/**
|
|
@@ -3652,6 +3786,14 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
3652
3786
|
* Set of field attributes.
|
|
3653
3787
|
*/
|
|
3654
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
|
+
}
|
|
3655
3797
|
/** group */
|
|
3656
3798
|
export type Group = AtomBase & {
|
|
3657
3799
|
/** Description of the group. */
|
|
@@ -3786,6 +3928,8 @@ export type GroupedVistaSummary = VistaBaseSummary & {
|
|
|
3786
3928
|
* A request to create a new group.
|
|
3787
3929
|
*/
|
|
3788
3930
|
export interface GroupsCreateRequest {
|
|
3931
|
+
/** Type of the group. */
|
|
3932
|
+
type?: GroupType;
|
|
3789
3933
|
/** Description of the group. */
|
|
3790
3934
|
description: string;
|
|
3791
3935
|
/** Information to define dynamic groups. */
|
|
@@ -3796,8 +3940,6 @@ export interface GroupsCreateRequest {
|
|
|
3796
3940
|
name: string;
|
|
3797
3941
|
/** Owner of the group. */
|
|
3798
3942
|
owner?: string;
|
|
3799
|
-
/** Type of the group. */
|
|
3800
|
-
type?: GroupType;
|
|
3801
3943
|
}
|
|
3802
3944
|
/**
|
|
3803
3945
|
* groups-create-response
|
|
@@ -3833,6 +3975,8 @@ export interface GroupsListRequest {
|
|
|
3833
3975
|
cursor?: string;
|
|
3834
3976
|
/** Filters the groups based on the group type. */
|
|
3835
3977
|
group_type?: GroupType[];
|
|
3978
|
+
/** Whether to fetch default or custom groups. */
|
|
3979
|
+
is_default?: boolean;
|
|
3836
3980
|
/**
|
|
3837
3981
|
* The maximum number of groups to return. The default is '50'.
|
|
3838
3982
|
* @format int32
|
|
@@ -3896,12 +4040,220 @@ export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
|
3896
4040
|
export interface GroupsUpdateResponse {
|
|
3897
4041
|
group: Group;
|
|
3898
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
|
+
}
|
|
3899
4250
|
/** issue */
|
|
3900
4251
|
export type Issue = WorkBase & {
|
|
3901
4252
|
/** Parts associated based on git events. */
|
|
3902
4253
|
developed_with?: PartSummary[];
|
|
3903
4254
|
/** Priority of the work based upon impact and criticality. */
|
|
3904
4255
|
priority?: IssuePriority;
|
|
4256
|
+
sla_tracker?: SlaTrackerSummary;
|
|
3905
4257
|
/** Vista group item. */
|
|
3906
4258
|
sprint?: VistaGroupItemSummary;
|
|
3907
4259
|
/**
|
|
@@ -3928,7 +4280,7 @@ export type IssueSummary = WorkBaseSummary & {
|
|
|
3928
4280
|
* Defines a job history line item.
|
|
3929
4281
|
*/
|
|
3930
4282
|
export interface JobHistoryItem {
|
|
3931
|
-
/**
|
|
4283
|
+
/** The properties of an enum value. */
|
|
3932
4284
|
employment_status?: EnumValue;
|
|
3933
4285
|
/**
|
|
3934
4286
|
* The end date of the job, or not specified if current.
|
|
@@ -3949,6 +4301,13 @@ export interface JobHistoryItem {
|
|
|
3949
4301
|
/** The job title for the user. */
|
|
3950
4302
|
title?: string;
|
|
3951
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
|
+
}
|
|
3952
4311
|
/**
|
|
3953
4312
|
* legacy-stage
|
|
3954
4313
|
* Describes the current stage of a work item.
|
|
@@ -3956,6 +4315,7 @@ export interface JobHistoryItem {
|
|
|
3956
4315
|
export interface LegacyStage {
|
|
3957
4316
|
/** Current stage name of the work item. */
|
|
3958
4317
|
name: string;
|
|
4318
|
+
stage?: CustomStageSummary;
|
|
3959
4319
|
}
|
|
3960
4320
|
/**
|
|
3961
4321
|
* legacy-stage-summary
|
|
@@ -4059,10 +4419,13 @@ export type LinkSummary = AtomBaseSummary & {
|
|
|
4059
4419
|
};
|
|
4060
4420
|
/** Type of link used to define the relationship. */
|
|
4061
4421
|
export declare enum LinkType {
|
|
4422
|
+
CustomLink = "custom_link",
|
|
4062
4423
|
DevelopedWith = "developed_with",
|
|
4063
4424
|
Imports = "imports",
|
|
4425
|
+
IsAnalyzedBy = "is_analyzed_by",
|
|
4064
4426
|
IsDependentOn = "is_dependent_on",
|
|
4065
4427
|
IsDuplicateOf = "is_duplicate_of",
|
|
4428
|
+
IsMergedInto = "is_merged_into",
|
|
4066
4429
|
IsParentOf = "is_parent_of",
|
|
4067
4430
|
IsPartOf = "is_part_of",
|
|
4068
4431
|
IsRelatedTo = "is_related_to",
|
|
@@ -4161,6 +4524,11 @@ export interface LinksListRequest {
|
|
|
4161
4524
|
mode?: ListMode;
|
|
4162
4525
|
/** The ID of the object to list the links for. */
|
|
4163
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[];
|
|
4164
4532
|
/**
|
|
4165
4533
|
* The link types to filter for, otherwise if not present, all link
|
|
4166
4534
|
* types are included.
|
|
@@ -4289,6 +4657,8 @@ export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
|
4289
4657
|
};
|
|
4290
4658
|
/** metric-definitions-list-request */
|
|
4291
4659
|
export interface MetricDefinitionsListRequest {
|
|
4660
|
+
/** The type of metric definitions sought. */
|
|
4661
|
+
type?: MetricDefinitionMetricType[];
|
|
4292
4662
|
/** The type of objects the metric definition applies to. */
|
|
4293
4663
|
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
4294
4664
|
/**
|
|
@@ -4316,8 +4686,6 @@ export interface MetricDefinitionsListRequest {
|
|
|
4316
4686
|
mode?: ListMode;
|
|
4317
4687
|
/** The status of the metric definition. */
|
|
4318
4688
|
status?: MetricDefinitionStatus[];
|
|
4319
|
-
/** The type of metric definitions sought. */
|
|
4320
|
-
type?: MetricDefinitionMetricType[];
|
|
4321
4689
|
}
|
|
4322
4690
|
/** metric-definitions-list-response */
|
|
4323
4691
|
export interface MetricDefinitionsListResponse {
|
|
@@ -4336,6 +4704,16 @@ export interface MetricDefinitionsListResponse {
|
|
|
4336
4704
|
}
|
|
4337
4705
|
/** metrics-data */
|
|
4338
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;
|
|
4339
4717
|
/**
|
|
4340
4718
|
* One or more data points collected for a given metric such as object
|
|
4341
4719
|
* usage, object state etc.
|
|
@@ -4357,7 +4735,7 @@ export interface MetricsData {
|
|
|
4357
4735
|
* external_ref=org_customer_1 may resolve to
|
|
4358
4736
|
* don:identity:dvrv-us-1:devo/0:revo/155.
|
|
4359
4737
|
*/
|
|
4360
|
-
org_ref
|
|
4738
|
+
org_ref?: string;
|
|
4361
4739
|
/** Rev User ID or user ref for which metric is being published. */
|
|
4362
4740
|
user_ref?: string;
|
|
4363
4741
|
}
|
|
@@ -4369,6 +4747,17 @@ export interface MetricsDataIngestRequest {
|
|
|
4369
4747
|
*/
|
|
4370
4748
|
metrics: MetricsData[];
|
|
4371
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;
|
|
4372
4761
|
/** object-member-search-summary */
|
|
4373
4762
|
export type ObjectMemberSearchSummary = SearchSummaryBase & {
|
|
4374
4763
|
object_member: ObjectMemberSummary;
|
|
@@ -4813,6 +5202,8 @@ export type PartBase = AtomBase & {
|
|
|
4813
5202
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
4814
5203
|
/** Name of the part. */
|
|
4815
5204
|
name: string;
|
|
5205
|
+
/** The users that own the part. */
|
|
5206
|
+
owned_by: UserSummary[];
|
|
4816
5207
|
};
|
|
4817
5208
|
/** part-search-summary */
|
|
4818
5209
|
export type PartSearchSummary = SearchSummaryBase & {
|
|
@@ -4835,6 +5226,7 @@ export declare enum PartType {
|
|
|
4835
5226
|
}
|
|
4836
5227
|
/** parts-create-request */
|
|
4837
5228
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
5229
|
+
type: PartType;
|
|
4838
5230
|
/**
|
|
4839
5231
|
* The IDs of the artifacts.
|
|
4840
5232
|
* @example ["ARTIFACT-12345"]
|
|
@@ -4856,7 +5248,6 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
4856
5248
|
* @example ["DEVU-12345"]
|
|
4857
5249
|
*/
|
|
4858
5250
|
owned_by: string[];
|
|
4859
|
-
type: PartType;
|
|
4860
5251
|
};
|
|
4861
5252
|
/** parts-create-request-capability */
|
|
4862
5253
|
export interface PartsCreateRequestCapability {
|
|
@@ -4928,6 +5319,8 @@ export interface PartsGetResponse {
|
|
|
4928
5319
|
}
|
|
4929
5320
|
/** parts-list-request */
|
|
4930
5321
|
export interface PartsListRequest {
|
|
5322
|
+
/** Filters for parts of the provided type(s). */
|
|
5323
|
+
type?: PartType[];
|
|
4931
5324
|
/**
|
|
4932
5325
|
* Filters for parts created by any of these users.
|
|
4933
5326
|
* @example ["DEVU-12345"]
|
|
@@ -4960,8 +5353,6 @@ export interface PartsListRequest {
|
|
|
4960
5353
|
owned_by?: string[];
|
|
4961
5354
|
/** The filter for specifying parent part. */
|
|
4962
5355
|
parent_part?: ParentPartFilter;
|
|
4963
|
-
/** Filters for parts of the provided type(s). */
|
|
4964
|
-
type?: PartType[];
|
|
4965
5356
|
}
|
|
4966
5357
|
/** parts-list-response */
|
|
4967
5358
|
export interface PartsListResponse {
|
|
@@ -4980,6 +5371,7 @@ export interface PartsListResponse {
|
|
|
4980
5371
|
}
|
|
4981
5372
|
/** parts-update-request */
|
|
4982
5373
|
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
5374
|
+
type?: PartType;
|
|
4983
5375
|
artifacts?: PartsUpdateRequestArtifacts;
|
|
4984
5376
|
/** Custom fields. */
|
|
4985
5377
|
custom_fields?: object;
|
|
@@ -4998,7 +5390,6 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
4998
5390
|
/** The updated name of the part. */
|
|
4999
5391
|
name?: string;
|
|
5000
5392
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
5001
|
-
type?: PartType;
|
|
5002
5393
|
};
|
|
5003
5394
|
/** parts-update-request-artifacts */
|
|
5004
5395
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -5649,6 +6040,11 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
5649
6040
|
* Request object to create a new Rev user for a Rev organization.
|
|
5650
6041
|
*/
|
|
5651
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;
|
|
5652
6048
|
/**
|
|
5653
6049
|
* The IDs of the artifacts to associate with the Rev user.
|
|
5654
6050
|
* @example ["ARTIFACT-12345"]
|
|
@@ -5903,11 +6299,11 @@ export interface SchemaFieldCreateViewUiMetadata {
|
|
|
5903
6299
|
* schema-field-descriptor
|
|
5904
6300
|
* Set of field attributes.
|
|
5905
6301
|
*/
|
|
5906
|
-
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) & {
|
|
5907
6303
|
field_type: SchemaFieldDescriptorFieldType;
|
|
5908
6304
|
};
|
|
5909
6305
|
/** schema-field-descriptor-array-type */
|
|
5910
|
-
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) & {
|
|
5911
6307
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
5912
6308
|
/**
|
|
5913
6309
|
* The exact array length.
|
|
@@ -5934,6 +6330,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
5934
6330
|
Id = "id",
|
|
5935
6331
|
Int = "int",
|
|
5936
6332
|
RichText = "rich_text",
|
|
6333
|
+
Struct = "struct",
|
|
5937
6334
|
Text = "text",
|
|
5938
6335
|
Timestamp = "timestamp",
|
|
5939
6336
|
Tokens = "tokens",
|
|
@@ -5975,6 +6372,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
5975
6372
|
Id = "id",
|
|
5976
6373
|
Int = "int",
|
|
5977
6374
|
RichText = "rich_text",
|
|
6375
|
+
Struct = "struct",
|
|
5978
6376
|
Text = "text",
|
|
5979
6377
|
Timestamp = "timestamp",
|
|
5980
6378
|
Tokens = "tokens",
|
|
@@ -6055,6 +6453,8 @@ export interface SchemaFieldUiMetadata {
|
|
|
6055
6453
|
is_hidden_during_create?: boolean;
|
|
6056
6454
|
/** Whether the field is read-only in the UI. */
|
|
6057
6455
|
is_read_only?: boolean;
|
|
6456
|
+
/** Whether the field is mandatory in the UI. */
|
|
6457
|
+
is_required?: boolean;
|
|
6058
6458
|
/** Whether the field is shown in the UI summary view. */
|
|
6059
6459
|
is_shown_in_summary?: boolean;
|
|
6060
6460
|
/** Whether the field is sortable in the UI. */
|
|
@@ -6191,6 +6591,16 @@ export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
6191
6591
|
/** The string suffix. */
|
|
6192
6592
|
suffix?: string;
|
|
6193
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
|
+
};
|
|
6194
6604
|
/** schema-text-field-descriptor */
|
|
6195
6605
|
export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
6196
6606
|
/** The contained substring. */
|
|
@@ -6377,10 +6787,13 @@ export interface SearchCoreResponse {
|
|
|
6377
6787
|
export declare enum SearchHybridNamespace {
|
|
6378
6788
|
Article = "article",
|
|
6379
6789
|
Conversation = "conversation",
|
|
6790
|
+
Dataset = "dataset",
|
|
6791
|
+
Incident = "incident",
|
|
6380
6792
|
Issue = "issue",
|
|
6381
6793
|
Part = "part",
|
|
6382
6794
|
QuestionAnswer = "question_answer",
|
|
6383
6795
|
Ticket = "ticket",
|
|
6796
|
+
Widget = "widget",
|
|
6384
6797
|
Work = "work"
|
|
6385
6798
|
}
|
|
6386
6799
|
/**
|
|
@@ -6498,6 +6911,56 @@ export interface SearchSummaryBase {
|
|
|
6498
6911
|
/** Text snippet where the search hit occurred. */
|
|
6499
6912
|
snippet?: string;
|
|
6500
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
|
+
}
|
|
6501
6964
|
/** service-account */
|
|
6502
6965
|
export type ServiceAccount = UserBase;
|
|
6503
6966
|
/** service-account-summary */
|
|
@@ -7038,13 +7501,13 @@ export declare enum SnapWidgetType {
|
|
|
7038
7501
|
}
|
|
7039
7502
|
/** snap-widgets-create-request */
|
|
7040
7503
|
export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
|
|
7504
|
+
type: SnapWidgetsCreateRequestType;
|
|
7041
7505
|
/** A human readable name for the snap widget. */
|
|
7042
7506
|
name: string;
|
|
7043
7507
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
7044
7508
|
namespace?: SnapWidgetNamespace;
|
|
7045
7509
|
/** The status of the snap widget. */
|
|
7046
7510
|
status?: SnapWidgetStatus;
|
|
7047
|
-
type: SnapWidgetsCreateRequestType;
|
|
7048
7511
|
};
|
|
7049
7512
|
export declare enum SnapWidgetsCreateRequestType {
|
|
7050
7513
|
EmailPreview = "email_preview"
|
|
@@ -7053,6 +7516,11 @@ export declare enum SnapWidgetsCreateRequestType {
|
|
|
7053
7516
|
export interface SnapWidgetsCreateResponse {
|
|
7054
7517
|
snap_widget: SnapWidget;
|
|
7055
7518
|
}
|
|
7519
|
+
/**
|
|
7520
|
+
* stage
|
|
7521
|
+
* Describes the current stage of a object.
|
|
7522
|
+
*/
|
|
7523
|
+
export type Stage = object;
|
|
7056
7524
|
/** stage-diagram-summary */
|
|
7057
7525
|
export type StageDiagramSummary = AtomBaseSummary;
|
|
7058
7526
|
/**
|
|
@@ -7068,6 +7536,11 @@ export interface StageFilter {
|
|
|
7068
7536
|
* Sets an object's initial stage.
|
|
7069
7537
|
*/
|
|
7070
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;
|
|
7071
7544
|
/** The name of the stage. */
|
|
7072
7545
|
name?: string;
|
|
7073
7546
|
}
|
|
@@ -7078,6 +7551,11 @@ export interface StageInit {
|
|
|
7078
7551
|
export interface StageUpdate {
|
|
7079
7552
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
7080
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;
|
|
7081
7559
|
}
|
|
7082
7560
|
/** Type of stage validation options when creating an object. */
|
|
7083
7561
|
export declare enum StageValidationOptionForCreate {
|
|
@@ -7247,9 +7725,9 @@ export type SurveyResponse = AtomBase & {
|
|
|
7247
7725
|
recipient?: UserSummary;
|
|
7248
7726
|
/** Response for the survey. */
|
|
7249
7727
|
response?: object;
|
|
7250
|
-
/**
|
|
7728
|
+
/** The properties of an enum value. */
|
|
7251
7729
|
response_channel?: EnumValue;
|
|
7252
|
-
/**
|
|
7730
|
+
/** The properties of an enum value. */
|
|
7253
7731
|
stage?: EnumValue;
|
|
7254
7732
|
/** The ID of the survey for which response is taken. */
|
|
7255
7733
|
survey?: string;
|
|
@@ -7365,6 +7843,11 @@ export interface SurveysResponsesListRequest {
|
|
|
7365
7843
|
* @example ["ACC-12345"]
|
|
7366
7844
|
*/
|
|
7367
7845
|
objects?: string[];
|
|
7846
|
+
/**
|
|
7847
|
+
* Filters for survey responses dispatched to any of these users.
|
|
7848
|
+
* @example ["DEVU-12345"]
|
|
7849
|
+
*/
|
|
7850
|
+
recipient?: string[];
|
|
7368
7851
|
/**
|
|
7369
7852
|
* Fields to sort the survey responses by and the direction to sort
|
|
7370
7853
|
* them.
|
|
@@ -7764,6 +8247,8 @@ export type Ticket = WorkBase & {
|
|
|
7764
8247
|
/** Whether the ticket needs a response. */
|
|
7765
8248
|
needs_response?: boolean;
|
|
7766
8249
|
rev_org?: OrgSummary;
|
|
8250
|
+
/** The properties of an enum value. */
|
|
8251
|
+
sentiment?: EnumValue;
|
|
7767
8252
|
/** Severity of the ticket. */
|
|
7768
8253
|
severity?: TicketSeverity;
|
|
7769
8254
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -7824,6 +8309,7 @@ export declare enum TimelineEntriesCollection {
|
|
|
7824
8309
|
* The request to create a timeline entry for an object.
|
|
7825
8310
|
*/
|
|
7826
8311
|
export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineComment & {
|
|
8312
|
+
type: TimelineEntriesCreateRequestType;
|
|
7827
8313
|
/**
|
|
7828
8314
|
* The collection(s) that the entry belongs to, otherwise if not
|
|
7829
8315
|
* provided, then the entry's default collection is used.
|
|
@@ -7856,7 +8342,6 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
7856
8342
|
* @example ["DEVU-12345"]
|
|
7857
8343
|
*/
|
|
7858
8344
|
private_to?: string[];
|
|
7859
|
-
type: TimelineEntriesCreateRequestType;
|
|
7860
8345
|
/**
|
|
7861
8346
|
* The visibility of the entry. If 'private', then the entry is only
|
|
7862
8347
|
* visible to the creator, 'internal' is visible with the Dev
|
|
@@ -8017,12 +8502,12 @@ export interface TimelineEntriesListResponse {
|
|
|
8017
8502
|
* The request to update a timeline entry.
|
|
8018
8503
|
*/
|
|
8019
8504
|
export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
|
|
8505
|
+
type: TimelineEntriesUpdateRequestType;
|
|
8020
8506
|
/**
|
|
8021
8507
|
* The ID of the timeline entry to update.
|
|
8022
8508
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
8023
8509
|
*/
|
|
8024
8510
|
id: string;
|
|
8025
|
-
type: TimelineEntriesUpdateRequestType;
|
|
8026
8511
|
};
|
|
8027
8512
|
/** timeline-entries-update-request-timeline-comment */
|
|
8028
8513
|
export interface TimelineEntriesUpdateRequestTimelineComment {
|
|
@@ -8143,6 +8628,12 @@ export declare enum TimelineEntryObjectType {
|
|
|
8143
8628
|
Ticket = "ticket",
|
|
8144
8629
|
TimelineComment = "timeline_comment"
|
|
8145
8630
|
}
|
|
8631
|
+
/** Display panels for the Timeline entry. */
|
|
8632
|
+
export declare enum TimelineEntryPanel {
|
|
8633
|
+
CustomerChat = "customer_chat",
|
|
8634
|
+
Discussions = "discussions",
|
|
8635
|
+
Events = "events"
|
|
8636
|
+
}
|
|
8146
8637
|
export declare enum TimelineEntryType {
|
|
8147
8638
|
TimelineComment = "timeline_comment"
|
|
8148
8639
|
}
|
|
@@ -8232,16 +8723,16 @@ export type TrackEventsPublishResponse = object;
|
|
|
8232
8723
|
* type is 'number'.
|
|
8233
8724
|
*/
|
|
8234
8725
|
export interface Unit {
|
|
8235
|
-
/**
|
|
8236
|
-
* This represents human readable unit name of the UOM For example,
|
|
8237
|
-
* number of API calls.
|
|
8238
|
-
*/
|
|
8239
|
-
name: string;
|
|
8240
8726
|
/**
|
|
8241
8727
|
* This defines the UOM unit type. For example, for 'number of video
|
|
8242
8728
|
* calls', unit type will be a number.
|
|
8243
8729
|
*/
|
|
8244
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;
|
|
8245
8736
|
}
|
|
8246
8737
|
/**
|
|
8247
8738
|
* This defines the UOM unit type. For example, for 'number of video
|
|
@@ -8638,6 +9129,8 @@ export declare enum VistaGroupItemState {
|
|
|
8638
9129
|
* Vista group item.
|
|
8639
9130
|
*/
|
|
8640
9131
|
export interface VistaGroupItemSummary {
|
|
9132
|
+
/** Type of the group object. */
|
|
9133
|
+
type: VistaGroupItemType;
|
|
8641
9134
|
/**
|
|
8642
9135
|
* Timestamp when the vista ends.
|
|
8643
9136
|
* @format date-time
|
|
@@ -8656,8 +9149,6 @@ export interface VistaGroupItemSummary {
|
|
|
8656
9149
|
start_date?: string;
|
|
8657
9150
|
/** Defines the state of the group item. */
|
|
8658
9151
|
state?: VistaGroupItemState;
|
|
8659
|
-
/** Type of the group object. */
|
|
8660
|
-
type: VistaGroupItemType;
|
|
8661
9152
|
}
|
|
8662
9153
|
/** Type of the group object. */
|
|
8663
9154
|
export declare enum VistaGroupItemType {
|
|
@@ -8687,6 +9178,8 @@ export declare enum VistaType {
|
|
|
8687
9178
|
export type Webhook = AtomBase & {
|
|
8688
9179
|
/** The event types that the webhook will receive. */
|
|
8689
9180
|
event_types?: WebhookEventType[];
|
|
9181
|
+
/** Headers that are provided with every webhook invocation. */
|
|
9182
|
+
headers?: WebhookHeader[];
|
|
8690
9183
|
/**
|
|
8691
9184
|
* The secret to use for verifying webhook events.
|
|
8692
9185
|
* @format byte
|
|
@@ -8699,6 +9192,8 @@ export type Webhook = AtomBase & {
|
|
|
8699
9192
|
};
|
|
8700
9193
|
/** webhook-event-request */
|
|
8701
9194
|
export interface WebhookEventRequest {
|
|
9195
|
+
/** The event types that the webhook will receive. */
|
|
9196
|
+
type?: WebhookEventType;
|
|
8702
9197
|
account_created?: EventAccountCreated;
|
|
8703
9198
|
account_deleted?: EventAccountDeleted;
|
|
8704
9199
|
account_updated?: EventAccountUpdated;
|
|
@@ -8708,6 +9203,9 @@ export interface WebhookEventRequest {
|
|
|
8708
9203
|
dev_user_created?: EventDevUserCreated;
|
|
8709
9204
|
dev_user_deleted?: EventDevUserDeleted;
|
|
8710
9205
|
dev_user_updated?: EventDevUserUpdated;
|
|
9206
|
+
group_created?: EventGroupCreated;
|
|
9207
|
+
group_deleted?: EventGroupDeleted;
|
|
9208
|
+
group_updated?: EventGroupUpdated;
|
|
8711
9209
|
/** The event's ID. */
|
|
8712
9210
|
id: string;
|
|
8713
9211
|
part_created?: EventPartCreated;
|
|
@@ -8740,8 +9238,6 @@ export interface WebhookEventRequest {
|
|
|
8740
9238
|
* @example "2023-01-01T12:00:00.000Z"
|
|
8741
9239
|
*/
|
|
8742
9240
|
timestamp?: string;
|
|
8743
|
-
/** The event types that the webhook will receive. */
|
|
8744
|
-
type?: WebhookEventType;
|
|
8745
9241
|
verify?: WebhookEventVerify;
|
|
8746
9242
|
webhook_created?: EventWebhookCreated;
|
|
8747
9243
|
webhook_deleted?: EventWebhookDeleted;
|
|
@@ -8775,6 +9271,9 @@ export declare enum WebhookEventType {
|
|
|
8775
9271
|
DevUserCreated = "dev_user_created",
|
|
8776
9272
|
DevUserDeleted = "dev_user_deleted",
|
|
8777
9273
|
DevUserUpdated = "dev_user_updated",
|
|
9274
|
+
GroupCreated = "group_created",
|
|
9275
|
+
GroupDeleted = "group_deleted",
|
|
9276
|
+
GroupUpdated = "group_updated",
|
|
8778
9277
|
PartCreated = "part_created",
|
|
8779
9278
|
PartDeleted = "part_deleted",
|
|
8780
9279
|
PartUpdated = "part_updated",
|
|
@@ -8809,6 +9308,19 @@ export interface WebhookEventVerify {
|
|
|
8809
9308
|
*/
|
|
8810
9309
|
challenge: string;
|
|
8811
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
|
+
}
|
|
8812
9324
|
/** The status of the webhook. */
|
|
8813
9325
|
export declare enum WebhookStatus {
|
|
8814
9326
|
Active = "active",
|
|
@@ -8824,6 +9336,8 @@ export type WebhookSummary = AtomBaseSummary;
|
|
|
8824
9336
|
export interface WebhooksCreateRequest {
|
|
8825
9337
|
/** The event types that the webhook endpoint will receive. */
|
|
8826
9338
|
event_types?: WebhookEventType[];
|
|
9339
|
+
/** @maxItems 8 */
|
|
9340
|
+
headers?: WebhookHeader[];
|
|
8827
9341
|
/**
|
|
8828
9342
|
* The secret to use when verifying webhook events. If provided, the
|
|
8829
9343
|
* secret must be between 8 and 32 bytes (inclusive). If not set, a
|
|
@@ -8902,6 +9416,7 @@ export interface WebhooksUpdateRequest {
|
|
|
8902
9416
|
/** The action to update the webhook's status. */
|
|
8903
9417
|
action?: WebhooksUpdateAction;
|
|
8904
9418
|
event_types?: WebhooksUpdateRequestEventTypes;
|
|
9419
|
+
headers?: WebhooksUpdateRequestHeaders;
|
|
8905
9420
|
/**
|
|
8906
9421
|
* ID for the webhook.
|
|
8907
9422
|
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
@@ -8944,6 +9459,15 @@ export interface WebhooksUpdateRequestEventTypes {
|
|
|
8944
9459
|
*/
|
|
8945
9460
|
set?: WebhookEventType[];
|
|
8946
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
|
+
}
|
|
8947
9471
|
/**
|
|
8948
9472
|
* webhooks-update-response
|
|
8949
9473
|
* The response to updating the webhook.
|
|
@@ -9028,6 +9552,7 @@ export declare enum WorkType {
|
|
|
9028
9552
|
}
|
|
9029
9553
|
/** works-create-request */
|
|
9030
9554
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
|
|
9555
|
+
type: WorkType;
|
|
9031
9556
|
/**
|
|
9032
9557
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
9033
9558
|
* applies to. Specifying a part is required when creating tickets and
|
|
@@ -9081,7 +9606,6 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
9081
9606
|
target_close_date?: string;
|
|
9082
9607
|
/** Title of the work object. */
|
|
9083
9608
|
title: string;
|
|
9084
|
-
type: WorkType;
|
|
9085
9609
|
};
|
|
9086
9610
|
/** works-create-request-issue */
|
|
9087
9611
|
export interface WorksCreateRequestIssue {
|
|
@@ -9185,6 +9709,8 @@ export interface WorksDeleteRequest {
|
|
|
9185
9709
|
export type WorksDeleteResponse = object;
|
|
9186
9710
|
/** works-export-request */
|
|
9187
9711
|
export interface WorksExportRequest {
|
|
9712
|
+
/** Filters for work of the provided types. */
|
|
9713
|
+
type?: WorkType[];
|
|
9188
9714
|
/** Provides ways to specify date ranges on objects. */
|
|
9189
9715
|
actual_close_date?: DateFilter;
|
|
9190
9716
|
/**
|
|
@@ -9235,8 +9761,6 @@ export interface WorksExportRequest {
|
|
|
9235
9761
|
/** Provides ways to specify date ranges on objects. */
|
|
9236
9762
|
target_close_date?: DateFilter;
|
|
9237
9763
|
ticket?: WorksFilterTicket;
|
|
9238
|
-
/** Filters for work of the provided types. */
|
|
9239
|
-
type?: WorkType[];
|
|
9240
9764
|
}
|
|
9241
9765
|
/** works-export-response */
|
|
9242
9766
|
export interface WorksExportResponse {
|
|
@@ -9261,6 +9785,8 @@ export interface WorksFilterIssue {
|
|
|
9261
9785
|
* @example ["REV-AbCdEfGh"]
|
|
9262
9786
|
*/
|
|
9263
9787
|
rev_orgs?: string[];
|
|
9788
|
+
/** The filter for SLA summary. */
|
|
9789
|
+
sla_summary?: SlaSummaryFilter;
|
|
9264
9790
|
/** Filters for issues with any of the sprint. */
|
|
9265
9791
|
sprint?: string[];
|
|
9266
9792
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -9322,6 +9848,8 @@ export interface WorksGetResponse {
|
|
|
9322
9848
|
}
|
|
9323
9849
|
/** works-list-request */
|
|
9324
9850
|
export interface WorksListRequest {
|
|
9851
|
+
/** Filters for work of the provided types. */
|
|
9852
|
+
type?: WorkType[];
|
|
9325
9853
|
/** Provides ways to specify date ranges on objects. */
|
|
9326
9854
|
actual_close_date?: DateFilter;
|
|
9327
9855
|
/**
|
|
@@ -9384,8 +9912,6 @@ export interface WorksListRequest {
|
|
|
9384
9912
|
/** Provides ways to specify date ranges on objects. */
|
|
9385
9913
|
target_close_date?: DateFilter;
|
|
9386
9914
|
ticket?: WorksFilterTicket;
|
|
9387
|
-
/** Filters for work of the provided types. */
|
|
9388
|
-
type?: WorkType[];
|
|
9389
9915
|
}
|
|
9390
9916
|
/** works-list-response */
|
|
9391
9917
|
export interface WorksListResponse {
|
|
@@ -9404,6 +9930,7 @@ export interface WorksListResponse {
|
|
|
9404
9930
|
}
|
|
9405
9931
|
/** works-update-request */
|
|
9406
9932
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
9933
|
+
type?: WorkType;
|
|
9407
9934
|
/**
|
|
9408
9935
|
* Updates the part that the work item applies to.
|
|
9409
9936
|
* @example "PROD-12345"
|
|
@@ -9451,7 +9978,6 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
9451
9978
|
target_close_date?: string | null;
|
|
9452
9979
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
9453
9980
|
title?: string;
|
|
9454
|
-
type?: WorkType;
|
|
9455
9981
|
};
|
|
9456
9982
|
/** works-update-request-artifacts */
|
|
9457
9983
|
export interface WorksUpdateRequestArtifacts {
|
|
@@ -9863,6 +10389,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9863
10389
|
* @example ["PROD-12345"]
|
|
9864
10390
|
*/
|
|
9865
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[];
|
|
9866
10397
|
/**
|
|
9867
10398
|
* Filters for articles authored by any of the provided users.
|
|
9868
10399
|
* @example ["DEVU-12345"]
|
|
@@ -9883,6 +10414,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9883
10414
|
* @example ["DEVU-12345"]
|
|
9884
10415
|
*/
|
|
9885
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[];
|
|
9886
10422
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
9887
10423
|
/**
|
|
9888
10424
|
* @description Get count of articles matching given filter.
|
|
@@ -9949,6 +10485,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9949
10485
|
* @example ["PROD-12345"]
|
|
9950
10486
|
*/
|
|
9951
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[];
|
|
9952
10493
|
/**
|
|
9953
10494
|
* Filters for articles authored by any of the provided users.
|
|
9954
10495
|
* @example ["DEVU-12345"]
|
|
@@ -9984,6 +10525,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9984
10525
|
* @example ["DEVU-12345"]
|
|
9985
10526
|
*/
|
|
9986
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[];
|
|
9987
10533
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
9988
10534
|
/**
|
|
9989
10535
|
* @description Lists a collection of articles.
|
|
@@ -10884,6 +11430,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10884
11430
|
cursor?: string;
|
|
10885
11431
|
/** Filters the groups based on the group type. */
|
|
10886
11432
|
group_type?: GroupType[];
|
|
11433
|
+
/** Whether to fetch default or custom groups. */
|
|
11434
|
+
is_default?: boolean;
|
|
10887
11435
|
/**
|
|
10888
11436
|
* The maximum number of groups to return. The default is '50'.
|
|
10889
11437
|
* @format int32
|
|
@@ -10972,6 +11520,160 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10972
11520
|
* @secure
|
|
10973
11521
|
*/
|
|
10974
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>>;
|
|
10975
11677
|
/**
|
|
10976
11678
|
* @description Creates a link between two objects to indicate a relationship.
|
|
10977
11679
|
*
|
|
@@ -11048,6 +11750,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11048
11750
|
* used.
|
|
11049
11751
|
*/
|
|
11050
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[];
|
|
11051
11758
|
/**
|
|
11052
11759
|
* The link types to filter for, otherwise if not present, all link
|
|
11053
11760
|
* types are included.
|
|
@@ -11118,6 +11825,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11118
11825
|
* @secure
|
|
11119
11826
|
*/
|
|
11120
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>>;
|
|
11121
11837
|
/**
|
|
11122
11838
|
* @description Creates an organization schedule fragment.
|
|
11123
11839
|
*
|
|
@@ -12472,6 +13188,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12472
13188
|
* @example ["ACC-12345"]
|
|
12473
13189
|
*/
|
|
12474
13190
|
objects?: string[];
|
|
13191
|
+
/**
|
|
13192
|
+
* Filters for survey responses dispatched to any of these users.
|
|
13193
|
+
* @example ["DEVU-12345"]
|
|
13194
|
+
*/
|
|
13195
|
+
recipient?: string[];
|
|
12475
13196
|
/**
|
|
12476
13197
|
* Fields to sort the survey responses by and the direction to sort
|
|
12477
13198
|
* them.
|
|
@@ -13044,6 +13765,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13044
13765
|
* @example ["REV-AbCdEfGh"]
|
|
13045
13766
|
*/
|
|
13046
13767
|
'issue.rev_orgs'?: string[];
|
|
13768
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
13769
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
13047
13770
|
/** Filters for issues with any of the sprint. */
|
|
13048
13771
|
'issue.sprint'?: string[];
|
|
13049
13772
|
/** Filters for issues with any of the provided subtypes. */
|
|
@@ -13186,6 +13909,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13186
13909
|
* @example ["REV-AbCdEfGh"]
|
|
13187
13910
|
*/
|
|
13188
13911
|
'issue.rev_orgs'?: string[];
|
|
13912
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
13913
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
13189
13914
|
/** Filters for issues with any of the sprint. */
|
|
13190
13915
|
'issue.sprint'?: string[];
|
|
13191
13916
|
/** Filters for issues with any of the provided subtypes. */
|