@ourskyai/platform-api 1.3.5020 → 1.3.5055

package/README.md

@@ -1,4 +1,4 @@
-## @ourskyai/platform-api@1.3.5020
+## @ourskyai/platform-api@1.3.5055
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @ourskyai/platform-api@1.3.5020 --save
+npm install @ourskyai/platform-api@1.3.5055 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * OurSky Platform
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.3.5020
+ * The version of the OpenAPI document: 1.3.5055
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -987,6 +987,19 @@ export interface V1GetInstructionRequestUploadHealth {
      */
     'averageUploadDurationSeconds'?: number;
 }
+/**
+ * 
+ * @export
+ * @interface V1GetNodeCommandsResponse
+ */
+export interface V1GetNodeCommandsResponse {
+    /**
+     * 
+     * @type {Array<V1NodeCommand>}
+     * @memberof V1GetNodeCommandsResponse
+     */
+    'nodeCommands': Array<V1NodeCommand>;
+}
 /**
  * 
  * @export
@@ -1283,6 +1296,19 @@ export interface V1GroundStationParticipant {
 }
 
 
+/**
+ * 
+ * @export
+ * @interface V1Halt
+ */
+export interface V1Halt {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof V1Halt
+     */
+    'placeholder'?: boolean;
+}
 /**
  * An image set represents a contiguous set of observations of the same target captured by the same node.
  * @export
@@ -1780,6 +1806,60 @@ export interface V1Node {
 }
 
 
+/**
+ * 
+ * @export
+ * @interface V1NodeCommand
+ */
+export interface V1NodeCommand {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1NodeCommand
+     */
+    'id': string;
+    /**
+     * 
+     * @type {V1NodeCommandType}
+     * @memberof V1NodeCommand
+     */
+    'type': V1NodeCommandType;
+    /**
+     * 
+     * @type {V1NodeCommandBody}
+     * @memberof V1NodeCommand
+     */
+    'body': V1NodeCommandBody;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1NodeCommand
+     */
+    'executableAt'?: string;
+}
+
+
+/**
+ * @type V1NodeCommandBody
+ * @export
+ */
+export type V1NodeCommandBody = V1Halt | V1StartPerpetualInstructionLoop | V1StopPerpetualInstructionLoop;
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const V1NodeCommandType = {
+    V1_START_PERPETUAL_INSTRUCTION_LOOP: 'V1_START_PERPETUAL_INSTRUCTION_LOOP',
+    V1_STOP_PERPETUAL_INSTRUCTION_LOOP: 'V1_STOP_PERPETUAL_INSTRUCTION_LOOP',
+    V1_HALT: 'V1_HALT'
+} as const;
+
+export type V1NodeCommandType = typeof V1NodeCommandType[keyof typeof V1NodeCommandType];
+
+
 /**
  * 
  * @export
@@ -2445,6 +2525,32 @@ export interface V1SlewTimingInterval {
      */
     'durationMs': number;
 }
