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

package/src/funcs/appsListAppVersions.ts

@@ -0,0 +1,204 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * List app versions with installation counts
+ *
+ * @remarks
+ * Lists every uploaded version of the app, with the review status of each and the number of
+ * installations that run it. `apps-cli status` shows the same information.
+ *
+ * The response is an object keyed by version string, in the order the versions were first
+ * uploaded. Every version is listed, including versions that are in review or
+ * rejected, which no installation runs. An app that hasn't been uploaded since review began has
+ * no versions yet, and the response is `{}`.
+ *
+ * A version that's uploaded more than once has one key. Its `status` is the status of the
+ * latest upload, and its counts cover every installation that runs an accepted upload of that
+ * version. A manifest without a `version` is listed under the key `""`.
+ *
+ * Each installation counts under the version it runs, which is the version its administrators
+ * last approved (see [Existing installations keep their version](/apps/security-and-review#existing-installations-keep-their-version)).
+ * **Site-wide installations aren't counted.** An installation for a whole site covers every
+ * user, company, facility, and health system in it, so the counts leave it out.
+ *
+ * **Permissions.** Accepts the app service account's permanent token, or the developer CLI
+ * token (`gsd_`, from `apps-cli login`) of an `owner` or `developer` of the app, as
+ * `Authorization: Bearer`. Any other app token gets `403`. Anyone else gets `404`, the same
+ * response as for an app id that doesn't exist. That includes a developer signed in with a
+ * browser session.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function appsListAppVersions(
+  client: GreenSecurityCore,
+  request: operations.ListAppVersionsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    { [k: string]: components.AppVersionInstalls },
+    | 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.ListAppVersionsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      { [k: string]: components.AppVersionInstalls },
+      | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListAppVersionsRequest$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",
+    }),
+  };
+  const path = pathToFunc("/apps/{app_id}/versions")(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: "listAppVersions",
+    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,
+    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<
+    { [k: string]: components.AppVersionInstalls },
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, z.record(components.AppVersionInstalls$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 }];
+}

package/src/funcs/appsPublishAppManifest.ts

@@ -0,0 +1,213 @@
+/*
+ * 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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Publish an app manifest
+ *
+ * @remarks
+ * Publishes a new version of your marketplace app's manifest: its listing, the permissions
+ * it requests, its UI bundle and views, and the extra origins its sandbox may reach.
+ * `apps-cli upload` calls it after checking that the hosted bundle matches your local
+ * build.
+ *
+ * Every submission is reviewed against the app's last accepted version, and the response's
+ * `status` says what became of it: `accepted`, `screening` (the network sources it adds are
+ * being checked), `pending_review` (it adds a sensitive permission and waits for a Green
+ * Security admin) or `rejected`, with `review_reasons`. A rejection still answers `200`, with
+ * `success` false. Only an accepted version replaces the permissions granted to the app, and
+ * new installations get it. An installation it adds nothing for uses it from the next time
+ * its views are opened; one it adds permissions or network sources for keeps its version
+ * until one of its admins approves the new ones. So publish only once the bundle at
+ * `ui_extensions.bundle.url` is live and matches `integrity`, and keep earlier bundles
+ * hosted. An upload that repeats the last accepted manifest exactly changes nothing.
+ *
+ * Leave out `ui_extensions` to publish a back-end-only app, one with no views that works
+ * only through its service account (see the second example). With a `version`, the
+ * manifest may only send installers to a view it has: `post_install_action.type`
+ * `app_settings_view` needs a `settings` view, and `app_main_view` needs a view for a
+ * viewport other than `settings`, or the manifest is refused with `422`. So an app whose
+ * only view is `settings` uses `app_settings_view`, and a back-end-only app uses `url` or
+ * leaves `post_install_action` out. Left out, the action follows the app's views:
+ * `app_main_view`, `app_settings_view` for a settings-only app, or no post-install step for
+ * a back-end-only app.
+ *
+ * Each permission must be an existing Green Security permission or a platform permission
+ * such as `app_secrets.write` (see `AppManifestPermission`). A manifest that names any
+ * other permission is refused with `400` "Permission '<name>' not found." and writes
+ * nothing: the app, its role and its role's permissions are left as they were.
+ *
+ * **Permissions.** Accepts the app service account's permanent token, or a developer CLI
+ * token (`gsd_`) of a user who is an `owner` or `developer` of the app, as
+ * `Authorization: Bearer`. App user and installation tokens are refused.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function appsPublishAppManifest(
+  client: GreenSecurityCore,
+  request: components.AppManifest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.PublishAppManifestPublishAppManifestOk,
+    | 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: components.AppManifest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.PublishAppManifestPublishAppManifestOk,
+      | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.AppManifest$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("/marketplace/catalog")();
+
+  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: "publishAppManifest",
+    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<
+    operations.PublishAppManifestPublishAppManifestOk,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.PublishAppManifestPublishAppManifestOk$inboundSchema,
+    ),
+    M.jsonErr([400, 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 }];
+}

package/src/funcs/appsRemoveAppDeveloper.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery, 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";
+
+/**
+ * Remove an app developer
+ *
+ * @remarks
+ * Removes a user from the app's developers and closes their dev sessions for it. The app's
+ * last `owner` cannot be removed (`409`).
+ *
+ * **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 appsRemoveAppDeveloper(
+  client: GreenSecurityCore,
+  request: operations.RemoveAppDeveloperRequest,
+  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.RemoveAppDeveloperRequest,
+  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.RemoveAppDeveloperRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/marketplace/apps/{id}/developers")(pathParams);
+
+  const query = encodeFormQuery({
+    "user_id": payload.user_id,
+  });
+
+  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: "removeAppDeveloper",
+    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,
+    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.DeleteApiResponse,
+    | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DeleteApiResponse$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 }];
+}