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

package/src/models/errors/devsessionerrorresponse.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { GreenSecurityError } from "./greensecurityerror.js";
+
+/**
+ * The standard error envelope. When `manifest` is refused, it also carries `errors`.
+ */
+export type DevSessionErrorResponseData = {
+  /**
+   * A short message that describes the error. For a refused `manifest`, it's
+   *
+   * @remarks
+   * `Invalid manifest: ` followed by the entries of `errors`, joined with `; `.
+   */
+  error: string;
+  /**
+   * Whether the request succeeded. Always false for an error response.
+   */
+  success?: boolean | undefined;
+  /**
+   * The HTTP status code of the error, or `null` if not available.
+   */
+  code?: number | null | undefined;
+  /**
+   * Only when `manifest` is refused: one message per problem, up to 20, in the order
+   *
+   * @remarks
+   * `error` lists them. A message can quote a key or value from your manifest, which may
+   * itself contain `; `, so read this list rather than splitting `error`.
+   */
+  errors?: Array<string> | undefined;
+};
+
+/**
+ * The standard error envelope. When `manifest` is refused, it also carries `errors`.
+ */
+export class DevSessionErrorResponse extends GreenSecurityError {
+  /**
+   * A short message that describes the error. For a refused `manifest`, it's
+   *
+   * @remarks
+   * `Invalid manifest: ` followed by the entries of `errors`, joined with `; `.
+   */
+  error: string;
+  /**
+   * Whether the request succeeded. Always false for an error response.
+   */
+  success?: boolean | undefined;
+  /**
+   * The HTTP status code of the error, or `null` if not available.
+   */
+  code?: number | null | undefined;
+  /**
+   * Only when `manifest` is refused: one message per problem, up to 20, in the order
+   *
+   * @remarks
+   * `error` lists them. A message can quote a key or value from your manifest, which may
+   * itself contain `; `, so read this list rather than splitting `error`.
+   */
+  errors?: Array<string> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: DevSessionErrorResponseData;
+
+  constructor(
+    err: DevSessionErrorResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    if (err.success != null) this.success = err.success;
+    if (err.code != null) this.code = err.code;
+    if (err.errors != null) this.errors = err.errors;
+
+    this.name = "DevSessionErrorResponse";
+  }
+}
+
+/** @internal */
+export const DevSessionErrorResponse$inboundSchema: z.ZodType<
+  DevSessionErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: types.string(),
+  success: types.optional(types.boolean()),
+  code: z.nullable(types.number()).optional(),
+  errors: types.optional(z.array(types.string())),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new DevSessionErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/index.ts

@@ -5,8 +5,12 @@
 export * from "./apierror.js";
 export * from "./apierrorresponse.js";
 export * from "./apivalidationerrorresponse.js";
+export * from "./appsecretsunprocessable.js";
+export * from "./createappdevsession.js";
+export * from "./devsessionerrorresponse.js";
 export * from "./greensecurityerror.js";
 export * from "./httpclienterrors.js";
+export * from "./oautherror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unprocessableentityorvalidationerror.js";

package/src/models/errors/oautherror.ts

