@ourskyai/sda-api 1.3.2765 → 1.3.3181
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 +1147 -186
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +744 -157
- package/dist/api.js +565 -20
- 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 +744 -157
- package/dist/esm/api.js +564 -19
- 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.3181
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -179,55 +179,6 @@ export interface ObservationBoundingBox {
|
|
|
179
179
|
*/
|
|
180
180
|
'endY': number;
|
|
181
181
|
}
|
|
182
|
-
/**
|
|
183
|
-
* Observation Feature
|
|
184
|
-
* @export
|
|
185
|
-
* @interface ObservationFeature
|
|
186
|
-
*/
|
|
187
|
-
export interface ObservationFeature {
|
|
188
|
-
/**
|
|
189
|
-
*
|
|
190
|
-
* @type {number}
|
|
191
|
-
* @memberof ObservationFeature
|
|
192
|
-
*/
|
|
193
|
-
'ra': number;
|
|
194
|
-
/**
|
|
195
|
-
*
|
|
196
|
-
* @type {number}
|
|
197
|
-
* @memberof ObservationFeature
|
|
198
|
-
*/
|
|
199
|
-
'dec': number;
|
|
200
|
-
/**
|
|
201
|
-
*
|
|
202
|
-
* @type {string}
|
|
203
|
-
* @memberof ObservationFeature
|
|
204
|
-
*/
|
|
205
|
-
'timestamp': string;
|
|
206
|
-
/**
|
|
207
|
-
*
|
|
208
|
-
* @type {ObservationBoundingBox}
|
|
209
|
-
* @memberof ObservationFeature
|
|
210
|
-
*/
|
|
211
|
-
'boundingBox'?: ObservationBoundingBox;
|
|
212
|
-
/**
|
|
213
|
-
* BETA: the apparent magnitude of the target at the time of the observation
|
|
214
|
-
* @type {number}
|
|
215
|
-
* @memberof ObservationFeature
|
|
216
|
-
*/
|
|
217
|
-
'apparentMagnitude'?: number;
|
|
218
|
-
/**
|
|
219
|
-
*
|
|
220
|
-
* @type {number}
|
|
221
|
-
* @memberof ObservationFeature
|
|
222
|
-
*/
|
|
223
|
-
'distanceFromPrediction'?: number;
|
|
224
|
-
/**
|
|
225
|
-
*
|
|
226
|
-
* @type {Array<TargetCorrelation>}
|
|
227
|
-
* @memberof ObservationFeature
|
|
228
|
-
*/
|
|
229
|
-
'targetCorrelations'?: Array<TargetCorrelation>;
|
|
230
|
-
}
|
|
231
182
|
/**
|
|
232
183
|
*
|
|
233
184
|
* @export
|
|
@@ -301,6 +252,18 @@ export interface ObservationResult {
|
|
|
301
252
|
* @memberof ObservationResult
|
|
302
253
|
*/
|
|
303
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;
|
|
304
267
|
/**
|
|
305
268
|
*
|
|
306
269
|
* @type {ObservationBoundingBox}
|
|
@@ -327,11 +290,27 @@ export interface ObservationResult {
|
|
|
327
290
|
'distanceFromPrediction'?: number;
|
|
328
291
|
/**
|
|
329
292
|
*
|
|
330
|
-
* @type {Array<
|
|
293
|
+
* @type {Array<V1ObservationFeature>}
|
|
331
294
|
* @memberof ObservationResult
|
|
332
295
|
*/
|
|
333
|
-
'features'?: Array<
|
|
296
|
+
'features'?: Array<V1ObservationFeature>;
|
|
334
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
|
+
|
|
335
314
|
/**
|
|
336
315
|
*
|
|
337
316
|
* @export
|
|
@@ -394,31 +373,6 @@ export interface SuccessfulCreate {
|
|
|
394
373
|
*/
|
|
395
374
|
'id': string;
|
|
396
375
|
}
|
|
397
|
-
/**
|
|
398
|
-
* Target Correlation
|
|
399
|
-
* @export
|
|
400
|
-
* @interface TargetCorrelation
|
|
401
|
-
*/
|
|
402
|
-
export interface TargetCorrelation {
|
|
403
|
-
/**
|
|
404
|
-
*
|
|
405
|
-
* @type {string}
|
|
406
|
-
* @memberof TargetCorrelation
|
|
407
|
-
*/
|
|
408
|
-
'targetId': string;
|
|
409
|
-
/**
|
|
410
|
-
*
|
|
411
|
-
* @type {number}
|
|
412
|
-
* @memberof TargetCorrelation
|
|
413
|
-
*/
|
|
414
|
-
'ra': number;
|
|
415
|
-
/**
|
|
416
|
-
*
|
|
417
|
-
* @type {number}
|
|
418
|
-
* @memberof TargetCorrelation
|
|
419
|
-
*/
|
|
420
|
-
'dec': number;
|
|
421
|
-
}
|
|
422
376
|
/**
|
|
423
377
|
*
|
|
424
378
|
* @export
|
|
@@ -545,78 +499,48 @@ export interface V1CreateSatelliteTargetRequest {
|
|
|
545
499
|
/**
|
|
546
500
|
*
|
|
547
501
|
* @export
|
|
548
|
-
* @interface
|
|
502
|
+
* @interface V1CreateSearchInstructionRequest
|
|
549
503
|
*/
|
|
550
|
-
export interface
|
|
551
|
-
/**
|
|
552
|
-
*
|
|
553
|
-
* @type {string}
|
|
554
|
-
* @memberof V1CreateSearchTaskRequest
|
|
555
|
-
*/
|
|
556
|
-
'nodeId': string;
|
|
504
|
+
export interface V1CreateSearchInstructionRequest {
|
|
557
505
|
/**
|
|
558
506
|
*
|
|
559
507
|
* @type {string}
|
|
560
|
-
* @memberof
|
|
508
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
561
509
|
*/
|
|
562
510
|
'targetId': string;
|
|
563
511
|
/**
|
|
564
512
|
*
|
|
565
513
|
* @type {TrackingType}
|
|
566
|
-
* @memberof
|
|
514
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
567
515
|
*/
|
|
568
|
-
'trackingType'
|
|
516
|
+
'trackingType': TrackingType;
|
|
569
517
|
/**
|
|
570
518
|
*
|
|
571
|
-
* @type {Array<
|
|
572
|
-
* @memberof
|
|
519
|
+
* @type {Array<V1SearchInstructionStep>}
|
|
520
|
+
* @memberof V1CreateSearchInstructionRequest
|
|
573
521
|
*/
|
|
574
|
-
'steps': Array<
|
|
522
|
+
'steps': Array<V1SearchInstructionStep>;
|
|
575
523
|
}
|
|
576
524
|
|
|
577
525
|
|
|
578
526
|
/**
|
|
579
|
-
*
|
|
527
|
+
*
|
|
580
528
|
* @export
|
|
581
|
-
* @interface
|
|
529
|
+
* @interface V1CreateSurveyInstructionRequest
|
|
582
530
|
*/
|
|
583
|
-
export interface
|
|
584
|
-
/**
|
|
585
|
-
* Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
586
|
-
* @type {number}
|
|
587
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
588
|
-
*/
|
|
589
|
-
'ra'?: number;
|
|
590
|
-
/**
|
|
591
|
-
* Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
592
|
-
* @type {number}
|
|
593
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
594
|
-
*/
|
|
595
|
-
'dec'?: number;
|
|
596
|
-
/**
|
|
597
|
-
* Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
598
|
-
* @type {number}
|
|
599
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
600
|
-
*/
|
|
601
|
-
'raOffset'?: number;
|
|
602
|
-
/**
|
|
603
|
-
* Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
604
|
-
* @type {number}
|
|
605
|
-
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
606
|
-
*/
|
|
607
|
-
'decOffset'?: number;
|
|
531
|
+
export interface V1CreateSurveyInstructionRequest {
|
|
608
532
|
/**
|
|
609
533
|
*
|
|
610
534
|
* @type {string}
|
|
611
|
-
* @memberof
|
|
535
|
+
* @memberof V1CreateSurveyInstructionRequest
|
|
612
536
|
*/
|
|
613
|
-
'
|
|
537
|
+
'targetId': string;
|
|
614
538
|
/**
|
|
615
539
|
*
|
|
616
|
-
* @type {
|
|
617
|
-
* @memberof
|
|
540
|
+
* @type {Array<V1SurveyInstructionStep>}
|
|
541
|
+
* @memberof V1CreateSurveyInstructionRequest
|
|
618
542
|
*/
|
|
619
|
-
'
|
|
543
|
+
'steps': Array<V1SurveyInstructionStep>;
|
|
620
544
|
}
|
|
621
545
|
/**
|
|
622
546
|
*
|
|
@@ -938,6 +862,55 @@ export interface V1ImageSetImage {
|
|
|
938
862
|
*/
|
|
939
863
|
'exposureLength': number;
|
|
940
864
|
}
|
|
865
|
+
/**
|
|
866
|
+
* Observation Feature
|
|
867
|
+
* @export
|
|
868
|
+
* @interface V1ObservationFeature
|
|
869
|
+
*/
|
|
870
|
+
export interface V1ObservationFeature {
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {number}
|
|
874
|
+
* @memberof V1ObservationFeature
|
|
875
|
+
*/
|
|
876
|
+
'ra': number;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {number}
|
|
880
|
+
* @memberof V1ObservationFeature
|
|
881
|
+
*/
|
|
882
|
+
'dec': number;
|
|
883
|
+
/**
|
|
884
|
+
*
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof V1ObservationFeature
|
|
887
|
+
*/
|
|
888
|
+
'timestamp': string;
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @type {ObservationBoundingBox}
|
|
892
|
+
* @memberof V1ObservationFeature
|
|
893
|
+
*/
|
|
894
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
895
|
+
/**
|
|
896
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
897
|
+
* @type {number}
|
|
898
|
+
* @memberof V1ObservationFeature
|
|
899
|
+
*/
|
|
900
|
+
'apparentMagnitude'?: number;
|
|
901
|
+
/**
|
|
902
|
+
*
|
|
903
|
+
* @type {number}
|
|
904
|
+
* @memberof V1ObservationFeature
|
|
905
|
+
*/
|
|
906
|
+
'distanceFromPrediction'?: number;
|
|
907
|
+
/**
|
|
908
|
+
*
|
|
909
|
+
* @type {Array<V1TargetCorrelation>}
|
|
910
|
+
* @memberof V1ObservationFeature
|
|
911
|
+
*/
|
|
912
|
+
'targetCorrelations'?: Array<V1TargetCorrelation>;
|
|
913
|
+
}
|
|
941
914
|
/**
|
|
942
915
|
* Observation Sequence Result
|
|
943
916
|
* @export
|
|
@@ -1018,6 +991,105 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
1018
991
|
*/
|
|
1019
992
|
'observationQuality'?: ObservationQuality;
|
|
1020
993
|
}
|
|
994
|
+
/**
|
|
995
|
+
*
|
|
996
|
+
* @export
|
|
997
|
+
* @interface V1ObservationStatus
|
|
998
|
+
*/
|
|
999
|
+
export interface V1ObservationStatus {
|
|
1000
|
+
/**
|
|
1001
|
+
*
|
|
1002
|
+
* @type {string}
|
|
1003
|
+
* @memberof V1ObservationStatus
|
|
1004
|
+
*/
|
|
1005
|
+
'id': string;
|
|
1006
|
+
/**
|
|
1007
|
+
*
|
|
1008
|
+
* @type {string}
|
|
1009
|
+
* @memberof V1ObservationStatus
|
|
1010
|
+
*/
|
|
1011
|
+
'targetId': string;
|
|
1012
|
+
/**
|
|
1013
|
+
*
|
|
1014
|
+
* @type {TrackingType}
|
|
1015
|
+
* @memberof V1ObservationStatus
|
|
1016
|
+
*/
|
|
1017
|
+
'trackingType'?: TrackingType;
|
|
1018
|
+
/**
|
|
1019
|
+
*
|
|
1020
|
+
* @type {number}
|
|
1021
|
+
* @memberof V1ObservationStatus
|
|
1022
|
+
*/
|
|
1023
|
+
'ra': number;
|
|
1024
|
+
/**
|
|
1025
|
+
*
|
|
1026
|
+
* @type {number}
|
|
1027
|
+
* @memberof V1ObservationStatus
|
|
1028
|
+
*/
|
|
1029
|
+
'dec': number;
|
|
1030
|
+
/**
|
|
1031
|
+
*
|
|
1032
|
+
* @type {string}
|
|
1033
|
+
* @memberof V1ObservationStatus
|
|
1034
|
+
*/
|
|
1035
|
+
'observationTime': string;
|
|
1036
|
+
/**
|
|
1037
|
+
* TLE line 1 of when the observation was tasked
|
|
1038
|
+
* @type {string}
|
|
1039
|
+
* @memberof V1ObservationStatus
|
|
1040
|
+
*/
|
|
1041
|
+
'tleLine1': string;
|
|
1042
|
+
/**
|
|
1043
|
+
* TLE line 2 of when the observation was tasked
|
|
1044
|
+
* @type {string}
|
|
1045
|
+
* @memberof V1ObservationStatus
|
|
1046
|
+
*/
|
|
1047
|
+
'tleLine2': string;
|
|
1048
|
+
/**
|
|
1049
|
+
*
|
|
1050
|
+
* @type {string}
|
|
1051
|
+
* @memberof V1ObservationStatus
|
|
1052
|
+
*/
|
|
1053
|
+
'tleEpoch': string;
|
|
1054
|
+
/**
|
|
1055
|
+
*
|
|
1056
|
+
* @type {string}
|
|
1057
|
+
* @memberof V1ObservationStatus
|
|
1058
|
+
*/
|
|
1059
|
+
'imageSetId'?: string;
|
|
1060
|
+
/**
|
|
1061
|
+
*
|
|
1062
|
+
* @type {string}
|
|
1063
|
+
* @memberof V1ObservationStatus
|
|
1064
|
+
*/
|
|
1065
|
+
'observationSequenceResultId'?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
*
|
|
1068
|
+
* @type {string}
|
|
1069
|
+
* @memberof V1ObservationStatus
|
|
1070
|
+
*/
|
|
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;
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
|
|
1021
1093
|
/**
|
|
1022
1094
|
*
|
|
1023
1095
|
* @export
|
|
@@ -1146,59 +1218,222 @@ export interface V1SatelliteTarget {
|
|
|
1146
1218
|
|
|
1147
1219
|
|
|
1148
1220
|
/**
|
|
1149
|
-
*
|
|
1221
|
+
* Search Instruction
|
|
1150
1222
|
* @export
|
|
1151
|
-
* @interface
|
|
1223
|
+
* @interface V1SearchInstruction
|
|
1152
1224
|
*/
|
|
1153
|
-
export interface
|
|
1225
|
+
export interface V1SearchInstruction {
|
|
1154
1226
|
/**
|
|
1155
1227
|
*
|
|
1156
1228
|
* @type {string}
|
|
1157
|
-
* @memberof
|
|
1229
|
+
* @memberof V1SearchInstruction
|
|
1158
1230
|
*/
|
|
1159
1231
|
'id': string;
|
|
1160
1232
|
/**
|
|
1161
1233
|
*
|
|
1162
1234
|
* @type {string}
|
|
1163
|
-
* @memberof
|
|
1235
|
+
* @memberof V1SearchInstruction
|
|
1164
1236
|
*/
|
|
1165
|
-
'
|
|
1237
|
+
'nodeId'?: string;
|
|
1166
1238
|
/**
|
|
1167
1239
|
*
|
|
1168
|
-
* @type {
|
|
1169
|
-
* @memberof
|
|
1240
|
+
* @type {string}
|
|
1241
|
+
* @memberof V1SearchInstruction
|
|
1170
1242
|
*/
|
|
1171
|
-
'
|
|
1243
|
+
'targetId': string;
|
|
1172
1244
|
/**
|
|
1173
1245
|
*
|
|
1174
|
-
* @type {
|
|
1175
|
-
* @memberof
|
|
1246
|
+
* @type {TrackingType}
|
|
1247
|
+
* @memberof V1SearchInstruction
|
|
1176
1248
|
*/
|
|
1177
|
-
'
|
|
1249
|
+
'trackingType': TrackingType;
|
|
1178
1250
|
/**
|
|
1179
|
-
*
|
|
1180
|
-
* @type {
|
|
1181
|
-
* @memberof
|
|
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
|
|
1182
1254
|
*/
|
|
1183
|
-
'
|
|
1255
|
+
'steps': Array<V1SearchInstructionStep>;
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Search Instruction Step
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface V1SearchInstructionStep
|
|
1263
|
+
*/
|
|
1264
|
+
export interface V1SearchInstructionStep {
|
|
1184
1265
|
/**
|
|
1185
|
-
*
|
|
1186
|
-
* @type {
|
|
1187
|
-
* @memberof
|
|
1266
|
+
* Along-track offset in the local spacecraft frame.
|
|
1267
|
+
* @type {number}
|
|
1268
|
+
* @memberof V1SearchInstructionStep
|
|
1188
1269
|
*/
|
|
1189
|
-
'
|
|
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;
|
|
1190
1283
|
/**
|
|
1191
1284
|
*
|
|
1192
1285
|
* @type {string}
|
|
1193
|
-
* @memberof
|
|
1286
|
+
* @memberof V1SearchInstructionStep
|
|
1194
1287
|
*/
|
|
1195
|
-
'
|
|
1288
|
+
'startTime': string;
|
|
1196
1289
|
/**
|
|
1197
1290
|
*
|
|
1198
1291
|
* @type {string}
|
|
1199
|
-
* @memberof
|
|
1292
|
+
* @memberof V1SearchInstructionStep
|
|
1200
1293
|
*/
|
|
1201
|
-
'
|
|
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
|
+
}
|
|
1358
|
+
/**
|
|
1359
|
+
* Target Correlation
|
|
1360
|
+
* @export
|
|
1361
|
+
* @interface V1TargetCorrelation
|
|
1362
|
+
*/
|
|
1363
|
+
export interface V1TargetCorrelation {
|
|
1364
|
+
/**
|
|
1365
|
+
*
|
|
1366
|
+
* @type {string}
|
|
1367
|
+
* @memberof V1TargetCorrelation
|
|
1368
|
+
*/
|
|
1369
|
+
'targetId': string;
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @type {number}
|
|
1373
|
+
* @memberof V1TargetCorrelation
|
|
1374
|
+
*/
|
|
1375
|
+
'ra': number;
|
|
1376
|
+
/**
|
|
1377
|
+
*
|
|
1378
|
+
* @type {number}
|
|
1379
|
+
* @memberof V1TargetCorrelation
|
|
1380
|
+
*/
|
|
1381
|
+
'dec': number;
|
|
1382
|
+
}
|
|
1383
|
+
/**
|
|
1384
|
+
* TDM
|
|
1385
|
+
* @export
|
|
1386
|
+
* @interface V1Tdm
|
|
1387
|
+
*/
|
|
1388
|
+
export interface V1Tdm {
|
|
1389
|
+
/**
|
|
1390
|
+
*
|
|
1391
|
+
* @type {string}
|
|
1392
|
+
* @memberof V1Tdm
|
|
1393
|
+
*/
|
|
1394
|
+
'id': string;
|
|
1395
|
+
/**
|
|
1396
|
+
*
|
|
1397
|
+
* @type {string}
|
|
1398
|
+
* @memberof V1Tdm
|
|
1399
|
+
*/
|
|
1400
|
+
'targetId': string;
|
|
1401
|
+
/**
|
|
1402
|
+
*
|
|
1403
|
+
* @type {Array<string>}
|
|
1404
|
+
* @memberof V1Tdm
|
|
1405
|
+
*/
|
|
1406
|
+
'streaks': Array<string>;
|
|
1407
|
+
/**
|
|
1408
|
+
*
|
|
1409
|
+
* @type {string}
|
|
1410
|
+
* @memberof V1Tdm
|
|
1411
|
+
*/
|
|
1412
|
+
'assetUrl': string;
|
|
1413
|
+
/**
|
|
1414
|
+
*
|
|
1415
|
+
* @type {string}
|
|
1416
|
+
* @memberof V1Tdm
|
|
1417
|
+
*/
|
|
1418
|
+
'imageSetId': string;
|
|
1419
|
+
/**
|
|
1420
|
+
*
|
|
1421
|
+
* @type {Array<string>}
|
|
1422
|
+
* @memberof V1Tdm
|
|
1423
|
+
*/
|
|
1424
|
+
'imageUrls': Array<string>;
|
|
1425
|
+
/**
|
|
1426
|
+
*
|
|
1427
|
+
* @type {string}
|
|
1428
|
+
* @memberof V1Tdm
|
|
1429
|
+
*/
|
|
1430
|
+
'createdAt': string;
|
|
1431
|
+
/**
|
|
1432
|
+
*
|
|
1433
|
+
* @type {string}
|
|
1434
|
+
* @memberof V1Tdm
|
|
1435
|
+
*/
|
|
1436
|
+
'createdBy': string;
|
|
1202
1437
|
}
|
|
1203
1438
|
/**
|
|
1204
1439
|
*
|
|
@@ -1526,14 +1761,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1526
1761
|
};
|
|
1527
1762
|
},
|
|
1528
1763
|
/**
|
|
1529
|
-
*
|
|
1530
|
-
* @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
|
|
1531
1766
|
* @param {*} [options] Override http request option.
|
|
1532
1767
|
* @throws {RequiredError}
|
|
1533
1768
|
*/
|
|
1534
|
-
|
|
1535
|
-
// verify required parameter '
|
|
1536
|
-
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)
|
|
1537
1772
|
const localVarPath = `/v1/search-instruction`;
|
|
1538
1773
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1539
1774
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1559,7 +1794,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1559
1794
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1560
1795
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1561
1796
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1562
|
-
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)
|
|
1563
1839
|
|
|
1564
1840
|
return {
|
|
1565
1841
|
url: toPathString(localVarUrlObj),
|
|
@@ -1724,6 +2000,90 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1724
2000
|
|
|
1725
2001
|
|
|
1726
2002
|
|
|
2003
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2004
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2005
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2006
|
+
|
|
2007
|
+
return {
|
|
2008
|
+
url: toPathString(localVarUrlObj),
|
|
2009
|
+
options: localVarRequestOptions,
|
|
2010
|
+
};
|
|
2011
|
+
},
|
|
2012
|
+
/**
|
|
2013
|
+
* Delete a search instruction.
|
|
2014
|
+
* @param {string} id
|
|
2015
|
+
* @param {*} [options] Override http request option.
|
|
2016
|
+
* @throws {RequiredError}
|
|
2017
|
+
*/
|
|
2018
|
+
v1DeleteSearchInstruction: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2019
|
+
// verify required parameter 'id' is not null or undefined
|
|
2020
|
+
assertParamExists('v1DeleteSearchInstruction', 'id', id)
|
|
2021
|
+
const localVarPath = `/v1/search-instruction`;
|
|
2022
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2023
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2024
|
+
let baseOptions;
|
|
2025
|
+
if (configuration) {
|
|
2026
|
+
baseOptions = configuration.baseOptions;
|
|
2027
|
+
}
|
|
2028
|
+
|
|
2029
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
2030
|
+
const localVarHeaderParameter = {} as any;
|
|
2031
|
+
const localVarQueryParameter = {} as any;
|
|
2032
|
+
|
|
2033
|
+
// authentication Roles required
|
|
2034
|
+
|
|
2035
|
+
// authentication BearerToken required
|
|
2036
|
+
// http bearer authentication required
|
|
2037
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2038
|
+
|
|
2039
|
+
if (id !== undefined) {
|
|
2040
|
+
localVarQueryParameter['id'] = id;
|
|
2041
|
+
}
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2046
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2047
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2048
|
+
|
|
2049
|
+
return {
|
|
2050
|
+
url: toPathString(localVarUrlObj),
|
|
2051
|
+
options: localVarRequestOptions,
|
|
2052
|
+
};
|
|
2053
|
+
},
|
|
2054
|
+
/**
|
|
2055
|
+
* Delete a survey instruction.
|
|
2056
|
+
* @param {string} id
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
*/
|
|
2060
|
+
v1DeleteSurveyInstruction: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2061
|
+
// verify required parameter 'id' is not null or undefined
|
|
2062
|
+
assertParamExists('v1DeleteSurveyInstruction', 'id', id)
|
|
2063
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
2064
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2065
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2066
|
+
let baseOptions;
|
|
2067
|
+
if (configuration) {
|
|
2068
|
+
baseOptions = configuration.baseOptions;
|
|
2069
|
+
}
|
|
2070
|
+
|
|
2071
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
2072
|
+
const localVarHeaderParameter = {} as any;
|
|
2073
|
+
const localVarQueryParameter = {} as any;
|
|
2074
|
+
|
|
2075
|
+
// authentication Roles required
|
|
2076
|
+
|
|
2077
|
+
// authentication BearerToken required
|
|
2078
|
+
// http bearer authentication required
|
|
2079
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2080
|
+
|
|
2081
|
+
if (id !== undefined) {
|
|
2082
|
+
localVarQueryParameter['id'] = id;
|
|
2083
|
+
}
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
1727
2087
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1728
2088
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1729
2089
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -1969,6 +2329,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1969
2329
|
|
|
1970
2330
|
|
|
1971
2331
|
|
|
2332
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2333
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2334
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2335
|
+
|
|
2336
|
+
return {
|
|
2337
|
+
url: toPathString(localVarUrlObj),
|
|
2338
|
+
options: localVarRequestOptions,
|
|
2339
|
+
};
|
|
2340
|
+
},
|
|
2341
|
+
/**
|
|
2342
|
+
* Get observation features.
|
|
2343
|
+
* @param {string} imageId
|
|
2344
|
+
* @param {*} [options] Override http request option.
|
|
2345
|
+
* @throws {RequiredError}
|
|
2346
|
+
*/
|
|
2347
|
+
v1GetObservationFeatures: async (imageId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2348
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
2349
|
+
assertParamExists('v1GetObservationFeatures', 'imageId', imageId)
|
|
2350
|
+
const localVarPath = `/v1/observation-features`;
|
|
2351
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2352
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2353
|
+
let baseOptions;
|
|
2354
|
+
if (configuration) {
|
|
2355
|
+
baseOptions = configuration.baseOptions;
|
|
2356
|
+
}
|
|
2357
|
+
|
|
2358
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2359
|
+
const localVarHeaderParameter = {} as any;
|
|
2360
|
+
const localVarQueryParameter = {} as any;
|
|
2361
|
+
|
|
2362
|
+
// authentication Roles required
|
|
2363
|
+
|
|
2364
|
+
// authentication BearerToken required
|
|
2365
|
+
// http bearer authentication required
|
|
2366
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2367
|
+
|
|
2368
|
+
if (imageId !== undefined) {
|
|
2369
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
2370
|
+
}
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
|
|
1972
2374
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1973
2375
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1974
2376
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2016,6 +2418,63 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2016
2418
|
|
|
2017
2419
|
|
|
2018
2420
|
|
|
2421
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2422
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2423
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2424
|
+
|
|
2425
|
+
return {
|
|
2426
|
+
url: toPathString(localVarUrlObj),
|
|
2427
|
+
options: localVarRequestOptions,
|
|
2428
|
+
};
|
|
2429
|
+
},
|
|
2430
|
+
/**
|
|
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.
|
|
2432
|
+
* @param {string} [targetId]
|
|
2433
|
+
* @param {string} [before]
|
|
2434
|
+
* @param {string} [searchInstructionId]
|
|
2435
|
+
* @param {string} [surveyInstructionId]
|
|
2436
|
+
* @param {*} [options] Override http request option.
|
|
2437
|
+
* @throws {RequiredError}
|
|
2438
|
+
*/
|
|
2439
|
+
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2440
|
+
const localVarPath = `/v1/observation-statuses`;
|
|
2441
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2442
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2443
|
+
let baseOptions;
|
|
2444
|
+
if (configuration) {
|
|
2445
|
+
baseOptions = configuration.baseOptions;
|
|
2446
|
+
}
|
|
2447
|
+
|
|
2448
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2449
|
+
const localVarHeaderParameter = {} as any;
|
|
2450
|
+
const localVarQueryParameter = {} as any;
|
|
2451
|
+
|
|
2452
|
+
// authentication Roles required
|
|
2453
|
+
|
|
2454
|
+
// authentication BearerToken required
|
|
2455
|
+
// http bearer authentication required
|
|
2456
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2457
|
+
|
|
2458
|
+
if (targetId !== undefined) {
|
|
2459
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
2460
|
+
}
|
|
2461
|
+
|
|
2462
|
+
if (before !== undefined) {
|
|
2463
|
+
localVarQueryParameter['before'] = (before as any instanceof Date) ?
|
|
2464
|
+
(before as any).toISOString() :
|
|
2465
|
+
before;
|
|
2466
|
+
}
|
|
2467
|
+
|
|
2468
|
+
if (searchInstructionId !== undefined) {
|
|
2469
|
+
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
2470
|
+
}
|
|
2471
|
+
|
|
2472
|
+
if (surveyInstructionId !== undefined) {
|
|
2473
|
+
localVarQueryParameter['surveyInstructionId'] = surveyInstructionId;
|
|
2474
|
+
}
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2019
2478
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2020
2479
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2021
2480
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2094,10 +2553,139 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2094
2553
|
localVarQueryParameter['satelliteTargetId'] = satelliteTargetId;
|
|
2095
2554
|
}
|
|
2096
2555
|
|
|
2097
|
-
if (until !== undefined) {
|
|
2098
|
-
localVarQueryParameter['until'] = (until as any instanceof Date) ?
|
|
2099
|
-
(until as any).toISOString() :
|
|
2100
|
-
until;
|
|
2556
|
+
if (until !== undefined) {
|
|
2557
|
+
localVarQueryParameter['until'] = (until as any instanceof Date) ?
|
|
2558
|
+
(until as any).toISOString() :
|
|
2559
|
+
until;
|
|
2560
|
+
}
|
|
2561
|
+
|
|
2562
|
+
|
|
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
|
+
|
|
2606
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2607
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2608
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2609
|
+
|
|
2610
|
+
return {
|
|
2611
|
+
url: toPathString(localVarUrlObj),
|
|
2612
|
+
options: localVarRequestOptions,
|
|
2613
|
+
};
|
|
2614
|
+
},
|
|
2615
|
+
/**
|
|
2616
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
2617
|
+
* @param {OrbitType} [orbitType]
|
|
2618
|
+
* @param {string} [noradId]
|
|
2619
|
+
* @param {*} [options] Override http request option.
|
|
2620
|
+
* @throws {RequiredError}
|
|
2621
|
+
*/
|
|
2622
|
+
v1GetSatelliteTargets: async (orbitType?: OrbitType, noradId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2623
|
+
const localVarPath = `/v1/satellite-targets`;
|
|
2624
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2625
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2626
|
+
let baseOptions;
|
|
2627
|
+
if (configuration) {
|
|
2628
|
+
baseOptions = configuration.baseOptions;
|
|
2629
|
+
}
|
|
2630
|
+
|
|
2631
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2632
|
+
const localVarHeaderParameter = {} as any;
|
|
2633
|
+
const localVarQueryParameter = {} as any;
|
|
2634
|
+
|
|
2635
|
+
// authentication Roles required
|
|
2636
|
+
|
|
2637
|
+
// authentication BearerToken required
|
|
2638
|
+
// http bearer authentication required
|
|
2639
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2640
|
+
|
|
2641
|
+
if (orbitType !== undefined) {
|
|
2642
|
+
localVarQueryParameter['orbitType'] = orbitType;
|
|
2643
|
+
}
|
|
2644
|
+
|
|
2645
|
+
if (noradId !== undefined) {
|
|
2646
|
+
localVarQueryParameter['noradId'] = noradId;
|
|
2647
|
+
}
|
|
2648
|
+
|
|
2649
|
+
|
|
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;
|
|
2101
2689
|
}
|
|
2102
2690
|
|
|
2103
2691
|
|
|
@@ -2112,14 +2700,13 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2112
2700
|
};
|
|
2113
2701
|
},
|
|
2114
2702
|
/**
|
|
2115
|
-
*
|
|
2116
|
-
* @param {
|
|
2117
|
-
* @param {string} [noradId]
|
|
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.
|
|
2118
2705
|
* @param {*} [options] Override http request option.
|
|
2119
2706
|
* @throws {RequiredError}
|
|
2120
2707
|
*/
|
|
2121
|
-
|
|
2122
|
-
const localVarPath = `/v1/
|
|
2708
|
+
v1GetSurveyInstructions: async (before?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2709
|
+
const localVarPath = `/v1/survey-instructions`;
|
|
2123
2710
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2124
2711
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2125
2712
|
let baseOptions;
|
|
@@ -2137,12 +2724,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2137
2724
|
// http bearer authentication required
|
|
2138
2725
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2139
2726
|
|
|
2140
|
-
if (
|
|
2141
|
-
localVarQueryParameter['
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
if (noradId !== undefined) {
|
|
2145
|
-
localVarQueryParameter['noradId'] = noradId;
|
|
2727
|
+
if (before !== undefined) {
|
|
2728
|
+
localVarQueryParameter['before'] = (before as any instanceof Date) ?
|
|
2729
|
+
(before as any).toISOString() :
|
|
2730
|
+
before;
|
|
2146
2731
|
}
|
|
2147
2732
|
|
|
2148
2733
|
|
|
@@ -2413,13 +2998,23 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2413
2998
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2414
2999
|
},
|
|
2415
3000
|
/**
|
|
2416
|
-
*
|
|
2417
|
-
* @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
|
|
2418
3013
|
* @param {*} [options] Override http request option.
|
|
2419
3014
|
* @throws {RequiredError}
|
|
2420
3015
|
*/
|
|
2421
|
-
async
|
|
2422
|
-
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);
|
|
2423
3018
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2424
3019
|
},
|
|
2425
3020
|
/**
|
|
@@ -2462,6 +3057,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2462
3057
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteOrganizationTarget(satelliteTargetId, options);
|
|
2463
3058
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2464
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
|
+
},
|
|
2465
3080
|
/**
|
|
2466
3081
|
* Delete a webhook configuration.
|
|
2467
3082
|
* @param {string} id
|
|
@@ -2521,6 +3136,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2521
3136
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNodeProperties(nodeId, options);
|
|
2522
3137
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2523
3138
|
},
|
|
3139
|
+
/**
|
|
3140
|
+
* Get observation features.
|
|
3141
|
+
* @param {string} imageId
|
|
3142
|
+
* @param {*} [options] Override http request option.
|
|
3143
|
+
* @throws {RequiredError}
|
|
3144
|
+
*/
|
|
3145
|
+
async v1GetObservationFeatures(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationFeature>>> {
|
|
3146
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationFeatures(imageId, options);
|
|
3147
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3148
|
+
},
|
|
2524
3149
|
/**
|
|
2525
3150
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
2526
3151
|
* @param {string} [targetId]
|
|
@@ -2532,6 +3157,19 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2532
3157
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationSequenceResults(targetId, after, options);
|
|
2533
3158
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2534
3159
|
},
|
|
3160
|
+
/**
|
|
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.
|
|
3162
|
+
* @param {string} [targetId]
|
|
3163
|
+
* @param {string} [before]
|
|
3164
|
+
* @param {string} [searchInstructionId]
|
|
3165
|
+
* @param {string} [surveyInstructionId]
|
|
3166
|
+
* @param {*} [options] Override http request option.
|
|
3167
|
+
* @throws {RequiredError}
|
|
3168
|
+
*/
|
|
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);
|
|
3171
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3172
|
+
},
|
|
2535
3173
|
/**
|
|
2536
3174
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2537
3175
|
* @param {*} [options] Override http request option.
|
|
@@ -2552,6 +3190,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2552
3190
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, options);
|
|
2553
3191
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2554
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
|
+
},
|
|
2555
3203
|
/**
|
|
2556
3204
|
* The available satellite objects that the OurSky platform can currently track.
|
|
2557
3205
|
* @param {OrbitType} [orbitType]
|
|
@@ -2563,6 +3211,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2563
3211
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetSatelliteTargets(orbitType, noradId, options);
|
|
2564
3212
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2565
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
|
+
},
|
|
2566
3234
|
/**
|
|
2567
3235
|
* Get a TDM.
|
|
2568
3236
|
* @param {string} tdmId
|
|
@@ -2660,13 +3328,22 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2660
3328
|
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
2661
3329
|
},
|
|
2662
3330
|
/**
|
|
2663
|
-
*
|
|
2664
|
-
* @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.
|
|
2665
3342
|
* @param {*} [options] Override http request option.
|
|
2666
3343
|
* @throws {RequiredError}
|
|
2667
3344
|
*/
|
|
2668
|
-
|
|
2669
|
-
return localVarFp.
|
|
3345
|
+
v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
3346
|
+
return localVarFp.v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(axios, basePath));
|
|
2670
3347
|
},
|
|
2671
3348
|
/**
|
|
2672
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.
|
|
@@ -2704,6 +3381,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2704
3381
|
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2705
3382
|
return localVarFp.v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(axios, basePath));
|
|
2706
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
|
+
},
|
|
2707
3402
|
/**
|
|
2708
3403
|
* Delete a webhook configuration.
|
|
2709
3404
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -2757,6 +3452,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2757
3452
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant> {
|
|
2758
3453
|
return localVarFp.v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(axios, basePath));
|
|
2759
3454
|
},
|
|
3455
|
+
/**
|
|
3456
|
+
* Get observation features.
|
|
3457
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
3458
|
+
* @param {*} [options] Override http request option.
|
|
3459
|
+
* @throws {RequiredError}
|
|
3460
|
+
*/
|
|
3461
|
+
v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationFeature>> {
|
|
3462
|
+
return localVarFp.v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
3463
|
+
},
|
|
2760
3464
|
/**
|
|
2761
3465
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
2762
3466
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -2766,6 +3470,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2766
3470
|
v1GetObservationSequenceResults(requestParameters: DefaultApiV1GetObservationSequenceResultsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>> {
|
|
2767
3471
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
2768
3472
|
},
|
|
3473
|
+
/**
|
|
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.
|
|
3475
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3476
|
+
* @param {*} [options] Override http request option.
|
|
3477
|
+
* @throws {RequiredError}
|
|
3478
|
+
*/
|
|
3479
|
+
v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
|
|
3480
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
|
|
3481
|
+
},
|
|
2769
3482
|
/**
|
|
2770
3483
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2771
3484
|
* @param {*} [options] Override http request option.
|
|
@@ -2783,6 +3496,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2783
3496
|
v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>> {
|
|
2784
3497
|
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
|
|
2785
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
|
+
},
|
|
2786
3508
|
/**
|
|
2787
3509
|
* The available satellite objects that the OurSky platform can currently track.
|
|
2788
3510
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -2792,6 +3514,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2792
3514
|
v1GetSatelliteTargets(requestParameters: DefaultApiV1GetSatelliteTargetsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargetsResponse> {
|
|
2793
3515
|
return localVarFp.v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(axios, basePath));
|
|
2794
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
|
+
},
|
|
2795
3535
|
/**
|
|
2796
3536
|
* Get a TDM.
|
|
2797
3537
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
@@ -2896,17 +3636,31 @@ export interface DefaultApiV1CreateSatelliteTargetRequest {
|
|
|
2896
3636
|
}
|
|
2897
3637
|
|
|
2898
3638
|
/**
|
|
2899
|
-
* Request parameters for
|
|
3639
|
+
* Request parameters for v1CreateSearchInstruction operation in DefaultApi.
|
|
3640
|
+
* @export
|
|
3641
|
+
* @interface DefaultApiV1CreateSearchInstructionRequest
|
|
3642
|
+
*/
|
|
3643
|
+
export interface DefaultApiV1CreateSearchInstructionRequest {
|
|
3644
|
+
/**
|
|
3645
|
+
*
|
|
3646
|
+
* @type {V1CreateSearchInstructionRequest}
|
|
3647
|
+
* @memberof DefaultApiV1CreateSearchInstruction
|
|
3648
|
+
*/
|
|
3649
|
+
readonly v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest
|
|
3650
|
+
}
|
|
3651
|
+
|
|
3652
|
+
/**
|
|
3653
|
+
* Request parameters for v1CreateSurveyInstruction operation in DefaultApi.
|
|
2900
3654
|
* @export
|
|
2901
|
-
* @interface
|
|
3655
|
+
* @interface DefaultApiV1CreateSurveyInstructionRequest
|
|
2902
3656
|
*/
|
|
2903
|
-
export interface
|
|
3657
|
+
export interface DefaultApiV1CreateSurveyInstructionRequest {
|
|
2904
3658
|
/**
|
|
2905
3659
|
*
|
|
2906
|
-
* @type {
|
|
2907
|
-
* @memberof
|
|
3660
|
+
* @type {V1CreateSurveyInstructionRequest}
|
|
3661
|
+
* @memberof DefaultApiV1CreateSurveyInstruction
|
|
2908
3662
|
*/
|
|
2909
|
-
readonly
|
|
3663
|
+
readonly v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest
|
|
2910
3664
|
}
|
|
2911
3665
|
|
|
2912
3666
|
/**
|
|
@@ -2965,6 +3719,34 @@ export interface DefaultApiV1DeleteOrganizationTargetRequest {
|
|
|
2965
3719
|
readonly satelliteTargetId: string
|
|
2966
3720
|
}
|
|
2967
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
|
+
|
|
2968
3750
|
/**
|
|
2969
3751
|
* Request parameters for v1DeleteWebhookConfiguration operation in DefaultApi.
|
|
2970
3752
|
* @export
|
|
@@ -3035,6 +3817,20 @@ export interface DefaultApiV1GetNodePropertiesRequest {
|
|
|
3035
3817
|
readonly nodeId: string
|
|
3036
3818
|
}
|
|
3037
3819
|
|
|
3820
|
+
/**
|
|
3821
|
+
* Request parameters for v1GetObservationFeatures operation in DefaultApi.
|
|
3822
|
+
* @export
|
|
3823
|
+
* @interface DefaultApiV1GetObservationFeaturesRequest
|
|
3824
|
+
*/
|
|
3825
|
+
export interface DefaultApiV1GetObservationFeaturesRequest {
|
|
3826
|
+
/**
|
|
3827
|
+
*
|
|
3828
|
+
* @type {string}
|
|
3829
|
+
* @memberof DefaultApiV1GetObservationFeatures
|
|
3830
|
+
*/
|
|
3831
|
+
readonly imageId: string
|
|
3832
|
+
}
|
|
3833
|
+
|
|
3038
3834
|
/**
|
|
3039
3835
|
* Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
|
|
3040
3836
|
* @export
|
|
@@ -3056,6 +3852,41 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
|
|
|
3056
3852
|
readonly after?: string
|
|
3057
3853
|
}
|
|
3058
3854
|
|
|
3855
|
+
/**
|
|
3856
|
+
* Request parameters for v1GetObservationStatuses operation in DefaultApi.
|
|
3857
|
+
* @export
|
|
3858
|
+
* @interface DefaultApiV1GetObservationStatusesRequest
|
|
3859
|
+
*/
|
|
3860
|
+
export interface DefaultApiV1GetObservationStatusesRequest {
|
|
3861
|
+
/**
|
|
3862
|
+
*
|
|
3863
|
+
* @type {string}
|
|
3864
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3865
|
+
*/
|
|
3866
|
+
readonly targetId?: string
|
|
3867
|
+
|
|
3868
|
+
/**
|
|
3869
|
+
*
|
|
3870
|
+
* @type {string}
|
|
3871
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3872
|
+
*/
|
|
3873
|
+
readonly before?: string
|
|
3874
|
+
|
|
3875
|
+
/**
|
|
3876
|
+
*
|
|
3877
|
+
* @type {string}
|
|
3878
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3879
|
+
*/
|
|
3880
|
+
readonly searchInstructionId?: string
|
|
3881
|
+
|
|
3882
|
+
/**
|
|
3883
|
+
*
|
|
3884
|
+
* @type {string}
|
|
3885
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3886
|
+
*/
|
|
3887
|
+
readonly surveyInstructionId?: string
|
|
3888
|
+
}
|
|
3889
|
+
|
|
3059
3890
|
/**
|
|
3060
3891
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
3061
3892
|
* @export
|
|
@@ -3077,6 +3908,20 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
|
|
|
3077
3908
|
readonly until: string
|
|
3078
3909
|
}
|
|
3079
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
|
+
|
|
3080
3925
|
/**
|
|
3081
3926
|
* Request parameters for v1GetSatelliteTargets operation in DefaultApi.
|
|
3082
3927
|
* @export
|
|
@@ -3098,6 +3943,34 @@ export interface DefaultApiV1GetSatelliteTargetsRequest {
|
|
|
3098
3943
|
readonly noradId?: string
|
|
3099
3944
|
}
|
|
3100
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
|
+
|
|
3101
3974
|
/**
|
|
3102
3975
|
* Request parameters for v1GetTdm operation in DefaultApi.
|
|
3103
3976
|
* @export
|
|
@@ -3213,14 +4086,25 @@ export class DefaultApi extends BaseAPI {
|
|
|
3213
4086
|
}
|
|
3214
4087
|
|
|
3215
4088
|
/**
|
|
3216
|
-
*
|
|
3217
|
-
* @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.
|
|
3218
4091
|
* @param {*} [options] Override http request option.
|
|
3219
4092
|
* @throws {RequiredError}
|
|
3220
4093
|
* @memberof DefaultApi
|
|
3221
4094
|
*/
|
|
3222
|
-
public
|
|
3223
|
-
return DefaultApiFp(this.configuration).
|
|
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.
|
|
4102
|
+
* @param {*} [options] Override http request option.
|
|
4103
|
+
* @throws {RequiredError}
|
|
4104
|
+
* @memberof DefaultApi
|
|
4105
|
+
*/
|
|
4106
|
+
public v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) {
|
|
4107
|
+
return DefaultApiFp(this.configuration).v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3224
4108
|
}
|
|
3225
4109
|
|
|
3226
4110
|
/**
|
|
@@ -3267,6 +4151,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
3267
4151
|
return DefaultApiFp(this.configuration).v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
3268
4152
|
}
|
|
3269
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
|
+
|
|
3270
4176
|
/**
|
|
3271
4177
|
* Delete a webhook configuration.
|
|
3272
4178
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -3332,6 +4238,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3332
4238
|
return DefaultApiFp(this.configuration).v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(this.axios, this.basePath));
|
|
3333
4239
|
}
|
|
3334
4240
|
|
|
4241
|
+
/**
|
|
4242
|
+
* Get observation features.
|
|
4243
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
4244
|
+
* @param {*} [options] Override http request option.
|
|
4245
|
+
* @throws {RequiredError}
|
|
4246
|
+
* @memberof DefaultApi
|
|
4247
|
+
*/
|
|
4248
|
+
public v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig) {
|
|
4249
|
+
return DefaultApiFp(this.configuration).v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
4250
|
+
}
|
|
4251
|
+
|
|
3335
4252
|
/**
|
|
3336
4253
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
3337
4254
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -3343,6 +4260,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3343
4260
|
return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3344
4261
|
}
|
|
3345
4262
|
|
|
4263
|
+
/**
|
|
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.
|
|
4265
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
4266
|
+
* @param {*} [options] Override http request option.
|
|
4267
|
+
* @throws {RequiredError}
|
|
4268
|
+
* @memberof DefaultApi
|
|
4269
|
+
*/
|
|
4270
|
+
public v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig) {
|
|
4271
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
4272
|
+
}
|
|
4273
|
+
|
|
3346
4274
|
/**
|
|
3347
4275
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
3348
4276
|
* @param {*} [options] Override http request option.
|
|
@@ -3364,6 +4292,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3364
4292
|
return DefaultApiFp(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
|
|
3365
4293
|
}
|
|
3366
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
|
+
|
|
3367
4306
|
/**
|
|
3368
4307
|
* The available satellite objects that the OurSky platform can currently track.
|
|
3369
4308
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -3375,6 +4314,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
3375
4314
|
return DefaultApiFp(this.configuration).v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(this.axios, this.basePath));
|
|
3376
4315
|
}
|
|
3377
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
|
+
|
|
3378
4339
|
/**
|
|
3379
4340
|
* Get a TDM.
|
|
3380
4341
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|