@moovio/sdk 0.22.11 → 0.22.13

package/src/models/components/invoicepayment.ts

@@ -28,7 +28,8 @@ import {
  * Payment made towards an invoice, will be either a transfer or an external payment.
  */
 export type InvoicePayment = {
-  paymentType: InvoicePaymentType;
+  invoicePaymentID: string;
+  invoicePaymentType: InvoicePaymentType;
   transfer?: InvoiceTransferPayment | undefined;
   external?: InvoiceExternalPayment | undefined;
 };
@@ -39,13 +40,15 @@ export const InvoicePayment$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  paymentType: InvoicePaymentType$inboundSchema,
+  invoicePaymentID: z.string(),
+  invoicePaymentType: InvoicePaymentType$inboundSchema,
   transfer: InvoiceTransferPayment$inboundSchema.optional(),
   external: InvoiceExternalPayment$inboundSchema.optional(),
 });
 /** @internal */
 export type InvoicePayment$Outbound = {
-  paymentType: string;
+  invoicePaymentID: string;
+  invoicePaymentType: string;
   transfer?: InvoiceTransferPayment$Outbound | undefined;
   external?: InvoiceExternalPayment$Outbound | undefined;
 };
@@ -56,7 +59,8 @@ export const InvoicePayment$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   InvoicePayment
 > = z.object({
-  paymentType: InvoicePaymentType$outboundSchema,
+  invoicePaymentID: z.string(),
+  invoicePaymentType: InvoicePaymentType$outboundSchema,
   transfer: InvoiceTransferPayment$outboundSchema.optional(),
   external: InvoiceExternalPayment$outboundSchema.optional(),
 });

package/src/models/components/invoicetransferpayment.ts

@@ -4,39 +4,23 @@
 
 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";
 
-export const PaymentType = {
-  Transfer: "transfer",
-} as const;
-export type PaymentType = ClosedEnum<typeof PaymentType>;
-
 export type InvoiceTransferPayment = {
-  paymentType: PaymentType;
   transferID: string;
 };
 
-/** @internal */
-export const PaymentType$inboundSchema: z.ZodNativeEnum<typeof PaymentType> = z
-  .nativeEnum(PaymentType);
-/** @internal */
-export const PaymentType$outboundSchema: z.ZodNativeEnum<typeof PaymentType> =
-  PaymentType$inboundSchema;
-
 /** @internal */
 export const InvoiceTransferPayment$inboundSchema: z.ZodType<
   InvoiceTransferPayment,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  paymentType: PaymentType$inboundSchema,
   transferID: z.string(),
 });
 /** @internal */
 export type InvoiceTransferPayment$Outbound = {
-  paymentType: string;
   transferID: string;
 };
 
@@ -46,7 +30,6 @@ export const InvoiceTransferPayment$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   InvoiceTransferPayment
 > = z.object({
-  paymentType: PaymentType$outboundSchema,
   transferID: z.string(),
 });
 

package/src/models/components/pingresponse.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 {
+  Webhook,
+  Webhook$inboundSchema,
+  Webhook$Outbound,
+  Webhook$outboundSchema,
+} from "./webhook.js";
+
+/**
+ * Response from pinging a webhook.
+ */
+export type PingResponse = {
+  /**
+   * The webhook that was pinged.
+   */
+  webhook: Webhook;
+  /**
+   * The request body sent to the target URL. It will contain an event type of `event.test` and an empty (null) data payload.
+   */
+  requestBodySent: { [k: string]: any };
+  /**
+   * The response status code after sending a ping event to the URL.
+   */
+  responseStatusCode: number;
+};
+
+/** @internal */
+export const PingResponse$inboundSchema: z.ZodType<
+  PingResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  webhook: Webhook$inboundSchema,
+  requestBodySent: z.record(z.any()),
+  responseStatusCode: z.number().int(),
+});
+/** @internal */
+export type PingResponse$Outbound = {
+  webhook: Webhook$Outbound;
+  requestBodySent: { [k: string]: any };
+  responseStatusCode: number;
+};
+
+/** @internal */
+export const PingResponse$outboundSchema: z.ZodType<
+  PingResponse$Outbound,
+  z.ZodTypeDef,
+  PingResponse
+> = z.object({
+  webhook: Webhook$outboundSchema,
+  requestBodySent: z.record(z.any()),
+  responseStatusCode: z.number().int(),
+});
+
+export function pingResponseToJSON(pingResponse: PingResponse): string {
+  return JSON.stringify(PingResponse$outboundSchema.parse(pingResponse));
+}
+export function pingResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PingResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PingResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PingResponse' from JSON`,
+  );
+}