@@ -0,0 +1,127 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { GreenSecurityError } from "./greensecurityerror.js";
+
+/**
+ * The error body of the `/oauth/*` endpoints (RFC 6749 section 5.2, RFC 8628 section 3.5).
+ *
+ * @remarks
+ * These endpoints use this shape rather than `ApiErrorResponse`, including for a body that
+ * fails validation or cannot be parsed: that is a `400` `invalid_request`, never a `422`.
+ */
+export type OAuthErrorData = {
+  /**
+   * The RFC error code:
+   *
+   * @remarks
+   *
+   * | Code | Meaning |
+   * | --- | --- |
+   * | `invalid_request` | A parameter is missing or malformed (including `client_id` without `client_secret` or the reverse), an OAuth parameter was sent in the query string rather than the body, the body could not be parsed, or more than one activation covers the user and `activation_id` was left out. |
+   * | `invalid_client` | The client could not be authenticated. Returned with `401`. On the apps CLI's `refresh_token` (a `gsdr_` token): a `client_id` other than `greensecurity-apps-cli`. On `client_credentials`: wrong `client_id` or `client_secret`; an `Authorization` token that is missing, invalid, or not the service account's permanent token (a short-lived, narrowed or app token is refused); or a locked service account. On `refresh_token`: `client_id` or `client_secret` does not match the refresh token's service account, or that account is locked. On the device grant and `POST /oauth/device_authorization`: an unknown `client_id`. On `POST /oauth/introspect` and `POST /oauth/revoke`: see each endpoint. |
+   * | `invalid_grant` | `subject_token` is invalid or expired, is an app token or a narrowed (scoped) token, or belongs to a locked user or a service account; `refresh_token` is unknown, expired, already used or not a service account's; an apps CLI refresh token is unknown, expired, revoked or reused, its login is past 90 days, or its developer is locked or deleted (all answered "Re-authenticate with `gs-apps login`."); or `device_code` is unknown or already used, or the user who approved it can no longer sign in. |
+   * | `unauthorized_client` | The caller may not use this grant: `client_credentials` from a user who is not an API service account. |
+   * | `unsupported_grant_type` | `grant_type` is not one of the four supported grants. |
+   * | `invalid_target` | `audience` names no app, or an app the user is not covered by; or `activation_id` is not an activation of the caller's app, or does not match `audience`. |
+   * | `invalid_scope` | None of the requested scopes is available to the client: what it asked for and what it is allowed have nothing in common. On `POST /oauth/device_authorization`, any scope other than `apps:develop`. |
+   * | `authorization_pending` | Device flow: the user has not approved the request yet. Keep polling. |
+   * | `slow_down` | Device flow: polling too fast. Add 5 seconds to the interval and keep polling. `POST /oauth/device_authorization` also returns it, with `429`, when one address starts too many logins, and so does the apps CLI's `refresh_token` past 60 refreshes per address in ten minutes. Wait and retry; it is not a failed login. |
+   * | `access_denied` | Device flow: the user declined the request. Stop polling. |
+   * | `expired_token` | Device flow: `device_code` expired. Start again from `POST /oauth/device_authorization`. |
+   */
+  error: components.OAuthErrorCode;
+  /**
+   * A human-readable explanation, for logs rather than for end users. When a request
+   *
+   * @remarks
+   * parameter fails validation it names the parameter, as `<parameter>: <message>`.
+   */
+  errorDescription?: string | undefined;
+};
+
+/**
+ * The error body of the `/oauth/*` endpoints (RFC 6749 section 5.2, RFC 8628 section 3.5).
+ *
+ * @remarks
+ * These endpoints use this shape rather than `ApiErrorResponse`, including for a body that
+ * fails validation or cannot be parsed: that is a `400` `invalid_request`, never a `422`.
+ */
+export class OAuthError extends GreenSecurityError {
+  /**
+   * The RFC error code:
+   *
+   * @remarks
+   *
+   * | Code | Meaning |
+   * | --- | --- |
+   * | `invalid_request` | A parameter is missing or malformed (including `client_id` without `client_secret` or the reverse), an OAuth parameter was sent in the query string rather than the body, the body could not be parsed, or more than one activation covers the user and `activation_id` was left out. |
+   * | `invalid_client` | The client could not be authenticated. Returned with `401`. On the apps CLI's `refresh_token` (a `gsdr_` token): a `client_id` other than `greensecurity-apps-cli`. On `client_credentials`: wrong `client_id` or `client_secret`; an `Authorization` token that is missing, invalid, or not the service account's permanent token (a short-lived, narrowed or app token is refused); or a locked service account. On `refresh_token`: `client_id` or `client_secret` does not match the refresh token's service account, or that account is locked. On the device grant and `POST /oauth/device_authorization`: an unknown `client_id`. On `POST /oauth/introspect` and `POST /oauth/revoke`: see each endpoint. |
+   * | `invalid_grant` | `subject_token` is invalid or expired, is an app token or a narrowed (scoped) token, or belongs to a locked user or a service account; `refresh_token` is unknown, expired, already used or not a service account's; an apps CLI refresh token is unknown, expired, revoked or reused, its login is past 90 days, or its developer is locked or deleted (all answered "Re-authenticate with `gs-apps login`."); or `device_code` is unknown or already used, or the user who approved it can no longer sign in. |
+   * | `unauthorized_client` | The caller may not use this grant: `client_credentials` from a user who is not an API service account. |
+   * | `unsupported_grant_type` | `grant_type` is not one of the four supported grants. |
+   * | `invalid_target` | `audience` names no app, or an app the user is not covered by; or `activation_id` is not an activation of the caller's app, or does not match `audience`. |
+   * | `invalid_scope` | None of the requested scopes is available to the client: what it asked for and what it is allowed have nothing in common. On `POST /oauth/device_authorization`, any scope other than `apps:develop`. |
+   * | `authorization_pending` | Device flow: the user has not approved the request yet. Keep polling. |
+   * | `slow_down` | Device flow: polling too fast. Add 5 seconds to the interval and keep polling. `POST /oauth/device_authorization` also returns it, with `429`, when one address starts too many logins, and so does the apps CLI's `refresh_token` past 60 refreshes per address in ten minutes. Wait and retry; it is not a failed login. |
+   * | `access_denied` | Device flow: the user declined the request. Stop polling. |
+   * | `expired_token` | Device flow: `device_code` expired. Start again from `POST /oauth/device_authorization`. |
+   */
+  error: components.OAuthErrorCode;
+  /**
+   * A human-readable explanation, for logs rather than for end users. When a request
+   *
+   * @remarks
+   * parameter fails validation it names the parameter, as `<parameter>: <message>`.
+   */
+  errorDescription?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: OAuthErrorData;
+
+  constructor(
+    err: OAuthErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    if (err.errorDescription != null) {
+      this.errorDescription = err.errorDescription;
+    }
+
+    this.name = "OAuthError";
+  }
+}
+
+/** @internal */
+export const OAuthError$inboundSchema: z.ZodType<
+  OAuthError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: components.OAuthErrorCode$inboundSchema,
+  error_description: types.optional(types.string()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    const remapped = remap$(v, {
+      "error_description": "errorDescription",
+    });
+
+    return new OAuthError(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/operations/addappdeveloper.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 * as components from "../components/index.js";
+
+export type AddAppDeveloperRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  id: number;
+  appDeveloperAdd: components.AppDeveloperAdd;
+};
+
+/** @internal */
+export type AddAppDeveloperRequest$Outbound = {
+  id: number;
+  AppDeveloperAdd: components.AppDeveloperAdd$Outbound;
+};
+
+/** @internal */
+export const AddAppDeveloperRequest$outboundSchema: z.ZodType<
+  AddAppDeveloperRequest$Outbound,
+  z.ZodTypeDef,
+  AddAppDeveloperRequest
+> = z.object({
+  id: z.number().int(),
+  appDeveloperAdd: components.AppDeveloperAdd$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    appDeveloperAdd: "AppDeveloperAdd",
+  });
+});
+
+export function addAppDeveloperRequestToJSON(
+  addAppDeveloperRequest: AddAppDeveloperRequest,
+): string {
+  return JSON.stringify(
+    AddAppDeveloperRequest$outboundSchema.parse(addAppDeveloperRequest),
+  );
+}

