openblox/dist/apis/cloud/luauExecution/luauExecution.d.ts

Roblox API Wrapper For Both Classic And OpenCloud APIs.

/// <reference types="node" />
import type { ArrayNonEmptyIfConst, Identifier } from "typeforge";
/**
 * Executes a roblox luau script for a given place.
 * @endpoint
 * POST /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
 * POST /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
 *
 * @param universeId The ID of the universe to execute the script under.
 * @param placeId The ID of the place to execute the script under.
 * @param version The optional version number of the place to execute the script under.
 * @param script The script to execute.
 *
 * @example
 * const { data:executed } = await LuauExecutionApi.executeLuau({
 *   universeId: 5795192361, placeId: 16866553538, script: `local x, y = 3, 4; return x + y`
 * })
 * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y","universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
 * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y"}
 */
export declare const executeLuau: <UniverseId extends Identifier, PlaceId extends Identifier, Version extends number | undefined = undefined>(this: any, args: {
    universeId: UniverseId;
    placeId: PlaceId;
    version?: Version | undefined;
    script: string | Buffer | ArrayNonEmptyIfConst<string | Buffer>;
}) => Promise<{
    data: {
        path: `/v2/universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${string}/tasks/${string}`;
        user: Identifier;
        state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
        script: string;
        universeId: UniverseId;
        placeId: PlaceId;
        version: Version extends undefined ? number : Version;
        sessionId: string;
        taskId: string;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            path: `/v2/universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${string}/tasks/${string}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
        };
    };
} & {
    again: () => Promise<{
        data: {
            path: `/v2/universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${string}/tasks/${string}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
            universeId: UniverseId;
            placeId: PlaceId;
            version: Version extends undefined ? number : Version;
            sessionId: string;
            taskId: string;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                path: `/v2/universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${string}/tasks/${string}`;
                user: Identifier;
                state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
                script: string;
            };
        };
    }>;
}>;
/**
 * Gets a luau execution task.
 * @endpoint
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-sessions/{sessionId}/tasks
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-sessions/{sessionId}/tasks
 *
 * @param universeId The ID of the universe to get the luau execution task from.
 * @param placeId The ID of the place to get the luau execution task from.
 * @param version The optional version number of the place to get the luau execution task for.
 * @param sessionId The ID of the session to get the luau execution task for.
 * @param taskId The ID of the task to get the luau execution task for.
 * @param view If the response should return the script source (`"FULL"`) instead of an empty string.
 *
 * @example
 * import { pollMethod } from "openblox/helpers";
 *
 * type Results = number[]
 * const { data:executedTask } = await pollMethod(
 *   LuauExecutionApi.luauExecutionTask<Results>({
 *    universeId: 5795192361, placeId: 16866553538, version: 26,
 *    sessionId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d", taskId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d"
 *   }),
 *   async ({ data }, stopPolling) => data.state === "COMPLETE" && stopPolling()
 * )
 * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","createTime":"2024-10-01T02:31:46.304Z","updateTime":"2024-10-01T02:31:49.959Z","user":"45348281","state":"COMPLETE","script":"","output":{"results":[7]},"universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
 * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","createTime":"2024-10-01T02:31:46.304Z","updateTime":"2024-10-01T02:31:49.959Z","user":"45348281","state":"COMPLETE","script":"","output":{"results":[7]}}
 */
