@leaflow/sdk 0.0.0-dev.212.gea1bf06 → 0.0.0-dev.214.g13f9d6c

package/dist/billing/catalog/v1/schema.d.ts

@@ -0,0 +1,910 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/catalog/v1/prices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List what is on sale, with prices
+         * @description Every sellable thing and what it costs, in one request. A plan appears once per price.
+         *
+         *     `currency` is required: a plan has a price in each currency it is sold in, so "what does
+         *     this cost" has no answer without one.
+         *
+         *     Retired prices are left out. Existing subscriptions still reference them, so this is not
+         *     the place to look up what an existing purchase is paying.
+         */
+        get: operations["list-prices"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/products": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List catalog products */
+        get: operations["list-products"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/products/{productId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                productId: components["schemas"]["ProductID"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get a service
+         * @description Resolves an identifier that was stored elsewhere — on an order line, an invoice line, or
+         *     the terms of a credit — into something that can be displayed.
+         */
+        get: operations["get-product"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/plans/{planId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * Get a sellable item
+         * @description Resolves a stored identifier into something that can be displayed. Returns items that are
+         *     no longer on sale: an existing purchase still refers to one.
+         */
+        get: operations["get-plan"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/prices/{priceId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                priceId: string;
+            };
+            cookie?: never;
+        };
+        /**
+         * Get a price
+         * @description Returns the catalog price, including retired prices. Fixed purchase history and renewal agreements are shown on orders and subscriptions rather than reconstructed from today's catalog.
+         */
+        get: operations["get-price"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/plans": {
+        parameters: {
+            query: {
+                product_id: components["schemas"]["ProductID"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List catalog plans */
+        get: operations["list-plans"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/plans/{planId}/prices": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                planId: components["parameters"]["PlanId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List catalog prices
+         * @description Public list prices only. An account holding a negotiated agreement may be charged less;
+         *     it is never charged more.
+         */
+        get: operations["list-prices-by-plan"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/rate-cards/{rateCardId}/rules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                rateCardId: components["parameters"]["RateCardId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List catalog rates
+         * @description Only public price lists are readable here. A list written for a single agreement is not,
+         *     and its identifier cannot be used to reach it.
+         */
+        get: operations["list-rates"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/catalog/v1/estimates": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Estimate a basket
+         * @description Uses public list prices. Nothing is reserved and nothing is recorded, so this may be
+         *     called as often as required.
+         *
+         *     `POST` is used because the set of items to price does not fit in a query string. There is
+         *     no corresponding `GET`, and no estimate is stored to retrieve.
+         *
+         *     An account holding a negotiated agreement may be charged less than this. Tax and
+         *     discounts are not included.
+         */
+        post: operations["create-estimate"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /**
+         * @description Whether a fulfilled purchase may end immediately or only after its paid term. Does not grant a refund. When absent, the terms are not configured and termination requires review.
+         * @enum {string}
+         */
+        TerminationPolicy: "immediate" | "period_end";
+        /**
+         * @description Prorated returns the unused value of paid service periods using integer-second duration ratios. Setup fees are excluded. Tax and funds follow the original invoice and payment sources.
+         * @enum {string}
+         */
+        RefundPolicy: "none" | "prorated";
+        Error: {
+            code?: string;
+            message: string;
+            /**
+             * @description What a given `code` carries alongside the message. The keys depend on the code,
+             *     and a client that does not recognise one ignores it.
+             */
+            meta?: {
+                [key: string]: unknown;
+            };
+            /** Format: int64 */
+            status: number;
+        };
+        Product: {
+            id: components["schemas"]["ProductID"];
+            name: string;
+            description?: string;
+        };
+        /** @description Immutable platform service identifier, such as compute, canopy or assistant. */
+        ProductID: string;
+        ProductList: {
+            items: components["schemas"]["Product"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        Plan: {
+            enabled: boolean;
+            lookup_key?: string;
+            product: components["schemas"]["Product"];
+            features: components["schemas"]["PlanFeature"][];
+            /** Format: uuid */
+            id: string;
+            product_id: components["schemas"]["ProductID"];
+            name: string;
+            description?: string;
+        };
+        PlanList: {
+            items: components["schemas"]["Plan"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        Price: {
+            rate_card?: components["schemas"]["ObjectIdentity"];
+            lookup_key?: string;
+            product: components["schemas"]["Product"];
+            plan: components["schemas"]["ObjectIdentity"];
+            /** Format: uuid */
+            meter_id?: string;
+            meter?: components["schemas"]["ObjectIdentity"];
+            unit_quantity: string;
+            enabled?: boolean;
+            termination_policy?: components["schemas"]["TerminationPolicy"];
+            refund_policy?: components["schemas"]["RefundPolicy"];
+            product_id?: components["schemas"]["ProductID"];
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            plan_id: string;
+            currency: string;
+            /**
+             * @description `postpaid` charges for what is used, `prepaid` buys a period in advance, `one_time`
+             *     charges once.
+             * @enum {string}
+             */
+            type: "postpaid" | "prepaid" | "one_time";
+            /**
+             * @description How the amount is arrived at. `rated` means the rate depends on attributes such as
+             *     region or machine type, and is looked up on a price list.
+             * @enum {string}
+             */
+            billing_scheme: "per_unit" | "tiered" | "rated";
+            /** @description Present for `per_unit`. */
+            unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description `none` for a price that is not tiered, which is most of them.
+             *
+             *     Otherwise `graduated` charges each band at its own rate, and `volume` charges
+             *     everything at the rate of the band the total falls in.
+             * @enum {string}
+             */
+            tiers_mode?: "none" | "graduated" | "volume";
+            /** @description Present for `tiered`, in ascending order. */
+            tiers?: components["schemas"]["Tier"][];
+            /**
+             * Format: uuid
+             * @description For `rated` prices, the price list the rates are read from.
+             */
+            rate_card_id?: string;
+            /** @description The smallest quantity that can be bought. Absent means no lower bound. */
+            min_quantity?: string;
+            /**
+             * @description The largest purchasable quantity. Omitted when no maximum applies. A quantity above this limit is
+             *     rejected with BILLING_PRICE_INVALID and field=max_quantity.
+             */
+            max_quantity?: string;
+            /** @description Quantities must be a multiple of this. Absent means any quantity within the bounds. */
+            quantity_step?: string;
+            /** @description For prepaid prices, how many periods one purchase covers. */
+            interval_count?: number;
+            /** @enum {string} */
+            interval: "none" | "day" | "month" | "year";
+            setup_fee?: components["schemas"]["Money"];
+        };
+        PriceList: {
+            items: components["schemas"]["Price"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        Rate: {
+            meter: components["schemas"]["ObjectIdentity"];
+            /** @description The unit readings arrive in, such as `core-second`. */
+            unit?: string;
+            /** @description The attributes this rate applies to, such as region and machine type. */
+            dimensions: {
+                [key: string]: string;
+            };
+            /** @enum {string} */
+            pricing_model: "per_unit" | "graduated" | "volume";
+            /** @description Present for `per_unit`. Tiered rates carry their amounts on the tiers. */
+            unit_amount?: components["schemas"]["Money"];
+            /** @description Present for `graduated` and `volume`, in ascending order. */
+            tiers?: components["schemas"]["Tier"][];
+            /**
+             * @description How many measured units one amount covers. An hourly rate on a per-second meter is
+             *     `"3600"`.
+             */
+            unit_quantity?: string;
+            currency: string;
+            /** Format: date-time */
+            effective_from: string;
+            /** Format: date-time */
+            effective_to?: string | null;
+        };
+        RateList: {
+            items: components["schemas"]["Rate"][];
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /**
+         * @description Identify a price directly, or select a price for a plan. For each resource give its ID or lookup key, never both. Lookup keys require product_id.
+         *
+         *     A line that gives a meter, `dimensions` or `duration_seconds` estimates usage and is
+         *     priced only at a postpaid price. Such a line is refused with HTTP 400
+         *     `BILLING_PURCHASE_INVALID` when `price_type` is `prepaid` or `one_time`, or when the price
+         *     it names is not postpaid; `meta.field` is `price_type`, `price_id` or `price_lookup_key`
+         *     accordingly. When the plan has no postpaid price, the line is returned unpriced with
+         *     `no_price`.
+         */
+        QuoteLine: {
+            price_lookup_key?: string;
+            plan_lookup_key?: string;
+            meter_lookup_key?: string;
+            /** Format: uuid */
+            price_id?: string;
+            product_id?: components["schemas"]["ProductID"];
+            /** Format: uuid */
+            plan_id?: string;
+            /** Format: uuid */
+            meter_id?: string;
+            /**
+             * @description The attributes the price depends on — region, instance type, token class.
+             *
+             *     Required when the price draws its rates from a price list, which is how anything
+             *     sold by region or by machine type is priced. A price that carries a single unit
+             *     amount, or a ladder, has no attributes to give and takes none.
+             *
+             *     Every attribute the meter declares must be present. A combination with no rate
+             *     covering it is refused rather than priced at zero.
+             */
+            dimensions?: {
+                [key: string]: string;
+            };
+            /**
+             * @description Narrows the selection when a plan offers more than one billing type.
+             * @enum {string}
+             */
+            price_type?: "postpaid" | "prepaid" | "one_time";
+            /** @enum {string} */
+            interval?: "none" | "day" | "month" | "year";
+            interval_count?: number;
+            quantity: string;
+            /**
+             * Format: int64
+             * @description For metered items, how long to price for. This allows an estimate such as "about
+             *     this much per month" to be shown before anything exists. The priced quantity is
+             *     `quantity` multiplied by this duration.
+             */
+            duration_seconds?: number;
+        };
+        EstimateRequest: {
+            /** @description Must be one the catalogue publishes. */
+            currency: string;
+            lines: components["schemas"]["QuoteLine"][];
+        };
+        QuoteLineResult: {
+            /** @description Tax included in the account quote. Absent in public catalogue estimates. */
+            tax_amount?: components["schemas"]["Money"];
+            /** @description Tax already included in the displayed price. */
+            tax_included_amount?: components["schemas"]["Money"];
+            /** @description Which line of the request this answers. */
+            index: number;
+            /**
+             * @description Whether a price was found for this line. Read this before anything else.
+             *
+             *     A single item with no price no longer fails the whole request. A catalogue
+             *     almost always has something not yet priced, and refusing the request would
+             *     leave no way to render a list in which a few entries are simply not on sale.
+             *
+             *     When false, `price_id`, `unit_amount` and `amount` are absent and
+             *     `unpriced_reason` states what is missing.
+             */
+            priced: boolean;
+            /**
+             * @description Why no price was found; `none` while `priced` is true.
+             *
+             *     The last four are told apart because their remedies differ: the price points
+             *     at no price list, the list holds no rate for that meter, that exact combination
+             *     of attributes is not configured, or it is configured but nothing is in effect
+             *     at the moment asked about.
+             * @enum {string}
+             */
+            unpriced_reason?: "none" | "no_price" | "no_rate_card" | "no_meter" | "no_dimensions" | "no_effective_rule";
+            /**
+             * Format: uuid
+             * @description The price selected. Returned whenever `priced` is true, including when the
+             *     request identified the item indirectly, so that the choice can be confirmed.
+             */
+            price_id?: string;
+            plan_name?: string;
+            unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description The quantity actually priced. When `duration_seconds` is given, it is the requested
+             *     `quantity` multiplied by that duration.
+             */
+            quantity?: string;
+            /** @description Not rounded. Round only for display. */
+            amount?: components["schemas"]["Money"];
+            currency: string;
+        };
+        Quote: {
+            lines?: components["schemas"]["QuoteLineResult"][];
+            /**
+             * @description What would be owed in total. Amounts to be returned are not netted off it.
+             *
+             *     Null when any line could not be priced. What would be owed is not knowable then, and a
+             *     total that silently left the unpriced lines out would read as a smaller bill rather than
+             *     an incomplete one — the per-line `priced` flag is easy to skip, a missing total is not.
+             */
+            total?: components["schemas"]["Money"] | null;
+            currency: string;
+        };
+        Tier: {
+            /** @description The upper bound of this band. Null on the last band, which has no bound. */
+            up_to?: string | null;
+            unit_amount: components["schemas"]["Money"];
+            /** @description Charged once when this band is reached, in addition to the per-unit amount. */
+            flat_amount?: components["schemas"]["Money"];
+        };
+        PlanFeature: {
+            feature: components["schemas"]["ObjectIdentity"];
+            name: string;
+        };
+        /** @description A catalog object inlined for display. */
+        ObjectIdentity: {
+            lookup_key?: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+        };
+        /**
+         * @description A decimal string, in the currency stated alongside it.
+         *
+         *     **The currency is not part of this type.** It is carried by a `currency` field next to the
+         *     amount, or by the account the amount belongs to. Reading an amount without that field is
+         *     reading a number with no unit.
+         *
+         *     It is a string rather than a JSON number because a JSON number is a float in most parsers,
+         *     and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+         *     through a float.
+         * @example 10.2500000000
+         */
+        Money: string;
+    };
+    responses: {
+        /** @description Unchanged since the `ETag` that was sent. No body. */
+        NotModified: {
+            headers: {
+                /** @description The same entity tag that was sent. */
+                ETag?: string;
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Error */
+        Error: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+    };
+    parameters: {
+        /**
+         * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+         *     answer is `304` with no body.
+         *
+         *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+         */
+        IfNoneMatch: string;
+        /** @description 1-based page number; the first page when omitted. */
+        Page: number;
+        /** @description How many per page, 100 at most. */
+        PageSize: number;
+        PlanId: string;
+        RateCardId: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "list-prices": {
+        parameters: {
+            query: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                /** @description ISO 4217, three uppercase letters. */
+                currency: string;
+                product_id?: components["schemas"]["ProductID"];
+                /** @description Narrows to one payment timing. */
+                type?: "postpaid" | "prepaid" | "one_time";
+            };
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description Changes whenever this catalog representation changes. */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PriceList"];
+                };
+            };
+            /** @description Not Modified */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-products": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+            };
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /**
+                     * @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
+                     *     to be told `304` instead of receiving the same listing again.
+                     */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProductList"];
+                };
+            };
+            304: components["responses"]["NotModified"];
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-product": {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path: {
+                productId: components["schemas"]["ProductID"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description Changes whenever this catalog representation changes. */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Product"];
+                };
+            };
+            /** @description Not Modified */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-plan": {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path: {
+                planId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description Changes whenever this catalog representation changes. */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Plan"];
+                };
+            };
+            /** @description Not Modified */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "get-price": {
+        parameters: {
+            query?: never;
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path: {
+                priceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /** @description Changes whenever this catalog listing changes. */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Price"];
+                };
+            };
+            /** @description Not Modified */
+            304: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-plans": {
+        parameters: {
+            query: {
+                product_id: components["schemas"]["ProductID"];
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+            };
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /**
+                     * @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
+                     *     to be told `304` instead of receiving the same listing again.
+                     */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlanList"];
+                };
+            };
+            304: components["responses"]["NotModified"];
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-prices-by-plan": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                currency?: string;
+            };
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path: {
+                planId: components["parameters"]["PlanId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /**
+                     * @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
+                     *     to be told `304` instead of receiving the same listing again.
+                     */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PriceList"];
+                };
+            };
+            304: components["responses"]["NotModified"];
+            default: components["responses"]["Error"];
+        };
+    };
+    "list-rates": {
+        parameters: {
+            query?: {
+                /** @description 1-based page number; the first page when omitted. */
+                page?: components["parameters"]["Page"];
+                /** @description How many per page, 100 at most. */
+                page_size?: components["parameters"]["PageSize"];
+                /** @description Filter by the meter UUID. */
+                meter_id?: string;
+                /** @description Return the rates in effect at this moment. Defaults to now. */
+                at?: string;
+            };
+            header?: {
+                /**
+                 * @description The `ETag` from an earlier reply. When the catalogue has not changed since, the
+                 *     answer is `304` with no body.
+                 *
+                 *     Send it on every catalogue read. An unchanged catalogue is answered without a body.
+                 */
+                "If-None-Match"?: components["parameters"]["IfNoneMatch"];
+            };
+            path: {
+                rateCardId: components["parameters"]["RateCardId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    /**
+                     * @description Changes whenever the catalogue changes. Send it back as `If-None-Match`
+                     *     to be told `304` instead of receiving the same listing again.
+                     */
+                    ETag?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RateList"];
+                };
+            };
+            304: components["responses"]["NotModified"];
+            default: components["responses"]["Error"];
+        };
+    };
+    "create-estimate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["EstimateRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Quote"];
+                };
+            };
+            default: components["responses"]["Error"];
+        };
+    };
+}