@moovio/sdk 0.7.1 → 0.8.1

package/src/models/components/schedulelistresponse.ts

@@ -0,0 +1,151 @@
+/*
+ * 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 { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  OccurrencesResponse,
+  OccurrencesResponse$inboundSchema,
+  OccurrencesResponse$Outbound,
+  OccurrencesResponse$outboundSchema,
+} from "./occurrencesresponse.js";
+import {
+  PartialScheduleAccount,
+  PartialScheduleAccount$inboundSchema,
+  PartialScheduleAccount$Outbound,
+  PartialScheduleAccount$outboundSchema,
+} from "./partialscheduleaccount.js";
+import {
+  Recur,
+  Recur$inboundSchema,
+  Recur$Outbound,
+  Recur$outboundSchema,
+} from "./recur.js";
+
+export type ScheduleListResponse = {
+  /**
+   * Simple description to place on the transfer.
+   */
+  description?: string | undefined;
+  destinationAccountID: string;
+  /**
+   * The operating mode for an account.
+   */
+  mode: Mode;
+  occurrences?: Array<OccurrencesResponse> | undefined;
+  ownerAccountID: string;
+  partnerAccountID: string;
+  /**
+   * Defines configuration for recurring transfers.
+   */
+  recur?: Recur | undefined;
+  scheduleID: string;
+  sourceAccountID: string;
+  createdOn: Date;
+  updatedOn: Date;
+  disabledOn?: Date | undefined;
+  sourceAccount?: PartialScheduleAccount | undefined;
+  destinationAccount?: PartialScheduleAccount | undefined;
+  partnerAccount?: PartialScheduleAccount | undefined;
+};
+
+/** @internal */
+export const ScheduleListResponse$inboundSchema: z.ZodType<
+  ScheduleListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string().optional(),
+  destinationAccountID: z.string(),
+  mode: Mode$inboundSchema,
+  occurrences: z.array(OccurrencesResponse$inboundSchema).optional(),
+  ownerAccountID: z.string(),
+  partnerAccountID: z.string(),
+  recur: Recur$inboundSchema.optional(),
+  scheduleID: z.string(),
+  sourceAccountID: z.string(),
+  createdOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updatedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  disabledOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  sourceAccount: PartialScheduleAccount$inboundSchema.optional(),
+  destinationAccount: PartialScheduleAccount$inboundSchema.optional(),
+  partnerAccount: PartialScheduleAccount$inboundSchema.optional(),
+});
+
+/** @internal */
+export type ScheduleListResponse$Outbound = {
+  description?: string | undefined;
+  destinationAccountID: string;
+  mode: string;
+  occurrences?: Array<OccurrencesResponse$Outbound> | undefined;
+  ownerAccountID: string;
+  partnerAccountID: string;
+  recur?: Recur$Outbound | undefined;
+  scheduleID: string;
+  sourceAccountID: string;
+  createdOn: string;
+  updatedOn: string;
+  disabledOn?: string | undefined;
+  sourceAccount?: PartialScheduleAccount$Outbound | undefined;
+  destinationAccount?: PartialScheduleAccount$Outbound | undefined;
+  partnerAccount?: PartialScheduleAccount$Outbound | undefined;
+};
+
+/** @internal */
+export const ScheduleListResponse$outboundSchema: z.ZodType<
+  ScheduleListResponse$Outbound,
+  z.ZodTypeDef,
+  ScheduleListResponse
+> = z.object({
+  description: z.string().optional(),
+  destinationAccountID: z.string(),
+  mode: Mode$outboundSchema,
+  occurrences: z.array(OccurrencesResponse$outboundSchema).optional(),
+  ownerAccountID: z.string(),
+  partnerAccountID: z.string(),
+  recur: Recur$outboundSchema.optional(),
+  scheduleID: z.string(),
+  sourceAccountID: z.string(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  updatedOn: z.date().transform(v => v.toISOString()),
+  disabledOn: z.date().transform(v => v.toISOString()).optional(),
+  sourceAccount: PartialScheduleAccount$outboundSchema.optional(),
+  destinationAccount: PartialScheduleAccount$outboundSchema.optional(),
+  partnerAccount: PartialScheduleAccount$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 ScheduleListResponse$ {
+  /** @deprecated use `ScheduleListResponse$inboundSchema` instead. */
+  export const inboundSchema = ScheduleListResponse$inboundSchema;
+  /** @deprecated use `ScheduleListResponse$outboundSchema` instead. */
+  export const outboundSchema = ScheduleListResponse$outboundSchema;
+  /** @deprecated use `ScheduleListResponse$Outbound` instead. */
+  export type Outbound = ScheduleListResponse$Outbound;
+}
+
+export function scheduleListResponseToJSON(
+  scheduleListResponse: ScheduleListResponse,
+): string {
+  return JSON.stringify(
+    ScheduleListResponse$outboundSchema.parse(scheduleListResponse),
+  );
+}
+
+export function scheduleListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ScheduleListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScheduleListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScheduleListResponse' from JSON`,
+  );
+}

package/src/models/components/taxid.ts

@@ -7,7 +7,7 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type TaxIDEin = {
+export type Ein = {
   number: string;
 };
 
@@ -15,68 +15,62 @@ export type TaxIDEin = {
  * An EIN (employer identification number) for the business. For sole proprietors, an SSN can be used as the EIN.
  */
 export type TaxID = {
-  ein: TaxIDEin;
+  ein: Ein;
 };
 
 /** @internal */
-export const TaxIDEin$inboundSchema: z.ZodType<
-  TaxIDEin,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  number: z.string(),
-});
+export const Ein$inboundSchema: z.ZodType<Ein, z.ZodTypeDef, unknown> = z
+  .object({
+    number: z.string(),
+  });
 
 /** @internal */
-export type TaxIDEin$Outbound = {
+export type Ein$Outbound = {
   number: string;
 };
 
 /** @internal */
-export const TaxIDEin$outboundSchema: z.ZodType<
-  TaxIDEin$Outbound,
-  z.ZodTypeDef,
-  TaxIDEin
-> = z.object({
-  number: z.string(),
-});
+export const Ein$outboundSchema: z.ZodType<Ein$Outbound, z.ZodTypeDef, Ein> = z
+  .object({
+    number: z.string(),
+  });
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace TaxIDEin$ {
-  /** @deprecated use `TaxIDEin$inboundSchema` instead. */
-  export const inboundSchema = TaxIDEin$inboundSchema;
-  /** @deprecated use `TaxIDEin$outboundSchema` instead. */
-  export const outboundSchema = TaxIDEin$outboundSchema;
-  /** @deprecated use `TaxIDEin$Outbound` instead. */
-  export type Outbound = TaxIDEin$Outbound;
+export namespace Ein$ {
+  /** @deprecated use `Ein$inboundSchema` instead. */
+  export const inboundSchema = Ein$inboundSchema;
+  /** @deprecated use `Ein$outboundSchema` instead. */
+  export const outboundSchema = Ein$outboundSchema;
+  /** @deprecated use `Ein$Outbound` instead. */
+  export type Outbound = Ein$Outbound;
 }
 
-export function taxIDEinToJSON(taxIDEin: TaxIDEin): string {
-  return JSON.stringify(TaxIDEin$outboundSchema.parse(taxIDEin));
+export function einToJSON(ein: Ein): string {
+  return JSON.stringify(Ein$outboundSchema.parse(ein));
 }
 
-export function taxIDEinFromJSON(
+export function einFromJSON(
   jsonString: string,
-): SafeParseResult<TaxIDEin, SDKValidationError> {
+): SafeParseResult<Ein, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => TaxIDEin$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TaxIDEin' from JSON`,
+    (x) => Ein$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Ein' from JSON`,
   );
 }
 
 /** @internal */
 export const TaxID$inboundSchema: z.ZodType<TaxID, z.ZodTypeDef, unknown> = z
   .object({
-    ein: z.lazy(() => TaxIDEin$inboundSchema),
+    ein: z.lazy(() => Ein$inboundSchema),
   });
 
 /** @internal */
 export type TaxID$Outbound = {
-  ein: TaxIDEin$Outbound;
+  ein: Ein$Outbound;
 };
 
 /** @internal */
@@ -85,7 +79,7 @@ export const TaxID$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TaxID
 > = z.object({
-  ein: z.lazy(() => TaxIDEin$outboundSchema),
+  ein: z.lazy(() => Ein$outboundSchema),
 });
 
 /**

package/src/models/components/taxidupdate.ts

@@ -7,7 +7,7 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type Ein = {
+export type TaxIDUpdateEin = {
   number?: string | undefined;
 };
 
@@ -15,50 +15,56 @@ export type Ein = {
  * An EIN (employer identification number) for the business. For sole proprietors, an SSN can be used as the EIN.
  */
 export type TaxIDUpdate = {
-  ein?: Ein | undefined;
+  ein?: TaxIDUpdateEin | undefined;
 };
 
 /** @internal */
-export const Ein$inboundSchema: z.ZodType<Ein, z.ZodTypeDef, unknown> = z
-  .object({
-    number: z.string().optional(),
-  });
+export const TaxIDUpdateEin$inboundSchema: z.ZodType<
+  TaxIDUpdateEin,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  number: z.string().optional(),
+});
 
 /** @internal */
-export type Ein$Outbound = {
+export type TaxIDUpdateEin$Outbound = {
   number?: string | undefined;
 };
 
 /** @internal */
-export const Ein$outboundSchema: z.ZodType<Ein$Outbound, z.ZodTypeDef, Ein> = z
-  .object({
-    number: z.string().optional(),
-  });
+export const TaxIDUpdateEin$outboundSchema: z.ZodType<
+  TaxIDUpdateEin$Outbound,
+  z.ZodTypeDef,
+  TaxIDUpdateEin
+> = z.object({
+  number: 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 Ein$ {
-  /** @deprecated use `Ein$inboundSchema` instead. */
-  export const inboundSchema = Ein$inboundSchema;
-  /** @deprecated use `Ein$outboundSchema` instead. */
-  export const outboundSchema = Ein$outboundSchema;
-  /** @deprecated use `Ein$Outbound` instead. */
-  export type Outbound = Ein$Outbound;
+export namespace TaxIDUpdateEin$ {
+  /** @deprecated use `TaxIDUpdateEin$inboundSchema` instead. */
+  export const inboundSchema = TaxIDUpdateEin$inboundSchema;
+  /** @deprecated use `TaxIDUpdateEin$outboundSchema` instead. */
+  export const outboundSchema = TaxIDUpdateEin$outboundSchema;
+  /** @deprecated use `TaxIDUpdateEin$Outbound` instead. */
+  export type Outbound = TaxIDUpdateEin$Outbound;
 }
 
-export function einToJSON(ein: Ein): string {
-  return JSON.stringify(Ein$outboundSchema.parse(ein));
+export function taxIDUpdateEinToJSON(taxIDUpdateEin: TaxIDUpdateEin): string {
+  return JSON.stringify(TaxIDUpdateEin$outboundSchema.parse(taxIDUpdateEin));
 }
 
-export function einFromJSON(
+export function taxIDUpdateEinFromJSON(
   jsonString: string,
-): SafeParseResult<Ein, SDKValidationError> {
+): SafeParseResult<TaxIDUpdateEin, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Ein$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Ein' from JSON`,
+    (x) => TaxIDUpdateEin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TaxIDUpdateEin' from JSON`,
   );
 }
 
@@ -68,12 +74,12 @@ export const TaxIDUpdate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  ein: z.lazy(() => Ein$inboundSchema).optional(),
+  ein: z.lazy(() => TaxIDUpdateEin$inboundSchema).optional(),
 });
 
 /** @internal */
 export type TaxIDUpdate$Outbound = {
-  ein?: Ein$Outbound | undefined;
+  ein?: TaxIDUpdateEin$Outbound | undefined;
 };
 
 /** @internal */
@@ -82,7 +88,7 @@ export const TaxIDUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TaxIDUpdate
 > = z.object({
-  ein: z.lazy(() => Ein$outboundSchema).optional(),
+  ein: z.lazy(() => TaxIDUpdateEin$outboundSchema).optional(),
 });
 
 /**

package/src/models/components/terminalcard.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 {
+  CardBrand,
+  CardBrand$inboundSchema,
+  CardBrand$outboundSchema,
+} from "./cardbrand.js";
+import {
+  CardExpiration,
+  CardExpiration$inboundSchema,
+  CardExpiration$Outbound,
+  CardExpiration$outboundSchema,
+} from "./cardexpiration.js";
+import {
+  CardType,
+  CardType$inboundSchema,
+  CardType$outboundSchema,
+} from "./cardtype.js";
+import {
+  EntryMode,
+  EntryMode$inboundSchema,
+  EntryMode$outboundSchema,
+} from "./entrymode.js";
+
+/**
+ * Describes payment card details captured with tap or in-person payment.
+ */
+export type TerminalCard = {
+  /**
+   * How the card information was entered into the point of sale terminal.
+   */
+  entryMode?: EntryMode | undefined;
+  /**
+   * The card brand.
+   */
+  brand?: CardBrand | undefined;
+  bin?: string | undefined;
+  /**
+   * The type of the card.
+   */
+  cardType?: CardType | undefined;
+  /**
+   * The expiration date of the card or token.
+   */
+  expiration?: CardExpiration | undefined;
+  /**
+   * Uniquely identifies a linked payment card or token.
+   *
+   * @remarks
+   * For Apple Pay, the fingerprint is based on the tokenized card number and may vary based on the user's device.
+   * This field can be used to identify specific payment methods across multiple accounts on your platform.
+   */
+  fingerprint?: string | undefined;
+  /**
+   * The name of the cardholder as it appears on the card.
+   */
+  holderName?: string | undefined;
+  /**
+   * Financial institution that issued the card.
+   */
+  issuer?: string | undefined;
+  /**
+   * Country where the card was issued.
+   */
+  issuerCountry?: string | undefined;
+  /**
+   * Last four digits of the card number
+   */
+  lastFourCardNumber?: string | undefined;
+};
+
+/** @internal */
+export const TerminalCard$inboundSchema: z.ZodType<
+  TerminalCard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entryMode: EntryMode$inboundSchema.optional(),
+  brand: CardBrand$inboundSchema.optional(),
+  bin: z.string().optional(),
+  cardType: CardType$inboundSchema.optional(),
+  expiration: CardExpiration$inboundSchema.optional(),
+  fingerprint: z.string().optional(),
+  holderName: z.string().optional(),
+  issuer: z.string().optional(),
+  issuerCountry: z.string().optional(),
+  lastFourCardNumber: z.string().optional(),
+});
+
+/** @internal */
+export type TerminalCard$Outbound = {
+  entryMode?: string | undefined;
+  brand?: string | undefined;
+  bin?: string | undefined;
+  cardType?: string | undefined;
+  expiration?: CardExpiration$Outbound | undefined;
+  fingerprint?: string | undefined;
+  holderName?: string | undefined;
+  issuer?: string | undefined;
+  issuerCountry?: string | undefined;
+  lastFourCardNumber?: string | undefined;
+};
+
+/** @internal */
+export const TerminalCard$outboundSchema: z.ZodType<
+  TerminalCard$Outbound,
+  z.ZodTypeDef,
+  TerminalCard
+> = z.object({
+  entryMode: EntryMode$outboundSchema.optional(),
+  brand: CardBrand$outboundSchema.optional(),
+  bin: z.string().optional(),
+  cardType: CardType$outboundSchema.optional(),
+  expiration: CardExpiration$outboundSchema.optional(),
+  fingerprint: z.string().optional(),
+  holderName: z.string().optional(),
+  issuer: z.string().optional(),
+  issuerCountry: z.string().optional(),
+  lastFourCardNumber: 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 TerminalCard$ {
+  /** @deprecated use `TerminalCard$inboundSchema` instead. */
+  export const inboundSchema = TerminalCard$inboundSchema;
+  /** @deprecated use `TerminalCard$outboundSchema` instead. */
+  export const outboundSchema = TerminalCard$outboundSchema;
+  /** @deprecated use `TerminalCard$Outbound` instead. */
+  export type Outbound = TerminalCard$Outbound;
+}
+
+export function terminalCardToJSON(terminalCard: TerminalCard): string {
+  return JSON.stringify(TerminalCard$outboundSchema.parse(terminalCard));
+}
+
+export function terminalCardFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminalCard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminalCard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminalCard' from JSON`,
+  );
+}

package/src/models/operations/listschedules.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -26,15 +27,21 @@ export type ListSchedulesGlobals = {
   xMoovVersion?: string | undefined;
 };
 
+export const Hydrate = {
+  Accounts: "accounts",
+} as const;
+export type Hydrate = ClosedEnum<typeof Hydrate>;
+
 export type ListSchedulesRequest = {
   skip?: number | undefined;
   count?: number | undefined;
+  hydrate?: Hydrate | undefined;
   accountID: string;
 };
 
 export type ListSchedulesResponse = {
   headers: { [k: string]: Array<string> };
-  result: Array<components.ScheduleResponse>;
+  result: Array<components.ScheduleListResponse>;
 };
 
 /** @internal */
@@ -99,6 +106,25 @@ export function listSchedulesGlobalsFromJSON(
   );
 }
 
