@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/resources/connect/connectedAccounts.d.ts

@@ -0,0 +1,494 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/** The FairCoin half of a seller's account. The seller's xpub is deliberately ABSENT (ADR 0012 D6). */
+export declare const connectedAccountFaircoinSchema: z.ZodObject<{
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+    status: z.ZodEnum<{
+        active: "active";
+        pending: "pending";
+    }>;
+    oxy_user_id: z.ZodString;
+    registered_at: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type ConnectedAccountFaircoin = z.output<typeof connectedAccountFaircoinSchema>;
+export declare const connectedAccountSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"connected_account">;
+    livemode: z.ZodBoolean;
+    external_ref: z.ZodString;
+    rails: z.ZodArray<z.ZodEnum<{
+        card: "card";
+        faircoin: "faircoin";
+    }>>;
+    faircoin: z.ZodNullable<z.ZodObject<{
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        status: z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+        }>;
+        oxy_user_id: z.ZodString;
+        registered_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>>;
+    country: z.ZodNullable<z.ZodString>;
+    default_currency: z.ZodNullable<z.ZodString>;
+    payable: z.ZodBoolean;
+    payouts_enabled: z.ZodBoolean;
+    charges_enabled: z.ZodBoolean;
+    transfers_capability: z.ZodNullable<z.ZodEnum<{
+        active: "active";
+        pending: "pending";
+        inactive: "inactive";
+    }>>;
+    card_payments_capability: z.ZodNullable<z.ZodEnum<{
+        active: "active";
+        pending: "pending";
+        inactive: "inactive";
+    }>>;
+    requirements: z.ZodObject<{
+        currently_due: z.ZodArray<z.ZodString>;
+        eventually_due: z.ZodArray<z.ZodString>;
+        past_due: z.ZodArray<z.ZodString>;
+        pending_verification: z.ZodArray<z.ZodString>;
+        disabled_reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    last_synced_at: z.ZodNullable<z.ZodNumber>;
+    created: z.ZodNumber;
+    updated_at: z.ZodNumber;
+}, z.core.$strict>;
+export type ConnectedAccount = Expand<z.output<typeof connectedAccountSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        connected_account: ConnectedAccount;
+    }
+}
+/**
+ * `POST /v1/connected_accounts`: open (or return) the account for one seller.
+ *
+ * Two halves, at least one: the CARD half (`country` + `business_type`, both or
+ * neither) and the FAIRCOIN half (`faircoin`). There is deliberately no `xpub`
+ * here: the key comes from the SELLER's own session, never from the platform
+ * (ADR 0012 D3).
+ */
+export declare const createConnectedAccountParams: z.ZodObject<{
+    external_ref: z.ZodString;
+    country: z.ZodOptional<z.ZodString>;
+    business_type: z.ZodOptional<z.ZodEnum<{
+        individual: "individual";
+        company: "company";
+    }>>;
+    faircoin: z.ZodOptional<z.ZodObject<{
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        oxy_user_id: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CreateConnectedAccountParams = z.input<typeof createConnectedAccountParams>;
+export declare const listConnectedAccountsQuery: 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>>>;
+}, z.core.$strict>;
+export type ListConnectedAccountsParams = z.input<typeof listConnectedAccountsQuery>;
+/** `POST /v1/connected_accounts/{accountId}/refresh` takes no parameters. */
+export declare const refreshConnectedAccountParams: z.ZodObject<{}, z.core.$strict>;
+/** A seller's onboarding link. */
+export declare const createConnectedAccountLinkParams: z.ZodObject<{
+    refresh_url: z.ZodURL;
+    return_url: z.ZodURL;
+    rail: z.ZodOptional<z.ZodEnum<{
+        card: "card";
+        faircoin: "faircoin";
+    }>>;
+}, z.core.$strict>;
+export type CreateConnectedAccountLinkParams = z.input<typeof createConnectedAccountLinkParams>;
+export declare const connectedAccountRoutes: readonly [{
+    readonly operationId: "createConnectedAccount";
+    readonly method: "post";
+    readonly path: "/v1/connected_accounts";
+    readonly tag: "Connected accounts";
+    readonly summary: "Open a connected account";
+    readonly description: "Opens the account for one seller (201), or answers the one this `external_ref` already opened (200) — a provider account cannot be deleted, so a converged retry says so.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        external_ref: z.ZodString;
+        country: z.ZodOptional<z.ZodString>;
+        business_type: z.ZodOptional<z.ZodEnum<{
+            individual: "individual";
+            company: "company";
+        }>>;
+        faircoin: z.ZodOptional<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            oxy_user_id: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"connected_account">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodString;
+        rails: z.ZodArray<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>>;
+        faircoin: z.ZodNullable<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            status: z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+            }>;
+            oxy_user_id: z.ZodString;
+            registered_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>>;
+        country: z.ZodNullable<z.ZodString>;
+        default_currency: z.ZodNullable<z.ZodString>;
+        payable: z.ZodBoolean;
+        payouts_enabled: z.ZodBoolean;
+        charges_enabled: z.ZodBoolean;
+        transfers_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        card_payments_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        requirements: z.ZodObject<{
+            currently_due: z.ZodArray<z.ZodString>;
+            eventually_due: z.ZodArray<z.ZodString>;
+            past_due: z.ZodArray<z.ZodString>;
+            pending_verification: z.ZodArray<z.ZodString>;
+            disabled_reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        last_synced_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "connectedAccounts.create";
+}, {
+    readonly operationId: "listConnectedAccounts";
+    readonly method: "get";
+    readonly path: "/v1/connected_accounts";
+    readonly tag: "Connected accounts";
+    readonly summary: "List connected accounts";
+    readonly description: "Every seller this merchant has onboarded, newest first.";
+    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>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"connected_account">;
+            livemode: z.ZodBoolean;
+            external_ref: z.ZodString;
+            rails: z.ZodArray<z.ZodEnum<{
+                card: "card";
+                faircoin: "faircoin";
+            }>>;
+            faircoin: z.ZodNullable<z.ZodObject<{
+                network: z.ZodEnum<{
+                    mainnet: "mainnet";
+                    testnet: "testnet";
+                }>;
+                status: z.ZodEnum<{
+                    active: "active";
+                    pending: "pending";
+                }>;
+                oxy_user_id: z.ZodString;
+                registered_at: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>>;
+            country: z.ZodNullable<z.ZodString>;
+            default_currency: z.ZodNullable<z.ZodString>;
+            payable: z.ZodBoolean;
+            payouts_enabled: z.ZodBoolean;
+            charges_enabled: z.ZodBoolean;
+            transfers_capability: z.ZodNullable<z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+                inactive: "inactive";
+            }>>;
+            card_payments_capability: z.ZodNullable<z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+                inactive: "inactive";
+            }>>;
+            requirements: z.ZodObject<{
+                currently_due: z.ZodArray<z.ZodString>;
+                eventually_due: z.ZodArray<z.ZodString>;
+                past_due: z.ZodArray<z.ZodString>;
+                pending_verification: z.ZodArray<z.ZodString>;
+                disabled_reason: z.ZodNullable<z.ZodString>;
+            }, z.core.$strict>;
+            last_synced_at: z.ZodNullable<z.ZodNumber>;
+            created: z.ZodNumber;
+            updated_at: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "connectedAccounts.list";
+    readonly expandable: "connected_account";
+}, {
+    readonly operationId: "retrieveConnectedAccountByRef";
+    readonly method: "get";
+    readonly path: "/v1/connected_accounts/by_ref/{externalRef}";
+    readonly tag: "Connected accounts";
+    readonly summary: "Retrieve a connected account by your id";
+    readonly description: "By `external_ref`, the durable address you already hold — so a create whose answer never arrived is recoverable without a list scan.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly externalRef: "Your own id for the seller.";
+    };
+    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>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"connected_account">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodString;
+        rails: z.ZodArray<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>>;
+        faircoin: z.ZodNullable<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            status: z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+            }>;
+            oxy_user_id: z.ZodString;
+            registered_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>>;
+        country: z.ZodNullable<z.ZodString>;
+        default_currency: z.ZodNullable<z.ZodString>;
+        payable: z.ZodBoolean;
+        payouts_enabled: z.ZodBoolean;
+        charges_enabled: z.ZodBoolean;
+        transfers_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        card_payments_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        requirements: z.ZodObject<{
+            currently_due: z.ZodArray<z.ZodString>;
+            eventually_due: z.ZodArray<z.ZodString>;
+            past_due: z.ZodArray<z.ZodString>;
+            pending_verification: z.ZodArray<z.ZodString>;
+            disabled_reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        last_synced_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "connectedAccounts.retrieveByRef";
+}, {
+    readonly operationId: "retrieveConnectedAccount";
+    readonly method: "get";
+    readonly path: "/v1/connected_accounts/{accountId}";
+    readonly tag: "Connected accounts";
+    readonly summary: "Retrieve a connected account";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly accountId: "The connected account (`ca_…`).";
+    };
+    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>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"connected_account">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodString;
+        rails: z.ZodArray<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>>;
+        faircoin: z.ZodNullable<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            status: z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+            }>;
+            oxy_user_id: z.ZodString;
+            registered_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>>;
+        country: z.ZodNullable<z.ZodString>;
+        default_currency: z.ZodNullable<z.ZodString>;
+        payable: z.ZodBoolean;
+        payouts_enabled: z.ZodBoolean;
+        charges_enabled: z.ZodBoolean;
+        transfers_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        card_payments_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        requirements: z.ZodObject<{
+            currently_due: z.ZodArray<z.ZodString>;
+            eventually_due: z.ZodArray<z.ZodString>;
+            past_due: z.ZodArray<z.ZodString>;
+            pending_verification: z.ZodArray<z.ZodString>;
+            disabled_reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        last_synced_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "connectedAccounts.retrieve";
+}, {
+    readonly operationId: "refreshConnectedAccount";
+    readonly method: "post";
+    readonly path: "/v1/connected_accounts/{accountId}/refresh";
+    readonly tag: "Connected accounts";
+    readonly summary: "Refresh a connected account";
+    readonly description: "Re-reads the account from the provider now. The sweep and the inbound event keep it fresh on their own; this is for a seller watching a screen.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly accountId: "The connected account (`ca_…`).";
+    };
+    readonly body: z.ZodObject<{}, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"connected_account">;
+        livemode: z.ZodBoolean;
+        external_ref: z.ZodString;
+        rails: z.ZodArray<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>>;
+        faircoin: z.ZodNullable<z.ZodObject<{
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            status: z.ZodEnum<{
+                active: "active";
+                pending: "pending";
+            }>;
+            oxy_user_id: z.ZodString;
+            registered_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>>;
+        country: z.ZodNullable<z.ZodString>;
+        default_currency: z.ZodNullable<z.ZodString>;
+        payable: z.ZodBoolean;
+        payouts_enabled: z.ZodBoolean;
+        charges_enabled: z.ZodBoolean;
+        transfers_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        card_payments_capability: z.ZodNullable<z.ZodEnum<{
+            active: "active";
+            pending: "pending";
+            inactive: "inactive";
+        }>>;
+        requirements: z.ZodObject<{
+            currently_due: z.ZodArray<z.ZodString>;
+            eventually_due: z.ZodArray<z.ZodString>;
+            past_due: z.ZodArray<z.ZodString>;
+            pending_verification: z.ZodArray<z.ZodString>;
+            disabled_reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>;
+        last_synced_at: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "connectedAccounts.refresh";
+}, {
+    readonly operationId: "createConnectedAccountLink";
+    readonly method: "post";
+    readonly path: "/v1/connected_accounts/{accountId}/account_links";
+    readonly tag: "Connected accounts";
+    readonly summary: "Create a seller's onboarding link";
+    readonly description: "Minted on demand and never stored: single-use and short-lived. A visit to `return_url` proves nothing about verification — read the account back.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly accountId: "The connected account (`ca_…`).";
+    };
+    readonly body: z.ZodObject<{
+        refresh_url: z.ZodURL;
+        return_url: z.ZodURL;
+        rail: z.ZodOptional<z.ZodEnum<{
+            card: "card";
+            faircoin: "faircoin";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"account_link">;
+        livemode: z.ZodBoolean;
+        url: z.ZodString;
+        expires_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "connectedAccounts.createAccountLink";
+}];