@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.
|
@@ -380,6 +380,11 @@ export interface AtomBaseSummary {
|
|
|
380
380
|
* authentication connection that is set up for a Dev organization.
|
|
381
381
|
*/
|
|
382
382
|
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
383
|
+
/**
|
|
384
|
+
* Defines the type for the authentication connection. The configuration
|
|
385
|
+
* for each authentication connection will depend on the type value.
|
|
386
|
+
*/
|
|
387
|
+
type: AuthConnectionType;
|
|
383
388
|
/**
|
|
384
389
|
* Display name of the authentication connection. This name will be
|
|
385
390
|
* visible to all the users when they sign in to this Dev
|
|
@@ -395,11 +400,6 @@ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptio
|
|
|
395
400
|
enabled?: boolean;
|
|
396
401
|
/** ID of the authentication connection. */
|
|
397
402
|
id: string;
|
|
398
|
-
/**
|
|
399
|
-
* Defines the type for the authentication connection. The configuration
|
|
400
|
-
* for each authentication connection will depend on the type value.
|
|
401
|
-
*/
|
|
402
|
-
type: AuthConnectionType;
|
|
403
403
|
};
|
|
404
404
|
/**
|
|
405
405
|
* auth-connection-options-azure-ad
|
|
@@ -534,11 +534,11 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
534
534
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
535
535
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
536
536
|
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
537
|
+
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
537
538
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
538
539
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
539
540
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
540
541
|
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
541
|
-
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
542
542
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
543
543
|
}
|
|
544
544
|
/** The type of the issued token. Bearer is the only supported token type. */
|
|
@@ -720,7 +720,10 @@ export interface AuthTokensRevInfo {
|
|
|
720
720
|
account_ref?: string;
|
|
721
721
|
/** Carries account info. */
|
|
722
722
|
account_traits?: AuthTokensAccountTraits;
|
|
723
|
-
/**
|
|
723
|
+
/**
|
|
724
|
+
* An identifier which uniquely identifies a Rev org.
|
|
725
|
+
* @deprecated
|
|
726
|
+
*/
|
|
724
727
|
org_ref?: string;
|
|
725
728
|
/** Carries Rev org info. */
|
|
726
729
|
org_traits?: AuthTokensOrgTraits;
|
|
@@ -886,6 +889,11 @@ export declare enum DateTimePresetType {
|
|
|
886
889
|
* Request to create a new enterprise authentication connection.
|
|
887
890
|
*/
|
|
888
891
|
export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
|
|
892
|
+
/**
|
|
893
|
+
* Defines the type for the authentication connection. Different types of
|
|
894
|
+
* authentication connections have different configuration parameters.
|
|
895
|
+
*/
|
|
896
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
889
897
|
/**
|
|
890
898
|
* Display name of the authentication connection. This name will be
|
|
891
899
|
* visible to all the users when they sign in to this Dev
|
|
@@ -893,11 +901,6 @@ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
893
901
|
* it would appear on the login button as 'Log in to abclogin'.
|
|
894
902
|
*/
|
|
895
903
|
display_name?: string;
|
|
896
|
-
/**
|
|
897
|
-
* Defines the type for the authentication connection. Different types of
|
|
898
|
-
* authentication connections have different configuration parameters.
|
|
899
|
-
*/
|
|
900
|
-
type: DevOrgAuthConnectionsCreateRequestType;
|
|
901
904
|
};
|
|
902
905
|
/**
|
|
903
906
|
* Defines the type for the authentication connection. Different types of
|
|
@@ -980,6 +983,12 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
980
983
|
* organization.
|
|
981
984
|
*/
|
|
982
985
|
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
|
|
986
|
+
/**
|
|
987
|
+
* Specifies the type for the authentication connection. Different types
|
|
988
|
+
* of authentication connections have different configuration parameters
|
|
989
|
+
* that can be updated.
|
|
990
|
+
*/
|
|
991
|
+
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
983
992
|
/**
|
|
984
993
|
* New display name of the authentication connection. This name will
|
|
985
994
|
* be visible to all the users when they sign in to this Dev
|
|
@@ -989,12 +998,6 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
989
998
|
display_name?: string;
|
|
990
999
|
/** ID of the authentication connection which is to be updated. */
|
|
991
1000
|
id: string;
|
|
992
|
-
/**
|
|
993
|
-
* Specifies the type for the authentication connection. Different types
|
|
994
|
-
* of authentication connections have different configuration parameters
|
|
995
|
-
* that can be updated.
|
|
996
|
-
*/
|
|
997
|
-
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
998
1001
|
};
|
|
999
1002
|
/**
|
|
1000
1003
|
* Specifies the type for the authentication connection. Different types
|
|
@@ -1133,24 +1136,24 @@ export type Enhancement = PartBase;
|
|
|
1133
1136
|
export type EnhancementSummary = PartBaseSummary;
|
|
1134
1137
|
/**
|
|
1135
1138
|
* enum-value
|
|
1136
|
-
*
|
|
1139
|
+
* The properties of an enum value.
|
|
1137
1140
|
*/
|
|
1138
1141
|
export interface EnumValue {
|
|
1139
1142
|
/**
|
|
1140
|
-
*
|
|
1143
|
+
* The uiique ID of the enum value.
|
|
1141
1144
|
* @format int64
|
|
1142
1145
|
*/
|
|
1143
1146
|
id: number;
|
|
1144
|
-
/**
|
|
1147
|
+
/** The display label of the enum value. */
|
|
1145
1148
|
label: string;
|
|
1146
1149
|
/**
|
|
1147
|
-
*
|
|
1150
|
+
* Used for determining the relative order of the enum value.
|
|
1148
1151
|
* @format int64
|
|
1149
1152
|
*/
|
|
1150
1153
|
ordinal: number;
|
|
1151
1154
|
}
|
|
1152
1155
|
/** error-bad-request */
|
|
1153
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
1156
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
1154
1157
|
type: ErrorBadRequestType;
|
|
1155
1158
|
};
|
|
1156
1159
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -1186,6 +1189,44 @@ export interface ErrorBadRequestInvalidId {
|
|
|
1186
1189
|
/** The field whose ID is invalid. */
|
|
1187
1190
|
field_name: string;
|
|
1188
1191
|
}
|
|
1192
|
+
/** error-bad-request-merge-works-error */
|
|
1193
|
+
export interface ErrorBadRequestMergeWorksError {
|
|
1194
|
+
/** The errors encountered during the validation of the merge. */
|
|
1195
|
+
errors?: ErrorBadRequestMergeWorksErrorError[];
|
|
1196
|
+
}
|
|
1197
|
+
/** error-bad-request-merge-works-error-error */
|
|
1198
|
+
export interface ErrorBadRequestMergeWorksErrorError {
|
|
1199
|
+
already_merged?: ErrorBadRequestMergeWorksErrorErrorAlreadyMerged;
|
|
1200
|
+
closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
|
|
1201
|
+
/** The details of the error. */
|
|
1202
|
+
details: string;
|
|
1203
|
+
different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
|
|
1204
|
+
invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
|
|
1205
|
+
subtype?: 'already_merged' | 'closed' | 'different_workspace' | 'invalid_stage_transition';
|
|
1206
|
+
/** The ID of the work which failed the validation. */
|
|
1207
|
+
work: string;
|
|
1208
|
+
}
|
|
1209
|
+
/** error-bad-request-merge-works-error-error-already-merged */
|
|
1210
|
+
export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
|
|
1211
|
+
/** ID of the work into which the work was merged. */
|
|
1212
|
+
merged_into: string;
|
|
1213
|
+
}
|
|
1214
|
+
/** error-bad-request-merge-works-error-error-closed */
|
|
1215
|
+
export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
|
|
1216
|
+
/** error-bad-request-merge-works-error-error-different-workspace */
|
|
1217
|
+
export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
|
|
1218
|
+
/** The workspace of the primary work. */
|
|
1219
|
+
primary_workspace: string;
|
|
1220
|
+
/** The workspace of the secondary work. */
|
|
1221
|
+
secondary_workspace: string;
|
|
1222
|
+
}
|
|
1223
|
+
/** error-bad-request-merge-works-error-error-invalid-stage-transition */
|
|
1224
|
+
export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
1225
|
+
/** The current stage of the work. */
|
|
1226
|
+
current_stage: string;
|
|
1227
|
+
/** The stage to which the transition isn't allowed. */
|
|
1228
|
+
requested_stage: string;
|
|
1229
|
+
}
|
|
1189
1230
|
/** error-bad-request-missing-dependency */
|
|
1190
1231
|
export interface ErrorBadRequestMissingDependency {
|
|
1191
1232
|
/** The dependent fields. */
|
|
@@ -1229,6 +1270,7 @@ export declare enum ErrorBadRequestType {
|
|
|
1229
1270
|
InvalidEnumValue = "invalid_enum_value",
|
|
1230
1271
|
InvalidField = "invalid_field",
|
|
1231
1272
|
InvalidId = "invalid_id",
|
|
1273
|
+
MergeWorksError = "merge_works_error",
|
|
1232
1274
|
MissingDependency = "missing_dependency",
|
|
1233
1275
|
MissingRequiredField = "missing_required_field",
|
|
1234
1276
|
ParseError = "parse_error",
|
|
@@ -1293,12 +1335,12 @@ export declare enum ErrorForbiddenType {
|
|
|
1293
1335
|
}
|
|
1294
1336
|
/** error-internal-server-error */
|
|
1295
1337
|
export type ErrorInternalServerError = ErrorBase & ErrorInternalServerErrorInternalError & {
|
|
1338
|
+
type: ErrorInternalServerErrorType;
|
|
1296
1339
|
/**
|
|
1297
1340
|
* A unique ID that's generated for the error that can be used for
|
|
1298
1341
|
* inquiry.
|
|
1299
1342
|
*/
|
|
1300
1343
|
reference_id?: string;
|
|
1301
|
-
type: ErrorInternalServerErrorType;
|
|
1302
1344
|
};
|
|
1303
1345
|
/** error-internal-server-error-internal-error */
|
|
1304
1346
|
export type ErrorInternalServerErrorInternalError = object;
|
|
@@ -1325,12 +1367,12 @@ export declare enum ErrorServiceUnavailableType {
|
|
|
1325
1367
|
}
|
|
1326
1368
|
/** error-too-many-requests */
|
|
1327
1369
|
export type ErrorTooManyRequests = ErrorBase & ErrorTooManyRequestsTooManyRequests & {
|
|
1370
|
+
type: ErrorTooManyRequestsType;
|
|
1328
1371
|
/**
|
|
1329
1372
|
* The number of seconds after which the client should retry.
|
|
1330
1373
|
* @format int64
|
|
1331
1374
|
*/
|
|
1332
1375
|
retry_after?: number;
|
|
1333
|
-
type: ErrorTooManyRequestsType;
|
|
1334
1376
|
};
|
|
1335
1377
|
/** error-too-many-requests-too-many-requests */
|
|
1336
1378
|
export type ErrorTooManyRequestsTooManyRequests = object;
|
|
@@ -1357,10 +1399,12 @@ export interface EventAccountDeleted {
|
|
|
1357
1399
|
* @example "ACC-12345"
|
|
1358
1400
|
*/
|
|
1359
1401
|
id: string;
|
|
1402
|
+
old_account?: Account;
|
|
1360
1403
|
}
|
|
1361
1404
|
/** event-account-updated */
|
|
1362
1405
|
export interface EventAccountUpdated {
|
|
1363
1406
|
account: Account;
|
|
1407
|
+
old_account?: Account;
|
|
1364
1408
|
}
|
|
1365
1409
|
/** event-conversation-created */
|
|
1366
1410
|
export interface EventConversationCreated {
|
|
@@ -1383,10 +1427,25 @@ export interface EventDevUserCreated {
|
|
|
1383
1427
|
export interface EventDevUserDeleted {
|
|
1384
1428
|
/** The ID of the Dev user that was deleted. */
|
|
1385
1429
|
id: string;
|
|
1430
|
+
old_dev_user?: DevUser;
|
|
1386
1431
|
}
|
|
1387
1432
|
/** event-dev-user-updated */
|
|
1388
1433
|
export interface EventDevUserUpdated {
|
|
1389
1434
|
dev_user: DevUser;
|
|
1435
|
+
old_dev_user?: DevUser;
|
|
1436
|
+
}
|
|
1437
|
+
/** event-group-created */
|
|
1438
|
+
export interface EventGroupCreated {
|
|
1439
|
+
group: Group;
|
|
1440
|
+
}
|
|
1441
|
+
/** event-group-deleted */
|
|
1442
|
+
export interface EventGroupDeleted {
|
|
1443
|
+
/** The ID of the group that was deleted. */
|
|
1444
|
+
id: string;
|
|
1445
|
+
}
|
|
1446
|
+
/** event-group-updated */
|
|
1447
|
+
export interface EventGroupUpdated {
|
|
1448
|
+
group: Group;
|
|
1390
1449
|
}
|
|
1391
1450
|
/** event-part-created */
|
|
1392
1451
|
export interface EventPartCreated {
|
|
@@ -1399,9 +1458,11 @@ export interface EventPartDeleted {
|
|
|
1399
1458
|
* @example "PROD-12345"
|
|
1400
1459
|
*/
|
|
1401
1460
|
id: string;
|
|
1461
|
+
old_part?: Part;
|
|
1402
1462
|
}
|
|
1403
1463
|
/** event-part-updated */
|
|
1404
1464
|
export interface EventPartUpdated {
|
|
1465
|
+
old_part?: Part;
|
|
1405
1466
|
part: Part;
|
|
1406
1467
|
}
|
|
1407
1468
|
/** event-rev-org-created */
|
|
@@ -1415,9 +1476,11 @@ export interface EventRevOrgDeleted {
|
|
|
1415
1476
|
* @example "REV-AbCdEfGh"
|
|
1416
1477
|
*/
|
|
1417
1478
|
id: string;
|
|
1479
|
+
old_rev_org?: RevOrg;
|
|
1418
1480
|
}
|
|
1419
1481
|
/** event-rev-org-updated */
|
|
1420
1482
|
export interface EventRevOrgUpdated {
|
|
1483
|
+
old_rev_org?: RevOrg;
|
|
1421
1484
|
rev_org: RevOrg;
|
|
1422
1485
|
}
|
|
1423
1486
|
/** event-rev-user-created */
|
|
@@ -1428,9 +1491,11 @@ export interface EventRevUserCreated {
|
|
|
1428
1491
|
export interface EventRevUserDeleted {
|
|
1429
1492
|
/** The ID of the Rev user that was deleted. */
|
|
1430
1493
|
id: string;
|
|
1494
|
+
old_rev_user?: RevUser;
|
|
1431
1495
|
}
|
|
1432
1496
|
/** event-rev-user-updated */
|
|
1433
1497
|
export interface EventRevUserUpdated {
|
|
1498
|
+
old_rev_user?: RevUser;
|
|
1434
1499
|
rev_user: RevUser;
|
|
1435
1500
|
}
|
|
1436
1501
|
/** event-sla-tracker-created */
|
|
@@ -1518,9 +1583,11 @@ export interface EventWorkDeleted {
|
|
|
1518
1583
|
* @example "ISS-12345"
|
|
1519
1584
|
*/
|
|
1520
1585
|
id: string;
|
|
1586
|
+
old_work?: Work;
|
|
1521
1587
|
}
|
|
1522
1588
|
/** event-work-updated */
|
|
1523
1589
|
export interface EventWorkUpdated {
|
|
1590
|
+
old_work?: Work;
|
|
1524
1591
|
work: Work;
|
|
1525
1592
|
}
|
|
1526
1593
|
/**
|
|
@@ -1541,6 +1608,8 @@ export interface ExternalIdentity {
|
|
|
1541
1608
|
export type Feature = PartBase;
|
|
1542
1609
|
/** feature-summary */
|
|
1543
1610
|
export type FeatureSummary = PartBaseSummary;
|
|
1611
|
+
/** group */
|
|
1612
|
+
export type Group = AtomBase;
|
|
1544
1613
|
/** group-summary */
|
|
1545
1614
|
export type GroupSummary = AtomBaseSummary;
|
|
1546
1615
|
/** issue */
|
|
@@ -1549,6 +1618,7 @@ export type Issue = WorkBase & {
|
|
|
1549
1618
|
developed_with?: PartSummary[];
|
|
1550
1619
|
/** Priority of the work based upon impact and criticality. */
|
|
1551
1620
|
priority?: IssuePriority;
|
|
1621
|
+
sla_tracker?: SlaTrackerSummary;
|
|
1552
1622
|
/** Vista group item. */
|
|
1553
1623
|
sprint?: VistaGroupItemSummary;
|
|
1554
1624
|
/**
|
|
@@ -1570,7 +1640,7 @@ export declare enum IssuePriority {
|
|
|
1570
1640
|
* Defines a job history line item.
|
|
1571
1641
|
*/
|
|
1572
1642
|
export interface JobHistoryItem {
|
|
1573
|
-
/**
|
|
1643
|
+
/** The properties of an enum value. */
|
|
1574
1644
|
employment_status?: EnumValue;
|
|
1575
1645
|
/**
|
|
1576
1646
|
* The end date of the job, or not specified if current.
|
|
@@ -1591,6 +1661,13 @@ export interface JobHistoryItem {
|
|
|
1591
1661
|
/** The job title for the user. */
|
|
1592
1662
|
title?: string;
|
|
1593
1663
|
}
|
|
1664
|
+
/** keyrings-create-callback-request */
|
|
1665
|
+
export interface KeyringsCreateCallbackRequest {
|
|
1666
|
+
/** Code to exchange for an access token. */
|
|
1667
|
+
code: string;
|
|
1668
|
+
/** State value given to the authorization request. */
|
|
1669
|
+
state: string;
|
|
1670
|
+
}
|
|
1594
1671
|
/**
|
|
1595
1672
|
* legacy-stage
|
|
1596
1673
|
* Describes the current stage of a work item.
|
|
@@ -1713,6 +1790,8 @@ export type PartBase = AtomBase & {
|
|
|
1713
1790
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
1714
1791
|
/** Name of the part. */
|
|
1715
1792
|
name: string;
|
|
1793
|
+
/** The users that own the part. */
|
|
1794
|
+
owned_by: UserSummary[];
|
|
1716
1795
|
};
|
|
1717
1796
|
/** part-summary */
|
|
1718
1797
|
export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
|
|
@@ -1726,6 +1805,7 @@ export declare enum PartType {
|
|
|
1726
1805
|
}
|
|
1727
1806
|
/** parts-create-request */
|
|
1728
1807
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
1808
|
+
type: PartType;
|
|
1729
1809
|
/**
|
|
1730
1810
|
* The IDs of the artifacts.
|
|
1731
1811
|
* @example ["ARTIFACT-12345"]
|
|
@@ -1740,7 +1820,6 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
1740
1820
|
* @example ["DEVU-12345"]
|
|
1741
1821
|
*/
|
|
1742
1822
|
owned_by: string[];
|
|
1743
|
-
type: PartType;
|
|
1744
1823
|
};
|
|
1745
1824
|
/** parts-create-request-capability */
|
|
1746
1825
|
export interface PartsCreateRequestCapability {
|
|
@@ -1812,6 +1891,8 @@ export interface PartsGetResponse {
|
|
|
1812
1891
|
}
|
|
1813
1892
|
/** parts-list-request */
|
|
1814
1893
|
export interface PartsListRequest {
|
|
1894
|
+
/** Filters for parts of the provided type(s). */
|
|
1895
|
+
type?: PartType[];
|
|
1815
1896
|
/**
|
|
1816
1897
|
* Filters for parts created by any of these users.
|
|
1817
1898
|
* @example ["DEVU-12345"]
|
|
@@ -1844,8 +1925,6 @@ export interface PartsListRequest {
|
|
|
1844
1925
|
owned_by?: string[];
|
|
1845
1926
|
/** The filter for specifying parent part. */
|
|
1846
1927
|
parent_part?: ParentPartFilter;
|
|
1847
|
-
/** Filters for parts of the provided type(s). */
|
|
1848
|
-
type?: PartType[];
|
|
1849
1928
|
}
|
|
1850
1929
|
/** parts-list-response */
|
|
1851
1930
|
export interface PartsListResponse {
|
|
@@ -1864,6 +1943,7 @@ export interface PartsListResponse {
|
|
|
1864
1943
|
}
|
|
1865
1944
|
/** parts-update-request */
|
|
1866
1945
|
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
1946
|
+
type?: PartType;
|
|
1867
1947
|
artifacts?: PartsUpdateRequestArtifacts;
|
|
1868
1948
|
/** The updated description of the part. */
|
|
1869
1949
|
description?: string;
|
|
@@ -1875,7 +1955,6 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
1875
1955
|
/** The updated name of the part. */
|
|
1876
1956
|
name?: string;
|
|
1877
1957
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
1878
|
-
type?: PartType;
|
|
1879
1958
|
};
|
|
1880
1959
|
/** parts-update-request-artifacts */
|
|
1881
1960
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -2278,9 +2357,9 @@ export type SurveyResponse = AtomBase & {
|
|
|
2278
2357
|
recipient?: UserSummary;
|
|
2279
2358
|
/** Response for the survey. */
|
|
2280
2359
|
response?: object;
|
|
2281
|
-
/**
|
|
2360
|
+
/** The properties of an enum value. */
|
|
2282
2361
|
response_channel?: EnumValue;
|
|
2283
|
-
/**
|
|
2362
|
+
/** The properties of an enum value. */
|
|
2284
2363
|
stage?: EnumValue;
|
|
2285
2364
|
/** The ID of the survey for which response is taken. */
|
|
2286
2365
|
survey?: string;
|
|
@@ -2502,6 +2581,8 @@ export type Ticket = WorkBase & {
|
|
|
2502
2581
|
/** Whether the ticket needs a response. */
|
|
2503
2582
|
needs_response?: boolean;
|
|
2504
2583
|
rev_org?: OrgSummary;
|
|
2584
|
+
/** The properties of an enum value. */
|
|
2585
|
+
sentiment?: EnumValue;
|
|
2505
2586
|
/** Severity of the ticket. */
|
|
2506
2587
|
severity?: TicketSeverity;
|
|
2507
2588
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -2549,6 +2630,7 @@ export declare enum TimelineCommentBodyType {
|
|
|
2549
2630
|
* The request to create a timeline entry for an object.
|
|
2550
2631
|
*/
|
|
2551
2632
|
export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineComment & {
|
|
2633
|
+
type: TimelineEntriesCreateRequestType;
|
|
2552
2634
|
/**
|
|
2553
2635
|
* If set, then the entry is ephemeral and will be deleted after the
|
|
2554
2636
|
* provided time. The minimum value should be at least a minute more
|
|
@@ -2569,7 +2651,6 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
2569
2651
|
* @example ["DEVU-12345"]
|
|
2570
2652
|
*/
|
|
2571
2653
|
private_to?: string[];
|
|
2572
|
-
type: TimelineEntriesCreateRequestType;
|
|
2573
2654
|
/**
|
|
2574
2655
|
* The visibility of the entry. If 'private', then the entry is only
|
|
2575
2656
|
* visible to the creator, 'internal' is visible with the Dev
|
|
@@ -2697,12 +2778,12 @@ export interface TimelineEntriesListResponse {
|
|
|
2697
2778
|
* The request to update a timeline entry.
|
|
2698
2779
|
*/
|
|
2699
2780
|
export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
|
|
2781
|
+
type: TimelineEntriesUpdateRequestType;
|
|
2700
2782
|
/**
|
|
2701
2783
|
* The ID of the timeline entry to update.
|
|
2702
2784
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
2703
2785
|
*/
|
|
2704
2786
|
id: string;
|
|
2705
|
-
type: TimelineEntriesUpdateRequestType;
|
|
2706
2787
|
};
|
|
2707
2788
|
/** timeline-entries-update-request-timeline-comment */
|
|
2708
2789
|
export interface TimelineEntriesUpdateRequestTimelineComment {
|
|
@@ -2878,6 +2959,8 @@ export declare enum VistaGroupItemState {
|
|
|
2878
2959
|
* Vista group item.
|
|
2879
2960
|
*/
|
|
2880
2961
|
export interface VistaGroupItemSummary {
|
|
2962
|
+
/** Type of the group object. */
|
|
2963
|
+
type: VistaGroupItemType;
|
|
2881
2964
|
/**
|
|
2882
2965
|
* Timestamp when the vista ends.
|
|
2883
2966
|
* @format date-time
|
|
@@ -2896,8 +2979,6 @@ export interface VistaGroupItemSummary {
|
|
|
2896
2979
|
start_date?: string;
|
|
2897
2980
|
/** Defines the state of the group item. */
|
|
2898
2981
|
state?: VistaGroupItemState;
|
|
2899
|
-
/** Type of the group object. */
|
|
2900
|
-
type: VistaGroupItemType;
|
|
2901
2982
|
}
|
|
2902
2983
|
/** Type of the group object. */
|
|
2903
2984
|
export declare enum VistaGroupItemType {
|
|
@@ -2920,6 +3001,8 @@ export type Webhook = AtomBase & {
|
|
|
2920
3001
|
};
|
|
2921
3002
|
/** webhook-event-request */
|
|
2922
3003
|
export interface WebhookEventRequest {
|
|
3004
|
+
/** The event types that the webhook will receive. */
|
|
3005
|
+
type?: WebhookEventType;
|
|
2923
3006
|
account_created?: EventAccountCreated;
|
|
2924
3007
|
account_deleted?: EventAccountDeleted;
|
|
2925
3008
|
account_updated?: EventAccountUpdated;
|
|
@@ -2929,6 +3012,9 @@ export interface WebhookEventRequest {
|
|
|
2929
3012
|
dev_user_created?: EventDevUserCreated;
|
|
2930
3013
|
dev_user_deleted?: EventDevUserDeleted;
|
|
2931
3014
|
dev_user_updated?: EventDevUserUpdated;
|
|
3015
|
+
group_created?: EventGroupCreated;
|
|
3016
|
+
group_deleted?: EventGroupDeleted;
|
|
3017
|
+
group_updated?: EventGroupUpdated;
|
|
2932
3018
|
/** The event's ID. */
|
|
2933
3019
|
id: string;
|
|
2934
3020
|
part_created?: EventPartCreated;
|
|
@@ -2961,8 +3047,6 @@ export interface WebhookEventRequest {
|
|
|
2961
3047
|
* @example "2023-01-01T12:00:00.000Z"
|
|
2962
3048
|
*/
|
|
2963
3049
|
timestamp?: string;
|
|
2964
|
-
/** The event types that the webhook will receive. */
|
|
2965
|
-
type?: WebhookEventType;
|
|
2966
3050
|
verify?: WebhookEventVerify;
|
|
2967
3051
|
webhook_created?: EventWebhookCreated;
|
|
2968
3052
|
webhook_deleted?: EventWebhookDeleted;
|
|
@@ -2996,6 +3080,9 @@ export declare enum WebhookEventType {
|
|
|
2996
3080
|
DevUserCreated = "dev_user_created",
|
|
2997
3081
|
DevUserDeleted = "dev_user_deleted",
|
|
2998
3082
|
DevUserUpdated = "dev_user_updated",
|
|
3083
|
+
GroupCreated = "group_created",
|
|
3084
|
+
GroupDeleted = "group_deleted",
|
|
3085
|
+
GroupUpdated = "group_updated",
|
|
2999
3086
|
PartCreated = "part_created",
|
|
3000
3087
|
PartDeleted = "part_deleted",
|
|
3001
3088
|
PartUpdated = "part_updated",
|
|
@@ -3204,6 +3291,7 @@ export declare enum WorkType {
|
|
|
3204
3291
|
}
|
|
3205
3292
|
/** works-create-request */
|
|
3206
3293
|
export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTicket) & {
|
|
3294
|
+
type: WorkType;
|
|
3207
3295
|
/**
|
|
3208
3296
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
3209
3297
|
* applies to. Specifying a part is required when creating tickets and
|
|
@@ -3242,7 +3330,6 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
3242
3330
|
target_close_date?: string;
|
|
3243
3331
|
/** Title of the work object. */
|
|
3244
3332
|
title: string;
|
|
3245
|
-
type: WorkType;
|
|
3246
3333
|
};
|
|
3247
3334
|
/** works-create-request-issue */
|
|
3248
3335
|
export interface WorksCreateRequestIssue {
|
|
@@ -3304,6 +3391,8 @@ export interface WorksDeleteRequest {
|
|
|
3304
3391
|
export type WorksDeleteResponse = object;
|
|
3305
3392
|
/** works-export-request */
|
|
3306
3393
|
export interface WorksExportRequest {
|
|
3394
|
+
/** Filters for work of the provided types. */
|
|
3395
|
+
type?: WorkType[];
|
|
3307
3396
|
/** Provides ways to specify date ranges on objects. */
|
|
3308
3397
|
actual_close_date?: DateFilter;
|
|
3309
3398
|
/**
|
|
@@ -3349,8 +3438,6 @@ export interface WorksExportRequest {
|
|
|
3349
3438
|
/** Provides ways to specify date ranges on objects. */
|
|
3350
3439
|
target_close_date?: DateFilter;
|
|
3351
3440
|
ticket?: WorksFilterTicket;
|
|
3352
|
-
/** Filters for work of the provided types. */
|
|
3353
|
-
type?: WorkType[];
|
|
3354
3441
|
}
|
|
3355
3442
|
/** works-export-response */
|
|
3356
3443
|
export interface WorksExportResponse {
|
|
@@ -3375,6 +3462,8 @@ export interface WorksFilterIssue {
|
|
|
3375
3462
|
* @example ["REV-AbCdEfGh"]
|
|
3376
3463
|
*/
|
|
3377
3464
|
rev_orgs?: string[];
|
|
3465
|
+
/** The filter for SLA summary. */
|
|
3466
|
+
sla_summary?: SlaSummaryFilter;
|
|
3378
3467
|
/** Filters for issues with any of the sprint. */
|
|
3379
3468
|
sprint?: string[];
|
|
3380
3469
|
/** Provides ways to specify date ranges on objects. */
|
|
@@ -3419,6 +3508,8 @@ export interface WorksGetResponse {
|
|
|
3419
3508
|
}
|
|
3420
3509
|
/** works-list-request */
|
|
3421
3510
|
export interface WorksListRequest {
|
|
3511
|
+
/** Filters for work of the provided types. */
|
|
3512
|
+
type?: WorkType[];
|
|
3422
3513
|
/** Provides ways to specify date ranges on objects. */
|
|
3423
3514
|
actual_close_date?: DateFilter;
|
|
3424
3515
|
/**
|
|
@@ -3476,8 +3567,6 @@ export interface WorksListRequest {
|
|
|
3476
3567
|
/** Provides ways to specify date ranges on objects. */
|
|
3477
3568
|
target_close_date?: DateFilter;
|
|
3478
3569
|
ticket?: WorksFilterTicket;
|
|
3479
|
-
/** Filters for work of the provided types. */
|
|
3480
|
-
type?: WorkType[];
|
|
3481
3570
|
}
|
|
3482
3571
|
/** works-list-response */
|
|
3483
3572
|
export interface WorksListResponse {
|
|
@@ -3496,6 +3585,7 @@ export interface WorksListResponse {
|
|
|
3496
3585
|
}
|
|
3497
3586
|
/** works-update-request */
|
|
3498
3587
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
|
|
3588
|
+
type?: WorkType;
|
|
3499
3589
|
/**
|
|
3500
3590
|
* Updates the part that the work item applies to.
|
|
3501
3591
|
* @example "PROD-12345"
|
|
@@ -3528,7 +3618,6 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
3528
3618
|
target_close_date?: string | null;
|
|
3529
3619
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
3530
3620
|
title?: string;
|
|
3531
|
-
type?: WorkType;
|
|
3532
3621
|
};
|
|
3533
3622
|
/** works-update-request-artifacts */
|
|
3534
3623
|
export interface WorksUpdateRequestArtifacts {
|
|
@@ -4197,6 +4286,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4197
4286
|
* @secure
|
|
4198
4287
|
*/
|
|
4199
4288
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
4289
|
+
/**
|
|
4290
|
+
* @description OAuth2 authorization callback.
|
|
4291
|
+
*
|
|
4292
|
+
* @tags keyring
|
|
4293
|
+
* @name KeyringsCreateCallback
|
|
4294
|
+
* @request GET:/keyrings.authorize
|
|
4295
|
+
*/
|
|
4296
|
+
keyringsCreateCallback: (query: {
|
|
4297
|
+
/** Code to exchange for an access token. */
|
|
4298
|
+
code: string;
|
|
4299
|
+
/** State value given to the authorization request. */
|
|
4300
|
+
state: string;
|
|
4301
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
4302
|
+
/**
|
|
4303
|
+
* @description OAuth2 authorization callback.
|
|
4304
|
+
*
|
|
4305
|
+
* @tags keyring
|
|
4306
|
+
* @name KeyringsCreateCallbackPost
|
|
4307
|
+
* @request POST:/keyrings.authorize
|
|
4308
|
+
* @secure
|
|
4309
|
+
*/
|
|
4310
|
+
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
4200
4311
|
/**
|
|
4201
4312
|
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
4202
4313
|
*
|
|
@@ -4770,6 +4881,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4770
4881
|
* @example ["REV-AbCdEfGh"]
|
|
4771
4882
|
*/
|
|
4772
4883
|
'issue.rev_orgs'?: string[];
|
|
4884
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
4885
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
4773
4886
|
/** Filters for issues with any of the sprint. */
|
|
4774
4887
|
'issue.sprint'?: string[];
|
|
4775
4888
|
/**
|
|
@@ -4895,6 +5008,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4895
5008
|
* @example ["REV-AbCdEfGh"]
|
|
4896
5009
|
*/
|
|
4897
5010
|
'issue.rev_orgs'?: string[];
|
|
5011
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
5012
|
+
'issue.sla_summary.stage'?: SlaSummaryStage[];
|
|
4898
5013
|
/** Filters for issues with any of the sprint. */
|
|
4899
5014
|
'issue.sprint'?: string[];
|
|
4900
5015
|
/**
|
|
@@ -92,11 +92,11 @@ var AuthTokenSubjectTokenType;
|
|
|
92
92
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtAuth0"] = "urn:devrev:params:oauth:token-type:jwt:auth0";
|
|
93
93
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtDev"] = "urn:devrev:params:oauth:token-type:jwt:dev";
|
|
94
94
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRat"] = "urn:devrev:params:oauth:token-type:rat";
|
|
95
|
+
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRev"] = "urn:devrev:params:oauth:token-type:rev";
|
|
95
96
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRevinfo"] = "urn:devrev:params:oauth:token-type:revinfo";
|
|
96
97
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
|
|
97
98
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSysu"] = "urn:devrev:params:oauth:token-type:sysu";
|
|
98
99
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfo"] = "urn:devrev:params:oauth:token-type:userinfo";
|
|
99
|
-
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfoProfile"] = "urn:devrev:params:oauth:token-type:userinfo:profile";
|
|
100
100
|
AuthTokenSubjectTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
|
|
101
101
|
})(AuthTokenSubjectTokenType = exports.AuthTokenSubjectTokenType || (exports.AuthTokenSubjectTokenType = {}));
|
|
102
102
|
/** The type of the issued token. Bearer is the only supported token type. */
|
|
@@ -148,6 +148,7 @@ var ErrorBadRequestType;
|
|
|
148
148
|
ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
|
|
149
149
|
ErrorBadRequestType["InvalidField"] = "invalid_field";
|
|
150
150
|
ErrorBadRequestType["InvalidId"] = "invalid_id";
|
|
151
|
+
ErrorBadRequestType["MergeWorksError"] = "merge_works_error";
|
|
151
152
|
ErrorBadRequestType["MissingDependency"] = "missing_dependency";
|
|
152
153
|
ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
|
|
153
154
|
ErrorBadRequestType["ParseError"] = "parse_error";
|
|
@@ -397,6 +398,9 @@ var WebhookEventType;
|
|
|
397
398
|
WebhookEventType["DevUserCreated"] = "dev_user_created";
|
|
398
399
|
WebhookEventType["DevUserDeleted"] = "dev_user_deleted";
|
|
399
400
|
WebhookEventType["DevUserUpdated"] = "dev_user_updated";
|
|
401
|
+
WebhookEventType["GroupCreated"] = "group_created";
|
|
402
|
+
WebhookEventType["GroupDeleted"] = "group_deleted";
|
|
403
|
+
WebhookEventType["GroupUpdated"] = "group_updated";
|
|
400
404
|
WebhookEventType["PartCreated"] = "part_created";
|
|
401
405
|
WebhookEventType["PartDeleted"] = "part_deleted";
|
|
402
406
|
WebhookEventType["PartUpdated"] = "part_updated";
|
|
@@ -864,6 +868,23 @@ class Api extends HttpClient {
|
|
|
864
868
|
* @secure
|
|
865
869
|
*/
|
|
866
870
|
this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
871
|
+
/**
|
|
872
|
+
* @description OAuth2 authorization callback.
|
|
873
|
+
*
|
|
874
|
+
* @tags keyring
|
|
875
|
+
* @name KeyringsCreateCallback
|
|
876
|
+
* @request GET:/keyrings.authorize
|
|
877
|
+
*/
|
|
878
|
+
this.keyringsCreateCallback = (query, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'GET', query: query }, params));
|
|
879
|
+
/**
|
|
880
|
+
* @description OAuth2 authorization callback.
|
|
881
|
+
*
|
|
882
|
+
* @tags keyring
|
|
883
|
+
* @name KeyringsCreateCallbackPost
|
|
884
|
+
* @request POST:/keyrings.authorize
|
|
885
|
+
* @secure
|
|
886
|
+
*/
|
|
887
|
+
this.keyringsCreateCallbackPost = (data, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
867
888
|
/**
|
|
868
889
|
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
869
890
|
*
|