@ourskyai/sda-api 1.3.3445 → 1.3.3644
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 +216 -22
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +153 -19
- package/dist/api.js +98 -7
- 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 +153 -19
- package/dist/esm/api.js +97 -6
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -20,37 +20,37 @@ import { BaseAPI } from './base';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AstrometricOffsets {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* the average offset from the star catalog (NOMAD or GAIA DR3) for right ascension in degrees in EME2000 frame
|
|
24
24
|
* @type {number}
|
|
25
25
|
* @memberof AstrometricOffsets
|
|
26
26
|
*/
|
|
27
27
|
'raPlateSolveOffsetAverage': number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* the standard deviation of offset from the star catalog (NOMAD or GAIA DR3) for right ascension in degrees in EME2000 frame
|
|
30
30
|
* @type {number}
|
|
31
31
|
* @memberof AstrometricOffsets
|
|
32
32
|
*/
|
|
33
33
|
'raPlateSolveOffsetStdDev': number;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* the average offset from the star catalog (NOMAD or GAIA DR3) for declination in degrees in EME2000 frame
|
|
36
36
|
* @type {number}
|
|
37
37
|
* @memberof AstrometricOffsets
|
|
38
38
|
*/
|
|
39
39
|
'decPlateSolveOffsetAverage': number;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* the standard deviation of offset from the star catalog (NOMAD or GAIA DR3) for declination in degrees in EME2000 frame
|
|
42
42
|
* @type {number}
|
|
43
43
|
* @memberof AstrometricOffsets
|
|
44
44
|
*/
|
|
45
45
|
'decPlateSolveOffsetStdDev': number;
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
47
|
+
* The standard deviation of the full-width-half-max of all stars in the image measured in arcseconds
|
|
48
48
|
* @type {number}
|
|
49
49
|
* @memberof AstrometricOffsets
|
|
50
50
|
*/
|
|
51
51
|
'fwhmStdDev': number;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* The average of the full-width-half-max of all stars in the image measured in arcseconds
|
|
54
54
|
* @type {number}
|
|
55
55
|
* @memberof AstrometricOffsets
|
|
56
56
|
*/
|
|
@@ -95,6 +95,25 @@ export declare const FilterType: {
|
|
|
95
95
|
readonly PHOTO_COUSINS_I: "PHOTO_COUSINS_I";
|
|
96
96
|
};
|
|
97
97
|
export type FilterType = typeof FilterType[keyof typeof FilterType];
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @export
|
|
101
|
+
* @interface FitsHeader
|
|
102
|
+
*/
|
|
103
|
+
export interface FitsHeader {
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof FitsHeader
|
|
108
|
+
*/
|
|
109
|
+
'key': string;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof FitsHeader
|
|
114
|
+
*/
|
|
115
|
+
'value': string;
|
|
116
|
+
}
|
|
98
117
|
/**
|
|
99
118
|
* Location
|
|
100
119
|
* @export
|
|
@@ -223,25 +242,25 @@ export interface ObservationResult {
|
|
|
223
242
|
*/
|
|
224
243
|
'jpgUrl'?: string;
|
|
225
244
|
/**
|
|
226
|
-
*
|
|
245
|
+
* The un-corrected apparent right ascension in degrees and EME2000 frame at the ground station
|
|
227
246
|
* @type {number}
|
|
228
247
|
* @memberof ObservationResult
|
|
229
248
|
*/
|
|
230
249
|
'ra': number;
|
|
231
250
|
/**
|
|
232
|
-
*
|
|
251
|
+
* The un-corrected apparent declination in degrees and EME2000 frame at the ground station
|
|
233
252
|
* @type {number}
|
|
234
253
|
* @memberof ObservationResult
|
|
235
254
|
*/
|
|
236
255
|
'dec': number;
|
|
237
256
|
/**
|
|
238
|
-
* The measured right ascension calibrated for stellar aberration in degrees
|
|
257
|
+
* The measured right ascension calibrated for stellar aberration in degrees and EME2000 frame
|
|
239
258
|
* @type {number}
|
|
240
259
|
* @memberof ObservationResult
|
|
241
260
|
*/
|
|
242
261
|
'correctedRa'?: number;
|
|
243
262
|
/**
|
|
244
|
-
* The measured declination calibrated for stellar aberration in degrees
|
|
263
|
+
* The measured declination calibrated for stellar aberration in degrees and EME2000 frame
|
|
245
264
|
* @type {number}
|
|
246
265
|
* @memberof ObservationResult
|
|
247
266
|
*/
|
|
@@ -258,6 +277,12 @@ export interface ObservationResult {
|
|
|
258
277
|
* @memberof ObservationResult
|
|
259
278
|
*/
|
|
260
279
|
'timestamp': string;
|
|
280
|
+
/**
|
|
281
|
+
* Timestamps for this image are considered to be accurate to within +/- this value in seconds
|
|
282
|
+
* @type {number}
|
|
283
|
+
* @memberof ObservationResult
|
|
284
|
+
*/
|
|
285
|
+
'timingAccuracy': number;
|
|
261
286
|
/**
|
|
262
287
|
* BETA: the apparent magnitude of the target at the time of the observation
|
|
263
288
|
* @type {number}
|
|
@@ -265,7 +290,7 @@ export interface ObservationResult {
|
|
|
265
290
|
*/
|
|
266
291
|
'apparentMagnitude'?: number;
|
|
267
292
|
/**
|
|
268
|
-
*
|
|
293
|
+
* The distance from the predicted location in arcseconds (using SGP4 propagation)
|
|
269
294
|
* @type {number}
|
|
270
295
|
* @memberof ObservationResult
|
|
271
296
|
*/
|
|
@@ -831,6 +856,12 @@ export interface V1ImageSetImage {
|
|
|
831
856
|
* @memberof V1ImageSetImage
|
|
832
857
|
*/
|
|
833
858
|
'exposureLength': number;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {Array<FitsHeader>}
|
|
862
|
+
* @memberof V1ImageSetImage
|
|
863
|
+
*/
|
|
864
|
+
'fitsHeaders': Array<FitsHeader>;
|
|
834
865
|
}
|
|
835
866
|
/**
|
|
836
867
|
* Observation Feature
|
|
@@ -839,13 +870,13 @@ export interface V1ImageSetImage {
|
|
|
839
870
|
*/
|
|
840
871
|
export interface V1ObservationFeature {
|
|
841
872
|
/**
|
|
842
|
-
*
|
|
873
|
+
* the right ascension in degrees in EME2000 frame
|
|
843
874
|
* @type {number}
|
|
844
875
|
* @memberof V1ObservationFeature
|
|
845
876
|
*/
|
|
846
877
|
'ra': number;
|
|
847
878
|
/**
|
|
848
|
-
*
|
|
879
|
+
* the declination in degrees in EME2000 frame
|
|
849
880
|
* @type {number}
|
|
850
881
|
* @memberof V1ObservationFeature
|
|
851
882
|
*/
|
|
@@ -869,7 +900,7 @@ export interface V1ObservationFeature {
|
|
|
869
900
|
*/
|
|
870
901
|
'apparentMagnitude'?: number;
|
|
871
902
|
/**
|
|
872
|
-
*
|
|
903
|
+
* The distance from the predicted location in arcseconds (using SGP4 propagation)
|
|
873
904
|
* @type {number}
|
|
874
905
|
* @memberof V1ObservationFeature
|
|
875
906
|
*/
|
|
@@ -1125,6 +1156,18 @@ export interface V1SatellitePotential {
|
|
|
1125
1156
|
* @memberof V1SatellitePotential
|
|
1126
1157
|
*/
|
|
1127
1158
|
'orbitType'?: OrbitType;
|
|
1159
|
+
/**
|
|
1160
|
+
*
|
|
1161
|
+
* @type {WeatherCondition}
|
|
1162
|
+
* @memberof V1SatellitePotential
|
|
1163
|
+
*/
|
|
1164
|
+
'weatherCondition'?: WeatherCondition;
|
|
1165
|
+
/**
|
|
1166
|
+
*
|
|
1167
|
+
* @type {string}
|
|
1168
|
+
* @memberof V1SatellitePotential
|
|
1169
|
+
*/
|
|
1170
|
+
'weatherDescription'?: string;
|
|
1128
1171
|
}
|
|
1129
1172
|
/**
|
|
1130
1173
|
* Satellite Target
|
|
@@ -1324,17 +1367,35 @@ export interface V1TargetCorrelation {
|
|
|
1324
1367
|
*/
|
|
1325
1368
|
'targetId': string;
|
|
1326
1369
|
/**
|
|
1327
|
-
*
|
|
1370
|
+
* The predicted (propagated) center of the targetId in Right Ascension in degrees
|
|
1328
1371
|
* @type {number}
|
|
1329
1372
|
* @memberof V1TargetCorrelation
|
|
1330
1373
|
*/
|
|
1331
1374
|
'ra': number;
|
|
1332
1375
|
/**
|
|
1333
|
-
*
|
|
1376
|
+
* The predicted (propagated) center of the streak in Declination in degrees
|
|
1334
1377
|
* @type {number}
|
|
1335
1378
|
* @memberof V1TargetCorrelation
|
|
1336
1379
|
*/
|
|
1337
1380
|
'dec': number;
|
|
1381
|
+
/**
|
|
1382
|
+
* The predicted (propagated) length of the target streak in degrees
|
|
1383
|
+
* @type {number}
|
|
1384
|
+
* @memberof V1TargetCorrelation
|
|
1385
|
+
*/
|
|
1386
|
+
'streakLength'?: number;
|
|
1387
|
+
/**
|
|
1388
|
+
* The distance between the predicted and actual center of the streak in degrees
|
|
1389
|
+
* @type {number}
|
|
1390
|
+
* @memberof V1TargetCorrelation
|
|
1391
|
+
*/
|
|
1392
|
+
'distanceFromStreak'?: number;
|
|
1393
|
+
/**
|
|
1394
|
+
* The angle between the predicted and actual angle-to-celestial-north for the streak in degrees
|
|
1395
|
+
* @type {number}
|
|
1396
|
+
* @memberof V1TargetCorrelation
|
|
1397
|
+
*/
|
|
1398
|
+
'angleFromStreak'?: number;
|
|
1338
1399
|
}
|
|
1339
1400
|
/**
|
|
1340
1401
|
* TDM
|
|
@@ -1509,6 +1570,21 @@ export interface V1WebhookConfiguration {
|
|
|
1509
1570
|
*/
|
|
1510
1571
|
'createdAt': string;
|
|
1511
1572
|
}
|
|
1573
|
+
/**
|
|
1574
|
+
*
|
|
1575
|
+
* @export
|
|
1576
|
+
* @enum {string}
|
|
1577
|
+
*/
|
|
1578
|
+
export declare const WeatherCondition: {
|
|
1579
|
+
readonly THUNDERSTORM: "THUNDERSTORM";
|
|
1580
|
+
readonly DRIZZLE: "DRIZZLE";
|
|
1581
|
+
readonly RAIN: "RAIN";
|
|
1582
|
+
readonly SNOW: "SNOW";
|
|
1583
|
+
readonly ATMOSPHERE: "ATMOSPHERE";
|
|
1584
|
+
readonly CLEAR: "CLEAR";
|
|
1585
|
+
readonly CLOUDS: "CLOUDS";
|
|
1586
|
+
};
|
|
1587
|
+
export type WeatherCondition = typeof WeatherCondition[keyof typeof WeatherCondition];
|
|
1512
1588
|
/**
|
|
1513
1589
|
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1514
1590
|
* @export
|
|
@@ -1690,6 +1766,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1690
1766
|
* @throws {RequiredError}
|
|
1691
1767
|
*/
|
|
1692
1768
|
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1769
|
+
/**
|
|
1770
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
1771
|
+
* @param {string} until
|
|
1772
|
+
* @param {boolean} [includeWeather]
|
|
1773
|
+
* @param {*} [options] Override http request option.
|
|
1774
|
+
* @throws {RequiredError}
|
|
1775
|
+
*/
|
|
1776
|
+
v1GetOrganizationSatellitePotentials: (until: string, includeWeather?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1693
1777
|
/**
|
|
1694
1778
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1695
1779
|
* @param {*} [options] Override http request option.
|
|
@@ -1700,10 +1784,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1700
1784
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
1701
1785
|
* @param {string} satelliteTargetId
|
|
1702
1786
|
* @param {string} until
|
|
1787
|
+
* @param {boolean} [includeWeather]
|
|
1703
1788
|
* @param {*} [options] Override http request option.
|
|
1704
1789
|
* @throws {RequiredError}
|
|
1705
1790
|
*/
|
|
1706
|
-
v1GetSatellitePotentials: (satelliteTargetId: string, until: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1791
|
+
v1GetSatellitePotentials: (satelliteTargetId: string, until: string, includeWeather?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1707
1792
|
/**
|
|
1708
1793
|
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1709
1794
|
* @param {string} id
|
|
@@ -1924,6 +2009,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1924
2009
|
* @throws {RequiredError}
|
|
1925
2010
|
*/
|
|
1926
2011
|
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
2012
|
+
/**
|
|
2013
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2014
|
+
* @param {string} until
|
|
2015
|
+
* @param {boolean} [includeWeather]
|
|
2016
|
+
* @param {*} [options] Override http request option.
|
|
2017
|
+
* @throws {RequiredError}
|
|
2018
|
+
*/
|
|
2019
|
+
v1GetOrganizationSatellitePotentials(until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
1927
2020
|
/**
|
|
1928
2021
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1929
2022
|
* @param {*} [options] Override http request option.
|
|
@@ -1934,10 +2027,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1934
2027
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
1935
2028
|
* @param {string} satelliteTargetId
|
|
1936
2029
|
* @param {string} until
|
|
2030
|
+
* @param {boolean} [includeWeather]
|
|
1937
2031
|
* @param {*} [options] Override http request option.
|
|
1938
2032
|
* @throws {RequiredError}
|
|
1939
2033
|
*/
|
|
1940
|
-
v1GetSatellitePotentials(satelliteTargetId: string, until: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
2034
|
+
v1GetSatellitePotentials(satelliteTargetId: string, until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
1941
2035
|
/**
|
|
1942
2036
|
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1943
2037
|
* @param {string} id
|
|
@@ -2154,6 +2248,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2154
2248
|
* @throws {RequiredError}
|
|
2155
2249
|
*/
|
|
2156
2250
|
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>>;
|
|
2251
|
+
/**
|
|
2252
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2253
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
2254
|
+
* @param {*} [options] Override http request option.
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
*/
|
|
2257
|
+
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>>;
|
|
2157
2258
|
/**
|
|
2158
2259
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2159
2260
|
* @param {*} [options] Override http request option.
|
|
@@ -2514,6 +2615,25 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
2514
2615
|
*/
|
|
2515
2616
|
readonly surveyInstructionId?: string;
|
|
2516
2617
|
}
|
|
2618
|
+
/**
|
|
2619
|
+
* Request parameters for v1GetOrganizationSatellitePotentials operation in DefaultApi.
|
|
2620
|
+
* @export
|
|
2621
|
+
* @interface DefaultApiV1GetOrganizationSatellitePotentialsRequest
|
|
2622
|
+
*/
|
|
2623
|
+
export interface DefaultApiV1GetOrganizationSatellitePotentialsRequest {
|
|
2624
|
+
/**
|
|
2625
|
+
*
|
|
2626
|
+
* @type {string}
|
|
2627
|
+
* @memberof DefaultApiV1GetOrganizationSatellitePotentials
|
|
2628
|
+
*/
|
|
2629
|
+
readonly until: string;
|
|
2630
|
+
/**
|
|
2631
|
+
*
|
|
2632
|
+
* @type {boolean}
|
|
2633
|
+
* @memberof DefaultApiV1GetOrganizationSatellitePotentials
|
|
2634
|
+
*/
|
|
2635
|
+
readonly includeWeather?: boolean;
|
|
2636
|
+
}
|
|
2517
2637
|
/**
|
|
2518
2638
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
2519
2639
|
* @export
|
|
@@ -2532,6 +2652,12 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
|
|
|
2532
2652
|
* @memberof DefaultApiV1GetSatellitePotentials
|
|
2533
2653
|
*/
|
|
2534
2654
|
readonly until: string;
|
|
2655
|
+
/**
|
|
2656
|
+
*
|
|
2657
|
+
* @type {boolean}
|
|
2658
|
+
* @memberof DefaultApiV1GetSatellitePotentials
|
|
2659
|
+
*/
|
|
2660
|
+
readonly includeWeather?: boolean;
|
|
2535
2661
|
}
|
|
2536
2662
|
/**
|
|
2537
2663
|
* Request parameters for v1GetSatelliteTarget operation in DefaultApi.
|
|
@@ -2823,6 +2949,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2823
2949
|
* @memberof DefaultApi
|
|
2824
2950
|
*/
|
|
2825
2951
|
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationStatus[], any>>;
|
|
2952
|
+
/**
|
|
2953
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2954
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
2955
|
+
* @param {*} [options] Override http request option.
|
|
2956
|
+
* @throws {RequiredError}
|
|
2957
|
+
* @memberof DefaultApi
|
|
2958
|
+
*/
|
|
2959
|
+
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatellitePotential[], any>>;
|
|
2826
2960
|
/**
|
|
2827
2961
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2828
2962
|
* @param {*} [options] Override http request option.
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.WebhookAuthType = exports.TrackingType = exports.ShutterType = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.ObservationState = exports.MountType = exports.FilterType = void 0;
|
|
25
|
+
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.WebhookAuthType = exports.WeatherCondition = exports.TrackingType = exports.ShutterType = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.ObservationState = exports.MountType = exports.FilterType = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -127,6 +127,20 @@ exports.TrackingType = {
|
|
|
127
127
|
SIDEREAL: 'SIDEREAL',
|
|
128
128
|
TARGET_RATE: 'TARGET_RATE'
|
|
129
129
|
};
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @export
|
|
133
|
+
* @enum {string}
|
|
134
|
+
*/
|
|
135
|
+
exports.WeatherCondition = {
|
|
136
|
+
THUNDERSTORM: 'THUNDERSTORM',
|
|
137
|
+
DRIZZLE: 'DRIZZLE',
|
|
138
|
+
RAIN: 'RAIN',
|
|
139
|
+
SNOW: 'SNOW',
|
|
140
|
+
ATMOSPHERE: 'ATMOSPHERE',
|
|
141
|
+
CLEAR: 'CLEAR',
|
|
142
|
+
CLOUDS: 'CLOUDS'
|
|
143
|
+
};
|
|
130
144
|
/**
|
|
131
145
|
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
132
146
|
* @export
|
|
@@ -874,6 +888,46 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
874
888
|
options: localVarRequestOptions,
|
|
875
889
|
};
|
|
876
890
|
}),
|
|
891
|
+
/**
|
|
892
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
893
|
+
* @param {string} until
|
|
894
|
+
* @param {boolean} [includeWeather]
|
|
895
|
+
* @param {*} [options] Override http request option.
|
|
896
|
+
* @throws {RequiredError}
|
|
897
|
+
*/
|
|
898
|
+
v1GetOrganizationSatellitePotentials: (until, includeWeather, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
899
|
+
// verify required parameter 'until' is not null or undefined
|
|
900
|
+
(0, common_1.assertParamExists)('v1GetOrganizationSatellitePotentials', 'until', until);
|
|
901
|
+
const localVarPath = `/v1/organization-target-potentials`;
|
|
902
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
903
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
904
|
+
let baseOptions;
|
|
905
|
+
if (configuration) {
|
|
906
|
+
baseOptions = configuration.baseOptions;
|
|
907
|
+
}
|
|
908
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
909
|
+
const localVarHeaderParameter = {};
|
|
910
|
+
const localVarQueryParameter = {};
|
|
911
|
+
// authentication Roles required
|
|
912
|
+
// authentication BearerToken required
|
|
913
|
+
// http bearer authentication required
|
|
914
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
915
|
+
if (until !== undefined) {
|
|
916
|
+
localVarQueryParameter['until'] = (until instanceof Date) ?
|
|
917
|
+
until.toISOString() :
|
|
918
|
+
until;
|
|
919
|
+
}
|
|
920
|
+
if (includeWeather !== undefined) {
|
|
921
|
+
localVarQueryParameter['includeWeather'] = includeWeather;
|
|
922
|
+
}
|
|
923
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
924
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
925
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
926
|
+
return {
|
|
927
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
928
|
+
options: localVarRequestOptions,
|
|
929
|
+
};
|
|
930
|
+
}),
|
|
877
931
|
/**
|
|
878
932
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
879
933
|
* @param {*} [options] Override http request option.
|
|
@@ -906,10 +960,11 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
906
960
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
907
961
|
* @param {string} satelliteTargetId
|
|
908
962
|
* @param {string} until
|
|
963
|
+
* @param {boolean} [includeWeather]
|
|
909
964
|
* @param {*} [options] Override http request option.
|
|
910
965
|
* @throws {RequiredError}
|
|
911
966
|
*/
|
|
912
|
-
v1GetSatellitePotentials: (satelliteTargetId, until, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
967
|
+
v1GetSatellitePotentials: (satelliteTargetId, until, includeWeather, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
913
968
|
// verify required parameter 'satelliteTargetId' is not null or undefined
|
|
914
969
|
(0, common_1.assertParamExists)('v1GetSatellitePotentials', 'satelliteTargetId', satelliteTargetId);
|
|
915
970
|
// verify required parameter 'until' is not null or undefined
|
|
@@ -936,6 +991,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
936
991
|
until.toISOString() :
|
|
937
992
|
until;
|
|
938
993
|
}
|
|
994
|
+
if (includeWeather !== undefined) {
|
|
995
|
+
localVarQueryParameter['includeWeather'] = includeWeather;
|
|
996
|
+
}
|
|
939
997
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
940
998
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
941
999
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1513,6 +1571,19 @@ const DefaultApiFp = function (configuration) {
|
|
|
1513
1571
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1514
1572
|
});
|
|
1515
1573
|
},
|
|
1574
|
+
/**
|
|
1575
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
1576
|
+
* @param {string} until
|
|
1577
|
+
* @param {boolean} [includeWeather]
|
|
1578
|
+
* @param {*} [options] Override http request option.
|
|
1579
|
+
* @throws {RequiredError}
|
|
1580
|
+
*/
|
|
1581
|
+
v1GetOrganizationSatellitePotentials(until, includeWeather, options) {
|
|
1582
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1583
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetOrganizationSatellitePotentials(until, includeWeather, options);
|
|
1584
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1585
|
+
});
|
|
1586
|
+
},
|
|
1516
1587
|
/**
|
|
1517
1588
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1518
1589
|
* @param {*} [options] Override http request option.
|
|
@@ -1528,12 +1599,13 @@ const DefaultApiFp = function (configuration) {
|
|
|
1528
1599
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
1529
1600
|
* @param {string} satelliteTargetId
|
|
1530
1601
|
* @param {string} until
|
|
1602
|
+
* @param {boolean} [includeWeather]
|
|
1531
1603
|
* @param {*} [options] Override http request option.
|
|
1532
1604
|
* @throws {RequiredError}
|
|
1533
1605
|
*/
|
|
1534
|
-
v1GetSatellitePotentials(satelliteTargetId, until, options) {
|
|
1606
|
+
v1GetSatellitePotentials(satelliteTargetId, until, includeWeather, options) {
|
|
1535
1607
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1536
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, options);
|
|
1608
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSatellitePotentials(satelliteTargetId, until, includeWeather, options);
|
|
1537
1609
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1538
1610
|
});
|
|
1539
1611
|
},
|
|
@@ -1844,6 +1916,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1844
1916
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1845
1917
|
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
|
|
1846
1918
|
},
|
|
1919
|
+
/**
|
|
1920
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
1921
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
1922
|
+
* @param {*} [options] Override http request option.
|
|
1923
|
+
* @throws {RequiredError}
|
|
1924
|
+
*/
|
|
1925
|
+
v1GetOrganizationSatellitePotentials(requestParameters, options) {
|
|
1926
|
+
return localVarFp.v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(axios, basePath));
|
|
1927
|
+
},
|
|
1847
1928
|
/**
|
|
1848
1929
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1849
1930
|
* @param {*} [options] Override http request option.
|
|
@@ -1859,7 +1940,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1859
1940
|
* @throws {RequiredError}
|
|
1860
1941
|
*/
|
|
1861
1942
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
1862
|
-
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
|
|
1943
|
+
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, requestParameters.includeWeather, options).then((request) => request(axios, basePath));
|
|
1863
1944
|
},
|
|
1864
1945
|
/**
|
|
1865
1946
|
* Get a satellite target that the OurSky platform can currently track by id.
|
|
@@ -2160,6 +2241,16 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
2160
2241
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
2161
2242
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
2162
2243
|
}
|
|
2244
|
+
/**
|
|
2245
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2246
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
2247
|
+
* @param {*} [options] Override http request option.
|
|
2248
|
+
* @throws {RequiredError}
|
|
2249
|
+
* @memberof DefaultApi
|
|
2250
|
+
*/
|
|
2251
|
+
v1GetOrganizationSatellitePotentials(requestParameters, options) {
|
|
2252
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetOrganizationSatellitePotentials(requestParameters.until, requestParameters.includeWeather, options).then((request) => request(this.axios, this.basePath));
|
|
2253
|
+
}
|
|
2163
2254
|
/**
|
|
2164
2255
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2165
2256
|
* @param {*} [options] Override http request option.
|
|
@@ -2177,7 +2268,7 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
2177
2268
|
* @memberof DefaultApi
|
|
2178
2269
|
*/
|
|
2179
2270
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
2180
|
-
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
|
|
2271
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, requestParameters.includeWeather, options).then((request) => request(this.axios, this.basePath));
|
|
2181
2272
|
}
|
|
2182
2273
|
/**
|
|
2183
2274
|
* Get a satellite target that the OurSky platform can currently track by id.
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.3644
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|