@typeship-ax/cli 0.8.0 → 0.9.1
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/AGENTS.md +31 -0
- package/README.md +26 -9
- package/api.json +1875 -684
- package/api.md +352 -500
- package/dist/api-identity.d.ts +40 -0
- package/dist/api-identity.d.ts.map +1 -0
- package/dist/api-identity.js +128 -0
- package/dist/auth-profiles.d.ts +30 -0
- package/dist/auth-profiles.d.ts.map +1 -0
- package/dist/auth-profiles.js +138 -0
- package/dist/cli.js +522 -355
- package/dist/console-login-check.d.ts +21 -0
- package/dist/console-login-check.d.ts.map +1 -0
- package/dist/console-login-check.js +107 -0
- package/dist/console-login-contract.d.ts +45 -0
- package/dist/console-login-contract.d.ts.map +1 -0
- package/dist/console-login-contract.js +40 -0
- package/dist/core/http.d.ts +17 -2
- package/dist/core/http.d.ts.map +1 -1
- package/dist/core/http.js +78 -17
- package/dist/credential-storage.d.ts +24 -0
- package/dist/credential-storage.d.ts.map +1 -0
- package/dist/credential-storage.js +207 -0
- package/dist/docs.d.ts +25 -0
- package/dist/docs.d.ts.map +1 -1
- package/dist/docs.js +144 -0
- package/dist/errors.d.ts +18 -10
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +24 -14
- package/dist/index.d.ts +10 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -4
- package/dist/named-credentials.d.ts +21 -0
- package/dist/named-credentials.d.ts.map +1 -0
- package/dist/named-credentials.js +86 -0
- package/dist/oauth-login.d.ts +39 -0
- package/dist/oauth-login.d.ts.map +1 -0
- package/dist/oauth-login.js +171 -0
- package/dist/oauth-request.d.ts +21 -0
- package/dist/oauth-request.d.ts.map +1 -0
- package/dist/oauth-request.js +119 -0
- package/dist/oauth-session.d.ts +106 -0
- package/dist/oauth-session.d.ts.map +1 -0
- package/dist/oauth-session.js +244 -0
- package/dist/ops.d.ts +14 -1
- package/dist/ops.d.ts.map +1 -1
- package/dist/ops.js +30 -30
- package/dist/polling-login.d.ts +57 -0
- package/dist/polling-login.d.ts.map +1 -0
- package/dist/polling-login.js +204 -0
- package/dist/resources/account.d.ts +2 -2
- package/dist/resources/account.d.ts.map +1 -1
- package/dist/resources/account.js +1 -0
- package/dist/resources/api-keys.d.ts +3 -3
- package/dist/resources/api-keys.d.ts.map +1 -1
- package/dist/resources/api-keys.js +2 -0
- package/dist/resources/definition-revisions.d.ts +5 -5
- package/dist/resources/definition-revisions.d.ts.map +1 -1
- package/dist/resources/definition-revisions.js +4 -0
- package/dist/resources/definitions.d.ts +15 -4
- package/dist/resources/definitions.d.ts.map +1 -1
- package/dist/resources/definitions.js +11 -2
- package/dist/resources/generate.d.ts +14 -3
- package/dist/resources/generate.d.ts.map +1 -1
- package/dist/resources/generate.js +10 -2
- package/dist/resources/generations.d.ts +3 -3
- package/dist/resources/generations.d.ts.map +1 -1
- package/dist/resources/generations.js +2 -0
- package/dist/resources/projects.d.ts +56 -20
- package/dist/resources/projects.d.ts.map +1 -1
- package/dist/resources/projects.js +40 -4
- package/dist/resources/targets.d.ts +20 -9
- package/dist/resources/targets.d.ts.map +1 -1
- package/dist/resources/targets.js +14 -1
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +38 -22
- package/dist/types.d.ts +385 -119
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +11 -0
- package/package.json +2 -1
- package/src/api-identity.ts +98 -0
- package/src/auth-profiles.ts +114 -0
- package/src/cli.ts +444 -332
- package/src/console-login-check.ts +88 -0
- package/src/console-login-contract.ts +65 -0
- package/src/core/http.ts +88 -19
- package/src/credential-storage.ts +183 -0
- package/src/docs.ts +138 -0
- package/src/errors.ts +26 -15
- package/src/index.ts +29 -4
- package/src/named-credentials.ts +74 -0
- package/src/oauth-login.ts +184 -0
- package/src/oauth-request.ts +90 -0
- package/src/oauth-session.ts +258 -0
- package/src/ops.ts +44 -31
- package/src/polling-login.ts +165 -0
- package/src/resources/account.ts +3 -0
- package/src/resources/api-keys.ts +5 -0
- package/src/resources/definition-revisions.ts +9 -0
- package/src/resources/definitions.ts +25 -0
- package/src/resources/generate.ts +23 -0
- package/src/resources/generations.ts +5 -0
- package/src/resources/projects.ts +95 -7
- package/src/resources/targets.ts +32 -0
- package/src/schemas.ts +38 -22
- package/src/types.ts +404 -119
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
|
|
5
5
|
import { paginate, PagePromise } from "../core/pagination.js";
|
|
6
6
|
import {
|
|
7
|
+
ResponseParseError,
|
|
7
8
|
TransportError,
|
|
8
9
|
UnexpectedApiError,
|
|
9
10
|
ValidationError,
|
|
11
|
+
BadGatewayError,
|
|
10
12
|
BadRequestError,
|
|
11
13
|
ConflictError,
|
|
12
14
|
ForbiddenError,
|
|
@@ -26,12 +28,12 @@ import type {
|
|
|
26
28
|
DiagnosticRemediationRequest,
|
|
27
29
|
DiagnosticReport,
|
|
28
30
|
DiagnosticReportRead,
|
|
29
|
-
Generation,
|
|
30
31
|
GenerationBatch,
|
|
31
32
|
GenerationBatchRead,
|
|
32
33
|
GenerationList,
|
|
33
34
|
GenerationListRead,
|
|
34
|
-
|
|
35
|
+
GenerationSummary,
|
|
36
|
+
GenerationSummaryRead,
|
|
35
37
|
Project,
|
|
36
38
|
ProjectId,
|
|
37
39
|
ProjectList,
|
|
@@ -60,6 +62,7 @@ export class ProjectsResource {
|
|
|
60
62
|
return paginate<ProjectSummaryRead, ProjectsListError>(this._core, {
|
|
61
63
|
method: "GET",
|
|
62
64
|
path: "/projects",
|
|
65
|
+
security: [{"apiKey":[]}],
|
|
63
66
|
query: {
|
|
64
67
|
limit: params?.limit,
|
|
65
68
|
cursor: params?.cursor,
|
|
@@ -102,6 +105,7 @@ export class ProjectsResource {
|
|
|
102
105
|
return this._core.request<ProjectRead, ProjectsCreateError>({
|
|
103
106
|
method: "POST",
|
|
104
107
|
path: "/projects",
|
|
108
|
+
security: [{"apiKey":[]}],
|
|
105
109
|
headers: {
|
|
106
110
|
"Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
|
|
107
111
|
},
|
|
@@ -124,6 +128,8 @@ export class ProjectsResource {
|
|
|
124
128
|
|
|
125
129
|
/**
|
|
126
130
|
* Retrieve a project
|
|
131
|
+
*
|
|
132
|
+
* Returns Project-owned fields only. List Targets separately for Target and Delivery data.
|
|
127
133
|
* `GET /projects/{project_id}`
|
|
128
134
|
*/
|
|
129
135
|
async retrieve(
|
|
@@ -133,6 +139,7 @@ export class ProjectsResource {
|
|
|
133
139
|
return this._core.request<ProjectRead, ProjectsRetrieveError>({
|
|
134
140
|
method: "GET",
|
|
135
141
|
path: `/projects/${encodeURIComponent(String(projectId))}`,
|
|
142
|
+
security: [{"apiKey":[]}],
|
|
136
143
|
errors: {
|
|
137
144
|
"401": UnauthorizedError,
|
|
138
145
|
"403": ForbiddenError,
|
|
@@ -156,6 +163,7 @@ export class ProjectsResource {
|
|
|
156
163
|
return this._core.request<DeletedProjectRead, ProjectsDeleteError>({
|
|
157
164
|
method: "DELETE",
|
|
158
165
|
path: `/projects/${encodeURIComponent(String(projectId))}`,
|
|
166
|
+
security: [{"apiKey":[]}],
|
|
159
167
|
errors: {
|
|
160
168
|
"401": UnauthorizedError,
|
|
161
169
|
"403": ForbiddenError,
|
|
@@ -180,6 +188,7 @@ export class ProjectsResource {
|
|
|
180
188
|
return this._core.request<ProjectRead, ProjectsUpdateError>({
|
|
181
189
|
method: "PATCH",
|
|
182
190
|
path: `/projects/${encodeURIComponent(String(projectId))}`,
|
|
191
|
+
security: [{"apiKey":[]}],
|
|
183
192
|
body,
|
|
184
193
|
errors: {
|
|
185
194
|
"400": BadRequestError,
|
|
@@ -187,8 +196,10 @@ export class ProjectsResource {
|
|
|
187
196
|
"402": PaymentRequiredError,
|
|
188
197
|
"403": ForbiddenError,
|
|
189
198
|
"404": NotFoundError,
|
|
199
|
+
"409": ConflictError,
|
|
190
200
|
"422": UnprocessableEntityError,
|
|
191
201
|
"429": RateLimitedError,
|
|
202
|
+
"502": BadGatewayError,
|
|
192
203
|
},
|
|
193
204
|
schemaKey: "projects.update",
|
|
194
205
|
options,
|
|
@@ -211,6 +222,7 @@ export class ProjectsResource {
|
|
|
211
222
|
return this._core.request<DiagnosticReportRead, ProjectsRetrieveDiagnosticsError>({
|
|
212
223
|
method: "GET",
|
|
213
224
|
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics`,
|
|
225
|
+
security: [{"apiKey":[]}],
|
|
214
226
|
errors: {
|
|
215
227
|
"401": UnauthorizedError,
|
|
216
228
|
"403": ForbiddenError,
|
|
@@ -229,22 +241,31 @@ export class ProjectsResource {
|
|
|
229
241
|
* Fetches the complete configured source, records a new immutable revision only when content
|
|
230
242
|
* changed, and returns its Diagnostics. This does not generate targets or consume a metered
|
|
231
243
|
* generation.
|
|
244
|
+
*
|
|
245
|
+
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
232
246
|
* `POST /projects/{project_id}/diagnostics`
|
|
233
247
|
*/
|
|
234
248
|
async refreshDiagnostics(
|
|
235
249
|
projectId: ProjectId,
|
|
250
|
+
params?: ProjectsRefreshDiagnosticsParams,
|
|
236
251
|
options?: RequestOptions,
|
|
237
252
|
): Promise<ApiResult<DiagnosticReportRead, ProjectsRefreshDiagnosticsError>> {
|
|
238
253
|
return this._core.request<DiagnosticReportRead, ProjectsRefreshDiagnosticsError>({
|
|
239
254
|
method: "POST",
|
|
240
255
|
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics`,
|
|
256
|
+
security: [{"apiKey":[]}],
|
|
257
|
+
headers: {
|
|
258
|
+
"Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
|
|
259
|
+
},
|
|
241
260
|
errors: {
|
|
242
261
|
"401": UnauthorizedError,
|
|
243
262
|
"403": ForbiddenError,
|
|
244
263
|
"404": NotFoundError,
|
|
264
|
+
"409": ConflictError,
|
|
245
265
|
"422": UnprocessableEntityError,
|
|
246
266
|
"429": RateLimitedError,
|
|
247
267
|
},
|
|
268
|
+
idempotencyKey: "Idempotency-Key",
|
|
248
269
|
schemaKey: "projects.refreshDiagnostics",
|
|
249
270
|
options,
|
|
250
271
|
});
|
|
@@ -256,25 +277,34 @@ export class ProjectsResource {
|
|
|
256
277
|
* Applies only deterministic patches. Repository sources receive an updateable source pull
|
|
257
278
|
* request; URL sources receive project overlays. Diagnostics that require API-owner intent return
|
|
258
279
|
* 422 and include an authoring_brief in the Diagnostic instead.
|
|
280
|
+
*
|
|
281
|
+
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
259
282
|
* `POST /projects/{project_id}/diagnostics/remediations`
|
|
260
283
|
*/
|
|
261
284
|
async remediateDiagnostics(
|
|
262
285
|
projectId: ProjectId,
|
|
263
286
|
body: DiagnosticRemediationRequest,
|
|
287
|
+
params?: ProjectsRemediateDiagnosticsParams,
|
|
264
288
|
options?: RequestOptions,
|
|
265
289
|
): Promise<ApiResult<DiagnosticRemediationRead, ProjectsRemediateDiagnosticsError>> {
|
|
266
290
|
return this._core.request<DiagnosticRemediationRead, ProjectsRemediateDiagnosticsError>({
|
|
267
291
|
method: "POST",
|
|
268
292
|
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics/remediations`,
|
|
293
|
+
security: [{"apiKey":[]}],
|
|
294
|
+
headers: {
|
|
295
|
+
"Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
|
|
296
|
+
},
|
|
269
297
|
body,
|
|
270
298
|
errors: {
|
|
271
299
|
"400": BadRequestError,
|
|
272
300
|
"401": UnauthorizedError,
|
|
273
301
|
"403": ForbiddenError,
|
|
274
302
|
"404": NotFoundError,
|
|
303
|
+
"409": ConflictError,
|
|
275
304
|
"422": UnprocessableEntityError,
|
|
276
305
|
"429": RateLimitedError,
|
|
277
306
|
},
|
|
307
|
+
idempotencyKey: "Idempotency-Key",
|
|
278
308
|
schemaKey: "projects.remediateDiagnostics",
|
|
279
309
|
options,
|
|
280
310
|
});
|
|
@@ -295,6 +325,7 @@ export class ProjectsResource {
|
|
|
295
325
|
return this._core.request<RepositoryIntegrationHealthRead, ProjectsRetrieveIntegrationHealthError>({
|
|
296
326
|
method: "GET",
|
|
297
327
|
path: `/projects/${encodeURIComponent(String(projectId))}/integration-health`,
|
|
328
|
+
security: [{"apiKey":[]}],
|
|
298
329
|
errors: {
|
|
299
330
|
"401": UnauthorizedError,
|
|
300
331
|
"403": ForbiddenError,
|
|
@@ -317,10 +348,11 @@ export class ProjectsResource {
|
|
|
317
348
|
projectId: ProjectId,
|
|
318
349
|
params?: ProjectsListGenerationsParams,
|
|
319
350
|
options?: RequestOptions,
|
|
320
|
-
): PagePromise<
|
|
321
|
-
return paginate<
|
|
351
|
+
): PagePromise<GenerationSummaryRead, ProjectsListGenerationsError> {
|
|
352
|
+
return paginate<GenerationSummaryRead, ProjectsListGenerationsError>(this._core, {
|
|
322
353
|
method: "GET",
|
|
323
354
|
path: `/projects/${encodeURIComponent(String(projectId))}/generations`,
|
|
355
|
+
security: [{"apiKey":[]}],
|
|
324
356
|
query: {
|
|
325
357
|
limit: params?.limit,
|
|
326
358
|
cursor: params?.cursor,
|
|
@@ -356,24 +388,33 @@ export class ProjectsResource {
|
|
|
356
388
|
* commit, branch, or pull request is created and that generation reports
|
|
357
389
|
* `pr_status: no_changes`. This is the same pipeline automatic
|
|
358
390
|
* regeneration runs after a source change.
|
|
391
|
+
*
|
|
392
|
+
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
359
393
|
* `POST /projects/{project_id}/generations`
|
|
360
394
|
*/
|
|
361
395
|
async generate(
|
|
362
396
|
projectId: ProjectId,
|
|
397
|
+
params?: ProjectsGenerateParams,
|
|
363
398
|
options?: RequestOptions,
|
|
364
399
|
): Promise<ApiResult<GenerationBatchRead, ProjectsGenerateError>> {
|
|
365
400
|
return this._core.request<GenerationBatchRead, ProjectsGenerateError>({
|
|
366
401
|
method: "POST",
|
|
367
402
|
path: `/projects/${encodeURIComponent(String(projectId))}/generations`,
|
|
403
|
+
security: [{"apiKey":[]}],
|
|
404
|
+
headers: {
|
|
405
|
+
"Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
|
|
406
|
+
},
|
|
368
407
|
errors: {
|
|
369
408
|
"401": UnauthorizedError,
|
|
370
409
|
"402": PaymentRequiredError,
|
|
371
410
|
"403": ForbiddenError,
|
|
372
411
|
"404": NotFoundError,
|
|
412
|
+
"409": ConflictError,
|
|
373
413
|
"422": UnprocessableEntityError,
|
|
374
414
|
"429": RateLimitedError,
|
|
375
415
|
"500": InternalServerError,
|
|
376
416
|
},
|
|
417
|
+
idempotencyKey: "Idempotency-Key",
|
|
377
418
|
schemaKey: "projects.generate",
|
|
378
419
|
options,
|
|
379
420
|
});
|
|
@@ -397,14 +438,16 @@ export type ProjectsListError =
|
|
|
397
438
|
| ForbiddenError
|
|
398
439
|
| RateLimitedError
|
|
399
440
|
| UnexpectedApiError
|
|
441
|
+
| ResponseParseError
|
|
400
442
|
| TransportError
|
|
401
443
|
| ValidationError;
|
|
402
444
|
|
|
403
445
|
export interface ProjectsCreateParams {
|
|
404
446
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
447
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
448
|
+
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
449
|
+
* path, query, and JSON body replays the original response. Reusing the key with changed intent
|
|
450
|
+
* returns 409. After expiry the key starts a new write.
|
|
408
451
|
*/
|
|
409
452
|
idempotencyKey?: string;
|
|
410
453
|
}
|
|
@@ -420,6 +463,7 @@ export type ProjectsCreateError =
|
|
|
420
463
|
| RateLimitedError
|
|
421
464
|
| InternalServerError
|
|
422
465
|
| UnexpectedApiError
|
|
466
|
+
| ResponseParseError
|
|
423
467
|
| TransportError
|
|
424
468
|
| ValidationError;
|
|
425
469
|
|
|
@@ -430,6 +474,7 @@ export type ProjectsRetrieveError =
|
|
|
430
474
|
| NotFoundError
|
|
431
475
|
| RateLimitedError
|
|
432
476
|
| UnexpectedApiError
|
|
477
|
+
| ResponseParseError
|
|
433
478
|
| TransportError
|
|
434
479
|
| ValidationError;
|
|
435
480
|
|
|
@@ -440,6 +485,7 @@ export type ProjectsDeleteError =
|
|
|
440
485
|
| NotFoundError
|
|
441
486
|
| RateLimitedError
|
|
442
487
|
| UnexpectedApiError
|
|
488
|
+
| ResponseParseError
|
|
443
489
|
| TransportError
|
|
444
490
|
| ValidationError;
|
|
445
491
|
|
|
@@ -450,9 +496,12 @@ export type ProjectsUpdateError =
|
|
|
450
496
|
| PaymentRequiredError
|
|
451
497
|
| ForbiddenError
|
|
452
498
|
| NotFoundError
|
|
499
|
+
| ConflictError
|
|
453
500
|
| UnprocessableEntityError
|
|
454
501
|
| RateLimitedError
|
|
502
|
+
| BadGatewayError
|
|
455
503
|
| UnexpectedApiError
|
|
504
|
+
| ResponseParseError
|
|
456
505
|
| TransportError
|
|
457
506
|
| ValidationError;
|
|
458
507
|
|
|
@@ -463,29 +512,54 @@ export type ProjectsRetrieveDiagnosticsError =
|
|
|
463
512
|
| NotFoundError
|
|
464
513
|
| RateLimitedError
|
|
465
514
|
| UnexpectedApiError
|
|
515
|
+
| ResponseParseError
|
|
466
516
|
| TransportError
|
|
467
517
|
| ValidationError;
|
|
468
518
|
|
|
519
|
+
export interface ProjectsRefreshDiagnosticsParams {
|
|
520
|
+
/**
|
|
521
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
522
|
+
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
523
|
+
* path, query, and JSON body replays the original response. Reusing the key with changed intent
|
|
524
|
+
* returns 409. After expiry the key starts a new write.
|
|
525
|
+
*/
|
|
526
|
+
idempotencyKey?: string;
|
|
527
|
+
}
|
|
528
|
+
|
|
469
529
|
/** Every error `refreshDiagnostics` can produce, as a discriminated union. */
|
|
470
530
|
export type ProjectsRefreshDiagnosticsError =
|
|
471
531
|
| UnauthorizedError
|
|
472
532
|
| ForbiddenError
|
|
473
533
|
| NotFoundError
|
|
534
|
+
| ConflictError
|
|
474
535
|
| UnprocessableEntityError
|
|
475
536
|
| RateLimitedError
|
|
476
537
|
| UnexpectedApiError
|
|
538
|
+
| ResponseParseError
|
|
477
539
|
| TransportError
|
|
478
540
|
| ValidationError;
|
|
479
541
|
|
|
542
|
+
export interface ProjectsRemediateDiagnosticsParams {
|
|
543
|
+
/**
|
|
544
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
545
|
+
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
546
|
+
* path, query, and JSON body replays the original response. Reusing the key with changed intent
|
|
547
|
+
* returns 409. After expiry the key starts a new write.
|
|
548
|
+
*/
|
|
549
|
+
idempotencyKey?: string;
|
|
550
|
+
}
|
|
551
|
+
|
|
480
552
|
/** Every error `remediateDiagnostics` can produce, as a discriminated union. */
|
|
481
553
|
export type ProjectsRemediateDiagnosticsError =
|
|
482
554
|
| BadRequestError
|
|
483
555
|
| UnauthorizedError
|
|
484
556
|
| ForbiddenError
|
|
485
557
|
| NotFoundError
|
|
558
|
+
| ConflictError
|
|
486
559
|
| UnprocessableEntityError
|
|
487
560
|
| RateLimitedError
|
|
488
561
|
| UnexpectedApiError
|
|
562
|
+
| ResponseParseError
|
|
489
563
|
| TransportError
|
|
490
564
|
| ValidationError;
|
|
491
565
|
|
|
@@ -496,6 +570,7 @@ export type ProjectsRetrieveIntegrationHealthError =
|
|
|
496
570
|
| NotFoundError
|
|
497
571
|
| RateLimitedError
|
|
498
572
|
| UnexpectedApiError
|
|
573
|
+
| ResponseParseError
|
|
499
574
|
| TransportError
|
|
500
575
|
| ValidationError;
|
|
501
576
|
|
|
@@ -519,18 +594,31 @@ export type ProjectsListGenerationsError =
|
|
|
519
594
|
| NotFoundError
|
|
520
595
|
| RateLimitedError
|
|
521
596
|
| UnexpectedApiError
|
|
597
|
+
| ResponseParseError
|
|
522
598
|
| TransportError
|
|
523
599
|
| ValidationError;
|
|
524
600
|
|
|
601
|
+
export interface ProjectsGenerateParams {
|
|
602
|
+
/**
|
|
603
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
604
|
+
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
605
|
+
* path, query, and JSON body replays the original response. Reusing the key with changed intent
|
|
606
|
+
* returns 409. After expiry the key starts a new write.
|
|
607
|
+
*/
|
|
608
|
+
idempotencyKey?: string;
|
|
609
|
+
}
|
|
610
|
+
|
|
525
611
|
/** Every error `generate` can produce, as a discriminated union. */
|
|
526
612
|
export type ProjectsGenerateError =
|
|
527
613
|
| UnauthorizedError
|
|
528
614
|
| PaymentRequiredError
|
|
529
615
|
| ForbiddenError
|
|
530
616
|
| NotFoundError
|
|
617
|
+
| ConflictError
|
|
531
618
|
| UnprocessableEntityError
|
|
532
619
|
| RateLimitedError
|
|
533
620
|
| InternalServerError
|
|
534
621
|
| UnexpectedApiError
|
|
622
|
+
| ResponseParseError
|
|
535
623
|
| TransportError
|
|
536
624
|
| ValidationError;
|
package/src/resources/targets.ts
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
|
|
5
5
|
import { paginate, PagePromise } from "../core/pagination.js";
|
|
6
6
|
import {
|
|
7
|
+
ResponseParseError,
|
|
7
8
|
TransportError,
|
|
8
9
|
UnexpectedApiError,
|
|
9
10
|
ValidationError,
|
|
@@ -53,6 +54,7 @@ export class TargetsResource {
|
|
|
53
54
|
return paginate<TargetRead, TargetsListError>(this._core, {
|
|
54
55
|
method: "GET",
|
|
55
56
|
path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
|
|
57
|
+
security: [{"apiKey":[]}],
|
|
56
58
|
query: {
|
|
57
59
|
limit: params?.limit,
|
|
58
60
|
cursor: params?.cursor,
|
|
@@ -82,16 +84,23 @@ export class TargetsResource {
|
|
|
82
84
|
*
|
|
83
85
|
* Several Targets may use the same generator with distinct configuration, Deliveries, and release
|
|
84
86
|
* streams.
|
|
87
|
+
*
|
|
88
|
+
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
85
89
|
* `POST /projects/{project_id}/targets`
|
|
86
90
|
*/
|
|
87
91
|
async create(
|
|
88
92
|
projectId: ProjectId,
|
|
89
93
|
body: TargetFields,
|
|
94
|
+
params?: TargetsCreateParams,
|
|
90
95
|
options?: RequestOptions,
|
|
91
96
|
): Promise<ApiResult<TargetResponseRead, TargetsCreateError>> {
|
|
92
97
|
return this._core.request<TargetResponseRead, TargetsCreateError>({
|
|
93
98
|
method: "POST",
|
|
94
99
|
path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
|
|
100
|
+
security: [{"apiKey":[]}],
|
|
101
|
+
headers: {
|
|
102
|
+
"Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
|
|
103
|
+
},
|
|
95
104
|
body,
|
|
96
105
|
errors: {
|
|
97
106
|
"400": BadRequestError,
|
|
@@ -102,6 +111,7 @@ export class TargetsResource {
|
|
|
102
111
|
"422": UnprocessableEntityError,
|
|
103
112
|
"429": RateLimitedError,
|
|
104
113
|
},
|
|
114
|
+
idempotencyKey: "Idempotency-Key",
|
|
105
115
|
schemaKey: "targets.create",
|
|
106
116
|
options,
|
|
107
117
|
});
|
|
@@ -118,6 +128,7 @@ export class TargetsResource {
|
|
|
118
128
|
return this._core.request<TargetResponseRead, TargetsRetrieveError>({
|
|
119
129
|
method: "GET",
|
|
120
130
|
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
131
|
+
security: [{"apiKey":[]}],
|
|
121
132
|
errors: {
|
|
122
133
|
"401": UnauthorizedError,
|
|
123
134
|
"403": ForbiddenError,
|
|
@@ -144,6 +155,7 @@ export class TargetsResource {
|
|
|
144
155
|
return this._core.request<DeletedTargetRead, TargetsDeleteError>({
|
|
145
156
|
method: "DELETE",
|
|
146
157
|
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
158
|
+
security: [{"apiKey":[]}],
|
|
147
159
|
errors: {
|
|
148
160
|
"401": UnauthorizedError,
|
|
149
161
|
"403": ForbiddenError,
|
|
@@ -169,6 +181,7 @@ export class TargetsResource {
|
|
|
169
181
|
return this._core.request<TargetResponseRead, TargetsUpdateError>({
|
|
170
182
|
method: "PATCH",
|
|
171
183
|
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
184
|
+
security: [{"apiKey":[]}],
|
|
172
185
|
body,
|
|
173
186
|
errors: {
|
|
174
187
|
"400": BadRequestError,
|
|
@@ -198,6 +211,7 @@ export class TargetsResource {
|
|
|
198
211
|
return paginate<TargetReleaseRead, TargetsListReleasesError>(this._core, {
|
|
199
212
|
method: "GET",
|
|
200
213
|
path: `/targets/${encodeURIComponent(String(targetId))}/releases`,
|
|
214
|
+
security: [{"apiKey":[]}],
|
|
201
215
|
query: {
|
|
202
216
|
limit: params?.limit,
|
|
203
217
|
cursor: params?.cursor,
|
|
@@ -233,6 +247,7 @@ export class TargetsResource {
|
|
|
233
247
|
return this._core.request<TargetReleaseResponseRead, TargetsRetrieveReleaseError>({
|
|
234
248
|
method: "GET",
|
|
235
249
|
path: `/target_releases/${encodeURIComponent(String(targetReleaseId))}`,
|
|
250
|
+
security: [{"apiKey":[]}],
|
|
236
251
|
errors: {
|
|
237
252
|
"401": UnauthorizedError,
|
|
238
253
|
"403": ForbiddenError,
|
|
@@ -264,9 +279,20 @@ export type TargetsListError =
|
|
|
264
279
|
| NotFoundError
|
|
265
280
|
| RateLimitedError
|
|
266
281
|
| UnexpectedApiError
|
|
282
|
+
| ResponseParseError
|
|
267
283
|
| TransportError
|
|
268
284
|
| ValidationError;
|
|
269
285
|
|
|
286
|
+
export interface TargetsCreateParams {
|
|
287
|
+
/**
|
|
288
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
289
|
+
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
290
|
+
* path, query, and JSON body replays the original response. Reusing the key with changed intent
|
|
291
|
+
* returns 409. After expiry the key starts a new write.
|
|
292
|
+
*/
|
|
293
|
+
idempotencyKey?: string;
|
|
294
|
+
}
|
|
295
|
+
|
|
270
296
|
/** Every error `create` can produce, as a discriminated union. */
|
|
271
297
|
export type TargetsCreateError =
|
|
272
298
|
| BadRequestError
|
|
@@ -277,6 +303,7 @@ export type TargetsCreateError =
|
|
|
277
303
|
| UnprocessableEntityError
|
|
278
304
|
| RateLimitedError
|
|
279
305
|
| UnexpectedApiError
|
|
306
|
+
| ResponseParseError
|
|
280
307
|
| TransportError
|
|
281
308
|
| ValidationError;
|
|
282
309
|
|
|
@@ -287,6 +314,7 @@ export type TargetsRetrieveError =
|
|
|
287
314
|
| NotFoundError
|
|
288
315
|
| RateLimitedError
|
|
289
316
|
| UnexpectedApiError
|
|
317
|
+
| ResponseParseError
|
|
290
318
|
| TransportError
|
|
291
319
|
| ValidationError;
|
|
292
320
|
|
|
@@ -298,6 +326,7 @@ export type TargetsDeleteError =
|
|
|
298
326
|
| ConflictError
|
|
299
327
|
| RateLimitedError
|
|
300
328
|
| UnexpectedApiError
|
|
329
|
+
| ResponseParseError
|
|
301
330
|
| TransportError
|
|
302
331
|
| ValidationError;
|
|
303
332
|
|
|
@@ -311,6 +340,7 @@ export type TargetsUpdateError =
|
|
|
311
340
|
| UnprocessableEntityError
|
|
312
341
|
| RateLimitedError
|
|
313
342
|
| UnexpectedApiError
|
|
343
|
+
| ResponseParseError
|
|
314
344
|
| TransportError
|
|
315
345
|
| ValidationError;
|
|
316
346
|
|
|
@@ -332,6 +362,7 @@ export type TargetsListReleasesError =
|
|
|
332
362
|
| NotFoundError
|
|
333
363
|
| RateLimitedError
|
|
334
364
|
| UnexpectedApiError
|
|
365
|
+
| ResponseParseError
|
|
335
366
|
| TransportError
|
|
336
367
|
| ValidationError;
|
|
337
368
|
|
|
@@ -342,5 +373,6 @@ export type TargetsRetrieveReleaseError =
|
|
|
342
373
|
| NotFoundError
|
|
343
374
|
| RateLimitedError
|
|
344
375
|
| UnexpectedApiError
|
|
376
|
+
| ResponseParseError
|
|
345
377
|
| TransportError
|
|
346
378
|
| ValidationError;
|