@peable.to/contracts 0.4.0 → 1.1.0

package/dist/cjs/resources/events/webhookEndpoints.js

@@ -0,0 +1,215 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webhookEndpointRoutes = exports.listWebhookEndpointsQuery = exports.rollWebhookEndpointSecretParams = exports.updateWebhookEndpointParams = exports.createWebhookEndpointParams = exports.deletedWebhookEndpointSchema = exports.webhookEndpointWithSecretSchema = exports.webhookEndpointSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const events_1 = require("../../vocabulary/events");
+const webhookDeliveries_1 = require("./webhookDeliveries");
+/**
+ * Webhook endpoints (`we_…`, ADR 0014 D4) — one URL a merchant receives events
+ * at, with the event types it wants and the secret deliveries to it are signed
+ * with. A merchant may hold several; every event fans out to each ENABLED
+ * endpoint whose `enabled_events` matches it, as one delivery per endpoint.
+ */
+const enabledEvent = zod_1.z.enum(events_1.WEBHOOK_ENABLED_EVENTS);
+const endpointShape = {
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('webhook_endpoint'),
+    livemode: primitives_1.livemode.describe('The mode of the merchant that owns it (ADR 0017).'),
+    url: zod_1.z.string(),
+    description: zod_1.z.string().nullable(),
+    enabled_events: zod_1.z
+        .array(enabledEvent)
+        .describe('The event types sent to it; `*` is every type, including ones added later.'),
+    status: zod_1.z.enum(events_1.WEBHOOK_ENDPOINT_STATUSES),
+    disabled_reason: zod_1.z
+        .enum(events_1.WEBHOOK_ENDPOINT_DISABLED_REASONS)
+        .nullable()
+        .describe('`null` exactly when `status` is `enabled`. `delivery_failures`: every delivery failed for three days straight.'),
+    api_version: zod_1.z.string().describe('The wire version events are rendered with for this endpoint.'),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+    updated_at: primitives_1.unixSeconds,
+};
+const endpointExample = {
+    id: 'we_0193b8f2c1a87d3e9f4c',
+    object: 'webhook_endpoint',
+    livemode: false,
+    url: 'https://example.com/peable/webhooks',
+    description: 'Order fulfilment',
+    enabled_events: ['payment_intent.succeeded', 'charge.refunded'],
+    status: 'enabled',
+    disabled_reason: null,
+    api_version: '2026-11-03',
+    metadata: {},
+    created: 1793750000,
+    updated_at: 1793750000,
+};
+/** An endpoint as every answer but a create and a roll renders it: never the secret. */
+exports.webhookEndpointSchema = (0, objects_1.defineObject)('webhook_endpoint', 'WebhookEndpoint', zod_1.z.object(endpointShape).strict(), { examples: [endpointExample] });
+/**
+ * The answer of a create and of a `roll_secret` — the ONLY two that show the
+ * signing secret. Peable never shows it again; a lost secret is rolled, not
+ * retrieved.
+ */
+exports.webhookEndpointWithSecretSchema = (0, objects_1.defineComponent)('WebhookEndpointWithSecret', zod_1.z
+    .object({
+    ...endpointShape,
+    secret: zod_1.z
+        .string()
+        .regex(/^whsec_/)
+        .describe('The signing secret (`whsec_…`), shown on this answer only.'),
+})
+    .strict(), { examples: [{ ...endpointExample, secret: 'whsec_9f4a7d3e0193b8f2c1a87d3e9f4a7d3e' }] });
+/** What `DELETE /v1/webhook_endpoints/:id` answers. */
+exports.deletedWebhookEndpointSchema = (0, objects_1.defineComponent)('DeletedWebhookEndpoint', (0, envelopes_1.deletedOf)('webhook_endpoint'));
+const enabledEventsParam = zod_1.z
+    .array(enabledEvent)
+    .min(1, 'enabled_events needs at least one event type, or "*"')
+    .max(events_1.WEBHOOK_ENABLED_EVENTS.length)
+    // A repeated type means nothing more than one; stored once.
+    .transform((list) => [...new Set(list)]);
+const descriptionParam = zod_1.z.string().max(events_1.WEBHOOK_ENDPOINT_DESCRIPTION_MAX);
+const urlParam = zod_1.z
+    .string()
+    .min(1)
+    .describe('An `https` URL (a test-mode endpoint may also use `http`), ports 80/443 only.');
+exports.createWebhookEndpointParams = zod_1.z
+    .object({
+    url: urlParam,
+    enabled_events: enabledEventsParam,
+    description: descriptionParam.min(1).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+exports.updateWebhookEndpointParams = zod_1.z
+    .object({
+    url: urlParam.optional(),
+    enabled_events: enabledEventsParam.optional(),
+    disabled: zod_1.z
+        .boolean()
+        .optional()
+        .describe('`true` stops deliveries; `false` re-enables an endpoint, whatever disabled it.'),
+    description: descriptionParam.optional().describe('`""` clears it.'),
+    metadata: params_1.metadataUpdateParam.optional(),
+})
+    .strict();
+exports.rollWebhookEndpointSecretParams = zod_1.z
+    .object({
+    expires_in_seconds: zod_1.z
+        .number()
+        .int()
+        .min(0)
+        .max(events_1.WEBHOOK_SECRET_ROLL_MAX_EXPIRES_IN_SECONDS)
+        .optional()
+        .describe('How long the PREVIOUS secret keeps signing beside the new one, in seconds (0–86400, default 0). While both are live every delivery carries two `v1=` signatures, so a receiver can switch secrets without a gap.'),
+})
+    .strict();
+exports.listWebhookEndpointsQuery = (0, params_1.listQuery)({});
+const idDoc = { id: 'The webhook endpoint (`we_…`).' };
+exports.webhookEndpointRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createWebhookEndpoint',
+        method: 'post',
+        path: '/v1/webhook_endpoints',
+        tag: 'Webhook endpoints',
+        summary: 'Create a webhook endpoint',
+        description: 'The answer is the ONLY one that shows `secret`. A retry with the same `Idempotency-Key` replays it, secret included, for 24 hours. At most 16 endpoints per merchant and mode.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createWebhookEndpointParams,
+        response: exports.webhookEndpointWithSecretSchema,
+        sdk: 'webhookEndpoints.create',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listWebhookEndpoints',
+        method: 'get',
+        path: '/v1/webhook_endpoints',
+        tag: 'Webhook endpoints',
+        summary: 'List webhook endpoints',
+        description: 'Newest first. Never the secret.',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listWebhookEndpointsQuery,
+        response: (0, envelopes_1.listOf)(exports.webhookEndpointSchema),
+        sdk: 'webhookEndpoints.list',
+        expandable: 'webhook_endpoint',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveWebhookEndpoint',
+        method: 'get',
+        path: '/v1/webhook_endpoints/{id}',
+        tag: 'Webhook endpoints',
+        summary: 'Retrieve a webhook endpoint',
+        description: 'Never the secret: a lost secret is rolled, not retrieved.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: idDoc,
+        query: params_1.expandOnlyQuery,
+        response: exports.webhookEndpointSchema,
+        sdk: 'webhookEndpoints.retrieve',
+        expandable: 'webhook_endpoint',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateWebhookEndpoint',
+        method: 'post',
+        path: '/v1/webhook_endpoints/{id}',
+        tag: 'Webhook endpoints',
+        summary: 'Update a webhook endpoint',
+        description: '`url`, `enabled_events`, `disabled`, `description` (`""` clears it) and `metadata` (a patch).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: idDoc,
+        body: exports.updateWebhookEndpointParams,
+        response: exports.webhookEndpointSchema,
+        sdk: 'webhookEndpoints.update',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'deleteWebhookEndpoint',
+        method: 'delete',
+        path: '/v1/webhook_endpoints/{id}',
+        tag: 'Webhook endpoints',
+        summary: 'Delete a webhook endpoint',
+        description: 'Its deliveries go with it, pending ones included.',
+        auth: 'service',
+        scope: 'payments:write',
+        params: idDoc,
+        response: exports.deletedWebhookEndpointSchema,
+        sdk: 'webhookEndpoints.del',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'rollWebhookEndpointSecret',
+        method: 'post',
+        path: '/v1/webhook_endpoints/{id}/roll_secret',
+        tag: 'Webhook endpoints',
+        summary: 'Roll the signing secret',
+        description: 'Mint a new secret and show it once. With `expires_in_seconds` (≤ 24h) the previous one keeps signing beside it until then; without, it stops now.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: idDoc,
+        body: exports.rollWebhookEndpointSecretParams,
+        response: exports.webhookEndpointWithSecretSchema,
+        sdk: 'webhookEndpoints.rollSecret',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'sendWebhookEndpointTestEvent',
+        method: 'post',
+        path: '/v1/webhook_endpoints/{id}/test',
+        tag: 'Webhook endpoints',
+        summary: 'Send a test event',
+        description: 'Send this endpoint a `webhook_endpoint.test` event now and answer the delivery after its first attempt. A disabled endpoint is refused (`webhook_endpoint_disabled`).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: idDoc,
+        response: webhookDeliveries_1.webhookDeliverySchema,
+        sdk: 'webhookEndpoints.sendTestEvent',
+    }),
+];