package/src/models/components/transferachaddendarecord.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";
+
+/**
+ * An addenda record which was added to an ACH transfer
+ */
+export type TransferACHAddendaRecord = {
+  /**
+   * The ACH addenda record, which may have masked PII
+   */
+  record: string;
+  /**
+   * Flag indicating whether or not this record has been masked
+   */
+  isMasked: boolean;
+};
+
+/** @internal */
+export const TransferACHAddendaRecord$inboundSchema: z.ZodType<
+  TransferACHAddendaRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  record: z.string(),
+  isMasked: z.boolean(),
+});
+/** @internal */
+export type TransferACHAddendaRecord$Outbound = {
+  record: string;
+  isMasked: boolean;
+};
+
+/** @internal */
+export const TransferACHAddendaRecord$outboundSchema: z.ZodType<
+  TransferACHAddendaRecord$Outbound,
+  z.ZodTypeDef,
+  TransferACHAddendaRecord
+> = z.object({
+  record: z.string(),
+  isMasked: z.boolean(),
+});
+
+export function transferACHAddendaRecordToJSON(
+  transferACHAddendaRecord: TransferACHAddendaRecord,
+): string {
+  return JSON.stringify(
+    TransferACHAddendaRecord$outboundSchema.parse(transferACHAddendaRecord),
+  );
+}
+export function transferACHAddendaRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferACHAddendaRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferACHAddendaRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferACHAddendaRecord' from JSON`,
+  );
+}

package/src/models/components/updatewebhook.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 {
+  WebhookEventType,
+  WebhookEventType$inboundSchema,
+  WebhookEventType$outboundSchema,
+} from "./webhookeventtype.js";
+import {
+  WebhookStatus,
+  WebhookStatus$inboundSchema,
+  WebhookStatus$outboundSchema,
+} from "./webhookstatus.js";
+
+/**
+ * Request body for updating an existing webhook.
+ */
+export type UpdateWebhook = {
+  /**
+   * The URL where webhook events will be sent.
+   */
+  url: string;
+  /**
+   * The status of the webhook.
+   */
+  status: WebhookStatus;
+  /**
+   * The list of event types this webhook should subscribe to.
+   */
+  eventTypes: Array<WebhookEventType>;
+  /**
+   * A description of the webhook for reference. Can be an empty string.
+   */
+  description: string;
+};
+
+/** @internal */
+export const UpdateWebhook$inboundSchema: z.ZodType<
+  UpdateWebhook,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  status: WebhookStatus$inboundSchema,
+  eventTypes: z.array(WebhookEventType$inboundSchema),
+  description: z.string(),
+});
+/** @internal */
+export type UpdateWebhook$Outbound = {
+  url: string;
+  status: string;
+  eventTypes: Array<string>;
+  description: string;
+};
+
+/** @internal */
+export const UpdateWebhook$outboundSchema: z.ZodType<
+  UpdateWebhook$Outbound,
+  z.ZodTypeDef,
+  UpdateWebhook
+> = z.object({
+  url: z.string(),
+  status: WebhookStatus$outboundSchema,
+  eventTypes: z.array(WebhookEventType$outboundSchema),
+  description: z.string(),
+});
+
+export function updateWebhookToJSON(updateWebhook: UpdateWebhook): string {
+  return JSON.stringify(UpdateWebhook$outboundSchema.parse(updateWebhook));
+}
+export function updateWebhookFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateWebhook, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateWebhook$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateWebhook' from JSON`,
+  );
+}

package/src/models/components/webhook.ts

