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

package/src/models/components/apppostinstallaction.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const AppPostInstallActionType = {
+  Url: "url",
+  AppSettingsView: "app_settings_view",
+  AppMainView: "app_main_view",
+} as const;
+export type AppPostInstallActionType = OpenEnum<
+  typeof AppPostInstallActionType
+>;
+
+/**
+ * What the installer sees once the app is installed. `url` is required when `type` is
+ *
+ * @remarks
+ * `url`. In a manifest with a `version`, `app_settings_view` requires a `settings` view,
+ * and `app_main_view` requires a view for a viewport other than `settings`.
+ *
+ * Left out, the action follows the app's views, so it never names a view the app lacks:
+ * `app_main_view` when the app has a view other than `settings`, `app_settings_view`
+ * when `settings` is its only view, and no post-install step for a back-end-only app.
+ * A back-end-only app that wants to send installers somewhere uses `url`.
+ */
+export type AppPostInstallAction = {
+  type: AppPostInstallActionType;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const AppPostInstallActionType$inboundSchema: z.ZodType<
+  AppPostInstallActionType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AppPostInstallActionType);
+/** @internal */
+export const AppPostInstallActionType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AppPostInstallActionType
+> = openEnums.outboundSchema(AppPostInstallActionType);
+
+/** @internal */
+export const AppPostInstallAction$inboundSchema: z.ZodType<
+  AppPostInstallAction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: AppPostInstallActionType$inboundSchema,
+  url: types.optional(types.string()),
+});
+/** @internal */
+export type AppPostInstallAction$Outbound = {
+  type: string;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const AppPostInstallAction$outboundSchema: z.ZodType<
+  AppPostInstallAction$Outbound,
+  z.ZodTypeDef,
+  AppPostInstallAction
+> = z.object({
+  type: AppPostInstallActionType$outboundSchema,
+  url: z.string().optional(),
+});
+
+export function appPostInstallActionToJSON(
+  appPostInstallAction: AppPostInstallAction,
+): string {
+  return JSON.stringify(
+    AppPostInstallAction$outboundSchema.parse(appPostInstallAction),
+  );
+}
+export function appPostInstallActionFromJSON(
+  jsonString: string,
+): SafeParseResult<AppPostInstallAction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppPostInstallAction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppPostInstallAction' from JSON`,
+  );
+}

package/src/models/components/appreviewreason.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * One finding of the review of a catalog submission.
+ */
+export type AppReviewReason = {
+  /**
+   * What the review found, for example `purpose_too_short`,
+   *
+   * @remarks
+   * `justification_required`, `csp_denylisted`, `csp_ip_literal`, `csp_tls_failed`,
+   * `version_reused`, `superseded` or `rejected_by_reviewer`. New codes may be added.
+   */
+  code: string;
+  /**
+   * The finding in words. For `rejected_by_reviewer`, the reviewer's reason.
+   */
+  message: string;
+  /**
+   * The manifest field the finding is about, as a dotted path, when there is one.
+   */
+  path?: string | undefined;
+};
+
+/** @internal */
+export const AppReviewReason$inboundSchema: z.ZodType<
+  AppReviewReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: types.string(),
+  message: types.string(),
+  path: types.optional(types.string()),
+});
+
+export function appReviewReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<AppReviewReason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppReviewReason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppReviewReason' from JSON`,
+  );
+}

package/src/models/components/approute.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Reserved for a future full-page view. Stored and validated, not rendered.
+ */
+export type AppRoute = {
+  path: string;
+  component: string;
+};
+
+/** @internal */
+export const AppRoute$inboundSchema: z.ZodType<
+  AppRoute,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  path: types.string(),
+  component: types.string(),
+});
+/** @internal */
+export type AppRoute$Outbound = {
+  path: string;
+  component: string;
+};
+
+/** @internal */
+export const AppRoute$outboundSchema: z.ZodType<
+  AppRoute$Outbound,
+  z.ZodTypeDef,
+  AppRoute
+> = z.object({
+  path: z.string(),
+  component: z.string(),
+});
+
+export function appRouteToJSON(appRoute: AppRoute): string {
+  return JSON.stringify(AppRoute$outboundSchema.parse(appRoute));
+}
+export function appRouteFromJSON(
+  jsonString: string,
+): SafeParseResult<AppRoute, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppRoute$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppRoute' from JSON`,
+  );
+}

