@moovio/sdk 26.7.0-dev.4 → 26.7.0-dev.5

package/src/models/components/pushdeliveryspeed.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Delivery speed options for push-to-card payouts.
+ */
+export const PushDeliverySpeed = {
+  Instant: "instant",
+  Deferred: "deferred",
+} as const;
+/**
+ * Delivery speed options for push-to-card payouts.
+ */
+export type PushDeliverySpeed = OpenEnum<typeof PushDeliverySpeed>;
+
+/** @internal */
+export const PushDeliverySpeed$inboundSchema: z.ZodType<
+  PushDeliverySpeed,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PushDeliverySpeed);
+/** @internal */
+export const PushDeliverySpeed$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PushDeliverySpeed
+> = openEnums.outboundSchema(PushDeliverySpeed);

package/src/models/components/pushoptions.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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PushDeliverySpeed,
+  PushDeliverySpeed$inboundSchema,
+  PushDeliverySpeed$outboundSchema,
+} from "./pushdeliveryspeed.js";
+
+/**
+ * Delivery options for push-to-card payouts.
+ */
+export type PushOptions = {
+  /**
+   * Delivery speeds the recipient may choose from for `push-to-card`. Include `instant` to allow immediate
+   *
+   * @remarks
+   * delivery, `deferred` to allow delayed delivery, or both to let the recipient choose at checkout.
+   */
+  allowedSpeeds: Array<PushDeliverySpeed>;
+  /**
+   * Delay before delivering a deferred `push-to-card` payout. Required when `allowedSpeeds` includes `deferred`.
+   *
+   * @remarks
+   * Accepted values are `24h` or `48h`.
+   */
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptions$inboundSchema: z.ZodType<
+  PushOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$inboundSchema),
+  deferredBy: types.optional(types.string()),
+});
+/** @internal */
+export type PushOptions$Outbound = {
+  allowedSpeeds: Array<string>;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptions$outboundSchema: z.ZodType<
+  PushOptions$Outbound,
+  z.ZodTypeDef,
+  PushOptions
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$outboundSchema),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsToJSON(pushOptions: PushOptions): string {
+  return JSON.stringify(PushOptions$outboundSchema.parse(pushOptions));
+}
+export function pushOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptions' from JSON`,
+  );
+}

package/src/models/components/pushoptionserror.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PushOptionsError = {
+  allowedSpeeds?: string | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsError$inboundSchema: z.ZodType<
+  PushOptionsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: types.optional(types.string()),
+  deferredBy: types.optional(types.string()),
+});
+/** @internal */
+export type PushOptionsError$Outbound = {
+  allowedSpeeds?: string | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsError$outboundSchema: z.ZodType<
+  PushOptionsError$Outbound,
+  z.ZodTypeDef,
+  PushOptionsError
+> = z.object({
+  allowedSpeeds: z.string().optional(),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsErrorToJSON(
+  pushOptionsError: PushOptionsError,
+): string {
+  return JSON.stringify(
+    PushOptionsError$outboundSchema.parse(pushOptionsError),
+  );
+}
+export function pushOptionsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptionsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptionsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptionsError' from JSON`,
+  );
+}

package/src/models/components/pushoptionsupdate.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PushDeliverySpeed,
+  PushDeliverySpeed$inboundSchema,
+  PushDeliverySpeed$outboundSchema,
+} from "./pushdeliveryspeed.js";
+
+/**
+ * Delivery options for push-to-card payouts.
+ */
+export type PushOptionsUpdate = {
+  /**
+   * Delivery speeds the recipient may choose from for `push-to-card`. Include `instant` to allow immediate
+   *
+   * @remarks
+   * delivery, `deferred` to allow delayed delivery, or both to let the recipient choose at checkout.
+   */
+  allowedSpeeds?: Array<PushDeliverySpeed> | undefined;
+  /**
+   * Delay before delivering a deferred `push-to-card` payout. Required when `allowedSpeeds` includes `deferred`.
+   *
+   * @remarks
+   * Accepted values are `24h` or `48h`.
+   */
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsUpdate$inboundSchema: z.ZodType<
+  PushOptionsUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowedSpeeds: types.optional(z.array(PushDeliverySpeed$inboundSchema)),
+  deferredBy: types.optional(types.string()),
+});
+/** @internal */
+export type PushOptionsUpdate$Outbound = {
+  allowedSpeeds?: Array<string> | undefined;
+  deferredBy?: string | undefined;
+};
+
+/** @internal */
+export const PushOptionsUpdate$outboundSchema: z.ZodType<
+  PushOptionsUpdate$Outbound,
+  z.ZodTypeDef,
+  PushOptionsUpdate
+> = z.object({
+  allowedSpeeds: z.array(PushDeliverySpeed$outboundSchema).optional(),
+  deferredBy: z.string().optional(),
+});
+
+export function pushOptionsUpdateToJSON(
+  pushOptionsUpdate: PushOptionsUpdate,
+): string {
+  return JSON.stringify(
+    PushOptionsUpdate$outboundSchema.parse(pushOptionsUpdate),
+  );
+}
+export function pushOptionsUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<PushOptionsUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushOptionsUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushOptionsUpdate' from JSON`,
+  );
+}

