@moovio/sdk 0.12.6 → 0.13.0

package/src/models/components/underwriting.ts

@@ -6,18 +6,51 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BusinessPresence,
+  BusinessPresence$inboundSchema,
+  BusinessPresence$outboundSchema,
+} from "./businesspresence.js";
 import {
   CardVolumeDistribution,
   CardVolumeDistribution$inboundSchema,
   CardVolumeDistribution$Outbound,
   CardVolumeDistribution$outboundSchema,
 } from "./cardvolumedistribution.js";
+import {
+  CollectFunds,
+  CollectFunds$inboundSchema,
+  CollectFunds$Outbound,
+  CollectFunds$outboundSchema,
+} from "./collectfunds.js";
 import {
   FulfillmentDetails,
   FulfillmentDetails$inboundSchema,
   FulfillmentDetails$Outbound,
   FulfillmentDetails$outboundSchema,
 } from "./fulfillmentdetails.js";
+import {
+  GeographicReach,
+  GeographicReach$inboundSchema,
+  GeographicReach$outboundSchema,
+} from "./geographicreach.js";
+import {
+  MoneyTransfer,
+  MoneyTransfer$inboundSchema,
+  MoneyTransfer$Outbound,
+  MoneyTransfer$outboundSchema,
+} from "./moneytransfer.js";
+import {
+  PendingLitigation,
+  PendingLitigation$inboundSchema,
+  PendingLitigation$outboundSchema,
+} from "./pendinglitigation.js";
+import {
+  SendFunds,
+  SendFunds$inboundSchema,
+  SendFunds$Outbound,
+  SendFunds$outboundSchema,
+} from "./sendfunds.js";
 import {
   UnderwritingStatus,
   UnderwritingStatus$inboundSchema,
@@ -29,21 +62,34 @@ import {
   VolumeByCustomerType$Outbound,
   VolumeByCustomerType$outboundSchema,
 } from "./volumebycustomertype.js";
+import {
+  VolumeShareByCustomerType,
+  VolumeShareByCustomerType$inboundSchema,
+  VolumeShareByCustomerType$Outbound,
+  VolumeShareByCustomerType$outboundSchema,
+} from "./volumesharebycustomertype.js";
 
 /**
  * Describes underwriting values (in USD) used for card payment acceptance.
  */
 export type Underwriting = {
-  averageTransactionSize: number;
-  maxTransactionSize: number;
-  averageMonthlyTransactionVolume: number;
+  averageTransactionSize?: number | undefined;
+  maxTransactionSize?: number | undefined;
+  averageMonthlyTransactionVolume?: number | undefined;
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  status: UnderwritingStatus;
-  volumeByCustomerType: VolumeByCustomerType;
-  cardVolumeDistribution: CardVolumeDistribution;
-  fulfillment: FulfillmentDetails;
+  status?: UnderwritingStatus | undefined;
+  volumeByCustomerType?: VolumeByCustomerType | undefined;
+  cardVolumeDistribution?: CardVolumeDistribution | undefined;
+  fulfillment?: FulfillmentDetails | undefined;
+  geographicReach?: GeographicReach | undefined;
+  businessPresence?: BusinessPresence | undefined;
+  pendingLitigation?: PendingLitigation | undefined;
+  volumeShareByCustomerType?: VolumeShareByCustomerType | undefined;
+  collectFunds?: CollectFunds | undefined;
+  moneyTransfer?: MoneyTransfer | undefined;
+  sendFunds?: SendFunds | undefined;
 };
 
 /** @internal */
@@ -52,24 +98,38 @@ export const Underwriting$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  averageTransactionSize: z.number().int(),
-  maxTransactionSize: z.number().int(),
-  averageMonthlyTransactionVolume: z.number().int(),
-  status: UnderwritingStatus$inboundSchema,
-  volumeByCustomerType: VolumeByCustomerType$inboundSchema,
-  cardVolumeDistribution: CardVolumeDistribution$inboundSchema,
-  fulfillment: FulfillmentDetails$inboundSchema,
+  averageTransactionSize: z.number().int().optional(),
+  maxTransactionSize: z.number().int().optional(),
+  averageMonthlyTransactionVolume: z.number().int().optional(),
+  status: UnderwritingStatus$inboundSchema.optional(),
+  volumeByCustomerType: VolumeByCustomerType$inboundSchema.optional(),
+  cardVolumeDistribution: CardVolumeDistribution$inboundSchema.optional(),
+  fulfillment: FulfillmentDetails$inboundSchema.optional(),
+  geographicReach: GeographicReach$inboundSchema.optional(),
+  businessPresence: BusinessPresence$inboundSchema.optional(),
+  pendingLitigation: PendingLitigation$inboundSchema.optional(),
+  volumeShareByCustomerType: VolumeShareByCustomerType$inboundSchema.optional(),
+  collectFunds: CollectFunds$inboundSchema.optional(),
+  moneyTransfer: MoneyTransfer$inboundSchema.optional(),
+  sendFunds: SendFunds$inboundSchema.optional(),
 });
 
 /** @internal */
 export type Underwriting$Outbound = {
-  averageTransactionSize: number;
-  maxTransactionSize: number;
-  averageMonthlyTransactionVolume: number;
-  status: string;
-  volumeByCustomerType: VolumeByCustomerType$Outbound;
-  cardVolumeDistribution: CardVolumeDistribution$Outbound;
-  fulfillment: FulfillmentDetails$Outbound;
+  averageTransactionSize?: number | undefined;
+  maxTransactionSize?: number | undefined;
+  averageMonthlyTransactionVolume?: number | undefined;
+  status?: string | undefined;
+  volumeByCustomerType?: VolumeByCustomerType$Outbound | undefined;
+  cardVolumeDistribution?: CardVolumeDistribution$Outbound | undefined;
+  fulfillment?: FulfillmentDetails$Outbound | undefined;
+  geographicReach?: string | undefined;
+  businessPresence?: string | undefined;
+  pendingLitigation?: string | undefined;
+  volumeShareByCustomerType?: VolumeShareByCustomerType$Outbound | undefined;
+  collectFunds?: CollectFunds$Outbound | undefined;
+  moneyTransfer?: MoneyTransfer$Outbound | undefined;
+  sendFunds?: SendFunds$Outbound | undefined;
 };
 
 /** @internal */
