@peable.to/contracts 0.3.0 → 1.0.0

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

@@ -0,0 +1,369 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Promotion codes (`promo_…`, ADR 0018) — a customer-facing `code` that
+ * redeems a coupon, with its own limits. Codes are case-insensitive and unique
+ * among a merchant's ACTIVE codes.
+ */
+export declare const promotionCodeRestrictionsSchema: z.ZodObject<{
+    first_time_transaction: z.ZodBoolean;
+    minimum_amount: z.ZodNullable<z.ZodString>;
+    minimum_amount_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";
+    }>>;
+}, z.core.$strict>;
+export type PromotionCodeRestrictions = z.output<typeof promotionCodeRestrictionsSchema>;
+export declare const promotionCodeSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"promotion_code">;
+    livemode: z.ZodBoolean;
+    code: z.ZodString;
+    coupon: z.ZodType<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">, z.core.$ZodTypeInternals<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">>>;
+    customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+    active: z.ZodBoolean;
+    max_redemptions: z.ZodNullable<z.ZodNumber>;
+    expires_at: z.ZodNullable<z.ZodNumber>;
+    times_redeemed: z.ZodNumber;
+    restrictions: z.ZodObject<{
+        first_time_transaction: z.ZodBoolean;
+        minimum_amount: z.ZodNullable<z.ZodString>;
+        minimum_amount_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";
+        }>>;
+    }, z.core.$strict>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type PromotionCode = Expand<z.output<typeof promotionCodeSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        promotion_code: PromotionCode;
+    }
+}
+export declare const createPromotionCodeParams: z.ZodObject<{
+    coupon: z.ZodString;
+    code: z.ZodOptional<z.ZodString>;
+    customer: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    max_redemptions: z.ZodOptional<z.ZodNumber>;
+    expires_at: z.ZodOptional<z.ZodNumber>;
+    restrictions: z.ZodOptional<z.ZodObject<{
+        first_time_transaction: z.ZodOptional<z.ZodBoolean>;
+        minimum_amount: z.ZodOptional<z.ZodString>;
+        minimum_amount_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";
+        }>>;
+    }, 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 CreatePromotionCodeParams = z.input<typeof createPromotionCodeParams>;
+export declare const updatePromotionCodeParams: z.ZodObject<{
+    active: z.ZodOptional<z.ZodBoolean>;
+    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 UpdatePromotionCodeParams = z.input<typeof updatePromotionCodeParams>;
+export declare const listPromotionCodesQuery: 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>>>;
+    code: z.ZodOptional<z.ZodString>;
+    coupon: z.ZodOptional<z.ZodString>;
+    customer: z.ZodOptional<z.ZodString>;
+    active: z.ZodOptional<z.ZodType<boolean, boolean, z.core.$ZodTypeInternals<boolean, boolean>>>;
+}, z.core.$strict>;
+export type PromotionCodeListParams = z.input<typeof listPromotionCodesQuery>;
+export declare const promotionCodeRoutes: readonly [{
+    readonly operationId: "createPromotionCode";
+    readonly method: "post";
+    readonly path: "/v1/promotion_codes";
+    readonly tag: "Promotion codes";
+    readonly summary: "Create a promotion code";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        coupon: z.ZodString;
+        code: z.ZodOptional<z.ZodString>;
+        customer: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodBoolean>;
+        max_redemptions: z.ZodOptional<z.ZodNumber>;
+        expires_at: z.ZodOptional<z.ZodNumber>;
+        restrictions: z.ZodOptional<z.ZodObject<{
+            first_time_transaction: z.ZodOptional<z.ZodBoolean>;
+            minimum_amount: z.ZodOptional<z.ZodString>;
+            minimum_amount_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";
+            }>>;
+        }, 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<"promotion_code">;
+        livemode: z.ZodBoolean;
+        code: z.ZodString;
+        coupon: z.ZodType<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">, z.core.$ZodTypeInternals<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">>>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        active: z.ZodBoolean;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        expires_at: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        restrictions: z.ZodObject<{
+            first_time_transaction: z.ZodBoolean;
+            minimum_amount: z.ZodNullable<z.ZodString>;
+            minimum_amount_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";
+            }>>;
+        }, z.core.$strict>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "promotionCodes.create";
+    readonly expandable: "promotion_code";
+}, {
+    readonly operationId: "listPromotionCodes";
+    readonly method: "get";
+    readonly path: "/v1/promotion_codes";
+    readonly tag: "Promotion codes";
+    readonly summary: "List promotion codes";
+    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>>>;
+        code: z.ZodOptional<z.ZodString>;
+        coupon: z.ZodOptional<z.ZodString>;
+        customer: z.ZodOptional<z.ZodString>;
+        active: z.ZodOptional<z.ZodType<boolean, boolean, z.core.$ZodTypeInternals<boolean, boolean>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"promotion_code">;
+            livemode: z.ZodBoolean;
+            code: z.ZodString;
+            coupon: z.ZodType<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">, z.core.$ZodTypeInternals<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">>>;
+            customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+            active: z.ZodBoolean;
+            max_redemptions: z.ZodNullable<z.ZodNumber>;
+            expires_at: z.ZodNullable<z.ZodNumber>;
+            times_redeemed: z.ZodNumber;
+            restrictions: z.ZodObject<{
+                first_time_transaction: z.ZodBoolean;
+                minimum_amount: z.ZodNullable<z.ZodString>;
+                minimum_amount_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";
+                }>>;
+            }, 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: "promotionCodes.list";
+    readonly expandable: "promotion_code";
+}, {
+    readonly operationId: "retrievePromotionCode";
+    readonly method: "get";
+    readonly path: "/v1/promotion_codes/{id}";
+    readonly tag: "Promotion codes";
+    readonly summary: "Retrieve a promotion code";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        readonly id: "The promotion code (`promo_…`).";
+    };
+    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<"promotion_code">;
+        livemode: z.ZodBoolean;
+        code: z.ZodString;
+        coupon: z.ZodType<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">, z.core.$ZodTypeInternals<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">>>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        active: z.ZodBoolean;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        expires_at: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        restrictions: z.ZodObject<{
+            first_time_transaction: z.ZodBoolean;
+            minimum_amount: z.ZodNullable<z.ZodString>;
+            minimum_amount_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";
+            }>>;
+        }, z.core.$strict>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "promotionCodes.retrieve";
+    readonly expandable: "promotion_code";
+}, {
+    readonly operationId: "updatePromotionCode";
+    readonly method: "post";
+    readonly path: "/v1/promotion_codes/{id}";
+    readonly tag: "Promotion codes";
+    readonly summary: "Update a promotion code";
+    readonly description: "Only `active` and `metadata` change.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        readonly id: "The promotion code (`promo_…`).";
+    };
+    readonly body: z.ZodObject<{
+        active: z.ZodOptional<z.ZodBoolean>;
+        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<"promotion_code">;
+        livemode: z.ZodBoolean;
+        code: z.ZodString;
+        coupon: z.ZodType<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">, z.core.$ZodTypeInternals<string | import("../..").Ref<"coupon">, string | import("../..").Ref<"coupon">>>;
+        customer: z.ZodNullable<z.ZodType<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">, z.core.$ZodTypeInternals<string | import("../..").Ref<"customer">, string | import("../..").Ref<"customer">>>>;
+        active: z.ZodBoolean;
+        max_redemptions: z.ZodNullable<z.ZodNumber>;
+        expires_at: z.ZodNullable<z.ZodNumber>;
+        times_redeemed: z.ZodNumber;
+        restrictions: z.ZodObject<{
+            first_time_transaction: z.ZodBoolean;
+            minimum_amount: z.ZodNullable<z.ZodString>;
+            minimum_amount_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";
+            }>>;
+        }, z.core.$strict>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodString>;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "promotionCodes.update";
+    readonly expandable: "promotion_code";
+}];

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

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+import { type CurrencyCode } from '../../vocabulary/money';
+/**
+ * Request pieces the catalog's bodies share — and that every other body naming
+ * an amount, a currency or an inline price reuses (checkout line items,
+ * invoice items), so one shape rule is written once and every caller refuses
+ * the same mistake with the same `param`.
+ */
+/** A canonical base-unit integer string: `"1999"`, never `"19.99"` or `1999`. */
+export declare const baseUnitAmountParam: z.ZodString;
+/** A positive count that fits a Postgres `integer`. */
+export declare const countParam: z.ZodNumber;
+/** A future instant in a body (`redeem_by`, `expires_at`): positive Unix seconds. */
+export declare const positiveUnixSecondsParam: z.ZodNumber;
+/**
+ * A boolean filter in a query string. A typed caller passes `true` / `false`
+ * (the SDK spells it for the URL); the URL carries `'true'` / `'false'`,
+ * which the gateway reads the same.
+ */
+export declare const queryFlag: z.ZodType<boolean, boolean>;
+/** `ids[]=a&ids[]=b` or `ids=a`: one id is a list of one. */
+export declare function queryIdList(max: number): z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>;
+/** `""` on an update clears the field (Stripe's rule): the parsed value is `null`. */
+export declare const clearing: <T extends z.ZodType>(schema: T) => z.ZodPipe<z.ZodUnion<readonly [T, z.ZodLiteral<"">]>, z.ZodTransform<Awaited<z.output<T>> | null, "" | z.core.$InferUnionOutput<T>>>;
+/** Report one broken rule at `path` (relative to the object being parsed). */
+export type Issue = (path: (string | number)[], message: string) => void;
+export declare function issuer(ctx: z.RefinementCtx): {
+    issue: Issue;
+    failed: () => boolean;
+};
+/** Refuse an amount above the catalog's bound for `currency`. */
+export declare function amountWithinBound(issue: Issue, amount: string | undefined, currency: CurrencyCode, path: (string | number)[]): void;
+/** Add a bound issue for a coupon or promotion amount in `currency`. */
+export declare function checkAmountBound(ctx: z.RefinementCtx, amount: string | undefined, currency: CurrencyCode | undefined, path: (string | number)[]): void;

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

