@devrev/typescript-sdk 1.1.15 → 1.1.17
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,22 @@
|
|
|
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
|
+
/**
|
|
14
|
+
* The version of the artifact that needs to be fetched.
|
|
15
|
+
* @format date-time
|
|
16
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
17
|
+
*/
|
|
18
|
+
version?: string;
|
|
19
|
+
}
|
|
3
20
|
/**
|
|
4
21
|
* artifacts-locate-response
|
|
5
22
|
* The response to getting an artifact's download URL.
|
|
@@ -8,6 +25,7 @@ export interface ArtifactsLocateResponse {
|
|
|
8
25
|
/**
|
|
9
26
|
* The expiration timestamp of the URL.
|
|
10
27
|
* @format date-time
|
|
28
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11
29
|
*/
|
|
12
30
|
expires_at?: string;
|
|
13
31
|
/** The artifact's download URL. */
|
|
@@ -30,7 +48,7 @@ export interface ArtifactsPrepareResponse {
|
|
|
30
48
|
form_data: ArtifactsPrepareResponseFormData[];
|
|
31
49
|
/**
|
|
32
50
|
* The generated artifact's ID.
|
|
33
|
-
* @example "
|
|
51
|
+
* @example "ARTIFACT-12345"
|
|
34
52
|
*/
|
|
35
53
|
id: string;
|
|
36
54
|
/** The URL that the file's data should be uploaded to. */
|
|
@@ -49,6 +67,7 @@ export interface AtomBase {
|
|
|
49
67
|
/**
|
|
50
68
|
* Timestamp when the object was created.
|
|
51
69
|
* @format date-time
|
|
70
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
52
71
|
*/
|
|
53
72
|
created_date?: string;
|
|
54
73
|
/** Human-readable object ID unique to the Dev organization. */
|
|
@@ -59,6 +78,7 @@ export interface AtomBase {
|
|
|
59
78
|
/**
|
|
60
79
|
* Timestamp when the object was last modified.
|
|
61
80
|
* @format date-time
|
|
81
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
62
82
|
*/
|
|
63
83
|
modified_date?: string;
|
|
64
84
|
}
|
|
@@ -173,11 +193,13 @@ export type AuthToken = AtomBase & {
|
|
|
173
193
|
/**
|
|
174
194
|
* The time at which the token expires.
|
|
175
195
|
* @format date-time
|
|
196
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
176
197
|
*/
|
|
177
198
|
expires_at?: string;
|
|
178
199
|
/**
|
|
179
200
|
* The time at which the token was issued.
|
|
180
201
|
* @format date-time
|
|
202
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
181
203
|
*/
|
|
182
204
|
issued_at?: string;
|
|
183
205
|
/** The type of the requested token. */
|
|
@@ -320,6 +342,14 @@ export interface AuthTokensDeleteRequest {
|
|
|
320
342
|
*/
|
|
321
343
|
token_id?: string;
|
|
322
344
|
}
|
|
345
|
+
/**
|
|
346
|
+
* auth-tokens-get-request
|
|
347
|
+
* The request to get the token metadata.
|
|
348
|
+
*/
|
|
349
|
+
export interface AuthTokensGetRequest {
|
|
350
|
+
/** The unique identifier of the token under a given Dev organization. */
|
|
351
|
+
token_id: string;
|
|
352
|
+
}
|
|
323
353
|
/**
|
|
324
354
|
* auth-tokens-get-response
|
|
325
355
|
* The response to get the token metadata.
|
|
@@ -327,6 +357,25 @@ export interface AuthTokensDeleteRequest {
|
|
|
327
357
|
export interface AuthTokensGetResponse {
|
|
328
358
|
token: AuthToken;
|
|
329
359
|
}
|
|
360
|
+
/**
|
|
361
|
+
* auth-tokens-list-request
|
|
362
|
+
* A request to list the token metadata.
|
|
363
|
+
*/
|
|
364
|
+
export interface AuthTokensListRequest {
|
|
365
|
+
/**
|
|
366
|
+
* An identifier that represents the application, which requested the
|
|
367
|
+
* token. Only relevant for application access tokens.
|
|
368
|
+
*/
|
|
369
|
+
client_id?: string;
|
|
370
|
+
/** The type of the requested token. */
|
|
371
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
372
|
+
/**
|
|
373
|
+
* The subject associated with the token. In the absence of this
|
|
374
|
+
* parameter, the ID of the authenticated entity is treated as the
|
|
375
|
+
* subject.
|
|
376
|
+
*/
|
|
377
|
+
subject?: string;
|
|
378
|
+
}
|
|
330
379
|
/**
|
|
331
380
|
* auth-tokens-list-response
|
|
332
381
|
* The response to list the token metadata.
|
|
@@ -408,6 +457,69 @@ export interface AuthTokensUserTraits {
|
|
|
408
457
|
export type Capability = PartBase;
|
|
409
458
|
/** capability-summary */
|
|
410
459
|
export type CapabilitySummary = PartBaseSummary;
|
|
460
|
+
/**
|
|
461
|
+
* date-filter
|
|
462
|
+
* Provides ways to specify date ranges on objects.
|
|
463
|
+
*/
|
|
464
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
465
|
+
/** Type of date filter. */
|
|
466
|
+
type: DateFilterType;
|
|
467
|
+
};
|
|
468
|
+
/** Type of date filter. */
|
|
469
|
+
export declare enum DateFilterType {
|
|
470
|
+
Preset = "preset",
|
|
471
|
+
Range = "range"
|
|
472
|
+
}
|
|
473
|
+
/** date-time-filter */
|
|
474
|
+
export interface DateTimeFilter {
|
|
475
|
+
/**
|
|
476
|
+
* Filters for objects created after the provided timestamp
|
|
477
|
+
* (inclusive).
|
|
478
|
+
* @format date-time
|
|
479
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
480
|
+
*/
|
|
481
|
+
after?: string;
|
|
482
|
+
/**
|
|
483
|
+
* Filters for objects created before the provided timestamp
|
|
484
|
+
* (inclusive).
|
|
485
|
+
* @format date-time
|
|
486
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
487
|
+
*/
|
|
488
|
+
before?: string;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* date-time-preset
|
|
492
|
+
* Provides preset types for date filter.
|
|
493
|
+
*/
|
|
494
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
495
|
+
/** Type of date preset. */
|
|
496
|
+
preset_type: DateTimePresetType;
|
|
497
|
+
};
|
|
498
|
+
/** date-time-preset-last-n-days */
|
|
499
|
+
export interface DateTimePresetLastNDays {
|
|
500
|
+
/**
|
|
501
|
+
* The range starts from the current timestamp and continues for the
|
|
502
|
+
* past n days.
|
|
503
|
+
* @min 0
|
|
504
|
+
* @max 4294967295
|
|
505
|
+
*/
|
|
506
|
+
days: number;
|
|
507
|
+
}
|
|
508
|
+
/** date-time-preset-next-n-days */
|
|
509
|
+
export interface DateTimePresetNextNDays {
|
|
510
|
+
/**
|
|
511
|
+
* The range starts from the current timestamp and continues for the
|
|
512
|
+
* next n days.
|
|
513
|
+
* @min 0
|
|
514
|
+
* @max 4294967295
|
|
515
|
+
*/
|
|
516
|
+
days: number;
|
|
517
|
+
}
|
|
518
|
+
/** Type of date preset. */
|
|
519
|
+
export declare enum DateTimePresetType {
|
|
520
|
+
LastNDays = "last_n_days",
|
|
521
|
+
NextNDays = "next_n_days"
|
|
522
|
+
}
|
|
411
523
|
/**
|
|
412
524
|
* dev-org-auth-connections-create-request
|
|
413
525
|
* Request to create a new enterprise authentication connection.
|
|
@@ -458,6 +570,15 @@ export interface DevOrgAuthConnectionsDeleteRequest {
|
|
|
458
570
|
/** ID of the authentication connection to be deleted. */
|
|
459
571
|
id: string;
|
|
460
572
|
}
|
|
573
|
+
/**
|
|
574
|
+
* dev-org-auth-connections-get-request
|
|
575
|
+
* Request to get configuration details of organization's authentication
|
|
576
|
+
* Connection.
|
|
577
|
+
*/
|
|
578
|
+
export interface DevOrgAuthConnectionsGetRequest {
|
|
579
|
+
/** ID of the authentication connection. */
|
|
580
|
+
id: string;
|
|
581
|
+
}
|
|
461
582
|
/**
|
|
462
583
|
* dev-org-auth-connections-get-response
|
|
463
584
|
* Response object encapsulating the configuration details of an
|
|
@@ -545,6 +666,14 @@ export type DevUser = UserBase & {
|
|
|
545
666
|
};
|
|
546
667
|
/** dev-user-summary */
|
|
547
668
|
export type DevUserSummary = UserBaseSummary;
|
|
669
|
+
/**
|
|
670
|
+
* dev-users-get-request
|
|
671
|
+
* A request to get a Dev user's information.
|
|
672
|
+
*/
|
|
673
|
+
export interface DevUsersGetRequest {
|
|
674
|
+
/** User ID of the requested Dev user. */
|
|
675
|
+
id: string;
|
|
676
|
+
}
|
|
548
677
|
/**
|
|
549
678
|
* dev-users-get-response
|
|
550
679
|
* The response to getting the information for the Dev user.
|
|
@@ -552,6 +681,36 @@ export type DevUserSummary = UserBaseSummary;
|
|
|
552
681
|
export interface DevUsersGetResponse {
|
|
553
682
|
dev_user: DevUser;
|
|
554
683
|
}
|
|
684
|
+
/**
|
|
685
|
+
* dev-users-list-request
|
|
686
|
+
* A request to get the list of Dev user's information.
|
|
687
|
+
*/
|
|
688
|
+
export interface DevUsersListRequest {
|
|
689
|
+
/**
|
|
690
|
+
* The cursor to resume iteration from. If not provided, then
|
|
691
|
+
* iteration starts from the beginning.
|
|
692
|
+
*/
|
|
693
|
+
cursor?: string;
|
|
694
|
+
/** Filters Dev users based on email addresses. */
|
|
695
|
+
email?: string[];
|
|
696
|
+
/**
|
|
697
|
+
* The maximum number of Dev users to return. The default is '50'.
|
|
698
|
+
* @format int32
|
|
699
|
+
*/
|
|
700
|
+
limit?: number;
|
|
701
|
+
/**
|
|
702
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
703
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
704
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
705
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
706
|
+
* always be returned in the specified sort-by order.
|
|
707
|
+
*/
|
|
708
|
+
mode?: ListMode;
|
|
709
|
+
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
710
|
+
sort_by?: string[];
|
|
711
|
+
/** Filters Dev users based on state. */
|
|
712
|
+
state?: UserState[];
|
|
713
|
+
}
|
|
555
714
|
/**
|
|
556
715
|
* dev-users-list-response
|
|
557
716
|
* The response to listing the Dev users.
|
|
@@ -570,6 +729,11 @@ export interface DevUsersListResponse {
|
|
|
570
729
|
*/
|
|
571
730
|
prev_cursor?: string;
|
|
572
731
|
}
|
|
732
|
+
/**
|
|
733
|
+
* dev-users-self-request
|
|
734
|
+
* A request to get the authenticated user's information.
|
|
735
|
+
*/
|
|
736
|
+
export type DevUsersSelfRequest = object;
|
|
573
737
|
/**
|
|
574
738
|
* dev-users-self-response
|
|
575
739
|
* The response to getting the information for the authenticated user.
|
|
@@ -580,17 +744,11 @@ export interface DevUsersSelfResponse {
|
|
|
580
744
|
/** empty */
|
|
581
745
|
export type Empty = object;
|
|
582
746
|
/** 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
|
-
};
|
|
747
|
+
export type Enhancement = PartBase;
|
|
590
748
|
/** enhancement-summary */
|
|
591
749
|
export type EnhancementSummary = PartBaseSummary;
|
|
592
750
|
/** error-bad-request */
|
|
593
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
|
|
751
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
|
|
594
752
|
type: ErrorBadRequestType;
|
|
595
753
|
};
|
|
596
754
|
/** error-bad-request-bad-request */
|
|
@@ -609,6 +767,17 @@ export interface ErrorBadRequestInvalidField {
|
|
|
609
767
|
/** The field name that's invalid. */
|
|
610
768
|
field_name: string;
|
|
611
769
|
}
|
|
770
|
+
/** error-bad-request-missing-dependency */
|
|
771
|
+
export interface ErrorBadRequestMissingDependency {
|
|
772
|
+
/** The field on which the value depends. */
|
|
773
|
+
dependent_field_name?: string;
|
|
774
|
+
/** The value which needs to be set of the dependent field. */
|
|
775
|
+
dependent_field_value?: string;
|
|
776
|
+
/** The field whose value was received. */
|
|
777
|
+
provided_field_name?: string;
|
|
778
|
+
/** The value that was received. */
|
|
779
|
+
provided_field_value?: string;
|
|
780
|
+
}
|
|
612
781
|
/** error-bad-request-missing-required-field */
|
|
613
782
|
export interface ErrorBadRequestMissingRequiredField {
|
|
614
783
|
/** The missing field's name. */
|
|
@@ -620,6 +789,7 @@ export declare enum ErrorBadRequestType {
|
|
|
620
789
|
BadRequest = "bad_request",
|
|
621
790
|
InvalidEnumValue = "invalid_enum_value",
|
|
622
791
|
InvalidField = "invalid_field",
|
|
792
|
+
MissingDependency = "missing_dependency",
|
|
623
793
|
MissingRequiredField = "missing_required_field",
|
|
624
794
|
ParseError = "parse_error",
|
|
625
795
|
ValueNotPermitted = "value_not_permitted"
|
|
@@ -710,7 +880,7 @@ export interface EventPartCreated {
|
|
|
710
880
|
export interface EventPartDeleted {
|
|
711
881
|
/**
|
|
712
882
|
* The ID of the part that was deleted.
|
|
713
|
-
* @example "
|
|
883
|
+
* @example "PROD-12345"
|
|
714
884
|
*/
|
|
715
885
|
id: string;
|
|
716
886
|
}
|
|
@@ -726,7 +896,7 @@ export interface EventRevOrgCreated {
|
|
|
726
896
|
export interface EventRevOrgDeleted {
|
|
727
897
|
/**
|
|
728
898
|
* The ID of the Rev organization that was deleted.
|
|
729
|
-
* @example "
|
|
899
|
+
* @example "REV-AbCdEfGh"
|
|
730
900
|
*/
|
|
731
901
|
id: string;
|
|
732
902
|
}
|
|
@@ -755,7 +925,7 @@ export interface EventTagCreated {
|
|
|
755
925
|
export interface EventTagDeleted {
|
|
756
926
|
/**
|
|
757
927
|
* The ID of the tag that was deleted.
|
|
758
|
-
* @example "
|
|
928
|
+
* @example "TAG-12345"
|
|
759
929
|
*/
|
|
760
930
|
id: string;
|
|
761
931
|
}
|
|
@@ -803,7 +973,7 @@ export interface EventWorkCreated {
|
|
|
803
973
|
export interface EventWorkDeleted {
|
|
804
974
|
/**
|
|
805
975
|
* The ID of the work that was deleted.
|
|
806
|
-
* @example "
|
|
976
|
+
* @example "ISS-12345"
|
|
807
977
|
*/
|
|
808
978
|
id: string;
|
|
809
979
|
}
|
|
@@ -868,6 +1038,24 @@ export type OrgSummary = RevOrgSummary & {
|
|
|
868
1038
|
export declare enum OrgType {
|
|
869
1039
|
RevOrg = "rev_org"
|
|
870
1040
|
}
|
|
1041
|
+
/**
|
|
1042
|
+
* parent-part-filter
|
|
1043
|
+
* The filter for specifying parent part.
|
|
1044
|
+
*/
|
|
1045
|
+
export interface ParentPartFilter {
|
|
1046
|
+
/**
|
|
1047
|
+
* Number of levels to fetch the part hierarchy up to.
|
|
1048
|
+
* @format int32
|
|
1049
|
+
* @min 1
|
|
1050
|
+
*/
|
|
1051
|
+
level?: number;
|
|
1052
|
+
/**
|
|
1053
|
+
* Part IDs to fetch the hierarchy for.
|
|
1054
|
+
* @minItems 1
|
|
1055
|
+
* @example ["PROD-12345"]
|
|
1056
|
+
*/
|
|
1057
|
+
parts: string[];
|
|
1058
|
+
}
|
|
871
1059
|
/** part */
|
|
872
1060
|
export type Part = (Capability | Enhancement | Feature | Product) & {
|
|
873
1061
|
type: PartType;
|
|
@@ -904,7 +1092,7 @@ export declare enum PartType {
|
|
|
904
1092
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
905
1093
|
/**
|
|
906
1094
|
* The IDs of the artifacts.
|
|
907
|
-
* @example ["
|
|
1095
|
+
* @example ["ARTIFACT-12345"]
|
|
908
1096
|
*/
|
|
909
1097
|
artifacts?: string[];
|
|
910
1098
|
/** Description of the part. */
|
|
@@ -913,7 +1101,7 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
|
|
|
913
1101
|
name: string;
|
|
914
1102
|
/**
|
|
915
1103
|
* The users that own the part.
|
|
916
|
-
* @example ["
|
|
1104
|
+
* @example ["DEVU-12345"]
|
|
917
1105
|
*/
|
|
918
1106
|
owned_by: string[];
|
|
919
1107
|
type: PartType;
|
|
@@ -923,7 +1111,7 @@ export interface PartsCreateRequestCapability {
|
|
|
923
1111
|
/**
|
|
924
1112
|
* ID of the parent product for the capability.
|
|
925
1113
|
* @maxItems 1
|
|
926
|
-
* @example ["
|
|
1114
|
+
* @example ["PROD-12345"]
|
|
927
1115
|
*/
|
|
928
1116
|
parent_part: string[];
|
|
929
1117
|
}
|
|
@@ -932,21 +1120,29 @@ export interface PartsCreateRequestEnhancement {
|
|
|
932
1120
|
/**
|
|
933
1121
|
* ID of the parent part on which the enhancement is to be created.
|
|
934
1122
|
* @maxItems 1
|
|
935
|
-
* @example ["
|
|
1123
|
+
* @example ["PROD-12345"]
|
|
936
1124
|
*/
|
|
937
1125
|
parent_part: string[];
|
|
938
1126
|
/**
|
|
939
1127
|
* Target close date by which enhancement is expected to be closed.
|
|
940
1128
|
* @format date-time
|
|
1129
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
941
1130
|
*/
|
|
942
1131
|
target_close_date?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Target start date by which enhancement is expected to be started.
|
|
1134
|
+
* Example Date Format: 2000-11-01T01:01:01Z
|
|
1135
|
+
* @format date-time
|
|
1136
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1137
|
+
*/
|
|
1138
|
+
target_start_date?: string;
|
|
943
1139
|
}
|
|
944
1140
|
/** parts-create-request-feature */
|
|
945
1141
|
export interface PartsCreateRequestFeature {
|
|
946
1142
|
/**
|
|
947
1143
|
* ID of the parent capability/feature for the feature.
|
|
948
1144
|
* @maxItems 1
|
|
949
|
-
* @example ["
|
|
1145
|
+
* @example ["PROD-12345"]
|
|
950
1146
|
*/
|
|
951
1147
|
parent_part: string[];
|
|
952
1148
|
}
|
|
@@ -960,16 +1156,61 @@ export interface PartsCreateResponse {
|
|
|
960
1156
|
export interface PartsDeleteRequest {
|
|
961
1157
|
/**
|
|
962
1158
|
* The ID of the part to delete.
|
|
963
|
-
* @example "
|
|
1159
|
+
* @example "PROD-12345"
|
|
964
1160
|
*/
|
|
965
1161
|
id: string;
|
|
966
1162
|
}
|
|
967
1163
|
/** parts-delete-response */
|
|
968
1164
|
export type PartsDeleteResponse = object;
|
|
1165
|
+
/** parts-get-request */
|
|
1166
|
+
export interface PartsGetRequest {
|
|
1167
|
+
/**
|
|
1168
|
+
* The ID of the part to retrieve.
|
|
1169
|
+
* @example "PROD-12345"
|
|
1170
|
+
*/
|
|
1171
|
+
id: string;
|
|
1172
|
+
}
|
|
969
1173
|
/** parts-get-response */
|
|
970
1174
|
export interface PartsGetResponse {
|
|
971
1175
|
part: Part;
|
|
972
1176
|
}
|
|
1177
|
+
/** parts-list-request */
|
|
1178
|
+
export interface PartsListRequest {
|
|
1179
|
+
/**
|
|
1180
|
+
* Filters for parts created by any of these users.
|
|
1181
|
+
* @example ["DEVU-12345"]
|
|
1182
|
+
*/
|
|
1183
|
+
created_by?: string[];
|
|
1184
|
+
/**
|
|
1185
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1186
|
+
* iteration starts from the beginning.
|
|
1187
|
+
*/
|
|
1188
|
+
cursor?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* The maximum number of parts to return. The default is '50'.
|
|
1191
|
+
* @format int32
|
|
1192
|
+
*/
|
|
1193
|
+
limit?: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1196
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1197
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1198
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1199
|
+
* always be returned in the specified sort-by order.
|
|
1200
|
+
*/
|
|
1201
|
+
mode?: ListMode;
|
|
1202
|
+
/** Filters for parts of the provided name(s). */
|
|
1203
|
+
name?: string[];
|
|
1204
|
+
/**
|
|
1205
|
+
* Filters for parts owned by any of these users.
|
|
1206
|
+
* @example ["DEVU-12345"]
|
|
1207
|
+
*/
|
|
1208
|
+
owned_by?: string[];
|
|
1209
|
+
/** The filter for specifying parent part. */
|
|
1210
|
+
parent_part?: ParentPartFilter;
|
|
1211
|
+
/** Filters for parts of the provided type(s). */
|
|
1212
|
+
type?: PartType[];
|
|
1213
|
+
}
|
|
973
1214
|
/** parts-list-response */
|
|
974
1215
|
export interface PartsListResponse {
|
|
975
1216
|
/**
|
|
@@ -992,7 +1233,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
992
1233
|
description?: string;
|
|
993
1234
|
/**
|
|
994
1235
|
* The ID of the part to update.
|
|
995
|
-
* @example "
|
|
1236
|
+
* @example "PROD-12345"
|
|
996
1237
|
*/
|
|
997
1238
|
id: string;
|
|
998
1239
|
/** The updated name of the part. */
|
|
@@ -1004,7 +1245,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
|
|
|
1004
1245
|
export interface PartsUpdateRequestArtifacts {
|
|
1005
1246
|
/**
|
|
1006
1247
|
* Sets the artifacts to the provided IDs.
|
|
1007
|
-
* @example ["
|
|
1248
|
+
* @example ["ARTIFACT-12345"]
|
|
1008
1249
|
*/
|
|
1009
1250
|
set?: string[];
|
|
1010
1251
|
}
|
|
@@ -1015,8 +1256,16 @@ export interface PartsUpdateRequestEnhancement {
|
|
|
1015
1256
|
/**
|
|
1016
1257
|
* Updates the target close date of the enhancement.
|
|
1017
1258
|
* @format date-time
|
|
1259
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1018
1260
|
*/
|
|
1019
1261
|
target_close_date?: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* Updates the target start date of the enhancement. Example Date
|
|
1264
|
+
* Format: 2000-11-01T01:01:01Z
|
|
1265
|
+
* @format date-time
|
|
1266
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1267
|
+
*/
|
|
1268
|
+
target_start_date?: string;
|
|
1020
1269
|
}
|
|
1021
1270
|
/** parts-update-request-feature */
|
|
1022
1271
|
export type PartsUpdateRequestFeature = object;
|
|
@@ -1025,7 +1274,7 @@ export interface PartsUpdateRequestOwnedBy {
|
|
|
1025
1274
|
/**
|
|
1026
1275
|
* Sets the owner IDs to the provided user IDs. This must not be
|
|
1027
1276
|
* empty.
|
|
1028
|
-
* @example ["
|
|
1277
|
+
* @example ["DEVU-12345"]
|
|
1029
1278
|
*/
|
|
1030
1279
|
set?: string[];
|
|
1031
1280
|
}
|
|
@@ -1092,7 +1341,7 @@ export interface RevOrgsCreateResponse {
|
|
|
1092
1341
|
export interface RevOrgsDeleteRequest {
|
|
1093
1342
|
/**
|
|
1094
1343
|
* The ID of Rev organization to delete.
|
|
1095
|
-
* @example "
|
|
1344
|
+
* @example "REV-AbCdEfGh"
|
|
1096
1345
|
*/
|
|
1097
1346
|
id: string;
|
|
1098
1347
|
}
|
|
@@ -1101,6 +1350,23 @@ export interface RevOrgsDeleteRequest {
|
|
|
1101
1350
|
* The response to deleting a Rev organization.
|
|
1102
1351
|
*/
|
|
1103
1352
|
export type RevOrgsDeleteResponse = object;
|
|
1353
|
+
/**
|
|
1354
|
+
* rev-orgs-get-request
|
|
1355
|
+
* Request object to get Rev organization's information.
|
|
1356
|
+
*/
|
|
1357
|
+
export interface RevOrgsGetRequest {
|
|
1358
|
+
/**
|
|
1359
|
+
* The ID of account for which default Rev organization is to be
|
|
1360
|
+
* fetched.
|
|
1361
|
+
* @example "ACC-12345"
|
|
1362
|
+
*/
|
|
1363
|
+
account?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* The ID of the required Rev organization.
|
|
1366
|
+
* @example "REV-AbCdEfGh"
|
|
1367
|
+
*/
|
|
1368
|
+
id?: string;
|
|
1369
|
+
}
|
|
1104
1370
|
/**
|
|
1105
1371
|
* rev-orgs-get-response
|
|
1106
1372
|
* The response to getting a Rev organization's information.
|
|
@@ -1108,6 +1374,42 @@ export type RevOrgsDeleteResponse = object;
|
|
|
1108
1374
|
export interface RevOrgsGetResponse {
|
|
1109
1375
|
rev_org: RevOrg;
|
|
1110
1376
|
}
|
|
1377
|
+
/**
|
|
1378
|
+
* rev-orgs-list-request
|
|
1379
|
+
* A request to get the list of Rev organizations for the authenticated
|
|
1380
|
+
* user's Dev organization.
|
|
1381
|
+
*/
|
|
1382
|
+
export interface RevOrgsListRequest {
|
|
1383
|
+
/** Filters by creator. */
|
|
1384
|
+
created_by?: string[];
|
|
1385
|
+
created_date?: DateTimeFilter;
|
|
1386
|
+
/**
|
|
1387
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1388
|
+
* iteration starts from the beginning.
|
|
1389
|
+
*/
|
|
1390
|
+
cursor?: string;
|
|
1391
|
+
/** List of external refs to filter Rev organizations for. */
|
|
1392
|
+
external_ref?: string[];
|
|
1393
|
+
/**
|
|
1394
|
+
* The maximum number of Rev organizations to be retrieved per page.
|
|
1395
|
+
* @format int32
|
|
1396
|
+
*/
|
|
1397
|
+
limit?: number;
|
|
1398
|
+
/**
|
|
1399
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1400
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1401
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1402
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1403
|
+
* always be returned in the specified sort-by order.
|
|
1404
|
+
*/
|
|
1405
|
+
mode?: ListMode;
|
|
1406
|
+
modified_date?: DateTimeFilter;
|
|
1407
|
+
/**
|
|
1408
|
+
* Fields to sort the Rev organizations by and the direction to sort
|
|
1409
|
+
* them.
|
|
1410
|
+
*/
|
|
1411
|
+
sort_by?: string[];
|
|
1412
|
+
}
|
|
1111
1413
|
/**
|
|
1112
1414
|
* rev-orgs-list-response
|
|
1113
1415
|
* The response to getting a list of Rev organizations' information.
|
|
@@ -1147,7 +1449,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
1147
1449
|
external_ref?: string;
|
|
1148
1450
|
/**
|
|
1149
1451
|
* The ID of Rev organization to update.
|
|
1150
|
-
* @example "
|
|
1452
|
+
* @example "REV-AbCdEfGh"
|
|
1151
1453
|
*/
|
|
1152
1454
|
id: string;
|
|
1153
1455
|
/** The tier of the RevOrg. */
|
|
@@ -1190,7 +1492,7 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
1190
1492
|
export interface SetTagWithValue {
|
|
1191
1493
|
/**
|
|
1192
1494
|
* The ID of the tag.
|
|
1193
|
-
* @example "
|
|
1495
|
+
* @example "TAG-12345"
|
|
1194
1496
|
*/
|
|
1195
1497
|
id: string;
|
|
1196
1498
|
/**
|
|
@@ -1199,6 +1501,11 @@ export interface SetTagWithValue {
|
|
|
1199
1501
|
*/
|
|
1200
1502
|
value?: string;
|
|
1201
1503
|
}
|
|
1504
|
+
/**
|
|
1505
|
+
* sla-summary-filter
|
|
1506
|
+
* The filter for SLA summary.
|
|
1507
|
+
*/
|
|
1508
|
+
export type SlaSummaryFilter = object;
|
|
1202
1509
|
/**
|
|
1203
1510
|
* stage
|
|
1204
1511
|
* Describes the current stage of a work item.
|
|
@@ -1207,6 +1514,14 @@ export interface Stage {
|
|
|
1207
1514
|
/** Current stage name of the work item. */
|
|
1208
1515
|
name: string;
|
|
1209
1516
|
}
|
|
1517
|
+
/**
|
|
1518
|
+
* stage-filter
|
|
1519
|
+
* The filter for stages.
|
|
1520
|
+
*/
|
|
1521
|
+
export interface StageFilter {
|
|
1522
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
1523
|
+
name?: string[];
|
|
1524
|
+
}
|
|
1210
1525
|
/**
|
|
1211
1526
|
* stage-init
|
|
1212
1527
|
* Sets an object's initial stage.
|
|
@@ -1223,6 +1538,11 @@ export interface StageUpdate {
|
|
|
1223
1538
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
1224
1539
|
name?: string;
|
|
1225
1540
|
}
|
|
1541
|
+
/**
|
|
1542
|
+
* survey-aggregation-filter
|
|
1543
|
+
* The filter for survey aggregation.
|
|
1544
|
+
*/
|
|
1545
|
+
export type SurveyAggregationFilter = object;
|
|
1226
1546
|
/** sys-user-summary */
|
|
1227
1547
|
export type SysUserSummary = UserBaseSummary;
|
|
1228
1548
|
/** tag */
|
|
@@ -1289,7 +1609,7 @@ export interface TagsCreateResponse {
|
|
|
1289
1609
|
export interface TagsDeleteRequest {
|
|
1290
1610
|
/**
|
|
1291
1611
|
* The ID of the tag to delete.
|
|
1292
|
-
* @example "
|
|
1612
|
+
* @example "TAG-12345"
|
|
1293
1613
|
*/
|
|
1294
1614
|
id: string;
|
|
1295
1615
|
}
|
|
@@ -1298,6 +1618,17 @@ export interface TagsDeleteRequest {
|
|
|
1298
1618
|
* The response for deleting a tag.
|
|
1299
1619
|
*/
|
|
1300
1620
|
export type TagsDeleteResponse = object;
|
|
1621
|
+
/**
|
|
1622
|
+
* tags-get-request
|
|
1623
|
+
* The request to get a tag's information.
|
|
1624
|
+
*/
|
|
1625
|
+
export interface TagsGetRequest {
|
|
1626
|
+
/**
|
|
1627
|
+
* The requested tag's ID.
|
|
1628
|
+
* @example "TAG-12345"
|
|
1629
|
+
*/
|
|
1630
|
+
id: string;
|
|
1631
|
+
}
|
|
1301
1632
|
/**
|
|
1302
1633
|
* tags-get-response
|
|
1303
1634
|
* The response to getting a tag's information.
|
|
@@ -1305,6 +1636,34 @@ export type TagsDeleteResponse = object;
|
|
|
1305
1636
|
export interface TagsGetResponse {
|
|
1306
1637
|
tag: Tag;
|
|
1307
1638
|
}
|
|
1639
|
+
/**
|
|
1640
|
+
* tags-list-request
|
|
1641
|
+
* The request to get information about a list of tags.
|
|
1642
|
+
*/
|
|
1643
|
+
export interface TagsListRequest {
|
|
1644
|
+
/**
|
|
1645
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1646
|
+
* iteration starts from the beginning.
|
|
1647
|
+
*/
|
|
1648
|
+
cursor?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* The maximum number of tags to return. The default is '50'.
|
|
1651
|
+
* @format int32
|
|
1652
|
+
*/
|
|
1653
|
+
limit?: number;
|
|
1654
|
+
/**
|
|
1655
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1656
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1657
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1658
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1659
|
+
* always be returned in the specified sort-by order.
|
|
1660
|
+
*/
|
|
1661
|
+
mode?: ListMode;
|
|
1662
|
+
/** Filters for tags with the provided names. */
|
|
1663
|
+
name?: string[];
|
|
1664
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
1665
|
+
sort_by?: string[];
|
|
1666
|
+
}
|
|
1308
1667
|
/**
|
|
1309
1668
|
* tags-list-response
|
|
1310
1669
|
* The response to listing the tags.
|
|
@@ -1342,7 +1701,7 @@ export interface TagsUpdateRequest {
|
|
|
1342
1701
|
description?: string;
|
|
1343
1702
|
/**
|
|
1344
1703
|
* The ID of the tag to update.
|
|
1345
|
-
* @example "
|
|
1704
|
+
* @example "TAG-12345"
|
|
1346
1705
|
*/
|
|
1347
1706
|
id: string;
|
|
1348
1707
|
/**
|
|
@@ -1401,18 +1760,19 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1401
1760
|
* provided time. The minimum value should be at least a minute more
|
|
1402
1761
|
* than the current timestamp.
|
|
1403
1762
|
* @format date-time
|
|
1763
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1404
1764
|
*/
|
|
1405
1765
|
expires_at?: string;
|
|
1406
1766
|
/**
|
|
1407
1767
|
* The ID of the object to create the timeline entry for.
|
|
1408
|
-
* @example "
|
|
1768
|
+
* @example "PROD-12345"
|
|
1409
1769
|
*/
|
|
1410
1770
|
object: string;
|
|
1411
1771
|
/**
|
|
1412
1772
|
* If the visibility of the entry is private, this specifies the users
|
|
1413
1773
|
* that the entry is private to. Note the creator is always implicitly
|
|
1414
1774
|
* included in this list.
|
|
1415
|
-
* @example ["
|
|
1775
|
+
* @example ["DEVU-12345"]
|
|
1416
1776
|
*/
|
|
1417
1777
|
private_to?: string[];
|
|
1418
1778
|
type: TimelineEntriesCreateRequestType;
|
|
@@ -1429,7 +1789,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1429
1789
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
1430
1790
|
/**
|
|
1431
1791
|
* The IDs of the artifacts attached to the comment.
|
|
1432
|
-
* @example ["
|
|
1792
|
+
* @example ["ARTIFACT-12345"]
|
|
1433
1793
|
*/
|
|
1434
1794
|
artifacts?: string[];
|
|
1435
1795
|
/** The comment's body. */
|
|
@@ -1465,6 +1825,17 @@ export interface TimelineEntriesDeleteRequest {
|
|
|
1465
1825
|
* The response to deleting a timeline entry from an object.
|
|
1466
1826
|
*/
|
|
1467
1827
|
export type TimelineEntriesDeleteResponse = object;
|
|
1828
|
+
/**
|
|
1829
|
+
* timeline-entries-get-request
|
|
1830
|
+
* The request to get a timeline entry.
|
|
1831
|
+
*/
|
|
1832
|
+
export interface TimelineEntriesGetRequest {
|
|
1833
|
+
/**
|
|
1834
|
+
* The ID of the timeline entry to get.
|
|
1835
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
1836
|
+
*/
|
|
1837
|
+
id: string;
|
|
1838
|
+
}
|
|
1468
1839
|
/**
|
|
1469
1840
|
* timeline-entries-get-response
|
|
1470
1841
|
* The request to getting a timeline entry.
|
|
@@ -1472,6 +1843,42 @@ export type TimelineEntriesDeleteResponse = object;
|
|
|
1472
1843
|
export interface TimelineEntriesGetResponse {
|
|
1473
1844
|
timeline_entry: TimelineEntry;
|
|
1474
1845
|
}
|
|
1846
|
+
/**
|
|
1847
|
+
* timeline-entries-list-request
|
|
1848
|
+
* The request to list timeline entries for an object.
|
|
1849
|
+
*/
|
|
1850
|
+
export interface TimelineEntriesListRequest {
|
|
1851
|
+
/**
|
|
1852
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1853
|
+
* iteration starts from the beginning.
|
|
1854
|
+
*/
|
|
1855
|
+
cursor?: string;
|
|
1856
|
+
/**
|
|
1857
|
+
* The maximum number of entries to return. If not set, then this
|
|
1858
|
+
* defaults to `50`.
|
|
1859
|
+
* @format int32
|
|
1860
|
+
*/
|
|
1861
|
+
limit?: number;
|
|
1862
|
+
/**
|
|
1863
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1864
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1865
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1866
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1867
|
+
* always be returned in the specified sort-by order.
|
|
1868
|
+
*/
|
|
1869
|
+
mode?: ListMode;
|
|
1870
|
+
/**
|
|
1871
|
+
* The ID of the object to list timeline entries for.
|
|
1872
|
+
* @example "PROD-12345"
|
|
1873
|
+
*/
|
|
1874
|
+
object: string;
|
|
1875
|
+
/**
|
|
1876
|
+
* The visibility of the timeline entries to filter for. Note this is
|
|
1877
|
+
* a strict filter, such that only entries with the exact visibilities
|
|
1878
|
+
* specified will be returned.
|
|
1879
|
+
*/
|
|
1880
|
+
visibility?: TimelineEntryVisibility[];
|
|
1881
|
+
}
|
|
1475
1882
|
/**
|
|
1476
1883
|
* timeline-entries-list-response
|
|
1477
1884
|
* The response to listing timeline entries for an object.
|
|
@@ -1518,18 +1925,18 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
1518
1925
|
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
1519
1926
|
* added more than once, i.e. nothing is done if the artifact is
|
|
1520
1927
|
* already attached. Mutually exclusive with `set`.
|
|
1521
|
-
* @example ["
|
|
1928
|
+
* @example ["ARTIFACT-12345"]
|
|
1522
1929
|
*/
|
|
1523
1930
|
add?: string[];
|
|
1524
1931
|
/**
|
|
1525
1932
|
* Removes the provided artifacts from the comment. If an artifact is
|
|
1526
1933
|
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
1527
|
-
* @example ["
|
|
1934
|
+
* @example ["ARTIFACT-12345"]
|
|
1528
1935
|
*/
|
|
1529
1936
|
remove?: string[];
|
|
1530
1937
|
/**
|
|
1531
1938
|
* Sets the field to the provided artifacts.
|
|
1532
|
-
* @example ["
|
|
1939
|
+
* @example ["ARTIFACT-12345"]
|
|
1533
1940
|
*/
|
|
1534
1941
|
set?: string[];
|
|
1535
1942
|
}
|
|
@@ -1691,6 +2098,7 @@ export interface WebhookEventRequest {
|
|
|
1691
2098
|
* should only be processed if the timestamp isn't stale by several
|
|
1692
2099
|
* seconds.
|
|
1693
2100
|
* @format date-time
|
|
2101
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1694
2102
|
*/
|
|
1695
2103
|
timestamp?: string;
|
|
1696
2104
|
/** The event types that the webhook will receive. */
|
|
@@ -1797,6 +2205,17 @@ export interface WebhooksDeleteRequest {
|
|
|
1797
2205
|
* The response to deleting the webhook.
|
|
1798
2206
|
*/
|
|
1799
2207
|
export type WebhooksDeleteResponse = object;
|
|
2208
|
+
/**
|
|
2209
|
+
* webhooks-get-request
|
|
2210
|
+
* The request to get a webhook's information.
|
|
2211
|
+
*/
|
|
2212
|
+
export interface WebhooksGetRequest {
|
|
2213
|
+
/**
|
|
2214
|
+
* ID for the webhook.
|
|
2215
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
2216
|
+
*/
|
|
2217
|
+
id: string;
|
|
2218
|
+
}
|
|
1800
2219
|
/**
|
|
1801
2220
|
* webhooks-get-response
|
|
1802
2221
|
* The response to getting the information for the webhook.
|
|
@@ -1804,6 +2223,11 @@ export type WebhooksDeleteResponse = object;
|
|
|
1804
2223
|
export interface WebhooksGetResponse {
|
|
1805
2224
|
webhook: Webhook;
|
|
1806
2225
|
}
|
|
2226
|
+
/**
|
|
2227
|
+
* webhooks-list-request
|
|
2228
|
+
* The request to list the webhooks.
|
|
2229
|
+
*/
|
|
2230
|
+
export type WebhooksListRequest = object;
|
|
1807
2231
|
/**
|
|
1808
2232
|
* webhooks-list-response
|
|
1809
2233
|
* The response to listing the webhooks.
|
|
@@ -1896,6 +2320,7 @@ export type WorkBase = AtomBase & {
|
|
|
1896
2320
|
/**
|
|
1897
2321
|
* Timestamp when the work is expected to be complete.
|
|
1898
2322
|
* @format date-time
|
|
2323
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1899
2324
|
*/
|
|
1900
2325
|
target_close_date?: string;
|
|
1901
2326
|
/** Title of the work object. */
|
|
@@ -1911,24 +2336,24 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
1911
2336
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
1912
2337
|
* applies to. Specifying a part is required when creating tickets and
|
|
1913
2338
|
* issues.
|
|
1914
|
-
* @example "
|
|
2339
|
+
* @example "PROD-12345"
|
|
1915
2340
|
*/
|
|
1916
2341
|
applies_to_part: string;
|
|
1917
2342
|
/**
|
|
1918
2343
|
* The IDs of the artifacts to associate with the work item.
|
|
1919
|
-
* @example ["
|
|
2344
|
+
* @example ["ARTIFACT-12345"]
|
|
1920
2345
|
*/
|
|
1921
2346
|
artifacts?: string[];
|
|
1922
2347
|
/** Body of the work object. */
|
|
1923
2348
|
body?: string;
|
|
1924
2349
|
/**
|
|
1925
2350
|
* The users that own the work.
|
|
1926
|
-
* @example ["
|
|
2351
|
+
* @example ["DEVU-12345"]
|
|
1927
2352
|
*/
|
|
1928
2353
|
owned_by: string[];
|
|
1929
2354
|
/**
|
|
1930
2355
|
* The users that reported the work.
|
|
1931
|
-
* @example ["
|
|
2356
|
+
* @example ["DEVU-12345"]
|
|
1932
2357
|
*/
|
|
1933
2358
|
reported_by?: string[];
|
|
1934
2359
|
/** Sets an object's initial stage. */
|
|
@@ -1938,6 +2363,7 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
1938
2363
|
/**
|
|
1939
2364
|
* Timestamp for when the work is expected to be complete.
|
|
1940
2365
|
* @format date-time
|
|
2366
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1941
2367
|
*/
|
|
1942
2368
|
target_close_date?: string;
|
|
1943
2369
|
/** Title of the work object. */
|
|
@@ -1959,7 +2385,7 @@ export interface WorksCreateRequestTicket {
|
|
|
1959
2385
|
is_spam?: boolean;
|
|
1960
2386
|
/**
|
|
1961
2387
|
* The Rev organization that the ticket is associated with.
|
|
1962
|
-
* @example "
|
|
2388
|
+
* @example "REV-AbCdEfGh"
|
|
1963
2389
|
*/
|
|
1964
2390
|
rev_org?: string;
|
|
1965
2391
|
/** Severity of the ticket. */
|
|
@@ -1975,21 +2401,160 @@ export interface WorksCreateResponse {
|
|
|
1975
2401
|
export interface WorksDeleteRequest {
|
|
1976
2402
|
/**
|
|
1977
2403
|
* The work's ID.
|
|
1978
|
-
* @example "
|
|
2404
|
+
* @example "ISS-12345"
|
|
1979
2405
|
*/
|
|
1980
2406
|
id: string;
|
|
1981
2407
|
}
|
|
1982
2408
|
/** works-delete-response */
|
|
1983
2409
|
export type WorksDeleteResponse = object;
|
|
2410
|
+
/** works-export-request */
|
|
2411
|
+
export interface WorksExportRequest {
|
|
2412
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2413
|
+
actual_close_date?: DateFilter;
|
|
2414
|
+
/**
|
|
2415
|
+
* Filters for work belonging to any of the provided parts.
|
|
2416
|
+
* @example ["PROD-12345"]
|
|
2417
|
+
*/
|
|
2418
|
+
applies_to_part?: string[];
|
|
2419
|
+
/**
|
|
2420
|
+
* Filters for work created by any of these users.
|
|
2421
|
+
* @example ["DEVU-12345"]
|
|
2422
|
+
*/
|
|
2423
|
+
created_by?: string[];
|
|
2424
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2425
|
+
created_date?: DateFilter;
|
|
2426
|
+
/**
|
|
2427
|
+
* The number of work items to return. The default is '50', the
|
|
2428
|
+
* maximum is '5000'.
|
|
2429
|
+
* @format int32
|
|
2430
|
+
*/
|
|
2431
|
+
first?: number;
|
|
2432
|
+
issue?: WorksFilterIssue;
|
|
2433
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2434
|
+
modified_date?: DateFilter;
|
|
2435
|
+
/**
|
|
2436
|
+
* Filters for work owned by any of these users.
|
|
2437
|
+
* @example ["DEVU-12345"]
|
|
2438
|
+
*/
|
|
2439
|
+
owned_by?: string[];
|
|
2440
|
+
/** The filter for stages. */
|
|
2441
|
+
stage?: StageFilter;
|
|
2442
|
+
/**
|
|
2443
|
+
* Filters for work with any of the provided tags.
|
|
2444
|
+
* @example ["TAG-12345"]
|
|
2445
|
+
*/
|
|
2446
|
+
tags?: string[];
|
|
2447
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2448
|
+
target_close_date?: DateFilter;
|
|
2449
|
+
ticket?: WorksFilterTicket;
|
|
2450
|
+
/** Filters for work of the provided types. */
|
|
2451
|
+
type?: WorkType[];
|
|
2452
|
+
}
|
|
1984
2453
|
/** works-export-response */
|
|
1985
2454
|
export interface WorksExportResponse {
|
|
1986
2455
|
/** The resulting collection of work items. */
|
|
1987
2456
|
works: Work[];
|
|
1988
2457
|
}
|
|
2458
|
+
/** works-filter-issue */
|
|
2459
|
+
export interface WorksFilterIssue {
|
|
2460
|
+
/** Filters for issues with any of the provided priorities. */
|
|
2461
|
+
priority?: IssuePriority[];
|
|
2462
|
+
/**
|
|
2463
|
+
* Filters for issues with any of the provided Rev organizations.
|
|
2464
|
+
* @example ["REV-AbCdEfGh"]
|
|
2465
|
+
*/
|
|
2466
|
+
rev_orgs?: string[];
|
|
2467
|
+
}
|
|
2468
|
+
/** works-filter-ticket */
|
|
2469
|
+
export interface WorksFilterTicket {
|
|
2470
|
+
/** Filters for tickets belonging to specific groups. */
|
|
2471
|
+
group?: string[];
|
|
2472
|
+
/** Filters for tickets that are spam. */
|
|
2473
|
+
is_spam?: boolean;
|
|
2474
|
+
/** Filters for tickets that need response. */
|
|
2475
|
+
needs_response?: boolean;
|
|
2476
|
+
/**
|
|
2477
|
+
* Filters for tickets that are associated with any of the provided
|
|
2478
|
+
* Rev organizations.
|
|
2479
|
+
* @example ["REV-AbCdEfGh"]
|
|
2480
|
+
*/
|
|
2481
|
+
rev_org?: string[];
|
|
2482
|
+
/** Filters for tickets with any of the provided severities. */
|
|
2483
|
+
severity?: TicketSeverity[];
|
|
2484
|
+
/** The filter for SLA summary. */
|
|
2485
|
+
sla_summary?: SlaSummaryFilter;
|
|
2486
|
+
/** Filters for tickets with any of the provided source channels. */
|
|
2487
|
+
source_channel?: string[];
|
|
2488
|
+
/** The filter for survey aggregation. */
|
|
2489
|
+
surveys?: SurveyAggregationFilter;
|
|
2490
|
+
}
|
|
2491
|
+
/** works-get-request */
|
|
2492
|
+
export interface WorksGetRequest {
|
|
2493
|
+
/**
|
|
2494
|
+
* The work's ID.
|
|
2495
|
+
* @example "ISS-12345"
|
|
2496
|
+
*/
|
|
2497
|
+
id: string;
|
|
2498
|
+
}
|
|
1989
2499
|
/** works-get-response */
|
|
1990
2500
|
export interface WorksGetResponse {
|
|
1991
2501
|
work: Work;
|
|
1992
2502
|
}
|
|
2503
|
+
/** works-list-request */
|
|
2504
|
+
export interface WorksListRequest {
|
|
2505
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2506
|
+
actual_close_date?: DateFilter;
|
|
2507
|
+
/**
|
|
2508
|
+
* Filters for work belonging to any of the provided parts.
|
|
2509
|
+
* @example ["PROD-12345"]
|
|
2510
|
+
*/
|
|
2511
|
+
applies_to_part?: string[];
|
|
2512
|
+
/**
|
|
2513
|
+
* Filters for work created by any of these users.
|
|
2514
|
+
* @example ["DEVU-12345"]
|
|
2515
|
+
*/
|
|
2516
|
+
created_by?: string[];
|
|
2517
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2518
|
+
created_date?: DateFilter;
|
|
2519
|
+
/**
|
|
2520
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2521
|
+
* iteration starts from the beginning.
|
|
2522
|
+
*/
|
|
2523
|
+
cursor?: string;
|
|
2524
|
+
issue?: WorksFilterIssue;
|
|
2525
|
+
/**
|
|
2526
|
+
* The maximum number of works to return. The default is '50'.
|
|
2527
|
+
* @format int32
|
|
2528
|
+
*/
|
|
2529
|
+
limit?: number;
|
|
2530
|
+
/**
|
|
2531
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2532
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2533
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2534
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2535
|
+
* always be returned in the specified sort-by order.
|
|
2536
|
+
*/
|
|
2537
|
+
mode?: ListMode;
|
|
2538
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2539
|
+
modified_date?: DateFilter;
|
|
2540
|
+
/**
|
|
2541
|
+
* Filters for work owned by any of these users.
|
|
2542
|
+
* @example ["DEVU-12345"]
|
|
2543
|
+
*/
|
|
2544
|
+
owned_by?: string[];
|
|
2545
|
+
/** The filter for stages. */
|
|
2546
|
+
stage?: StageFilter;
|
|
2547
|
+
/**
|
|
2548
|
+
* Filters for work with any of the provided tags.
|
|
2549
|
+
* @example ["TAG-12345"]
|
|
2550
|
+
*/
|
|
2551
|
+
tags?: string[];
|
|
2552
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2553
|
+
target_close_date?: DateFilter;
|
|
2554
|
+
ticket?: WorksFilterTicket;
|
|
2555
|
+
/** Filters for work of the provided types. */
|
|
2556
|
+
type?: WorkType[];
|
|
2557
|
+
}
|
|
1993
2558
|
/** works-list-response */
|
|
1994
2559
|
export interface WorksListResponse {
|
|
1995
2560
|
/**
|
|
@@ -2009,7 +2574,7 @@ export interface WorksListResponse {
|
|
|
2009
2574
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
|
|
2010
2575
|
/**
|
|
2011
2576
|
* Updates the part that the work item applies to.
|
|
2012
|
-
* @example "
|
|
2577
|
+
* @example "PROD-12345"
|
|
2013
2578
|
*/
|
|
2014
2579
|
applies_to_part?: string;
|
|
2015
2580
|
artifacts?: WorksUpdateRequestArtifactIds;
|
|
@@ -2017,7 +2582,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2017
2582
|
body?: string;
|
|
2018
2583
|
/**
|
|
2019
2584
|
* The work's ID.
|
|
2020
|
-
* @example "
|
|
2585
|
+
* @example "ISS-12345"
|
|
2021
2586
|
*/
|
|
2022
2587
|
id: string;
|
|
2023
2588
|
owned_by?: WorksUpdateRequestOwnedBy;
|
|
@@ -2028,8 +2593,9 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2028
2593
|
/**
|
|
2029
2594
|
* Updates the timestamp for when the work is expected to be complete.
|
|
2030
2595
|
* @format date-time
|
|
2596
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2031
2597
|
*/
|
|
2032
|
-
target_close_date?: string;
|
|
2598
|
+
target_close_date?: string | null;
|
|
2033
2599
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
2034
2600
|
title?: string;
|
|
2035
2601
|
type?: WorkType;
|
|
@@ -2038,7 +2604,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2038
2604
|
export interface WorksUpdateRequestArtifactIds {
|
|
2039
2605
|
/**
|
|
2040
2606
|
* Sets the IDs to the provided artifact IDs.
|
|
2041
|
-
* @example ["
|
|
2607
|
+
* @example ["ARTIFACT-12345"]
|
|
2042
2608
|
*/
|
|
2043
2609
|
set?: string[];
|
|
2044
2610
|
}
|
|
@@ -2054,7 +2620,7 @@ export interface WorksUpdateRequestOwnedBy {
|
|
|
2054
2620
|
/**
|
|
2055
2621
|
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2056
2622
|
* empty.
|
|
2057
|
-
* @example ["
|
|
2623
|
+
* @example ["DEVU-12345"]
|
|
2058
2624
|
*/
|
|
2059
2625
|
set?: string[];
|
|
2060
2626
|
}
|
|
@@ -2062,7 +2628,7 @@ export interface WorksUpdateRequestOwnedBy {
|
|
|
2062
2628
|
export interface WorksUpdateRequestReportedBy {
|
|
2063
2629
|
/**
|
|
2064
2630
|
* Sets the users that reported the work to the provided user IDs.
|
|
2065
|
-
* @example ["
|
|
2631
|
+
* @example ["DEVU-12345"]
|
|
2066
2632
|
*/
|
|
2067
2633
|
set?: string[];
|
|
2068
2634
|
}
|
|
@@ -2079,7 +2645,7 @@ export interface WorksUpdateRequestTicket {
|
|
|
2079
2645
|
is_spam?: boolean;
|
|
2080
2646
|
/**
|
|
2081
2647
|
* Updates the Rev organization that the ticket is associated with.
|
|
2082
|
-
* @example "
|
|
2648
|
+
* @example "REV-AbCdEfGh"
|
|
2083
2649
|
*/
|
|
2084
2650
|
rev_org?: string | null;
|
|
2085
2651
|
/** Severity of the ticket. */
|
|
@@ -2149,15 +2715,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2149
2715
|
artifactsLocate: (query: {
|
|
2150
2716
|
/**
|
|
2151
2717
|
* The ID of the artifact to get the URL for.
|
|
2152
|
-
* @example "
|
|
2718
|
+
* @example "ARTIFACT-12345"
|
|
2153
2719
|
*/
|
|
2154
2720
|
id: string;
|
|
2155
2721
|
/**
|
|
2156
2722
|
* The version of the artifact that needs to be fetched.
|
|
2157
2723
|
* @format date-time
|
|
2724
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2158
2725
|
*/
|
|
2159
|
-
|
|
2726
|
+
version?: string;
|
|
2160
2727
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2728
|
+
/**
|
|
2729
|
+
* @description Gets the download URL for the artifact.
|
|
2730
|
+
*
|
|
2731
|
+
* @tags artifacts
|
|
2732
|
+
* @name ArtifactsLocatePost
|
|
2733
|
+
* @request POST:/artifacts.locate
|
|
2734
|
+
* @secure
|
|
2735
|
+
*/
|
|
2736
|
+
artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2161
2737
|
/**
|
|
2162
2738
|
* @description Creates an artifact and generates an upload URL for its data.
|
|
2163
2739
|
*
|
|
@@ -2197,6 +2773,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2197
2773
|
/** The unique identifier of the token under a given Dev organization. */
|
|
2198
2774
|
token_id: string;
|
|
2199
2775
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
2776
|
+
/**
|
|
2777
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
2778
|
+
*
|
|
2779
|
+
* @tags auth-tokens
|
|
2780
|
+
* @name AuthTokensGetPost
|
|
2781
|
+
* @request POST:/auth-tokens.get
|
|
2782
|
+
* @secure
|
|
2783
|
+
*/
|
|
2784
|
+
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
2200
2785
|
/**
|
|
2201
2786
|
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
2202
2787
|
*
|
|
@@ -2223,6 +2808,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2223
2808
|
*/
|
|
2224
2809
|
subject?: string;
|
|
2225
2810
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
2811
|
+
/**
|
|
2812
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
2813
|
+
*
|
|
2814
|
+
* @tags auth-tokens
|
|
2815
|
+
* @name AuthTokensListPost
|
|
2816
|
+
* @request POST:/auth-tokens.list
|
|
2817
|
+
* @secure
|
|
2818
|
+
*/
|
|
2819
|
+
authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
2226
2820
|
/**
|
|
2227
2821
|
* @description Revokes all the tokens that matches the given token type created by the authenticated user.
|
|
2228
2822
|
*
|
|
@@ -2271,6 +2865,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2271
2865
|
/** ID of the authentication connection. */
|
|
2272
2866
|
id: string;
|
|
2273
2867
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
2868
|
+
/**
|
|
2869
|
+
* @description Retrieves the details for an authentication connection.
|
|
2870
|
+
*
|
|
2871
|
+
* @tags auth-connection, dev-orgs
|
|
2872
|
+
* @name DevOrgAuthConnectionsGetPost
|
|
2873
|
+
* @request POST:/dev-orgs.auth-connections.get
|
|
2874
|
+
* @secure
|
|
2875
|
+
*/
|
|
2876
|
+
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
2274
2877
|
/**
|
|
2275
2878
|
* @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
2879
|
*
|
|
@@ -2280,6 +2883,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2280
2883
|
* @secure
|
|
2281
2884
|
*/
|
|
2282
2885
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
2886
|
+
/**
|
|
2887
|
+
* @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.
|
|
2888
|
+
*
|
|
2889
|
+
* @tags auth-connection, dev-orgs
|
|
2890
|
+
* @name DevOrgAuthConnectionsListPost
|
|
2891
|
+
* @request POST:/dev-orgs.auth-connections.list
|
|
2892
|
+
* @secure
|
|
2893
|
+
*/
|
|
2894
|
+
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
2283
2895
|
/**
|
|
2284
2896
|
* @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
2897
|
*
|
|
@@ -2310,6 +2922,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2310
2922
|
/** User ID of the requested Dev user. */
|
|
2311
2923
|
id: string;
|
|
2312
2924
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
2925
|
+
/**
|
|
2926
|
+
* @description Gets the requested user's information.
|
|
2927
|
+
*
|
|
2928
|
+
* @tags dev-users
|
|
2929
|
+
* @name DevUsersGetPost
|
|
2930
|
+
* @request POST:/dev-users.get
|
|
2931
|
+
* @secure
|
|
2932
|
+
*/
|
|
2933
|
+
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
2313
2934
|
/**
|
|
2314
2935
|
* @description Lists users within your organization.
|
|
2315
2936
|
*
|
|
@@ -2342,19 +2963,67 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2342
2963
|
state?: UserState[];
|
|
2343
2964
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
2344
2965
|
/**
|
|
2345
|
-
* @description
|
|
2966
|
+
* @description Lists users within your organization.
|
|
2346
2967
|
*
|
|
2347
2968
|
* @tags dev-users
|
|
2348
|
-
* @name
|
|
2349
|
-
* @request GET:/dev-users.
|
|
2350
|
-
* @secure
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2969
|
+
* @name DevUsersList
|
|
2970
|
+
* @request GET:/dev-users.list
|
|
2971
|
+
* @secure */
|
|
2972
|
+
devUsersListPaginator(query?: {
|
|
2973
|
+
/**
|
|
2974
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
2975
|
+
* starts from the beginning.
|
|
2976
|
+
*/
|
|
2977
|
+
cursor?: string;
|
|
2978
|
+
/** Filters Dev users based on email addresses. */
|
|
2979
|
+
email?: string[];
|
|
2980
|
+
/**
|
|
2981
|
+
* The maximum number of Dev users to return. The default is '50'.
|
|
2982
|
+
* @format int32
|
|
2983
|
+
*/
|
|
2984
|
+
limit?: number;
|
|
2985
|
+
/**
|
|
2986
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
2987
|
+
* used.
|
|
2988
|
+
*/
|
|
2989
|
+
mode?: ListMode;
|
|
2990
|
+
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
2991
|
+
sort_by?: string[];
|
|
2992
|
+
/** Filters Dev users based on state. */
|
|
2993
|
+
state?: UserState[];
|
|
2994
|
+
}, params?: RequestParams): AsyncGenerator<DevUsersListResponse, void, unknown>;
|
|
2995
|
+
/**
|
|
2996
|
+
* @description Lists users within your organization.
|
|
2997
|
+
*
|
|
2998
|
+
* @tags dev-users
|
|
2999
|
+
* @name DevUsersListPost
|
|
3000
|
+
* @request POST:/dev-users.list
|
|
3001
|
+
* @secure
|
|
3002
|
+
*/
|
|
3003
|
+
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
3004
|
+
/**
|
|
3005
|
+
* @description Gets the authenticated user's information.
|
|
3006
|
+
*
|
|
3007
|
+
* @tags dev-users
|
|
3008
|
+
* @name DevUsersSelf
|
|
3009
|
+
* @request GET:/dev-users.self
|
|
3010
|
+
* @secure
|
|
3011
|
+
*/
|
|
3012
|
+
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
3013
|
+
/**
|
|
3014
|
+
* @description Gets the authenticated user's information.
|
|
3015
|
+
*
|
|
3016
|
+
* @tags dev-users
|
|
3017
|
+
* @name DevUsersSelfPost
|
|
3018
|
+
* @request POST:/dev-users.self
|
|
3019
|
+
* @secure
|
|
3020
|
+
*/
|
|
3021
|
+
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
3022
|
+
/**
|
|
3023
|
+
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
3024
|
+
*
|
|
3025
|
+
* @tags parts
|
|
3026
|
+
* @name PartsCreate
|
|
2358
3027
|
* @request POST:/parts.create
|
|
2359
3028
|
* @secure
|
|
2360
3029
|
*/
|
|
@@ -2379,10 +3048,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2379
3048
|
partsGet: (query: {
|
|
2380
3049
|
/**
|
|
2381
3050
|
* The ID of the part to retrieve.
|
|
2382
|
-
* @example "
|
|
3051
|
+
* @example "PROD-12345"
|
|
2383
3052
|
*/
|
|
2384
3053
|
id: string;
|
|
2385
3054
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
3055
|
+
/**
|
|
3056
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
3057
|
+
*
|
|
3058
|
+
* @tags parts
|
|
3059
|
+
* @name PartsGetPost
|
|
3060
|
+
* @request POST:/parts.get
|
|
3061
|
+
* @secure
|
|
3062
|
+
*/
|
|
3063
|
+
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
2386
3064
|
/**
|
|
2387
3065
|
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
2388
3066
|
*
|
|
@@ -2394,7 +3072,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2394
3072
|
partsList: (query?: {
|
|
2395
3073
|
/**
|
|
2396
3074
|
* Filters for parts created by any of these users.
|
|
2397
|
-
* @example ["
|
|
3075
|
+
* @example ["DEVU-12345"]
|
|
2398
3076
|
*/
|
|
2399
3077
|
created_by?: string[];
|
|
2400
3078
|
/**
|
|
@@ -2416,12 +3094,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2416
3094
|
name?: string[];
|
|
2417
3095
|
/**
|
|
2418
3096
|
* Filters for parts owned by any of these users.
|
|
2419
|
-
* @example ["
|
|
3097
|
+
* @example ["DEVU-12345"]
|
|
2420
3098
|
*/
|
|
2421
3099
|
owned_by?: string[];
|
|
3100
|
+
/**
|
|
3101
|
+
* Number of levels to fetch the part hierarchy up to.
|
|
3102
|
+
* @format int32
|
|
3103
|
+
* @min 1
|
|
3104
|
+
*/
|
|
3105
|
+
'parent_part.level'?: number;
|
|
3106
|
+
/**
|
|
3107
|
+
* Part IDs to fetch the hierarchy for. Required if any parent_part.*
|
|
3108
|
+
* fields are provided.
|
|
3109
|
+
* @minItems 1
|
|
3110
|
+
* @example ["PROD-12345"]
|
|
3111
|
+
*/
|
|
3112
|
+
'parent_part.parts'?: string[];
|
|
2422
3113
|
/** Filters for parts of the provided type(s). */
|
|
2423
3114
|
type?: PartType[];
|
|
2424
3115
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
3116
|
+
/**
|
|
3117
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
3118
|
+
*
|
|
3119
|
+
* @tags parts
|
|
3120
|
+
* @name PartsList
|
|
3121
|
+
* @request GET:/parts.list
|
|
3122
|
+
* @secure */
|
|
3123
|
+
partsListPaginator(query?: {
|
|
3124
|
+
/**
|
|
3125
|
+
* Filters for parts created by any of these users.
|
|
3126
|
+
* @example ["DEVU-12345"]
|
|
3127
|
+
*/
|
|
3128
|
+
created_by?: string[];
|
|
3129
|
+
/**
|
|
3130
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3131
|
+
* starts from the beginning.
|
|
3132
|
+
*/
|
|
3133
|
+
cursor?: string;
|
|
3134
|
+
/**
|
|
3135
|
+
* The maximum number of parts to return. The default is '50'.
|
|
3136
|
+
* @format int32
|
|
3137
|
+
*/
|
|
3138
|
+
limit?: number;
|
|
3139
|
+
/**
|
|
3140
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3141
|
+
* used.
|
|
3142
|
+
*/
|
|
3143
|
+
mode?: ListMode;
|
|
3144
|
+
/** Filters for parts of the provided name(s). */
|
|
3145
|
+
name?: string[];
|
|
3146
|
+
/**
|
|
3147
|
+
* Filters for parts owned by any of these users.
|
|
3148
|
+
* @example ["DEVU-12345"]
|
|
3149
|
+
*/
|
|
3150
|
+
owned_by?: string[];
|
|
3151
|
+
/**
|
|
3152
|
+
* Number of levels to fetch the part hierarchy up to.
|
|
3153
|
+
* @format int32
|
|
3154
|
+
* @min 1
|
|
3155
|
+
*/
|
|
3156
|
+
'parent_part.level'?: number;
|
|
3157
|
+
/**
|
|
3158
|
+
* Part IDs to fetch the hierarchy for. Required if any parent_part.*
|
|
3159
|
+
* fields are provided.
|
|
3160
|
+
* @minItems 1
|
|
3161
|
+
* @example ["PROD-12345"]
|
|
3162
|
+
*/
|
|
3163
|
+
'parent_part.parts'?: string[];
|
|
3164
|
+
/** Filters for parts of the provided type(s). */
|
|
3165
|
+
type?: PartType[];
|
|
3166
|
+
}, params?: RequestParams): AsyncGenerator<PartsListResponse, void, unknown>;
|
|
3167
|
+
/**
|
|
3168
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
3169
|
+
*
|
|
3170
|
+
* @tags parts
|
|
3171
|
+
* @name PartsListPost
|
|
3172
|
+
* @request POST:/parts.list
|
|
3173
|
+
* @secure
|
|
3174
|
+
*/
|
|
3175
|
+
partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
2425
3176
|
/**
|
|
2426
3177
|
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
2427
3178
|
*
|
|
@@ -2461,15 +3212,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2461
3212
|
/**
|
|
2462
3213
|
* The ID of account for which default Rev organization is to be
|
|
2463
3214
|
* fetched.
|
|
2464
|
-
* @example "
|
|
3215
|
+
* @example "ACC-12345"
|
|
2465
3216
|
*/
|
|
2466
3217
|
account?: string;
|
|
2467
3218
|
/**
|
|
2468
3219
|
* The ID of the required Rev organization.
|
|
2469
|
-
* @example "
|
|
3220
|
+
* @example "REV-AbCdEfGh"
|
|
2470
3221
|
*/
|
|
2471
3222
|
id?: string;
|
|
2472
3223
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
3224
|
+
/**
|
|
3225
|
+
* @description Retrieves the Rev organization's information.
|
|
3226
|
+
*
|
|
3227
|
+
* @tags rev-orgs
|
|
3228
|
+
* @name RevOrgsGetPost
|
|
3229
|
+
* @request POST:/rev-orgs.get
|
|
3230
|
+
* @secure
|
|
3231
|
+
*/
|
|
3232
|
+
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
2473
3233
|
/**
|
|
2474
3234
|
* @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
3235
|
*
|
|
@@ -2484,12 +3244,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2484
3244
|
/**
|
|
2485
3245
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2486
3246
|
* @format date-time
|
|
3247
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2487
3248
|
*/
|
|
2488
3249
|
'created_date.after'?: string;
|
|
2489
3250
|
/**
|
|
2490
3251
|
* Filters for objects created before the provided timestamp
|
|
2491
3252
|
* (inclusive).
|
|
2492
3253
|
* @format date-time
|
|
3254
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2493
3255
|
*/
|
|
2494
3256
|
'created_date.before'?: string;
|
|
2495
3257
|
/**
|
|
@@ -2512,12 +3274,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2512
3274
|
/**
|
|
2513
3275
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2514
3276
|
* @format date-time
|
|
3277
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2515
3278
|
*/
|
|
2516
3279
|
'modified_date.after'?: string;
|
|
2517
3280
|
/**
|
|
2518
3281
|
* Filters for objects created before the provided timestamp
|
|
2519
3282
|
* (inclusive).
|
|
2520
3283
|
* @format date-time
|
|
3284
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2521
3285
|
*/
|
|
2522
3286
|
'modified_date.before'?: string;
|
|
2523
3287
|
/**
|
|
@@ -2526,6 +3290,74 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2526
3290
|
*/
|
|
2527
3291
|
sort_by?: string[];
|
|
2528
3292
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
3293
|
+
/**
|
|
3294
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3295
|
+
*
|
|
3296
|
+
* @tags rev-orgs
|
|
3297
|
+
* @name RevOrgsList
|
|
3298
|
+
* @request GET:/rev-orgs.list
|
|
3299
|
+
* @secure */
|
|
3300
|
+
revOrgsListPaginator(query?: {
|
|
3301
|
+
/** Filters by creator. */
|
|
3302
|
+
created_by?: string[];
|
|
3303
|
+
/**
|
|
3304
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3305
|
+
* @format date-time
|
|
3306
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3307
|
+
*/
|
|
3308
|
+
'created_date.after'?: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* Filters for objects created before the provided timestamp
|
|
3311
|
+
* (inclusive).
|
|
3312
|
+
* @format date-time
|
|
3313
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3314
|
+
*/
|
|
3315
|
+
'created_date.before'?: string;
|
|
3316
|
+
/**
|
|
3317
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3318
|
+
* starts from the beginning.
|
|
3319
|
+
*/
|
|
3320
|
+
cursor?: string;
|
|
3321
|
+
/** List of external refs to filter Rev organizations for. */
|
|
3322
|
+
external_ref?: string[];
|
|
3323
|
+
/**
|
|
3324
|
+
* The maximum number of Rev organizations to be retrieved per page.
|
|
3325
|
+
* @format int32
|
|
3326
|
+
*/
|
|
3327
|
+
limit?: number;
|
|
3328
|
+
/**
|
|
3329
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3330
|
+
* used.
|
|
3331
|
+
*/
|
|
3332
|
+
mode?: ListMode;
|
|
3333
|
+
/**
|
|
3334
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3335
|
+
* @format date-time
|
|
3336
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3337
|
+
*/
|
|
3338
|
+
'modified_date.after'?: string;
|
|
3339
|
+
/**
|
|
3340
|
+
* Filters for objects created before the provided timestamp
|
|
3341
|
+
* (inclusive).
|
|
3342
|
+
* @format date-time
|
|
3343
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3344
|
+
*/
|
|
3345
|
+
'modified_date.before'?: string;
|
|
3346
|
+
/**
|
|
3347
|
+
* Fields to sort the Rev organizations by and the direction to sort
|
|
3348
|
+
* them.
|
|
3349
|
+
*/
|
|
3350
|
+
sort_by?: string[];
|
|
3351
|
+
}, params?: RequestParams): AsyncGenerator<RevOrgsListResponse, void, unknown>;
|
|
3352
|
+
/**
|
|
3353
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3354
|
+
*
|
|
3355
|
+
* @tags rev-orgs
|
|
3356
|
+
* @name RevOrgsListPost
|
|
3357
|
+
* @request POST:/rev-orgs.list
|
|
3358
|
+
* @secure
|
|
3359
|
+
*/
|
|
3360
|
+
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
2529
3361
|
/**
|
|
2530
3362
|
* @description Updates the Rev organization's information.
|
|
2531
3363
|
*
|
|
@@ -2564,10 +3396,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2564
3396
|
tagsGet: (query: {
|
|
2565
3397
|
/**
|
|
2566
3398
|
* The requested tag's ID.
|
|
2567
|
-
* @example "
|
|
3399
|
+
* @example "TAG-12345"
|
|
2568
3400
|
*/
|
|
2569
3401
|
id: string;
|
|
2570
3402
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
3403
|
+
/**
|
|
3404
|
+
* @description Gets a tag's information.
|
|
3405
|
+
*
|
|
3406
|
+
* @tags tags
|
|
3407
|
+
* @name TagsGetPost
|
|
3408
|
+
* @request POST:/tags.get
|
|
3409
|
+
* @secure
|
|
3410
|
+
*/
|
|
3411
|
+
tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
2571
3412
|
/**
|
|
2572
3413
|
* @description Lists the available tags.
|
|
2573
3414
|
*
|
|
@@ -2592,7 +3433,48 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2592
3433
|
* used.
|
|
2593
3434
|
*/
|
|
2594
3435
|
mode?: ListMode;
|
|
3436
|
+
/** Filters for tags with the provided names. */
|
|
3437
|
+
name?: string[];
|
|
3438
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
3439
|
+
sort_by?: string[];
|
|
2595
3440
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
3441
|
+
/**
|
|
3442
|
+
* @description Lists the available tags.
|
|
3443
|
+
*
|
|
3444
|
+
* @tags tags
|
|
3445
|
+
* @name TagsList
|
|
3446
|
+
* @request GET:/tags.list
|
|
3447
|
+
* @secure */
|
|
3448
|
+
tagsListPaginator(query?: {
|
|
3449
|
+
/**
|
|
3450
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3451
|
+
* starts from the beginning.
|
|
3452
|
+
*/
|
|
3453
|
+
cursor?: string;
|
|
3454
|
+
/**
|
|
3455
|
+
* The maximum number of tags to return. The default is '50'.
|
|
3456
|
+
* @format int32
|
|
3457
|
+
*/
|
|
3458
|
+
limit?: number;
|
|
3459
|
+
/**
|
|
3460
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3461
|
+
* used.
|
|
3462
|
+
*/
|
|
3463
|
+
mode?: ListMode;
|
|
3464
|
+
/** Filters for tags with the provided names. */
|
|
3465
|
+
name?: string[];
|
|
3466
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
3467
|
+
sort_by?: string[];
|
|
3468
|
+
}, params?: RequestParams): AsyncGenerator<TagsListResponse, void, unknown>;
|
|
3469
|
+
/**
|
|
3470
|
+
* @description Lists the available tags.
|
|
3471
|
+
*
|
|
3472
|
+
* @tags tags
|
|
3473
|
+
* @name TagsListPost
|
|
3474
|
+
* @request POST:/tags.list
|
|
3475
|
+
* @secure
|
|
3476
|
+
*/
|
|
3477
|
+
tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
2596
3478
|
/**
|
|
2597
3479
|
* @description Updates a tag's information.
|
|
2598
3480
|
*
|
|
@@ -2635,6 +3517,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2635
3517
|
*/
|
|
2636
3518
|
id: string;
|
|
2637
3519
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
3520
|
+
/**
|
|
3521
|
+
* @description Gets an entry on an object's timeline.
|
|
3522
|
+
*
|
|
3523
|
+
* @tags timeline-entries
|
|
3524
|
+
* @name TimelineEntriesGetPost
|
|
3525
|
+
* @request POST:/timeline-entries.get
|
|
3526
|
+
* @secure
|
|
3527
|
+
*/
|
|
3528
|
+
timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
2638
3529
|
/**
|
|
2639
3530
|
* @description Lists the timeline entries for an object.
|
|
2640
3531
|
*
|
|
@@ -2646,7 +3537,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2646
3537
|
timelineEntriesList: (query: {
|
|
2647
3538
|
/**
|
|
2648
3539
|
* The ID of the object to list timeline entries for.
|
|
2649
|
-
* @example "
|
|
3540
|
+
* @example "PROD-12345"
|
|
2650
3541
|
*/
|
|
2651
3542
|
object: string;
|
|
2652
3543
|
/**
|
|
@@ -2672,6 +3563,51 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2672
3563
|
*/
|
|
2673
3564
|
visibility?: TimelineEntryVisibility[];
|
|
2674
3565
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
3566
|
+
/**
|
|
3567
|
+
* @description Lists the timeline entries for an object.
|
|
3568
|
+
*
|
|
3569
|
+
* @tags timeline-entries
|
|
3570
|
+
* @name TimelineEntriesList
|
|
3571
|
+
* @request GET:/timeline-entries.list
|
|
3572
|
+
* @secure */
|
|
3573
|
+
timelineEntriesListPaginator(query: {
|
|
3574
|
+
/**
|
|
3575
|
+
* The ID of the object to list timeline entries for.
|
|
3576
|
+
* @example "PROD-12345"
|
|
3577
|
+
*/
|
|
3578
|
+
object: string;
|
|
3579
|
+
/**
|
|
3580
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3581
|
+
* starts from the beginning.
|
|
3582
|
+
*/
|
|
3583
|
+
cursor?: string;
|
|
3584
|
+
/**
|
|
3585
|
+
* The maximum number of entries to return. If not set, then this
|
|
3586
|
+
* defaults to `50`.
|
|
3587
|
+
* @format int32
|
|
3588
|
+
*/
|
|
3589
|
+
limit?: number;
|
|
3590
|
+
/**
|
|
3591
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3592
|
+
* used.
|
|
3593
|
+
*/
|
|
3594
|
+
mode?: ListMode;
|
|
3595
|
+
/**
|
|
3596
|
+
* The visibility of the timeline entries to filter for. Note this is a
|
|
3597
|
+
* strict filter, such that only entries with the exact visibilities
|
|
3598
|
+
* specified will be returned.
|
|
3599
|
+
*/
|
|
3600
|
+
visibility?: TimelineEntryVisibility[];
|
|
3601
|
+
}, params?: RequestParams): AsyncGenerator<TimelineEntriesListResponse, void, unknown>;
|
|
3602
|
+
/**
|
|
3603
|
+
* @description Lists the timeline entries for an object.
|
|
3604
|
+
*
|
|
3605
|
+
* @tags timeline-entries
|
|
3606
|
+
* @name TimelineEntriesListPost
|
|
3607
|
+
* @request POST:/timeline-entries.list
|
|
3608
|
+
* @secure
|
|
3609
|
+
*/
|
|
3610
|
+
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
2675
3611
|
/**
|
|
2676
3612
|
* @description Updates an entry on an object's timeline.
|
|
2677
3613
|
*
|
|
@@ -2714,6 +3650,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2714
3650
|
*/
|
|
2715
3651
|
id: string;
|
|
2716
3652
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
3653
|
+
/**
|
|
3654
|
+
* @description Gets the requested webhook's information.
|
|
3655
|
+
*
|
|
3656
|
+
* @tags webhooks
|
|
3657
|
+
* @name WebhooksGetPost
|
|
3658
|
+
* @request POST:/webhooks.get
|
|
3659
|
+
* @secure
|
|
3660
|
+
*/
|
|
3661
|
+
webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
2717
3662
|
/**
|
|
2718
3663
|
* @description Lists the webhooks.
|
|
2719
3664
|
*
|
|
@@ -2723,6 +3668,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2723
3668
|
* @secure
|
|
2724
3669
|
*/
|
|
2725
3670
|
webhooksList: (params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
3671
|
+
/**
|
|
3672
|
+
* @description Lists the webhooks.
|
|
3673
|
+
*
|
|
3674
|
+
* @tags webhooks
|
|
3675
|
+
* @name WebhooksListPost
|
|
3676
|
+
* @request POST:/webhooks.list
|
|
3677
|
+
* @secure
|
|
3678
|
+
*/
|
|
3679
|
+
webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
2726
3680
|
/**
|
|
2727
3681
|
* @description Updates the requested webhook.
|
|
2728
3682
|
*
|
|
@@ -2761,12 +3715,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2761
3715
|
worksExport: (query?: {
|
|
2762
3716
|
/**
|
|
2763
3717
|
* Filters for work belonging to any of the provided parts.
|
|
2764
|
-
* @example ["
|
|
3718
|
+
* @example ["PROD-12345"]
|
|
2765
3719
|
*/
|
|
2766
3720
|
applies_to_part?: string[];
|
|
2767
3721
|
/**
|
|
2768
3722
|
* Filters for work created by any of these users.
|
|
2769
|
-
* @example ["
|
|
3723
|
+
* @example ["DEVU-12345"]
|
|
2770
3724
|
*/
|
|
2771
3725
|
created_by?: string[];
|
|
2772
3726
|
/**
|
|
@@ -2779,19 +3733,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2779
3733
|
'issue.priority'?: IssuePriority[];
|
|
2780
3734
|
/**
|
|
2781
3735
|
* Filters for issues with any of the provided Rev organizations.
|
|
2782
|
-
* @example ["
|
|
3736
|
+
* @example ["REV-AbCdEfGh"]
|
|
2783
3737
|
*/
|
|
2784
3738
|
'issue.rev_orgs'?: string[];
|
|
2785
3739
|
/**
|
|
2786
3740
|
* Filters for work owned by any of these users.
|
|
2787
|
-
* @example ["
|
|
3741
|
+
* @example ["DEVU-12345"]
|
|
2788
3742
|
*/
|
|
2789
3743
|
owned_by?: string[];
|
|
2790
3744
|
/** Filters for records in the provided stage(s) by name. */
|
|
2791
3745
|
'stage.name'?: string[];
|
|
2792
3746
|
/**
|
|
2793
3747
|
* Filters for work with any of the provided tags.
|
|
2794
|
-
* @example ["
|
|
3748
|
+
* @example ["TAG-12345"]
|
|
2795
3749
|
*/
|
|
2796
3750
|
tags?: string[];
|
|
2797
3751
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -2803,7 +3757,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2803
3757
|
/**
|
|
2804
3758
|
* Filters for tickets that are associated with any of the provided Rev
|
|
2805
3759
|
* organizations.
|
|
2806
|
-
* @example ["
|
|
3760
|
+
* @example ["REV-AbCdEfGh"]
|
|
2807
3761
|
*/
|
|
2808
3762
|
'ticket.rev_org'?: string[];
|
|
2809
3763
|
/** Filters for tickets with any of the provided severities. */
|
|
@@ -2813,6 +3767,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2813
3767
|
/** Filters for work of the provided types. */
|
|
2814
3768
|
type?: WorkType[];
|
|
2815
3769
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
3770
|
+
/**
|
|
3771
|
+
* @description Exports a collection of work items.
|
|
3772
|
+
*
|
|
3773
|
+
* @tags works
|
|
3774
|
+
* @name WorksExportPost
|
|
3775
|
+
* @request POST:/works.export
|
|
3776
|
+
* @secure
|
|
3777
|
+
*/
|
|
3778
|
+
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
2816
3779
|
/**
|
|
2817
3780
|
* @description Gets a work item's information.
|
|
2818
3781
|
*
|
|
@@ -2824,10 +3787,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2824
3787
|
worksGet: (query: {
|
|
2825
3788
|
/**
|
|
2826
3789
|
* The work's ID.
|
|
2827
|
-
* @example "
|
|
3790
|
+
* @example "ISS-12345"
|
|
2828
3791
|
*/
|
|
2829
3792
|
id: string;
|
|
2830
3793
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
3794
|
+
/**
|
|
3795
|
+
* @description Gets a work item's information.
|
|
3796
|
+
*
|
|
3797
|
+
* @tags works
|
|
3798
|
+
* @name WorksGetPost
|
|
3799
|
+
* @request POST:/works.get
|
|
3800
|
+
* @secure
|
|
3801
|
+
*/
|
|
3802
|
+
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
2831
3803
|
/**
|
|
2832
3804
|
* @description Lists a collection of work items.
|
|
2833
3805
|
*
|
|
@@ -2839,12 +3811,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2839
3811
|
worksList: (query?: {
|
|
2840
3812
|
/**
|
|
2841
3813
|
* Filters for work belonging to any of the provided parts.
|
|
2842
|
-
* @example ["
|
|
3814
|
+
* @example ["PROD-12345"]
|
|
2843
3815
|
*/
|
|
2844
3816
|
applies_to_part?: string[];
|
|
2845
3817
|
/**
|
|
2846
3818
|
* Filters for work created by any of these users.
|
|
2847
|
-
* @example ["
|
|
3819
|
+
* @example ["DEVU-12345"]
|
|
2848
3820
|
*/
|
|
2849
3821
|
created_by?: string[];
|
|
2850
3822
|
/**
|
|
@@ -2856,7 +3828,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2856
3828
|
'issue.priority'?: IssuePriority[];
|
|
2857
3829
|
/**
|
|
2858
3830
|
* Filters for issues with any of the provided Rev organizations.
|
|
2859
|
-
* @example ["
|
|
3831
|
+
* @example ["REV-AbCdEfGh"]
|
|
2860
3832
|
*/
|
|
2861
3833
|
'issue.rev_orgs'?: string[];
|
|
2862
3834
|
/**
|
|
@@ -2871,14 +3843,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2871
3843
|
mode?: ListMode;
|
|
2872
3844
|
/**
|
|
2873
3845
|
* Filters for work owned by any of these users.
|
|
2874
|
-
* @example ["
|
|
3846
|
+
* @example ["DEVU-12345"]
|
|
2875
3847
|
*/
|
|
2876
3848
|
owned_by?: string[];
|
|
2877
3849
|
/** Filters for records in the provided stage(s) by name. */
|
|
2878
3850
|
'stage.name'?: string[];
|
|
2879
3851
|
/**
|
|
2880
3852
|
* Filters for work with any of the provided tags.
|
|
2881
|
-
* @example ["
|
|
3853
|
+
* @example ["TAG-12345"]
|
|
2882
3854
|
*/
|
|
2883
3855
|
tags?: string[];
|
|
2884
3856
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -2890,7 +3862,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2890
3862
|
/**
|
|
2891
3863
|
* Filters for tickets that are associated with any of the provided Rev
|
|
2892
3864
|
* organizations.
|
|
2893
|
-
* @example ["
|
|
3865
|
+
* @example ["REV-AbCdEfGh"]
|
|
2894
3866
|
*/
|
|
2895
3867
|
'ticket.rev_org'?: string[];
|
|
2896
3868
|
/** Filters for tickets with any of the provided severities. */
|
|
@@ -2900,6 +3872,86 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2900
3872
|
/** Filters for work of the provided types. */
|
|
2901
3873
|
type?: WorkType[];
|
|
2902
3874
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
3875
|
+
/**
|
|
3876
|
+
* @description Lists a collection of work items.
|
|
3877
|
+
*
|
|
3878
|
+
* @tags works
|
|
3879
|
+
* @name WorksList
|
|
3880
|
+
* @request GET:/works.list
|
|
3881
|
+
* @secure */
|
|
3882
|
+
worksListPaginator(query?: {
|
|
3883
|
+
/**
|
|
3884
|
+
* Filters for work belonging to any of the provided parts.
|
|
3885
|
+
* @example ["PROD-12345"]
|
|
3886
|
+
*/
|
|
3887
|
+
applies_to_part?: string[];
|
|
3888
|
+
/**
|
|
3889
|
+
* Filters for work created by any of these users.
|
|
3890
|
+
* @example ["DEVU-12345"]
|
|
3891
|
+
*/
|
|
3892
|
+
created_by?: string[];
|
|
3893
|
+
/**
|
|
3894
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3895
|
+
* starts from the beginning.
|
|
3896
|
+
*/
|
|
3897
|
+
cursor?: string;
|
|
3898
|
+
/** Filters for issues with any of the provided priorities. */
|
|
3899
|
+
'issue.priority'?: IssuePriority[];
|
|
3900
|
+
/**
|
|
3901
|
+
* Filters for issues with any of the provided Rev organizations.
|
|
3902
|
+
* @example ["REV-AbCdEfGh"]
|
|
3903
|
+
*/
|
|
3904
|
+
'issue.rev_orgs'?: string[];
|
|
3905
|
+
/**
|
|
3906
|
+
* The maximum number of works to return. The default is '50'.
|
|
3907
|
+
* @format int32
|
|
3908
|
+
*/
|
|
3909
|
+
limit?: number;
|
|
3910
|
+
/**
|
|
3911
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3912
|
+
* used.
|
|
3913
|
+
*/
|
|
3914
|
+
mode?: ListMode;
|
|
3915
|
+
/**
|
|
3916
|
+
* Filters for work owned by any of these users.
|
|
3917
|
+
* @example ["DEVU-12345"]
|
|
3918
|
+
*/
|
|
3919
|
+
owned_by?: string[];
|
|
3920
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
3921
|
+
'stage.name'?: string[];
|
|
3922
|
+
/**
|
|
3923
|
+
* Filters for work with any of the provided tags.
|
|
3924
|
+
* @example ["TAG-12345"]
|
|
3925
|
+
*/
|
|
3926
|
+
tags?: string[];
|
|
3927
|
+
/** Filters for tickets belonging to specific groups. */
|
|
3928
|
+
'ticket.group'?: string[];
|
|
3929
|
+
/** Filters for tickets that are spam. */
|
|
3930
|
+
'ticket.is_spam'?: boolean;
|
|
3931
|
+
/** Filters for tickets that need response. */
|
|
3932
|
+
'ticket.needs_response'?: boolean;
|
|
3933
|
+
/**
|
|
3934
|
+
* Filters for tickets that are associated with any of the provided Rev
|
|
3935
|
+
* organizations.
|
|
3936
|
+
* @example ["REV-AbCdEfGh"]
|
|
3937
|
+
*/
|
|
3938
|
+
'ticket.rev_org'?: string[];
|
|
3939
|
+
/** Filters for tickets with any of the provided severities. */
|
|
3940
|
+
'ticket.severity'?: TicketSeverity[];
|
|
3941
|
+
/** Filters for tickets with any of the provided source channels. */
|
|
3942
|
+
'ticket.source_channel'?: string[];
|
|
3943
|
+
/** Filters for work of the provided types. */
|
|
3944
|
+
type?: WorkType[];
|
|
3945
|
+
}, params?: RequestParams): AsyncGenerator<WorksListResponse, void, unknown>;
|
|
3946
|
+
/**
|
|
3947
|
+
* @description Lists a collection of work items.
|
|
3948
|
+
*
|
|
3949
|
+
* @tags works
|
|
3950
|
+
* @name WorksListPost
|
|
3951
|
+
* @request POST:/works.list
|
|
3952
|
+
* @secure
|
|
3953
|
+
*/
|
|
3954
|
+
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
2903
3955
|
/**
|
|
2904
3956
|
* @description Updates a work item's information.
|
|
2905
3957
|
*
|