@peable.to/contracts 6.1.0 → 6.3.0

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

@@ -23,6 +23,7 @@ const customerBalanceTransactions_1 = require("./customerBalanceTransactions");
 const invoiceItems_1 = require("./invoiceItems");
 const invoices_1 = require("./invoices");
 const public_1 = require("./public");
+const quotes_1 = require("./quotes");
 const subscriptions_1 = require("./subscriptions");
 __exportStar(require("./billingPortal"), exports);
 __exportStar(require("./creditNotes"), exports);
@@ -30,13 +31,15 @@ __exportStar(require("./customerBalanceTransactions"), exports);
 __exportStar(require("./invoiceItems"), exports);
 __exportStar(require("./invoices"), exports);
 __exportStar(require("./public"), exports);
+__exportStar(require("./quotes"), exports);
 __exportStar(require("./subscriptions"), exports);
-/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, the balance ledger and the customer portal. */
+/** Orbit's native billing engine (ADR 0018): subscriptions, invoices, credit notes, quotes, the balance ledger and the customer portal. */
 exports.billingEngineRoutes = [
     ...subscriptions_1.subscriptionRoutes,
     ...invoices_1.invoiceRoutes,
     ...invoiceItems_1.invoiceItemRoutes,
     ...creditNotes_1.creditNoteRoutes,
+    ...quotes_1.quoteRoutes,
     ...customerBalanceTransactions_1.customerBalanceTransactionRoutes,
     ...billingPortal_1.billingPortalRoutes,
     ...public_1.publicBillingRoutes,

package/dist/cjs/resources/billingEngine/quotes.js

@@ -0,0 +1,342 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quoteRoutes = exports.listQuoteLineItemsQuery = exports.listQuotesQuery = exports.quoteActionParams = exports.finalizeQuoteParams = exports.updateQuoteParams = exports.createQuoteParams = exports.quoteSchema = 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 invoices_1 = require("../../vocabulary/invoices");
+const quotes_1 = require("../../vocabulary/quotes");
+const subscriptions_1 = require("../../vocabulary/subscriptions");
+const shared_1 = require("../checkout/shared");
+const params_2 = require("./params");
+const subscriptions_2 = require("./subscriptions");
+/**
+ * Quotes (`qt_…`) — Stripe's Quotes on Orbit's native billing engine (ADR 0018
+ * §5). A quote prices catalog Prices for one customer: a `draft` is edited,
+ * `finalize` numbers it and fixes its discount and Peable Tax (failing closed,
+ * never zero), and `accept` turns it into native billing objects — an invoice
+ * for one-time lines, a subscription with its first invoice for recurring ones
+ * (one-time lines then ride on that first invoice). Its lines are Stripe's
+ * `item`, the same object a Checkout Session's lines are.
+ */
+const totalDetailsSchema = zod_1.z
+    .object({
+    amount_discount: primitives_1.amount,
+    amount_shipping: primitives_1.amount.describe('Always `0`: a quote ships nothing.'),
+    amount_tax: primitives_1.amount
+        .nullable()
+        .describe('Every tax, inclusive and exclusive; `null` on a draft whose tax is not known yet.'),
+})
+    .strict();
+exports.quoteSchema = (0, objects_1.defineObject)('quote', 'Quote', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('quote'),
+    livemode: primitives_1.livemode,
+    number: zod_1.z
+        .string()
+        .nullable()
+        .describe('`null` while a draft; `QT-PREFIX-0001` once finalized — per merchant.'),
+    status: zod_1.z.enum(quotes_1.QUOTE_STATUSES),
+    customer: (0, objects_1.expandable)('customer', '`cus_…`, or the Customer with `expand[]=customer`.'),
+    currency: primitives_1.currency,
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS),
+    invoice_settings: zod_1.z
+        .object({
+        days_until_due: zod_1.z
+            .number()
+            .int()
+            .nullable()
+            .describe("`send_invoice` only; the billing settings' default when `null`."),
+    })
+        .strict(),
+    subscription_data: zod_1.z
+        .object({
+        description: zod_1.z.string().nullable(),
+        trial_period_days: zod_1.z.number().int().nullable(),
+        metadata: primitives_1.metadata,
+    })
+        .strict()
+        .describe('What the subscription an accepted quote with recurring lines starts with.'),
+    discount: subscriptions_2.discountSchema.nullable(),
+    automatic_tax: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        status: zod_1.z.enum(invoices_1.AUTOMATIC_TAX_STATUSES).nullable(),
+        tax_calculation: zod_1.z
+            .string()
+            .nullable()
+            .describe('The Peable Tax calculation (`taxcalc_…`) the quote finalized with.'),
+    })
+        .strict(),
+    amount_subtotal: primitives_1.amount.describe('Every line before discount and tax (one period of a recurring line).'),
+    amount_total: primitives_1.amount.describe('`amount_subtotal - amount_discount + exclusive tax`.'),
+    total_details: totalDetailsSchema,
+    expires_at: primitives_1.unixSeconds.describe('An open quote is cancelled at this instant.'),
+    header: zod_1.z.string().nullable(),
+    description: zod_1.z.string().nullable(),
+    footer: zod_1.z.string().nullable(),
+    invoice: (0, objects_1.expandable)('invoice', "The invoice accepting made (`in_…`, expandable): the one-time invoice, or the subscription's first.").nullable(),
+    subscription: (0, objects_1.expandable)('subscription', 'The subscription accepting made (`sub_…`, expandable); `null` without recurring lines.').nullable(),
+    status_transitions: zod_1.z
+        .object({
+        finalized_at: primitives_1.unixSeconds.nullable(),
+        accepted_at: primitives_1.unixSeconds.nullable(),
+        canceled_at: primitives_1.unixSeconds.nullable(),
+    })
+        .strict(),
+    test_clock: zod_1.z.string().nullable(),
+    metadata: primitives_1.metadata,
+    created: primitives_1.unixSeconds,
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'qt_0193b8f2c1a87d3e9f4a',
+            object: 'quote',
+            livemode: false,
+            number: 'QT-ACME-0001',
+            status: 'open',
+            customer: 'cus_0193b8f2c1a87d3e9f4a',
+            currency: 'EUR',
+            collection_method: 'send_invoice',
+            invoice_settings: { days_until_due: 30 },
+            subscription_data: { description: null, trial_period_days: null, metadata: {} },
+            discount: null,
+            automatic_tax: { enabled: false, status: null, tax_calculation: null },
+            amount_subtotal: '120000',
+            amount_total: '120000',
+            total_details: { amount_discount: '0', amount_shipping: '0', amount_tax: '0' },
+            expires_at: 1796342400,
+            header: 'Annual support',
+            description: null,
+            footer: null,
+            invoice: null,
+            subscription: null,
+            status_transitions: { finalized_at: 1793750400, accepted_at: null, canceled_at: null },
+            test_clock: null,
+            metadata: {},
+            created: 1793750400,
+        },
+    ],
+});
+// ---- Requests ------------------------------------------------------------------------
+const quoteLineItemParams = zod_1.z
+    .object({
+    price: params_1.idParam.describe('An active, licensed catalog Price (`price_…`), one-time or recurring.'),
+    quantity: zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(quotes_1.QUOTE_LIMITS.quantityMax)
+        .optional()
+        .describe('Default 1.'),
+})
+    .strict();
+const lineItemsParam = zod_1.z
+    .array(quoteLineItemParams)
+    .min(1)
+    .max(quotes_1.QUOTE_LIMITS.lineItemsMax)
+    .describe('Each price once, in one currency; every recurring price on one interval. Replaces every line on an update.');
+const invoiceSettingsParam = zod_1.z.object({ days_until_due: params_2.daysUntilDueParam.optional() }).strict();
+const subscriptionDataParam = zod_1.z
+    .object({
+    description: (0, params_2.shortText)(500).optional(),
+    trial_period_days: zod_1.z.number().int().min(1).max(quotes_1.QUOTE_LIMITS.trialPeriodDaysMax).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+})
+    .strict();
+exports.createQuoteParams = zod_1.z
+    .object({
+    customer: params_1.idParam,
+    line_items: lineItemsParam,
+    collection_method: zod_1.z
+        .enum(subscriptions_1.COLLECTION_METHODS)
+        .optional()
+        .describe('Default `charge_automatically`; a FairCoin (`FAIR`) quote is always `send_invoice`.'),
+    invoice_settings: invoiceSettingsParam.optional(),
+    subscription_data: subscriptionDataParam.optional(),
+    discounts: params_2.discountsParam.optional().describe('At most one: a coupon or a promotion code.'),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    expires_at: params_1.unixSecondsParam
+        .optional()
+        .describe("Default: 30 days from now (the customer's test clock time when it has one)."),
+    header: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.headerMax).optional(),
+    description: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.descriptionMax).optional(),
+    footer: (0, params_2.shortText)(quotes_1.QUOTE_LIMITS.footerMax).optional(),
+    metadata: params_1.metadataCreateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** Drafts only, except `metadata`. A field sent as `""` is cleared. */
+exports.updateQuoteParams = zod_1.z
+    .object({
+    line_items: lineItemsParam.optional(),
+    collection_method: zod_1.z.enum(subscriptions_1.COLLECTION_METHODS).optional(),
+    invoice_settings: invoiceSettingsParam.optional(),
+    subscription_data: subscriptionDataParam.optional(),
+    discounts: zod_1.z.union([params_2.discountsParam, zod_1.z.literal('')]).optional(),
+    automatic_tax: params_2.automaticTaxParam.optional(),
+    expires_at: params_1.unixSecondsParam.optional(),
+    header: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.headerMax), zod_1.z.literal('')]).optional(),
+    description: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.descriptionMax), zod_1.z.literal('')]).optional(),
+    footer: zod_1.z.union([(0, params_2.shortText)(quotes_1.QUOTE_LIMITS.footerMax), zod_1.z.literal('')]).optional(),
+    metadata: params_1.metadataUpdateParam.optional(),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+exports.finalizeQuoteParams = zod_1.z
+    .object({
+    expires_at: params_1.unixSecondsParam.optional().describe('A new expiry, set as it finalizes.'),
+    expand: params_1.expandParam.optional(),
+})
+    .strict();
+/** The body of `accept` and `cancel`: nothing but `expand[]`. */
+exports.quoteActionParams = zod_1.z.object({ expand: params_1.expandParam.optional() }).strict();
+exports.listQuotesQuery = (0, params_1.listQuery)({
+    customer: params_1.idParam.optional(),
+    status: zod_1.z.enum(quotes_1.QUOTE_STATUSES).optional(),
+});
+/** A quote's lines, in their order; `created` does not apply to them. */
+exports.listQuoteLineItemsQuery = (0, params_1.listQuery)({});
+// ---- Routes --------------------------------------------------------------------------
+const quoteId = { id: 'The quote (`qt_…`).' };
+exports.quoteRoutes = [
+    (0, route_1.defineRoute)({
+        operationId: 'createQuote',
+        method: 'post',
+        path: '/v1/quotes',
+        tag: 'Quotes',
+        summary: 'Create a quote',
+        description: "A draft for one customer, priced from catalog Prices with the catalog's own pricing. Its tax is computed when it finalizes.",
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.create',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listQuotes',
+        method: 'get',
+        path: '/v1/quotes',
+        tag: 'Quotes',
+        summary: 'List quotes',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listQuotesQuery,
+        response: (0, envelopes_1.listOf)(exports.quoteSchema),
+        sdk: 'quotes.list',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveQuote',
+        method: 'get',
+        path: '/v1/quotes/{id}',
+        tag: 'Quotes',
+        summary: 'Retrieve a quote',
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        query: params_1.expandOnlyQuery,
+        response: exports.quoteSchema,
+        sdk: 'quotes.retrieve',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}',
+        tag: 'Quotes',
+        summary: 'Update a quote',
+        description: 'Drafts only, except `metadata`. `line_items` replaces every line; a field sent as `""` is cleared; `metadata` is a patch.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.updateQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.update',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'finalizeQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/finalize',
+        tag: 'Quotes',
+        summary: 'Finalize a draft quote',
+        description: 'It gets its number, its discount and its Peable Tax. Tax fails closed: a quote whose tax cannot be computed stays a draft (`automatic_tax.status` says why).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.finalizeQuoteParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.finalizeQuote',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'acceptQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/accept',
+        tag: 'Quotes',
+        summary: 'Accept an open quote',
+        description: 'The customer said yes. One-time lines become an invoice; recurring lines a subscription whose first invoice also carries the one-time lines. The invoice is finalized (tax before finalize) and collected as the engine collects any other: charged when `charge_automatically` and the customer has a card, otherwise paid on its hosted page — where FairCoin is always offered.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.quoteActionParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.accept',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'cancelQuote',
+        method: 'post',
+        path: '/v1/quotes/{id}/cancel',
+        tag: 'Quotes',
+        summary: 'Cancel a quote',
+        description: 'A draft or an open quote; an accepted one cannot be cancelled.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: quoteId,
+        body: exports.quoteActionParams,
+        response: exports.quoteSchema,
+        sdk: 'quotes.cancel',
+        expandable: 'quote',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listQuoteLineItems',
+        method: 'get',
+        path: '/v1/quotes/{id}/line_items',
+        tag: 'Quotes',
+        summary: "List a quote's line items",
+        description: "In their order (at most twenty); the cursor is a line's own `li_…`.",
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        query: exports.listQuoteLineItemsQuery,
+        response: (0, envelopes_1.listOf)(shared_1.checkoutLineItemSchema),
+        sdk: 'quotes.listLineItems',
+        expandable: 'item',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveQuotePdf',
+        method: 'get',
+        path: '/v1/quotes/{id}/pdf',
+        tag: 'Quotes',
+        summary: "Download a quote's PDF",
+        description: 'A draft renders marked as a draft, without a number.',
+        auth: 'service',
+        scope: 'payments:read',
+        params: quoteId,
+        response: { kind: 'binary', contentType: 'application/pdf' },
+        sdk: 'quotes.pdf',
+    }),
+];