@@ -78,13 +138,21 @@ export const Underwriting$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Underwriting
 > = z.object({
-  averageTransactionSize: z.number().int(),
-  maxTransactionSize: z.number().int(),
-  averageMonthlyTransactionVolume: z.number().int(),
-  status: UnderwritingStatus$outboundSchema,
-  volumeByCustomerType: VolumeByCustomerType$outboundSchema,
-  cardVolumeDistribution: CardVolumeDistribution$outboundSchema,
-  fulfillment: FulfillmentDetails$outboundSchema,
+  averageTransactionSize: z.number().int().optional(),
+  maxTransactionSize: z.number().int().optional(),
+  averageMonthlyTransactionVolume: z.number().int().optional(),
+  status: UnderwritingStatus$outboundSchema.optional(),
+  volumeByCustomerType: VolumeByCustomerType$outboundSchema.optional(),
+  cardVolumeDistribution: CardVolumeDistribution$outboundSchema.optional(),
+  fulfillment: FulfillmentDetails$outboundSchema.optional(),
+  geographicReach: GeographicReach$outboundSchema.optional(),
+  businessPresence: BusinessPresence$outboundSchema.optional(),
+  pendingLitigation: PendingLitigation$outboundSchema.optional(),
+  volumeShareByCustomerType: VolumeShareByCustomerType$outboundSchema
+    .optional(),
+  collectFunds: CollectFunds$outboundSchema.optional(),
+  moneyTransfer: MoneyTransfer$outboundSchema.optional(),
+  sendFunds: SendFunds$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/upsertunderwriting.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BusinessPresence,
+  BusinessPresence$inboundSchema,
+  BusinessPresence$outboundSchema,
+} from "./businesspresence.js";
+import {
+  CollectFunds,
+  CollectFunds$inboundSchema,
+  CollectFunds$Outbound,
+  CollectFunds$outboundSchema,
+} from "./collectfunds.js";
+import {
+  GeographicReach,
+  GeographicReach$inboundSchema,
+  GeographicReach$outboundSchema,
+} from "./geographicreach.js";
+import {
+  MoneyTransfer,
+  MoneyTransfer$inboundSchema,
+  MoneyTransfer$Outbound,
+  MoneyTransfer$outboundSchema,
+} from "./moneytransfer.js";
+import {
+  PendingLitigation,
+  PendingLitigation$inboundSchema,
+  PendingLitigation$outboundSchema,
+} from "./pendinglitigation.js";
+import {
+  SendFunds,
+  SendFunds$inboundSchema,
+  SendFunds$Outbound,
+  SendFunds$outboundSchema,
+} from "./sendfunds.js";
+import {
+  VolumeShareByCustomerType,
+  VolumeShareByCustomerType$inboundSchema,
+  VolumeShareByCustomerType$Outbound,
+  VolumeShareByCustomerType$outboundSchema,
+} from "./volumesharebycustomertype.js";
+
+export type UpsertUnderwriting = {
+  geographicReach?: GeographicReach | undefined;
+  businessPresence?: BusinessPresence | undefined;
+  pendingLitigation?: PendingLitigation | undefined;
+  volumeShareByCustomerType?: VolumeShareByCustomerType | undefined;
+  collectFunds?: CollectFunds | undefined;
+  moneyTransfer?: MoneyTransfer | undefined;
+  sendFunds?: SendFunds | undefined;
+};
+
+/** @internal */
+export const UpsertUnderwriting$inboundSchema: z.ZodType<
+  UpsertUnderwriting,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  geographicReach: GeographicReach$inboundSchema.optional(),
+  businessPresence: BusinessPresence$inboundSchema.optional(),
+  pendingLitigation: PendingLitigation$inboundSchema.optional(),
+  volumeShareByCustomerType: VolumeShareByCustomerType$inboundSchema.optional(),
+  collectFunds: CollectFunds$inboundSchema.optional(),
+  moneyTransfer: MoneyTransfer$inboundSchema.optional(),
+  sendFunds: SendFunds$inboundSchema.optional(),
+});
+
+/** @internal */
+export type UpsertUnderwriting$Outbound = {
+  geographicReach?: string | undefined;
+  businessPresence?: string | undefined;
+  pendingLitigation?: string | undefined;
+  volumeShareByCustomerType?: VolumeShareByCustomerType$Outbound | undefined;
+  collectFunds?: CollectFunds$Outbound | undefined;
+  moneyTransfer?: MoneyTransfer$Outbound | undefined;
+  sendFunds?: SendFunds$Outbound | undefined;
+};
+
+/** @internal */
+export const UpsertUnderwriting$outboundSchema: z.ZodType<
+  UpsertUnderwriting$Outbound,
+  z.ZodTypeDef,
+  UpsertUnderwriting
+> = z.object({
+  geographicReach: GeographicReach$outboundSchema.optional(),
+  businessPresence: BusinessPresence$outboundSchema.optional(),
+  pendingLitigation: PendingLitigation$outboundSchema.optional(),
+  volumeShareByCustomerType: VolumeShareByCustomerType$outboundSchema
+    .optional(),
+  collectFunds: CollectFunds$outboundSchema.optional(),
+  moneyTransfer: MoneyTransfer$outboundSchema.optional(),
+  sendFunds: SendFunds$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpsertUnderwriting$ {
+  /** @deprecated use `UpsertUnderwriting$inboundSchema` instead. */
+  export const inboundSchema = UpsertUnderwriting$inboundSchema;
+  /** @deprecated use `UpsertUnderwriting$outboundSchema` instead. */
+  export const outboundSchema = UpsertUnderwriting$outboundSchema;
+  /** @deprecated use `UpsertUnderwriting$Outbound` instead. */
+  export type Outbound = UpsertUnderwriting$Outbound;
+}
+
+export function upsertUnderwritingToJSON(
+  upsertUnderwriting: UpsertUnderwriting,
+): string {
+  return JSON.stringify(
+    UpsertUnderwriting$outboundSchema.parse(upsertUnderwriting),
+  );
+}
+
+export function upsertUnderwritingFromJSON(
+  jsonString: string,
+): SafeParseResult<UpsertUnderwriting, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpsertUnderwriting$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpsertUnderwriting' from JSON`,
+  );
+}