@@ -0,0 +1,115 @@
+/*
+ * 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 {
+  WebhookEventType,
+  WebhookEventType$inboundSchema,
+  WebhookEventType$outboundSchema,
+} from "./webhookeventtype.js";
+import {
+  WebhookStatus,
+  WebhookStatus$inboundSchema,
+  WebhookStatus$outboundSchema,
+} from "./webhookstatus.js";
+
+/**
+ * A configured webhook endpoint that receives event notifications.
+ */
+export type Webhook = {
+  /**
+   * Unique identifier for the webhook.
+   */
+  webhookID: string;
+  /**
+   * The URL where webhook events will be sent.
+   */
+  url: string;
+  /**
+   * The status of a webhook.
+   */
+  status: WebhookStatus;
+  /**
+   * The list of event types this webhook is subscribed to.
+   */
+  eventTypes: Array<WebhookEventType>;
+  /**
+   * A description of the webhook for reference.
+   */
+  description: string;
+  /**
+   * Timestamp of when the webhook was created.
+   */
+  createdOn: Date;
+  /**
+   * Timestamp of when the webhook was last updated.
+   */
+  updatedOn: Date;
+  /**
+   * Timestamp of when the webhook last received an event.
+   */
+  lastUsedOn?: Date | undefined;
+};
+
+/** @internal */
+export const Webhook$inboundSchema: z.ZodType<Webhook, z.ZodTypeDef, unknown> =
+  z.object({
+    webhookID: z.string(),
+    url: z.string(),
+    status: WebhookStatus$inboundSchema,
+    eventTypes: z.array(WebhookEventType$inboundSchema),
+    description: z.string(),
+    createdOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updatedOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    lastUsedOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+  });
+/** @internal */
+export type Webhook$Outbound = {
+  webhookID: string;
+  url: string;
+  status: string;
+  eventTypes: Array<string>;
+  description: string;
+  createdOn: string;
+  updatedOn: string;
+  lastUsedOn?: string | undefined;
+};
+
+/** @internal */
+export const Webhook$outboundSchema: z.ZodType<
+  Webhook$Outbound,
+  z.ZodTypeDef,
+  Webhook
+> = z.object({
+  webhookID: z.string(),
+  url: z.string(),
+  status: WebhookStatus$outboundSchema,
+  eventTypes: z.array(WebhookEventType$outboundSchema),
+  description: z.string(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  updatedOn: z.date().transform(v => v.toISOString()),
+  lastUsedOn: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function webhookToJSON(webhook: Webhook): string {
+  return JSON.stringify(Webhook$outboundSchema.parse(webhook));
+}
+export function webhookFromJSON(
+  jsonString: string,
+): SafeParseResult<Webhook, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Webhook$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Webhook' from JSON`,
+  );
+}

package/src/models/components/webhooksecret.ts

@@ -0,0 +1,53 @@
+/*
+ * 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";
+
+/**
+ * The secret used to verify webhook payloads.
+ */
+export type WebhookSecret = {
+  /**
+   * The secret key used to sign webhook payloads. Use this to verify the authenticity of incoming webhooks.
+   */
+  secret: string;
+};
+
+/** @internal */
+export const WebhookSecret$inboundSchema: z.ZodType<
+  WebhookSecret,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  secret: z.string(),
+});
+/** @internal */
+export type WebhookSecret$Outbound = {
+  secret: string;
+};
+
+/** @internal */
+export const WebhookSecret$outboundSchema: z.ZodType<
+  WebhookSecret$Outbound,
+  z.ZodTypeDef,
+  WebhookSecret
+> = z.object({
+  secret: z.string(),
+});
+
+export function webhookSecretToJSON(webhookSecret: WebhookSecret): string {
+  return JSON.stringify(WebhookSecret$outboundSchema.parse(webhookSecret));
+}
+export function webhookSecretFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookSecret, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookSecret$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookSecret' from JSON`,
+  );
+}

package/src/models/components/webhookstatus.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The status of a webhook.
+ */
+export const WebhookStatus = {
+  Enabled: "enabled",
+  Disabled: "disabled",
+} as const;
+/**
+ * The status of a webhook.
+ */
+export type WebhookStatus = ClosedEnum<typeof WebhookStatus>;
+
+/** @internal */
+export const WebhookStatus$inboundSchema: z.ZodNativeEnum<
+  typeof WebhookStatus
+> = z.nativeEnum(WebhookStatus);
+/** @internal */
+export const WebhookStatus$outboundSchema: z.ZodNativeEnum<
+  typeof WebhookStatus
+> = WebhookStatus$inboundSchema;

