@moovio/sdk 0.6.1 → 0.6.2

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/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";

package/src/models/operations/listreceipts.ts

@@ -0,0 +1,222 @@
+/*
+ * 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 ListReceiptsGlobals = {
+  /**
+   * 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 ListReceiptsRequest = {
+  /**
+   * The unique identifier to filter receipts by.
+   */
+  id?: string | undefined;
+};
+
+export type ListReceiptsResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.ReceiptResponse>;
+};
+
+/** @internal */
+export const ListReceiptsGlobals$inboundSchema: z.ZodType<
+  ListReceiptsGlobals,
+  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 ListReceiptsGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const ListReceiptsGlobals$outboundSchema: z.ZodType<
+  ListReceiptsGlobals$Outbound,
+  z.ZodTypeDef,
+  ListReceiptsGlobals
+> = 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 ListReceiptsGlobals$ {
+  /** @deprecated use `ListReceiptsGlobals$inboundSchema` instead. */
+  export const inboundSchema = ListReceiptsGlobals$inboundSchema;
+  /** @deprecated use `ListReceiptsGlobals$outboundSchema` instead. */
+  export const outboundSchema = ListReceiptsGlobals$outboundSchema;
+  /** @deprecated use `ListReceiptsGlobals$Outbound` instead. */
+  export type Outbound = ListReceiptsGlobals$Outbound;
+}
+
+export function listReceiptsGlobalsToJSON(
+  listReceiptsGlobals: ListReceiptsGlobals,
+): string {
+  return JSON.stringify(
+    ListReceiptsGlobals$outboundSchema.parse(listReceiptsGlobals),
+  );
+}
+
+export function listReceiptsGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListReceiptsGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListReceiptsGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListReceiptsGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListReceiptsRequest$inboundSchema: z.ZodType<
+  ListReceiptsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+});
+
+/** @internal */
+export type ListReceiptsRequest$Outbound = {
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ListReceiptsRequest$outboundSchema: z.ZodType<
+  ListReceiptsRequest$Outbound,
+  z.ZodTypeDef,
+  ListReceiptsRequest
+> = z.object({
+  id: 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 ListReceiptsRequest$ {
+  /** @deprecated use `ListReceiptsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListReceiptsRequest$inboundSchema;
+  /** @deprecated use `ListReceiptsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListReceiptsRequest$outboundSchema;
+  /** @deprecated use `ListReceiptsRequest$Outbound` instead. */
+  export type Outbound = ListReceiptsRequest$Outbound;
+}
+
+export function listReceiptsRequestToJSON(
+  listReceiptsRequest: ListReceiptsRequest,
+): string {
+  return JSON.stringify(
+    ListReceiptsRequest$outboundSchema.parse(listReceiptsRequest),
+  );
+}
+
+export function listReceiptsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListReceiptsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListReceiptsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListReceiptsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListReceiptsResponse$inboundSchema: z.ZodType<
+  ListReceiptsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.array(components.ReceiptResponse$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListReceiptsResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.ReceiptResponse$Outbound>;
+};
+
+/** @internal */
+export const ListReceiptsResponse$outboundSchema: z.ZodType<
+  ListReceiptsResponse$Outbound,
+  z.ZodTypeDef,
+  ListReceiptsResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(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 ListReceiptsResponse$ {
+  /** @deprecated use `ListReceiptsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListReceiptsResponse$inboundSchema;
+  /** @deprecated use `ListReceiptsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListReceiptsResponse$outboundSchema;
+  /** @deprecated use `ListReceiptsResponse$Outbound` instead. */
+  export type Outbound = ListReceiptsResponse$Outbound;
+}
+
+export function listReceiptsResponseToJSON(
+  listReceiptsResponse: ListReceiptsResponse,
+): string {
+  return JSON.stringify(
+    ListReceiptsResponse$outboundSchema.parse(listReceiptsResponse),
+  );
+}
+
+export function listReceiptsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListReceiptsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListReceiptsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListReceiptsResponse' from JSON`,
+  );
+}

package/src/sdk/receipts.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { receiptsCreate } from "../funcs/receiptsCreate.js";
+import { receiptsList } from "../funcs/receiptsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Receipts extends ClientSDK {
+  /**
+   *  Create receipts for transfers and scheduled transfers.
+   *
+   *  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.write` scope.
+   */
+  async create(
+    request: Array<components.ReceiptRequest>,
+    options?: RequestOptions,
+  ): Promise<operations.CreateReceiptsResponse> {
+    return unwrapAsync(receiptsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List receipts by trasnferID, scheduleID, or occurrenceID.
+   *
+   * 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.
+   */
+  async list(
+    request: operations.ListReceiptsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListReceiptsResponse> {
+    return unwrapAsync(receiptsList(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -26,6 +26,7 @@ import { Onboarding } from "./onboarding.js";
 import { PaymentLinks } from "./paymentlinks.js";
 import { PaymentMethods } from "./paymentmethods.js";
 import { Ping } from "./ping.js";
+import { Receipts } from "./receipts.js";
 import { Representatives } from "./representatives.js";
 import { Scheduling } from "./scheduling.js";
 import { Sweeps } from "./sweeps.js";
@@ -188,6 +189,11 @@ export class Moov extends ClientSDK {
     return (this._ping ??= new Ping(this._options));
   }
 
+  private _receipts?: Receipts;
+  get receipts(): Receipts {
+    return (this._receipts ??= new Receipts(this._options));
+  }
+
   private _terminalApplications?: TerminalApplications;
   get terminalApplications(): TerminalApplications {
     return (this._terminalApplications ??= new TerminalApplications(