@peable.to/contracts 0.4.0 → 1.1.0

package/dist/types/resources/catalog/billingSettings.d.ts

@@ -0,0 +1,160 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * The merchant's billing settings (ADR 0018 §5; one per merchant and mode).
+ * Every field has a default, so a merchant that never opens the screen bills
+ * correctly:
+ *
+ *  - `invoice_prefix`: derived from the merchant id; numbers are
+ *    `PREFIX-0001`, gapless per merchant.
+ *  - `dunning.retry_schedule_days`: `[1, 3, 5, 7]` — each retry so many days
+ *    after the previous attempt (16 days, four retries, Stripe's default
+ *    window).
+ *  - `dunning.final_action`: `cancel` — the subscription ends when the last
+ *    retry fails; `dunning.invoice_action`: `mark_uncollectible`.
+ *  - emails on: the payer is told when an invoice is finalized for them
+ *    (`send_invoice`) and when a payment fails.
+ */
+export declare const billingSettingsSchema: z.ZodObject<{
+    object: z.ZodLiteral<"billing_settings">;
+    livemode: z.ZodBoolean;
+    invoice_prefix: z.ZodString;
+    next_invoice_sequence: z.ZodNumber;
+    default_days_until_due: z.ZodNumber;
+    dunning: z.ZodObject<{
+        retry_schedule_days: z.ZodArray<z.ZodNumber>;
+        final_action: z.ZodEnum<{
+            past_due: "past_due";
+            unpaid: "unpaid";
+            cancel: "cancel";
+        }>;
+        invoice_action: z.ZodEnum<{
+            mark_uncollectible: "mark_uncollectible";
+            leave_open: "leave_open";
+        }>;
+    }, z.core.$strict>;
+    emails: z.ZodObject<{
+        invoice_finalized: z.ZodBoolean;
+        payment_failed: z.ZodBoolean;
+    }, z.core.$strict>;
+    updated: z.ZodNumber;
+}, z.core.$strict>;
+export type BillingSettings = Expand<z.output<typeof billingSettingsSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        billing_settings: BillingSettings;
+    }
+}
+export declare const updateBillingSettingsParams: z.ZodObject<{
+    invoice_prefix: z.ZodOptional<z.ZodString>;
+    default_days_until_due: z.ZodOptional<z.ZodNumber>;
+    dunning: z.ZodOptional<z.ZodObject<{
+        retry_schedule_days: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        final_action: z.ZodOptional<z.ZodEnum<{
+            past_due: "past_due";
+            unpaid: "unpaid";
+            cancel: "cancel";
+        }>>;
+        invoice_action: z.ZodOptional<z.ZodEnum<{
+            mark_uncollectible: "mark_uncollectible";
+            leave_open: "leave_open";
+        }>>;
+    }, z.core.$strict>>;
+    emails: z.ZodOptional<z.ZodObject<{
+        invoice_finalized: z.ZodOptional<z.ZodBoolean>;
+        payment_failed: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type UpdateBillingSettingsParams = z.input<typeof updateBillingSettingsParams>;
+export declare const billingSettingsRoutes: readonly [{
+    readonly operationId: "retrieveBillingSettings";
+    readonly method: "get";
+    readonly path: "/v1/billing_settings";
+    readonly tag: "Billing settings";
+    readonly summary: "Retrieve the billing settings";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"billing_settings">;
+        livemode: z.ZodBoolean;
+        invoice_prefix: z.ZodString;
+        next_invoice_sequence: z.ZodNumber;
+        default_days_until_due: z.ZodNumber;
+        dunning: z.ZodObject<{
+            retry_schedule_days: z.ZodArray<z.ZodNumber>;
+            final_action: z.ZodEnum<{
+                past_due: "past_due";
+                unpaid: "unpaid";
+                cancel: "cancel";
+            }>;
+            invoice_action: z.ZodEnum<{
+                mark_uncollectible: "mark_uncollectible";
+                leave_open: "leave_open";
+            }>;
+        }, z.core.$strict>;
+        emails: z.ZodObject<{
+            invoice_finalized: z.ZodBoolean;
+            payment_failed: z.ZodBoolean;
+        }, z.core.$strict>;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billingSettings.retrieve";
+}, {
+    readonly operationId: "updateBillingSettings";
+    readonly method: "post";
+    readonly path: "/v1/billing_settings";
+    readonly tag: "Billing settings";
+    readonly summary: "Update the billing settings";
+    readonly description: "Invoice numbering, the default payment term, dunning and the payer emails.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        invoice_prefix: z.ZodOptional<z.ZodString>;
+        default_days_until_due: z.ZodOptional<z.ZodNumber>;
+        dunning: z.ZodOptional<z.ZodObject<{
+            retry_schedule_days: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+            final_action: z.ZodOptional<z.ZodEnum<{
+                past_due: "past_due";
+                unpaid: "unpaid";
+                cancel: "cancel";
+            }>>;
+            invoice_action: z.ZodOptional<z.ZodEnum<{
+                mark_uncollectible: "mark_uncollectible";
+                leave_open: "leave_open";
+            }>>;
+        }, z.core.$strict>>;
+        emails: z.ZodOptional<z.ZodObject<{
+            invoice_finalized: z.ZodOptional<z.ZodBoolean>;
+            payment_failed: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"billing_settings">;
+        livemode: z.ZodBoolean;
+        invoice_prefix: z.ZodString;
+        next_invoice_sequence: z.ZodNumber;
+        default_days_until_due: z.ZodNumber;
+        dunning: z.ZodObject<{
+            retry_schedule_days: z.ZodArray<z.ZodNumber>;
+            final_action: z.ZodEnum<{
+                past_due: "past_due";
+                unpaid: "unpaid";
+                cancel: "cancel";
+            }>;
+            invoice_action: z.ZodEnum<{
+                mark_uncollectible: "mark_uncollectible";
+                leave_open: "leave_open";
+            }>;
+        }, z.core.$strict>;
+        emails: z.ZodObject<{
+            invoice_finalized: z.ZodBoolean;
+            payment_failed: z.ZodBoolean;
+        }, z.core.$strict>;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billingSettings.update";
+}];

package/dist/types/resources/catalog/coupons.d.ts

@@ -0,0 +1,403 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Coupons (ADR 0018) — a discount, by percentage or by a fixed amount in one
+ * currency. Its `id` is the merchant's own (`SUMMER25`) or generated
+ * (`coupon_…`), and names that one coupon forever: a deleted coupon's id is
+ * never reused. Only `name` and `metadata` change; the terms of a discount a
+ * customer already holds cannot.
+ */
+export declare const couponSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"coupon">;
+    livemode: z.ZodBoolean;
+    name: z.ZodNullable<z.ZodString>;
+    percent_off: z.ZodNullable<z.ZodNumber>;
+    amount_off: z.ZodNullable<z.ZodString>;
+    currency: z.ZodNullable<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";
+    }>>;
+    duration: z.ZodEnum<{
+        once: "once";
+        repeating: "repeating";
+        forever: "forever";
+    }>;
+    duration_in_months: z.ZodNullable<z.ZodNumber>;
+    max_redemptions: z.ZodNullable<z.ZodNumber>;
+    redeem_by: z.ZodNullable<z.ZodNumber>;
+    times_redeemed: z.ZodNumber;
+    valid: z.ZodBoolean;
+    applies_to: z.ZodNullable<z.ZodObject<{
+        products: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type Coupon = Expand<z.output<typeof couponSchema>>;
+/** What `DELETE /v1/coupons/{id}` answers. Existing discounts are not affected. */
+export declare const deletedCouponSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"coupon">;
+    deleted: z.ZodLiteral<true>;
+}, z.core.$strict>;
+export type DeletedCoupon = z.output<typeof deletedCouponSchema>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        coupon: Coupon;
+    }
+}
+export declare const createCouponParams: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    percent_off: z.ZodOptional<z.ZodPipe<z.ZodNumber, z.ZodTransform<number, number>>>;
+    amount_off: z.ZodOptional<z.ZodString>;
+    currency: z.ZodOptional<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";
+    }>>;
+    duration: z.ZodOptional<z.ZodEnum<{
+        once: "once";
+        repeating: "repeating";
+        forever: "forever";
+    }>>;
+    duration_in_months: z.ZodOptional<z.ZodNumber>;
+    max_redemptions: z.ZodOptional<z.ZodNumber>;
+    redeem_by: z.ZodOptional<z.ZodNumber>;
+    applies_to: z.ZodOptional<z.ZodObject<{
+        products: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+    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>;
+export type CreateCouponParams = z.input<typeof createCouponParams>;
+export declare const updateCouponParams: z.ZodObject<{
+    name: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>, z.ZodTransform<string | null, string>>>;
+    metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+    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>;
+export type UpdateCouponParams = z.input<typeof updateCouponParams>;
+export declare const listCouponsQuery: z.ZodObject<{
+    limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+    starting_after: z.ZodOptional<z.ZodString>;
+    ending_before: z.ZodOptional<z.ZodString>;
+    created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+        gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+    }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+        gt?: number | undefined;
+        gte?: number | undefined;
+        lt?: number | undefined;
+        lte?: number | undefined;
+    }>>]>>;
+    expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+}, z.core.$strict>;
+export type CouponListParams = z.input<typeof listCouponsQuery>;
+export declare const couponRoutes: readonly [{
+    readonly operationId: "createCoupon";
+    readonly method: "post";
+    readonly path: "/v1/coupons";
+    readonly tag: "Coupons";
+    readonly summary: "Create a coupon";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        percent_off: z.ZodOptional<z.ZodPipe<z.ZodNumber, z.ZodTransform<number, number>>>;
+        amount_off: z.ZodOptional<z.ZodString>;
+        currency: z.ZodOptional<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";
+        }>>;
+        duration: z.ZodOptional<z.ZodEnum<{
+            once: "once";
+            repeating: "repeating";
+            forever: "forever";
+        }>>;
+        duration_in_months: z.ZodOptional<z.ZodNumber>;
+        max_redemptions: z.ZodOptional<z.ZodNumber>;
+        redeem_by: z.ZodOptional<z.ZodNumber>;
+        applies_to: z.ZodOptional<z.ZodObject<{
+            products: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<Record<string, string>, Record<string, string>>>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"coupon">;
+        livemode: z.ZodBoolean;
+        name: z.ZodNullable<z.ZodString>;
+        percent_off: z.ZodNullable<z.ZodNumber>;
+        amount_off: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<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";
+        }>>;
+        duration: z.ZodEnum<{
+            once: "once";
+            repeating: "repeating";
+            forever: "forever";
+        }>;
+        duration_in_months: z.ZodNullable<z.ZodNumber>;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        redeem_by: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        valid: z.ZodBoolean;
+        applies_to: z.ZodNullable<z.ZodObject<{
+            products: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "coupons.create";
+    readonly expandable: "coupon";
+}, {
+    readonly operationId: "listCoupons";
+    readonly method: "get";
+    readonly path: "/v1/coupons";
+    readonly tag: "Coupons";
+    readonly summary: "List coupons";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly query: z.ZodObject<{
+        limit: z.ZodPipe<z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>, z.ZodTransform<number, number | undefined>>;
+        starting_after: z.ZodOptional<z.ZodString>;
+        ending_before: z.ZodOptional<z.ZodString>;
+        created: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>, z.ZodTransform<import("../..").RangeFilter, number>>, z.ZodPipe<z.ZodObject<{
+            gt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            gte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lt: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+            lte: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>>;
+        }, z.core.$strict>, z.ZodTransform<import("../..").RangeFilter, {
+            gt?: number | undefined;
+            gte?: number | undefined;
+            lt?: number | undefined;
+            lte?: number | undefined;
+        }>>]>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"coupon">;
+            livemode: z.ZodBoolean;
+            name: z.ZodNullable<z.ZodString>;
+            percent_off: z.ZodNullable<z.ZodNumber>;
+            amount_off: z.ZodNullable<z.ZodString>;
+            currency: z.ZodNullable<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";
+            }>>;
+            duration: z.ZodEnum<{
+                once: "once";
+                repeating: "repeating";
+                forever: "forever";
+            }>;
+            duration_in_months: z.ZodNullable<z.ZodNumber>;
+            max_redemptions: z.ZodNullable<z.ZodNumber>;
+            redeem_by: z.ZodNullable<z.ZodNumber>;
+            times_redeemed: z.ZodNumber;
+            valid: z.ZodBoolean;
+            applies_to: z.ZodNullable<z.ZodObject<{
+                products: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>>;
+            metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "coupons.list";
+    readonly expandable: "coupon";
+}, {
+    readonly operationId: "retrieveCoupon";
+    readonly method: "get";
+    readonly path: "/v1/coupons/{id}";
+    readonly tag: "Coupons";
+    readonly summary: "Retrieve a coupon";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The coupon (`SUMMER25`, `coupon_…`).";
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"coupon">;
+        livemode: z.ZodBoolean;
+        name: z.ZodNullable<z.ZodString>;
+        percent_off: z.ZodNullable<z.ZodNumber>;
+        amount_off: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<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";
+        }>>;
+        duration: z.ZodEnum<{
+            once: "once";
+            repeating: "repeating";
+            forever: "forever";
+        }>;
+        duration_in_months: z.ZodNullable<z.ZodNumber>;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        redeem_by: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        valid: z.ZodBoolean;
+        applies_to: z.ZodNullable<z.ZodObject<{
+            products: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "coupons.retrieve";
+    readonly expandable: "coupon";
+}, {
+    readonly operationId: "updateCoupon";
+    readonly method: "post";
+    readonly path: "/v1/coupons/{id}";
+    readonly tag: "Coupons";
+    readonly summary: "Update a coupon";
+    readonly description: "Only `name` and `metadata` change.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The coupon (`SUMMER25`, `coupon_…`).";
+    };
+    readonly body: z.ZodObject<{
+        name: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"">]>, z.ZodTransform<string | null, string>>>;
+        metadata: z.ZodOptional<z.ZodPipe<z.ZodRecord<z.ZodString, z.ZodString>, z.ZodTransform<import("../..").MetadataPatch, Record<string, string>>>>;
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"coupon">;
+        livemode: z.ZodBoolean;
+        name: z.ZodNullable<z.ZodString>;
+        percent_off: z.ZodNullable<z.ZodNumber>;
+        amount_off: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<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";
+        }>>;
+        duration: z.ZodEnum<{
+            once: "once";
+            repeating: "repeating";
+            forever: "forever";
+        }>;
+        duration_in_months: z.ZodNullable<z.ZodNumber>;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        redeem_by: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        valid: z.ZodBoolean;
+        applies_to: z.ZodNullable<z.ZodObject<{
+            products: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "coupons.update";
+    readonly expandable: "coupon";
+}, {
+    readonly operationId: "deleteCoupon";
+    readonly method: "delete";
+    readonly path: "/v1/coupons/{id}";
+    readonly tag: "Coupons";
+    readonly summary: "Delete a coupon";
+    readonly description: "Discounts customers already hold are not affected; the id is never reused.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly params: {
+        readonly id: "The coupon (`SUMMER25`, `coupon_…`).";
+    };
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"coupon">;
+        deleted: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+    readonly sdk: "coupons.del";
+}];