package/src/models/components/volumesharebycustomertype.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VolumeShareByCustomerType = {
+  business?: number | undefined;
+  consumer?: number | undefined;
+  p2p?: number | undefined;
+};
+
+/** @internal */
+export const VolumeShareByCustomerType$inboundSchema: z.ZodType<
+  VolumeShareByCustomerType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  business: z.number().int().optional(),
+  consumer: z.number().int().optional(),
+  p2p: z.number().int().optional(),
+});
+
+/** @internal */
+export type VolumeShareByCustomerType$Outbound = {
+  business?: number | undefined;
+  consumer?: number | undefined;
+  p2p?: number | undefined;
+};
+
+/** @internal */
+export const VolumeShareByCustomerType$outboundSchema: z.ZodType<
+  VolumeShareByCustomerType$Outbound,
+  z.ZodTypeDef,
+  VolumeShareByCustomerType
+> = z.object({
+  business: z.number().int().optional(),
+  consumer: z.number().int().optional(),
+  p2p: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VolumeShareByCustomerType$ {
+  /** @deprecated use `VolumeShareByCustomerType$inboundSchema` instead. */
+  export const inboundSchema = VolumeShareByCustomerType$inboundSchema;
+  /** @deprecated use `VolumeShareByCustomerType$outboundSchema` instead. */
+  export const outboundSchema = VolumeShareByCustomerType$outboundSchema;
+  /** @deprecated use `VolumeShareByCustomerType$Outbound` instead. */
+  export type Outbound = VolumeShareByCustomerType$Outbound;
+}
+
+export function volumeShareByCustomerTypeToJSON(
+  volumeShareByCustomerType: VolumeShareByCustomerType,
+): string {
+  return JSON.stringify(
+    VolumeShareByCustomerType$outboundSchema.parse(volumeShareByCustomerType),
+  );
+}
+
+export function volumeShareByCustomerTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<VolumeShareByCustomerType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VolumeShareByCustomerType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VolumeShareByCustomerType' from JSON`,
+  );
+}

