@peable.to/contracts 0.3.0 → 1.0.0

package/dist/types/resources/checkout/contributions.d.ts

@@ -0,0 +1,375 @@
+import { z } from 'zod';
+/** A FairCoin base-unit amount a contribution can carry: positive, within a JS-safe integer. */
+export declare const contributionAmountSchema: z.ZodString;
+export declare const contributionDetailsSchema: z.ZodObject<{
+    organization_id: z.ZodString;
+    purpose: z.ZodString;
+    amount_mode: z.ZodEnum<{
+        fixed: "fixed";
+        free: "free";
+    }>;
+    expires_at: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type ContributionDetails = z.infer<typeof contributionDetailsSchema>;
+export declare const createContributionSchema: z.ZodObject<{
+    purpose: z.ZodString;
+    amount_mode: z.ZodEnum<{
+        fixed: "fixed";
+        free: "free";
+    }>;
+    amount: z.ZodOptional<z.ZodString>;
+    currency: z.ZodLiteral<"FAIR">;
+    expires_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strict>;
+export type CreateContribution = z.infer<typeof createContributionSchema>;
+/** A contribution link, as its members manage it. */
+export declare const contributionLinkSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"payment_link">;
+    amount: z.ZodString;
+    currency: z.ZodLiteral<"FAIR">;
+    network: z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>;
+    active: z.ZodBoolean;
+    url: z.ZodURL;
+    contribution: z.ZodObject<{
+        organization_id: z.ZodString;
+        purpose: z.ZodString;
+        amount_mode: z.ZodEnum<{
+            fixed: "fixed";
+            free: "free";
+        }>;
+        expires_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type ContributionLink = z.infer<typeof contributionLinkSchema>;
+export declare const contributionListSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payment_link">;
+        amount: z.ZodString;
+        currency: z.ZodLiteral<"FAIR">;
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        active: z.ZodBoolean;
+        url: z.ZodURL;
+        contribution: z.ZodObject<{
+            organization_id: z.ZodString;
+            purpose: z.ZodString;
+            amount_mode: z.ZodEnum<{
+                fixed: "fixed";
+                free: "free";
+            }>;
+            expires_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>;
+        created: z.ZodNumber;
+    }, z.core.$strict>>;
+    has_more: z.ZodBoolean;
+    url: z.ZodString;
+}, z.core.$strict>;
+export type ContributionList = z.infer<typeof contributionListSchema>;
+/** A payment made through a contribution link. Non-custodial: Peable cannot refund it. */
+export declare const contributionCollectionSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"payment_intent">;
+    amount: z.ZodString;
+    currency: z.ZodLiteral<"FAIR">;
+    status: z.ZodString;
+    created: z.ZodNumber;
+    refund_capability: z.ZodLiteral<"unsupported_non_custodial">;
+    refunds: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"refund">;
+        amount: z.ZodString;
+        status: z.ZodString;
+        created: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type ContributionCollection = z.infer<typeof contributionCollectionSchema>;
+export declare const contributionCollectionListSchema: z.ZodObject<{
+    object: z.ZodLiteral<"list">;
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payment_intent">;
+        amount: z.ZodString;
+        currency: z.ZodLiteral<"FAIR">;
+        status: z.ZodString;
+        created: z.ZodNumber;
+        refund_capability: z.ZodLiteral<"unsupported_non_custodial">;
+        refunds: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"refund">;
+            amount: z.ZodString;
+            status: z.ZodString;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    has_more: z.ZodBoolean;
+    url: z.ZodString;
+}, z.core.$strict>;
+export type ContributionCollectionList = z.infer<typeof contributionCollectionListSchema>;
+/** The query of every contribution write: the environment and nothing else. */
+export declare const contributionScopeQuerySchema: z.ZodObject<{
+    environment: z.ZodEnum<{
+        development: "development";
+        staging: "staging";
+        production: "production";
+    }>;
+}, z.core.$strict>;
+/**
+ * Paging a contribution list: the list parameters every list accepts
+ * (`link_…` cursors for links, `pi_…` for collections) plus the environment.
+ */
+export declare const contributionPageQuerySchema: 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>>>;
+    environment: z.ZodEnum<{
+        development: "development";
+        staging: "staging";
+        production: "production";
+    }>;
+}, z.core.$strict>;
+/** What a payer may say when starting a free contribution's checkout. */
+export declare const contributionMintSchema: z.ZodObject<{
+    amount: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** A contribution start's `Idempotency-Key`: a UUID the page writes before the request. */
+export declare const contributionOperationKeySchema: z.ZodUUID;
+export declare const contributionPatchSchema: z.ZodObject<{
+    active: z.ZodBoolean;
+}, z.core.$strict>;
+/** `"1.25"` FAIR → `"125000000"` base units, with exact integer arithmetic. */
+export declare function decimalContributionAmount(value: string): string;
+/** Base units → the shortest exact FAIR decimal. */
+export declare function formatContributionAmount(value: string): string;
+export declare const contributionRoutes: readonly [{
+    readonly operationId: "createContribution";
+    readonly method: "post";
+    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions";
+    readonly tag: "Contributions";
+    readonly summary: "Create a contribution link";
+    readonly description: "Requires a UUID `Idempotency-Key` header: the operation key, so a retry after a lost answer returns the same link.";
+    readonly auth: "user";
+    readonly params: {
+        readonly organizationId: "The Oxy organization.";
+        readonly applicationId: "The organization's Oxy application whose merchant collects.";
+    };
+    readonly query: z.ZodObject<{
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+    }, z.core.$strict>;
+    readonly body: z.ZodObject<{
+        purpose: z.ZodString;
+        amount_mode: z.ZodEnum<{
+            fixed: "fixed";
+            free: "free";
+        }>;
+        amount: z.ZodOptional<z.ZodString>;
+        currency: z.ZodLiteral<"FAIR">;
+        expires_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payment_link">;
+        amount: z.ZodString;
+        currency: z.ZodLiteral<"FAIR">;
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        active: z.ZodBoolean;
+        url: z.ZodURL;
+        contribution: z.ZodObject<{
+            organization_id: z.ZodString;
+            purpose: z.ZodString;
+            amount_mode: z.ZodEnum<{
+                fixed: "fixed";
+                free: "free";
+            }>;
+            expires_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+}, {
+    readonly operationId: "listContributions";
+    readonly method: "get";
+    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions";
+    readonly tag: "Contributions";
+    readonly summary: "List an organization's contribution links";
+    readonly auth: "user";
+    readonly params: {
+        readonly organizationId: "The Oxy organization.";
+        readonly applicationId: "The organization's Oxy application whose merchant collects.";
+    };
+    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>>>;
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"payment_link">;
+            amount: z.ZodString;
+            currency: z.ZodLiteral<"FAIR">;
+            network: z.ZodEnum<{
+                mainnet: "mainnet";
+                testnet: "testnet";
+            }>;
+            active: z.ZodBoolean;
+            url: z.ZodURL;
+            contribution: z.ZodObject<{
+                organization_id: z.ZodString;
+                purpose: z.ZodString;
+                amount_mode: z.ZodEnum<{
+                    fixed: "fixed";
+                    free: "free";
+                }>;
+                expires_at: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "updateContribution";
+    readonly method: "post";
+    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions/{id}";
+    readonly tag: "Contributions";
+    readonly summary: "Enable or disable a contribution link";
+    readonly auth: "user";
+    readonly params: {
+        readonly id: "The contribution link (`link_…`).";
+        readonly organizationId: "The Oxy organization.";
+        readonly applicationId: "The organization's Oxy application whose merchant collects.";
+    };
+    readonly query: z.ZodObject<{
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+    }, z.core.$strict>;
+    readonly body: z.ZodObject<{
+        active: z.ZodBoolean;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"payment_link">;
+        amount: z.ZodString;
+        currency: z.ZodLiteral<"FAIR">;
+        network: z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>;
+        active: z.ZodBoolean;
+        url: z.ZodURL;
+        contribution: z.ZodObject<{
+            organization_id: z.ZodString;
+            purpose: z.ZodString;
+            amount_mode: z.ZodEnum<{
+                fixed: "fixed";
+                free: "free";
+            }>;
+            expires_at: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strict>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+}, {
+    readonly operationId: "listContributionCollections";
+    readonly method: "get";
+    readonly path: "/v1/organizations/{organizationId}/applications/{applicationId}/contributions/{id}/collections";
+    readonly tag: "Contributions";
+    readonly summary: "List the payments made through a contribution link";
+    readonly auth: "user";
+    readonly params: {
+        readonly id: "The contribution link (`link_…`).";
+        readonly organizationId: "The Oxy organization.";
+        readonly applicationId: "The organization's Oxy application whose merchant collects.";
+    };
+    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>>>;
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"payment_intent">;
+            amount: z.ZodString;
+            currency: z.ZodLiteral<"FAIR">;
+            status: z.ZodString;
+            created: z.ZodNumber;
+            refund_capability: z.ZodLiteral<"unsupported_non_custodial">;
+            refunds: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                object: z.ZodLiteral<"refund">;
+                amount: z.ZodString;
+                status: z.ZodString;
+                created: z.ZodNumber;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+}];

package/dist/types/resources/checkout/files.d.ts

@@ -0,0 +1,280 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Files (`file_…`) — bytes a merchant gives Orbit for one stated purpose
+ * (ADR 0016: Orbit owns the object; the storage is Oxy Files, a binding that
+ * never reaches the wire). Stripe's Files API, with Oxy Files underneath.
+ */
+export declare const fileSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"file">;
+    livemode: z.ZodBoolean;
+    purpose: z.ZodEnum<{
+        dispute_evidence: "dispute_evidence";
+        business_logo: "business_logo";
+        identity_document: "identity_document";
+        additional_verification: "additional_verification";
+        finance_report_run: "finance_report_run";
+        tax_document: "tax_document";
+    }>;
+    filename: z.ZodNullable<z.ZodString>;
+    size: z.ZodNumber;
+    type: z.ZodEnum<{
+        pdf: "pdf";
+        png: "png";
+        jpg: "jpg";
+        csv: "csv";
+    }>;
+    status: z.ZodEnum<{
+        available: "available";
+        withheld: "withheld";
+        removed: "removed";
+    }>;
+    url: z.ZodNullable<z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+/** The API's `file` object; `FileObject` so it never shadows the DOM's `File`. */
+export type FileObject = Expand<z.output<typeof fileSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        file: FileObject;
+    }
+}
+/**
+ * `POST /v1/files` as `multipart/form-data`: a `purpose` field and a `file`
+ * part. The gateway reads the form itself, bounded by the largest purpose's
+ * ceiling, and checks each part with these schemas.
+ */
+export declare const createFileUploadParams: z.ZodObject<{
+    purpose: z.ZodEnum<{
+        dispute_evidence: "dispute_evidence";
+        business_logo: "business_logo";
+        identity_document: "identity_document";
+        additional_verification: "additional_verification";
+        tax_document: "tax_document";
+    }>;
+    file: z.ZodFile;
+}, z.core.$strict>;
+/**
+ * `POST /v1/files` as JSON: an Oxy file the caller already owns (their
+ * application's, or an account they are or act for). Its ownership is checked
+ * once, here, and never again.
+ */
+export declare const createFileFromOxyParams: z.ZodObject<{
+    purpose: z.ZodEnum<{
+        dispute_evidence: "dispute_evidence";
+        business_logo: "business_logo";
+        identity_document: "identity_document";
+        additional_verification: "additional_verification";
+        tax_document: "tax_document";
+    }>;
+    oxy_file: z.ZodString;
+}, z.core.$strict>;
+export type CreateFileFromOxyParams = z.input<typeof createFileFromOxyParams>;
+export declare const listFilesQuery: 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>>>;
+    purpose: z.ZodOptional<z.ZodEnum<{
+        dispute_evidence: "dispute_evidence";
+        business_logo: "business_logo";
+        identity_document: "identity_document";
+        additional_verification: "additional_verification";
+        finance_report_run: "finance_report_run";
+        tax_document: "tax_document";
+    }>>;
+}, z.core.$strict>;
+export type ListFilesParams = Pick<z.input<typeof listFilesQuery>, 'purpose'>;
+export declare const fileRoutes: readonly [{
+    readonly operationId: "createFile";
+    readonly method: "post";
+    readonly path: "/v1/files";
+    readonly tag: "Files";
+    readonly summary: "Upload a file";
+    readonly description: "The bytes as `multipart/form-data` (`purpose`, `file`), or — as JSON — `{ purpose, oxy_file }` to import an Oxy file you own. The type is recognised from the bytes, never from a `Content-Type`; each purpose has its own formats and size ceiling.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        purpose: z.ZodEnum<{
+            dispute_evidence: "dispute_evidence";
+            business_logo: "business_logo";
+            identity_document: "identity_document";
+            additional_verification: "additional_verification";
+            tax_document: "tax_document";
+        }>;
+        file: z.ZodFile;
+    }, z.core.$strict>;
+    readonly bodyEncoding: "multipart";
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"file">;
+        livemode: z.ZodBoolean;
+        purpose: z.ZodEnum<{
+            dispute_evidence: "dispute_evidence";
+            business_logo: "business_logo";
+            identity_document: "identity_document";
+            additional_verification: "additional_verification";
+            finance_report_run: "finance_report_run";
+            tax_document: "tax_document";
+        }>;
+        filename: z.ZodNullable<z.ZodString>;
+        size: z.ZodNumber;
+        type: z.ZodEnum<{
+            pdf: "pdf";
+            png: "png";
+            jpg: "jpg";
+            csv: "csv";
+        }>;
+        status: z.ZodEnum<{
+            available: "available";
+            withheld: "withheld";
+            removed: "removed";
+        }>;
+        url: z.ZodNullable<z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "files.create";
+}, {
+    readonly operationId: "listFiles";
+    readonly method: "get";
+    readonly path: "/v1/files";
+    readonly tag: "Files";
+    readonly summary: "List files";
+    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>>>;
+        purpose: z.ZodOptional<z.ZodEnum<{
+            dispute_evidence: "dispute_evidence";
+            business_logo: "business_logo";
+            identity_document: "identity_document";
+            additional_verification: "additional_verification";
+            finance_report_run: "finance_report_run";
+            tax_document: "tax_document";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"file">;
+            livemode: z.ZodBoolean;
+            purpose: z.ZodEnum<{
+                dispute_evidence: "dispute_evidence";
+                business_logo: "business_logo";
+                identity_document: "identity_document";
+                additional_verification: "additional_verification";
+                finance_report_run: "finance_report_run";
+                tax_document: "tax_document";
+            }>;
+            filename: z.ZodNullable<z.ZodString>;
+            size: z.ZodNumber;
+            type: z.ZodEnum<{
+                pdf: "pdf";
+                png: "png";
+                jpg: "jpg";
+                csv: "csv";
+            }>;
+            status: z.ZodEnum<{
+                available: "available";
+                withheld: "withheld";
+                removed: "removed";
+            }>;
+            url: z.ZodNullable<z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "files.list";
+    readonly expandable: "file";
+}, {
+    readonly operationId: "retrieveFile";
+    readonly method: "get";
+    readonly path: "/v1/files/{id}";
+    readonly tag: "Files";
+    readonly summary: "Retrieve a file";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The file (`file_…`).";
+    };
+    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<"file">;
+        livemode: z.ZodBoolean;
+        purpose: z.ZodEnum<{
+            dispute_evidence: "dispute_evidence";
+            business_logo: "business_logo";
+            identity_document: "identity_document";
+            additional_verification: "additional_verification";
+            finance_report_run: "finance_report_run";
+            tax_document: "tax_document";
+        }>;
+        filename: z.ZodNullable<z.ZodString>;
+        size: z.ZodNumber;
+        type: z.ZodEnum<{
+            pdf: "pdf";
+            png: "png";
+            jpg: "jpg";
+            csv: "csv";
+        }>;
+        status: z.ZodEnum<{
+            available: "available";
+            withheld: "withheld";
+            removed: "removed";
+        }>;
+        url: z.ZodNullable<z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "files.retrieve";
+    readonly expandable: "file";
+}, {
+    readonly operationId: "retrieveFileContents";
+    readonly method: "get";
+    readonly path: "/v1/files/{id}/contents";
+    readonly tag: "Files";
+    readonly summary: "Download a file's contents";
+    readonly description: "The bytes of a file you read back — a report run's CSV — as an attachment. Any other purpose answers 404: evidence and identity documents leave Peable only to their provider.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The file (`file_…`).";
+    };
+    readonly query: z.ZodObject<{}, z.core.$strict>;
+    readonly response: {
+        readonly kind: "binary";
+        readonly contentType: "text/csv";
+    };
+    readonly sdk: "files.contents";
+}];