@peable.to/shared-types 0.5.0 → 0.6.0

package/dist/types/event.d.ts

@@ -71,10 +71,10 @@ export type WebhookEventType = 'payment_intent.confirming' | 'payment_intent.set
 /** Wake-up only. Re-read the owner-bound SDK resource; this is never paid or grant authority. */
 export interface BillingObservation {
     object: 'billing_observation';
-    resourceKind: 'subscription' | 'invoice';
-    resourceId: string;
+    resource_kind: 'subscription' | 'invoice';
+    resource_id: string;
     revision: number;
-    observedAt: string;
+    observed_at: number;
 }
 export interface WebhookEventPayload {
     'billing.observation.updated': BillingObservation;
@@ -97,7 +97,7 @@ export interface WebhookEventPayload {
  *
  * ```ts
  * if (event.type === 'payment_intent.disputed') {
- *   event.data.object.evidenceDueAt; // Dispute, not PaymentIntent
+ *   event.data.object.evidence_due_at; // Dispute, not PaymentIntent
  * }
  * ```
  *
@@ -116,7 +116,7 @@ export type WebhookEvent<K extends WebhookEventType = WebhookEventType> = {
         id: string;
         object: 'event';
         type: T;
-        created: string;
+        created: number;
         /**
          * The connected account (`ca_…`) this event is about — Stripe's
          * `event.account` (ADR 0012 D7). Present on every event for an on-behalf

package/dist/types/merchant.d.ts

@@ -4,7 +4,7 @@ export type MerchantEnvironment = (typeof MERCHANT_ENVIRONMENTS)[number];
 export interface Merchant {
     id: string;
     object: 'merchant';
-    oxyAppId: string;
+    oxy_app_id: string;
     environment: MerchantEnvironment;
     /**
      * The FairCoin chain this merchant accepts on — `null` on a CARD-ONLY
@@ -18,17 +18,20 @@ export interface Merchant {
     network: NetworkType | null;
     /** `null` on a card-only merchant. Nullable together with `network`. */
     xpub: string | null;
-    webhookUrl?: string;
-    requiredConfirmations: number;
+    webhook_url?: string;
+    required_confirmations: number;
     /**
      * Payer-facing branding. Absent when unset — `MerchantDisplay` is what a
      * payer surface renders, and it substitutes a neutral fallback; these are
      * the raw values the merchant owns.
      */
-    displayName?: string;
-    /** Bare Oxy file id, not a URL. `MerchantDisplay.avatarUrl` resolves it. */
-    avatarFileId?: string;
+    display_name?: string;
+    /**
+     * Bare Oxy file id, not a URL. `MerchantDisplay.avatarUrl` resolves it.
+     * Absent again once Oxy reports the file deleted or taken down.
+     */
+    avatar_file_id?: string;
     description?: string;
-    createdAt: string;
-    updatedAt: string;
+    created: number;
+    updated_at: number;
 }

package/dist/types/merchantDisplay.d.ts

@@ -2,6 +2,6 @@ export interface MerchantDisplay {
     /** `Merchant.displayName`, or a neutral fallback when unset. */
     name: string;
     /** Resolved server-side via the canonical media chokepoint; `null` when the merchant has no avatar. */
-    avatarUrl: string | null;
+    avatar_url: string | null;
     description: string | null;
 }

package/dist/types/paymentIntent.d.ts

@@ -89,7 +89,7 @@ export interface PaymentIntent {
      * FairCoin rail only; `null` on a card payment, which reserves no address.
      */
     address: string | null;
-    merchantId: string;
+    merchant_id: string;
     /**
      * The seller this payment is made ON BEHALF OF (`ca_…`), or `null` for a
      * payment to the merchant itself (ADR 0012 D5). On-behalf payments are
@@ -98,17 +98,17 @@ export interface PaymentIntent {
      * Optional in the type only so fixtures written against earlier versions
      * still compile; a gateway at this version always sends it.
      */
-    connectedAccountId?: string | null;
+    connected_account_id?: string | null;
     txid: string | null;
     /** On-chain confirmations. Structurally `0` for the whole life of a card payment. */
     confirmations: number;
-    clientSecret: string;
+    client_secret: string;
     metadata: Record<string, string>;
     /**
      * When an UNPAID intent expires. Meaningful only while {@link canExpire}
      * is true for `status` — see `canExpire` below.
      */
-    expiresAt: string;
+    expires_at: number;
     /**
      * Whether this intent can still expire (ADR 0012 D9). `false` once the payer
      * has reported a broadcast: a FairCoin payment that is `broadcast` or
@@ -117,9 +117,9 @@ export interface PaymentIntent {
      * Optional in the type only for fixtures written against earlier versions;
      * a gateway at this version always sends it.
      */
-    canExpire?: boolean;
-    createdAt: string;
-    updatedAt: string;
+    can_expire?: boolean;
+    created: number;
+    updated_at: number;
 }
 export interface CreatePaymentIntentParams {
     /** Amount in the currency's smallest unit, as a canonical integer string. */
@@ -134,7 +134,7 @@ export interface CreatePaymentIntentParams {
     /** Defaults to `'FAIR'` on the faircoin rail; required on the card rail. */
     currency?: CurrencyCode;
     metadata?: Record<string, string>;
-    expiresInSeconds?: number;
+    expires_in_seconds?: number;
     /**
      * Create the payment ON BEHALF OF this connected account (`ca_…`) — the
      * address derives from the seller's own key and the coins go straight to
@@ -142,5 +142,5 @@ export interface CreatePaymentIntentParams {
      * is refused. The account's FairCoin half must be `active` and `network`
      * must be the account's network.
      */
-    connectedAccount?: string;
+    connected_account?: string;
 }

package/dist/types/paymentLink.d.ts

@@ -20,11 +20,11 @@ export interface PaymentLink {
     active: boolean;
     metadata: Record<string, string>;
     /** Optional post-payment redirect target for the checkout page. */
-    successUrl?: string;
+    success_url?: string;
     /** Canonical `checkout.peable.to/l/<id>` URL. */
     url: string;
-    createdAt: string;
-    updatedAt: string;
+    created: number;
+    updated_at: number;
 }
 /** What an unauthenticated checkout-page visitor may see — no secrets, no metadata. */
 export interface PublicPaymentLink {
@@ -47,5 +47,5 @@ export interface CreatePaymentLinkParams {
     /** Defaults to `'FAIR'` on the faircoin rail; required on the card rail. */
     currency?: CurrencyCode;
     metadata?: Record<string, string>;
-    successUrl?: string;
+    success_url?: string;
 }

package/dist/types/settlement.d.ts

@@ -35,15 +35,15 @@ export interface ConnectedAccountFaircoin {
     network: NetworkType;
     status: ConnectedAccountFaircoinStatus;
     /** The Oxy user who may register the key — and, once `active`, who did. */
-    oxyUserId: string;
+    oxy_user_id: string;
     /** When the seller registered their key. `null` while `pending`. */
-    registeredAt: string | null;
+    registered_at: number | null;
 }
 export interface ConnectedAccount {
     id: string;
     object: 'connected_account';
     /** The merchant's OWN id for this seller — how they address it. */
-    externalRef: string;
+    external_ref: string;
     /** Which halves this account has. Never empty. */
     rails: readonly ConnectedAccountRail[];
     /**
@@ -57,7 +57,7 @@ export interface ConnectedAccount {
      * no card half and was never asked for one (ADR 0012 D1).
      */
     country: string | null;
-    defaultCurrency: string | null;
+    default_currency: string | null;
     /**
      * Whether this seller can receive a CARD settlement (a transfer) right now.
      * Always `false` on a FairCoin-only seller.
@@ -68,40 +68,40 @@ export interface ConnectedAccount {
      * question that belongs to the merchant.
      */
     payable: boolean;
-    payoutsEnabled: boolean;
-    chargesEnabled: boolean;
+    payouts_enabled: boolean;
+    charges_enabled: boolean;
     /**
      * `null` means the capability was never REQUESTED, which is a different fact
      * from the provider declining it (`inactive`). Collapsing the two makes "why
      * is this seller stuck" unanswerable.
      */
-    transfersCapability: CapabilityStatus | null;
-    cardPaymentsCapability: CapabilityStatus | null;
+    transfers_capability: CapabilityStatus | null;
+    card_payments_capability: CapabilityStatus | null;
     /**
      * COUNTS of outstanding requirements, never the requirements themselves and
      * never their values. The gateway records that a seller owes a document; it
      * does not learn what the document says.
      */
     requirements: {
-        currentlyDue: number;
-        eventuallyDue: number;
-        pastDue: number;
-        pendingVerification: number;
+        currently_due: number;
+        eventually_due: number;
+        past_due: number;
+        pending_verification: number;
     };
-    disabledReasonCodes: readonly string[];
-    lastSyncedAt: string | null;
-    createdAt: string;
-    updatedAt: string;
+    disabled_reason_codes: readonly string[];
+    last_synced_at: number | null;
+    created: number;
+    updated_at: number;
 }
 export interface Transfer {
     id: string;
     object: 'transfer';
     /** The merchant's OWN id for what this settles. Their idempotency. */
-    externalRef: string;
+    external_ref: string;
     /** The `ca_…` of the seller — never their account id at the provider. */
-    connectedAccountId: string;
+    connected_account_id: string;
     /** The `pi_…` this settlement was funded by — never an internal primary key. */
-    paymentIntentId: string;
+    payment_intent_id: string;
     amount: string;
     currency: string;
     /**
@@ -111,11 +111,11 @@ export interface Transfer {
      * add up reversals it may not have all seen, which is why this is the
      * provider's own total rather than a sum of the reversals below.
      */
-    amountReversed: string;
+    amount_reversed: string;
     status: TransferStatus;
-    failureMessage: string | null;
-    createdAt: string;
-    updatedAt: string;
+    failure_message: string | null;
+    created: number;
+    updated_at: number;
 }
 /**
  * One reversal operation, returned beside the settlement it acted on.
@@ -128,12 +128,12 @@ export interface TransferReversal {
     id: string;
     object: 'transfer_reversal';
     /** The merchant's own id for this reversal — their `Idempotency-Key`. */
-    externalRef: string;
+    external_ref: string;
     amount: string;
     currency: string;
     status: TransferReversalStatus;
-    failureMessage: string | null;
-    createdAt: string;
+    failure_message: string | null;
+    created: number;
 }
 /** What `POST /v1/transfers/:id/reversals` answers: the transfer, and the leg. */
 export interface TransferWithReversal extends Transfer {
@@ -164,7 +164,7 @@ export interface TransferWithReversal extends Transfer {
 export interface Settlement {
     object: 'settlement';
     /** The `pi_…` this describes. */
-    paymentIntentId: string;
+    payment_intent_id: string;
     /**
      *  - `available` — settled; these figures are final.
      *  - `pending`   — a settlement record exists and is not final yet.
@@ -177,10 +177,10 @@ export interface Settlement {
     net: string | null;
     /** The SETTLEMENT currency, which may differ from the payment's. */
     currency: string | null;
-    /** When the funds become available, ISO-8601. */
-    availableOn: string | null;
+    /** When the funds become available, Unix seconds. */
+    available_on: number | null;
     /** Present only when a conversion happened. `null` is not a rate of 1. */
-    exchangeRate: number | null;
+    exchange_rate: number | null;
 }
 /** Where one refund stands — the MONEY's own lifecycle, not the payment's. */
 export type RefundStatus = 'pending' | 'succeeded' | 'failed';
@@ -196,9 +196,9 @@ export interface Refund {
     id: string;
     object: 'refund';
     /** `null` on an IMPORTED refund; see {@link RefundOrigin}. */
-    externalRef: string | null;
+    external_ref: string | null;
     origin: RefundOrigin;
-    paymentIntentId: string;
+    payment_intent_id: string;
     amount: string;
     currency: CurrencyCode | string;
     status: RefundStatus;
@@ -210,8 +210,8 @@ export interface Refund {
      * them re-read the intent is a round trip whose answer can move on before it
      * arrives.
      */
-    paymentStatus: string;
-    failureCode: string | null;
-    createdAt: string;
-    updatedAt: string;
+    payment_status: string;
+    failure_code: string | null;
+    created: number;
+    updated_at: number;
 }

package/dist/types/social.d.ts

@@ -78,7 +78,7 @@ export interface SocialReceiveCursorResponse {
      * `SOCIAL_RECEIVE_FIRST_FRESH_INDEX - 1`, since index 0 itself is the
      * caller's stable default address and is never reserved through this flow.
      */
-    reservedThrough: number;
+    reserved_through: number;
     /**
      * The identity public key (hex) those addresses were derived from, as the
      * backend saw it. A device compares it with the key it derives from itself:
@@ -88,7 +88,7 @@ export interface SocialReceiveCursorResponse {
      * `null` means exactly one thing: this caller has no cursor, so no address
      * has ever been reserved for them. Every cursor that exists names its key.
      */
-    identityPublicKey: string | null;
+    identity_public_key: string | null;
 }
 /** Where a transaction's counterparty identity came from (spec §4.8). */
 export type EnrichmentKind = 'merchant' | 'user' | 'unknown';
@@ -100,9 +100,9 @@ export type EnrichmentKind = 'merchant' | 'user' | 'unknown';
 export interface EnrichmentResult {
     kind: EnrichmentKind;
     /** Merchant name or user's `name.displayName ?? handle`. */
-    displayName?: string;
+    display_name?: string;
     /** Bare Oxy file id — render via the canonical media chokepoint, never a URL. */
-    avatarFileId?: string;
+    avatar_file_id?: string;
     /** Present for `kind: 'user'` only. */
     username?: string;
     /** Present for `kind: 'merchant'` only. */
@@ -151,8 +151,8 @@ export interface SocialPayment {
      * than dropping the payment.
      */
     source?: SocialPaymentSource;
-    /** ISO-8601. When the address was minted, which is when the payment was set up. */
-    createdAt: string;
+    /** Unix seconds. When the address was minted, which is when the payment was set up. */
+    created: number;
 }
 /** Response of `GET /v1/social/me/payments`, newest first. */
 export interface SocialPaymentsResponse {