@gr4vy/sdk 1.0.0-beta.8 → 1.0.0

package/src/models/errors/error504.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type Error504Data = {
   /**
@@ -25,7 +26,7 @@ export type Error504Data = {
   details?: Array<components.ErrorDetail> | undefined;
 };
 
-export class Error504 extends Error {
+export class Error504 extends Gr4vyError {
   /**
    * Always `error`.
    */
@@ -43,13 +44,15 @@ export class Error504 extends Error {
   /** The original data that was passed to this error instance. */
   data$: Error504Data;
 
-  constructor(err: Error504Data) {
+  constructor(
+    err: Error504Data,
+    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;
-
     if (err.type != null) this.type = err.type;
     if (err.code != null) this.code = err.code;
     if (err.status != null) this.status = err.status;
@@ -70,9 +73,16 @@ export const Error504$inboundSchema: z.ZodType<
   status: z.number().int().default(504),
   message: z.string().default("Request could not be processed"),
   details: z.array(components.ErrorDetail$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Error504(v);
+    return new Error504(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/gr4vyerror.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 Gr4vyError 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 = "Gr4vyError";
+  }
+}

package/src/models/errors/httpvalidationerror.ts

@@ -4,24 +4,27 @@
 
 import * as z from "zod";
 import * as components from "../components/index.js";
+import { Gr4vyError } from "./gr4vyerror.js";
 
 export type HTTPValidationErrorData = {
   detail?: Array<components.ValidationError> | undefined;
 };
 
-export class HTTPValidationError extends Error {
+export class HTTPValidationError extends Gr4vyError {
   detail?: Array<components.ValidationError> | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: HTTPValidationErrorData;
 
-  constructor(err: HTTPValidationErrorData) {
+  constructor(
+    err: HTTPValidationErrorData,
+    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;
-
     if (err.detail != null) this.detail = err.detail;
 
     this.name = "HTTPValidationError";
@@ -35,9 +38,16 @@ export const HTTPValidationError$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   detail: z.array(components.ValidationError$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new HTTPValidationError(v);
+    return new HTTPValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/index.ts

@@ -15,5 +15,6 @@ export * from "./error502.js";
 export * from "./error504.js";
 export * from "./httpclienterrors.js";
 export * from "./httpvalidationerror.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkerror.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 { Gr4vyError } from "./gr4vyerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends Gr4vyError {
+  /**
+   * 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/sdkerror.ts

@@ -2,26 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class SDKError extends Error {
-  public readonly statusCode: number;
-  public readonly contentType: string;
+import { Gr4vyError } from "./gr4vyerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class SDKError extends Gr4vyError {
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly 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.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 = "SDKError";
   }
 }

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/addbuyer.ts

@@ -14,7 +14,6 @@ export type AddBuyerGlobals = {
 };
 
 export type AddBuyerRequest = {
-  timeoutInSeconds?: number | undefined;
   /**
    * The ID of the merchant account to use for this request.
    */
@@ -80,19 +79,16 @@ export const AddBuyerRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  timeout_in_seconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   BuyerCreate: components.BuyerCreate$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
-    "timeout_in_seconds": "timeoutInSeconds",
     "BuyerCreate": "buyerCreate",
   });
 });
 
 /** @internal */
 export type AddBuyerRequest$Outbound = {
-  timeout_in_seconds: number;
   merchantAccountId?: string | null | undefined;
   BuyerCreate: components.BuyerCreate$Outbound;
 };
@@ -103,12 +99,10 @@ export const AddBuyerRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AddBuyerRequest
 > = z.object({
-  timeoutInSeconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   buyerCreate: components.BuyerCreate$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
-    timeoutInSeconds: "timeout_in_seconds",
     buyerCreate: "BuyerCreate",
   });
 });

package/src/models/operations/addbuyershippingdetails.ts

@@ -18,7 +18,6 @@ export type AddBuyerShippingDetailsRequest = {
    * The ID of the buyer to add shipping details to.
    */
   buyerId: string;
-  timeoutInSeconds?: number | undefined;
   /**
    * The ID of the merchant account to use for this request.
    */
@@ -89,13 +88,11 @@ export const AddBuyerShippingDetailsRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   buyer_id: z.string(),
-  timeout_in_seconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   ShippingDetailsCreate: components.ShippingDetailsCreate$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "buyer_id": "buyerId",
-    "timeout_in_seconds": "timeoutInSeconds",
     "ShippingDetailsCreate": "shippingDetailsCreate",
   });
 });
@@ -103,7 +100,6 @@ export const AddBuyerShippingDetailsRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type AddBuyerShippingDetailsRequest$Outbound = {
   buyer_id: string;
-  timeout_in_seconds: number;
   merchantAccountId?: string | null | undefined;
   ShippingDetailsCreate: components.ShippingDetailsCreate$Outbound;
 };
@@ -115,13 +111,11 @@ export const AddBuyerShippingDetailsRequest$outboundSchema: z.ZodType<
   AddBuyerShippingDetailsRequest
 > = z.object({
   buyerId: z.string(),
-  timeoutInSeconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   shippingDetailsCreate: components.ShippingDetailsCreate$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     buyerId: "buyer_id",
-    timeoutInSeconds: "timeout_in_seconds",
     shippingDetailsCreate: "ShippingDetailsCreate",
   });
 });

