@moovio/sdk 0.6.1 → 0.7.0

package/src/models/components/receiptrequest.ts

@@ -0,0 +1,123 @@
+/*
+ * 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 {
+  ReceiptKind,
+  ReceiptKind$inboundSchema,
+  ReceiptKind$outboundSchema,
+} from "./receiptkind.js";
+
+/**
+ * A receipt request for a specific transfer, schedule, or schedule occurrence.
+ */
+export type ReceiptRequest = {
+  /**
+   * The type of receipt being requested.
+   */
+  kind: ReceiptKind;
+  /**
+   * The email address to send the receipt to.
+   *
+   * @remarks
+   * Either email or emailAccountID must be provided, but not both.
+   */
+  email?: string | undefined;
+  /**
+   * The accountID to send the receipt to.
+   *
+   * @remarks
+   * Either email or emailAccountID must be provided, but not both.
+   */
+  emailAccountID?: string | undefined;
+  /**
+   * The ID of the transfer associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forTransferID?: string | undefined;
+  /**
+   * The ID of the schedule associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forScheduleID?: string | undefined;
+  /**
+   * The ID of the schedule occurrence associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forOccurrenceID?: string | undefined;
+};
+
+/** @internal */
+export const ReceiptRequest$inboundSchema: z.ZodType<
+  ReceiptRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: ReceiptKind$inboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+});
+
+/** @internal */
+export type ReceiptRequest$Outbound = {
+  kind: string;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+};
+
+/** @internal */
+export const ReceiptRequest$outboundSchema: z.ZodType<
+  ReceiptRequest$Outbound,
+  z.ZodTypeDef,
+  ReceiptRequest
+> = z.object({
+  kind: ReceiptKind$outboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: 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 ReceiptRequest$ {
+  /** @deprecated use `ReceiptRequest$inboundSchema` instead. */
+  export const inboundSchema = ReceiptRequest$inboundSchema;
+  /** @deprecated use `ReceiptRequest$outboundSchema` instead. */
+  export const outboundSchema = ReceiptRequest$outboundSchema;
+  /** @deprecated use `ReceiptRequest$Outbound` instead. */
+  export type Outbound = ReceiptRequest$Outbound;
+}
+
+export function receiptRequestToJSON(receiptRequest: ReceiptRequest): string {
+  return JSON.stringify(ReceiptRequest$outboundSchema.parse(receiptRequest));
+}
+
+export function receiptRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ReceiptRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReceiptRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReceiptRequest' from JSON`,
+  );
+}

package/src/models/components/receiptresponse.ts

