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

package/src/funcs/appsHeartbeatAppDevSession.ts

@@ -1,202 +0,0 @@
-/*
- * 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 { 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";
-
-/**
- * Keep a dev session alive
- *
- * @remarks
- * Marks a dev session as still running. Call it every 30 seconds; a session with no
- * heartbeat for 2 minutes is treated as inactive and the host stops using it until the next
- * heartbeat. A heartbeat does not extend the 12-hour lifetime.
- *
- * Access is checked again on every heartbeat. A `404` means the session was closed,
- * expired or replaced by a newer one, or you are no longer a developer of the app; a `403`
- * means dev preview has been switched off for the app. Either way the session is closed:
- * start a new one with `POST /apps/{app_id}/dev-sessions` once the cause is resolved.
- *
- * **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 appsHeartbeatAppDevSession(
-  client: GreenSecurityCore,
-  request: operations.HeartbeatAppDevSessionRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
-    | 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.HeartbeatAppDevSessionRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      operations.HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
-      | errors.ApiErrorResponse
-      | errors.UnprocessableEntityOrValidationError
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.HeartbeatAppDevSessionRequest$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}/heartbeat")(
-    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: "heartbeatAppDevSession",
-    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.HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
-    | errors.ApiErrorResponse
-    | errors.UnprocessableEntityOrValidationError
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(
-      200,
-      operations.HeartbeatAppDevSessionHeartbeatAppDevSessionOk$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/appsListAppActivations.ts

@@ -1,273 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { GreenSecurityCore } from "../core.js";
-import { encodeFormQuery } 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 { 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";
-import {
-  createPageIterator,
-  haltIterator,
-  PageIterator,
-  Paginator,
-} from "../types/operations.js";
-
-/**
- * List your app's activations
- *
- * @remarks
- * Lists the activations (installations) of the apps your service account belongs to: which
- * app, what each installation covers, and when it was made. A back-end-only app has no UI to
- * be handed an activation id, so this is where its backend finds the `activation_id` it passes
- * to `POST /oauth/token` with `grant_type=client_credentials` to get an installation token for
- * one installation.
- *
- * To hear about installs as they happen, declare `webhooks` in your app's manifest: your app's
- * own endpoint then receives `MarketplaceAppActivation.created`, `.updated` and `.destroyed`
- * for every installation, the first one included. Use this list to reconcile, on start-up and
- * after any delivery you could not process.
- *
- * Sorted by `id` unless `sort` says otherwise, ascending unless `desc` is set.
- *
- * **Permissions.** Accepts only the app service account's own unscoped token, as
- * `Authorization: Bearer`: its permanent token, or an access token from `client_credentials`
- * issued without `activation_id` or `scope`. App tokens (`gsu_`, `gsi_`, `gsd_`, and the
- * `gsdr_` refresh token) are refused with `403` — an installation token acts as the same service
- * account but is narrowed to one installation — and so is a token narrowed with `scope`. A
- * `token` query parameter is refused with `401`, even alongside the header. A user that is not
- * the service account of any app gets `403`.
- *
- * If set, this operation will use {@link Security.bearerJwt} from the global security.
- */
-export function appsListAppActivations(
-  client: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): APIPromise<
-  PageIterator<
-    Result<
-      operations.ListAppActivationsResponse,
-      | errors.ApiErrorResponse
-      | errors.UnprocessableEntityOrValidationError
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    { page: number }
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: GreenSecurityCore,
-  request: operations.ListAppActivationsRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    PageIterator<
-      Result<
-        operations.ListAppActivationsResponse,
-        | errors.ApiErrorResponse
-        | errors.UnprocessableEntityOrValidationError
-        | GreenSecurityError
-        | ResponseValidationError
-        | ConnectionError
-        | RequestAbortedError
-        | RequestTimeoutError
-        | InvalidRequestError
-        | UnexpectedClientError
-        | SDKValidationError
-      >,
-      { page: number }
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => operations.ListAppActivationsRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [haltIterator(parsed), { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const path = pathToFunc("/marketplace/activations")();
-
-  const query = encodeFormQuery({
-    "desc": payload.desc,
-    "items_per_page": payload.items_per_page,
-    "page": payload.page,
-    "sort": payload.sort,
-  });
-
-  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: "listAppActivations",
-    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 [haltIterator(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 [haltIterator(doResult), { status: "request-error", request: req }];
-  }
-  const response = doResult.value;
-
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
-  const [result, raw] = await M.match<
-    operations.ListAppActivationsResponse,
-    | errors.ApiErrorResponse
-    | errors.UnprocessableEntityOrValidationError
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, operations.ListAppActivationsResponse$inboundSchema, {
-      key: "Result",
-    }),
-    M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(422, errors.UnprocessableEntityOrValidationError$inboundSchema),
-    M.fail("4XX"),
-    M.fail([500, "5XX"]),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [haltIterator(result), {
-      status: "complete",
-      request: req,
-      response,
-    }];
-  }
-
-  const nextFunc = (
-    responseData: unknown,
-  ): {
-    next: Paginator<
-      Result<
-        operations.ListAppActivationsResponse,
-        | errors.ApiErrorResponse
-        | errors.UnprocessableEntityOrValidationError
-        | GreenSecurityError
-        | ResponseValidationError
-        | ConnectionError
-        | RequestAbortedError
-        | RequestTimeoutError
-        | InvalidRequestError
-        | UnexpectedClientError
-        | SDKValidationError
-      >
-    >;
-    "~next"?: { page: number };
-  } => {
-    const page = request?.page ?? 1;
-    const nextPage = page + 1;
-
-    if (!responseData) {
-      return { next: () => null };
-    }
-    const results = (responseData as { items: unknown }).items;
-    if (!Array.isArray(results) || !results.length) {
-      return { next: () => null };
-    }
-    const limit = request?.itemsPerPage ?? 25;
-    if (results.length < limit) {
-      return { next: () => null };
-    }
-
-    const nextVal = () =>
-      appsListAppActivations(
-        client,
-        {
-          ...request,
-          page: nextPage,
-        },
-        options,
-      );
-
-    return { next: nextVal, "~next": { page: nextPage } };
-  };
-
-  const page = { ...result, ...nextFunc(raw) };
-  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
-    status: "complete",
-    request: req,
-    response,
-  }];
-}