@ourskyai/sda-api 1.3.2765 → 1.3.2816

package/README.md

@@ -1,4 +1,4 @@
-## @ourskyai/sda-api@1.3.2765
+## @ourskyai/sda-api@1.3.2816
 
 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.2765 --save
+npm install @ourskyai/sda-api@1.3.2816 --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.2765
+ * The version of the OpenAPI document: 1.3.2816
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -179,55 +179,6 @@ export interface ObservationBoundingBox {
      */
     'endY': number;
 }
-/**
- * Observation Feature
- * @export
- * @interface ObservationFeature
- */
-export interface ObservationFeature {
-    /**
-     * 
-     * @type {number}
-     * @memberof ObservationFeature
-     */
-    'ra': number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ObservationFeature
-     */
-    'dec': number;
-    /**
-     * 
-     * @type {string}
-     * @memberof ObservationFeature
-     */
-    'timestamp': string;
-    /**
-     * 
-     * @type {ObservationBoundingBox}
-     * @memberof ObservationFeature
-     */
-    'boundingBox'?: ObservationBoundingBox;
-    /**
-     * BETA: the apparent magnitude of the target at the time of the observation
-     * @type {number}
-     * @memberof ObservationFeature
-     */
-    'apparentMagnitude'?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof ObservationFeature
-     */
-    'distanceFromPrediction'?: number;
-    /**
-     * 
-     * @type {Array<TargetCorrelation>}
-     * @memberof ObservationFeature
-     */
-    'targetCorrelations'?: Array<TargetCorrelation>;
-}
 /**
  * 
  * @export
@@ -327,10 +278,10 @@ export interface ObservationResult {
     'distanceFromPrediction'?: number;
     /**
      * 
-     * @type {Array<ObservationFeature>}
+     * @type {Array<V1ObservationFeature>}
      * @memberof ObservationResult
      */
-    'features'?: Array<ObservationFeature>;
+    'features'?: Array<V1ObservationFeature>;
 }
 /**
  * 
@@ -394,31 +345,6 @@ export interface SuccessfulCreate {
      */
     'id': string;
 }
-/**
- * Target Correlation
- * @export
- * @interface TargetCorrelation
- */
-export interface TargetCorrelation {
-    /**
-     * 
-     * @type {string}
-     * @memberof TargetCorrelation
-     */
-    'targetId': string;
-    /**
-     * 
-     * @type {number}
-     * @memberof TargetCorrelation
-     */
-    'ra': number;
-    /**
-     * 
-     * @type {number}
-     * @memberof TargetCorrelation
-     */
-    'dec': number;
-}
 /**
  * 
  * @export
@@ -938,6 +864,55 @@ export interface V1ImageSetImage {
      */
     'exposureLength': number;
 }
+/**
+ * Observation Feature
+ * @export
+ * @interface V1ObservationFeature
+ */
+export interface V1ObservationFeature {
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationFeature
+     */
+    'ra': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationFeature
+     */
+    'dec': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationFeature
+     */
+    'timestamp': string;
+    /**
+     * 
+     * @type {ObservationBoundingBox}
+     * @memberof V1ObservationFeature
+     */
+    'boundingBox'?: ObservationBoundingBox;
+    /**
+     * BETA: the apparent magnitude of the target at the time of the observation
+     * @type {number}
+     * @memberof V1ObservationFeature
+     */
+    'apparentMagnitude'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationFeature
+     */
+    'distanceFromPrediction'?: number;
+    /**
+     * 
+     * @type {Array<V1TargetCorrelation>}
+     * @memberof V1ObservationFeature
+     */
+    'targetCorrelations'?: Array<V1TargetCorrelation>;
+}
 /**
  * Observation Sequence Result
  * @export
@@ -1018,6 +993,87 @@ export interface V1ObservationSequenceResultImageSetsInner {
      */
     'observationQuality'?: ObservationQuality;
 }