+/**
+ * 
+ * @export
+ * @interface V1StartPerpetualInstructionLoop
+ */
+export interface V1StartPerpetualInstructionLoop {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof V1StartPerpetualInstructionLoop
+     */
+    'placeholder'?: boolean;
+}
+/**
+ * 
+ * @export
+ * @interface V1StopPerpetualInstructionLoop
+ */
+export interface V1StopPerpetualInstructionLoop {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof V1StopPerpetualInstructionLoop
+     */
+    'placeholder'?: boolean;
+}
 /**
  * 
  * @export
@@ -3451,6 +3557,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Delete a node command
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1DeleteNodeCommand: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('v1DeleteNodeCommand', 'id', id)
+            const localVarPath = `/v1/node-commands`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication Roles required
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (id !== undefined) {
+                localVarQueryParameter['id'] = id;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3779,6 +3927,57 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get node commands
+         * @param {string} nodeId 
+         * @param {string} executableAt 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetNodeCommands: async (nodeId: string, executableAt: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'nodeId' is not null or undefined
+            assertParamExists('v1GetNodeCommands', 'nodeId', nodeId)
+            // verify required parameter 'executableAt' is not null or undefined
+            assertParamExists('v1GetNodeCommands', 'executableAt', executableAt)
+            const localVarPath = `/v1/node-commands`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication Roles required
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (nodeId !== undefined) {
+                localVarQueryParameter['nodeId'] = nodeId;
+            }
+
+            if (executableAt !== undefined) {
+                localVarQueryParameter['executableAt'] = (executableAt as any instanceof Date) ?
+                    (executableAt as any).toISOString() :
+                    executableAt;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -4539,6 +4738,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteImageSetImage(imageId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Delete a node command
+         * @param {string} id 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1DeleteNodeCommand(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteNodeCommand(id, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get cameras.
          * @param {*} [options] Override http request option.
@@ -4618,6 +4827,17 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNode(lineageId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get node commands
+         * @param {string} nodeId 
+         * @param {string} executableAt 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1GetNodeCommands(nodeId: string, executableAt: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetNodeCommandsResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNodeCommands(nodeId, executableAt, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * returns the current release for the node
          * @param {string} lineageId lineage id
@@ -4904,6 +5124,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
             return localVarFp.v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Delete a node command
+         * @param {DefaultApiV1DeleteNodeCommandRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1DeleteNodeCommand(requestParameters: DefaultApiV1DeleteNodeCommandRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
+            return localVarFp.v1DeleteNodeCommand(requestParameters.id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get cameras.
          * @param {*} [options] Override http request option.
@@ -4975,6 +5204,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1GetNode(requestParameters: DefaultApiV1GetNodeRequest, options?: AxiosRequestConfig): AxiosPromise<V1Node> {
             return localVarFp.v1GetNode(requestParameters.lineageId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get node commands
+         * @param {DefaultApiV1GetNodeCommandsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetNodeCommands(requestParameters: DefaultApiV1GetNodeCommandsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetNodeCommandsResponse> {
+            return localVarFp.v1GetNodeCommands(requestParameters.nodeId, requestParameters.executableAt, options).then((request) => request(axios, basePath));
+        },
         /**
          * returns the current release for the node
          * @param {DefaultApiV1GetNodeControllerReleaseRequest} requestParameters Request parameters.
@@ -5348,6 +5586,20 @@ export interface DefaultApiV1DeleteImageSetImageRequest {
     readonly imageId: string
 }
 
+/**
+ * Request parameters for v1DeleteNodeCommand operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1DeleteNodeCommandRequest
+ */
+export interface DefaultApiV1DeleteNodeCommandRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1DeleteNodeCommand
+     */
+    readonly id: string
+}
+
 /**
  * Request parameters for v1GetImageSet operation in DefaultApi.
  * @export
@@ -5446,6 +5698,27 @@ export interface DefaultApiV1GetNodeRequest {
     readonly lineageId: string
 }
 
+/**
+ * Request parameters for v1GetNodeCommands operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetNodeCommandsRequest
+ */
+export interface DefaultApiV1GetNodeCommandsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetNodeCommands
+     */
+    readonly nodeId: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetNodeCommands
+     */
+    readonly executableAt: string
+}
+
 /**
  * Request parameters for v1GetNodeControllerRelease operation in DefaultApi.
  * @export
@@ -5820,6 +6093,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Delete a node command
+     * @param {DefaultApiV1DeleteNodeCommandRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1DeleteNodeCommand(requestParameters: DefaultApiV1DeleteNodeCommandRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1DeleteNodeCommand(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get cameras.
      * @param {*} [options] Override http request option.
@@ -5907,6 +6191,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1GetNode(requestParameters.lineageId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get node commands
+     * @param {DefaultApiV1GetNodeCommandsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1GetNodeCommands(requestParameters: DefaultApiV1GetNodeCommandsRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1GetNodeCommands(requestParameters.nodeId, requestParameters.executableAt, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * returns the current release for the node
      * @param {DefaultApiV1GetNodeControllerReleaseRequest} requestParameters Request parameters.

package/base.ts

@@ -4,7 +4,7 @@
  * OurSky Platform
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.3.5020
+ * The version of the OpenAPI document: 1.3.5055
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * OurSky Platform
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.3.5020
+ * The version of the OpenAPI document: 1.3.5055
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * OurSky Platform
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.3.5020
+ * The version of the OpenAPI document: 1.3.5055
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).