@moovio/sdk 0.21.14 → 0.21.16

package/src/models/operations/listinvoices.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListInvoicesGlobals = {
+  /**
+   * 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.
+   * When no version is specified, the API defaults to `v2024.01.00`.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type ListInvoicesRequest = {
+  skip?: number | undefined;
+  count?: number | undefined;
+  status?: components.InvoiceStatus | undefined;
+  customerAccountID?: string | undefined;
+  accountID: string;
+};
+
+export type ListInvoicesResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.Invoice>;
+};
+
+/** @internal */
+export const ListInvoicesGlobals$inboundSchema: z.ZodType<
+  ListInvoicesGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+/** @internal */
+export type ListInvoicesGlobals$Outbound = {
+  "X-Moov-Version"?: string | undefined;
+};
+
+/** @internal */
+export const ListInvoicesGlobals$outboundSchema: z.ZodType<
+  ListInvoicesGlobals$Outbound,
+  z.ZodTypeDef,
+  ListInvoicesGlobals
+> = z.object({
+  xMoovVersion: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+export function listInvoicesGlobalsToJSON(
+  listInvoicesGlobals: ListInvoicesGlobals,
+): string {
+  return JSON.stringify(
+    ListInvoicesGlobals$outboundSchema.parse(listInvoicesGlobals),
+  );
+}
+export function listInvoicesGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInvoicesGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInvoicesGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInvoicesGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInvoicesRequest$inboundSchema: z.ZodType<
+  ListInvoicesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+  status: components.InvoiceStatus$inboundSchema.optional(),
+  customerAccountID: z.string().optional(),
+  accountID: z.string(),
+});
+/** @internal */
+export type ListInvoicesRequest$Outbound = {
+  skip?: number | undefined;
+  count?: number | undefined;
+  status?: string | undefined;
+  customerAccountID?: string | undefined;
+  accountID: string;
+};
+
+/** @internal */
+export const ListInvoicesRequest$outboundSchema: z.ZodType<
+  ListInvoicesRequest$Outbound,
+  z.ZodTypeDef,
+  ListInvoicesRequest
+> = z.object({
+  skip: z.number().int().optional(),
+  count: z.number().int().optional(),
+  status: components.InvoiceStatus$outboundSchema.optional(),
+  customerAccountID: z.string().optional(),
+  accountID: z.string(),
+});
+
+export function listInvoicesRequestToJSON(
+  listInvoicesRequest: ListInvoicesRequest,
+): string {
+  return JSON.stringify(
+    ListInvoicesRequest$outboundSchema.parse(listInvoicesRequest),
+  );
+}
+export function listInvoicesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInvoicesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInvoicesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInvoicesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInvoicesResponse$inboundSchema: z.ZodType<
+  ListInvoicesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.array(components.Invoice$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type ListInvoicesResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.Invoice$Outbound>;
+};
+
+/** @internal */
+export const ListInvoicesResponse$outboundSchema: z.ZodType<
+  ListInvoicesResponse$Outbound,
+  z.ZodTypeDef,
+  ListInvoicesResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.Invoice$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function listInvoicesResponseToJSON(
+  listInvoicesResponse: ListInvoicesResponse,
+): string {
+  return JSON.stringify(
+    ListInvoicesResponse$outboundSchema.parse(listInvoicesResponse),
+  );
+}
+export function listInvoicesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInvoicesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInvoicesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInvoicesResponse' from JSON`,
+  );
+}

