@moovio/sdk 26.4.0-dev.1 → 26.4.0-dev.11

package/src/models/components/cardpresentpaymenttransferpaymentmethod.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TransferTerminalCard,
+  TransferTerminalCard$inboundSchema,
+  TransferTerminalCard$Outbound,
+  TransferTerminalCard$outboundSchema,
+} from "./transferterminalcard.js";
+
+/**
+ * A card used at point of sale terminal for a card present transaction as contained within a payment method.
+ */
+export type CardPresentPaymentTransferPaymentMethod = {
+  /**
+   * ID of the payment method.
+   */
+  paymentMethodID: string;
+  paymentMethodType: "card-present-payment";
+  /**
+   * Describes payment card details captured with tap or in-person payment.
+   */
+  terminalCard?: TransferTerminalCard | undefined;
+};
+
+/** @internal */
+export const CardPresentPaymentTransferPaymentMethod$inboundSchema: z.ZodType<
+  CardPresentPaymentTransferPaymentMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentMethodID: z.string(),
+  paymentMethodType: z.literal("card-present-payment"),
+  terminalCard: TransferTerminalCard$inboundSchema.optional(),
+});
+/** @internal */
+export type CardPresentPaymentTransferPaymentMethod$Outbound = {
+  paymentMethodID: string;
+  paymentMethodType: "card-present-payment";
+  terminalCard?: TransferTerminalCard$Outbound | undefined;
+};
+
+/** @internal */
+export const CardPresentPaymentTransferPaymentMethod$outboundSchema: z.ZodType<
+  CardPresentPaymentTransferPaymentMethod$Outbound,
+  z.ZodTypeDef,
+  CardPresentPaymentTransferPaymentMethod
+> = z.object({
+  paymentMethodID: z.string(),
+  paymentMethodType: z.literal("card-present-payment"),
+  terminalCard: TransferTerminalCard$outboundSchema.optional(),
+});
+
+export function cardPresentPaymentTransferPaymentMethodToJSON(
+  cardPresentPaymentTransferPaymentMethod:
+    CardPresentPaymentTransferPaymentMethod,
+): string {
+  return JSON.stringify(
+    CardPresentPaymentTransferPaymentMethod$outboundSchema.parse(
+      cardPresentPaymentTransferPaymentMethod,
+    ),
+  );
+}
+export function cardPresentPaymentTransferPaymentMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CardPresentPaymentTransferPaymentMethod,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CardPresentPaymentTransferPaymentMethod$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CardPresentPaymentTransferPaymentMethod' from JSON`,
+  );
+}

package/src/models/components/createfeeplanagreement.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CreateFeePlanAgreement = {
+  /**
+   * A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
+   */
   planID: string;
 };
 

