@moovio/sdk 0.21.13 → 0.21.15

package/src/models/components/invoice.ts

@@ -0,0 +1,178 @@
+/*
+ * 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 {
+  InvoiceLineItems,
+  InvoiceLineItems$inboundSchema,
+  InvoiceLineItems$Outbound,
+  InvoiceLineItems$outboundSchema,
+} from "./invoicelineitems.js";
+import {
+  InvoicePayment,
+  InvoicePayment$inboundSchema,
+  InvoicePayment$Outbound,
+  InvoicePayment$outboundSchema,
+} from "./invoicepayment.js";
+import {
+  InvoiceStatus,
+  InvoiceStatus$inboundSchema,
+  InvoiceStatus$outboundSchema,
+} from "./invoicestatus.js";
+
+export type Invoice = {
+  invoiceID: string;
+  invoiceNumber: string;
+  description: string;
+  customerAccountID: string;
+  partnerAccountID: string;
+  status: InvoiceStatus;
+  /**
+   * A collection of line items for an invoice.
+   */
+  lineItems: InvoiceLineItems;
+  subtotalAmount: AmountDecimal;
+  taxAmount: AmountDecimal;
+  /**
+   * Total amount of the invoice, sum of subTotalAmount and taxAmount
+   */
+  totalAmount: AmountDecimal;
+  /**
+   * Total amount of pending transfers paid towards the invoice
+   */
+  pendingAmount: AmountDecimal;
+  /**
+   * Total amount of completed transfers paid towards the invoice
+   */
+  paidAmount: AmountDecimal;
+  /**
+   * Total amount of refunds initiated against transfers paid towards the invoice
+   */
+  refundedAmount: AmountDecimal;
+  /**
+   * Total amount of disputes initiated against transfers paid towards the invoice
+   */
+  disputedAmount: AmountDecimal;
+  paymentLinkCode?: string | undefined;
+  payments?: Array<InvoicePayment> | undefined;
+  createdOn: Date;
+  invoiceDate?: Date | undefined;
+  dueDate?: Date | undefined;
+  sentOn?: Date | undefined;
+  paidOn?: Date | undefined;
+  canceledOn?: Date | undefined;
+};
+
+/** @internal */
+export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
+  z.object({
+    invoiceID: z.string(),
+    invoiceNumber: z.string(),
+    description: z.string(),
+    customerAccountID: z.string(),
+    partnerAccountID: z.string(),
+    status: InvoiceStatus$inboundSchema,
+    lineItems: InvoiceLineItems$inboundSchema,
+    subtotalAmount: AmountDecimal$inboundSchema,
+    taxAmount: AmountDecimal$inboundSchema,
+    totalAmount: AmountDecimal$inboundSchema,
+    pendingAmount: AmountDecimal$inboundSchema,
+    paidAmount: AmountDecimal$inboundSchema,
+    refundedAmount: AmountDecimal$inboundSchema,
+    disputedAmount: AmountDecimal$inboundSchema,
+    paymentLinkCode: z.string().optional(),
+    payments: z.array(InvoicePayment$inboundSchema).optional(),
+    createdOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    invoiceDate: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    dueDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    sentOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    paidOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    canceledOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+  });
+/** @internal */
+export type Invoice$Outbound = {
+  invoiceID: string;
+  invoiceNumber: string;
+  description: string;
+  customerAccountID: string;
+  partnerAccountID: string;
+  status: string;
+  lineItems: InvoiceLineItems$Outbound;
+  subtotalAmount: AmountDecimal$Outbound;
+  taxAmount: AmountDecimal$Outbound;
+  totalAmount: AmountDecimal$Outbound;
+  pendingAmount: AmountDecimal$Outbound;
+  paidAmount: AmountDecimal$Outbound;
+  refundedAmount: AmountDecimal$Outbound;
+  disputedAmount: AmountDecimal$Outbound;
+  paymentLinkCode?: string | undefined;
+  payments?: Array<InvoicePayment$Outbound> | undefined;
+  createdOn: string;
+  invoiceDate?: string | undefined;
+  dueDate?: string | undefined;
+  sentOn?: string | undefined;
+  paidOn?: string | undefined;
+  canceledOn?: string | undefined;
+};
+
+/** @internal */
+export const Invoice$outboundSchema: z.ZodType<
+  Invoice$Outbound,
+  z.ZodTypeDef,
+  Invoice
+> = z.object({
+  invoiceID: z.string(),
+  invoiceNumber: z.string(),
+  description: z.string(),
+  customerAccountID: z.string(),
+  partnerAccountID: z.string(),
+  status: InvoiceStatus$outboundSchema,
+  lineItems: InvoiceLineItems$outboundSchema,
+  subtotalAmount: AmountDecimal$outboundSchema,
+  taxAmount: AmountDecimal$outboundSchema,
+  totalAmount: AmountDecimal$outboundSchema,
+  pendingAmount: AmountDecimal$outboundSchema,
+  paidAmount: AmountDecimal$outboundSchema,
+  refundedAmount: AmountDecimal$outboundSchema,
+  disputedAmount: AmountDecimal$outboundSchema,
+  paymentLinkCode: z.string().optional(),
+  payments: z.array(InvoicePayment$outboundSchema).optional(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  invoiceDate: z.date().transform(v => v.toISOString()).optional(),
+  dueDate: z.date().transform(v => v.toISOString()).optional(),
+  sentOn: z.date().transform(v => v.toISOString()).optional(),
+  paidOn: z.date().transform(v => v.toISOString()).optional(),
+  canceledOn: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function invoiceToJSON(invoice: Invoice): string {
+  return JSON.stringify(Invoice$outboundSchema.parse(invoice));
+}
+export function invoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<Invoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invoice' from JSON`,
+  );
+}

package/src/models/components/invoiceexternalpayment.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.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";
+
+export const InvoiceExternalPaymentPaymentType = {
+  External: "external",
+} as const;
+export type InvoiceExternalPaymentPaymentType = ClosedEnum<
+  typeof InvoiceExternalPaymentPaymentType
+>;
+
+export type InvoiceExternalPayment = {
+  paymentType: InvoiceExternalPaymentPaymentType;
+  description: string;
+  foreignID?: string | undefined;
+  paymentDate?: Date | undefined;
+  amount: AmountDecimal;
+};
+
+/** @internal */
+export const InvoiceExternalPaymentPaymentType$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceExternalPaymentPaymentType
+> = z.nativeEnum(InvoiceExternalPaymentPaymentType);
+/** @internal */
+export const InvoiceExternalPaymentPaymentType$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceExternalPaymentPaymentType
+> = InvoiceExternalPaymentPaymentType$inboundSchema;
+
+/** @internal */
+export const InvoiceExternalPayment$inboundSchema: z.ZodType<
+  InvoiceExternalPayment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentType: InvoiceExternalPaymentPaymentType$inboundSchema,
+  description: z.string(),
+  foreignID: z.string().optional(),
+  paymentDate: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  amount: AmountDecimal$inboundSchema,
+});
+/** @internal */
+export type InvoiceExternalPayment$Outbound = {
+  paymentType: string;
+  description: string;
+  foreignID?: string | undefined;
+  paymentDate?: string | undefined;
+  amount: AmountDecimal$Outbound;
+};
+
+/** @internal */
+export const InvoiceExternalPayment$outboundSchema: z.ZodType<
+  InvoiceExternalPayment$Outbound,
+  z.ZodTypeDef,
+  InvoiceExternalPayment
+> = z.object({
+  paymentType: InvoiceExternalPaymentPaymentType$outboundSchema,
+  description: z.string(),
+  foreignID: z.string().optional(),
+  paymentDate: z.date().transform(v => v.toISOString()).optional(),
+  amount: AmountDecimal$outboundSchema,
+});
+
+export function invoiceExternalPaymentToJSON(
+  invoiceExternalPayment: InvoiceExternalPayment,
+): string {
+  return JSON.stringify(
+    InvoiceExternalPayment$outboundSchema.parse(invoiceExternalPayment),
+  );
+}
+export function invoiceExternalPaymentFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceExternalPayment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceExternalPayment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceExternalPayment' from JSON`,
+  );
+}