+/**
+ * 
+ * @export
+ * @interface V1ObservationStatus
+ */
+export interface V1ObservationStatus {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'targetId': string;
+    /**
+     * 
+     * @type {TrackingType}
+     * @memberof V1ObservationStatus
+     */
+    'trackingType'?: TrackingType;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationStatus
+     */
+    'ra': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1ObservationStatus
+     */
+    'dec': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'observationTime': string;
+    /**
+     * TLE line 1 of when the observation was tasked
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'tleLine1': string;
+    /**
+     * TLE line 2 of when the observation was tasked
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'tleLine2': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'tleEpoch': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'imageSetId'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'observationSequenceResultId'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V1ObservationStatus
+     */
+    'searchInstructionId'?: string;
+}
+
+
 /**
  * 
  * @export
@@ -1145,6 +1201,31 @@ export interface V1SatelliteTarget {
 }
 
 
+/**
+ * Target Correlation
+ * @export
+ * @interface V1TargetCorrelation
+ */
+export interface V1TargetCorrelation {
+    /**
+     * 
+     * @type {string}
+     * @memberof V1TargetCorrelation
+     */
+    'targetId': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1TargetCorrelation
+     */
+    'ra': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof V1TargetCorrelation
+     */
+    'dec': number;
+}
 /**
  * TDM
  * @export
@@ -1969,6 +2050,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,
+            };
+        },
+        /**
+         * Get observation features.
+         * @param {string} imageId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetObservationFeatures: async (imageId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'imageId' is not null or undefined
+            assertParamExists('v1GetObservationFeatures', 'imageId', imageId)
+            const localVarPath = `/v1/observation-features`;
+            // 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 (imageId !== undefined) {
+                localVarQueryParameter['imageId'] = imageId;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -2016,6 +2139,58 @@ 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 the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+         * @param {string} [targetId] 
+         * @param {string} [before] 
+         * @param {string} [searchInstructionId] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/v1/observation-statuses`;
+            // 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 (targetId !== undefined) {
+                localVarQueryParameter['targetId'] = targetId;
+            }
+
+            if (before !== undefined) {
+                localVarQueryParameter['before'] = (before as any instanceof Date) ?
+                    (before as any).toISOString() :
+                    before;
+            }
+
+            if (searchInstructionId !== undefined) {
+                localVarQueryParameter['searchInstructionId'] = searchInstructionId;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -2521,6 +2696,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNodeProperties(nodeId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get observation features.
+         * @param {string} imageId 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1GetObservationFeatures(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationFeature>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationFeatures(imageId, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time.  To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
          * @param {string} [targetId] 
@@ -2532,6 +2717,18 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationSequenceResults(targetId, after, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+         * @param {string} [targetId] 
+         * @param {string} [before] 
+         * @param {string} [searchInstructionId] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, 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.
@@ -2757,6 +2954,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant> {
             return localVarFp.v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get observation features.
+         * @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationFeature>> {
+            return localVarFp.v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time.  To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
          * @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
@@ -2766,6 +2972,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         v1GetObservationSequenceResults(requestParameters: DefaultApiV1GetObservationSequenceResultsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>> {
             return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+         * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
+            return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
          * @param {*} [options] Override http request option.
@@ -3035,6 +3250,20 @@ export interface DefaultApiV1GetNodePropertiesRequest {
     readonly nodeId: string
 }
 
+/**
+ * Request parameters for v1GetObservationFeatures operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetObservationFeaturesRequest
+ */
+export interface DefaultApiV1GetObservationFeaturesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetObservationFeatures
+     */
+    readonly imageId: string
+}
+
 /**
  * Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
  * @export
@@ -3056,6 +3285,34 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
     readonly after?: string
 }
 
+/**
+ * Request parameters for v1GetObservationStatuses operation in DefaultApi.
+ * @export
+ * @interface DefaultApiV1GetObservationStatusesRequest
+ */
+export interface DefaultApiV1GetObservationStatusesRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetObservationStatuses
+     */
+    readonly targetId?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetObservationStatuses
+     */
+    readonly before?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof DefaultApiV1GetObservationStatuses
+     */
+    readonly searchInstructionId?: string
+}
+
 /**
  * Request parameters for v1GetSatellitePotentials operation in DefaultApi.
  * @export
@@ -3332,6 +3589,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get observation features.
+     * @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time.  To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
      * @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
@@ -3343,6 +3611,17 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`.  By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter.  When searching by `searchInstructionId`, a `before` timestamp is not required.
+     * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, 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.

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.2765
+ * The version of the OpenAPI document: 1.3.2816
  * 
  *
  * 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.2765
+ * The version of the OpenAPI document: 1.3.2816
  * 
  *
  * 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.2765
+ * The version of the OpenAPI document: 1.3.2816
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).