+/** @internal */
+export const Hydrate$inboundSchema: z.ZodNativeEnum<typeof Hydrate> = z
+  .nativeEnum(Hydrate);
+
+/** @internal */
+export const Hydrate$outboundSchema: z.ZodNativeEnum<typeof Hydrate> =
+  Hydrate$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Hydrate$ {
+  /** @deprecated use `Hydrate$inboundSchema` instead. */
+  export const inboundSchema = Hydrate$inboundSchema;
+  /** @deprecated use `Hydrate$outboundSchema` instead. */
+  export const outboundSchema = Hydrate$outboundSchema;
+}
+
 /** @internal */
 export const ListSchedulesRequest$inboundSchema: z.ZodType<
   ListSchedulesRequest,
@@ -107,6 +133,7 @@ export const ListSchedulesRequest$inboundSchema: z.ZodType<
 > = z.object({
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
+  hydrate: Hydrate$inboundSchema.optional(),
   accountID: z.string(),
 });
 
@@ -114,6 +141,7 @@ export const ListSchedulesRequest$inboundSchema: z.ZodType<
 export type ListSchedulesRequest$Outbound = {
   skip?: number | undefined;
   count?: number | undefined;
+  hydrate?: string | undefined;
   accountID: string;
 };
 
@@ -125,6 +153,7 @@ export const ListSchedulesRequest$outboundSchema: z.ZodType<
 > = z.object({
   skip: z.number().int().optional(),
   count: z.number().int().optional(),
+  hydrate: Hydrate$outboundSchema.optional(),
   accountID: z.string(),
 });
 