package/src/models/operations/closeappdevsession.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CloseAppDevSessionRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  appId: number;
+  /**
+   * The dev session's id.
+   */
+  id: string;
+};
+
+/** @internal */
+export type CloseAppDevSessionRequest$Outbound = {
+  app_id: number;
+  id: string;
+};
+
+/** @internal */
+export const CloseAppDevSessionRequest$outboundSchema: z.ZodType<
+  CloseAppDevSessionRequest$Outbound,
+  z.ZodTypeDef,
+  CloseAppDevSessionRequest
+> = z.object({
+  appId: z.number().int(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    appId: "app_id",
+  });
+});
+
+export function closeAppDevSessionRequestToJSON(
+  closeAppDevSessionRequest: CloseAppDevSessionRequest,
+): string {
+  return JSON.stringify(
+    CloseAppDevSessionRequest$outboundSchema.parse(closeAppDevSessionRequest),
+  );
+}

package/src/models/operations/createappdevsession.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 * as components from "../components/index.js";
+
+export type CreateAppDevSessionRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  appId: number;
+  devSessionCreate: components.DevSessionCreate;
+};
+
+/** @internal */
+export type CreateAppDevSessionRequest$Outbound = {
+  app_id: number;
+  DevSessionCreate: components.DevSessionCreate$Outbound;
+};
+
+/** @internal */
+export const CreateAppDevSessionRequest$outboundSchema: z.ZodType<
+  CreateAppDevSessionRequest$Outbound,
+  z.ZodTypeDef,
+  CreateAppDevSessionRequest
+> = z.object({
+  appId: z.number().int(),
+  devSessionCreate: components.DevSessionCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    appId: "app_id",
+    devSessionCreate: "DevSessionCreate",
+  });
+});
+
+export function createAppDevSessionRequestToJSON(
+  createAppDevSessionRequest: CreateAppDevSessionRequest,
+): string {
+  return JSON.stringify(
+    CreateAppDevSessionRequest$outboundSchema.parse(createAppDevSessionRequest),
+  );
+}

