@capxul/sdk 0.1.0-alpha.4 → 0.1.0-alpha.8

package/dist/types-PM4AQRLP.d.ts

@@ -0,0 +1,1136 @@
+import { Y as PublicId, A as AccountId$1, S as SafeId$1, d as OrganizationId$1, c as KycProfileId$1, b as ExternalAccountId$1, O as OperationId$1, C as CorrelationId$1, f as SubAccountId$1, B as BalanceLedgerEntryId$1, a as ApiKeyId$1, h as TreasuryId$1, M as MemberId$1, K as KybProfileId$1, N as NextAction$1, P as PaymentId$1, g as TransferId$1, k as WithdrawalId$1, D as DocumentId$1, W as WebhookEndpointId$1, j as WebhookEventId$1, V as VirtualAccountId$1, i as VirtualCardId$1 } from './next-action-DkrwXYay.js';
+
+type AccountId = string;
+type OrganizationId = string;
+type MemberId = string;
+type SafeId = string;
+type TreasuryId = string;
+type KycProfileId = string;
+type KybProfileId = string;
+type ExternalAccountId = string;
+type PaymentId = string;
+type WithdrawalId = string;
+type OperationId = string;
+type CorrelationId = string;
+type WebhookEndpointId = string;
+type WebhookEventId = string;
+type SubAccountId = string;
+type VirtualAccountId = string;
+type VirtualCardId = string;
+type TransferId = string;
+type DocumentId = string;
+type BalanceLedgerEntryId = string;
+type ApiKeyId = string;
+/**
+ * Lowercased, shape-validated email address.
+ */
+type Email = string;
+/**
+ * E.164 international phone number.
+ */
+type PhoneNumber = string;
+/**
+ * 3–30 chars, letter-first, lowercased; globally unique handle.
+ */
+type Username = string;
+/**
+ * ISO 8601 timestamp in UTC.
+ */
+type TimestampIso$1 = string;
+/**
+ * Lowercased EVM address .
+ */
+type Address = string;
+/**
+ * EVM transaction hash.
+ */
+type TxHash = string;
+/**
+ * Non-negative EVM block number.
+ */
+type BlockNumber = number;
+/**
+ * EVM chain ID (positive integer).
+ */
+type ChainId = number;
+/**
+ * Non-negative integer string for token amounts (avoids JS float precision).
+ */
+type WeiAmount = string;
+/**
+ * Mutually-exclusive-keys union (Stripe-style, no `kind` wrapper) for
+ * addressing a user by any of four identifiers: email, phone, username,
+ * or accountId. Exactly one field must be present.
+ *
+ */
+type UserIdentifier$1 = {
+    email: Email;
+} | {
+    phone: PhoneNumber;
+} | {
+    username: Username;
+} | {
+    accountId: AccountId;
+};
+/**
+ * On-chain settlement detail. Present on the HTTP wire; the `@capxul/sdk`
+ * client strips by default — opt back in via `include: ["settlement"]`.
+ *
+ */
+type Settlement$1 = {
+    token: "USDC";
+    tokenAmount: WeiAmount;
+    contractAddress: Address;
+    chain: ChainId;
+    txHash?: TxHash;
+    blockNumber?: BlockNumber;
+};
+type Money$1 = {
+    value: string;
+    currency: string;
+};
+type OperationStatus$1 = "accepted" | "processing" | "action_required" | "submitted" | "succeeded" | "failed" | "canceled" | "indexed";
+type OperationSummary$1 = {
+    id: OperationId;
+    status: OperationStatus$1;
+    correlationId: CorrelationId;
+};
+type NextAction = CompleteKycAction | CompleteKybAction | ApproveTransactionAction | SendFundsAction | FollowRedirectAction | ProvideOtpAction | FixDestinationAction | ContactSupportAction | ConfirmFxQuoteAction;
+type CompleteKycAction = {
+    kind: "complete_kyc";
+    url?: string;
+    expiresAt?: string;
+};
+type CompleteKybAction = {
+    kind: "complete_kyb";
+    url?: string;
+    embedToken?: string;
+    expiresAt?: string;
+};
+type ApproveTransactionAction = {
+    kind: "approve_transaction";
+    intentId: string;
+    url?: string;
+};
+type SendFundsAction = {
+    kind: "send_funds";
+    amount: Money$1;
+    destination: {
+        [key: string]: unknown;
+    };
+};
+type FollowRedirectAction = {
+    kind: "follow_redirect";
+    url: string;
+    expiresAt?: string;
+};
+type ProvideOtpAction = {
+    kind: "provide_otp";
+    channel?: "email" | "sms" | "provider";
+};
+/**
+ * Recipient address needs attention. Enriched payload carries
+ * invitation metadata for `reason = recipient_not_yet_capxul_user`
+ * so the client UI can surface an "invite" CTA.
+ *
+ */
+type FixDestinationAction = {
+    kind: "fix_destination";
+    reason: "recipient_not_yet_capxul_user" | "recipient_unreachable_email" | "destination_kyc_blocked" | "invalid_format";
+    recipient?: {
+        email?: Email;
+        phone?: PhoneNumber;
+        username?: Username;
+        invitationSentAt?: TimestampIso$1;
+        invitationExpiresAt?: TimestampIso$1;
+        signupUrl?: string;
+    };
+};
+/**
+ * Cross-currency transfer needs the caller to commit the quoted
+ * FX rate before processing begins. Quotes expire — on
+ * POST /v1/transfers/{id}/confirm the API returns
+ * QUOTE_EXPIRED (409) or QUOTE_NOT_FOUND (404).
+ *
+ */
+type ConfirmFxQuoteAction = {
+    kind: "confirm_fx_quote";
+    quoteId: string;
+    /**
+     * Decimal string (no floats).
+     */
+    rate: string;
+    sourceAmount: Money$1;
+    creditAmount: Money$1;
+    fees?: Money$1;
+    expiresAt: TimestampIso$1;
+};
+type ContactSupportAction = {
+    kind: "contact_support";
+    reason: string;
+};
+type Account$1 = {
+    object: "account";
+    id: AccountId;
+    email: Email;
+    name?: string;
+    username?: Username;
+    phone?: PhoneNumber;
+    /**
+     * ISO 3166-1 alpha-2 country code. Self-lens only.
+     */
+    countryCode?: string;
+    /**
+     * KYC tier for the account owner. Self-lens only; null until KYC starts.
+     */
+    kycTier?: 0 | 1 | 2 | 3;
+    /**
+     * The personal Safe pointer for self-lens reads. Lens-
+     * conditional per Doc 02: omitted on co-member and
+     * service-key responses for other users' accounts;
+     * present on `capxul.me.get()` and on
+     * `capxul.accounts.retrieve(selfAccountId)`. The SDK's
+     * response parser trusts server-side lens filtering to
+     * either include or omit this field.
+     *
+     */
+    primarySafeId?: string;
+    /**
+     * Self/admin visibility flag for email lookup consent.
+     */
+    discoverableByEmail?: boolean;
+    /**
+     * Self/admin visibility flag for phone lookup consent.
+     */
+    discoverableByPhone?: boolean;
+    createdAt: TimestampIso$1;
+    updatedAt: TimestampIso$1;
+};
+type Organization$1 = {
+    object: "organization";
+    id: OrganizationId;
+    status: string;
+    operation: OperationSummary$1;
+};
+type Member$1 = {
+    object: "member";
+    id: MemberId;
+    organizationId: OrganizationId;
+    accountId: AccountId;
+    role: "owner" | "finance_manager" | "team_lead" | "viewer";
+    createdAt: TimestampIso$1;
+};
+type Safe$1 = {
+    object: "safe";
+    id: SafeId;
+    owner: {
+        [key: string]: unknown;
+    };
+    status: "not_started" | "deploying" | "active" | "failed" | "action_required";
+    /**
+     * The on-chain Safe address (lowercased). Absent while
+     * `status` is `not_started` or `deploying`; present once
+     * `status` is `active`.
+     *
+     */
+    address?: string;
+    /**
+     * The chain the Safe is deployed on. 84532 = Base Sepolia
+     * (v1 scope). Absent during pre-deploy statuses.
+     *
+     */
+    chainId?: number;
+    /**
+     * In-flight operation (typically the deploy operation) during
+     * `deploying` status. Absent when the Safe has reached a
+     * terminal state.
+     *
+     */
+    operation?: OperationSummary$1;
+};
+type Treasury$1 = {
+    object: "treasury";
+    id: TreasuryId;
+    organizationId: OrganizationId;
+    status: string;
+};
+type KycProfile$1 = {
+    object: "kyc_profile";
+    id: KycProfileId;
+    owner: {
+        [key: string]: unknown;
+    };
+    status: "not_started" | "pending" | "action_required" | "verified" | "rejected" | "expired";
+    nextAction?: NextAction;
+};
+type KybProfile$1 = {
+    object: "kyb_profile";
+    id: KybProfileId;
+    owner: {
+        type: "organization";
+        id: OrganizationId;
+    };
+    /**
+     * 6-value KYB state machine. Live-key gating fires on `approved`.
+     */
+    status: "not_started" | "pending" | "action_required" | "approved" | "rejected" | "expired";
+    nextAction?: NextAction;
+};
+/**
+ * Withdrawal destination kind. `card_payout` covers
+ * Visa/Mastercard push-to-card rails.
+ *
+ */
+type ExternalAccountKind$1 = "bank" | "evm" | "solana" | "starknet" | "card_payout";
+type ExternalAccount$1 = {
+    object: "external_account";
+    id: ExternalAccountId;
+    kind: ExternalAccountKind$1;
+    label?: string;
+    status: "pending_verification" | "active" | "revoked" | "failed";
+    address?: string;
+    iban?: string;
+    bic?: string;
+    accountHolder?: string;
+    network?: "visa" | "mastercard";
+    last4?: string;
+    createdAt?: TimestampIso$1;
+    /**
+     * Trust-chain operation summary from the most-recent
+     * observability-instrumented mutation that produced or
+     * modified this resource. Reflects the LATEST mutation,
+     * not the original create. See OperationSummary for
+     * shape (id, status, correlationId).
+     *
+     */
+    operation: OperationSummary$1;
+};
+/**
+ * Sender or recipient on a Payment. Two-kind discriminator on
+ * resolution state: `capxul_user` (identifier resolved to an
+ * accountId) vs `pending_recipient` (identifier recognized but
+ * the user hasn't signed up yet — see `nextAction.kind =
+ * "fix_destination"`). Address fields mirror UserIdentifier.
+ *
+ */
+type PaymentParty$1 = {
+    kind: "capxul_user";
+    accountId: AccountId;
+    publicName?: string;
+    email?: Email;
+    phone?: PhoneNumber;
+    username?: Username;
+} | {
+    kind: "pending_recipient";
+    email?: Email;
+    phone?: PhoneNumber;
+    username?: Username;
+    invitationSentAt?: TimestampIso$1;
+    invitationExpiresAt?: TimestampIso$1;
+    signupUrl?: string;
+};
+type Payment$1 = {
+    object: "payment";
+    id: PaymentId;
+    status: "processing" | "action_required" | "succeeded" | "failed" | "canceled";
+    amount?: Money$1;
+    reference?: string;
+    sender?: PaymentParty$1;
+    recipient?: PaymentParty$1;
+    operation: OperationSummary$1;
+    nextAction?: NextAction;
+    settlement?: Settlement$1;
+    /**
+     * Populated when `status` is `failed`. Absent on any non-failed
+     * status. Carries the machine-routable code + human message
+     * for UI display per sdk-surface.md §1a.
+     *
+     */
+    error?: {
+        /**
+         * Value drawn from the `CapxulErrorCode` catalog — see
+         * `ErrorEnvelope.error.code` for the 34-value enum. The
+         * enum is deliberately inlined (not $ref'd) to avoid
+         * TS7056 in the generated schemas export; runtime values
+         * still match the canonical catalog one-for-one.
+         *
+         */
+        code: string;
+        message: string;
+    };
+    createdAt?: TimestampIso$1;
+};
+type Withdrawal$1 = {
+    object: "withdrawal";
+    id: WithdrawalId;
+    status: "processing" | "action_required" | "succeeded" | "failed" | "canceled";
+    amount?: Money$1;
+    reference?: string;
+    source?: {
+        subAccountId?: SubAccountId;
+    };
+    destination?: {
+        externalAccountId?: ExternalAccountId;
+    };
+    operation: OperationSummary$1;
+    nextAction?: NextAction;
+    settlement?: Settlement$1;
+    /**
+     * Populated when `status` is `failed`. Absent on any non-failed
+     * status. Same shape as Payment.error per sdk-surface.md §1a.
+     *
+     */
+    error?: {
+        /**
+         * Value drawn from the `CapxulErrorCode` catalog — see
+         * `ErrorEnvelope.error.code`. Inlined (not $ref'd) to
+         * avoid TS7056 in the generated schemas export.
+         *
+         */
+        code: string;
+        message: string;
+    };
+    createdAt?: TimestampIso$1;
+};
+type Operation$1 = {
+    object: "operation";
+    id: OperationId;
+    correlationId: CorrelationId;
+    /**
+     * Public API remains open-ended for forward-compatible
+     * operation projection. Internal TypeScript emitters are
+     * compile-time checked against `OPERATION_KINDS` in
+     * `@repo/platform-kernel`; generated public clients keep this
+     * as `string` so new operation kinds can appear before a
+     * client regeneration.
+     *
+     */
+    kind: string;
+    status: OperationStatus$1;
+    source: string;
+    actor: {
+        [key: string]: unknown;
+    };
+    subject?: {
+        [key: string]: unknown;
+    };
+    nextAction?: NextAction;
+    /**
+     * Present when the operation reached a terminal successful
+     * state (`succeeded` or `indexed`) AND produced a public
+     * resource. Absent for pre-terminal, failed, or canceled
+     * operations, or for operations that don't produce a resource
+     * (e.g. pure read operations). Locked by CANON.md §4.33.
+     *
+     */
+    result?: {
+        /**
+         * Discriminator naming the kind of public resource
+         * produced by this operation. Union of the `object:
+         * const` values across every primitive declared in
+         * sdk-surface.md §1a. Inlined (not extracted as a
+         * reusable `PublicResource` schema) to avoid TS7056
+         * in the generated schemas export catalog.
+         *
+         */
+        object: "account" | "organization" | "safe" | "treasury" | "kyc_profile" | "kyb_profile" | "external_account" | "payment" | "member" | "withdrawal" | "operation" | "webhook_endpoint" | "webhook_event" | "sub_account" | "virtual_account" | "virtual_card" | "transfer" | "document" | "balance_ledger_entry" | "api_key";
+        /**
+         * The public ID of the resource this operation produced.
+         * Prefix pattern matches `object` (e.g., `pay_01…` when
+         * `object = payment`, `txfr_…` when `object = transfer`).
+         *
+         */
+        id: string;
+    };
+    /**
+     * Present when the operation reached a terminal failed state.
+     * Same shape as resource-level errors per sdk-surface.md §1a.
+     *
+     */
+    error?: {
+        /**
+         * Value drawn from the `CapxulErrorCode` catalog — see
+         * `ErrorEnvelope.error.code`. Inlined (not $ref'd) to
+         * avoid TS7056 in the generated schemas export.
+         *
+         */
+        code: string;
+        message: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+};
+type BalanceLedgerEntry$1 = {
+    object: "balance_ledger_entry";
+    id: BalanceLedgerEntryId;
+    safeId: SafeId;
+    delta: Money$1;
+    runningBalance: Money$1;
+    originatedBy: {
+        type: "payment" | "withdrawal" | "transfer" | "document" | "external";
+        id?: string;
+    };
+    occurredAt: TimestampIso$1;
+};
+type CreateWebhookEndpointRequest = {
+    url: string;
+    eventTypes?: Array<string>;
+};
+type WebhookEndpoint$1 = {
+    object: "webhook_endpoint";
+    id: WebhookEndpointId;
+    url: string;
+    status: string;
+};
+type WebhookEvent$1 = {
+    object: "webhook_event";
+    id: WebhookEventId;
+    type: string;
+    createdAt: string;
+    operationId?: OperationId;
+    correlationId?: CorrelationId;
+    data: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Venmo-style minimal discoverability result.
+ * `exists` tells the caller whether the identifier resolves to a
+ * Capxul user. `accountId` + `publicName` present only when exists
+ * AND the user opted into discoverability for that identifier kind.
+ * `memberSince` is month-precision to resist timing enumeration.
+ *
+ */
+type AccountLookupResult$1 = {
+    email?: Email;
+    phone?: PhoneNumber;
+    username?: Username;
+    exists: boolean;
+    accountId?: AccountId;
+    publicName?: string;
+    /**
+     * Month-precision membership stamp, format YYYY-MM.
+     */
+    memberSince?: string;
+};
+type SubAccountOwnerKind$1 = "account" | "organization";
+/**
+ * Named partition under an account or organization. OFF-CHAIN
+ * accounting construct — no per-sub-account Safe deploy. Balance
+ * AGGREGATES across custody sources (parent Safe stablecoin pool,
+ * virtual-account fiat at providers, etc.).
+ *
+ */
+type SubAccount$1 = {
+    object: "sub_account";
+    id: SubAccountId;
+    parent: {
+        kind: SubAccountOwnerKind$1;
+        /**
+         * AccountId or OrganizationId matching `kind`.
+         */
+        id: string;
+    };
+    name: string;
+    purpose?: string;
+    status: "active" | "archived";
+    balance: Money$1;
+    /**
+     * Per-custody-source balance breakdown. Present only when the
+     * caller opts in via `include: ["balancesByCustody"]`.
+     *
+     */
+    balancesByCustody?: Array<{
+        source: "root" | "virtual_account";
+        amount: Money$1;
+        virtualAccountId?: VirtualAccountId;
+    }>;
+    createdAt: TimestampIso$1;
+};
+type VirtualAccountOwnerKind$1 = "account" | "sub_account" | "organization";
+/**
+ * IBAN-bearing fiat receive rail. Funds physically held at an
+ * external provider (Bridge, Modern Treasury, etc.); provider is
+ * abstracted at the SDK level.
+ *
+ */
+type VirtualAccount$1 = {
+    object: "virtual_account";
+    id: VirtualAccountId;
+    owner: {
+        kind: VirtualAccountOwnerKind$1;
+        id: string;
+    };
+    /**
+     * International Bank Account Number (provider-issued).
+     */
+    iban?: string;
+    bic?: string;
+    bankName?: string;
+    /**
+     * ISO 4217 three-letter currency code.
+     */
+    currency: string;
+    status: "provisioning" | "active" | "frozen" | "closed";
+    balance: Money$1;
+    /**
+     * Opaque provider identifier (e.g. `bridge`, `modern_treasury`).
+     */
+    provider: string;
+    createdAt: TimestampIso$1;
+};
+type CreateVirtualAccountRequest = {
+    ownerKind: VirtualAccountOwnerKind$1;
+    /**
+     * AccountId, SubAccountId, or OrganizationId matching `ownerKind`.
+     */
+    ownerId: string;
+    /**
+     * ISO 4217 three-letter currency code.
+     */
+    currency: string;
+};
+type VirtualCardOwnerKind$1 = "account" | "sub_account" | "organization";
+type VirtualCardLimits$1 = {
+    dailyLimit?: Money$1;
+    monthlyLimit?: Money$1;
+};
+/**
+ * Issued card spending the owning sub-account's balance. Active /
+ * frozen / canceled lifecycle.
+ *
+ */
+type VirtualCard$1 = {
+    object: "virtual_card";
+    id: VirtualCardId;
+    owner: {
+        kind: VirtualCardOwnerKind$1;
+        id: string;
+    };
+    network: "visa" | "mastercard";
+    last4: string;
+    currency: string;
+    limits?: VirtualCardLimits$1;
+    status: "active" | "frozen" | "canceled";
+    createdAt: TimestampIso$1;
+};
+type CreateVirtualCardRequest = {
+    ownerKind: VirtualCardOwnerKind$1;
+    ownerId: string;
+    network?: "visa" | "mastercard";
+    currency?: string;
+    limits?: VirtualCardLimits$1;
+};
+/**
+ * Forward-only pagination. `cursor` absent when
+ * `hasMore: false`.
+ *
+ */
+type PageInfo$1 = {
+    hasMore: boolean;
+    cursor?: string;
+};
+/**
+ * Custody-source kind for transfer source/destination. `root` is
+ * the parent account/org's main Safe stablecoin pool and takes no
+ * `id`.
+ *
+ */
+type TransferCustody$1 = "root" | "sub_account" | "virtual_account";
+type TransferEndpoint$1 = {
+    custody: TransferCustody$1;
+    /**
+     * SubAccountId or VirtualAccountId when `custody` is not `root`.
+     */
+    id?: string;
+};
+type TransferOwner = {
+    kind: "account" | "organization";
+    id: string;
+};
+/**
+ * Foreign-exchange block. Present when `source` and `destination`
+ * currencies differ. Quote must be confirmed via POST
+ * /v1/transfers/{id}/confirm before processing begins (unless
+ * `autoConfirm` with `maxSlippageBps` is supplied at create time).
+ *
+ */
+type TransferFx$1 = {
+    /**
+     * Decimal string (no floats).
+     */
+    rate: string;
+    quoteId: string;
+    expiresAt: TimestampIso$1;
+    fees?: Money$1;
+};
+/**
+ * Cross-custody internal move within a single owner (not a payment
+ * to another party; not a withdrawal out of Capxul). Status
+ * lifecycle: processing → succeeded | failed | canceled for
+ * same-currency; cross-currency inserts `action_required:
+ * confirm_fx_quote` before processing.
+ *
+ */
+type Transfer$1 = {
+    object: "transfer";
+    id: TransferId;
+    owner: TransferOwner;
+    source: TransferEndpoint$1;
+    destination: TransferEndpoint$1;
+    amount: Money$1;
+    debitAmount?: Money$1;
+    creditAmount?: Money$1;
+    fx?: TransferFx$1;
+    reference?: string;
+    status: "processing" | "action_required" | "succeeded" | "failed" | "canceled";
+    nextAction?: NextAction;
+    operation: OperationSummary$1;
+    settlement?: Settlement$1;
+    /**
+     * Populated when `status` is `failed`. Absent on any non-failed
+     * status. Same shape as Payment.error per sdk-surface.md §1a.
+     *
+     */
+    error?: {
+        /**
+         * Value drawn from the `CapxulErrorCode` catalog — see
+         * `ErrorEnvelope.error.code`. Inlined (not $ref'd) to
+         * avoid TS7056 in the generated schemas export.
+         *
+         */
+        code: string;
+        message: string;
+    };
+    createdAt: TimestampIso$1;
+};
+type DocumentOwner = {
+    kind: "account" | "organization";
+    id: string;
+};
+/**
+ * `type = invoice` — a request for payment addressed to a recipient.
+ * Subsumes the former top-level `invoice` primitive.
+ * Lifecycle: draft → open → paid → canceled | expired. The
+ * `fulfilledBy` link dereferences to the settling Payment when
+ * `status = paid` and the caller expands `include: ["fulfilledBy"]`.
+ *
+ */
+type InvoiceDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "invoice";
+    owner: DocumentOwner;
+    recipient: UserIdentifier$1;
+    amount: Money$1;
+    reference?: string;
+    dueAt?: TimestampIso$1;
+    status: "draft" | "open" | "paid" | "canceled" | "expired";
+    fulfilledBy?: PaymentId;
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = payroll_run` — per-execution payroll artifact. Shape
+ * detail deferred (payroll schedule vs run
+ * field set lands in a follow-up design session). Current schema
+ * is the minimum required for the discriminator + ownership.
+ *
+ */
+type PayrollRunDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "payroll_run";
+    owner: DocumentOwner;
+    scheduleId?: DocumentId;
+    totalAmount?: Money$1;
+    status?: "draft" | "processing" | "completed" | "failed" | "canceled";
+    paymentIds?: Array<PaymentId>;
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = payroll_schedule` — recurring payroll metadata. Shape
+ * detail deferred
+ *
+ */
+type PayrollScheduleDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "payroll_schedule";
+    owner: DocumentOwner;
+    cadence?: "weekly" | "biweekly" | "semimonthly" | "monthly";
+    nextRunAt?: TimestampIso$1;
+    status?: "active" | "paused" | "canceled";
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = receipt` — customer-facing confirmation of a settled
+ * payment.
+ *
+ */
+type ReceiptDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "receipt";
+    owner: DocumentOwner;
+    for: PaymentId;
+    amount: Money$1;
+    issuedAt?: TimestampIso$1;
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = kyc_upload` — an uploaded KYC artifact (passport scan,
+ * utility bill, etc.) attached to a KYC profile.
+ *
+ */
+type KycUploadDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "kyc_upload";
+    owner: DocumentOwner;
+    kycProfileId?: KycProfileId;
+    storageId: string;
+    kind: "passport" | "driver_license" | "national_id" | "utility_bill" | "selfie" | "other";
+    status?: "uploaded" | "reviewing" | "approved" | "rejected";
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = bank_statement` — uploaded periodic bank statement.
+ */
+type BankStatementDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "bank_statement";
+    owner: DocumentOwner;
+    storageId: string;
+    periodStart?: TimestampIso$1;
+    periodEnd?: TimestampIso$1;
+    createdAt: TimestampIso$1;
+};
+/**
+ * `type = tax_form` — uploaded tax form (W2 / W9 / 1099 / etc.).
+ */
+type TaxFormDocument$1 = {
+    object: "document";
+    id: DocumentId;
+    type: "tax_form";
+    owner: DocumentOwner;
+    storageId: string;
+    kind: "w2" | "w9" | "1099-nec" | "1099-misc" | "other";
+    year: number;
+    createdAt: TimestampIso$1;
+};
+/**
+ * Unified artifact primitive with `type` discriminator. Subsumes
+ * the former top-level `invoice` and `org_payroll_entry` primitives
+ * dropped from the v1 catalog. Extending this union with new
+ * `type` values is additive.
+ *
+ */
+type Document$1 = InvoiceDocument$1 | PayrollRunDocument$1 | PayrollScheduleDocument$1 | ReceiptDocument$1 | KycUploadDocument$1 | BankStatementDocument$1 | TaxFormDocument$1;
+/**
+ * Discriminated on `type`. Per-type fields are validated at runtime
+ * by Zod — unknown fields for a given type return INVALID_INPUT.
+ *
+ */
+type CreateDocumentRequest = {
+    type: "invoice";
+    recipient: UserIdentifier$1;
+    amount: Money$1;
+    reference?: string;
+    dueAt?: TimestampIso$1;
+    include?: Array<string>;
+} | {
+    type: "payroll_schedule";
+    cadence?: "weekly" | "biweekly" | "semimonthly" | "monthly";
+    nextRunAt?: TimestampIso$1;
+    include?: Array<string>;
+} | {
+    type: "receipt";
+    for: PaymentId;
+    include?: Array<string>;
+} | {
+    type: "kyc_upload";
+    storageId: string;
+    kind: "passport" | "driver_license" | "national_id" | "utility_bill" | "selfie" | "other";
+    kycProfileId?: KycProfileId;
+    include?: Array<string>;
+} | {
+    type: "bank_statement";
+    storageId: string;
+    periodStart?: TimestampIso$1;
+    periodEnd?: TimestampIso$1;
+    include?: Array<string>;
+} | {
+    type: "tax_form";
+    storageId: string;
+    kind: "w2" | "w9" | "1099-nec" | "1099-misc" | "other";
+    year: number;
+    include?: Array<string>;
+};
+/**
+ * API-key scope vocabulary. `resource:read` +
+ * `resource:write` per public primitive, plus three special verbs
+ * where they meaningfully differ (`payments:refund`,
+ * `accounts:lookup`). 35-scope catalog total. Unknown scopes
+ * return INVALID_INPUT with details.field = "scopes" at mint time.
+ *
+ */
+type Scope$1 = "accounts:read" | "accounts:write" | "accounts:lookup" | "organizations:read" | "organizations:write" | "members:read" | "members:write" | "payments:read" | "payments:write" | "payments:refund" | "transfers:read" | "transfers:write" | "withdrawals:read" | "withdrawals:write" | "external_accounts:read" | "external_accounts:write" | "sub_accounts:read" | "sub_accounts:write" | "virtual_accounts:read" | "virtual_accounts:write" | "virtual_cards:read" | "virtual_cards:write" | "documents:read" | "documents:write" | "kyc_profiles:read" | "kyc_profiles:write" | "kyb_profiles:read" | "kyb_profiles:write" | "api_keys:read" | "api_keys:write" | "webhook_endpoints:read" | "webhook_endpoints:write" | "webhook_events:read" | "operations:read" | "balance_ledger:read" | "treasury:read";
+type ApiKeyEnvironment$1 = "test" | "live";
+type ApiKeyType$1 = "secret" | "publishable";
+/**
+ * Mint a new api-key for the organization. `environment` + `type`
+ * select the prefix family (cap_test_, cap_live_, cap_pk_test_,
+ * cap_pk_live_ ,). `scopes` array is
+ * validated against the canonical catalog — unknown values
+ * return INVALID_INPUT.
+ *
+ */
+type CreateApiKeyRequest = {
+    label?: string;
+    environment: ApiKeyEnvironment$1;
+    type: ApiKeyType$1;
+    scopes: Array<Scope$1>;
+};
+/**
+ * Minted api-key resource. The plaintext `secret` is RETURNED
+ * ONCE in the create response; subsequent reads omit it and
+ * expose only `prefix` + `tail` (last 4 chars) for display.
+ *
+ */
+type ApiKey$1 = {
+    object: "api_key";
+    id: ApiKeyId;
+    label?: string;
+    environment: ApiKeyEnvironment$1;
+    type: ApiKeyType$1;
+    /**
+     * Public prefix (e.g. `cap_live_`, `cap_pk_test_`).
+     */
+    prefix?: string;
+    /**
+     * Last 4 chars of the secret for display.
+     */
+    tail?: string;
+    scopes: Array<Scope$1>;
+    status: "active" | "revoked";
+    /**
+     * Plaintext secret. Returned ONCE on the create response;
+     * subsequent retrievals omit this field.
+     *
+     */
+    secret?: string;
+    createdAt: TimestampIso$1;
+    revokedAt?: TimestampIso$1;
+};
+
+/**
+ * SDK surface types.
+ *
+ * Derivation policy (post-codegen-relitigation, 2026-04-20):
+ * - Import wire types directly from `@repo/api-contract/gen/types` — the
+ *   new generator (@hey-api/openapi-ts) emits faithful discriminated
+ *   unions from OpenAPI `const:` and narrow string-literal enums, so
+ *   the old `z.infer<typeof schemas.X>` round-trip through Zod (which
+ *   stripped discriminants via `passthrough()`) is gone.
+ * - Rebrand the top-level `id` field on every resource to the kernel's
+ *   branded ID type per `.claude/rules/typescript-style.md`.
+ * - Keep `WithStatus<>` so per-method narrowings are discriminated unions
+ *   (one variant per status literal), which `Extract<T, { status: K }>`
+ *   can narrow inside `matchStatus`.
+ * - Use `Override<>` ONLY where the OpenAPI source emits `additionalProperties`
+ *   open shapes (`Safe.owner`, `Operation.actor`, `Operation.subject`) that
+ *   need the SDK's canonical tagged-ref shape. Every other former
+ *   `Override<>` site was redundant and has been deleted.
+ */
+
+type Rebrand<Wire, Id extends PublicId> = Wire & {
+    readonly id: Id;
+};
+/**
+ * Override-via-intersection helper. Kept for the few wire fields that
+ * OpenAPI emits as open-shape (`additionalProperties` → `{ [key:
+ * string]: unknown }`) where the SDK surface needs the canonical
+ * tagged-ref shape. `Safe.owner`, `Operation.actor`, `Operation.subject`
+ * are the current consumers.
+ */
+type Override<Wire, Fields> = Wire & Fields;
+/**
+ * Distributes over the literal union `S` so the result is a discrim-
+ * inated union (one member per status value). `Extract<T, { status:
+ * "x" }>` narrows correctly against the output — without the
+ * distribution, a plain object with a union-typed `status` field is
+ * not a discriminated union and Extract returns `never`.
+ *
+ * When `S === "action_required"` the variant additionally requires
+ * `nextAction: NextAction` (not optional) per Rule D (CANON.md §4.40 +
+ * sdk-surface.md §3a): `action_required` is inline on mutation /
+ * snapshot responses and callers can safely route via `matchAction`.
+ */
+type WithStatus<T, S extends string> = S extends unknown ? T & {
+    readonly status: S;
+} & (S extends "action_required" ? {
+    readonly nextAction: NextAction$1;
+} : unknown) : never;
+type Money = Money$1;
+type Settlement = Settlement$1;
+type TimestampIso = TimestampIso$1;
+type UserIdentifier = UserIdentifier$1;
+/**
+ * Tagged reference to the public resource a succeeded operation
+ * produced (per sdk-surface.md §1b `operation`).
+ */
+type OperationResult = {
+    readonly object: "account" | "organization" | "safe" | "treasury" | "kyc_profile" | "kyb_profile" | "external_account" | "payment" | "member" | "withdrawal" | "operation" | "webhook_endpoint" | "webhook_event" | "sub_account" | "virtual_account" | "virtual_card" | "transfer" | "document" | "balance_ledger_entry" | "api_key";
+    readonly id: string;
+};
+/**
+ * Terminal-state error sidecar on resources that can fail (Operation,
+ * Payment, Withdrawal, Transfer).
+ */
+type ResourceError = {
+    readonly code: string;
+    readonly message: string;
+};
+
+type OperationStatus = OperationStatus$1;
+type OperationSummary = Rebrand<OperationSummary$1, OperationId$1> & {
+    readonly correlationId: CorrelationId$1;
+};
+/**
+ * Full operation envelope.
+ *
+ * `actor` and `subject` are hand-overridden because OpenAPI emits
+ * them as `additionalProperties` open-shape; SDK surface carries the
+ * canonical tagged-ref shape.
+ *
+ * `nextAction` is re-asserted against the kernel's `NextAction` union
+ * (9 kinds including `confirm_fx_quote` per §4.58) so callers get the
+ * kernel-branded field types (e.g. `Email`, `PhoneNumber`, `Username`
+ * on `fix_destination.recipient`). The wire carries the same 9 kinds
+ * structurally; the kernel re-assertion preserves the SDK surface's
+ * exhaustiveness contract against drift.
+ *
+ * `result` and `error` come through the generator faithfully, but
+ * we re-type them to narrow the tagged-ref `object` field to the
+ * closed `OperationResult["object"]` catalog.
+ */
+type Operation = Override<Rebrand<Operation$1, OperationId$1>, {
+    readonly correlationId: CorrelationId$1;
+    readonly actor: {
+        readonly type: string;
+        readonly id: string;
+    };
+    readonly subject?: {
+        readonly type: string;
+        readonly id: string;
+    };
+    readonly nextAction?: NextAction$1;
+    readonly result?: OperationResult | null;
+    readonly error?: ResourceError | null;
+}>;
+type Account = Omit<Rebrand<Account$1, AccountId$1>, "kycTier" | "primarySafeId"> & {
+    readonly kycTier?: Account$1["kycTier"] | null;
+    readonly primarySafeId?: SafeId$1 | null;
+};
+type AccountLookupResult = AccountLookupResult$1;
+/**
+ * `owner` is hand-overridden: the OpenAPI source emits it as an
+ * `additionalProperties` open object; SDK surface carries the canonical
+ * tagged-ref shape.
+ */
+type Safe = Override<Rebrand<Safe$1, SafeId$1>, {
+    readonly owner: {
+        readonly type: "account";
+        readonly id: AccountId$1;
+    } | {
+        readonly type: "organization";
+        readonly id: OrganizationId$1;
+    };
+}>;
+type Organization = Rebrand<Organization$1, OrganizationId$1>;
+type Treasury = Rebrand<Treasury$1, TreasuryId$1> & {
+    readonly organizationId: OrganizationId$1;
+};
+type KycProfile = Rebrand<KycProfile$1, KycProfileId$1>;
+type KybProfile = Rebrand<KybProfile$1, KybProfileId$1>;
+/**
+ * Trust-chain operation summary is sourced from the wire's nested
+ * `operation: OperationSummary` field (see resources.mdx §canonical
+ * operation envelope). The wire surfaces `correlationId` as a plain
+ * string; we override the nested field with the kernel-branded SDK
+ * `OperationSummary` so callers get `CorrelationId` / `OperationId`
+ * brands. Required at the resource boundary (matches Withdrawal /
+ * Payment / Transfer / Organization).
+ */
+type ExternalAccount = Override<Rebrand<ExternalAccount$1, ExternalAccountId$1>, {
+    readonly operation: OperationSummary;
+}>;
+type ExternalAccountKind = ExternalAccountKind$1;
+type PageInfo = PageInfo$1;
+type List<T> = {
+    readonly object: "list";
+    readonly data: readonly T[];
+    readonly page: PageInfo;
+};
+type WirePaymentWithBrand = Rebrand<Payment$1, PaymentId$1>;
+type PaymentStatus = "processing" | "action_required" | "succeeded" | "failed" | "canceled";
+/**
+ * Full `Payment` — discriminated union on status so `matchStatus`
+ * narrows correctly.
+ */
+type Payment = WithStatus<WirePaymentWithBrand, PaymentStatus>;
+/**
+ * Per-method narrowing for `payments.create`. Terminal states
+ * (`succeeded`, `canceled`) arrive out-of-band per Rule D (CANON.md
+ * §4.40 + sdk-surface.md §3a), so the synchronous return carries
+ * only `processing | action_required | failed`.
+ */
+type CreatePaymentResult = WithStatus<WirePaymentWithBrand, "processing" | "action_required" | "failed">;
+type PaymentParty = PaymentParty$1;
+type WireWithdrawalWithBrand = Rebrand<Withdrawal$1, WithdrawalId$1>;
+/**
+ * Canon-aligned superset (resources.mdx §withdrawal lifecycle note).
+ * Wider than `OperationStatus` because `submitted → completed` is a
+ * withdrawal-specific transition driven by external reconciliation
+ * the operation envelope cannot witness directly. Slice 1 of
+ * Withdrawals v1 (#440) widened this from `PaymentStatus` to match
+ * canon.
+ */
+type WithdrawalStatus = "draft" | "action_required" | "processing" | "submitted" | "completed" | "failed" | "canceled";
+type Withdrawal = WithStatus<WireWithdrawalWithBrand, WithdrawalStatus>;
+type CreateWithdrawalResult = WithStatus<WireWithdrawalWithBrand, "processing" | "action_required" | "failed">;
+type WireTransferWithBrand = Rebrand<Transfer$1, TransferId$1>;
+type TransferStatus = PaymentStatus;
+type Transfer = WithStatus<WireTransferWithBrand, TransferStatus>;
+type CreateTransferResult = WithStatus<WireTransferWithBrand, "processing" | "action_required" | "failed">;
+type TransferEndpoint = TransferEndpoint$1;
+type TransferCustody = TransferCustody$1;
+type TransferFx = TransferFx$1;
+type Document = Document$1 & {
+    readonly id: DocumentId$1;
+};
+type InvoiceDocument = InvoiceDocument$1;
+type PayrollRunDocument = PayrollRunDocument$1;
+type PayrollScheduleDocument = PayrollScheduleDocument$1;
+type ReceiptDocument = ReceiptDocument$1;
+type KycUploadDocument = KycUploadDocument$1;
+type BankStatementDocument = BankStatementDocument$1;
+type TaxFormDocument = TaxFormDocument$1;
+type SubAccount = Rebrand<SubAccount$1, SubAccountId$1>;
+type SubAccountOwnerKind = SubAccountOwnerKind$1;
+type VirtualAccount = Rebrand<VirtualAccount$1, VirtualAccountId$1>;
+type VirtualAccountOwnerKind = VirtualAccountOwnerKind$1;
+type VirtualCard = Rebrand<VirtualCard$1, VirtualCardId$1>;
+type VirtualCardOwnerKind = VirtualCardOwnerKind$1;
+type VirtualCardLimits = VirtualCardLimits$1;
+type WebhookEndpoint = Rebrand<WebhookEndpoint$1, WebhookEndpointId$1>;
+type WebhookEvent = Rebrand<WebhookEvent$1, WebhookEventId$1>;
+type ApiKey = Rebrand<ApiKey$1, ApiKeyId$1>;
+type ApiKeyEnvironment = ApiKeyEnvironment$1;
+type ApiKeyType = ApiKeyType$1;
+type Scope = Scope$1;
+type Member = Rebrand<Member$1, MemberId$1>;
+type BalanceLedgerEntry = Rebrand<BalanceLedgerEntry$1, BalanceLedgerEntryId$1>;
+
+export type { WithdrawalStatus as $, Account as A, BalanceLedgerEntry as B, CreatePaymentResult as C, Document as D, ExternalAccount as E, TransferEndpoint as F, TransferFx as G, TransferStatus as H, InvoiceDocument as I, Treasury as J, KybProfile as K, List as L, Member as M, VirtualAccountOwnerKind as N, Operation as O, PageInfo as P, VirtualCard as Q, ReceiptDocument as R, Safe as S, TaxFormDocument as T, UserIdentifier as U, VirtualAccount as V, VirtualCardLimits as W, VirtualCardOwnerKind as X, WebhookEndpoint as Y, WebhookEvent as Z, Withdrawal as _, AccountLookupResult as a, CreateApiKeyRequest as a0, CreateDocumentRequest as a1, CreateWebhookEndpointRequest as a2, CreateVirtualAccountRequest as a3, CreateVirtualCardRequest as a4, ApiKey as b, ApiKeyEnvironment as c, ApiKeyType as d, BankStatementDocument as e, CreateTransferResult as f, CreateWithdrawalResult as g, ExternalAccountKind as h, KycProfile as i, KycUploadDocument as j, Money as k, OperationStatus as l, OperationSummary as m, Organization as n, Payment as o, PaymentParty as p, PaymentStatus as q, PayrollRunDocument as r, PayrollScheduleDocument as s, Scope as t, Settlement as u, SubAccount as v, SubAccountOwnerKind as w, TimestampIso as x, Transfer as y, TransferCustody as z };