@gr4vy/sdk 0.17.2

package/src/models/components/payoutsummary.ts

@@ -0,0 +1,216 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PayoutCategory,
+  PayoutCategory$inboundSchema,
+  PayoutCategory$outboundSchema,
+} from "./payoutcategory.js";
+import {
+  PayoutMerchantSummary,
+  PayoutMerchantSummary$inboundSchema,
+  PayoutMerchantSummary$Outbound,
+  PayoutMerchantSummary$outboundSchema,
+} from "./payoutmerchantsummary.js";
+import {
+  PayoutPaymentService,
+  PayoutPaymentService$inboundSchema,
+  PayoutPaymentService$Outbound,
+  PayoutPaymentService$outboundSchema,
+} from "./payoutpaymentservice.js";
+import {
+  PayoutStatus,
+  PayoutStatus$inboundSchema,
+  PayoutStatus$outboundSchema,
+} from "./payoutstatus.js";
+import {
+  TransactionBuyer,
+  TransactionBuyer$inboundSchema,
+  TransactionBuyer$Outbound,
+  TransactionBuyer$outboundSchema,
+} from "./transactionbuyer.js";
+import {
+  TransactionPaymentMethod,
+  TransactionPaymentMethod$inboundSchema,
+  TransactionPaymentMethod$Outbound,
+  TransactionPaymentMethod$outboundSchema,
+} from "./transactionpaymentmethod.js";
+
+/**
+ * PayoutSummary
+ *
+ * @remarks
+ *
+ * Represents a summary of a payout.
+ */
+export type PayoutSummary = {
+  /**
+   * Always `payout`.
+   */
+  type?: "payout" | undefined;
+  /**
+   * The ID for the payout.
+   */
+  id?: string | null | undefined;
+  /**
+   * The monetary amount for this payout, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for $12.99.
+   */
+  amount: number;
+  /**
+   * The buyer used for this payout.
+   */
+  buyer?: TransactionBuyer | null | undefined;
+  /**
+   * The type of payout to process.
+   */
+  category?: PayoutCategory | null | undefined;
+  /**
+   * The date this payout was created at.
+   */
+  createdAt: Date;
+  /**
+   * A supported ISO-4217 currency code.
+   */
+  currency: string;
+  /**
+   * The merchant identifier for this payout.
+   */
+  externalIdentifier?: string | null | undefined;
+  /**
+   * The merchant details associated to this payout.
+   */
+  merchant?: PayoutMerchantSummary | null | undefined;
+  /**
+   * The ID of the merchant account this payout was created for.
+   */
+  merchantAccountId?: string | null | undefined;
+  paymentMethod: TransactionPaymentMethod;
+  paymentService: PayoutPaymentService;
+  /**
+   * The ID of the payout in the underlying payment service.
+   */
+  paymentServicePayoutId?: string | null | undefined;
+  status: PayoutStatus;
+  /**
+   * The date this payout was last updated at.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const PayoutSummary$inboundSchema: z.ZodType<
+  PayoutSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("payout").default("payout"),
+  id: z.nullable(z.string()).optional(),
+  amount: z.number().int(),
+  buyer: z.nullable(TransactionBuyer$inboundSchema).optional(),
+  category: z.nullable(PayoutCategory$inboundSchema).optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  currency: z.string(),
+  external_identifier: z.nullable(z.string()).optional(),
+  merchant: z.nullable(PayoutMerchantSummary$inboundSchema).optional(),
+  merchant_account_id: z.nullable(z.string()).optional(),
+  payment_method: TransactionPaymentMethod$inboundSchema,
+  payment_service: PayoutPaymentService$inboundSchema,
+  payment_service_payout_id: z.nullable(z.string()).optional(),
+  status: PayoutStatus$inboundSchema,
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "external_identifier": "externalIdentifier",
+    "merchant_account_id": "merchantAccountId",
+    "payment_method": "paymentMethod",
+    "payment_service": "paymentService",
+    "payment_service_payout_id": "paymentServicePayoutId",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type PayoutSummary$Outbound = {
+  type: "payout";
+  id?: string | null | undefined;
+  amount: number;
+  buyer?: TransactionBuyer$Outbound | null | undefined;
+  category?: string | null | undefined;
+  created_at: string;
+  currency: string;
+  external_identifier?: string | null | undefined;
+  merchant?: PayoutMerchantSummary$Outbound | null | undefined;
+  merchant_account_id?: string | null | undefined;
+  payment_method: TransactionPaymentMethod$Outbound;
+  payment_service: PayoutPaymentService$Outbound;
+  payment_service_payout_id?: string | null | undefined;
+  status: string;
+  updated_at: string;
+};
+
+/** @internal */
+export const PayoutSummary$outboundSchema: z.ZodType<
+  PayoutSummary$Outbound,
+  z.ZodTypeDef,
+  PayoutSummary
+> = z.object({
+  type: z.literal("payout").default("payout" as const),
+  id: z.nullable(z.string()).optional(),
+  amount: z.number().int(),
+  buyer: z.nullable(TransactionBuyer$outboundSchema).optional(),
+  category: z.nullable(PayoutCategory$outboundSchema).optional(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  currency: z.string(),
+  externalIdentifier: z.nullable(z.string()).optional(),
+  merchant: z.nullable(PayoutMerchantSummary$outboundSchema).optional(),
+  merchantAccountId: z.nullable(z.string()).optional(),
+  paymentMethod: TransactionPaymentMethod$outboundSchema,
+  paymentService: PayoutPaymentService$outboundSchema,
+  paymentServicePayoutId: z.nullable(z.string()).optional(),
+  status: PayoutStatus$outboundSchema,
+  updatedAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    externalIdentifier: "external_identifier",
+    merchantAccountId: "merchant_account_id",
+    paymentMethod: "payment_method",
+    paymentService: "payment_service",
+    paymentServicePayoutId: "payment_service_payout_id",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayoutSummary$ {
+  /** @deprecated use `PayoutSummary$inboundSchema` instead. */
+  export const inboundSchema = PayoutSummary$inboundSchema;
+  /** @deprecated use `PayoutSummary$outboundSchema` instead. */
+  export const outboundSchema = PayoutSummary$outboundSchema;
+  /** @deprecated use `PayoutSummary$Outbound` instead. */
+  export type Outbound = PayoutSummary$Outbound;
+}
+
+export function payoutSummaryToJSON(payoutSummary: PayoutSummary): string {
+  return JSON.stringify(PayoutSummary$outboundSchema.parse(payoutSummary));
+}
+
+export function payoutSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PayoutSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PayoutSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PayoutSummary' from JSON`,
+  );
+}

package/src/models/components/producttype.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+
+export const ProductType = {
+  Physical: "physical",
+  Discount: "discount",
+  ShippingFee: "shipping_fee",
+  SalesTax: "sales_tax",
+  Digital: "digital",
+  GiftCard: "gift_card",
+  StoreCredit: "store_credit",
+  Surcharge: "surcharge",
+} as const;
+export type ProductType = OpenEnum<typeof ProductType>;
+
+/** @internal */
+export const ProductType$inboundSchema: z.ZodType<
+  ProductType,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(ProductType),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const ProductType$outboundSchema: z.ZodType<
+  ProductType,
+  z.ZodTypeDef,
+  ProductType
+> = z.union([
+  z.nativeEnum(ProductType),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductType$ {
+  /** @deprecated use `ProductType$inboundSchema` instead. */
+  export const inboundSchema = ProductType$inboundSchema;
+  /** @deprecated use `ProductType$outboundSchema` instead. */
+  export const outboundSchema = ProductType$outboundSchema;
+}

package/src/models/components/recipient.ts

@@ -0,0 +1,120 @@
+/*
+ * 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 { RFCDate } from "../../types/rfcdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Address,
+  Address$inboundSchema,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
+
+/**
+ * Recipient of an account funding transaction
+ */
+export type Recipient = {
+  /**
+   * The first name of the recipient.
+   */
+  firstName: string;
+  /**
+   * The last name of the recipient.
+   */
+  lastName: string;
+  /**
+   * The recipient of the fund's address.
+   */
+  address?: Address | null | undefined;
+  /**
+   * The account number of the recipient. Depending on the type of funds transfer, this could be a wallet ID, bank accoutn number, or email address.
+   */
+  accountNumber?: string | null | undefined;
+  /**
+   * The date of birth of the recipient.
+   */
+  dateOfBirth?: RFCDate | null | undefined;
+};
+
+/** @internal */
+export const Recipient$inboundSchema: z.ZodType<
+  Recipient,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  first_name: z.string(),
+  last_name: z.string(),
+  address: z.nullable(Address$inboundSchema).optional(),
+  account_number: z.nullable(z.string()).optional(),
+  date_of_birth: z.nullable(z.string().transform(v => new RFCDate(v)))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "account_number": "accountNumber",
+    "date_of_birth": "dateOfBirth",
+  });
+});
+
+/** @internal */
+export type Recipient$Outbound = {
+  first_name: string;
+  last_name: string;
+  address?: Address$Outbound | null | undefined;
+  account_number?: string | null | undefined;
+  date_of_birth?: string | null | undefined;
+};
+
+/** @internal */
+export const Recipient$outboundSchema: z.ZodType<
+  Recipient$Outbound,
+  z.ZodTypeDef,
+  Recipient
+> = z.object({
+  firstName: z.string(),
+  lastName: z.string(),
+  address: z.nullable(Address$outboundSchema).optional(),
+  accountNumber: z.nullable(z.string()).optional(),
+  dateOfBirth: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+    accountNumber: "account_number",
+    dateOfBirth: "date_of_birth",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Recipient$ {
+  /** @deprecated use `Recipient$inboundSchema` instead. */
+  export const inboundSchema = Recipient$inboundSchema;
+  /** @deprecated use `Recipient$outboundSchema` instead. */
+  export const outboundSchema = Recipient$outboundSchema;
+  /** @deprecated use `Recipient$Outbound` instead. */
+  export type Outbound = Recipient$Outbound;
+}
+
+export function recipientToJSON(recipient: Recipient): string {
+  return JSON.stringify(Recipient$outboundSchema.parse(recipient));
+}
+
+export function recipientFromJSON(
+  jsonString: string,
+): SafeParseResult<Recipient, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Recipient$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Recipient' from JSON`,
+  );
+}