package/src/models/operations/findappsecret.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+
+export const FindAppSecretQueryParamExpand = {
+  Payload: "payload",
+} as const;
+export type FindAppSecretQueryParamExpand = ClosedEnum<
+  typeof FindAppSecretQueryParamExpand
+>;
+
+export type FindAppSecretRequest = {
+  /**
+   * The secret's name.
+   */
+  name: string;
+  /**
+   * The secret's scope, as `scope[type]` and, for user secrets, `scope[user_id]`.
+   */
+  scope: components.AppSecretScope;
+  /**
+   * Service account only, and required there (`422` without it). Leave it out with an app token, which carries its own activation; if sent, it must be that activation (`403` otherwise).
+   */
+  activationId?: number | undefined;
+  /**
+   * Pass `payload` to include the decrypted value.
+   */
+  expand?: Array<FindAppSecretQueryParamExpand> | undefined;
+};
+
+/** @internal */
+export const FindAppSecretQueryParamExpand$outboundSchema: z.ZodNativeEnum<
+  typeof FindAppSecretQueryParamExpand
+> = z.nativeEnum(FindAppSecretQueryParamExpand);
+
+/** @internal */
+export type FindAppSecretRequest$Outbound = {
+  name: string;
+  scope: components.AppSecretScope$Outbound;
+  activation_id?: number | undefined;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const FindAppSecretRequest$outboundSchema: z.ZodType<
+  FindAppSecretRequest$Outbound,
+  z.ZodTypeDef,
+  FindAppSecretRequest
+> = z.object({
+  name: z.string(),
+  scope: components.AppSecretScope$outboundSchema,
+  activationId: z.number().int().optional(),
+  expand: z.array(FindAppSecretQueryParamExpand$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    activationId: "activation_id",
+  });
+});
+
+export function findAppSecretRequestToJSON(
+  findAppSecretRequest: FindAppSecretRequest,
+): string {
+  return JSON.stringify(
+    FindAppSecretRequest$outboundSchema.parse(findAppSecretRequest),
+  );
+}

package/src/models/operations/heartbeatappdevsession.ts

