@ourskyai/platform-api 1.3.1945 → 1.3.2078

package/README.md

@@ -1,4 +1,4 @@
-## @ourskyai/platform-api@1.3.1945
+## @ourskyai/platform-api@1.3.2078
 
 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.1945 --save
+npm install @ourskyai/platform-api@1.3.2078 --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.1945
+ * The version of the OpenAPI document: 1.3.2078
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -293,6 +293,12 @@ export interface V1Camera {
      * @memberof V1Camera
      */
     'isColor': boolean;
+    /**
+     * 
+     * @type {Array<V1VideoModeFramerateProperty>}
+     * @memberof V1Camera
+     */
+    'videoModeFramerateProperties'?: Array<V1VideoModeFramerateProperty>;
 }
 
 
@@ -410,48 +416,61 @@ export interface V1CreateMountRequest {
 /**
  * 
  * @export
- * @interface V1CreateNodeDiagnosticRequest
+ * @interface V1CreateNodeDiagnostic
  */
-export interface V1CreateNodeDiagnosticRequest {
-    /**
-     * 
-     * @type {string}
-     * @memberof V1CreateNodeDiagnosticRequest
-     */
-    'nodeId': string;
+export interface V1CreateNodeDiagnostic {
     /**
      * 
      * @type {V1NodeComponentType}
-     * @memberof V1CreateNodeDiagnosticRequest
+     * @memberof V1CreateNodeDiagnostic
      */
     'componentType': V1NodeComponentType;
     /**
      * 
      * @type {string}
-     * @memberof V1CreateNodeDiagnosticRequest
+     * @memberof V1CreateNodeDiagnostic
      */
     'componentId': string;
     /**
      * 
      * @type {V1NodeDiagnosticType}
-     * @memberof V1CreateNodeDiagnosticRequest
+     * @memberof V1CreateNodeDiagnostic
      */
     'diagnosticType': V1NodeDiagnosticType;
     /**
      * 
      * @type {string}
-     * @memberof V1CreateNodeDiagnosticRequest
+     * @memberof V1CreateNodeDiagnostic
      */
     'value': string;
     /**
      * 
      * @type {string}
-     * @memberof V1CreateNodeDiagnosticRequest
+     * @memberof V1CreateNodeDiagnostic
      */
     'measuredAt': string;
 }
 
 
+/**
+ * 
+ * @export
+ * @interface V1CreateNodeDiagnosticsRequest
+ */
+export interface V1CreateNodeDiagnosticsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1CreateNodeDiagnosticsRequest
+     */
+    'nodeId': string;
+    /**
+     * 
+     * @type {Array<V1CreateNodeDiagnostic>}
+     * @memberof V1CreateNodeDiagnosticsRequest
+     */
+    'diagnostics': Array<V1CreateNodeDiagnostic>;
+}
 /**
  * 
  * @export
@@ -674,6 +693,12 @@ export interface V1GetOrCreateCameraRequest {
      * @memberof V1GetOrCreateCameraRequest
      */
     'isColor'?: boolean;
+    /**
+     * 
+     * @type {Array<V1VideoModeFramerateProperty>}
+     * @memberof V1GetOrCreateCameraRequest
+     */
+    'videoModeFramerateProperties'?: Array<V1VideoModeFramerateProperty>;
 }
 
 
@@ -1204,7 +1229,13 @@ export const V1NodeDiagnosticType = {
     MIN_SLEW_AND_CENTER_SPEED_MS: 'MIN_SLEW_AND_CENTER_SPEED_MS',
     MAX_SLEW_AND_CENTER_SPEED_MS: 'MAX_SLEW_AND_CENTER_SPEED_MS',
     MIN_SLEW_ACCURACY_ARCSECONDS: 'MIN_SLEW_ACCURACY_ARCSECONDS',
-    MAX_SLEW_ACCURACY_ARCSECONDS: 'MAX_SLEW_ACCURACY_ARCSECONDS'
+    MAX_SLEW_ACCURACY_ARCSECONDS: 'MAX_SLEW_ACCURACY_ARCSECONDS',
+    SLEW_SPEED_DEGREES_PER_SECOND: 'SLEW_SPEED_DEGREES_PER_SECOND',
+    CENTERING_TIME_MS: 'CENTERING_TIME_MS',
+    POINTING_ERROR_DEGREES: 'POINTING_ERROR_DEGREES',
+    CAMERA_CHECKED: 'CAMERA_CHECKED',
+    MOUNT_CHECKED: 'MOUNT_CHECKED',
+    OPTICAL_TUBE_CHECKED: 'OPTICAL_TUBE_CHECKED'
 } as const;
 
 export type V1NodeDiagnosticType = typeof V1NodeDiagnosticType[keyof typeof V1NodeDiagnosticType];
