@greensecurity/javascript-sdk 0.35.55 → 0.36.0

package/src/models/errors/apierror.ts

@@ -2,41 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class APIError extends Error {
-  /**
-   * HTTP status code
-   */
-  public readonly statusCode: number;
-  /**
-   * HTTP content type
-   */
-  public readonly contentType: string;
-  /**
-   * HTTP body
-   */
-  public readonly body: string;
-  /**
-   * Raw response
-   */
-  public readonly rawResponse: Response;
+import { GreenSecurityError } from "./greensecurityerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends GreenSecurityError {
   constructor(
     message: string,
-    rawResponse: Response,
-    body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.body = body;
-    this.rawResponse = rawResponse;
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : " ";
+    message += `Body ${body}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "APIError";
   }
 }

package/src/models/errors/apierrorresponse.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { GreenSecurityError } from "./greensecurityerror.js";
 
 /**
  * Green Security uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe’s servers (these are rare).
@@ -24,7 +25,7 @@ export type ApiErrorResponseData = {
  *
  * Some 4xx errors that could be handled programmatically (e.g., invalid input) include an error description that briefly explains the error reported.
  */
-export class ApiErrorResponse extends Error {
+export class ApiErrorResponse extends GreenSecurityError {
   error: string;
   success: boolean;
   code?: number | null | undefined;
@@ -32,13 +33,15 @@ export class ApiErrorResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: ApiErrorResponseData;
 
-  constructor(err: ApiErrorResponseData) {
+  constructor(
+    err: ApiErrorResponseData,
+    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);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.error = err.error;
     this.success = err.success;
     if (err.code != null) this.code = err.code;
@@ -56,9 +59,16 @@ export const ApiErrorResponse$inboundSchema: z.ZodType<
   error: z.string(),
   success: z.boolean(),
   code: z.nullable(z.number().int()).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new ApiErrorResponse(v);
+    return new ApiErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/greensecurityerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class GreenSecurityError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "GreenSecurityError";
+  }
+}

package/src/models/errors/index.ts

@@ -5,4 +5,5 @@
 export * from "./apierror.js";
 export * from "./apierrorresponse.js";
 export * from "./httpclienterrors.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { GreenSecurityError } from "./greensecurityerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends GreenSecurityError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/operations/postauthenticate.ts

@@ -12,22 +12,22 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Login request parameters
  */
 export type PostAuthenticateRequestBody =
-  | components.LoginRequirementsFromEmail
-  | components.LoginEmailAndPassword;
+  | components.LoginEmailAndPassword
+  | components.LoginRequirementsFromEmail;
 
 /**
  * The request has been accepted for processing, but the processing has not been completed. The request might be processed later.
  */
 export type PostAuthenticateResponseBody =
-  | (components.PasswordRequiredResponse & { requires: "password" })
+  | (components.SamlLoginRequiredResponse & { requires: "saml_login" })
   | (components.MfaRequiredResponse & { requires: "mfa_code" })
-  | (components.SamlLoginRequiredResponse & { requires: "saml_login" });
+  | (components.PasswordRequiredResponse & { requires: "password" });
 
 export type PostAuthenticateResponse =
   | components.User
-  | (components.PasswordRequiredResponse & { requires: "password" })
+  | (components.SamlLoginRequiredResponse & { requires: "saml_login" })
   | (components.MfaRequiredResponse & { requires: "mfa_code" })
-  | (components.SamlLoginRequiredResponse & { requires: "saml_login" });
+  | (components.PasswordRequiredResponse & { requires: "password" });
 
 /** @internal */
 export const PostAuthenticateRequestBody$inboundSchema: z.ZodType<
@@ -35,14 +35,14 @@ export const PostAuthenticateRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  components.LoginRequirementsFromEmail$inboundSchema,
   components.LoginEmailAndPassword$inboundSchema,
+  components.LoginRequirementsFromEmail$inboundSchema,
 ]);
 
 /** @internal */
 export type PostAuthenticateRequestBody$Outbound =
-  | components.LoginRequirementsFromEmail$Outbound
-  | components.LoginEmailAndPassword$Outbound;
+  | components.LoginEmailAndPassword$Outbound
+  | components.LoginRequirementsFromEmail$Outbound;
 
 /** @internal */
 export const PostAuthenticateRequestBody$outboundSchema: z.ZodType<
@@ -50,8 +50,8 @@ export const PostAuthenticateRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PostAuthenticateRequestBody
 > = z.union([
-  components.LoginRequirementsFromEmail$outboundSchema,
   components.LoginEmailAndPassword$outboundSchema,
+  components.LoginRequirementsFromEmail$outboundSchema,
 ]);
 
 /**
@@ -93,8 +93,8 @@ export const PostAuthenticateResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  components.PasswordRequiredResponse$inboundSchema.and(
-    z.object({ requires: z.literal("password") }).transform((v) => ({
+  components.SamlLoginRequiredResponse$inboundSchema.and(
+    z.object({ requires: z.literal("saml_login") }).transform((v) => ({
       requires: v.requires,
     })),
   ),
@@ -103,8 +103,8 @@ export const PostAuthenticateResponseBody$inboundSchema: z.ZodType<
       requires: v.requires,
     })),
   ),
-  components.SamlLoginRequiredResponse$inboundSchema.and(
-    z.object({ requires: z.literal("saml_login") }).transform((v) => ({
+  components.PasswordRequiredResponse$inboundSchema.and(
+    z.object({ requires: z.literal("password") }).transform((v) => ({
       requires: v.requires,
     })),
   ),
@@ -112,11 +112,9 @@ export const PostAuthenticateResponseBody$inboundSchema: z.ZodType<
 
 /** @internal */
 export type PostAuthenticateResponseBody$Outbound =
-  | (components.PasswordRequiredResponse$Outbound & { requires: "password" })
+  | (components.SamlLoginRequiredResponse$Outbound & { requires: "saml_login" })
   | (components.MfaRequiredResponse$Outbound & { requires: "mfa_code" })
-  | (components.SamlLoginRequiredResponse$Outbound & {
-    requires: "saml_login";
-  });
+  | (components.PasswordRequiredResponse$Outbound & { requires: "password" });
 
 /** @internal */
 export const PostAuthenticateResponseBody$outboundSchema: z.ZodType<
@@ -124,8 +122,8 @@ export const PostAuthenticateResponseBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PostAuthenticateResponseBody
 > = z.union([
-  components.PasswordRequiredResponse$outboundSchema.and(
-    z.object({ requires: z.literal("password") }).transform((v) => ({
+  components.SamlLoginRequiredResponse$outboundSchema.and(
+    z.object({ requires: z.literal("saml_login") }).transform((v) => ({
       requires: v.requires,
     })),
   ),
@@ -134,8 +132,8 @@ export const PostAuthenticateResponseBody$outboundSchema: z.ZodType<
       requires: v.requires,
     })),
   ),
-  components.SamlLoginRequiredResponse$outboundSchema.and(
-    z.object({ requires: z.literal("saml_login") }).transform((v) => ({
+  components.PasswordRequiredResponse$outboundSchema.and(
+    z.object({ requires: z.literal("password") }).transform((v) => ({
       requires: v.requires,
     })),
   ),
@@ -182,8 +180,8 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
 > = z.union([
   components.User$inboundSchema,
   z.union([
-    components.PasswordRequiredResponse$inboundSchema.and(
-      z.object({ requires: z.literal("password") }).transform((v) => ({
+    components.SamlLoginRequiredResponse$inboundSchema.and(
+      z.object({ requires: z.literal("saml_login") }).transform((v) => ({
         requires: v.requires,
       })),
     ),
@@ -192,8 +190,8 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
         requires: v.requires,
       })),
     ),
-    components.SamlLoginRequiredResponse$inboundSchema.and(
-      z.object({ requires: z.literal("saml_login") }).transform((v) => ({
+    components.PasswordRequiredResponse$inboundSchema.and(
+      z.object({ requires: z.literal("password") }).transform((v) => ({
         requires: v.requires,
       })),
     ),
@@ -203,11 +201,9 @@ export const PostAuthenticateResponse$inboundSchema: z.ZodType<
 /** @internal */
 export type PostAuthenticateResponse$Outbound =
   | components.User$Outbound
-  | (components.PasswordRequiredResponse$Outbound & { requires: "password" })
+  | (components.SamlLoginRequiredResponse$Outbound & { requires: "saml_login" })
   | (components.MfaRequiredResponse$Outbound & { requires: "mfa_code" })
-  | (components.SamlLoginRequiredResponse$Outbound & {
-    requires: "saml_login";
-  });
+  | (components.PasswordRequiredResponse$Outbound & { requires: "password" });
 
 /** @internal */
 export const PostAuthenticateResponse$outboundSchema: z.ZodType<
@@ -217,8 +213,8 @@ export const PostAuthenticateResponse$outboundSchema: z.ZodType<
 > = z.union([
   components.User$outboundSchema,
   z.union([
-    components.PasswordRequiredResponse$outboundSchema.and(
-      z.object({ requires: z.literal("password") }).transform((v) => ({
+    components.SamlLoginRequiredResponse$outboundSchema.and(
+      z.object({ requires: z.literal("saml_login") }).transform((v) => ({
         requires: v.requires,
       })),
     ),
@@ -227,8 +223,8 @@ export const PostAuthenticateResponse$outboundSchema: z.ZodType<
         requires: v.requires,
       })),
     ),
-    components.SamlLoginRequiredResponse$outboundSchema.and(
-      z.object({ requires: z.literal("saml_login") }).transform((v) => ({
+    components.PasswordRequiredResponse$outboundSchema.and(
+      z.object({ requires: z.literal("password") }).transform((v) => ({
         requires: v.requires,
       })),
     ),

package/src/models/operations/securityzonecheckin.ts

@@ -63,7 +63,7 @@ export type One = {
   temperature?: number | undefined;
 };
 
-export type SecurityZoneCheckinRequestBody = Two | One;
+export type SecurityZoneCheckinRequestBody = One | Two;
 
 export const Requires = {
   CompleteCheckin: "complete_checkin",
@@ -356,12 +356,12 @@ export const SecurityZoneCheckinRequestBody$inboundSchema: z.ZodType<
   SecurityZoneCheckinRequestBody,
   z.ZodTypeDef,
   unknown
-> = z.union([z.lazy(() => Two$inboundSchema), z.lazy(() => One$inboundSchema)]);
+> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
 
 /** @internal */
 export type SecurityZoneCheckinRequestBody$Outbound =
-  | Two$Outbound
-  | One$Outbound;
+  | One$Outbound
+  | Two$Outbound;
 
 /** @internal */
 export const SecurityZoneCheckinRequestBody$outboundSchema: z.ZodType<
@@ -369,8 +369,8 @@ export const SecurityZoneCheckinRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SecurityZoneCheckinRequestBody
 > = z.union([
-  z.lazy(() => Two$outboundSchema),
   z.lazy(() => One$outboundSchema),
+  z.lazy(() => Two$outboundSchema),
 ]);
 
 /**

package/src/types/constdatetime.ts

@@ -11,5 +11,5 @@ export function constDateTime(
     return (
       typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
     );
-  }, `Value must be equivelant to ${val}`);
+  }, `Value must be equivalent to ${val}`);
 }