export declare const luauExecutionTask: <Results extends any[]>(this: any, args: {
    universeId: Identifier;
    placeId: Identifier;
    version?: number | undefined;
    sessionId: string;
    taskId: string;
    view?: "BASIC" | "FULL" | undefined;
}) => Promise<{
    data: {
        path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
        createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        user: Identifier;
        state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
        script: string;
        error: {
            code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR";
            message: "string";
        };
        output?: false | 0 | null | undefined;
        universeId: Identifier;
        placeId: Identifier;
        version: number;
        sessionId: string;
        taskId: string;
    } | {
        path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
        createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
        user: Identifier;
        state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
        script: string;
        output: {
            results: import("typeforge").Prettify<Results, Results extends Date ? true : false>;
        };
        error?: false | 0 | null | undefined;
        universeId: Identifier;
        placeId: Identifier;
        version: number;
        sessionId: string;
        taskId: string;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: ({
            /**
             * Executes a roblox luau script for a given place.
             * @endpoint
             * POST /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
             * POST /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
             *
             * @param universeId The ID of the universe to execute the script under.
             * @param placeId The ID of the place to execute the script under.
             * @param version The optional version number of the place to execute the script under.
             * @param script The script to execute.
             *
             * @example
             * const { data:executed } = await LuauExecutionApi.executeLuau({
             *   universeId: 5795192361, placeId: 16866553538, script: `local x, y = 3, 4; return x + y`
             * })
             * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y","universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
             * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y"}
             */
            path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
        } & {
            error: {
                code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR";
                message: "string";
            };
            output?: false | 0 | null | undefined;
        }) | ({
            /**
             * Executes a roblox luau script for a given place.
             * @endpoint
             * POST /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
             * POST /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
             *
             * @param universeId The ID of the universe to execute the script under.
             * @param placeId The ID of the place to execute the script under.
             * @param version The optional version number of the place to execute the script under.
             * @param script The script to execute.
             *
             * @example
             * const { data:executed } = await LuauExecutionApi.executeLuau({
             *   universeId: 5795192361, placeId: 16866553538, script: `local x, y = 3, 4; return x + y`
             * })
             * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y","universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
             * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y"}
             */
            path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
        } & {
            output: {
                results: import("typeforge").Prettify<Results, Results extends Date ? true : false>;
            };
            error?: false | 0 | null | undefined;
        });
    };
} & {
    again: () => Promise<{
        data: {
            path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
            error: {
                code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR";
                message: "string";
            };
            output?: false | 0 | null | undefined;
            universeId: Identifier;
            placeId: Identifier;
            version: number;
            sessionId: string;
            taskId: string;
        } | {
            path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
            createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
            user: Identifier;
            state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
            script: string;
            output: {
                results: import("typeforge").Prettify<Results, Results extends Date ? true : false>;
            };
            error?: false | 0 | null | undefined;
            universeId: Identifier;
            placeId: Identifier;
            version: number;
            sessionId: string;
            taskId: string;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: ({
                /**
                 * Executes a roblox luau script for a given place.
                 * @endpoint
                 * POST /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
                 * POST /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
                 *
                 * @param universeId The ID of the universe to execute the script under.
                 * @param placeId The ID of the place to execute the script under.
                 * @param version The optional version number of the place to execute the script under.
                 * @param script The script to execute.
                 *
                 * @example
                 * const { data:executed } = await LuauExecutionApi.executeLuau({
                 *   universeId: 5795192361, placeId: 16866553538, script: `local x, y = 3, 4; return x + y`
                 * })
                 * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y","universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
                 * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y"}
                 */
                path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                user: Identifier;
                state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
                script: string;
            } & {
                error: {
                    code: "ERROR_CODE_UNSPECIFIED" | "SCRIPT_ERROR" | "DEADLINE_EXCEEDED" | "OUTPUT_SIZE_LIMIT_EXCEEDED" | "INTERNAL_ERROR";
                    message: "string";
                };
                output?: false | 0 | null | undefined;
            }) | ({
                /**
                 * Executes a roblox luau script for a given place.
                 * @endpoint
                 * POST /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks
                 * POST /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks
                 *
                 * @param universeId The ID of the universe to execute the script under.
                 * @param placeId The ID of the place to execute the script under.
                 * @param version The optional version number of the place to execute the script under.
                 * @param script The script to execute.
                 *
                 * @example
                 * const { data:executed } = await LuauExecutionApi.executeLuau({
                 *   universeId: 5795192361, placeId: 16866553538, script: `local x, y = 3, 4; return x + y`
                 * })
                 * @exampleData {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y","universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}
                 * @exampleRawBody {"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d","user":"45348281","state":"PROCESSING","script":"local x, y = 3, 4; return x + y"}
                 */
                path: `/v2/universes/${number}/places/${number}/luau-execution-sessions/${string}/tasks/${string}` | `/v2/universes/${number}/places/${number}/versions/${number}/luau-execution-sessions/${string}/tasks/${string}`;
                createTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                updateTime: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
                user: Identifier;
                state: "STATE_UNSPECIFIED" | "QUEUED" | "PROCESSING" | "CANCELLED" | "COMPLETE" | "FAILED";
                script: string;
            } & {
                output: {
                    results: import("typeforge").Prettify<Results, Results extends Date ? true : false>;
                };
                error?: false | 0 | null | undefined;
            });
        };
    }>;
}>;
/**
 * Lists luau execution logs.
 * @endpoint
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-session-tasks/{taskId}/logs
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/luau-execution-sessions/{sessionId}/tasks/{taskId}/logs
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-session-tasks/{taskId}/logs
 * GET /cloud/v2/universes/{universeId}/places/{placeId}/versions/{version}/luau-execution-sessions/{sessionId}/tasks/{taskId}/logs
 *
 * @param universeId The ID of the universe to list logs for.
 * @param placeId The ID of the place to list logs for.
 * @param version The optional version number of the place to list logs for.
 * @param sessionId The ID of the session to get logs for.
 * @param taskId The ID of the task to get logs for.
 * @param limit The maximum amount of logs to return. The service might return fewer than this value. If unspecified, at most 10000 luau execution session task logs are returned. The maximum value is 10000 and higher values are set to 10000.
 * @param cursor A page token, received from a previous call, to retrieve a subsequent page.
 *
 * @example const { data:logs } = await LuauExecutionApi.listLuauExecutionLogs({
 *   universeId: 5795192361, placeId: 16866553538, version: 26,
 *   sessionId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d", taskId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d"
 * })
 * @exampleData [{"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/logs/1","messages":[],"universeId":"5795192361","placeId":"16866553538","version":26,"sessionId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d","taskId":"67823af7-1f99-4fc5-b3bb-da7ab3456b5d"}]
 * @exampleRawBody {"luauExecutionSessionTaskLogs":[{"path":"universes/5795192361/places/16866553538/versions/26/luau-execution-sessions/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/tasks/67823af7-1f99-4fc5-b3bb-da7ab3456b5d/logs/1","messages":[]}],"nextPageToken":""}
 */