@@ -1597,6 +1628,62 @@ export interface V1UpdateNodeMetricsRequest {
      */
     'measuredAt': string;
 }
+/**
+ * 
+ * @export
+ * @interface V1VideoModeFramerateProperty
+ */
+export interface V1VideoModeFramerateProperty {
+    /**
+     * 
+     * @type {number}
+     * @memberof V1VideoModeFramerateProperty
+     */
+    'roiXPixels': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1VideoModeFramerateProperty
+     */
+    'roiYPixels': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1VideoModeFramerateProperty
+     */
+    'adcBitDepth': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1VideoModeFramerateProperty
+     */
+    'fps': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1VideoModeFramerateProperty
+     */
+    'binning': number;
+}
+/**
+ * 
+ * @export
+ * @interface V2CompleteObservationRequest
+ */
+export interface V2CompleteObservationRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2CompleteObservationRequest
+     */
+    'imageSetId': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof V2CompleteObservationRequest
+     */
+    'expectedImageCount': number;
+}
 /**
  * 
  * @export
@@ -1997,13 +2084,13 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
         },
         /**
          * Create node diagnostics.
-         * @param {Array<V1CreateNodeDiagnosticRequest>} v1CreateNodeDiagnosticRequest 
+         * @param {V1CreateNodeDiagnosticsRequest} v1CreateNodeDiagnosticsRequest 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        v1CreateNodeDiagnostics: async (v1CreateNodeDiagnosticRequest: Array<V1CreateNodeDiagnosticRequest>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'v1CreateNodeDiagnosticRequest' is not null or undefined
-            assertParamExists('v1CreateNodeDiagnostics', 'v1CreateNodeDiagnosticRequest', v1CreateNodeDiagnosticRequest)
+        v1CreateNodeDiagnostics: async (v1CreateNodeDiagnosticsRequest: V1CreateNodeDiagnosticsRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'v1CreateNodeDiagnosticsRequest' is not null or undefined
+            assertParamExists('v1CreateNodeDiagnostics', 'v1CreateNodeDiagnosticsRequest', v1CreateNodeDiagnosticsRequest)
             const localVarPath = `/v1/node-diagnostics`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -2029,7 +2116,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(v1CreateNodeDiagnosticRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(v1CreateNodeDiagnosticsRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -2694,6 +2781,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Complete an observation utilizing the async pipeline.
+         * @param {V2CompleteObservationRequest} v2CompleteObservationRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v2CompleteObservation: async (v2CompleteObservationRequest: V2CompleteObservationRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'v2CompleteObservationRequest' is not null or undefined
+            assertParamExists('v2CompleteObservation', 'v2CompleteObservationRequest', v2CompleteObservationRequest)
+            const localVarPath = `/v2/observation-complete`;
+            // 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(v2CompleteObservationRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get next observation.
          * @param {string} nodeId 
@@ -2815,12 +2943,12 @@ export const DefaultApiFp = function(configuration?: Configuration) {
         },
         /**
          * Create node diagnostics.
-         * @param {Array<V1CreateNodeDiagnosticRequest>} v1CreateNodeDiagnosticRequest 
+         * @param {V1CreateNodeDiagnosticsRequest} v1CreateNodeDiagnosticsRequest 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async v1CreateNodeDiagnostics(v1CreateNodeDiagnosticRequest: Array<V1CreateNodeDiagnosticRequest>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateNodeDiagnostics(v1CreateNodeDiagnosticRequest, options);
+        async v1CreateNodeDiagnostics(v1CreateNodeDiagnosticsRequest: V1CreateNodeDiagnosticsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateNodeDiagnostics(v1CreateNodeDiagnosticsRequest, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -2983,6 +3111,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateNodeMetrics(v1UpdateNodeMetricsRequest, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Complete an observation utilizing the async pipeline.
+         * @param {V2CompleteObservationRequest} v2CompleteObservationRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v2CompleteObservation(v2CompleteObservationRequest: V2CompleteObservationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v2CompleteObservation(v2CompleteObservationRequest, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get next observation.
          * @param {string} nodeId 
@@ -3064,7 +3202,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         v1CreateNodeDiagnostics(requestParameters: DefaultApiV1CreateNodeDiagnosticsRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
-            return localVarFp.v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticRequest, options).then((request) => request(axios, basePath));
+            return localVarFp.v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticsRequest, options).then((request) => request(axios, basePath));
         },
         /**
          * Create an optical tube.
@@ -3208,6 +3346,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1UpdateNodeMetrics(requestParameters: DefaultApiV1UpdateNodeMetricsRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
             return localVarFp.v1UpdateNodeMetrics(requestParameters.v1UpdateNodeMetricsRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Complete an observation utilizing the async pipeline.
+         * @param {DefaultApiV2CompleteObservationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v2CompleteObservation(requestParameters: DefaultApiV2CompleteObservationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
+            return localVarFp.v2CompleteObservation(requestParameters.v2CompleteObservationRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get next observation.
          * @param {DefaultApiV2GetObservationRequest} requestParameters Request parameters.
@@ -3361,10 +3508,10 @@ export interface DefaultApiV1CreateMountRequest {
 export interface DefaultApiV1CreateNodeDiagnosticsRequest {
     /**
      * 
-     * @type {Array<V1CreateNodeDiagnosticRequest>}
+     * @type {V1CreateNodeDiagnosticsRequest}
      * @memberof DefaultApiV1CreateNodeDiagnostics
      */