package/src/models/components/createinvoice.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+import {
+  CreateInvoiceLineItems,
+  CreateInvoiceLineItems$inboundSchema,
+  CreateInvoiceLineItems$Outbound,
+  CreateInvoiceLineItems$outboundSchema,
+} from "./createinvoicelineitems.js";
+
+export type CreateInvoice = {
+  /**
+   * A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
+   */
+  customerAccountID: string;
+  description?: string | undefined;
+  /**
+   * A collection of line items for an invoice.
+   */
+  lineItems: CreateInvoiceLineItems;
+  invoiceDate?: Date | undefined;
+  dueDate?: Date | undefined;
+  taxAmount?: AmountDecimal | undefined;
+};
+
+/** @internal */
+export const CreateInvoice$inboundSchema: z.ZodType<
+  CreateInvoice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customerAccountID: z.string(),
+  description: z.string().optional(),
+  lineItems: CreateInvoiceLineItems$inboundSchema,
+  invoiceDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  dueDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  taxAmount: AmountDecimal$inboundSchema.optional(),
+});
+/** @internal */
+export type CreateInvoice$Outbound = {
+  customerAccountID: string;
+  description?: string | undefined;
+  lineItems: CreateInvoiceLineItems$Outbound;
+  invoiceDate?: string | undefined;
+  dueDate?: string | undefined;
+  taxAmount?: AmountDecimal$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateInvoice$outboundSchema: z.ZodType<
+  CreateInvoice$Outbound,
+  z.ZodTypeDef,
+  CreateInvoice
+> = z.object({
+  customerAccountID: z.string(),
+  description: z.string().optional(),
+  lineItems: CreateInvoiceLineItems$outboundSchema,
+  invoiceDate: z.date().transform(v => v.toISOString()).optional(),
+  dueDate: z.date().transform(v => v.toISOString()).optional(),
+  taxAmount: AmountDecimal$outboundSchema.optional(),
+});
+
+export function createInvoiceToJSON(createInvoice: CreateInvoice): string {
+  return JSON.stringify(CreateInvoice$outboundSchema.parse(createInvoice));
+}
+export function createInvoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoice' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitem.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+import {
+  CreateInvoiceLineItemOption,
+  CreateInvoiceLineItemOption$inboundSchema,
+  CreateInvoiceLineItemOption$Outbound,
+  CreateInvoiceLineItemOption$outboundSchema,
+} from "./createinvoicelineitemoption.js";
+
+/**
+ * Represents a single item in an invoice, including optional modifiers and quantity.
+ */
+export type CreateInvoiceLineItem = {
+  /**
+   * The name of the item.
+   */
+  name: string;
+  /**
+   * The base price of the item before applying option modifiers.
+   */
+  basePrice: AmountDecimal;
+  /**
+   * The quantity of this item.
+   */
+  quantity: number;
+  /**
+   *   Optional unique identifier associating the line item with a product.
+   *
+   * @remarks
+   *   When provided, images associated with the product will be included on the line item.
+   *   This does not populate other details of the line item.
+   */
+  productID?: string | undefined;
+  /**
+   * Optional list of modifiers applied to this item (e.g., toppings, upgrades, customizations).
+   */
+  options?: Array<CreateInvoiceLineItemOption> | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItem$inboundSchema: z.ZodType<
+  CreateInvoiceLineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$inboundSchema,
+  quantity: z.number().int(),
+  productID: z.string().optional(),
+  options: z.array(CreateInvoiceLineItemOption$inboundSchema).optional(),
+});
+/** @internal */
+export type CreateInvoiceLineItem$Outbound = {
+  name: string;
+  basePrice: AmountDecimal$Outbound;
+  quantity: number;
+  productID?: string | undefined;
+  options?: Array<CreateInvoiceLineItemOption$Outbound> | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItem$outboundSchema: z.ZodType<
+  CreateInvoiceLineItem$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceLineItem
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$outboundSchema,
+  quantity: z.number().int(),
+  productID: z.string().optional(),
+  options: z.array(CreateInvoiceLineItemOption$outboundSchema).optional(),
+});
+
+export function createInvoiceLineItemToJSON(
+  createInvoiceLineItem: CreateInvoiceLineItem,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItem$outboundSchema.parse(createInvoiceLineItem),
+  );
+}
+export function createInvoiceLineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoiceLineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoiceLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoiceLineItem' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitemoption.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+
+/**
+ * Represents a modifier or option applied to a line item.
+ */
+export type CreateInvoiceLineItemOption = {
+  /**
+   * The name of the option or modifier.
+   */
+  name: string;
+  /**
+   * The quantity of this option.
+   */
+  quantity: number;
+  /**
+   * Optional price modification applied by this option. Can be positive, negative, or zero.
+   */
+  priceModifier?: AmountDecimal | undefined;
+  /**
+   * Optional group identifier to categorize related options (e.g., 'toppings').
+   */
+  group?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemOption$inboundSchema: z.ZodType<
+  CreateInvoiceLineItemOption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$inboundSchema.optional(),
+  group: z.string().optional(),
+});
+/** @internal */
+export type CreateInvoiceLineItemOption$Outbound = {
+  name: string;
+  quantity: number;
+  priceModifier?: AmountDecimal$Outbound | undefined;
+  group?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemOption$outboundSchema: z.ZodType<
+  CreateInvoiceLineItemOption$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceLineItemOption
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$outboundSchema.optional(),
+  group: z.string().optional(),
+});
+
+export function createInvoiceLineItemOptionToJSON(
+  createInvoiceLineItemOption: CreateInvoiceLineItemOption,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItemOption$outboundSchema.parse(
+      createInvoiceLineItemOption,
+    ),
+  );
+}
+export function createInvoiceLineItemOptionFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoiceLineItemOption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoiceLineItemOption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoiceLineItemOption' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitemoptionvalidationerror.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimalValidationError,
+  AmountDecimalValidationError$inboundSchema,
+  AmountDecimalValidationError$Outbound,
+  AmountDecimalValidationError$outboundSchema,
+} from "./amountdecimalvalidationerror.js";
+
+export type CreateInvoiceLineItemOptionValidationError = {
+  name?: string | undefined;
+  group?: string | undefined;
+  priceModifier?: AmountDecimalValidationError | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemOptionValidationError$inboundSchema:
+  z.ZodType<CreateInvoiceLineItemOptionValidationError, z.ZodTypeDef, unknown> =
+    z.object({
+      name: z.string().optional(),
+      group: z.string().optional(),
+      priceModifier: AmountDecimalValidationError$inboundSchema.optional(),
+      quantity: z.string().optional(),
+    });
+/** @internal */
+export type CreateInvoiceLineItemOptionValidationError$Outbound = {
+  name?: string | undefined;
+  group?: string | undefined;
+  priceModifier?: AmountDecimalValidationError$Outbound | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemOptionValidationError$outboundSchema:
+  z.ZodType<
+    CreateInvoiceLineItemOptionValidationError$Outbound,
+    z.ZodTypeDef,
+    CreateInvoiceLineItemOptionValidationError
+  > = z.object({
+    name: z.string().optional(),
+    group: z.string().optional(),
+    priceModifier: AmountDecimalValidationError$outboundSchema.optional(),
+    quantity: z.string().optional(),
+  });
+
+export function createInvoiceLineItemOptionValidationErrorToJSON(
+  createInvoiceLineItemOptionValidationError:
+    CreateInvoiceLineItemOptionValidationError,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItemOptionValidationError$outboundSchema.parse(
+      createInvoiceLineItemOptionValidationError,
+    ),
+  );
+}
+export function createInvoiceLineItemOptionValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CreateInvoiceLineItemOptionValidationError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateInvoiceLineItemOptionValidationError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CreateInvoiceLineItemOptionValidationError' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitems.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CreateInvoiceLineItem,
+  CreateInvoiceLineItem$inboundSchema,
+  CreateInvoiceLineItem$Outbound,
+  CreateInvoiceLineItem$outboundSchema,
+} from "./createinvoicelineitem.js";
+
+/**
+ * A collection of line items for an invoice.
+ */
+export type CreateInvoiceLineItems = {
+  /**
+   * The list of line items.
+   */
+  items: Array<CreateInvoiceLineItem>;
+};
+
+/** @internal */
+export const CreateInvoiceLineItems$inboundSchema: z.ZodType<
+  CreateInvoiceLineItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(CreateInvoiceLineItem$inboundSchema),
+});
+/** @internal */
+export type CreateInvoiceLineItems$Outbound = {
+  items: Array<CreateInvoiceLineItem$Outbound>;
+};
+
+/** @internal */
+export const CreateInvoiceLineItems$outboundSchema: z.ZodType<
+  CreateInvoiceLineItems$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceLineItems
+> = z.object({
+  items: z.array(CreateInvoiceLineItem$outboundSchema),
+});
+
+export function createInvoiceLineItemsToJSON(
+  createInvoiceLineItems: CreateInvoiceLineItems,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItems$outboundSchema.parse(createInvoiceLineItems),
+  );
+}
+export function createInvoiceLineItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoiceLineItems, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoiceLineItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoiceLineItems' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitemsupdate.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CreateInvoiceLineItem,
+  CreateInvoiceLineItem$inboundSchema,
+  CreateInvoiceLineItem$Outbound,
+  CreateInvoiceLineItem$outboundSchema,
+} from "./createinvoicelineitem.js";
+
+/**
+ * A collection of line items for an invoice.
+ */
+export type CreateInvoiceLineItemsUpdate = {
+  /**
+   * The list of line items.
+   */
+  items?: Array<CreateInvoiceLineItem> | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemsUpdate$inboundSchema: z.ZodType<
+  CreateInvoiceLineItemsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(CreateInvoiceLineItem$inboundSchema).optional(),
+});
+/** @internal */
+export type CreateInvoiceLineItemsUpdate$Outbound = {
+  items?: Array<CreateInvoiceLineItem$Outbound> | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemsUpdate$outboundSchema: z.ZodType<
+  CreateInvoiceLineItemsUpdate$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceLineItemsUpdate
+> = z.object({
+  items: z.array(CreateInvoiceLineItem$outboundSchema).optional(),
+});
+
+export function createInvoiceLineItemsUpdateToJSON(
+  createInvoiceLineItemsUpdate: CreateInvoiceLineItemsUpdate,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItemsUpdate$outboundSchema.parse(
+      createInvoiceLineItemsUpdate,
+    ),
+  );
+}
+export function createInvoiceLineItemsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoiceLineItemsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateInvoiceLineItemsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoiceLineItemsUpdate' from JSON`,
+  );
+}

