@wandelbots/nova-api 25.8.0-dev.17 → 25.8.0-dev.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wandelbots/nova-api",
-  "version": "25.8.0-dev.17",
+  "version": "25.8.0-dev.19",
   "description": "API Client to interact with Wandelbots Public API.",
   "files": [
     "*",

package/v2/api.d.ts

@@ -1708,9 +1708,22 @@ export interface GetTrajectoryResponse {
 export interface HTTPValidationError {
     /**
      *
-     * @type {Array<ValidationError>}
+     * @type {Array<ValidationError2>}
      * @memberof HTTPValidationError
      */
+    'detail'?: Array<ValidationError2>;
+}
+/**
+ *
+ * @export
+ * @interface HTTPValidationError2
+ */
+export interface HTTPValidationError2 {
+    /**
+     *
+     * @type {Array<ValidationError>}
+     * @memberof HTTPValidationError2
+     */
     'detail'?: Array<ValidationError>;
 }
 /**
@@ -4166,6 +4179,148 @@ export interface ProfinetSubSlotDescription {
      */
     'output_length': number;
 }
+/**
+ * A program is a collection of instructions that are executed in the robot cell.
+ * @export
+ * @interface Program
+ */
+export interface Program {
+    /**
+     *
+     * @type {string}
+     * @memberof Program
+     */
+    'program': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Program
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Program
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Program
+     */
+    'app': string;
+    /**
+     *
+     * @type {object}
+     * @memberof Program
+     */
+    'input_schema'?: object;
+    /**
+     *
+     * @type {object}
+     * @memberof Program
+     */
+    'preconditions'?: object;
+}
+/**
+ * Holds the state of a program run.
+ * @export
+ * @interface ProgramRun
+ */
+export interface ProgramRun {
+    /**
+     * Unique identifier of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'run': string;
+    /**
+     * Unique identifier of the program
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'program': string;
+    /**
+     * State of the program run
+     * @type {ProgramRunState}
+     * @memberof ProgramRun
+     */
+    'state': ProgramRunState;
+    /**
+     * Logs of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'logs'?: string;
+    /**
+     * Stdout of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'stdout'?: string;
+    /**
+     * Stderr of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'stderr'?: string;
+    /**
+     * Error message of the program run, if any
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'error'?: string;
+    /**
+     * Traceback of the program run, if any
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'traceback'?: string;
+    /**
+     * Start time of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'start_time'?: string;
+    /**
+     * End time of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'end_time'?: string;
+    /**
+     * Input data of the program run
+     * @type {object}
+     * @memberof ProgramRun
+     */
+    'input_data'?: object;
+}
+/**
+ * The state of a program run.
+ * @export
+ * @enum {string}
+ */
+export declare const ProgramRunState: {
+    readonly Preparing: "PREPARING";
+    readonly Running: "RUNNING";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+    readonly Stopped: "STOPPED";
+};
+export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
+/**
+ * The state of a program run.
+ * @export
+ * @interface ProgramStartRequest
+ */
+export interface ProgramStartRequest {
+    /**
+     * The arguments to pass to the program.
+     * @type {object}
+     * @memberof ProgramStartRequest
+     */
+    'arguments': object;
+}
 /**
  * <!-- theme: danger -->  > **Experimental**  RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
  * @export
@@ -5127,6 +5282,31 @@ export interface ValidationError {
         [key: string]: any;
     };
 }
+/**
+ * A validation error of a program.
+ * @export
+ * @interface ValidationError2
+ */
+export interface ValidationError2 {
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof ValidationError2
+     */
+    'loc': Array<number>;
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError2
+     */
+    'msg': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError2
+     */
+    'type': string;
+}
 /**
  * @type ValidationErrorLocInner
  * @export
@@ -7786,6 +7966,180 @@ export declare class MotionGroupModelsApi extends BaseAPI {
      */
     getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
 }
+/**
+ * ProgramApi - axios parameter creator
+ * @export
+ */
+export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get details of a program.
+     * @summary Get program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List details of all existing programs.
+     * @summary List programs
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint starts a new program execution.  The program will be executed asynchronously.
+     * @summary Start the program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {ProgramStartRequest} programStartRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startProgram: (cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Stop a specific program run.
+     * @summary Stop program run
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stopProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProgramApi - functional programming interface
+ * @export
+ */
+export declare const ProgramApiFp: (configuration?: Configuration) => {
+    /**
+     * Get details of a program.
+     * @summary Get program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>>;
+    /**
+     * List details of all existing programs.
+     * @summary List programs
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>>;
+    /**
+     * This endpoint starts a new program execution.  The program will be executed asynchronously.
+     * @summary Start the program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {ProgramStartRequest} programStartRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
+    /**
+     * Stop a specific program run.
+     * @summary Stop program run
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ProgramApi - factory interface
+ * @export
+ */
+export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get details of a program.
+     * @summary Get program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program>;
+    /**
+     * List details of all existing programs.
+     * @summary List programs
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>>;
+    /**
+     * This endpoint starts a new program execution.  The program will be executed asynchronously.
+     * @summary Start the program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {ProgramStartRequest} programStartRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
+    /**
+     * Stop a specific program run.
+     * @summary Stop program run
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ProgramApi - object-oriented interface
+ * @export
+ * @class ProgramApi
+ * @extends {BaseAPI}
+ */
+export declare class ProgramApi extends BaseAPI {
+    /**
+     * Get details of a program.
+     * @summary Get program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program, any>>;
+    /**
+     * List details of all existing programs.
+     * @summary List programs
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Program[], any>>;
+    /**
+     * This endpoint starts a new program execution.  The program will be executed asynchronously.
+     * @summary Start the program
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {ProgramStartRequest} programStartRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
+    /**
+     * Stop a specific program run.
+     * @summary Stop program run
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} program
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}
 /**
  * StoreCollisionComponentsApi - axios parameter creator
  * @export