-    readonly v1CreateNodeDiagnosticRequest: Array<V1CreateNodeDiagnosticRequest>
+    readonly v1CreateNodeDiagnosticsRequest: V1CreateNodeDiagnosticsRequest
 }
 
 /**
@@ -3577,6 +3724,20 @@ export interface DefaultApiV1UpdateNodeMetricsRequest {
     readonly v1UpdateNodeMetricsRequest: V1UpdateNodeMetricsRequest
 }
 
+/**
+ * Request parameters for v2CompleteObservation operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV2CompleteObservationRequest
+ */
+export interface DefaultApiV2CompleteObservationRequest {
+    /**
+     * 
+     * @type {V2CompleteObservationRequest}
+     * @memberof DefaultApiV2CompleteObservation
+     */
+    readonly v2CompleteObservationRequest: V2CompleteObservationRequest
+}
+
 /**
  * Request parameters for v2GetObservation operation in DefaultApi.
  * @export
@@ -3672,7 +3833,7 @@ export class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     public v1CreateNodeDiagnostics(requestParameters: DefaultApiV1CreateNodeDiagnosticsRequest, options?: AxiosRequestConfig) {
-        return DefaultApiFp(this.configuration).v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticRequest, options).then((request) => request(this.axios, this.basePath));
+        return DefaultApiFp(this.configuration).v1CreateNodeDiagnostics(requestParameters.v1CreateNodeDiagnosticsRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -3849,6 +4010,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1UpdateNodeMetrics(requestParameters.v1UpdateNodeMetricsRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Complete an observation utilizing the async pipeline.
+     * @param {DefaultApiV2CompleteObservationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v2CompleteObservation(requestParameters: DefaultApiV2CompleteObservationRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v2CompleteObservation(requestParameters.v2CompleteObservationRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get next observation.
      * @param {DefaultApiV2GetObservationRequest} 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.1945
+ * The version of the OpenAPI document: 1.3.2078
  * 
  *
  * 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.1945
+ * The version of the OpenAPI document: 1.3.2078
  * 
  *
  * 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.1945
+ * The version of the OpenAPI document: 1.3.2078
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).