plato-sandbox-sdk 1.1.8 → 1.1.9

package/README.md

@@ -256,6 +256,12 @@ const dbConfig = await client.simulator.getSimulatorDbConfig({
     artifactId: '2ea954c0-7e5a-4a12-82fd-12cb46538827'
 });
 
+// Get available flows for a simulator
+const flows = await client.simulator.getSimulatorFlows({
+    artifactId: '2ea954c0-7e5a-4a12-82fd-12cb46538827'
+});
+console.log('Available flows:', flows);
+
 // Create a new simulator
 await client.env.createSimulator({
     createSimulatorRequest: {

package/dist/apis/EnvApi.d.ts

@@ -0,0 +1,308 @@
+/**
+ * Plato API
+ * API for Plato platform - SDK routes only
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateSimulatorRequest, EvaluateRequest, JobStatusResponse, Log, MakeEnvRequest2, ResetEnvRequest, ScoreRequest, WorkerReadyResponse } from '../models/index';
+export interface BackupEnvironmentRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface CloseEnvironmentRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface CreateSimulatorOperationRequest {
+    createSimulatorRequest: CreateSimulatorRequest;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface EvaluateSessionRequest {
+    sessionId: string;
+    authorization?: string;
+    xInternalService?: string;
+    evaluateRequest?: EvaluateRequest;
+}
+export interface GetActiveSessionRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetCdpUrlRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetEnvironmentStateRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetJobStatusRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetProxyUrlRequest {
+    jobGroupId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetSimulatorsRequest {
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest {
+    jobId: string;
+    timeout?: number;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface LogStateMutationApiEnvSessionIdLogPostRequest {
+    sessionId: string;
+    log: Log;
+}
+export interface MakeEnvironmentRequest {
+    makeEnvRequest2: MakeEnvRequest2;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface ResetEnvironmentRequest {
+    jobGroupId: string;
+    resetEnvRequest: ResetEnvRequest;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface ScoreEnvApiEnvSessionSessionIdScorePostRequest {
+    sessionId: string;
+    scoreRequest: ScoreRequest;
+    authorization?: string;
+    xInternalService?: string;
+}
+export interface SendHeartbeatRequest {
+    jobId: string;
+    authorization?: string;
+    xInternalService?: string;
+}
+/**
+ *
+ */
+export declare class EnvApi extends runtime.BaseAPI {
+    /**
+     * Create a backup of the environment.
+     * Backup Env
+     */
+    backupEnvironmentRaw(requestParameters: BackupEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Create a backup of the environment.
+     * Backup Env
+     */
+    backupEnvironment(requestParameters: BackupEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Close Env
+     */
+    closeEnvironmentRaw(requestParameters: CloseEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Close Env
+     */
+    closeEnvironment(requestParameters: CloseEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Create a new simulator.
+     * Create Simulator
+     */
+    createSimulatorRaw(requestParameters: CreateSimulatorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Create a new simulator.
+     * Create Simulator
+     */
+    createSimulator(requestParameters: CreateSimulatorOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Evaluate the session.
+     * Evaluate Session
+     */
+    evaluateSessionRaw(requestParameters: EvaluateSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Evaluate the session.
+     * Evaluate Session
+     */
+    evaluateSession(requestParameters: EvaluateSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get the active session for a job group.
+     * Get Active Session
+     */
+    getActiveSessionRaw(requestParameters: GetActiveSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get the active session for a job group.
+     * Get Active Session
+     */
+    getActiveSession(requestParameters: GetActiveSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get the CDP URL for the environment.
+     * Get Cdp Url
+     */
+    getCdpUrlRaw(requestParameters: GetCdpUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get the CDP URL for the environment.
+     * Get Cdp Url
+     */
+    getCdpUrl(requestParameters: GetCdpUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get Env State
+     */
+    getEnvironmentStateRaw(requestParameters: GetEnvironmentStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get Env State
+     */
+    getEnvironmentState(requestParameters: GetEnvironmentStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get Job Status
+     */
+    getJobStatusRaw(requestParameters: GetJobStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JobStatusResponse>>;
+    /**
+     * Get Job Status
+     */
+    getJobStatus(requestParameters: GetJobStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JobStatusResponse>;
+    /**
+     * Get the public URL for the environment.
+     * Get Proxy Url
+     */
+    getProxyUrlRaw(requestParameters: GetProxyUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get the public URL for the environment.
+     * Get Proxy Url
+     */
+    getProxyUrl(requestParameters: GetProxyUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get all simulators with optimized queries.
+     * Get Simulators
+     */
+    getSimulatorsRaw(requestParameters: GetSimulatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<{
+        [key: string]: any;
+    }>>>;
+    /**
+     * Get all simulators with optimized queries.
+     * Get Simulators
+     */
+    getSimulators(requestParameters?: GetSimulatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Check if the workers for this job group are ready and healthy.  Uses the persistent job ready notification service to wait for job readiness. Falls back to checking Redis if notification not received (in case we missed it). Raises 500 if job not ready after all checks.
+     * Get Worker Ready
+     */
+    getWorkerReadyApiEnvJobIdWorkerReadyGetRaw(requestParameters: GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkerReadyResponse>>;
+    /**
+     * Check if the workers for this job group are ready and healthy.  Uses the persistent job ready notification service to wait for job readiness. Falls back to checking Redis if notification not received (in case we missed it). Raises 500 if job not ready after all checks.
+     * Get Worker Ready
+     */
+    getWorkerReadyApiEnvJobIdWorkerReadyGet(requestParameters: GetWorkerReadyApiEnvJobIdWorkerReadyGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkerReadyResponse>;
+    /**
+     * Log a state mutation or batch of mutations.
+     * Log State Mutation
+     */
+    logStateMutationApiEnvSessionIdLogPostRaw(requestParameters: LogStateMutationApiEnvSessionIdLogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Log a state mutation or batch of mutations.
+     * Log State Mutation
+     */
+    logStateMutationApiEnvSessionIdLogPost(requestParameters: LogStateMutationApiEnvSessionIdLogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Make Env
+     */
+    makeEnvironmentRaw(requestParameters: MakeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Make Env
+     */
+    makeEnvironment(requestParameters: MakeEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Reset the environment with an optional task.
+     * Reset Env
+     */
+    resetEnvironmentRaw(requestParameters: ResetEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Reset the environment with an optional task.
+     * Reset Env
+     */
+    resetEnvironment(requestParameters: ResetEnvironmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Score the environment.
+     * Score Env
+     */
+    scoreEnvApiEnvSessionSessionIdScorePostRaw(requestParameters: ScoreEnvApiEnvSessionSessionIdScorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Score the environment.
+     * Score Env
+     */
+    scoreEnvApiEnvSessionSessionIdScorePost(requestParameters: ScoreEnvApiEnvSessionSessionIdScorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Send a heartbeat to keep the environment session alive.
+     * Send Heartbeat
+     */
+    sendHeartbeatRaw(requestParameters: SendHeartbeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Send a heartbeat to keep the environment session alive.
+     * Send Heartbeat
+     */
+    sendHeartbeat(requestParameters: SendHeartbeatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+}