@greensecurity/javascript-sdk 0.46.0-beta.9 → 0.46.0

package/src/funcs/appsCreateAppDevSession.ts

@@ -1,206 +0,0 @@
-/*
- * 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";
-
-/**
- * Start a dev session
- *
- * @remarks
- * Registers a dev session, which is what `gs-apps dev` does on start. While the session is
- * active, the Green Security app loads your views from the CLI's dev server at `origin`
- * instead of the published bundle, for you only: other users of the same tenant keep
- * seeing the published version. Every build the dev server announces must be signed with
- * the private half of `public_key_jwk`.
- *
- * Starting a session closes any earlier session of yours for the same app. A session lasts
- * 12 hours and counts as inactive after 2 minutes without a heartbeat, so call
- * `POST /apps/{app_id}/dev-sessions/{id}/heartbeat` every 30 seconds.
- *
- * A `422` means a field failed validation: `origin`, `server_token`, `public_key_jwk` or
- * `manifest` is malformed, `manifest` changes a field a dev session may not (see
- * `AppDevManifest`), or several installations cover you and `activation_id` was left out.
- *
- * The response never includes `server_token`: you generated it, so keep your own copy.
- *
- * Dev sessions are available on staging, and in production only for apps an administrator
- * has enabled dev preview for; otherwise this endpoint answers `403`.
- *
- * **Permissions.** Requires a developer CLI token (`gsd_`, from `gs-apps login`) of an
- * `owner` or `developer` of the app, as `Authorization: Bearer`. Any other token, including
- * your own session token and the app's service account token, is refused with `403`. An app
- * you are not a developer of is reported as not found.
- *
- * If set, this operation will use {@link Security.bearerJwt} from the global security.
- */
-export function appsCreateAppDevSession(
-  client: GreenSecurityCore,
-  request: operations.CreateAppDevSessionRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.DevSession,
-    | errors.ApiErrorResponse
-    | errors.CreateAppDevSessionResponseBody
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: GreenSecurityCore,
-  request: operations.CreateAppDevSessionRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.DevSession,
-      | errors.ApiErrorResponse
-      | errors.CreateAppDevSessionResponseBody
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.CreateAppDevSessionRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = encodeJSON("body", payload.DevSessionCreate, { explode: true });
-
-  const pathParams = {
-    app_id: encodeSimple("app_id", payload.app_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-  const path = pathToFunc("/apps/{app_id}/dev-sessions")(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: "createAppDevSession",
-    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.DevSession,
-    | errors.ApiErrorResponse
-    | errors.CreateAppDevSessionResponseBody
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(201, components.DevSession$inboundSchema),
-    M.jsonErr([400, 401, 403, 404, 409], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(422, errors.CreateAppDevSessionResponseBody$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/appsDeleteAppSecret.ts

@@ -1,210 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { GreenSecurityCore } from "../core.js";
-import { encodeJSON } 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 { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Delete an app secret
- *
- * @remarks
- * Deletes the secret with `name` in the given scope, and returns it with `deleted: true`.
- *
- * **Permissions.** Send one of these as `Authorization: Bearer`; any other token is refused
- * with `403`.
- *
- * - **An app token**: an app user token (`gsu_`) or an app installation token (`gsi_`). The
- *   activation comes from the token, so leave `activation_id` out; if you send it, it must be
- *   the token's own activation (`403` otherwise). Either token may delete from the `installation`
- *   scope. For the `user` scope:
- *   - an app user token reaches only its own user (`user_id` may be left out);
- *   - an installation token the host minted for one of your views reaches only that view's
- *     viewer (`user_id` may be left out);
- *   - an installation token from `client_credentials` reaches any user its activation
- *     covers, and `user_id` is required.
- * - **Your app's service account**: its permanent token, or a short-lived OAuth access token
- *   issued to it without `scope` (by `client_credentials` without `activation_id`, or by the
- *   `refresh_token` grant). A token issued with `scope` is refused with `403`, and any other
- *   kind of token, such as a one-time sign-in link token, with `403` "This kind of token may
- *   not access app secrets". It has no activation of its own, so `activation_id` is required
- *   (`422` without it) and must be one of your app's activations (`403` otherwise). Its `user`
- *   scope reaches any user the activation covers, and `user_id` is required.
- *
- * A `user_id` that does not exist and one the token may not reach get the same `403` "This
- * credential may not access secrets of that user", so the endpoint never reveals which user
- * ids exist.
- *
- * Whatever the token, your app must hold the platform permission `app_secrets.write`: list
- * it in the manifest's `permissions` and upload. Until then every Secret Store call is
- * refused with `403` "This app has not been granted app_secrets.write." For the service
- * account this is checked before `activation_id` is looked at, so an app without the
- * permission gets that answer whether or not it sent an `activation_id`.
- *
- * Every response carries `Cache-Control: no-store`, errors included, so no cache keeps a
- * secret.
- *
- * If set, this operation will use {@link Security.bearerJwt} from the global security.
- */
-export function appsDeleteAppSecret(
-  client: GreenSecurityCore,
-  request: components.AppSecretDeleteRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.AppSecretDeleted,
-    | errors.ApiErrorResponse
-    | errors.AppSecretsUnprocessable
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: GreenSecurityCore,
-  request: components.AppSecretDeleteRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.AppSecretDeleted,
-      | errors.ApiErrorResponse
-      | errors.AppSecretsUnprocessable
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => components.AppSecretDeleteRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = encodeJSON("body", payload, { explode: true });
-
-  const path = pathToFunc("/apps/secrets/delete")();
-
-  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: "deleteAppSecret",
-    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.AppSecretDeleted,
-    | errors.ApiErrorResponse
-    | errors.AppSecretsUnprocessable
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.AppSecretDeleted$inboundSchema),
-    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(422, errors.AppSecretsUnprocessable$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
-    M.fail("4XX"),
-    M.fail("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/appsFindAppSecret.ts

@@ -1,230 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { GreenSecurityCore } from "../core.js";
-import {
-  encodeDeepObjectQuery,
-  encodeFormQuery,
-  queryJoin,
-} 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";
-
-/**
- * Find an app secret
- *
- * @remarks
- * Returns the secret with `name` in the given scope. The payload is only included when you
- * ask for it with `expand=payload`, so a lookup that only needs to know the secret exists
- * never moves the value. An expired secret is reported as not found.
- *
- * **Permissions.** Send one of these as `Authorization: Bearer`; any other token is refused
- * with `403`.
- *
- * - **An app token**: an app user token (`gsu_`) or an app installation token (`gsi_`). The
- *   activation comes from the token, so leave `activation_id` out; if you send it, it must be
- *   the token's own activation (`403` otherwise). Either token may read the `installation`
- *   scope. For the `user` scope:
- *   - an app user token reaches only its own user (`user_id` may be left out);
- *   - an installation token the host minted for one of your views reaches only that view's
- *     viewer (`user_id` may be left out);
- *   - an installation token from `client_credentials` reaches any user its activation
- *     covers, and `user_id` is required.
- * - **Your app's service account**: its permanent token, or a short-lived OAuth access token
- *   issued to it without `scope` (by `client_credentials` without `activation_id`, or by the
- *   `refresh_token` grant). A token issued with `scope` is refused with `403`, and any other
- *   kind of token, such as a one-time sign-in link token, with `403` "This kind of token may
- *   not access app secrets". It has no activation of its own, so `activation_id` is required
- *   (`422` without it) and must be one of your app's activations (`403` otherwise). Its `user`
- *   scope reaches any user the activation covers, and `user_id` is required.
- *
- * A `user_id` that does not exist and one the token may not reach get the same `403` "This
- * credential may not access secrets of that user", so the endpoint never reveals which user
- * ids exist.
- *
- * Whatever the token, your app must hold the platform permission `app_secrets.write`: list
- * it in the manifest's `permissions` and upload. Until then every Secret Store call is
- * refused with `403` "This app has not been granted app_secrets.write." For the service
- * account this is checked before `activation_id` is looked at, so an app without the
- * permission gets that answer whether or not it sent an `activation_id`.
- *
- * Every response carries `Cache-Control: no-store`, errors included, so no cache keeps a
- * secret.
- *
- * If set, this operation will use {@link Security.bearerJwt} from the global security.
- */
-export function appsFindAppSecret(
-  client: GreenSecurityCore,
-  request: operations.FindAppSecretRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.AppSecret,
-    | errors.ApiErrorResponse
-    | errors.AppSecretsUnprocessable
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: GreenSecurityCore,
-  request: operations.FindAppSecretRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.AppSecret,
-      | errors.ApiErrorResponse
-      | errors.AppSecretsUnprocessable
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => operations.FindAppSecretRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const path = pathToFunc("/apps/secrets/find")();
-
-  const query = queryJoin(
-    encodeDeepObjectQuery({
-      "scope": payload.scope,
-    }),
-    encodeFormQuery({
-      "expand": payload.expand,
-    }, { explode: false }),
-    encodeFormQuery({
-      "activation_id": payload.activation_id,
-      "name": payload.name,
-    }),
-  );
-
-  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: "findAppSecret",
-    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: "GET",
-    baseURL: options?.serverURL,
-    path: path,
-    headers: headers,
-    query: query,
-    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.AppSecret,
-    | errors.ApiErrorResponse
-    | errors.AppSecretsUnprocessable
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.AppSecret$inboundSchema),
-    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(422, errors.AppSecretsUnprocessable$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
-    M.fail("4XX"),
-    M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
-  }
-
-  return [result, { status: "complete", request: req, response }];
-}