@leaflow/sdk 0.171.0 → 0.173.1

package/dist/swas/v1/generated/models.d.ts

@@ -0,0 +1,426 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow SWAS API
+ * Manage SWAS purchases and instances in the current project. Use an IAM scoped token for every request. Amounts are decimal strings in the stated currency; timestamps are UTC RFC 3339. Accepted requests may still be in progress. Read purchase, operation and refund progress separately.
+ * OpenAPI spec version: 1.0.0
+ */
+/**
+ * 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.
+ */
+export type Money = string;
+/**
+ * A non-negative decimal amount with at most 15 integer digits and 10 fractional digits.
+ */
+export type DecimalAmount = Money & string;
+export interface ExpectedQuote {
+    currency: "USD";
+    amount: DecimalAmount;
+}
+export interface PurchaseCreate {
+    /**
+     * @minimum 1
+     * @maximum 9007199254740991
+     */
+    catalog_revision: number;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    provider_plan_id: string;
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    billing_price_id: string;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    image_id: string;
+    quantity: 1;
+    expected_quote: ExpectedQuote;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    region_id: string;
+}
+export type PurchaseState = (typeof PurchaseState)[keyof typeof PurchaseState];
+export declare const PurchaseState: {
+    readonly submitted: "submitted";
+    readonly checkout_create_reserved: "checkout_create_reserved";
+    readonly checkout_unknown: "checkout_unknown";
+    readonly checkout_open: "checkout_open";
+    readonly order_ready: "order_ready";
+    readonly accept_unknown: "accept_unknown";
+    readonly accepted: "accepted";
+    readonly create_unknown: "create_unknown";
+    readonly awaiting_delivery: "awaiting_delivery";
+    readonly delivered: "delivered";
+    readonly settle_unknown: "settle_unknown";
+    readonly completed: "completed";
+    readonly rejected: "rejected";
+    readonly provider_rejected: "provider_rejected";
+};
+/**
+ * Durable purchase progress. delivered and billing_settled describe different facts. Acceptance is not cloud delivery or checkout completion.
+ */
+export interface Purchase {
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    id: string;
+    state: PurchaseState;
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    checkout_session_id: string;
+    delivered: boolean;
+    billing_settled: boolean;
+}
+export type PricePeriodMonths = (typeof PricePeriodMonths)[keyof typeof PricePeriodMonths] | null;
+export declare const PricePeriodMonths: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_3: 3;
+    readonly NUMBER_6: 6;
+    readonly NUMBER_12: 12;
+    readonly NUMBER_24: 24;
+    readonly NUMBER_36: 36;
+};
+export interface Price {
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    billing_plan_id: string;
+    /** @pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ */
+    billing_price_id: string;
+    currency: "USD";
+    amount: DecimalAmount;
+    period_months: PricePeriodMonths;
+}
+export interface Plan {
+    provider_plan_id: string;
+    region_id: string;
+    name: string;
+    /** @minimum 1 */
+    catalog_revision: number;
+    buyable: boolean;
+    price: Price | null;
+    /**
+     * @minItems 1
+     * @maxItems 256
+     */
+    image_ids: string[];
+    /** @minimum 1 */
+    cpu: number;
+    /** @minimum 1 */
+    memory_mb: number;
+    /** @minimum 1 */
+    disk_gb: number;
+}
+/**
+ * Bounded catalog snapshot for one requested region. Incomplete or unavailable price information is not a purchasable offer.
+ */
+export interface Catalog {
+    items: Plan[];
+    /** UTC RFC 3339 timestamp. */
+    source_observed_at: string;
+    complete: boolean;
+}
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+export type InstancePricePeriodMonths = (typeof InstancePricePeriodMonths)[keyof typeof InstancePricePeriodMonths];
+export declare const InstancePricePeriodMonths: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_3: 3;
+    readonly NUMBER_6: 6;
+    readonly NUMBER_12: 12;
+    readonly NUMBER_24: 24;
+    readonly NUMBER_36: 36;
+};
+export interface InstancePrice {
+    currency: "USD";
+    amount: DecimalAmount;
+    period_months: InstancePricePeriodMonths;
+}
+export declare const InstanceCapabilitiesValue: {
+    readonly manage: false;
+    readonly customer_refund: false;
+    readonly supplier_refund: false;
+    readonly release: false;
+};
+export type InstanceCapabilities = typeof InstanceCapabilitiesValue;
+export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus];
+export declare const InstanceStatus: {
+    readonly Pending: "Pending";
+    readonly Starting: "Starting";
+    readonly Running: "Running";
+    readonly Stopping: "Stopping";
+    readonly Stopped: "Stopped";
+    readonly Resetting: "Resetting";
+    readonly Upgrading: "Upgrading";
+    readonly Disabled: "Disabled";
+    readonly Unknown: "Unknown";
+};
+export type InstanceBusinessStatus = (typeof InstanceBusinessStatus)[keyof typeof InstanceBusinessStatus];
+export declare const InstanceBusinessStatus: {
+    readonly Normal: "Normal";
+    readonly Expired: "Expired";
+    readonly Overdue: "Overdue";
+    readonly Unknown: "Unknown";
+};
+export type InstanceObservation = (typeof InstanceObservation)[keyof typeof InstanceObservation];
+export declare const InstanceObservation: {
+    readonly present: "present";
+    readonly missing: "missing";
+};
+export interface Instance {
+    id: string;
+    purchase_id: string;
+    project_id: string;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    region_id: string;
+    /** @maxLength 128 */
+    provider_plan_id: string;
+    /** @maxLength 128 */
+    image_id: string;
+    status: InstanceStatus;
+    business_status: InstanceBusinessStatus;
+    observation: InstanceObservation;
+    created_at: string | null;
+    expires_at: string | null;
+    original_price: InstancePrice;
+    /** UTC RFC 3339 timestamp. */
+    source_observed_at: string;
+    /**
+     * @minimum 1
+     * @maximum 9007199254740991
+     */
+    sync_revision: number;
+    capabilities: InstanceCapabilities;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+export type InstancePagination = OffsetPagination;
+export interface InstanceList {
+    /** @maxItems 200 */
+    items: Instance[];
+    pagination: OffsetPagination;
+}
+export interface StartInstance {
+    [key: string]: unknown;
+}
+export type ManagementOperationAction = (typeof ManagementOperationAction)[keyof typeof ManagementOperationAction];
+export declare const ManagementOperationAction: {
+    readonly start: "start";
+    readonly stop: "stop";
+    readonly reboot: "reboot";
+};
+export type ManagementOperationState = (typeof ManagementOperationState)[keyof typeof ManagementOperationState];
+export declare const ManagementOperationState: {
+    readonly queued: "queued";
+    readonly dispatch_unknown: "dispatch_unknown";
+    readonly provider_ack: "provider_ack";
+    readonly completed: "completed";
+};
+export type ManagementOperationLastObservedStatus = (typeof ManagementOperationLastObservedStatus)[keyof typeof ManagementOperationLastObservedStatus];
+export declare const ManagementOperationLastObservedStatus: {
+    readonly Stopped: "Stopped";
+    readonly Running: "Running";
+    readonly Starting: "Starting";
+};
+/**
+ * Observed reboot progress. running_observed_at is null until a later Running observation is available.
+ */
+export interface RebootCycle {
+    /** UTC RFC 3339 timestamp. */
+    starting_observed_at: string;
+    running_observed_at: string | null;
+}
+/**
+ * Read state to follow the operation. For a reboot, reboot_cycle records a Starting observation followed by a later Running observation. A missing cycle or null running time does not confirm completion.
+ */
+export interface ManagementOperation {
+    id: string;
+    purchase_id: string;
+    action: ManagementOperationAction;
+    state: ManagementOperationState;
+    last_observed_status: ManagementOperationLastObservedStatus;
+    /** UTC RFC 3339 timestamp. */
+    created_at: string;
+    /** UTC RFC 3339 timestamp. */
+    updated_at: string;
+    reboot_cycle?: RebootCycle;
+}
+export interface StopInstance {
+    [key: string]: unknown;
+}
+export interface CustomerRefundProgress {
+    state: "unknown";
+    reason: "billing_refund_reader_unavailable";
+    /** @nullable */
+    amount: null;
+    /** @nullable */
+    currency: null;
+}
+export declare const SupplierRefundProgressValue: {
+    readonly state: "not_observed";
+    readonly reason: "supplier_refund_not_queried";
+};
+export type SupplierRefundProgress = typeof SupplierRefundProgressValue;
+export type RefundProgressCancellationState = (typeof RefundProgressCancellationState)[keyof typeof RefundProgressCancellationState];
+export declare const RefundProgressCancellationState: {
+    readonly requested: "requested";
+    readonly scheduled: "scheduled";
+    readonly releasing: "releasing";
+    readonly completed: "completed";
+    readonly canceled: "canceled";
+    readonly failed: "failed";
+};
+/**
+ * Cancellation and refund progress are independent. Unknown money amounts and currencies are null; cancellation completion does not confirm cash settlement.
+ */
+export interface RefundProgress {
+    purchase_id: string;
+    cancellation_id: string;
+    cancellation_state: RefundProgressCancellationState;
+    customer_refund: CustomerRefundProgress;
+    supplier_refund: SupplierRefundProgress;
+    /** UTC RFC 3339 timestamp. */
+    observed_at: string;
+}
+export interface RebootInstance {
+    [key: string]: unknown;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export type ListPlansParams = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    region_id: string;
+};
+export type CreatePurchaseHeaders = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    "Idempotency-Key": string;
+};
+export type ListInstancesParams = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    region_id: string;
+    /**
+     * 1-based page number. Defaults to 1.
+     * @minimum 1
+     * @maximum 2147483647
+     */
+    page?: number;
+    /**
+     * Items per page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    page_size?: number;
+};
+export type StartInstanceHeaders = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    "Idempotency-Key": string;
+};
+export type StopInstanceHeaders = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    "Idempotency-Key": string;
+};
+export type RebootInstanceHeaders = {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    "Idempotency-Key": string;
+};

package/dist/swas/v1/generated/models.js

@@ -0,0 +1,87 @@
+export const PurchaseState = {
+    submitted: "submitted",
+    checkout_create_reserved: "checkout_create_reserved",
+    checkout_unknown: "checkout_unknown",
+    checkout_open: "checkout_open",
+    order_ready: "order_ready",
+    accept_unknown: "accept_unknown",
+    accepted: "accepted",
+    create_unknown: "create_unknown",
+    awaiting_delivery: "awaiting_delivery",
+    delivered: "delivered",
+    settle_unknown: "settle_unknown",
+    completed: "completed",
+    rejected: "rejected",
+    provider_rejected: "provider_rejected",
+};
+export const PricePeriodMonths = {
+    NUMBER_1: 1,
+    NUMBER_3: 3,
+    NUMBER_6: 6,
+    NUMBER_12: 12,
+    NUMBER_24: 24,
+    NUMBER_36: 36,
+};
+export const InstancePricePeriodMonths = {
+    NUMBER_1: 1,
+    NUMBER_3: 3,
+    NUMBER_6: 6,
+    NUMBER_12: 12,
+    NUMBER_24: 24,
+    NUMBER_36: 36,
+};
+export const InstanceCapabilitiesValue = {
+    manage: false,
+    customer_refund: false,
+    supplier_refund: false,
+    release: false,
+};
+export const InstanceStatus = {
+    Pending: "Pending",
+    Starting: "Starting",
+    Running: "Running",
+    Stopping: "Stopping",
+    Stopped: "Stopped",
+    Resetting: "Resetting",
+    Upgrading: "Upgrading",
+    Disabled: "Disabled",
+    Unknown: "Unknown",
+};
+export const InstanceBusinessStatus = {
+    Normal: "Normal",
+    Expired: "Expired",
+    Overdue: "Overdue",
+    Unknown: "Unknown",
+};
+export const InstanceObservation = {
+    present: "present",
+    missing: "missing",
+};
+export const ManagementOperationAction = {
+    start: "start",
+    stop: "stop",
+    reboot: "reboot",
+};
+export const ManagementOperationState = {
+    queued: "queued",
+    dispatch_unknown: "dispatch_unknown",
+    provider_ack: "provider_ack",
+    completed: "completed",
+};
+export const ManagementOperationLastObservedStatus = {
+    Stopped: "Stopped",
+    Running: "Running",
+    Starting: "Starting",
+};
+export const SupplierRefundProgressValue = {
+    state: "not_observed",
+    reason: "supplier_refund_not_queried",
+};
+export const RefundProgressCancellationState = {
+    requested: "requested",
+    scheduled: "scheduled",
+    releasing: "releasing",
+    completed: "completed",
+    canceled: "canceled",
+    failed: "failed",
+};

package/dist/swas/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow SWAS API
+ * Manage SWAS purchases and instances in the current project. Use an IAM scoped token for every request. Amounts are decimal strings in the stated currency; timestamps are UTC RFC 3339. Accepted requests may still be in progress. Read purchase, operation and refund progress separately.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * Lists available plans and prices for the requested region. A plan without a price is not available to buy.
+ * @summary List plans
+ */
+export declare const listPlansQueryRegionIdMax = 128;
+export declare const ListPlansQueryParams: zod.ZodObject<{
+    region_id: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Creates a purchase using the current catalog revision and expected price. Reuse the same Idempotency-Key after a timeout. Acceptance is not confirmation of payment or instance delivery.
+ * @summary Create purchase
+ */
+export declare const createPurchaseHeaderIdempotencyKeyMax = 128;
+export declare const CreatePurchaseHeader: zod.ZodObject<{
+    "Idempotency-Key": zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const CreatePurchaseBody: zod.ZodObject<{
+    catalog_revision: zod.ZodInt;
+    provider_plan_id: zod.ZodString;
+    billing_price_id: zod.ZodUUID;
+    image_id: zod.ZodString;
+    quantity: zod.ZodLiteral<1>;
+    expected_quote: zod.ZodObject<{
+        currency: zod.ZodLiteral<"USD">;
+        amount: zod.ZodIntersection<zod.ZodString, zod.ZodString>;
+    }, zod.z.core.$strict>;
+    region_id: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Returns purchase, delivery and Billing progress. Payment and instance delivery may finish at different times.
+ * @summary Get purchase
+ */
+export declare const getPurchasePathPurchaseIdRegExp: RegExp;
+export declare const GetPurchaseParams: zod.ZodObject<{
+    purchaseId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Lists the current project's instances in the requested region. Pagination uses page and page_size; total_count is returned when known.
+ * @summary List instances
+ */
+export declare const listInstancesQueryRegionIdMax = 128;
+export declare const listInstancesQueryPageDefault = 1;
+export declare const listInstancesQueryPageMax = 2147483647;
+export declare const listInstancesQueryPageSizeDefault = 50;
+export declare const listInstancesQueryPageSizeMax = 200;
+export declare const ListInstancesQueryParams: zod.ZodObject<{
+    region_id: zod.ZodString;
+    page: zod.ZodDefault<zod.ZodInt>;
+    page_size: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * Returns an instance and its most recently observed status.
+ * @summary Get instance
+ */
+export declare const GetInstanceParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Starts an existing instance. Returns an operation to poll; acceptance is not completion.
+ * @summary Start instance
+ */
+export declare const StartInstanceParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const startInstanceHeaderIdempotencyKeyMax = 128;
+export declare const StartInstanceHeader: zod.ZodObject<{
+    "Idempotency-Key": zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const StartInstanceBody: zod.ZodObject<{}, zod.z.core.$strict>;
+/**
+ * Returns management progress for the specified instance. Unknown progress is not confirmation of success; do not repeat an operation solely because its outcome is unknown.
+ * @summary Get instance operation
+ */
+export declare const GetInstanceOperationParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+    operationId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Stops an existing instance. Returns an operation to poll; acceptance is not completion.
+ * @summary Stop instance
+ */
+export declare const StopInstanceParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const stopInstanceHeaderIdempotencyKeyMax = 128;
+export declare const StopInstanceHeader: zod.ZodObject<{
+    "Idempotency-Key": zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const StopInstanceBody: zod.ZodObject<{}, zod.z.core.$strict>;
+/**
+ * Returns cancellation and refund progress for the specified instance. Unknown refund amounts and currencies are null. A completed cancellation does not confirm that money has been returned.
+ * @summary Get cancellation refund progress
+ */
+export declare const GetCancellationRefundProgressParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+    cancellationId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Reboots an existing instance. Returns an operation to poll; an unchanged Running status does not confirm completion.
+ * @summary Reboot instance
+ */
+export declare const RebootInstanceParams: zod.ZodObject<{
+    instanceId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const rebootInstanceHeaderIdempotencyKeyMax = 128;
+export declare const RebootInstanceHeader: zod.ZodObject<{
+    "Idempotency-Key": zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const RebootInstanceBody: zod.ZodObject<{}, zod.z.core.$strict>;