package/src/models/components/volumesharebycustomertypeerror.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VolumeShareByCustomerTypeError = {
+  business?: string | undefined;
+  consumer?: string | undefined;
+  p2p?: string | undefined;
+};
+
+/** @internal */
+export const VolumeShareByCustomerTypeError$inboundSchema: z.ZodType<
+  VolumeShareByCustomerTypeError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  business: z.string().optional(),
+  consumer: z.string().optional(),
+  p2p: z.string().optional(),
+});
+
+/** @internal */
+export type VolumeShareByCustomerTypeError$Outbound = {
+  business?: string | undefined;
+  consumer?: string | undefined;
+  p2p?: string | undefined;
+};
+
+/** @internal */
+export const VolumeShareByCustomerTypeError$outboundSchema: z.ZodType<
+  VolumeShareByCustomerTypeError$Outbound,
+  z.ZodTypeDef,
+  VolumeShareByCustomerTypeError
+> = z.object({
+  business: z.string().optional(),
+  consumer: z.string().optional(),
+  p2p: 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 VolumeShareByCustomerTypeError$ {
+  /** @deprecated use `VolumeShareByCustomerTypeError$inboundSchema` instead. */
+  export const inboundSchema = VolumeShareByCustomerTypeError$inboundSchema;
+  /** @deprecated use `VolumeShareByCustomerTypeError$outboundSchema` instead. */
+  export const outboundSchema = VolumeShareByCustomerTypeError$outboundSchema;
+  /** @deprecated use `VolumeShareByCustomerTypeError$Outbound` instead. */
+  export type Outbound = VolumeShareByCustomerTypeError$Outbound;
+}
+
+export function volumeShareByCustomerTypeErrorToJSON(
+  volumeShareByCustomerTypeError: VolumeShareByCustomerTypeError,
+): string {
+  return JSON.stringify(
+    VolumeShareByCustomerTypeError$outboundSchema.parse(
+      volumeShareByCustomerTypeError,
+    ),
+  );
+}
+
+export function volumeShareByCustomerTypeErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<VolumeShareByCustomerTypeError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VolumeShareByCustomerTypeError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VolumeShareByCustomerTypeError' from JSON`,
+  );
+}

package/src/models/components/webhookdatatransfercreated.ts

@@ -19,6 +19,7 @@ export type WebhookDataTransferCreated = {
   accountID: string;
   transferID: string;
   status: WebhookDataTransferStatus;
+  foreignID?: string | undefined;
 };
 
 /** @internal */
@@ -30,6 +31,7 @@ export const WebhookDataTransferCreated$inboundSchema: z.ZodType<
   accountID: z.string(),
   transferID: z.string(),
   status: WebhookDataTransferStatus$inboundSchema,
