@ourskyai/sda-api 1.3.3445 → 1.3.3644

package/README.md

@@ -1,4 +1,4 @@
-## @ourskyai/sda-api@1.3.3445
+## @ourskyai/sda-api@1.3.3644
 
 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/sda-api@1.3.3445 --save
+npm install @ourskyai/sda-api@1.3.3644 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * OurSky SDA
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
  *
- * The version of the OpenAPI document: 1.3.3445
+ * The version of the OpenAPI document: 1.3.3644
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,37 +30,37 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base';
  */
 export interface AstrometricOffsets {
     /**
-     * 
+     * the average offset from the star catalog (NOMAD or GAIA DR3) for right ascension in degrees in EME2000 frame
      * @type {number}
      * @memberof AstrometricOffsets
      */
     'raPlateSolveOffsetAverage': number;
     /**
-     * 
+     * the standard deviation of offset from the star catalog (NOMAD or GAIA DR3) for right ascension in degrees in EME2000 frame
      * @type {number}
      * @memberof AstrometricOffsets
      */
     'raPlateSolveOffsetStdDev': number;
     /**
-     * 
+     * the average offset from the star catalog (NOMAD or GAIA DR3) for declination in degrees in EME2000 frame
      * @type {number}
      * @memberof AstrometricOffsets
      */
     'decPlateSolveOffsetAverage': number;
     /**
-     * 
+     * the standard deviation of offset from the star catalog (NOMAD or GAIA DR3) for declination in degrees in EME2000 frame
      * @type {number}
      * @memberof AstrometricOffsets
      */
     'decPlateSolveOffsetStdDev': number;
     /**
-     * 
+     * The standard deviation of the full-width-half-max of all stars in the image measured in arcseconds
      * @type {number}
      * @memberof AstrometricOffsets
      */
     'fwhmStdDev': number;
     /**
-     * 
+     * The average of the full-width-half-max of all stars in the image measured in arcseconds
      * @type {number}
      * @memberof AstrometricOffsets
      */
@@ -109,6 +109,25 @@ export const FilterType = {
 export type FilterType = typeof FilterType[keyof typeof FilterType];
 
 
+/**
+ * 
+ * @export
+ * @interface FitsHeader
+ */
+export interface FitsHeader {
+    /**
+     * 
+     * @type {string}
+     * @memberof FitsHeader
+     */
+    'key': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FitsHeader
+     */
+    'value': string;
+}
 /**
  * Location
  * @export
@@ -241,25 +260,25 @@ export interface ObservationResult {
      */
     'jpgUrl'?: string;
     /**
-     * 
+     * The un-corrected apparent right ascension in degrees and EME2000 frame at the ground station
      * @type {number}
      * @memberof ObservationResult
      */
     'ra': number;
     /**
-     * 
+     * The un-corrected apparent declination in degrees and EME2000 frame at the ground station
      * @type {number}
      * @memberof ObservationResult
      */
     'dec': number;
     /**
-     * The measured right ascension calibrated for stellar aberration in degrees
+     * The measured right ascension calibrated for stellar aberration in degrees and EME2000 frame
      * @type {number}
      * @memberof ObservationResult
      */
     'correctedRa'?: number;
     /**
-     * The measured declination calibrated for stellar aberration in degrees
+     * The measured declination calibrated for stellar aberration in degrees and EME2000 frame
      * @type {number}
      * @memberof ObservationResult
      */
@@ -276,6 +295,12 @@ export interface ObservationResult {
      * @memberof ObservationResult
      */
     'timestamp': string;
+    /**
+     * Timestamps for this image are considered to be accurate to within +/- this value in seconds
+     * @type {number}
+     * @memberof ObservationResult
+     */
+    'timingAccuracy': number;
     /**
      * BETA: the apparent magnitude of the target at the time of the observation
      * @type {number}
@@ -283,7 +308,7 @@ export interface ObservationResult {
      */
     'apparentMagnitude'?: number;
     /**
-     * 
+     * The distance from the predicted location in arcseconds (using SGP4 propagation)
      * @type {number}
      * @memberof ObservationResult
      */
@@ -877,6 +902,12 @@ export interface V1ImageSetImage {
      * @memberof V1ImageSetImage
      */
     'exposureLength': number;
+    /**
+     * 
+     * @type {Array<FitsHeader>}
+     * @memberof V1ImageSetImage
+     */
+    'fitsHeaders': Array<FitsHeader>;
 }
 /**
  * Observation Feature
@@ -885,13 +916,13 @@ export interface V1ImageSetImage {
  */
 export interface V1ObservationFeature {
     /**
-     * 
+     * the right ascension in degrees in EME2000 frame
      * @type {number}
      * @memberof V1ObservationFeature
      */
     'ra': number;
     /**
-     * 
+     * the declination in degrees in EME2000 frame
      * @type {number}
      * @memberof V1ObservationFeature
      */
@@ -915,7 +946,7 @@ export interface V1ObservationFeature {
      */
     'apparentMagnitude'?: number;
     /**
-     * 
+     * The distance from the predicted location in arcseconds (using SGP4 propagation)
      * @type {number}
      * @memberof V1ObservationFeature
      */
@@ -1173,6 +1204,18 @@ export interface V1SatellitePotential {
      * @memberof V1SatellitePotential
      */
     'orbitType'?: OrbitType;
+    /**
+     * 
+     * @type {WeatherCondition}
+     * @memberof V1SatellitePotential
+     */
+    'weatherCondition'?: WeatherCondition;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1SatellitePotential
+     */
+    'weatherDescription'?: string;
 }
 
 
@@ -1378,17 +1421,35 @@ export interface V1TargetCorrelation {
      */
     'targetId': string;
     /**
-     * 
+     * The predicted (propagated) center of the targetId in Right Ascension in degrees
      * @type {number}
      * @memberof V1TargetCorrelation
      */
     'ra': number;
     /**
-     * 
+     * The predicted (propagated) center of the streak in Declination in degrees
      * @type {number}
      * @memberof V1TargetCorrelation
      */
     'dec': number;
+    /**
+     * The predicted (propagated) length of the target streak in degrees
+     * @type {number}
+     * @memberof V1TargetCorrelation
+     */
+    'streakLength'?: number;
+    /**
+     * The distance between the predicted and actual center of the streak in degrees
+     * @type {number}
+     * @memberof V1TargetCorrelation
+     */
+    'distanceFromStreak'?: number;
+    /**
+     * The angle between the predicted and actual angle-to-celestial-north for the streak in degrees
+     * @type {number}
+     * @memberof V1TargetCorrelation
+     */
+    'angleFromStreak'?: number;
 }
 /**
  * TDM
@@ -1565,6 +1626,25 @@ export interface V1WebhookConfiguration {
      */
     'createdAt': string;
 }
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const WeatherCondition = {
+    THUNDERSTORM: 'THUNDERSTORM',
+    DRIZZLE: 'DRIZZLE',
+    RAIN: 'RAIN',
+    SNOW: 'SNOW',
+    ATMOSPHERE: 'ATMOSPHERE',
+    CLEAR: 'CLEAR',
+    CLOUDS: 'CLOUDS'
+} as const;
+
+export type WeatherCondition = typeof WeatherCondition[keyof typeof WeatherCondition];
+
+
 /**
  * Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
  * @export
@@ -2485,6 +2565,55 @@ 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 potential observation windows for all satellites of your organization across the network from now until the `until` datetime
+         * @param {string} until 
+         * @param {boolean} [includeWeather] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetOrganizationSatellitePotentials: async (until: string, includeWeather?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'until' is not null or undefined
+            assertParamExists('v1GetOrganizationSatellitePotentials', 'until', until)
+            const localVarPath = `/v1/organization-target-potentials`;
+            // 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 (until !== undefined) {
+                localVarQueryParameter['until'] = (until as any instanceof Date) ?
+                    (until as any).toISOString() :
+                    until;
+            }
+
+            if (includeWeather !== undefined) {
+                localVarQueryParameter['includeWeather'] = includeWeather;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -2533,10 +2662,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
          * Get potential observation windows for a satellite across the network from now until the `until` datetime
          * @param {string} satelliteTargetId 
          * @param {string} until 
+         * @param {boolean} [includeWeather] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        v1GetSatellitePotentials: async (satelliteTargetId: string, until: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        v1GetSatellitePotentials: async (satelliteTargetId: string, until: string, includeWeather?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'satelliteTargetId' is not null or undefined
             assertParamExists('v1GetSatellitePotentials', 'satelliteTargetId', satelliteTargetId)
             // verify required parameter 'until' is not null or undefined
@@ -2569,6 +2699,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
                     until;
             }
 
+            if (includeWeather !== undefined) {
+                localVarQueryParameter['includeWeather'] = includeWeather;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -3180,6 +3314,17 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
+         * @param {string} until 
+         * @param {boolean} [includeWeather] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1GetOrganizationSatellitePotentials(until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetOrganizationSatellitePotentials(until, includeWeather, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
          * @param {*} [options] Override http request option.
@@ -3193,11 +3338,12 @@ export const DefaultApiFp = function(configuration?: Configuration) {
          * Get potential observation windows for a satellite across the network from now until the `until` datetime
          * @param {string} satelliteTargetId 
          * @param {string} until 
+         * @param {boolean} [includeWeather] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async v1GetSatellitePotentials(satelliteTargetId: string, until: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, options);
+        async v1GetSatellitePotentials(satelliteTargetId: string, until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, includeWeather, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -3489,6 +3635,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
             return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
+         * @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>> {
+            return localVarFp.v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
          * @param {*} [options] Override http request option.
@@ -3504,7 +3659,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>> {
-            return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
+            return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, requestParameters.includeWeather, options).then((request) => request(axios, basePath));
         },
         /**
          * Get a satellite target that the OurSky platform can currently track by id.
@@ -3897,6 +4052,27 @@ export interface DefaultApiV1GetObservationStatusesRequest {
     readonly surveyInstructionId?: string
 }
 
+/**
+ * Request parameters for v1GetOrganizationSatellitePotentials operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetOrganizationSatellitePotentialsRequest
+ */
+export interface DefaultApiV1GetOrganizationSatellitePotentialsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetOrganizationSatellitePotentials
+     */
+    readonly until: string
+
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DefaultApiV1GetOrganizationSatellitePotentials
+     */
+    readonly includeWeather?: boolean
+}
+
 /**
  * Request parameters for v1GetSatellitePotentials operation in DefaultApi.
  * @export
@@ -3916,6 +4092,13 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
      * @memberof DefaultApiV1GetSatellitePotentials
      */
     readonly until: string
+
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DefaultApiV1GetSatellitePotentials
+     */
+    readonly includeWeather?: boolean
 }
 
 /**
@@ -4281,6 +4464,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
+     * @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
      * @param {*} [options] Override http request option.
@@ -4299,7 +4493,7 @@ export class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     public v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig) {
-        return DefaultApiFp(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
+        return DefaultApiFp(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, requestParameters.includeWeather, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/base.ts

@@ -4,7 +4,7 @@
  * OurSky SDA
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
  *
- * The version of the OpenAPI document: 1.3.3445
+ * The version of the OpenAPI document: 1.3.3644
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * OurSky SDA
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
  *
- * The version of the OpenAPI document: 1.3.3445
+ * The version of the OpenAPI document: 1.3.3644
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * OurSky SDA
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
  *
- * The version of the OpenAPI document: 1.3.3445
+ * The version of the OpenAPI document: 1.3.3644
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).