plato-sandbox-sdk 1.1.7 → 1.1.9

package/README.md

@@ -37,7 +37,7 @@ const env = await client.makeEnvironment({
 console.log('Environment created:', env.job_group_id);
 
 // Get environment status
-const status = await client.env.getJobStatusApiEnvJobGroupIdStatusGet({
+const status = await client.env.getJobStatus({
     jobGroupId: env.job_group_id
 });
 
@@ -73,7 +73,7 @@ try {
 }
 
 // Setup sandbox on the VM
-const setupResult = await client.publicBuild.setupSandboxApiPublicBuildVmPublicIdSetupSandboxPost({
+const setupResult = await client.publicBuild.setupSandbox({
     publicId: vm.publicId,
     setupSandboxRequest: {
         // ... setup options
@@ -116,7 +116,7 @@ async function runEnvironmentLifecycle() {
     console.log('Environment ready!');
 
     // 3. Reset environment with a task
-    await client.env.resetEnvApiEnvJobGroupIdResetPost({
+    await client.env.resetEnvironment({
         jobGroupId: env.jobId,
         resetEnvRequest: {
             taskId: '1a84e3d6-1900-40ba-bf00-beeca1748ad5',
@@ -124,30 +124,30 @@ async function runEnvironmentLifecycle() {
     });
 
     // 4. Get environment URLs
-    const publicUrl = await client.env.getProxyUrlApiEnvJobGroupIdProxyUrlGet({ 
+    const publicUrl = await client.env.getProxyUrl({ 
         jobGroupId: env.jobId 
     });
     console.log('Public URL:', publicUrl);
 
-    const cdpUrl = await client.env.getCdpUrlApiEnvJobGroupIdCdpUrlGet({ 
+    const cdpUrl = await client.env.getCdpUrl({ 
         jobGroupId: env.jobId 
     });
     console.log('CDP URL:', cdpUrl);
 
     // 5. Get environment state
-    const state = await client.env.getEnvStateApiEnvJobGroupIdStateGet({ 
+    const state = await client.env.getEnvironmentState({ 
         jobGroupId: env.jobId 
     });
     console.log('Environment state:', state);
 
     // 6. Get active session
-    const session = await client.env.getActiveSessionApiEnvJobGroupIdActiveSessionGet({ 
+    const session = await client.env.getActiveSession({ 
         jobGroupId: env.jobId 
     });
     const sessionId = (session as any).session_id;
 
     // 7. Evaluate the session
-    const evaluation = await client.env.evaluateSessionApiEnvSessionSessionIdEvaluatePost({
+    const evaluation = await client.env.evaluateSession({
         sessionId,
         evaluateRequest: {
             // Custom evaluation data
@@ -157,7 +157,7 @@ async function runEnvironmentLifecycle() {
     console.log('Evaluation result:', evaluation);
 
     // 8. Score the session
-    await client.env.scoreSessionApiEnvSessionSessionIdScorePost({
+    await client.env.scoreSession({
         sessionId,
         scoreRequest: {
             score: 0.95,
@@ -179,12 +179,12 @@ runEnvironmentLifecycle().catch(console.error);
 
 ```typescript
 // Get current state
-const state = await client.env.getEnvStateApiEnvJobGroupIdStateGet({
+const state = await client.env.getEnvironmentState({
     jobGroupId: 'job-123'
 });
 
 // Reset to a specific task
-await client.env.resetEnvApiEnvJobGroupIdResetPost({
+await client.env.resetEnvironment({
     jobGroupId: 'job-123',
     resetEnvRequest: {
         taskId: 'task-456',
@@ -194,7 +194,7 @@ await client.env.resetEnvApiEnvJobGroupIdResetPost({
 });
 
 // Backup current state
-await client.env.backupEnvApiEnvJobGroupIdBackupPost({
+await client.env.backupEnvironment({
     jobGroupId: 'job-123'
 });
 ```
@@ -203,12 +203,12 @@ await client.env.backupEnvApiEnvJobGroupIdBackupPost({
 
 ```typescript
 // Get active session
-const session = await client.env.getActiveSessionApiEnvJobGroupIdActiveSessionGet({
+const session = await client.env.getActiveSession({
     jobGroupId: 'job-123'
 });
 
 // Evaluate session
-const evaluation = await client.env.evaluateSessionApiEnvSessionSessionIdEvaluatePost({
+const evaluation = await client.env.evaluateSession({
     sessionId: session.session_id,
     evaluateRequest: {
         customData: { /* your evaluation data */ }
@@ -216,7 +216,7 @@ const evaluation = await client.env.evaluateSessionApiEnvSessionSessionIdEvaluat
 });
 
 // Score session
-await client.env.scoreSessionApiEnvSessionSessionIdScorePost({
+await client.env.scoreSession({
     sessionId: session.session_id,
     scoreRequest: {
         score: 0.85,
@@ -228,7 +228,7 @@ await client.env.scoreSessionApiEnvSessionSessionIdScorePost({
 });
 
 // Log session data
-await client.env.logApiEnvSessionIdLogPost({
+await client.env.logToEnvironment({
     sessionId: session.session_id,
     log: {
         level: 'info',
@@ -242,22 +242,28 @@ await client.env.logApiEnvSessionIdLogPost({
 
 ```typescript
 // List available simulators
-const simulators = await client.env.listSimulatorsApiEnvSimulatorsGet({});
+const simulators = await client.env.getSimulators({});
 
 // Get simulator versions
-const versions = await client.simulator.getSimulatorVersionsApiSimulatorSimulatorNameVersionsGet({
+const versions = await client.simulator.getSimulatorVersions({
     simulatorName: 'espocrm'
 });
 
 console.log('Available versions:', versions.versions);
 
 // Get database configuration for a simulator
-const dbConfig = await client.simulator.getDbConfigApiSimulatorArtifactIdDbConfigGetRaw({
+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.createSimulatorApiEnvSimulatorsPost({
+await client.env.createSimulator({
     createSimulatorRequest: {
         name: 'my-simulator',
         description: 'Custom simulator',
@@ -270,25 +276,25 @@ await client.env.createSimulatorApiEnvSimulatorsPost({
 
 ```typescript
 // Get your Gitea info
-const myInfo = await client.gitea.getMyInfoApiGiteaMyInfoGet({});
+const myInfo = await client.gitea.getGiteaMyInfo({});
 console.log('Gitea user:', myInfo);
 
 // List simulator repositories
-const repos = await client.gitea.listSimulatorsApiGiteaSimulatorsGet({});
+const repos = await client.gitea.getGiteaSimulators({});
 
 // Get repository info for a specific simulator
-const repoInfo = await client.gitea.getRepoInfoApiGiteaSimulatorsSimulatorIdRepoGet({
+const repoInfo = await client.gitea.getGiteaSimulatorRepo({
     simulatorId: 'sim-123'
 });
 
 console.log('Repository:', repoInfo.url);
 
 // Get Gitea credentials (for cloning repos)
-const credentials = await client.gitea.getCredentialsApiGiteaCredentialsGet({});
+const credentials = await client.gitea.getGiteaCredentials({});
 console.log('Git credentials:', credentials);
 
 // Create a repository for a simulator
-await client.gitea.createRepoApiGiteaSimulatorsSimulatorIdRepoPost({
+await client.gitea.createGiteaSimulatorRepo({
     simulatorId: 'sim-123',
     body: {
         name: 'my-simulator-repo',
@@ -301,12 +307,12 @@ await client.gitea.createRepoApiGiteaSimulatorsSimulatorIdRepoPost({
 
 ```typescript
 // Get CDP (Chrome DevTools Protocol) URL for browser automation
-const cdpUrl = await client.env.getCdpUrlApiEnvJobGroupIdCdpUrlGet({
+const cdpUrl = await client.env.getCdpUrl({
     jobGroupId: 'job-123'
 });
 
 // Get proxy URL for accessing the application
-const proxyUrl = await client.env.getProxyUrlApiEnvJobGroupIdProxyUrlGet({
+const proxyUrl = await client.env.getProxyUrl({
     jobGroupId: 'job-123'
 });
 
@@ -356,13 +362,13 @@ const tasks = ['task-1', 'task-2', 'task-3'];
 
 for (const taskId of tasks) {
     // Reset to the task
-    await client.env.resetEnvApiEnvJobGroupIdResetPost({
+    await client.env.resetEnvironment({
         jobGroupId: env.jobId,
         resetEnvRequest: { taskId },
     });
     
     // Get the session
-    const session = await client.env.getActiveSessionApiEnvJobGroupIdActiveSessionGet({
+    const session = await client.env.getActiveSession({
         jobGroupId: env.jobId
     });
     
@@ -370,11 +376,11 @@ for (const taskId of tasks) {
     // await performTask(session);
     
     // Evaluate and score
-    await client.env.evaluateSessionApiEnvSessionSessionIdEvaluatePost({
+    await client.env.evaluateSession({
         sessionId: (session as any).session_id,
     });
     
-    await client.env.scoreSessionApiEnvSessionSessionIdScorePost({
+    await client.env.scoreSession({
         sessionId: (session as any).session_id,
         scoreRequest: { score: 1.0 },
     });

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;
+    }>;
+}