package/src/models/components/appsecret.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AppSecretScope,
+  AppSecretScope$inboundSchema,
+} from "./appsecretscope.js";
+
+/**
+ * A named, encrypted value your app stores with Green Security, scoped to one activation
+ *
+ * @remarks
+ * of the app: the app token's own activation, or the `activation_id` the service account
+ * sends. `payload` is returned only by `GET /apps/secrets/find` with `expand=payload`.
+ * Removing the activation, or changing what it covers, deletes all of its secrets.
+ */
+export type AppSecret = {
+  /**
+   * Unique identifier for the object.
+   */
+  id: number;
+  object: "app.secret";
+  /**
+   * Unique per scope. Letters, digits, `_`, `.` and `-`, up to 100 characters.
+   */
+  name: string;
+  /**
+   * Who a secret belongs to, selected by `type`. `installation` secrets are shared by every
+   *
+   * @remarks
+   * user of one activation of your app and name no user; `user` secrets belong to a single
+   * user within it.
+   */
+  scope: AppSecretScope;
+  /**
+   * When the secret was created, in seconds since the Unix epoch.
+   */
+  created: number;
+  /**
+   * When the secret expires, in seconds since the Unix epoch, or `null` if it does not. Expired secrets are no longer returned, and are deleted.
+   */
+  expiresAt?: number | null | undefined;
+  /**
+   * The decrypted value. Only present when requested with `expand=payload`. A payload
+   *
+   * @remarks
+   * that cannot be decrypted is a `500` "The secret could not be read.", never `null`.
+   */
+  payload?: string | undefined;
+};
+
+/** @internal */
+export const AppSecret$inboundSchema: z.ZodType<
+  AppSecret,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  object: types.literal("app.secret"),
+  name: types.string(),
+  scope: AppSecretScope$inboundSchema,
+  created: types.number(),
+  expires_at: z.nullable(types.number()).optional(),
+  payload: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "expires_at": "expiresAt",
+  });
+});
+
+export function appSecretFromJSON(
+  jsonString: string,
+): SafeParseResult<AppSecret, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppSecret$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppSecret' from JSON`,
+  );
+}

package/src/models/components/appsecretdeleted.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AppSecretScope,
+  AppSecretScope$inboundSchema,
+} from "./appsecretscope.js";
+
+/**
+ * The response to `POST /apps/secrets/delete`: the secret as it was just before it was
+ *
+ * @remarks
+ * deleted, without its payload, marked `deleted: true`.
+ */
+export type AppSecretDeleted = {
+  /**
+   * The deleted secret's id.
+   */
+  id: number;
+  object: "app.secret";
+  name: string;
+  /**
+   * Who a secret belongs to, selected by `type`. `installation` secrets are shared by every
+   *
+   * @remarks
+   * user of one activation of your app and name no user; `user` secrets belong to a single
+   * user within it.
+   */
+  scope: AppSecretScope;
+  /**
+   * When the secret was created, in seconds since the Unix epoch.
+   */
+  created: number;
+  /**
+   * When the secret would have expired, in seconds since the Unix epoch, or `null` if it had no expiry.
+   */
+  expiresAt?: number | null | undefined;
+  deleted: true;
+};
+
+/** @internal */
+export const AppSecretDeleted$inboundSchema: z.ZodType<
+  AppSecretDeleted,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  object: types.literal("app.secret"),
+  name: types.string(),
+  scope: AppSecretScope$inboundSchema,
+  created: types.number(),
+  expires_at: z.nullable(types.number()).optional(),
+  deleted: types.literal(true),
+}).transform((v) => {
+  return remap$(v, {
+    "expires_at": "expiresAt",
+  });
+});
+
+export function appSecretDeletedFromJSON(
+  jsonString: string,
+): SafeParseResult<AppSecretDeleted, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppSecretDeleted$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppSecretDeleted' from JSON`,
+  );
+}

