@movmo_app/payments 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -126,6 +126,14 @@ export declare interface CreateMovmoAuthFetchOptions {
     readCookie?: (name: string) => string | null;
 }
 
+/**
+ * The cardholder/zip subset of {@link UpdatePaymentMethodPatch} that the Edit
+ * flow (MOVMO-381) can mutate. Derived via `Pick` so it stays in sync if the
+ * editable field set grows — shared by the modal, the manager, and
+ * `useUpdatePaymentMethod` so the patch shape isn't restated in three places.
+ */
+declare type EditablePaymentMethodFields = Pick<UpdatePaymentMethodPatch, 'cardholderName' | 'zip'>;
+
 export declare const getPaymentsConfig: () => InternalPaymentsConfig;
 
 /* Excluded from this release type: InternalPaymentsConfig */
@@ -296,6 +304,22 @@ export declare interface PaymentMethodSummary {
     expMonth: number;
     expYear: number;
     isDefault: boolean;
+    /**
+     * Which vault the row lives in. monolith-api returns this on every row
+     * post-MOVMO-381. Only `'spreedly'` rows accept cardholder/zip metadata
+     * edits — Stripe rows are immutable on those fields and the backend rejects
+     * the patch (4xx). The Edit menu item in PaymentMethodsManager is gated on
+     * this value.
+     *
+     * Optional so the UI doesn't crash on pre-MOVMO-381 monolith deployments
+     * that haven't shipped the new field yet — those rows behave as if
+     * Edit isn't available.
+     */
+    vault?: 'stripe' | 'spreedly';
+    /** Current cardholder name (MOVMO-381). Empty/absent for legacy rows. */
+    cardholderName?: string;
+    /** Current billing ZIP (MOVMO-381). Empty/absent for legacy rows. */
+    zip?: string;
 }
 
 export declare interface PaymentsConfig {
@@ -319,6 +343,14 @@ export declare interface PaymentsConfig {
 
 export declare const setPaymentsConfig: (config: Partial<PaymentsConfig>) => void;
 
+export declare interface UpdatePaymentMethodPatch {
+    isDefault?: boolean;
+    /** MOVMO-381 — editable on Spreedly rows only; monolith-api rejects (4xx) Stripe rows. */
+    cardholderName?: string;
+    /** MOVMO-381 — editable on Spreedly rows only; monolith-api rejects (4xx) Stripe rows. */
+    zip?: string;
+}
+
 /**
  * Calls `DELETE /v1/users/:userId/payment-methods/:methodId`.
  *
@@ -407,6 +439,27 @@ export declare interface UseSetDefaultPaymentMethodResult {
 
 export declare type UseSetDefaultPaymentMethodStatus = 'idle' | 'pending' | 'error';
 
+/**
+ * Calls `PUT /v1/users/:userId/payment-methods/:methodId` with the
+ * cardholder-name + zip subset (MOVMO-381). The backend forwards to Spreedly
+ * for vault-backed rows and rejects the request (4xx) for Stripe-backed rows;
+ * the resulting `Error` carries the server's message so callers can surface it
+ * in the modal.
+ *
+ * Follows the same idle→pending→idle/error contract as
+ * `useSetDefaultPaymentMethod` (throws on failure so optimistic-update
+ * consumers can roll back), with a `(methodId, patch)` signature.
+ */
+export declare const useUpdatePaymentMethod: (userId: string) => UseUpdatePaymentMethodResult;
+
+export declare interface UseUpdatePaymentMethodResult {
+    updatePaymentMethod: (methodId: string, patch: EditablePaymentMethodFields) => Promise<void>;
+    status: UseUpdatePaymentMethodStatus;
+    error: string | null;
+}
+
+export declare type UseUpdatePaymentMethodStatus = 'idle' | 'pending' | 'error';
+
 /**
  * Fetches a user's saved payment methods from monolith-api.
  *