@@ -0,0 +1,96 @@
+/*
+ * 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";
+
+export type HeartbeatAppDevSessionRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  appId: number;
+  /**
+   * The dev session's id.
+   */
+  id: string;
+};
+
+/**
+ * The session is active.
+ */
+export type HeartbeatAppDevSessionHeartbeatAppDevSessionOk = {
+  /**
+   * The dev session's id.
+   */
+  id: string;
+  /**
+   * When the session expires, in milliseconds since the Unix epoch.
+   */
+  expiresAt: number;
+};
+
+/** @internal */
+export type HeartbeatAppDevSessionRequest$Outbound = {
+  app_id: number;
+  id: string;
+};
+
+/** @internal */
+export const HeartbeatAppDevSessionRequest$outboundSchema: z.ZodType<
+  HeartbeatAppDevSessionRequest$Outbound,
+  z.ZodTypeDef,
+  HeartbeatAppDevSessionRequest
+> = z.object({
+  appId: z.number().int(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    appId: "app_id",
+  });
+});
+
+export function heartbeatAppDevSessionRequestToJSON(
+  heartbeatAppDevSessionRequest: HeartbeatAppDevSessionRequest,
+): string {
+  return JSON.stringify(
+    HeartbeatAppDevSessionRequest$outboundSchema.parse(
+      heartbeatAppDevSessionRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const HeartbeatAppDevSessionHeartbeatAppDevSessionOk$inboundSchema:
+  z.ZodType<
+    HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: types.string(),
+    expires_at: types.number(),
+  }).transform((v) => {
+    return remap$(v, {
+      "expires_at": "expiresAt",
+    });
+  });
+
+export function heartbeatAppDevSessionHeartbeatAppDevSessionOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HeartbeatAppDevSessionHeartbeatAppDevSessionOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'HeartbeatAppDevSessionHeartbeatAppDevSessionOk' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -4,6 +4,7 @@
 
 export * from "./acceptinvitation.js";
 export * from "./acceptvendorcredential.js";
+export * from "./addappdeveloper.js";
 export * from "./addcompanymanager.js";
 export * from "./adddatarequestfile.js";
 export * from "./addmobiledevice.js";
@@ -15,7 +16,9 @@ export * from "./cancelhandoff.js";
 export * from "./changepassword.js";
 export * from "./changesubscription.js";
 export * from "./checkdownloadcode.js";
+export * from "./closeappdevsession.js";
 export * from "./convertquote.js";
+export * from "./createappdevsession.js";
 export * from "./createcompanytargetfacility.js";
 export * from "./createevent.js";
 export * from "./createinvoice.js";
@@ -49,6 +52,7 @@ export * from "./expeditetimeremaining.js";
 export * from "./exportcompanytargetfacilities.js";
 export * from "./exportfacilityvendors.js";
 export * from "./exportvendorscans.js";
+export * from "./findappsecret.js";
 export * from "./getcompany.js";
 export * from "./getcompanytargetfacilitiesexportstatus.js";
 export * from "./getcurrentuser.js";
@@ -85,6 +89,7 @@ export * from "./getvendorsexportstatus.js";
 export * from "./getvendortargetfacilities.js";
 export * from "./getvendoruploadhistory.js";
 export * from "./getwebhookendpoint.js";
+export * from "./heartbeatappdevsession.js";
 export * from "./initiatescheduledreport.js";
 export * from "./invoicesexport.js";
 export * from "./listalerts.js";
@@ -94,6 +99,10 @@ export * from "./listallmedicalproductcategories.js";
 export * from "./listallmedicalproductfamilies.js";
 export * from "./listallmedicalproducts.js";
 export * from "./listallwebhookendpoints.js";
+export * from "./listappactivations.js";
+export * from "./listappdevelopers.js";
+export * from "./listappsecrets.js";
+export * from "./listappversions.js";
 export * from "./listcompanycredentials.js";
 export * from "./listcompanycredits.js";
 export * from "./listcompanymanagercontacts.js";
@@ -145,8 +154,12 @@ export * from "./patchmedicalproduct.js";
 export * from "./patchmedicalproductcategory.js";
 export * from "./patchmedicalproductfamily.js";
 export * from "./postauthenticate.js";
+export * from "./publishappmanifest.js";
 export * from "./purchasescrubcredits.js";
+export * from "./removeappdeveloper.js";
+export * from "./revoketoken.js";
 export * from "./rotateapikey.js";
+export * from "./rotateappwebhookendpointsecret.js";
 export * from "./securityzonecheckin.js";
 export * from "./senddownloadcode.js";
 export * from "./submitscreeningresponse.js";