package/src/models/operations/markpaidinvoice.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MarkPaidInvoiceGlobals = {
+  /**
+   * 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.
+   * When no version is specified, the API defaults to `v2024.01.00`.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type MarkPaidInvoiceRequest = {
+  accountID: string;
+  invoiceID: string;
+  markInvoicePaid: components.MarkInvoicePaid;
+};
+
+export type MarkPaidInvoiceResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Invoice;
+};
+
+/** @internal */
+export const MarkPaidInvoiceGlobals$inboundSchema: z.ZodType<
+  MarkPaidInvoiceGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+/** @internal */
+export type MarkPaidInvoiceGlobals$Outbound = {
+  "X-Moov-Version"?: string | undefined;
+};
+
+/** @internal */
+export const MarkPaidInvoiceGlobals$outboundSchema: z.ZodType<
+  MarkPaidInvoiceGlobals$Outbound,
+  z.ZodTypeDef,
+  MarkPaidInvoiceGlobals
+> = z.object({
+  xMoovVersion: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+export function markPaidInvoiceGlobalsToJSON(
+  markPaidInvoiceGlobals: MarkPaidInvoiceGlobals,
+): string {
+  return JSON.stringify(
+    MarkPaidInvoiceGlobals$outboundSchema.parse(markPaidInvoiceGlobals),
+  );
+}
+export function markPaidInvoiceGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<MarkPaidInvoiceGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarkPaidInvoiceGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarkPaidInvoiceGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const MarkPaidInvoiceRequest$inboundSchema: z.ZodType<
+  MarkPaidInvoiceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  invoiceID: z.string(),
+  MarkInvoicePaid: components.MarkInvoicePaid$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "MarkInvoicePaid": "markInvoicePaid",
+  });
+});
+/** @internal */
+export type MarkPaidInvoiceRequest$Outbound = {
+  accountID: string;
+  invoiceID: string;
+  MarkInvoicePaid: components.MarkInvoicePaid$Outbound;
+};
+
+/** @internal */
+export const MarkPaidInvoiceRequest$outboundSchema: z.ZodType<
+  MarkPaidInvoiceRequest$Outbound,
+  z.ZodTypeDef,
+  MarkPaidInvoiceRequest
+> = z.object({
+  accountID: z.string(),
+  invoiceID: z.string(),
+  markInvoicePaid: components.MarkInvoicePaid$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    markInvoicePaid: "MarkInvoicePaid",
+  });
+});
+
+export function markPaidInvoiceRequestToJSON(
+  markPaidInvoiceRequest: MarkPaidInvoiceRequest,
+): string {
+  return JSON.stringify(
+    MarkPaidInvoiceRequest$outboundSchema.parse(markPaidInvoiceRequest),
+  );
+}
+export function markPaidInvoiceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<MarkPaidInvoiceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarkPaidInvoiceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarkPaidInvoiceRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const MarkPaidInvoiceResponse$inboundSchema: z.ZodType<
+  MarkPaidInvoiceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.Invoice$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type MarkPaidInvoiceResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Invoice$Outbound;
+};
+
+/** @internal */
+export const MarkPaidInvoiceResponse$outboundSchema: z.ZodType<
+  MarkPaidInvoiceResponse$Outbound,
+  z.ZodTypeDef,
+  MarkPaidInvoiceResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Invoice$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function markPaidInvoiceResponseToJSON(
+  markPaidInvoiceResponse: MarkPaidInvoiceResponse,
+): string {
+  return JSON.stringify(
+    MarkPaidInvoiceResponse$outboundSchema.parse(markPaidInvoiceResponse),
+  );
+}
+export function markPaidInvoiceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MarkPaidInvoiceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarkPaidInvoiceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarkPaidInvoiceResponse' from JSON`,
+  );
+}

