@typeship-ax/mcp 0.6.0 → 0.8.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/README.md +1 -1
- package/api.json +5597 -3010
- package/api.md +433 -54
- package/dist/core/http.d.ts +6 -92
- package/dist/core/http.d.ts.map +1 -1
- package/dist/core/http.js +70 -209
- package/dist/core/pagination.d.ts.map +1 -1
- package/dist/core/pagination.js +6 -34
- package/dist/dates.d.ts +0 -2
- package/dist/dates.d.ts.map +1 -1
- package/dist/dates.js +0 -1
- package/dist/docs.d.ts +11 -0
- package/dist/docs.d.ts.map +1 -0
- package/dist/docs.js +114 -0
- package/dist/errors.d.ts +27 -27
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +7 -7
- package/dist/index.d.ts +19 -11
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +23 -13
- package/dist/mcp-protocol.d.ts +19 -24
- package/dist/mcp-protocol.d.ts.map +1 -1
- package/dist/mcp-protocol.js +160 -124
- package/dist/mcp.js +16 -19
- package/dist/ops.d.ts +5 -0
- package/dist/ops.d.ts.map +1 -1
- package/dist/ops.js +31 -17
- package/dist/resources/account.d.ts +2 -2
- package/dist/resources/account.d.ts.map +1 -1
- package/dist/resources/api-keys.d.ts +10 -5
- package/dist/resources/api-keys.d.ts.map +1 -1
- package/dist/resources/api-keys.js +3 -1
- package/dist/resources/definition-revisions.d.ts +58 -0
- package/dist/resources/definition-revisions.d.ts.map +1 -0
- package/dist/resources/definition-revisions.js +110 -0
- package/dist/resources/definitions.d.ts +24 -0
- package/dist/resources/definitions.d.ts.map +1 -0
- package/dist/resources/definitions.js +51 -0
- package/dist/resources/generate.d.ts +5 -5
- package/dist/resources/generate.d.ts.map +1 -1
- package/dist/resources/generate.js +3 -3
- package/dist/resources/generations.d.ts +3 -3
- package/dist/resources/generations.d.ts.map +1 -1
- package/dist/resources/generations.js +1 -1
- package/dist/resources/projects.d.ts +66 -26
- package/dist/resources/projects.d.ts.map +1 -1
- package/dist/resources/projects.js +87 -13
- package/dist/resources/targets.d.ts +86 -0
- package/dist/resources/targets.d.ts.map +1 -0
- package/dist/resources/targets.js +184 -0
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +119 -62
- package/dist/types.d.ts +1761 -222
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +9 -3
- package/package.json +1 -1
- package/src/core/http.ts +75 -293
- package/src/core/pagination.ts +6 -30
- package/src/dates.ts +0 -1
- package/src/docs.ts +101 -0
- package/src/errors.ts +30 -30
- package/src/index.ts +23 -13
- package/src/mcp-protocol.ts +170 -120
- package/src/mcp.ts +22 -22
- package/src/ops.ts +43 -17
- package/src/resources/account.ts +3 -3
- package/src/resources/api-keys.ts +22 -7
- package/src/resources/definition-revisions.ts +198 -0
- package/src/resources/definitions.ts +97 -0
- package/src/resources/generate.ts +6 -6
- package/src/resources/generations.ts +4 -4
- package/src/resources/projects.ts +182 -37
- package/src/resources/targets.ts +346 -0
- package/src/schemas.ts +119 -62
- package/src/types.ts +1947 -281
- package/dist/resources/spec-revisions.d.ts +0 -47
- package/dist/resources/spec-revisions.d.ts.map +0 -1
- package/dist/resources/spec-revisions.js +0 -90
- package/src/resources/spec-revisions.ts +0 -150
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"projects.d.ts","sourceRoot":"","sources":["../../src/resources/projects.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,oBAAoB,
|
|
1
|
+
{"version":3,"file":"projects.d.ts","sourceRoot":"","sources":["../../src/resources/projects.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EACV,oBAAoB,EAEpB,kBAAkB,EAElB,yBAAyB,EACzB,4BAA4B,EAE5B,oBAAoB,EAGpB,mBAAmB,EAGnB,cAAc,EAEd,SAAS,EAGT,WAAW,EAEX,kBAAkB,EAElB,+BAA+B,EAC/B,QAAQ,EACR,oBAAoB,EACrB,MAAM,aAAa,CAAC;AAErB,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;OAKG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IA2BrD;;;;;;;;;;OAUG;IACG,MAAM,CACV,IAAI,EAAE,oBAAoB,EAC1B,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAwBvD;;;OAGG;IACG,QAAQ,CACZ,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;IAgBzD;;;OAGG;IACG,MAAM,CACV,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,mBAAmB,CAAC,CAAC;IAgB9D;;;OAGG;IACG,MAAM,CACV,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAmBvD;;;;;;;;OAQG;IACG,mBAAmB,CACvB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,gCAAgC,CAAC,CAAC;IAgB7E;;;;;;;OAOG;IACG,kBAAkB,CACtB,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,+BAA+B,CAAC,CAAC;IAgB5E;;;;;;;OAOG;IACG,oBAAoB,CACxB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,iCAAiC,CAAC,CAAC;IAkBnF;;;;;;;OAOG;IACG,yBAAyB,CAC7B,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,+BAA+B,EAAE,sCAAsC,CAAC,CAAC;IAgB9F;;;;;OAKG;IACH,eAAe,CACb,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,6BAA6B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,cAAc,EAAE,4BAA4B,CAAC;IA6B5D;;;;;;;;;;;OAWG;IACG,QAAQ,CACZ,SAAS,EAAE,SAAS,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;CAiBlE;AAED,MAAM,WAAW,kBAAkB;IACjC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,kEAAkE;AAClE,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,mBAAmB,GAC3B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,+EAA+E;AAC/E,MAAM,MAAM,gCAAgC,GACxC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,8EAA8E;AAC9E,MAAM,MAAM,+BAA+B,GACvC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,gFAAgF;AAChF,MAAM,MAAM,iCAAiC,GACzC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,qFAAqF;AACrF,MAAM,MAAM,sCAAsC,GAC9C,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,2EAA2E;AAC3E,MAAM,MAAM,4BAA4B,GACpC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,qBAAqB,GAC7B,iBAAiB,GACjB,oBAAoB,GACpB,cAAc,GACd,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
|
|
@@ -43,9 +43,9 @@ export class ProjectsResource {
|
|
|
43
43
|
* Create a project
|
|
44
44
|
*
|
|
45
45
|
* Stores a URL- or GitHub-sourced project. Free includes one stored project, every selected
|
|
46
|
-
*
|
|
46
|
+
* target, and the first 25 operations, while keeping manual and automatic regeneration, history,
|
|
47
47
|
* destination pull requests, and preview checks. Stateless POST /generate does not consume this
|
|
48
|
-
* slot. Pro adds projects and the
|
|
48
|
+
* slot. Pro adds projects and generates every operation in the Definition.
|
|
49
49
|
*
|
|
50
50
|
* A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
|
|
51
51
|
* `POST /projects`
|
|
@@ -64,6 +64,7 @@ export class ProjectsResource {
|
|
|
64
64
|
"402": PaymentRequiredError,
|
|
65
65
|
"403": ForbiddenError,
|
|
66
66
|
"409": ConflictError,
|
|
67
|
+
"422": UnprocessableEntityError,
|
|
67
68
|
"429": RateLimitedError,
|
|
68
69
|
"500": InternalServerError,
|
|
69
70
|
},
|
|
@@ -125,6 +126,7 @@ export class ProjectsResource {
|
|
|
125
126
|
"402": PaymentRequiredError,
|
|
126
127
|
"403": ForbiddenError,
|
|
127
128
|
"404": NotFoundError,
|
|
129
|
+
"422": UnprocessableEntityError,
|
|
128
130
|
"429": RateLimitedError,
|
|
129
131
|
},
|
|
130
132
|
schemaKey: "projects.update",
|
|
@@ -132,17 +134,89 @@ export class ProjectsResource {
|
|
|
132
134
|
});
|
|
133
135
|
}
|
|
134
136
|
/**
|
|
135
|
-
*
|
|
137
|
+
* Analyze a project's latest Definition Revision
|
|
138
|
+
*
|
|
139
|
+
* Runs deterministic OpenAPI or GraphQL authorship checks against the latest observed immutable
|
|
140
|
+
* Definition Revision after applying the Definition's existing patches. Diagnostics group every
|
|
141
|
+
* affected location under a stable rule. Exact patches are included only when Typeship can derive
|
|
142
|
+
* the change without inventing API behavior.
|
|
143
|
+
* `GET /projects/{project_id}/diagnostics`
|
|
144
|
+
*/
|
|
145
|
+
async retrieveDiagnostics(projectId, options) {
|
|
146
|
+
return this._core.request({
|
|
147
|
+
method: "GET",
|
|
148
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics`,
|
|
149
|
+
errors: {
|
|
150
|
+
"401": UnauthorizedError,
|
|
151
|
+
"403": ForbiddenError,
|
|
152
|
+
"404": NotFoundError,
|
|
153
|
+
"429": RateLimitedError,
|
|
154
|
+
},
|
|
155
|
+
idempotent: true,
|
|
156
|
+
schemaKey: "projects.retrieveDiagnostics",
|
|
157
|
+
options,
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Refresh a project's Diagnostics from its configured source
|
|
162
|
+
*
|
|
163
|
+
* Fetches the complete configured source, records a new immutable revision only when content
|
|
164
|
+
* changed, and returns its Diagnostics. This does not generate targets or consume a metered
|
|
165
|
+
* generation.
|
|
166
|
+
* `POST /projects/{project_id}/diagnostics`
|
|
167
|
+
*/
|
|
168
|
+
async refreshDiagnostics(projectId, options) {
|
|
169
|
+
return this._core.request({
|
|
170
|
+
method: "POST",
|
|
171
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics`,
|
|
172
|
+
errors: {
|
|
173
|
+
"401": UnauthorizedError,
|
|
174
|
+
"403": ForbiddenError,
|
|
175
|
+
"404": NotFoundError,
|
|
176
|
+
"422": UnprocessableEntityError,
|
|
177
|
+
"429": RateLimitedError,
|
|
178
|
+
},
|
|
179
|
+
schemaKey: "projects.refreshDiagnostics",
|
|
180
|
+
options,
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Apply exact, reviewed diagnostic remediations
|
|
185
|
+
*
|
|
186
|
+
* Applies only deterministic patches. Repository sources receive an updateable source pull
|
|
187
|
+
* request; URL sources receive project overlays. Diagnostics that require API-owner intent return
|
|
188
|
+
* 422 and include an authoring_brief in the Diagnostic instead.
|
|
189
|
+
* `POST /projects/{project_id}/diagnostics/remediations`
|
|
190
|
+
*/
|
|
191
|
+
async remediateDiagnostics(projectId, body, options) {
|
|
192
|
+
return this._core.request({
|
|
193
|
+
method: "POST",
|
|
194
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/diagnostics/remediations`,
|
|
195
|
+
body,
|
|
196
|
+
errors: {
|
|
197
|
+
"400": BadRequestError,
|
|
198
|
+
"401": UnauthorizedError,
|
|
199
|
+
"403": ForbiddenError,
|
|
200
|
+
"404": NotFoundError,
|
|
201
|
+
"422": UnprocessableEntityError,
|
|
202
|
+
"429": RateLimitedError,
|
|
203
|
+
},
|
|
204
|
+
schemaKey: "projects.remediateDiagnostics",
|
|
205
|
+
options,
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Diagnose a project's repository integrations
|
|
136
210
|
*
|
|
137
|
-
* Returns machine-actionable source and destination access,
|
|
138
|
-
* setup, required status names, and the latest durable webhook
|
|
139
|
-
* same result.
|
|
140
|
-
* `GET /projects/{project_id}/
|
|
211
|
+
* Returns provider-neutral, machine-actionable source and destination access, Definition
|
|
212
|
+
* readability, source-approval label setup, required status names, and the latest durable webhook
|
|
213
|
+
* delivery. The Console renders this same result.
|
|
214
|
+
* `GET /projects/{project_id}/integration-health`
|
|
141
215
|
*/
|
|
142
|
-
async
|
|
216
|
+
async retrieveIntegrationHealth(projectId, options) {
|
|
143
217
|
return this._core.request({
|
|
144
218
|
method: "GET",
|
|
145
|
-
path: `/projects/${encodeURIComponent(String(projectId))}/
|
|
219
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/integration-health`,
|
|
146
220
|
errors: {
|
|
147
221
|
"401": UnauthorizedError,
|
|
148
222
|
"403": ForbiddenError,
|
|
@@ -150,7 +224,7 @@ export class ProjectsResource {
|
|
|
150
224
|
"429": RateLimitedError,
|
|
151
225
|
},
|
|
152
226
|
idempotent: true,
|
|
153
|
-
schemaKey: "projects.
|
|
227
|
+
schemaKey: "projects.retrieveIntegrationHealth",
|
|
154
228
|
options,
|
|
155
229
|
});
|
|
156
230
|
}
|
|
@@ -167,7 +241,7 @@ export class ProjectsResource {
|
|
|
167
241
|
query: {
|
|
168
242
|
limit: params?.limit,
|
|
169
243
|
cursor: params?.cursor,
|
|
170
|
-
|
|
244
|
+
target_id: params?.targetId,
|
|
171
245
|
},
|
|
172
246
|
errors: {
|
|
173
247
|
"400": BadRequestError,
|
|
@@ -189,9 +263,9 @@ export class ProjectsResource {
|
|
|
189
263
|
});
|
|
190
264
|
}
|
|
191
265
|
/**
|
|
192
|
-
* Generate
|
|
266
|
+
* Generate targets and open pull requests
|
|
193
267
|
*
|
|
194
|
-
* Resolves the project's URL or
|
|
268
|
+
* Resolves the project's URL or GitHub source, generates every
|
|
195
269
|
* configured delivery package, stores each result in the project's history,
|
|
196
270
|
* and attempts to open a pull request in every configured destination.
|
|
197
271
|
* When the complete generated tree already matches a destination, no
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
|
|
2
|
+
import { PagePromise } from "../core/pagination.js";
|
|
3
|
+
import { TransportError, UnexpectedApiError, ValidationError, BadRequestError, ConflictError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
|
|
4
|
+
import type { DeletedTargetRead, ProjectId, TargetFields, TargetId, TargetRead, TargetReleaseId, TargetReleaseRead, TargetReleaseResponseRead, TargetResponseRead, TargetUpdateRequest } from "../types.js";
|
|
5
|
+
export declare class TargetsResource {
|
|
6
|
+
private readonly _core;
|
|
7
|
+
constructor(_core: HttpCore);
|
|
8
|
+
/**
|
|
9
|
+
* List a project's Targets
|
|
10
|
+
*
|
|
11
|
+
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
12
|
+
* `GET /projects/{project_id}/targets`
|
|
13
|
+
*/
|
|
14
|
+
list(projectId: ProjectId, params?: TargetsListParams, options?: RequestOptions): PagePromise<TargetRead, TargetsListError>;
|
|
15
|
+
/**
|
|
16
|
+
* Create an independently configured Target
|
|
17
|
+
*
|
|
18
|
+
* Several Targets may use the same generator with distinct configuration, Deliveries, and release
|
|
19
|
+
* streams.
|
|
20
|
+
* `POST /projects/{project_id}/targets`
|
|
21
|
+
*/
|
|
22
|
+
create(projectId: ProjectId, body: TargetFields, options?: RequestOptions): Promise<ApiResult<TargetResponseRead, TargetsCreateError>>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve a Target
|
|
25
|
+
* `GET /targets/{target_id}`
|
|
26
|
+
*/
|
|
27
|
+
retrieve(targetId: TargetId, options?: RequestOptions): Promise<ApiResult<TargetResponseRead, TargetsRetrieveError>>;
|
|
28
|
+
/**
|
|
29
|
+
* Delete an unused Target
|
|
30
|
+
*
|
|
31
|
+
* Targets with Generation or release history, or an active release candidate, must be disabled
|
|
32
|
+
* instead.
|
|
33
|
+
* `DELETE /targets/{target_id}`
|
|
34
|
+
*/
|
|
35
|
+
delete(targetId: TargetId, options?: RequestOptions): Promise<ApiResult<DeletedTargetRead, TargetsDeleteError>>;
|
|
36
|
+
/**
|
|
37
|
+
* Update a Target, its Deliveries, or its next reviewed version
|
|
38
|
+
* `PATCH /targets/{target_id}`
|
|
39
|
+
*/
|
|
40
|
+
update(targetId: TargetId, body: TargetUpdateRequest, options?: RequestOptions): Promise<ApiResult<TargetResponseRead, TargetsUpdateError>>;
|
|
41
|
+
/**
|
|
42
|
+
* List immutable releases for a Target
|
|
43
|
+
*
|
|
44
|
+
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
45
|
+
* `GET /targets/{target_id}/releases`
|
|
46
|
+
*/
|
|
47
|
+
listReleases(targetId: TargetId, params?: TargetsListReleasesParams, options?: RequestOptions): PagePromise<TargetReleaseRead, TargetsListReleasesError>;
|
|
48
|
+
/**
|
|
49
|
+
* Retrieve an immutable Target release
|
|
50
|
+
* `GET /target_releases/{target_release_id}`
|
|
51
|
+
*/
|
|
52
|
+
retrieveRelease(targetReleaseId: TargetReleaseId, options?: RequestOptions): Promise<ApiResult<TargetReleaseResponseRead, TargetsRetrieveReleaseError>>;
|
|
53
|
+
}
|
|
54
|
+
export interface TargetsListParams {
|
|
55
|
+
/** Maximum number of resources to return. */
|
|
56
|
+
limit?: number;
|
|
57
|
+
/**
|
|
58
|
+
* Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
|
|
59
|
+
* operation, filters, and ordering that issued it.
|
|
60
|
+
*/
|
|
61
|
+
cursor?: string;
|
|
62
|
+
}
|
|
63
|
+
/** Every error `list` can produce, as a discriminated union. */
|
|
64
|
+
export type TargetsListError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
65
|
+
/** Every error `create` can produce, as a discriminated union. */
|
|
66
|
+
export type TargetsCreateError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | UnprocessableEntityError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
67
|
+
/** Every error `retrieve` can produce, as a discriminated union. */
|
|
68
|
+
export type TargetsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
69
|
+
/** Every error `delete` can produce, as a discriminated union. */
|
|
70
|
+
export type TargetsDeleteError = UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
71
|
+
/** Every error `update` can produce, as a discriminated union. */
|
|
72
|
+
export type TargetsUpdateError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | ConflictError | UnprocessableEntityError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
73
|
+
export interface TargetsListReleasesParams {
|
|
74
|
+
/** Maximum number of resources to return. */
|
|
75
|
+
limit?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
|
|
78
|
+
* operation, filters, and ordering that issued it.
|
|
79
|
+
*/
|
|
80
|
+
cursor?: string;
|
|
81
|
+
}
|
|
82
|
+
/** Every error `listReleases` can produce, as a discriminated union. */
|
|
83
|
+
export type TargetsListReleasesError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
84
|
+
/** Every error `retrieveRelease` can produce, as a discriminated union. */
|
|
85
|
+
export type TargetsRetrieveReleaseError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | TransportError | ValidationError;
|
|
86
|
+
//# sourceMappingURL=targets.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"targets.d.ts","sourceRoot":"","sources":["../../src/resources/targets.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,aAAa,EACb,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAEV,iBAAiB,EACjB,SAAS,EAET,YAAY,EACZ,QAAQ,EAGR,UAAU,EAEV,eAAe,EAGf,iBAAiB,EAEjB,yBAAyB,EAEzB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;OAKG;IACH,IAAI,CACF,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,UAAU,EAAE,gBAAgB,CAAC;IA4B5C;;;;;;OAMG;IACG,MAAM,CACV,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,YAAY,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;IAmB7D;;;OAGG;IACG,QAAQ,CACZ,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAgB/D;;;;;;OAMG;IACG,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;IAiB5D;;;OAGG;IACG,MAAM,CACV,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;IAmB7D;;;;;OAKG;IACH,YAAY,CACV,QAAQ,EAAE,QAAQ,EAClB,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;IA4B3D;;;OAGG;IACG,eAAe,CACnB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,2BAA2B,CAAC,CAAC;CAe9E;AAED,MAAM,WAAW,iBAAiB;IAChC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oEAAoE;AACpE,MAAM,MAAM,oBAAoB,GAC5B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAC1B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,aAAa,GACb,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wEAAwE;AACxE,MAAM,MAAM,wBAAwB,GAChC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,2EAA2E;AAC3E,MAAM,MAAM,2BAA2B,GACnC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
// typeship — targets resource.
|
|
2
|
+
// Generated by typeship — https://typeship.dev — do not edit by hand.
|
|
3
|
+
import { paginate } from "../core/pagination.js";
|
|
4
|
+
import { BadRequestError, ConflictError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
|
|
5
|
+
export class TargetsResource {
|
|
6
|
+
_core;
|
|
7
|
+
constructor(_core) {
|
|
8
|
+
this._core = _core;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* List a project's Targets
|
|
12
|
+
*
|
|
13
|
+
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
14
|
+
* `GET /projects/{project_id}/targets`
|
|
15
|
+
*/
|
|
16
|
+
list(projectId, params, options) {
|
|
17
|
+
return paginate(this._core, {
|
|
18
|
+
method: "GET",
|
|
19
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
|
|
20
|
+
query: {
|
|
21
|
+
limit: params?.limit,
|
|
22
|
+
cursor: params?.cursor,
|
|
23
|
+
},
|
|
24
|
+
errors: {
|
|
25
|
+
"400": BadRequestError,
|
|
26
|
+
"401": UnauthorizedError,
|
|
27
|
+
"403": ForbiddenError,
|
|
28
|
+
"404": NotFoundError,
|
|
29
|
+
"429": RateLimitedError,
|
|
30
|
+
},
|
|
31
|
+
idempotent: true,
|
|
32
|
+
schemaKey: "targets.list",
|
|
33
|
+
options,
|
|
34
|
+
}, {
|
|
35
|
+
style: "cursor",
|
|
36
|
+
itemsField: "data",
|
|
37
|
+
cursorParam: "cursor",
|
|
38
|
+
nextCursorField: "next_cursor",
|
|
39
|
+
hasMoreField: "has_more",
|
|
40
|
+
limitParam: "limit",
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Create an independently configured Target
|
|
45
|
+
*
|
|
46
|
+
* Several Targets may use the same generator with distinct configuration, Deliveries, and release
|
|
47
|
+
* streams.
|
|
48
|
+
* `POST /projects/{project_id}/targets`
|
|
49
|
+
*/
|
|
50
|
+
async create(projectId, body, options) {
|
|
51
|
+
return this._core.request({
|
|
52
|
+
method: "POST",
|
|
53
|
+
path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
|
|
54
|
+
body,
|
|
55
|
+
errors: {
|
|
56
|
+
"400": BadRequestError,
|
|
57
|
+
"401": UnauthorizedError,
|
|
58
|
+
"403": ForbiddenError,
|
|
59
|
+
"404": NotFoundError,
|
|
60
|
+
"409": ConflictError,
|
|
61
|
+
"422": UnprocessableEntityError,
|
|
62
|
+
"429": RateLimitedError,
|
|
63
|
+
},
|
|
64
|
+
schemaKey: "targets.create",
|
|
65
|
+
options,
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Retrieve a Target
|
|
70
|
+
* `GET /targets/{target_id}`
|
|
71
|
+
*/
|
|
72
|
+
async retrieve(targetId, options) {
|
|
73
|
+
return this._core.request({
|
|
74
|
+
method: "GET",
|
|
75
|
+
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
76
|
+
errors: {
|
|
77
|
+
"401": UnauthorizedError,
|
|
78
|
+
"403": ForbiddenError,
|
|
79
|
+
"404": NotFoundError,
|
|
80
|
+
"429": RateLimitedError,
|
|
81
|
+
},
|
|
82
|
+
idempotent: true,
|
|
83
|
+
schemaKey: "targets.retrieve",
|
|
84
|
+
options,
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Delete an unused Target
|
|
89
|
+
*
|
|
90
|
+
* Targets with Generation or release history, or an active release candidate, must be disabled
|
|
91
|
+
* instead.
|
|
92
|
+
* `DELETE /targets/{target_id}`
|
|
93
|
+
*/
|
|
94
|
+
async delete(targetId, options) {
|
|
95
|
+
return this._core.request({
|
|
96
|
+
method: "DELETE",
|
|
97
|
+
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
98
|
+
errors: {
|
|
99
|
+
"401": UnauthorizedError,
|
|
100
|
+
"403": ForbiddenError,
|
|
101
|
+
"404": NotFoundError,
|
|
102
|
+
"409": ConflictError,
|
|
103
|
+
"429": RateLimitedError,
|
|
104
|
+
},
|
|
105
|
+
idempotent: true,
|
|
106
|
+
schemaKey: "targets.delete",
|
|
107
|
+
options,
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Update a Target, its Deliveries, or its next reviewed version
|
|
112
|
+
* `PATCH /targets/{target_id}`
|
|
113
|
+
*/
|
|
114
|
+
async update(targetId, body, options) {
|
|
115
|
+
return this._core.request({
|
|
116
|
+
method: "PATCH",
|
|
117
|
+
path: `/targets/${encodeURIComponent(String(targetId))}`,
|
|
118
|
+
body,
|
|
119
|
+
errors: {
|
|
120
|
+
"400": BadRequestError,
|
|
121
|
+
"401": UnauthorizedError,
|
|
122
|
+
"403": ForbiddenError,
|
|
123
|
+
"404": NotFoundError,
|
|
124
|
+
"409": ConflictError,
|
|
125
|
+
"422": UnprocessableEntityError,
|
|
126
|
+
"429": RateLimitedError,
|
|
127
|
+
},
|
|
128
|
+
schemaKey: "targets.update",
|
|
129
|
+
options,
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* List immutable releases for a Target
|
|
134
|
+
*
|
|
135
|
+
* Auto-paginates: `for await (const item of …)` walks every page.
|
|
136
|
+
* `GET /targets/{target_id}/releases`
|
|
137
|
+
*/
|
|
138
|
+
listReleases(targetId, params, options) {
|
|
139
|
+
return paginate(this._core, {
|
|
140
|
+
method: "GET",
|
|
141
|
+
path: `/targets/${encodeURIComponent(String(targetId))}/releases`,
|
|
142
|
+
query: {
|
|
143
|
+
limit: params?.limit,
|
|
144
|
+
cursor: params?.cursor,
|
|
145
|
+
},
|
|
146
|
+
errors: {
|
|
147
|
+
"400": BadRequestError,
|
|
148
|
+
"401": UnauthorizedError,
|
|
149
|
+
"403": ForbiddenError,
|
|
150
|
+
"404": NotFoundError,
|
|
151
|
+
"429": RateLimitedError,
|
|
152
|
+
},
|
|
153
|
+
idempotent: true,
|
|
154
|
+
schemaKey: "targets.listReleases",
|
|
155
|
+
options,
|
|
156
|
+
}, {
|
|
157
|
+
style: "cursor",
|
|
158
|
+
itemsField: "data",
|
|
159
|
+
cursorParam: "cursor",
|
|
160
|
+
nextCursorField: "next_cursor",
|
|
161
|
+
hasMoreField: "has_more",
|
|
162
|
+
limitParam: "limit",
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Retrieve an immutable Target release
|
|
167
|
+
* `GET /target_releases/{target_release_id}`
|
|
168
|
+
*/
|
|
169
|
+
async retrieveRelease(targetReleaseId, options) {
|
|
170
|
+
return this._core.request({
|
|
171
|
+
method: "GET",
|
|
172
|
+
path: `/target_releases/${encodeURIComponent(String(targetReleaseId))}`,
|
|
173
|
+
errors: {
|
|
174
|
+
"401": UnauthorizedError,
|
|
175
|
+
"403": ForbiddenError,
|
|
176
|
+
"404": NotFoundError,
|
|
177
|
+
"429": RateLimitedError,
|
|
178
|
+
},
|
|
179
|
+
idempotent: true,
|
|
180
|
+
schemaKey: "targets.retrieveRelease",
|
|
181
|
+
options,
|
|
182
|
+
});
|
|
183
|
+
}
|
|
184
|
+
}
|
package/dist/schemas.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;IAAE,GAAG,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,CA+BpE,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CA0GxC,CAAC"}
|