@greensecurity/javascript-sdk 0.46.0 → 0.47.0-beta.1

package/src/apps/surfaces.ts

@@ -2,6 +2,7 @@
  * Hand-written (not generated by Speakeasy). Part of the third-party app platform contract;
  * see docs/third-party-apps/plan.md. Host (web-mobile-client) and SDK both import from here.
  */
+import { isConcreteRoutePath } from "./routes.js";
 
 export type Portal = "vendor" | "company" | "facility" | "system";
 
@@ -13,7 +14,9 @@ export type SurfaceKind =
   | "list.row_action"
   | "detail"
   | "detail.tabs"
-  | "settings";
+  | "settings"
+  /** An app page: one of the app's own `ui_extensions.routes`, rendered full screen. */
+  | "page";
 
 /**
  * The kind of record a surface is showing. These match the public API resource each one is
@@ -22,15 +25,7 @@ export type SurfaceKind =
  * and have no public read endpoint yet.
  */
 export type ObjectType =
-  | "vendor"
-  | "vendor_credential"
-  | "facility"
-  | "company"
-  | "vendor_scan"
-  | "invoice"
-  | "event"
-  | "visitor"
-  | "contact";
+  "vendor" | "vendor_credential" | "facility" | "company" | "vendor_scan" | "invoice" | "event" | "visitor" | "contact";
 
 export interface SurfaceDef {
   readonly id: string;
@@ -53,6 +48,29 @@ export interface SurfaceDef {
   readonly wave: 1 | 2;
 }
 
+/**
+ * Host URL segment reserved for app pages: `/{portal}/apps/{appId}/pages{path}`. No host route may
+ * be defined under it except the screens that render app pages, so an app path can never shadow a
+ * host page. It is not reserved inside an app's own space: `/pages/foo` is an ordinary app path.
+ */
+export const APP_PAGES_SEGMENT = "pages";
+
+/**
+ * The host pathname of an app page: `/{portal}/apps/{appId}/pages{path}`, with the root path `/`
+ * at `/{portal}/apps/{appId}/pages`. Throws unless `appId` is a positive integer and `path` is a
+ * concrete route path (`isConcreteRoutePath`), so no input can resolve outside the app's own pages
+ * (`/../settings`, `//evil.example`).
+ */
+export function appPagePathname(portal: Portal, appId: number, path: string): string {
+  if (!Number.isSafeInteger(appId) || appId <= 0) {
+    throw new RangeError(`appPagePathname: app id must be a positive integer, got ${String(appId)}`);
+  }
+  if (!isConcreteRoutePath(path)) {
+    throw new RangeError(`appPagePathname: not a concrete route path: ${JSON.stringify(path)}`);
+  }
+  return `/${portal}/apps/${appId}/${APP_PAGES_SEGMENT}${path === "/" ? "" : path}`;
+}
+
 type Entry = [id: string, kind: SurfaceKind, objectType: ObjectType | null, route: string, idParam: string | null];
 
 /** Expands a list surface into the surface itself and its row-action surface. */
@@ -74,8 +92,8 @@ function portalShell(portal: Portal): Entry[] {
 const COMPANY: Entry[] = [
   ...portalShell("company"),
   ...list("company", "vendor", "vendor", "/company/vendors"),
-  ["gs.company.vendor.detail", "detail", "vendor", "/company/vendordetails", "vendorId"],
-  ["gs.company.vendor.detail.tabs", "detail.tabs", "vendor", "/company/vendordetails", "vendorId"],
+  ["gs.company.vendor.detail", "detail", "vendor", "/company/vendors/[vendorId]", "vendorId"],
+  ["gs.company.vendor.detail.tabs", "detail.tabs", "vendor", "/company/vendors/[vendorId]", "vendorId"],
   ...list("company", "vendor_credential", "vendor_credential", "/company/credentials"),
   ["gs.company.vendor_credential.detail", "detail", "vendor_credential", "/company/credentials/[id]", "id"],
   ...list("company", "facility", "facility", "/company/facilities"),
@@ -118,7 +136,15 @@ function staffPortal(portal: "facility" | "system"): Entry[] {
 }
 
 function define(portal: Portal | null, wave: 1 | 2, entries: Entry[]): SurfaceDef[] {
-  return entries.map(([id, kind, objectType, route, idParam]) => ({ id, portal, kind, objectType, route, idParam, wave }));
+  return entries.map(([id, kind, objectType, route, idParam]) => ({
+    id,
+    portal,
+    kind,
+    objectType,
+    route,
+    idParam,
+    wave,
+  }));
 }
 
 export const SURFACES: readonly SurfaceDef[] = Object.freeze([
@@ -128,6 +154,10 @@ export const SURFACES: readonly SurfaceDef[] = Object.freeze([
   ...define("system", 2, staffPortal("system")),
   // The app's own settings page. Every portal has one, so the route names the portal as a segment.
   ...define(null, 1, [["settings", "settings", null, "/[portal]/apps/[appId]/settings", "appId"]]),
+  // Every app page (`ui_extensions.routes`), under the one prefix reserved for apps. Like
+  // `settings` it has no portal of its own, and it is not a view viewport or a `surface` target:
+  // apps declare pages as routes and reach them with `{ type: "appPage" }`.
+  ...define(null, 1, [["page", "page", null, `/[portal]/apps/[appId]/${APP_PAGES_SEGMENT}/[...path]`, "appId"]]),
 ]);
 
 /**
@@ -152,7 +182,10 @@ export function drawerDefaultFor(portal: Portal): SurfaceId {
   return `gs.${portal}.drawer.default`;
 }
 
-/** Surfaces the host renders for a portal in the given wave (and earlier waves). */
+/**
+ * Surfaces the host renders for a portal in the given wave (and earlier waves). Portal-less
+ * surfaces (`settings`, `page`) are never included: they belong to an app, not to a portal screen.
+ */
 export function surfacesForPortal(portal: Portal, wave: 1 | 2 = 1): SurfaceDef[] {
   return SURFACES.filter((s) => s.portal === portal && s.wave <= wave);
 }

package/src/apps/testing/index.ts

@@ -13,15 +13,24 @@
  * await view.find("Button")!.trigger("onPress");
  * expect(view.find("FocusView")!.props["shown"]).toBe(true);
  * ```
+ *
+ * An app page gets its route through the context:
+ *
+ * ```ts
+ * const page = await renderForTest(<ReportDetail />, {
+ *   context: { environment: { route: mockPageRoute("/reports/:id", "/reports/7") } },
+ * });
+ * ```
  */
 
 import { polyfillInstalled } from "../runtime/polyfill.js";
 import { RemoteReceiver, type RemoteReceiverElement, type RemoteReceiverNode, type RemoteReceiverRoot } from "@remote-dom/core/receivers";
 import type { ReactElement } from "react";
 import { COMPONENTS, type ComponentName, type ComponentSpec } from "../components.js";
-import { PROTOCOL_VERSION, type AppTokens, type ExtensionContext } from "../context.js";
+import { PROTOCOL_VERSION, type AppTokens, type ExtensionContext, type PageRoute } from "../context.js";
 import type { HostApi, RemoteConnection, RemoteMutationRecord } from "../protocol.js";
 import { REMOTE_FRAGMENT_TAG } from "../runtime/elements.js";
+import { matchAppRoute } from "../routes.js";
 import { createSandboxExports, type SandboxRuntime } from "../runtime/sandbox.js";
 
 // Remote-dom node type constants (`NODE_TYPE_ELEMENT`, `NODE_TYPE_TEXT`).
@@ -54,8 +63,14 @@ export function mockTokens(now: number = Date.now()): AppTokens {
  * platform permissions such as `app_secrets.write` out of `auth.user.scope`: the server grants
  * them to the app's role only, so a real user token never carries them. The mock performs no
  * permission checks; stub the Secret Store's 403 yourself to test a missing grant.
+ *
+ * `environment.navParams` (what this app's own `navigate` passed as `envParams`) and
+ * `environment.queryParams` (an app page's URL query) both default to `{}`; set either to test a
+ * view opened by a navigation or from a link. Setting `environment.route` puts the view on an app
+ * page (see {@link mockPageRoute}).
  */
 export function getMockContext(overrides: DeepPartial<ExtensionContext> = {}): ExtensionContext {
+  const route = overrides.environment?.route;
   const base: ExtensionContext = {
     protocolVersion: PROTOCOL_VERSION,
     app: { id: 1, version: "1.0.0", permissions: [], csp: { connectSrc: [], imageSrc: [] } },
@@ -65,12 +80,43 @@ export function getMockContext(overrides: DeepPartial<ExtensionContext> = {}): E
       portal: "company",
       platform: "web",
       queryParams: {},
+      navParams: {},
       constants: {},
       apiBaseUrl: "https://api.example.test/api",
     },
     auth: mockTokens(),
   };
-  return deepMerge(base, overrides) as ExtensionContext;
+  // An app page is rendered on the `page` surface; an explicit `surfaceId` still wins.
+  if (route !== undefined) base.environment.surfaceId = "page";
+  const merged = deepMerge(base, overrides) as ExtensionContext;
+  if (route !== undefined) merged.environment.route = completeRoute(route);
+  return merged;
+}
+
+/**
+ * The `environment.route` the host sends for `pathname` on the declared route `path`, with its
+ * params decoded the way the host does it (`matchAppRoute`). `pathname` defaults to `path`, so a
+ * route without params needs only one argument. Throws when `pathname` does not match `path`:
+ * the host would never render that page.
+ *
+ * ```ts
+ * mockPageRoute("/reports/:id", "/reports/7"); // { path: "/reports/:id", pathname: "/reports/7", params: { id: "7" } }
+ * ```
+ */
+export function mockPageRoute(path: string, pathname: string = path): PageRoute {
+  const match = matchAppRoute([{ path }], pathname);
+  if (!match) throw new Error(`${pathname} does not match the route ${path}`);
+  return { path, pathname, params: match.params };
+}
+
+/** Fills a partial `environment.route` override: a missing pathname is the path, missing params are `{}`. */
+function completeRoute(route: DeepPartial<PageRoute>): PageRoute {
+  const path = route.path ?? route.pathname ?? "/";
+  const params: Record<string, string> = {};
+  for (const [name, value] of Object.entries(route.params ?? {})) {
+    if (typeof value === "string") params[name] = value;
+  }
+  return { path, pathname: route.pathname ?? path, params };
 }
 
 function isPlainObject(value: unknown): value is Record<string, unknown> {

package/src/apps/ui/index.ts

@@ -13,9 +13,16 @@ import { createUiComponent, type UiProps } from "./factory.js";
 
 export type { UiProps } from "./factory.js";
 
-// View roots. A view component renders exactly one ContextView or SettingsView at its top.
+// View roots. A view component renders exactly one of these at its top: ContextView on a surface,
+// SettingsView on the settings page, PageView on an app page.
 export const ContextView = /* @__PURE__ */ createUiComponent("ContextView");
 export const SettingsView = /* @__PURE__ */ createUiComponent("SettingsView");
+/**
+ * An app page (`ui_extensions.routes`), full width inside the portal's own chrome. `title` is the
+ * page header; the `actions` slot joins the header's actions and `banner` sits above the body.
+ * Read the route's params with `usePageRoute()` from `apps/hooks`.
+ */
+export const PageView = /* @__PURE__ */ createUiComponent("PageView");
 
 const FocusViewElement = /* @__PURE__ */ createUiComponent("FocusView");
 
@@ -108,3 +115,13 @@ export const Radio = /* @__PURE__ */ createUiComponent("Radio");
 export const Switch = /* @__PURE__ */ createUiComponent("Switch");
 export const DateField = /* @__PURE__ */ createUiComponent("DateField");
 export const FormFieldGroup = /* @__PURE__ */ createUiComponent("FormFieldGroup");
+
+// Charts. Data only: pick a palette with `theme`; `onClick` receives a `ChartClickEvent`
+// (`index`, `label`, `value` and, on multi-series charts, `series`).
+export const BarChart = /* @__PURE__ */ createUiComponent("BarChart");
+export const HorizontalBarChart = /* @__PURE__ */ createUiComponent("HorizontalBarChart");
+export const StackedBarChart = /* @__PURE__ */ createUiComponent("StackedBarChart");
+export const LineChart = /* @__PURE__ */ createUiComponent("LineChart");
+export const AreaChart = /* @__PURE__ */ createUiComponent("AreaChart");
+export const ComboChart = /* @__PURE__ */ createUiComponent("ComboChart");
+export const PieChart = /* @__PURE__ */ createUiComponent("PieChart");

package/src/funcs/appsAddAppDeveloper.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Add an app developer
+ *
+ * @remarks
+ * Makes a user an `owner` or `developer` of the app. Adding a user who is already on the
+ * list changes their role; demoting the app's last owner is refused with `409`, and so is
+ * adding a `developer` to an app that has no owner yet. Otherwise the response is `200`
+ * with the developer.
+ *
+ * The user must already be covered by an installation of the app. An app has at most 100
+ * developers: adding one more is refused with `422`, as is a request that does not send
+ * exactly one of `user_id` and `email`.
+ *
+ * **Permissions.** Accepts the app service account's permanent token, or a developer CLI
+ * token (`gsd_`) of an `owner` of the app, as `Authorization: Bearer`. Anyone else is told
+ * the app does not exist (`404`).
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function appsAddAppDeveloper(
+  client: GreenSecurityCore,
+  request: operations.AddAppDeveloperRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AppDeveloper,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.AddAppDeveloperRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AppDeveloper,
+      | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.AddAppDeveloperRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.AppDeveloperAdd, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/marketplace/apps/{id}/developers")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "addAppDeveloper",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.AppDeveloper,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.AppDeveloper$inboundSchema),
+    M.jsonErr([400, 401, 404, 409], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableEntityOrValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/appsCloseAppDevSession.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Close a dev session
+ *
+ * @remarks
+ * Closes a dev session, which is what `apps-cli dev` does on exit. The Green Security app
+ * goes back to the published bundle once the session has ended. Closing a session that
+ * is already closed or expired succeeds too.
+ *
+ * **Permissions.** Requires the developer CLI token (`gsd_`) of the developer who started
+ * the session, as `Authorization: Bearer`. Another developer's session is reported as not
+ * found.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function appsCloseAppDevSession(
+  client: GreenSecurityCore,
+  request: operations.CloseAppDevSessionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DeleteApiResponse,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.CloseAppDevSessionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DeleteApiResponse,
+      | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.CloseAppDevSessionRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    app_id: encodeSimple("app_id", payload.app_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/apps/{app_id}/dev-sessions/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "closeAppDevSession",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.DeleteApiResponse,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DeleteApiResponse$inboundSchema),
+    M.jsonErr([401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableEntityOrValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}