@@ -0,0 +1,157 @@
+/*
+ * 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 {
+  ReceiptKind,
+  ReceiptKind$inboundSchema,
+  ReceiptKind$outboundSchema,
+} from "./receiptkind.js";
+import {
+  SentReceipt,
+  SentReceipt$inboundSchema,
+  SentReceipt$Outbound,
+  SentReceipt$outboundSchema,
+} from "./sentreceipt.js";
+
+export type ReceiptResponse = {
+  /**
+   * Unique identifier for the receipt request.
+   */
+  receiptID: string;
+  /**
+   * AccountID for which the receipt request was created.
+   */
+  createdBy: string;
+  /**
+   * The date and time the receipt was disabled.
+   */
+  disabledOn?: Date | undefined;
+  /**
+   * The type of receipt.
+   */
+  kind: ReceiptKind;
+  /**
+   * The email address the receipt is sent to.
+   *
+   * @remarks
+   * Either email or emailAccountID will be in the response, but not both.
+   */
+  email?: string | undefined;
+  /**
+   * The accountID the receipt is sent to.
+   *
+   * @remarks
+   * Either email or emailAccountID will be in the response, but not both.
+   */
+  emailAccountID?: string | undefined;
+  /**
+   * The ID of the transfer associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forTransferID?: string | undefined;
+  /**
+   * The ID of the schedule associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forScheduleID?: string | undefined;
+  /**
+   * The ID of the schedule occurrence associated with this receipt.
+   *
+   * @remarks
+   * Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.
+   */
+  forOccurrenceID?: string | undefined;
+  /**
+   * The list of receipts that have been sent.
+   */
+  sentFor: Array<SentReceipt>;
+};
+
+/** @internal */
+export const ReceiptResponse$inboundSchema: z.ZodType<
+  ReceiptResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  receiptID: z.string(),
+  createdBy: z.string(),
+  disabledOn: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  kind: ReceiptKind$inboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+  sentFor: z.array(SentReceipt$inboundSchema),
+});
+
+/** @internal */
+export type ReceiptResponse$Outbound = {
+  receiptID: string;
+  createdBy: string;
+  disabledOn?: string | undefined;
+  kind: string;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+  sentFor: Array<SentReceipt$Outbound>;
+};
+
+/** @internal */
+export const ReceiptResponse$outboundSchema: z.ZodType<
+  ReceiptResponse$Outbound,
+  z.ZodTypeDef,
+  ReceiptResponse
+> = z.object({
+  receiptID: z.string(),
+  createdBy: z.string(),
+  disabledOn: z.date().transform(v => v.toISOString()).optional(),
+  kind: ReceiptKind$outboundSchema,
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+  sentFor: z.array(SentReceipt$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReceiptResponse$ {
+  /** @deprecated use `ReceiptResponse$inboundSchema` instead. */
+  export const inboundSchema = ReceiptResponse$inboundSchema;
+  /** @deprecated use `ReceiptResponse$outboundSchema` instead. */
+  export const outboundSchema = ReceiptResponse$outboundSchema;
+  /** @deprecated use `ReceiptResponse$Outbound` instead. */
+  export type Outbound = ReceiptResponse$Outbound;
+}
+
+export function receiptResponseToJSON(
+  receiptResponse: ReceiptResponse,
+): string {
+  return JSON.stringify(ReceiptResponse$outboundSchema.parse(receiptResponse));
+}
+
+export function receiptResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ReceiptResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReceiptResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReceiptResponse' from JSON`,
+  );
+}

package/src/models/components/sentreceipt.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 SentReceipt = {
+  /**
+   * Unique identifier for the receipt.
+   */
+  receiptID: string;
+  /**
+   * The idempotency key used when creating the receipt.
+   */
+  idempotencyKey: string;
+  /**
+   * When the receipt was sent.
+   */
+  sentOn: Date;
+};
+
+/** @internal */
+export const SentReceipt$inboundSchema: z.ZodType<
+  SentReceipt,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  receiptID: z.string(),
+  idempotencyKey: z.string(),
+  sentOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+/** @internal */
+export type SentReceipt$Outbound = {
+  receiptID: string;
+  idempotencyKey: string;
+  sentOn: string;
+};
+
+/** @internal */
+export const SentReceipt$outboundSchema: z.ZodType<
+  SentReceipt$Outbound,
+  z.ZodTypeDef,
+  SentReceipt
+> = z.object({
+  receiptID: z.string(),
+  idempotencyKey: z.string(),
+  sentOn: z.date().transform(v => v.toISOString()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SentReceipt$ {
+  /** @deprecated use `SentReceipt$inboundSchema` instead. */
+  export const inboundSchema = SentReceipt$inboundSchema;
+  /** @deprecated use `SentReceipt$outboundSchema` instead. */
+  export const outboundSchema = SentReceipt$outboundSchema;
+  /** @deprecated use `SentReceipt$Outbound` instead. */
+  export type Outbound = SentReceipt$Outbound;
+}
+
+export function sentReceiptToJSON(sentReceipt: SentReceipt): string {
+  return JSON.stringify(SentReceipt$outboundSchema.parse(sentReceipt));
+}
+
+export function sentReceiptFromJSON(
+  jsonString: string,
+): SafeParseResult<SentReceipt, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SentReceipt$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SentReceipt' from JSON`,
+  );
+}

package/src/models/components/terminalapplication.ts

@@ -34,19 +34,19 @@ export type TerminalApplication = {
    */
   platform: TerminalApplicationPlatform;
   /**
-   * The app bundle identifier of the terminal application. Will be returned if platform is ios.
+   * The app bundle identifier of the terminal application. Will be returned if platform is `ios`.
    */
   appBundleID?: string | undefined;
   /**
-   * The app package name of the terminal application. Will be returned if platform is android.
+   * The app package name of the terminal application. Will be returned if platform is `android`.
    */
   packageName?: string | undefined;
   /**
-   * The app version of the terminal application Will be returned if platform is android.
+   * The app version of the terminal application Will be returned if platform is `android`.
    */
   sha256Digest?: string | undefined;
   /**
-   * The app version of the terminal application Will be returned if platform is android.
+   * The app version of the terminal application Will be returned if platform is `android`.
    */
   versionCode?: string | undefined;
 };

package/src/models/errors/index.ts

@@ -22,6 +22,7 @@ export * from "./linkcarderror.js";
 export * from "./microdepositvalidationerror.js";
 export * from "./onboardinginviteerror.js";
 export * from "./patchsweepconfigerror.js";
+export * from "./receiptvalidationerror.js";
 export * from "./refundvalidationerror.js";
 export * from "./representativevalidationerror.js";
 export * from "./requestcarderror.js";

package/src/models/errors/receiptvalidationerror.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type ReceiptValidationErrorData = {
+  kind?: string | undefined;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+};
+
+export class ReceiptValidationError extends Error {
+  kind?: string | undefined;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ReceiptValidationErrorData;
+
+  constructor(err: ReceiptValidationErrorData) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message);
+    this.data$ = err;
+
+    if (err.kind != null) this.kind = err.kind;
+    if (err.email != null) this.email = err.email;
+    if (err.emailAccountID != null) this.emailAccountID = err.emailAccountID;
+    if (err.forTransferID != null) this.forTransferID = err.forTransferID;
+    if (err.forScheduleID != null) this.forScheduleID = err.forScheduleID;
+    if (err.forOccurrenceID != null) this.forOccurrenceID = err.forOccurrenceID;
+
+    this.name = "ReceiptValidationError";
+  }
+}
+
+/** @internal */
+export const ReceiptValidationError$inboundSchema: z.ZodType<
+  ReceiptValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: z.string().optional(),
+  email: z.string().optional(),
+  emailAccountID: z.string().optional(),
+  forTransferID: z.string().optional(),
+  forScheduleID: z.string().optional(),
+  forOccurrenceID: z.string().optional(),
+})
+  .transform((v) => {
+    return new ReceiptValidationError(v);
+  });
+
+/** @internal */
+export type ReceiptValidationError$Outbound = {
+  kind?: string | undefined;
+  email?: string | undefined;
+  emailAccountID?: string | undefined;
+  forTransferID?: string | undefined;
+  forScheduleID?: string | undefined;
+  forOccurrenceID?: string | undefined;
+};
+
+/** @internal */
+export const ReceiptValidationError$outboundSchema: z.ZodType<
+  ReceiptValidationError$Outbound,
+  z.ZodTypeDef,
+  ReceiptValidationError
+> = z.instanceof(ReceiptValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    kind: z.string().optional(),
+    email: z.string().optional(),
+    emailAccountID: z.string().optional(),
+    forTransferID: z.string().optional(),
+    forScheduleID: z.string().optional(),
+    forOccurrenceID: 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 ReceiptValidationError$ {
+  /** @deprecated use `ReceiptValidationError$inboundSchema` instead. */
+  export const inboundSchema = ReceiptValidationError$inboundSchema;
+  /** @deprecated use `ReceiptValidationError$outboundSchema` instead. */
+  export const outboundSchema = ReceiptValidationError$outboundSchema;
+  /** @deprecated use `ReceiptValidationError$Outbound` instead. */
+  export type Outbound = ReceiptValidationError$Outbound;
+}

package/src/models/operations/createreceipts.ts

@@ -0,0 +1,161 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateReceiptsGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type CreateReceiptsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ReceiptResponse;
+};
+
+/** @internal */
+export const CreateReceiptsGlobals$inboundSchema: z.ZodType<
+  CreateReceiptsGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type CreateReceiptsGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const CreateReceiptsGlobals$outboundSchema: z.ZodType<
+  CreateReceiptsGlobals$Outbound,
+  z.ZodTypeDef,
+  CreateReceiptsGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateReceiptsGlobals$ {
+  /** @deprecated use `CreateReceiptsGlobals$inboundSchema` instead. */
+  export const inboundSchema = CreateReceiptsGlobals$inboundSchema;
+  /** @deprecated use `CreateReceiptsGlobals$outboundSchema` instead. */
+  export const outboundSchema = CreateReceiptsGlobals$outboundSchema;
+  /** @deprecated use `CreateReceiptsGlobals$Outbound` instead. */
+  export type Outbound = CreateReceiptsGlobals$Outbound;
+}
+
+export function createReceiptsGlobalsToJSON(
+  createReceiptsGlobals: CreateReceiptsGlobals,
+): string {
+  return JSON.stringify(
+    CreateReceiptsGlobals$outboundSchema.parse(createReceiptsGlobals),
+  );
+}
+
+export function createReceiptsGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateReceiptsGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateReceiptsGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateReceiptsGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateReceiptsResponse$inboundSchema: z.ZodType<
+  CreateReceiptsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.ReceiptResponse$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type CreateReceiptsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.ReceiptResponse$Outbound;
+};
+
+/** @internal */
+export const CreateReceiptsResponse$outboundSchema: z.ZodType<
+  CreateReceiptsResponse$Outbound,
+  z.ZodTypeDef,
+  CreateReceiptsResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.ReceiptResponse$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateReceiptsResponse$ {
+  /** @deprecated use `CreateReceiptsResponse$inboundSchema` instead. */
+  export const inboundSchema = CreateReceiptsResponse$inboundSchema;
+  /** @deprecated use `CreateReceiptsResponse$outboundSchema` instead. */
+  export const outboundSchema = CreateReceiptsResponse$outboundSchema;
+  /** @deprecated use `CreateReceiptsResponse$Outbound` instead. */
+  export type Outbound = CreateReceiptsResponse$Outbound;
+}
+
+export function createReceiptsResponseToJSON(
+  createReceiptsResponse: CreateReceiptsResponse,
+): string {
+  return JSON.stringify(
+    CreateReceiptsResponse$outboundSchema.parse(createReceiptsResponse),
+  );
+}
+
+export function createReceiptsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateReceiptsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateReceiptsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateReceiptsResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -15,6 +15,7 @@ export * from "./createcancellation.js";
 export * from "./createfeeplanagreements.js";
 export * from "./createonboardinginvite.js";
 export * from "./createpaymentlink.js";
+export * from "./createreceipts.js";
 export * from "./createrepresentative.js";
 export * from "./createreversal.js";
 export * from "./createschedule.js";
@@ -97,6 +98,7 @@ export * from "./listpartnerpricing.js";
 export * from "./listpartnerpricingagreements.js";
 export * from "./listpaymentlinks.js";
 export * from "./listpaymentmethods.js";
+export * from "./listreceipts.js";
 export * from "./listrefunds.js";
 export * from "./listrepresentatives.js";
 export * from "./listschedules.js";