@ourskyai/sda-api 1.3.2078 → 1.3.2229
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 +281 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +187 -1
- package/dist/api.js +142 -2
- 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 +187 -1
- package/dist/esm/api.js +141 -1
- 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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @ourskyai/sda-api@1.3.
|
|
1
|
+
## @ourskyai/sda-api@1.3.2229
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @ourskyai/sda-api@1.3.
|
|
39
|
+
npm install @ourskyai/sda-api@1.3.2229 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
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.2229
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -109,6 +109,37 @@ export const FilterType = {
|
|
|
109
109
|
export type FilterType = typeof FilterType[keyof typeof FilterType];
|
|
110
110
|
|
|
111
111
|
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @export
|
|
115
|
+
* @interface ObservationBoundingBox
|
|
116
|
+
*/
|
|
117
|
+
export interface ObservationBoundingBox {
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @type {number}
|
|
121
|
+
* @memberof ObservationBoundingBox
|
|
122
|
+
*/
|
|
123
|
+
'startX': number;
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @type {number}
|
|
127
|
+
* @memberof ObservationBoundingBox
|
|
128
|
+
*/
|
|
129
|
+
'startY': number;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @type {number}
|
|
133
|
+
* @memberof ObservationBoundingBox
|
|
134
|
+
*/
|
|
135
|
+
'endX': number;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @type {number}
|
|
139
|
+
* @memberof ObservationBoundingBox
|
|
140
|
+
*/
|
|
141
|
+
'endY': number;
|
|
142
|
+
}
|
|
112
143
|
/**
|
|
113
144
|
* A single observation result. This is a 1:1 mapping with a single image
|
|
114
145
|
* @export
|
|
@@ -133,6 +164,12 @@ export interface ObservationResult {
|
|
|
133
164
|
* @memberof ObservationResult
|
|
134
165
|
*/
|
|
135
166
|
'imageUrl'?: string;
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {string}
|
|
170
|
+
* @memberof ObservationResult
|
|
171
|
+
*/
|
|
172
|
+
'jpgUrl'?: string;
|
|
136
173
|
/**
|
|
137
174
|
*
|
|
138
175
|
* @type {number}
|
|
@@ -145,6 +182,12 @@ export interface ObservationResult {
|
|
|
145
182
|
* @memberof ObservationResult
|
|
146
183
|
*/
|
|
147
184
|
'dec': number;
|
|
185
|
+
/**
|
|
186
|
+
*
|
|
187
|
+
* @type {ObservationBoundingBox}
|
|
188
|
+
* @memberof ObservationResult
|
|
189
|
+
*/
|
|
190
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
148
191
|
/**
|
|
149
192
|
*
|
|
150
193
|
* @type {string}
|
|
@@ -178,6 +221,21 @@ export const OrbitType = {
|
|
|
178
221
|
export type OrbitType = typeof OrbitType[keyof typeof OrbitType];
|
|
179
222
|
|
|
180
223
|
|
|
224
|
+
/**
|
|
225
|
+
*
|
|
226
|
+
* @export
|
|
227
|
+
* @enum {string}
|
|
228
|
+
*/
|
|
229
|
+
|
|
230
|
+
export const SatelliteTargetTrackingStatus = {
|
|
231
|
+
ACTIVE: 'ACTIVE',
|
|
232
|
+
INACTIVE: 'INACTIVE',
|
|
233
|
+
DEORBITED: 'DEORBITED'
|
|
234
|
+
} as const;
|
|
235
|
+
|
|
236
|
+
export type SatelliteTargetTrackingStatus = typeof SatelliteTargetTrackingStatus[keyof typeof SatelliteTargetTrackingStatus];
|
|
237
|
+
|
|
238
|
+
|
|
181
239
|
/**
|
|
182
240
|
*
|
|
183
241
|
* @export
|
|
@@ -401,6 +459,12 @@ export interface V1ImageSetImage {
|
|
|
401
459
|
* @memberof V1ImageSetImage
|
|
402
460
|
*/
|
|
403
461
|
'imageUrl': string;
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @type {string}
|
|
465
|
+
* @memberof V1ImageSetImage
|
|
466
|
+
*/
|
|
467
|
+
'fullJpgUrl'?: string;
|
|
404
468
|
/**
|
|
405
469
|
*
|
|
406
470
|
* @type {string}
|
|
@@ -645,7 +709,27 @@ export interface V1SatellitePotential {
|
|
|
645
709
|
* @memberof V1SatellitePotential
|
|
646
710
|
*/
|
|
647
711
|
'lastObservableTime': string;
|
|
712
|
+
/**
|
|
713
|
+
*
|
|
714
|
+
* @type {string}
|
|
715
|
+
* @memberof V1SatellitePotential
|
|
716
|
+
*/
|
|
717
|
+
'satelliteTargetId'?: string;
|
|
718
|
+
/**
|
|
719
|
+
*
|
|
720
|
+
* @type {string}
|
|
721
|
+
* @memberof V1SatellitePotential
|
|
722
|
+
*/
|
|
723
|
+
'noradId'?: string;
|
|
724
|
+
/**
|
|
725
|
+
*
|
|
726
|
+
* @type {OrbitType}
|
|
727
|
+
* @memberof V1SatellitePotential
|
|
728
|
+
*/
|
|
729
|
+
'orbitType'?: OrbitType;
|
|
648
730
|
}
|
|
731
|
+
|
|
732
|
+
|
|
649
733
|
/**
|
|
650
734
|
* Satellite Target
|
|
651
735
|
* @export
|
|
@@ -676,6 +760,30 @@ export interface V1SatelliteTarget {
|
|
|
676
760
|
* @memberof V1SatelliteTarget
|
|
677
761
|
*/
|
|
678
762
|
'orbitType': OrbitType;
|
|
763
|
+
/**
|
|
764
|
+
*
|
|
765
|
+
* @type {string}
|
|
766
|
+
* @memberof V1SatelliteTarget
|
|
767
|
+
*/
|
|
768
|
+
'tleEpoch'?: string;
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @type {string}
|
|
772
|
+
* @memberof V1SatelliteTarget
|
|
773
|
+
*/
|
|
774
|
+
'tleLine1'?: string;
|
|
775
|
+
/**
|
|
776
|
+
*
|
|
777
|
+
* @type {string}
|
|
778
|
+
* @memberof V1SatelliteTarget
|
|
779
|
+
*/
|
|
780
|
+
'tleLine2'?: string;
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {SatelliteTargetTrackingStatus}
|
|
784
|
+
* @memberof V1SatelliteTarget
|
|
785
|
+
*/
|
|
786
|
+
'trackingStatus'?: SatelliteTargetTrackingStatus;
|
|
679
787
|
}
|
|
680
788
|
|
|
681
789
|
|
|
@@ -996,6 +1104,90 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
996
1104
|
options: localVarRequestOptions,
|
|
997
1105
|
};
|
|
998
1106
|
},
|
|
1107
|
+
/**
|
|
1108
|
+
* Delete an image set.
|
|
1109
|
+
* @param {string} id
|
|
1110
|
+
* @param {*} [options] Override http request option.
|
|
1111
|
+
* @throws {RequiredError}
|
|
1112
|
+
*/
|
|
1113
|
+
v1DeleteImageSet: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1114
|
+
// verify required parameter 'id' is not null or undefined
|
|
1115
|
+
assertParamExists('v1DeleteImageSet', 'id', id)
|
|
1116
|
+
const localVarPath = `/v1/image-set`;
|
|
1117
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1118
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1119
|
+
let baseOptions;
|
|
1120
|
+
if (configuration) {
|
|
1121
|
+
baseOptions = configuration.baseOptions;
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1125
|
+
const localVarHeaderParameter = {} as any;
|
|
1126
|
+
const localVarQueryParameter = {} as any;
|
|
1127
|
+
|
|
1128
|
+
// authentication Roles required
|
|
1129
|
+
|
|
1130
|
+
// authentication BearerToken required
|
|
1131
|
+
// http bearer authentication required
|
|
1132
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1133
|
+
|
|
1134
|
+
if (id !== undefined) {
|
|
1135
|
+
localVarQueryParameter['id'] = id;
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1141
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1142
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1143
|
+
|
|
1144
|
+
return {
|
|
1145
|
+
url: toPathString(localVarUrlObj),
|
|
1146
|
+
options: localVarRequestOptions,
|
|
1147
|
+
};
|
|
1148
|
+
},
|
|
1149
|
+
/**
|
|
1150
|
+
* Delete an image.
|
|
1151
|
+
* @param {string} imageId
|
|
1152
|
+
* @param {*} [options] Override http request option.
|
|
1153
|
+
* @throws {RequiredError}
|
|
1154
|
+
*/
|
|
1155
|
+
v1DeleteImageSetImage: async (imageId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1156
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
1157
|
+
assertParamExists('v1DeleteImageSetImage', 'imageId', imageId)
|
|
1158
|
+
const localVarPath = `/v1/image-set-image`;
|
|
1159
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1160
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1161
|
+
let baseOptions;
|
|
1162
|
+
if (configuration) {
|
|
1163
|
+
baseOptions = configuration.baseOptions;
|
|
1164
|
+
}
|
|
1165
|
+
|
|
1166
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1167
|
+
const localVarHeaderParameter = {} as any;
|
|
1168
|
+
const localVarQueryParameter = {} as any;
|
|
1169
|
+
|
|
1170
|
+
// authentication Roles required
|
|
1171
|
+
|
|
1172
|
+
// authentication BearerToken required
|
|
1173
|
+
// http bearer authentication required
|
|
1174
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1175
|
+
|
|
1176
|
+
if (imageId !== undefined) {
|
|
1177
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1183
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1184
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1185
|
+
|
|
1186
|
+
return {
|
|
1187
|
+
url: toPathString(localVarUrlObj),
|
|
1188
|
+
options: localVarRequestOptions,
|
|
1189
|
+
};
|
|
1190
|
+
},
|
|
999
1191
|
/**
|
|
1000
1192
|
* Delete an organization target.
|
|
1001
1193
|
* @param {string} satelliteTargetId
|
|
@@ -1634,6 +1826,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
1634
1826
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest, options);
|
|
1635
1827
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1636
1828
|
},
|
|
1829
|
+
/**
|
|
1830
|
+
* Delete an image set.
|
|
1831
|
+
* @param {string} id
|
|
1832
|
+
* @param {*} [options] Override http request option.
|
|
1833
|
+
* @throws {RequiredError}
|
|
1834
|
+
*/
|
|
1835
|
+
async v1DeleteImageSet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
1836
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteImageSet(id, options);
|
|
1837
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1838
|
+
},
|
|
1839
|
+
/**
|
|
1840
|
+
* Delete an image.
|
|
1841
|
+
* @param {string} imageId
|
|
1842
|
+
* @param {*} [options] Override http request option.
|
|
1843
|
+
* @throws {RequiredError}
|
|
1844
|
+
*/
|
|
1845
|
+
async v1DeleteImageSetImage(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
1846
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteImageSetImage(imageId, options);
|
|
1847
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1848
|
+
},
|
|
1637
1849
|
/**
|
|
1638
1850
|
* Delete an organization target.
|
|
1639
1851
|
* @param {string} satelliteTargetId
|
|
@@ -1821,6 +2033,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
1821
2033
|
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
1822
2034
|
return localVarFp.v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
1823
2035
|
},
|
|
2036
|
+
/**
|
|
2037
|
+
* Delete an image set.
|
|
2038
|
+
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
2039
|
+
* @param {*} [options] Override http request option.
|
|
2040
|
+
* @throws {RequiredError}
|
|
2041
|
+
*/
|
|
2042
|
+
v1DeleteImageSet(requestParameters: DefaultApiV1DeleteImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2043
|
+
return localVarFp.v1DeleteImageSet(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
2044
|
+
},
|
|
2045
|
+
/**
|
|
2046
|
+
* Delete an image.
|
|
2047
|
+
* @param {DefaultApiV1DeleteImageSetImageRequest} requestParameters Request parameters.
|
|
2048
|
+
* @param {*} [options] Override http request option.
|
|
2049
|
+
* @throws {RequiredError}
|
|
2050
|
+
*/
|
|
2051
|
+
v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2052
|
+
return localVarFp.v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
2053
|
+
},
|
|
1824
2054
|
/**
|
|
1825
2055
|
* Delete an organization target.
|
|
1826
2056
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
@@ -2003,6 +2233,34 @@ export interface DefaultApiV1CreateWebhookConfigurationRequest {
|
|
|
2003
2233
|
readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest
|
|
2004
2234
|
}
|
|
2005
2235
|
|
|
2236
|
+
/**
|
|
2237
|
+
* Request parameters for v1DeleteImageSet operation in DefaultApi.
|
|
2238
|
+
* @export
|
|
2239
|
+
* @interface DefaultApiV1DeleteImageSetRequest
|
|
2240
|
+
*/
|
|
2241
|
+
export interface DefaultApiV1DeleteImageSetRequest {
|
|
2242
|
+
/**
|
|
2243
|
+
*
|
|
2244
|
+
* @type {string}
|
|
2245
|
+
* @memberof DefaultApiV1DeleteImageSet
|
|
2246
|
+
*/
|
|
2247
|
+
readonly id: string
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
/**
|
|
2251
|
+
* Request parameters for v1DeleteImageSetImage operation in DefaultApi.
|
|
2252
|
+
* @export
|
|
2253
|
+
* @interface DefaultApiV1DeleteImageSetImageRequest
|
|
2254
|
+
*/
|
|
2255
|
+
export interface DefaultApiV1DeleteImageSetImageRequest {
|
|
2256
|
+
/**
|
|
2257
|
+
*
|
|
2258
|
+
* @type {string}
|
|
2259
|
+
* @memberof DefaultApiV1DeleteImageSetImage
|
|
2260
|
+
*/
|
|
2261
|
+
readonly imageId: string
|
|
2262
|
+
}
|
|
2263
|
+
|
|
2006
2264
|
/**
|
|
2007
2265
|
* Request parameters for v1DeleteOrganizationTarget operation in DefaultApi.
|
|
2008
2266
|
* @export
|
|
@@ -2236,6 +2494,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
2236
2494
|
return DefaultApiFp(this.configuration).v1CreateWebhookConfiguration(requestParameters.v1UpdateWebhookConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2237
2495
|
}
|
|
2238
2496
|
|
|
2497
|
+
/**
|
|
2498
|
+
* Delete an image set.
|
|
2499
|
+
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
2500
|
+
* @param {*} [options] Override http request option.
|
|
2501
|
+
* @throws {RequiredError}
|
|
2502
|
+
* @memberof DefaultApi
|
|
2503
|
+
*/
|
|
2504
|
+
public v1DeleteImageSet(requestParameters: DefaultApiV1DeleteImageSetRequest, options?: AxiosRequestConfig) {
|
|
2505
|
+
return DefaultApiFp(this.configuration).v1DeleteImageSet(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2506
|
+
}
|
|
2507
|
+
|
|
2508
|
+
/**
|
|
2509
|
+
* Delete an image.
|
|
2510
|
+
* @param {DefaultApiV1DeleteImageSetImageRequest} requestParameters Request parameters.
|
|
2511
|
+
* @param {*} [options] Override http request option.
|
|
2512
|
+
* @throws {RequiredError}
|
|
2513
|
+
* @memberof DefaultApi
|
|
2514
|
+
*/
|
|
2515
|
+
public v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig) {
|
|
2516
|
+
return DefaultApiFp(this.configuration).v1DeleteImageSetImage(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
2517
|
+
}
|
|
2518
|
+
|
|
2239
2519
|
/**
|
|
2240
2520
|
* Delete an organization target.
|
|
2241
2521
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
package/base.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.2229
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.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.2229
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.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.2229
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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.2229
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -95,6 +95,37 @@ 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 ObservationBoundingBox
|
|
102
|
+
*/
|
|
103
|
+
export interface ObservationBoundingBox {
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {number}
|
|
107
|
+
* @memberof ObservationBoundingBox
|
|
108
|
+
*/
|
|
109
|
+
'startX': number;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {number}
|
|
113
|
+
* @memberof ObservationBoundingBox
|
|
114
|
+
*/
|
|
115
|
+
'startY': number;
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
* @type {number}
|
|
119
|
+
* @memberof ObservationBoundingBox
|
|
120
|
+
*/
|
|
121
|
+
'endX': number;
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
* @type {number}
|
|
125
|
+
* @memberof ObservationBoundingBox
|
|
126
|
+
*/
|
|
127
|
+
'endY': number;
|
|
128
|
+
}
|
|
98
129
|
/**
|
|
99
130
|
* A single observation result. This is a 1:1 mapping with a single image
|
|
100
131
|
* @export
|
|
@@ -119,6 +150,12 @@ export interface ObservationResult {
|
|
|
119
150
|
* @memberof ObservationResult
|
|
120
151
|
*/
|
|
121
152
|
'imageUrl'?: string;
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof ObservationResult
|
|
157
|
+
*/
|
|
158
|
+
'jpgUrl'?: string;
|
|
122
159
|
/**
|
|
123
160
|
*
|
|
124
161
|
* @type {number}
|
|
@@ -131,6 +168,12 @@ export interface ObservationResult {
|
|
|
131
168
|
* @memberof ObservationResult
|
|
132
169
|
*/
|
|
133
170
|
'dec': number;
|
|
171
|
+
/**
|
|
172
|
+
*
|
|
173
|
+
* @type {ObservationBoundingBox}
|
|
174
|
+
* @memberof ObservationResult
|
|
175
|
+
*/
|
|
176
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
134
177
|
/**
|
|
135
178
|
*
|
|
136
179
|
* @type {string}
|
|
@@ -160,6 +203,17 @@ export declare const OrbitType: {
|
|
|
160
203
|
readonly MOLNIYA: "MOLNIYA";
|
|
161
204
|
};
|
|
162
205
|
export type OrbitType = typeof OrbitType[keyof typeof OrbitType];
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @export
|
|
209
|
+
* @enum {string}
|
|
210
|
+
*/
|
|
211
|
+
export declare const SatelliteTargetTrackingStatus: {
|
|
212
|
+
readonly ACTIVE: "ACTIVE";
|
|
213
|
+
readonly INACTIVE: "INACTIVE";
|
|
214
|
+
readonly DEORBITED: "DEORBITED";
|
|
215
|
+
};
|
|
216
|
+
export type SatelliteTargetTrackingStatus = typeof SatelliteTargetTrackingStatus[keyof typeof SatelliteTargetTrackingStatus];
|
|
163
217
|
/**
|
|
164
218
|
*
|
|
165
219
|
* @export
|
|
@@ -375,6 +429,12 @@ export interface V1ImageSetImage {
|
|
|
375
429
|
* @memberof V1ImageSetImage
|
|
376
430
|
*/
|
|
377
431
|
'imageUrl': string;
|
|
432
|
+
/**
|
|
433
|
+
*
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof V1ImageSetImage
|
|
436
|
+
*/
|
|
437
|
+
'fullJpgUrl'?: string;
|
|
378
438
|
/**
|
|
379
439
|
*
|
|
380
440
|
* @type {string}
|
|
@@ -619,6 +679,24 @@ export interface V1SatellitePotential {
|
|
|
619
679
|
* @memberof V1SatellitePotential
|
|
620
680
|
*/
|
|
621
681
|
'lastObservableTime': string;
|
|
682
|
+
/**
|
|
683
|
+
*
|
|
684
|
+
* @type {string}
|
|
685
|
+
* @memberof V1SatellitePotential
|
|
686
|
+
*/
|
|
687
|
+
'satelliteTargetId'?: string;
|
|
688
|
+
/**
|
|
689
|
+
*
|
|
690
|
+
* @type {string}
|
|
691
|
+
* @memberof V1SatellitePotential
|
|
692
|
+
*/
|
|
693
|
+
'noradId'?: string;
|
|
694
|
+
/**
|
|
695
|
+
*
|
|
696
|
+
* @type {OrbitType}
|
|
697
|
+
* @memberof V1SatellitePotential
|
|
698
|
+
*/
|
|
699
|
+
'orbitType'?: OrbitType;
|
|
622
700
|
}
|
|
623
701
|
/**
|
|
624
702
|
* Satellite Target
|
|
@@ -650,6 +728,30 @@ export interface V1SatelliteTarget {
|
|
|
650
728
|
* @memberof V1SatelliteTarget
|
|
651
729
|
*/
|
|
652
730
|
'orbitType': OrbitType;
|
|
731
|
+
/**
|
|
732
|
+
*
|
|
733
|
+
* @type {string}
|
|
734
|
+
* @memberof V1SatelliteTarget
|
|
735
|
+
*/
|
|
736
|
+
'tleEpoch'?: string;
|
|
737
|
+
/**
|
|
738
|
+
*
|
|
739
|
+
* @type {string}
|
|
740
|
+
* @memberof V1SatelliteTarget
|
|
741
|
+
*/
|
|
742
|
+
'tleLine1'?: string;
|
|
743
|
+
/**
|
|
744
|
+
*
|
|
745
|
+
* @type {string}
|
|
746
|
+
* @memberof V1SatelliteTarget
|
|
747
|
+
*/
|
|
748
|
+
'tleLine2'?: string;
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @type {SatelliteTargetTrackingStatus}
|
|
752
|
+
* @memberof V1SatelliteTarget
|
|
753
|
+
*/
|
|
754
|
+
'trackingStatus'?: SatelliteTargetTrackingStatus;
|
|
653
755
|
}
|
|
654
756
|
/**
|
|
655
757
|
* TDM
|
|
@@ -826,6 +928,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
826
928
|
* @throws {RequiredError}
|
|
827
929
|
*/
|
|
828
930
|
v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
931
|
+
/**
|
|
932
|
+
* Delete an image set.
|
|
933
|
+
* @param {string} id
|
|
934
|
+
* @param {*} [options] Override http request option.
|
|
935
|
+
* @throws {RequiredError}
|
|
936
|
+
*/
|
|
937
|
+
v1DeleteImageSet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
938
|
+
/**
|
|
939
|
+
* Delete an image.
|
|
940
|
+
* @param {string} imageId
|
|
941
|
+
* @param {*} [options] Override http request option.
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
*/
|
|
944
|
+
v1DeleteImageSetImage: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
829
945
|
/**
|
|
830
946
|
* Delete an organization target.
|
|
831
947
|
* @param {string} satelliteTargetId
|
|
@@ -959,6 +1075,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
959
1075
|
* @throws {RequiredError}
|
|
960
1076
|
*/
|
|
961
1077
|
v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Delete an image set.
|
|
1080
|
+
* @param {string} id
|
|
1081
|
+
* @param {*} [options] Override http request option.
|
|
1082
|
+
* @throws {RequiredError}
|
|
1083
|
+
*/
|
|
1084
|
+
v1DeleteImageSet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1085
|
+
/**
|
|
1086
|
+
* Delete an image.
|
|
1087
|
+
* @param {string} imageId
|
|
1088
|
+
* @param {*} [options] Override http request option.
|
|
1089
|
+
* @throws {RequiredError}
|
|
1090
|
+
*/
|
|
1091
|
+
v1DeleteImageSetImage(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
962
1092
|
/**
|
|
963
1093
|
* Delete an organization target.
|
|
964
1094
|
* @param {string} satelliteTargetId
|
|
@@ -1092,6 +1222,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1092
1222
|
* @throws {RequiredError}
|
|
1093
1223
|
*/
|
|
1094
1224
|
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1225
|
+
/**
|
|
1226
|
+
* Delete an image set.
|
|
1227
|
+
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
1228
|
+
* @param {*} [options] Override http request option.
|
|
1229
|
+
* @throws {RequiredError}
|
|
1230
|
+
*/
|
|
1231
|
+
v1DeleteImageSet(requestParameters: DefaultApiV1DeleteImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1232
|
+
/**
|
|
1233
|
+
* Delete an image.
|
|
1234
|
+
* @param {DefaultApiV1DeleteImageSetImageRequest} requestParameters Request parameters.
|
|
1235
|
+
* @param {*} [options] Override http request option.
|
|
1236
|
+
* @throws {RequiredError}
|
|
1237
|
+
*/
|
|
1238
|
+
v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1095
1239
|
/**
|
|
1096
1240
|
* Delete an organization target.
|
|
1097
1241
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
@@ -1240,6 +1384,32 @@ export interface DefaultApiV1CreateWebhookConfigurationRequest {
|
|
|
1240
1384
|
*/
|
|
1241
1385
|
readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
|
|
1242
1386
|
}
|
|
1387
|
+
/**
|
|
1388
|
+
* Request parameters for v1DeleteImageSet operation in DefaultApi.
|
|
1389
|
+
* @export
|
|
1390
|
+
* @interface DefaultApiV1DeleteImageSetRequest
|
|
1391
|
+
*/
|
|
1392
|
+
export interface DefaultApiV1DeleteImageSetRequest {
|
|
1393
|
+
/**
|
|
1394
|
+
*
|
|
1395
|
+
* @type {string}
|
|
1396
|
+
* @memberof DefaultApiV1DeleteImageSet
|
|
1397
|
+
*/
|
|
1398
|
+
readonly id: string;
|
|
1399
|
+
}
|
|
1400
|
+
/**
|
|
1401
|
+
* Request parameters for v1DeleteImageSetImage operation in DefaultApi.
|
|
1402
|
+
* @export
|
|
1403
|
+
* @interface DefaultApiV1DeleteImageSetImageRequest
|
|
1404
|
+
*/
|
|
1405
|
+
export interface DefaultApiV1DeleteImageSetImageRequest {
|
|
1406
|
+
/**
|
|
1407
|
+
*
|
|
1408
|
+
* @type {string}
|
|
1409
|
+
* @memberof DefaultApiV1DeleteImageSetImage
|
|
1410
|
+
*/
|
|
1411
|
+
readonly imageId: string;
|
|
1412
|
+
}
|
|
1243
1413
|
/**
|
|
1244
1414
|
* Request parameters for v1DeleteOrganizationTarget operation in DefaultApi.
|
|
1245
1415
|
* @export
|
|
@@ -1446,6 +1616,22 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1446
1616
|
* @memberof DefaultApi
|
|
1447
1617
|
*/
|
|
1448
1618
|
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1619
|
+
/**
|
|
1620
|
+
* Delete an image set.
|
|
1621
|
+
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
1622
|
+
* @param {*} [options] Override http request option.
|
|
1623
|
+
* @throws {RequiredError}
|
|
1624
|
+
* @memberof DefaultApi
|
|
1625
|
+
*/
|
|
1626
|
+
v1DeleteImageSet(requestParameters: DefaultApiV1DeleteImageSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Delete an image.
|
|
1629
|
+
* @param {DefaultApiV1DeleteImageSetImageRequest} requestParameters Request parameters.
|
|
1630
|
+
* @param {*} [options] Override http request option.
|
|
1631
|
+
* @throws {RequiredError}
|
|
1632
|
+
* @memberof DefaultApi
|
|
1633
|
+
*/
|
|
1634
|
+
v1DeleteImageSetImage(requestParameters: DefaultApiV1DeleteImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1449
1635
|
/**
|
|
1450
1636
|
* Delete an organization target.
|
|
1451
1637
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|