package/src/models/components/sourcesystem.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Identifies the core banking source system that produced the deposit account payload.
+ *
+ * @remarks
+ *
+ * The expected format of the request body depends on this value, so it must be supplied
+ * in the `X-Source-System` header on every request.
+ */
+export const SourceSystem = {
+  JhSilverlake: "jh_silverlake",
+  JhCif2020: "jh_cif2020",
+  JhCoredirector: "jh_coredirector",
+} as const;
+/**
+ * Identifies the core banking source system that produced the deposit account payload.
+ *
+ * @remarks
+ *
+ * The expected format of the request body depends on this value, so it must be supplied
+ * in the `X-Source-System` header on every request.
+ */
+export type SourceSystem = OpenEnum<typeof SourceSystem>;
+
+/** @internal */
+export const SourceSystem$inboundSchema: z.ZodType<
+  SourceSystem,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SourceSystem);
+/** @internal */
+export const SourceSystem$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SourceSystem
+> = openEnums.outboundSchema(SourceSystem);

package/src/models/components/termsofservice.ts

@@ -17,7 +17,7 @@ export type TermsOfService = {
    */
   acceptedDate: Date;
   /**
-   * The IP address from which the terms of service were accepted.
+   * The IP address (IPv4 or IPv6) from which the terms of service were accepted.
    */
   acceptedIP: string;
 };

package/src/models/components/updatepaymentlinkamountdetails.ts

@@ -7,37 +7,137 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  AmountDecimalUpdate,
-  AmountDecimalUpdate$inboundSchema,
-  AmountDecimalUpdate$Outbound,
-  AmountDecimalUpdate$outboundSchema,
-} from "./amountdecimalupdate.js";
+
+/**
+ * The amount of tax applied to the payment link.
+ */
+export type Tax = {
+  /**
+   * A 3-letter ISO 4217 currency code.
+   */
+  currency?: string | undefined;
+  /**
+   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
+   *
+   * @remarks
+   *
+   * For example, $12.987654321 is '12.987654321'.
+   */
+  valueDecimal?: string | undefined;
+};
+
+/**
+ * The amount of surcharge applied to the payment link.
+ */
+export type Surcharge = {
+  /**
+   * A 3-letter ISO 4217 currency code.
+   */
+  currency?: string | undefined;
+  /**
+   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
+   *
+   * @remarks
+   *
+   * For example, $12.987654321 is '12.987654321'.
+   */
+  valueDecimal?: string | undefined;
+};
 
 export type UpdatePaymentLinkAmountDetails = {
   /**
    * The amount of tax applied to the payment link.
    */
-  tax?: AmountDecimalUpdate | undefined;
+  tax?: Tax | null | undefined;
   /**
    * The amount of surcharge applied to the payment link.
    */
-  surcharge?: AmountDecimalUpdate | undefined;
+  surcharge?: Surcharge | null | undefined;
+};
+
+/** @internal */
+export const Tax$inboundSchema: z.ZodType<Tax, z.ZodTypeDef, unknown> = z
+  .object({
+    currency: types.optional(types.string()),
+    valueDecimal: types.optional(types.string()),
+  });
+/** @internal */
+export type Tax$Outbound = {
+  currency?: string | undefined;
+  valueDecimal?: string | undefined;
 };
 
