@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/resources/payments/setupIntents.d.ts

@@ -0,0 +1,391 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * SetupIntents (`seti_…`) — saving a card for later without charging it
+ * (ADR 0016, ADR 0019). The provider SetupIntent is an internal binding; its
+ * success is what creates the Peable `pm_…`, attached to the customer.
+ */
+export declare const setupIntentSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"setup_intent">;
+    livemode: z.ZodBoolean;
+    status: z.ZodEnum<{
+        succeeded: "succeeded";
+        canceled: "canceled";
+        requires_payment_method: "requires_payment_method";
+        requires_confirmation: "requires_confirmation";
+        requires_action: "requires_action";
+        processing: "processing";
+    }>;
+    usage: z.ZodEnum<{
+        off_session: "off_session";
+        on_session: "on_session";
+    }>;
+    payment_method_types: z.ZodTuple<[z.ZodLiteral<"card">], null>;
+    customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+    payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+    client_secret: z.ZodString;
+    next_action: z.ZodNullable<z.ZodObject<{
+        type: z.ZodLiteral<"use_peable_sdk">;
+    }, z.core.$strict>>;
+    last_setup_error: z.ZodNullable<z.ZodObject<{
+        type: z.ZodEnum<{
+            api_error: "api_error";
+            card_error: "card_error";
+            payment_error: "payment_error";
+        }>;
+        code: z.ZodNullable<z.ZodString>;
+        decline_code: z.ZodNullable<z.ZodString>;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+    cancellation_reason: z.ZodNullable<z.ZodEnum<{
+        duplicate: "duplicate";
+        abandoned: "abandoned";
+        requested_by_customer: "requested_by_customer";
+    }>>;
+    description: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type SetupIntent = Expand<z.output<typeof setupIntentSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        setup_intent: SetupIntent;
+    }
+}
+export declare const createSetupIntentParams: z.ZodObject<{
+    customer: z.ZodOptional<z.ZodString>;
+    usage: z.ZodOptional<z.ZodEnum<{
+        off_session: "off_session";
+        on_session: "on_session";
+    }>>;
+    payment_method_types: z.ZodOptional<z.ZodTuple<[z.ZodLiteral<"card">], null>>;
+    description: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type CreateSetupIntentParams = z.input<typeof createSetupIntentParams>;
+export declare const cancelSetupIntentParams: z.ZodObject<{
+    cancellation_reason: z.ZodOptional<z.ZodEnum<{
+        duplicate: "duplicate";
+        abandoned: "abandoned";
+        requested_by_customer: "requested_by_customer";
+    }>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type CancelSetupIntentParams = z.input<typeof cancelSetupIntentParams>;
+export declare const listSetupIntentsQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    customer: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ListSetupIntentsParams = z.input<typeof listSetupIntentsQuery>;
+/** A merchant retrieve takes `expand[]`; the payer's takes `client_secret` and nothing to expand. */
+export declare const retrieveSetupIntentQuery: z.ZodObject<{
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    client_secret: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type RetrieveSetupIntentParams = z.input<typeof retrieveSetupIntentQuery>;
+export declare const setupIntentRoutes: readonly [{
+    readonly operationId: "createSetupIntent";
+    readonly method: "post";
+    readonly path: "/v1/setup_intents";
+    readonly tag: "Setup intents";
+    readonly summary: "Create a setup intent";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        customer: z.ZodOptional<z.ZodString>;
+        usage: z.ZodOptional<z.ZodEnum<{
+            off_session: "off_session";
+            on_session: "on_session";
+        }>>;
+        payment_method_types: z.ZodOptional<z.ZodTuple<[z.ZodLiteral<"card">], null>>;
+        description: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"setup_intent">;
+        livemode: z.ZodBoolean;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            canceled: "canceled";
+            requires_payment_method: "requires_payment_method";
+            requires_confirmation: "requires_confirmation";
+            requires_action: "requires_action";
+            processing: "processing";
+        }>;
+        usage: z.ZodEnum<{
+            off_session: "off_session";
+            on_session: "on_session";
+        }>;
+        payment_method_types: z.ZodTuple<[z.ZodLiteral<"card">], null>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+        client_secret: z.ZodString;
+        next_action: z.ZodNullable<z.ZodObject<{
+            type: z.ZodLiteral<"use_peable_sdk">;
+        }, z.core.$strict>>;
+        last_setup_error: z.ZodNullable<z.ZodObject<{
+            type: z.ZodEnum<{
+                api_error: "api_error";
+                card_error: "card_error";
+                payment_error: "payment_error";
+            }>;
+            code: z.ZodNullable<z.ZodString>;
+            decline_code: z.ZodNullable<z.ZodString>;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+        cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        description: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "setupIntents.create";
+    readonly expandable: "setup_intent";
+}, {
+    readonly operationId: "listSetupIntents";
+    readonly method: "get";
+    readonly path: "/v1/setup_intents";
+    readonly tag: "Setup intents";
+    readonly summary: "List setup intents";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        customer: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"setup_intent">;
+            livemode: z.ZodBoolean;
+            status: z.ZodEnum<{
+                succeeded: "succeeded";
+                canceled: "canceled";
+                requires_payment_method: "requires_payment_method";
+                requires_confirmation: "requires_confirmation";
+                requires_action: "requires_action";
+                processing: "processing";
+            }>;
+            usage: z.ZodEnum<{
+                off_session: "off_session";
+                on_session: "on_session";
+            }>;
+            payment_method_types: z.ZodTuple<[z.ZodLiteral<"card">], null>;
+            customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+            payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+            client_secret: z.ZodString;
+            next_action: z.ZodNullable<z.ZodObject<{
+                type: z.ZodLiteral<"use_peable_sdk">;
+            }, z.core.$strict>>;
+            last_setup_error: z.ZodNullable<z.ZodObject<{
+                type: z.ZodEnum<{
+                    api_error: "api_error";
+                    card_error: "card_error";
+                    payment_error: "payment_error";
+                }>;
+                code: z.ZodNullable<z.ZodString>;
+                decline_code: z.ZodNullable<z.ZodString>;
+                message: z.ZodString;
+            }, z.core.$strict>>;
+            cancellation_reason: z.ZodNullable<z.ZodEnum<{
+                duplicate: "duplicate";
+                abandoned: "abandoned";
+                requested_by_customer: "requested_by_customer";
+            }>>;
+            description: z.ZodNullable<z.ZodString>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "setupIntents.list";
+    readonly expandable: "setup_intent";
+}, {
+    readonly operationId: "retrieveSetupIntent";
+    readonly method: "get";
+    readonly path: "/v1/setup_intents/{id}";
+    readonly tag: "Setup intents";
+    readonly summary: "Retrieve a setup intent";
+    readonly description: "With the merchant credential: reconciled with the provider when not terminal, expandable. Without one, the PAYER reads the row as stored with its `client_secret` (the `X-Peable-Client-Secret` header, or the query).";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+        client_secret: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"setup_intent">;
+        livemode: z.ZodBoolean;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            canceled: "canceled";
+            requires_payment_method: "requires_payment_method";
+            requires_confirmation: "requires_confirmation";
+            requires_action: "requires_action";
+            processing: "processing";
+        }>;
+        usage: z.ZodEnum<{
+            off_session: "off_session";
+            on_session: "on_session";
+        }>;
+        payment_method_types: z.ZodTuple<[z.ZodLiteral<"card">], null>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+        client_secret: z.ZodString;
+        next_action: z.ZodNullable<z.ZodObject<{
+            type: z.ZodLiteral<"use_peable_sdk">;
+        }, z.core.$strict>>;
+        last_setup_error: z.ZodNullable<z.ZodObject<{
+            type: z.ZodEnum<{
+                api_error: "api_error";
+                card_error: "card_error";
+                payment_error: "payment_error";
+            }>;
+            code: z.ZodNullable<z.ZodString>;
+            decline_code: z.ZodNullable<z.ZodString>;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+        cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        description: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "setupIntents.retrieve";
+    readonly expandable: "setup_intent";
+}, {
+    readonly operationId: "cancelSetupIntent";
+    readonly method: "post";
+    readonly path: "/v1/setup_intents/{id}/cancel";
+    readonly tag: "Setup intents";
+    readonly summary: "Cancel a setup intent";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{
+        cancellation_reason: z.ZodOptional<z.ZodEnum<{
+            duplicate: "duplicate";
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"setup_intent">;
+        livemode: z.ZodBoolean;
+        status: z.ZodEnum<{
+            succeeded: "succeeded";
+            canceled: "canceled";
+            requires_payment_method: "requires_payment_method";
+            requires_confirmation: "requires_confirmation";
+            requires_action: "requires_action";
+            processing: "processing";
+        }>;
+        usage: z.ZodEnum<{
+            off_session: "off_session";
+            on_session: "on_session";
+        }>;
+        payment_method_types: z.ZodTuple<[z.ZodLiteral<"card">], null>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        payment_method: z.ZodNullable<z.ZodType<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_method">, string | import("../..").Ref<"payment_method">>>>;
+        client_secret: z.ZodString;
+        next_action: z.ZodNullable<z.ZodObject<{
+            type: z.ZodLiteral<"use_peable_sdk">;
+        }, z.core.$strict>>;
+        last_setup_error: z.ZodNullable<z.ZodObject<{
+            type: z.ZodEnum<{
+                api_error: "api_error";
+                card_error: "card_error";
+                payment_error: "payment_error";
+            }>;
+            code: z.ZodNullable<z.ZodString>;
+            decline_code: z.ZodNullable<z.ZodString>;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+        cancellation_reason: z.ZodNullable<z.ZodEnum<{
+            duplicate: "duplicate";
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        description: z.ZodNullable<z.ZodString>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "setupIntents.cancel";
+    readonly expandable: "setup_intent";
+}, {
+    readonly operationId: "retrieveSetupIntentClientAction";
+    readonly method: "post";
+    readonly path: "/v1/setup_intents/{id}/client_action";
+    readonly tag: "Setup intents";
+    readonly summary: "Retrieve a setup intent's client action";
+    readonly description: "The provider credential the payer's client confirms the SetupIntent with — read fresh, `Cache-Control: no-store`, never on the object. The merchant credential, or the payer's `client_secret` (`X-Peable-Client-Secret`). A succeeded or canceled setup intent answers 409.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    readonly query: z.ZodObject<{
+        client_secret: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        kind: z.ZodEnum<{
+            client_secret: "client_secret";
+            redirect: "redirect";
+        }>;
+        value: z.ZodString;
+        publishable_key: z.ZodOptional<z.ZodString>;
+        object: z.ZodLiteral<"client_action">;
+    }, z.core.$strict>;
+    readonly sdk: "setupIntents.clientAction";
+}];

package/dist/types/resources/payments/social.d.ts

@@ -0,0 +1,266 @@
+import { z } from 'zod';
+/**
+ * Social payments (pay a person by `@username`) and transaction enrichment —
+ * the wallet's routes, called with the person's own Oxy session. Display-only
+ * context throughout: nothing here decides where money goes; the address comes
+ * from the recipient's identity key and their reservation cursor.
+ */
+/**
+ * Display-only context for one social payment: which app the payer was in, and
+ * that app's own opaque id for what it was for (a Mention post, say). Peable
+ * never parses, resolves or links `ref`; it stores a string and hands the same
+ * string back.
+ */
+export declare const socialPaymentSourceSchema: z.ZodObject<{
+    app: z.ZodString;
+    ref: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type SocialPaymentSource = z.output<typeof socialPaymentSourceSchema>;
+/**
+ * Display-only counterparty identity for one address, as `POST /v1/enrich`
+ * resolves it. A failed or partial resolution degrades to `{ kind: 'unknown' }`.
+ */
+export declare const enrichmentResultSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        merchant: "merchant";
+        unknown: "unknown";
+        user: "user";
+    }>;
+    display_name: z.ZodOptional<z.ZodString>;
+    avatar_file_id: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type EnrichmentResult = z.output<typeof enrichmentResultSchema>;
+/**
+ * `.strict()` is load-bearing: `{ app, postId }` — the obvious misspelling of
+ * `ref` — would otherwise reserve an address and record a context missing the
+ * only part the recipient cares about, with a 200. `ref` is validated for SHAPE
+ * (printable non-space ASCII) and never for meaning, so it cannot become a
+ * free-text memo the gateway stores on behalf of two users.
+ */
+export declare const socialPaymentSourceParams: z.ZodObject<{
+    app: z.ZodString;
+    ref: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** `source` is OPTIONAL and stays that way: most person-to-person payments are for nothing in particular. */
+export declare const socialNextAddressParams: z.ZodObject<{
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+    source: z.ZodOptional<z.ZodObject<{
+        app: z.ZodString;
+        ref: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SocialNextAddressRequest = z.input<typeof socialNextAddressParams>;
+export declare const socialNextAddressSchema: z.ZodObject<{
+    address: z.ZodString;
+    index: z.ZodNumber;
+}, z.core.$strict>;
+export type SocialNextAddressResponse = z.output<typeof socialNextAddressSchema>;
+export declare const socialReceiveCursorQuery: z.ZodObject<{
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+}, z.core.$strip>;
+export type SocialReceiveCursorParams = z.input<typeof socialReceiveCursorQuery>;
+/**
+ * Lets the caller's device resync its watch window: every `next_address`
+ * advances a monotonic index whether or not it is ever paid, so a burst of
+ * reservations can outrun a device that widens only on payment. Watch
+ * `0..reserved_through + gap`.
+ */
+export declare const socialReceiveCursorSchema: z.ZodObject<{
+    reserved_through: z.ZodNumber;
+    identity_public_key: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type SocialReceiveCursorResponse = z.output<typeof socialReceiveCursorSchema>;
+export declare const socialPaymentsQuery: z.ZodObject<{
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+}, z.core.$strip>;
+export type SocialPaymentsParams = z.input<typeof socialPaymentsQuery>;
+/**
+ * One social payment as the CALLER saw it — the address-free view, and the
+ * only history a surface without a key can ask for. Carries NO amount: the
+ * attribution records which address was minted, not what was paid; the amount
+ * is on-chain at `address`.
+ */
+export declare const socialPaymentSchema: z.ZodObject<{
+    address: z.ZodString;
+    direction: z.ZodEnum<{
+        sent: "sent";
+        received: "received";
+    }>;
+    counterparty: z.ZodObject<{
+        kind: z.ZodEnum<{
+            merchant: "merchant";
+            unknown: "unknown";
+            user: "user";
+        }>;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    source: z.ZodOptional<z.ZodObject<{
+        app: z.ZodString;
+        ref: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type SocialPayment = z.output<typeof socialPaymentSchema>;
+export declare const socialPaymentsSchema: z.ZodObject<{
+    payments: z.ZodArray<z.ZodObject<{
+        address: z.ZodString;
+        direction: z.ZodEnum<{
+            sent: "sent";
+            received: "received";
+        }>;
+        counterparty: z.ZodObject<{
+            kind: z.ZodEnum<{
+                merchant: "merchant";
+                unknown: "unknown";
+                user: "user";
+            }>;
+            display_name: z.ZodOptional<z.ZodString>;
+            avatar_file_id: z.ZodOptional<z.ZodString>;
+            username: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        source: z.ZodOptional<z.ZodObject<{
+            app: z.ZodString;
+            ref: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        created: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SocialPaymentsResponse = z.output<typeof socialPaymentsSchema>;
+export declare const enrichParams: z.ZodObject<{
+    addresses: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export type EnrichRequest = z.input<typeof enrichParams>;
+export declare const enrichSchema: z.ZodObject<{
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        kind: z.ZodEnum<{
+            merchant: "merchant";
+            unknown: "unknown";
+            user: "user";
+        }>;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type EnrichResponse = z.output<typeof enrichSchema>;
+export declare const socialRoutes: readonly [{
+    readonly operationId: "reserveSocialAddress";
+    readonly method: "post";
+    readonly path: "/v1/social/{username}/next_address";
+    readonly tag: "Social payments";
+    readonly summary: "Reserve an address to pay a person";
+    readonly description: "A fresh address of the recipient's, derived from their Oxy identity key. Limited per (sender, recipient) pair; a recipient without an identity answers 409 `keyless_recipient`; paying yourself is refused.";
+    readonly auth: "user";
+    readonly params: {
+        readonly username: "The recipient’s Oxy username.";
+    };
+    readonly body: z.ZodObject<{
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        source: z.ZodOptional<z.ZodObject<{
+            app: z.ZodString;
+            ref: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        address: z.ZodString;
+        index: z.ZodNumber;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "retrieveSocialReceiveCursor";
+    readonly method: "get";
+    readonly path: "/v1/social/me/cursor";
+    readonly tag: "Social payments";
+    readonly summary: "Retrieve the caller's receive cursor";
+    readonly auth: "user";
+    readonly query: z.ZodObject<{
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+    }, z.core.$strip>;
+    readonly response: z.ZodObject<{
+        reserved_through: z.ZodNumber;
+        identity_public_key: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "listSocialPayments";
+    readonly method: "get";
+    readonly path: "/v1/social/me/payments";
+    readonly tag: "Social payments";
+    readonly summary: "List the caller's social payments";
+    readonly auth: "user";
+    readonly query: z.ZodObject<{
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+    }, z.core.$strip>;
+    readonly response: z.ZodObject<{
+        payments: z.ZodArray<z.ZodObject<{
+            address: z.ZodString;
+            direction: z.ZodEnum<{
+                sent: "sent";
+                received: "received";
+            }>;
+            counterparty: z.ZodObject<{
+                kind: z.ZodEnum<{
+                    merchant: "merchant";
+                    unknown: "unknown";
+                    user: "user";
+                }>;
+                display_name: z.ZodOptional<z.ZodString>;
+                avatar_file_id: z.ZodOptional<z.ZodString>;
+                username: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            source: z.ZodOptional<z.ZodObject<{
+                app: z.ZodString;
+                ref: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "enrichAddresses";
+    readonly method: "post";
+    readonly path: "/v1/enrich";
+    readonly tag: "Social payments";
+    readonly summary: "Resolve who is behind addresses";
+    readonly description: "Display-only counterparty identity for the caller’s own payments; never affects custody.";
+    readonly auth: "user";
+    readonly body: z.ZodObject<{
+        addresses: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        data: z.ZodRecord<z.ZodString, z.ZodObject<{
+            kind: z.ZodEnum<{
+                merchant: "merchant";
+                unknown: "unknown";
+                user: "user";
+            }>;
+            display_name: z.ZodOptional<z.ZodString>;
+            avatar_file_id: z.ZodOptional<z.ZodString>;
+            username: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+}];