@@ -166,7 +195,7 @@ export const ListSchedulesResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   Headers: z.record(z.array(z.string())),
-  Result: z.array(components.ScheduleResponse$inboundSchema),
+  Result: z.array(components.ScheduleListResponse$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "Headers": "headers",
@@ -177,7 +206,7 @@ export const ListSchedulesResponse$inboundSchema: z.ZodType<
 /** @internal */
 export type ListSchedulesResponse$Outbound = {
   Headers: { [k: string]: Array<string> };
-  Result: Array<components.ScheduleResponse$Outbound>;
+  Result: Array<components.ScheduleListResponse$Outbound>;
 };
 
 /** @internal */
@@ -187,7 +216,7 @@ export const ListSchedulesResponse$outboundSchema: z.ZodType<
   ListSchedulesResponse
 > = z.object({
   headers: z.record(z.array(z.string())),
-  result: z.array(components.ScheduleResponse$outboundSchema),
+  result: z.array(components.ScheduleListResponse$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     headers: "Headers",

package/src/sdk/scheduling.ts

@@ -31,7 +31,7 @@ export class Scheduling extends ClientSDK {
   }
 
   /**
-   * Describes a list of schedules associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.
+   * Describes a list of schedules associated with an account. Append the `hydrate=accounts` query parameter to include partial account details in the response.
    *
    * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
    * you'll need to specify the `/accounts/{accountID}/transfers.read` scope.