+/** @internal */
+export const Tax$outboundSchema: z.ZodType<Tax$Outbound, z.ZodTypeDef, Tax> = z
+  .object({
+    currency: z.string().optional(),
+    valueDecimal: z.string().optional(),
+  });
+
+export function taxToJSON(tax: Tax): string {
+  return JSON.stringify(Tax$outboundSchema.parse(tax));
+}
+export function taxFromJSON(
+  jsonString: string,
+): SafeParseResult<Tax, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tax$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tax' from JSON`,
+  );
+}
+
+/** @internal */
+export const Surcharge$inboundSchema: z.ZodType<
+  Surcharge,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: types.optional(types.string()),
+  valueDecimal: types.optional(types.string()),
+});
+/** @internal */
+export type Surcharge$Outbound = {
+  currency?: string | undefined;
+  valueDecimal?: string | undefined;
+};
+
+/** @internal */
+export const Surcharge$outboundSchema: z.ZodType<
+  Surcharge$Outbound,
+  z.ZodTypeDef,
+  Surcharge
+> = z.object({
+  currency: z.string().optional(),
+  valueDecimal: z.string().optional(),
+});
+
+export function surchargeToJSON(surcharge: Surcharge): string {
+  return JSON.stringify(Surcharge$outboundSchema.parse(surcharge));
+}
+export function surchargeFromJSON(
+  jsonString: string,
+): SafeParseResult<Surcharge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Surcharge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Surcharge' from JSON`,
+  );
+}
+
 /** @internal */
 export const UpdatePaymentLinkAmountDetails$inboundSchema: z.ZodType<
   UpdatePaymentLinkAmountDetails,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  tax: types.optional(AmountDecimalUpdate$inboundSchema),
-  surcharge: types.optional(AmountDecimalUpdate$inboundSchema),
+  tax: z.nullable(z.lazy(() => Tax$inboundSchema)).optional(),
+  surcharge: z.nullable(z.lazy(() => Surcharge$inboundSchema)).optional(),
 });
 /** @internal */
 export type UpdatePaymentLinkAmountDetails$Outbound = {
-  tax?: AmountDecimalUpdate$Outbound | undefined;
-  surcharge?: AmountDecimalUpdate$Outbound | undefined;
+  tax?: Tax$Outbound | null | undefined;
+  surcharge?: Surcharge$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -46,8 +146,8 @@ export const UpdatePaymentLinkAmountDetails$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdatePaymentLinkAmountDetails
 > = z.object({
-  tax: AmountDecimalUpdate$outboundSchema.optional(),
-  surcharge: AmountDecimalUpdate$outboundSchema.optional(),
+  tax: z.nullable(z.lazy(() => Tax$outboundSchema)).optional(),
+  surcharge: z.nullable(z.lazy(() => Surcharge$outboundSchema)).optional(),
 });
 
 export function updatePaymentLinkAmountDetailsToJSON(

package/src/models/errors/depositaccountvalidationerror.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { MoovError } from "./mooverror.js";
+
+/**
+ * Descriptions of any field validations that failed while parsing the deposit account payload.
+ */
+export type DepositAccountValidationErrorData = {
+  /**
+   * An error describing why the X-Source-System header was missing or unsupported.
+   */
+  sourceSystem?: string | undefined;
+  /**
+   * An error describing why the request body could not be parsed for the given source system.
+   */
+  body?: string | undefined;
+};
+
+/**
+ * Descriptions of any field validations that failed while parsing the deposit account payload.
+ */
+export class DepositAccountValidationError extends MoovError {
+  /**
+   * An error describing why the X-Source-System header was missing or unsupported.
+   */
+  sourceSystem?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: DepositAccountValidationErrorData;
+
+  constructor(
+    err: DepositAccountValidationErrorData,
+    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.sourceSystem != null) this.sourceSystem = err.sourceSystem;
+
+    this.name = "DepositAccountValidationError";
+  }
+}
+
+/** @internal */
+export const DepositAccountValidationError$inboundSchema: z.ZodType<
+  DepositAccountValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sourceSystem: types.optional(types.string()),
+  body: types.optional(types.string()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new DepositAccountValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type DepositAccountValidationError$Outbound = {
+  sourceSystem?: string | undefined;
+  body?: string | undefined;
+};
+
+/** @internal */
+export const DepositAccountValidationError$outboundSchema: z.ZodType<
+  DepositAccountValidationError$Outbound,
+  z.ZodTypeDef,
+  DepositAccountValidationError
+> = z.instanceof(DepositAccountValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    sourceSystem: z.string().optional(),
+    body: z.string().optional(),
+  }));

