@moovio/sdk 0.5.4 → 0.6.1

package/src/models/errors/transfer.ts

@@ -48,6 +48,7 @@ export type TransferData = {
    */
   moovFeeDetails?: components.MoovFeeDetails | undefined;
   groupID?: string | undefined;
+  cancellations?: Array<components.Cancellation> | undefined;
   refundedAmount?: components.Amount | undefined;
   refunds?: Array<components.CardAcquiringRefund> | undefined;
   disputedAmount?: components.Amount | undefined;
@@ -100,6 +101,7 @@ export class Transfer extends Error {
    */
   moovFeeDetails?: components.MoovFeeDetails | undefined;
   groupID?: string | undefined;
+  cancellations?: Array<components.Cancellation> | undefined;
   refundedAmount?: components.Amount | undefined;
   refunds?: Array<components.CardAcquiringRefund> | undefined;
   disputedAmount?: components.Amount | undefined;
@@ -133,6 +135,7 @@ export class Transfer extends Error {
     if (err.moovFeeDecimal != null) this.moovFeeDecimal = err.moovFeeDecimal;
     if (err.moovFeeDetails != null) this.moovFeeDetails = err.moovFeeDetails;
     if (err.groupID != null) this.groupID = err.groupID;
+    if (err.cancellations != null) this.cancellations = err.cancellations;
     if (err.refundedAmount != null) this.refundedAmount = err.refundedAmount;
     if (err.refunds != null) this.refunds = err.refunds;
     if (err.disputedAmount != null) this.disputedAmount = err.disputedAmount;
@@ -167,6 +170,7 @@ export const Transfer$inboundSchema: z.ZodType<
   moovFeeDecimal: z.string().optional(),
   moovFeeDetails: components.MoovFeeDetails$inboundSchema.optional(),
   groupID: z.string().optional(),
+  cancellations: z.array(components.Cancellation$inboundSchema).optional(),
   refundedAmount: components.Amount$inboundSchema.optional(),
   refunds: z.array(components.CardAcquiringRefund$inboundSchema).optional(),
   disputedAmount: components.Amount$inboundSchema.optional(),
@@ -196,6 +200,7 @@ export type Transfer$Outbound = {
   moovFeeDecimal?: string | undefined;
   moovFeeDetails?: components.MoovFeeDetails$Outbound | undefined;
   groupID?: string | undefined;
+  cancellations?: Array<components.Cancellation$Outbound> | undefined;
   refundedAmount?: components.Amount$Outbound | undefined;
   refunds?: Array<components.CardAcquiringRefund$Outbound> | undefined;
   disputedAmount?: components.Amount$Outbound | undefined;
@@ -228,6 +233,7 @@ export const Transfer$outboundSchema: z.ZodType<
     moovFeeDecimal: z.string().optional(),
     moovFeeDetails: components.MoovFeeDetails$outboundSchema.optional(),
     groupID: z.string().optional(),
+    cancellations: z.array(components.Cancellation$outboundSchema).optional(),
     refundedAmount: components.Amount$outboundSchema.optional(),
     refunds: z.array(components.CardAcquiringRefund$outboundSchema).optional(),
     disputedAmount: components.Amount$outboundSchema.optional(),

package/src/models/operations/createcancellation.ts

@@ -0,0 +1,229 @@
+/*
+ * 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 CreateCancellationGlobals = {
+  /**
+   * 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 CreateCancellationRequest = {
+  /**
+   * The partner's Moov account ID.
+   */
+  accountID: string;
+  /**
+   * The transfer ID to cancel.
+   */
+  transferID: string;
+};
+
+export type CreateCancellationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Cancellation;
+};
+
+/** @internal */
+export const CreateCancellationGlobals$inboundSchema: z.ZodType<
+  CreateCancellationGlobals,
+  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 CreateCancellationGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const CreateCancellationGlobals$outboundSchema: z.ZodType<
+  CreateCancellationGlobals$Outbound,
+  z.ZodTypeDef,
+  CreateCancellationGlobals
+> = 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 CreateCancellationGlobals$ {
+  /** @deprecated use `CreateCancellationGlobals$inboundSchema` instead. */
+  export const inboundSchema = CreateCancellationGlobals$inboundSchema;
+  /** @deprecated use `CreateCancellationGlobals$outboundSchema` instead. */
+  export const outboundSchema = CreateCancellationGlobals$outboundSchema;
+  /** @deprecated use `CreateCancellationGlobals$Outbound` instead. */
+  export type Outbound = CreateCancellationGlobals$Outbound;
+}
+
+export function createCancellationGlobalsToJSON(
+  createCancellationGlobals: CreateCancellationGlobals,
+): string {
+  return JSON.stringify(
+    CreateCancellationGlobals$outboundSchema.parse(createCancellationGlobals),
+  );
+}
+
+export function createCancellationGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCancellationGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCancellationGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCancellationGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateCancellationRequest$inboundSchema: z.ZodType<
+  CreateCancellationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  transferID: z.string(),
+});
+
+/** @internal */
+export type CreateCancellationRequest$Outbound = {
+  accountID: string;
+  transferID: string;
+};
+
+/** @internal */
+export const CreateCancellationRequest$outboundSchema: z.ZodType<
+  CreateCancellationRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCancellationRequest
+> = z.object({
+  accountID: z.string(),
+  transferID: 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 CreateCancellationRequest$ {
+  /** @deprecated use `CreateCancellationRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateCancellationRequest$inboundSchema;
+  /** @deprecated use `CreateCancellationRequest$outboundSchema` instead. */
+  export const outboundSchema = CreateCancellationRequest$outboundSchema;
+  /** @deprecated use `CreateCancellationRequest$Outbound` instead. */
+  export type Outbound = CreateCancellationRequest$Outbound;
+}
+
+export function createCancellationRequestToJSON(
+  createCancellationRequest: CreateCancellationRequest,
+): string {
+  return JSON.stringify(
+    CreateCancellationRequest$outboundSchema.parse(createCancellationRequest),
+  );
+}
+
+export function createCancellationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCancellationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCancellationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCancellationRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateCancellationResponse$inboundSchema: z.ZodType<
+  CreateCancellationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.Cancellation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type CreateCancellationResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Cancellation$Outbound;
+};
+
+/** @internal */
+export const CreateCancellationResponse$outboundSchema: z.ZodType<
+  CreateCancellationResponse$Outbound,
+  z.ZodTypeDef,
+  CreateCancellationResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Cancellation$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 CreateCancellationResponse$ {
+  /** @deprecated use `CreateCancellationResponse$inboundSchema` instead. */
+  export const inboundSchema = CreateCancellationResponse$inboundSchema;
+  /** @deprecated use `CreateCancellationResponse$outboundSchema` instead. */
+  export const outboundSchema = CreateCancellationResponse$outboundSchema;
+  /** @deprecated use `CreateCancellationResponse$Outbound` instead. */
+  export type Outbound = CreateCancellationResponse$Outbound;
+}
+
+export function createCancellationResponseToJSON(
+  createCancellationResponse: CreateCancellationResponse,
+): string {
+  return JSON.stringify(
+    CreateCancellationResponse$outboundSchema.parse(createCancellationResponse),
+  );
+}
+
+export function createCancellationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCancellationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCancellationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCancellationResponse' from JSON`,
+  );
+}

