@peable.to/shared-types 0.15.0 → 0.17.0

package/dist/types/file.d.ts

@@ -4,10 +4,18 @@
  * reference the file — a `business_logo` is public, a `dispute_evidence` file
  * is private and can only be attached to the merchant's own disputes.
  */
-export declare const FILE_PURPOSES: readonly ["dispute_evidence", "business_logo", "identity_document", "additional_verification"];
+export declare const FILE_PURPOSES: readonly ["dispute_evidence", "business_logo", "identity_document", "additional_verification", "finance_report_run"];
 export type FilePurpose = (typeof FILE_PURPOSES)[number];
+/**
+ * The purposes a merchant may upload or import. `finance_report_run` is not
+ * among them: a report's CSV is written by Peable's report runs
+ * (`/v1/reporting/report_runs`) and nobody else, so a file of that purpose is
+ * always a report Peable produced.
+ */
+export declare const FILE_UPLOAD_PURPOSES: readonly ["dispute_evidence", "business_logo", "identity_document", "additional_verification"];
+export type FileUploadPurpose = (typeof FILE_UPLOAD_PURPOSES)[number];
 /** The stored format, by its conventional extension (Stripe's `type`). */
-export declare const FILE_TYPES: readonly ["pdf", "png", "jpg"];
+export declare const FILE_TYPES: readonly ["pdf", "png", "jpg", "csv"];
 export type FileType = (typeof FILE_TYPES)[number];
 /**
  * Whether the bytes can be used right now.
@@ -21,12 +29,13 @@ export type FileType = (typeof FILE_TYPES)[number];
 export declare const FILE_STATUSES: readonly ["available", "withheld", "removed"];
 export type FileStatus = (typeof FILE_STATUSES)[number];
 /**
- * The upload policy of each purpose: the formats it takes, recognised from the
- * bytes and never from a client's `Content-Type`, and the largest file.
+ * The policy of each purpose: the formats it takes, recognised from the bytes
+ * and never from a client's `Content-Type`, and the largest file.
  *
  * The provider's own ceilings, restated where the upload is parsed, so a file
  * the card network would refuse is refused at upload — not at the one-shot
- * dispute submission it was meant for.
+ * dispute submission it was meant for. `finance_report_run` is Peable's own
+ * output (see {@link FILE_UPLOAD_PURPOSES}); its ceiling bounds a report.
  */
 export declare const FILE_PURPOSE_POLICIES: Readonly<Record<FilePurpose, {
     readonly types: readonly FileType[];
@@ -50,10 +59,16 @@ export interface FileObject {
     type: FileType;
     status: FileStatus;
     /**
-     * A public URL for a `business_logo` that is `available` — what a payer
-     * surface renders. `null` for every other purpose: evidence and identity
-     * documents are never addressable by URL, and their bytes leave Peable only
-     * to the provider they are submitted to.
+     * Where the bytes can be read, while the file is `available`:
+     *
+     *  - a `business_logo`: a PUBLIC URL — what a payer surface renders;
+     *  - a `finance_report_run`: the gateway's `GET /v1/files/:id/contents`,
+     *    which answers the CSV to the merchant's own credential (Stripe's
+     *    `files.stripe.com/v1/files/:id/contents`).
+     *
+     * `null` for every other purpose: evidence and identity documents are never
+     * addressable by URL, and their bytes leave Peable only to the provider they
+     * are submitted to.
      */
     url: string | null;
     created: number;
@@ -68,7 +83,7 @@ export interface FileObject {
  *    checked once, here, and never again.
  */
 export interface CreateFileFromOxyParams {
-    purpose: FilePurpose;
+    purpose: FileUploadPurpose;
     /** Oxy file id. */
     oxy_file: string;
 }

package/dist/types/index.d.ts

@@ -10,7 +10,9 @@ export { PEABLE_API_VERSION, type WebhookEventType, type WebhookEvent, type Webh
 export { WEBHOOK_ENDPOINT_STATUSES, WEBHOOK_ENDPOINT_DISABLED_REASONS, WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT, WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS, type WebhookEnabledEvent, type WebhookEndpoint, type WebhookEndpointStatus, type WebhookEndpointDisabledReason, type DeletedWebhookEndpoint, type CreateWebhookEndpointParams, type UpdateWebhookEndpointParams, type RollWebhookEndpointSecretParams, } from './webhookEndpoint';
 export { PRICE_BILLING_SCHEMES, PRICE_TIERS_MODES, PRICE_TYPES, RECURRING_INTERVALS, RECURRING_USAGE_TYPES, PRICE_TAX_BEHAVIORS, TRANSFORM_QUANTITY_ROUNDS, COUPON_DURATIONS, CATALOG_LIMITS, type PriceBillingScheme, type PriceTiersMode, type PriceType, type RecurringInterval, type RecurringUsageType, type PriceTaxBehavior, type TransformQuantityRound, type CouponDuration, type ProductMarketingFeature, type Product, type DeletedProduct, type PriceTier, type PriceTransformQuantity, type PriceRecurring, type Price, type Coupon, type DeletedCoupon, type PromotionCodeRestrictions, type PromotionCode, type RecurringParams, type PriceTierParams, type PriceDataParams, type DefaultPriceDataParams, type CreateProductParams, type UpdateProductParams, type ProductListParams, type CreatePriceParams, type UpdatePriceParams, type PriceListParams, type CreateCouponParams, type UpdateCouponParams, type CouponListParams, type CreatePromotionCodeParams, type UpdatePromotionCodeParams, type PromotionCodeListParams, } from './catalog';
 export { DISPUTE_FILE_EVIDENCE_FIELDS, DISPUTE_REASONS, DISPUTE_TEXT_EVIDENCE_FIELDS, normalizeDisputeReason, type Dispute, type DisputeEvidence, type DisputeEvidenceDetails, type DisputeEvidenceField, type DisputeEvidenceParams, type DisputeFileEvidenceField, type DisputeReason, type DisputeStatus, type DisputeTextEvidenceField, type ListDisputesParams, type UpdateDisputeParams, } from './dispute';
-export { FILE_PURPOSES, FILE_PURPOSE_POLICIES, FILE_STATUSES, FILE_TYPES, type CreateFileFromOxyParams, type FileObject, type FilePurpose, type FileStatus, type FileType, type ListFilesParams, } from './file';
+export { FILE_PURPOSES, FILE_PURPOSE_POLICIES, FILE_UPLOAD_PURPOSES, FILE_STATUSES, FILE_TYPES, type CreateFileFromOxyParams, type FileObject, type FilePurpose, type FileStatus, type FileType, type FileUploadPurpose, type ListFilesParams, } from './file';
+export { SEARCHABLE_RESOURCES, SEARCH_QUERY_MAX_CLAUSES, SEARCH_QUERY_MAX_LENGTH, SEARCH_SUBSTRING_MIN_LENGTH, type SearchParams, type SearchResult, type SearchableResource, } from './search';
+export { REPORT_RUN_STATUSES, REPORT_TYPE_IDS, REPORT_TYPE_LAYOUTS, type CreateReportRunParams, type ListReportRunsParams, type ReportRun, type ReportRunParameters, type ReportRunStatus, type ReportType, type ReportTypeId, } from './reporting';
 export { CARD_RAIL_PAYMENT_METHOD_TYPES, PAYMENT_METHOD_CONFIGURATION_TYPES, PAYMENT_METHOD_CURRENCIES, type CardRailPaymentMethodType, type CreatePaymentMethodConfigurationParams, type CreatePaymentMethodDomainParams, type ListPaymentMethodDomainsParams, type PaymentMethodConfiguration, type PaymentMethodConfigurationEntry, type PaymentMethodConfigurationEntryParams, type PaymentMethodConfigurationType, type PaymentMethodDisplayPreference, type PaymentMethodDomain, type PaymentMethodDomainWalletStatus, type PaymentMethodUnavailableReason, type UpdatePaymentMethodConfigurationParams, type UpdatePaymentMethodDomainParams, } from './paymentMethodConfiguration';
 export { PAYOUT_INTERVALS, PAYOUT_WEEKLY_ANCHORS, type Account, type AccountBusinessProfile, type AccountCapabilityStatus, type AccountPayoutSchedule, type AccountRequirements, type AccountSettings, type AccountType, type CreateAccountLinkParams, type PayoutInterval, type PayoutWeeklyAnchor, type UpdateAccountParams, } from './account';
 export { BALANCE_TRANSACTION_STATUSES, BALANCE_TRANSACTION_TYPES, PAYOUT_STATUSES, RECONCILIATION_MISMATCH_KINDS, type ApplicationFee, type Balance, type BalanceAmount, type BalanceTransaction, type BalanceTransactionFeeDetail, type BalanceTransactionStatus, type BalanceTransactionType, type CreatePayoutParams, type FeeRefund, type ListBalanceTransactionsParams, type ListPayoutsParams, type Payout, type PayoutReconciliationReport, type PayoutStatus, type ReconciliationMismatch, type ReconciliationMismatchKind, } from './balance';
@@ -23,8 +25,9 @@ export { signWebhook, verifyWebhook } from './webhookSigner';
 export { type MerchantEnvironment, type Merchant, MERCHANT_ENVIRONMENTS, } from './merchant';
 export type { MerchantDisplay } from './merchantDisplay';
 export type { AccountLink, ConnectOnboarding, ConnectOnboardingComplete, RegisterFaircoinKeyParams, } from './connect';
-export type { PaymentLink, PublicPaymentLink, CreatePaymentLinkParams, UpdatePaymentLinkParams, } from './paymentLink';
-export type { CheckoutSession, CheckoutSessionPublic, CreateCheckoutSessionParams, UpdateCheckoutSessionParams, } from './checkoutSession';
+export { PAYMENT_LINK_LIMITS, type PaymentLink, type PublicPaymentLink, type PaymentLinkLineItemParams, type PaymentLinkAfterCompletionParams, type CreatePaymentLinkParams, type UpdatePaymentLinkParams, type CreatePaymentLinkSessionParams, type PaymentLinkSessionStart, } from './paymentLink';
+export { CHECKOUT_SESSION_MODES, CHECKOUT_SESSION_STATUSES, CHECKOUT_PAYMENT_STATUSES, CHECKOUT_UI_MODES, CHECKOUT_LOCALES, CHECKOUT_SUBMIT_TYPES, CHECKOUT_CUSTOMER_CREATIONS, CHECKOUT_BILLING_ADDRESS_COLLECTIONS, CHECKOUT_CUSTOM_FIELD_TYPES, CHECKOUT_TAX_ID_TYPES, CHECKOUT_LIMITS, CHECKOUT_SESSION_ID_TEMPLATE, type CheckoutSessionMode, type CheckoutSessionStatus, type CheckoutSessionPaymentStatus, type CheckoutUiMode, type CheckoutLocale, type CheckoutSubmitType, type CheckoutCustomerCreation, type CheckoutBillingAddressCollection, type CheckoutCustomFieldType, type CheckoutTaxIdType, type CheckoutAdjustableQuantity, type CheckoutLineItem, type CheckoutTaxId, type CheckoutCustomerDetails, type CheckoutShippingDetails, type CheckoutCustomFieldLabel, type CheckoutCustomFieldDropdownOption, type CheckoutCustomField, type CheckoutDiscount, type CheckoutTotalDetails, type CheckoutAutomaticTax, type CheckoutConsentCollection, type CheckoutConsent, type CheckoutAfterCompletion, type CheckoutSession, type CheckoutSessionPublic, type UpdateCheckoutSessionPublicParams, type ConfirmCheckoutSessionPublicParams, type CheckoutProductDataParams, type CheckoutPriceDataParams, type CheckoutLineItemParams, type CheckoutCustomFieldParams, type CreateCheckoutSessionParams, type UpdateCheckoutSessionParams, } from './checkoutSession';
+export { BRANDING_FONTS, BRANDING_BORDER_STYLES, BRANDING_COLOR_PATTERN, DEFAULT_BRANDING, type BrandingFont, type BrandingBorderStyle, type MerchantBranding, type UpdateMerchantBrandingParams, type CheckoutBranding, type MerchantEmailSettings, type UpdateMerchantEmailSettingsParams, } from './branding';
 export { SOCIAL_SOURCE_APP_MAX_LENGTH, SOCIAL_SOURCE_REF_MAX_LENGTH, type SocialPaymentSource, type SocialNextAddressRequest, type SocialNextAddressResponse, type SocialReceiveCursorResponse, type SocialPaymentDirection, type SocialPayment, type SocialPaymentsResponse, type EnrichmentKind, type EnrichmentResult, type EnrichRequest, type EnrichResponse, } from './social';
 export { BILLING_SUBSCRIPTION_STATUSES, type BillingSubscriptionStatus, type CreateBillingTaxQuoteParams, type BillingTaxQuote, type BillingInvoiceAuthoritySource, type BillingFinalInvoice, type BillingFinalInvoiceAuthority, type BillingFaircoinRenewalChoice, type BillingFaircoinRenewalConsent, type BillingFaircoinRenewalRevocation, type BillingCheckoutSession, type BillingEmbeddedCheckoutSession, type BillingEmbeddedCheckoutConfiguration, type BillingEmbeddedCheckoutBinding, type BillingEmbeddedCheckoutAction, type BillingEmbeddedCheckoutScope, type BillingCheckoutObservation, type RetrieveBillingCheckoutOperationParams, type BillingCheckoutOperationSource, type BillingCheckoutOperationRecovery, type BillingPaidInvoice, type BillingInvoiceState, type BillingCustomer, type BillingRail, type BillingRailSettlement, type BillingRailOffer, type BillingRailOption, type BillingRailList, type EnsureBillingCustomerParams, type CreateBillingCheckoutParams, type CreateBillingPortalParams, type BillingHostedSession, type BillingSubscription, } from './billing';
 export { canonicalBillingAuthority, canonicalBillingTaxQuote, PEABLE_BILLING_AUTHORITY_KEYS, } from './billing-authority';

package/dist/types/paymentLink.d.ts

@@ -1,72 +1,177 @@
 import type { ContributionDetails } from '@peable.to/contracts';
+import type { CheckoutBranding } from './branding';
+import type { CheckoutAdjustableQuantity, CheckoutAfterCompletion, CheckoutBillingAddressCollection, CheckoutCustomField, CheckoutCustomFieldParams, CheckoutCustomerCreation, CheckoutLineItem, CheckoutLocale, CheckoutSubmitType } from './checkoutSession';
 import type { CurrencyCode } from './money';
-import type { NetworkType } from './network';
 import type { MerchantDisplay } from './merchantDisplay';
+import type { NetworkType } from './network';
 import type { PaymentIntentRail } from './paymentIntent';
-/** The merchant-facing DTO — returned by the merchant-authed CRUD routes. */
+export declare const PAYMENT_LINK_LIMITS: Readonly<{
+    lineItemsMax: 20;
+    customMessageMax: 500;
+}>;
 export interface PaymentLink {
     id: string;
     object: 'payment_link';
-    /**
-     * Which of the provider's two worlds this object belongs to (ADR 0017):
-     * `true` for a `production` merchant, `false` for every other environment.
-     */
     livemode: boolean;
-    contribution?: ContributionDetails;
-    /**
-     * Amount in the currency's smallest unit, as a canonical integer string.
-     * Never a float, and never interpretable without `currency`.
-     */
-    amount: string;
+    active: boolean;
     currency: CurrencyCode;
     rail: PaymentIntentRail;
-    /** FairCoin rail only; `null` on a card link. */
     network: NetworkType | null;
-    active: boolean;
+    /** The link's prices (`GET /v1/payment_links/:id/line_items` lists them in full). */
+    line_items: CheckoutLineItem[];
+    allow_promotion_codes: boolean;
+    billing_address_collection: CheckoutBillingAddressCollection;
+    shipping_address_collection: {
+        allowed_countries: string[];
+    } | null;
+    phone_number_collection: {
+        enabled: boolean;
+    };
+    tax_id_collection: {
+        enabled: boolean;
+    };
+    custom_fields: CheckoutCustomField[];
+    consent_collection: {
+        terms_of_service: 'none' | 'required';
+    } | null;
+    automatic_tax: {
+        enabled: boolean;
+    };
+    customer_creation: CheckoutCustomerCreation;
+    after_completion: CheckoutAfterCompletion;
+    restrictions: {
+        completed_sessions: {
+            limit: number;
+            count: number;
+        };
+    } | null;
+    submit_type: CheckoutSubmitType;
+    locale: CheckoutLocale | null;
+    /** Present on an organization contribution link (FairCoin). */
+    contribution?: ContributionDetails;
     metadata: Record<string, string>;
-    /** Optional post-payment redirect target for the checkout page. */
-    success_url?: string;
-    /** Canonical `checkout.peable.to/l/<id>` URL. */
+    /** `checkout.peable.to/l/<id>` — share it, or render it as a QR code. */
     url: string;
     created: number;
     updated_at: number;
 }
-/** What an unauthenticated checkout-page visitor may see — no secrets, no metadata. */
+/** What an anonymous visitor may see before checkout starts — no metadata, no counts. */
 export interface PublicPaymentLink {
     id: string;
     object: 'payment_link';
-    /**
-     * Which of the provider's two worlds this object belongs to (ADR 0017):
-     * `true` for a `production` merchant, `false` for every other environment.
-     */
     livemode: boolean;
-    contribution?: ContributionDetails;
-    amount: string;
+    active: boolean;
     currency: CurrencyCode;
     rail: PaymentIntentRail;
     network: NetworkType | null;
-    active: boolean;
+    line_items: CheckoutLineItem[];
+    contribution?: ContributionDetails;
+    /** A fixed contribution's amount; `null` when the payer chooses (or for a price link). */
+    contribution_amount: string | null;
     merchant: MerchantDisplay;
+    branding: CheckoutBranding;
+    locale: CheckoutLocale | null;
+}
+export interface PaymentLinkLineItemParams {
+    price: string;
+    quantity: number;
+    adjustable_quantity?: {
+        enabled: boolean;
+        minimum?: number;
+        maximum?: number;
+    };
+}
+export interface PaymentLinkAfterCompletionParams {
+    type: 'redirect' | 'hosted_confirmation';
+    /** `type: redirect` — may carry `{CHECKOUT_SESSION_ID}`. */
+    redirect?: {
+        url: string;
+    };
+    hosted_confirmation?: {
+        custom_message?: string;
+    };
 }
 export interface CreatePaymentLinkParams {
-    amount: string;
-    /** Defaults to `'faircoin'`, so pre-ADR-0001 integrations keep working. */
-    rail?: PaymentIntentRail;
-    /** Required on the faircoin rail; refused on the card rail. */
-    network?: NetworkType;
-    /** Defaults to `'FAIR'` on the faircoin rail; required on the card rail. */
-    currency?: CurrencyCode;
+    /** 1–20 prices of ONE currency, one-time prices only. */
+    line_items: PaymentLinkLineItemParams[];
+    allow_promotion_codes?: boolean;
+    billing_address_collection?: CheckoutBillingAddressCollection;
+    shipping_address_collection?: {
+        allowed_countries: string[];
+    };
+    phone_number_collection?: {
+        enabled: boolean;
+    };
+    tax_id_collection?: {
+        enabled: boolean;
+    };
+    custom_fields?: CheckoutCustomFieldParams[];
+    consent_collection?: {
+        terms_of_service?: 'none' | 'required';
+    };
+    automatic_tax?: {
+        enabled: boolean;
+    };
+    customer_creation?: CheckoutCustomerCreation;
+    after_completion?: PaymentLinkAfterCompletionParams;
+    restrictions?: {
+        completed_sessions: {
+            limit: number;
+        };
+    };
+    submit_type?: CheckoutSubmitType;
+    locale?: CheckoutLocale | 'auto';
     metadata?: Record<string, string>;
-    success_url?: string;
 }
 /**
- * `POST /v1/payment_links/:id`. `amount`/`network` are deliberately absent — a
- * link's price is immutable once shared.
+ * `POST /v1/payment_links/:id`. The line items are fixed once shared (a payer
+ * may hold a session priced from them); everything else may change.
  */
 export interface UpdatePaymentLinkParams {
     active?: boolean;
+    allow_promotion_codes?: boolean;
+    billing_address_collection?: CheckoutBillingAddressCollection;
+    shipping_address_collection?: {
+        allowed_countries: string[];
+    } | '';
+    phone_number_collection?: {
+        enabled: boolean;
+    };
+    tax_id_collection?: {
+        enabled: boolean;
+    };
+    custom_fields?: CheckoutCustomFieldParams[] | '';
+    consent_collection?: {
+        terms_of_service?: 'none' | 'required';
+    };
+    automatic_tax?: {
+        enabled: boolean;
+    };
+    customer_creation?: CheckoutCustomerCreation;
+    after_completion?: PaymentLinkAfterCompletionParams;
+    restrictions?: {
+        completed_sessions: {
+            limit: number;
+        };
+    } | '';
+    submit_type?: CheckoutSubmitType;
+    locale?: CheckoutLocale | 'auto';
     /** A patch: named keys are set, `""` removes a key, others are kept. */
     metadata?: Record<string, string>;
-    /** `null` removes it. */
-    success_url?: string | null;
 }
+/**
+ * `POST /v1/payment_links/:id/checkout_sessions` — a payer starting checkout
+ * (anonymous, rate-limited). A contribution link the payer prices takes
+ * `amount`; nothing else is the payer's to say.
+ */
+export interface CreatePaymentLinkSessionParams {
+    amount?: string;
+}
+/** Its answer: where to go — the hosted session and the secret that opens it. */
+export interface PaymentLinkSessionStart {
+    object: 'checkout_session_start';
+    id: string;
+    client_secret: string;
+    url: string;
+}
+export type { CheckoutAdjustableQuantity };

package/dist/types/reporting.d.ts

@@ -0,0 +1,84 @@
+import type { CurrencyCode } from './money';
+import type { FileObject } from './file';
+/**
+ * Every report Peable produces, by Stripe's versioned id: the trailing `.1` is
+ * the column layout's version, so a layout can change under a new id without
+ * changing a report a merchant already parses.
+ */
+export declare const REPORT_TYPE_IDS: readonly ["payments.itemized.1", "balance.summary.1", "payouts.itemized.1"];
+export type ReportTypeId = (typeof REPORT_TYPE_IDS)[number];
+/**
+ * The layout of each report: its name, every column it can carry and the ones
+ * it carries when `parameters.columns` is absent. Fixed per version.
+ *
+ * - `payments.itemized.1` — one row per payment intent CREATED in the
+ *   interval. Amounts are base-unit strings, as on the API.
+ * - `balance.summary.1` — per currency, the balance at `interval_start`, the
+ *   activity and payouts inside the interval, and the balance at
+ *   `interval_end`, from the ledger (ADR 0015). A figure built on a transaction
+ *   whose fee the provider has not reported is empty, never `0`.
+ * - `payouts.itemized.1` — one row per payout created in the interval.
+ */
+export declare const REPORT_TYPE_LAYOUTS: Readonly<Record<ReportTypeId, {
+    readonly name: string;
+    readonly columns: readonly string[];
+    readonly default_columns: readonly string[];
+    /** Whether the report reads the ledger, and so needs the merchant's account. */
+    readonly ledger: boolean;
+}>>;
+/** `reporting.report_type` — what can be run, and over which interval data exists. */
+export interface ReportType {
+    /** `payments.itemized.1`, … */
+    id: ReportTypeId;
+    object: 'reporting.report_type';
+    livemode: boolean;
+    name: string;
+    /** The column layout's version — the trailing number of the id. */
+    version: number;
+    /** Every column `parameters.columns` may name, in the order they are written. */
+    columns: string[];
+    default_columns: string[];
+    /** The earliest `interval_start` with data (Unix seconds). */
+    data_available_start: number;
+    /** The latest `interval_end` a run may ask for: now — the data is live. */
+    data_available_end: number;
+    /** When the layout last changed. */
+    updated: number;
+}
+export declare const REPORT_RUN_STATUSES: readonly ["pending", "succeeded", "failed"];
+export type ReportRunStatus = (typeof REPORT_RUN_STATUSES)[number];
+/** What a run was asked to cover. */
+export interface ReportRunParameters {
+    /** Inclusive, Unix seconds. */
+    interval_start: number;
+    /** Exclusive, Unix seconds. */
+    interval_end: number;
+    /** The columns, in the layout's order; the report type's `default_columns` when absent. */
+    columns?: string[];
+    /** Only this currency. */
+    currency?: CurrencyCode;
+}
+/** `reporting.report_run` (`frr_…`). */
+export interface ReportRun {
+    id: string;
+    object: 'reporting.report_run';
+    livemode: boolean;
+    created: number;
+    report_type: ReportTypeId;
+    parameters: ReportRunParameters;
+    status: ReportRunStatus;
+    /** Why a `failed` run failed; `null` otherwise. */
+    error: string | null;
+    /** The CSV once `succeeded` — a `file_…` of purpose `finance_report_run`. */
+    result: FileObject | null;
+    succeeded_at: number | null;
+}
+/** `POST /v1/reporting/report_runs`. */
+export interface CreateReportRunParams {
+    report_type: ReportTypeId;
+    parameters: ReportRunParameters;
+}
+/** `GET /v1/reporting/report_runs`. */
+export interface ListReportRunsParams {
+    report_type?: ReportTypeId;
+}

package/dist/types/search.d.ts

@@ -0,0 +1,48 @@
+/**
+ * One page of a search.
+ *
+ * Unlike a {@link List} it pages FORWARD only, by an opaque `next_page` token
+ * passed back as `page`: a search is a filter over the newest-first walk of the
+ * resource, and the token remembers both where the walk stopped and which
+ * query it belongs to (a token used with another query is refused).
+ */
+export interface SearchResult<T> {
+    object: 'search_result';
+    data: T[];
+    has_more: boolean;
+    /** Pass as `page` for the next page; `null` on the last one. */
+    next_page: string | null;
+    /** The path that was searched (`/v1/customers/search`). */
+    url: string;
+    /** Present only when asked for with `expand: ['total_count']`. */
+    total_count?: number;
+}
+/** The parameters every search accepts. */
+export interface SearchParams {
+    /**
+     * The query, in Stripe's search query language:
+     * `email:"jenny@example.com"`, `amount>1000 AND currency:"EUR"`,
+     * `metadata['order_id']:'6735'`, `name~"shirt"`, `-status:"canceled"`,
+     * `customer:null`. Clauses join with spaces or `AND` (all of them must
+     * match) or with `OR` (any), never both; at most 10 clauses and 1000
+     * characters.
+     */
+    query: string;
+    /** 1–100. Default 10. */
+    limit?: number;
+    /** The `next_page` of the previous page, with the SAME query. */
+    page?: string;
+    /**
+     * `data.`-prefixed expansions (`['data.customer']`), and `'total_count'` to
+     * count every match (one extra query).
+     */
+    expand?: string[];
+}
+/** Every searchable resource, by its path segment (`/v1/<resource>/search`). */
+export declare const SEARCHABLE_RESOURCES: readonly ["payment_intents", "charges", "customers", "products", "prices", "refunds"];
+export type SearchableResource = (typeof SEARCHABLE_RESOURCES)[number];
+/** Search query bounds — the gateway's, restated so a client can check before it asks. */
+export declare const SEARCH_QUERY_MAX_LENGTH = 1000;
+export declare const SEARCH_QUERY_MAX_CLAUSES = 10;
+/** A `~` substring needs at least this many characters (Stripe's rule). */
+export declare const SEARCH_SUBSTRING_MIN_LENGTH = 3;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/shared-types",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "Shared TypeScript types for the Peable Gateway — the wire contract shared by the backend, SDK, and frontend.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",