package/src/models/errors/index.ts

@@ -21,6 +21,7 @@ export * from "./createsweepconfigerror.js";
 export * from "./createticketerror.js";
 export * from "./createwalletvalidationerror.js";
 export * from "./createwebhookvalidationerror.js";
+export * from "./depositaccountvalidationerror.js";
 export * from "./duplicatecarderror.js";
 export * from "./feeplanagreementerror.js";
 export * from "./fileuploadvalidationerror.js";

package/src/models/operations/createdepositaccount.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateDepositAccountRequest = {
+  accountID: string;
+  /**
+   * Identifies the core banking source system that produced the request body.
+   */
+  xSourceSystem: components.SourceSystem;
+  requestBody: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type CreateDepositAccountResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.DepositAccountIngestedResponse;
+};
+
+/** @internal */
+export const CreateDepositAccountRequest$inboundSchema: z.ZodType<
+  CreateDepositAccountRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: types.string(),
+  "X-Source-System": components.SourceSystem$inboundSchema,
+  RequestBody: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Source-System": "xSourceSystem",
+    "RequestBody": "requestBody",
+  });
+});
+/** @internal */
+export type CreateDepositAccountRequest$Outbound = {
+  accountID: string;
+  "X-Source-System": string;
+  RequestBody: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const CreateDepositAccountRequest$outboundSchema: z.ZodType<
+  CreateDepositAccountRequest$Outbound,
+  z.ZodTypeDef,
+  CreateDepositAccountRequest
+> = z.object({
+  accountID: z.string(),
+  xSourceSystem: components.SourceSystem$outboundSchema,
+  requestBody: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    xSourceSystem: "X-Source-System",
+    requestBody: "RequestBody",
+  });
+});
+
+export function createDepositAccountRequestToJSON(
+  createDepositAccountRequest: CreateDepositAccountRequest,
+): string {
+  return JSON.stringify(
+    CreateDepositAccountRequest$outboundSchema.parse(
+      createDepositAccountRequest,
+    ),
+  );
+}
+export function createDepositAccountRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDepositAccountRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateDepositAccountRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDepositAccountRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateDepositAccountResponse$inboundSchema: z.ZodType<
+  CreateDepositAccountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.DepositAccountIngestedResponse$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type CreateDepositAccountResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.DepositAccountIngestedResponse$Outbound;
+};
+
+/** @internal */
+export const CreateDepositAccountResponse$outboundSchema: z.ZodType<
+  CreateDepositAccountResponse$Outbound,
+  z.ZodTypeDef,
+  CreateDepositAccountResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.DepositAccountIngestedResponse$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function createDepositAccountResponseToJSON(
+  createDepositAccountResponse: CreateDepositAccountResponse,
+): string {
+  return JSON.stringify(
+    CreateDepositAccountResponse$outboundSchema.parse(
+      createDepositAccountResponse,
+    ),
+  );
+}
+export function createDepositAccountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateDepositAccountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateDepositAccountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateDepositAccountResponse' from JSON`,
+  );
+}