package/src/models/components/appsecretdeleterequest.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  AppSecretScope,
+  AppSecretScope$Outbound,
+  AppSecretScope$outboundSchema,
+} from "./appsecretscope.js";
+
+export type AppSecretDeleteRequest = {
+  name: string;
+  /**
+   * Who a secret belongs to, selected by `type`. `installation` secrets are shared by every
+   *
+   * @remarks
+   * user of one activation of your app and name no user; `user` secrets belong to a single
+   * user within it.
+   */
+  scope: AppSecretScope;
+  /**
+   * Service account only, and required there (`422` without it): the activation of your app
+   *
+   * @remarks
+   * to act on (`403` if it is not one). Leave it out with an app token, which carries its
+   * own activation; if sent, it must be that activation (`403` otherwise).
+   */
+  activationId?: number | undefined;
+};
+
+/** @internal */
+export type AppSecretDeleteRequest$Outbound = {
+  name: string;
+  scope: AppSecretScope$Outbound;
+  activation_id?: number | undefined;
+};
+
+/** @internal */
+export const AppSecretDeleteRequest$outboundSchema: z.ZodType<
+  AppSecretDeleteRequest$Outbound,
+  z.ZodTypeDef,
+  AppSecretDeleteRequest
+> = z.object({
+  name: z.string(),
+  scope: AppSecretScope$outboundSchema,
+  activationId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    activationId: "activation_id",
+  });
+});
+
+export function appSecretDeleteRequestToJSON(
+  appSecretDeleteRequest: AppSecretDeleteRequest,
+): string {
+  return JSON.stringify(
+    AppSecretDeleteRequest$outboundSchema.parse(appSecretDeleteRequest),
+  );
+}

package/src/models/components/appsecretinstallationscope.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A secret shared by every user of the activation. Sending `user_id` with it is refused with `422`.
+ */
+export type AppSecretInstallationScope = {
+  type: "installation";
+};
+
+/** @internal */
+export const AppSecretInstallationScope$inboundSchema: z.ZodType<
+  AppSecretInstallationScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: types.literal("installation"),
+});
+/** @internal */
+export type AppSecretInstallationScope$Outbound = {
+  type: "installation";
+};
+
+/** @internal */
+export const AppSecretInstallationScope$outboundSchema: z.ZodType<
+  AppSecretInstallationScope$Outbound,
+  z.ZodTypeDef,
+  AppSecretInstallationScope
+> = z.object({
+  type: z.literal("installation"),
+});
+
+export function appSecretInstallationScopeToJSON(
+  appSecretInstallationScope: AppSecretInstallationScope,
+): string {
+  return JSON.stringify(
+    AppSecretInstallationScope$outboundSchema.parse(appSecretInstallationScope),
+  );
+}
+export function appSecretInstallationScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<AppSecretInstallationScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppSecretInstallationScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppSecretInstallationScope' from JSON`,
+  );
+}

