@peable.to/contracts 0.4.0 → 1.1.0

package/dist/types/common/params.d.ts

@@ -0,0 +1,156 @@
+import { z } from 'zod';
+/**
+ * An integer in a query string. Arrives as a string from a URL, as a number
+ * from a typed caller; both are the same request.
+ */
+export declare function queryInteger(bounds?: {
+    min?: number;
+    max?: number;
+}): z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+/** `true` / `false` in a query string (or a real boolean from a typed caller). */
+export declare const queryBoolean: z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
+    true: "true";
+    false: "false";
+}>]>, z.ZodTransform<boolean, boolean | "true" | "false">>;
+/** The latest representable instant (9999-12-31T23:59:59Z), the bound of every Unix-seconds parameter. */
+export declare const MAX_UNIX_SECONDS = 253402300799;
+/** Unix seconds in a body. */
+export declare const unixSecondsParam: z.ZodNumber;
+/** Unix seconds in a query string. */
+export declare const queryUnixSeconds: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+/** A range over a Unix-seconds field; each bound optional, together a conjunction. */
+export interface RangeFilter {
+    readonly gt?: number | undefined;
+    readonly gte?: number | undefined;
+    readonly lt?: number | undefined;
+    readonly lte?: number | undefined;
+}
+/**
+ * `created=X` (exactly that second) or `created[gt|gte|lt|lte]=X`. The bare
+ * form is normalized to the range `[X, X]` so the repository reads one shape.
+ */
+export declare const rangeParam: 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<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<RangeFilter, {
+    gt?: number | undefined;
+    gte?: number | undefined;
+    lt?: number | undefined;
+    lte?: number | undefined;
+}>>]>;
+/**
+ * `expand[]=a&expand[]=b` arrives as an array; `expand=a` as a string. Both
+ * mean the same request. Dot paths, at most four levels; on a list every path
+ * starts with `data.`.
+ */
+export declare const expandParam: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>;
+/** The public id of a cursor. Bounded so a cursor is never an unbounded index probe. */
+export declare const cursorParam: z.ZodString;
+/** An object id in a body or query. */
+export declare const idParam: z.ZodString;
+/** The list limit: 1–100, default 10. */
+export declare const limitParam: 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>>;
+/** The parameters every list accepts. */
+export declare const listShape: {
+    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<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<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>>>;
+};
+/**
+ * A list query: the shared parameters plus the route's own filters.
+ *
+ * `.strict()`: an unknown parameter is a 400 naming it, never silently ignored
+ * — `?stauts=settled` answering every intent is a filter the caller believes
+ * they applied.
+ */
+export declare function listQuery<S extends z.ZodRawShape>(filters: S): 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<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<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>>>;
+} & S extends infer T ? { -readonly [P in keyof T]: T[P]; } : never, z.core.$strict>;
+/** A retrieve's query: `expand[]` and nothing else unless the route says so. */
+export declare function retrieveQuery<S extends z.ZodRawShape>(extra: S): 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>>>;
+} & S extends infer T ? { -readonly [P in keyof T]: T[P]; } : never, z.core.$strict>;
+/** The query of a route that takes `expand[]` only. */
+export declare const expandOnlyQuery: 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>;
+/** The query of a route that takes no parameters at all. */
+export declare const emptyQuery: z.ZodObject<{}, z.core.$strict>;
+/** The parameters every `GET /v1/<objects>/search` accepts. */
+export declare const searchShape: {
+    query: z.ZodString;
+    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>>;
+    page: z.ZodOptional<z.ZodString>;
+    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>>>;
+};
+/** A search query. */
+export declare const searchQuery: z.ZodObject<{
+    query: z.ZodString;
+    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>>;
+    page: z.ZodOptional<z.ZodString>;
+    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>;
+/** The parameters every list accepts, as a caller sends them. */
+export type ListParams = z.input<ReturnType<typeof listQuery<Record<never, z.ZodType>>>>;
+/** A Unix-seconds range as a caller sends it: bounds, each optional. */
+export type RangeQuery = Extract<z.input<typeof rangeParam>, object>;
+/** The parameter a single read or write accepts to expand its answer. */
+export interface ExpandParams {
+    /** Dot paths, at most four levels deep (`['payment_intent.connected_account']`). */
+    expand?: string[];
+}
+/** The parameters every search accepts, as a caller sends them. */
+export type SearchParams = z.input<typeof searchQuery>;
+export declare const METADATA_MAX_KEYS = 50;
+export declare const METADATA_KEY_MAX = 40;
+export declare const METADATA_VALUE_MAX = 500;
+/** A metadata update, as the repository applies it. */
+export interface MetadataPatch {
+    readonly set: Record<string, string>;
+    readonly unset: readonly string[];
+}
+/**
+ * The bag a create stores. Empty values are dropped: there is nothing to unset
+ * yet.
+ */
+export declare const metadataCreateParam: z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>;
+/**
+ * The patch an update applies: named keys are set, a key sent as `""` is
+ * removed, keys not named are kept. The 50-key limit is then judged on the
+ * merged result, which only the database can see.
+ */
+export declare const metadataUpdateParam: z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<MetadataPatch, Record<string, string>>>;
+/** The answer when the MERGED bag would exceed the key limit. */
+export declare const METADATA_LIMIT_MESSAGE = "metadata holds at most 50 keys";
+/** `""` clears a field on an update, Stripe's rule. */
+export declare const clearable: <T extends z.ZodType>(schema: T) => z.ZodUnion<readonly [T, z.ZodLiteral<"">]>;
+/** Bounded text. */
+export declare const text: (max: number) => z.ZodString;

package/dist/types/common/primitives.d.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+/**
+ * The house style's primitives (ADR 0014 D1), as RESPONSE schemas: what the
+ * gateway emits. Request-side building blocks (coercing query integers,
+ * `expand[]`, metadata patches) are in `params.ts`.
+ */
+/** Every instant on the wire: integer Unix seconds. */
+export declare const unixSeconds: z.ZodNumber;
+/** A base-unit amount: an integer string in the currency's smallest unit (a FAIR amount does not fit a JS number). */
+export declare const amount: z.ZodString;
+/** A signed base-unit amount (a customer balance, a balance transaction's net). */
+export declare const signedAmount: z.ZodString;
+/** An uppercase ISO 4217 code, or `FAIR`. */
+export declare const currency: z.ZodEnum<{
+    FAIR: "FAIR";
+    EUR: "EUR";
+    USD: "USD";
+    GBP: "GBP";
+    CHF: "CHF";
+    SEK: "SEK";
+    NOK: "NOK";
+    DKK: "DKK";
+    PLN: "PLN";
+    CZK: "CZK";
+    CAD: "CAD";
+    AUD: "AUD";
+    JPY: "JPY";
+}>;
+/** A currency the card rail can denominate in. */
+export declare const fiatCurrency: z.ZodEnum<{
+    EUR: "EUR";
+    USD: "USD";
+    GBP: "GBP";
+    CHF: "CHF";
+    SEK: "SEK";
+    NOK: "NOK";
+    DKK: "DKK";
+    PLN: "PLN";
+    CZK: "CZK";
+    CAD: "CAD";
+    AUD: "AUD";
+    JPY: "JPY";
+}>;
+/** The FairCoin network. */
+export declare const network: z.ZodEnum<{
+    mainnet: "mainnet";
+    testnet: "testnet";
+}>;
+/** Whether the object exists in live mode (`false`: test mode). */
+export declare const livemode: z.ZodBoolean;
+/** The merchant's own key/value bag, as returned. */
+export declare const metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+/** A nullable string — the shape of every optional text field on a response. */
+export declare const nullableString: z.ZodNullable<z.ZodString>;
+/** A literal `object` discriminator. */
+export declare const objectName: <T extends string>(name: T) => z.ZodLiteral<T>;

package/dist/types/contributions.d.ts

@@ -0,0 +1 @@
+export { type ContributionCollection, type ContributionCollectionList, type ContributionDetails, type ContributionLink, type ContributionList, type CreateContribution, contributionAmountSchema, contributionCollectionListSchema, contributionCollectionSchema, contributionDetailsSchema, contributionLinkSchema, contributionListSchema, contributionMintSchema, contributionOperationKeySchema, contributionPageQuerySchema, contributionPatchSchema, contributionScopeQuerySchema, createContributionSchema, decimalContributionAmount, formatContributionAmount, } from './resources/checkout/contributions';

package/dist/types/index.d.ts

@@ -1,171 +1,16 @@
-import { z } from 'zod';
-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>;
-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>;
-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>;
-/**
- * The list parameters every list accepts (ADR 0014 D1), newest first:
- *
- * - `limit` 1–100, default 10;
- * - `starting_after` — the id of the last object of the previous page — or
- *   `ending_before` — the id of the first object of the current one, which
- *   pages backwards and still answers newest first. Never both;
- * - `created` (one second) or `created[gt|gte|lt|lte]`, Unix seconds.
- *
- * Cursors are resolved by the gateway inside the caller's scope; one naming
- * anything else is a 400 with `param` naming the cursor.
- */
-export declare const listQueryShape: {
-    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-    starting_after: z.ZodOptional<z.ZodString>;
-    ending_before: z.ZodOptional<z.ZodString>;
-    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodCoercedNumber<unknown>, z.ZodTransform<{
-        gte: number;
-        lte: number;
-    }, number>>, z.ZodObject<{
-        gt: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        gte: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        lt: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        lte: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-    }, z.core.$strict>]>>;
-};
-/**
- * Paging a contribution list: the list parameters (`link_…` cursors for links,
- * `pi_…` for collections) plus the environment the Test/Live toggle selects.
- */
-export declare const contributionPageQuerySchema: z.ZodObject<{
-    environment: z.ZodEnum<{
-        development: "development";
-        staging: "staging";
-        production: "production";
-    }>;
-    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-    starting_after: z.ZodOptional<z.ZodString>;
-    ending_before: z.ZodOptional<z.ZodString>;
-    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodCoercedNumber<unknown>, z.ZodTransform<{
-        gte: number;
-        lte: number;
-    }, number>>, z.ZodObject<{
-        gt: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        gte: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        lt: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        lte: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-    }, z.core.$strict>]>>;
-}, z.core.$strict>;
-export declare const contributionMintSchema: z.ZodObject<{
-    amount: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
-export declare const contributionOperationKeySchema: z.ZodString;
-export declare const contributionPatchSchema: z.ZodObject<{
-    active: z.ZodBoolean;
-}, z.core.$strict>;
-export declare function decimalContributionAmount(value: string): string;
-export declare function formatContributionAmount(value: string): string;
-export type ContributionCollectionList = z.infer<typeof contributionCollectionListSchema>;
+export * from './common/address';
+export * from './common/envelopes';
+export * from './common/objects';
+export * from './common/params';
+export * from './common/primitives';
+export * from './route';
+export * from './routes';
+export * from './vocabulary';
+export * from './resources/core';
+export * from './resources/payments';
+export * from './resources/checkout';
+export * from './resources/catalog';
+export * from './resources/billingEngine';
+export * from './resources/connect';
+export * from './resources/tax';
+export * from './resources/events';

package/dist/types/openapi/document.d.ts

@@ -0,0 +1,16 @@
+export interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: Record<string, unknown>;
+    servers: {
+        url: string;
+        description: string;
+    }[];
+    tags: {
+        name: string;
+    }[];
+    paths: Record<string, Record<string, unknown>>;
+    webhooks: Record<string, unknown>;
+    components: Record<string, unknown>;
+}
+/** Generate the whole document. Pure: the same contracts give the same bytes. */
+export declare function buildOpenApiDocument(): OpenApiDocument;

package/dist/types/openapi/index.d.ts

@@ -0,0 +1,2 @@
+export { buildOpenApiDocument, type OpenApiDocument } from './document';
+export { webhookEvents, type WebhookEventContract } from './webhooks';

package/dist/types/openapi/webhooks.d.ts

@@ -0,0 +1,15 @@
+import type { z } from 'zod';
+/** One webhook event type as the OpenAPI `webhooks` section documents it. */
+export interface WebhookEventContract {
+    /** `payment_intent.succeeded`. */
+    readonly type: string;
+    readonly description?: string;
+    /** The whole envelope (`Event`) with `data.object` narrowed to this type's object. */
+    readonly schema: z.ZodType;
+}
+/**
+ * Every event type the gateway emits, with its payload: one entry per member
+ * of `WEBHOOK_EVENT_TYPES`, its body the `Event` envelope with `type` fixed and
+ * `data.object` the object `WEBHOOK_EVENT_OBJECTS` names.
+ */
+export declare function webhookEvents(): readonly WebhookEventContract[];