package/src/models/components/redirectpaymentmethodcreate.ts

@@ -0,0 +1,273 @@
+/*
+ * 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 {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The method to use, this can be any of the methods that support redirect requests.
+ */
+export const RedirectPaymentMethodCreateMethod = {
+  Abitab: "abitab",
+  Affirm: "affirm",
+  Afterpay: "afterpay",
+  Alipay: "alipay",
+  Alipayhk: "alipayhk",
+  Arcuspaynetwork: "arcuspaynetwork",
+  Bacs: "bacs",
+  Bancontact: "bancontact",
+  Banked: "banked",
+  Bcp: "bcp",
+  Becs: "becs",
+  Bitpay: "bitpay",
+  Boleto: "boleto",
+  Boost: "boost",
+  Cashapp: "cashapp",
+  Clearpay: "clearpay",
+  Dana: "dana",
+  Dcb: "dcb",
+  Dlocal: "dlocal",
+  Ebanx: "ebanx",
+  Efecty: "efecty",
+  Eps: "eps",
+  Everydaypay: "everydaypay",
+  Gcash: "gcash",
+  Gem: "gem",
+  Gemds: "gemds",
+  Giropay: "giropay",
+  Givingblock: "givingblock",
+  Gocardless: "gocardless",
+  Gopay: "gopay",
+  Grabpay: "grabpay",
+  Ideal: "ideal",
+  Kakaopay: "kakaopay",
+  Kcp: "kcp",
+  Khipu: "khipu",
+  Klarna: "klarna",
+  Latitude: "latitude",
+  Latitudeds: "latitudeds",
+  Laybuy: "laybuy",
+  Linepay: "linepay",
+  Linkaja: "linkaja",
+  Maybankqrpay: "maybankqrpay",
+  Mercadopago: "mercadopago",
+  Multibanco: "multibanco",
+  Multipago: "multipago",
+  Netbanking: "netbanking",
+  Nupay: "nupay",
+  Nequi: "nequi",
+  Oney10x: "oney_10x",
+  Oney12x: "oney_12x",
+  Oney3x: "oney_3x",
+  Oney4x: "oney_4x",
+  Oney6x: "oney_6x",
+  Ovo: "ovo",
+  Oxxo: "oxxo",
+  Pagoefectivo: "pagoefectivo",
+  Payid: "payid",
+  Paymaya: "paymaya",
+  Paypal: "paypal",
+  Paypalpaylater: "paypalpaylater",
+  Payto: "payto",
+  Payvalida: "payvalida",
+  Picpay: "picpay",
+  Pix: "pix",
+  Pse: "pse",
+  Rabbitlinepay: "rabbitlinepay",
+  Rapipago: "rapipago",
+  Razorpay: "razorpay",
+  Redpagos: "redpagos",
+  Scalapay: "scalapay",
+  Sepa: "sepa",
+  Servipag: "servipag",
+  Shopeepay: "shopeepay",
+  Singteldash: "singteldash",
+  Smartpay: "smartpay",
+  Sofort: "sofort",
+  Spei: "spei",
+  Stitch: "stitch",
+  Stripedd: "stripedd",
+  Thaiqr: "thaiqr",
+  Touchngo: "touchngo",
+  Truemoney: "truemoney",
+  Trustly: "trustly",
+  Trustlyeurope: "trustlyeurope",
+  Upi: "upi",
+  Venmo: "venmo",
+  Vipps: "vipps",
+  Waave: "waave",
+  Webpay: "webpay",
+  Wechat: "wechat",
+  Yape: "yape",
+  Zippay: "zippay",
+} as const;
+/**
+ * The method to use, this can be any of the methods that support redirect requests.
+ */
+export type RedirectPaymentMethodCreateMethod = OpenEnum<
+  typeof RedirectPaymentMethodCreateMethod
+>;
+
+/**
+ * Create a transaction for an APM/LPM that requires a redirect.
+ */
+export type RedirectPaymentMethodCreate = {
+  /**
+   * The method to use, this can be any of the methods that support redirect requests.
+   */
+  method: RedirectPaymentMethodCreateMethod;
+  /**
+   * The `id` of a stored buyer to use Use this instead of the `buyer_external_identifier`.
+   */
+  buyerId?: string | null | undefined;
+  /**
+   * The `external_identifier` of a stored buyer to use. Use this instead of the `buyer_id`.
+   */
+  buyerExternalIdentifier?: string | null | undefined;
+  /**
+   * The 2-letter ISO code of the country to use this payment method for. This is used to select the payment service to use.
+   */
+  country: string;
+  /**
+   * The ISO-4217 currency code to use this payment method for. This is used to select the payment service to use.
+   */
+  currency: string;
+  /**
+   * The redirect URL to redirect a buyer to after they have authorized the payment method.
+   */
+  redirectUrl: string;
+  /**
+   * The merchant identifier for this payment method.
+   */
+  externalIdentifier?: string | null | undefined;
+};
+
+/** @internal */
+export const RedirectPaymentMethodCreateMethod$inboundSchema: z.ZodType<
+  RedirectPaymentMethodCreateMethod,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(RedirectPaymentMethodCreateMethod),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const RedirectPaymentMethodCreateMethod$outboundSchema: z.ZodType<
+  RedirectPaymentMethodCreateMethod,
+  z.ZodTypeDef,
+  RedirectPaymentMethodCreateMethod
+> = z.union([
+  z.nativeEnum(RedirectPaymentMethodCreateMethod),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RedirectPaymentMethodCreateMethod$ {
+  /** @deprecated use `RedirectPaymentMethodCreateMethod$inboundSchema` instead. */
+  export const inboundSchema = RedirectPaymentMethodCreateMethod$inboundSchema;
+  /** @deprecated use `RedirectPaymentMethodCreateMethod$outboundSchema` instead. */
+  export const outboundSchema =
+    RedirectPaymentMethodCreateMethod$outboundSchema;
+}
+
+/** @internal */
+export const RedirectPaymentMethodCreate$inboundSchema: z.ZodType<
+  RedirectPaymentMethodCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  method: RedirectPaymentMethodCreateMethod$inboundSchema,
+  buyer_id: z.nullable(z.string()).optional(),
+  buyer_external_identifier: z.nullable(z.string()).optional(),
+  country: z.string(),
+  currency: z.string(),
+  redirect_url: z.string(),
+  external_identifier: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "buyer_id": "buyerId",
+    "buyer_external_identifier": "buyerExternalIdentifier",
+    "redirect_url": "redirectUrl",
+    "external_identifier": "externalIdentifier",
+  });
+});
+
+/** @internal */
+export type RedirectPaymentMethodCreate$Outbound = {
+  method: string;
+  buyer_id?: string | null | undefined;
+  buyer_external_identifier?: string | null | undefined;
+  country: string;
+  currency: string;
+  redirect_url: string;
+  external_identifier?: string | null | undefined;
+};
+
+/** @internal */
+export const RedirectPaymentMethodCreate$outboundSchema: z.ZodType<
+  RedirectPaymentMethodCreate$Outbound,
+  z.ZodTypeDef,
+  RedirectPaymentMethodCreate
+> = z.object({
+  method: RedirectPaymentMethodCreateMethod$outboundSchema,
+  buyerId: z.nullable(z.string()).optional(),
+  buyerExternalIdentifier: z.nullable(z.string()).optional(),
+  country: z.string(),
+  currency: z.string(),
+  redirectUrl: z.string(),
+  externalIdentifier: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    buyerId: "buyer_id",
+    buyerExternalIdentifier: "buyer_external_identifier",
+    redirectUrl: "redirect_url",
+    externalIdentifier: "external_identifier",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RedirectPaymentMethodCreate$ {
+  /** @deprecated use `RedirectPaymentMethodCreate$inboundSchema` instead. */
+  export const inboundSchema = RedirectPaymentMethodCreate$inboundSchema;
+  /** @deprecated use `RedirectPaymentMethodCreate$outboundSchema` instead. */
+  export const outboundSchema = RedirectPaymentMethodCreate$outboundSchema;
+  /** @deprecated use `RedirectPaymentMethodCreate$Outbound` instead. */
+  export type Outbound = RedirectPaymentMethodCreate$Outbound;
+}
+
+export function redirectPaymentMethodCreateToJSON(
+  redirectPaymentMethodCreate: RedirectPaymentMethodCreate,
+): string {
+  return JSON.stringify(
+    RedirectPaymentMethodCreate$outboundSchema.parse(
+      redirectPaymentMethodCreate,
+    ),
+  );
+}
+
+export function redirectPaymentMethodCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<RedirectPaymentMethodCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RedirectPaymentMethodCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RedirectPaymentMethodCreate' from JSON`,
+  );
+}