@devrev/typescript-sdk 1.1.16 → 1.1.18
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.
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
/** artifact-summary */
|
|
2
2
|
export type ArtifactSummary = AtomBaseSummary;
|
|
3
|
+
/**
|
|
4
|
+
* artifacts-locate-request
|
|
5
|
+
* The request to get an artifact's download URL.
|
|
6
|
+
*/
|
|
7
|
+
export interface ArtifactsLocateRequest {
|
|
8
|
+
/**
|
|
9
|
+
* The ID of the artifact to get the URL for.
|
|
10
|
+
* @example "ARTIFACT-12345"
|
|
11
|
+
*/
|
|
12
|
+
id: string;
|
|
13
|
+
/** The version of the artifact that needs to be fetched. */
|
|
14
|
+
version?: string;
|
|
15
|
+
}
|
|
3
16
|
/**
|
|
4
17
|
* artifacts-locate-response
|
|
5
18
|
* The response to getting an artifact's download URL.
|
|
@@ -8,6 +21,7 @@ export interface ArtifactsLocateResponse {
|
|
|
8
21
|
/**
|
|
9
22
|
* The expiration timestamp of the URL.
|
|
10
23
|
* @format date-time
|
|
24
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11
25
|
*/
|
|
12
26
|
expires_at?: string;
|
|
13
27
|
/** The artifact's download URL. */
|
|
@@ -30,7 +44,7 @@ export interface ArtifactsPrepareResponse {
|
|
|
30
44
|
form_data: ArtifactsPrepareResponseFormData[];
|
|
31
45
|
/**
|
|
32
46
|
* The generated artifact's ID.
|
|
33
|
-
* @example "
|
|
47
|
+
* @example "ARTIFACT-12345"
|
|
34
48
|
*/
|
|
35
49
|
id: string;
|
|
36
50
|
/** The URL that the file's data should be uploaded to. */
|
|
@@ -49,6 +63,7 @@ export interface AtomBase {
|
|
|
49
63
|
/**
|
|
50
64
|
* Timestamp when the object was created.
|
|
51
65
|
* @format date-time
|
|
66
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
52
67
|
*/
|
|
53
68
|
created_date?: string;
|
|
54
69
|
/** Human-readable object ID unique to the Dev organization. */
|
|
@@ -59,6 +74,7 @@ export interface AtomBase {
|
|
|
59
74
|
/**
|
|
60
75
|
* Timestamp when the object was last modified.
|
|
61
76
|
* @format date-time
|
|
77
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
62
78
|
*/
|
|
63
79
|
modified_date?: string;
|
|
64
80
|
}
|
|
@@ -173,11 +189,13 @@ export type AuthToken = AtomBase & {
|
|
|
173
189
|
/**
|
|
174
190
|
* The time at which the token expires.
|
|
175
191
|
* @format date-time
|
|
192
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
176
193
|
*/
|
|
177
194
|
expires_at?: string;
|
|
178
195
|
/**
|
|
179
196
|
* The time at which the token was issued.
|
|
180
197
|
* @format date-time
|
|
198
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
181
199
|
*/
|
|
182
200
|
issued_at?: string;
|
|
183
201
|
/** The type of the requested token. */
|
|
@@ -202,6 +220,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
202
220
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
203
221
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
204
222
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
223
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
205
224
|
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
206
225
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
207
226
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
@@ -219,6 +238,7 @@ export declare enum AuthTokenStatus {
|
|
|
219
238
|
export declare enum AuthTokenSubjectTokenType {
|
|
220
239
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
221
240
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
241
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
222
242
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
223
243
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
224
244
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
@@ -320,6 +340,14 @@ export interface AuthTokensDeleteRequest {
|
|
|
320
340
|
*/
|
|
321
341
|
token_id?: string;
|
|
322
342
|
}
|
|
343
|
+
/**
|
|
344
|
+
* auth-tokens-get-request
|
|
345
|
+
* The request to get the token metadata.
|
|
346
|
+
*/
|
|
347
|
+
export interface AuthTokensGetRequest {
|
|
348
|
+
/** The unique identifier of the token under a given Dev organization. */
|
|
349
|
+
token_id: string;
|
|
350
|
+
}
|
|
323
351
|
/**
|
|
324
352
|
* auth-tokens-get-response
|
|
325
353
|
* The response to get the token metadata.
|
|
@@ -327,6 +355,25 @@ export interface AuthTokensDeleteRequest {
|
|
|
327
355
|
export interface AuthTokensGetResponse {
|
|
328
356
|
token: AuthToken;
|
|
329
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* auth-tokens-list-request
|
|
360
|
+
* A request to list the token metadata.
|
|
361
|
+
*/
|
|
362
|
+
export interface AuthTokensListRequest {
|
|
363
|
+
/**
|
|
364
|
+
* An identifier that represents the application, which requested the
|
|
365
|
+
* token. Only relevant for application access tokens.
|
|
366
|
+
*/
|
|
367
|
+
client_id?: string;
|
|
368
|
+
/** The type of the requested token. */
|
|
369
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
370
|
+
/**
|
|
371
|
+
* The subject associated with the token. In the absence of this
|
|
372
|
+
* parameter, the ID of the authenticated entity is treated as the
|
|
373
|
+
* subject.
|
|
374
|
+
*/
|
|
375
|
+
subject?: string;
|
|
376
|
+
}
|
|
330
377
|
/**
|
|
331
378
|
* auth-tokens-list-response
|
|
332
379
|
* The response to list the token metadata.
|
|
@@ -408,6 +455,69 @@ export interface AuthTokensUserTraits {
|
|
|
408
455
|
export type Capability = PartBase;
|
|
409
456
|
/** capability-summary */
|
|
410
457
|
export type CapabilitySummary = PartBaseSummary;
|
|
458
|
+
/**
|
|
459
|
+
* date-filter
|
|
460
|
+
* Provides ways to specify date ranges on objects.
|
|
461
|
+
*/
|
|
462
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
463
|
+
/** Type of date filter. */
|
|
464
|
+
type: DateFilterType;
|
|
465
|
+
};
|
|
466
|
+
/** Type of date filter. */
|
|
467
|
+
export declare enum DateFilterType {
|
|
468
|
+
Preset = "preset",
|
|
469
|
+
Range = "range"
|
|
470
|
+
}
|
|
471
|
+
/** date-time-filter */
|
|
472
|
+
export interface DateTimeFilter {
|
|
473
|
+
/**
|
|
474
|
+
* Filters for objects created after the provided timestamp
|
|
475
|
+
* (inclusive).
|
|
476
|
+
* @format date-time
|
|
477
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
478
|
+
*/
|
|
479
|
+
after?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Filters for objects created before the provided timestamp
|
|
482
|
+
* (inclusive).
|
|
483
|
+
* @format date-time
|
|
484
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
485
|
+
*/
|
|
486
|
+
before?: string;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* date-time-preset
|
|
490
|
+
* Provides preset types for date filter.
|
|
491
|
+
*/
|
|
492
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
493
|
+
/** Type of date preset. */
|
|
494
|
+
preset_type: DateTimePresetType;
|
|
495
|
+
};
|
|
496
|
+
/** date-time-preset-last-n-days */
|
|
497
|
+
export interface DateTimePresetLastNDays {
|
|
498
|
+
/**
|
|
499
|
+
* The range starts from the current timestamp and continues for the
|
|
500
|
+
* past n days.
|
|
501
|
+
* @min 0
|
|
502
|
+
* @max 4294967295
|
|
503
|
+
*/
|
|
504
|
+
days: number;
|
|
505
|
+
}
|
|
506
|
+
/** date-time-preset-next-n-days */
|
|
507
|
+
export interface DateTimePresetNextNDays {
|
|
508
|
+
/**
|
|
509
|
+
* The range starts from the current timestamp and continues for the
|
|
510
|
+
* next n days.
|
|
511
|
+
* @min 0
|
|
512
|
+
* @max 4294967295
|
|
513
|
+
*/
|
|
514
|
+
days: number;
|
|
515
|
+
}
|
|
516
|
+
/** Type of date preset. */
|
|
517
|
+
export declare enum DateTimePresetType {
|
|
518
|
+
LastNDays = "last_n_days",
|
|
519
|
+
NextNDays = "next_n_days"
|
|
520
|
+
}
|
|
411
521
|
/**
|
|
412
522
|
* dev-org-auth-connections-create-request
|
|
413
523
|
* Request to create a new enterprise authentication connection.
|
|
@@ -458,6 +568,15 @@ export interface DevOrgAuthConnectionsDeleteRequest {
|
|
|
458
568
|
/** ID of the authentication connection to be deleted. */
|
|
459
569
|
id: string;
|
|
460
570
|
}
|
|
571
|
+
/**
|
|
572
|
+
* dev-org-auth-connections-get-request
|
|
573
|
+
* Request to get configuration details of organization's authentication
|
|
574
|
+
* Connection.
|
|
575
|
+
*/
|
|
576
|
+
export interface DevOrgAuthConnectionsGetRequest {
|
|
577
|
+
/** ID of the authentication connection. */
|
|
578
|
+
id: string;
|
|
579
|
+
}
|
|
461
580
|
/**
|
|
462
581
|
* dev-org-auth-connections-get-response
|
|
463
582
|
* Response object encapsulating the configuration details of an
|
|
@@ -545,6 +664,14 @@ export type DevUser = UserBase & {
|
|
|
545
664
|
};
|
|
546
665
|
/** dev-user-summary */
|
|
547
666
|
export type DevUserSummary = UserBaseSummary;
|
|
667
|
+
/**
|
|
668
|
+
* dev-users-get-request
|
|
669
|
+
* A request to get a Dev user's information.
|
|
670
|
+
*/
|
|
671
|
+
export interface DevUsersGetRequest {
|
|
672
|
+
/** User ID of the requested Dev user. */
|
|
673
|
+
id: string;
|
|
674
|
+
}
|
|
548
675
|
/**
|
|
549
676
|
* dev-users-get-response
|
|
550
677
|
* The response to getting the information for the Dev user.
|
|
@@ -552,6 +679,36 @@ export type DevUserSummary = UserBaseSummary;
|
|
|
552
679
|
export interface DevUsersGetResponse {
|
|
553
680
|
dev_user: DevUser;
|
|
554
681
|
}
|
|
682
|
+
/**
|
|
683
|
+
* dev-users-list-request
|
|
684
|
+
* A request to get the list of Dev user's information.
|
|
685
|
+
*/
|
|
686
|
+
export interface DevUsersListRequest {
|
|
687
|
+
/**
|
|
688
|
+
* The cursor to resume iteration from. If not provided, then
|
|
689
|
+
* iteration starts from the beginning.
|
|
690
|
+
*/
|
|
691
|
+
cursor?: string;
|
|
692
|
+
/** Filters Dev users based on email addresses. */
|
|
693
|
+
email?: string[];
|
|
694
|
+
/**
|
|
695
|
+
* The maximum number of Dev users to return. The default is '50'.
|
|
696
|
+
* @format int32
|
|
697
|
+
*/
|
|
698
|
+
limit?: number;
|
|
699
|
+
/**
|
|
700
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
701
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
702
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
703
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
704
|
+
* always be returned in the specified sort-by order.
|
|
705
|
+
*/
|
|
706
|
+
mode?: ListMode;
|
|
707
|
+
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
708
|
+
sort_by?: string[];
|
|
709
|
+
/** Filters Dev users based on state. */
|
|
710
|
+
state?: UserState[];
|
|
711
|
+
}
|
|
555
712
|
/**
|
|
556
713
|
* dev-users-list-response
|
|
557
714
|
* The response to listing the Dev users.
|
|
@@ -570,6 +727,11 @@ export interface DevUsersListResponse {
|
|
|
570
727
|
*/
|
|
571
728
|
prev_cursor?: string;
|
|
572
729
|
}
|
|
730
|
+
/**
|
|
731
|
+
* dev-users-self-request
|
|
732
|
+
* A request to get the authenticated user's information.
|
|
733
|
+
*/
|
|
734
|
+
export type DevUsersSelfRequest = object;
|
|
573
735
|
/**
|
|
574
736
|
* dev-users-self-response
|
|
575
737
|
* The response to getting the information for the authenticated user.
|
|
@@ -580,17 +742,11 @@ export interface DevUsersSelfResponse {
|
|
|
580
742
|
/** empty */
|
|
581
743
|
export type Empty = object;
|
|
582
744
|
/** enhancement */
|
|
583
|
-
export type Enhancement = PartBase
|
|
584
|
-
/**
|
|
585
|
-
* Timestamp when the enhancement is expected to be closed.
|
|
586
|
-
* @format date-time
|
|
587
|
-
*/
|
|
588
|
-
target_close_date?: string;
|
|
589
|
-
};
|
|
745
|
+
export type Enhancement = PartBase;
|
|
590
746
|
/** enhancement-summary */
|
|
591
747
|
export type EnhancementSummary = PartBaseSummary;
|
|
592
748
|
/** error-bad-request */
|
|
593
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
|
|
749
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
|
|
594
750
|
type: ErrorBadRequestType;
|
|
595
751
|
};
|
|
596
752
|
/** error-bad-request-bad-request */
|
|
@@ -609,6 +765,17 @@ export interface ErrorBadRequestInvalidField {
|
|
|
609
765
|
/** The field name that's invalid. */
|
|
610
766
|
field_name: string;
|
|
611
767
|
}
|
|
768
|
+
/** error-bad-request-missing-dependency */
|
|
769
|
+
export interface ErrorBadRequestMissingDependency {
|
|
770
|
+
/** The field on which the value depends. */
|
|
771
|
+
dependent_field_name?: string;
|
|
772
|
+
/** The value which needs to be set of the dependent field. */
|
|
773
|
+
dependent_field_value?: string;
|
|
774
|
+
/** The field whose value was received. */
|
|
775
|
+
provided_field_name?: string;
|
|
776
|
+
/** The value that was received. */
|
|
777
|
+
provided_field_value?: string;
|
|
778
|
+
}
|
|
612
779
|
/** error-bad-request-missing-required-field */
|
|
613
780
|
export interface ErrorBadRequestMissingRequiredField {
|
|
614
781
|
/** The missing field's name. */
|
|
@@ -620,6 +787,7 @@ export declare enum ErrorBadRequestType {
|
|
|
620
787
|
BadRequest = "bad_request",
|
|
621
788
|
InvalidEnumValue = "invalid_enum_value",
|
|
622
789
|
InvalidField = "invalid_field",
|
|
790
|
+
MissingDependency = "missing_dependency",
|
|
623
791
|
MissingRequiredField = "missing_required_field",
|
|
624
792
|
ParseError = "parse_error",
|
|
625
793
|
ValueNotPermitted = "value_not_permitted"
|
|
@@ -710,7 +878,7 @@ export interface EventPartCreated {
|
|
|
710
878
|
export interface EventPartDeleted {
|
|
711
879
|
/**
|
|
712
880
|
* The ID of the part that was deleted.
|
|
713
|
-
* @example "
|
|
881
|
+
* @example "PROD-12345"
|
|
714
882
|
*/
|
|
715
883
|
id: string;
|
|
716
884
|
}
|
|
@@ -726,7 +894,7 @@ export interface EventRevOrgCreated {
|
|
|
726
894
|
export interface EventRevOrgDeleted {
|
|
727
895
|
/**
|
|
728
896
|
* The ID of the Rev organization that was deleted.
|
|
729
|
-
* @example "
|
|
897
|
+
* @example "REV-AbCdEfGh"
|
|
730
898
|
*/
|
|
731
899
|
id: string;
|
|
732
900
|
}
|
|
@@ -747,6 +915,19 @@ export interface EventRevUserDeleted {
|
|
|
747
915
|
export interface EventRevUserUpdated {
|
|
748
916
|
rev_user: RevUser;
|
|
749
917
|
}
|
|
918
|
+
/** event-sla-tracker-created */
|
|
919
|
+
export interface EventSlaTrackerCreated {
|
|
920
|
+
sla_tracker: SlaTracker;
|
|
921
|
+
}
|
|
922
|
+
/** event-sla-tracker-deleted */
|
|
923
|
+
export interface EventSlaTrackerDeleted {
|
|
924
|
+
/** The ID of the SLA tracker that was deleted. */
|
|
925
|
+
id: string;
|
|
926
|
+
}
|
|
927
|
+
/** event-sla-tracker-updated */
|
|
928
|
+
export interface EventSlaTrackerUpdated {
|
|
929
|
+
sla_tracker: SlaTracker;
|
|
930
|
+
}
|
|
750
931
|
/** event-tag-created */
|
|
751
932
|
export interface EventTagCreated {
|
|
752
933
|
tag: Tag;
|
|
@@ -755,7 +936,7 @@ export interface EventTagCreated {
|
|
|
755
936
|
export interface EventTagDeleted {
|
|
756
937
|
/**
|
|
757
938
|
* The ID of the tag that was deleted.
|
|
758
|
-
* @example "
|
|
939
|
+
* @example "TAG-12345"
|
|
759
940
|
*/
|
|
760
941
|
id: string;
|
|
761
942
|
}
|
|
@@ -803,7 +984,7 @@ export interface EventWorkCreated {
|
|
|
803
984
|
export interface EventWorkDeleted {
|
|
804
985
|
/**
|
|
805
986
|
* The ID of the work that was deleted.
|
|
806
|
-
* @example "
|
|
987
|
+
* @example "ISS-12345"
|
|
807
988
|
*/
|
|
808
989
|
id: string;
|
|
809
990
|
}
|
|
@@ -834,6 +1015,14 @@ export declare enum IssuePriority {
|
|
|
834
1015
|
P2 = "p2",
|
|
835
1016
|
P3 = "p3"
|
|
836
1017
|
}
|
|
1018
|
+
/**
|
|
1019
|
+
* legacy-stage
|
|
1020
|
+
* Describes the current stage of a work item.
|
|
1021
|
+
*/
|
|
1022
|
+
export interface LegacyStage {
|
|
1023
|
+
/** Current stage name of the work item. */
|
|
1024
|
+
name: string;
|
|
1025
|
+
}
|
|
837
1026
|
/**
|
|
838
1027
|
* The iteration mode to use. If "after", then entries after the provided
|
|
839
1028
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -868,6 +1057,24 @@ export type OrgSummary = RevOrgSummary & {
|
|
|
868
1057
|
export declare enum OrgType {
|
|
869
1058
|
RevOrg = "rev_org"
|
|
870
1059
|
}
|
|
1060
|
+
/**
|
|
1061
|
+
* parent-part-filter
|
|
1062
|
+
* The filter for specifying parent part.
|
|
1063
|
+
*/
|
|
1064
|
+
export interface ParentPartFilter {
|
|
1065
|
+
/**
|
|
1066
|
+
* Number of levels to fetch the part hierarchy up to.
|
|
1067
|
+
* @format int32
|
|
1068
|
+
* @min 1
|
|
1069
|
+
*/
|
|
1070
|
+
level?: number;
|
|
1071
|
+
/**
|
|
1072
|
+
* Part IDs to fetch the hierarchy for.
|
|
1073
|
+
* @minItems 1
|
|
1074
|
+
* @example ["PROD-12345"]
|
|
1075
|
+
*/
|
|
1076
|
+
parts: string[];
|
|
1077
|
+
}
|
|
871
1078
|
/** part */
|
|
872
1079
|
export type Part = (Capability | Enhancement | Feature | Product) & {
|
|
873
1080
|
type: PartType;
|
|
@@ -904,7 +1111,7 @@ export declare enum PartType {
|
|
|
904
1111
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
905
1112
|
/**
|
|
906
1113
|
* The IDs of the artifacts.
|
|
907
|
-
* @example ["
|
|
1114
|
+
* @example ["ARTIFACT-12345"]
|
|
908
1115
|
*/
|
|
909
1116
|
artifacts?: string[];
|
|
910
1117
|
/** Description of the part. */
|
|
@@ -913,7 +1120,7 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
913
1120
|
name: string;
|
|
914
1121
|
/**
|
|
915
1122
|
* The users that own the part.
|
|
916
|
-
* @example ["
|
|
1123
|
+
* @example ["DEVU-12345"]
|
|
917
1124
|
*/
|
|
918
1125
|
owned_by: string[];
|
|
919
1126
|
type: PartType;
|
|
@@ -923,7 +1130,7 @@ export interface PartsCreateRequestCapability {
|
|
|
923
1130
|
/**
|
|
924
1131
|
* ID of the parent product for the capability.
|
|
925
1132
|
* @maxItems 1
|
|
926
|
-
* @example ["
|
|
1133
|
+
* @example ["PROD-12345"]
|
|
927
1134
|
*/
|
|
928
1135
|
parent_part: string[];
|
|
929
1136
|
}
|
|
@@ -932,21 +1139,29 @@ export interface PartsCreateRequestEnhancement {
|
|
|
932
1139
|
/**
|
|
933
1140
|
* ID of the parent part on which the enhancement is to be created.
|
|
934
1141
|
* @maxItems 1
|
|
935
|
-
* @example ["
|
|
1142
|
+
* @example ["PROD-12345"]
|
|
936
1143
|
*/
|
|
937
1144
|
parent_part: string[];
|
|
938
1145
|
/**
|
|
939
1146
|
* Target close date by which enhancement is expected to be closed.
|
|
940
1147
|
* @format date-time
|
|
1148
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
941
1149
|
*/
|
|
942
1150
|
target_close_date?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Target start date by which enhancement is expected to be started.
|
|
1153
|
+
* Example Date Format: 2000-11-01T01:01:01Z
|
|
1154
|
+
* @format date-time
|
|
1155
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1156
|
+
*/
|
|
1157
|
+
target_start_date?: string;
|
|
943
1158
|
}
|
|
944
1159
|
/** parts-create-request-feature */
|
|
945
1160
|
export interface PartsCreateRequestFeature {
|
|
946
1161
|
/**
|
|
947
1162
|
* ID of the parent capability/feature for the feature.
|
|
948
1163
|
* @maxItems 1
|
|
949
|
-
* @example ["
|
|
1164
|
+
* @example ["PROD-12345"]
|
|
950
1165
|
*/
|
|
951
1166
|
parent_part: string[];
|
|
952
1167
|
}
|
|
@@ -960,16 +1175,61 @@ export interface PartsCreateResponse {
|
|
|
960
1175
|
export interface PartsDeleteRequest {
|
|
961
1176
|
/**
|
|
962
1177
|
* The ID of the part to delete.
|
|
963
|
-
* @example "
|
|
1178
|
+
* @example "PROD-12345"
|
|
964
1179
|
*/
|
|
965
1180
|
id: string;
|
|
966
1181
|
}
|
|
967
1182
|
/** parts-delete-response */
|
|
968
1183
|
export type PartsDeleteResponse = object;
|
|
1184
|
+
/** parts-get-request */
|
|
1185
|
+
export interface PartsGetRequest {
|
|
1186
|
+
/**
|
|
1187
|
+
* The ID of the part to retrieve.
|
|
1188
|
+
* @example "PROD-12345"
|
|
1189
|
+
*/
|
|
1190
|
+
id: string;
|
|
1191
|
+
}
|
|
969
1192
|
/** parts-get-response */
|
|
970
1193
|
export interface PartsGetResponse {
|
|
971
1194
|
part: Part;
|
|
972
1195
|
}
|
|
1196
|
+
/** parts-list-request */
|
|
1197
|
+
export interface PartsListRequest {
|
|
1198
|
+
/**
|
|
1199
|
+
* Filters for parts created by any of these users.
|
|
1200
|
+
* @example ["DEVU-12345"]
|
|
1201
|
+
*/
|
|
1202
|
+
created_by?: string[];
|
|
1203
|
+
/**
|
|
1204
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1205
|
+
* iteration starts from the beginning.
|
|
1206
|
+
*/
|
|
1207
|
+
cursor?: string;
|
|
1208
|
+
/**
|
|
1209
|
+
* The maximum number of parts to return. The default is '50'.
|
|
1210
|
+
* @format int32
|
|
1211
|
+
*/
|
|
1212
|
+
limit?: number;
|
|
1213
|
+
/**
|
|
1214
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1215
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1216
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1217
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1218
|
+
* always be returned in the specified sort-by order.
|
|
1219
|
+
*/
|
|
1220
|
+
mode?: ListMode;
|
|
1221
|
+
/** Filters for parts of the provided name(s). */
|
|
1222
|
+
name?: string[];
|
|
1223
|
+
/**
|
|
1224
|
+
* Filters for parts owned by any of these users.
|
|
1225
|
+
* @example ["DEVU-12345"]
|
|
1226
|
+
*/
|
|
1227
|
+
owned_by?: string[];
|
|
1228
|
+
/** The filter for specifying parent part. */
|
|
1229
|
+
parent_part?: ParentPartFilter;
|
|
1230
|
+
/** Filters for parts of the provided type(s). */
|
|
1231
|
+
type?: PartType[];
|
|
1232
|
+
}
|
|
973
1233
|
/** parts-list-response */
|
|
974
1234
|
export interface PartsListResponse {
|
|
975
1235
|
/**
|
|
@@ -992,7 +1252,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
992
1252
|
description?: string;
|
|
993
1253
|
/**
|
|
994
1254
|
* The ID of the part to update.
|
|
995
|
-
* @example "
|
|
1255
|
+
* @example "PROD-12345"
|
|
996
1256
|
*/
|
|
997
1257
|
id: string;
|
|
998
1258
|
/** The updated name of the part. */
|
|
@@ -1004,7 +1264,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
1004
1264
|
export interface PartsUpdateRequestArtifacts {
|
|
1005
1265
|
/**
|
|
1006
1266
|
* Sets the artifacts to the provided IDs.
|
|
1007
|
-
* @example ["
|
|
1267
|
+
* @example ["ARTIFACT-12345"]
|
|
1008
1268
|
*/
|
|
1009
1269
|
set?: string[];
|
|
1010
1270
|
}
|
|
@@ -1015,8 +1275,16 @@ export interface PartsUpdateRequestEnhancement {
|
|
|
1015
1275
|
/**
|
|
1016
1276
|
* Updates the target close date of the enhancement.
|
|
1017
1277
|
* @format date-time
|
|
1278
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1018
1279
|
*/
|
|
1019
1280
|
target_close_date?: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* Updates the target start date of the enhancement. Example Date
|
|
1283
|
+
* Format: 2000-11-01T01:01:01Z
|
|
1284
|
+
* @format date-time
|
|
1285
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1286
|
+
*/
|
|
1287
|
+
target_start_date?: string;
|
|
1020
1288
|
}
|
|
1021
1289
|
/** parts-update-request-feature */
|
|
1022
1290
|
export type PartsUpdateRequestFeature = object;
|
|
@@ -1025,7 +1293,7 @@ export interface PartsUpdateRequestOwnedBy {
|
|
|
1025
1293
|
/**
|
|
1026
1294
|
* Sets the owner IDs to the provided user IDs. This must not be
|
|
1027
1295
|
* empty.
|
|
1028
|
-
* @example ["
|
|
1296
|
+
* @example ["DEVU-12345"]
|
|
1029
1297
|
*/
|
|
1030
1298
|
set?: string[];
|
|
1031
1299
|
}
|
|
@@ -1092,7 +1360,7 @@ export interface RevOrgsCreateResponse {
|
|
|
1092
1360
|
export interface RevOrgsDeleteRequest {
|
|
1093
1361
|
/**
|
|
1094
1362
|
* The ID of Rev organization to delete.
|
|
1095
|
-
* @example "
|
|
1363
|
+
* @example "REV-AbCdEfGh"
|
|
1096
1364
|
*/
|
|
1097
1365
|
id: string;
|
|
1098
1366
|
}
|
|
@@ -1101,6 +1369,23 @@ export interface RevOrgsDeleteRequest {
|
|
|
1101
1369
|
* The response to deleting a Rev organization.
|
|
1102
1370
|
*/
|
|
1103
1371
|
export type RevOrgsDeleteResponse = object;
|
|
1372
|
+
/**
|
|
1373
|
+
* rev-orgs-get-request
|
|
1374
|
+
* Request object to get Rev organization's information.
|
|
1375
|
+
*/
|
|
1376
|
+
export interface RevOrgsGetRequest {
|
|
1377
|
+
/**
|
|
1378
|
+
* The ID of account for which default Rev organization is to be
|
|
1379
|
+
* fetched.
|
|
1380
|
+
* @example "ACC-12345"
|
|
1381
|
+
*/
|
|
1382
|
+
account?: string;
|
|
1383
|
+
/**
|
|
1384
|
+
* The ID of the required Rev organization.
|
|
1385
|
+
* @example "REV-AbCdEfGh"
|
|
1386
|
+
*/
|
|
1387
|
+
id?: string;
|
|
1388
|
+
}
|
|
1104
1389
|
/**
|
|
1105
1390
|
* rev-orgs-get-response
|
|
1106
1391
|
* The response to getting a Rev organization's information.
|
|
@@ -1108,6 +1393,42 @@ export type RevOrgsDeleteResponse = object;
|
|
|
1108
1393
|
export interface RevOrgsGetResponse {
|
|
1109
1394
|
rev_org: RevOrg;
|
|
1110
1395
|
}
|
|
1396
|
+
/**
|
|
1397
|
+
* rev-orgs-list-request
|
|
1398
|
+
* A request to get the list of Rev organizations for the authenticated
|
|
1399
|
+
* user's Dev organization.
|
|
1400
|
+
*/
|
|
1401
|
+
export interface RevOrgsListRequest {
|
|
1402
|
+
/** Filters by creator. */
|
|
1403
|
+
created_by?: string[];
|
|
1404
|
+
created_date?: DateTimeFilter;
|
|
1405
|
+
/**
|
|
1406
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1407
|
+
* iteration starts from the beginning.
|
|
1408
|
+
*/
|
|
1409
|
+
cursor?: string;
|
|
1410
|
+
/** List of external refs to filter Rev organizations for. */
|
|
1411
|
+
external_ref?: string[];
|
|
1412
|
+
/**
|
|
1413
|
+
* The maximum number of Rev organizations to be retrieved per page.
|
|
1414
|
+
* @format int32
|
|
1415
|
+
*/
|
|
1416
|
+
limit?: number;
|
|
1417
|
+
/**
|
|
1418
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1419
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1420
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1421
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1422
|
+
* always be returned in the specified sort-by order.
|
|
1423
|
+
*/
|
|
1424
|
+
mode?: ListMode;
|
|
1425
|
+
modified_date?: DateTimeFilter;
|
|
1426
|
+
/**
|
|
1427
|
+
* Fields to sort the Rev organizations by and the direction to sort
|
|
1428
|
+
* them.
|
|
1429
|
+
*/
|
|
1430
|
+
sort_by?: string[];
|
|
1431
|
+
}
|
|
1111
1432
|
/**
|
|
1112
1433
|
* rev-orgs-list-response
|
|
1113
1434
|
* The response to getting a list of Rev organizations' information.
|
|
@@ -1147,7 +1468,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
1147
1468
|
external_ref?: string;
|
|
1148
1469
|
/**
|
|
1149
1470
|
* The ID of Rev organization to update.
|
|
1150
|
-
* @example "
|
|
1471
|
+
* @example "REV-AbCdEfGh"
|
|
1151
1472
|
*/
|
|
1152
1473
|
id: string;
|
|
1153
1474
|
/** The tier of the RevOrg. */
|
|
@@ -1190,7 +1511,7 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
1190
1511
|
export interface SetTagWithValue {
|
|
1191
1512
|
/**
|
|
1192
1513
|
* The ID of the tag.
|
|
1193
|
-
* @example "
|
|
1514
|
+
* @example "TAG-12345"
|
|
1194
1515
|
*/
|
|
1195
1516
|
id: string;
|
|
1196
1517
|
/**
|
|
@@ -1200,12 +1521,33 @@ export interface SetTagWithValue {
|
|
|
1200
1521
|
value?: string;
|
|
1201
1522
|
}
|
|
1202
1523
|
/**
|
|
1203
|
-
*
|
|
1204
|
-
*
|
|
1524
|
+
* sla-summary-filter
|
|
1525
|
+
* The filter for SLA summary.
|
|
1205
1526
|
*/
|
|
1206
|
-
export interface
|
|
1207
|
-
/**
|
|
1208
|
-
|
|
1527
|
+
export interface SlaSummaryFilter {
|
|
1528
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
1529
|
+
stage?: SlaSummaryStage[];
|
|
1530
|
+
}
|
|
1531
|
+
/**
|
|
1532
|
+
* The stage of the SLA. This is the metric stage which is closest to
|
|
1533
|
+
* breach.
|
|
1534
|
+
*/
|
|
1535
|
+
export declare enum SlaSummaryStage {
|
|
1536
|
+
Breached = "breached",
|
|
1537
|
+
Completed = "completed",
|
|
1538
|
+
Paused = "paused",
|
|
1539
|
+
Running = "running",
|
|
1540
|
+
Warning = "warning"
|
|
1541
|
+
}
|
|
1542
|
+
/** sla-tracker */
|
|
1543
|
+
export type SlaTracker = AtomBase;
|
|
1544
|
+
/**
|
|
1545
|
+
* stage-filter
|
|
1546
|
+
* The filter for stages.
|
|
1547
|
+
*/
|
|
1548
|
+
export interface StageFilter {
|
|
1549
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
1550
|
+
name?: string[];
|
|
1209
1551
|
}
|
|
1210
1552
|
/**
|
|
1211
1553
|
* stage-init
|
|
@@ -1223,6 +1565,11 @@ export interface StageUpdate {
|
|
|
1223
1565
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
1224
1566
|
name?: string;
|
|
1225
1567
|
}
|
|
1568
|
+
/**
|
|
1569
|
+
* survey-aggregation-filter
|
|
1570
|
+
* The filter for survey aggregation.
|
|
1571
|
+
*/
|
|
1572
|
+
export type SurveyAggregationFilter = object;
|
|
1226
1573
|
/** sys-user-summary */
|
|
1227
1574
|
export type SysUserSummary = UserBaseSummary;
|
|
1228
1575
|
/** tag */
|
|
@@ -1289,7 +1636,7 @@ export interface TagsCreateResponse {
|
|
|
1289
1636
|
export interface TagsDeleteRequest {
|
|
1290
1637
|
/**
|
|
1291
1638
|
* The ID of the tag to delete.
|
|
1292
|
-
* @example "
|
|
1639
|
+
* @example "TAG-12345"
|
|
1293
1640
|
*/
|
|
1294
1641
|
id: string;
|
|
1295
1642
|
}
|
|
@@ -1298,6 +1645,17 @@ export interface TagsDeleteRequest {
|
|
|
1298
1645
|
* The response for deleting a tag.
|
|
1299
1646
|
*/
|
|
1300
1647
|
export type TagsDeleteResponse = object;
|
|
1648
|
+
/**
|
|
1649
|
+
* tags-get-request
|
|
1650
|
+
* The request to get a tag's information.
|
|
1651
|
+
*/
|
|
1652
|
+
export interface TagsGetRequest {
|
|
1653
|
+
/**
|
|
1654
|
+
* The requested tag's ID.
|
|
1655
|
+
* @example "TAG-12345"
|
|
1656
|
+
*/
|
|
1657
|
+
id: string;
|
|
1658
|
+
}
|
|
1301
1659
|
/**
|
|
1302
1660
|
* tags-get-response
|
|
1303
1661
|
* The response to getting a tag's information.
|
|
@@ -1305,6 +1663,34 @@ export type TagsDeleteResponse = object;
|
|
|
1305
1663
|
export interface TagsGetResponse {
|
|
1306
1664
|
tag: Tag;
|
|
1307
1665
|
}
|
|
1666
|
+
/**
|
|
1667
|
+
* tags-list-request
|
|
1668
|
+
* The request to get information about a list of tags.
|
|
1669
|
+
*/
|
|
1670
|
+
export interface TagsListRequest {
|
|
1671
|
+
/**
|
|
1672
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1673
|
+
* iteration starts from the beginning.
|
|
1674
|
+
*/
|
|
1675
|
+
cursor?: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* The maximum number of tags to return. The default is '50'.
|
|
1678
|
+
* @format int32
|
|
1679
|
+
*/
|
|
1680
|
+
limit?: number;
|
|
1681
|
+
/**
|
|
1682
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1683
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1684
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1685
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1686
|
+
* always be returned in the specified sort-by order.
|
|
1687
|
+
*/
|
|
1688
|
+
mode?: ListMode;
|
|
1689
|
+
/** Filters for tags with the provided names. */
|
|
1690
|
+
name?: string[];
|
|
1691
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
1692
|
+
sort_by?: string[];
|
|
1693
|
+
}
|
|
1308
1694
|
/**
|
|
1309
1695
|
* tags-list-response
|
|
1310
1696
|
* The response to listing the tags.
|
|
@@ -1342,7 +1728,7 @@ export interface TagsUpdateRequest {
|
|
|
1342
1728
|
description?: string;
|
|
1343
1729
|
/**
|
|
1344
1730
|
* The ID of the tag to update.
|
|
1345
|
-
* @example "
|
|
1731
|
+
* @example "TAG-12345"
|
|
1346
1732
|
*/
|
|
1347
1733
|
id: string;
|
|
1348
1734
|
/**
|
|
@@ -1401,18 +1787,19 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1401
1787
|
* provided time. The minimum value should be at least a minute more
|
|
1402
1788
|
* than the current timestamp.
|
|
1403
1789
|
* @format date-time
|
|
1790
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1404
1791
|
*/
|
|
1405
1792
|
expires_at?: string;
|
|
1406
1793
|
/**
|
|
1407
1794
|
* The ID of the object to create the timeline entry for.
|
|
1408
|
-
* @example "
|
|
1795
|
+
* @example "PROD-12345"
|
|
1409
1796
|
*/
|
|
1410
1797
|
object: string;
|
|
1411
1798
|
/**
|
|
1412
1799
|
* If the visibility of the entry is private, this specifies the users
|
|
1413
1800
|
* that the entry is private to. Note the creator is always implicitly
|
|
1414
1801
|
* included in this list.
|
|
1415
|
-
* @example ["
|
|
1802
|
+
* @example ["DEVU-12345"]
|
|
1416
1803
|
*/
|
|
1417
1804
|
private_to?: string[];
|
|
1418
1805
|
type: TimelineEntriesCreateRequestType;
|
|
@@ -1429,7 +1816,8 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1429
1816
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
1430
1817
|
/**
|
|
1431
1818
|
* The IDs of the artifacts attached to the comment.
|
|
1432
|
-
* @
|
|
1819
|
+
* @maxItems 10
|
|
1820
|
+
* @example ["ARTIFACT-12345"]
|
|
1433
1821
|
*/
|
|
1434
1822
|
artifacts?: string[];
|
|
1435
1823
|
/** The comment's body. */
|
|
@@ -1465,6 +1853,17 @@ export interface TimelineEntriesDeleteRequest {
|
|
|
1465
1853
|
* The response to deleting a timeline entry from an object.
|
|
1466
1854
|
*/
|
|
1467
1855
|
export type TimelineEntriesDeleteResponse = object;
|
|
1856
|
+
/**
|
|
1857
|
+
* timeline-entries-get-request
|
|
1858
|
+
* The request to get a timeline entry.
|
|
1859
|
+
*/
|
|
1860
|
+
export interface TimelineEntriesGetRequest {
|
|
1861
|
+
/**
|
|
1862
|
+
* The ID of the timeline entry to get.
|
|
1863
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
1864
|
+
*/
|
|
1865
|
+
id: string;
|
|
1866
|
+
}
|
|
1468
1867
|
/**
|
|
1469
1868
|
* timeline-entries-get-response
|
|
1470
1869
|
* The request to getting a timeline entry.
|
|
@@ -1472,6 +1871,42 @@ export type TimelineEntriesDeleteResponse = object;
|
|
|
1472
1871
|
export interface TimelineEntriesGetResponse {
|
|
1473
1872
|
timeline_entry: TimelineEntry;
|
|
1474
1873
|
}
|
|
1874
|
+
/**
|
|
1875
|
+
* timeline-entries-list-request
|
|
1876
|
+
* The request to list timeline entries for an object.
|
|
1877
|
+
*/
|
|
1878
|
+
export interface TimelineEntriesListRequest {
|
|
1879
|
+
/**
|
|
1880
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1881
|
+
* iteration starts from the beginning.
|
|
1882
|
+
*/
|
|
1883
|
+
cursor?: string;
|
|
1884
|
+
/**
|
|
1885
|
+
* The maximum number of entries to return. If not set, then this
|
|
1886
|
+
* defaults to `50`.
|
|
1887
|
+
* @format int32
|
|
1888
|
+
*/
|
|
1889
|
+
limit?: number;
|
|
1890
|
+
/**
|
|
1891
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1892
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1893
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1894
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1895
|
+
* always be returned in the specified sort-by order.
|
|
1896
|
+
*/
|
|
1897
|
+
mode?: ListMode;
|
|
1898
|
+
/**
|
|
1899
|
+
* The ID of the object to list timeline entries for.
|
|
1900
|
+
* @example "PROD-12345"
|
|
1901
|
+
*/
|
|
1902
|
+
object: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* The visibility of the timeline entries to filter for. Note this is
|
|
1905
|
+
* a strict filter, such that only entries with the exact visibilities
|
|
1906
|
+
* specified will be returned.
|
|
1907
|
+
*/
|
|
1908
|
+
visibility?: TimelineEntryVisibility[];
|
|
1909
|
+
}
|
|
1475
1910
|
/**
|
|
1476
1911
|
* timeline-entries-list-response
|
|
1477
1912
|
* The response to listing timeline entries for an object.
|
|
@@ -1518,18 +1953,21 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
1518
1953
|
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
1519
1954
|
* added more than once, i.e. nothing is done if the artifact is
|
|
1520
1955
|
* already attached. Mutually exclusive with `set`.
|
|
1521
|
-
* @
|
|
1956
|
+
* @maxItems 10
|
|
1957
|
+
* @example ["ARTIFACT-12345"]
|
|
1522
1958
|
*/
|
|
1523
1959
|
add?: string[];
|
|
1524
1960
|
/**
|
|
1525
1961
|
* Removes the provided artifacts from the comment. If an artifact is
|
|
1526
1962
|
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
1527
|
-
* @
|
|
1963
|
+
* @maxItems 10
|
|
1964
|
+
* @example ["ARTIFACT-12345"]
|
|
1528
1965
|
*/
|
|
1529
1966
|
remove?: string[];
|
|
1530
1967
|
/**
|
|
1531
1968
|
* Sets the field to the provided artifacts.
|
|
1532
|
-
* @
|
|
1969
|
+
* @maxItems 10
|
|
1970
|
+
* @example ["ARTIFACT-12345"]
|
|
1533
1971
|
*/
|
|
1534
1972
|
set?: string[];
|
|
1535
1973
|
}
|
|
@@ -1679,6 +2117,9 @@ export interface WebhookEventRequest {
|
|
|
1679
2117
|
rev_user_created?: EventRevUserCreated;
|
|
1680
2118
|
rev_user_deleted?: EventRevUserDeleted;
|
|
1681
2119
|
rev_user_updated?: EventRevUserUpdated;
|
|
2120
|
+
sla_tracker_created?: EventSlaTrackerCreated;
|
|
2121
|
+
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
2122
|
+
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
1682
2123
|
tag_created?: EventTagCreated;
|
|
1683
2124
|
tag_deleted?: EventTagDeleted;
|
|
1684
2125
|
tag_updated?: EventTagUpdated;
|
|
@@ -1691,6 +2132,7 @@ export interface WebhookEventRequest {
|
|
|
1691
2132
|
* should only be processed if the timestamp isn't stale by several
|
|
1692
2133
|
* seconds.
|
|
1693
2134
|
* @format date-time
|
|
2135
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1694
2136
|
*/
|
|
1695
2137
|
timestamp?: string;
|
|
1696
2138
|
/** The event types that the webhook will receive. */
|
|
@@ -1797,6 +2239,17 @@ export interface WebhooksDeleteRequest {
|
|
|
1797
2239
|
* The response to deleting the webhook.
|
|
1798
2240
|
*/
|
|
1799
2241
|
export type WebhooksDeleteResponse = object;
|
|
2242
|
+
/**
|
|
2243
|
+
* webhooks-get-request
|
|
2244
|
+
* The request to get a webhook's information.
|
|
2245
|
+
*/
|
|
2246
|
+
export interface WebhooksGetRequest {
|
|
2247
|
+
/**
|
|
2248
|
+
* ID for the webhook.
|
|
2249
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
2250
|
+
*/
|
|
2251
|
+
id: string;
|
|
2252
|
+
}
|
|
1800
2253
|
/**
|
|
1801
2254
|
* webhooks-get-response
|
|
1802
2255
|
* The response to getting the information for the webhook.
|
|
@@ -1804,6 +2257,11 @@ export type WebhooksDeleteResponse = object;
|
|
|
1804
2257
|
export interface WebhooksGetResponse {
|
|
1805
2258
|
webhook: Webhook;
|
|
1806
2259
|
}
|
|
2260
|
+
/**
|
|
2261
|
+
* webhooks-list-request
|
|
2262
|
+
* The request to list the webhooks.
|
|
2263
|
+
*/
|
|
2264
|
+
export type WebhooksListRequest = object;
|
|
1807
2265
|
/**
|
|
1808
2266
|
* webhooks-list-response
|
|
1809
2267
|
* The response to listing the webhooks.
|
|
@@ -1890,12 +2348,13 @@ export type WorkBase = AtomBase & {
|
|
|
1890
2348
|
/** Users that reported the work. */
|
|
1891
2349
|
reported_by?: UserSummary[];
|
|
1892
2350
|
/** Describes the current stage of a work item. */
|
|
1893
|
-
stage?:
|
|
2351
|
+
stage?: LegacyStage;
|
|
1894
2352
|
/** Tags associated with the object. */
|
|
1895
2353
|
tags?: TagWithValue[];
|
|
1896
2354
|
/**
|
|
1897
2355
|
* Timestamp when the work is expected to be complete.
|
|
1898
2356
|
* @format date-time
|
|
2357
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1899
2358
|
*/
|
|
1900
2359
|
target_close_date?: string;
|
|
1901
2360
|
/** Title of the work object. */
|
|
@@ -1911,24 +2370,24 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
1911
2370
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
1912
2371
|
* applies to. Specifying a part is required when creating tickets and
|
|
1913
2372
|
* issues.
|
|
1914
|
-
* @example "
|
|
2373
|
+
* @example "PROD-12345"
|
|
1915
2374
|
*/
|
|
1916
2375
|
applies_to_part: string;
|
|
1917
2376
|
/**
|
|
1918
2377
|
* The IDs of the artifacts to associate with the work item.
|
|
1919
|
-
* @example ["
|
|
2378
|
+
* @example ["ARTIFACT-12345"]
|
|
1920
2379
|
*/
|
|
1921
2380
|
artifacts?: string[];
|
|
1922
2381
|
/** Body of the work object. */
|
|
1923
2382
|
body?: string;
|
|
1924
2383
|
/**
|
|
1925
2384
|
* The users that own the work.
|
|
1926
|
-
* @example ["
|
|
2385
|
+
* @example ["DEVU-12345"]
|
|
1927
2386
|
*/
|
|
1928
2387
|
owned_by: string[];
|
|
1929
2388
|
/**
|
|
1930
2389
|
* The users that reported the work.
|
|
1931
|
-
* @example ["
|
|
2390
|
+
* @example ["DEVU-12345"]
|
|
1932
2391
|
*/
|
|
1933
2392
|
reported_by?: string[];
|
|
1934
2393
|
/** Sets an object's initial stage. */
|
|
@@ -1938,6 +2397,7 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
1938
2397
|
/**
|
|
1939
2398
|
* Timestamp for when the work is expected to be complete.
|
|
1940
2399
|
* @format date-time
|
|
2400
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1941
2401
|
*/
|
|
1942
2402
|
target_close_date?: string;
|
|
1943
2403
|
/** Title of the work object. */
|
|
@@ -1946,6 +2406,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
1946
2406
|
};
|
|
1947
2407
|
/** works-create-request-issue */
|
|
1948
2408
|
export interface WorksCreateRequestIssue {
|
|
2409
|
+
/**
|
|
2410
|
+
* The IDs of the parts associated with issue.
|
|
2411
|
+
* @maxItems 8
|
|
2412
|
+
* @example ["PROD-12345"]
|
|
2413
|
+
*/
|
|
2414
|
+
developed_with?: string[];
|
|
1949
2415
|
/** Priority of the work based upon impact and criticality. */
|
|
1950
2416
|
priority?: IssuePriority;
|
|
1951
2417
|
/** The sprint that the issue belongs to. */
|
|
@@ -1959,7 +2425,7 @@ export interface WorksCreateRequestTicket {
|
|
|
1959
2425
|
is_spam?: boolean;
|
|
1960
2426
|
/**
|
|
1961
2427
|
* The Rev organization that the ticket is associated with.
|
|
1962
|
-
* @example "
|
|
2428
|
+
* @example "REV-AbCdEfGh"
|
|
1963
2429
|
*/
|
|
1964
2430
|
rev_org?: string;
|
|
1965
2431
|
/** Severity of the ticket. */
|
|
@@ -1975,21 +2441,160 @@ export interface WorksCreateResponse {
|
|
|
1975
2441
|
export interface WorksDeleteRequest {
|
|
1976
2442
|
/**
|
|
1977
2443
|
* The work's ID.
|
|
1978
|
-
* @example "
|
|
2444
|
+
* @example "ISS-12345"
|
|
1979
2445
|
*/
|
|
1980
2446
|
id: string;
|
|
1981
2447
|
}
|
|
1982
2448
|
/** works-delete-response */
|
|
1983
2449
|
export type WorksDeleteResponse = object;
|
|
2450
|
+
/** works-export-request */
|
|
2451
|
+
export interface WorksExportRequest {
|
|
2452
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2453
|
+
actual_close_date?: DateFilter;
|
|
2454
|
+
/**
|
|
2455
|
+
* Filters for work belonging to any of the provided parts.
|
|
2456
|
+
* @example ["PROD-12345"]
|
|
2457
|
+
*/
|
|
2458
|
+
applies_to_part?: string[];
|
|
2459
|
+
/**
|
|
2460
|
+
* Filters for work created by any of these users.
|
|
2461
|
+
* @example ["DEVU-12345"]
|
|
2462
|
+
*/
|
|
2463
|
+
created_by?: string[];
|
|
2464
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2465
|
+
created_date?: DateFilter;
|
|
2466
|
+
/**
|
|
2467
|
+
* The number of work items to return. The default is '50', the
|
|
2468
|
+
* maximum is '5000'.
|
|
2469
|
+
* @format int32
|
|
2470
|
+
*/
|
|
2471
|
+
first?: number;
|
|
2472
|
+
issue?: WorksFilterIssue;
|
|
2473
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2474
|
+
modified_date?: DateFilter;
|
|
2475
|
+
/**
|
|
2476
|
+
* Filters for work owned by any of these users.
|
|
2477
|
+
* @example ["DEVU-12345"]
|
|
2478
|
+
*/
|
|
2479
|
+
owned_by?: string[];
|
|
2480
|
+
/** The filter for stages. */
|
|
2481
|
+
stage?: StageFilter;
|
|
2482
|
+
/**
|
|
2483
|
+
* Filters for work with any of the provided tags.
|
|
2484
|
+
* @example ["TAG-12345"]
|
|
2485
|
+
*/
|
|
2486
|
+
tags?: string[];
|
|
2487
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2488
|
+
target_close_date?: DateFilter;
|
|
2489
|
+
ticket?: WorksFilterTicket;
|
|
2490
|
+
/** Filters for work of the provided types. */
|
|
2491
|
+
type?: WorkType[];
|
|
2492
|
+
}
|
|
1984
2493
|
/** works-export-response */
|
|
1985
2494
|
export interface WorksExportResponse {
|
|
1986
2495
|
/** The resulting collection of work items. */
|
|
1987
2496
|
works: Work[];
|
|
1988
2497
|
}
|
|
2498
|
+
/** works-filter-issue */
|
|
2499
|
+
export interface WorksFilterIssue {
|
|
2500
|
+
/** Filters for issues with any of the provided priorities. */
|
|
2501
|
+
priority?: IssuePriority[];
|
|
2502
|
+
/**
|
|
2503
|
+
* Filters for issues with any of the provided Rev organizations.
|
|
2504
|
+
* @example ["REV-AbCdEfGh"]
|
|
2505
|
+
*/
|
|
2506
|
+
rev_orgs?: string[];
|
|
2507
|
+
}
|
|
2508
|
+
/** works-filter-ticket */
|
|
2509
|
+
export interface WorksFilterTicket {
|
|
2510
|
+
/** Filters for tickets belonging to specific groups. */
|
|
2511
|
+
group?: string[];
|
|
2512
|
+
/** Filters for tickets that are spam. */
|
|
2513
|
+
is_spam?: boolean;
|
|
2514
|
+
/** Filters for tickets that need response. */
|
|
2515
|
+
needs_response?: boolean;
|
|
2516
|
+
/**
|
|
2517
|
+
* Filters for tickets that are associated with any of the provided
|
|
2518
|
+
* Rev organizations.
|
|
2519
|
+
* @example ["REV-AbCdEfGh"]
|
|
2520
|
+
*/
|
|
2521
|
+
rev_org?: string[];
|
|
2522
|
+
/** Filters for tickets with any of the provided severities. */
|
|
2523
|
+
severity?: TicketSeverity[];
|
|
2524
|
+
/** The filter for SLA summary. */
|
|
2525
|
+
sla_summary?: SlaSummaryFilter;
|
|
2526
|
+
/** Filters for tickets with any of the provided source channels. */
|
|
2527
|
+
source_channel?: string[];
|
|
2528
|
+
/** The filter for survey aggregation. */
|
|
2529
|
+
surveys?: SurveyAggregationFilter;
|
|
2530
|
+
}
|
|
2531
|
+
/** works-get-request */
|
|
2532
|
+
export interface WorksGetRequest {
|
|
2533
|
+
/**
|
|
2534
|
+
* The work's ID.
|
|
2535
|
+
* @example "ISS-12345"
|
|
2536
|
+
*/
|
|
2537
|
+
id: string;
|
|
2538
|
+
}
|
|
1989
2539
|
/** works-get-response */
|
|
1990
2540
|
export interface WorksGetResponse {
|
|
1991
2541
|
work: Work;
|
|
1992
2542
|
}
|
|
2543
|
+
/** works-list-request */
|
|
2544
|
+
export interface WorksListRequest {
|
|
2545
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2546
|
+
actual_close_date?: DateFilter;
|
|
2547
|
+
/**
|
|
2548
|
+
* Filters for work belonging to any of the provided parts.
|
|
2549
|
+
* @example ["PROD-12345"]
|
|
2550
|
+
*/
|
|
2551
|
+
applies_to_part?: string[];
|
|
2552
|
+
/**
|
|
2553
|
+
* Filters for work created by any of these users.
|
|
2554
|
+
* @example ["DEVU-12345"]
|
|
2555
|
+
*/
|
|
2556
|
+
created_by?: string[];
|
|
2557
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2558
|
+
created_date?: DateFilter;
|
|
2559
|
+
/**
|
|
2560
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2561
|
+
* iteration starts from the beginning.
|
|
2562
|
+
*/
|
|
2563
|
+
cursor?: string;
|
|
2564
|
+
issue?: WorksFilterIssue;
|
|
2565
|
+
/**
|
|
2566
|
+
* The maximum number of works to return. The default is '50'.
|
|
2567
|
+
* @format int32
|
|
2568
|
+
*/
|
|
2569
|
+
limit?: number;
|
|
2570
|
+
/**
|
|
2571
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2572
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2573
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2574
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2575
|
+
* always be returned in the specified sort-by order.
|
|
2576
|
+
*/
|
|
2577
|
+
mode?: ListMode;
|
|
2578
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2579
|
+
modified_date?: DateFilter;
|
|
2580
|
+
/**
|
|
2581
|
+
* Filters for work owned by any of these users.
|
|
2582
|
+
* @example ["DEVU-12345"]
|
|
2583
|
+
*/
|
|
2584
|
+
owned_by?: string[];
|
|
2585
|
+
/** The filter for stages. */
|
|
2586
|
+
stage?: StageFilter;
|
|
2587
|
+
/**
|
|
2588
|
+
* Filters for work with any of the provided tags.
|
|
2589
|
+
* @example ["TAG-12345"]
|
|
2590
|
+
*/
|
|
2591
|
+
tags?: string[];
|
|
2592
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2593
|
+
target_close_date?: DateFilter;
|
|
2594
|
+
ticket?: WorksFilterTicket;
|
|
2595
|
+
/** Filters for work of the provided types. */
|
|
2596
|
+
type?: WorkType[];
|
|
2597
|
+
}
|
|
1993
2598
|
/** works-list-response */
|
|
1994
2599
|
export interface WorksListResponse {
|
|
1995
2600
|
/**
|
|
@@ -2009,7 +2614,7 @@ export interface WorksListResponse {
|
|
|
2009
2614
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
|
|
2010
2615
|
/**
|
|
2011
2616
|
* Updates the part that the work item applies to.
|
|
2012
|
-
* @example "
|
|
2617
|
+
* @example "PROD-12345"
|
|
2013
2618
|
*/
|
|
2014
2619
|
applies_to_part?: string;
|
|
2015
2620
|
artifacts?: WorksUpdateRequestArtifactIds;
|
|
@@ -2017,7 +2622,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2017
2622
|
body?: string;
|
|
2018
2623
|
/**
|
|
2019
2624
|
* The work's ID.
|
|
2020
|
-
* @example "
|
|
2625
|
+
* @example "ISS-12345"
|
|
2021
2626
|
*/
|
|
2022
2627
|
id: string;
|
|
2023
2628
|
owned_by?: WorksUpdateRequestOwnedBy;
|
|
@@ -2028,6 +2633,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2028
2633
|
/**
|
|
2029
2634
|
* Updates the timestamp for when the work is expected to be complete.
|
|
2030
2635
|
* @format date-time
|
|
2636
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2031
2637
|
*/
|
|
2032
2638
|
target_close_date?: string | null;
|
|
2033
2639
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
@@ -2038,23 +2644,33 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2038
2644
|
export interface WorksUpdateRequestArtifactIds {
|
|
2039
2645
|
/**
|
|
2040
2646
|
* Sets the IDs to the provided artifact IDs.
|
|
2041
|
-
* @example ["
|
|
2647
|
+
* @example ["ARTIFACT-12345"]
|
|
2042
2648
|
*/
|
|
2043
2649
|
set?: string[];
|
|
2044
2650
|
}
|
|
2045
2651
|
/** works-update-request-issue */
|
|
2046
2652
|
export interface WorksUpdateRequestIssue {
|
|
2653
|
+
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
2047
2654
|
/** Priority of the work based upon impact and criticality. */
|
|
2048
2655
|
priority?: IssuePriority;
|
|
2049
2656
|
/** Updates the sprint that the issue belongs to. */
|
|
2050
2657
|
sprint?: string | null;
|
|
2051
2658
|
}
|
|
2659
|
+
/** works-update-request-issue-developed-with */
|
|
2660
|
+
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
2661
|
+
/**
|
|
2662
|
+
* Sets the IDs of the parts associated with issue.
|
|
2663
|
+
* @maxItems 8
|
|
2664
|
+
* @example ["PROD-12345"]
|
|
2665
|
+
*/
|
|
2666
|
+
set?: string[];
|
|
2667
|
+
}
|
|
2052
2668
|
/** works-update-request-owned-by */
|
|
2053
2669
|
export interface WorksUpdateRequestOwnedBy {
|
|
2054
2670
|
/**
|
|
2055
2671
|
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2056
2672
|
* empty.
|
|
2057
|
-
* @example ["
|
|
2673
|
+
* @example ["DEVU-12345"]
|
|
2058
2674
|
*/
|
|
2059
2675
|
set?: string[];
|
|
2060
2676
|
}
|
|
@@ -2062,7 +2678,7 @@ export interface WorksUpdateRequestOwnedBy {
|
|
|
2062
2678
|
export interface WorksUpdateRequestReportedBy {
|
|
2063
2679
|
/**
|
|
2064
2680
|
* Sets the users that reported the work to the provided user IDs.
|
|
2065
|
-
* @example ["
|
|
2681
|
+
* @example ["DEVU-12345"]
|
|
2066
2682
|
*/
|
|
2067
2683
|
set?: string[];
|
|
2068
2684
|
}
|
|
@@ -2079,7 +2695,7 @@ export interface WorksUpdateRequestTicket {
|
|
|
2079
2695
|
is_spam?: boolean;
|
|
2080
2696
|
/**
|
|
2081
2697
|
* Updates the Rev organization that the ticket is associated with.
|
|
2082
|
-
* @example "
|
|
2698
|
+
* @example "REV-AbCdEfGh"
|
|
2083
2699
|
*/
|
|
2084
2700
|
rev_org?: string | null;
|
|
2085
2701
|
/** Severity of the ticket. */
|
|
@@ -2149,15 +2765,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2149
2765
|
artifactsLocate: (query: {
|
|
2150
2766
|
/**
|
|
2151
2767
|
* The ID of the artifact to get the URL for.
|
|
2152
|
-
* @example "
|
|
2768
|
+
* @example "ARTIFACT-12345"
|
|
2153
2769
|
*/
|
|
2154
2770
|
id: string;
|
|
2155
|
-
/**
|
|
2156
|
-
|
|
2157
|
-
* @format date-time
|
|
2158
|
-
*/
|
|
2159
|
-
timestamp?: string;
|
|
2771
|
+
/** The version of the artifact that needs to be fetched. */
|
|
2772
|
+
version?: string;
|
|
2160
2773
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2774
|
+
/**
|
|
2775
|
+
* @description Gets the download URL for the artifact.
|
|
2776
|
+
*
|
|
2777
|
+
* @tags artifacts
|
|
2778
|
+
* @name ArtifactsLocatePost
|
|
2779
|
+
* @request POST:/artifacts.locate
|
|
2780
|
+
* @secure
|
|
2781
|
+
*/
|
|
2782
|
+
artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2161
2783
|
/**
|
|
2162
2784
|
* @description Creates an artifact and generates an upload URL for its data.
|
|
2163
2785
|
*
|
|
@@ -2197,6 +2819,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2197
2819
|
/** The unique identifier of the token under a given Dev organization. */
|
|
2198
2820
|
token_id: string;
|
|
2199
2821
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
2822
|
+
/**
|
|
2823
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
2824
|
+
*
|
|
2825
|
+
* @tags auth-tokens
|
|
2826
|
+
* @name AuthTokensGetPost
|
|
2827
|
+
* @request POST:/auth-tokens.get
|
|
2828
|
+
* @secure
|
|
2829
|
+
*/
|
|
2830
|
+
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
2200
2831
|
/**
|
|
2201
2832
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
2202
2833
|
*
|
|
@@ -2223,6 +2854,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2223
2854
|
*/
|
|
2224
2855
|
subject?: string;
|
|
2225
2856
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
2857
|
+
/**
|
|
2858
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
2859
|
+
*
|
|
2860
|
+
* @tags auth-tokens
|
|
2861
|
+
* @name AuthTokensListPost
|
|
2862
|
+
* @request POST:/auth-tokens.list
|
|
2863
|
+
* @secure
|
|
2864
|
+
*/
|
|
2865
|
+
authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
2226
2866
|
/**
|
|
2227
2867
|
* @description Revokes all the tokens that matches the given token type created by the authenticated user.
|
|
2228
2868
|
*
|
|
@@ -2271,6 +2911,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2271
2911
|
/** ID of the authentication connection. */
|
|
2272
2912
|
id: string;
|
|
2273
2913
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
2914
|
+
/**
|
|
2915
|
+
* @description Retrieves the details for an authentication connection.
|
|
2916
|
+
*
|
|
2917
|
+
* @tags auth-connection, dev-orgs
|
|
2918
|
+
* @name DevOrgAuthConnectionsGetPost
|
|
2919
|
+
* @request POST:/dev-orgs.auth-connections.get
|
|
2920
|
+
* @secure
|
|
2921
|
+
*/
|
|
2922
|
+
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
2274
2923
|
/**
|
|
2275
2924
|
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
2276
2925
|
*
|
|
@@ -2280,6 +2929,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2280
2929
|
* @secure
|
|
2281
2930
|
*/
|
|
2282
2931
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
2932
|
+
/**
|
|
2933
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
2934
|
+
*
|
|
2935
|
+
* @tags auth-connection, dev-orgs
|
|
2936
|
+
* @name DevOrgAuthConnectionsListPost
|
|
2937
|
+
* @request POST:/dev-orgs.auth-connections.list
|
|
2938
|
+
* @secure
|
|
2939
|
+
*/
|
|
2940
|
+
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
2283
2941
|
/**
|
|
2284
2942
|
* @description Enable or disable an authentication connection for a Dev organization. Currently, only 1 authentication connection can be enabled at a time. When a new authentication connection is enabled, the connection which is currently enabled for the Dev organization is automatically disabled.
|
|
2285
2943
|
*
|
|
@@ -2310,6 +2968,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2310
2968
|
/** User ID of the requested Dev user. */
|
|
2311
2969
|
id: string;
|
|
2312
2970
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
2971
|
+
/**
|
|
2972
|
+
* @description Gets the requested user's information.
|
|
2973
|
+
*
|
|
2974
|
+
* @tags dev-users
|
|
2975
|
+
* @name DevUsersGetPost
|
|
2976
|
+
* @request POST:/dev-users.get
|
|
2977
|
+
* @secure
|
|
2978
|
+
*/
|
|
2979
|
+
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
2313
2980
|
/**
|
|
2314
2981
|
* @description Lists users within your organization.
|
|
2315
2982
|
*
|
|
@@ -2341,6 +3008,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2341
3008
|
/** Filters Dev users based on state. */
|
|
2342
3009
|
state?: UserState[];
|
|
2343
3010
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
3011
|
+
/**
|
|
3012
|
+
* @description Lists users within your organization.
|
|
3013
|
+
*
|
|
3014
|
+
* @tags dev-users
|
|
3015
|
+
* @name DevUsersListPost
|
|
3016
|
+
* @request POST:/dev-users.list
|
|
3017
|
+
* @secure
|
|
3018
|
+
*/
|
|
3019
|
+
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
2344
3020
|
/**
|
|
2345
3021
|
* @description Gets the authenticated user's information.
|
|
2346
3022
|
*
|
|
@@ -2350,6 +3026,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2350
3026
|
* @secure
|
|
2351
3027
|
*/
|
|
2352
3028
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
3029
|
+
/**
|
|
3030
|
+
* @description Gets the authenticated user's information.
|
|
3031
|
+
*
|
|
3032
|
+
* @tags dev-users
|
|
3033
|
+
* @name DevUsersSelfPost
|
|
3034
|
+
* @request POST:/dev-users.self
|
|
3035
|
+
* @secure
|
|
3036
|
+
*/
|
|
3037
|
+
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
2353
3038
|
/**
|
|
2354
3039
|
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
2355
3040
|
*
|
|
@@ -2379,10 +3064,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2379
3064
|
partsGet: (query: {
|
|
2380
3065
|
/**
|
|
2381
3066
|
* The ID of the part to retrieve.
|
|
2382
|
-
* @example "
|
|
3067
|
+
* @example "PROD-12345"
|
|
2383
3068
|
*/
|
|
2384
3069
|
id: string;
|
|
2385
3070
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
3071
|
+
/**
|
|
3072
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
3073
|
+
*
|
|
3074
|
+
* @tags parts
|
|
3075
|
+
* @name PartsGetPost
|
|
3076
|
+
* @request POST:/parts.get
|
|
3077
|
+
* @secure
|
|
3078
|
+
*/
|
|
3079
|
+
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
2386
3080
|
/**
|
|
2387
3081
|
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
2388
3082
|
*
|
|
@@ -2394,7 +3088,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2394
3088
|
partsList: (query?: {
|
|
2395
3089
|
/**
|
|
2396
3090
|
* Filters for parts created by any of these users.
|
|
2397
|
-
* @example ["
|
|
3091
|
+
* @example ["DEVU-12345"]
|
|
2398
3092
|
*/
|
|
2399
3093
|
created_by?: string[];
|
|
2400
3094
|
/**
|
|
@@ -2416,12 +3110,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2416
3110
|
name?: string[];
|
|
2417
3111
|
/**
|
|
2418
3112
|
* Filters for parts owned by any of these users.
|
|
2419
|
-
* @example ["
|
|
3113
|
+
* @example ["DEVU-12345"]
|
|
2420
3114
|
*/
|
|
2421
3115
|
owned_by?: string[];
|
|
3116
|
+
/**
|
|
3117
|
+
* Number of levels to fetch the part hierarchy up to.
|
|
3118
|
+
* @format int32
|
|
3119
|
+
* @min 1
|
|
3120
|
+
*/
|
|
3121
|
+
'parent_part.level'?: number;
|
|
3122
|
+
/**
|
|
3123
|
+
* Part IDs to fetch the hierarchy for. Required if any parent_part.*
|
|
3124
|
+
* fields are provided.
|
|
3125
|
+
* @minItems 1
|
|
3126
|
+
* @example ["PROD-12345"]
|
|
3127
|
+
*/
|
|
3128
|
+
'parent_part.parts'?: string[];
|
|
2422
3129
|
/** Filters for parts of the provided type(s). */
|
|
2423
3130
|
type?: PartType[];
|
|
2424
3131
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
3132
|
+
/**
|
|
3133
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
3134
|
+
*
|
|
3135
|
+
* @tags parts
|
|
3136
|
+
* @name PartsListPost
|
|
3137
|
+
* @request POST:/parts.list
|
|
3138
|
+
* @secure
|
|
3139
|
+
*/
|
|
3140
|
+
partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
2425
3141
|
/**
|
|
2426
3142
|
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
2427
3143
|
*
|
|
@@ -2461,15 +3177,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2461
3177
|
/**
|
|
2462
3178
|
* The ID of account for which default Rev organization is to be
|
|
2463
3179
|
* fetched.
|
|
2464
|
-
* @example "
|
|
3180
|
+
* @example "ACC-12345"
|
|
2465
3181
|
*/
|
|
2466
3182
|
account?: string;
|
|
2467
3183
|
/**
|
|
2468
3184
|
* The ID of the required Rev organization.
|
|
2469
|
-
* @example "
|
|
3185
|
+
* @example "REV-AbCdEfGh"
|
|
2470
3186
|
*/
|
|
2471
3187
|
id?: string;
|
|
2472
3188
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
3189
|
+
/**
|
|
3190
|
+
* @description Retrieves the Rev organization's information.
|
|
3191
|
+
*
|
|
3192
|
+
* @tags rev-orgs
|
|
3193
|
+
* @name RevOrgsGetPost
|
|
3194
|
+
* @request POST:/rev-orgs.get
|
|
3195
|
+
* @secure
|
|
3196
|
+
*/
|
|
3197
|
+
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
2473
3198
|
/**
|
|
2474
3199
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
2475
3200
|
*
|
|
@@ -2484,12 +3209,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2484
3209
|
/**
|
|
2485
3210
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2486
3211
|
* @format date-time
|
|
3212
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2487
3213
|
*/
|
|
2488
3214
|
'created_date.after'?: string;
|
|
2489
3215
|
/**
|
|
2490
3216
|
* Filters for objects created before the provided timestamp
|
|
2491
3217
|
* (inclusive).
|
|
2492
3218
|
* @format date-time
|
|
3219
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2493
3220
|
*/
|
|
2494
3221
|
'created_date.before'?: string;
|
|
2495
3222
|
/**
|
|
@@ -2512,12 +3239,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2512
3239
|
/**
|
|
2513
3240
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2514
3241
|
* @format date-time
|
|
3242
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2515
3243
|
*/
|
|
2516
3244
|
'modified_date.after'?: string;
|
|
2517
3245
|
/**
|
|
2518
3246
|
* Filters for objects created before the provided timestamp
|
|
2519
3247
|
* (inclusive).
|
|
2520
3248
|
* @format date-time
|
|
3249
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2521
3250
|
*/
|
|
2522
3251
|
'modified_date.before'?: string;
|
|
2523
3252
|
/**
|
|
@@ -2526,6 +3255,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2526
3255
|
*/
|
|
2527
3256
|
sort_by?: string[];
|
|
2528
3257
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
3258
|
+
/**
|
|
3259
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3260
|
+
*
|
|
3261
|
+
* @tags rev-orgs
|
|
3262
|
+
* @name RevOrgsListPost
|
|
3263
|
+
* @request POST:/rev-orgs.list
|
|
3264
|
+
* @secure
|
|
3265
|
+
*/
|
|
3266
|
+
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
2529
3267
|
/**
|
|
2530
3268
|
* @description Updates the Rev organization's information.
|
|
2531
3269
|
*
|
|
@@ -2564,10 +3302,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
3302
|
tagsGet: (query: {
|
|
2565
3303
|
/**
|
|
2566
3304
|
* The requested tag's ID.
|
|
2567
|
-
* @example "
|
|
3305
|
+
* @example "TAG-12345"
|
|
2568
3306
|
*/
|
|
2569
3307
|
id: string;
|
|
2570
3308
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
3309
|
+
/**
|
|
3310
|
+
* @description Gets a tag's information.
|
|
3311
|
+
*
|
|
3312
|
+
* @tags tags
|
|
3313
|
+
* @name TagsGetPost
|
|
3314
|
+
* @request POST:/tags.get
|
|
3315
|
+
* @secure
|
|
3316
|
+
*/
|
|
3317
|
+
tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
2571
3318
|
/**
|
|
2572
3319
|
* @description Lists the available tags.
|
|
2573
3320
|
*
|
|
@@ -2597,6 +3344,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2597
3344
|
/** Fields to sort tags by and the direction to sort them. */
|
|
2598
3345
|
sort_by?: string[];
|
|
2599
3346
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
3347
|
+
/**
|
|
3348
|
+
* @description Lists the available tags.
|
|
3349
|
+
*
|
|
3350
|
+
* @tags tags
|
|
3351
|
+
* @name TagsListPost
|
|
3352
|
+
* @request POST:/tags.list
|
|
3353
|
+
* @secure
|
|
3354
|
+
*/
|
|
3355
|
+
tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
2600
3356
|
/**
|
|
2601
3357
|
* @description Updates a tag's information.
|
|
2602
3358
|
*
|
|
@@ -2639,6 +3395,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2639
3395
|
*/
|
|
2640
3396
|
id: string;
|
|
2641
3397
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
3398
|
+
/**
|
|
3399
|
+
* @description Gets an entry on an object's timeline.
|
|
3400
|
+
*
|
|
3401
|
+
* @tags timeline-entries
|
|
3402
|
+
* @name TimelineEntriesGetPost
|
|
3403
|
+
* @request POST:/timeline-entries.get
|
|
3404
|
+
* @secure
|
|
3405
|
+
*/
|
|
3406
|
+
timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
2642
3407
|
/**
|
|
2643
3408
|
* @description Lists the timeline entries for an object.
|
|
2644
3409
|
*
|
|
@@ -2650,7 +3415,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2650
3415
|
timelineEntriesList: (query: {
|
|
2651
3416
|
/**
|
|
2652
3417
|
* The ID of the object to list timeline entries for.
|
|
2653
|
-
* @example "
|
|
3418
|
+
* @example "PROD-12345"
|
|
2654
3419
|
*/
|
|
2655
3420
|
object: string;
|
|
2656
3421
|
/**
|
|
@@ -2676,6 +3441,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2676
3441
|
*/
|
|
2677
3442
|
visibility?: TimelineEntryVisibility[];
|
|
2678
3443
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
3444
|
+
/**
|
|
3445
|
+
* @description Lists the timeline entries for an object.
|
|
3446
|
+
*
|
|
3447
|
+
* @tags timeline-entries
|
|
3448
|
+
* @name TimelineEntriesListPost
|
|
3449
|
+
* @request POST:/timeline-entries.list
|
|
3450
|
+
* @secure
|
|
3451
|
+
*/
|
|
3452
|
+
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
2679
3453
|
/**
|
|
2680
3454
|
* @description Updates an entry on an object's timeline.
|
|
2681
3455
|
*
|
|
@@ -2718,6 +3492,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2718
3492
|
*/
|
|
2719
3493
|
id: string;
|
|
2720
3494
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
3495
|
+
/**
|
|
3496
|
+
* @description Gets the requested webhook's information.
|
|
3497
|
+
*
|
|
3498
|
+
* @tags webhooks
|
|
3499
|
+
* @name WebhooksGetPost
|
|
3500
|
+
* @request POST:/webhooks.get
|
|
3501
|
+
* @secure
|
|
3502
|
+
*/
|
|
3503
|
+
webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
2721
3504
|
/**
|
|
2722
3505
|
* @description Lists the webhooks.
|
|
2723
3506
|
*
|
|
@@ -2727,6 +3510,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2727
3510
|
* @secure
|
|
2728
3511
|
*/
|
|
2729
3512
|
webhooksList: (params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
3513
|
+
/**
|
|
3514
|
+
* @description Lists the webhooks.
|
|
3515
|
+
*
|
|
3516
|
+
* @tags webhooks
|
|
3517
|
+
* @name WebhooksListPost
|
|
3518
|
+
* @request POST:/webhooks.list
|
|
3519
|
+
* @secure
|
|
3520
|
+
*/
|
|
3521
|
+
webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
2730
3522
|
/**
|
|
2731
3523
|
* @description Updates the requested webhook.
|
|
2732
3524
|
*
|
|
@@ -2765,12 +3557,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2765
3557
|
worksExport: (query?: {
|
|
2766
3558
|
/**
|
|
2767
3559
|
* Filters for work belonging to any of the provided parts.
|
|
2768
|
-
* @example ["
|
|
3560
|
+
* @example ["PROD-12345"]
|
|
2769
3561
|
*/
|
|
2770
3562
|
applies_to_part?: string[];
|
|
2771
3563
|
/**
|
|
2772
3564
|
* Filters for work created by any of these users.
|
|
2773
|
-
* @example ["
|
|
3565
|
+
* @example ["DEVU-12345"]
|
|
2774
3566
|
*/
|
|
2775
3567
|
created_by?: string[];
|
|
2776
3568
|
/**
|
|
@@ -2783,19 +3575,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2783
3575
|
'issue.priority'?: IssuePriority[];
|
|
2784
3576
|
/**
|
|
2785
3577
|
* Filters for issues with any of the provided Rev organizations.
|
|
2786
|
-
* @example ["
|
|
3578
|
+
* @example ["REV-AbCdEfGh"]
|
|
2787
3579
|
*/
|
|
2788
3580
|
'issue.rev_orgs'?: string[];
|
|
2789
3581
|
/**
|
|
2790
3582
|
* Filters for work owned by any of these users.
|
|
2791
|
-
* @example ["
|
|
3583
|
+
* @example ["DEVU-12345"]
|
|
2792
3584
|
*/
|
|
2793
3585
|
owned_by?: string[];
|
|
2794
3586
|
/** Filters for records in the provided stage(s) by name. */
|
|
2795
3587
|
'stage.name'?: string[];
|
|
2796
3588
|
/**
|
|
2797
3589
|
* Filters for work with any of the provided tags.
|
|
2798
|
-
* @example ["
|
|
3590
|
+
* @example ["TAG-12345"]
|
|
2799
3591
|
*/
|
|
2800
3592
|
tags?: string[];
|
|
2801
3593
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -2807,16 +3599,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2807
3599
|
/**
|
|
2808
3600
|
* Filters for tickets that are associated with any of the provided Rev
|
|
2809
3601
|
* organizations.
|
|
2810
|
-
* @example ["
|
|
3602
|
+
* @example ["REV-AbCdEfGh"]
|
|
2811
3603
|
*/
|
|
2812
3604
|
'ticket.rev_org'?: string[];
|
|
2813
3605
|
/** Filters for tickets with any of the provided severities. */
|
|
2814
3606
|
'ticket.severity'?: TicketSeverity[];
|
|
3607
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
3608
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
2815
3609
|
/** Filters for tickets with any of the provided source channels. */
|
|
2816
3610
|
'ticket.source_channel'?: string[];
|
|
2817
3611
|
/** Filters for work of the provided types. */
|
|
2818
3612
|
type?: WorkType[];
|
|
2819
3613
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
3614
|
+
/**
|
|
3615
|
+
* @description Exports a collection of work items.
|
|
3616
|
+
*
|
|
3617
|
+
* @tags works
|
|
3618
|
+
* @name WorksExportPost
|
|
3619
|
+
* @request POST:/works.export
|
|
3620
|
+
* @secure
|
|
3621
|
+
*/
|
|
3622
|
+
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
2820
3623
|
/**
|
|
2821
3624
|
* @description Gets a work item's information.
|
|
2822
3625
|
*
|
|
@@ -2828,10 +3631,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2828
3631
|
worksGet: (query: {
|
|
2829
3632
|
/**
|
|
2830
3633
|
* The work's ID.
|
|
2831
|
-
* @example "
|
|
3634
|
+
* @example "ISS-12345"
|
|
2832
3635
|
*/
|
|
2833
3636
|
id: string;
|
|
2834
3637
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
3638
|
+
/**
|
|
3639
|
+
* @description Gets a work item's information.
|
|
3640
|
+
*
|
|
3641
|
+
* @tags works
|
|
3642
|
+
* @name WorksGetPost
|
|
3643
|
+
* @request POST:/works.get
|
|
3644
|
+
* @secure
|
|
3645
|
+
*/
|
|
3646
|
+
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
2835
3647
|
/**
|
|
2836
3648
|
* @description Lists a collection of work items.
|
|
2837
3649
|
*
|
|
@@ -2843,12 +3655,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2843
3655
|
worksList: (query?: {
|
|
2844
3656
|
/**
|
|
2845
3657
|
* Filters for work belonging to any of the provided parts.
|
|
2846
|
-
* @example ["
|
|
3658
|
+
* @example ["PROD-12345"]
|
|
2847
3659
|
*/
|
|
2848
3660
|
applies_to_part?: string[];
|
|
2849
3661
|
/**
|
|
2850
3662
|
* Filters for work created by any of these users.
|
|
2851
|
-
* @example ["
|
|
3663
|
+
* @example ["DEVU-12345"]
|
|
2852
3664
|
*/
|
|
2853
3665
|
created_by?: string[];
|
|
2854
3666
|
/**
|
|
@@ -2860,7 +3672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2860
3672
|
'issue.priority'?: IssuePriority[];
|
|
2861
3673
|
/**
|
|
2862
3674
|
* Filters for issues with any of the provided Rev organizations.
|
|
2863
|
-
* @example ["
|
|
3675
|
+
* @example ["REV-AbCdEfGh"]
|
|
2864
3676
|
*/
|
|
2865
3677
|
'issue.rev_orgs'?: string[];
|
|
2866
3678
|
/**
|
|
@@ -2875,14 +3687,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2875
3687
|
mode?: ListMode;
|
|
2876
3688
|
/**
|
|
2877
3689
|
* Filters for work owned by any of these users.
|
|
2878
|
-
* @example ["
|
|
3690
|
+
* @example ["DEVU-12345"]
|
|
2879
3691
|
*/
|
|
2880
3692
|
owned_by?: string[];
|
|
2881
3693
|
/** Filters for records in the provided stage(s) by name. */
|
|
2882
3694
|
'stage.name'?: string[];
|
|
2883
3695
|
/**
|
|
2884
3696
|
* Filters for work with any of the provided tags.
|
|
2885
|
-
* @example ["
|
|
3697
|
+
* @example ["TAG-12345"]
|
|
2886
3698
|
*/
|
|
2887
3699
|
tags?: string[];
|
|
2888
3700
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -2894,16 +3706,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2894
3706
|
/**
|
|
2895
3707
|
* Filters for tickets that are associated with any of the provided Rev
|
|
2896
3708
|
* organizations.
|
|
2897
|
-
* @example ["
|
|
3709
|
+
* @example ["REV-AbCdEfGh"]
|
|
2898
3710
|
*/
|
|
2899
3711
|
'ticket.rev_org'?: string[];
|
|
2900
3712
|
/** Filters for tickets with any of the provided severities. */
|
|
2901
3713
|
'ticket.severity'?: TicketSeverity[];
|
|
3714
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
3715
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
2902
3716
|
/** Filters for tickets with any of the provided source channels. */
|
|
2903
3717
|
'ticket.source_channel'?: string[];
|
|
2904
3718
|
/** Filters for work of the provided types. */
|
|
2905
3719
|
type?: WorkType[];
|
|
2906
3720
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
3721
|
+
/**
|
|
3722
|
+
* @description Lists a collection of work items.
|
|
3723
|
+
*
|
|
3724
|
+
* @tags works
|
|
3725
|
+
* @name WorksListPost
|
|
3726
|
+
* @request POST:/works.list
|
|
3727
|
+
* @secure
|
|
3728
|
+
*/
|
|
3729
|
+
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
2907
3730
|
/**
|
|
2908
3731
|
* @description Updates a work item's information.
|
|
2909
3732
|
*
|