package/src/models/components/invoicelineitem.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 {
+  InvoiceLineItemOption,
+  InvoiceLineItemOption$inboundSchema,
+  InvoiceLineItemOption$Outbound,
+  InvoiceLineItemOption$outboundSchema,
+} from "./invoicelineitemoption.js";
+
+/**
+ * Represents a single item in an invoice, including optional modifiers and quantity.
+ */
+export type InvoiceLineItem = {
+  /**
+   * 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 list of modifiers applied to this item (e.g., toppings, upgrades, customizations).
+   */
+  options?: Array<InvoiceLineItemOption> | undefined;
+  /**
+   * Optional unique identifier associating the line item with a product.
+   */
+  productID?: string | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItem$inboundSchema: z.ZodType<
+  InvoiceLineItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$inboundSchema,
+  quantity: z.number().int(),
+  options: z.array(InvoiceLineItemOption$inboundSchema).optional(),
+  productID: z.string().optional(),
+});
+/** @internal */
+export type InvoiceLineItem$Outbound = {
+  name: string;
+  basePrice: AmountDecimal$Outbound;
+  quantity: number;
+  options?: Array<InvoiceLineItemOption$Outbound> | undefined;
+  productID?: string | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItem$outboundSchema: z.ZodType<
+  InvoiceLineItem$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItem
+> = z.object({
+  name: z.string(),
+  basePrice: AmountDecimal$outboundSchema,
+  quantity: z.number().int(),
+  options: z.array(InvoiceLineItemOption$outboundSchema).optional(),
+  productID: z.string().optional(),
+});
+
+export function invoiceLineItemToJSON(
+  invoiceLineItem: InvoiceLineItem,
+): string {
+  return JSON.stringify(InvoiceLineItem$outboundSchema.parse(invoiceLineItem));
+}
+export function invoiceLineItemFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceLineItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItem' from JSON`,
+  );
+}

