@devrev/typescript-sdk 1.1.23 → 1.1.24
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.
|
@@ -14,6 +14,222 @@ export type Account = OrgBase & {
|
|
|
14
14
|
/** The Tier of the corresponding Account. */
|
|
15
15
|
tier?: string;
|
|
16
16
|
};
|
|
17
|
+
/**
|
|
18
|
+
* accounts-create-request
|
|
19
|
+
* Request object to create a new account in the Dev organization.
|
|
20
|
+
*/
|
|
21
|
+
export interface AccountsCreateRequest {
|
|
22
|
+
/** Description of the account. */
|
|
23
|
+
description?: string;
|
|
24
|
+
/** Name of the account. */
|
|
25
|
+
display_name: string;
|
|
26
|
+
/** List of company's domain names. Example - ['devrev.ai']. */
|
|
27
|
+
domains?: string[];
|
|
28
|
+
/**
|
|
29
|
+
* External refs are unique identifiers from your customer system of
|
|
30
|
+
* records, stored as a list.
|
|
31
|
+
*/
|
|
32
|
+
external_refs?: string[];
|
|
33
|
+
/** List of Dev users owning this account. */
|
|
34
|
+
owned_by?: string[];
|
|
35
|
+
/** The tier of the account. */
|
|
36
|
+
tier?: string;
|
|
37
|
+
/**
|
|
38
|
+
* List of company websites. Example - ['www.devrev.ai',
|
|
39
|
+
* 'www.marketplace.devrev.ai'].
|
|
40
|
+
*/
|
|
41
|
+
websites?: string[];
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* accounts-create-response
|
|
45
|
+
* The response to creating a new account.
|
|
46
|
+
*/
|
|
47
|
+
export interface AccountsCreateResponse {
|
|
48
|
+
account: Account;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* accounts-delete-request
|
|
52
|
+
* Request object to delete an account.
|
|
53
|
+
*/
|
|
54
|
+
export interface AccountsDeleteRequest {
|
|
55
|
+
/**
|
|
56
|
+
* The ID of account to delete.
|
|
57
|
+
* @example "ACC-12345"
|
|
58
|
+
*/
|
|
59
|
+
id: string;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* accounts-delete-response
|
|
63
|
+
* The response to deleting an account.
|
|
64
|
+
*/
|
|
65
|
+
export type AccountsDeleteResponse = object;
|
|
66
|
+
/**
|
|
67
|
+
* accounts-export-request
|
|
68
|
+
* The request to export a collection of accounts.
|
|
69
|
+
*/
|
|
70
|
+
export interface AccountsExportRequest {
|
|
71
|
+
/** Filters for accounts created by the specified user(s). */
|
|
72
|
+
created_by?: string[];
|
|
73
|
+
created_date?: DateTimeFilter;
|
|
74
|
+
/** Array of display names of accounts to be filtered. */
|
|
75
|
+
display_name?: string[];
|
|
76
|
+
/** Array of references of accounts to be filtered. */
|
|
77
|
+
external_refs?: string[];
|
|
78
|
+
/**
|
|
79
|
+
* The number of accounts to return. The default is '50'.
|
|
80
|
+
* @format int32
|
|
81
|
+
* @min 1
|
|
82
|
+
* @max 500
|
|
83
|
+
*/
|
|
84
|
+
first?: number;
|
|
85
|
+
modified_date?: DateTimeFilter;
|
|
86
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
87
|
+
sort_by?: string[];
|
|
88
|
+
/** Filters for accounts on specified stages. */
|
|
89
|
+
stage?: string[];
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* accounts-export-response
|
|
93
|
+
* The response to exporting a collection of accounts.
|
|
94
|
+
*/
|
|
95
|
+
export interface AccountsExportResponse {
|
|
96
|
+
/** The exported accounts. */
|
|
97
|
+
accounts: Account[];
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* accounts-get-request
|
|
101
|
+
* Request object to get an account's information.
|
|
102
|
+
*/
|
|
103
|
+
export interface AccountsGetRequest {
|
|
104
|
+
/**
|
|
105
|
+
* The ID of the account to be retrieved.
|
|
106
|
+
* @example "ACC-12345"
|
|
107
|
+
*/
|
|
108
|
+
id: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* accounts-get-response
|
|
112
|
+
* The returned account.
|
|
113
|
+
*/
|
|
114
|
+
export interface AccountsGetResponse {
|
|
115
|
+
account: Account;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* accounts-list-request
|
|
119
|
+
* List the accounts.
|
|
120
|
+
*/
|
|
121
|
+
export interface AccountsListRequest {
|
|
122
|
+
/** Filters for accounts created by the specified user(s). */
|
|
123
|
+
created_by?: string[];
|
|
124
|
+
created_date?: DateTimeFilter;
|
|
125
|
+
/**
|
|
126
|
+
* The cursor to resume iteration from. If not provided, then
|
|
127
|
+
* iteration starts from the beginning.
|
|
128
|
+
*/
|
|
129
|
+
cursor?: string;
|
|
130
|
+
/** Array of display names of accounts to be filtered. */
|
|
131
|
+
display_name?: string[];
|
|
132
|
+
/** Array of references of accounts to be filtered. */
|
|
133
|
+
external_refs?: string[];
|
|
134
|
+
/**
|
|
135
|
+
* The maximum number of accounts to return per page. The default is
|
|
136
|
+
* '50'.
|
|
137
|
+
* @format int32
|
|
138
|
+
*/
|
|
139
|
+
limit?: number;
|
|
140
|
+
/**
|
|
141
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
142
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
143
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
144
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
145
|
+
* always be returned in the specified sort-by order.
|
|
146
|
+
*/
|
|
147
|
+
mode?: ListMode;
|
|
148
|
+
modified_date?: DateTimeFilter;
|
|
149
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
150
|
+
sort_by?: string[];
|
|
151
|
+
/** Filters for accounts on specified stages. */
|
|
152
|
+
stage?: string[];
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* accounts-list-response
|
|
156
|
+
* The response to listing all accounts matching the filter criteria.
|
|
157
|
+
*/
|
|
158
|
+
export interface AccountsListResponse {
|
|
159
|
+
/** List containing all the accounts */
|
|
160
|
+
accounts: Account[];
|
|
161
|
+
/**
|
|
162
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
163
|
+
* sort order. If not set, then no later elements exist.
|
|
164
|
+
*/
|
|
165
|
+
next_cursor?: string;
|
|
166
|
+
/**
|
|
167
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
168
|
+
* sort order. If not set, then no prior elements exist.
|
|
169
|
+
*/
|
|
170
|
+
prev_cursor?: string;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* accounts-update-request
|
|
174
|
+
* Request to update details of the account.
|
|
175
|
+
*/
|
|
176
|
+
export interface AccountsUpdateRequest {
|
|
177
|
+
/** Updated description of the account. */
|
|
178
|
+
description?: string;
|
|
179
|
+
/** Updated display name for the account. */
|
|
180
|
+
display_name?: string;
|
|
181
|
+
/** Updated list of company's domain names. Example - ['devrev.ai']. */
|
|
182
|
+
domains?: string[];
|
|
183
|
+
/** Updated External Refs of account. */
|
|
184
|
+
external_refs?: string[];
|
|
185
|
+
/**
|
|
186
|
+
* The ID of account to update.
|
|
187
|
+
* @example "ACC-12345"
|
|
188
|
+
*/
|
|
189
|
+
id: string;
|
|
190
|
+
/** Updated list of the users owning this account. */
|
|
191
|
+
owned_by?: string[];
|
|
192
|
+
/** Updated tier of the account. */
|
|
193
|
+
tier?: string | null;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* accounts-update-response
|
|
197
|
+
* Updated account object.
|
|
198
|
+
*/
|
|
199
|
+
export interface AccountsUpdateResponse {
|
|
200
|
+
account: Account;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* archetype-metric-target
|
|
204
|
+
* Metric with corresponding target values.
|
|
205
|
+
*/
|
|
206
|
+
export interface ArchetypeMetricTarget {
|
|
207
|
+
/**
|
|
208
|
+
* If true, the schedule attached to this metric is out of schedule at
|
|
209
|
+
* the time of the query.
|
|
210
|
+
*/
|
|
211
|
+
is_out_of_schedule?: boolean;
|
|
212
|
+
metric_definition: MetricDefinitionSummary;
|
|
213
|
+
org_schedule?: OrgScheduleSummary;
|
|
214
|
+
/**
|
|
215
|
+
* Time in minutes that remains on a paused metric.
|
|
216
|
+
* @format int32
|
|
217
|
+
*/
|
|
218
|
+
remaining_time?: number;
|
|
219
|
+
/**
|
|
220
|
+
* Time at which the metric would breach SLA if no action taken.
|
|
221
|
+
* @format date-time
|
|
222
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
223
|
+
*/
|
|
224
|
+
target_time?: string;
|
|
225
|
+
/**
|
|
226
|
+
* Time at which the metric would reach the SLA warning limit if no
|
|
227
|
+
* action taken.
|
|
228
|
+
* @format date-time
|
|
229
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
230
|
+
*/
|
|
231
|
+
warning_target_time?: string;
|
|
232
|
+
}
|
|
17
233
|
/** artifact */
|
|
18
234
|
export type Artifact = AtomBase;
|
|
19
235
|
/** artifact-summary */
|
|
@@ -61,7 +277,7 @@ export interface ArtifactsGetResponse {
|
|
|
61
277
|
*/
|
|
62
278
|
export interface ArtifactsListRequest {
|
|
63
279
|
/** The ID of the object to filter artifacts. */
|
|
64
|
-
parent_id
|
|
280
|
+
parent_id?: string;
|
|
65
281
|
}
|
|
66
282
|
/**
|
|
67
283
|
* artifacts-list-response
|
|
@@ -105,6 +321,8 @@ export interface ArtifactsLocateResponse {
|
|
|
105
321
|
export interface ArtifactsPrepareRequest {
|
|
106
322
|
/** The name of the file that's being uploaded. */
|
|
107
323
|
file_name: string;
|
|
324
|
+
/** The type of file that's being uploaded. */
|
|
325
|
+
file_type?: string;
|
|
108
326
|
}
|
|
109
327
|
/**
|
|
110
328
|
* artifacts-prepare-response
|
|
@@ -288,8 +506,10 @@ export declare enum AuthTokenGrantType {
|
|
|
288
506
|
/** The type of the requested token. */
|
|
289
507
|
export declare enum AuthTokenRequestedTokenType {
|
|
290
508
|
UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
|
|
509
|
+
UrnDevrevParamsOauthTokenTypeAatActAs = "urn:devrev:params:oauth:token-type:aat:act-as",
|
|
291
510
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
292
511
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
512
|
+
UrnDevrevParamsOauthTokenTypeDevConnect = "urn:devrev:params:oauth:token-type:dev:connect",
|
|
293
513
|
UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
|
|
294
514
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
295
515
|
UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
|
|
@@ -330,7 +550,10 @@ export declare enum AuthTokenTokenType {
|
|
|
330
550
|
* type.
|
|
331
551
|
*/
|
|
332
552
|
export interface AuthTokensCreateRequest {
|
|
333
|
-
/**
|
|
553
|
+
/**
|
|
554
|
+
* The unique ID of the Dev user or the service account to
|
|
555
|
+
* impersonate.
|
|
556
|
+
*/
|
|
334
557
|
act_as?: string;
|
|
335
558
|
/** The expected audience values with respect to the token. */
|
|
336
559
|
aud?: string[];
|
|
@@ -559,6 +782,7 @@ export type Conversation = AtomBase & {
|
|
|
559
782
|
metadata?: ConversationMetadata;
|
|
560
783
|
/** Owner IDs for the conversation. */
|
|
561
784
|
owned_by?: UserSummary[];
|
|
785
|
+
sla_tracker?: SlaTrackerSummary;
|
|
562
786
|
/** Describes the current stage of a work item. */
|
|
563
787
|
stage?: LegacyStage;
|
|
564
788
|
/** Tags associated with the object. */
|
|
@@ -877,7 +1101,7 @@ export type Enhancement = PartBase;
|
|
|
877
1101
|
/** enhancement-summary */
|
|
878
1102
|
export type EnhancementSummary = PartBaseSummary;
|
|
879
1103
|
/** error-bad-request */
|
|
880
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
|
|
1104
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
881
1105
|
type: ErrorBadRequestType;
|
|
882
1106
|
};
|
|
883
1107
|
/** error-bad-request-bad-request */
|
|
@@ -903,6 +1127,8 @@ export interface ErrorBadRequestInvalidField {
|
|
|
903
1127
|
}
|
|
904
1128
|
/** error-bad-request-missing-dependency */
|
|
905
1129
|
export interface ErrorBadRequestMissingDependency {
|
|
1130
|
+
/** The dependent fields. */
|
|
1131
|
+
dependencies?: ErrorBadRequestMissingDependencyDependency[];
|
|
906
1132
|
/** The field on which the value depends. */
|
|
907
1133
|
dependent_field_name?: string;
|
|
908
1134
|
/** The value which needs to be set of the dependent field. */
|
|
@@ -912,6 +1138,13 @@ export interface ErrorBadRequestMissingDependency {
|
|
|
912
1138
|
/** The value that was received. */
|
|
913
1139
|
provided_field_value?: string;
|
|
914
1140
|
}
|
|
1141
|
+
/** error-bad-request-missing-dependency-dependency */
|
|
1142
|
+
export interface ErrorBadRequestMissingDependencyDependency {
|
|
1143
|
+
/** The dependent field name. */
|
|
1144
|
+
field_name: string;
|
|
1145
|
+
/** The dependent field value. */
|
|
1146
|
+
field_value: string;
|
|
1147
|
+
}
|
|
915
1148
|
/** error-bad-request-missing-required-field */
|
|
916
1149
|
export interface ErrorBadRequestMissingRequiredField {
|
|
917
1150
|
/** The missing field's name. */
|
|
@@ -937,10 +1170,28 @@ export declare enum ErrorBadRequestType {
|
|
|
937
1170
|
MissingRequiredField = "missing_required_field",
|
|
938
1171
|
ParseError = "parse_error",
|
|
939
1172
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
1173
|
+
UnexpectedJsonType = "unexpected_json_type",
|
|
940
1174
|
ValueNotPermitted = "value_not_permitted"
|
|
941
1175
|
}
|
|
1176
|
+
/** error-bad-request-unexpected-json-type */
|
|
1177
|
+
export interface ErrorBadRequestUnexpectedJsonType {
|
|
1178
|
+
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
1179
|
+
expected: ErrorBadRequestUnexpectedJsonTypeType;
|
|
1180
|
+
/** The field name that's invalid. */
|
|
1181
|
+
field_name: string;
|
|
1182
|
+
}
|
|
1183
|
+
export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
1184
|
+
Array = "array",
|
|
1185
|
+
Bool = "bool",
|
|
1186
|
+
Null = "null",
|
|
1187
|
+
Number = "number",
|
|
1188
|
+
Object = "object",
|
|
1189
|
+
String = "string"
|
|
1190
|
+
}
|
|
942
1191
|
/** error-bad-request-value-not-permitted */
|
|
943
1192
|
export interface ErrorBadRequestValueNotPermitted {
|
|
1193
|
+
/** The allowed values for the field. */
|
|
1194
|
+
allowed_values?: string[];
|
|
944
1195
|
/** The field whose value is not permitted. */
|
|
945
1196
|
field_name: string;
|
|
946
1197
|
/** The reason the value isn't permitted. */
|
|
@@ -953,6 +1204,15 @@ export interface ErrorBase {
|
|
|
953
1204
|
/** The message associated with the error. */
|
|
954
1205
|
message?: string;
|
|
955
1206
|
}
|
|
1207
|
+
/** error-conflict */
|
|
1208
|
+
export type ErrorConflict = ErrorBase & ErrorConflictConflict & {
|
|
1209
|
+
type: ErrorConflictType;
|
|
1210
|
+
};
|
|
1211
|
+
/** error-conflict-conflict */
|
|
1212
|
+
export type ErrorConflictConflict = object;
|
|
1213
|
+
export declare enum ErrorConflictType {
|
|
1214
|
+
Conflict = "conflict"
|
|
1215
|
+
}
|
|
956
1216
|
/** error-forbidden */
|
|
957
1217
|
export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
|
|
958
1218
|
type: ErrorForbiddenType;
|
|
@@ -1117,6 +1377,19 @@ export interface EventSlaTrackerDeleted {
|
|
|
1117
1377
|
export interface EventSlaTrackerUpdated {
|
|
1118
1378
|
sla_tracker: SlaTracker;
|
|
1119
1379
|
}
|
|
1380
|
+
/** event-survey-response-created */
|
|
1381
|
+
export interface EventSurveyResponseCreated {
|
|
1382
|
+
survey_response: SurveyResponse;
|
|
1383
|
+
}
|
|
1384
|
+
/** event-survey-response-deleted */
|
|
1385
|
+
export interface EventSurveyResponseDeleted {
|
|
1386
|
+
/** The ID of the survey response that was deleted. */
|
|
1387
|
+
id: string;
|
|
1388
|
+
}
|
|
1389
|
+
/** event-survey-response-updated */
|
|
1390
|
+
export interface EventSurveyResponseUpdated {
|
|
1391
|
+
survey_response: SurveyResponse;
|
|
1392
|
+
}
|
|
1120
1393
|
/** event-tag-created */
|
|
1121
1394
|
export interface EventTagCreated {
|
|
1122
1395
|
tag: Tag;
|
|
@@ -1198,6 +1471,12 @@ export type Issue = WorkBase & {
|
|
|
1198
1471
|
developed_with?: PartSummary[];
|
|
1199
1472
|
/** Priority of the work based upon impact and criticality. */
|
|
1200
1473
|
priority?: IssuePriority;
|
|
1474
|
+
/**
|
|
1475
|
+
* Target start date for the object.
|
|
1476
|
+
* @format date-time
|
|
1477
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1478
|
+
*/
|
|
1479
|
+
target_start_date?: string;
|
|
1201
1480
|
};
|
|
1202
1481
|
/** Priority of the work based upon impact and criticality. */
|
|
1203
1482
|
export declare enum IssuePriority {
|
|
@@ -1225,6 +1504,11 @@ export declare enum ListMode {
|
|
|
1225
1504
|
After = "after",
|
|
1226
1505
|
Before = "before"
|
|
1227
1506
|
}
|
|
1507
|
+
/** metric-definition-summary */
|
|
1508
|
+
export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
1509
|
+
/** Human readable name of the metric. */
|
|
1510
|
+
name?: string;
|
|
1511
|
+
};
|
|
1228
1512
|
/** org-base */
|
|
1229
1513
|
export type OrgBase = AtomBase & {
|
|
1230
1514
|
/** Name of the Organization. */
|
|
@@ -1241,6 +1525,42 @@ export declare enum OrgEnvironment {
|
|
|
1241
1525
|
Staging = "staging",
|
|
1242
1526
|
Test = "test"
|
|
1243
1527
|
}
|
|
1528
|
+
/**
|
|
1529
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1530
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1531
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1532
|
+
*/
|
|
1533
|
+
export declare enum OrgScheduleStatus {
|
|
1534
|
+
Archived = "archived",
|
|
1535
|
+
Draft = "draft",
|
|
1536
|
+
Published = "published"
|
|
1537
|
+
}
|
|
1538
|
+
/** org-schedule-summary */
|
|
1539
|
+
export type OrgScheduleSummary = AtomBaseSummary & {
|
|
1540
|
+
/** Human-readable name. */
|
|
1541
|
+
name?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1544
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1545
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1546
|
+
*/
|
|
1547
|
+
status: OrgScheduleStatus;
|
|
1548
|
+
/**
|
|
1549
|
+
* Timezone in which this is defined. Only organization schedules in
|
|
1550
|
+
* the same timezone can be directly combined.
|
|
1551
|
+
*/
|
|
1552
|
+
timezone?: string;
|
|
1553
|
+
/**
|
|
1554
|
+
* Derived field indicating when a valid organization schedule will
|
|
1555
|
+
* become invalid. If omitted, the schedule is already invalid. A
|
|
1556
|
+
* schedule is valid if it has a weekly schedule for all named periods
|
|
1557
|
+
* for all its schedule fragments, and if it has a schedule fragment
|
|
1558
|
+
* for the time period in question.
|
|
1559
|
+
* @format date-time
|
|
1560
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1561
|
+
*/
|
|
1562
|
+
valid_until?: string;
|
|
1563
|
+
};
|
|
1244
1564
|
/** org-summary */
|
|
1245
1565
|
export type OrgSummary = RevOrgSummary & {
|
|
1246
1566
|
type: OrgType;
|
|
@@ -1598,6 +1918,8 @@ export interface RevOrgsListRequest {
|
|
|
1598
1918
|
* iteration starts from the beginning.
|
|
1599
1919
|
*/
|
|
1600
1920
|
cursor?: string;
|
|
1921
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
1922
|
+
display_name?: string[];
|
|
1601
1923
|
/** List of external refs to filter Rev organizations for. */
|
|
1602
1924
|
external_ref?: string[];
|
|
1603
1925
|
/**
|
|
@@ -1711,6 +2033,27 @@ export interface SetTagWithValue {
|
|
|
1711
2033
|
*/
|
|
1712
2034
|
value?: string;
|
|
1713
2035
|
}
|
|
2036
|
+
/**
|
|
2037
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
2038
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
2039
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
2040
|
+
*/
|
|
2041
|
+
export declare enum SlaStatus {
|
|
2042
|
+
Archived = "archived",
|
|
2043
|
+
Draft = "draft",
|
|
2044
|
+
Published = "published"
|
|
2045
|
+
}
|
|
2046
|
+
/** sla-summary */
|
|
2047
|
+
export type SlaSummary = AtomBaseSummary & {
|
|
2048
|
+
/** Human-readable name. */
|
|
2049
|
+
name: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
2052
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
2053
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
2054
|
+
*/
|
|
2055
|
+
status: SlaStatus;
|
|
2056
|
+
};
|
|
1714
2057
|
/**
|
|
1715
2058
|
* sla-summary-filter
|
|
1716
2059
|
* The filter for SLA summary.
|
|
@@ -1733,7 +2076,37 @@ export declare enum SlaSummaryStage {
|
|
|
1733
2076
|
Warning = "warning"
|
|
1734
2077
|
}
|
|
1735
2078
|
/** sla-tracker */
|
|
1736
|
-
export type SlaTracker = AtomBase
|
|
2079
|
+
export type SlaTracker = AtomBase & {
|
|
2080
|
+
/** Details of the object on which the SLA is being tracked. */
|
|
2081
|
+
applies_to_id?: string;
|
|
2082
|
+
/** Summary of the metrics target being tracked in the SLA tracker. */
|
|
2083
|
+
metric_target_summaries: ArchetypeMetricTarget[];
|
|
2084
|
+
sla?: SlaSummary;
|
|
2085
|
+
/**
|
|
2086
|
+
* Details of the applicable SLA policy. Can be omitted if no sla
|
|
2087
|
+
* applies, or if no policy of the sla applies at the moment.
|
|
2088
|
+
*/
|
|
2089
|
+
sla_policy_id?: string;
|
|
2090
|
+
/** SLA stage of the object being tracked. */
|
|
2091
|
+
stage?: string;
|
|
2092
|
+
/**
|
|
2093
|
+
* It is an indicator of whether the SLA has ever been breached
|
|
2094
|
+
* (missed). If not, it shows whether the SLA is completed, in
|
|
2095
|
+
* progress, or nil - if no policy is applied.
|
|
2096
|
+
*/
|
|
2097
|
+
status?: string;
|
|
2098
|
+
};
|
|
2099
|
+
/** sla-tracker-summary */
|
|
2100
|
+
export type SlaTrackerSummary = AtomBaseSummary;
|
|
2101
|
+
/** sla-trackers-get-request */
|
|
2102
|
+
export interface SlaTrackersGetRequest {
|
|
2103
|
+
/** The ID of the SLA tracker to get. */
|
|
2104
|
+
id: string;
|
|
2105
|
+
}
|
|
2106
|
+
/** sla-trackers-get-response */
|
|
2107
|
+
export interface SlaTrackersGetResponse {
|
|
2108
|
+
sla_tracker: SlaTracker;
|
|
2109
|
+
}
|
|
1737
2110
|
/** snap-widget */
|
|
1738
2111
|
export interface SnapWidget {
|
|
1739
2112
|
type: SnapWidgetType;
|
|
@@ -1763,11 +2136,62 @@ export interface StageUpdate {
|
|
|
1763
2136
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
1764
2137
|
name?: string;
|
|
1765
2138
|
}
|
|
2139
|
+
/** staged-info-filter */
|
|
2140
|
+
export interface StagedInfoFilter {
|
|
2141
|
+
/** Filters for issues that are staged. */
|
|
2142
|
+
is_staged?: boolean;
|
|
2143
|
+
}
|
|
1766
2144
|
/**
|
|
1767
2145
|
* survey-aggregation-filter
|
|
1768
2146
|
* The filter for survey aggregation.
|
|
1769
2147
|
*/
|
|
1770
2148
|
export type SurveyAggregationFilter = object;
|
|
2149
|
+
/** survey-response */
|
|
2150
|
+
export type SurveyResponse = AtomBase & {
|
|
2151
|
+
/** The unique ID associated with the dispatched survey. */
|
|
2152
|
+
dispatch_id?: string;
|
|
2153
|
+
/** The ID of the object for which survey is taken. */
|
|
2154
|
+
object?: string;
|
|
2155
|
+
/** Response for the survey. */
|
|
2156
|
+
response?: object;
|
|
2157
|
+
/** The ID of the survey for which response is taken. */
|
|
2158
|
+
survey?: string;
|
|
2159
|
+
};
|
|
2160
|
+
/** sync-metadata-filter */
|
|
2161
|
+
export interface SyncMetadataFilter {
|
|
2162
|
+
last_sync_in?: SyncMetadataFilterSyncInFilter;
|
|
2163
|
+
last_sync_out?: SyncMetadataFilterSyncOutFilter;
|
|
2164
|
+
/** Filters for issues synced from this specific origin system. */
|
|
2165
|
+
origin_system?: string[];
|
|
2166
|
+
}
|
|
2167
|
+
/** sync-metadata-filter-sync-in-filter */
|
|
2168
|
+
export interface SyncMetadataFilterSyncInFilter {
|
|
2169
|
+
/** Filters for works with selected sync statuses. */
|
|
2170
|
+
status?: SyncMetadataFilterSyncInFilterStatus[];
|
|
2171
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2172
|
+
sync_date?: DateFilter;
|
|
2173
|
+
/** Filters for works modified with selected sync units. */
|
|
2174
|
+
sync_unit?: string[];
|
|
2175
|
+
}
|
|
2176
|
+
export declare enum SyncMetadataFilterSyncInFilterStatus {
|
|
2177
|
+
Failed = "failed",
|
|
2178
|
+
Modified = "modified",
|
|
2179
|
+
Staged = "staged",
|
|
2180
|
+
Succeeded = "succeeded"
|
|
2181
|
+
}
|
|
2182
|
+
/** sync-metadata-filter-sync-out-filter */
|
|
2183
|
+
export interface SyncMetadataFilterSyncOutFilter {
|
|
2184
|
+
/** Filters for works with selected sync statuses. */
|
|
2185
|
+
status?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
2186
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2187
|
+
sync_date?: DateFilter;
|
|
2188
|
+
/** Filters for works modified with selected sync units. */
|
|
2189
|
+
sync_unit?: string[];
|
|
2190
|
+
}
|
|
2191
|
+
export declare enum SyncMetadataFilterSyncOutFilterStatus {
|
|
2192
|
+
Failed = "failed",
|
|
2193
|
+
Succeeded = "succeeded"
|
|
2194
|
+
}
|
|
1771
2195
|
/** sys-user-summary */
|
|
1772
2196
|
export type SysUserSummary = UserBaseSummary;
|
|
1773
2197
|
/** tag */
|
|
@@ -1950,6 +2374,7 @@ export type Ticket = WorkBase & {
|
|
|
1950
2374
|
rev_org?: OrgSummary;
|
|
1951
2375
|
/** Severity of the ticket. */
|
|
1952
2376
|
severity?: TicketSeverity;
|
|
2377
|
+
sla_tracker?: SlaTrackerSummary;
|
|
1953
2378
|
/** Source channel of the ticket. */
|
|
1954
2379
|
source_channel?: string;
|
|
1955
2380
|
};
|
|
@@ -2027,7 +2452,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
2027
2452
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
2028
2453
|
/**
|
|
2029
2454
|
* The IDs of the artifacts attached to the comment.
|
|
2030
|
-
* @maxItems
|
|
2455
|
+
* @maxItems 50
|
|
2031
2456
|
* @example ["ARTIFACT-12345"]
|
|
2032
2457
|
*/
|
|
2033
2458
|
artifacts?: string[];
|
|
@@ -2177,7 +2602,7 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
2177
2602
|
remove?: string[];
|
|
2178
2603
|
/**
|
|
2179
2604
|
* Sets the field to the provided artifacts.
|
|
2180
|
-
* @maxItems
|
|
2605
|
+
* @maxItems 50
|
|
2181
2606
|
* @example ["ARTIFACT-12345"]
|
|
2182
2607
|
*/
|
|
2183
2608
|
set?: string[];
|
|
@@ -2342,6 +2767,9 @@ export interface WebhookEventRequest {
|
|
|
2342
2767
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
2343
2768
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
2344
2769
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
2770
|
+
survey_response_created?: EventSurveyResponseCreated;
|
|
2771
|
+
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
2772
|
+
survey_response_updated?: EventSurveyResponseUpdated;
|
|
2345
2773
|
tag_created?: EventTagCreated;
|
|
2346
2774
|
tag_deleted?: EventTagDeleted;
|
|
2347
2775
|
tag_updated?: EventTagUpdated;
|
|
@@ -2401,6 +2829,9 @@ export declare enum WebhookEventType {
|
|
|
2401
2829
|
RevUserCreated = "rev_user_created",
|
|
2402
2830
|
RevUserDeleted = "rev_user_deleted",
|
|
2403
2831
|
RevUserUpdated = "rev_user_updated",
|
|
2832
|
+
SlaTrackerCreated = "sla_tracker_created",
|
|
2833
|
+
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
2834
|
+
SlaTrackerUpdated = "sla_tracker_updated",
|
|
2404
2835
|
TagCreated = "tag_created",
|
|
2405
2836
|
TagDeleted = "tag_deleted",
|
|
2406
2837
|
TagUpdated = "tag_updated",
|
|
@@ -2652,6 +3083,12 @@ export interface WorksCreateRequestIssue {
|
|
|
2652
3083
|
priority_v2?: number;
|
|
2653
3084
|
/** The sprint that the issue belongs to. */
|
|
2654
3085
|
sprint?: string;
|
|
3086
|
+
/**
|
|
3087
|
+
* Timestamp for when the work is expected to start.
|
|
3088
|
+
* @format date-time
|
|
3089
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3090
|
+
*/
|
|
3091
|
+
target_start_date?: string;
|
|
2655
3092
|
}
|
|
2656
3093
|
/** works-create-request-ticket */
|
|
2657
3094
|
export interface WorksCreateRequestTicket {
|
|
@@ -2722,6 +3159,8 @@ export interface WorksExportRequest {
|
|
|
2722
3159
|
reported_by?: string[];
|
|
2723
3160
|
/** The filter for stages. */
|
|
2724
3161
|
stage?: StageFilter;
|
|
3162
|
+
staged_info?: StagedInfoFilter;
|
|
3163
|
+
sync_metadata?: SyncMetadataFilter;
|
|
2725
3164
|
/**
|
|
2726
3165
|
* Filters for work with any of the provided tags.
|
|
2727
3166
|
* @example ["TAG-12345"]
|
|
@@ -2745,6 +3184,8 @@ export interface WorksFilterIssue {
|
|
|
2745
3184
|
* @example ["ACC-12345"]
|
|
2746
3185
|
*/
|
|
2747
3186
|
accounts?: string[];
|
|
3187
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3188
|
+
actual_start_date?: DateFilter;
|
|
2748
3189
|
/** Filters for issues with any of the provided priorities. */
|
|
2749
3190
|
priority?: IssuePriority[];
|
|
2750
3191
|
/** Filters for issues with any of the provided priority enum ids. */
|
|
@@ -2754,6 +3195,8 @@ export interface WorksFilterIssue {
|
|
|
2754
3195
|
* @example ["REV-AbCdEfGh"]
|
|
2755
3196
|
*/
|
|
2756
3197
|
rev_orgs?: string[];
|
|
3198
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3199
|
+
target_start_date?: DateFilter;
|
|
2757
3200
|
}
|
|
2758
3201
|
/** works-filter-ticket */
|
|
2759
3202
|
export interface WorksFilterTicket {
|
|
@@ -2841,6 +3284,8 @@ export interface WorksListRequest {
|
|
|
2841
3284
|
reported_by?: string[];
|
|
2842
3285
|
/** The filter for stages. */
|
|
2843
3286
|
stage?: StageFilter;
|
|
3287
|
+
staged_info?: StagedInfoFilter;
|
|
3288
|
+
sync_metadata?: SyncMetadataFilter;
|
|
2844
3289
|
/**
|
|
2845
3290
|
* Filters for work with any of the provided tags.
|
|
2846
3291
|
* @example ["TAG-12345"]
|
|
@@ -2874,7 +3319,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2874
3319
|
* @example "PROD-12345"
|
|
2875
3320
|
*/
|
|
2876
3321
|
applies_to_part?: string;
|
|
2877
|
-
artifacts?:
|
|
3322
|
+
artifacts?: WorksUpdateRequestArtifacts;
|
|
2878
3323
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
2879
3324
|
body?: string;
|
|
2880
3325
|
/**
|
|
@@ -2898,10 +3343,23 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2898
3343
|
title?: string;
|
|
2899
3344
|
type?: WorkType;
|
|
2900
3345
|
};
|
|
2901
|
-
/** works-update-request-
|
|
2902
|
-
export interface
|
|
3346
|
+
/** works-update-request-artifacts */
|
|
3347
|
+
export interface WorksUpdateRequestArtifacts {
|
|
3348
|
+
/**
|
|
3349
|
+
* Adds the provided artifacts (if not already present) to the field.
|
|
3350
|
+
* @maxItems 50
|
|
3351
|
+
* @example ["ARTIFACT-12345"]
|
|
3352
|
+
*/
|
|
3353
|
+
add?: string[];
|
|
3354
|
+
/**
|
|
3355
|
+
* Removes the provided artifacts (if they exist) from the field.
|
|
3356
|
+
* @maxItems 50
|
|
3357
|
+
* @example ["ARTIFACT-12345"]
|
|
3358
|
+
*/
|
|
3359
|
+
remove?: string[];
|
|
2903
3360
|
/**
|
|
2904
|
-
* Sets the
|
|
3361
|
+
* Sets the field to the provided artifacts.
|
|
3362
|
+
* @maxItems 50
|
|
2905
3363
|
* @example ["ARTIFACT-12345"]
|
|
2906
3364
|
*/
|
|
2907
3365
|
set?: string[];
|
|
@@ -2918,6 +3376,12 @@ export interface WorksUpdateRequestIssue {
|
|
|
2918
3376
|
priority_v2?: number;
|
|
2919
3377
|
/** Updates the sprint that the issue belongs to. */
|
|
2920
3378
|
sprint?: string | null;
|
|
3379
|
+
/**
|
|
3380
|
+
* Updates the timestamp for when the work is expected to start.
|
|
3381
|
+
* @format date-time
|
|
3382
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3383
|
+
*/
|
|
3384
|
+
target_start_date?: string | null;
|
|
2921
3385
|
}
|
|
2922
3386
|
/** works-update-request-issue-developed-with */
|
|
2923
3387
|
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
@@ -3028,6 +3492,190 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
3028
3492
|
* DevRev's REST API.
|
|
3029
3493
|
*/
|
|
3030
3494
|
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
3495
|
+
/**
|
|
3496
|
+
* @description Creates an account, which is a record representing a customer or an organization.
|
|
3497
|
+
*
|
|
3498
|
+
* @tags accounts
|
|
3499
|
+
* @name AccountsCreate
|
|
3500
|
+
* @request POST:/accounts.create
|
|
3501
|
+
* @secure
|
|
3502
|
+
*/
|
|
3503
|
+
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
|
|
3504
|
+
/**
|
|
3505
|
+
* @description Deletes an account.
|
|
3506
|
+
*
|
|
3507
|
+
* @tags accounts
|
|
3508
|
+
* @name AccountsDelete
|
|
3509
|
+
* @request POST:/accounts.delete
|
|
3510
|
+
* @secure
|
|
3511
|
+
*/
|
|
3512
|
+
accountsDelete: (data: AccountsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
3513
|
+
/**
|
|
3514
|
+
* @description Exports a collection of accounts.
|
|
3515
|
+
*
|
|
3516
|
+
* @tags accounts
|
|
3517
|
+
* @name AccountsExport
|
|
3518
|
+
* @request GET:/accounts.export
|
|
3519
|
+
* @secure
|
|
3520
|
+
*/
|
|
3521
|
+
accountsExport: (query?: {
|
|
3522
|
+
/** Filters for accounts created by the specified user(s). */
|
|
3523
|
+
created_by?: string[];
|
|
3524
|
+
/**
|
|
3525
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3526
|
+
* @format date-time
|
|
3527
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3528
|
+
*/
|
|
3529
|
+
'created_date.after'?: string;
|
|
3530
|
+
/**
|
|
3531
|
+
* Filters for objects created before the provided timestamp
|
|
3532
|
+
* (inclusive).
|
|
3533
|
+
* @format date-time
|
|
3534
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3535
|
+
*/
|
|
3536
|
+
'created_date.before'?: string;
|
|
3537
|
+
/** Array of display names of accounts to be filtered. */
|
|
3538
|
+
display_name?: string[];
|
|
3539
|
+
/** Array of references of accounts to be filtered. */
|
|
3540
|
+
external_refs?: string[];
|
|
3541
|
+
/**
|
|
3542
|
+
* The number of accounts to return. The default is '50'.
|
|
3543
|
+
* @format int32
|
|
3544
|
+
* @min 1
|
|
3545
|
+
* @max 500
|
|
3546
|
+
*/
|
|
3547
|
+
first?: number;
|
|
3548
|
+
/**
|
|
3549
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3550
|
+
* @format date-time
|
|
3551
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3552
|
+
*/
|
|
3553
|
+
'modified_date.after'?: string;
|
|
3554
|
+
/**
|
|
3555
|
+
* Filters for objects created before the provided timestamp
|
|
3556
|
+
* (inclusive).
|
|
3557
|
+
* @format date-time
|
|
3558
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3559
|
+
*/
|
|
3560
|
+
'modified_date.before'?: string;
|
|
3561
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
3562
|
+
sort_by?: string[];
|
|
3563
|
+
/** Filters for accounts on specified stages. */
|
|
3564
|
+
stage?: string[];
|
|
3565
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
3566
|
+
/**
|
|
3567
|
+
* @description Exports a collection of accounts.
|
|
3568
|
+
*
|
|
3569
|
+
* @tags accounts
|
|
3570
|
+
* @name AccountsExportPost
|
|
3571
|
+
* @request POST:/accounts.export
|
|
3572
|
+
* @secure
|
|
3573
|
+
*/
|
|
3574
|
+
accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
3575
|
+
/**
|
|
3576
|
+
* @description Retrieves an account's information.
|
|
3577
|
+
*
|
|
3578
|
+
* @tags accounts
|
|
3579
|
+
* @name AccountsGet
|
|
3580
|
+
* @request GET:/accounts.get
|
|
3581
|
+
* @secure
|
|
3582
|
+
*/
|
|
3583
|
+
accountsGet: (query: {
|
|
3584
|
+
/**
|
|
3585
|
+
* The ID of the account to be retrieved.
|
|
3586
|
+
* @example "ACC-12345"
|
|
3587
|
+
*/
|
|
3588
|
+
id: string;
|
|
3589
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* @description Retrieves an account's information.
|
|
3592
|
+
*
|
|
3593
|
+
* @tags accounts
|
|
3594
|
+
* @name AccountsGetPost
|
|
3595
|
+
* @request POST:/accounts.get
|
|
3596
|
+
* @secure
|
|
3597
|
+
*/
|
|
3598
|
+
accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
3599
|
+
/**
|
|
3600
|
+
* @description Gets a list of accounts.
|
|
3601
|
+
*
|
|
3602
|
+
* @tags accounts
|
|
3603
|
+
* @name AccountsList
|
|
3604
|
+
* @request GET:/accounts.list
|
|
3605
|
+
* @secure
|
|
3606
|
+
*/
|
|
3607
|
+
accountsList: (query?: {
|
|
3608
|
+
/** Filters for accounts created by the specified user(s). */
|
|
3609
|
+
created_by?: string[];
|
|
3610
|
+
/**
|
|
3611
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3612
|
+
* @format date-time
|
|
3613
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3614
|
+
*/
|
|
3615
|
+
'created_date.after'?: string;
|
|
3616
|
+
/**
|
|
3617
|
+
* Filters for objects created before the provided timestamp
|
|
3618
|
+
* (inclusive).
|
|
3619
|
+
* @format date-time
|
|
3620
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3621
|
+
*/
|
|
3622
|
+
'created_date.before'?: string;
|
|
3623
|
+
/**
|
|
3624
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3625
|
+
* starts from the beginning.
|
|
3626
|
+
*/
|
|
3627
|
+
cursor?: string;
|
|
3628
|
+
/** Array of display names of accounts to be filtered. */
|
|
3629
|
+
display_name?: string[];
|
|
3630
|
+
/** Array of references of accounts to be filtered. */
|
|
3631
|
+
external_refs?: string[];
|
|
3632
|
+
/**
|
|
3633
|
+
* The maximum number of accounts to return per page. The default is
|
|
3634
|
+
* '50'.
|
|
3635
|
+
* @format int32
|
|
3636
|
+
*/
|
|
3637
|
+
limit?: number;
|
|
3638
|
+
/**
|
|
3639
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3640
|
+
* used.
|
|
3641
|
+
*/
|
|
3642
|
+
mode?: ListMode;
|
|
3643
|
+
/**
|
|
3644
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
3645
|
+
* @format date-time
|
|
3646
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3647
|
+
*/
|
|
3648
|
+
'modified_date.after'?: string;
|
|
3649
|
+
/**
|
|
3650
|
+
* Filters for objects created before the provided timestamp
|
|
3651
|
+
* (inclusive).
|
|
3652
|
+
* @format date-time
|
|
3653
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3654
|
+
*/
|
|
3655
|
+
'modified_date.before'?: string;
|
|
3656
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
3657
|
+
sort_by?: string[];
|
|
3658
|
+
/** Filters for accounts on specified stages. */
|
|
3659
|
+
stage?: string[];
|
|
3660
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
3661
|
+
/**
|
|
3662
|
+
* @description Gets a list of accounts.
|
|
3663
|
+
*
|
|
3664
|
+
* @tags accounts
|
|
3665
|
+
* @name AccountsListPost
|
|
3666
|
+
* @request POST:/accounts.list
|
|
3667
|
+
* @secure
|
|
3668
|
+
*/
|
|
3669
|
+
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
3670
|
+
/**
|
|
3671
|
+
* @description Updates an account's information.
|
|
3672
|
+
*
|
|
3673
|
+
* @tags accounts
|
|
3674
|
+
* @name AccountsUpdate
|
|
3675
|
+
* @request POST:/accounts.update
|
|
3676
|
+
* @secure
|
|
3677
|
+
*/
|
|
3678
|
+
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
3031
3679
|
/**
|
|
3032
3680
|
* @description Gets the requested artifact's information.
|
|
3033
3681
|
*
|
|
@@ -3062,9 +3710,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3062
3710
|
* @request GET:/artifacts.list
|
|
3063
3711
|
* @secure
|
|
3064
3712
|
*/
|
|
3065
|
-
artifactsList: (query
|
|
3713
|
+
artifactsList: (query?: {
|
|
3066
3714
|
/** The ID of the object to filter artifacts. */
|
|
3067
|
-
parent_id
|
|
3715
|
+
parent_id?: string;
|
|
3068
3716
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
3069
3717
|
/**
|
|
3070
3718
|
* @description List the artifacts attached to an object.
|
|
@@ -3549,6 +4197,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3549
4197
|
* starts from the beginning.
|
|
3550
4198
|
*/
|
|
3551
4199
|
cursor?: string;
|
|
4200
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
4201
|
+
display_name?: string[];
|
|
3552
4202
|
/** List of external refs to filter Rev organizations for. */
|
|
3553
4203
|
external_ref?: string[];
|
|
3554
4204
|
/**
|
|
@@ -3598,6 +4248,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3598
4248
|
* @secure
|
|
3599
4249
|
*/
|
|
3600
4250
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any>>;
|
|
4251
|
+
/**
|
|
4252
|
+
* @description Gets an SLA tracker.
|
|
4253
|
+
*
|
|
4254
|
+
* @tags slas
|
|
4255
|
+
* @name SlaTrackersGet
|
|
4256
|
+
* @request GET:/sla-trackers.get
|
|
4257
|
+
* @secure
|
|
4258
|
+
*/
|
|
4259
|
+
slaTrackersGet: (query: {
|
|
4260
|
+
/** The ID of the SLA tracker to get. */
|
|
4261
|
+
id: string;
|
|
4262
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
4263
|
+
/**
|
|
4264
|
+
* @description Gets an SLA tracker.
|
|
4265
|
+
*
|
|
4266
|
+
* @tags slas
|
|
4267
|
+
* @name SlaTrackersGetPost
|
|
4268
|
+
* @request POST:/sla-trackers.get
|
|
4269
|
+
* @secure
|
|
4270
|
+
*/
|
|
4271
|
+
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
|
|
3601
4272
|
/**
|
|
3602
4273
|
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
3603
4274
|
*
|
|
@@ -3922,6 +4593,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3922
4593
|
reported_by?: string[];
|
|
3923
4594
|
/** Filters for records in the provided stage(s) by name. */
|
|
3924
4595
|
'stage.name'?: string[];
|
|
4596
|
+
/** Filters for issues that are staged. */
|
|
4597
|
+
'staged_info.is_staged'?: boolean;
|
|
4598
|
+
/** Filters for works with selected sync statuses. */
|
|
4599
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
4600
|
+
/** Filters for works modified with selected sync units. */
|
|
4601
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
4602
|
+
/** Filters for works with selected sync statuses. */
|
|
4603
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
4604
|
+
/** Filters for works modified with selected sync units. */
|
|
4605
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
4606
|
+
/** Filters for issues synced from this specific origin system. */
|
|
4607
|
+
'sync_metadata.origin_system'?: string[];
|
|
3925
4608
|
/**
|
|
3926
4609
|
* Filters for work with any of the provided tags.
|
|
3927
4610
|
* @example ["TAG-12345"]
|
|
@@ -4043,6 +4726,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4043
4726
|
reported_by?: string[];
|
|
4044
4727
|
/** Filters for records in the provided stage(s) by name. */
|
|
4045
4728
|
'stage.name'?: string[];
|
|
4729
|
+
/** Filters for issues that are staged. */
|
|
4730
|
+
'staged_info.is_staged'?: boolean;
|
|
4731
|
+
/** Filters for works with selected sync statuses. */
|
|
4732
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
4733
|
+
/** Filters for works modified with selected sync units. */
|
|
4734
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
4735
|
+
/** Filters for works with selected sync statuses. */
|
|
4736
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
4737
|
+
/** Filters for works modified with selected sync units. */
|
|
4738
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
4739
|
+
/** Filters for issues synced from this specific origin system. */
|
|
4740
|
+
'sync_metadata.origin_system'?: string[];
|
|
4046
4741
|
/**
|
|
4047
4742
|
* Filters for work with any of the provided tags.
|
|
4048
4743
|
* @example ["TAG-12345"]
|