package/src/models/errors/createinvoicepaymenterror.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { MoovError } from "./mooverror.js";
+
+export type CreateInvoicePaymentErrorData = {
+  foreignID?: string | undefined;
+  description?: string | undefined;
+  paymentDate?: string | undefined;
+};
+
+export class CreateInvoicePaymentError extends MoovError {
+  foreignID?: string | undefined;
+  description?: string | undefined;
+  paymentDate?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: CreateInvoicePaymentErrorData;
+
+  constructor(
+    err: CreateInvoicePaymentErrorData,
+    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, httpMeta);
+    this.data$ = err;
+    if (err.foreignID != null) this.foreignID = err.foreignID;
+    if (err.description != null) this.description = err.description;
+    if (err.paymentDate != null) this.paymentDate = err.paymentDate;
+
+    this.name = "CreateInvoicePaymentError";
+  }
+}
+
+/** @internal */
+export const CreateInvoicePaymentError$inboundSchema: z.ZodType<
+  CreateInvoicePaymentError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  foreignID: z.string().optional(),
+  description: z.string().optional(),
+  paymentDate: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CreateInvoicePaymentError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type CreateInvoicePaymentError$Outbound = {
+  foreignID?: string | undefined;
+  description?: string | undefined;
+  paymentDate?: string | undefined;
+};
+
+/** @internal */
+export const CreateInvoicePaymentError$outboundSchema: z.ZodType<
+  CreateInvoicePaymentError$Outbound,
+  z.ZodTypeDef,
+  CreateInvoicePaymentError
+> = z.instanceof(CreateInvoicePaymentError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    foreignID: z.string().optional(),
+    description: z.string().optional(),
+    paymentDate: z.string().optional(),
+  }));

package/src/models/errors/createwebhookvalidationerror.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { MoovError } from "./mooverror.js";
+
+export type CreateWebhookValidationErrorData = {
+  /**
+   * Details about the URL validation error.
+   */
+  url?: string | undefined;
+  /**
+   * Details about the status validation error.
+   */
+  status?: string | undefined;
+  /**
+   * Details about the event types validation error.
+   */
+  eventTypes?: string | undefined;
+  /**
+   * Details about the description validation error.
+   */
+  description?: string | undefined;
+};
+
+export class CreateWebhookValidationError extends MoovError {
+  /**
+   * Details about the URL validation error.
+   */
+  url?: string | undefined;
+  /**
+   * Details about the status validation error.
+   */
+  status?: string | undefined;
+  /**
+   * Details about the event types validation error.
+   */
+  eventTypes?: string | undefined;
+  /**
+   * Details about the description validation error.
+   */
+  description?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: CreateWebhookValidationErrorData;
+
+  constructor(
+    err: CreateWebhookValidationErrorData,
+    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, httpMeta);
+    this.data$ = err;
+    if (err.url != null) this.url = err.url;
+    if (err.status != null) this.status = err.status;
+    if (err.eventTypes != null) this.eventTypes = err.eventTypes;
+    if (err.description != null) this.description = err.description;
+
+    this.name = "CreateWebhookValidationError";
+  }
+}
+
+/** @internal */
+export const CreateWebhookValidationError$inboundSchema: z.ZodType<
+  CreateWebhookValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string().optional(),
+  status: z.string().optional(),
+  eventTypes: z.string().optional(),
+  description: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CreateWebhookValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type CreateWebhookValidationError$Outbound = {
+  url?: string | undefined;
+  status?: string | undefined;
+  eventTypes?: string | undefined;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const CreateWebhookValidationError$outboundSchema: z.ZodType<
+  CreateWebhookValidationError$Outbound,
+  z.ZodTypeDef,
+  CreateWebhookValidationError
+> = z.instanceof(CreateWebhookValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    url: z.string().optional(),
+    status: z.string().optional(),
+    eventTypes: z.string().optional(),
+    description: z.string().optional(),
+  }));