package/src/models/components/createinvoicelineitemsvalidationerror.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CreateInvoiceLineItemValidationError,
+  CreateInvoiceLineItemValidationError$inboundSchema,
+  CreateInvoiceLineItemValidationError$Outbound,
+  CreateInvoiceLineItemValidationError$outboundSchema,
+} from "./createinvoicelineitemvalidationerror.js";
+
+export type CreateInvoiceLineItemsValidationError = {
+  items?: { [k: string]: CreateInvoiceLineItemValidationError } | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemsValidationError$inboundSchema: z.ZodType<
+  CreateInvoiceLineItemsValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.record(CreateInvoiceLineItemValidationError$inboundSchema)
+    .optional(),
+});
+/** @internal */
+export type CreateInvoiceLineItemsValidationError$Outbound = {
+  items?:
+    | { [k: string]: CreateInvoiceLineItemValidationError$Outbound }
+    | undefined;
+};
+
+/** @internal */
+export const CreateInvoiceLineItemsValidationError$outboundSchema: z.ZodType<
+  CreateInvoiceLineItemsValidationError$Outbound,
+  z.ZodTypeDef,
+  CreateInvoiceLineItemsValidationError
+> = z.object({
+  items: z.record(CreateInvoiceLineItemValidationError$outboundSchema)
+    .optional(),
+});
+
+export function createInvoiceLineItemsValidationErrorToJSON(
+  createInvoiceLineItemsValidationError: CreateInvoiceLineItemsValidationError,
+): string {
+  return JSON.stringify(
+    CreateInvoiceLineItemsValidationError$outboundSchema.parse(
+      createInvoiceLineItemsValidationError,
+    ),
+  );
+}
+export function createInvoiceLineItemsValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateInvoiceLineItemsValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateInvoiceLineItemsValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateInvoiceLineItemsValidationError' from JSON`,
+  );
+}