@ourskyai/sda-api 1.3.3442 → 1.3.3603
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 +171 -20
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +108 -17
- 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 +108 -17
- 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.3603
|
|
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
|
*/
|
|
@@ -223,25 +223,25 @@ export interface ObservationResult {
|
|
|
223
223
|
*/
|
|
224
224
|
'jpgUrl'?: string;
|
|
225
225
|
/**
|
|
226
|
-
*
|
|
226
|
+
* The un-corrected apparent right ascension in degrees and EME2000 frame at the ground station
|
|
227
227
|
* @type {number}
|
|
228
228
|
* @memberof ObservationResult
|
|
229
229
|
*/
|
|
230
230
|
'ra': number;
|
|
231
231
|
/**
|
|
232
|
-
*
|
|
232
|
+
* The un-corrected apparent declination in degrees and EME2000 frame at the ground station
|
|
233
233
|
* @type {number}
|
|
234
234
|
* @memberof ObservationResult
|
|
235
235
|
*/
|
|
236
236
|
'dec': number;
|
|
237
237
|
/**
|
|
238
|
-
* The measured right ascension calibrated for stellar aberration in degrees
|
|
238
|
+
* The measured right ascension calibrated for stellar aberration in degrees and EME2000 frame
|
|
239
239
|
* @type {number}
|
|
240
240
|
* @memberof ObservationResult
|
|
241
241
|
*/
|
|
242
242
|
'correctedRa'?: number;
|
|
243
243
|
/**
|
|
244
|
-
* The measured declination calibrated for stellar aberration in degrees
|
|
244
|
+
* The measured declination calibrated for stellar aberration in degrees and EME2000 frame
|
|
245
245
|
* @type {number}
|
|
246
246
|
* @memberof ObservationResult
|
|
247
247
|
*/
|
|
@@ -258,6 +258,12 @@ export interface ObservationResult {
|
|
|
258
258
|
* @memberof ObservationResult
|
|
259
259
|
*/
|
|
260
260
|
'timestamp': string;
|
|
261
|
+
/**
|
|
262
|
+
* Timestamps for this image are considered to be accurate to within +/- this value in seconds
|
|
263
|
+
* @type {number}
|
|
264
|
+
* @memberof ObservationResult
|
|
265
|
+
*/
|
|
266
|
+
'timingAccuracy': number;
|
|
261
267
|
/**
|
|
262
268
|
* BETA: the apparent magnitude of the target at the time of the observation
|
|
263
269
|
* @type {number}
|
|
@@ -265,7 +271,7 @@ export interface ObservationResult {
|
|
|
265
271
|
*/
|
|
266
272
|
'apparentMagnitude'?: number;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
274
|
+
* The distance from the predicted location in arcseconds (using SGP4 propagation)
|
|
269
275
|
* @type {number}
|
|
270
276
|
* @memberof ObservationResult
|
|
271
277
|
*/
|
|
@@ -839,13 +845,13 @@ export interface V1ImageSetImage {
|
|
|
839
845
|
*/
|
|
840
846
|
export interface V1ObservationFeature {
|
|
841
847
|
/**
|
|
842
|
-
*
|
|
848
|
+
* the right ascension in degrees in EME2000 frame
|
|
843
849
|
* @type {number}
|
|
844
850
|
* @memberof V1ObservationFeature
|
|
845
851
|
*/
|
|
846
852
|
'ra': number;
|
|
847
853
|
/**
|
|
848
|
-
*
|
|
854
|
+
* the declination in degrees in EME2000 frame
|
|
849
855
|
* @type {number}
|
|
850
856
|
* @memberof V1ObservationFeature
|
|
851
857
|
*/
|
|
@@ -869,7 +875,7 @@ export interface V1ObservationFeature {
|
|
|
869
875
|
*/
|
|
870
876
|
'apparentMagnitude'?: number;
|
|
871
877
|
/**
|
|
872
|
-
*
|
|
878
|
+
* The distance from the predicted location in arcseconds (using SGP4 propagation)
|
|
873
879
|
* @type {number}
|
|
874
880
|
* @memberof V1ObservationFeature
|
|
875
881
|
*/
|
|
@@ -1125,6 +1131,18 @@ export interface V1SatellitePotential {
|
|
|
1125
1131
|
* @memberof V1SatellitePotential
|
|
1126
1132
|
*/
|
|
1127
1133
|
'orbitType'?: OrbitType;
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @type {WeatherCondition}
|
|
1137
|
+
* @memberof V1SatellitePotential
|
|
1138
|
+
*/
|
|
1139
|
+
'weatherCondition'?: WeatherCondition;
|
|
1140
|
+
/**
|
|
1141
|
+
*
|
|
1142
|
+
* @type {string}
|
|
1143
|
+
* @memberof V1SatellitePotential
|
|
1144
|
+
*/
|
|
1145
|
+
'weatherDescription'?: string;
|
|
1128
1146
|
}
|
|
1129
1147
|
/**
|
|
1130
1148
|
* Satellite Target
|
|
@@ -1509,6 +1527,21 @@ export interface V1WebhookConfiguration {
|
|
|
1509
1527
|
*/
|
|
1510
1528
|
'createdAt': string;
|
|
1511
1529
|
}
|
|
1530
|
+
/**
|
|
1531
|
+
*
|
|
1532
|
+
* @export
|
|
1533
|
+
* @enum {string}
|
|
1534
|
+
*/
|
|
1535
|
+
export declare const WeatherCondition: {
|
|
1536
|
+
readonly THUNDERSTORM: "THUNDERSTORM";
|
|
1537
|
+
readonly DRIZZLE: "DRIZZLE";
|
|
1538
|
+
readonly RAIN: "RAIN";
|
|
1539
|
+
readonly SNOW: "SNOW";
|
|
1540
|
+
readonly ATMOSPHERE: "ATMOSPHERE";
|
|
1541
|
+
readonly CLEAR: "CLEAR";
|
|
1542
|
+
readonly CLOUDS: "CLOUDS";
|
|
1543
|
+
};
|
|
1544
|
+
export type WeatherCondition = typeof WeatherCondition[keyof typeof WeatherCondition];
|
|
1512
1545
|
/**
|
|
1513
1546
|
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1514
1547
|
* @export
|
|
@@ -1690,6 +1723,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1690
1723
|
* @throws {RequiredError}
|
|
1691
1724
|
*/
|
|
1692
1725
|
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1726
|
+
/**
|
|
1727
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
1728
|
+
* @param {string} until
|
|
1729
|
+
* @param {boolean} [includeWeather]
|
|
1730
|
+
* @param {*} [options] Override http request option.
|
|
1731
|
+
* @throws {RequiredError}
|
|
1732
|
+
*/
|
|
1733
|
+
v1GetOrganizationSatellitePotentials: (until: string, includeWeather?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1693
1734
|
/**
|
|
1694
1735
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1695
1736
|
* @param {*} [options] Override http request option.
|
|
@@ -1700,10 +1741,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1700
1741
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
1701
1742
|
* @param {string} satelliteTargetId
|
|
1702
1743
|
* @param {string} until
|
|
1744
|
+
* @param {boolean} [includeWeather]
|
|
1703
1745
|
* @param {*} [options] Override http request option.
|
|
1704
1746
|
* @throws {RequiredError}
|
|
1705
1747
|
*/
|
|
1706
|
-
v1GetSatellitePotentials: (satelliteTargetId: string, until: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1748
|
+
v1GetSatellitePotentials: (satelliteTargetId: string, until: string, includeWeather?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1707
1749
|
/**
|
|
1708
1750
|
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1709
1751
|
* @param {string} id
|
|
@@ -1924,6 +1966,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1924
1966
|
* @throws {RequiredError}
|
|
1925
1967
|
*/
|
|
1926
1968
|
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
1969
|
+
/**
|
|
1970
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
1971
|
+
* @param {string} until
|
|
1972
|
+
* @param {boolean} [includeWeather]
|
|
1973
|
+
* @param {*} [options] Override http request option.
|
|
1974
|
+
* @throws {RequiredError}
|
|
1975
|
+
*/
|
|
1976
|
+
v1GetOrganizationSatellitePotentials(until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
1927
1977
|
/**
|
|
1928
1978
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1929
1979
|
* @param {*} [options] Override http request option.
|
|
@@ -1934,10 +1984,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1934
1984
|
* Get potential observation windows for a satellite across the network from now until the `until` datetime
|
|
1935
1985
|
* @param {string} satelliteTargetId
|
|
1936
1986
|
* @param {string} until
|
|
1987
|
+
* @param {boolean} [includeWeather]
|
|
1937
1988
|
* @param {*} [options] Override http request option.
|
|
1938
1989
|
* @throws {RequiredError}
|
|
1939
1990
|
*/
|
|
1940
|
-
v1GetSatellitePotentials(satelliteTargetId: string, until: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
1991
|
+
v1GetSatellitePotentials(satelliteTargetId: string, until: string, includeWeather?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
|
|
1941
1992
|
/**
|
|
1942
1993
|
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1943
1994
|
* @param {string} id
|
|
@@ -2154,6 +2205,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2154
2205
|
* @throws {RequiredError}
|
|
2155
2206
|
*/
|
|
2156
2207
|
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>>;
|
|
2208
|
+
/**
|
|
2209
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2210
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
2211
|
+
* @param {*} [options] Override http request option.
|
|
2212
|
+
* @throws {RequiredError}
|
|
2213
|
+
*/
|
|
2214
|
+
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>>;
|
|
2157
2215
|
/**
|
|
2158
2216
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2159
2217
|
* @param {*} [options] Override http request option.
|
|
@@ -2514,6 +2572,25 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
2514
2572
|
*/
|
|
2515
2573
|
readonly surveyInstructionId?: string;
|
|
2516
2574
|
}
|
|
2575
|
+
/**
|
|
2576
|
+
* Request parameters for v1GetOrganizationSatellitePotentials operation in DefaultApi.
|
|
2577
|
+
* @export
|
|
2578
|
+
* @interface DefaultApiV1GetOrganizationSatellitePotentialsRequest
|
|
2579
|
+
*/
|
|
2580
|
+
export interface DefaultApiV1GetOrganizationSatellitePotentialsRequest {
|
|
2581
|
+
/**
|
|
2582
|
+
*
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof DefaultApiV1GetOrganizationSatellitePotentials
|
|
2585
|
+
*/
|
|
2586
|
+
readonly until: string;
|
|
2587
|
+
/**
|
|
2588
|
+
*
|
|
2589
|
+
* @type {boolean}
|
|
2590
|
+
* @memberof DefaultApiV1GetOrganizationSatellitePotentials
|
|
2591
|
+
*/
|
|
2592
|
+
readonly includeWeather?: boolean;
|
|
2593
|
+
}
|
|
2517
2594
|
/**
|
|
2518
2595
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
2519
2596
|
* @export
|
|
@@ -2532,6 +2609,12 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
|
|
|
2532
2609
|
* @memberof DefaultApiV1GetSatellitePotentials
|
|
2533
2610
|
*/
|
|
2534
2611
|
readonly until: string;
|
|
2612
|
+
/**
|
|
2613
|
+
*
|
|
2614
|
+
* @type {boolean}
|
|
2615
|
+
* @memberof DefaultApiV1GetSatellitePotentials
|
|
2616
|
+
*/
|
|
2617
|
+
readonly includeWeather?: boolean;
|
|
2535
2618
|
}
|
|
2536
2619
|
/**
|
|
2537
2620
|
* Request parameters for v1GetSatelliteTarget operation in DefaultApi.
|
|
@@ -2823,6 +2906,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2823
2906
|
* @memberof DefaultApi
|
|
2824
2907
|
*/
|
|
2825
2908
|
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationStatus[], any>>;
|
|
2909
|
+
/**
|
|
2910
|
+
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2911
|
+
* @param {DefaultApiV1GetOrganizationSatellitePotentialsRequest} requestParameters Request parameters.
|
|
2912
|
+
* @param {*} [options] Override http request option.
|
|
2913
|
+
* @throws {RequiredError}
|
|
2914
|
+
* @memberof DefaultApi
|
|
2915
|
+
*/
|
|
2916
|
+
v1GetOrganizationSatellitePotentials(requestParameters: DefaultApiV1GetOrganizationSatellitePotentialsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatellitePotential[], any>>;
|
|
2826
2917
|
/**
|
|
2827
2918
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2828
2919
|
* @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.3603
|
|
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.3603
|
|
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.3603
|
|
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.3603
|
|
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.3603
|
|
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.3603
|
|
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.3603
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|