@moovio/sdk 0.0.0-dev.17 → 0.0.0-dev.19

package/src/models/components/collectionpaymentmethodtype.ts

@@ -13,6 +13,7 @@ export const CollectionPaymentMethodType = {
   ApplePay: "apple-pay",
   CardPayment: "card-payment",
   AchDebitCollect: "ach-debit-collect",
+  GooglePay: "google-pay",
 } as const;
 /**
  * Payment methods allowed for collecting a payment.

package/src/models/components/createreversal.ts

@@ -7,12 +7,22 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ReversalAmountDetails,
+  ReversalAmountDetails$inboundSchema,
+  ReversalAmountDetails$Outbound,
+  ReversalAmountDetails$outboundSchema,
+} from "./reversalamountdetails.js";
 
 export type CreateReversal = {
   /**
    * Amount to reverse in cents. Partial amounts will automatically trigger a refund instead of a cancellation.
    */
   amount: number;
+  /**
+   * Breakdown of the reversed amount.
+   */
+  amountDetails?: ReversalAmountDetails | undefined;
 };
 
 /** @internal */
@@ -22,10 +32,12 @@ export const CreateReversal$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: types.number(),
+  amountDetails: types.optional(ReversalAmountDetails$inboundSchema),
 });
 /** @internal */
 export type CreateReversal$Outbound = {
   amount: number;
+  amountDetails?: ReversalAmountDetails$Outbound | undefined;
 };
 
 /** @internal */
@@ -35,6 +47,7 @@ export const CreateReversal$outboundSchema: z.ZodType<
   CreateReversal
 > = z.object({
   amount: z.number().int(),
+  amountDetails: ReversalAmountDetails$outboundSchema.optional(),
 });
 
 export function createReversalToJSON(createReversal: CreateReversal): string {

package/src/models/components/index.ts

@@ -110,6 +110,8 @@ export * from "./cardbrandfees.js";
 export * from "./cardexpiration.js";
 export * from "./cardexpirationerror.js";
 export * from "./cardissuingnetwork.js";
+export * from "./cardmetadata.js";
+export * from "./cardmetadatarequest.js";
 export * from "./cardpaymentdetails.js";
 export * from "./cardpaymentdetailserror.js";
 export * from "./cardpaymentpaymentmethod.js";
@@ -455,6 +457,8 @@ export * from "./resolutionlinkrecipient.js";
 export * from "./resolutionlinkstatus.js";
 export * from "./returnpolicytype.js";
 export * from "./reversal.js";
+export * from "./reversalamountdetails.js";
+export * from "./reversalamountdetailsvalidationerror.js";
 export * from "./reversedwithcancellation.js";
 export * from "./reversedwithrefund.js";
 export * from "./revoketokenrequest.js";

package/src/models/components/reversalamountdetails.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+
+export type ReversalAmountDetails = {
+  /**
+   * The amount of surcharge to refund. Should be proportionate to the surcharge on the original transfer. This does not reply if the reversal resulted in a cancellation instead of a refund
+   */
+  surcharge?: AmountDecimal | undefined;
+};
+
+/** @internal */
+export const ReversalAmountDetails$inboundSchema: z.ZodType<
+  ReversalAmountDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  surcharge: types.optional(AmountDecimal$inboundSchema),
+});
+/** @internal */
+export type ReversalAmountDetails$Outbound = {
+  surcharge?: AmountDecimal$Outbound | undefined;
+};
+
+/** @internal */
+export const ReversalAmountDetails$outboundSchema: z.ZodType<
+  ReversalAmountDetails$Outbound,
+  z.ZodTypeDef,
+  ReversalAmountDetails
+> = z.object({
+  surcharge: AmountDecimal$outboundSchema.optional(),
+});
+
+export function reversalAmountDetailsToJSON(
+  reversalAmountDetails: ReversalAmountDetails,
+): string {
+  return JSON.stringify(
+    ReversalAmountDetails$outboundSchema.parse(reversalAmountDetails),
+  );
+}
+export function reversalAmountDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ReversalAmountDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReversalAmountDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReversalAmountDetails' from JSON`,
+  );
+}

package/src/models/components/reversalamountdetailsvalidationerror.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ReversalAmountDetailsValidationError = {
+  surcharge?: string | undefined;
+};
+
+/** @internal */
+export const ReversalAmountDetailsValidationError$inboundSchema: z.ZodType<
+  ReversalAmountDetailsValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  surcharge: types.optional(types.string()),
+});
+/** @internal */
+export type ReversalAmountDetailsValidationError$Outbound = {
+  surcharge?: string | undefined;
+};
+
+/** @internal */
+export const ReversalAmountDetailsValidationError$outboundSchema: z.ZodType<
+  ReversalAmountDetailsValidationError$Outbound,
+  z.ZodTypeDef,
+  ReversalAmountDetailsValidationError
+> = z.object({
+  surcharge: z.string().optional(),
+});
+
+export function reversalAmountDetailsValidationErrorToJSON(
+  reversalAmountDetailsValidationError: ReversalAmountDetailsValidationError,
+): string {
+  return JSON.stringify(
+    ReversalAmountDetailsValidationError$outboundSchema.parse(
+      reversalAmountDetailsValidationError,
+    ),
+  );
+}
+export function reversalAmountDetailsValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ReversalAmountDetailsValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ReversalAmountDetailsValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReversalAmountDetailsValidationError' from JSON`,
+  );
+}