package/src/models/operations/addpaymentlink.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AddPaymentLinkGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type AddPaymentLinkRequest = {
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+  paymentLinkCreate: components.PaymentLinkCreate;
+};
+
+/** @internal */
+export const AddPaymentLinkGlobals$inboundSchema: z.ZodType<
+  AddPaymentLinkGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/** @internal */
+export type AddPaymentLinkGlobals$Outbound = {
+  merchantAccountId?: string | undefined;
+};
+
+/** @internal */
+export const AddPaymentLinkGlobals$outboundSchema: z.ZodType<
+  AddPaymentLinkGlobals$Outbound,
+  z.ZodTypeDef,
+  AddPaymentLinkGlobals
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AddPaymentLinkGlobals$ {
+  /** @deprecated use `AddPaymentLinkGlobals$inboundSchema` instead. */
+  export const inboundSchema = AddPaymentLinkGlobals$inboundSchema;
+  /** @deprecated use `AddPaymentLinkGlobals$outboundSchema` instead. */
+  export const outboundSchema = AddPaymentLinkGlobals$outboundSchema;
+  /** @deprecated use `AddPaymentLinkGlobals$Outbound` instead. */
+  export type Outbound = AddPaymentLinkGlobals$Outbound;
+}
+
+export function addPaymentLinkGlobalsToJSON(
+  addPaymentLinkGlobals: AddPaymentLinkGlobals,
+): string {
+  return JSON.stringify(
+    AddPaymentLinkGlobals$outboundSchema.parse(addPaymentLinkGlobals),
+  );
+}
+
+export function addPaymentLinkGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<AddPaymentLinkGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddPaymentLinkGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddPaymentLinkGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const AddPaymentLinkRequest$inboundSchema: z.ZodType<
+  AddPaymentLinkRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantAccountId: z.nullable(z.string()).optional(),
+  PaymentLinkCreate: components.PaymentLinkCreate$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "PaymentLinkCreate": "paymentLinkCreate",
+  });
+});
+
+/** @internal */
+export type AddPaymentLinkRequest$Outbound = {
+  merchantAccountId?: string | null | undefined;
+  PaymentLinkCreate: components.PaymentLinkCreate$Outbound;
+};
+
+/** @internal */
+export const AddPaymentLinkRequest$outboundSchema: z.ZodType<
+  AddPaymentLinkRequest$Outbound,
+  z.ZodTypeDef,
+  AddPaymentLinkRequest
+> = z.object({
+  merchantAccountId: z.nullable(z.string()).optional(),
+  paymentLinkCreate: components.PaymentLinkCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    paymentLinkCreate: "PaymentLinkCreate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AddPaymentLinkRequest$ {
+  /** @deprecated use `AddPaymentLinkRequest$inboundSchema` instead. */
+  export const inboundSchema = AddPaymentLinkRequest$inboundSchema;
+  /** @deprecated use `AddPaymentLinkRequest$outboundSchema` instead. */
+  export const outboundSchema = AddPaymentLinkRequest$outboundSchema;
+  /** @deprecated use `AddPaymentLinkRequest$Outbound` instead. */
+  export type Outbound = AddPaymentLinkRequest$Outbound;
+}
+
+export function addPaymentLinkRequestToJSON(
+  addPaymentLinkRequest: AddPaymentLinkRequest,
+): string {
+  return JSON.stringify(
+    AddPaymentLinkRequest$outboundSchema.parse(addPaymentLinkRequest),
+  );
+}
+
+export function addPaymentLinkRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AddPaymentLinkRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddPaymentLinkRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddPaymentLinkRequest' from JSON`,
+  );
+}