package/src/models/components/invoicelineitemoption.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 InvoiceLineItemOption = {
+  /**
+   * 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 InvoiceLineItemOption$inboundSchema: z.ZodType<
+  InvoiceLineItemOption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$inboundSchema.optional(),
+  group: z.string().optional(),
+});
+/** @internal */
+export type InvoiceLineItemOption$Outbound = {
+  name: string;
+  quantity: number;
+  priceModifier?: AmountDecimal$Outbound | undefined;
+  group?: string | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItemOption$outboundSchema: z.ZodType<
+  InvoiceLineItemOption$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItemOption
+> = z.object({
+  name: z.string(),
+  quantity: z.number().int(),
+  priceModifier: AmountDecimal$outboundSchema.optional(),
+  group: z.string().optional(),
+});
+
+export function invoiceLineItemOptionToJSON(
+  invoiceLineItemOption: InvoiceLineItemOption,
+): string {
+  return JSON.stringify(
+    InvoiceLineItemOption$outboundSchema.parse(invoiceLineItemOption),
+  );
+}
+export function invoiceLineItemOptionFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItemOption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceLineItemOption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItemOption' from JSON`,
+  );
+}

package/src/models/components/invoicelineitemoptionvalidationerror.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 InvoiceLineItemOptionValidationError = {
+  name?: string | undefined;
+  group?: string | undefined;
+  priceModifier?: AmountDecimalValidationError | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItemOptionValidationError$inboundSchema: z.ZodType<
+  InvoiceLineItemOptionValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  group: z.string().optional(),
+  priceModifier: AmountDecimalValidationError$inboundSchema.optional(),
+  quantity: z.string().optional(),
+});
+/** @internal */
+export type InvoiceLineItemOptionValidationError$Outbound = {
+  name?: string | undefined;
+  group?: string | undefined;
+  priceModifier?: AmountDecimalValidationError$Outbound | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItemOptionValidationError$outboundSchema: z.ZodType<
+  InvoiceLineItemOptionValidationError$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItemOptionValidationError
+> = z.object({
+  name: z.string().optional(),
+  group: z.string().optional(),
+  priceModifier: AmountDecimalValidationError$outboundSchema.optional(),
+  quantity: z.string().optional(),
+});
+
+export function invoiceLineItemOptionValidationErrorToJSON(
+  invoiceLineItemOptionValidationError: InvoiceLineItemOptionValidationError,
+): string {
+  return JSON.stringify(
+    InvoiceLineItemOptionValidationError$outboundSchema.parse(
+      invoiceLineItemOptionValidationError,
+    ),
+  );
+}
+export function invoiceLineItemOptionValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItemOptionValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      InvoiceLineItemOptionValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItemOptionValidationError' from JSON`,
+  );
+}

