@typeship-ax/cli 0.20.0 → 0.21.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 +3 -3
- package/README.md +2 -2
- package/api.json +7355 -6233
- package/api.md +332 -398
- package/dist/api-identity.d.ts.map +1 -1
- package/dist/api-identity.js +6 -1
- package/dist/cli.js +15 -15
- package/dist/core/http.d.ts +26 -14
- package/dist/core/http.d.ts.map +1 -1
- package/dist/core/http.js +90 -19
- package/dist/core/pagination.d.ts +8 -8
- package/dist/core/pagination.d.ts.map +1 -1
- package/dist/core/pagination.js +7 -16
- package/dist/errors.d.ts +4 -4
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +7 -7
- package/dist/index.d.ts +33 -19
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +37 -17
- package/dist/ops.d.ts +1 -1
- package/dist/ops.d.ts.map +1 -1
- package/dist/ops.js +39 -42
- package/dist/resources/api-keys.d.ts +10 -10
- package/dist/resources/api-keys.d.ts.map +1 -1
- package/dist/resources/api-keys.js +6 -6
- package/dist/resources/deliveries.d.ts +46 -0
- package/dist/resources/deliveries.d.ts.map +1 -0
- package/dist/resources/deliveries.js +70 -0
- package/dist/resources/drafts.d.ts +155 -0
- package/dist/resources/drafts.d.ts.map +1 -0
- package/dist/resources/drafts.js +230 -0
- package/dist/resources/files.d.ts +23 -0
- package/dist/resources/files.d.ts.map +1 -0
- package/dist/resources/files.js +38 -0
- package/dist/resources/generate.d.ts +14 -14
- package/dist/resources/generate.d.ts.map +1 -1
- package/dist/resources/generate.js +7 -7
- package/dist/resources/generations.d.ts +65 -21
- package/dist/resources/generations.d.ts.map +1 -1
- package/dist/resources/generations.js +67 -20
- package/dist/resources/organization.d.ts +18 -0
- package/dist/resources/organization.d.ts.map +1 -0
- package/dist/resources/{account.js → organization.js} +10 -10
- package/dist/resources/projects.d.ts +36 -126
- package/dist/resources/projects.d.ts.map +1 -1
- package/dist/resources/projects.js +21 -171
- package/dist/resources/publications.d.ts +46 -0
- package/dist/resources/publications.d.ts.map +1 -0
- package/dist/resources/publications.js +70 -0
- package/dist/resources/releases.d.ts +66 -0
- package/dist/resources/releases.d.ts.map +1 -0
- package/dist/resources/releases.js +101 -0
- package/dist/resources/spec-revisions.d.ts +85 -0
- package/dist/resources/spec-revisions.d.ts.map +1 -0
- package/dist/resources/spec-revisions.js +116 -0
- package/dist/resources/specs.d.ts +72 -0
- package/dist/resources/specs.d.ts.map +1 -0
- package/dist/resources/specs.js +107 -0
- package/dist/resources/targets.d.ts +42 -262
- package/dist/resources/targets.d.ts.map +1 -1
- package/dist/resources/targets.js +28 -407
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +149 -154
- package/dist/types.d.ts +1281 -1611
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +44 -49
- package/package.json +1 -1
- package/src/api-identity.ts +6 -2
- package/src/cli.ts +16 -16
- package/src/core/http.ts +89 -24
- package/src/core/pagination.ts +13 -23
- package/src/errors.ts +7 -7
- package/src/index.ts +41 -23
- package/src/ops.ts +40 -43
- package/src/resources/api-keys.ts +13 -16
- package/src/resources/deliveries.ts +139 -0
- package/src/resources/drafts.ts +422 -0
- package/src/resources/files.ts +68 -0
- package/src/resources/generate.ts +16 -19
- package/src/resources/generations.ts +146 -35
- package/src/resources/{account.ts → organization.ts} +14 -14
- package/src/resources/projects.ts +42 -337
- package/src/resources/publications.ts +139 -0
- package/src/resources/releases.ts +199 -0
- package/src/resources/spec-revisions.ts +237 -0
- package/src/resources/specs.ts +200 -0
- package/src/resources/targets.ts +57 -760
- package/src/schemas.ts +149 -154
- package/src/types.ts +1357 -1692
- package/dist/resources/account.d.ts +0 -18
- package/dist/resources/account.d.ts.map +0 -1
- package/dist/resources/definition-revisions.d.ts +0 -75
- package/dist/resources/definition-revisions.d.ts.map +0 -1
- package/dist/resources/definition-revisions.js +0 -142
- package/dist/resources/definitions.d.ts +0 -50
- package/dist/resources/definitions.d.ts.map +0 -1
- package/dist/resources/definitions.js +0 -73
- package/src/resources/definition-revisions.ts +0 -265
- package/src/resources/definitions.ts +0 -146
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
import { HttpCore, type
|
|
1
|
+
import { HttpCore, type RequestOptions } from "../core/http.js";
|
|
2
2
|
import { PagePromise } from "../core/pagination.js";
|
|
3
3
|
import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadGatewayError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PaymentRequiredError, PreconditionFailedError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
|
|
4
|
-
import type { DeletedTargetRead,
|
|
4
|
+
import type { DeletedTargetRead, ProjectId, ReleaseResponseRead, TargetAdoption, TargetCreateRequest, TargetId, TargetRead, TargetResponseRead, TargetUpdateRequest } from "../types.js";
|
|
5
5
|
export declare class TargetsResource {
|
|
6
6
|
private readonly _core;
|
|
7
7
|
constructor(_core: HttpCore);
|
|
8
8
|
/**
|
|
9
|
-
* List
|
|
9
|
+
* List Targets
|
|
10
10
|
*
|
|
11
11
|
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
12
|
-
* `GET /
|
|
12
|
+
* `GET /targets`
|
|
13
13
|
*/
|
|
14
|
-
list(
|
|
14
|
+
list(params?: TargetsListParams, options?: RequestOptions): PagePromise<TargetRead, TargetsListError>;
|
|
15
15
|
/**
|
|
16
16
|
* Create an independently configured Target
|
|
17
17
|
*
|
|
@@ -19,14 +19,14 @@ export declare class TargetsResource {
|
|
|
19
19
|
* can use the same generator.
|
|
20
20
|
*
|
|
21
21
|
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
22
|
-
* `POST /
|
|
22
|
+
* `POST /targets`
|
|
23
23
|
*/
|
|
24
|
-
create(
|
|
24
|
+
create(body: TargetCreateRequest, params?: TargetsCreateParams, options?: RequestOptions): Promise<TargetResponseRead>;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Get a Target
|
|
27
27
|
* `GET /targets/{target_id}`
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
get(targetId: TargetId, options?: RequestOptions): Promise<TargetResponseRead>;
|
|
30
30
|
/**
|
|
31
31
|
* Delete an unused Target
|
|
32
32
|
*
|
|
@@ -38,175 +38,40 @@ export declare class TargetsResource {
|
|
|
38
38
|
* and If-Match.
|
|
39
39
|
* `DELETE /targets/{target_id}`
|
|
40
40
|
*/
|
|
41
|
-
delete(targetId: TargetId, params?: TargetsDeleteParams, options?: RequestOptions): Promise<
|
|
41
|
+
delete(targetId: TargetId, params?: TargetsDeleteParams, options?: RequestOptions): Promise<DeletedTargetRead>;
|
|
42
42
|
/**
|
|
43
|
-
* Update a Target
|
|
43
|
+
* Update a Target or its Deliveries
|
|
44
44
|
*
|
|
45
45
|
* Omitted fields keep their current values. Supplied config, checks, and deliveries replace their
|
|
46
46
|
* complete stored values.
|
|
47
|
+
* With Project auto_generate enabled, changing Target config, checks, or Deliveries queues that
|
|
48
|
+
* Target's Generation. A queued or running Target reuses that Generation.
|
|
47
49
|
* Omitting If-Match applies the update to the current resource; with If-Match, a stale ETag
|
|
48
50
|
* returns 412 precondition_failed without saving.
|
|
49
|
-
*
|
|
51
|
+
* Select the next version through PATCH /drafts/{draft_id} on the Target's draft_id.
|
|
50
52
|
*
|
|
51
53
|
* A `409 target_busy` means the Target is publishing; wait for it to finish. A `409
|
|
52
54
|
* delivery_conflict` means another Target owns the requested repository tree; retrieve both
|
|
53
55
|
* Targets, choose a free destination, and retry.
|
|
54
|
-
* A `502` response means the update was saved, but retiring an obsolete review or regenerating
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* repeating a completed selection starts no new work.
|
|
56
|
+
* A `502` response means the update was saved, but retiring an obsolete review or regenerating
|
|
57
|
+
* the Target failed. Retrieve the Target and follow the error's retryable and suggested_action
|
|
58
|
+
* fields.
|
|
58
59
|
* See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
|
|
59
60
|
* and If-Match.
|
|
60
61
|
* `PATCH /targets/{target_id}`
|
|
61
62
|
*/
|
|
62
|
-
update(targetId: TargetId, body: TargetUpdateRequest, params?: TargetsUpdateParams, options?: RequestOptions): Promise<
|
|
63
|
+
update(targetId: TargetId, body: TargetUpdateRequest, params?: TargetsUpdateParams, options?: RequestOptions): Promise<TargetResponseRead>;
|
|
63
64
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
67
|
-
* `GET /targets/{target_id}/releases`
|
|
68
|
-
*/
|
|
69
|
-
listReleases(targetId: TargetId, params?: TargetsListReleasesParams, options?: RequestOptions): PagePromise<TargetReleaseRead, TargetsListReleasesError>;
|
|
70
|
-
/**
|
|
71
|
-
* Retrieve a Target's rolling Draft release
|
|
72
|
-
*
|
|
73
|
-
* Returns the Draft's status and its one next step, Current's version, the proposed version,
|
|
74
|
-
* readiness, checks, and conflict counts. Every status is described on `status`. The response
|
|
75
|
-
* carries an `ETag`; send it in `If-Match` when updating the Draft to avoid changing a newer
|
|
76
|
-
* version selection.
|
|
77
|
-
* `GET /targets/{target_id}/draft`
|
|
78
|
-
*/
|
|
79
|
-
retrieveDraft(targetId: TargetId, options?: RequestOptions): Promise<ApiResult<TargetDraftResponseRead, TargetsRetrieveDraftError>>;
|
|
80
|
-
/**
|
|
81
|
-
* Select an exact Draft version or return to automatic versioning
|
|
82
|
-
*
|
|
83
|
-
* Checks your version choice against the required version bump, then regenerates the existing
|
|
84
|
-
* Draft pull request.
|
|
85
|
-
*
|
|
86
|
-
* Send the Draft's `ETag` in `If-Match` to reject an intervening change with 412
|
|
87
|
-
* precondition_failed before saving or regenerating. Omitting `If-Match` applies the selection to
|
|
88
|
-
* the current Draft. Version is required; null restores automatic selection.
|
|
89
|
-
*
|
|
90
|
-
* A `502` response means the selected version was saved, but regeneration failed. Follow the
|
|
91
|
-
* error's retryable and suggested_action fields. Repeating an unfinished selection resumes
|
|
92
|
-
* generation; repeating a completed selection starts no new work. If using If-Match, retrieve the
|
|
93
|
-
* Draft and confirm the saved selection before retrying with its current ETag.
|
|
94
|
-
* A `409 target_busy` means the Target is publishing; wait and retry. A `409 version_occupied`
|
|
95
|
-
* means the version is already released; retrieve the Draft and releases, choose a new version,
|
|
96
|
-
* and retry.
|
|
97
|
-
* See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
|
|
98
|
-
* and If-Match.
|
|
99
|
-
* `PATCH /targets/{target_id}/draft`
|
|
100
|
-
*/
|
|
101
|
-
updateDraft(targetId: TargetId, body: TargetDraftUpdate, params?: TargetsUpdateDraftParams, options?: RequestOptions): Promise<ApiResult<TargetDraftResponseRead, TargetsUpdateDraftError>>;
|
|
102
|
-
/**
|
|
103
|
-
* Adopt a verified existing package as Current
|
|
65
|
+
* Adopt a verified existing package as the latest release
|
|
104
66
|
*
|
|
105
67
|
* Checks the repository tag, package metadata, and registry artifact, then records the package as
|
|
106
|
-
* an Imported
|
|
107
|
-
*
|
|
68
|
+
* an Imported latest release. Opens the first Typeship Draft at the next major version; review it
|
|
69
|
+
* to establish the baseline for preserving existing code.
|
|
108
70
|
*
|
|
109
71
|
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
110
72
|
* `POST /targets/{target_id}/adopt`
|
|
111
73
|
*/
|
|
112
|
-
|
|
113
|
-
/**
|
|
114
|
-
* Retrieve an immutable Target release
|
|
115
|
-
* `GET /target-releases/{target_release_id}`
|
|
116
|
-
*/
|
|
117
|
-
retrieveRelease(targetReleaseId: TargetReleaseId, options?: RequestOptions): Promise<ApiResult<TargetReleaseResponseRead, TargetsRetrieveReleaseError>>;
|
|
118
|
-
/**
|
|
119
|
-
* Retry publication of an exact Target release
|
|
120
|
-
*
|
|
121
|
-
* Retries publication of the specified release through its repository workflow. Uses that
|
|
122
|
-
* release's version and accepted commit, even if a newer Draft or release exists.
|
|
123
|
-
*
|
|
124
|
-
* A `502` response means the repository publication workflow could not be dispatched.
|
|
125
|
-
*
|
|
126
|
-
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
127
|
-
* `POST /target-releases/{target_release_id}/republish`
|
|
128
|
-
*/
|
|
129
|
-
republishRelease(targetReleaseId: TargetReleaseId, params?: TargetsRepublishReleaseParams, options?: RequestOptions): Promise<ApiResult<TargetReleaseResponseRead, TargetsRepublishReleaseError>>;
|
|
130
|
-
/**
|
|
131
|
-
* List customized and conflicted files on a Draft
|
|
132
|
-
*
|
|
133
|
-
* Lists the Draft's files that differ from the last accepted package or need a conflict decision,
|
|
134
|
-
* ordered by path, without file content. Each conflict names its kind, where the incoming version
|
|
135
|
-
* comes from, the saved decision, and the sides you can read with retrieveDraftFileContent. With
|
|
136
|
-
* `filter=history`, lists the files affected by a default-branch history rewrite instead; the
|
|
137
|
-
* list is empty when none is pending.
|
|
138
|
-
*
|
|
139
|
-
* Returns `409 stale_draft` while Typeship has not integrated the Draft's latest commit (Draft
|
|
140
|
-
* status generating or branch_changed), or when the Draft changes between pages.
|
|
141
|
-
*
|
|
142
|
-
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
143
|
-
* `GET /targets/{target_id}/draft/files`
|
|
144
|
-
*/
|
|
145
|
-
listDraftFiles(targetId: TargetId, params?: TargetsListDraftFilesParams, options?: RequestOptions): PagePromise<DraftFileRead, TargetsListDraftFilesError>;
|
|
146
|
-
/**
|
|
147
|
-
* Read one side of a Draft file
|
|
148
|
-
*
|
|
149
|
-
* Returns up to 24 KiB of one side of a conflicted or history-affected file: text as UTF-8,
|
|
150
|
-
* binary content as base64. Follow `next_cursor` with the same path and side to read the rest,
|
|
151
|
-
* and concatenate the chunks in order. A side where the file is absent returns 404.
|
|
152
|
-
* `GET /targets/{target_id}/draft/files/content`
|
|
153
|
-
*/
|
|
154
|
-
retrieveDraftFileContent(targetId: TargetId, params: TargetsRetrieveDraftFileContentParams, options?: RequestOptions): Promise<ApiResult<DraftFileContentResponseRead, TargetsRetrieveDraftFileContentError>>;
|
|
155
|
-
/**
|
|
156
|
-
* Resolve selected Draft conflicts
|
|
157
|
-
*
|
|
158
|
-
* Saves decisions for conflicts on the Draft's head_revision: keep the repository or incoming
|
|
159
|
-
* version, or supply the final content as text or, for binary files, base64. Decisions save
|
|
160
|
-
* together or not at all, and a decision can be replaced until it is applied. Use `dry_run` to
|
|
161
|
-
* validate them first.
|
|
162
|
-
*
|
|
163
|
-
* Saving changes no files. When every conflict has a decision, `remaining_conflicts` is 0 and the
|
|
164
|
-
* Draft status becomes `needs_generation`: generate the Target to apply the decisions and run its
|
|
165
|
-
* checks. Applying them can report conflicts from the next merge stage.
|
|
166
|
-
* `POST /targets/{target_id}/draft/conflicts/resolve`
|
|
167
|
-
*/
|
|
168
|
-
resolveDraftConflicts(targetId: TargetId, body: ResolveDraftConflicts, options?: RequestOptions): Promise<ApiResult<DraftConflictResolutionResponseRead, TargetsResolveDraftConflictsError>>;
|
|
169
|
-
/**
|
|
170
|
-
* Discard selected Draft customizations
|
|
171
|
-
*
|
|
172
|
-
* Replaces the listed customized paths that are not conflicts with the generated files, in one
|
|
173
|
-
* commit on the Draft branch. A listed file that exists only on the Draft is deleted. Use
|
|
174
|
-
* `dry_run` to see the planned writes and deletions first. Resolve conflicts with
|
|
175
|
-
* resolveDraftConflicts.
|
|
176
|
-
*
|
|
177
|
-
* After the commit, the Draft status is `branch_changed` until Typeship integrates it from the
|
|
178
|
-
* repository's pull request event and reruns the checks; you do not need to generate the Target.
|
|
179
|
-
* `POST /targets/{target_id}/draft/customizations/discard`
|
|
180
|
-
*/
|
|
181
|
-
discardDraftCustomizations(targetId: TargetId, body: DiscardDraftCustomizations, options?: RequestOptions): Promise<ApiResult<DraftCustomizationDiscardResponseRead, TargetsDiscardDraftCustomizationsError>>;
|
|
182
|
-
/**
|
|
183
|
-
* Approve recovery from rewritten default-branch history
|
|
184
|
-
*
|
|
185
|
-
* When the Draft status is `history_rewritten`, review the affected files with `listDraftFiles`
|
|
186
|
-
* and `filter=history`, then approve with the Draft's `history_recovery` revisions. Approval
|
|
187
|
-
* saves the recovery without changing Git, and the Draft status becomes `needs_generation`:
|
|
188
|
-
* generate the Target to open a new Draft from the rewritten default branch. The previous Draft
|
|
189
|
-
* branch stays available, and overlapping code comes back as conflicts to resolve. A rewritten
|
|
190
|
-
* Draft branch alone needs no approval.
|
|
191
|
-
* `POST /targets/{target_id}/draft/history/recover`
|
|
192
|
-
*/
|
|
193
|
-
recoverDraftHistory(targetId: TargetId, body: RecoverDraftHistory, options?: RequestOptions): Promise<ApiResult<DraftHistoryRecoveryResponseRead, TargetsRecoverDraftHistoryError>>;
|
|
194
|
-
/**
|
|
195
|
-
* Retrieve a Delivery
|
|
196
|
-
*
|
|
197
|
-
* Returns the configured repository or hosted MCP Delivery for a Target. A Delivery in another
|
|
198
|
-
* organization returns 404 not_found.
|
|
199
|
-
* `GET /deliveries/{delivery_id}`
|
|
200
|
-
*/
|
|
201
|
-
retrieveDelivery(deliveryId: DeliveryId, options?: RequestOptions): Promise<ApiResult<DeliveryResponseRead, TargetsRetrieveDeliveryError>>;
|
|
202
|
-
/**
|
|
203
|
-
* Retrieve a Publication
|
|
204
|
-
*
|
|
205
|
-
* Returns the current registry publication state for a Target Release. A Publication in another
|
|
206
|
-
* organization returns 404 not_found.
|
|
207
|
-
* `GET /publications/{publication_id}`
|
|
208
|
-
*/
|
|
209
|
-
retrievePublication(publicationId: PublicationId, options?: RequestOptions): Promise<ApiResult<PublicationResponseRead, TargetsRetrievePublicationError>>;
|
|
74
|
+
adopt(targetId: TargetId, body: TargetAdoption, params?: TargetsAdoptParams, options?: RequestOptions): Promise<ReleaseResponseRead>;
|
|
210
75
|
}
|
|
211
76
|
export interface TargetsListParams {
|
|
212
77
|
/**
|
|
@@ -217,28 +82,30 @@ export interface TargetsListParams {
|
|
|
217
82
|
*/
|
|
218
83
|
limit?: number;
|
|
219
84
|
/**
|
|
220
|
-
* Opaque cursor from the preceding page's next_cursor. Valid only for the same
|
|
85
|
+
* Opaque cursor from the preceding page's next_cursor. Valid only for the same organization,
|
|
221
86
|
* operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
|
|
222
87
|
* malformed, or repeated cursors return 400 invalid_request. The page limit may change between
|
|
223
88
|
* requests.
|
|
224
89
|
*/
|
|
225
90
|
cursor?: string;
|
|
91
|
+
/** Only Targets in this Project. */
|
|
92
|
+
projectId?: ProjectId;
|
|
226
93
|
}
|
|
227
|
-
/**
|
|
94
|
+
/** Typed errors `list` can throw. */
|
|
228
95
|
export type TargetsListError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
229
96
|
export interface TargetsCreateParams {
|
|
230
97
|
/**
|
|
231
|
-
* Identifies one logical write for 24 hours. The key is scoped to the authenticated
|
|
232
|
-
* operation;
|
|
233
|
-
* path, query, If-Match header, and JSON body replays the original response. Reusing
|
|
234
|
-
* changed intent returns 409. After expiry the key starts a new write.
|
|
98
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
|
|
99
|
+
* and operation; generation without an organization uses a hashed network identity. Retrying the
|
|
100
|
+
* same method, path, query, If-Match header, and JSON body replays the original response. Reusing
|
|
101
|
+
* the key with changed intent returns 409. After expiry the key starts a new write.
|
|
235
102
|
*/
|
|
236
103
|
idempotencyKey?: string;
|
|
237
104
|
}
|
|
238
|
-
/**
|
|
105
|
+
/** Typed errors `create` can throw. */
|
|
239
106
|
export type TargetsCreateError = BadRequestError | UnauthorizedError | PaymentRequiredError | ForbiddenError | NotFoundError | ConflictError | UnprocessableEntityError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
240
|
-
/**
|
|
241
|
-
export type
|
|
107
|
+
/** Typed errors `get` can throw. */
|
|
108
|
+
export type TargetsGetError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
242
109
|
export interface TargetsDeleteParams {
|
|
243
110
|
/**
|
|
244
111
|
* ETag from a preceding response. The write applies only if the resource still has that version;
|
|
@@ -247,7 +114,7 @@ export interface TargetsDeleteParams {
|
|
|
247
114
|
*/
|
|
248
115
|
ifMatch?: string;
|
|
249
116
|
}
|
|
250
|
-
/**
|
|
117
|
+
/** Typed errors `delete` can throw. */
|
|
251
118
|
export type TargetsDeleteError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | PreconditionFailedError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
252
119
|
export interface TargetsUpdateParams {
|
|
253
120
|
/**
|
|
@@ -257,104 +124,17 @@ export interface TargetsUpdateParams {
|
|
|
257
124
|
*/
|
|
258
125
|
ifMatch?: string;
|
|
259
126
|
}
|
|
260
|
-
/**
|
|
127
|
+
/** Typed errors `update` can throw. */
|
|
261
128
|
export type TargetsUpdateError = BadRequestError | UnauthorizedError | PaymentRequiredError | ForbiddenError | NotFoundError | ConflictError | PreconditionFailedError | UnprocessableEntityError | RateLimitedError | InternalServerError | BadGatewayError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
262
|
-
export interface
|
|
263
|
-
/**
|
|
264
|
-
* Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
|
|
265
|
-
* representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
266
|
-
* invalid_request. List query parameters must appear only once; unrecognized parameters also
|
|
267
|
-
* return 400.
|
|
268
|
-
*/
|
|
269
|
-
limit?: number;
|
|
270
|
-
/**
|
|
271
|
-
* Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
|
|
272
|
-
* operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
|
|
273
|
-
* malformed, or repeated cursors return 400 invalid_request. The page limit may change between
|
|
274
|
-
* requests.
|
|
275
|
-
*/
|
|
276
|
-
cursor?: string;
|
|
277
|
-
}
|
|
278
|
-
/** Every error `listReleases` can produce, as a discriminated union. */
|
|
279
|
-
export type TargetsListReleasesError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
280
|
-
/** Every error `retrieveDraft` can produce, as a discriminated union. */
|
|
281
|
-
export type TargetsRetrieveDraftError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
282
|
-
export interface TargetsUpdateDraftParams {
|
|
283
|
-
/**
|
|
284
|
-
* ETag from a preceding response. The write applies only if the resource still has that version;
|
|
285
|
-
* otherwise it returns 412 precondition_failed without changes. Omit to write the current
|
|
286
|
-
* version. See https://typeship.dev/docs/typeship-api#conditional-writes.
|
|
287
|
-
*/
|
|
288
|
-
ifMatch?: string;
|
|
289
|
-
}
|
|
290
|
-
/** Every error `updateDraft` can produce, as a discriminated union. */
|
|
291
|
-
export type TargetsUpdateDraftError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | PreconditionFailedError | UnprocessableEntityError | RateLimitedError | InternalServerError | BadGatewayError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
292
|
-
export interface TargetsAdoptReleaseParams {
|
|
129
|
+
export interface TargetsAdoptParams {
|
|
293
130
|
/**
|
|
294
|
-
* Identifies one logical write for 24 hours. The key is scoped to the authenticated
|
|
295
|
-
* operation;
|
|
296
|
-
* path, query, If-Match header, and JSON body replays the original response. Reusing
|
|
297
|
-
* changed intent returns 409. After expiry the key starts a new write.
|
|
131
|
+
* Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
|
|
132
|
+
* and operation; generation without an organization uses a hashed network identity. Retrying the
|
|
133
|
+
* same method, path, query, If-Match header, and JSON body replays the original response. Reusing
|
|
134
|
+
* the key with changed intent returns 409. After expiry the key starts a new write.
|
|
298
135
|
*/
|
|
299
136
|
idempotencyKey?: string;
|
|
300
137
|
}
|
|
301
|
-
/**
|
|
302
|
-
export type
|
|
303
|
-
/** Every error `retrieveRelease` can produce, as a discriminated union. */
|
|
304
|
-
export type TargetsRetrieveReleaseError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
305
|
-
export interface TargetsRepublishReleaseParams {
|
|
306
|
-
/**
|
|
307
|
-
* Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
|
|
308
|
-
* operation; account-less generation uses a hashed network identity. Retrying the same method,
|
|
309
|
-
* path, query, If-Match header, and JSON body replays the original response. Reusing the key with
|
|
310
|
-
* changed intent returns 409. After expiry the key starts a new write.
|
|
311
|
-
*/
|
|
312
|
-
idempotencyKey?: string;
|
|
313
|
-
}
|
|
314
|
-
/** Every error `republishRelease` can produce, as a discriminated union. */
|
|
315
|
-
export type TargetsRepublishReleaseError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | BadGatewayError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
316
|
-
export interface TargetsListDraftFilesParams {
|
|
317
|
-
/**
|
|
318
|
-
* conflicted: conflicts only. customized: files that differ from the last accepted package.
|
|
319
|
-
* history: files affected by a default-branch history rewrite. Omit for conflicted and customized
|
|
320
|
-
* files.
|
|
321
|
-
*/
|
|
322
|
-
filter?: "conflicted" | "customized" | "history";
|
|
323
|
-
/**
|
|
324
|
-
* Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
|
|
325
|
-
* representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
|
|
326
|
-
* invalid_request. List query parameters must appear only once; unrecognized parameters also
|
|
327
|
-
* return 400.
|
|
328
|
-
*/
|
|
329
|
-
limit?: number;
|
|
330
|
-
/**
|
|
331
|
-
* Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
|
|
332
|
-
* operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
|
|
333
|
-
* malformed, or repeated cursors return 400 invalid_request. The page limit may change between
|
|
334
|
-
* requests.
|
|
335
|
-
*/
|
|
336
|
-
cursor?: string;
|
|
337
|
-
}
|
|
338
|
-
/** Every error `listDraftFiles` can produce, as a discriminated union. */
|
|
339
|
-
export type TargetsListDraftFilesError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
340
|
-
export interface TargetsRetrieveDraftFileContentParams {
|
|
341
|
-
/** File path from listDraftFiles. */
|
|
342
|
-
path: string;
|
|
343
|
-
/** A side listed for the file. */
|
|
344
|
-
side: DraftFileSide;
|
|
345
|
-
/** next_cursor from the preceding chunk of the same path and side. */
|
|
346
|
-
cursor?: string;
|
|
347
|
-
}
|
|
348
|
-
/** Every error `retrieveDraftFileContent` can produce, as a discriminated union. */
|
|
349
|
-
export type TargetsRetrieveDraftFileContentError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
350
|
-
/** Every error `resolveDraftConflicts` can produce, as a discriminated union. */
|
|
351
|
-
export type TargetsResolveDraftConflictsError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
352
|
-
/** Every error `discardDraftCustomizations` can produce, as a discriminated union. */
|
|
353
|
-
export type TargetsDiscardDraftCustomizationsError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
354
|
-
/** Every error `recoverDraftHistory` can produce, as a discriminated union. */
|
|
355
|
-
export type TargetsRecoverDraftHistoryError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
356
|
-
/** Every error `retrieveDelivery` can produce, as a discriminated union. */
|
|
357
|
-
export type TargetsRetrieveDeliveryError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
358
|
-
/** Every error `retrievePublication` can produce, as a discriminated union. */
|
|
359
|
-
export type TargetsRetrievePublicationError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
138
|
+
/** Typed errors `adopt` can throw. */
|
|
139
|
+
export type TargetsAdoptError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | UnprocessableEntityError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
|
|
360
140
|
//# sourceMappingURL=targets.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../src/resources/targets.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../src/resources/targets.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAEV,iBAAiB,EACjB,SAAS,EAET,mBAAmB,EAEnB,cAAc,EACd,mBAAmB,EACnB,QAAQ,EAGR,UAAU,EAEV,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;OAKG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,CAAC;IA+BrG;;;;;;;;OAQG;IACG,MAAM,CACV,IAAI,EAAE,mBAAmB,EACzB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kBAAkB,CAAC;IA0B9B;;;OAGG;IACG,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAkBpF;;;;;;;;;;OAUG;IACG,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAwB7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,EACzB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kBAAkB,CAAC;IA2B9B;;;;;;;;;OASG;IACG,KAAK,CACT,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,cAAc,EACpB,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;CAwBhC;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,qCAAqC;AACrC,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oCAAoC;AACpC,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,uBAAuB,GACvB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,sCAAsC;AACtC,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
|