@leaflow/sdk 0.59.0 → 0.62.0

package/dist/storage/v1/schema.d.ts

@@ -0,0 +1,1694 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/api/v1/backups": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List backups */
+        get: operations["list-backups"];
+        put?: never;
+        /**
+         * Create a backup
+         * @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
+         */
+        post: operations["create-backup"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/backups/{backupId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a backup
+         * @description Queries the current state of the backup, which makes it slower but more accurate than the list endpoint. Use it to poll creation progress.
+         */
+        get: operations["get-backup"];
+        put?: never;
+        post?: never;
+        /**
+         * Delete a backup
+         * @description Independent of the source disk: deletion succeeds whether or not that disk still exists.
+         */
+        delete: operations["delete-backup"];
+        options?: never;
+        head?: never;
+        /** Rename a backup */
+        patch: operations["rename-backup"];
+        trace?: never;
+    };
+    "/api/v1/backups/{backupId}/restore": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Restore from a backup
+         * @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
+         */
+        post: operations["restore-backup"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disk-types": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List disk types on sale
+         * @description Only disk types currently on sale are listed. A withdrawn one disappears from here and can no longer be bought, while the disks already on it keep working and can still be resized.
+         */
+        get: operations["list-disk-types"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disk-types/{diskTypeId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a disk type
+         * @description Retrieve capacity and performance constraints for an existing disk, including system disk types and types withdrawn from sale.
+         */
+        get: operations["get-disk-type"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List disks
+         * @description Lists disks in the current project. Use resource-usages to inspect consumers and pending reservations.
+         */
+        get: operations["list-disks"];
+        put?: never;
+        /**
+         * Create a disk
+         * @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
+         */
+        post: operations["create-disk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disks/{diskId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a disk
+         * @description Returns the disk and its observed state. Read its attachments for consumers, device names and pending attachment operations.
+         */
+        get: operations["get-disk"];
+        put?: never;
+        post?: never;
+        /**
+         * Delete a disk
+         * @description Deletion is rejected while the disk is attached, or while snapshots created from it still exist.
+         */
+        delete: operations["delete-disk"];
+        options?: never;
+        head?: never;
+        /**
+         * Rename a disk
+         * @description Changes the name only. Use the resize endpoint for capacity; type and availability zone are immutable.
+         */
+        patch: operations["rename-disk"];
+        trace?: never;
+    };
+    "/api/v1/disks/{diskId}/resize": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Resize a disk
+         * @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
+         */
+        post: operations["resize-disk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disks/{diskId}/revert": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Revert to a snapshot
+         * @description Restores the contents of the disk to the moment the snapshot was taken. **All data written after that moment is lost and cannot be recovered.**
+         *
+         *     Three restrictions apply: only the most recent snapshot of the disk can be reverted to; the disk must be detached from its instance first; and a disk resized since the snapshot was taken cannot be reverted. To return to an earlier point in time, or to keep the existing disk, create a new disk from the snapshot instead.
+         *
+         *     The revert is not complete when this endpoint returns; poll the retrieve endpoint.
+         */
+        post: operations["revert-disk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/operation-logs": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the operation log of the project
+         * @description Records every write operation in the project: who performed it, when, on what, and whether it succeeded. Read operations are not recorded.
+         *
+         *     **Operations performed by the platform are included, but the individual operator is not disclosed** and `by_platform` is true. Suspension for non-payment and bans for abuse are examples: the time at which an instance was stopped by the platform is needed, whereas the operator is internal information.
+         *
+         *     Fields such as passwords are replaced with a placeholder as the record is written and never appear in `payload`.
+         */
+        get: operations["list-operation-logs"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/snapshots": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List snapshots */
+        get: operations["list-snapshots"];
+        put?: never;
+        /**
+         * Create a snapshot
+         * @description Creates a Billing order, including for metered pricing. The price must belong to the resource’s Billing Plan; applicable contract pricing is resolved by Billing. Technical capacity is checked before sellable quota is reserved. Provisioning continues automatically after payment; do not submit a new purchase after paying. Reuse the original idempotency key after an uncertain response.
+         */
+        post: operations["create-snapshot"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/snapshots/{snapshotId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Retrieve a snapshot */
+        get: operations["get-snapshot"];
+        put?: never;
+        post?: never;
+        /** Delete a snapshot */
+        delete: operations["delete-snapshot"];
+        options?: never;
+        head?: never;
+        /** Rename a snapshot */
+        patch: operations["rename-snapshot"];
+        trace?: never;
+    };
+    "/api/v1/resource-usages": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List resource usages
+         * @description Lists direct consumers, including pending reservations and claims being released. The resource must be readable by the caller. Historical released claims are included only when requested.
+         */
+        get: operations["list-resource-usages"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/resource-usages/{usageId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get resource usage */
+        get: operations["get-resource-usage"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/resources/{resourceType}/{resourceId}/reclamation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get resource reclamation */
+        get: operations["get-resource-reclamation"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/resources/{resourceType}/{resourceId}/idle-policy": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Set resource idle policy
+         * @description Requires permission to delete this resource. Enabling schedules reclamation only after the resource is continuously unreferenced for the requested retention. Existing claims, attachments and unfinished operations always prevent reclamation.
+         */
+        put: operations["set-resource-idle-policy"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/disks/{resourceId}/attachments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List disk attachments
+         * @description Actual attachment state, including operations whose provider outcome is unknown. Use usage_id to locate the corresponding blocking claim.
+         */
+        get: operations["list-disk-attachments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/attachments/{attachmentId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get attachment */
+        get: operations["get-attachment"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        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;
+        };
+        BackupResource: {
+            /** Format: uuid */
+            availability_zone_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** Format: uuid */
+            region_id: string;
+            /**
+             * Format: int64
+             * @description Capacity of the source disk when the backup was created. A restored disk cannot be smaller than this
+             */
+            size_gb: number;
+            /**
+             * Format: uuid
+             * @description The disk this backup was taken from. The backup remains usable after that disk is deleted
+             */
+            source_disk_id: string;
+            /** @enum {string} */
+            status: "provisioning" | "available" | "restoring" | "deleting" | "error";
+            subscription_item_ids?: string[];
+        };
+        BackupListResponseBody: {
+            items: components["schemas"]["BackupResource"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        CreateBackupRequestBody: {
+            /** Format: uuid */
+            disk_id: string;
+            name: string;
+            order: components["schemas"]["OrderOptions"];
+            price: components["schemas"]["CatalogReference"];
+        };
+        RenameBackupRequestBody: {
+            name: string;
+        };
+        RestoreBackupRequestBody: {
+            /**
+             * Format: uuid
+             * @description May differ from the availability zone of the source disk, but must be in the same region. It has to be on sale — restoring creates a new disk, so a withdrawn type is rejected here as well
+             */
+            disk_type_id: string;
+            name: string;
+            /**
+             * Format: int64
+             * @description Matches the size of the backup when omitted. When given, it must not be smaller than the backup
+             */
+            size_gb?: number;
+            order: components["schemas"]["OrderOptions"];
+            price: components["schemas"]["CatalogReference"];
+        };
+        DiskResource: {
+            /** Format: uuid */
+            availability_zone_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: uuid */
+            disk_type_id: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** Format: uuid */
+            region_id: string;
+            /** Format: int64 */
+            size_gb: number;
+            /**
+             * Format: int64
+             * @description IOPS this disk is allowed. Null when its type is not rate-limited.
+             *
+             *     Computed from the disk's own capacity, so it grows when the disk is grown — but see the
+             *     note on the resize endpoint: growing a disk that is attached is refused, precisely because
+             *     the new figure would not take effect until it was attached again.
+             */
+            iops: number | null;
+            /**
+             * Format: int64
+             * @description Throughput this disk is allowed, in bytes per second. Null when its type is not rate-limited
+             */
+            throughput_bytes_per_sec: number | null;
+            /** @enum {string} */
+            status: "provisioning" | "available" | "attaching" | "in_use" | "detaching" | "resizing" | "reverting" | "restoring" | "releasing" | "deleting" | "error";
+            subscription_item_ids?: string[];
+        };
+        DiskTypeResource: {
+            /** Format: uuid */
+            availability_zone_id: string;
+            /** Format: uuid */
+            id: string;
+            /**
+             * Format: int64
+             * @description IOPS a disk of `min_size_gb` gets. Null when this type is not rate-limited.
+             *
+             *     Performance grows with capacity, so this and `iops_at_max_size` are the two ends of the
+             *     range. The exact figure for the size actually bought appears on the disk itself once it
+             *     exists.
+             */
+            iops_at_min_size: number | null;
+            /**
+             * Format: int64
+             * @description IOPS a disk of `max_size_gb` gets. Null when this type is not rate-limited
+             */
+            iops_at_max_size: number | null;
+            /** Format: int64 */
+            max_size_gb: number;
+            /** @enum {string} */
+            media: "ssd" | "hdd" | "nvme";
+            /** Format: int64 */
+            min_size_gb: number;
+            name: string;
+            /** Format: uuid */
+            region_id: string;
+            /** Format: int64 */
+            step_gb: number;
+            /**
+             * Format: int64
+             * @description Throughput a disk of `min_size_gb` gets, in **bytes per second**. Null when this type is
+             *     not rate-limited.
+             *
+             *     Bytes rather than MiB so the number needs no rounding on the way out; divide by 1048576
+             *     for MiB/s at the point of display.
+             */
+            throughput_at_min_size: number | null;
+            /**
+             * Format: int64
+             * @description Throughput a disk of `max_size_gb` gets, in bytes per second. Null when this type is not rate-limited
+             */
+            throughput_at_max_size: number | null;
+            /**
+             * Format: uuid
+             * @description The Billing Plan for this type. Read its available prices from Billing; resource capacity and sellable quota are evaluated when placing the order.
+             */
+            billing_plan_id: string;
+        };
+        DiskTypeListResponseBody: {
+            items: components["schemas"]["DiskTypeResource"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        DiskListResponseBody: {
+            items: components["schemas"]["DiskResource"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        CreateDiskRequestBody: {
+            /**
+             * Format: uuid
+             * @description A disk type currently on sale. A withdrawn one is rejected even though its identifier still resolves
+             */
+            disk_type_id: string;
+            name: string;
+            /** Format: int64 */
+            size_gb: number;
+            /**
+             * Format: uuid
+             * @description Restore from this snapshot. When given, the capacity need only be no smaller than the snapshot
+             */
+            snapshot_id?: string;
+            order: components["schemas"]["OrderOptions"];
+            price: components["schemas"]["CatalogReference"];
+        };
+        RenameDiskRequestBody: {
+            name: string;
+        };
+        ResizeDiskRequestBody: {
+            /**
+             * Format: int64
+             * @description Must be larger than the current capacity
+             */
+            size_gb: number;
+            order: components["schemas"]["OrderOptions"];
+            price: components["schemas"]["CatalogReference"];
+        };
+        RevertDiskRequestBody: {
+            /**
+             * Format: uuid
+             * @description Must be the most recent snapshot of the disk
+             */
+            snapshot_id: string;
+        };
+        OperationLogResource: {
+            /** @description Name of the operation; matches the operation id of the endpoint */
+            action: string;
+            /** @description The user who initiated the operation. Empty when the platform performed it */
+            actor: string | null;
+            /**
+             * @description The name this user went by at the time of the operation, recorded alongside the operation itself. It is not refreshed afterwards: the record states who acted then, and a name read today is a statement about a different moment.
+             *
+             *     Null on entries recorded before this field existed, and on entries performed by the platform. An empty string means the account had no name recorded.
+             */
+            actor_name: string | null;
+            /** @description True when the operation was performed by the platform */
+            by_platform: boolean;
+            /** Format: date-time */
+            created_at: string;
+            /** @description Brief reason for the failure */
+            failure: string | null;
+            /** Format: uuid */
+            id: string;
+            /** @description Path and query parameters of the request. Fields such as passwords are redacted */
+            payload: {
+                [key: string]: unknown;
+            };
+            /** Format: uuid */
+            region_id: string | null;
+            /** @description Empty for create operations: the id of the new resource is in the response, not in the request path */
+            subject_id: string;
+            subject_type: string;
+            succeeded: boolean;
+        };
+        OperationLogListResponseBody: {
+            items: components["schemas"]["OperationLogResource"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        SnapshotResource: {
+            /** Format: uuid */
+            availability_zone_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: uuid */
+            disk_id: string;
+            /** Format: uuid */
+            id: string;
+            name: string;
+            /** Format: uuid */
+            region_id: string;
+            /**
+             * Format: int64
+             * @description Capacity of the source disk when the snapshot was created. A disk restored from it cannot be smaller
+             */
+            size_gb: number;
+            /** @enum {string} */
+            status: "provisioning" | "available" | "restoring" | "deleting" | "error";
+            subscription_item_ids?: string[];
+        };
+        SnapshotListResponseBody: {
+            items: components["schemas"]["SnapshotResource"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        CreateSnapshotRequestBody: {
+            /** Format: uuid */
+            disk_id: string;
+            name: string;
+            order: components["schemas"]["OrderOptions"];
+            price: components["schemas"]["CatalogReference"];
+        };
+        RenameSnapshotRequestBody: {
+            name: string;
+        };
+        /** @description Reuse the same key for retries of the same purchase. Reusing it with a different request fails. Billing selects contract pricing, applies eligible grants and promotions, and owns payment challenges and expiry. */
+        OrderOptions: {
+            idempotency_key: string;
+            payment_plan?: components["schemas"]["PaymentPlan"];
+            expected_amount?: string;
+            redemption_code?: string;
+        };
+        /** @description Specify exactly one of id or lookup_key. A lookup key is scoped to the product of the resource service. */
+        CatalogReference: {
+            /** Format: uuid */
+            id?: string;
+            lookup_key?: string;
+        };
+        /**
+         * @description A billable order has been created. Read it from the billing API to find out what is
+         *     owed and whether payment is still required.
+         *
+         *     Only the identifier is returned. Amounts and state are not repeated here; the order
+         *     itself is the single source for them.
+         */
+        PlacedOrder: {
+            /**
+             * Format: uuid
+             * @description Identifies the order. Use it to read the order and, where payment is required,
+             *     to pay it.
+             *
+             *     An order is created even when nothing is owed, such as a plan with no charge or one
+             *     covered entirely by granted credit. Such an order is already settled, and no
+             *     payment step applies.
+             */
+            order_id: string;
+        };
+        /** @description An authoritative claim held by the resource owner. Reserved, active and releasing claims all prevent idle reclamation. Stopped consumers retain their claims. Released claims remain readable. */
+        ResourceUsage: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            project_id: string;
+            resource: components["schemas"]["ResourceReference"];
+            consumer: components["schemas"]["ResourceReference"];
+            purpose: string;
+            /** @enum {string} */
+            state: "reserved" | "active" | "releasing" | "released";
+            /** Format: int64 */
+            generation: number;
+            /** Format: uuid */
+            operation_id: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+            /** Format: date-time */
+            released_at?: string;
+        };
+        ResourceUsageList: {
+            items: components["schemas"]["ResourceUsage"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /** @description Automatic reclamation is disabled by default. When enabled, retention starts after the last live claim is confirmed released. Traffic, IO and consumer heartbeats do not affect eligibility. */
+        IdlePolicy: {
+            /** @default false */
+            enabled: boolean;
+            /** Format: int64 */
+            retention_seconds: number;
+        };
+        ReclamationState: {
+            resource: components["schemas"]["ResourceReference"];
+            policy: components["schemas"]["IdlePolicy"];
+            /** Format: int64 */
+            active_usage_count: number;
+            /** Format: date-time */
+            unreferenced_at?: string;
+            /** Format: date-time */
+            eligible_at?: string;
+            /** @enum {string} */
+            status: "retained" | "in_use" | "idle" | "reclaiming" | "deleted";
+            blocked_reasons: string[];
+        };
+        Attachment: {
+            /** Format: uuid */
+            id: string;
+            /** Format: uuid */
+            usage_id: string;
+            resource: components["schemas"]["ResourceReference"];
+            consumer: components["schemas"]["ResourceReference"];
+            /** @enum {string} */
+            state: "reserved" | "attaching" | "attached" | "detaching" | "detached" | "unknown";
+            /** Format: int64 */
+            generation: number;
+            device?: string;
+            read_only: boolean;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        AttachmentList: {
+            items: components["schemas"]["Attachment"][];
+            /** Format: int64 */
+            page: number;
+            /** Format: int64 */
+            page_size: number;
+            /** Format: int64 */
+            total_count?: number;
+        };
+        /** @description Requested funding split. This does not select a card or payment provider; complete payment through Billing. */
+        PaymentPlan: {
+            balance_amount: string;
+            provider_amount: string;
+        };
+        /** @description A resource identified within its owning service. The project is taken from the containing usage or request. */
+        ResourceReference: {
+            service: string;
+            type: string;
+            /** Format: uuid */
+            id: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    "list-backups": {
+        parameters: {
+            query?: {
+                /** @description Return only the backups of this disk */
+                disk_id?: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BackupListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateBackupRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlacedOrder"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                backupId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BackupResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "delete-backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                backupId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "rename-backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                backupId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenameBackupRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BackupResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "restore-backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                backupId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RestoreBackupRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlacedOrder"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-disk-types": {
+        parameters: {
+            query: {
+                region_id: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskTypeListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-disk-type": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskTypeId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskTypeResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-disks": {
+        parameters: {
+            query?: {
+                region_id?: string;
+                /** @description Supplied together with `region_id` to filter attachable disks */
+                availability_zone_id?: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDiskRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlacedOrder"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "delete-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "rename-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenameDiskRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "resize-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ResizeDiskRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlacedOrder"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "revert-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                diskId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RevertDiskRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DiskResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-operation-logs": {
+        parameters: {
+            query?: {
+                /** @description Return a single kind of operation; the value matches the operation id of the endpoint */
+                action?: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationLogListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-snapshots": {
+        parameters: {
+            query?: {
+                /** @description Return only the snapshots of this disk */
+                disk_id?: string;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnapshotListResponseBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "create-snapshot": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSnapshotRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PlacedOrder"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-snapshot": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                snapshotId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnapshotResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "delete-snapshot": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                snapshotId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "rename-snapshot": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                snapshotId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RenameSnapshotRequestBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SnapshotResource"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-resource-usages": {
+        parameters: {
+            query: {
+                resource_type: string;
+                resource_id: string;
+                include_released?: boolean;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ResourceUsageList"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-resource-usage": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                usageId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ResourceUsage"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-resource-reclamation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                resourceType: string;
+                resourceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReclamationState"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "set-resource-idle-policy": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                resourceType: string;
+                resourceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IdlePolicy"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ReclamationState"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-disk-attachments": {
+        parameters: {
+            query?: {
+                page?: number;
+                page_size?: number;
+                include_detached?: boolean;
+            };
+            header?: never;
+            path: {
+                resourceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AttachmentList"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "get-attachment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                attachmentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Attachment"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+}