@rivetkit/engine-api-full 2.0.4-rc.1

package/types/api/resources/metadata/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/types/api/resources/metadata/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/types/api/resources/namespaces/client/Client.d.ts

@@ -0,0 +1,48 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as Rivet from "../../../index";
+export declare namespace Namespaces {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Namespaces {
+    protected readonly _options: Namespaces.Options;
+    constructor(_options: Namespaces.Options);
+    /**
+     * @param {Rivet.NamespacesListRequest} request
+     * @param {Namespaces.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.namespaces.list()
+     */
+    list(request?: Rivet.NamespacesListRequest, requestOptions?: Namespaces.RequestOptions): Promise<Rivet.NamespaceListResponse>;
+    /**
+     * @param {Rivet.NamespacesCreateRequest} request
+     * @param {Namespaces.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.namespaces.create({
+     *         displayName: "display_name",
+     *         name: "name"
+     *     })
+     */
+    create(request: Rivet.NamespacesCreateRequest, requestOptions?: Namespaces.RequestOptions): Promise<Rivet.NamespacesCreateResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

package/types/api/resources/namespaces/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/types/api/resources/namespaces/client/requests/NamespacesCreateRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         displayName: "display_name",
+ *         name: "name"
+ *     }
+ */
+export interface NamespacesCreateRequest {
+    displayName: string;
+    name: string;
+}

package/types/api/resources/namespaces/client/requests/NamespacesListRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface NamespacesListRequest {
+    limit?: number;
+    cursor?: string;
+    name?: string;
+    /**
+     * Deprecated.
+     */
+    namespaceIds?: string;
+    namespaceId?: Rivet.RivetId | Rivet.RivetId[];
+}

package/types/api/resources/namespaces/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type NamespacesListRequest } from "./NamespacesListRequest";
+export { type NamespacesCreateRequest } from "./NamespacesCreateRequest";

package/types/api/resources/namespaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/types/api/resources/runners/client/Client.d.ts

@@ -0,0 +1,54 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import * as Rivet from "../../../index";
+export declare namespace Runners {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Runners {
+    protected readonly _options: Runners.Options;
+    constructor(_options: Runners.Options);
+    /**
+     * @param {Rivet.RunnersListRequest} request
+     * @param {Runners.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.runners.list({
+     *         namespace: "namespace"
+     *     })
+     */
+    list(request: Rivet.RunnersListRequest, requestOptions?: Runners.RequestOptions): Promise<Rivet.RunnersListResponse>;
+    /**
+     * 2 round trips:
+     *
+     * - GET /runners/names (fanout)
+     * - [api-peer] namespace::ops::resolve_for_name_global
+     *
+     * @param {Rivet.RunnersListNamesRequest} request
+     * @param {Runners.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.runners.listNames({
+     *         namespace: "namespace"
+     *     })
+     */
+    listNames(request: Rivet.RunnersListNamesRequest, requestOptions?: Runners.RequestOptions): Promise<Rivet.RunnersListNamesResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

package/types/api/resources/runners/client/index.d.ts

@@ -0,0 +1 @@
+export * from "./requests";

package/types/api/resources/runners/client/requests/RunnersListNamesRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         namespace: "namespace"
+ *     }
+ */
+export interface RunnersListNamesRequest {
+    namespace: string;
+    limit?: number;
+    cursor?: string;
+}

package/types/api/resources/runners/client/requests/RunnersListRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../../../../index";
+/**
+ * @example
+ *     {
+ *         namespace: "namespace"
+ *     }
+ */
+export interface RunnersListRequest {
+    namespace: string;
+    name?: string;
+    /**
+     * Deprecated.
+     */
+    runnerIds?: string;
+    runnerId?: Rivet.RivetId | Rivet.RivetId[];
+    includeStopped?: boolean;
+    limit?: number;
+    cursor?: string;
+}

package/types/api/resources/runners/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type RunnersListRequest } from "./RunnersListRequest";
+export { type RunnersListNamesRequest } from "./RunnersListNamesRequest";

package/types/api/resources/runners/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/types/api/types/Actor.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Actor {
+    actorId: Rivet.RivetId;
+    /** Denotes when the actor was last connectable. Null if actor is not running. */
+    connectableTs?: number;
+    crashPolicy: Rivet.CrashPolicy;
+    /** Denotes when the actor was first created. */
+    createTs: number;
+    datacenter: string;
+    /** Denotes when the actor was destroyed. */
+    destroyTs?: number;
+    /** Error details if the actor failed to start. */
+    error?: Record<string, unknown>;
+    key?: string;
+    name: string;
+    namespaceId: Rivet.RivetId;
+    /** Denotes when the actor started waiting for an allocation. */
+    pendingAllocationTs?: number;
+    /**
+     * Denotes when the actor will try to allocate again. If this is set, the actor will not attempt to
+     * allocate until the given timestamp.
+     */
+    rescheduleTs?: number;
+    runnerNameSelector: string;
+    /** Denotes when the actor entered a sleeping state. */
+    sleepTs?: number;
+    /** Denotes when the actor was first made connectable. Null if never. */
+    startTs?: number;
+}

