@argos-ci/api-client 0.16.0 → 0.17.0
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.
- package/dist/chunk-CfYAbeIz.mjs +13 -0
- package/dist/index.d.mts +889 -0
- package/dist/index.mjs +233 -0
- package/package.json +11 -11
- package/dist/index.d.ts +0 -1069
- package/dist/index.js +0 -259
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,889 @@
|
|
|
1
|
+
import * as _$openapi_fetch0 from "openapi-fetch";
|
|
2
|
+
|
|
3
|
+
//#region src/schema.d.ts
|
|
4
|
+
declare namespace schema_d_exports {
|
|
5
|
+
export { $defs, components, operations, paths, webhooks };
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* This file was auto-generated by openapi-typescript.
|
|
9
|
+
* Do not make direct changes to the file.
|
|
10
|
+
*/
|
|
11
|
+
interface paths {
|
|
12
|
+
"/builds": {
|
|
13
|
+
parameters: {
|
|
14
|
+
query?: never;
|
|
15
|
+
header?: never;
|
|
16
|
+
path?: never;
|
|
17
|
+
cookie?: never;
|
|
18
|
+
};
|
|
19
|
+
get?: never;
|
|
20
|
+
put?: never;
|
|
21
|
+
post: operations["createBuild"];
|
|
22
|
+
delete?: never;
|
|
23
|
+
options?: never;
|
|
24
|
+
head?: never;
|
|
25
|
+
patch?: never;
|
|
26
|
+
trace?: never;
|
|
27
|
+
};
|
|
28
|
+
"/builds/finalize": {
|
|
29
|
+
parameters: {
|
|
30
|
+
query?: never;
|
|
31
|
+
header?: never;
|
|
32
|
+
path?: never;
|
|
33
|
+
cookie?: never;
|
|
34
|
+
};
|
|
35
|
+
get?: never;
|
|
36
|
+
put?: never;
|
|
37
|
+
post: operations["finalizeBuilds"];
|
|
38
|
+
delete?: never;
|
|
39
|
+
options?: never;
|
|
40
|
+
head?: never;
|
|
41
|
+
patch?: never;
|
|
42
|
+
trace?: never;
|
|
43
|
+
};
|
|
44
|
+
"/builds/{buildId}": {
|
|
45
|
+
parameters: {
|
|
46
|
+
query?: never;
|
|
47
|
+
header?: never;
|
|
48
|
+
path?: never;
|
|
49
|
+
cookie?: never;
|
|
50
|
+
};
|
|
51
|
+
get: operations["getBuild"];
|
|
52
|
+
put: operations["updateBuild"];
|
|
53
|
+
post?: never;
|
|
54
|
+
delete?: never;
|
|
55
|
+
options?: never;
|
|
56
|
+
head?: never;
|
|
57
|
+
patch?: never;
|
|
58
|
+
trace?: never;
|
|
59
|
+
};
|
|
60
|
+
"/builds/{buildId}/diffs": {
|
|
61
|
+
parameters: {
|
|
62
|
+
query?: never;
|
|
63
|
+
header?: never;
|
|
64
|
+
path?: never;
|
|
65
|
+
cookie?: never;
|
|
66
|
+
};
|
|
67
|
+
get: operations["getBuildDiffs"];
|
|
68
|
+
put?: never;
|
|
69
|
+
post?: never;
|
|
70
|
+
delete?: never;
|
|
71
|
+
options?: never;
|
|
72
|
+
head?: never;
|
|
73
|
+
patch?: never;
|
|
74
|
+
trace?: never;
|
|
75
|
+
};
|
|
76
|
+
"/project": {
|
|
77
|
+
parameters: {
|
|
78
|
+
query?: never;
|
|
79
|
+
header?: never;
|
|
80
|
+
path?: never;
|
|
81
|
+
cookie?: never;
|
|
82
|
+
};
|
|
83
|
+
get: operations["getAuthProject"];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
"/project/builds": {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
get: operations["getAuthProjectBuilds"];
|
|
100
|
+
put?: never;
|
|
101
|
+
post?: never;
|
|
102
|
+
delete?: never;
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
patch?: never;
|
|
106
|
+
trace?: never;
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
type webhooks = Record<string, never>;
|
|
110
|
+
interface components {
|
|
111
|
+
schemas: {
|
|
112
|
+
/** @description SHA1 hash */Sha1Hash: string; /** @description SHA256 hash */
|
|
113
|
+
Sha256Hash: string;
|
|
114
|
+
/**
|
|
115
|
+
* @description A unique identifier for the build
|
|
116
|
+
* @example 12345
|
|
117
|
+
*/
|
|
118
|
+
BuildId: string; /** @description Screenshot input */
|
|
119
|
+
ScreenshotInput: {
|
|
120
|
+
key: string;
|
|
121
|
+
name: string;
|
|
122
|
+
baseName?: string | null;
|
|
123
|
+
parentName?: string | null;
|
|
124
|
+
metadata?: {
|
|
125
|
+
/**
|
|
126
|
+
* @description Ignored. Can be set to get completions, validations and documentation in some editors.
|
|
127
|
+
* @example https://api.argos-ci.com/v2/screenshot-metadata.json
|
|
128
|
+
*/
|
|
129
|
+
$schema?: string; /** @description The URL of the page that was screenshotted */
|
|
130
|
+
url?: string | null; /** @description An URL to an accessible preview of the screenshot */
|
|
131
|
+
previewUrl?: string | null;
|
|
132
|
+
viewport?: {
|
|
133
|
+
/** @description The width of the viewport */width: number; /** @description The height of the viewport */
|
|
134
|
+
height: number;
|
|
135
|
+
} | null; /** @description The color scheme when the screenshot was taken */
|
|
136
|
+
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
137
|
+
mediaType?: ("screen" | "print") | null;
|
|
138
|
+
test?: {
|
|
139
|
+
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
140
|
+
title: string; /** @description The path of titles leading to the test */
|
|
141
|
+
titlePath: string[]; /** @description The number of retries for the test */
|
|
142
|
+
retries?: number | null; /** @description The current retry count */
|
|
143
|
+
retry?: number | null; /** @description The repeat count for the test */
|
|
144
|
+
repeat?: number | null; /** @description The location of the test in the source code */
|
|
145
|
+
location?: {
|
|
146
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
147
|
+
line: number; /** @description The column number in the file */
|
|
148
|
+
column: number;
|
|
149
|
+
}; /** @description Annotations associated to the test */
|
|
150
|
+
annotations?: {
|
|
151
|
+
/** @description The type of annotation */type: string; /** @description The description of the annotation */
|
|
152
|
+
description?: string; /** @description The location of the annotation in the source code */
|
|
153
|
+
location?: {
|
|
154
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
155
|
+
line: number; /** @description The column number in the file */
|
|
156
|
+
column: number;
|
|
157
|
+
};
|
|
158
|
+
}[]; /** @description Tags associated to the test */
|
|
159
|
+
tags?: string[];
|
|
160
|
+
} | null;
|
|
161
|
+
browser?: {
|
|
162
|
+
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
163
|
+
version: string;
|
|
164
|
+
} | null; /** @description The automation library that generated the screenshot */
|
|
165
|
+
automationLibrary: {
|
|
166
|
+
/** @description The name of the automation library */name: string; /** @description The version of the automation library */
|
|
167
|
+
version: string;
|
|
168
|
+
}; /** @description The Argos SDK that generated the screenshot */
|
|
169
|
+
sdk: {
|
|
170
|
+
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
171
|
+
version: string;
|
|
172
|
+
}; /** @description Storybook story metadata */
|
|
173
|
+
story?: {
|
|
174
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
175
|
+
tags?: string[]; /** @description Story mode */
|
|
176
|
+
mode?: string; /** @description True if the story has a play function */
|
|
177
|
+
play?: boolean;
|
|
178
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
179
|
+
tags?: string[];
|
|
180
|
+
} | null;
|
|
181
|
+
pwTraceKey?: string | null;
|
|
182
|
+
threshold?: number | null; /** @default image/png */
|
|
183
|
+
contentType: string;
|
|
184
|
+
}; /** @description Build metadata */
|
|
185
|
+
BuildMetadata: {
|
|
186
|
+
/** @description Test suite report */testReport?: {
|
|
187
|
+
/**
|
|
188
|
+
* @description Status of the test suite
|
|
189
|
+
* @enum {string}
|
|
190
|
+
*/
|
|
191
|
+
status: "passed" | "failed" | "timedout" | "interrupted";
|
|
192
|
+
stats?: {
|
|
193
|
+
/** @description Date when the test suite started */startTime?: string; /** @description Duration of the test suite in milliseconds */
|
|
194
|
+
duration?: number;
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
}; /** @description Build */
|
|
198
|
+
Build: {
|
|
199
|
+
id: components["schemas"]["BuildId"]; /** @description The build number */
|
|
200
|
+
number: number; /** @description The head reference of the build */
|
|
201
|
+
head: components["schemas"]["BuildGitReference"]; /** @description The base reference of the build */
|
|
202
|
+
base: components["schemas"]["BuildGitReference"] | null; /** @description The status of the build */
|
|
203
|
+
status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted"); /** @description The conclusion of the build */
|
|
204
|
+
conclusion: ("no-changes" | "changes-detected") | null; /** @description Stats of the diffs present in the build */
|
|
205
|
+
stats: {
|
|
206
|
+
/** @description Added snapshots */added: number; /** @description Removed snapshots */
|
|
207
|
+
removed: number; /** @description Unchanged snapshots */
|
|
208
|
+
unchanged: number; /** @description Changed snapshots */
|
|
209
|
+
changed: number; /** @description Ignored snapshots */
|
|
210
|
+
ignored: number; /** @description Failure screenshots */
|
|
211
|
+
failure: number; /** @description Retry failure screenshots */
|
|
212
|
+
retryFailure: number; /** @description Total number of snapshots */
|
|
213
|
+
total: number;
|
|
214
|
+
} | null;
|
|
215
|
+
metadata: {
|
|
216
|
+
/** @description Test suite report */testReport?: {
|
|
217
|
+
/**
|
|
218
|
+
* @description Status of the test suite
|
|
219
|
+
* @enum {string}
|
|
220
|
+
*/
|
|
221
|
+
status: "passed" | "failed" | "timedout" | "interrupted";
|
|
222
|
+
stats?: {
|
|
223
|
+
/** @description Date when the test suite started */startTime?: string; /** @description Duration of the test suite in milliseconds */
|
|
224
|
+
duration?: number;
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
} | null;
|
|
228
|
+
/**
|
|
229
|
+
* Format: uri
|
|
230
|
+
* @description The URL of the build
|
|
231
|
+
*/
|
|
232
|
+
url: string; /** @description The notification payload for the build */
|
|
233
|
+
notification: {
|
|
234
|
+
description: string;
|
|
235
|
+
context: string;
|
|
236
|
+
github: {
|
|
237
|
+
/** @enum {string} */state: "pending" | "success" | "error" | "failure";
|
|
238
|
+
};
|
|
239
|
+
gitlab: {
|
|
240
|
+
/** @enum {string} */state: "pending" | "running" | "success" | "failed" | "canceled";
|
|
241
|
+
};
|
|
242
|
+
} | null;
|
|
243
|
+
}; /** @description Git reference */
|
|
244
|
+
BuildGitReference: {
|
|
245
|
+
/** @description The commit SHA */sha: components["schemas"]["Sha1Hash"]; /** @description The branch name */
|
|
246
|
+
branch: string;
|
|
247
|
+
}; /** @description Error response */
|
|
248
|
+
Error: {
|
|
249
|
+
error: string;
|
|
250
|
+
details?: {
|
|
251
|
+
message: string;
|
|
252
|
+
}[];
|
|
253
|
+
}; /** @description Page information */
|
|
254
|
+
PageInfo: {
|
|
255
|
+
/** @description Total number of items */total: number; /** @description Current page number */
|
|
256
|
+
page: number; /** @description Number of items per page */
|
|
257
|
+
perPage: number;
|
|
258
|
+
}; /** @description Snapshot diff */
|
|
259
|
+
SnapshotDiff: {
|
|
260
|
+
/** @description Unique identifier of the snapshot diff */id: string; /** @description Name of the snapshot diff */
|
|
261
|
+
name: string;
|
|
262
|
+
/**
|
|
263
|
+
* @description Status of the snapshot diff
|
|
264
|
+
* @enum {string}
|
|
265
|
+
*/
|
|
266
|
+
status: "pending" | "removed" | "failure" | "added" | "changed" | "unchanged" | "retryFailure" | "ignored"; /** @description Similarity score between snapshots */
|
|
267
|
+
score: number | null; /** @description Grouping key for the snapshot diff */
|
|
268
|
+
group: string | null; /** @description Parent name of the snapshot (usually the story id) */
|
|
269
|
+
parentName: string | null; /** @description URL of the diff image */
|
|
270
|
+
url: string | null;
|
|
271
|
+
base: {
|
|
272
|
+
/** @description Unique identifier of the snapshot */id: string; /** @description Name of the snapshot */
|
|
273
|
+
name: string;
|
|
274
|
+
metadata: {
|
|
275
|
+
/**
|
|
276
|
+
* @description Ignored. Can be set to get completions, validations and documentation in some editors.
|
|
277
|
+
* @example https://api.argos-ci.com/v2/screenshot-metadata.json
|
|
278
|
+
*/
|
|
279
|
+
$schema?: string; /** @description The URL of the page that was screenshotted */
|
|
280
|
+
url?: string | null; /** @description An URL to an accessible preview of the screenshot */
|
|
281
|
+
previewUrl?: string | null;
|
|
282
|
+
viewport?: {
|
|
283
|
+
/** @description The width of the viewport */width: number; /** @description The height of the viewport */
|
|
284
|
+
height: number;
|
|
285
|
+
} | null; /** @description The color scheme when the screenshot was taken */
|
|
286
|
+
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
287
|
+
mediaType?: ("screen" | "print") | null;
|
|
288
|
+
test?: {
|
|
289
|
+
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
290
|
+
title: string; /** @description The path of titles leading to the test */
|
|
291
|
+
titlePath: string[]; /** @description The number of retries for the test */
|
|
292
|
+
retries?: number | null; /** @description The current retry count */
|
|
293
|
+
retry?: number | null; /** @description The repeat count for the test */
|
|
294
|
+
repeat?: number | null; /** @description The location of the test in the source code */
|
|
295
|
+
location?: {
|
|
296
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
297
|
+
line: number; /** @description The column number in the file */
|
|
298
|
+
column: number;
|
|
299
|
+
}; /** @description Annotations associated to the test */
|
|
300
|
+
annotations?: {
|
|
301
|
+
/** @description The type of annotation */type: string; /** @description The description of the annotation */
|
|
302
|
+
description?: string; /** @description The location of the annotation in the source code */
|
|
303
|
+
location?: {
|
|
304
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
305
|
+
line: number; /** @description The column number in the file */
|
|
306
|
+
column: number;
|
|
307
|
+
};
|
|
308
|
+
}[]; /** @description Tags associated to the test */
|
|
309
|
+
tags?: string[];
|
|
310
|
+
} | null;
|
|
311
|
+
browser?: {
|
|
312
|
+
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
313
|
+
version: string;
|
|
314
|
+
} | null; /** @description The automation library that generated the screenshot */
|
|
315
|
+
automationLibrary: {
|
|
316
|
+
/** @description The name of the automation library */name: string; /** @description The version of the automation library */
|
|
317
|
+
version: string;
|
|
318
|
+
}; /** @description The Argos SDK that generated the screenshot */
|
|
319
|
+
sdk: {
|
|
320
|
+
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
321
|
+
version: string;
|
|
322
|
+
}; /** @description Storybook story metadata */
|
|
323
|
+
story?: {
|
|
324
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
325
|
+
tags?: string[]; /** @description Story mode */
|
|
326
|
+
mode?: string; /** @description True if the story has a play function */
|
|
327
|
+
play?: boolean;
|
|
328
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
329
|
+
tags?: string[];
|
|
330
|
+
} | null; /** @description Width of the screenshot in pixels */
|
|
331
|
+
width: number | null; /** @description Height of the screenshot in pixels */
|
|
332
|
+
height: number | null;
|
|
333
|
+
/**
|
|
334
|
+
* Format: uri
|
|
335
|
+
* @description Public URL of the snapshot
|
|
336
|
+
*/
|
|
337
|
+
url: string; /** @description Content type of the snapshot file */
|
|
338
|
+
contentType: string;
|
|
339
|
+
} | null;
|
|
340
|
+
head: {
|
|
341
|
+
/** @description Unique identifier of the snapshot */id: string; /** @description Name of the snapshot */
|
|
342
|
+
name: string;
|
|
343
|
+
metadata: {
|
|
344
|
+
/**
|
|
345
|
+
* @description Ignored. Can be set to get completions, validations and documentation in some editors.
|
|
346
|
+
* @example https://api.argos-ci.com/v2/screenshot-metadata.json
|
|
347
|
+
*/
|
|
348
|
+
$schema?: string; /** @description The URL of the page that was screenshotted */
|
|
349
|
+
url?: string | null; /** @description An URL to an accessible preview of the screenshot */
|
|
350
|
+
previewUrl?: string | null;
|
|
351
|
+
viewport?: {
|
|
352
|
+
/** @description The width of the viewport */width: number; /** @description The height of the viewport */
|
|
353
|
+
height: number;
|
|
354
|
+
} | null; /** @description The color scheme when the screenshot was taken */
|
|
355
|
+
colorScheme?: ("light" | "dark") | null; /** @description The media type when the screenshot was taken */
|
|
356
|
+
mediaType?: ("screen" | "print") | null;
|
|
357
|
+
test?: {
|
|
358
|
+
/** @description The unique identifier of the test */id?: string | null; /** @description The title of the test */
|
|
359
|
+
title: string; /** @description The path of titles leading to the test */
|
|
360
|
+
titlePath: string[]; /** @description The number of retries for the test */
|
|
361
|
+
retries?: number | null; /** @description The current retry count */
|
|
362
|
+
retry?: number | null; /** @description The repeat count for the test */
|
|
363
|
+
repeat?: number | null; /** @description The location of the test in the source code */
|
|
364
|
+
location?: {
|
|
365
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
366
|
+
line: number; /** @description The column number in the file */
|
|
367
|
+
column: number;
|
|
368
|
+
}; /** @description Annotations associated to the test */
|
|
369
|
+
annotations?: {
|
|
370
|
+
/** @description The type of annotation */type: string; /** @description The description of the annotation */
|
|
371
|
+
description?: string; /** @description The location of the annotation in the source code */
|
|
372
|
+
location?: {
|
|
373
|
+
/** @description The located file */file: string; /** @description The line number in the file */
|
|
374
|
+
line: number; /** @description The column number in the file */
|
|
375
|
+
column: number;
|
|
376
|
+
};
|
|
377
|
+
}[]; /** @description Tags associated to the test */
|
|
378
|
+
tags?: string[];
|
|
379
|
+
} | null;
|
|
380
|
+
browser?: {
|
|
381
|
+
/** @description The name of the browser */name: string; /** @description The version of the browser */
|
|
382
|
+
version: string;
|
|
383
|
+
} | null; /** @description The automation library that generated the screenshot */
|
|
384
|
+
automationLibrary: {
|
|
385
|
+
/** @description The name of the automation library */name: string; /** @description The version of the automation library */
|
|
386
|
+
version: string;
|
|
387
|
+
}; /** @description The Argos SDK that generated the screenshot */
|
|
388
|
+
sdk: {
|
|
389
|
+
/** @description The name of the Argos SDK */name: string; /** @description The version of the Argos SDK */
|
|
390
|
+
version: string;
|
|
391
|
+
}; /** @description Storybook story metadata */
|
|
392
|
+
story?: {
|
|
393
|
+
/** @description Unique ID of the story */id: string; /** @description Tags attached to the story */
|
|
394
|
+
tags?: string[]; /** @description Story mode */
|
|
395
|
+
mode?: string; /** @description True if the story has a play function */
|
|
396
|
+
play?: boolean;
|
|
397
|
+
} | null; /** @description Tags associated to the screenshot */
|
|
398
|
+
tags?: string[];
|
|
399
|
+
} | null; /** @description Width of the screenshot in pixels */
|
|
400
|
+
width: number | null; /** @description Height of the screenshot in pixels */
|
|
401
|
+
height: number | null;
|
|
402
|
+
/**
|
|
403
|
+
* Format: uri
|
|
404
|
+
* @description Public URL of the snapshot
|
|
405
|
+
*/
|
|
406
|
+
url: string; /** @description Content type of the snapshot file */
|
|
407
|
+
contentType: string;
|
|
408
|
+
} | null;
|
|
409
|
+
}; /** @description Project */
|
|
410
|
+
Project: {
|
|
411
|
+
id: string;
|
|
412
|
+
defaultBaseBranch: string;
|
|
413
|
+
hasRemoteContentAccess: boolean;
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
responses: never;
|
|
417
|
+
parameters: never;
|
|
418
|
+
requestBodies: never;
|
|
419
|
+
headers: never;
|
|
420
|
+
pathItems: never;
|
|
421
|
+
}
|
|
422
|
+
type $defs = Record<string, never>;
|
|
423
|
+
interface operations {
|
|
424
|
+
createBuild: {
|
|
425
|
+
parameters: {
|
|
426
|
+
query?: never;
|
|
427
|
+
header?: never;
|
|
428
|
+
path?: never;
|
|
429
|
+
cookie?: never;
|
|
430
|
+
};
|
|
431
|
+
requestBody?: {
|
|
432
|
+
content: {
|
|
433
|
+
"application/json": {
|
|
434
|
+
/** @description The commit the build is running on */commit: components["schemas"]["Sha1Hash"]; /** @description The branch the build is running on */
|
|
435
|
+
branch: string; /** @description Keys of screenshot files */
|
|
436
|
+
screenshotKeys: components["schemas"]["Sha256Hash"][]; /** @description Keys of Playwright trace files */
|
|
437
|
+
pwTraceKeys?: components["schemas"]["Sha256Hash"][]; /** @description The name of the build (for multi-build setups) */
|
|
438
|
+
name?: string | null; /** @description Whether to run the build in parallel */
|
|
439
|
+
parallel?: boolean | null; /** @description A unique nonce for the parallel build */
|
|
440
|
+
parallelNonce?: string | null; /** @description The pull request number */
|
|
441
|
+
prNumber?: number | null; /** @description The head commit of the pull request */
|
|
442
|
+
prHeadCommit?: components["schemas"]["Sha1Hash"] | null; /** @description The commit to use as a reference for the build */
|
|
443
|
+
referenceCommit?: components["schemas"]["Sha1Hash"] | null; /** @description The branch to use as a reference for the build */
|
|
444
|
+
referenceBranch?: string | null; /** @description The parent commits of the build */
|
|
445
|
+
parentCommits?: components["schemas"]["Sha1Hash"][] | null; /** @description The mode in which the build is running */
|
|
446
|
+
mode?: ("ci" | "monitoring") | null; /** @description The CI provider being used */
|
|
447
|
+
ciProvider?: string | null; /** @description The version of the Argos SDK being used */
|
|
448
|
+
argosSdk?: string | null; /** @description The ID of the current run */
|
|
449
|
+
runId?: string | null; /** @description The attempt number of the current run */
|
|
450
|
+
runAttempt?: number | null; /** @description Whether the build was skipped, not comparing anything and always succeeding */
|
|
451
|
+
skipped?: boolean | null; /** @description Whether the build has been created in a merge queue */
|
|
452
|
+
mergeQueue?: boolean | null; /** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
|
|
453
|
+
mergeQueuePrNumbers?: number[] | null;
|
|
454
|
+
/**
|
|
455
|
+
* @description Indicates whether this build contains only a subset of screenshots.
|
|
456
|
+
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
457
|
+
*/
|
|
458
|
+
subset?: boolean | null;
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
responses: {
|
|
463
|
+
/** @description Result of build creation */201: {
|
|
464
|
+
headers: {
|
|
465
|
+
[name: string]: unknown;
|
|
466
|
+
};
|
|
467
|
+
content: {
|
|
468
|
+
"application/json": {
|
|
469
|
+
build: components["schemas"]["Build"];
|
|
470
|
+
screenshots: {
|
|
471
|
+
key: string; /** Format: uri */
|
|
472
|
+
putUrl: string;
|
|
473
|
+
}[];
|
|
474
|
+
pwTraces: {
|
|
475
|
+
key: string; /** Format: uri */
|
|
476
|
+
putUrl: string;
|
|
477
|
+
}[];
|
|
478
|
+
};
|
|
479
|
+
};
|
|
480
|
+
}; /** @description Invalid parameters */
|
|
481
|
+
400: {
|
|
482
|
+
headers: {
|
|
483
|
+
[name: string]: unknown;
|
|
484
|
+
};
|
|
485
|
+
content: {
|
|
486
|
+
"application/json": components["schemas"]["Error"];
|
|
487
|
+
};
|
|
488
|
+
}; /** @description Unauthorized */
|
|
489
|
+
401: {
|
|
490
|
+
headers: {
|
|
491
|
+
[name: string]: unknown;
|
|
492
|
+
};
|
|
493
|
+
content: {
|
|
494
|
+
"application/json": components["schemas"]["Error"];
|
|
495
|
+
};
|
|
496
|
+
}; /** @description Conflict */
|
|
497
|
+
409: {
|
|
498
|
+
headers: {
|
|
499
|
+
[name: string]: unknown;
|
|
500
|
+
};
|
|
501
|
+
content: {
|
|
502
|
+
"application/json": components["schemas"]["Error"];
|
|
503
|
+
};
|
|
504
|
+
}; /** @description Server error */
|
|
505
|
+
500: {
|
|
506
|
+
headers: {
|
|
507
|
+
[name: string]: unknown;
|
|
508
|
+
};
|
|
509
|
+
content: {
|
|
510
|
+
"application/json": components["schemas"]["Error"];
|
|
511
|
+
};
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
};
|
|
515
|
+
finalizeBuilds: {
|
|
516
|
+
parameters: {
|
|
517
|
+
query?: never;
|
|
518
|
+
header?: never;
|
|
519
|
+
path?: never;
|
|
520
|
+
cookie?: never;
|
|
521
|
+
};
|
|
522
|
+
requestBody?: {
|
|
523
|
+
content: {
|
|
524
|
+
"application/json": {
|
|
525
|
+
parallelNonce: string;
|
|
526
|
+
};
|
|
527
|
+
};
|
|
528
|
+
};
|
|
529
|
+
responses: {
|
|
530
|
+
/** @description Result of build finalization */200: {
|
|
531
|
+
headers: {
|
|
532
|
+
[name: string]: unknown;
|
|
533
|
+
};
|
|
534
|
+
content: {
|
|
535
|
+
"application/json": {
|
|
536
|
+
builds: components["schemas"]["Build"][];
|
|
537
|
+
};
|
|
538
|
+
};
|
|
539
|
+
}; /** @description Invalid parameters */
|
|
540
|
+
400: {
|
|
541
|
+
headers: {
|
|
542
|
+
[name: string]: unknown;
|
|
543
|
+
};
|
|
544
|
+
content: {
|
|
545
|
+
"application/json": components["schemas"]["Error"];
|
|
546
|
+
};
|
|
547
|
+
}; /** @description Unauthorized */
|
|
548
|
+
401: {
|
|
549
|
+
headers: {
|
|
550
|
+
[name: string]: unknown;
|
|
551
|
+
};
|
|
552
|
+
content: {
|
|
553
|
+
"application/json": components["schemas"]["Error"];
|
|
554
|
+
};
|
|
555
|
+
}; /** @description Forbidden */
|
|
556
|
+
403: {
|
|
557
|
+
headers: {
|
|
558
|
+
[name: string]: unknown;
|
|
559
|
+
};
|
|
560
|
+
content: {
|
|
561
|
+
"application/json": components["schemas"]["Error"];
|
|
562
|
+
};
|
|
563
|
+
}; /** @description Not found */
|
|
564
|
+
404: {
|
|
565
|
+
headers: {
|
|
566
|
+
[name: string]: unknown;
|
|
567
|
+
};
|
|
568
|
+
content: {
|
|
569
|
+
"application/json": components["schemas"]["Error"];
|
|
570
|
+
};
|
|
571
|
+
}; /** @description Conflict */
|
|
572
|
+
409: {
|
|
573
|
+
headers: {
|
|
574
|
+
[name: string]: unknown;
|
|
575
|
+
};
|
|
576
|
+
content: {
|
|
577
|
+
"application/json": components["schemas"]["Error"];
|
|
578
|
+
};
|
|
579
|
+
}; /** @description Server error */
|
|
580
|
+
500: {
|
|
581
|
+
headers: {
|
|
582
|
+
[name: string]: unknown;
|
|
583
|
+
};
|
|
584
|
+
content: {
|
|
585
|
+
"application/json": components["schemas"]["Error"];
|
|
586
|
+
};
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
getBuild: {
|
|
591
|
+
parameters: {
|
|
592
|
+
query?: never;
|
|
593
|
+
header?: never;
|
|
594
|
+
path: {
|
|
595
|
+
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
596
|
+
};
|
|
597
|
+
cookie?: never;
|
|
598
|
+
};
|
|
599
|
+
requestBody?: never;
|
|
600
|
+
responses: {
|
|
601
|
+
/** @description Build */200: {
|
|
602
|
+
headers: {
|
|
603
|
+
[name: string]: unknown;
|
|
604
|
+
};
|
|
605
|
+
content: {
|
|
606
|
+
"application/json": components["schemas"]["Build"];
|
|
607
|
+
};
|
|
608
|
+
}; /** @description Invalid parameters */
|
|
609
|
+
400: {
|
|
610
|
+
headers: {
|
|
611
|
+
[name: string]: unknown;
|
|
612
|
+
};
|
|
613
|
+
content: {
|
|
614
|
+
"application/json": components["schemas"]["Error"];
|
|
615
|
+
};
|
|
616
|
+
}; /** @description Unauthorized */
|
|
617
|
+
401: {
|
|
618
|
+
headers: {
|
|
619
|
+
[name: string]: unknown;
|
|
620
|
+
};
|
|
621
|
+
content: {
|
|
622
|
+
"application/json": components["schemas"]["Error"];
|
|
623
|
+
};
|
|
624
|
+
}; /** @description Not found */
|
|
625
|
+
404: {
|
|
626
|
+
headers: {
|
|
627
|
+
[name: string]: unknown;
|
|
628
|
+
};
|
|
629
|
+
content: {
|
|
630
|
+
"application/json": components["schemas"]["Error"];
|
|
631
|
+
};
|
|
632
|
+
}; /** @description Server error */
|
|
633
|
+
500: {
|
|
634
|
+
headers: {
|
|
635
|
+
[name: string]: unknown;
|
|
636
|
+
};
|
|
637
|
+
content: {
|
|
638
|
+
"application/json": components["schemas"]["Error"];
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
};
|
|
642
|
+
};
|
|
643
|
+
updateBuild: {
|
|
644
|
+
parameters: {
|
|
645
|
+
query?: never;
|
|
646
|
+
header?: never;
|
|
647
|
+
path: {
|
|
648
|
+
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
649
|
+
};
|
|
650
|
+
cookie?: never;
|
|
651
|
+
};
|
|
652
|
+
requestBody?: {
|
|
653
|
+
content: {
|
|
654
|
+
"application/json": {
|
|
655
|
+
screenshots: components["schemas"]["ScreenshotInput"][];
|
|
656
|
+
parallel?: boolean | null;
|
|
657
|
+
parallelTotal?: number | null;
|
|
658
|
+
parallelIndex?: number | null;
|
|
659
|
+
metadata?: components["schemas"]["BuildMetadata"];
|
|
660
|
+
};
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
responses: {
|
|
664
|
+
/** @description Result of build update */200: {
|
|
665
|
+
headers: {
|
|
666
|
+
[name: string]: unknown;
|
|
667
|
+
};
|
|
668
|
+
content: {
|
|
669
|
+
"application/json": {
|
|
670
|
+
build: components["schemas"]["Build"];
|
|
671
|
+
};
|
|
672
|
+
};
|
|
673
|
+
}; /** @description Invalid parameters */
|
|
674
|
+
400: {
|
|
675
|
+
headers: {
|
|
676
|
+
[name: string]: unknown;
|
|
677
|
+
};
|
|
678
|
+
content: {
|
|
679
|
+
"application/json": components["schemas"]["Error"];
|
|
680
|
+
};
|
|
681
|
+
}; /** @description Unauthorized */
|
|
682
|
+
401: {
|
|
683
|
+
headers: {
|
|
684
|
+
[name: string]: unknown;
|
|
685
|
+
};
|
|
686
|
+
content: {
|
|
687
|
+
"application/json": components["schemas"]["Error"];
|
|
688
|
+
};
|
|
689
|
+
}; /** @description Forbidden */
|
|
690
|
+
403: {
|
|
691
|
+
headers: {
|
|
692
|
+
[name: string]: unknown;
|
|
693
|
+
};
|
|
694
|
+
content: {
|
|
695
|
+
"application/json": components["schemas"]["Error"];
|
|
696
|
+
};
|
|
697
|
+
}; /** @description Not found */
|
|
698
|
+
404: {
|
|
699
|
+
headers: {
|
|
700
|
+
[name: string]: unknown;
|
|
701
|
+
};
|
|
702
|
+
content: {
|
|
703
|
+
"application/json": components["schemas"]["Error"];
|
|
704
|
+
};
|
|
705
|
+
}; /** @description Conflict */
|
|
706
|
+
409: {
|
|
707
|
+
headers: {
|
|
708
|
+
[name: string]: unknown;
|
|
709
|
+
};
|
|
710
|
+
content: {
|
|
711
|
+
"application/json": components["schemas"]["Error"];
|
|
712
|
+
};
|
|
713
|
+
}; /** @description Server error */
|
|
714
|
+
500: {
|
|
715
|
+
headers: {
|
|
716
|
+
[name: string]: unknown;
|
|
717
|
+
};
|
|
718
|
+
content: {
|
|
719
|
+
"application/json": components["schemas"]["Error"];
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
getBuildDiffs: {
|
|
725
|
+
parameters: {
|
|
726
|
+
query?: {
|
|
727
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
728
|
+
page?: string;
|
|
729
|
+
};
|
|
730
|
+
header?: never;
|
|
731
|
+
path: {
|
|
732
|
+
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
733
|
+
};
|
|
734
|
+
cookie?: never;
|
|
735
|
+
};
|
|
736
|
+
requestBody?: never;
|
|
737
|
+
responses: {
|
|
738
|
+
/** @description List of screenshot diffs */200: {
|
|
739
|
+
headers: {
|
|
740
|
+
[name: string]: unknown;
|
|
741
|
+
};
|
|
742
|
+
content: {
|
|
743
|
+
"application/json": {
|
|
744
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
745
|
+
results: components["schemas"]["SnapshotDiff"][];
|
|
746
|
+
};
|
|
747
|
+
};
|
|
748
|
+
}; /** @description Invalid parameters */
|
|
749
|
+
400: {
|
|
750
|
+
headers: {
|
|
751
|
+
[name: string]: unknown;
|
|
752
|
+
};
|
|
753
|
+
content: {
|
|
754
|
+
"application/json": components["schemas"]["Error"];
|
|
755
|
+
};
|
|
756
|
+
}; /** @description Unauthorized */
|
|
757
|
+
401: {
|
|
758
|
+
headers: {
|
|
759
|
+
[name: string]: unknown;
|
|
760
|
+
};
|
|
761
|
+
content: {
|
|
762
|
+
"application/json": components["schemas"]["Error"];
|
|
763
|
+
};
|
|
764
|
+
}; /** @description Not found */
|
|
765
|
+
404: {
|
|
766
|
+
headers: {
|
|
767
|
+
[name: string]: unknown;
|
|
768
|
+
};
|
|
769
|
+
content: {
|
|
770
|
+
"application/json": components["schemas"]["Error"];
|
|
771
|
+
};
|
|
772
|
+
}; /** @description Server error */
|
|
773
|
+
500: {
|
|
774
|
+
headers: {
|
|
775
|
+
[name: string]: unknown;
|
|
776
|
+
};
|
|
777
|
+
content: {
|
|
778
|
+
"application/json": components["schemas"]["Error"];
|
|
779
|
+
};
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
getAuthProject: {
|
|
784
|
+
parameters: {
|
|
785
|
+
query?: never;
|
|
786
|
+
header?: never;
|
|
787
|
+
path?: never;
|
|
788
|
+
cookie?: never;
|
|
789
|
+
};
|
|
790
|
+
requestBody?: never;
|
|
791
|
+
responses: {
|
|
792
|
+
/** @description Project */200: {
|
|
793
|
+
headers: {
|
|
794
|
+
[name: string]: unknown;
|
|
795
|
+
};
|
|
796
|
+
content: {
|
|
797
|
+
"application/json": components["schemas"]["Project"];
|
|
798
|
+
};
|
|
799
|
+
}; /** @description Unauthorized */
|
|
800
|
+
401: {
|
|
801
|
+
headers: {
|
|
802
|
+
[name: string]: unknown;
|
|
803
|
+
};
|
|
804
|
+
content: {
|
|
805
|
+
"application/json": components["schemas"]["Error"];
|
|
806
|
+
};
|
|
807
|
+
}; /** @description Server error */
|
|
808
|
+
500: {
|
|
809
|
+
headers: {
|
|
810
|
+
[name: string]: unknown;
|
|
811
|
+
};
|
|
812
|
+
content: {
|
|
813
|
+
"application/json": components["schemas"]["Error"];
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
getAuthProjectBuilds: {
|
|
819
|
+
parameters: {
|
|
820
|
+
query?: {
|
|
821
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
822
|
+
page?: string;
|
|
823
|
+
head?: string;
|
|
824
|
+
headSha?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
|
|
825
|
+
distinctName?: string;
|
|
826
|
+
};
|
|
827
|
+
header?: never;
|
|
828
|
+
path?: never;
|
|
829
|
+
cookie?: never;
|
|
830
|
+
};
|
|
831
|
+
requestBody?: never;
|
|
832
|
+
responses: {
|
|
833
|
+
/** @description List of builds */200: {
|
|
834
|
+
headers: {
|
|
835
|
+
[name: string]: unknown;
|
|
836
|
+
};
|
|
837
|
+
content: {
|
|
838
|
+
"application/json": {
|
|
839
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
840
|
+
results: components["schemas"]["Build"][];
|
|
841
|
+
};
|
|
842
|
+
};
|
|
843
|
+
}; /** @description Invalid parameters */
|
|
844
|
+
400: {
|
|
845
|
+
headers: {
|
|
846
|
+
[name: string]: unknown;
|
|
847
|
+
};
|
|
848
|
+
content: {
|
|
849
|
+
"application/json": components["schemas"]["Error"];
|
|
850
|
+
};
|
|
851
|
+
}; /** @description Unauthorized */
|
|
852
|
+
401: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content: {
|
|
857
|
+
"application/json": components["schemas"]["Error"];
|
|
858
|
+
};
|
|
859
|
+
}; /** @description Server error */
|
|
860
|
+
500: {
|
|
861
|
+
headers: {
|
|
862
|
+
[name: string]: unknown;
|
|
863
|
+
};
|
|
864
|
+
content: {
|
|
865
|
+
"application/json": components["schemas"]["Error"];
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
}
|
|
871
|
+
//#endregion
|
|
872
|
+
//#region src/index.d.ts
|
|
873
|
+
type ArgosAPIClient = ReturnType<typeof createClient>;
|
|
874
|
+
/**
|
|
875
|
+
* Create Argos API client.
|
|
876
|
+
*/
|
|
877
|
+
declare function createClient(options: {
|
|
878
|
+
baseUrl?: string;
|
|
879
|
+
authToken: string;
|
|
880
|
+
}): _$openapi_fetch0.Client<paths, `${string}/${string}`>;
|
|
881
|
+
declare class APIError extends Error {
|
|
882
|
+
constructor(message: string);
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* Handle API errors.
|
|
886
|
+
*/
|
|
887
|
+
declare function throwAPIError(error: components["schemas"]["Error"]): never;
|
|
888
|
+
//#endregion
|
|
889
|
+
export { APIError, ArgosAPIClient, schema_d_exports as ArgosAPISchema, createClient, throwAPIError };
|