@apideck/unify 0.24.1 → 0.25.1

package/src/models/components/contact.ts

@@ -86,7 +86,7 @@ export type Contact = {
   /**
    * Full name of the contact.
    */
-  name: string | null;
+  name?: string | null | undefined;
   /**
    * The owner of the contact.
    */
@@ -225,7 +225,7 @@ export type ContactInput = {
   /**
    * Full name of the contact.
    */
-  name: string | null;
+  name?: string | null | undefined;
   /**
    * The owner of the contact.
    */
@@ -380,7 +380,7 @@ export namespace ContactGender$ {
 export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
   z.object({
     id: z.string().optional(),
-    name: z.nullable(z.string()),
+    name: z.nullable(z.string()).optional(),
     owner_id: z.nullable(z.string()).optional(),
     type: z.nullable(ContactType$inboundSchema).optional(),
     company_id: z.nullable(z.string()).optional(),
@@ -460,7 +460,7 @@ export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
 /** @internal */
 export type Contact$Outbound = {
   id?: string | undefined;
-  name: string | null;
+  name?: string | null | undefined;
   owner_id?: string | null | undefined;
   type?: string | null | undefined;
   company_id?: string | null | undefined;
@@ -509,7 +509,7 @@ export const Contact$outboundSchema: z.ZodType<
   Contact
 > = z.object({
   id: z.string().optional(),
-  name: z.nullable(z.string()),
+  name: z.nullable(z.string()).optional(),
   ownerId: z.nullable(z.string()).optional(),
   type: z.nullable(ContactType$outboundSchema).optional(),
   companyId: z.nullable(z.string()).optional(),
@@ -610,7 +610,7 @@ export const ContactInput$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  name: z.nullable(z.string()),
+  name: z.nullable(z.string()).optional(),
   owner_id: z.nullable(z.string()).optional(),
   type: z.nullable(ContactType$inboundSchema).optional(),
   company_id: z.nullable(z.string()).optional(),
@@ -667,7 +667,7 @@ export const ContactInput$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ContactInput$Outbound = {
-  name: string | null;
+  name?: string | null | undefined;
   owner_id?: string | null | undefined;
   type?: string | null | undefined;
   company_id?: string | null | undefined;
@@ -709,7 +709,7 @@ export const ContactInput$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ContactInput
 > = z.object({
-  name: z.nullable(z.string()),
+  name: z.nullable(z.string()).optional(),
   ownerId: z.nullable(z.string()).optional(),
   type: z.nullable(ContactType$outboundSchema).optional(),
   companyId: z.nullable(z.string()).optional(),

package/src/models/components/session.ts

@@ -31,7 +31,7 @@ export type AllowActions = ClosedEnum<typeof AllowActions>;
 /**
  * Settings to change the way the Vault is displayed.
  */
-export type SessionSettings = {
+export type Settings = {
   /**
    * Provide the IDs of the Unified APIs you want to be visible. Leaving it empty or omitting this field will show all Unified APIs.
    */
@@ -132,7 +132,7 @@ export type Session = {
   /**
    * Settings to change the way the Vault is displayed.
    */
-  settings?: SessionSettings | undefined;
+  settings?: Settings | undefined;
   /**
    * Theming options to change the look and feel of Vault.
    */
@@ -163,8 +163,8 @@ export namespace AllowActions$ {
 }
 
 /** @internal */
-export const SessionSettings$inboundSchema: z.ZodType<
-  SessionSettings,
+export const Settings$inboundSchema: z.ZodType<
+  Settings,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -196,7 +196,7 @@ export const SessionSettings$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type SessionSettings$Outbound = {
+export type Settings$Outbound = {
   unified_apis?: Array<string> | undefined;
   hide_resource_settings: boolean;
   sandbox_mode: boolean;
@@ -211,10 +211,10 @@ export type SessionSettings$Outbound = {
 };
 
 /** @internal */
-export const SessionSettings$outboundSchema: z.ZodType<
-  SessionSettings$Outbound,
+export const Settings$outboundSchema: z.ZodType<
+  Settings$Outbound,
   z.ZodTypeDef,
-  SessionSettings
+  Settings
 > = z.object({
   unifiedApis: z.array(UnifiedApiId$outboundSchema).optional(),
   hideResourceSettings: z.boolean().default(false),
@@ -247,28 +247,26 @@ export const SessionSettings$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace SessionSettings$ {
-  /** @deprecated use `SessionSettings$inboundSchema` instead. */
-  export const inboundSchema = SessionSettings$inboundSchema;
-  /** @deprecated use `SessionSettings$outboundSchema` instead. */
-  export const outboundSchema = SessionSettings$outboundSchema;
-  /** @deprecated use `SessionSettings$Outbound` instead. */
-  export type Outbound = SessionSettings$Outbound;
+export namespace Settings$ {
+  /** @deprecated use `Settings$inboundSchema` instead. */
+  export const inboundSchema = Settings$inboundSchema;
+  /** @deprecated use `Settings$outboundSchema` instead. */
+  export const outboundSchema = Settings$outboundSchema;
+  /** @deprecated use `Settings$Outbound` instead. */
+  export type Outbound = Settings$Outbound;
 }
 
-export function sessionSettingsToJSON(
-  sessionSettings: SessionSettings,
-): string {
-  return JSON.stringify(SessionSettings$outboundSchema.parse(sessionSettings));
+export function settingsToJSON(settings: Settings): string {
+  return JSON.stringify(Settings$outboundSchema.parse(settings));
 }
 
-export function sessionSettingsFromJSON(
+export function settingsFromJSON(
   jsonString: string,
-): SafeParseResult<SessionSettings, SDKValidationError> {
+): SafeParseResult<Settings, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => SessionSettings$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SessionSettings' from JSON`,
+    (x) => Settings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Settings' from JSON`,
   );
 }
 
@@ -363,7 +361,7 @@ export const Session$inboundSchema: z.ZodType<Session, z.ZodTypeDef, unknown> =
   z.object({
     consumer_metadata: ConsumerMetadata$inboundSchema.optional(),
     redirect_uri: z.string().optional(),
-    settings: z.lazy(() => SessionSettings$inboundSchema).optional(),
+    settings: z.lazy(() => Settings$inboundSchema).optional(),
     theme: z.lazy(() => Theme$inboundSchema).optional(),
     custom_consumer_settings: z.record(z.any()).optional(),
   }).transform((v) => {
@@ -378,7 +376,7 @@ export const Session$inboundSchema: z.ZodType<Session, z.ZodTypeDef, unknown> =
 export type Session$Outbound = {
   consumer_metadata?: ConsumerMetadata$Outbound | undefined;
   redirect_uri?: string | undefined;
-  settings?: SessionSettings$Outbound | undefined;
+  settings?: Settings$Outbound | undefined;
   theme?: Theme$Outbound | undefined;
   custom_consumer_settings?: { [k: string]: any } | undefined;
 };
@@ -391,7 +389,7 @@ export const Session$outboundSchema: z.ZodType<
 > = z.object({
   consumerMetadata: ConsumerMetadata$outboundSchema.optional(),
   redirectUri: z.string().optional(),
-  settings: z.lazy(() => SessionSettings$outboundSchema).optional(),
+  settings: z.lazy(() => Settings$outboundSchema).optional(),
   theme: z.lazy(() => Theme$outboundSchema).optional(),
   customConsumerSettings: z.record(z.any()).optional(),
 }).transform((v) => {

package/src/models/errors/apideckerror.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class ApideckError extends Error {
+  /** HTTP meta data */
+  public readonly httpMeta: {
+    response: Response;
+    request: Request;
+    body: string;
+  };
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.httpMeta = httpMeta;
+
+    this.name = "ApideckError";
+  }
+}

package/src/models/errors/apierror.ts

@@ -2,20 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class APIError extends Error {
+import { ApideckError } from "./apideckerror.js";
+
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends ApideckError {
   constructor(
     message: string,
-    public readonly httpMeta: {
+    httpMeta: {
       response: Response;
       request: Request;
+      body: string;
     },
   ) {
-    super(
-      `${message}: Status ${httpMeta.response.status} Content-Type ${
-        httpMeta.response.headers.get("content-type") || ""
-      }`,
-    );
-
+    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/badrequestresponse.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApideckError } from "./apideckerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -46,7 +47,7 @@ export type BadRequestResponseData = {
 /**
  * Bad Request
  */
-export class BadRequestResponse extends Error {
+export class BadRequestResponse extends ApideckError {
   /**
    * HTTP status code
    */
@@ -71,11 +72,13 @@ export class BadRequestResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: BadRequestResponseData;
 
-  constructor(err: BadRequestResponseData) {
+  constructor(
+    err: BadRequestResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.statusCode != null) this.statusCode = err.statusCode;
     if (err.error != null) this.error = err.error;
     if (err.typeName != null) this.typeName = err.typeName;
@@ -139,6 +142,9 @@ export const BadRequestResponse$inboundSchema: z.ZodType<
   message: z.string().optional(),
   detail: z.union([z.string(), z.record(z.any())]).optional(),
   ref: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
     const remapped = remap$(v, {
@@ -146,7 +152,11 @@ export const BadRequestResponse$inboundSchema: z.ZodType<
       "type_name": "typeName",
     });
 
-    return new BadRequestResponse(remapped);
+    return new BadRequestResponse(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -7,6 +7,7 @@ export * from "./badrequestresponse.js";
 export * from "./httpclienterrors.js";
 export * from "./notfoundresponse.js";
 export * from "./paymentrequiredresponse.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unauthorizedresponse.js";
 export * from "./unprocessableresponse.js";

package/src/models/errors/notfoundresponse.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApideckError } from "./apideckerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -46,7 +47,7 @@ export type NotFoundResponseData = {
 /**
  * The specified resource was not found
  */
-export class NotFoundResponse extends Error {
+export class NotFoundResponse extends ApideckError {
   /**
    * HTTP status code
    */
@@ -71,11 +72,13 @@ export class NotFoundResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: NotFoundResponseData;
 
-  constructor(err: NotFoundResponseData) {
+  constructor(
+    err: NotFoundResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.statusCode != null) this.statusCode = err.statusCode;
     if (err.error != null) this.error = err.error;
     if (err.typeName != null) this.typeName = err.typeName;
@@ -146,6 +149,9 @@ export const NotFoundResponse$inboundSchema: z.ZodType<
   message: z.string().optional(),
   detail: z.union([z.string(), z.record(z.any())]).optional(),
   ref: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
     const remapped = remap$(v, {
@@ -153,7 +159,11 @@ export const NotFoundResponse$inboundSchema: z.ZodType<
       "type_name": "typeName",
     });
 
-    return new NotFoundResponse(remapped);
+    return new NotFoundResponse(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/paymentrequiredresponse.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
+import { ApideckError } from "./apideckerror.js";
 
 /**
  * Payment Required
@@ -38,7 +39,7 @@ export type PaymentRequiredResponseData = {
 /**
  * Payment Required
  */
-export class PaymentRequiredResponse extends Error {
+export class PaymentRequiredResponse extends ApideckError {
   /**
    * HTTP status code
    */
@@ -63,11 +64,13 @@ export class PaymentRequiredResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: PaymentRequiredResponseData;
 
-  constructor(err: PaymentRequiredResponseData) {
+  constructor(
+    err: PaymentRequiredResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.statusCode != null) this.statusCode = err.statusCode;
     if (err.error != null) this.error = err.error;
     if (err.typeName != null) this.typeName = err.typeName;
@@ -90,6 +93,9 @@ export const PaymentRequiredResponse$inboundSchema: z.ZodType<
   message: z.string().optional(),
   detail: z.string().optional(),
   ref: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
     const remapped = remap$(v, {
@@ -97,7 +103,11 @@ export const PaymentRequiredResponse$inboundSchema: z.ZodType<
       "type_name": "typeName",
     });
 
-    return new PaymentRequiredResponse(remapped);
+    return new PaymentRequiredResponse(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

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 { ApideckError } from "./apideckerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends ApideckError {
+  /**
+   * 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/errors/unauthorizedresponse.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApideckError } from "./apideckerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -46,7 +47,7 @@ export type UnauthorizedResponseData = {
 /**
  * Unauthorized
  */
-export class UnauthorizedResponse extends Error {
+export class UnauthorizedResponse extends ApideckError {
   /**
    * HTTP status code
    */
@@ -71,11 +72,13 @@ export class UnauthorizedResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: UnauthorizedResponseData;
 
-  constructor(err: UnauthorizedResponseData) {
+  constructor(
+    err: UnauthorizedResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.statusCode != null) this.statusCode = err.statusCode;
     if (err.error != null) this.error = err.error;
     if (err.typeName != null) this.typeName = err.typeName;
@@ -146,6 +149,9 @@ export const UnauthorizedResponse$inboundSchema: z.ZodType<
   message: z.string().optional(),
   detail: z.union([z.string(), z.record(z.any())]).optional(),
   ref: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
     const remapped = remap$(v, {
@@ -153,7 +159,11 @@ export const UnauthorizedResponse$inboundSchema: z.ZodType<
       "type_name": "typeName",
     });
 
-    return new UnauthorizedResponse(remapped);
+    return new UnauthorizedResponse(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/unprocessableresponse.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApideckError } from "./apideckerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 /**
@@ -46,7 +47,7 @@ export type UnprocessableResponseData = {
 /**
  * Unprocessable
  */
-export class UnprocessableResponse extends Error {
+export class UnprocessableResponse extends ApideckError {
   /**
    * HTTP status code
    */
@@ -71,11 +72,13 @@ export class UnprocessableResponse extends Error {
   /** The original data that was passed to this error instance. */
   data$: UnprocessableResponseData;
 
-  constructor(err: UnprocessableResponseData) {
+  constructor(
+    err: UnprocessableResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.statusCode != null) this.statusCode = err.statusCode;
     if (err.error != null) this.error = err.error;
     if (err.typeName != null) this.typeName = err.typeName;
@@ -150,6 +153,9 @@ export const UnprocessableResponse$inboundSchema: z.ZodType<
   message: z.string().optional(),
   detail: z.union([z.string(), z.record(z.any())]).optional(),
   ref: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
     const remapped = remap$(v, {
@@ -157,7 +163,11 @@ export const UnprocessableResponse$inboundSchema: z.ZodType<
       "type_name": "typeName",
     });
 
-    return new UnprocessableResponse(remapped);
+    return new UnprocessableResponse(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */