@ourskyai/sda-api 1.3.5667 → 1.3.6669
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 +1544 -24
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1151 -39
- package/dist/api.js +637 -16
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +1151 -39
- package/dist/esm/api.js +636 -15
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* OurSky SDA
|
|
5
|
-
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](
|
|
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.6669
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -57,6 +57,10 @@ export const FilterType = {
|
|
|
57
57
|
* @enum {string}
|
|
58
58
|
*/
|
|
59
59
|
export const ImageSetType = {
|
|
60
|
+
ASTRONOMICAL: 'ASTRONOMICAL',
|
|
61
|
+
EARTH_ORBITAL: 'EARTH_ORBITAL',
|
|
62
|
+
GNSS_CALIBRATION: 'GNSS_CALIBRATION',
|
|
63
|
+
SATELLITE_CALIBRATION: 'SATELLITE_CALIBRATION',
|
|
60
64
|
ALL_SKY: 'ALL_SKY'
|
|
61
65
|
};
|
|
62
66
|
/**
|
|
@@ -115,6 +119,17 @@ export const SatelliteTargetTrackingStatus = {
|
|
|
115
119
|
INACTIVE: 'INACTIVE',
|
|
116
120
|
DEORBITED: 'DEORBITED'
|
|
117
121
|
};
|
|
122
|
+
/**
|
|
123
|
+
* The reason a search was completed.
|
|
124
|
+
* @export
|
|
125
|
+
* @enum {string}
|
|
126
|
+
*/
|
|
127
|
+
export const SearchCompletedReason = {
|
|
128
|
+
ALL_HYPOTHESES_TESTED: 'ALL_HYPOTHESES_TESTED',
|
|
129
|
+
FOUND_TARGET: 'FOUND_TARGET',
|
|
130
|
+
CANCELLED: 'CANCELLED',
|
|
131
|
+
FAILED: 'FAILED'
|
|
132
|
+
};
|
|
118
133
|
/**
|
|
119
134
|
*
|
|
120
135
|
* @export
|
|
@@ -134,6 +149,19 @@ export const TrackingType = {
|
|
|
134
149
|
TARGET_RATE: 'TARGET_RATE',
|
|
135
150
|
NONE: 'NONE'
|
|
136
151
|
};
|
|
152
|
+
export const V1BlackoutVolumeRequestReferenceFrameEnum = {
|
|
153
|
+
ECI_J2000: 'ECI_J2000',
|
|
154
|
+
ECEF: 'ECEF'
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @export
|
|
159
|
+
* @enum {string}
|
|
160
|
+
*/
|
|
161
|
+
export const V1ImageFileType = {
|
|
162
|
+
FITS: 'FITS',
|
|
163
|
+
JPG: 'JPG'
|
|
164
|
+
};
|
|
137
165
|
/**
|
|
138
166
|
*
|
|
139
167
|
* @export
|
|
@@ -174,7 +202,10 @@ export const WebhookEvent = {
|
|
|
174
202
|
V1_OBSERVATION_STATUS_UPDATED: 'V1_OBSERVATION_STATUS_UPDATED',
|
|
175
203
|
V1_EO_CALIBRATION_OBSERVATION_CREATED: 'V1_EO_CALIBRATION_OBSERVATION_CREATED',
|
|
176
204
|
V1_NODE_CALIBRATION_DATA_CREATED: 'V1_NODE_CALIBRATION_DATA_CREATED',
|
|
177
|
-
V1_NODE_UPDATED: 'V1_NODE_UPDATED'
|
|
205
|
+
V1_NODE_UPDATED: 'V1_NODE_UPDATED',
|
|
206
|
+
V1_EO_SKY_IMAGERY_CREATED: 'V1_EO_SKY_IMAGERY_CREATED',
|
|
207
|
+
V2_SEARCH_COMPLETED: 'V2_SEARCH_COMPLETED',
|
|
208
|
+
V1_UCT_CREATED: 'V1_UCT_CREATED'
|
|
178
209
|
};
|
|
179
210
|
/**
|
|
180
211
|
* DefaultApi - axios parameter creator
|
|
@@ -182,6 +213,74 @@ export const WebhookEvent = {
|
|
|
182
213
|
*/
|
|
183
214
|
export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
184
215
|
return {
|
|
216
|
+
/**
|
|
217
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
218
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
219
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
getUncorrelatedTracks: (after, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
224
|
+
const localVarPath = `/v1/uncorrelated-tracks`;
|
|
225
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
226
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
227
|
+
let baseOptions;
|
|
228
|
+
if (configuration) {
|
|
229
|
+
baseOptions = configuration.baseOptions;
|
|
230
|
+
}
|
|
231
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
232
|
+
const localVarHeaderParameter = {};
|
|
233
|
+
const localVarQueryParameter = {};
|
|
234
|
+
// authentication Roles required
|
|
235
|
+
// authentication BearerToken required
|
|
236
|
+
// http bearer authentication required
|
|
237
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
238
|
+
if (after !== undefined) {
|
|
239
|
+
localVarQueryParameter['after'] = (after instanceof Date) ?
|
|
240
|
+
after.toISOString() :
|
|
241
|
+
after;
|
|
242
|
+
}
|
|
243
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
245
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
246
|
+
return {
|
|
247
|
+
url: toPathString(localVarUrlObj),
|
|
248
|
+
options: localVarRequestOptions,
|
|
249
|
+
};
|
|
250
|
+
}),
|
|
251
|
+
/**
|
|
252
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
253
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
v1CreateBlackoutVolume: (v1BlackoutVolumeRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
258
|
+
// verify required parameter 'v1BlackoutVolumeRequest' is not null or undefined
|
|
259
|
+
assertParamExists('v1CreateBlackoutVolume', 'v1BlackoutVolumeRequest', v1BlackoutVolumeRequest);
|
|
260
|
+
const localVarPath = `/v2/search/blackout-volume`;
|
|
261
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
262
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
263
|
+
let baseOptions;
|
|
264
|
+
if (configuration) {
|
|
265
|
+
baseOptions = configuration.baseOptions;
|
|
266
|
+
}
|
|
267
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
268
|
+
const localVarHeaderParameter = {};
|
|
269
|
+
const localVarQueryParameter = {};
|
|
270
|
+
// authentication Roles required
|
|
271
|
+
// authentication BearerToken required
|
|
272
|
+
// http bearer authentication required
|
|
273
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
274
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
275
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
276
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
277
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
278
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1BlackoutVolumeRequest, localVarRequestOptions, configuration);
|
|
279
|
+
return {
|
|
280
|
+
url: toPathString(localVarUrlObj),
|
|
281
|
+
options: localVarRequestOptions,
|
|
282
|
+
};
|
|
283
|
+
}),
|
|
185
284
|
/**
|
|
186
285
|
* Create an image set.
|
|
187
286
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -249,7 +348,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
249
348
|
};
|
|
250
349
|
}),
|
|
251
350
|
/**
|
|
252
|
-
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#
|
|
351
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
253
352
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
254
353
|
* @param {*} [options] Override http request option.
|
|
255
354
|
* @throws {RequiredError}
|
|
@@ -315,9 +414,10 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
315
414
|
};
|
|
316
415
|
}),
|
|
317
416
|
/**
|
|
318
|
-
* Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
417
|
+
* This endpoint is deprecated but will continue to work until 05/31/2025, please see [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) and [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric). Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
319
418
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
320
419
|
* @param {*} [options] Override http request option.
|
|
420
|
+
* @deprecated
|
|
321
421
|
* @throws {RequiredError}
|
|
322
422
|
*/
|
|
323
423
|
v1CreateSearchInstruction: (v1CreateSearchInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -446,6 +546,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
446
546
|
options: localVarRequestOptions,
|
|
447
547
|
};
|
|
448
548
|
}),
|
|
549
|
+
/**
|
|
550
|
+
* Delete a blackout volume.
|
|
551
|
+
* @param {string} id
|
|
552
|
+
* @param {*} [options] Override http request option.
|
|
553
|
+
* @throws {RequiredError}
|
|
554
|
+
*/
|
|
555
|
+
v1DeleteBlackoutVolume: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
556
|
+
// verify required parameter 'id' is not null or undefined
|
|
557
|
+
assertParamExists('v1DeleteBlackoutVolume', 'id', id);
|
|
558
|
+
const localVarPath = `/v2/search/blackout-volume`;
|
|
559
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
560
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
561
|
+
let baseOptions;
|
|
562
|
+
if (configuration) {
|
|
563
|
+
baseOptions = configuration.baseOptions;
|
|
564
|
+
}
|
|
565
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
566
|
+
const localVarHeaderParameter = {};
|
|
567
|
+
const localVarQueryParameter = {};
|
|
568
|
+
// authentication Roles required
|
|
569
|
+
// authentication BearerToken required
|
|
570
|
+
// http bearer authentication required
|
|
571
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
572
|
+
if (id !== undefined) {
|
|
573
|
+
localVarQueryParameter['id'] = id;
|
|
574
|
+
}
|
|
575
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
576
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
577
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
578
|
+
return {
|
|
579
|
+
url: toPathString(localVarUrlObj),
|
|
580
|
+
options: localVarRequestOptions,
|
|
581
|
+
};
|
|
582
|
+
}),
|
|
449
583
|
/**
|
|
450
584
|
* Delete an image set.
|
|
451
585
|
* @param {string} id
|
|
@@ -650,6 +784,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
650
784
|
options: localVarRequestOptions,
|
|
651
785
|
};
|
|
652
786
|
}),
|
|
787
|
+
/**
|
|
788
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
789
|
+
* @param {string} imageId
|
|
790
|
+
* @param {*} [options] Override http request option.
|
|
791
|
+
* @throws {RequiredError}
|
|
792
|
+
*/
|
|
793
|
+
v1GetImageMetadata: (imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
794
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
795
|
+
assertParamExists('v1GetImageMetadata', 'imageId', imageId);
|
|
796
|
+
const localVarPath = `/v1/image-metadata`;
|
|
797
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
798
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
799
|
+
let baseOptions;
|
|
800
|
+
if (configuration) {
|
|
801
|
+
baseOptions = configuration.baseOptions;
|
|
802
|
+
}
|
|
803
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
804
|
+
const localVarHeaderParameter = {};
|
|
805
|
+
const localVarQueryParameter = {};
|
|
806
|
+
// authentication Roles required
|
|
807
|
+
// authentication BearerToken required
|
|
808
|
+
// http bearer authentication required
|
|
809
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
810
|
+
if (imageId !== undefined) {
|
|
811
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
812
|
+
}
|
|
813
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
814
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
815
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
816
|
+
return {
|
|
817
|
+
url: toPathString(localVarUrlObj),
|
|
818
|
+
options: localVarRequestOptions,
|
|
819
|
+
};
|
|
820
|
+
}),
|
|
653
821
|
/**
|
|
654
822
|
* Get an image set.
|
|
655
823
|
* @param {string} id
|
|
@@ -1047,7 +1215,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1047
1215
|
};
|
|
1048
1216
|
}),
|
|
1049
1217
|
/**
|
|
1050
|
-
* Get organization targets see the [create](#
|
|
1218
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
1051
1219
|
* @param {*} [options] Override http request option.
|
|
1052
1220
|
* @throws {RequiredError}
|
|
1053
1221
|
*/
|
|
@@ -1581,6 +1749,174 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1581
1749
|
options: localVarRequestOptions,
|
|
1582
1750
|
};
|
|
1583
1751
|
}),
|
|
1752
|
+
/**
|
|
1753
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
1754
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
1755
|
+
* @param {*} [options] Override http request option.
|
|
1756
|
+
* @throws {RequiredError}
|
|
1757
|
+
*/
|
|
1758
|
+
v2CreatePlaneScan: (v1PlaneScanRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1759
|
+
// verify required parameter 'v1PlaneScanRequest' is not null or undefined
|
|
1760
|
+
assertParamExists('v2CreatePlaneScan', 'v1PlaneScanRequest', v1PlaneScanRequest);
|
|
1761
|
+
const localVarPath = `/v2/search/plane-scan`;
|
|
1762
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1763
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1764
|
+
let baseOptions;
|
|
1765
|
+
if (configuration) {
|
|
1766
|
+
baseOptions = configuration.baseOptions;
|
|
1767
|
+
}
|
|
1768
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1769
|
+
const localVarHeaderParameter = {};
|
|
1770
|
+
const localVarQueryParameter = {};
|
|
1771
|
+
// authentication Roles required
|
|
1772
|
+
// authentication BearerToken required
|
|
1773
|
+
// http bearer authentication required
|
|
1774
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1775
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1776
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1777
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1778
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1779
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1PlaneScanRequest, localVarRequestOptions, configuration);
|
|
1780
|
+
return {
|
|
1781
|
+
url: toPathString(localVarUrlObj),
|
|
1782
|
+
options: localVarRequestOptions,
|
|
1783
|
+
};
|
|
1784
|
+
}),
|
|
1785
|
+
/**
|
|
1786
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
1787
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
1788
|
+
* @param {*} [options] Override http request option.
|
|
1789
|
+
* @throws {RequiredError}
|
|
1790
|
+
*/
|
|
1791
|
+
v2CreateRicVolumeSearch: (v1RicVolumeSearchRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1792
|
+
// verify required parameter 'v1RicVolumeSearchRequest' is not null or undefined
|
|
1793
|
+
assertParamExists('v2CreateRicVolumeSearch', 'v1RicVolumeSearchRequest', v1RicVolumeSearchRequest);
|
|
1794
|
+
const localVarPath = `/v2/search/ric-volumetric`;
|
|
1795
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1796
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1797
|
+
let baseOptions;
|
|
1798
|
+
if (configuration) {
|
|
1799
|
+
baseOptions = configuration.baseOptions;
|
|
1800
|
+
}
|
|
1801
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1802
|
+
const localVarHeaderParameter = {};
|
|
1803
|
+
const localVarQueryParameter = {};
|
|
1804
|
+
// authentication Roles required
|
|
1805
|
+
// authentication BearerToken required
|
|
1806
|
+
// http bearer authentication required
|
|
1807
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1808
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1809
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1810
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1811
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1812
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1RicVolumeSearchRequest, localVarRequestOptions, configuration);
|
|
1813
|
+
return {
|
|
1814
|
+
url: toPathString(localVarUrlObj),
|
|
1815
|
+
options: localVarRequestOptions,
|
|
1816
|
+
};
|
|
1817
|
+
}),
|
|
1818
|
+
/**
|
|
1819
|
+
* Delete a plane scan.
|
|
1820
|
+
* @param {string} id
|
|
1821
|
+
* @param {*} [options] Override http request option.
|
|
1822
|
+
* @throws {RequiredError}
|
|
1823
|
+
*/
|
|
1824
|
+
v2DeletePlaneScan: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1825
|
+
// verify required parameter 'id' is not null or undefined
|
|
1826
|
+
assertParamExists('v2DeletePlaneScan', 'id', id);
|
|
1827
|
+
const localVarPath = `/v2/search/plane-scan`;
|
|
1828
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1829
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1830
|
+
let baseOptions;
|
|
1831
|
+
if (configuration) {
|
|
1832
|
+
baseOptions = configuration.baseOptions;
|
|
1833
|
+
}
|
|
1834
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1835
|
+
const localVarHeaderParameter = {};
|
|
1836
|
+
const localVarQueryParameter = {};
|
|
1837
|
+
// authentication Roles required
|
|
1838
|
+
// authentication BearerToken required
|
|
1839
|
+
// http bearer authentication required
|
|
1840
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1841
|
+
if (id !== undefined) {
|
|
1842
|
+
localVarQueryParameter['id'] = id;
|
|
1843
|
+
}
|
|
1844
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1845
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1846
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1847
|
+
return {
|
|
1848
|
+
url: toPathString(localVarUrlObj),
|
|
1849
|
+
options: localVarRequestOptions,
|
|
1850
|
+
};
|
|
1851
|
+
}),
|
|
1852
|
+
/**
|
|
1853
|
+
* Delete a RIC volume search.
|
|
1854
|
+
* @param {string} id
|
|
1855
|
+
* @param {*} [options] Override http request option.
|
|
1856
|
+
* @throws {RequiredError}
|
|
1857
|
+
*/
|
|
1858
|
+
v2DeleteRicVolumeSearch: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1859
|
+
// verify required parameter 'id' is not null or undefined
|
|
1860
|
+
assertParamExists('v2DeleteRicVolumeSearch', 'id', id);
|
|
1861
|
+
const localVarPath = `/v2/search/ric-volumetric`;
|
|
1862
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1863
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1864
|
+
let baseOptions;
|
|
1865
|
+
if (configuration) {
|
|
1866
|
+
baseOptions = configuration.baseOptions;
|
|
1867
|
+
}
|
|
1868
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
1869
|
+
const localVarHeaderParameter = {};
|
|
1870
|
+
const localVarQueryParameter = {};
|
|
1871
|
+
// authentication Roles required
|
|
1872
|
+
// authentication BearerToken required
|
|
1873
|
+
// http bearer authentication required
|
|
1874
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1875
|
+
if (id !== undefined) {
|
|
1876
|
+
localVarQueryParameter['id'] = id;
|
|
1877
|
+
}
|
|
1878
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1879
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1880
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1881
|
+
return {
|
|
1882
|
+
url: toPathString(localVarUrlObj),
|
|
1883
|
+
options: localVarRequestOptions,
|
|
1884
|
+
};
|
|
1885
|
+
}),
|
|
1886
|
+
/**
|
|
1887
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
1888
|
+
* @param {string} searchId
|
|
1889
|
+
* @param {*} [options] Override http request option.
|
|
1890
|
+
* @throws {RequiredError}
|
|
1891
|
+
*/
|
|
1892
|
+
v2GetSearch: (searchId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1893
|
+
// verify required parameter 'searchId' is not null or undefined
|
|
1894
|
+
assertParamExists('v2GetSearch', 'searchId', searchId);
|
|
1895
|
+
const localVarPath = `/v2/search`;
|
|
1896
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1897
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1898
|
+
let baseOptions;
|
|
1899
|
+
if (configuration) {
|
|
1900
|
+
baseOptions = configuration.baseOptions;
|
|
1901
|
+
}
|
|
1902
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1903
|
+
const localVarHeaderParameter = {};
|
|
1904
|
+
const localVarQueryParameter = {};
|
|
1905
|
+
// authentication Roles required
|
|
1906
|
+
// authentication BearerToken required
|
|
1907
|
+
// http bearer authentication required
|
|
1908
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1909
|
+
if (searchId !== undefined) {
|
|
1910
|
+
localVarQueryParameter['searchId'] = searchId;
|
|
1911
|
+
}
|
|
1912
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1913
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1914
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1915
|
+
return {
|
|
1916
|
+
url: toPathString(localVarUrlObj),
|
|
1917
|
+
options: localVarRequestOptions,
|
|
1918
|
+
};
|
|
1919
|
+
}),
|
|
1584
1920
|
};
|
|
1585
1921
|
};
|
|
1586
1922
|
/**
|
|
@@ -1590,6 +1926,31 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
1590
1926
|
export const DefaultApiFp = function (configuration) {
|
|
1591
1927
|
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration);
|
|
1592
1928
|
return {
|
|
1929
|
+
/**
|
|
1930
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
1931
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
1932
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
1933
|
+
* @param {*} [options] Override http request option.
|
|
1934
|
+
* @throws {RequiredError}
|
|
1935
|
+
*/
|
|
1936
|
+
getUncorrelatedTracks(after, options) {
|
|
1937
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1938
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getUncorrelatedTracks(after, options);
|
|
1939
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1940
|
+
});
|
|
1941
|
+
},
|
|
1942
|
+
/**
|
|
1943
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
1944
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
1945
|
+
* @param {*} [options] Override http request option.
|
|
1946
|
+
* @throws {RequiredError}
|
|
1947
|
+
*/
|
|
1948
|
+
v1CreateBlackoutVolume(v1BlackoutVolumeRequest, options) {
|
|
1949
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1950
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateBlackoutVolume(v1BlackoutVolumeRequest, options);
|
|
1951
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1952
|
+
});
|
|
1953
|
+
},
|
|
1593
1954
|
/**
|
|
1594
1955
|
* Create an image set.
|
|
1595
1956
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -1615,7 +1976,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1615
1976
|
});
|
|
1616
1977
|
},
|
|
1617
1978
|
/**
|
|
1618
|
-
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#
|
|
1979
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
1619
1980
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
1620
1981
|
* @param {*} [options] Override http request option.
|
|
1621
1982
|
* @throws {RequiredError}
|
|
@@ -1639,9 +2000,10 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1639
2000
|
});
|
|
1640
2001
|
},
|
|
1641
2002
|
/**
|
|
1642
|
-
* Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2003
|
+
* This endpoint is deprecated but will continue to work until 05/31/2025, please see [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) and [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric). Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
1643
2004
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
1644
2005
|
* @param {*} [options] Override http request option.
|
|
2006
|
+
* @deprecated
|
|
1645
2007
|
* @throws {RequiredError}
|
|
1646
2008
|
*/
|
|
1647
2009
|
v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options) {
|
|
@@ -1686,6 +2048,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1686
2048
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1687
2049
|
});
|
|
1688
2050
|
},
|
|
2051
|
+
/**
|
|
2052
|
+
* Delete a blackout volume.
|
|
2053
|
+
* @param {string} id
|
|
2054
|
+
* @param {*} [options] Override http request option.
|
|
2055
|
+
* @throws {RequiredError}
|
|
2056
|
+
*/
|
|
2057
|
+
v1DeleteBlackoutVolume(id, options) {
|
|
2058
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2059
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteBlackoutVolume(id, options);
|
|
2060
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2061
|
+
});
|
|
2062
|
+
},
|
|
1689
2063
|
/**
|
|
1690
2064
|
* Delete an image set.
|
|
1691
2065
|
* @param {string} id
|
|
@@ -1758,6 +2132,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1758
2132
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1759
2133
|
});
|
|
1760
2134
|
},
|
|
2135
|
+
/**
|
|
2136
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
2137
|
+
* @param {string} imageId
|
|
2138
|
+
* @param {*} [options] Override http request option.
|
|
2139
|
+
* @throws {RequiredError}
|
|
2140
|
+
*/
|
|
2141
|
+
v1GetImageMetadata(imageId, options) {
|
|
2142
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2143
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetImageMetadata(imageId, options);
|
|
2144
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2145
|
+
});
|
|
2146
|
+
},
|
|
1761
2147
|
/**
|
|
1762
2148
|
* Get an image set.
|
|
1763
2149
|
* @param {string} id
|
|
@@ -1897,7 +2283,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1897
2283
|
});
|
|
1898
2284
|
},
|
|
1899
2285
|
/**
|
|
1900
|
-
* Get organization targets see the [create](#
|
|
2286
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
1901
2287
|
* @param {*} [options] Override http request option.
|
|
1902
2288
|
* @throws {RequiredError}
|
|
1903
2289
|
*/
|
|
@@ -2084,6 +2470,66 @@ export const DefaultApiFp = function (configuration) {
|
|
|
2084
2470
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2085
2471
|
});
|
|
2086
2472
|
},
|
|
2473
|
+
/**
|
|
2474
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2475
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
2476
|
+
* @param {*} [options] Override http request option.
|
|
2477
|
+
* @throws {RequiredError}
|
|
2478
|
+
*/
|
|
2479
|
+
v2CreatePlaneScan(v1PlaneScanRequest, options) {
|
|
2480
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2481
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2CreatePlaneScan(v1PlaneScanRequest, options);
|
|
2482
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2483
|
+
});
|
|
2484
|
+
},
|
|
2485
|
+
/**
|
|
2486
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2487
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
2488
|
+
* @param {*} [options] Override http request option.
|
|
2489
|
+
* @throws {RequiredError}
|
|
2490
|
+
*/
|
|
2491
|
+
v2CreateRicVolumeSearch(v1RicVolumeSearchRequest, options) {
|
|
2492
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2493
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2CreateRicVolumeSearch(v1RicVolumeSearchRequest, options);
|
|
2494
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2495
|
+
});
|
|
2496
|
+
},
|
|
2497
|
+
/**
|
|
2498
|
+
* Delete a plane scan.
|
|
2499
|
+
* @param {string} id
|
|
2500
|
+
* @param {*} [options] Override http request option.
|
|
2501
|
+
* @throws {RequiredError}
|
|
2502
|
+
*/
|
|
2503
|
+
v2DeletePlaneScan(id, options) {
|
|
2504
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2505
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2DeletePlaneScan(id, options);
|
|
2506
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2507
|
+
});
|
|
2508
|
+
},
|
|
2509
|
+
/**
|
|
2510
|
+
* Delete a RIC volume search.
|
|
2511
|
+
* @param {string} id
|
|
2512
|
+
* @param {*} [options] Override http request option.
|
|
2513
|
+
* @throws {RequiredError}
|
|
2514
|
+
*/
|
|
2515
|
+
v2DeleteRicVolumeSearch(id, options) {
|
|
2516
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2517
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2DeleteRicVolumeSearch(id, options);
|
|
2518
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2519
|
+
});
|
|
2520
|
+
},
|
|
2521
|
+
/**
|
|
2522
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
2523
|
+
* @param {string} searchId
|
|
2524
|
+
* @param {*} [options] Override http request option.
|
|
2525
|
+
* @throws {RequiredError}
|
|
2526
|
+
*/
|
|
2527
|
+
v2GetSearch(searchId, options) {
|
|
2528
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2529
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v2GetSearch(searchId, options);
|
|
2530
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2531
|
+
});
|
|
2532
|
+
},
|
|
2087
2533
|
};
|
|
2088
2534
|
};
|
|
2089
2535
|
/**
|
|
@@ -2093,6 +2539,25 @@ export const DefaultApiFp = function (configuration) {
|
|
|
2093
2539
|
export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
2094
2540
|
const localVarFp = DefaultApiFp(configuration);
|
|
2095
2541
|
return {
|
|
2542
|
+
/**
|
|
2543
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
2544
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
2545
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
2546
|
+
* @param {*} [options] Override http request option.
|
|
2547
|
+
* @throws {RequiredError}
|
|
2548
|
+
*/
|
|
2549
|
+
getUncorrelatedTracks(requestParameters = {}, options) {
|
|
2550
|
+
return localVarFp.getUncorrelatedTracks(requestParameters.after, options).then((request) => request(axios, basePath));
|
|
2551
|
+
},
|
|
2552
|
+
/**
|
|
2553
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
2554
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
2555
|
+
* @param {*} [options] Override http request option.
|
|
2556
|
+
* @throws {RequiredError}
|
|
2557
|
+
*/
|
|
2558
|
+
v1CreateBlackoutVolume(requestParameters, options) {
|
|
2559
|
+
return localVarFp.v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(axios, basePath));
|
|
2560
|
+
},
|
|
2096
2561
|
/**
|
|
2097
2562
|
* Create an image set.
|
|
2098
2563
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -2112,7 +2577,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2112
2577
|
return localVarFp.v1CreateImageSetImage(requestParameters.v1CreateImageSetImageRequest, options).then((request) => request(axios, basePath));
|
|
2113
2578
|
},
|
|
2114
2579
|
/**
|
|
2115
|
-
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#
|
|
2580
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
2116
2581
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
2117
2582
|
* @param {*} [options] Override http request option.
|
|
2118
2583
|
* @throws {RequiredError}
|
|
@@ -2130,9 +2595,10 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2130
2595
|
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
2131
2596
|
},
|
|
2132
2597
|
/**
|
|
2133
|
-
* Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2598
|
+
* This endpoint is deprecated but will continue to work until 05/31/2025, please see [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) and [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric). Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2134
2599
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
2135
2600
|
* @param {*} [options] Override http request option.
|
|
2601
|
+
* @deprecated
|
|
2136
2602
|
* @throws {RequiredError}
|
|
2137
2603
|
*/
|
|
2138
2604
|
v1CreateSearchInstruction(requestParameters, options) {
|
|
@@ -2165,6 +2631,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2165
2631
|
v1CreateWebhookTest(requestParameters, options) {
|
|
2166
2632
|
return localVarFp.v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(axios, basePath));
|
|
2167
2633
|
},
|
|
2634
|
+
/**
|
|
2635
|
+
* Delete a blackout volume.
|
|
2636
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
2637
|
+
* @param {*} [options] Override http request option.
|
|
2638
|
+
* @throws {RequiredError}
|
|
2639
|
+
*/
|
|
2640
|
+
v1DeleteBlackoutVolume(requestParameters, options) {
|
|
2641
|
+
return localVarFp.v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
2642
|
+
},
|
|
2168
2643
|
/**
|
|
2169
2644
|
* Delete an image set.
|
|
2170
2645
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -2219,6 +2694,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2219
2694
|
v1DeleteWebhookConfiguration(requestParameters, options) {
|
|
2220
2695
|
return localVarFp.v1DeleteWebhookConfiguration(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
2221
2696
|
},
|
|
2697
|
+
/**
|
|
2698
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
2699
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
2700
|
+
* @param {*} [options] Override http request option.
|
|
2701
|
+
* @throws {RequiredError}
|
|
2702
|
+
*/
|
|
2703
|
+
v1GetImageMetadata(requestParameters, options) {
|
|
2704
|
+
return localVarFp.v1GetImageMetadata(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
2705
|
+
},
|
|
2222
2706
|
/**
|
|
2223
2707
|
* Get an image set.
|
|
2224
2708
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -2318,7 +2802,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2318
2802
|
return localVarFp.v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(axios, basePath));
|
|
2319
2803
|
},
|
|
2320
2804
|
/**
|
|
2321
|
-
* Get organization targets see the [create](#
|
|
2805
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2322
2806
|
* @param {*} [options] Override http request option.
|
|
2323
2807
|
* @throws {RequiredError}
|
|
2324
2808
|
*/
|
|
@@ -2450,6 +2934,51 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2450
2934
|
v1UpdateWebhookConfiguration(requestParameters, options) {
|
|
2451
2935
|
return localVarFp.v1UpdateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
2452
2936
|
},
|
|
2937
|
+
/**
|
|
2938
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2939
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
2940
|
+
* @param {*} [options] Override http request option.
|
|
2941
|
+
* @throws {RequiredError}
|
|
2942
|
+
*/
|
|
2943
|
+
v2CreatePlaneScan(requestParameters, options) {
|
|
2944
|
+
return localVarFp.v2CreatePlaneScan(requestParameters.v1PlaneScanRequest, options).then((request) => request(axios, basePath));
|
|
2945
|
+
},
|
|
2946
|
+
/**
|
|
2947
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2948
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
2949
|
+
* @param {*} [options] Override http request option.
|
|
2950
|
+
* @throws {RequiredError}
|
|
2951
|
+
*/
|
|
2952
|
+
v2CreateRicVolumeSearch(requestParameters, options) {
|
|
2953
|
+
return localVarFp.v2CreateRicVolumeSearch(requestParameters.v1RicVolumeSearchRequest, options).then((request) => request(axios, basePath));
|
|
2954
|
+
},
|
|
2955
|
+
/**
|
|
2956
|
+
* Delete a plane scan.
|
|
2957
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
2958
|
+
* @param {*} [options] Override http request option.
|
|
2959
|
+
* @throws {RequiredError}
|
|
2960
|
+
*/
|
|
2961
|
+
v2DeletePlaneScan(requestParameters, options) {
|
|
2962
|
+
return localVarFp.v2DeletePlaneScan(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
2963
|
+
},
|
|
2964
|
+
/**
|
|
2965
|
+
* Delete a RIC volume search.
|
|
2966
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
2967
|
+
* @param {*} [options] Override http request option.
|
|
2968
|
+
* @throws {RequiredError}
|
|
2969
|
+
*/
|
|
2970
|
+
v2DeleteRicVolumeSearch(requestParameters, options) {
|
|
2971
|
+
return localVarFp.v2DeleteRicVolumeSearch(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
2972
|
+
},
|
|
2973
|
+
/**
|
|
2974
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
2975
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
2976
|
+
* @param {*} [options] Override http request option.
|
|
2977
|
+
* @throws {RequiredError}
|
|
2978
|
+
*/
|
|
2979
|
+
v2GetSearch(requestParameters, options) {
|
|
2980
|
+
return localVarFp.v2GetSearch(requestParameters.searchId, options).then((request) => request(axios, basePath));
|
|
2981
|
+
},
|
|
2453
2982
|
};
|
|
2454
2983
|
};
|
|
2455
2984
|
/**
|
|
@@ -2459,6 +2988,27 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
2459
2988
|
* @extends {BaseAPI}
|
|
2460
2989
|
*/
|
|
2461
2990
|
export class DefaultApi extends BaseAPI {
|
|
2991
|
+
/**
|
|
2992
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
2993
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
2994
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
2995
|
+
* @param {*} [options] Override http request option.
|
|
2996
|
+
* @throws {RequiredError}
|
|
2997
|
+
* @memberof DefaultApi
|
|
2998
|
+
*/
|
|
2999
|
+
getUncorrelatedTracks(requestParameters = {}, options) {
|
|
3000
|
+
return DefaultApiFp(this.configuration).getUncorrelatedTracks(requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3001
|
+
}
|
|
3002
|
+
/**
|
|
3003
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3004
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3005
|
+
* @param {*} [options] Override http request option.
|
|
3006
|
+
* @throws {RequiredError}
|
|
3007
|
+
* @memberof DefaultApi
|
|
3008
|
+
*/
|
|
3009
|
+
v1CreateBlackoutVolume(requestParameters, options) {
|
|
3010
|
+
return DefaultApiFp(this.configuration).v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3011
|
+
}
|
|
2462
3012
|
/**
|
|
2463
3013
|
* Create an image set.
|
|
2464
3014
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -2480,7 +3030,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
2480
3030
|
return DefaultApiFp(this.configuration).v1CreateImageSetImage(requestParameters.v1CreateImageSetImageRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2481
3031
|
}
|
|
2482
3032
|
/**
|
|
2483
|
-
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#
|
|
3033
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
2484
3034
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
2485
3035
|
* @param {*} [options] Override http request option.
|
|
2486
3036
|
* @throws {RequiredError}
|
|
@@ -2500,9 +3050,10 @@ export class DefaultApi extends BaseAPI {
|
|
|
2500
3050
|
return DefaultApiFp(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2501
3051
|
}
|
|
2502
3052
|
/**
|
|
2503
|
-
* Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3053
|
+
* This endpoint is deprecated but will continue to work until 05/31/2025, please see [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) and [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric). Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
2504
3054
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
2505
3055
|
* @param {*} [options] Override http request option.
|
|
3056
|
+
* @deprecated
|
|
2506
3057
|
* @throws {RequiredError}
|
|
2507
3058
|
* @memberof DefaultApi
|
|
2508
3059
|
*/
|
|
@@ -2539,6 +3090,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
2539
3090
|
v1CreateWebhookTest(requestParameters, options) {
|
|
2540
3091
|
return DefaultApiFp(this.configuration).v1CreateWebhookTest(requestParameters.v1CreateWebhookTestRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2541
3092
|
}
|
|
3093
|
+
/**
|
|
3094
|
+
* Delete a blackout volume.
|
|
3095
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3096
|
+
* @param {*} [options] Override http request option.
|
|
3097
|
+
* @throws {RequiredError}
|
|
3098
|
+
* @memberof DefaultApi
|
|
3099
|
+
*/
|
|
3100
|
+
v1DeleteBlackoutVolume(requestParameters, options) {
|
|
3101
|
+
return DefaultApiFp(this.configuration).v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
3102
|
+
}
|
|
2542
3103
|
/**
|
|
2543
3104
|
* Delete an image set.
|
|
2544
3105
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -2599,6 +3160,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
2599
3160
|
v1DeleteWebhookConfiguration(requestParameters, options) {
|
|
2600
3161
|
return DefaultApiFp(this.configuration).v1DeleteWebhookConfiguration(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2601
3162
|
}
|
|
3163
|
+
/**
|
|
3164
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
3165
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
3166
|
+
* @param {*} [options] Override http request option.
|
|
3167
|
+
* @throws {RequiredError}
|
|
3168
|
+
* @memberof DefaultApi
|
|
3169
|
+
*/
|
|
3170
|
+
v1GetImageMetadata(requestParameters, options) {
|
|
3171
|
+
return DefaultApiFp(this.configuration).v1GetImageMetadata(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3172
|
+
}
|
|
2602
3173
|
/**
|
|
2603
3174
|
* Get an image set.
|
|
2604
3175
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -2709,7 +3280,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
2709
3280
|
return DefaultApiFp(this.configuration).v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
2710
3281
|
}
|
|
2711
3282
|
/**
|
|
2712
|
-
* Get organization targets see the [create](#
|
|
3283
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2713
3284
|
* @param {*} [options] Override http request option.
|
|
2714
3285
|
* @throws {RequiredError}
|
|
2715
3286
|
* @memberof DefaultApi
|
|
@@ -2856,4 +3427,54 @@ export class DefaultApi extends BaseAPI {
|
|
|
2856
3427
|
v1UpdateWebhookConfiguration(requestParameters, options) {
|
|
2857
3428
|
return DefaultApiFp(this.configuration).v1UpdateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2858
3429
|
}
|
|
3430
|
+
/**
|
|
3431
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3432
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
3433
|
+
* @param {*} [options] Override http request option.
|
|
3434
|
+
* @throws {RequiredError}
|
|
3435
|
+
* @memberof DefaultApi
|
|
3436
|
+
*/
|
|
3437
|
+
v2CreatePlaneScan(requestParameters, options) {
|
|
3438
|
+
return DefaultApiFp(this.configuration).v2CreatePlaneScan(requestParameters.v1PlaneScanRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3439
|
+
}
|
|
3440
|
+
/**
|
|
3441
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3442
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
3443
|
+
* @param {*} [options] Override http request option.
|
|
3444
|
+
* @throws {RequiredError}
|
|
3445
|
+
* @memberof DefaultApi
|
|
3446
|
+
*/
|
|
3447
|
+
v2CreateRicVolumeSearch(requestParameters, options) {
|
|
3448
|
+
return DefaultApiFp(this.configuration).v2CreateRicVolumeSearch(requestParameters.v1RicVolumeSearchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3449
|
+
}
|
|
3450
|
+
/**
|
|
3451
|
+
* Delete a plane scan.
|
|
3452
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
3453
|
+
* @param {*} [options] Override http request option.
|
|
3454
|
+
* @throws {RequiredError}
|
|
3455
|
+
* @memberof DefaultApi
|
|
3456
|
+
*/
|
|
3457
|
+
v2DeletePlaneScan(requestParameters, options) {
|
|
3458
|
+
return DefaultApiFp(this.configuration).v2DeletePlaneScan(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
3459
|
+
}
|
|
3460
|
+
/**
|
|
3461
|
+
* Delete a RIC volume search.
|
|
3462
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
3463
|
+
* @param {*} [options] Override http request option.
|
|
3464
|
+
* @throws {RequiredError}
|
|
3465
|
+
* @memberof DefaultApi
|
|
3466
|
+
*/
|
|
3467
|
+
v2DeleteRicVolumeSearch(requestParameters, options) {
|
|
3468
|
+
return DefaultApiFp(this.configuration).v2DeleteRicVolumeSearch(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
3469
|
+
}
|
|
3470
|
+
/**
|
|
3471
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3472
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
3473
|
+
* @param {*} [options] Override http request option.
|
|
3474
|
+
* @throws {RequiredError}
|
|
3475
|
+
* @memberof DefaultApi
|
|
3476
|
+
*/
|
|
3477
|
+
v2GetSearch(requestParameters, options) {
|
|
3478
|
+
return DefaultApiFp(this.configuration).v2GetSearch(requestParameters.searchId, options).then((request) => request(this.axios, this.basePath));
|
|
3479
|
+
}
|
|
2859
3480
|
}
|