package/src/models/components/appsecretscope.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AppSecretInstallationScope,
+  AppSecretInstallationScope$inboundSchema,
+  AppSecretInstallationScope$Outbound,
+  AppSecretInstallationScope$outboundSchema,
+} from "./appsecretinstallationscope.js";
+import {
+  AppSecretUserScope,
+  AppSecretUserScope$inboundSchema,
+  AppSecretUserScope$Outbound,
+  AppSecretUserScope$outboundSchema,
+} from "./appsecretuserscope.js";
+
+/**
+ * Who a secret belongs to, selected by `type`. `installation` secrets are shared by every
+ *
+ * @remarks
+ * user of one activation of your app and name no user; `user` secrets belong to a single
+ * user within it.
+ */
+export type AppSecretScope = AppSecretInstallationScope | AppSecretUserScope;
+
+/** @internal */
+export const AppSecretScope$inboundSchema: z.ZodType<
+  AppSecretScope,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  AppSecretInstallationScope$inboundSchema,
+  AppSecretUserScope$inboundSchema,
+]);
+/** @internal */
+export type AppSecretScope$Outbound =
+  | AppSecretInstallationScope$Outbound
+  | AppSecretUserScope$Outbound;
+
+/** @internal */
+export const AppSecretScope$outboundSchema: z.ZodType<
+  AppSecretScope$Outbound,
+  z.ZodTypeDef,
+  AppSecretScope
+> = z.union([
+  AppSecretInstallationScope$outboundSchema,
+  AppSecretUserScope$outboundSchema,
+]);
+
+export function appSecretScopeToJSON(appSecretScope: AppSecretScope): string {
+  return JSON.stringify(AppSecretScope$outboundSchema.parse(appSecretScope));
+}
+export function appSecretScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<AppSecretScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppSecretScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppSecretScope' from JSON`,
+  );
+}

package/src/models/components/appsecretsetrequest.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  AppSecretScope,
+  AppSecretScope$Outbound,
+  AppSecretScope$outboundSchema,
+} from "./appsecretscope.js";
+
+export type AppSecretSetRequest = {
+  /**
+   * Unique per scope. Setting an existing name replaces its payload and expiry.
+   */
+  name: string;
+  /**
+   * **At most 8192 bytes once UTF-8 encoded, not 8192 characters.** JSON Schema has no
+   *
+   * @remarks
+   * byte-length keyword, so `maxLength` here only bounds characters; the server checks
+   * the bytes and answers `422` "must be at most 8192 bytes" past them. ASCII is one
+   * byte per character, but a payload with multi-byte characters fits fewer than 8192.
+   *
+   * The value to store: a string that is not blank. It is encrypted at rest and never
+   * logged, and a rejected payload is never echoed in the error.
+   */
+  payload: string;
+  /**
+   * Who a secret belongs to, selected by `type`. `installation` secrets are shared by every
+   *
+   * @remarks
+   * user of one activation of your app and name no user; `user` secrets belong to a single
+   * user within it.
+   */
+  scope: AppSecretScope;
+  /**
+   * Optional expiry in seconds since the Unix epoch. Must be in the future and less than 100 years away.
+   */
+  expiresAt?: number | undefined;
+  /**
+   * Service account only, and required there (`422` without it): the activation of your app
+   *
+   * @remarks
+   * to act on (`403` if it is not one). Leave it out with an app token, which carries its
+   * own activation; if sent, it must be that activation (`403` otherwise).
+   */
+  activationId?: number | undefined;
+};
+
+/** @internal */
+export type AppSecretSetRequest$Outbound = {
+  name: string;
+  payload: string;
+  scope: AppSecretScope$Outbound;
+  expires_at?: number | undefined;
+  activation_id?: number | undefined;
+};
+
+/** @internal */
+export const AppSecretSetRequest$outboundSchema: z.ZodType<
+  AppSecretSetRequest$Outbound,
+  z.ZodTypeDef,
+  AppSecretSetRequest
+> = z.object({
+  name: z.string(),
+  payload: z.string(),
+  scope: AppSecretScope$outboundSchema,
+  expiresAt: z.number().int().optional(),
+  activationId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    expiresAt: "expires_at",
+    activationId: "activation_id",
+  });
+});
+
+export function appSecretSetRequestToJSON(
+  appSecretSetRequest: AppSecretSetRequest,
+): string {
+  return JSON.stringify(
+    AppSecretSetRequest$outboundSchema.parse(appSecretSetRequest),
+  );
+}