package/dist/cjs/resources/connect/reporting.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reportingRoutes = exports.downloadReportQuery = exports.listReportRunsQuery = exports.createReportRunParams = exports.reportRunSchema = exports.reportRunParametersSchema = exports.reportTypeSchema = void 0;
+exports.reportingRoutes = exports.downloadReportQuery = exports.listReportSchedulesQuery = exports.reportScheduleActionParams = exports.updateReportScheduleParams = exports.createReportScheduleParams = exports.listReportRunsQuery = exports.createReportRunParams = exports.reportScheduleSchema = exports.reportScheduleCadenceSchema = exports.reportRunSchema = exports.reportRunParametersSchema = exports.reportTypeSchema = void 0;
 const zod_1 = require("zod");
 const objects_1 = require("../../common/objects");
 const envelopes_1 = require("../../common/envelopes");
@@ -88,6 +88,7 @@ exports.reportRunSchema = (0, objects_2.defineObject)('reporting.report_run', 'R
         .nullable()
         .describe('The CSV once `succeeded` — a File of purpose `finance_report_run` (`GET /v1/files/{id}/contents` reads it).'),
     succeeded_at: primitives_1.unixSeconds.nullable(),
+    report_schedule: (0, objects_1.expandable)('reporting.report_schedule', 'The schedule that fired this run (`frs_…`); `null` for a run asked for directly.').nullable(),
 })
     .strict(), {
     examples: [
@@ -102,6 +103,78 @@ exports.reportRunSchema = (0, objects_2.defineObject)('reporting.report_run', 'R
             error: null,
             result: null,
             succeeded_at: null,
+            report_schedule: null,
+        },
+    ],
+});
+/** When a schedule fires (Stripe's payout-schedule spelling). */
+exports.reportScheduleCadenceSchema = (0, objects_2.defineComponent)('ReportScheduleCadence', zod_1.z
+    .object({
+    interval: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_INTERVALS),
+    weekly_anchor: zod_1.z
+        .enum(reporting_1.REPORT_SCHEDULE_WEEKDAYS)
+        .nullable()
+        .describe('The day a `weekly` schedule fires; `null` otherwise.'),
+    monthly_anchor: zod_1.z
+        .number()
+        .int()
+        .nullable()
+        .describe('The day of the month a `monthly` schedule fires (1–31; a shorter month fires on its last day); `null` otherwise.'),
+})
+    .strict());
+/**
+ * `reporting.report_schedule` (`frs_…`): a report run on a cadence. Each
+ * occurrence is local midnight in `timezone`; it creates an ordinary report
+ * run over the time since the previous occurrence, and emails `recipients` a
+ * link to it in Orbit once it succeeded (or failed). The CSV is never attached
+ * and never public: a recipient signs in to Orbit to download it.
+ */
+exports.reportScheduleSchema = (0, objects_2.defineObject)('reporting.report_schedule', 'ReportSchedule', zod_1.z
+    .object({
+    id: zod_1.z.string(),
+    object: zod_1.z.literal('reporting.report_schedule'),
+    livemode: primitives_1.livemode,
+    created: primitives_1.unixSeconds,
+    report_type: reportTypeId,
+    parameters: zod_1.z
+        .object({
+        columns: zod_1.z.array(zod_1.z.string()).optional(),
+        currency: primitives_1.currency.optional(),
+    })
+        .strict()
+        .describe("Every run's `parameters` but the interval, which each occurrence sets: the time since the previous occurrence."),
+    schedule: exports.reportScheduleCadenceSchema,
+    timezone: zod_1.z
+        .string()
+        .describe('The IANA time zone whose midnight each occurrence is (`Europe/Madrid`).'),
+    recipients: zod_1.z
+        .array(zod_1.z.string())
+        .describe('Who is emailed when a run of this schedule succeeds or fails.'),
+    locale: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_LOCALES).describe('The language of those emails.'),
+    status: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_STATUSES),
+    next_run_at: primitives_1.unixSeconds
+        .nullable()
+        .describe('The next occurrence while `active`; `null` while paused or canceled.'),
+    last_run: (0, objects_1.expandable)('reporting.report_run', 'The newest run this schedule fired.').nullable(),
+    canceled_at: primitives_1.unixSeconds.nullable(),
+})
+    .strict(), {
+    examples: [
+        {
+            id: 'frs_0193b8f34d1e4a6b8c27',
+            object: 'reporting.report_schedule',
+            livemode: false,
+            created: 1793750400,
+            report_type: 'balance.summary.1',
+            parameters: {},
+            schedule: { interval: 'monthly', weekly_anchor: null, monthly_anchor: 1 },
+            timezone: 'Europe/Madrid',
+            recipients: ['finance@example.com'],
+            locale: 'en',
+            status: 'active',
+            next_run_at: 1796079600,
+            last_run: null,
+            canceled_at: null,
         },
     ],
 });
