@ourskyai/platform-api 1.3.2407 → 1.3.2584

package/README.md

@@ -1,4 +1,4 @@
-## @ourskyai/platform-api@1.3.2407
+## @ourskyai/platform-api@1.3.2584
 
 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.2407 --save
+npm install @ourskyai/platform-api@1.3.2584 --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.2407
+ * The version of the OpenAPI document: 1.3.2584
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -528,6 +528,33 @@ export interface V1CreateNodeRequest {
      */
     'location': Location;
 }
+/**
+ * 
+ * @export
+ * @interface V1CreateObservationInstructionRequest
+ */
+export interface V1CreateObservationInstructionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1CreateObservationInstructionRequest
+     */
+    'nodeId': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1CreateObservationInstructionRequest
+     */
+    'targetId': string;
+    /**
+     * 
+     * @type {TrackingType}
+     * @memberof V1CreateObservationInstructionRequest
+     */
+    'trackingType': TrackingType;
+}
+
+
 /**
  * 
  * @export
@@ -561,6 +588,21 @@ export interface V1CreateOpticalTubeRequest {
 }
 
 
+/**
+ * Diagnostic Instruction
+ * @export
+ * @interface V1DiagnosticInstruction
+ */
+export interface V1DiagnosticInstruction {
+    /**
+     * 
+     * @type {V1NodeDiagnosticType}
+     * @memberof V1DiagnosticInstruction
+     */
+    'diagnosticType': V1NodeDiagnosticType;
+}
+
+
 /**
  * Elevation Mask Point
  * @export
@@ -630,6 +672,25 @@ export interface V1GainCurvePoint {
      */
     'eADU': number;
 }
+/**
+ * 
+ * @export
+ * @interface V1GetInstructionRequest
+ */
+export interface V1GetInstructionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1GetInstructionRequest
+     */
+    'nodeId': string;
+    /**
+     * 
+     * @type {Array<V1NodeDiagnosticType>}
+     * @memberof V1GetInstructionRequest
+     */
+    'supportedDiagnostics': Array<V1NodeDiagnosticType>;
+}
 /**
  * 
  * @export
@@ -1151,6 +1212,31 @@ export interface V1ImageSetImage {
      */
     'exposureLength': number;
 }
+/**
+ * Instruction
+ * @export
+ * @interface V1Instruction
+ */
+export interface V1Instruction {
+    /**
+     * 
+     * @type {V1ObservationInstruction}
+     * @memberof V1Instruction
+     */
+    'observation'?: V1ObservationInstruction;
+    /**
+     * 
+     * @type {V1DiagnosticInstruction}
+     * @memberof V1Instruction
+     */
+    'diagnostic'?: V1DiagnosticInstruction;
+    /**
+     * Search Instruction
+     * @type {Array<V1ObservationInstruction>}
+     * @memberof V1Instruction
+     */
+    'search'?: Array<V1ObservationInstruction>;
+}
 /**
  * 
  * @export
@@ -1323,12 +1409,18 @@ export const V1NodeDiagnosticType = {
     CENTERING_TIME_MS: 'CENTERING_TIME_MS',
     POINTING_ERROR_DEGREES: 'POINTING_ERROR_DEGREES',
     CAMERA_CHECKED: 'CAMERA_CHECKED',
+    CAMERA_HAS_GPS: 'CAMERA_HAS_GPS',
     MOUNT_CHECKED: 'MOUNT_CHECKED',
     OPTICAL_TUBE_CHECKED: 'OPTICAL_TUBE_CHECKED',
     ELEVATION_MASK_CHECKED: 'ELEVATION_MASK_CHECKED',
     AVAILABLE_DISK_BYTES: 'AVAILABLE_DISK_BYTES',
     AVAILABLE_MEMORY_BYTES: 'AVAILABLE_MEMORY_BYTES',
-    NTP_TIME_DRIFT_MS: 'NTP_TIME_DRIFT_MS'
+    NTP_TIME_DRIFT_MS: 'NTP_TIME_DRIFT_MS',
+    SYSTEM_UPTIME_S: 'SYSTEM_UPTIME_S',
+    APPLICATION_UPTIME_S: 'APPLICATION_UPTIME_S',
+    APPLICATION_CPU_TIME_S: 'APPLICATION_CPU_TIME_S',
+    CPU_USAGE_LAST_SECOND_PCT: 'CPU_USAGE_LAST_SECOND_PCT',
+    CPU_USAGE_LAST_MINUTE_PCT: 'CPU_USAGE_LAST_MINUTE_PCT'
 } as const;
 
 export type V1NodeDiagnosticType = typeof V1NodeDiagnosticType[keyof typeof V1NodeDiagnosticType];
@@ -1353,6 +1445,129 @@ export interface V1NodeWithLocation {
      */
     'location': Location;
 }
