@typeship-ax/cli 0.6.0 → 0.9.1

package/src/resources/targets.ts

@@ -0,0 +1,378 @@
+// typeship — targets resource.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+
+import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadRequestError,
+  ConflictError,
+  ForbiddenError,
+  NotFoundError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type {
+  DeletedTarget,
+  DeletedTargetRead,
+  ProjectId,
+  Target,
+  TargetFields,
+  TargetId,
+  TargetList,
+  TargetListRead,
+  TargetRead,
+  TargetRelease,
+  TargetReleaseId,
+  TargetReleaseList,
+  TargetReleaseListRead,
+  TargetReleaseRead,
+  TargetReleaseResponse,
+  TargetReleaseResponseRead,
+  TargetResponse,
+  TargetResponseRead,
+  TargetUpdateRequest,
+} from "../types.js";
+
+export class TargetsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * List a project's Targets
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /projects/{project_id}/targets`
+   */
+  list(
+    projectId: ProjectId,
+    params?: TargetsListParams,
+    options?: RequestOptions,
+  ): PagePromise<TargetRead, TargetsListError> {
+    return paginate<TargetRead, TargetsListError>(this._core, {
+      method: "GET",
+      path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "targets.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Create an independently configured Target
+   *
+   * Several Targets may use the same generator with distinct configuration, Deliveries, and release
+   * streams.
+   *
+   * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
+   * `POST /projects/{project_id}/targets`
+   */
+  async create(
+    projectId: ProjectId,
+    body: TargetFields,
+    params?: TargetsCreateParams,
+    options?: RequestOptions,
+  ): Promise<ApiResult<TargetResponseRead, TargetsCreateError>> {
+    return this._core.request<TargetResponseRead, TargetsCreateError>({
+      method: "POST",
+      path: `/projects/${encodeURIComponent(String(projectId))}/targets`,
+      security: [{"apiKey":[]}],
+      headers: {
+        "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
+      },
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+      },
+      idempotencyKey: "Idempotency-Key",
+      schemaKey: "targets.create",
+      options,
+    });
+  }
+
+  /**
+   * Retrieve a Target
+   * `GET /targets/{target_id}`
+   */
+  async retrieve(
+    targetId: TargetId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<TargetResponseRead, TargetsRetrieveError>> {
+    return this._core.request<TargetResponseRead, TargetsRetrieveError>({
+      method: "GET",
+      path: `/targets/${encodeURIComponent(String(targetId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "targets.retrieve",
+      options,
+    });
+  }
+
+  /**
+   * Delete an unused Target
+   *
+   * Targets with Generation or release history, or an active release candidate, must be disabled
+   * instead.
+   * `DELETE /targets/{target_id}`
+   */
+  async delete(
+    targetId: TargetId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<DeletedTargetRead, TargetsDeleteError>> {
+    return this._core.request<DeletedTargetRead, TargetsDeleteError>({
+      method: "DELETE",
+      path: `/targets/${encodeURIComponent(String(targetId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "targets.delete",
+      options,
+    });
+  }
+
+  /**
+   * Update a Target, its Deliveries, or its next reviewed version
+   * `PATCH /targets/{target_id}`
+   */
+  async update(
+    targetId: TargetId,
+    body: TargetUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<ApiResult<TargetResponseRead, TargetsUpdateError>> {
+    return this._core.request<TargetResponseRead, TargetsUpdateError>({
+      method: "PATCH",
+      path: `/targets/${encodeURIComponent(String(targetId))}`,
+      security: [{"apiKey":[]}],
+      body,
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "409": ConflictError,
+        "422": UnprocessableEntityError,
+        "429": RateLimitedError,
+      },
+      schemaKey: "targets.update",
+      options,
+    });
+  }
+
+  /**
+   * List immutable releases for a Target
+   *
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /targets/{target_id}/releases`
+   */
+  listReleases(
+    targetId: TargetId,
+    params?: TargetsListReleasesParams,
+    options?: RequestOptions,
+  ): PagePromise<TargetReleaseRead, TargetsListReleasesError> {
+    return paginate<TargetReleaseRead, TargetsListReleasesError>(this._core, {
+      method: "GET",
+      path: `/targets/${encodeURIComponent(String(targetId))}/releases`,
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "targets.listReleases",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * Retrieve an immutable Target release
+   * `GET /target_releases/{target_release_id}`
+   */
+  async retrieveRelease(
+    targetReleaseId: TargetReleaseId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<TargetReleaseResponseRead, TargetsRetrieveReleaseError>> {
+    return this._core.request<TargetReleaseResponseRead, TargetsRetrieveReleaseError>({
+      method: "GET",
+      path: `/target_releases/${encodeURIComponent(String(targetReleaseId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+      },
+      idempotent: true,
+      schemaKey: "targets.retrieveRelease",
+      options,
+    });
+  }
+}
+
+export interface TargetsListParams {
+  /** Maximum number of resources to return. */
+  limit?: number;
+  /**
+   * Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
+   * operation, filters, and ordering that issued it.
+   */
+  cursor?: string;
+}
+
+/** Every error `list` can produce, as a discriminated union. */
+export type TargetsListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface TargetsCreateParams {
+  /**
+   * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
+   * operation; account-less generation uses a hashed network identity. Retrying the same method,
+   * path, query, and JSON body replays the original response. Reusing the key with changed intent
+   * returns 409. After expiry the key starts a new write.
+   */
+  idempotencyKey?: string;
+}
+
+/** Every error `create` can produce, as a discriminated union. */
+export type TargetsCreateError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieve` can produce, as a discriminated union. */
+export type TargetsRetrieveError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `delete` can produce, as a discriminated union. */
+export type TargetsDeleteError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `update` can produce, as a discriminated union. */
+export type TargetsUpdateError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface TargetsListReleasesParams {
+  /** Maximum number of resources to return. */
+  limit?: number;
+  /**
+   * Opaque cursor from the preceding page's next_cursor. Valid only for the same account,
+   * operation, filters, and ordering that issued it.
+   */
+  cursor?: string;
+}
+
+/** Every error `listReleases` can produce, as a discriminated union. */
+export type TargetsListReleasesError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieveRelease` can produce, as a discriminated union. */
+export type TargetsRetrieveReleaseError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;