package/dist/cjs/resources/payments/charges.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chargeRoutes = exports.listChargesQuery = exports.chargeSchema = exports.chargeOutcomeSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const paymentMethods_1 = require("../core/paymentMethods");
+/**
+ * Charges (`ch_…`) — the read-only record of the money a CARD PaymentIntent
+ * moved (ADR 0019). Peable's object over the provider's charge, which stays an
+ * internal binding (ADR 0016). A FairCoin payment has no charge: its chain side
+ * is `PaymentIntent.faircoin`.
+ */
+exports.chargeOutcomeSchema = (0, objects_1.defineComponent)('ChargeOutcome', zod_1.z
+    .object({
+    network_status: primitives_1.nullableString.describe('`approved_by_network`, `declined_by_network`, `not_sent_to_network`, `reversed_after_approval`.'),
+    risk_level: primitives_1.nullableString.describe('`normal`, `elevated`, `highest`, or `not_assessed`.'),
+    type: primitives_1.nullableString.describe('`authorized`, `manual_review`, `issuer_declined`, `blocked`, `invalid`.'),
+    seller_message: primitives_1.nullableString.describe("Peable's own one-line explanation for the merchant — never the provider's prose."),
+})
+    .strict());
+exports.chargeSchema = (0, objects_1.defineObject)('charge', 'Charge', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('charge'),
+    livemode: primitives_1.livemode,
+    payment_intent: (0, objects_1.expandable)('payment_intent', '`pi_…`, or the PaymentIntent with `expand[]=payment_intent`.'),
+    customer: (0, objects_1.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.').nullable(),
+    payment_method: (0, objects_1.expandable)('payment_method', '`pm_…`, or the PaymentMethod with `expand[]=payment_method`.').nullable(),
+    amount: primitives_1.amount,
+    amount_captured: primitives_1.amount,
+    amount_refunded: primitives_1.amount,
+    currency: primitives_1.currency,
+    status: zod_1.z
+        .literal('succeeded')
+        .describe('Always `succeeded`: Peable records the authorization that succeeded.'),
+    paid: zod_1.z.boolean(),
+    captured: zod_1.z.boolean(),
+    refunded: zod_1.z
+        .boolean()
+        .describe('All of it came back — by refunds, or by releasing an uncaptured authorization.'),
+    disputed: zod_1.z.boolean(),
+    outcome: exports.chargeOutcomeSchema.nullable(),
+    billing_details: paymentMethods_1.billingDetailsSchema
+        .nullable()
+        .describe("Who the card's billing details name, as the provider reported them; `null` until the provider snapshot is read."),
+    payment_method_details: zod_1.z
+        .object({ type: zod_1.z.literal('card'), card: paymentMethods_1.cardDetailsSchema })
+        .strict()
+        .nullable(),
+    receipt_url: primitives_1.nullableString.describe("The provider's own URL never reaches the wire."),
+    balance_transaction: primitives_1.nullableString.describe("The ledger's `txn_…` once the provider's balance transaction was ingested (ADR 0015 §4); never a guess."),
+    application_fee: primitives_1.nullableString.describe("Orbit's `fee_…` taken on this charge, once the provider created it."),
+    application_fee_amount: primitives_1.amount
+        .nullable()
+        .describe('The fee instructed on the payment (`application_fee_amount`).'),
+    description: primitives_1.nullableString,
+    receipt_email: primitives_1.nullableString,
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'ch_0193b8f2c1a87d3e9f4a',
+            object: 'charge',
+            livemode: false,
+            payment_intent: 'pi_0193b8f2c1a87d3e9f4a',
+            customer: 'cus_0193b8f2c1a87d3e9f4a',
+            payment_method: 'pm_0193b8f2c1a87d3e9f4a',
+            amount: '2500',
+            amount_captured: '2500',
+            amount_refunded: '0',
+            currency: 'EUR',
+            status: 'succeeded',
+            paid: true,
+            captured: true,
+            refunded: false,
+            disputed: false,
+            outcome: {
+                network_status: 'approved_by_network',
+                risk_level: 'normal',
+                type: 'authorized',
+                seller_message: 'Payment complete.',
+            },
+            billing_details: null,
+            payment_method_details: {
+                type: 'card',
+                card: {
+                    brand: 'visa',
+                    last4: '4242',
+                    exp_month: 12,
+                    exp_year: 2030,
+                    country: 'US',
+                    funding: 'credit',
+                },
+            },
+            receipt_url: null,
+            balance_transaction: null,
+            application_fee: null,
+            application_fee_amount: null,
+            description: null,
+            receipt_email: null,
+            metadata: {},
+            created: 1793750400,
+        },
+    ],
+});
+exports.listChargesQuery = (0, params_1.listQuery)({
+    payment_intent: params_1.idParam.optional().describe("Only this payment's charges (`pi_…`)."),
+});
+exports.chargeRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listCharges',
+        method: 'get',
+        path: '/v1/charges',
+        tag: 'Charges',
+        summary: 'List charges',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listChargesQuery,
+        response: (0, envelopes_1.listOf)(exports.chargeSchema),
+        sdk: 'charges.list',
+        expandable: 'charge',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveCharge',
+        method: 'get',
+        path: '/v1/charges/{id}',
+        tag: 'Charges',
+        summary: 'Retrieve a charge',
+        auth: 'service',
+        scope: 'payments:read',
+        params: { id: 'The charge (`ch_…`).' },
+        query: params_1.expandOnlyQuery,
+        response: exports.chargeSchema,
+        sdk: 'charges.retrieve',
+        expandable: 'charge',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'searchCharges',
+        method: 'get',
+        path: '/v1/charges/search',
+        tag: 'Charges',
+        summary: 'Search charges',
+        description: "Stripe's query language over `amount`, `currency`, `customer`, `payment_intent`, `status`, `captured`, `refunded`, `disputed`, `created` and `metadata['key']`.",
+        auth: 'service',
+        scope: 'payments:read',
+        query: params_1.searchQuery,
+        response: (0, envelopes_1.searchResultOf)(exports.chargeSchema),
+        sdk: 'charges.search',
+        expandable: 'charge',
+    }),
+];

