@peable.to/contracts 0.3.0 → 1.0.0

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

@@ -0,0 +1,399 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/** One currency's figure in a balance. */
+export declare const balanceAmountSchema: z.ZodObject<{
+    amount: z.ZodString;
+    currency: z.ZodString;
+}, z.core.$strict>;
+export type BalanceAmount = z.output<typeof balanceAmountSchema>;
+/**
+ * `GET /v1/balance` — read from the ledger, per currency. A merchant without a
+ * fiat account has NO balance and is told so (404 `account_missing`), never
+ * shown zeros.
+ */
+export declare const balanceSchema: z.ZodObject<{
+    object: z.ZodLiteral<"balance">;
+    livemode: z.ZodBoolean;
+    available: z.ZodArray<z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodString;
+    }, z.core.$strict>>;
+    pending: z.ZodArray<z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodString;
+    }, z.core.$strict>>;
+    informational: z.ZodArray<z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodString;
+    }, z.core.$strict>>;
+    account: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type Balance = Expand<z.output<typeof balanceSchema>>;
+/** One component of a transaction's fee. */
+export declare const balanceTransactionFeeDetailSchema: z.ZodObject<{
+    amount: z.ZodString;
+    currency: z.ZodString;
+    type: z.ZodEnum<{
+        application_fee: "application_fee";
+        tax: "tax";
+        other: "other";
+        processing_fee: "processing_fee";
+    }>;
+}, z.core.$strict>;
+export type BalanceTransactionFeeDetail = z.output<typeof balanceTransactionFeeDetailSchema>;
+export declare const balanceTransactionSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"balance_transaction">;
+    livemode: z.ZodBoolean;
+    amount: z.ZodString;
+    fee: z.ZodNullable<z.ZodString>;
+    net: z.ZodNullable<z.ZodString>;
+    currency: z.ZodString;
+    type: z.ZodEnum<{
+        application_fee: "application_fee";
+        payout: "payout";
+        transfer: "transfer";
+        charge: "charge";
+        dispute: "dispute";
+        refund: "refund";
+        adjustment: "adjustment";
+        other: "other";
+        payment: "payment";
+        payment_refund: "payment_refund";
+        application_fee_refund: "application_fee_refund";
+        payout_cancel: "payout_cancel";
+        payout_failure: "payout_failure";
+        transfer_refund: "transfer_refund";
+        dispute_reversal: "dispute_reversal";
+        processing_fee: "processing_fee";
+        faircoin_payment: "faircoin_payment";
+        faircoin_payment_reversal: "faircoin_payment_reversal";
+    }>;
+    reporting_category: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        available: "available";
+        informational: "informational";
+    }>;
+    available_on: z.ZodNullable<z.ZodNumber>;
+    created: z.ZodNumber;
+    description: z.ZodNullable<z.ZodString>;
+    exchange_rate: z.ZodNullable<z.ZodNumber>;
+    fee_details: z.ZodArray<z.ZodObject<{
+        amount: z.ZodString;
+        currency: z.ZodString;
+        type: z.ZodEnum<{
+            application_fee: "application_fee";
+            tax: "tax";
+            other: "other";
+            processing_fee: "processing_fee";
+        }>;
+    }, z.core.$strict>>;
+    source: z.ZodNullable<z.ZodString>;
+    payout: z.ZodNullable<z.ZodString>;
+    account: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type BalanceTransaction = Expand<z.output<typeof balanceTransactionSchema>>;
+/**
+ * What the daily reconciliation found disagreeing with the provider (Orbit's
+ * dashboard reads them). Never auto-corrected.
+ */
+export declare const reconciliationMismatchSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"reconciliation_mismatch">;
+    livemode: z.ZodBoolean;
+    account: z.ZodNullable<z.ZodString>;
+    kind: z.ZodEnum<{
+        missing_in_ledger: "missing_in_ledger";
+        amount_mismatch: "amount_mismatch";
+        status_mismatch: "status_mismatch";
+        missing_at_provider: "missing_at_provider";
+        payout_mismatch: "payout_mismatch";
+        unbalanced_journal: "unbalanced_journal";
+    }>;
+    object_id: z.ZodNullable<z.ZodString>;
+    expected: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    actual: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    detected_at: z.ZodNumber;
+    last_seen_at: z.ZodNumber;
+    resolved_at: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type ReconciliationMismatch = Expand<z.output<typeof reconciliationMismatchSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        balance: Balance;
+        balance_transaction: BalanceTransaction;
+        reconciliation_mismatch: ReconciliationMismatch;
+    }
+}
+export declare const listBalanceTransactionsQuery: 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>>>;
+    type: z.ZodOptional<z.ZodEnum<{
+        application_fee: "application_fee";
+        payout: "payout";
+        transfer: "transfer";
+        charge: "charge";
+        dispute: "dispute";
+        refund: "refund";
+        adjustment: "adjustment";
+        other: "other";
+        payment: "payment";
+        payment_refund: "payment_refund";
+        application_fee_refund: "application_fee_refund";
+        payout_cancel: "payout_cancel";
+        payout_failure: "payout_failure";
+        transfer_refund: "transfer_refund";
+        dispute_reversal: "dispute_reversal";
+        processing_fee: "processing_fee";
+        faircoin_payment: "faircoin_payment";
+        faircoin_payment_reversal: "faircoin_payment_reversal";
+    }>>;
+    payout: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    currency: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ListBalanceTransactionsParams = z.input<typeof listBalanceTransactionsQuery>;
+/** Reconciliation findings, as Orbit's dashboard lists them (not a public route). */
+export declare const listReconciliationMismatchesQuery: 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>>>;
+    open: z.ZodOptional<z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>>;
+}, z.core.$strict>;
+export declare const balanceRoutes: readonly [{
+    readonly operationId: "retrieveBalance";
+    readonly method: "get";
+    readonly path: "/v1/balance";
+    readonly tag: "Balance";
+    readonly summary: "Retrieve the balance";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    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<{
+        object: z.ZodLiteral<"balance">;
+        livemode: z.ZodBoolean;
+        available: z.ZodArray<z.ZodObject<{
+            amount: z.ZodString;
+            currency: z.ZodString;
+        }, z.core.$strict>>;
+        pending: z.ZodArray<z.ZodObject<{
+            amount: z.ZodString;
+            currency: z.ZodString;
+        }, z.core.$strict>>;
+        informational: z.ZodArray<z.ZodObject<{
+            amount: z.ZodString;
+            currency: z.ZodString;
+        }, z.core.$strict>>;
+        account: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly sdk: "balance.retrieve";
+}, {
+    readonly operationId: "listBalanceTransactions";
+    readonly method: "get";
+    readonly path: "/v1/balance_transactions";
+    readonly tag: "Balance transactions";
+    readonly summary: "List balance transactions";
+    readonly description: "Newest first, filtered by `type`, `payout`, `source`, `currency` and `created`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    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>>>;
+        type: z.ZodOptional<z.ZodEnum<{
+            application_fee: "application_fee";
+            payout: "payout";
+            transfer: "transfer";
+            charge: "charge";
+            dispute: "dispute";
+            refund: "refund";
+            adjustment: "adjustment";
+            other: "other";
+            payment: "payment";
+            payment_refund: "payment_refund";
+            application_fee_refund: "application_fee_refund";
+            payout_cancel: "payout_cancel";
+            payout_failure: "payout_failure";
+            transfer_refund: "transfer_refund";
+            dispute_reversal: "dispute_reversal";
+            processing_fee: "processing_fee";
+            faircoin_payment: "faircoin_payment";
+            faircoin_payment_reversal: "faircoin_payment_reversal";
+        }>>;
+        payout: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        currency: 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<"balance_transaction">;
+            livemode: z.ZodBoolean;
+            amount: z.ZodString;
+            fee: z.ZodNullable<z.ZodString>;
+            net: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            type: z.ZodEnum<{
+                application_fee: "application_fee";
+                payout: "payout";
+                transfer: "transfer";
+                charge: "charge";
+                dispute: "dispute";
+                refund: "refund";
+                adjustment: "adjustment";
+                other: "other";
+                payment: "payment";
+                payment_refund: "payment_refund";
+                application_fee_refund: "application_fee_refund";
+                payout_cancel: "payout_cancel";
+                payout_failure: "payout_failure";
+                transfer_refund: "transfer_refund";
+                dispute_reversal: "dispute_reversal";
+                processing_fee: "processing_fee";
+                faircoin_payment: "faircoin_payment";
+                faircoin_payment_reversal: "faircoin_payment_reversal";
+            }>;
+            reporting_category: z.ZodString;
+            status: z.ZodEnum<{
+                pending: "pending";
+                available: "available";
+                informational: "informational";
+            }>;
+            available_on: z.ZodNullable<z.ZodNumber>;
+            created: z.ZodNumber;
+            description: z.ZodNullable<z.ZodString>;
+            exchange_rate: z.ZodNullable<z.ZodNumber>;
+            fee_details: z.ZodArray<z.ZodObject<{
+                amount: z.ZodString;
+                currency: z.ZodString;
+                type: z.ZodEnum<{
+                    application_fee: "application_fee";
+                    tax: "tax";
+                    other: "other";
+                    processing_fee: "processing_fee";
+                }>;
+            }, z.core.$strict>>;
+            source: z.ZodNullable<z.ZodString>;
+            payout: z.ZodNullable<z.ZodString>;
+            account: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "balanceTransactions.list";
+    readonly expandable: "balance_transaction";
+}, {
+    readonly operationId: "retrieveBalanceTransaction";
+    readonly method: "get";
+    readonly path: "/v1/balance_transactions/{id}";
+    readonly tag: "Balance transactions";
+    readonly summary: "Retrieve a balance transaction";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly peableAccount: true;
+    readonly params: {
+        readonly id: "The balance transaction (`txn_…`).";
+    };
+    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<"balance_transaction">;
+        livemode: z.ZodBoolean;
+        amount: z.ZodString;
+        fee: z.ZodNullable<z.ZodString>;
+        net: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        type: z.ZodEnum<{
+            application_fee: "application_fee";
+            payout: "payout";
+            transfer: "transfer";
+            charge: "charge";
+            dispute: "dispute";
+            refund: "refund";
+            adjustment: "adjustment";
+            other: "other";
+            payment: "payment";
+            payment_refund: "payment_refund";
+            application_fee_refund: "application_fee_refund";
+            payout_cancel: "payout_cancel";
+            payout_failure: "payout_failure";
+            transfer_refund: "transfer_refund";
+            dispute_reversal: "dispute_reversal";
+            processing_fee: "processing_fee";
+            faircoin_payment: "faircoin_payment";
+            faircoin_payment_reversal: "faircoin_payment_reversal";
+        }>;
+        reporting_category: z.ZodString;
+        status: z.ZodEnum<{
+            pending: "pending";
+            available: "available";
+            informational: "informational";
+        }>;
+        available_on: z.ZodNullable<z.ZodNumber>;
+        created: z.ZodNumber;
+        description: z.ZodNullable<z.ZodString>;
+        exchange_rate: z.ZodNullable<z.ZodNumber>;
+        fee_details: z.ZodArray<z.ZodObject<{
+            amount: z.ZodString;
+            currency: z.ZodString;
+            type: z.ZodEnum<{
+                application_fee: "application_fee";
+                tax: "tax";
+                other: "other";
+                processing_fee: "processing_fee";
+            }>;
+        }, z.core.$strict>>;
+        source: z.ZodNullable<z.ZodString>;
+        payout: z.ZodNullable<z.ZodString>;
+        account: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>;
+    readonly sdk: "balanceTransactions.retrieve";
+}];