export declare const listLuauExecutionLogs: <UniverseId extends Identifier, PlaceId extends Identifier, SessionId extends string, TaskId extends string, Version extends number | undefined = undefined>(this: any, args: {
    universeId: UniverseId;
    placeId: PlaceId;
    version?: Version | undefined;
    taskId: TaskId;
    sessionId?: SessionId | undefined;
    limit?: number | undefined;
    cursor?: string | undefined;
}) => Promise<{
    data: {
        path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
        messages: any[];
        universeId: Identifier;
        placeId: Identifier;
        version: number;
        sessionId: string;
        taskId: string;
    }[];
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            luauExecutionSessionTaskLogs: [{
                path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
                messages: any[];
            }];
            nextPageToken: string;
        };
    };
    cursors: {
        previous: import("../../apiGroup/apiGroup.types").Cursor;
        next: import("../../apiGroup/apiGroup.types").Cursor;
    };
    [Symbol.asyncIterator]: () => AsyncGenerator<{
        data: {
            path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
            messages: any[];
            universeId: Identifier;
            placeId: Identifier;
            version: number;
            sessionId: string;
            taskId: string;
        }[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                luauExecutionSessionTaskLogs: [{
                    path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
                    messages: any[];
                }];
                nextPageToken: string;
            };
        };
        cursors: {
            previous: import("../../apiGroup/apiGroup.types").Cursor;
            next: import("../../apiGroup/apiGroup.types").Cursor;
        };
        [Symbol.asyncIterator]: null;
    } & {
        again: () => Promise<{
            data: {
                path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
                messages: any[];
                universeId: Identifier;
                placeId: Identifier;
                version: number;
                sessionId: string;
                taskId: string;
            }[];
            response: {
                fullResponse: unknown;
                url: `https://${string}`;
                method: import("../../../utils/utils.types").RestMethod;
                success: boolean;
                statusCode: number;
                headers: Headers;
                body: {
                    luauExecutionSessionTaskLogs: [{
                        path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
                        messages: any[];
                    }];
                    nextPageToken: string;
                };
            };
        }>;
    }, any, unknown>;
} & {
    again: () => Promise<{
        data: {
            path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
            messages: any[];
            universeId: Identifier;
            placeId: Identifier;
            version: number;
            sessionId: string;
            taskId: string;
        }[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                luauExecutionSessionTaskLogs: [{
                    path: `universes/${UniverseId}/places/${PlaceId}${Version extends number ? `/versions/${Version}` : ""}/luau-execution-sessions/${SessionId}/tasks/${TaskId}/logs/1`;
                    messages: any[];
                }];
                nextPageToken: string;
            };
        };
    }>;
}>;