@ourskyai/sda-api 1.3.2816 → 1.3.3194
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 +798 -116
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +479 -71
- package/dist/api.js +434 -29
- 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 +479 -71
- package/dist/esm/api.js +433 -28
- 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/api.ts
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 TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.3194
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -252,6 +252,18 @@ export interface ObservationResult {
|
|
|
252
252
|
* @memberof ObservationResult
|
|
253
253
|
*/
|
|
254
254
|
'dec': number;
|
|
255
|
+
/**
|
|
256
|
+
* The measured right ascension calibrated for stellar aberration in degrees
|
|
257
|
+
* @type {number}
|
|
258
|
+
* @memberof ObservationResult
|
|
259
|
+
*/
|
|
260
|
+
'correctedRa'?: number;
|
|
261
|
+
/**
|
|
262
|
+
* The measured declination calibrated for stellar aberration in degrees
|
|
263
|
+
* @type {number}
|
|
264
|
+
* @memberof ObservationResult
|
|
265
|
+
*/
|
|
266
|
+
'correctedDec'?: number;
|
|
255
267
|
/**
|
|
256
268
|
*
|
|
257
269
|
* @type {ObservationBoundingBox}
|
|
@@ -283,6 +295,22 @@ export interface ObservationResult {
|
|
|
283
295
|
*/
|
|
284
296
|
'features'?: Array<V1ObservationFeature>;
|
|
285
297
|
}
|
|
298
|
+
/**
|
|
299
|
+
*
|
|
300
|
+
* @export
|
|
301
|
+
* @enum {string}
|
|
302
|
+
*/
|
|
303
|
+
|
|
304
|
+
export const ObservationState = {
|
|
305
|
+
PENDING: 'PENDING',
|
|
306
|
+
UNDERWAY: 'UNDERWAY',
|
|
307
|
+
COMPLETED: 'COMPLETED',
|
|
308
|
+
FAILED: 'FAILED'
|
|
309
|
+
} as const;
|
|
310
|
+
|
|
311
|
+
export type ObservationState = typeof ObservationState[keyof typeof ObservationState];
|
|
312
|
+
|
|
313
|
+
|
|
286
314
|
/**
|
|
287
315
|
*
|
|
288
316
|
* @export
|
|
@@ -471,78 +499,48 @@ export interface V1CreateSatelliteTargetRequest {
|
|
|
471
499
|
/**
|
|
472
500
|
*
|
|
473
501
|
* @export
|
|
474
|
-
* @interface
|
|
502
|
+
* @interface V1CreateSearchInstructionRequest
|
|
475
503
|
*/
|
|
476
|
-
export interface
|
|
477
|
-
/**
|
|
478
|
-
*
|
|
479
|
-
* @type {string}
|
|
480
|
-
* @memberof V1CreateSearchTaskRequest
|
|
481
|
-
*/
|
|
482
|
-
'nodeId': string;
|
|
504
|
+
export interface V1CreateSearchInstructionRequest {
|
|
483
505
|
/**
|
|
484
506
|
*
|
|
485
507
|
* @type {string}
|
|
486
|
-
* @memberof
|
|
508
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
487
509
|
*/
|
|
488
510
|
'targetId': string;
|
|
489
511
|
/**
|
|
490
512
|
*
|
|
491
513
|
* @type {TrackingType}
|
|
492
|
-
* @memberof
|
|
514
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
493
515
|
*/
|
|
494
|
-
'trackingType'
|
|
516
|
+
'trackingType': TrackingType;
|
|
495
517
|
/**
|
|
496
518
|
*
|
|
497
|
-
* @type {Array<
|
|
498
|
-
* @memberof
|
|
519
|
+
* @type {Array<V1SearchInstructionStep>}
|
|
520
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
499
521
|
*/
|
|
500
|
-
'steps': Array<
|
|
522
|
+
'steps': Array<V1SearchInstructionStep>;
|
|
501
523
|
}
|
|
502
524
|
|
|
503
525
|
|
|
504
526
|
/**
|
|
505
|
-
*
|
|
527
|
+
*
|
|
506
528
|
* @export
|
|
507
|
-
* @interface
|
|
529
|
+
* @interface V1CreateSurveyInstructionRequest
|
|
508
530
|
*/
|
|
509
|
-
export interface
|
|
510
|
-
/**
|
|
511
|
-
* Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
512
|
-
* @type {number}
|
|
513
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
514
|
-
*/
|
|
515
|
-
'ra'?: number;
|
|
516
|
-
/**
|
|
517
|
-
* Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
518
|
-
* @type {number}
|
|
519
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
520
|
-
*/
|
|
521
|
-
'dec'?: number;
|
|
522
|
-
/**
|
|
523
|
-
* Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
524
|
-
* @type {number}
|
|
525
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
526
|
-
*/
|
|
527
|
-
'raOffset'?: number;
|
|
528
|
-
/**
|
|
529
|
-
* Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
530
|
-
* @type {number}
|
|
531
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
532
|
-
*/
|
|
533
|
-
'decOffset'?: number;
|
|
531
|
+
export interface V1CreateSurveyInstructionRequest {
|
|
534
532
|
/**
|
|
535
533
|
*
|
|
536
534
|
* @type {string}
|
|
537
|
-
* @memberof
|
|
535
|
+
* @memberof V1CreateSurveyInstructionRequest
|
|
538
536
|
*/
|
|
539
|
-
'
|
|
537
|
+
'targetId': string;
|
|
540
538
|
/**
|
|
541
539
|
*
|
|
542
|
-
* @type {
|
|
543
|
-
* @memberof
|
|
540
|
+
* @type {Array<V1SurveyInstructionStep>}
|
|
541
|
+
* @memberof V1CreateSurveyInstructionRequest
|
|
544
542
|
*/
|
|
545
|
-
'
|
|
543
|
+
'steps': Array<V1SurveyInstructionStep>;
|
|
546
544
|
}
|
|
547
545
|
/**
|
|
548
546
|
*
|
|
@@ -1071,6 +1069,24 @@ export interface V1ObservationStatus {
|
|
|
1071
1069
|
* @memberof V1ObservationStatus
|
|
1072
1070
|
*/
|
|
1073
1071
|
'searchInstructionId'?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
*
|
|
1074
|
+
* @type {string}
|
|
1075
|
+
* @memberof V1ObservationStatus
|
|
1076
|
+
*/
|
|
1077
|
+
'surveyInstructionId'?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
*
|
|
1080
|
+
* @type {string}
|
|
1081
|
+
* @memberof V1ObservationStatus
|
|
1082
|
+
*/
|
|
1083
|
+
'completedAt'?: string;
|
|
1084
|
+
/**
|
|
1085
|
+
*
|
|
1086
|
+
* @type {ObservationState}
|
|
1087
|
+
* @memberof V1ObservationStatus
|
|
1088
|
+
*/
|
|
1089
|
+
'state': ObservationState;
|
|
1074
1090
|
}
|
|
1075
1091
|
|
|
1076
1092
|
|
|
@@ -1201,6 +1217,144 @@ export interface V1SatelliteTarget {
|
|
|
1201
1217
|
}
|
|
1202
1218
|
|
|
1203
1219
|
|
|
1220
|
+
/**
|
|
1221
|
+
* Search Instruction
|
|
1222
|
+
* @export
|
|
1223
|
+
* @interface V1SearchInstruction
|
|
1224
|
+
*/
|
|
1225
|
+
export interface V1SearchInstruction {
|
|
1226
|
+
/**
|
|
1227
|
+
*
|
|
1228
|
+
* @type {string}
|
|
1229
|
+
* @memberof V1SearchInstruction
|
|
1230
|
+
*/
|
|
1231
|
+
'id': string;
|
|
1232
|
+
/**
|
|
1233
|
+
*
|
|
1234
|
+
* @type {string}
|
|
1235
|
+
* @memberof V1SearchInstruction
|
|
1236
|
+
*/
|
|
1237
|
+
'nodeId'?: string;
|
|
1238
|
+
/**
|
|
1239
|
+
*
|
|
1240
|
+
* @type {string}
|
|
1241
|
+
* @memberof V1SearchInstruction
|
|
1242
|
+
*/
|
|
1243
|
+
'targetId': string;
|
|
1244
|
+
/**
|
|
1245
|
+
*
|
|
1246
|
+
* @type {TrackingType}
|
|
1247
|
+
* @memberof V1SearchInstruction
|
|
1248
|
+
*/
|
|
1249
|
+
'trackingType': TrackingType;
|
|
1250
|
+
/**
|
|
1251
|
+
* Each step indicates an observation attempt at a given distance offset in the local spacecraft frame. Offset values for each step should always be entered in absolute distance offset from the target\'s TLE, not relative to the previous step.
|
|
1252
|
+
* @type {Array<V1SearchInstructionStep>}
|
|
1253
|
+
* @memberof V1SearchInstruction
|
|
1254
|
+
*/
|
|
1255
|
+
'steps': Array<V1SearchInstructionStep>;
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Search Instruction Step
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface V1SearchInstructionStep
|
|
1263
|
+
*/
|
|
1264
|
+
export interface V1SearchInstructionStep {
|
|
1265
|
+
/**
|
|
1266
|
+
* Along-track offset in the local spacecraft frame.
|
|
1267
|
+
* @type {number}
|
|
1268
|
+
* @memberof V1SearchInstructionStep
|
|
1269
|
+
*/
|
|
1270
|
+
'alongTrackOffsetMeters': number;
|
|
1271
|
+
/**
|
|
1272
|
+
* Cross-track offset in the local spacecraft frame.
|
|
1273
|
+
* @type {number}
|
|
1274
|
+
* @memberof V1SearchInstructionStep
|
|
1275
|
+
*/
|
|
1276
|
+
'crossTrackOffsetMeters': number;
|
|
1277
|
+
/**
|
|
1278
|
+
* Radial offset in the local spacecraft frame.
|
|
1279
|
+
* @type {number}
|
|
1280
|
+
* @memberof V1SearchInstructionStep
|
|
1281
|
+
*/
|
|
1282
|
+
'radialOffsetMeters': number;
|
|
1283
|
+
/**
|
|
1284
|
+
*
|
|
1285
|
+
* @type {string}
|
|
1286
|
+
* @memberof V1SearchInstructionStep
|
|
1287
|
+
*/
|
|
1288
|
+
'startTime': string;
|
|
1289
|
+
/**
|
|
1290
|
+
*
|
|
1291
|
+
* @type {string}
|
|
1292
|
+
* @memberof V1SearchInstructionStep
|
|
1293
|
+
*/
|
|
1294
|
+
'endTime': string;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
*
|
|
1298
|
+
* @export
|
|
1299
|
+
* @interface V1SurveyInstruction
|
|
1300
|
+
*/
|
|
1301
|
+
export interface V1SurveyInstruction {
|
|
1302
|
+
/**
|
|
1303
|
+
*
|
|
1304
|
+
* @type {string}
|
|
1305
|
+
* @memberof V1SurveyInstruction
|
|
1306
|
+
*/
|
|
1307
|
+
'id': string;
|
|
1308
|
+
/**
|
|
1309
|
+
*
|
|
1310
|
+
* @type {string}
|
|
1311
|
+
* @memberof V1SurveyInstruction
|
|
1312
|
+
*/
|
|
1313
|
+
'nodeId'?: string;
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @type {string}
|
|
1317
|
+
* @memberof V1SurveyInstruction
|
|
1318
|
+
*/
|
|
1319
|
+
'targetId': string;
|
|
1320
|
+
/**
|
|
1321
|
+
* Each step indicates a sidereal observation attempt at a given (Ra, Dec). When supplying coordinates, they should be given in J2000 reference frames using an SGP4 model for propagation.
|
|
1322
|
+
* @type {Array<V1SurveyInstructionStep>}
|
|
1323
|
+
* @memberof V1SurveyInstruction
|
|
1324
|
+
*/
|
|
1325
|
+
'steps': Array<V1SurveyInstructionStep>;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* Survey Instruction Step
|
|
1329
|
+
* @export
|
|
1330
|
+
* @interface V1SurveyInstructionStep
|
|
1331
|
+
*/
|
|
1332
|
+
export interface V1SurveyInstructionStep {
|
|
1333
|
+
/**
|
|
1334
|
+
*
|
|
1335
|
+
* @type {number}
|
|
1336
|
+
* @memberof V1SurveyInstructionStep
|
|
1337
|
+
*/
|
|
1338
|
+
'ra': number;
|
|
1339
|
+
/**
|
|
1340
|
+
*
|
|
1341
|
+
* @type {number}
|
|
1342
|
+
* @memberof V1SurveyInstructionStep
|
|
1343
|
+
*/
|
|
1344
|
+
'dec': number;
|
|
1345
|
+
/**
|
|
1346
|
+
*
|
|
1347
|
+
* @type {string}
|
|
1348
|
+
* @memberof V1SurveyInstructionStep
|
|
1349
|
+
*/
|
|
1350
|
+
'startTime': string;
|
|
1351
|
+
/**
|
|
1352
|
+
*
|
|
1353
|
+
* @type {string}
|
|
1354
|
+
* @memberof V1SurveyInstructionStep
|
|
1355
|
+
*/
|
|
1356
|
+
'endTime': string;
|
|
1357
|
+
}
|
|
1204
1358
|
/**
|
|
1205
1359
|
* Target Correlation
|
|
1206
1360
|
* @export
|
|
@@ -1607,14 +1761,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1607
1761
|
};
|
|
1608
1762
|
},
|
|
1609
1763
|
/**
|
|
1610
|
-
*
|
|
1611
|
-
* @param {
|
|
1764
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
1765
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
1612
1766
|
* @param {*} [options] Override http request option.
|
|
1613
1767
|
* @throws {RequiredError}
|
|
1614
1768
|
*/
|
|
1615
|
-
|
|
1616
|
-
// verify required parameter '
|
|
1617
|
-
assertParamExists('
|
|
1769
|
+
v1CreateSearchInstruction: async (v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1770
|
+
// verify required parameter 'v1CreateSearchInstructionRequest' is not null or undefined
|
|
1771
|
+
assertParamExists('v1CreateSearchInstruction', 'v1CreateSearchInstructionRequest', v1CreateSearchInstructionRequest)
|
|
1618
1772
|
const localVarPath = `/v1/search-instruction`;
|
|
1619
1773
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1620
1774
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1640,7 +1794,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1640
1794
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1641
1795
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1642
1796
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1643
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
1797
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSearchInstructionRequest, localVarRequestOptions, configuration)
|
|
1798
|
+
|
|
1799
|
+
return {
|
|
1800
|
+
url: toPathString(localVarUrlObj),
|
|
1801
|
+
options: localVarRequestOptions,
|
|
1802
|
+
};
|
|
1803
|
+
},
|
|
1804
|
+
/**
|
|
1805
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
1806
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
1807
|
+
* @param {*} [options] Override http request option.
|
|
1808
|
+
* @throws {RequiredError}
|
|
1809
|
+
*/
|
|
1810
|
+
v1CreateSurveyInstruction: async (v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1811
|
+
// verify required parameter 'v1CreateSurveyInstructionRequest' is not null or undefined
|
|
1812
|
+
assertParamExists('v1CreateSurveyInstruction', 'v1CreateSurveyInstructionRequest', v1CreateSurveyInstructionRequest)
|
|
1813
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
1814
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1815
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1816
|
+
let baseOptions;
|
|
1817
|
+
if (configuration) {
|
|
1818
|
+
baseOptions = configuration.baseOptions;
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1821
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1822
|
+
const localVarHeaderParameter = {} as any;
|
|
1823
|
+
const localVarQueryParameter = {} as any;
|
|
1824
|
+
|
|
1825
|
+
// authentication Roles required
|
|
1826
|
+
|
|
1827
|
+
// authentication BearerToken required
|
|
1828
|
+
// http bearer authentication required
|
|
1829
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1834
|
+
|
|
1835
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1836
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1837
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1838
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSurveyInstructionRequest, localVarRequestOptions, configuration)
|
|
1644
1839
|
|
|
1645
1840
|
return {
|
|
1646
1841
|
url: toPathString(localVarUrlObj),
|
|
@@ -1815,15 +2010,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1815
2010
|
};
|
|
1816
2011
|
},
|
|
1817
2012
|
/**
|
|
1818
|
-
* Delete a
|
|
2013
|
+
* Delete a search instruction.
|
|
1819
2014
|
* @param {string} id
|
|
1820
2015
|
* @param {*} [options] Override http request option.
|
|
1821
2016
|
* @throws {RequiredError}
|
|
1822
2017
|
*/
|
|
1823
|
-
|
|
2018
|
+
v1DeleteSearchInstruction: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1824
2019
|
// verify required parameter 'id' is not null or undefined
|
|
1825
|
-
assertParamExists('
|
|
1826
|
-
const localVarPath = `/v1/
|
|
2020
|
+
assertParamExists('v1DeleteSearchInstruction', 'id', id)
|
|
2021
|
+
const localVarPath = `/v1/search-instruction`;
|
|
1827
2022
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1828
2023
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1829
2024
|
let baseOptions;
|
|
@@ -1857,15 +2052,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1857
2052
|
};
|
|
1858
2053
|
},
|
|
1859
2054
|
/**
|
|
1860
|
-
*
|
|
2055
|
+
* Delete a survey instruction.
|
|
1861
2056
|
* @param {string} id
|
|
1862
2057
|
* @param {*} [options] Override http request option.
|
|
1863
2058
|
* @throws {RequiredError}
|
|
1864
2059
|
*/
|
|
1865
|
-
|
|
2060
|
+
v1DeleteSurveyInstruction: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1866
2061
|
// verify required parameter 'id' is not null or undefined
|
|
1867
|
-
assertParamExists('
|
|
1868
|
-
const localVarPath = `/v1/
|
|
2062
|
+
assertParamExists('v1DeleteSurveyInstruction', 'id', id)
|
|
2063
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
1869
2064
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1870
2065
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1871
2066
|
let baseOptions;
|
|
@@ -1873,7 +2068,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1873
2068
|
baseOptions = configuration.baseOptions;
|
|
1874
2069
|
}
|
|
1875
2070
|
|
|
1876
|
-
const localVarRequestOptions = { method: '
|
|
2071
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1877
2072
|
const localVarHeaderParameter = {} as any;
|
|
1878
2073
|
const localVarQueryParameter = {} as any;
|
|
1879
2074
|
|
|
@@ -1899,15 +2094,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1899
2094
|
};
|
|
1900
2095
|
},
|
|
1901
2096
|
/**
|
|
1902
|
-
*
|
|
1903
|
-
* @param {string}
|
|
2097
|
+
* Delete a webhook configuration.
|
|
2098
|
+
* @param {string} id
|
|
1904
2099
|
* @param {*} [options] Override http request option.
|
|
1905
2100
|
* @throws {RequiredError}
|
|
1906
2101
|
*/
|
|
1907
|
-
|
|
1908
|
-
// verify required parameter '
|
|
1909
|
-
assertParamExists('
|
|
1910
|
-
const localVarPath = `/v1/
|
|
2102
|
+
v1DeleteWebhookConfiguration: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2103
|
+
// verify required parameter 'id' is not null or undefined
|
|
2104
|
+
assertParamExists('v1DeleteWebhookConfiguration', 'id', id)
|
|
2105
|
+
const localVarPath = `/v1/communications/webhook`;
|
|
1911
2106
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1912
2107
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1913
2108
|
let baseOptions;
|
|
@@ -1915,7 +2110,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1915
2110
|
baseOptions = configuration.baseOptions;
|
|
1916
2111
|
}
|
|
1917
2112
|
|
|
1918
|
-
const localVarRequestOptions = { method: '
|
|
2113
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1919
2114
|
const localVarHeaderParameter = {} as any;
|
|
1920
2115
|
const localVarQueryParameter = {} as any;
|
|
1921
2116
|
|
|
@@ -1925,8 +2120,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1925
2120
|
// http bearer authentication required
|
|
1926
2121
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1927
2122
|
|
|
1928
|
-
if (
|
|
1929
|
-
localVarQueryParameter['
|
|
2123
|
+
if (id !== undefined) {
|
|
2124
|
+
localVarQueryParameter['id'] = id;
|
|
1930
2125
|
}
|
|
1931
2126
|
|
|
1932
2127
|
|
|
@@ -1941,15 +2136,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1941
2136
|
};
|
|
1942
2137
|
},
|
|
1943
2138
|
/**
|
|
1944
|
-
* Get image set
|
|
1945
|
-
* @param {
|
|
2139
|
+
* Get an image set.
|
|
2140
|
+
* @param {string} id
|
|
1946
2141
|
* @param {*} [options] Override http request option.
|
|
1947
2142
|
* @throws {RequiredError}
|
|
1948
2143
|
*/
|
|
1949
|
-
|
|
1950
|
-
// verify required parameter '
|
|
1951
|
-
assertParamExists('
|
|
1952
|
-
const localVarPath = `/v1/image-set
|
|
2144
|
+
v1GetImageSet: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2145
|
+
// verify required parameter 'id' is not null or undefined
|
|
2146
|
+
assertParamExists('v1GetImageSet', 'id', id)
|
|
2147
|
+
const localVarPath = `/v1/image-set`;
|
|
1953
2148
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1954
2149
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1955
2150
|
let baseOptions;
|
|
@@ -1967,8 +2162,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1967
2162
|
// http bearer authentication required
|
|
1968
2163
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1969
2164
|
|
|
1970
|
-
if (
|
|
1971
|
-
localVarQueryParameter['
|
|
2165
|
+
if (id !== undefined) {
|
|
2166
|
+
localVarQueryParameter['id'] = id;
|
|
1972
2167
|
}
|
|
1973
2168
|
|
|
1974
2169
|
|
|
@@ -1983,12 +2178,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1983
2178
|
};
|
|
1984
2179
|
},
|
|
1985
2180
|
/**
|
|
1986
|
-
* Get image
|
|
2181
|
+
* Get an image.
|
|
2182
|
+
* @param {string} imageId
|
|
1987
2183
|
* @param {*} [options] Override http request option.
|
|
1988
2184
|
* @throws {RequiredError}
|
|
1989
2185
|
*/
|
|
1990
|
-
|
|
1991
|
-
|
|
2186
|
+
v1GetImageSetImage: async (imageId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2187
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
2188
|
+
assertParamExists('v1GetImageSetImage', 'imageId', imageId)
|
|
2189
|
+
const localVarPath = `/v1/image-set-image`;
|
|
1992
2190
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1993
2191
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1994
2192
|
let baseOptions;
|
|
@@ -2006,6 +2204,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2006
2204
|
// http bearer authentication required
|
|
2007
2205
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2008
2206
|
|
|
2207
|
+
if (imageId !== undefined) {
|
|
2208
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
2209
|
+
}
|
|
2210
|
+
|
|
2009
2211
|
|
|
2010
2212
|
|
|
2011
2213
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2018,16 +2220,93 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2018
2220
|
};
|
|
2019
2221
|
},
|
|
2020
2222
|
/**
|
|
2021
|
-
* Get
|
|
2022
|
-
* @param {string}
|
|
2223
|
+
* Get image set images.
|
|
2224
|
+
* @param {Array<string>} imageSets
|
|
2023
2225
|
* @param {*} [options] Override http request option.
|
|
2024
2226
|
* @throws {RequiredError}
|
|
2025
2227
|
*/
|
|
2026
|
-
|
|
2027
|
-
// verify required parameter '
|
|
2028
|
-
assertParamExists('
|
|
2029
|
-
const localVarPath = `/v1/
|
|
2030
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2228
|
+
v1GetImageSetImages: async (imageSets: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2229
|
+
// verify required parameter 'imageSets' is not null or undefined
|
|
2230
|
+
assertParamExists('v1GetImageSetImages', 'imageSets', imageSets)
|
|
2231
|
+
const localVarPath = `/v1/image-set-images`;
|
|
2232
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2233
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2234
|
+
let baseOptions;
|
|
2235
|
+
if (configuration) {
|
|
2236
|
+
baseOptions = configuration.baseOptions;
|
|
2237
|
+
}
|
|
2238
|
+
|
|
2239
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2240
|
+
const localVarHeaderParameter = {} as any;
|
|
2241
|
+
const localVarQueryParameter = {} as any;
|
|
2242
|
+
|
|
2243
|
+
// authentication Roles required
|
|
2244
|
+
|
|
2245
|
+
// authentication BearerToken required
|
|
2246
|
+
// http bearer authentication required
|
|
2247
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2248
|
+
|
|
2249
|
+
if (imageSets) {
|
|
2250
|
+
localVarQueryParameter['imageSets'] = imageSets.join(COLLECTION_FORMATS.csv);
|
|
2251
|
+
}
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
|
|
2255
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2256
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2257
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2258
|
+
|
|
2259
|
+
return {
|
|
2260
|
+
url: toPathString(localVarUrlObj),
|
|
2261
|
+
options: localVarRequestOptions,
|
|
2262
|
+
};
|
|
2263
|
+
},
|
|
2264
|
+
/**
|
|
2265
|
+
* Get image sets.
|
|
2266
|
+
* @param {*} [options] Override http request option.
|
|
2267
|
+
* @throws {RequiredError}
|
|
2268
|
+
*/
|
|
2269
|
+
v1GetImageSets: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2270
|
+
const localVarPath = `/v1/image-sets`;
|
|
2271
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2272
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2273
|
+
let baseOptions;
|
|
2274
|
+
if (configuration) {
|
|
2275
|
+
baseOptions = configuration.baseOptions;
|
|
2276
|
+
}
|
|
2277
|
+
|
|
2278
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2279
|
+
const localVarHeaderParameter = {} as any;
|
|
2280
|
+
const localVarQueryParameter = {} as any;
|
|
2281
|
+
|
|
2282
|
+
// authentication Roles required
|
|
2283
|
+
|
|
2284
|
+
// authentication BearerToken required
|
|
2285
|
+
// http bearer authentication required
|
|
2286
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2291
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2292
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2293
|
+
|
|
2294
|
+
return {
|
|
2295
|
+
url: toPathString(localVarUrlObj),
|
|
2296
|
+
options: localVarRequestOptions,
|
|
2297
|
+
};
|
|
2298
|
+
},
|
|
2299
|
+
/**
|
|
2300
|
+
* Get node properties.
|
|
2301
|
+
* @param {string} nodeId
|
|
2302
|
+
* @param {*} [options] Override http request option.
|
|
2303
|
+
* @throws {RequiredError}
|
|
2304
|
+
*/
|
|
2305
|
+
v1GetNodeProperties: async (nodeId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2306
|
+
// verify required parameter 'nodeId' is not null or undefined
|
|
2307
|
+
assertParamExists('v1GetNodeProperties', 'nodeId', nodeId)
|
|
2308
|
+
const localVarPath = `/v1/node-properties`;
|
|
2309
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2031
2310
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2032
2311
|
let baseOptions;
|
|
2033
2312
|
if (configuration) {
|
|
@@ -2149,14 +2428,15 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2149
2428
|
};
|
|
2150
2429
|
},
|
|
2151
2430
|
/**
|
|
2152
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
2431
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
2153
2432
|
* @param {string} [targetId]
|
|
2154
2433
|
* @param {string} [before]
|
|
2155
2434
|
* @param {string} [searchInstructionId]
|
|
2435
|
+
* @param {string} [surveyInstructionId]
|
|
2156
2436
|
* @param {*} [options] Override http request option.
|
|
2157
2437
|
* @throws {RequiredError}
|
|
2158
2438
|
*/
|
|
2159
|
-
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2439
|
+
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2160
2440
|
const localVarPath = `/v1/observation-statuses`;
|
|
2161
2441
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2162
2442
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2189,6 +2469,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2189
2469
|
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
2190
2470
|
}
|
|
2191
2471
|
|
|
2472
|
+
if (surveyInstructionId !== undefined) {
|
|
2473
|
+
localVarQueryParameter['surveyInstructionId'] = surveyInstructionId;
|
|
2474
|
+
}
|
|
2475
|
+
|
|
2192
2476
|
|
|
2193
2477
|
|
|
2194
2478
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2277,6 +2561,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2277
2561
|
|
|
2278
2562
|
|
|
2279
2563
|
|
|
2564
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2565
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2566
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2567
|
+
|
|
2568
|
+
return {
|
|
2569
|
+
url: toPathString(localVarUrlObj),
|
|
2570
|
+
options: localVarRequestOptions,
|
|
2571
|
+
};
|
|
2572
|
+
},
|
|
2573
|
+
/**
|
|
2574
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
2575
|
+
* @param {string} id
|
|
2576
|
+
* @param {*} [options] Override http request option.
|
|
2577
|
+
* @throws {RequiredError}
|
|
2578
|
+
*/
|
|
2579
|
+
v1GetSatelliteTarget: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2580
|
+
// verify required parameter 'id' is not null or undefined
|
|
2581
|
+
assertParamExists('v1GetSatelliteTarget', 'id', id)
|
|
2582
|
+
const localVarPath = `/v1/satellite-target`;
|
|
2583
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2584
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2585
|
+
let baseOptions;
|
|
2586
|
+
if (configuration) {
|
|
2587
|
+
baseOptions = configuration.baseOptions;
|
|
2588
|
+
}
|
|
2589
|
+
|
|
2590
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2591
|
+
const localVarHeaderParameter = {} as any;
|
|
2592
|
+
const localVarQueryParameter = {} as any;
|
|
2593
|
+
|
|
2594
|
+
// authentication Roles required
|
|
2595
|
+
|
|
2596
|
+
// authentication BearerToken required
|
|
2597
|
+
// http bearer authentication required
|
|
2598
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2599
|
+
|
|
2600
|
+
if (id !== undefined) {
|
|
2601
|
+
localVarQueryParameter['id'] = id;
|
|
2602
|
+
}
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
|
|
2280
2606
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2281
2607
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2282
2608
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2322,6 +2648,90 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2322
2648
|
|
|
2323
2649
|
|
|
2324
2650
|
|
|
2651
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2652
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2653
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2654
|
+
|
|
2655
|
+
return {
|
|
2656
|
+
url: toPathString(localVarUrlObj),
|
|
2657
|
+
options: localVarRequestOptions,
|
|
2658
|
+
};
|
|
2659
|
+
},
|
|
2660
|
+
/**
|
|
2661
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
2662
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
2663
|
+
* @param {*} [options] Override http request option.
|
|
2664
|
+
* @throws {RequiredError}
|
|
2665
|
+
*/
|
|
2666
|
+
v1GetSearchInstructions: async (before?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2667
|
+
const localVarPath = `/v1/search-instructions`;
|
|
2668
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2669
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2670
|
+
let baseOptions;
|
|
2671
|
+
if (configuration) {
|
|
2672
|
+
baseOptions = configuration.baseOptions;
|
|
2673
|
+
}
|
|
2674
|
+
|
|
2675
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2676
|
+
const localVarHeaderParameter = {} as any;
|
|
2677
|
+
const localVarQueryParameter = {} as any;
|
|
2678
|
+
|
|
2679
|
+
// authentication Roles required
|
|
2680
|
+
|
|
2681
|
+
// authentication BearerToken required
|
|
2682
|
+
// http bearer authentication required
|
|
2683
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2684
|
+
|
|
2685
|
+
if (before !== undefined) {
|
|
2686
|
+
localVarQueryParameter['before'] = (before as any instanceof Date) ?
|
|
2687
|
+
(before as any).toISOString() :
|
|
2688
|
+
before;
|
|
2689
|
+
}
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2694
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2695
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2696
|
+
|
|
2697
|
+
return {
|
|
2698
|
+
url: toPathString(localVarUrlObj),
|
|
2699
|
+
options: localVarRequestOptions,
|
|
2700
|
+
};
|
|
2701
|
+
},
|
|
2702
|
+
/**
|
|
2703
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
2704
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
2705
|
+
* @param {*} [options] Override http request option.
|
|
2706
|
+
* @throws {RequiredError}
|
|
2707
|
+
*/
|
|
2708
|
+
v1GetSurveyInstructions: async (before?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2709
|
+
const localVarPath = `/v1/survey-instructions`;
|
|
2710
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2711
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2712
|
+
let baseOptions;
|
|
2713
|
+
if (configuration) {
|
|
2714
|
+
baseOptions = configuration.baseOptions;
|
|
2715
|
+
}
|
|
2716
|
+
|
|
2717
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2718
|
+
const localVarHeaderParameter = {} as any;
|
|
2719
|
+
const localVarQueryParameter = {} as any;
|
|
2720
|
+
|
|
2721
|
+
// authentication Roles required
|
|
2722
|
+
|
|
2723
|
+
// authentication BearerToken required
|
|
2724
|
+
// http bearer authentication required
|
|
2725
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2726
|
+
|
|
2727
|
+
if (before !== undefined) {
|
|
2728
|
+
localVarQueryParameter['before'] = (before as any instanceof Date) ?
|
|
2729
|
+
(before as any).toISOString() :
|
|
2730
|
+
before;
|
|
2731
|
+
}
|
|
2732
|
+
|
|
2733
|
+
|
|
2734
|
+
|
|
2325
2735
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2326
2736
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2327
2737
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2588,13 +2998,23 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2588
2998
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2589
2999
|
},
|
|
2590
3000
|
/**
|
|
2591
|
-
*
|
|
2592
|
-
* @param {
|
|
3001
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
3002
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
3003
|
+
* @param {*} [options] Override http request option.
|
|
3004
|
+
* @throws {RequiredError}
|
|
3005
|
+
*/
|
|
3006
|
+
async v1CreateSearchInstruction(v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
|
|
3007
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options);
|
|
3008
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3009
|
+
},
|
|
3010
|
+
/**
|
|
3011
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
3012
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
2593
3013
|
* @param {*} [options] Override http request option.
|
|
2594
3014
|
* @throws {RequiredError}
|
|
2595
3015
|
*/
|
|
2596
|
-
async
|
|
2597
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3016
|
+
async v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
|
|
3017
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest, options);
|
|
2598
3018
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2599
3019
|
},
|
|
2600
3020
|
/**
|
|
@@ -2637,6 +3057,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2637
3057
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteOrganizationTarget(satelliteTargetId, options);
|
|
2638
3058
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2639
3059
|
},
|
|
3060
|
+
/**
|
|
3061
|
+
* Delete a search instruction.
|
|
3062
|
+
* @param {string} id
|
|
3063
|
+
* @param {*} [options] Override http request option.
|
|
3064
|
+
* @throws {RequiredError}
|
|
3065
|
+
*/
|
|
3066
|
+
async v1DeleteSearchInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
3067
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteSearchInstruction(id, options);
|
|
3068
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3069
|
+
},
|
|
3070
|
+
/**
|
|
3071
|
+
* Delete a survey instruction.
|
|
3072
|
+
* @param {string} id
|
|
3073
|
+
* @param {*} [options] Override http request option.
|
|
3074
|
+
* @throws {RequiredError}
|
|
3075
|
+
*/
|
|
3076
|
+
async v1DeleteSurveyInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
3077
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteSurveyInstruction(id, options);
|
|
3078
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3079
|
+
},
|
|
2640
3080
|
/**
|
|
2641
3081
|
* Delete a webhook configuration.
|
|
2642
3082
|
* @param {string} id
|
|
@@ -2718,15 +3158,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2718
3158
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2719
3159
|
},
|
|
2720
3160
|
/**
|
|
2721
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
3161
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
2722
3162
|
* @param {string} [targetId]
|
|
2723
3163
|
* @param {string} [before]
|
|
2724
3164
|
* @param {string} [searchInstructionId]
|
|
3165
|
+
* @param {string} [surveyInstructionId]
|
|
2725
3166
|
* @param {*} [options] Override http request option.
|
|
2726
3167
|
* @throws {RequiredError}
|
|
2727
3168
|
*/
|
|
2728
|
-
async v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>> {
|
|
2729
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, options);
|
|
3169
|
+
async v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>> {
|
|
3170
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options);
|
|
2730
3171
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2731
3172
|
},
|
|
2732
3173
|
/**
|
|
@@ -2749,6 +3190,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2749
3190
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, options);
|
|
2750
3191
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2751
3192
|
},
|
|
3193
|
+
/**
|
|
3194
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
3195
|
+
* @param {string} id
|
|
3196
|
+
* @param {*} [options] Override http request option.
|
|
3197
|
+
* @throws {RequiredError}
|
|
3198
|
+
*/
|
|
3199
|
+
async v1GetSatelliteTarget(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SatelliteTarget>> {
|
|
3200
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatelliteTarget(id, options);
|
|
3201
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3202
|
+
},
|
|
2752
3203
|
/**
|
|
2753
3204
|
* The available satellite objects that the OurSky platform can currently track.
|
|
2754
3205
|
* @param {OrbitType} [orbitType]
|
|
@@ -2760,6 +3211,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2760
3211
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatelliteTargets(orbitType, noradId, options);
|
|
2761
3212
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2762
3213
|
},
|
|
3214
|
+
/**
|
|
3215
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
3216
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
3217
|
+
* @param {*} [options] Override http request option.
|
|
3218
|
+
* @throws {RequiredError}
|
|
3219
|
+
*/
|
|
3220
|
+
async v1GetSearchInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SearchInstruction>>> {
|
|
3221
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSearchInstructions(before, options);
|
|
3222
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3223
|
+
},
|
|
3224
|
+
/**
|
|
3225
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
3226
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
3227
|
+
* @param {*} [options] Override http request option.
|
|
3228
|
+
* @throws {RequiredError}
|
|
3229
|
+
*/
|
|
3230
|
+
async v1GetSurveyInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SurveyInstruction>>> {
|
|
3231
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSurveyInstructions(before, options);
|
|
3232
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3233
|
+
},
|
|
2763
3234
|
/**
|
|
2764
3235
|
* Get a TDM.
|
|
2765
3236
|
* @param {string} tdmId
|
|
@@ -2857,13 +3328,22 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2857
3328
|
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
2858
3329
|
},
|
|
2859
3330
|
/**
|
|
2860
|
-
*
|
|
2861
|
-
* @param {
|
|
3331
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
3332
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
3333
|
+
* @param {*} [options] Override http request option.
|
|
3334
|
+
* @throws {RequiredError}
|
|
3335
|
+
*/
|
|
3336
|
+
v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
3337
|
+
return localVarFp.v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(axios, basePath));
|
|
3338
|
+
},
|
|
3339
|
+
/**
|
|
3340
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
3341
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
2862
3342
|
* @param {*} [options] Override http request option.
|
|
2863
3343
|
* @throws {RequiredError}
|
|
2864
3344
|
*/
|
|
2865
|
-
|
|
2866
|
-
return localVarFp.
|
|
3345
|
+
v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
3346
|
+
return localVarFp.v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(axios, basePath));
|
|
2867
3347
|
},
|
|
2868
3348
|
/**
|
|
2869
3349
|
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
@@ -2901,6 +3381,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2901
3381
|
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2902
3382
|
return localVarFp.v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(axios, basePath));
|
|
2903
3383
|
},
|
|
3384
|
+
/**
|
|
3385
|
+
* Delete a search instruction.
|
|
3386
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
3387
|
+
* @param {*} [options] Override http request option.
|
|
3388
|
+
* @throws {RequiredError}
|
|
3389
|
+
*/
|
|
3390
|
+
v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
3391
|
+
return localVarFp.v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
3392
|
+
},
|
|
3393
|
+
/**
|
|
3394
|
+
* Delete a survey instruction.
|
|
3395
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
3396
|
+
* @param {*} [options] Override http request option.
|
|
3397
|
+
* @throws {RequiredError}
|
|
3398
|
+
*/
|
|
3399
|
+
v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
3400
|
+
return localVarFp.v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
3401
|
+
},
|
|
2904
3402
|
/**
|
|
2905
3403
|
* Delete a webhook configuration.
|
|
2906
3404
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -2973,13 +3471,13 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2973
3471
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
2974
3472
|
},
|
|
2975
3473
|
/**
|
|
2976
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
3474
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
2977
3475
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
2978
3476
|
* @param {*} [options] Override http request option.
|
|
2979
3477
|
* @throws {RequiredError}
|
|
2980
3478
|
*/
|
|
2981
3479
|
v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
|
|
2982
|
-
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(axios, basePath));
|
|
3480
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
|
|
2983
3481
|
},
|
|
2984
3482
|
/**
|
|
2985
3483
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
@@ -2998,6 +3496,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2998
3496
|
v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>> {
|
|
2999
3497
|
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
|
|
3000
3498
|
},
|
|
3499
|
+
/**
|
|
3500
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
3501
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
3502
|
+
* @param {*} [options] Override http request option.
|
|
3503
|
+
* @throws {RequiredError}
|
|
3504
|
+
*/
|
|
3505
|
+
v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1SatelliteTarget> {
|
|
3506
|
+
return localVarFp.v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
3507
|
+
},
|
|
3001
3508
|
/**
|
|
3002
3509
|
* The available satellite objects that the OurSky platform can currently track.
|
|
3003
3510
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -3007,6 +3514,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
3007
3514
|
v1GetSatelliteTargets(requestParameters: DefaultApiV1GetSatelliteTargetsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargetsResponse> {
|
|
3008
3515
|
return localVarFp.v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(axios, basePath));
|
|
3009
3516
|
},
|
|
3517
|
+
/**
|
|
3518
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
3519
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
3520
|
+
* @param {*} [options] Override http request option.
|
|
3521
|
+
* @throws {RequiredError}
|
|
3522
|
+
*/
|
|
3523
|
+
v1GetSearchInstructions(requestParameters: DefaultApiV1GetSearchInstructionsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1SearchInstruction>> {
|
|
3524
|
+
return localVarFp.v1GetSearchInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
3525
|
+
},
|
|
3526
|
+
/**
|
|
3527
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
3528
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
3529
|
+
* @param {*} [options] Override http request option.
|
|
3530
|
+
* @throws {RequiredError}
|
|
3531
|
+
*/
|
|
3532
|
+
v1GetSurveyInstructions(requestParameters: DefaultApiV1GetSurveyInstructionsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1SurveyInstruction>> {
|
|
3533
|
+
return localVarFp.v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
3534
|
+
},
|
|
3010
3535
|
/**
|
|
3011
3536
|
* Get a TDM.
|
|
3012
3537
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
@@ -3111,17 +3636,31 @@ export interface DefaultApiV1CreateSatelliteTargetRequest {
|
|
|
3111
3636
|
}
|
|
3112
3637
|
|
|
3113
3638
|
/**
|
|
3114
|
-
* Request parameters for
|
|
3639
|
+
* Request parameters for v1CreateSearchInstruction operation in DefaultApi.
|
|
3115
3640
|
* @export
|
|
3116
|
-
* @interface
|
|
3641
|
+
* @interface DefaultApiV1CreateSearchInstructionRequest
|
|
3117
3642
|
*/
|
|
3118
|
-
export interface
|
|
3643
|
+
export interface DefaultApiV1CreateSearchInstructionRequest {
|
|
3119
3644
|
/**
|
|
3120
3645
|
*
|
|
3121
|
-
* @type {
|
|
3122
|
-
* @memberof
|
|
3646
|
+
* @type {V1CreateSearchInstructionRequest}
|
|
3647
|
+
* @memberof DefaultApiV1CreateSearchInstruction
|
|
3123
3648
|
*/
|
|
3124
|
-
readonly
|
|
3649
|
+
readonly v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest
|
|
3650
|
+
}
|
|
3651
|
+
|
|
3652
|
+
/**
|
|
3653
|
+
* Request parameters for v1CreateSurveyInstruction operation in DefaultApi.
|
|
3654
|
+
* @export
|
|
3655
|
+
* @interface DefaultApiV1CreateSurveyInstructionRequest
|
|
3656
|
+
*/
|
|
3657
|
+
export interface DefaultApiV1CreateSurveyInstructionRequest {
|
|
3658
|
+
/**
|
|
3659
|
+
*
|
|
3660
|
+
* @type {V1CreateSurveyInstructionRequest}
|
|
3661
|
+
* @memberof DefaultApiV1CreateSurveyInstruction
|
|
3662
|
+
*/
|
|
3663
|
+
readonly v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest
|
|
3125
3664
|
}
|
|
3126
3665
|
|
|
3127
3666
|
/**
|
|
@@ -3180,6 +3719,34 @@ export interface DefaultApiV1DeleteOrganizationTargetRequest {
|
|
|
3180
3719
|
readonly satelliteTargetId: string
|
|
3181
3720
|
}
|
|
3182
3721
|
|
|
3722
|
+
/**
|
|
3723
|
+
* Request parameters for v1DeleteSearchInstruction operation in DefaultApi.
|
|
3724
|
+
* @export
|
|
3725
|
+
* @interface DefaultApiV1DeleteSearchInstructionRequest
|
|
3726
|
+
*/
|
|
3727
|
+
export interface DefaultApiV1DeleteSearchInstructionRequest {
|
|
3728
|
+
/**
|
|
3729
|
+
*
|
|
3730
|
+
* @type {string}
|
|
3731
|
+
* @memberof DefaultApiV1DeleteSearchInstruction
|
|
3732
|
+
*/
|
|
3733
|
+
readonly id: string
|
|
3734
|
+
}
|
|
3735
|
+
|
|
3736
|
+
/**
|
|
3737
|
+
* Request parameters for v1DeleteSurveyInstruction operation in DefaultApi.
|
|
3738
|
+
* @export
|
|
3739
|
+
* @interface DefaultApiV1DeleteSurveyInstructionRequest
|
|
3740
|
+
*/
|
|
3741
|
+
export interface DefaultApiV1DeleteSurveyInstructionRequest {
|
|
3742
|
+
/**
|
|
3743
|
+
*
|
|
3744
|
+
* @type {string}
|
|
3745
|
+
* @memberof DefaultApiV1DeleteSurveyInstruction
|
|
3746
|
+
*/
|
|
3747
|
+
readonly id: string
|
|
3748
|
+
}
|
|
3749
|
+
|
|
3183
3750
|
/**
|
|
3184
3751
|
* Request parameters for v1DeleteWebhookConfiguration operation in DefaultApi.
|
|
3185
3752
|
* @export
|
|
@@ -3311,6 +3878,13 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
3311
3878
|
* @memberof DefaultApiV1GetObservationStatuses
|
|
3312
3879
|
*/
|
|
3313
3880
|
readonly searchInstructionId?: string
|
|
3881
|
+
|
|
3882
|
+
/**
|
|
3883
|
+
*
|
|
3884
|
+
* @type {string}
|
|
3885
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3886
|
+
*/
|
|
3887
|
+
readonly surveyInstructionId?: string
|
|
3314
3888
|
}
|
|
3315
3889
|
|
|
3316
3890
|
/**
|
|
@@ -3334,6 +3908,20 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
|
|
|
3334
3908
|
readonly until: string
|
|
3335
3909
|
}
|
|
3336
3910
|
|
|
3911
|
+
/**
|
|
3912
|
+
* Request parameters for v1GetSatelliteTarget operation in DefaultApi.
|
|
3913
|
+
* @export
|
|
3914
|
+
* @interface DefaultApiV1GetSatelliteTargetRequest
|
|
3915
|
+
*/
|
|
3916
|
+
export interface DefaultApiV1GetSatelliteTargetRequest {
|
|
3917
|
+
/**
|
|
3918
|
+
*
|
|
3919
|
+
* @type {string}
|
|
3920
|
+
* @memberof DefaultApiV1GetSatelliteTarget
|
|
3921
|
+
*/
|
|
3922
|
+
readonly id: string
|
|
3923
|
+
}
|
|
3924
|
+
|
|
3337
3925
|
/**
|
|
3338
3926
|
* Request parameters for v1GetSatelliteTargets operation in DefaultApi.
|
|
3339
3927
|
* @export
|
|
@@ -3355,6 +3943,34 @@ export interface DefaultApiV1GetSatelliteTargetsRequest {
|
|
|
3355
3943
|
readonly noradId?: string
|
|
3356
3944
|
}
|
|
3357
3945
|
|
|
3946
|
+
/**
|
|
3947
|
+
* Request parameters for v1GetSearchInstructions operation in DefaultApi.
|
|
3948
|
+
* @export
|
|
3949
|
+
* @interface DefaultApiV1GetSearchInstructionsRequest
|
|
3950
|
+
*/
|
|
3951
|
+
export interface DefaultApiV1GetSearchInstructionsRequest {
|
|
3952
|
+
/**
|
|
3953
|
+
* The timestamp to get the next page of results. Defaults to the current time.
|
|
3954
|
+
* @type {string}
|
|
3955
|
+
* @memberof DefaultApiV1GetSearchInstructions
|
|
3956
|
+
*/
|
|
3957
|
+
readonly before?: string
|
|
3958
|
+
}
|
|
3959
|
+
|
|
3960
|
+
/**
|
|
3961
|
+
* Request parameters for v1GetSurveyInstructions operation in DefaultApi.
|
|
3962
|
+
* @export
|
|
3963
|
+
* @interface DefaultApiV1GetSurveyInstructionsRequest
|
|
3964
|
+
*/
|
|
3965
|
+
export interface DefaultApiV1GetSurveyInstructionsRequest {
|
|
3966
|
+
/**
|
|
3967
|
+
* The timestamp to get the next page of results. Defaults to the current time.
|
|
3968
|
+
* @type {string}
|
|
3969
|
+
* @memberof DefaultApiV1GetSurveyInstructions
|
|
3970
|
+
*/
|
|
3971
|
+
readonly before?: string
|
|
3972
|
+
}
|
|
3973
|
+
|
|
3358
3974
|
/**
|
|
3359
3975
|
* Request parameters for v1GetTdm operation in DefaultApi.
|
|
3360
3976
|
* @export
|
|
@@ -3470,14 +4086,25 @@ export class DefaultApi extends BaseAPI {
|
|
|
3470
4086
|
}
|
|
3471
4087
|
|
|
3472
4088
|
/**
|
|
3473
|
-
*
|
|
3474
|
-
* @param {
|
|
4089
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
4090
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
4091
|
+
* @param {*} [options] Override http request option.
|
|
4092
|
+
* @throws {RequiredError}
|
|
4093
|
+
* @memberof DefaultApi
|
|
4094
|
+
*/
|
|
4095
|
+
public v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig) {
|
|
4096
|
+
return DefaultApiFp(this.configuration).v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4097
|
+
}
|
|
4098
|
+
|
|
4099
|
+
/**
|
|
4100
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
4101
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
3475
4102
|
* @param {*} [options] Override http request option.
|
|
3476
4103
|
* @throws {RequiredError}
|
|
3477
4104
|
* @memberof DefaultApi
|
|
3478
4105
|
*/
|
|
3479
|
-
public
|
|
3480
|
-
return DefaultApiFp(this.configuration).
|
|
4106
|
+
public v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) {
|
|
4107
|
+
return DefaultApiFp(this.configuration).v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3481
4108
|
}
|
|
3482
4109
|
|
|
3483
4110
|
/**
|
|
@@ -3524,6 +4151,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
3524
4151
|
return DefaultApiFp(this.configuration).v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
3525
4152
|
}
|
|
3526
4153
|
|
|
4154
|
+
/**
|
|
4155
|
+
* Delete a search instruction.
|
|
4156
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
4157
|
+
* @param {*} [options] Override http request option.
|
|
4158
|
+
* @throws {RequiredError}
|
|
4159
|
+
* @memberof DefaultApi
|
|
4160
|
+
*/
|
|
4161
|
+
public v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig) {
|
|
4162
|
+
return DefaultApiFp(this.configuration).v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
4163
|
+
}
|
|
4164
|
+
|
|
4165
|
+
/**
|
|
4166
|
+
* Delete a survey instruction.
|
|
4167
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
4168
|
+
* @param {*} [options] Override http request option.
|
|
4169
|
+
* @throws {RequiredError}
|
|
4170
|
+
* @memberof DefaultApi
|
|
4171
|
+
*/
|
|
4172
|
+
public v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig) {
|
|
4173
|
+
return DefaultApiFp(this.configuration).v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
4174
|
+
}
|
|
4175
|
+
|
|
3527
4176
|
/**
|
|
3528
4177
|
* Delete a webhook configuration.
|
|
3529
4178
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -3612,14 +4261,14 @@ export class DefaultApi extends BaseAPI {
|
|
|
3612
4261
|
}
|
|
3613
4262
|
|
|
3614
4263
|
/**
|
|
3615
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
4264
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
3616
4265
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3617
4266
|
* @param {*} [options] Override http request option.
|
|
3618
4267
|
* @throws {RequiredError}
|
|
3619
4268
|
* @memberof DefaultApi
|
|
3620
4269
|
*/
|
|
3621
4270
|
public v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig) {
|
|
3622
|
-
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
4271
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
3623
4272
|
}
|
|
3624
4273
|
|
|
3625
4274
|
/**
|
|
@@ -3643,6 +4292,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3643
4292
|
return DefaultApiFp(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
|
|
3644
4293
|
}
|
|
3645
4294
|
|
|
4295
|
+
/**
|
|
4296
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
4297
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
4298
|
+
* @param {*} [options] Override http request option.
|
|
4299
|
+
* @throws {RequiredError}
|
|
4300
|
+
* @memberof DefaultApi
|
|
4301
|
+
*/
|
|
4302
|
+
public v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig) {
|
|
4303
|
+
return DefaultApiFp(this.configuration).v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
4304
|
+
}
|
|
4305
|
+
|
|
3646
4306
|
/**
|
|
3647
4307
|
* The available satellite objects that the OurSky platform can currently track.
|
|
3648
4308
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -3654,6 +4314,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
3654
4314
|
return DefaultApiFp(this.configuration).v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(this.axios, this.basePath));
|
|
3655
4315
|
}
|
|
3656
4316
|
|
|
4317
|
+
/**
|
|
4318
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
4319
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
4320
|
+
* @param {*} [options] Override http request option.
|
|
4321
|
+
* @throws {RequiredError}
|
|
4322
|
+
* @memberof DefaultApi
|
|
4323
|
+
*/
|
|
4324
|
+
public v1GetSearchInstructions(requestParameters: DefaultApiV1GetSearchInstructionsRequest = {}, options?: AxiosRequestConfig) {
|
|
4325
|
+
return DefaultApiFp(this.configuration).v1GetSearchInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
4326
|
+
}
|
|
4327
|
+
|
|
4328
|
+
/**
|
|
4329
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
4330
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
4331
|
+
* @param {*} [options] Override http request option.
|
|
4332
|
+
* @throws {RequiredError}
|
|
4333
|
+
* @memberof DefaultApi
|
|
4334
|
+
*/
|
|
4335
|
+
public v1GetSurveyInstructions(requestParameters: DefaultApiV1GetSurveyInstructionsRequest = {}, options?: AxiosRequestConfig) {
|
|
4336
|
+
return DefaultApiFp(this.configuration).v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
4337
|
+
}
|
|
4338
|
+
|
|
3657
4339
|
/**
|
|
3658
4340
|
* Get a TDM.
|
|
3659
4341
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|