+/**
+ * Observation Instruction
+ * @export
+ * @interface V1ObservationInstruction
+ */
+export interface V1ObservationInstruction {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'imageSetId': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'targetId': string;
+    /**
+     * 
+     * @type {TrackingType}
+     * @memberof V1ObservationInstruction
+     */
+    'trackingType': TrackingType;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'exposureDuration': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'binning': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'gain': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'gainMode': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'ra': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'dec': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'captureStart': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'captureEnd': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'preCaptureWait': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'startSlewAt': string;
+    /**
+     * 
+     * @type {CameraMode}
+     * @memberof V1ObservationInstruction
+     */
+    'cameraMode': CameraMode;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'tleLine1': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationInstruction
+     */
+    'tleLine2': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'tleOffsetDec'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationInstruction
+     */
+    'tleOffsetRa'?: number;
+}
+
+
 /**
  * Optical Tube
  * @export
@@ -2332,6 +2547,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Create an observation instruction.
+         * @param {V1CreateObservationInstructionRequest} v1CreateObservationInstructionRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1CreateObservationInstruction: async (v1CreateObservationInstructionRequest: V1CreateObservationInstructionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'v1CreateObservationInstructionRequest' is not null or undefined
+            assertParamExists('v1CreateObservationInstruction', 'v1CreateObservationInstructionRequest', v1CreateObservationInstructionRequest)
+            const localVarPath = `/v1/observation-instruction`;
+            // 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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication Roles required
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(v1CreateObservationInstructionRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create an optical tube.
          * @param {V1CreateOpticalTubeRequest} v1CreateOpticalTubeRequest 
@@ -2576,6 +2832,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get instruction.
+         * @param {V1GetInstructionRequest} v1GetInstructionRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetInstruction: async (v1GetInstructionRequest: V1GetInstructionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'v1GetInstructionRequest' is not null or undefined
+            assertParamExists('v1GetInstruction', 'v1GetInstructionRequest', v1GetInstructionRequest)
+            const localVarPath = `/v1/instruction`;
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication Roles required
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(v1GetInstructionRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get a mount.
          * @param {string} id 
@@ -3300,6 +3597,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateNodeDiagnostics(v1CreateNodeDiagnosticsRequest, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Create an observation instruction.
+         * @param {V1CreateObservationInstructionRequest} v1CreateObservationInstructionRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1CreateObservationInstruction(v1CreateObservationInstructionRequest: V1CreateObservationInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateObservationInstruction(v1CreateObservationInstructionRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Create an optical tube.
          * @param {V1CreateOpticalTubeRequest} v1CreateOpticalTubeRequest 
@@ -3359,6 +3666,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetImageSetImage(imageId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get instruction.
+         * @param {V1GetInstructionRequest} v1GetInstructionRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1GetInstruction(v1GetInstructionRequest: V1GetInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1Instruction>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetInstruction(v1GetInstructionRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get a mount.
          * @param {string} id 
@@ -3593,6 +3910,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1CreateNodeDiagnostics(requestParameters: DefaultApiV1CreateNodeDiagnosticsRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
             return localVarFp.v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticsRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Create an observation instruction.
+         * @param {DefaultApiV1CreateObservationInstructionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1CreateObservationInstruction(requestParameters: DefaultApiV1CreateObservationInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
+            return localVarFp.v1CreateObservationInstruction(requestParameters.v1CreateObservationInstructionRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create an optical tube.
          * @param {DefaultApiV1CreateOpticalTubeRequest} requestParameters Request parameters.
@@ -3646,6 +3972,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1GetImageSetImage(requestParameters: DefaultApiV1GetImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageSetImage> {
             return localVarFp.v1GetImageSetImage(requestParameters.imageId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get instruction.
+         * @param {DefaultApiV1GetInstructionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetInstruction(requestParameters: DefaultApiV1GetInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<V1Instruction> {
+            return localVarFp.v1GetInstruction(requestParameters.v1GetInstructionRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get a mount.
          * @param {DefaultApiV1GetMountRequest} requestParameters Request parameters.
@@ -3944,6 +4279,20 @@ export interface DefaultApiV1CreateNodeDiagnosticsRequest {
     readonly v1CreateNodeDiagnosticsRequest: V1CreateNodeDiagnosticsRequest
 }
 
+/**
+ * Request parameters for v1CreateObservationInstruction operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1CreateObservationInstructionRequest
+ */
+export interface DefaultApiV1CreateObservationInstructionRequest {
+    /**
+     * 
+     * @type {V1CreateObservationInstructionRequest}
+     * @memberof DefaultApiV1CreateObservationInstruction
+     */
+    readonly v1CreateObservationInstructionRequest: V1CreateObservationInstructionRequest
+}
+
 /**
  * Request parameters for v1CreateOpticalTube operation in DefaultApi.
  * @export
@@ -4014,6 +4363,20 @@ export interface DefaultApiV1GetImageSetImageRequest {
     readonly imageId: string
 }
 
+/**
+ * Request parameters for v1GetInstruction operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetInstructionRequest
+ */
+export interface DefaultApiV1GetInstructionRequest {
+    /**
+     * 
+     * @type {V1GetInstructionRequest}
+     * @memberof DefaultApiV1GetInstruction
+     */
+    readonly v1GetInstructionRequest: V1GetInstructionRequest
+}
+
 /**
  * Request parameters for v1GetMount operation in DefaultApi.
  * @export
@@ -4326,6 +4689,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticsRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Create an observation instruction.
+     * @param {DefaultApiV1CreateObservationInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1CreateObservationInstruction(requestParameters: DefaultApiV1CreateObservationInstructionRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1CreateObservationInstruction(requestParameters.v1CreateObservationInstructionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Create an optical tube.
      * @param {DefaultApiV1CreateOpticalTubeRequest} requestParameters Request parameters.
@@ -4391,6 +4765,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1GetImageSetImage(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get instruction.
+     * @param {DefaultApiV1GetInstructionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1GetInstruction(requestParameters: DefaultApiV1GetInstructionRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1GetInstruction(requestParameters.v1GetInstructionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get a mount.
      * @param {DefaultApiV1GetMountRequest} 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.2407
+ * The version of the OpenAPI document: 1.3.2584
  * 
  *
  * 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.2407
+ * The version of the OpenAPI document: 1.3.2584
  * 
  *
  * 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.2407
+ * The version of the OpenAPI document: 1.3.2584
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).