package/src/models/operations/getcancellation.ts

@@ -0,0 +1,236 @@
+/*
+ * 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 GetCancellationGlobals = {
+  /**
+   * 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 GetCancellationRequest = {
+  /**
+   * Moov account ID of the partner or transfer's source or destination.
+   */
+  accountID: string;
+  /**
+   * Identifier for the transfer.
+   */
+  transferID: string;
+  /**
+   * Identifier for the cancellation.
+   */
+  cancellationID: string;
+};
+
+export type GetCancellationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.Cancellation;
+};
+
+/** @internal */
+export const GetCancellationGlobals$inboundSchema: z.ZodType<
+  GetCancellationGlobals,
+  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 GetCancellationGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const GetCancellationGlobals$outboundSchema: z.ZodType<
+  GetCancellationGlobals$Outbound,
+  z.ZodTypeDef,
+  GetCancellationGlobals
+> = 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 GetCancellationGlobals$ {
+  /** @deprecated use `GetCancellationGlobals$inboundSchema` instead. */
+  export const inboundSchema = GetCancellationGlobals$inboundSchema;
+  /** @deprecated use `GetCancellationGlobals$outboundSchema` instead. */
+  export const outboundSchema = GetCancellationGlobals$outboundSchema;
+  /** @deprecated use `GetCancellationGlobals$Outbound` instead. */
+  export type Outbound = GetCancellationGlobals$Outbound;
+}
+
+export function getCancellationGlobalsToJSON(
+  getCancellationGlobals: GetCancellationGlobals,
+): string {
+  return JSON.stringify(
+    GetCancellationGlobals$outboundSchema.parse(getCancellationGlobals),
+  );
+}
+
+export function getCancellationGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCancellationGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCancellationGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCancellationGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCancellationRequest$inboundSchema: z.ZodType<
+  GetCancellationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  transferID: z.string(),
+  cancellationID: z.string(),
+});
+
+/** @internal */
+export type GetCancellationRequest$Outbound = {
+  accountID: string;
+  transferID: string;
+  cancellationID: string;
+};
+
+/** @internal */
+export const GetCancellationRequest$outboundSchema: z.ZodType<
+  GetCancellationRequest$Outbound,
+  z.ZodTypeDef,
+  GetCancellationRequest
+> = z.object({
+  accountID: z.string(),
+  transferID: z.string(),
+  cancellationID: 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 GetCancellationRequest$ {
+  /** @deprecated use `GetCancellationRequest$inboundSchema` instead. */
+  export const inboundSchema = GetCancellationRequest$inboundSchema;
+  /** @deprecated use `GetCancellationRequest$outboundSchema` instead. */
+  export const outboundSchema = GetCancellationRequest$outboundSchema;
+  /** @deprecated use `GetCancellationRequest$Outbound` instead. */
+  export type Outbound = GetCancellationRequest$Outbound;
+}
+
+export function getCancellationRequestToJSON(
+  getCancellationRequest: GetCancellationRequest,
+): string {
+  return JSON.stringify(
+    GetCancellationRequest$outboundSchema.parse(getCancellationRequest),
+  );
+}
+
+export function getCancellationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCancellationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCancellationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCancellationRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCancellationResponse$inboundSchema: z.ZodType<
+  GetCancellationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.Cancellation$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type GetCancellationResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.Cancellation$Outbound;
+};
+
+/** @internal */
+export const GetCancellationResponse$outboundSchema: z.ZodType<
+  GetCancellationResponse$Outbound,
+  z.ZodTypeDef,
+  GetCancellationResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.Cancellation$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 GetCancellationResponse$ {
+  /** @deprecated use `GetCancellationResponse$inboundSchema` instead. */
+  export const inboundSchema = GetCancellationResponse$inboundSchema;
+  /** @deprecated use `GetCancellationResponse$outboundSchema` instead. */
+  export const outboundSchema = GetCancellationResponse$outboundSchema;
+  /** @deprecated use `GetCancellationResponse$Outbound` instead. */
+  export type Outbound = GetCancellationResponse$Outbound;
+}
+
+export function getCancellationResponseToJSON(
+  getCancellationResponse: GetCancellationResponse,
+): string {
+  return JSON.stringify(
+    GetCancellationResponse$outboundSchema.parse(getCancellationResponse),
+  );
+}
+
+export function getCancellationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCancellationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCancellationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCancellationResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -11,6 +11,7 @@ export * from "./createaccesstoken.js";
 export * from "./createaccount.js";
 export * from "./createapplepaysession.js";
 export * from "./createbrand.js";
+export * from "./createcancellation.js";
 export * from "./createfeeplanagreements.js";
 export * from "./createonboardinginvite.js";
 export * from "./createpaymentlink.js";
@@ -38,6 +39,7 @@ export * from "./getavatar.js";
 export * from "./getbankaccount.js";
 export * from "./getbankaccountverification.js";
 export * from "./getbrand.js";
+export * from "./getcancellation.js";
 export * from "./getcapability.js";
 export * from "./getcard.js";
 export * from "./getdispute.js";

package/src/sdk/transfers.ts

@@ -3,9 +3,11 @@
  */
 
 import { transfersCreate } from "../funcs/transfersCreate.js";
+import { transfersCreateCancellation } from "../funcs/transfersCreateCancellation.js";
 import { transfersCreateReversal } from "../funcs/transfersCreateReversal.js";
 import { transfersGenerateOptions } from "../funcs/transfersGenerateOptions.js";
 import { transfersGet } from "../funcs/transfersGet.js";
+import { transfersGetCancellation } from "../funcs/transfersGetCancellation.js";
 import { transfersGetRefund } from "../funcs/transfersGetRefund.js";
 import { transfersInitiateRefund } from "../funcs/transfersInitiateRefund.js";
 import { transfersList } from "../funcs/transfersList.js";
@@ -99,6 +101,40 @@ export class Transfers extends ClientSDK {
     ));
   }
 
+  /**
+   *   Initiate a cancellation for a card, ACH, or queued transfer.
+   *
+   *   To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
+   *   to specify the `/accounts/{accountID}/transfers.write` scope.
+   */
+  async createCancellation(
+    request: operations.CreateCancellationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CreateCancellationResponse> {
+    return unwrapAsync(transfersCreateCancellation(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   *   Get details of a cancellation for a transfer.
+   *
+   *   To access this endpoint using a [token](https://docs.moov.io/api/authentication/access-tokens/) you'll need
+   *   to specify the `/accounts/{accountID}/transfers.read` scope.
+   */
+  async getCancellation(
+    request: operations.GetCancellationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCancellationResponse> {
+    return unwrapAsync(transfersGetCancellation(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Initiate a refund for a card transfer.
    *