@ourskyai/sda-api 1.3.8459 → 1.3.8815
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +108 -25
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +94 -22
- package/dist/api.js +49 -11
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +94 -22
- package/dist/esm/api.js +48 -10
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.V2GetSearchesStatusEnum = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.WebhookAuthType = exports.WeatherCondition = exports.V1StateVectorReferenceFrameEnum = exports.V1SatelliteCalibrationFamily = exports.V1PlateSolveStatus = exports.V1ImageFileType = exports.V1BlackoutVolumeRequestReferenceFrameEnum = exports.TrackingType = exports.ShutterType = exports.SearchCompletedReason = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.ObservationState = exports.MountType = exports.ImageSetType = exports.FilterType = void 0;
|
|
25
|
+
exports.V2GetSearchesStatusEnum = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.WebhookAuthType = exports.WeatherCondition = exports.V1StateVectorReferenceFrameEnum = exports.V1SatelliteCalibrationFamily = exports.V1PlateSolveStatus = exports.V1ImageRejectionReason = exports.V1ImageFileType = exports.V1BlackoutVolumeRequestReferenceFrameEnum = exports.TrackingType = exports.ShutterType = exports.SearchCompletedReason = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.ObservationState = exports.MountType = exports.ImageSetType = exports.FilterType = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -174,6 +174,39 @@ exports.V1ImageFileType = {
|
|
|
174
174
|
FITS: 'FITS',
|
|
175
175
|
JPG: 'JPG'
|
|
176
176
|
};
|
|
177
|
+
/**
|
|
178
|
+
*
|
|
179
|
+
* @export
|
|
180
|
+
* @enum {string}
|
|
181
|
+
*/
|
|
182
|
+
exports.V1ImageRejectionReason = {
|
|
183
|
+
TARGET_NOT_FOUND: 'TARGET_NOT_FOUND',
|
|
184
|
+
RATE_TARGET_NOT_FOUND: 'RATE_TARGET_NOT_FOUND',
|
|
185
|
+
RATE_PLATE_SOLVE_FAILURE: 'RATE_PLATE_SOLVE_FAILURE',
|
|
186
|
+
STREAK_DETECTION_FAILURE: 'STREAK_DETECTION_FAILURE',
|
|
187
|
+
PLATE_SOLVE_FAILURE: 'PLATE_SOLVE_FAILURE',
|
|
188
|
+
PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE: 'PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE',
|
|
189
|
+
PLATE_SOLVE_NO_SOLUTION_FAILURE: 'PLATE_SOLVE_NO_SOLUTION_FAILURE',
|
|
190
|
+
CROP_IMAGE_FAILURE: 'CROP_IMAGE_FAILURE',
|
|
191
|
+
COSMETIC_CORRECTION_FAILURE: 'COSMETIC_CORRECTION_FAILURE',
|
|
192
|
+
GRADIENT_REMOVAL_FAILURE: 'GRADIENT_REMOVAL_FAILURE',
|
|
193
|
+
CATMAG_FAILURE: 'CATMAG_FAILURE',
|
|
194
|
+
IMAGE_QUALITY_TOO_LOW: 'IMAGE_QUALITY_TOO_LOW',
|
|
195
|
+
OBSERVATION_NOT_FOUND: 'OBSERVATION_NOT_FOUND',
|
|
196
|
+
NODE_NOT_FOUND: 'NODE_NOT_FOUND',
|
|
197
|
+
CAMERA_NOT_FOUND: 'CAMERA_NOT_FOUND',
|
|
198
|
+
OTA_NOT_FOUND: 'OTA_NOT_FOUND',
|
|
199
|
+
TLE_NOT_EXTRACTED: 'TLE_NOT_EXTRACTED',
|
|
200
|
+
FAILED_TO_LOAD: 'FAILED_TO_LOAD',
|
|
201
|
+
GPS_ERROR: 'GPS_ERROR',
|
|
202
|
+
MUTEX_TIMEOUT: 'MUTEX_TIMEOUT',
|
|
203
|
+
AWAIT_TIMEOUT: 'AWAIT_TIMEOUT',
|
|
204
|
+
CATALOG_COMPARE_ERROR: 'CATALOG_COMPARE_ERROR',
|
|
205
|
+
SAVE_FAILURE: 'SAVE_FAILURE',
|
|
206
|
+
RATE_CATALOG_COMPARE_ERROR: 'RATE_CATALOG_COMPARE_ERROR',
|
|
207
|
+
MISSING_IMG_WIDTH_HEADER: 'MISSING_IMG_WIDTH_HEADER',
|
|
208
|
+
UNKNOWN_ERROR: 'UNKNOWN_ERROR'
|
|
209
|
+
};
|
|
177
210
|
/**
|
|
178
211
|
*
|
|
179
212
|
* @export
|
|
@@ -1238,17 +1271,18 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1238
1271
|
};
|
|
1239
1272
|
}),
|
|
1240
1273
|
/**
|
|
1241
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
1274
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
1242
1275
|
* @param {string} [targetId]
|
|
1243
1276
|
* @param {string} [before]
|
|
1244
1277
|
* @param {string} [searchInstructionId]
|
|
1245
1278
|
* @param {string} [surveyInstructionId]
|
|
1246
1279
|
* @param {string} [resolvedImageInstructionId]
|
|
1280
|
+
* @param {string} [directTaskId]
|
|
1247
1281
|
* @param {string} [imageId]
|
|
1248
1282
|
* @param {*} [options] Override http request option.
|
|
1249
1283
|
* @throws {RequiredError}
|
|
1250
1284
|
*/
|
|
1251
|
-
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1285
|
+
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1252
1286
|
const localVarPath = `/v1/observation-statuses`;
|
|
1253
1287
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1254
1288
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -1280,6 +1314,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1280
1314
|
if (resolvedImageInstructionId !== undefined) {
|
|
1281
1315
|
localVarQueryParameter['resolvedImageInstructionId'] = resolvedImageInstructionId;
|
|
1282
1316
|
}
|
|
1317
|
+
if (directTaskId !== undefined) {
|
|
1318
|
+
localVarQueryParameter['directTaskId'] = directTaskId;
|
|
1319
|
+
}
|
|
1283
1320
|
if (imageId !== undefined) {
|
|
1284
1321
|
localVarQueryParameter['imageId'] = imageId;
|
|
1285
1322
|
}
|
|
@@ -2516,19 +2553,20 @@ const DefaultApiFp = function (configuration) {
|
|
|
2516
2553
|
});
|
|
2517
2554
|
},
|
|
2518
2555
|
/**
|
|
2519
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
2556
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
2520
2557
|
* @param {string} [targetId]
|
|
2521
2558
|
* @param {string} [before]
|
|
2522
2559
|
* @param {string} [searchInstructionId]
|
|
2523
2560
|
* @param {string} [surveyInstructionId]
|
|
2524
2561
|
* @param {string} [resolvedImageInstructionId]
|
|
2562
|
+
* @param {string} [directTaskId]
|
|
2525
2563
|
* @param {string} [imageId]
|
|
2526
2564
|
* @param {*} [options] Override http request option.
|
|
2527
2565
|
* @throws {RequiredError}
|
|
2528
2566
|
*/
|
|
2529
|
-
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options) {
|
|
2567
|
+
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options) {
|
|
2530
2568
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2531
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options);
|
|
2569
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options);
|
|
2532
2570
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
2533
2571
|
});
|
|
2534
2572
|
},
|
|
@@ -3105,13 +3143,13 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
3105
3143
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
3106
3144
|
},
|
|
3107
3145
|
/**
|
|
3108
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3146
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3109
3147
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3110
3148
|
* @param {*} [options] Override http request option.
|
|
3111
3149
|
* @throws {RequiredError}
|
|
3112
3150
|
*/
|
|
3113
3151
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
3114
|
-
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
3152
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
3115
3153
|
},
|
|
3116
3154
|
/**
|
|
3117
3155
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
@@ -3629,14 +3667,14 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
3629
3667
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3630
3668
|
}
|
|
3631
3669
|
/**
|
|
3632
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3670
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3633
3671
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3634
3672
|
* @param {*} [options] Override http request option.
|
|
3635
3673
|
* @throws {RequiredError}
|
|
3636
3674
|
* @memberof DefaultApi
|
|
3637
3675
|
*/
|
|
3638
3676
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
3639
|
-
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3677
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3640
3678
|
}
|
|
3641
3679
|
/**
|
|
3642
3680
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -488,11 +488,17 @@ export type V1BlackoutVolumeRequestReferenceFrameEnum = typeof V1BlackoutVolumeR
|
|
|
488
488
|
*/
|
|
489
489
|
export interface V1CreateDirectTaskInstructionRequest {
|
|
490
490
|
/**
|
|
491
|
-
* NET time after which the instruction can be executed. If null, the instruction can be executed immediately.
|
|
491
|
+
* NET time after which the instruction can be executed (expressed in UTC). If null, the instruction can be executed immediately.
|
|
492
492
|
* @type {string}
|
|
493
493
|
* @memberof V1CreateDirectTaskInstructionRequest
|
|
494
494
|
*/
|
|
495
495
|
'executableAfter'?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Latest time the instruction can be executed (expressed in UTC). If null, the instruction will not have an expiration.
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof V1CreateDirectTaskInstructionRequest
|
|
500
|
+
*/
|
|
501
|
+
'executableUntil'?: string;
|
|
496
502
|
/**
|
|
497
503
|
*
|
|
498
504
|
* @type {string}
|
|
@@ -961,6 +967,40 @@ export interface V1ImageMetadata {
|
|
|
961
967
|
*/
|
|
962
968
|
'createdAt': string;
|
|
963
969
|
}
|
|
970
|
+
/**
|
|
971
|
+
*
|
|
972
|
+
* @export
|
|
973
|
+
* @enum {string}
|
|
974
|
+
*/
|
|
975
|
+
export declare const V1ImageRejectionReason: {
|
|
976
|
+
readonly TARGET_NOT_FOUND: "TARGET_NOT_FOUND";
|
|
977
|
+
readonly RATE_TARGET_NOT_FOUND: "RATE_TARGET_NOT_FOUND";
|
|
978
|
+
readonly RATE_PLATE_SOLVE_FAILURE: "RATE_PLATE_SOLVE_FAILURE";
|
|
979
|
+
readonly STREAK_DETECTION_FAILURE: "STREAK_DETECTION_FAILURE";
|
|
980
|
+
readonly PLATE_SOLVE_FAILURE: "PLATE_SOLVE_FAILURE";
|
|
981
|
+
readonly PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE: "PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE";
|
|
982
|
+
readonly PLATE_SOLVE_NO_SOLUTION_FAILURE: "PLATE_SOLVE_NO_SOLUTION_FAILURE";
|
|
983
|
+
readonly CROP_IMAGE_FAILURE: "CROP_IMAGE_FAILURE";
|
|
984
|
+
readonly COSMETIC_CORRECTION_FAILURE: "COSMETIC_CORRECTION_FAILURE";
|
|
985
|
+
readonly GRADIENT_REMOVAL_FAILURE: "GRADIENT_REMOVAL_FAILURE";
|
|
986
|
+
readonly CATMAG_FAILURE: "CATMAG_FAILURE";
|
|
987
|
+
readonly IMAGE_QUALITY_TOO_LOW: "IMAGE_QUALITY_TOO_LOW";
|
|
988
|
+
readonly OBSERVATION_NOT_FOUND: "OBSERVATION_NOT_FOUND";
|
|
989
|
+
readonly NODE_NOT_FOUND: "NODE_NOT_FOUND";
|
|
990
|
+
readonly CAMERA_NOT_FOUND: "CAMERA_NOT_FOUND";
|
|
991
|
+
readonly OTA_NOT_FOUND: "OTA_NOT_FOUND";
|
|
992
|
+
readonly TLE_NOT_EXTRACTED: "TLE_NOT_EXTRACTED";
|
|
993
|
+
readonly FAILED_TO_LOAD: "FAILED_TO_LOAD";
|
|
994
|
+
readonly GPS_ERROR: "GPS_ERROR";
|
|
995
|
+
readonly MUTEX_TIMEOUT: "MUTEX_TIMEOUT";
|
|
996
|
+
readonly AWAIT_TIMEOUT: "AWAIT_TIMEOUT";
|
|
997
|
+
readonly CATALOG_COMPARE_ERROR: "CATALOG_COMPARE_ERROR";
|
|
998
|
+
readonly SAVE_FAILURE: "SAVE_FAILURE";
|
|
999
|
+
readonly RATE_CATALOG_COMPARE_ERROR: "RATE_CATALOG_COMPARE_ERROR";
|
|
1000
|
+
readonly MISSING_IMG_WIDTH_HEADER: "MISSING_IMG_WIDTH_HEADER";
|
|
1001
|
+
readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
|
|
1002
|
+
};
|
|
1003
|
+
export type V1ImageRejectionReason = typeof V1ImageRejectionReason[keyof typeof V1ImageRejectionReason];
|
|
964
1004
|
/**
|
|
965
1005
|
* An image set represents a contiguous set of observations of the same target captured by the same node.
|
|
966
1006
|
* @export
|
|
@@ -1196,6 +1236,12 @@ export interface V1ImageSetImage {
|
|
|
1196
1236
|
* @memberof V1ImageSetImage
|
|
1197
1237
|
*/
|
|
1198
1238
|
'predictedStreakLocation'?: V1PredictedStreakLocation;
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
* @type {V1ImageRejectionReason}
|
|
1242
|
+
* @memberof V1ImageSetImage
|
|
1243
|
+
*/
|
|
1244
|
+
'rejectedReason'?: V1ImageRejectionReason;
|
|
1199
1245
|
}
|
|
1200
1246
|
/**
|
|
1201
1247
|
* Extracted stars that matched during plate solving
|
|
@@ -1521,11 +1567,11 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
1521
1567
|
*/
|
|
1522
1568
|
export interface V1ObservationStatus {
|
|
1523
1569
|
/**
|
|
1524
|
-
*
|
|
1570
|
+
* The ID of the observation, null if the observation has not happened yet
|
|
1525
1571
|
* @type {string}
|
|
1526
1572
|
* @memberof V1ObservationStatus
|
|
1527
1573
|
*/
|
|
1528
|
-
'
|
|
1574
|
+
'observationId'?: string;
|
|
1529
1575
|
/**
|
|
1530
1576
|
*
|
|
1531
1577
|
* @type {string}
|
|
@@ -1539,41 +1585,41 @@ export interface V1ObservationStatus {
|
|
|
1539
1585
|
*/
|
|
1540
1586
|
'trackingType'?: TrackingType;
|
|
1541
1587
|
/**
|
|
1542
|
-
*
|
|
1588
|
+
* The expected RA at the time of the observation, null if the observation has not happened yet
|
|
1543
1589
|
* @type {number}
|
|
1544
1590
|
* @memberof V1ObservationStatus
|
|
1545
1591
|
*/
|
|
1546
|
-
'ra'
|
|
1592
|
+
'ra'?: number;
|
|
1547
1593
|
/**
|
|
1548
|
-
*
|
|
1594
|
+
* The expected Dec at the time of the observation, null if the observation has not happened yet
|
|
1549
1595
|
* @type {number}
|
|
1550
1596
|
* @memberof V1ObservationStatus
|
|
1551
1597
|
*/
|
|
1552
|
-
'dec'
|
|
1598
|
+
'dec'?: number;
|
|
1553
1599
|
/**
|
|
1554
|
-
*
|
|
1600
|
+
* Time the observation was executed at, null if the observation has not happened yet
|
|
1555
1601
|
* @type {string}
|
|
1556
1602
|
* @memberof V1ObservationStatus
|
|
1557
1603
|
*/
|
|
1558
|
-
'observationTime'
|
|
1604
|
+
'observationTime'?: string;
|
|
1559
1605
|
/**
|
|
1560
|
-
* TLE line 1 of when the observation was tasked
|
|
1606
|
+
* TLE line 1 of when the observation was tasked, null if the observation has not happened yet
|
|
1561
1607
|
* @type {string}
|
|
1562
1608
|
* @memberof V1ObservationStatus
|
|
1563
1609
|
*/
|
|
1564
|
-
'tleLine1'
|
|
1610
|
+
'tleLine1'?: string;
|
|
1565
1611
|
/**
|
|
1566
|
-
* TLE line 2 of when the observation was tasked
|
|
1612
|
+
* TLE line 2 of when the observation was tasked, null if the observation has not happened yet
|
|
1567
1613
|
* @type {string}
|
|
1568
1614
|
* @memberof V1ObservationStatus
|
|
1569
1615
|
*/
|
|
1570
|
-
'tleLine2'
|
|
1616
|
+
'tleLine2'?: string;
|
|
1571
1617
|
/**
|
|
1572
|
-
*
|
|
1618
|
+
* TLE Epoch of when the observation was tasked, null if the observation has not happened yet
|
|
1573
1619
|
* @type {string}
|
|
1574
1620
|
* @memberof V1ObservationStatus
|
|
1575
1621
|
*/
|
|
1576
|
-
'tleEpoch'
|
|
1622
|
+
'tleEpoch'?: string;
|
|
1577
1623
|
/**
|
|
1578
1624
|
*
|
|
1579
1625
|
* @type {string}
|
|
@@ -1603,7 +1649,25 @@ export interface V1ObservationStatus {
|
|
|
1603
1649
|
* @type {string}
|
|
1604
1650
|
* @memberof V1ObservationStatus
|
|
1605
1651
|
*/
|
|
1652
|
+
'directTaskId'?: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* The time the observation was completed in our system, null if the observation has not happened yet
|
|
1655
|
+
* @type {string}
|
|
1656
|
+
* @memberof V1ObservationStatus
|
|
1657
|
+
*/
|
|
1606
1658
|
'completedAt'?: string;
|
|
1659
|
+
/**
|
|
1660
|
+
* The time the instruction was scheduled for, if applicable (direct tasked instructions only)
|
|
1661
|
+
* @type {string}
|
|
1662
|
+
* @memberof V1ObservationStatus
|
|
1663
|
+
*/
|
|
1664
|
+
'scheduledAt'?: string;
|
|
1665
|
+
/**
|
|
1666
|
+
* The time the instruction was valid until, if applicable (direct tasked instructions only)
|
|
1667
|
+
* @type {string}
|
|
1668
|
+
* @memberof V1ObservationStatus
|
|
1669
|
+
*/
|
|
1670
|
+
'validUntil'?: string;
|
|
1607
1671
|
/**
|
|
1608
1672
|
*
|
|
1609
1673
|
* @type {ObservationState}
|
|
@@ -3357,17 +3421,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3357
3421
|
*/
|
|
3358
3422
|
v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3359
3423
|
/**
|
|
3360
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3424
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3361
3425
|
* @param {string} [targetId]
|
|
3362
3426
|
* @param {string} [before]
|
|
3363
3427
|
* @param {string} [searchInstructionId]
|
|
3364
3428
|
* @param {string} [surveyInstructionId]
|
|
3365
3429
|
* @param {string} [resolvedImageInstructionId]
|
|
3430
|
+
* @param {string} [directTaskId]
|
|
3366
3431
|
* @param {string} [imageId]
|
|
3367
3432
|
* @param {*} [options] Override http request option.
|
|
3368
3433
|
* @throws {RequiredError}
|
|
3369
3434
|
*/
|
|
3370
|
-
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3435
|
+
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, directTaskId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3371
3436
|
/**
|
|
3372
3437
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
3373
3438
|
* @param {string} until
|
|
@@ -3763,17 +3828,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
3763
3828
|
*/
|
|
3764
3829
|
v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
|
|
3765
3830
|
/**
|
|
3766
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3831
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3767
3832
|
* @param {string} [targetId]
|
|
3768
3833
|
* @param {string} [before]
|
|
3769
3834
|
* @param {string} [searchInstructionId]
|
|
3770
3835
|
* @param {string} [surveyInstructionId]
|
|
3771
3836
|
* @param {string} [resolvedImageInstructionId]
|
|
3837
|
+
* @param {string} [directTaskId]
|
|
3772
3838
|
* @param {string} [imageId]
|
|
3773
3839
|
* @param {*} [options] Override http request option.
|
|
3774
3840
|
* @throws {RequiredError}
|
|
3775
3841
|
*/
|
|
3776
|
-
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
3842
|
+
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, directTaskId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
3777
3843
|
/**
|
|
3778
3844
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
3779
3845
|
* @param {string} until
|
|
@@ -4165,7 +4231,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
4165
4231
|
*/
|
|
4166
4232
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
|
|
4167
4233
|
/**
|
|
4168
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
4234
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
4169
4235
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
4170
4236
|
* @param {*} [options] Override http request option.
|
|
4171
4237
|
* @throws {RequiredError}
|
|
@@ -4762,6 +4828,12 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
4762
4828
|
* @memberof DefaultApiV1GetObservationStatuses
|
|
4763
4829
|
*/
|
|
4764
4830
|
readonly resolvedImageInstructionId?: string;
|
|
4831
|
+
/**
|
|
4832
|
+
*
|
|
4833
|
+
* @type {string}
|
|
4834
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
4835
|
+
*/
|
|
4836
|
+
readonly directTaskId?: string;
|
|
4765
4837
|
/**
|
|
4766
4838
|
*
|
|
4767
4839
|
* @type {string}
|
|
@@ -5380,7 +5452,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
5380
5452
|
*/
|
|
5381
5453
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
|
|
5382
5454
|
/**
|
|
5383
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
5455
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
5384
5456
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
5385
5457
|
* @param {*} [options] Override http request option.
|
|
5386
5458
|
* @throws {RequiredError}
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -171,6 +171,39 @@ export const V1ImageFileType = {
|
|
|
171
171
|
FITS: 'FITS',
|
|
172
172
|
JPG: 'JPG'
|
|
173
173
|
};
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @export
|
|
177
|
+
* @enum {string}
|
|
178
|
+
*/
|
|
179
|
+
export const V1ImageRejectionReason = {
|
|
180
|
+
TARGET_NOT_FOUND: 'TARGET_NOT_FOUND',
|
|
181
|
+
RATE_TARGET_NOT_FOUND: 'RATE_TARGET_NOT_FOUND',
|
|
182
|
+
RATE_PLATE_SOLVE_FAILURE: 'RATE_PLATE_SOLVE_FAILURE',
|
|
183
|
+
STREAK_DETECTION_FAILURE: 'STREAK_DETECTION_FAILURE',
|
|
184
|
+
PLATE_SOLVE_FAILURE: 'PLATE_SOLVE_FAILURE',
|
|
185
|
+
PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE: 'PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE',
|
|
186
|
+
PLATE_SOLVE_NO_SOLUTION_FAILURE: 'PLATE_SOLVE_NO_SOLUTION_FAILURE',
|
|
187
|
+
CROP_IMAGE_FAILURE: 'CROP_IMAGE_FAILURE',
|
|
188
|
+
COSMETIC_CORRECTION_FAILURE: 'COSMETIC_CORRECTION_FAILURE',
|
|
189
|
+
GRADIENT_REMOVAL_FAILURE: 'GRADIENT_REMOVAL_FAILURE',
|
|
190
|
+
CATMAG_FAILURE: 'CATMAG_FAILURE',
|
|
191
|
+
IMAGE_QUALITY_TOO_LOW: 'IMAGE_QUALITY_TOO_LOW',
|
|
192
|
+
OBSERVATION_NOT_FOUND: 'OBSERVATION_NOT_FOUND',
|
|
193
|
+
NODE_NOT_FOUND: 'NODE_NOT_FOUND',
|
|
194
|
+
CAMERA_NOT_FOUND: 'CAMERA_NOT_FOUND',
|
|
195
|
+
OTA_NOT_FOUND: 'OTA_NOT_FOUND',
|
|
196
|
+
TLE_NOT_EXTRACTED: 'TLE_NOT_EXTRACTED',
|
|
197
|
+
FAILED_TO_LOAD: 'FAILED_TO_LOAD',
|
|
198
|
+
GPS_ERROR: 'GPS_ERROR',
|
|
199
|
+
MUTEX_TIMEOUT: 'MUTEX_TIMEOUT',
|
|
200
|
+
AWAIT_TIMEOUT: 'AWAIT_TIMEOUT',
|
|
201
|
+
CATALOG_COMPARE_ERROR: 'CATALOG_COMPARE_ERROR',
|
|
202
|
+
SAVE_FAILURE: 'SAVE_FAILURE',
|
|
203
|
+
RATE_CATALOG_COMPARE_ERROR: 'RATE_CATALOG_COMPARE_ERROR',
|
|
204
|
+
MISSING_IMG_WIDTH_HEADER: 'MISSING_IMG_WIDTH_HEADER',
|
|
205
|
+
UNKNOWN_ERROR: 'UNKNOWN_ERROR'
|
|
206
|
+
};
|
|
174
207
|
/**
|
|
175
208
|
*
|
|
176
209
|
* @export
|
|
@@ -1235,17 +1268,18 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1235
1268
|
};
|
|
1236
1269
|
}),
|
|
1237
1270
|
/**
|
|
1238
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
1271
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
1239
1272
|
* @param {string} [targetId]
|
|
1240
1273
|
* @param {string} [before]
|
|
1241
1274
|
* @param {string} [searchInstructionId]
|
|
1242
1275
|
* @param {string} [surveyInstructionId]
|
|
1243
1276
|
* @param {string} [resolvedImageInstructionId]
|
|
1277
|
+
* @param {string} [directTaskId]
|
|
1244
1278
|
* @param {string} [imageId]
|
|
1245
1279
|
* @param {*} [options] Override http request option.
|
|
1246
1280
|
* @throws {RequiredError}
|
|
1247
1281
|
*/
|
|
1248
|
-
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1282
|
+
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1249
1283
|
const localVarPath = `/v1/observation-statuses`;
|
|
1250
1284
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1251
1285
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1277,6 +1311,9 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1277
1311
|
if (resolvedImageInstructionId !== undefined) {
|
|
1278
1312
|
localVarQueryParameter['resolvedImageInstructionId'] = resolvedImageInstructionId;
|
|
1279
1313
|
}
|
|
1314
|
+
if (directTaskId !== undefined) {
|
|
1315
|
+
localVarQueryParameter['directTaskId'] = directTaskId;
|
|
1316
|
+
}
|
|
1280
1317
|
if (imageId !== undefined) {
|
|
1281
1318
|
localVarQueryParameter['imageId'] = imageId;
|
|
1282
1319
|
}
|
|
@@ -2512,19 +2549,20 @@ export const DefaultApiFp = function (configuration) {
|
|
|
2512
2549
|
});
|
|
2513
2550
|
},
|
|
2514
2551
|
/**
|
|
2515
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
2552
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
2516
2553
|
* @param {string} [targetId]
|
|
2517
2554
|
* @param {string} [before]
|
|
2518
2555
|
* @param {string} [searchInstructionId]
|
|
2519
2556
|
* @param {string} [surveyInstructionId]
|
|
2520
2557
|
* @param {string} [resolvedImageInstructionId]
|
|
2558
|
+
* @param {string} [directTaskId]
|
|
2521
2559
|
* @param {string} [imageId]
|
|
2522
2560
|
* @param {*} [options] Override http request option.
|
|
2523
2561
|
* @throws {RequiredError}
|
|
2524
2562
|
*/
|
|
2525
|
-
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options) {
|
|
2563
|
+
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options) {
|
|
2526
2564
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2527
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options);
|
|
2565
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options);
|
|
2528
2566
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2529
2567
|
});
|
|
2530
2568
|
},
|
|
@@ -3100,13 +3138,13 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
3100
3138
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
3101
3139
|
},
|
|
3102
3140
|
/**
|
|
3103
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3141
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3104
3142
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3105
3143
|
* @param {*} [options] Override http request option.
|
|
3106
3144
|
* @throws {RequiredError}
|
|
3107
3145
|
*/
|
|
3108
3146
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
3109
|
-
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
3147
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
3110
3148
|
},
|
|
3111
3149
|
/**
|
|
3112
3150
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
@@ -3623,14 +3661,14 @@ export class DefaultApi extends BaseAPI {
|
|
|
3623
3661
|
return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3624
3662
|
}
|
|
3625
3663
|
/**
|
|
3626
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
3664
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3627
3665
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3628
3666
|
* @param {*} [options] Override http request option.
|
|
3629
3667
|
* @throws {RequiredError}
|
|
3630
3668
|
* @memberof DefaultApi
|
|
3631
3669
|
*/
|
|
3632
3670
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
3633
|
-
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3671
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3634
3672
|
}
|
|
3635
3673
|
/**
|
|
3636
3674
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* 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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8815
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|