package/src/models/errors/cardmetadatarequesterror.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { MoovError } from "./mooverror.js";
+
+export type CardMetadataRequestErrorData = {
+  error?: string | undefined;
+  e2ee?: components.End2EndEncryptionError | undefined;
+  cardNumber?: string | undefined;
+};
+
+export class CardMetadataRequestError extends MoovError {
+  error?: string | undefined;
+  e2ee?: components.End2EndEncryptionError | undefined;
+  cardNumber?: string | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: CardMetadataRequestErrorData;
+
+  constructor(
+    err: CardMetadataRequestErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.error != null) this.error = err.error;
+    if (err.e2ee != null) this.e2ee = err.e2ee;
+    if (err.cardNumber != null) this.cardNumber = err.cardNumber;
+
+    this.name = "CardMetadataRequestError";
+  }
+}
+
+/** @internal */
+export const CardMetadataRequestError$inboundSchema: z.ZodType<
+  CardMetadataRequestError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: types.optional(types.string()),
+  e2ee: types.optional(components.End2EndEncryptionError$inboundSchema),
+  cardNumber: types.optional(types.string()),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CardMetadataRequestError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type CardMetadataRequestError$Outbound = {
+  error?: string | undefined;
+  e2ee?: components.End2EndEncryptionError$Outbound | undefined;
+  cardNumber?: string | undefined;
+};
+
+/** @internal */
+export const CardMetadataRequestError$outboundSchema: z.ZodType<
+  CardMetadataRequestError$Outbound,
+  z.ZodTypeDef,
+  CardMetadataRequestError
+> = z.instanceof(CardMetadataRequestError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    error: z.string().optional(),
+    e2ee: components.End2EndEncryptionError$outboundSchema.optional(),
+    cardNumber: z.string().optional(),
+  }));

package/src/models/errors/index.ts

@@ -10,6 +10,7 @@ export * from "./authtokenrequesterror.js";
 export * from "./bankaccountvalidationerror.js";
 export * from "./brandvalidationerror.js";
 export * from "./cardacquiringrefund.js";
+export * from "./cardmetadatarequesterror.js";
 export * from "./connectaccountrequestvalidationerror.js";
 export * from "./createaccounterror.js";
 export * from "./createinvoiceerror.js";

package/src/models/errors/reversalvalidationerror.ts

@@ -4,14 +4,17 @@
 
 import * as z from "zod/v3";
 import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
 import { MoovError } from "./mooverror.js";
 
 export type ReversalValidationErrorData = {
   amount?: string | undefined;
+  amountDetails?: components.ReversalAmountDetailsValidationError | undefined;
 };
 
 export class ReversalValidationError extends MoovError {
   amount?: string | undefined;
+  amountDetails?: components.ReversalAmountDetailsValidationError | undefined;
 
   /** The original data that was passed to this error instance. */
   data$: ReversalValidationErrorData;
@@ -26,6 +29,7 @@ export class ReversalValidationError extends MoovError {
     super(message, httpMeta);
     this.data$ = err;
     if (err.amount != null) this.amount = err.amount;
+    if (err.amountDetails != null) this.amountDetails = err.amountDetails;
 
     this.name = "ReversalValidationError";
   }
@@ -38,6 +42,9 @@ export const ReversalValidationError$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: types.optional(types.string()),
+  amountDetails: types.optional(
+    components.ReversalAmountDetailsValidationError$inboundSchema,
+  ),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),
@@ -53,6 +60,9 @@ export const ReversalValidationError$inboundSchema: z.ZodType<
 /** @internal */
 export type ReversalValidationError$Outbound = {
   amount?: string | undefined;
+  amountDetails?:
+    | components.ReversalAmountDetailsValidationError$Outbound
+    | undefined;
 };
 
 /** @internal */
@@ -64,4 +74,6 @@ export const ReversalValidationError$outboundSchema: z.ZodType<
   .transform(v => v.data$)
   .pipe(z.object({
     amount: z.string().optional(),
+    amountDetails: components
+      .ReversalAmountDetailsValidationError$outboundSchema.optional(),
   }));