package/src/models/operations/updateinvoice.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UpdateInvoiceGlobals = {
+  /**
+   * 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.
+   * When no version is specified, the API defaults to `v2024.01.00`.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type UpdateInvoiceRequest = {
+  accountID: string;
+  invoiceID: string;
+  updateInvoice: components.UpdateInvoice;
+};
+
+export type UpdateInvoiceResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Invoice;
+};
+
+/** @internal */
+export const UpdateInvoiceGlobals$inboundSchema: z.ZodType<
+  UpdateInvoiceGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "X-Moov-Version": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "X-Moov-Version": "xMoovVersion",
+  });
+});
+/** @internal */
+export type UpdateInvoiceGlobals$Outbound = {
+  "X-Moov-Version"?: string | undefined;
+};
+
+/** @internal */
+export const UpdateInvoiceGlobals$outboundSchema: z.ZodType<
+  UpdateInvoiceGlobals$Outbound,
+  z.ZodTypeDef,
+  UpdateInvoiceGlobals
+> = z.object({
+  xMoovVersion: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "X-Moov-Version",
+  });
+});
+
+export function updateInvoiceGlobalsToJSON(
+  updateInvoiceGlobals: UpdateInvoiceGlobals,
+): string {
+  return JSON.stringify(
+    UpdateInvoiceGlobals$outboundSchema.parse(updateInvoiceGlobals),
+  );
+}
+export function updateInvoiceGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateInvoiceGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateInvoiceGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateInvoiceGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateInvoiceRequest$inboundSchema: z.ZodType<
+  UpdateInvoiceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  invoiceID: z.string(),
+  UpdateInvoice: components.UpdateInvoice$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "UpdateInvoice": "updateInvoice",
+  });
+});
+/** @internal */
+export type UpdateInvoiceRequest$Outbound = {
+  accountID: string;
+  invoiceID: string;
+  UpdateInvoice: components.UpdateInvoice$Outbound;
+};
+
+/** @internal */
+export const UpdateInvoiceRequest$outboundSchema: z.ZodType<
+  UpdateInvoiceRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateInvoiceRequest
+> = z.object({
+  accountID: z.string(),
+  invoiceID: z.string(),
+  updateInvoice: components.UpdateInvoice$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    updateInvoice: "UpdateInvoice",
+  });
+});
+
+export function updateInvoiceRequestToJSON(
+  updateInvoiceRequest: UpdateInvoiceRequest,
+): string {
+  return JSON.stringify(
+    UpdateInvoiceRequest$outboundSchema.parse(updateInvoiceRequest),
+  );
+}
+export function updateInvoiceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateInvoiceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateInvoiceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateInvoiceRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateInvoiceResponse$inboundSchema: z.ZodType<
+  UpdateInvoiceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.Invoice$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type UpdateInvoiceResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Invoice$Outbound;
+};
+
+/** @internal */
+export const UpdateInvoiceResponse$outboundSchema: z.ZodType<
+  UpdateInvoiceResponse$Outbound,
+  z.ZodTypeDef,
+  UpdateInvoiceResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Invoice$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function updateInvoiceResponseToJSON(
+  updateInvoiceResponse: UpdateInvoiceResponse,
+): string {
+  return JSON.stringify(
+    UpdateInvoiceResponse$outboundSchema.parse(updateInvoiceResponse),
+  );
+}
+export function updateInvoiceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateInvoiceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateInvoiceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateInvoiceResponse' from JSON`,
+  );
+}

package/src/sdk/invoices.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { invoicesCreateInvoice } from "../funcs/invoicesCreateInvoice.js";
+import { invoicesGetInvoice } from "../funcs/invoicesGetInvoice.js";
+import { invoicesListInvoices } from "../funcs/invoicesListInvoices.js";
+import { invoicesMarkPaidInvoice } from "../funcs/invoicesMarkPaidInvoice.js";
+import { invoicesUpdateInvoice } from "../funcs/invoicesUpdateInvoice.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Invoices extends ClientSDK {
+  /**
+   * Create an invoice for a Moov account.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/invoices.write` scope.
+   */
+  async createInvoice(
+    request: operations.CreateInvoiceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateInvoiceResponse> {
+    return unwrapAsync(invoicesCreateInvoice(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all the invoices created under a Moov account.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/invoices.read` scope.
+   */
+  async listInvoices(
+    request: operations.ListInvoicesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListInvoicesResponse> {
+    return unwrapAsync(invoicesListInvoices(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an invoice by ID.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/invoices.read` scope.
+   */
+  async getInvoice(
+    request: operations.GetInvoiceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetInvoiceResponse> {
+    return unwrapAsync(invoicesGetInvoice(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Updates an invoice.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/invoices.write` scope.
+   */
+  async updateInvoice(
+    request: operations.UpdateInvoiceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateInvoiceResponse> {
+    return unwrapAsync(invoicesUpdateInvoice(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Marks an invoice as paid outside of the Moov platform.
+   * If a payment link was created, the corresponding payment link is canceled, but a receipt is still sent.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/invoices.write` scope.
+   */
+  async markPaidInvoice(
+    request: operations.MarkPaidInvoiceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.MarkPaidInvoiceResponse> {
+    return unwrapAsync(invoicesMarkPaidInvoice(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -23,6 +23,7 @@ import { Files } from "./files.js";
 import { Images } from "./images.js";
 import { Industries } from "./industries.js";
 import { Institutions } from "./institutions.js";
+import { Invoices } from "./invoices.js";
 import { IssuingTransactions } from "./issuingtransactions.js";
 import { Onboarding } from "./onboarding.js";
 import { PaymentLinks } from "./paymentlinks.js";
@@ -97,6 +98,11 @@ export class Moov extends ClientSDK {
     return (this._images ??= new Images(this._options));
   }
 
+  private _invoices?: Invoices;
+  get invoices(): Invoices {
+    return (this._invoices ??= new Invoices(this._options));
+  }
+
   private _paymentLinks?: PaymentLinks;
   get paymentLinks(): PaymentLinks {
     return (this._paymentLinks ??= new PaymentLinks(this._options));