+  foreignID: z.string().optional(),
 });
 
 /** @internal */
@@ -37,6 +39,7 @@ export type WebhookDataTransferCreated$Outbound = {
   accountID: string;
   transferID: string;
   status: string;
+  foreignID?: string | undefined;
 };
 
 /** @internal */
@@ -48,6 +51,7 @@ export const WebhookDataTransferCreated$outboundSchema: z.ZodType<
   accountID: z.string(),
   transferID: z.string(),
   status: WebhookDataTransferStatus$outboundSchema,
+  foreignID: z.string().optional(),
 });
 
 /**

package/src/models/components/webhookdatatransferupdated.ts

@@ -33,6 +33,7 @@ export type WebhookDataTransferUpdated = {
    * Payment method details for the source or destination of a transfer.
    */
   destination: WebhookTransferPaymentMethodDetails;
+  foreignID?: string | undefined;
 };
 
 /** @internal */
@@ -46,6 +47,7 @@ export const WebhookDataTransferUpdated$inboundSchema: z.ZodType<
   status: WebhookDataTransferStatus$inboundSchema,
   source: WebhookTransferPaymentMethodDetails$inboundSchema,
   destination: WebhookTransferPaymentMethodDetails$inboundSchema,
+  foreignID: z.string().optional(),
 });
 
 /** @internal */
@@ -55,6 +57,7 @@ export type WebhookDataTransferUpdated$Outbound = {
   status: string;
   source: WebhookTransferPaymentMethodDetails$Outbound;
   destination: WebhookTransferPaymentMethodDetails$Outbound;
+  foreignID?: string | undefined;
 };
 
 /** @internal */
@@ -68,6 +71,7 @@ export const WebhookDataTransferUpdated$outboundSchema: z.ZodType<
   status: WebhookDataTransferStatus$outboundSchema,
   source: WebhookTransferPaymentMethodDetails$outboundSchema,
   destination: WebhookTransferPaymentMethodDetails$outboundSchema,
+  foreignID: z.string().optional(),
 });
 
 /**

package/src/models/errors/index.ts

@@ -40,3 +40,4 @@ export * from "./updatecarderror.js";
 export * from "./updateissuedcarderror.js";
 export * from "./updatepaymentlinkerror.js";
 export * from "./updateunderwritingerror.js";
+export * from "./upsertunderwritingerror.js";

package/src/models/errors/transfer.ts

@@ -66,6 +66,10 @@ export type TransferData = {
    * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
    */
   salesTaxAmount?: components.Amount | undefined;
+  /**
+   * Optional alias from a foreign/external system which can be used to reference this resource.
+   */
+  foreignID?: string | undefined;
 };
 
 /**
@@ -128,6 +132,10 @@ export class Transfer extends MoovError {
    * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
    */
   salesTaxAmount?: components.Amount | undefined;
+  /**
+   * Optional alias from a foreign/external system which can be used to reference this resource.
+   */
+  foreignID?: string | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: TransferData;
@@ -167,6 +175,7 @@ export class Transfer extends MoovError {
     if (err.occurrenceID != null) this.occurrenceID = err.occurrenceID;
     if (err.paymentLinkCode != null) this.paymentLinkCode = err.paymentLinkCode;
     if (err.salesTaxAmount != null) this.salesTaxAmount = err.salesTaxAmount;
+    if (err.foreignID != null) this.foreignID = err.foreignID;
 
     this.name = "Transfer";
   }
@@ -205,6 +214,7 @@ export const Transfer$inboundSchema: z.ZodType<
   occurrenceID: z.string().optional(),
   paymentLinkCode: z.string().optional(),
   salesTaxAmount: components.Amount$inboundSchema.optional(),
+  foreignID: z.string().optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
@@ -245,6 +255,7 @@ export type Transfer$Outbound = {
   occurrenceID?: string | undefined;
   paymentLinkCode?: string | undefined;
   salesTaxAmount?: components.Amount$Outbound | undefined;
+  foreignID?: string | undefined;
 };
 
 /** @internal */
@@ -282,6 +293,7 @@ export const Transfer$outboundSchema: z.ZodType<
     occurrenceID: z.string().optional(),
     paymentLinkCode: z.string().optional(),
     salesTaxAmount: components.Amount$outboundSchema.optional(),
+    foreignID: z.string().optional(),
   }));
 
 /**