@@ -0,0 +1,220 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Test clocks (`clock_…`, ADR 0018 §3, test mode only). Customers attached to
+ * a clock — and every subscription and invoice of theirs — live at
+ * `frozen_time` instead of the wall clock, so a trial, a renewal or a dunning
+ * schedule runs in seconds. Advancing it runs the engine for everything on the
+ * clock up to the new time.
+ */
+export declare const testClockSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"test_helpers.test_clock">;
+    livemode: z.ZodLiteral<false>;
+    name: z.ZodNullable<z.ZodString>;
+    frozen_time: z.ZodNumber;
+    status: z.ZodEnum<{
+        ready: "ready";
+        advancing: "advancing";
+        internal_failure: "internal_failure";
+    }>;
+    deletes_after: z.ZodNumber;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type TestClock = Expand<z.output<typeof testClockSchema>>;
+export declare const deletedTestClockSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"test_helpers.test_clock">;
+    deleted: z.ZodLiteral<true>;
+}, z.core.$strict>;
+export type DeletedTestClock = z.output<typeof deletedTestClockSchema>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        'test_helpers.test_clock': TestClock;
+    }
+}
+export declare const createTestClockParams: z.ZodObject<{
+    frozen_time: z.ZodNumber;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type CreateTestClockParams = z.input<typeof createTestClockParams>;
+export declare const advanceTestClockParams: z.ZodObject<{
+    frozen_time: z.ZodNumber;
+}, z.core.$strict>;
+export type AdvanceTestClockParams = z.input<typeof advanceTestClockParams>;
+export declare const listTestClocksQuery: 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 TestClockListParams = z.input<typeof listTestClocksQuery>;
+export declare const testClockRoutes: readonly [{
+    readonly operationId: "createTestClock";
+    readonly method: "post";
+    readonly path: "/v1/test_helpers/test_clocks";
+    readonly tag: "Test clocks";
+    readonly summary: "Create a test clock";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly testModeOnly: true;
+    readonly body: z.ZodObject<{
+        frozen_time: z.ZodNumber;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"test_helpers.test_clock">;
+        livemode: z.ZodLiteral<false>;
+        name: z.ZodNullable<z.ZodString>;
+        frozen_time: z.ZodNumber;
+        status: z.ZodEnum<{
+            ready: "ready";
+            advancing: "advancing";
+            internal_failure: "internal_failure";
+        }>;
+        deletes_after: z.ZodNumber;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.testClocks.create";
+}, {
+    readonly operationId: "listTestClocks";
+    readonly method: "get";
+    readonly path: "/v1/test_helpers/test_clocks";
+    readonly tag: "Test clocks";
+    readonly summary: "List test clocks";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly testModeOnly: true;
+    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<"test_helpers.test_clock">;
+            livemode: z.ZodLiteral<false>;
+            name: z.ZodNullable<z.ZodString>;
+            frozen_time: z.ZodNumber;
+            status: z.ZodEnum<{
+                ready: "ready";
+                advancing: "advancing";
+                internal_failure: "internal_failure";
+            }>;
+            deletes_after: z.ZodNumber;
+            created: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.testClocks.list";
+    readonly expandable: "test_helpers.test_clock";
+}, {
+    readonly operationId: "retrieveTestClock";
+    readonly method: "get";
+    readonly path: "/v1/test_helpers/test_clocks/{id}";
+    readonly tag: "Test clocks";
+    readonly summary: "Retrieve a test clock";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly testModeOnly: true;
+    readonly params: {
+        id: string;
+    };
+    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<"test_helpers.test_clock">;
+        livemode: z.ZodLiteral<false>;
+        name: z.ZodNullable<z.ZodString>;
+        frozen_time: z.ZodNumber;
+        status: z.ZodEnum<{
+            ready: "ready";
+            advancing: "advancing";
+            internal_failure: "internal_failure";
+        }>;
+        deletes_after: z.ZodNumber;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.testClocks.retrieve";
+}, {
+    readonly operationId: "advanceTestClock";
+    readonly method: "post";
+    readonly path: "/v1/test_helpers/test_clocks/{id}/advance";
+    readonly tag: "Test clocks";
+    readonly summary: "Advance a test clock";
+    readonly description: "Moves `frozen_time` forward and runs the billing engine for everything on the clock up to it: trials end, subscriptions renew, invoices finalize and dunning retries.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly testModeOnly: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{
+        frozen_time: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"test_helpers.test_clock">;
+        livemode: z.ZodLiteral<false>;
+        name: z.ZodNullable<z.ZodString>;
+        frozen_time: z.ZodNumber;
+        status: z.ZodEnum<{
+            ready: "ready";
+            advancing: "advancing";
+            internal_failure: "internal_failure";
+        }>;
+        deletes_after: z.ZodNumber;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.testClocks.advance";
+}, {
+    readonly operationId: "deleteTestClock";
+    readonly method: "delete";
+    readonly path: "/v1/test_helpers/test_clocks/{id}";
+    readonly tag: "Test clocks";
+    readonly summary: "Delete a test clock";
+    readonly description: "Every live subscription on the clock is cancelled at its frozen time; the clock stays readable to the objects that name it.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly testModeOnly: true;
+    readonly params: {
+        id: string;
+    };
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"test_helpers.test_clock">;
+        deleted: z.ZodLiteral<true>;
+    }, z.core.$strict>;
+    readonly sdk: "testHelpers.testClocks.del";
+}];