package/src/models/operations/addreport.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AddReportGlobals = {
+  merchantAccountId?: string | undefined;
+};
+
+export type AddReportRequest = {
+  /**
+   * The ID of the merchant account to use for this request.
+   */
+  merchantAccountId?: string | null | undefined;
+  reportCreate: components.ReportCreate;
+};
+
+/** @internal */
+export const AddReportGlobals$inboundSchema: z.ZodType<
+  AddReportGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/** @internal */
+export type AddReportGlobals$Outbound = {
+  merchantAccountId?: string | undefined;
+};
+
+/** @internal */
+export const AddReportGlobals$outboundSchema: z.ZodType<
+  AddReportGlobals$Outbound,
+  z.ZodTypeDef,
+  AddReportGlobals
+> = z.object({
+  merchantAccountId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AddReportGlobals$ {
+  /** @deprecated use `AddReportGlobals$inboundSchema` instead. */
+  export const inboundSchema = AddReportGlobals$inboundSchema;
+  /** @deprecated use `AddReportGlobals$outboundSchema` instead. */
+  export const outboundSchema = AddReportGlobals$outboundSchema;
+  /** @deprecated use `AddReportGlobals$Outbound` instead. */
+  export type Outbound = AddReportGlobals$Outbound;
+}
+
+export function addReportGlobalsToJSON(
+  addReportGlobals: AddReportGlobals,
+): string {
+  return JSON.stringify(
+    AddReportGlobals$outboundSchema.parse(addReportGlobals),
+  );
+}
+
+export function addReportGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<AddReportGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddReportGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddReportGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const AddReportRequest$inboundSchema: z.ZodType<
+  AddReportRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantAccountId: z.nullable(z.string()).optional(),
+  ReportCreate: components.ReportCreate$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "ReportCreate": "reportCreate",
+  });
+});
+
+/** @internal */
+export type AddReportRequest$Outbound = {
+  merchantAccountId?: string | null | undefined;
+  ReportCreate: components.ReportCreate$Outbound;
+};
+
+/** @internal */
+export const AddReportRequest$outboundSchema: z.ZodType<
+  AddReportRequest$Outbound,
+  z.ZodTypeDef,
+  AddReportRequest
+> = z.object({
+  merchantAccountId: z.nullable(z.string()).optional(),
+  reportCreate: components.ReportCreate$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    reportCreate: "ReportCreate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AddReportRequest$ {
+  /** @deprecated use `AddReportRequest$inboundSchema` instead. */
+  export const inboundSchema = AddReportRequest$inboundSchema;
+  /** @deprecated use `AddReportRequest$outboundSchema` instead. */
+  export const outboundSchema = AddReportRequest$outboundSchema;
+  /** @deprecated use `AddReportRequest$Outbound` instead. */
+  export type Outbound = AddReportRequest$Outbound;
+}
+
+export function addReportRequestToJSON(
+  addReportRequest: AddReportRequest,
+): string {
+  return JSON.stringify(
+    AddReportRequest$outboundSchema.parse(addReportRequest),
+  );
+}
+
+export function addReportRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<AddReportRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddReportRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddReportRequest' from JSON`,
+  );
+}

package/src/models/operations/capturetransaction.ts

@@ -14,8 +14,10 @@ export type CaptureTransactionGlobals = {
 };
 
 export type CaptureTransactionRequest = {
+  /**
+   * The ID of the transaction
+   */
   transactionId: string;
-  timeoutInSeconds?: number | undefined;
   /**
    * The ID of the merchant account to use for this request.
    */
@@ -84,13 +86,11 @@ export const CaptureTransactionRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   transaction_id: z.string(),
-  timeout_in_seconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   TransactionCapture: components.TransactionCapture$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "transaction_id": "transactionId",
-    "timeout_in_seconds": "timeoutInSeconds",
     "TransactionCapture": "transactionCapture",
   });
 });
@@ -98,7 +98,6 @@ export const CaptureTransactionRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type CaptureTransactionRequest$Outbound = {
   transaction_id: string;
-  timeout_in_seconds: number;
   merchantAccountId?: string | null | undefined;
   TransactionCapture: components.TransactionCapture$Outbound;
 };
@@ -110,13 +109,11 @@ export const CaptureTransactionRequest$outboundSchema: z.ZodType<
   CaptureTransactionRequest
 > = z.object({
   transactionId: z.string(),
-  timeoutInSeconds: z.number().default(1),
   merchantAccountId: z.nullable(z.string()).optional(),
   transactionCapture: components.TransactionCapture$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     transactionId: "transaction_id",
-    timeoutInSeconds: "timeout_in_seconds",
     transactionCapture: "TransactionCapture",
   });
 });