package/types/api/types/ActorName.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActorName {
+    metadata: Record<string, unknown>;
+}

package/types/api/types/ActorsCreateResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsCreateResponse {
+    actor: Rivet.Actor;
+}

package/types/api/types/ActorsDeleteResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ActorsDeleteResponse = Record<string, unknown>;

package/types/api/types/ActorsGetOrCreateResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsGetOrCreateResponse {
+    actor: Rivet.Actor;
+    created: boolean;
+}

package/types/api/types/ActorsKvGetResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActorsKvGetResponse {
+    updateTs: number;
+    value: string;
+}

package/types/api/types/ActorsListNamesResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsListNamesResponse {
+    names: Record<string, Rivet.ActorName>;
+    pagination: Rivet.Pagination;
+}

package/types/api/types/ActorsListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface ActorsListResponse {
+    actors: Rivet.Actor[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/CrashPolicy.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CrashPolicy = "restart" | "sleep" | "destroy";
+export declare const CrashPolicy: {
+    readonly Restart: "restart";
+    readonly Sleep: "sleep";
+    readonly Destroy: "destroy";
+};

package/types/api/types/Datacenter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Datacenter {
+    label: number;
+    name: string;
+    url: string;
+}

package/types/api/types/DatacenterHealth.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface DatacenterHealth {
+    datacenterLabel: number;
+    datacenterName: string;
+    error?: string;
+    response?: Rivet.HealthResponse;
+    rttMs?: number;
+    status: Rivet.HealthStatus;
+}

package/types/api/types/DatacentersListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface DatacentersListResponse {
+    datacenters: Rivet.Datacenter[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/HealthFanoutResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface HealthFanoutResponse {
+    datacenters: Rivet.DatacenterHealth[];
+}

package/types/api/types/HealthResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface HealthResponse {
+    runtime: string;
+    status: string;
+    version: string;
+}

package/types/api/types/HealthStatus.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type HealthStatus = "ok" | "error";
+export declare const HealthStatus: {
+    readonly Ok: "ok";
+    readonly Error: "error";
+};

package/types/api/types/MetadataGetResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface MetadataGetResponse {
+    buildTimestamp: string;
+    cargoProfile: string;
+    cargoTarget: string;
+    gitSha: string;
+    runtime: string;
+    rustcHost: string;
+    rustcVersion: string;
+    version: string;
+}

package/types/api/types/Namespace.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Namespace {
+    createTs: number;
+    displayName: string;
+    name: string;
+    namespaceId: Rivet.RivetId;
+}

package/types/api/types/NamespaceListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface NamespaceListResponse {
+    namespaces: Rivet.Namespace[];
+    pagination: Rivet.Pagination;
+}

package/types/api/types/NamespacesCreateResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface NamespacesCreateResponse {
+    namespace: Rivet.Namespace;
+}

package/types/api/types/Pagination.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Pagination {
+    cursor?: string;
+}

package/types/api/types/RivetId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RivetId = string;

package/types/api/types/Runner.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface Runner {
+    createTs: number;
+    datacenter: string;
+    drainTs?: number;
+    key: string;
+    lastConnectedTs?: number;
+    lastPingTs: number;
+    lastRtt: number;
+    metadata?: Record<string, unknown>;
+    name: string;
+    namespaceId: Rivet.RivetId;
+    remainingSlots: number;
+    runnerId: Rivet.RivetId;
+    stopTs?: number;
+    totalSlots: number;
+    version: number;
+}

package/types/api/types/RunnerConfig.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfig {
+    normal?: Record<string, unknown>;
+    serverless?: Rivet.RunnerConfigServerless;
+    drainOnVersionUpgrade?: boolean;
+    metadata?: unknown;
+}

package/types/api/types/RunnerConfigKind.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type RunnerConfigKind = Rivet.RunnerConfigKindNormal | Rivet.RunnerConfigKindServerless;

package/types/api/types/RunnerConfigKindNormal.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RunnerConfigKindNormal {
+    normal: Record<string, unknown>;
+}

package/types/api/types/RunnerConfigKindServerless.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigKindServerless {
+    serverless: Rivet.RunnerConfigKindServerlessServerless;
+}

package/types/api/types/RunnerConfigKindServerlessServerless.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RunnerConfigKindServerlessServerless {
+    headers?: Record<string, string>;
+    maxRunners: number;
+    /** Milliseconds between metadata polling. If not set, uses the global default. */
+    metadataPollInterval?: number;
+    minRunners?: number;
+    /** Seconds. */
+    requestLifespan: number;
+    runnersMargin?: number;
+    slotsPerRunner: number;
+    url: string;
+}

package/types/api/types/RunnerConfigResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigResponse extends Rivet.RunnerConfig {
+    runnerPoolError?: Record<string, unknown>;
+}

package/types/api/types/RunnerConfigServerless.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RunnerConfigServerless {
+    headers?: Record<string, string>;
+    maxRunners: number;
+    /** Milliseconds between metadata polling. If not set, uses the global default. */
+    metadataPollInterval?: number;
+    minRunners?: number;
+    /** Seconds. */
+    requestLifespan: number;
+    runnersMargin?: number;
+    slotsPerRunner: number;
+    url: string;
+}

package/types/api/types/RunnerConfigVariant.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RunnerConfigVariant = "serverless" | "normal";
+export declare const RunnerConfigVariant: {
+    readonly Serverless: "serverless";
+    readonly Normal: "normal";
+};

package/types/api/types/RunnerConfigsDeleteResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RunnerConfigsDeleteResponse = Record<string, unknown>;

package/types/api/types/RunnerConfigsListResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsListResponse {
+    pagination: Rivet.Pagination;
+    runnerConfigs: Record<string, Rivet.RunnerConfigsListResponseRunnerConfigsValue>;
+}

package/types/api/types/RunnerConfigsListResponseRunnerConfigsValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsListResponseRunnerConfigsValue {
+    datacenters: Record<string, Rivet.RunnerConfigResponse>;
+}

package/types/api/types/RunnerConfigsRefreshMetadataRequestBody.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RunnerConfigsRefreshMetadataRequestBody = Record<string, unknown>;

package/types/api/types/RunnerConfigsRefreshMetadataResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RunnerConfigsRefreshMetadataResponse = Record<string, unknown>;

package/types/api/types/RunnerConfigsServerlessHealthCheckResponse.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type RunnerConfigsServerlessHealthCheckResponse = Rivet.RunnerConfigsServerlessHealthCheckResponseSuccess | Rivet.RunnerConfigsServerlessHealthCheckResponseFailure;

package/types/api/types/RunnerConfigsServerlessHealthCheckResponseFailure.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsServerlessHealthCheckResponseFailure {
+    failure: Rivet.RunnerConfigsServerlessHealthCheckResponseFailureFailure;
+}

package/types/api/types/RunnerConfigsServerlessHealthCheckResponseFailureFailure.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsServerlessHealthCheckResponseFailureFailure {
+    error: Rivet.RunnerConfigsServerlessMetadataError;
+}

package/types/api/types/RunnerConfigsServerlessHealthCheckResponseSuccess.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsServerlessHealthCheckResponseSuccess {
+    success: Rivet.RunnerConfigsServerlessHealthCheckResponseSuccessSuccess;
+}

package/types/api/types/RunnerConfigsServerlessHealthCheckResponseSuccessSuccess.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RunnerConfigsServerlessHealthCheckResponseSuccessSuccess {
+    version: string;
+}

package/types/api/types/RunnerConfigsServerlessMetadataError.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export type RunnerConfigsServerlessMetadataError = Rivet.RunnerConfigsServerlessMetadataErrorInvalidRequest | Rivet.RunnerConfigsServerlessMetadataErrorRequestFailed | Rivet.RunnerConfigsServerlessMetadataErrorRequestTimedOut | Rivet.RunnerConfigsServerlessMetadataErrorNonSuccessStatus | Rivet.RunnerConfigsServerlessMetadataErrorInvalidResponseJson | Rivet.RunnerConfigsServerlessMetadataErrorInvalidResponseSchema;

package/types/api/types/RunnerConfigsServerlessMetadataErrorInvalidRequest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RunnerConfigsServerlessMetadataErrorInvalidRequest {
+    invalidRequest: Record<string, unknown>;
+}

package/types/api/types/RunnerConfigsServerlessMetadataErrorInvalidResponseJson.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Rivet from "../index";
+export interface RunnerConfigsServerlessMetadataErrorInvalidResponseJson {
+    invalidResponseJson: Rivet.RunnerConfigsServerlessMetadataErrorInvalidResponseJsonInvalidResponseJson;
+}