package/src/models/components/invoicelineitems.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 {
+  InvoiceLineItem,
+  InvoiceLineItem$inboundSchema,
+  InvoiceLineItem$Outbound,
+  InvoiceLineItem$outboundSchema,
+} from "./invoicelineitem.js";
+
+/**
+ * A collection of line items for an invoice.
+ */
+export type InvoiceLineItems = {
+  /**
+   * The list of line items.
+   */
+  items: Array<InvoiceLineItem>;
+};
+
+/** @internal */
+export const InvoiceLineItems$inboundSchema: z.ZodType<
+  InvoiceLineItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(InvoiceLineItem$inboundSchema),
+});
+/** @internal */
+export type InvoiceLineItems$Outbound = {
+  items: Array<InvoiceLineItem$Outbound>;
+};
+
+/** @internal */
+export const InvoiceLineItems$outboundSchema: z.ZodType<
+  InvoiceLineItems$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItems
+> = z.object({
+  items: z.array(InvoiceLineItem$outboundSchema),
+});
+
+export function invoiceLineItemsToJSON(
+  invoiceLineItems: InvoiceLineItems,
+): string {
+  return JSON.stringify(
+    InvoiceLineItems$outboundSchema.parse(invoiceLineItems),
+  );
+}
+export function invoiceLineItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItems, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceLineItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItems' from JSON`,
+  );
+}

package/src/models/components/invoicelineitemsupdate.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 {
+  InvoiceLineItem,
+  InvoiceLineItem$inboundSchema,
+  InvoiceLineItem$Outbound,
+  InvoiceLineItem$outboundSchema,
+} from "./invoicelineitem.js";
+
+/**
+ * A collection of line items for an invoice.
+ */
+export type InvoiceLineItemsUpdate = {
+  /**
+   * The list of line items.
+   */
+  items?: Array<InvoiceLineItem> | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItemsUpdate$inboundSchema: z.ZodType<
+  InvoiceLineItemsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(InvoiceLineItem$inboundSchema).optional(),
+});
+/** @internal */
+export type InvoiceLineItemsUpdate$Outbound = {
+  items?: Array<InvoiceLineItem$Outbound> | undefined;
+};
+
+/** @internal */
+export const InvoiceLineItemsUpdate$outboundSchema: z.ZodType<
+  InvoiceLineItemsUpdate$Outbound,
+  z.ZodTypeDef,
+  InvoiceLineItemsUpdate
+> = z.object({
+  items: z.array(InvoiceLineItem$outboundSchema).optional(),
+});
+
+export function invoiceLineItemsUpdateToJSON(
+  invoiceLineItemsUpdate: InvoiceLineItemsUpdate,
+): string {
+  return JSON.stringify(
+    InvoiceLineItemsUpdate$outboundSchema.parse(invoiceLineItemsUpdate),
+  );
+}
+export function invoiceLineItemsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<InvoiceLineItemsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InvoiceLineItemsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InvoiceLineItemsUpdate' from JSON`,
+  );
+}