@devrev/typescript-sdk 1.1.22 → 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,8 +14,279 @@ 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
|
+
}
|
|
233
|
+
/** artifact */
|
|
234
|
+
export type Artifact = AtomBase;
|
|
17
235
|
/** artifact-summary */
|
|
18
236
|
export type ArtifactSummary = AtomBaseSummary;
|
|
237
|
+
/**
|
|
238
|
+
* artifact-version
|
|
239
|
+
* The version of the artifact.
|
|
240
|
+
*/
|
|
241
|
+
export interface ArtifactVersion {
|
|
242
|
+
modified_by?: UserSummary;
|
|
243
|
+
/**
|
|
244
|
+
* The timestamp at which the version was created.
|
|
245
|
+
* @format date-time
|
|
246
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
247
|
+
*/
|
|
248
|
+
timestamp: string;
|
|
249
|
+
/** The version of the artifact. */
|
|
250
|
+
version: string;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* artifacts-get-request
|
|
254
|
+
* The request to get an artifact's information.
|
|
255
|
+
*/
|
|
256
|
+
export interface ArtifactsGetRequest {
|
|
257
|
+
/**
|
|
258
|
+
* The requested artifact's ID.
|
|
259
|
+
* @example "ARTIFACT-12345"
|
|
260
|
+
*/
|
|
261
|
+
id: string;
|
|
262
|
+
/** The version of the artifact that needs to be fetched. */
|
|
263
|
+
version?: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* artifacts-get-response
|
|
267
|
+
* The response to getting an artifact's information.
|
|
268
|
+
*/
|
|
269
|
+
export interface ArtifactsGetResponse {
|
|
270
|
+
artifact: Artifact;
|
|
271
|
+
/** The version of the artifact. */
|
|
272
|
+
version: ArtifactVersion;
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* artifacts-list-request
|
|
276
|
+
* The request to list artifacts attached to an object.
|
|
277
|
+
*/
|
|
278
|
+
export interface ArtifactsListRequest {
|
|
279
|
+
/** The ID of the object to filter artifacts. */
|
|
280
|
+
parent_id?: string;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* artifacts-list-response
|
|
284
|
+
* The response to list artifacts attached to an object.
|
|
285
|
+
*/
|
|
286
|
+
export interface ArtifactsListResponse {
|
|
287
|
+
/** The artifact's information. */
|
|
288
|
+
artifacts: Artifact[];
|
|
289
|
+
}
|
|
19
290
|
/**
|
|
20
291
|
* artifacts-locate-request
|
|
21
292
|
* The request to get an artifact's download URL.
|
|
@@ -50,6 +321,8 @@ export interface ArtifactsLocateResponse {
|
|
|
50
321
|
export interface ArtifactsPrepareRequest {
|
|
51
322
|
/** The name of the file that's being uploaded. */
|
|
52
323
|
file_name: string;
|
|
324
|
+
/** The type of file that's being uploaded. */
|
|
325
|
+
file_type?: string;
|
|
53
326
|
}
|
|
54
327
|
/**
|
|
55
328
|
* artifacts-prepare-response
|
|
@@ -233,8 +506,10 @@ export declare enum AuthTokenGrantType {
|
|
|
233
506
|
/** The type of the requested token. */
|
|
234
507
|
export declare enum AuthTokenRequestedTokenType {
|
|
235
508
|
UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
|
|
509
|
+
UrnDevrevParamsOauthTokenTypeAatActAs = "urn:devrev:params:oauth:token-type:aat:act-as",
|
|
236
510
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
237
511
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
512
|
+
UrnDevrevParamsOauthTokenTypeDevConnect = "urn:devrev:params:oauth:token-type:dev:connect",
|
|
238
513
|
UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
|
|
239
514
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
240
515
|
UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
|
|
@@ -275,7 +550,10 @@ export declare enum AuthTokenTokenType {
|
|
|
275
550
|
* type.
|
|
276
551
|
*/
|
|
277
552
|
export interface AuthTokensCreateRequest {
|
|
278
|
-
/**
|
|
553
|
+
/**
|
|
554
|
+
* The unique ID of the Dev user or the service account to
|
|
555
|
+
* impersonate.
|
|
556
|
+
*/
|
|
279
557
|
act_as?: string;
|
|
280
558
|
/** The expected audience values with respect to the token. */
|
|
281
559
|
aud?: string[];
|
|
@@ -504,6 +782,7 @@ export type Conversation = AtomBase & {
|
|
|
504
782
|
metadata?: ConversationMetadata;
|
|
505
783
|
/** Owner IDs for the conversation. */
|
|
506
784
|
owned_by?: UserSummary[];
|
|
785
|
+
sla_tracker?: SlaTrackerSummary;
|
|
507
786
|
/** Describes the current stage of a work item. */
|
|
508
787
|
stage?: LegacyStage;
|
|
509
788
|
/** Tags associated with the object. */
|
|
@@ -822,11 +1101,16 @@ export type Enhancement = PartBase;
|
|
|
822
1101
|
/** enhancement-summary */
|
|
823
1102
|
export type EnhancementSummary = PartBaseSummary;
|
|
824
1103
|
/** error-bad-request */
|
|
825
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
|
|
1104
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
826
1105
|
type: ErrorBadRequestType;
|
|
827
1106
|
};
|
|
828
1107
|
/** error-bad-request-bad-request */
|
|
829
1108
|
export type ErrorBadRequestBadRequest = object;
|
|
1109
|
+
/** error-bad-request-invalid-api-version */
|
|
1110
|
+
export interface ErrorBadRequestInvalidApiVersion {
|
|
1111
|
+
/** The provided API version. */
|
|
1112
|
+
value: string;
|
|
1113
|
+
}
|
|
830
1114
|
/** error-bad-request-invalid-enum-value */
|
|
831
1115
|
export interface ErrorBadRequestInvalidEnumValue {
|
|
832
1116
|
/** The allowed values for the field. */
|
|
@@ -843,6 +1127,8 @@ export interface ErrorBadRequestInvalidField {
|
|
|
843
1127
|
}
|
|
844
1128
|
/** error-bad-request-missing-dependency */
|
|
845
1129
|
export interface ErrorBadRequestMissingDependency {
|
|
1130
|
+
/** The dependent fields. */
|
|
1131
|
+
dependencies?: ErrorBadRequestMissingDependencyDependency[];
|
|
846
1132
|
/** The field on which the value depends. */
|
|
847
1133
|
dependent_field_name?: string;
|
|
848
1134
|
/** The value which needs to be set of the dependent field. */
|
|
@@ -852,6 +1138,13 @@ export interface ErrorBadRequestMissingDependency {
|
|
|
852
1138
|
/** The value that was received. */
|
|
853
1139
|
provided_field_value?: string;
|
|
854
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
|
+
}
|
|
855
1148
|
/** error-bad-request-missing-required-field */
|
|
856
1149
|
export interface ErrorBadRequestMissingRequiredField {
|
|
857
1150
|
/** The missing field's name. */
|
|
@@ -859,17 +1152,46 @@ export interface ErrorBadRequestMissingRequiredField {
|
|
|
859
1152
|
}
|
|
860
1153
|
/** error-bad-request-parse-error */
|
|
861
1154
|
export type ErrorBadRequestParseError = object;
|
|
1155
|
+
/**
|
|
1156
|
+
* error-bad-request-stale-schema-fragments
|
|
1157
|
+
* Error indicating that the request contained one or more stale schema
|
|
1158
|
+
* fragments, which are schema fragments that have been replaced by a
|
|
1159
|
+
* newer version and are therefore considered deprecated schema fragments.
|
|
1160
|
+
* The caller should refresh and use the latest schema fragments in their
|
|
1161
|
+
* request.
|
|
1162
|
+
*/
|
|
1163
|
+
export type ErrorBadRequestStaleSchemaFragments = object;
|
|
862
1164
|
export declare enum ErrorBadRequestType {
|
|
863
1165
|
BadRequest = "bad_request",
|
|
1166
|
+
InvalidApiVersion = "invalid_api_version",
|
|
864
1167
|
InvalidEnumValue = "invalid_enum_value",
|
|
865
1168
|
InvalidField = "invalid_field",
|
|
866
1169
|
MissingDependency = "missing_dependency",
|
|
867
1170
|
MissingRequiredField = "missing_required_field",
|
|
868
1171
|
ParseError = "parse_error",
|
|
1172
|
+
StaleSchemaFragments = "stale_schema_fragments",
|
|
1173
|
+
UnexpectedJsonType = "unexpected_json_type",
|
|
869
1174
|
ValueNotPermitted = "value_not_permitted"
|
|
870
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
|
+
}
|
|
871
1191
|
/** error-bad-request-value-not-permitted */
|
|
872
1192
|
export interface ErrorBadRequestValueNotPermitted {
|
|
1193
|
+
/** The allowed values for the field. */
|
|
1194
|
+
allowed_values?: string[];
|
|
873
1195
|
/** The field whose value is not permitted. */
|
|
874
1196
|
field_name: string;
|
|
875
1197
|
/** The reason the value isn't permitted. */
|
|
@@ -882,6 +1204,15 @@ export interface ErrorBase {
|
|
|
882
1204
|
/** The message associated with the error. */
|
|
883
1205
|
message?: string;
|
|
884
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
|
+
}
|
|
885
1216
|
/** error-forbidden */
|
|
886
1217
|
export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
|
|
887
1218
|
type: ErrorForbiddenType;
|
|
@@ -1046,6 +1377,19 @@ export interface EventSlaTrackerDeleted {
|
|
|
1046
1377
|
export interface EventSlaTrackerUpdated {
|
|
1047
1378
|
sla_tracker: SlaTracker;
|
|
1048
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
|
+
}
|
|
1049
1393
|
/** event-tag-created */
|
|
1050
1394
|
export interface EventTagCreated {
|
|
1051
1395
|
tag: Tag;
|
|
@@ -1127,6 +1471,12 @@ export type Issue = WorkBase & {
|
|
|
1127
1471
|
developed_with?: PartSummary[];
|
|
1128
1472
|
/** Priority of the work based upon impact and criticality. */
|
|
1129
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;
|
|
1130
1480
|
};
|
|
1131
1481
|
/** Priority of the work based upon impact and criticality. */
|
|
1132
1482
|
export declare enum IssuePriority {
|
|
@@ -1154,6 +1504,11 @@ export declare enum ListMode {
|
|
|
1154
1504
|
After = "after",
|
|
1155
1505
|
Before = "before"
|
|
1156
1506
|
}
|
|
1507
|
+
/** metric-definition-summary */
|
|
1508
|
+
export type MetricDefinitionSummary = AtomBaseSummary & {
|
|
1509
|
+
/** Human readable name of the metric. */
|
|
1510
|
+
name?: string;
|
|
1511
|
+
};
|
|
1157
1512
|
/** org-base */
|
|
1158
1513
|
export type OrgBase = AtomBase & {
|
|
1159
1514
|
/** Name of the Organization. */
|
|
@@ -1170,6 +1525,42 @@ export declare enum OrgEnvironment {
|
|
|
1170
1525
|
Staging = "staging",
|
|
1171
1526
|
Test = "test"
|
|
1172
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
|
+
};
|
|
1173
1564
|
/** org-summary */
|
|
1174
1565
|
export type OrgSummary = RevOrgSummary & {
|
|
1175
1566
|
type: OrgType;
|
|
@@ -1527,6 +1918,8 @@ export interface RevOrgsListRequest {
|
|
|
1527
1918
|
* iteration starts from the beginning.
|
|
1528
1919
|
*/
|
|
1529
1920
|
cursor?: string;
|
|
1921
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
1922
|
+
display_name?: string[];
|
|
1530
1923
|
/** List of external refs to filter Rev organizations for. */
|
|
1531
1924
|
external_ref?: string[];
|
|
1532
1925
|
/**
|
|
@@ -1640,6 +2033,27 @@ export interface SetTagWithValue {
|
|
|
1640
2033
|
*/
|
|
1641
2034
|
value?: string;
|
|
1642
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
|
+
};
|
|
1643
2057
|
/**
|
|
1644
2058
|
* sla-summary-filter
|
|
1645
2059
|
* The filter for SLA summary.
|
|
@@ -1647,6 +2061,8 @@ export interface SetTagWithValue {
|
|
|
1647
2061
|
export interface SlaSummaryFilter {
|
|
1648
2062
|
/** Filters for records with any of the provided SLA stages. */
|
|
1649
2063
|
stage?: SlaSummaryStage[];
|
|
2064
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2065
|
+
target_time?: DateFilter;
|
|
1650
2066
|
}
|
|
1651
2067
|
/**
|
|
1652
2068
|
* The stage of the SLA. This is the metric stage which is closest to
|
|
@@ -1660,7 +2076,37 @@ export declare enum SlaSummaryStage {
|
|
|
1660
2076
|
Warning = "warning"
|
|
1661
2077
|
}
|
|
1662
2078
|
/** sla-tracker */
|
|
1663
|
-
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
|
+
}
|
|
1664
2110
|
/** snap-widget */
|
|
1665
2111
|
export interface SnapWidget {
|
|
1666
2112
|
type: SnapWidgetType;
|
|
@@ -1690,11 +2136,62 @@ export interface StageUpdate {
|
|
|
1690
2136
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
1691
2137
|
name?: string;
|
|
1692
2138
|
}
|
|
2139
|
+
/** staged-info-filter */
|
|
2140
|
+
export interface StagedInfoFilter {
|
|
2141
|
+
/** Filters for issues that are staged. */
|
|
2142
|
+
is_staged?: boolean;
|
|
2143
|
+
}
|
|
1693
2144
|
/**
|
|
1694
2145
|
* survey-aggregation-filter
|
|
1695
2146
|
* The filter for survey aggregation.
|
|
1696
2147
|
*/
|
|
1697
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
|
+
}
|
|
1698
2195
|
/** sys-user-summary */
|
|
1699
2196
|
export type SysUserSummary = UserBaseSummary;
|
|
1700
2197
|
/** tag */
|
|
@@ -1871,13 +2368,22 @@ export interface TagsUpdateResponse {
|
|
|
1871
2368
|
}
|
|
1872
2369
|
/** ticket */
|
|
1873
2370
|
export type Ticket = WorkBase & {
|
|
2371
|
+
/** Channels of the ticket. */
|
|
2372
|
+
channels?: TicketChannels[];
|
|
1874
2373
|
group?: GroupSummary;
|
|
1875
2374
|
rev_org?: OrgSummary;
|
|
1876
2375
|
/** Severity of the ticket. */
|
|
1877
2376
|
severity?: TicketSeverity;
|
|
2377
|
+
sla_tracker?: SlaTrackerSummary;
|
|
1878
2378
|
/** Source channel of the ticket. */
|
|
1879
2379
|
source_channel?: string;
|
|
1880
2380
|
};
|
|
2381
|
+
/** Channels of the ticket. */
|
|
2382
|
+
export declare enum TicketChannels {
|
|
2383
|
+
Email = "email",
|
|
2384
|
+
Plug = "plug",
|
|
2385
|
+
Slack = "slack"
|
|
2386
|
+
}
|
|
1881
2387
|
/** Severity of the ticket. */
|
|
1882
2388
|
export declare enum TicketSeverity {
|
|
1883
2389
|
Blocker = "blocker",
|
|
@@ -1946,7 +2452,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1946
2452
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
1947
2453
|
/**
|
|
1948
2454
|
* The IDs of the artifacts attached to the comment.
|
|
1949
|
-
* @maxItems
|
|
2455
|
+
* @maxItems 50
|
|
1950
2456
|
* @example ["ARTIFACT-12345"]
|
|
1951
2457
|
*/
|
|
1952
2458
|
artifacts?: string[];
|
|
@@ -2096,7 +2602,7 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
2096
2602
|
remove?: string[];
|
|
2097
2603
|
/**
|
|
2098
2604
|
* Sets the field to the provided artifacts.
|
|
2099
|
-
* @maxItems
|
|
2605
|
+
* @maxItems 50
|
|
2100
2606
|
* @example ["ARTIFACT-12345"]
|
|
2101
2607
|
*/
|
|
2102
2608
|
set?: string[];
|
|
@@ -2261,6 +2767,9 @@ export interface WebhookEventRequest {
|
|
|
2261
2767
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
2262
2768
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
2263
2769
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
2770
|
+
survey_response_created?: EventSurveyResponseCreated;
|
|
2771
|
+
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
2772
|
+
survey_response_updated?: EventSurveyResponseUpdated;
|
|
2264
2773
|
tag_created?: EventTagCreated;
|
|
2265
2774
|
tag_deleted?: EventTagDeleted;
|
|
2266
2775
|
tag_updated?: EventTagUpdated;
|
|
@@ -2320,6 +2829,9 @@ export declare enum WebhookEventType {
|
|
|
2320
2829
|
RevUserCreated = "rev_user_created",
|
|
2321
2830
|
RevUserDeleted = "rev_user_deleted",
|
|
2322
2831
|
RevUserUpdated = "rev_user_updated",
|
|
2832
|
+
SlaTrackerCreated = "sla_tracker_created",
|
|
2833
|
+
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
2834
|
+
SlaTrackerUpdated = "sla_tracker_updated",
|
|
2323
2835
|
TagCreated = "tag_created",
|
|
2324
2836
|
TagDeleted = "tag_deleted",
|
|
2325
2837
|
TagUpdated = "tag_updated",
|
|
@@ -2571,9 +3083,17 @@ export interface WorksCreateRequestIssue {
|
|
|
2571
3083
|
priority_v2?: number;
|
|
2572
3084
|
/** The sprint that the issue belongs to. */
|
|
2573
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;
|
|
2574
3092
|
}
|
|
2575
3093
|
/** works-create-request-ticket */
|
|
2576
3094
|
export interface WorksCreateRequestTicket {
|
|
3095
|
+
/** Channels of the ticket. */
|
|
3096
|
+
channels?: TicketChannels[];
|
|
2577
3097
|
/** The group that the ticket is associated with. */
|
|
2578
3098
|
group?: string;
|
|
2579
3099
|
/** Whether the ticket is spam. */
|
|
@@ -2632,8 +3152,15 @@ export interface WorksExportRequest {
|
|
|
2632
3152
|
* @example ["DEVU-12345"]
|
|
2633
3153
|
*/
|
|
2634
3154
|
owned_by?: string[];
|
|
3155
|
+
/**
|
|
3156
|
+
* Filters for work reported by any of these users.
|
|
3157
|
+
* @example ["DEVU-12345"]
|
|
3158
|
+
*/
|
|
3159
|
+
reported_by?: string[];
|
|
2635
3160
|
/** The filter for stages. */
|
|
2636
3161
|
stage?: StageFilter;
|
|
3162
|
+
staged_info?: StagedInfoFilter;
|
|
3163
|
+
sync_metadata?: SyncMetadataFilter;
|
|
2637
3164
|
/**
|
|
2638
3165
|
* Filters for work with any of the provided tags.
|
|
2639
3166
|
* @example ["TAG-12345"]
|
|
@@ -2657,6 +3184,8 @@ export interface WorksFilterIssue {
|
|
|
2657
3184
|
* @example ["ACC-12345"]
|
|
2658
3185
|
*/
|
|
2659
3186
|
accounts?: string[];
|
|
3187
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3188
|
+
actual_start_date?: DateFilter;
|
|
2660
3189
|
/** Filters for issues with any of the provided priorities. */
|
|
2661
3190
|
priority?: IssuePriority[];
|
|
2662
3191
|
/** Filters for issues with any of the provided priority enum ids. */
|
|
@@ -2666,9 +3195,13 @@ export interface WorksFilterIssue {
|
|
|
2666
3195
|
* @example ["REV-AbCdEfGh"]
|
|
2667
3196
|
*/
|
|
2668
3197
|
rev_orgs?: string[];
|
|
3198
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3199
|
+
target_start_date?: DateFilter;
|
|
2669
3200
|
}
|
|
2670
3201
|
/** works-filter-ticket */
|
|
2671
3202
|
export interface WorksFilterTicket {
|
|
3203
|
+
/** Filters for tickets with any of the provided channels. */
|
|
3204
|
+
channels?: TicketChannels[];
|
|
2672
3205
|
/** Filters for tickets belonging to specific groups. */
|
|
2673
3206
|
group?: string[];
|
|
2674
3207
|
/** Filters for tickets that are spam. */
|
|
@@ -2744,8 +3277,15 @@ export interface WorksListRequest {
|
|
|
2744
3277
|
* @example ["DEVU-12345"]
|
|
2745
3278
|
*/
|
|
2746
3279
|
owned_by?: string[];
|
|
3280
|
+
/**
|
|
3281
|
+
* Filters for work reported by any of these users.
|
|
3282
|
+
* @example ["DEVU-12345"]
|
|
3283
|
+
*/
|
|
3284
|
+
reported_by?: string[];
|
|
2747
3285
|
/** The filter for stages. */
|
|
2748
3286
|
stage?: StageFilter;
|
|
3287
|
+
staged_info?: StagedInfoFilter;
|
|
3288
|
+
sync_metadata?: SyncMetadataFilter;
|
|
2749
3289
|
/**
|
|
2750
3290
|
* Filters for work with any of the provided tags.
|
|
2751
3291
|
* @example ["TAG-12345"]
|
|
@@ -2779,7 +3319,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2779
3319
|
* @example "PROD-12345"
|
|
2780
3320
|
*/
|
|
2781
3321
|
applies_to_part?: string;
|
|
2782
|
-
artifacts?:
|
|
3322
|
+
artifacts?: WorksUpdateRequestArtifacts;
|
|
2783
3323
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
2784
3324
|
body?: string;
|
|
2785
3325
|
/**
|
|
@@ -2803,10 +3343,23 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2803
3343
|
title?: string;
|
|
2804
3344
|
type?: WorkType;
|
|
2805
3345
|
};
|
|
2806
|
-
/** works-update-request-
|
|
2807
|
-
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[];
|
|
2808
3354
|
/**
|
|
2809
|
-
*
|
|
3355
|
+
* Removes the provided artifacts (if they exist) from the field.
|
|
3356
|
+
* @maxItems 50
|
|
3357
|
+
* @example ["ARTIFACT-12345"]
|
|
3358
|
+
*/
|
|
3359
|
+
remove?: string[];
|
|
3360
|
+
/**
|
|
3361
|
+
* Sets the field to the provided artifacts.
|
|
3362
|
+
* @maxItems 50
|
|
2810
3363
|
* @example ["ARTIFACT-12345"]
|
|
2811
3364
|
*/
|
|
2812
3365
|
set?: string[];
|
|
@@ -2823,6 +3376,12 @@ export interface WorksUpdateRequestIssue {
|
|
|
2823
3376
|
priority_v2?: number;
|
|
2824
3377
|
/** Updates the sprint that the issue belongs to. */
|
|
2825
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;
|
|
2826
3385
|
}
|
|
2827
3386
|
/** works-update-request-issue-developed-with */
|
|
2828
3387
|
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
@@ -2862,6 +3421,7 @@ export interface WorksUpdateRequestTags {
|
|
|
2862
3421
|
}
|
|
2863
3422
|
/** works-update-request-ticket */
|
|
2864
3423
|
export interface WorksUpdateRequestTicket {
|
|
3424
|
+
channels?: WorksUpdateRequestTicketChannels;
|
|
2865
3425
|
/** Updates the group that the ticket is associated with. */
|
|
2866
3426
|
group?: string | null;
|
|
2867
3427
|
/** Updates whether the ticket is spam. */
|
|
@@ -2874,6 +3434,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
2874
3434
|
/** Severity of the ticket. */
|
|
2875
3435
|
severity?: TicketSeverity;
|
|
2876
3436
|
}
|
|
3437
|
+
/** works-update-request-ticket-channels */
|
|
3438
|
+
export interface WorksUpdateRequestTicketChannels {
|
|
3439
|
+
/** Sets the channels to the provided channels. */
|
|
3440
|
+
set?: TicketChannels[];
|
|
3441
|
+
}
|
|
2877
3442
|
/** works-update-response */
|
|
2878
3443
|
export interface WorksUpdateResponse {
|
|
2879
3444
|
work: Work;
|
|
@@ -2927,6 +3492,237 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
2927
3492
|
* DevRev's REST API.
|
|
2928
3493
|
*/
|
|
2929
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>>;
|
|
3679
|
+
/**
|
|
3680
|
+
* @description Gets the requested artifact's information.
|
|
3681
|
+
*
|
|
3682
|
+
* @tags artifacts
|
|
3683
|
+
* @name ArtifactsGet
|
|
3684
|
+
* @request GET:/artifacts.get
|
|
3685
|
+
* @secure
|
|
3686
|
+
*/
|
|
3687
|
+
artifactsGet: (query: {
|
|
3688
|
+
/**
|
|
3689
|
+
* The requested artifact's ID.
|
|
3690
|
+
* @example "ARTIFACT-12345"
|
|
3691
|
+
*/
|
|
3692
|
+
id: string;
|
|
3693
|
+
/** The version of the artifact that needs to be fetched. */
|
|
3694
|
+
version?: string;
|
|
3695
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
3696
|
+
/**
|
|
3697
|
+
* @description Gets the requested artifact's information.
|
|
3698
|
+
*
|
|
3699
|
+
* @tags artifacts
|
|
3700
|
+
* @name ArtifactsGetPost
|
|
3701
|
+
* @request POST:/artifacts.get
|
|
3702
|
+
* @secure
|
|
3703
|
+
*/
|
|
3704
|
+
artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
3705
|
+
/**
|
|
3706
|
+
* @description List the artifacts attached to an object.
|
|
3707
|
+
*
|
|
3708
|
+
* @tags artifacts
|
|
3709
|
+
* @name ArtifactsList
|
|
3710
|
+
* @request GET:/artifacts.list
|
|
3711
|
+
* @secure
|
|
3712
|
+
*/
|
|
3713
|
+
artifactsList: (query?: {
|
|
3714
|
+
/** The ID of the object to filter artifacts. */
|
|
3715
|
+
parent_id?: string;
|
|
3716
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
3717
|
+
/**
|
|
3718
|
+
* @description List the artifacts attached to an object.
|
|
3719
|
+
*
|
|
3720
|
+
* @tags artifacts
|
|
3721
|
+
* @name ArtifactsListPost
|
|
3722
|
+
* @request POST:/artifacts.list
|
|
3723
|
+
* @secure
|
|
3724
|
+
*/
|
|
3725
|
+
artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
2930
3726
|
/**
|
|
2931
3727
|
* @description Gets the download URL for the artifact.
|
|
2932
3728
|
*
|
|
@@ -3401,6 +4197,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3401
4197
|
* starts from the beginning.
|
|
3402
4198
|
*/
|
|
3403
4199
|
cursor?: string;
|
|
4200
|
+
/** Array of display names of Rev orgs to be filtered. */
|
|
4201
|
+
display_name?: string[];
|
|
3404
4202
|
/** List of external refs to filter Rev organizations for. */
|
|
3405
4203
|
external_ref?: string[];
|
|
3406
4204
|
/**
|
|
@@ -3450,6 +4248,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3450
4248
|
* @secure
|
|
3451
4249
|
*/
|
|
3452
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>>;
|
|
3453
4272
|
/**
|
|
3454
4273
|
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
3455
4274
|
*
|
|
@@ -3767,13 +4586,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3767
4586
|
* @example ["DEVU-12345"]
|
|
3768
4587
|
*/
|
|
3769
4588
|
owned_by?: string[];
|
|
4589
|
+
/**
|
|
4590
|
+
* Filters for work reported by any of these users.
|
|
4591
|
+
* @example ["DEVU-12345"]
|
|
4592
|
+
*/
|
|
4593
|
+
reported_by?: string[];
|
|
3770
4594
|
/** Filters for records in the provided stage(s) by name. */
|
|
3771
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[];
|
|
3772
4608
|
/**
|
|
3773
4609
|
* Filters for work with any of the provided tags.
|
|
3774
4610
|
* @example ["TAG-12345"]
|
|
3775
4611
|
*/
|
|
3776
4612
|
tags?: string[];
|
|
4613
|
+
/** Filters for tickets with any of the provided channels. */
|
|
4614
|
+
'ticket.channels'?: TicketChannels[];
|
|
3777
4615
|
/** Filters for tickets belonging to specific groups. */
|
|
3778
4616
|
'ticket.group'?: string[];
|
|
3779
4617
|
/** Filters for tickets that are spam. */
|
|
@@ -3881,13 +4719,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3881
4719
|
* @example ["DEVU-12345"]
|
|
3882
4720
|
*/
|
|
3883
4721
|
owned_by?: string[];
|
|
4722
|
+
/**
|
|
4723
|
+
* Filters for work reported by any of these users.
|
|
4724
|
+
* @example ["DEVU-12345"]
|
|
4725
|
+
*/
|
|
4726
|
+
reported_by?: string[];
|
|
3884
4727
|
/** Filters for records in the provided stage(s) by name. */
|
|
3885
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[];
|
|
3886
4741
|
/**
|
|
3887
4742
|
* Filters for work with any of the provided tags.
|
|
3888
4743
|
* @example ["TAG-12345"]
|
|
3889
4744
|
*/
|
|
3890
4745
|
tags?: string[];
|
|
4746
|
+
/** Filters for tickets with any of the provided channels. */
|
|
4747
|
+
'ticket.channels'?: TicketChannels[];
|
|
3891
4748
|
/** Filters for tickets belonging to specific groups. */
|
|
3892
4749
|
'ticket.group'?: string[];
|
|
3893
4750
|
/** Filters for tickets that are spam. */
|