@peable.to/contracts 0.4.0 → 1.1.0

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

@@ -0,0 +1,474 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * Usage meters (`mtr_…`, ADR 0018 §7): usage events named `event_name`,
+ * attributed to a customer by `customer_mapping.event_payload_key` of their
+ * payload and measured by `value_settings.event_payload_key`. A metered price
+ * (`recurring.meter`) bills its aggregate per period, in arrears.
+ */
+export declare const billingMeterSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"billing.meter">;
+    livemode: z.ZodBoolean;
+    display_name: z.ZodString;
+    event_name: z.ZodString;
+    default_aggregation: z.ZodObject<{
+        formula: z.ZodEnum<{
+            sum: "sum";
+            count: "count";
+            last: "last";
+        }>;
+    }, z.core.$strict>;
+    customer_mapping: z.ZodObject<{
+        type: z.ZodLiteral<"by_id">;
+        event_payload_key: z.ZodString;
+    }, z.core.$strict>;
+    value_settings: z.ZodObject<{
+        event_payload_key: z.ZodString;
+    }, z.core.$strict>;
+    status: z.ZodEnum<{
+        active: "active";
+        inactive: "inactive";
+    }>;
+    created: z.ZodNumber;
+    updated: z.ZodNumber;
+}, z.core.$strict>;
+export type BillingMeter = Expand<z.output<typeof billingMeterSchema>>;
+/**
+ * One usage event, `POST /v1/billing/meter_events`. `identifier` makes it
+ * idempotent: the same identifier is the same event, forever.
+ */
+export declare const billingMeterEventSchema: z.ZodObject<{
+    object: z.ZodLiteral<"billing.meter_event">;
+    livemode: z.ZodBoolean;
+    identifier: z.ZodString;
+    event_name: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodString>;
+    timestamp: z.ZodNumber;
+    created: z.ZodNumber;
+}, z.core.$strict>;
+export type BillingMeterEvent = Expand<z.output<typeof billingMeterEventSchema>>;
+/** A customer's aggregate over a window: `GET /v1/billing/meters/{id}/event_summaries`. */
+export declare const billingMeterEventSummarySchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"billing.meter_event_summary">;
+    livemode: z.ZodBoolean;
+    meter: z.ZodString;
+    aggregated_value: z.ZodString;
+    start_time: z.ZodNumber;
+    end_time: z.ZodNumber;
+}, z.core.$strict>;
+export type BillingMeterEventSummary = Expand<z.output<typeof billingMeterEventSummarySchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        'billing.meter': BillingMeter;
+        'billing.meter_event': BillingMeterEvent;
+        'billing.meter_event_summary': BillingMeterEventSummary;
+    }
+}
+export declare const createBillingMeterParams: z.ZodObject<{
+    display_name: z.ZodString;
+    event_name: z.ZodString;
+    default_aggregation: z.ZodObject<{
+        formula: z.ZodEnum<{
+            sum: "sum";
+            count: "count";
+            last: "last";
+        }>;
+    }, z.core.$strict>;
+    customer_mapping: z.ZodOptional<z.ZodObject<{
+        type: z.ZodLiteral<"by_id">;
+        event_payload_key: z.ZodString;
+    }, z.core.$strict>>;
+    value_settings: z.ZodOptional<z.ZodObject<{
+        event_payload_key: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CreateBillingMeterParams = z.input<typeof createBillingMeterParams>;
+export declare const updateBillingMeterParams: z.ZodObject<{
+    display_name: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type UpdateBillingMeterParams = z.input<typeof updateBillingMeterParams>;
+/** The body of `deactivate` / `reactivate`: nothing. */
+export declare const billingMeterStatusParams: z.ZodObject<{}, z.core.$strict>;
+export declare const listBillingMetersQuery: 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>>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        active: "active";
+        inactive: "inactive";
+    }>>;
+}, z.core.$strict>;
+export type BillingMeterListParams = z.input<typeof listBillingMetersQuery>;
+export declare const billingMeterEventSummariesQuery: z.ZodObject<{
+    customer: z.ZodString;
+    start_time: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+    end_time: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+}, z.core.$strict>;
+export type BillingMeterEventSummaryParams = z.input<typeof billingMeterEventSummariesQuery>;
+export declare const createBillingMeterEventParams: z.ZodObject<{
+    event_name: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodString>;
+    identifier: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type CreateBillingMeterEventParams = z.input<typeof createBillingMeterEventParams>;
+export declare const meterRoutes: readonly [{
+    readonly operationId: "createBillingMeter";
+    readonly method: "post";
+    readonly path: "/v1/billing/meters";
+    readonly tag: "Meters";
+    readonly summary: "Create a meter";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodOptional<z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>>;
+        value_settings: z.ZodOptional<z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"billing.meter">;
+        livemode: z.ZodBoolean;
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        value_settings: z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>;
+        created: z.ZodNumber;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.create";
+}, {
+    readonly operationId: "listBillingMeters";
+    readonly method: "get";
+    readonly path: "/v1/billing/meters";
+    readonly tag: "Meters";
+    readonly summary: "List meters";
+    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>>>;
+        status: z.ZodOptional<z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"billing.meter">;
+            livemode: z.ZodBoolean;
+            display_name: z.ZodString;
+            event_name: z.ZodString;
+            default_aggregation: z.ZodObject<{
+                formula: z.ZodEnum<{
+                    sum: "sum";
+                    count: "count";
+                    last: "last";
+                }>;
+            }, z.core.$strict>;
+            customer_mapping: z.ZodObject<{
+                type: z.ZodLiteral<"by_id">;
+                event_payload_key: z.ZodString;
+            }, z.core.$strict>;
+            value_settings: z.ZodObject<{
+                event_payload_key: z.ZodString;
+            }, z.core.$strict>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+            }>;
+            created: z.ZodNumber;
+            updated: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.list";
+    readonly expandable: "billing.meter";
+}, {
+    readonly operationId: "retrieveBillingMeter";
+    readonly method: "get";
+    readonly path: "/v1/billing/meters/{id}";
+    readonly tag: "Meters";
+    readonly summary: "Retrieve a meter";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    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<"billing.meter">;
+        livemode: z.ZodBoolean;
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        value_settings: z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>;
+        created: z.ZodNumber;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.retrieve";
+}, {
+    readonly operationId: "updateBillingMeter";
+    readonly method: "post";
+    readonly path: "/v1/billing/meters/{id}";
+    readonly tag: "Meters";
+    readonly summary: "Update a meter";
+    readonly description: "Only `display_name` changes.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{
+        display_name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"billing.meter">;
+        livemode: z.ZodBoolean;
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        value_settings: z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>;
+        created: z.ZodNumber;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.update";
+}, {
+    readonly operationId: "deactivateBillingMeter";
+    readonly method: "post";
+    readonly path: "/v1/billing/meters/{id}/deactivate";
+    readonly tag: "Meters";
+    readonly summary: "Deactivate a meter";
+    readonly description: "An inactive meter accepts no events.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{}, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"billing.meter">;
+        livemode: z.ZodBoolean;
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        value_settings: z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>;
+        created: z.ZodNumber;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.deactivate";
+}, {
+    readonly operationId: "reactivateBillingMeter";
+    readonly method: "post";
+    readonly path: "/v1/billing/meters/{id}/reactivate";
+    readonly tag: "Meters";
+    readonly summary: "Reactivate a meter";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly params: {
+        id: string;
+    };
+    readonly body: z.ZodObject<{}, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"billing.meter">;
+        livemode: z.ZodBoolean;
+        display_name: z.ZodString;
+        event_name: z.ZodString;
+        default_aggregation: z.ZodObject<{
+            formula: z.ZodEnum<{
+                sum: "sum";
+                count: "count";
+                last: "last";
+            }>;
+        }, z.core.$strict>;
+        customer_mapping: z.ZodObject<{
+            type: z.ZodLiteral<"by_id">;
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        value_settings: z.ZodObject<{
+            event_payload_key: z.ZodString;
+        }, z.core.$strict>;
+        status: z.ZodEnum<{
+            active: "active";
+            inactive: "inactive";
+        }>;
+        created: z.ZodNumber;
+        updated: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.reactivate";
+}, {
+    readonly operationId: "listBillingMeterEventSummaries";
+    readonly method: "get";
+    readonly path: "/v1/billing/meters/{id}/event_summaries";
+    readonly tag: "Meters";
+    readonly summary: "A customer's usage over a window";
+    readonly description: "One summary: the aggregate of the window `[start_time, end_time)`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    readonly query: z.ZodObject<{
+        customer: z.ZodString;
+        start_time: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+        end_time: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"list">;
+        data: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            object: z.ZodLiteral<"billing.meter_event_summary">;
+            livemode: z.ZodBoolean;
+            meter: z.ZodString;
+            aggregated_value: z.ZodString;
+            start_time: z.ZodNumber;
+            end_time: z.ZodNumber;
+        }, z.core.$strict>>;
+        has_more: z.ZodBoolean;
+        url: z.ZodString;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meters.listEventSummaries";
+}, {
+    readonly operationId: "createBillingMeterEvent";
+    readonly method: "post";
+    readonly path: "/v1/billing/meter_events";
+    readonly tag: "Meters";
+    readonly summary: "Record a meter event";
+    readonly description: "The customer must be yours and the value a non-negative integer. A repeated `identifier` answers the stored event.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        event_name: z.ZodString;
+        payload: z.ZodRecord<z.ZodString, z.ZodString>;
+        identifier: z.ZodOptional<z.ZodString>;
+        timestamp: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"billing.meter_event">;
+        livemode: z.ZodBoolean;
+        identifier: z.ZodString;
+        event_name: z.ZodString;
+        payload: z.ZodRecord<z.ZodString, z.ZodString>;
+        timestamp: z.ZodNumber;
+        created: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "billing.meterEvents.create";
+}];