package/src/models/operations/getcardmetadata.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 GetCardMetadataResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.CardMetadata;
+};
+
+/** @internal */
+export const GetCardMetadataResponse$inboundSchema: z.ZodType<
+  GetCardMetadataResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.CardMetadata$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+/** @internal */
+export type GetCardMetadataResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.CardMetadata$Outbound;
+};
+
+/** @internal */
+export const GetCardMetadataResponse$outboundSchema: z.ZodType<
+  GetCardMetadataResponse$Outbound,
+  z.ZodTypeDef,
+  GetCardMetadataResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.CardMetadata$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+export function getCardMetadataResponseToJSON(
+  getCardMetadataResponse: GetCardMetadataResponse,
+): string {
+  return JSON.stringify(
+    GetCardMetadataResponse$outboundSchema.parse(getCardMetadataResponse),
+  );
+}
+export function getCardMetadataResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCardMetadataResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCardMetadataResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCardMetadataResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -60,6 +60,7 @@ export * from "./getbrand.js";
 export * from "./getcancellation.js";
 export * from "./getcapability.js";
 export * from "./getcard.js";
+export * from "./getcardmetadata.js";
 export * from "./getdispute.js";
 export * from "./getdisputeevidence.js";
 export * from "./getdisputeevidencedata.js";

package/src/sdk/cards.ts

@@ -4,10 +4,12 @@
 
 import { cardsDisable } from "../funcs/cardsDisable.js";
 import { cardsGet } from "../funcs/cardsGet.js";
+import { cardsGetMetadata } from "../funcs/cardsGetMetadata.js";
 import { cardsLink } from "../funcs/cardsLink.js";
 import { cardsList } from "../funcs/cardsList.js";
 import { cardsUpdate } from "../funcs/cardsUpdate.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";
 
@@ -123,4 +125,23 @@ export class Cards extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Look up metadata for a card without linking it to a Moov account.
+   *
+   * Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance.
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/card-metadata.read` scope.
+   */
+  async getMetadata(
+    request: components.CardMetadataRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCardMetadataResponse> {
+    return unwrapAsync(cardsGetMetadata(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/test/tests/accessToken.test.ts

@@ -0,0 +1,86 @@
+import { describe, expect, test } from "bun:test";
+import { HTTPClient, Moov } from "@moovio/sdk";
+
+/**
+ * Builds a Moov SDK instance whose HTTPClient captures every outgoing
+ * Request without hitting the network. The captured Request can then be
+ * inspected for headers, URL, etc.
+ */
+function captureRequests(opts: ConstructorParameters<typeof Moov>[0]) {
+  const requests: Request[] = [];
+  const httpClient = new HTTPClient({
+    fetcher: async (input, init) => {
+      const req = input instanceof Request ? input : new Request(input, init);
+      requests.push(req.clone());
+      return new Response(null, { status: 200 });
+    },
+  });
+
+  const moov = new Moov({ ...opts, httpClient });
+  return { moov, requests };
+}
+
+describe("accessToken option", () => {
+  test("sets Authorization: Bearer header on outgoing requests", async () => {
+    const { moov, requests } = captureRequests({
+      accessToken: "test-access-token-123",
+    });
+
+    await moov.ping.ping();
+
+    expect(requests.length).toBe(1);
+    expect(requests[0].headers.get("Authorization")).toBe(
+      "Bearer test-access-token-123",
+    );
+  });
+
+  test("applies bearer auth on every request, not just the first", async () => {
+    const { moov, requests } = captureRequests({
+      accessToken: "another-token",
+    });
+
+    await moov.ping.ping();
+    await moov.ping.ping();
+    await moov.ping.ping();
+
+    expect(requests.length).toBe(3);
+    for (const req of requests) {
+      expect(req.headers.get("Authorization")).toBe("Bearer another-token");
+    }
+  });
+
+  test("HTTP Basic auth still works when accessToken is not set", async () => {
+    const { moov, requests } = captureRequests({
+      security: { username: "my-public-key", password: "my-secret-key" },
+    });
+
+    await moov.ping.ping();
+
+    expect(requests.length).toBe(1);
+    const auth = requests[0].headers.get("Authorization");
+    expect(auth).toMatch(/^Basic /);
+
+    // Decode the base64 portion and confirm the credentials round-trip.
+    const encoded = auth!.slice("Basic ".length);
+    const decoded = Buffer.from(encoded, "base64").toString("utf8");
+    expect(decoded).toBe("my-public-key:my-secret-key");
+  });
+
+  test("no Authorization header is sent when neither auth mode is configured", async () => {
+    const { moov, requests } = captureRequests({});
+
+    await moov.ping.ping();
+
+    expect(requests.length).toBe(1);
+    expect(requests[0].headers.get("Authorization")).toBeNull();
+  });
+
+  test("throws at construction when both accessToken and Basic creds are set", () => {
+    expect(() =>
+      new Moov({
+        accessToken: "some-token",
+        security: { username: "u", password: "p" },
+      })
+    ).toThrow(/cannot both be set/i);
+  });
+});