@@ -125,7 +198,79 @@ exports.createReportRunParams = zod_1.z
         .strict(),
 })
     .strict();
-exports.listReportRunsQuery = (0, params_1.listQuery)({ report_type: reportTypeId.optional() });
+exports.listReportRunsQuery = (0, params_1.listQuery)({
+    report_type: reportTypeId.optional(),
+    report_schedule: zod_1.z
+        .string()
+        .min(1)
+        .max(64)
+        .optional()
+        .describe('Only the runs this schedule (`frs_…`) fired.'),
+});
+/** A schedule's run template: a run's `parameters` without the interval. */
+const scheduleParameters = zod_1.z
+    .object({
+    columns: zod_1.z
+        .array(column)
+        .min(1)
+        .max(64)
+        .optional()
+        .describe("Columns of the report type's layout, each once."),
+    currency: zod_1.z.enum(money_1.CURRENCY_CODES).optional(),
+})
+    .strict();
+const cadenceParams = zod_1.z
+    .object({
+    interval: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_INTERVALS),
+    weekly_anchor: zod_1.z
+        .enum(reporting_1.REPORT_SCHEDULE_WEEKDAYS)
+        .optional()
+        .describe('Required for `weekly`, refused otherwise.'),
+    monthly_anchor: zod_1.z
+        .number()
+        .int()
+        .min(1)
+        .max(31)
+        .optional()
+        .describe('Required for `monthly`, refused otherwise; a shorter month fires on its last day.'),
+})
+    .strict();
+const recipientsParam = zod_1.z
+    .array(zod_1.z.email().max(254))
+    .max(reporting_1.REPORT_SCHEDULE_MAX_RECIPIENTS)
+    .describe(`At most ${String(reporting_1.REPORT_SCHEDULE_MAX_RECIPIENTS)} addresses, each once. They receive a link to the run in Orbit, never the file.`);
+const timezoneParam = zod_1.z
+    .string()
+    .min(1)
+    .max(64)
+    .describe('An IANA time zone (`Europe/Madrid`); `UTC` when absent.');
+/** `POST /v1/reporting/report_schedules`. */
+exports.createReportScheduleParams = zod_1.z
+    .object({
+    report_type: reportTypeId,
+    parameters: scheduleParameters.optional(),
+    schedule: cadenceParams,
+    timezone: timezoneParam.optional(),
+    recipients: recipientsParam.optional(),
+    locale: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_LOCALES).optional().describe('`en` when absent.'),
+})
+    .strict();
+/** `POST /v1/reporting/report_schedules/{id}`: each field sent replaces the stored one. */
+exports.updateReportScheduleParams = zod_1.z
+    .object({
+    report_type: reportTypeId.optional(),
+    parameters: scheduleParameters.optional(),
+    schedule: cadenceParams.optional(),
+    timezone: timezoneParam.optional(),
+    recipients: recipientsParam.optional(),
+    locale: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_LOCALES).optional(),
+})
+    .strict();
+/** Pause, resume and cancel take no parameters. */
+exports.reportScheduleActionParams = zod_1.z.object({}).strict();
+exports.listReportSchedulesQuery = (0, params_1.listQuery)({
+    status: zod_1.z.enum(reporting_1.REPORT_SCHEDULE_STATUSES).optional(),
+});
 /**
  * A download's query: a run's `parameters`, spelled as a query string
  * (`columns[]=a&columns[]=b`, or one `columns=a`).
@@ -150,6 +295,7 @@ exports.downloadReportQuery = zod_1.z
 })
     .strict();
 const reportTypeIdParam = { id: 'The report type (`payments.itemized.1`, …).' };
+const reportScheduleIdParam = { id: 'The report schedule (`frs_…`).' };
 exports.reportingRoutes = [
     (0, route_1.defineRoute)({
         operationId: 'listReportTypes',
@@ -232,4 +378,106 @@ exports.reportingRoutes = [
         sdk: 'reporting.reportRuns.retrieve',
         expandable: 'reporting.report_run',
     }),
+    (0, route_1.defineRoute)({
+        operationId: 'createReportSchedule',
+        method: 'post',
+        path: '/v1/reporting/report_schedules',
+        tag: 'Reporting',
+        summary: 'Create a report schedule',
+        description: 'A report run at local midnight in `timezone` every day, week or month, each over the time since the previous occurrence. `next_run_at` is the first occurrence after now; nothing is backfilled.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        body: exports.createReportScheduleParams,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.create',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'listReportSchedules',
+        method: 'get',
+        path: '/v1/reporting/report_schedules',
+        tag: 'Reporting',
+        summary: 'List report schedules',
+        description: 'Newest first; a canceled schedule is listed too.',
+        auth: 'service',
+        scope: 'payments:read',
+        query: exports.listReportSchedulesQuery,
+        response: (0, envelopes_1.listOf)(exports.reportScheduleSchema),
+        sdk: 'reporting.reportSchedules.list',
+        expandable: 'reporting.report_schedule',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'retrieveReportSchedule',
+        method: 'get',
+        path: '/v1/reporting/report_schedules/{id}',
+        tag: 'Reporting',
+        summary: 'Retrieve a report schedule',
+        auth: 'service',
+        scope: 'payments:read',
+        params: reportScheduleIdParam,
+        query: params_1.expandOnlyQuery,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.retrieve',
+        expandable: 'reporting.report_schedule',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'updateReportSchedule',
+        method: 'post',
+        path: '/v1/reporting/report_schedules/{id}',
+        tag: 'Reporting',
+        summary: 'Update a report schedule',
+        description: 'A new `schedule` or `timezone` moves an active schedule to its first occurrence after now. A canceled schedule cannot change (409 `report_schedule_unexpected_state`).',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: reportScheduleIdParam,
+        body: exports.updateReportScheduleParams,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.update',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'pauseReportSchedule',
+        method: 'post',
+        path: '/v1/reporting/report_schedules/{id}/pause',
+        tag: 'Reporting',
+        summary: 'Pause a report schedule',
+        description: 'Nothing fires until it is resumed. Pausing a paused schedule answers it as it is.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: reportScheduleIdParam,
+        body: exports.reportScheduleActionParams,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.pause',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'resumeReportSchedule',
+        method: 'post',
+        path: '/v1/reporting/report_schedules/{id}/resume',
+        tag: 'Reporting',
+        summary: 'Resume a paused report schedule',
+        description: 'It fires again from its first occurrence after now; the occurrences it missed while paused are not run.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: reportScheduleIdParam,
+        body: exports.reportScheduleActionParams,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.resume',
+    }),
+    (0, route_1.defineRoute)({
+        operationId: 'cancelReportSchedule',
+        method: 'post',
+        path: '/v1/reporting/report_schedules/{id}/cancel',
+        tag: 'Reporting',
+        summary: 'Cancel a report schedule',
+        description: 'For good: it never fires again, and a run it fires no longer emails anyone. Its runs and their files stay.',
+        auth: 'service',
+        scope: 'payments:write',
+        idempotent: true,
+        params: reportScheduleIdParam,
+        body: exports.reportScheduleActionParams,
+        response: exports.reportScheduleSchema,
+        sdk: 'reporting.reportSchedules.cancel',
+    }),
 ];

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

@@ -274,6 +274,10 @@ exports.WEBHOOK_EVENT_DESCRIPTIONS = {
     'billing_portal.configuration.created': 'A customer portal configuration was created.',
     'billing_portal.configuration.updated': 'A customer portal configuration was updated.',
     'billing_portal.session.created': 'A customer portal session was created.',
+    'quote.created': 'A draft Quote was created.',
+    'quote.finalized': 'A Quote was finalized: numbered, priced and taxed, waiting for its customer.',
+    'quote.accepted': 'A Quote was accepted: its `invoice` (and, for recurring lines, its `subscription`) exists.',
+    'quote.canceled': 'A Quote was cancelled, or expired while open.',
     'tax.assessment.created': 'A tax compliance assessment was run. Nothing was registered, filed or collected.',
     'tax.review_item.created': 'A tax assessment finding opened a review item.',
     'tax.review_item.updated': 'A tax review item was decided, or found again.',

package/dist/cjs/vocabulary/errors.js

@@ -117,8 +117,12 @@ exports.ERROR_CODE_DESCRIPTIONS = {
     invoice_not_editable: 'The invoice is finalized and can no longer be edited.',
     invoice_unexpected_state: 'The invoice is in a status that does not allow this operation.',
     invoice_no_customer_line_items: 'The invoice has no line items to finalize.',
+    quote_not_editable: 'Only a draft quote can be edited.',
+    quote_unexpected_state: "The quote's status does not allow this.",
+    quote_expired: 'The quote expired.',
     invoice_payment_intent_requires_action: "The invoice's payment needs the customer to act (a card challenge).",
     subscription_unexpected_state: 'The subscription is in a status that does not allow this operation.',
+    report_schedule_unexpected_state: 'A canceled report schedule never changes.',
     customer_currency_mismatch: "The currency differs from the customer's billing currency.",
     customer_test_clock_mismatch: 'The objects live on different test clocks.',
     coupon_invalid: 'The coupon does not exist or is no longer valid.',