package/dist/cjs/resources/payments/disputes.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disputeRoutes = exports.listPaymentIntentDisputesQuery = exports.listDisputesQuery = exports.closeDisputeParams = exports.updateDisputeParams = exports.disputeEvidenceParams = exports.disputeSchema = exports.disputeEvidenceDetailsSchema = exports.disputeEvidenceSchema = void 0;
+const zod_1 = require("zod");
+const envelopes_1 = require("../../common/envelopes");
+const objects_1 = require("../../common/objects");
+const params_1 = require("../../common/params");
+const primitives_1 = require("../../common/primitives");
+const route_1 = require("../../route");
+const payments_1 = require("../../vocabulary/payments");
+/**
+ * Disputes (`dp_…`) — the card network holding a payment's money while a
+ * cardholder contests it. A dispute is a DEADLINE: `evidence_details.due_by`
+ * arrives with it. The network's own dispute id never appears.
+ */
+/** Every evidence field, `null` when unset. */
+const evidenceFields = (field) => Object.fromEntries([...payments_1.DISPUTE_TEXT_EVIDENCE_FIELDS, ...payments_1.DISPUTE_FILE_EVIDENCE_FIELDS].map((name) => [name, field]));
+/**
+ * A merchant's evidence as the dispute holds it. Present ONLY on a live read
+ * (`GET /v1/disputes/{id}` and the answers of its update and close): the text
+ * is read from the provider, where a draft lives (Peable keeps none of its
+ * words); the file half is the `file_…` ids attached. Lists and events never
+ * carry it.
+ */
+exports.disputeEvidenceSchema = (0, objects_1.defineComponent)('DisputeEvidence', zod_1.z.object(evidenceFields(zod_1.z.string().nullable())).strict());
+exports.disputeEvidenceDetailsSchema = (0, objects_1.defineComponent)('DisputeEvidenceDetails', zod_1.z
+    .object({
+    due_by: primitives_1.unixSeconds
+        .nullable()
+        .describe('When the network stops accepting evidence; `null` once the dispute is closed.'),
+    has_evidence: zod_1.z.boolean().describe('Whether any evidence has been staged or submitted.'),
+    past_due: zod_1.z.boolean().describe('Whether the deadline passed without a submission.'),
+    submission_count: zod_1.z
+        .number()
+        .int()
+        .min(0)
+        .max(1)
+        .describe('`0` or `1`: a response is one-shot at the network.'),
+    submitted_at: primitives_1.unixSeconds
+        .nullable()
+        .describe('When the response reached the network; `null` while it has not.'),
+})
+    .strict());
+exports.disputeSchema = (0, objects_1.defineObject)('dispute', 'Dispute', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('dispute'),
+    livemode: primitives_1.livemode,
+    amount: primitives_1.amount.describe("The DISPUTED amount, which may be less than the payment's: a cardholder can contest part of a charge."),
+    currency: primitives_1.currency,
+    charge: (0, objects_1.expandable)('charge', '`ch_…`, or the Charge with `expand[]=charge`.').nullable(),
+    payment_intent: (0, objects_1.expandable)('payment_intent', 'The disputed payment (`pi_…`), or the PaymentIntent with `expand[]=payment_intent`.'),
+    status: zod_1.z
+        .enum(payments_1.DISPUTE_STATUSES)
+        .describe('`needs_response` and `under_review` are open; `won` and `lost` are terminal and say where the money ended up.'),
+    reason: zod_1.z.enum(payments_1.DISPUTE_REASONS),
+    is_charge_refundable: zod_1.z
+        .boolean()
+        .describe('Whether the disputed payment can still be refunded.'),
+    evidence_details: exports.disputeEvidenceDetailsSchema,
+    evidence: exports.disputeEvidenceSchema
+        .optional()
+        .describe('Live reads only: never on a list or an event.'),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+    updated_at: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'dp_0193b8f2c1a87d3e9f4a',
+            object: 'dispute',
+            livemode: false,
+            amount: '2500',
+            currency: 'EUR',
+            charge: 'ch_0193b8f2c1a87d3e9f4a',
+            payment_intent: 'pi_0193b8f2c1a87d3e9f4a',
+            status: 'needs_response',
+            reason: 'product_not_received',
+            is_charge_refundable: true,
+            evidence_details: {
+                due_by: 1794355200,
+                has_evidence: false,
+                past_due: false,
+                submission_count: 0,
+                submitted_at: null,
+            },
+            metadata: {},
+            created: 1793750400,
+            updated_at: 1793750400,
+        },
+    ],
+});
+const FILE_ID_MAX = 255;
+/** `""` unsets a field, as on Stripe. */
+const textEvidence = zod_1.z.string().max(payments_1.DISPUTE_EVIDENCE_TEXT_MAX).optional();
+const fileEvidence = zod_1.z.string().max(FILE_ID_MAX).optional();
+/**
+ * The evidence fields, in the network's names — a CLOSED set. Unknown keys are
+ * REFUSED rather than dropped: a merchant who sent `tracking_number` instead of
+ * `shipping_tracking_number` would otherwise submit, finally, a response
+ * missing the field they relied on.
+ */
+exports.disputeEvidenceParams = zod_1.z
+    .object({
+    ...Object.fromEntries(payments_1.DISPUTE_TEXT_EVIDENCE_FIELDS.map((field) => [field, textEvidence])),
+    ...Object.fromEntries(payments_1.DISPUTE_FILE_EVIDENCE_FIELDS.map((field) => [field, fileEvidence])),
+})
+    .strict()
+    .describe('Any subset of the fields: a text field is your words (at most 20,000 characters), a file field a `file_…` of purpose `dispute_evidence`. `""` unsets a field.');
+/**
+ * `submit: false` (the default) STAGES the evidence: text goes to the provider
+ * as a draft, files are attached by id. `submit: true` uploads the attached
+ * files and submits everything — ONCE; a second submission is refused.
+ */
+exports.updateDisputeParams = zod_1.z
+    .object({
+    evidence: exports.disputeEvidenceParams.optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+    submit: zod_1.z.boolean().optional(),
+})
+    .strict();
+exports.closeDisputeParams = zod_1.z.object({}).strict();
+exports.listDisputesQuery = (0, params_1.listQuery)({
+    payment_intent: params_1.idParam.optional().describe("Only this payment's disputes (`pi_…`)."),
+    charge: params_1.idParam.optional().describe("Only this charge's disputes (`ch_…`)."),
+});
+/** The per-payment sub-list: the payment is in the path. */
+exports.listPaymentIntentDisputesQuery = (0, params_1.listQuery)({});
+const disputeId = { disputeId: 'The dispute (`dp_…`).' };
+exports.disputeRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'listPaymentIntentDisputes',
+        method: 'get',
+        path: '/v1/payment_intents/{intentId}/disputes',
+        tag: 'Disputes',
+        summary: "List a payment's disputes",
+        auth: 'service',
+        scope: 'payments:read',
+        params: { intentId: 'The payment intent (`pi_…`).' },
+        query: exports.listPaymentIntentDisputesQuery,
+        response: (0, envelopes_1.listOf)(exports.disputeSchema),
+        sdk: 'disputes.listForPaymentIntent',
+        expandable: 'dispute',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listDisputes',
+        method: 'get',
+        path: '/v1/disputes',
+        tag: 'Disputes',
+        summary: 'List disputes',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listDisputesQuery,
+        response: (0, envelopes_1.listOf)(exports.disputeSchema),
+        sdk: 'disputes.list',
+        expandable: 'dispute',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveDispute',
+        method: 'get',
+        path: '/v1/disputes/{disputeId}',
+        tag: 'Disputes',
+        summary: 'Retrieve a dispute',
+        description: 'The one read that carries `evidence`, read live from the provider.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: disputeId,
+        query: params_1.expandOnlyQuery,
+        response: exports.disputeSchema,
+        sdk: 'disputes.retrieve',
+        expandable: 'dispute',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateDispute',
+        method: 'post',
+        path: '/v1/disputes/{disputeId}',
+        tag: 'Disputes',
+        summary: 'Update a dispute',
+        description: 'Metadata, a staged draft of evidence, or — with `submit: true` — the one submission. A dispute that no longer takes evidence answers 409.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: disputeId,
+        body: exports.updateDisputeParams,
+        response: exports.disputeSchema,
+        sdk: 'disputes.update',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'closeDispute',
+        method: 'post',
+        path: '/v1/disputes/{disputeId}/close',
+        tag: 'Disputes',
+        summary: 'Close a dispute',
+        description: 'Accept the dispute: it is lost.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: disputeId,
+        body: exports.closeDisputeParams,
+        response: exports.disputeSchema,
+        sdk: 'disputes.close',
+    }),
+];

package/dist/cjs/resources/payments/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paymentsRoutes = void 0;
+const charges_1 = require("./charges");
+const disputes_1 = require("./disputes");
+const paymentIntents_1 = require("./paymentIntents");
+const refunds_1 = require("./refunds");
+const setupIntents_1 = require("./setupIntents");
+const social_1 = require("./social");
+const testHelpers_1 = require("./testHelpers");
+__exportStar(require("./charges"), exports);
+__exportStar(require("./disputes"), exports);
+__exportStar(require("./paymentIntents"), exports);
+__exportStar(require("./refunds"), exports);
+__exportStar(require("./setupIntents"), exports);
+__exportStar(require("./social"), exports);
+__exportStar(require("./testHelpers"), exports);
+/** Payment intents, charges, refunds, disputes, setup intents, social payments. */
+exports.paymentsRoutes = [
+    ...paymentIntents_1.paymentIntentRoutes,
+    ...charges_1.chargeRoutes,
+    ...refunds_1.refundRoutes,
+    ...disputes_1.disputeRoutes,
+    ...setupIntents_1.setupIntentRoutes,
+    ...social_1.socialRoutes,
+    ...testHelpers_1.paymentIntentTestHelperRoutes,
+];