@ourskyai/sda-api 1.3.1734
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/.openapi-generator/FILES +13 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +45 -0
- package/api.ts +2277 -0
- package/base.ts +72 -0
- package/common.ts +150 -0
- package/configuration.ts +101 -0
- package/dist/api.d.ts +1496 -0
- package/dist/api.js +1215 -0
- package/dist/base.d.ts +54 -0
- package/dist/base.js +59 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +160 -0
- package/dist/configuration.d.ts +83 -0
- package/dist/configuration.js +42 -0
- package/dist/esm/api.d.ts +1496 -0
- package/dist/esm/api.js +1208 -0
- package/dist/esm/base.d.ts +54 -0
- package/dist/esm/base.js +54 -0
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +148 -0
- package/dist/esm/configuration.d.ts +83 -0
- package/dist/esm/configuration.js +38 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +33 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,1496 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OurSky SDA
|
|
3
|
+
* Once your organization has been signed up for the platform you will be able to log in and use the APIs under the \"Default\" section. Login by navigating to `https://api.<dev|prod>.oursky.ai/v1/auth/login` and use your email that ends in your organization domain. After entering your email you will receive a one time use email with a code, use that code to complete the login flow. After completing the login flow the browser will re-direct you to a page that displays a json object with your API token as the value of the `jwt` key. This is the only time your token will be displayed to you so please save it. To use this documentation site please select the \"Authorize\" button at the top right of the page and enter your token and select the correct environment (dev or prod) in the \"Servers\" dropdown. If you are using making api calls directly please ensure you include the header `Authorization: Bearer <your token>`. The basic api flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#default/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#default/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#default/v1GetTdms) endpoint to poll for TDMs.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.3.1734
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* astrometricOffsets
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AstrometricOffsets
|
|
20
|
+
*/
|
|
21
|
+
export interface AstrometricOffsets {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof AstrometricOffsets
|
|
26
|
+
*/
|
|
27
|
+
'raPlateSolveOffsetAverage': number;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof AstrometricOffsets
|
|
32
|
+
*/
|
|
33
|
+
'raPlateSolveOffsetStdDev': number;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof AstrometricOffsets
|
|
38
|
+
*/
|
|
39
|
+
'decPlateSolveOffsetAverage': number;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {number}
|
|
43
|
+
* @memberof AstrometricOffsets
|
|
44
|
+
*/
|
|
45
|
+
'decPlateSolveOffsetStdDev': number;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof AstrometricOffsets
|
|
50
|
+
*/
|
|
51
|
+
'fwhmStdDev': number;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {number}
|
|
55
|
+
* @memberof AstrometricOffsets
|
|
56
|
+
*/
|
|
57
|
+
'fwhmAverage': number;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* successful action
|
|
61
|
+
* @export
|
|
62
|
+
* @interface EmptySuccess
|
|
63
|
+
*/
|
|
64
|
+
export interface EmptySuccess {
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof EmptySuccess
|
|
69
|
+
*/
|
|
70
|
+
'message'?: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @export
|
|
75
|
+
* @enum {string}
|
|
76
|
+
*/
|
|
77
|
+
export declare const FilterType: {
|
|
78
|
+
readonly NONE: "NONE";
|
|
79
|
+
readonly RED: "RED";
|
|
80
|
+
readonly BLUE: "BLUE";
|
|
81
|
+
readonly GREEN: "GREEN";
|
|
82
|
+
readonly UV: "UV";
|
|
83
|
+
readonly IR: "IR";
|
|
84
|
+
readonly LUMINANCE: "LUMINANCE";
|
|
85
|
+
readonly ENHANCED_LUMINANCE: "ENHANCED_LUMINANCE";
|
|
86
|
+
readonly H_ALPHA: "H_ALPHA";
|
|
87
|
+
readonly H_BETA: "H_BETA";
|
|
88
|
+
readonly S_II: "S_II";
|
|
89
|
+
readonly O_III: "O_III";
|
|
90
|
+
readonly DUAL_BAND: "DUAL_BAND";
|
|
91
|
+
readonly PHOTO_JOHNSON_U: "PHOTO_JOHNSON_U";
|
|
92
|
+
readonly PHOTO_JOHNSON_B: "PHOTO_JOHNSON_B";
|
|
93
|
+
readonly PHOTO_JOHNSON_V: "PHOTO_JOHNSON_V";
|
|
94
|
+
readonly PHOTO_COUSINS_R: "PHOTO_COUSINS_R";
|
|
95
|
+
readonly PHOTO_COUSINS_I: "PHOTO_COUSINS_I";
|
|
96
|
+
};
|
|
97
|
+
export type FilterType = typeof FilterType[keyof typeof FilterType];
|
|
98
|
+
/**
|
|
99
|
+
* A single observation result. This is a 1:1 mapping with a single image
|
|
100
|
+
* @export
|
|
101
|
+
* @interface ObservationResult
|
|
102
|
+
*/
|
|
103
|
+
export interface ObservationResult {
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof ObservationResult
|
|
108
|
+
*/
|
|
109
|
+
'imageId': string;
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {AstrometricOffsets}
|
|
113
|
+
* @memberof ObservationResult
|
|
114
|
+
*/
|
|
115
|
+
'astrometricOffsets': AstrometricOffsets;
|
|
116
|
+
/**
|
|
117
|
+
*
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof ObservationResult
|
|
120
|
+
*/
|
|
121
|
+
'imageUrl'?: string;
|
|
122
|
+
/**
|
|
123
|
+
*
|
|
124
|
+
* @type {number}
|
|
125
|
+
* @memberof ObservationResult
|
|
126
|
+
*/
|
|
127
|
+
'ra': number;
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @type {number}
|
|
131
|
+
* @memberof ObservationResult
|
|
132
|
+
*/
|
|
133
|
+
'dec': number;
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof ObservationResult
|
|
138
|
+
*/
|
|
139
|
+
'timestamp': string;
|
|
140
|
+
/**
|
|
141
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
142
|
+
* @type {number}
|
|
143
|
+
* @memberof ObservationResult
|
|
144
|
+
*/
|
|
145
|
+
'apparentMagnitude'?: number;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* orbit type
|
|
149
|
+
* @export
|
|
150
|
+
* @enum {string}
|
|
151
|
+
*/
|
|
152
|
+
export declare const OrbitType: {
|
|
153
|
+
readonly GEOSTATIONARY: "GEOSTATIONARY";
|
|
154
|
+
readonly GEOSYNCHRONOUS: "GEOSYNCHRONOUS";
|
|
155
|
+
readonly MEO: "MEO";
|
|
156
|
+
readonly LEO: "LEO";
|
|
157
|
+
readonly GTO: "GTO";
|
|
158
|
+
readonly SSO: "SSO";
|
|
159
|
+
readonly TUNDRA: "TUNDRA";
|
|
160
|
+
readonly MOLNIYA: "MOLNIYA";
|
|
161
|
+
};
|
|
162
|
+
export type OrbitType = typeof OrbitType[keyof typeof OrbitType];
|
|
163
|
+
/**
|
|
164
|
+
* successful create
|
|
165
|
+
* @export
|
|
166
|
+
* @interface SuccessfulCreate
|
|
167
|
+
*/
|
|
168
|
+
export interface SuccessfulCreate {
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @type {string}
|
|
172
|
+
* @memberof SuccessfulCreate
|
|
173
|
+
*/
|
|
174
|
+
'id': string;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* target tracking type
|
|
178
|
+
* @export
|
|
179
|
+
* @enum {string}
|
|
180
|
+
*/
|
|
181
|
+
export declare const TrackingType: {
|
|
182
|
+
readonly SIDEREAL: "SIDEREAL";
|
|
183
|
+
readonly TARGET_RATE: "TARGET_RATE";
|
|
184
|
+
};
|
|
185
|
+
export type TrackingType = typeof TrackingType[keyof typeof TrackingType];
|
|
186
|
+
/**
|
|
187
|
+
* create image set
|
|
188
|
+
* @export
|
|
189
|
+
* @interface V1CreateImageSet
|
|
190
|
+
*/
|
|
191
|
+
export interface V1CreateImageSet {
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {string}
|
|
195
|
+
* @memberof V1CreateImageSet
|
|
196
|
+
*/
|
|
197
|
+
'targetId': string;
|
|
198
|
+
/**
|
|
199
|
+
*
|
|
200
|
+
* @type {string}
|
|
201
|
+
* @memberof V1CreateImageSet
|
|
202
|
+
*/
|
|
203
|
+
'nodeId': string;
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof V1CreateImageSet
|
|
208
|
+
*/
|
|
209
|
+
'observationId'?: string;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @type {string}
|
|
213
|
+
* @memberof V1CreateImageSet
|
|
214
|
+
* @deprecated
|
|
215
|
+
*/
|
|
216
|
+
'ourskyPluginVersion'?: string;
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @type {TrackingType}
|
|
220
|
+
* @memberof V1CreateImageSet
|
|
221
|
+
*/
|
|
222
|
+
'trackingType'?: TrackingType;
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {FilterType}
|
|
226
|
+
* @memberof V1CreateImageSet
|
|
227
|
+
*/
|
|
228
|
+
'filterType'?: FilterType;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* create image set image
|
|
232
|
+
* @export
|
|
233
|
+
* @interface V1CreateImageSetImage
|
|
234
|
+
*/
|
|
235
|
+
export interface V1CreateImageSetImage {
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof V1CreateImageSetImage
|
|
240
|
+
*/
|
|
241
|
+
'imageSetId': string;
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* successful create of image set image
|
|
245
|
+
* @export
|
|
246
|
+
* @interface V1CreateImageSetImageResponse
|
|
247
|
+
*/
|
|
248
|
+
export interface V1CreateImageSetImageResponse {
|
|
249
|
+
/**
|
|
250
|
+
*
|
|
251
|
+
* @type {string}
|
|
252
|
+
* @memberof V1CreateImageSetImageResponse
|
|
253
|
+
*/
|
|
254
|
+
'id': string;
|
|
255
|
+
/**
|
|
256
|
+
*
|
|
257
|
+
* @type {string}
|
|
258
|
+
* @memberof V1CreateImageSetImageResponse
|
|
259
|
+
*/
|
|
260
|
+
'uploadUrl': string;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
*
|
|
264
|
+
* @export
|
|
265
|
+
* @interface V1GetOrganizationTarget
|
|
266
|
+
*/
|
|
267
|
+
export interface V1GetOrganizationTarget {
|
|
268
|
+
/**
|
|
269
|
+
*
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof V1GetOrganizationTarget
|
|
272
|
+
*/
|
|
273
|
+
'id': string;
|
|
274
|
+
/**
|
|
275
|
+
*
|
|
276
|
+
* @type {V1SatelliteTarget}
|
|
277
|
+
* @memberof V1GetOrganizationTarget
|
|
278
|
+
*/
|
|
279
|
+
'satelliteTarget': V1SatelliteTarget;
|
|
280
|
+
/**
|
|
281
|
+
*
|
|
282
|
+
* @type {string}
|
|
283
|
+
* @memberof V1GetOrganizationTarget
|
|
284
|
+
*/
|
|
285
|
+
'createdBy': string;
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof V1GetOrganizationTarget
|
|
290
|
+
*/
|
|
291
|
+
'createdAt': string;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* v1GetSatelliteTargets
|
|
295
|
+
* @export
|
|
296
|
+
* @interface V1GetSatelliteTargets
|
|
297
|
+
*/
|
|
298
|
+
export interface V1GetSatelliteTargets {
|
|
299
|
+
/**
|
|
300
|
+
*
|
|
301
|
+
* @type {Array<V1SatelliteTarget>}
|
|
302
|
+
* @memberof V1GetSatelliteTargets
|
|
303
|
+
*/
|
|
304
|
+
'targets': Array<V1SatelliteTarget>;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* v1GetImageSet
|
|
308
|
+
* @export
|
|
309
|
+
* @interface V1ImageSet
|
|
310
|
+
*/
|
|
311
|
+
export interface V1ImageSet {
|
|
312
|
+
/**
|
|
313
|
+
*
|
|
314
|
+
* @type {string}
|
|
315
|
+
* @memberof V1ImageSet
|
|
316
|
+
*/
|
|
317
|
+
'id': string;
|
|
318
|
+
/**
|
|
319
|
+
*
|
|
320
|
+
* @type {string}
|
|
321
|
+
* @memberof V1ImageSet
|
|
322
|
+
*/
|
|
323
|
+
'targetId'?: string;
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @type {number}
|
|
327
|
+
* @memberof V1ImageSet
|
|
328
|
+
*/
|
|
329
|
+
'ra'?: number;
|
|
330
|
+
/**
|
|
331
|
+
*
|
|
332
|
+
* @type {number}
|
|
333
|
+
* @memberof V1ImageSet
|
|
334
|
+
*/
|
|
335
|
+
'dec'?: number;
|
|
336
|
+
/**
|
|
337
|
+
*
|
|
338
|
+
* @type {string}
|
|
339
|
+
* @memberof V1ImageSet
|
|
340
|
+
*/
|
|
341
|
+
'nodeId': string;
|
|
342
|
+
/**
|
|
343
|
+
*
|
|
344
|
+
* @type {string}
|
|
345
|
+
* @memberof V1ImageSet
|
|
346
|
+
*/
|
|
347
|
+
'observationId'?: string;
|
|
348
|
+
/**
|
|
349
|
+
*
|
|
350
|
+
* @type {TrackingType}
|
|
351
|
+
* @memberof V1ImageSet
|
|
352
|
+
*/
|
|
353
|
+
'trackingType': TrackingType;
|
|
354
|
+
/**
|
|
355
|
+
*
|
|
356
|
+
* @type {FilterType}
|
|
357
|
+
* @memberof V1ImageSet
|
|
358
|
+
*/
|
|
359
|
+
'filterType'?: FilterType;
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @type {string}
|
|
363
|
+
* @memberof V1ImageSet
|
|
364
|
+
*/
|
|
365
|
+
'createdAt': string;
|
|
366
|
+
/**
|
|
367
|
+
*
|
|
368
|
+
* @type {string}
|
|
369
|
+
* @memberof V1ImageSet
|
|
370
|
+
*/
|
|
371
|
+
'updatedAt'?: string;
|
|
372
|
+
/**
|
|
373
|
+
*
|
|
374
|
+
* @type {string}
|
|
375
|
+
* @memberof V1ImageSet
|
|
376
|
+
*/
|
|
377
|
+
'ourskyPluginVersion'?: string;
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* v1GetImageSetImage
|
|
381
|
+
* @export
|
|
382
|
+
* @interface V1ImageSetImage
|
|
383
|
+
*/
|
|
384
|
+
export interface V1ImageSetImage {
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof V1ImageSetImage
|
|
389
|
+
*/
|
|
390
|
+
'id': string;
|
|
391
|
+
/**
|
|
392
|
+
*
|
|
393
|
+
* @type {string}
|
|
394
|
+
* @memberof V1ImageSetImage
|
|
395
|
+
*/
|
|
396
|
+
'thumbnailUrl'?: string;
|
|
397
|
+
/**
|
|
398
|
+
*
|
|
399
|
+
* @type {string}
|
|
400
|
+
* @memberof V1ImageSetImage
|
|
401
|
+
*/
|
|
402
|
+
'imageUrl': string;
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @type {string}
|
|
406
|
+
* @memberof V1ImageSetImage
|
|
407
|
+
*/
|
|
408
|
+
'nodeId': string;
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @type {string}
|
|
412
|
+
* @memberof V1ImageSetImage
|
|
413
|
+
*/
|
|
414
|
+
'targetId'?: string;
|
|
415
|
+
/**
|
|
416
|
+
*
|
|
417
|
+
* @type {number}
|
|
418
|
+
* @memberof V1ImageSetImage
|
|
419
|
+
*/
|
|
420
|
+
'ra'?: number;
|
|
421
|
+
/**
|
|
422
|
+
*
|
|
423
|
+
* @type {number}
|
|
424
|
+
* @memberof V1ImageSetImage
|
|
425
|
+
*/
|
|
426
|
+
'dec'?: number;
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof V1ImageSetImage
|
|
431
|
+
*/
|
|
432
|
+
'imageSetId': string;
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @type {boolean}
|
|
436
|
+
* @memberof V1ImageSetImage
|
|
437
|
+
*/
|
|
438
|
+
'darkCalibrated': boolean;
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @type {boolean}
|
|
442
|
+
* @memberof V1ImageSetImage
|
|
443
|
+
*/
|
|
444
|
+
'flatCalibrated': boolean;
|
|
445
|
+
/**
|
|
446
|
+
*
|
|
447
|
+
* @type {boolean}
|
|
448
|
+
* @memberof V1ImageSetImage
|
|
449
|
+
*/
|
|
450
|
+
'biasCalibrated': boolean;
|
|
451
|
+
/**
|
|
452
|
+
*
|
|
453
|
+
* @type {number}
|
|
454
|
+
* @memberof V1ImageSetImage
|
|
455
|
+
*/
|
|
456
|
+
'fwhmAverage'?: number;
|
|
457
|
+
/**
|
|
458
|
+
*
|
|
459
|
+
* @type {number}
|
|
460
|
+
* @memberof V1ImageSetImage
|
|
461
|
+
*/
|
|
462
|
+
'fwhmStdDev'?: number;
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
* @type {number}
|
|
466
|
+
* @memberof V1ImageSetImage
|
|
467
|
+
*/
|
|
468
|
+
'fwhmAngle'?: number;
|
|
469
|
+
/**
|
|
470
|
+
*
|
|
471
|
+
* @type {number}
|
|
472
|
+
* @memberof V1ImageSetImage
|
|
473
|
+
*/
|
|
474
|
+
'raOffset'?: number;
|
|
475
|
+
/**
|
|
476
|
+
*
|
|
477
|
+
* @type {number}
|
|
478
|
+
* @memberof V1ImageSetImage
|
|
479
|
+
*/
|
|
480
|
+
'decOffset'?: number;
|
|
481
|
+
/**
|
|
482
|
+
*
|
|
483
|
+
* @type {number}
|
|
484
|
+
* @memberof V1ImageSetImage
|
|
485
|
+
*/
|
|
486
|
+
'totalOffset'?: number;
|
|
487
|
+
/**
|
|
488
|
+
*
|
|
489
|
+
* @type {number}
|
|
490
|
+
* @memberof V1ImageSetImage
|
|
491
|
+
*/
|
|
492
|
+
'totalOffsetStdDev'?: number;
|
|
493
|
+
/**
|
|
494
|
+
*
|
|
495
|
+
* @type {number}
|
|
496
|
+
* @memberof V1ImageSetImage
|
|
497
|
+
*/
|
|
498
|
+
'totalOffsetRMS'?: number;
|
|
499
|
+
/**
|
|
500
|
+
*
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof V1ImageSetImage
|
|
503
|
+
*/
|
|
504
|
+
'capturedAt': string;
|
|
505
|
+
/**
|
|
506
|
+
*
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof V1ImageSetImage
|
|
509
|
+
*/
|
|
510
|
+
'createdAt': string;
|
|
511
|
+
/**
|
|
512
|
+
*
|
|
513
|
+
* @type {number}
|
|
514
|
+
* @memberof V1ImageSetImage
|
|
515
|
+
*/
|
|
516
|
+
'binning'?: number;
|
|
517
|
+
/**
|
|
518
|
+
*
|
|
519
|
+
* @type {number}
|
|
520
|
+
* @memberof V1ImageSetImage
|
|
521
|
+
*/
|
|
522
|
+
'exposureLength': number;
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* v1ObservationSequenceResult
|
|
526
|
+
* @export
|
|
527
|
+
* @interface V1ObservationSequenceResult
|
|
528
|
+
*/
|
|
529
|
+
export interface V1ObservationSequenceResult {
|
|
530
|
+
/**
|
|
531
|
+
*
|
|
532
|
+
* @type {string}
|
|
533
|
+
* @memberof V1ObservationSequenceResult
|
|
534
|
+
*/
|
|
535
|
+
'id': string;
|
|
536
|
+
/**
|
|
537
|
+
*
|
|
538
|
+
* @type {string}
|
|
539
|
+
* @memberof V1ObservationSequenceResult
|
|
540
|
+
*/
|
|
541
|
+
'targetId': string;
|
|
542
|
+
/**
|
|
543
|
+
* The NORAD ID of the target, if available
|
|
544
|
+
* @type {string}
|
|
545
|
+
* @memberof V1ObservationSequenceResult
|
|
546
|
+
*/
|
|
547
|
+
'noradId'?: string;
|
|
548
|
+
/**
|
|
549
|
+
* An array of image sets. Each image set represents a contiguous set of observations of the same target captured by the same node
|
|
550
|
+
* @type {Array<V1ObservationSequenceResultImageSetsInner>}
|
|
551
|
+
* @memberof V1ObservationSequenceResult
|
|
552
|
+
*/
|
|
553
|
+
'imageSets': Array<V1ObservationSequenceResultImageSetsInner>;
|
|
554
|
+
/**
|
|
555
|
+
*
|
|
556
|
+
* @type {string}
|
|
557
|
+
* @memberof V1ObservationSequenceResult
|
|
558
|
+
*/
|
|
559
|
+
'createdAt': string;
|
|
560
|
+
/**
|
|
561
|
+
*
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof V1ObservationSequenceResult
|
|
564
|
+
*/
|
|
565
|
+
'createdBy': string;
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
*
|
|
569
|
+
* @export
|
|
570
|
+
* @interface V1ObservationSequenceResultImageSetsInner
|
|
571
|
+
*/
|
|
572
|
+
export interface V1ObservationSequenceResultImageSetsInner {
|
|
573
|
+
/**
|
|
574
|
+
*
|
|
575
|
+
* @type {string}
|
|
576
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
577
|
+
*/
|
|
578
|
+
'id': string;
|
|
579
|
+
/**
|
|
580
|
+
*
|
|
581
|
+
* @type {string}
|
|
582
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
583
|
+
*/
|
|
584
|
+
'nodeId': string;
|
|
585
|
+
/**
|
|
586
|
+
* The covariance matrix of the image set RA and Dec platesolve offset average. This is a 2D array of doubles - rows of columns
|
|
587
|
+
* @type {Array<Array<number>>}
|
|
588
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
589
|
+
*/
|
|
590
|
+
'covariance': Array<Array<number>>;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {Array<ObservationResult>}
|
|
594
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
595
|
+
*/
|
|
596
|
+
'observationResults': Array<ObservationResult>;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* create an organization target
|
|
600
|
+
* @export
|
|
601
|
+
* @interface V1OrganizationTarget
|
|
602
|
+
*/
|
|
603
|
+
export interface V1OrganizationTarget {
|
|
604
|
+
/**
|
|
605
|
+
*
|
|
606
|
+
* @type {string}
|
|
607
|
+
* @memberof V1OrganizationTarget
|
|
608
|
+
*/
|
|
609
|
+
'satelliteTargetId': string;
|
|
610
|
+
}
|
|
611
|
+
/**
|
|
612
|
+
* v1SatelliteTarget
|
|
613
|
+
* @export
|
|
614
|
+
* @interface V1SatelliteTarget
|
|
615
|
+
*/
|
|
616
|
+
export interface V1SatelliteTarget {
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {string}
|
|
620
|
+
* @memberof V1SatelliteTarget
|
|
621
|
+
*/
|
|
622
|
+
'id': string;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {string}
|
|
626
|
+
* @memberof V1SatelliteTarget
|
|
627
|
+
*/
|
|
628
|
+
'cosparId'?: string;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {string}
|
|
632
|
+
* @memberof V1SatelliteTarget
|
|
633
|
+
*/
|
|
634
|
+
'noradId'?: string;
|
|
635
|
+
/**
|
|
636
|
+
*
|
|
637
|
+
* @type {OrbitType}
|
|
638
|
+
* @memberof V1SatelliteTarget
|
|
639
|
+
*/
|
|
640
|
+
'orbitType': OrbitType;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* v1Tdm
|
|
644
|
+
* @export
|
|
645
|
+
* @interface V1Tdm
|
|
646
|
+
*/
|
|
647
|
+
export interface V1Tdm {
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
* @type {string}
|
|
651
|
+
* @memberof V1Tdm
|
|
652
|
+
*/
|
|
653
|
+
'id': string;
|
|
654
|
+
/**
|
|
655
|
+
*
|
|
656
|
+
* @type {string}
|
|
657
|
+
* @memberof V1Tdm
|
|
658
|
+
*/
|
|
659
|
+
'targetId': string;
|
|
660
|
+
/**
|
|
661
|
+
*
|
|
662
|
+
* @type {Array<string>}
|
|
663
|
+
* @memberof V1Tdm
|
|
664
|
+
*/
|
|
665
|
+
'streaks': Array<string>;
|
|
666
|
+
/**
|
|
667
|
+
*
|
|
668
|
+
* @type {string}
|
|
669
|
+
* @memberof V1Tdm
|
|
670
|
+
*/
|
|
671
|
+
'assetUrl': string;
|
|
672
|
+
/**
|
|
673
|
+
*
|
|
674
|
+
* @type {string}
|
|
675
|
+
* @memberof V1Tdm
|
|
676
|
+
*/
|
|
677
|
+
'imageSetId': string;
|
|
678
|
+
/**
|
|
679
|
+
*
|
|
680
|
+
* @type {Array<string>}
|
|
681
|
+
* @memberof V1Tdm
|
|
682
|
+
*/
|
|
683
|
+
'imageUrls': Array<string>;
|
|
684
|
+
/**
|
|
685
|
+
*
|
|
686
|
+
* @type {string}
|
|
687
|
+
* @memberof V1Tdm
|
|
688
|
+
*/
|
|
689
|
+
'createdAt': string;
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
* @type {string}
|
|
693
|
+
* @memberof V1Tdm
|
|
694
|
+
*/
|
|
695
|
+
'createdBy': string;
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* update email configuration
|
|
699
|
+
* @export
|
|
700
|
+
* @interface V1UpdateEmailConfiguration
|
|
701
|
+
*/
|
|
702
|
+
export interface V1UpdateEmailConfiguration {
|
|
703
|
+
/**
|
|
704
|
+
*
|
|
705
|
+
* @type {Array<string>}
|
|
706
|
+
* @memberof V1UpdateEmailConfiguration
|
|
707
|
+
*/
|
|
708
|
+
'emails': Array<string>;
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* update webhook configuration body
|
|
712
|
+
* @export
|
|
713
|
+
* @interface V1UpdateWebhookConfiguration
|
|
714
|
+
*/
|
|
715
|
+
export interface V1UpdateWebhookConfiguration {
|
|
716
|
+
/**
|
|
717
|
+
*
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof V1UpdateWebhookConfiguration
|
|
720
|
+
*/
|
|
721
|
+
'url': string;
|
|
722
|
+
/**
|
|
723
|
+
*
|
|
724
|
+
* @type {string}
|
|
725
|
+
* @memberof V1UpdateWebhookConfiguration
|
|
726
|
+
*/
|
|
727
|
+
'secret': string;
|
|
728
|
+
/**
|
|
729
|
+
*
|
|
730
|
+
* @type {Array<WebhookEvent>}
|
|
731
|
+
* @memberof V1UpdateWebhookConfiguration
|
|
732
|
+
*/
|
|
733
|
+
'events': Array<WebhookEvent>;
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* webhook configuration
|
|
737
|
+
* @export
|
|
738
|
+
* @interface V1WebhookConfiguration
|
|
739
|
+
*/
|
|
740
|
+
export interface V1WebhookConfiguration {
|
|
741
|
+
/**
|
|
742
|
+
*
|
|
743
|
+
* @type {string}
|
|
744
|
+
* @memberof V1WebhookConfiguration
|
|
745
|
+
*/
|
|
746
|
+
'id': string;
|
|
747
|
+
/**
|
|
748
|
+
*
|
|
749
|
+
* @type {string}
|
|
750
|
+
* @memberof V1WebhookConfiguration
|
|
751
|
+
*/
|
|
752
|
+
'url': string;
|
|
753
|
+
/**
|
|
754
|
+
*
|
|
755
|
+
* @type {Array<WebhookEvent>}
|
|
756
|
+
* @memberof V1WebhookConfiguration
|
|
757
|
+
*/
|
|
758
|
+
'events': Array<WebhookEvent>;
|
|
759
|
+
/**
|
|
760
|
+
*
|
|
761
|
+
* @type {string}
|
|
762
|
+
* @memberof V1WebhookConfiguration
|
|
763
|
+
*/
|
|
764
|
+
'createdBy': string;
|
|
765
|
+
/**
|
|
766
|
+
*
|
|
767
|
+
* @type {string}
|
|
768
|
+
* @memberof V1WebhookConfiguration
|
|
769
|
+
*/
|
|
770
|
+
'createdAt': string;
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* webhook event types
|
|
774
|
+
* @export
|
|
775
|
+
* @enum {string}
|
|
776
|
+
*/
|
|
777
|
+
export declare const WebhookEvent: {
|
|
778
|
+
readonly TDM_CREATED: "V1_TDM_CREATED";
|
|
779
|
+
readonly OBSERVATION_SEQUENCE_RESULT_CREATED: "V1_OBSERVATION_SEQUENCE_RESULT_CREATED";
|
|
780
|
+
readonly OBSERVATION_CREATED: "V1_OBSERVATION_CREATED";
|
|
781
|
+
readonly IMAGE_CREATED: "V1_IMAGE_CREATED";
|
|
782
|
+
};
|
|
783
|
+
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
784
|
+
/**
|
|
785
|
+
* DefaultApi - axios parameter creator
|
|
786
|
+
* @export
|
|
787
|
+
*/
|
|
788
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
789
|
+
/**
|
|
790
|
+
* create an image set
|
|
791
|
+
* @param {V1CreateImageSet} v1CreateImageSet request to create the Image Set
|
|
792
|
+
* @param {*} [options] Override http request option.
|
|
793
|
+
* @throws {RequiredError}
|
|
794
|
+
*/
|
|
795
|
+
v1CreateImageSet: (v1CreateImageSet: V1CreateImageSet, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
796
|
+
/**
|
|
797
|
+
* create an image set image
|
|
798
|
+
* @param {V1CreateImageSetImage} v1CreateImageSetImage request to create an image set image
|
|
799
|
+
* @param {*} [options] Override http request option.
|
|
800
|
+
* @throws {RequiredError}
|
|
801
|
+
*/
|
|
802
|
+
v1CreateImageSetImage: (v1CreateImageSetImage: V1CreateImageSetImage, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
803
|
+
/**
|
|
804
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
805
|
+
* @param {V1OrganizationTarget} v1OrganizationTarget create organization target
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
v1CreateOrganizationTarget: (v1OrganizationTarget: V1OrganizationTarget, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
810
|
+
/**
|
|
811
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
812
|
+
* @param {V1UpdateWebhookConfiguration} v1UpdateWebhookConfiguration request to create an organization webhook
|
|
813
|
+
* @param {*} [options] Override http request option.
|
|
814
|
+
* @throws {RequiredError}
|
|
815
|
+
*/
|
|
816
|
+
v1CreateWebhookConfiguration: (v1UpdateWebhookConfiguration: V1UpdateWebhookConfiguration, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
817
|
+
/**
|
|
818
|
+
* delete an organization target
|
|
819
|
+
* @param {string} satelliteTargetId
|
|
820
|
+
* @param {*} [options] Override http request option.
|
|
821
|
+
* @throws {RequiredError}
|
|
822
|
+
*/
|
|
823
|
+
v1DeleteOrganizationTarget: (satelliteTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
824
|
+
/**
|
|
825
|
+
* Delete an existing webhook configuration
|
|
826
|
+
* @param {string} id webhook id
|
|
827
|
+
* @param {*} [options] Override http request option.
|
|
828
|
+
* @throws {RequiredError}
|
|
829
|
+
*/
|
|
830
|
+
v1DeleteWebhookConfiguration: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
831
|
+
/**
|
|
832
|
+
* get an image set
|
|
833
|
+
* @param {string} id
|
|
834
|
+
* @param {*} [options] Override http request option.
|
|
835
|
+
* @throws {RequiredError}
|
|
836
|
+
*/
|
|
837
|
+
v1GetImageSet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
838
|
+
/**
|
|
839
|
+
* get an image
|
|
840
|
+
* @param {string} imageId
|
|
841
|
+
* @param {*} [options] Override http request option.
|
|
842
|
+
* @throws {RequiredError}
|
|
843
|
+
*/
|
|
844
|
+
v1GetImageSetImage: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
845
|
+
/**
|
|
846
|
+
* get image set images
|
|
847
|
+
* @param {Array<string>} imageSets
|
|
848
|
+
* @param {*} [options] Override http request option.
|
|
849
|
+
* @throws {RequiredError}
|
|
850
|
+
*/
|
|
851
|
+
v1GetImageSetImages: (imageSets: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
852
|
+
/**
|
|
853
|
+
* get image sets for targets observed for your organization
|
|
854
|
+
* @param {*} [options] Override http request option.
|
|
855
|
+
* @throws {RequiredError}
|
|
856
|
+
*/
|
|
857
|
+
v1GetImageSets: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
858
|
+
/**
|
|
859
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
860
|
+
* @param {string} [targetId]
|
|
861
|
+
* @param {string} [after]
|
|
862
|
+
* @param {*} [options] Override http request option.
|
|
863
|
+
* @throws {RequiredError}
|
|
864
|
+
*/
|
|
865
|
+
v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
866
|
+
/**
|
|
867
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
868
|
+
* @param {*} [options] Override http request option.
|
|
869
|
+
* @throws {RequiredError}
|
|
870
|
+
*/
|
|
871
|
+
v1GetOrganizationTargets: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
872
|
+
/**
|
|
873
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
874
|
+
* @param {OrbitType} [orbitType] orbit type
|
|
875
|
+
* @param {string} [noradId] norad id
|
|
876
|
+
* @param {*} [options] Override http request option.
|
|
877
|
+
* @throws {RequiredError}
|
|
878
|
+
*/
|
|
879
|
+
v1GetSatelliteTargets: (orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
880
|
+
/**
|
|
881
|
+
* get tdm
|
|
882
|
+
* @param {string} tdmId
|
|
883
|
+
* @param {*} [options] Override http request option.
|
|
884
|
+
* @throws {RequiredError}
|
|
885
|
+
*/
|
|
886
|
+
v1GetTdm: (tdmId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
887
|
+
/**
|
|
888
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
889
|
+
* @param {string} [targetId]
|
|
890
|
+
* @param {string} [after]
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
v1GetTdms: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
895
|
+
/**
|
|
896
|
+
* Get the currently configured webhooks
|
|
897
|
+
* @param {*} [options] Override http request option.
|
|
898
|
+
* @throws {RequiredError}
|
|
899
|
+
*/
|
|
900
|
+
v1GetWebhookConfigurations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
901
|
+
/**
|
|
902
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
903
|
+
* @param {V1UpdateEmailConfiguration} v1UpdateEmailConfiguration request to update an organization email preference
|
|
904
|
+
* @param {*} [options] Override http request option.
|
|
905
|
+
* @throws {RequiredError}
|
|
906
|
+
*/
|
|
907
|
+
v1UpdateEmailConfiguration: (v1UpdateEmailConfiguration: V1UpdateEmailConfiguration, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* DefaultApi - functional programming interface
|
|
911
|
+
* @export
|
|
912
|
+
*/
|
|
913
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
914
|
+
/**
|
|
915
|
+
* create an image set
|
|
916
|
+
* @param {V1CreateImageSet} v1CreateImageSet request to create the Image Set
|
|
917
|
+
* @param {*} [options] Override http request option.
|
|
918
|
+
* @throws {RequiredError}
|
|
919
|
+
*/
|
|
920
|
+
v1CreateImageSet(v1CreateImageSet: V1CreateImageSet, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
921
|
+
/**
|
|
922
|
+
* create an image set image
|
|
923
|
+
* @param {V1CreateImageSetImage} v1CreateImageSetImage request to create an image set image
|
|
924
|
+
* @param {*} [options] Override http request option.
|
|
925
|
+
* @throws {RequiredError}
|
|
926
|
+
*/
|
|
927
|
+
v1CreateImageSetImage(v1CreateImageSetImage: V1CreateImageSetImage, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1CreateImageSetImageResponse>>;
|
|
928
|
+
/**
|
|
929
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
930
|
+
* @param {V1OrganizationTarget} v1OrganizationTarget create organization target
|
|
931
|
+
* @param {*} [options] Override http request option.
|
|
932
|
+
* @throws {RequiredError}
|
|
933
|
+
*/
|
|
934
|
+
v1CreateOrganizationTarget(v1OrganizationTarget: V1OrganizationTarget, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
935
|
+
/**
|
|
936
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
937
|
+
* @param {V1UpdateWebhookConfiguration} v1UpdateWebhookConfiguration request to create an organization webhook
|
|
938
|
+
* @param {*} [options] Override http request option.
|
|
939
|
+
* @throws {RequiredError}
|
|
940
|
+
*/
|
|
941
|
+
v1CreateWebhookConfiguration(v1UpdateWebhookConfiguration: V1UpdateWebhookConfiguration, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
942
|
+
/**
|
|
943
|
+
* delete an organization target
|
|
944
|
+
* @param {string} satelliteTargetId
|
|
945
|
+
* @param {*} [options] Override http request option.
|
|
946
|
+
* @throws {RequiredError}
|
|
947
|
+
*/
|
|
948
|
+
v1DeleteOrganizationTarget(satelliteTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
949
|
+
/**
|
|
950
|
+
* Delete an existing webhook configuration
|
|
951
|
+
* @param {string} id webhook id
|
|
952
|
+
* @param {*} [options] Override http request option.
|
|
953
|
+
* @throws {RequiredError}
|
|
954
|
+
*/
|
|
955
|
+
v1DeleteWebhookConfiguration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
956
|
+
/**
|
|
957
|
+
* get an image set
|
|
958
|
+
* @param {string} id
|
|
959
|
+
* @param {*} [options] Override http request option.
|
|
960
|
+
* @throws {RequiredError}
|
|
961
|
+
*/
|
|
962
|
+
v1GetImageSet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageSet>>;
|
|
963
|
+
/**
|
|
964
|
+
* get an image
|
|
965
|
+
* @param {string} imageId
|
|
966
|
+
* @param {*} [options] Override http request option.
|
|
967
|
+
* @throws {RequiredError}
|
|
968
|
+
*/
|
|
969
|
+
v1GetImageSetImage(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageSetImage>>;
|
|
970
|
+
/**
|
|
971
|
+
* get image set images
|
|
972
|
+
* @param {Array<string>} imageSets
|
|
973
|
+
* @param {*} [options] Override http request option.
|
|
974
|
+
* @throws {RequiredError}
|
|
975
|
+
*/
|
|
976
|
+
v1GetImageSetImages(imageSets: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ImageSetImage>>>;
|
|
977
|
+
/**
|
|
978
|
+
* get image sets for targets observed for your organization
|
|
979
|
+
* @param {*} [options] Override http request option.
|
|
980
|
+
* @throws {RequiredError}
|
|
981
|
+
*/
|
|
982
|
+
v1GetImageSets(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ImageSet>>>;
|
|
983
|
+
/**
|
|
984
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
985
|
+
* @param {string} [targetId]
|
|
986
|
+
* @param {string} [after]
|
|
987
|
+
* @param {*} [options] Override http request option.
|
|
988
|
+
* @throws {RequiredError}
|
|
989
|
+
*/
|
|
990
|
+
v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
|
|
991
|
+
/**
|
|
992
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
993
|
+
* @param {*} [options] Override http request option.
|
|
994
|
+
* @throws {RequiredError}
|
|
995
|
+
*/
|
|
996
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1GetOrganizationTarget>>>;
|
|
997
|
+
/**
|
|
998
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
999
|
+
* @param {OrbitType} [orbitType] orbit type
|
|
1000
|
+
* @param {string} [noradId] norad id
|
|
1001
|
+
* @param {*} [options] Override http request option.
|
|
1002
|
+
* @throws {RequiredError}
|
|
1003
|
+
*/
|
|
1004
|
+
v1GetSatelliteTargets(orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetSatelliteTargets>>;
|
|
1005
|
+
/**
|
|
1006
|
+
* get tdm
|
|
1007
|
+
* @param {string} tdmId
|
|
1008
|
+
* @param {*} [options] Override http request option.
|
|
1009
|
+
* @throws {RequiredError}
|
|
1010
|
+
*/
|
|
1011
|
+
v1GetTdm(tdmId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1Tdm>>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1014
|
+
* @param {string} [targetId]
|
|
1015
|
+
* @param {string} [after]
|
|
1016
|
+
* @param {*} [options] Override http request option.
|
|
1017
|
+
* @throws {RequiredError}
|
|
1018
|
+
*/
|
|
1019
|
+
v1GetTdms(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1Tdm>>>;
|
|
1020
|
+
/**
|
|
1021
|
+
* Get the currently configured webhooks
|
|
1022
|
+
* @param {*} [options] Override http request option.
|
|
1023
|
+
* @throws {RequiredError}
|
|
1024
|
+
*/
|
|
1025
|
+
v1GetWebhookConfigurations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1WebhookConfiguration>>>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
1028
|
+
* @param {V1UpdateEmailConfiguration} v1UpdateEmailConfiguration request to update an organization email preference
|
|
1029
|
+
* @param {*} [options] Override http request option.
|
|
1030
|
+
* @throws {RequiredError}
|
|
1031
|
+
*/
|
|
1032
|
+
v1UpdateEmailConfiguration(v1UpdateEmailConfiguration: V1UpdateEmailConfiguration, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1033
|
+
};
|
|
1034
|
+
/**
|
|
1035
|
+
* DefaultApi - factory interface
|
|
1036
|
+
* @export
|
|
1037
|
+
*/
|
|
1038
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1039
|
+
/**
|
|
1040
|
+
* create an image set
|
|
1041
|
+
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @throws {RequiredError}
|
|
1044
|
+
*/
|
|
1045
|
+
v1CreateImageSet(requestParameters: DefaultApiV1CreateImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1046
|
+
/**
|
|
1047
|
+
* create an image set image
|
|
1048
|
+
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
1049
|
+
* @param {*} [options] Override http request option.
|
|
1050
|
+
* @throws {RequiredError}
|
|
1051
|
+
*/
|
|
1052
|
+
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1CreateImageSetImageResponse>;
|
|
1053
|
+
/**
|
|
1054
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
1055
|
+
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
1056
|
+
* @param {*} [options] Override http request option.
|
|
1057
|
+
* @throws {RequiredError}
|
|
1058
|
+
*/
|
|
1059
|
+
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
1062
|
+
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1063
|
+
* @param {*} [options] Override http request option.
|
|
1064
|
+
* @throws {RequiredError}
|
|
1065
|
+
*/
|
|
1066
|
+
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1067
|
+
/**
|
|
1068
|
+
* delete an organization target
|
|
1069
|
+
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
1070
|
+
* @param {*} [options] Override http request option.
|
|
1071
|
+
* @throws {RequiredError}
|
|
1072
|
+
*/
|
|
1073
|
+
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1074
|
+
/**
|
|
1075
|
+
* Delete an existing webhook configuration
|
|
1076
|
+
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1077
|
+
* @param {*} [options] Override http request option.
|
|
1078
|
+
* @throws {RequiredError}
|
|
1079
|
+
*/
|
|
1080
|
+
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1081
|
+
/**
|
|
1082
|
+
* get an image set
|
|
1083
|
+
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
1084
|
+
* @param {*} [options] Override http request option.
|
|
1085
|
+
* @throws {RequiredError}
|
|
1086
|
+
*/
|
|
1087
|
+
v1GetImageSet(requestParameters: DefaultApiV1GetImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageSet>;
|
|
1088
|
+
/**
|
|
1089
|
+
* get an image
|
|
1090
|
+
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
1091
|
+
* @param {*} [options] Override http request option.
|
|
1092
|
+
* @throws {RequiredError}
|
|
1093
|
+
*/
|
|
1094
|
+
v1GetImageSetImage(requestParameters: DefaultApiV1GetImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageSetImage>;
|
|
1095
|
+
/**
|
|
1096
|
+
* get image set images
|
|
1097
|
+
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
1098
|
+
* @param {*} [options] Override http request option.
|
|
1099
|
+
* @throws {RequiredError}
|
|
1100
|
+
*/
|
|
1101
|
+
v1GetImageSetImages(requestParameters: DefaultApiV1GetImageSetImagesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ImageSetImage>>;
|
|
1102
|
+
/**
|
|
1103
|
+
* get image sets for targets observed for your organization
|
|
1104
|
+
* @param {*} [options] Override http request option.
|
|
1105
|
+
* @throws {RequiredError}
|
|
1106
|
+
*/
|
|
1107
|
+
v1GetImageSets(options?: AxiosRequestConfig): AxiosPromise<Array<V1ImageSet>>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1110
|
+
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
1111
|
+
* @param {*} [options] Override http request option.
|
|
1112
|
+
* @throws {RequiredError}
|
|
1113
|
+
*/
|
|
1114
|
+
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
|
|
1115
|
+
/**
|
|
1116
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
1117
|
+
* @param {*} [options] Override http request option.
|
|
1118
|
+
* @throws {RequiredError}
|
|
1119
|
+
*/
|
|
1120
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): AxiosPromise<Array<V1GetOrganizationTarget>>;
|
|
1121
|
+
/**
|
|
1122
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
1123
|
+
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
1124
|
+
* @param {*} [options] Override http request option.
|
|
1125
|
+
* @throws {RequiredError}
|
|
1126
|
+
*/
|
|
1127
|
+
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargets>;
|
|
1128
|
+
/**
|
|
1129
|
+
* get tdm
|
|
1130
|
+
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1131
|
+
* @param {*} [options] Override http request option.
|
|
1132
|
+
* @throws {RequiredError}
|
|
1133
|
+
*/
|
|
1134
|
+
v1GetTdm(requestParameters: DefaultApiV1GetTdmRequest, options?: AxiosRequestConfig): AxiosPromise<V1Tdm>;
|
|
1135
|
+
/**
|
|
1136
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1137
|
+
* @param {DefaultApiV1GetTdmsRequest} requestParameters Request parameters.
|
|
1138
|
+
* @param {*} [options] Override http request option.
|
|
1139
|
+
* @throws {RequiredError}
|
|
1140
|
+
*/
|
|
1141
|
+
v1GetTdms(requestParameters?: DefaultApiV1GetTdmsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1Tdm>>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Get the currently configured webhooks
|
|
1144
|
+
* @param {*} [options] Override http request option.
|
|
1145
|
+
* @throws {RequiredError}
|
|
1146
|
+
*/
|
|
1147
|
+
v1GetWebhookConfigurations(options?: AxiosRequestConfig): AxiosPromise<Array<V1WebhookConfiguration>>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
1150
|
+
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
1151
|
+
* @param {*} [options] Override http request option.
|
|
1152
|
+
* @throws {RequiredError}
|
|
1153
|
+
*/
|
|
1154
|
+
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1155
|
+
};
|
|
1156
|
+
/**
|
|
1157
|
+
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
1158
|
+
* @export
|
|
1159
|
+
* @interface DefaultApiV1CreateImageSetRequest
|
|
1160
|
+
*/
|
|
1161
|
+
export interface DefaultApiV1CreateImageSetRequest {
|
|
1162
|
+
/**
|
|
1163
|
+
* request to create the Image Set
|
|
1164
|
+
* @type {V1CreateImageSet}
|
|
1165
|
+
* @memberof DefaultApiV1CreateImageSet
|
|
1166
|
+
*/
|
|
1167
|
+
readonly v1CreateImageSet: V1CreateImageSet;
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* Request parameters for v1CreateImageSetImage operation in DefaultApi.
|
|
1171
|
+
* @export
|
|
1172
|
+
* @interface DefaultApiV1CreateImageSetImageRequest
|
|
1173
|
+
*/
|
|
1174
|
+
export interface DefaultApiV1CreateImageSetImageRequest {
|
|
1175
|
+
/**
|
|
1176
|
+
* request to create an image set image
|
|
1177
|
+
* @type {V1CreateImageSetImage}
|
|
1178
|
+
* @memberof DefaultApiV1CreateImageSetImage
|
|
1179
|
+
*/
|
|
1180
|
+
readonly v1CreateImageSetImage: V1CreateImageSetImage;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* Request parameters for v1CreateOrganizationTarget operation in DefaultApi.
|
|
1184
|
+
* @export
|
|
1185
|
+
* @interface DefaultApiV1CreateOrganizationTargetRequest
|
|
1186
|
+
*/
|
|
1187
|
+
export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
1188
|
+
/**
|
|
1189
|
+
* create organization target
|
|
1190
|
+
* @type {V1OrganizationTarget}
|
|
1191
|
+
* @memberof DefaultApiV1CreateOrganizationTarget
|
|
1192
|
+
*/
|
|
1193
|
+
readonly v1OrganizationTarget: V1OrganizationTarget;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface DefaultApiV1CreateWebhookConfigurationRequest
|
|
1199
|
+
*/
|
|
1200
|
+
export interface DefaultApiV1CreateWebhookConfigurationRequest {
|
|
1201
|
+
/**
|
|
1202
|
+
* request to create an organization webhook
|
|
1203
|
+
* @type {V1UpdateWebhookConfiguration}
|
|
1204
|
+
* @memberof DefaultApiV1CreateWebhookConfiguration
|
|
1205
|
+
*/
|
|
1206
|
+
readonly v1UpdateWebhookConfiguration: V1UpdateWebhookConfiguration;
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Request parameters for v1DeleteOrganizationTarget operation in DefaultApi.
|
|
1210
|
+
* @export
|
|
1211
|
+
* @interface DefaultApiV1DeleteOrganizationTargetRequest
|
|
1212
|
+
*/
|
|
1213
|
+
export interface DefaultApiV1DeleteOrganizationTargetRequest {
|
|
1214
|
+
/**
|
|
1215
|
+
*
|
|
1216
|
+
* @type {string}
|
|
1217
|
+
* @memberof DefaultApiV1DeleteOrganizationTarget
|
|
1218
|
+
*/
|
|
1219
|
+
readonly satelliteTargetId: string;
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
* Request parameters for v1DeleteWebhookConfiguration operation in DefaultApi.
|
|
1223
|
+
* @export
|
|
1224
|
+
* @interface DefaultApiV1DeleteWebhookConfigurationRequest
|
|
1225
|
+
*/
|
|
1226
|
+
export interface DefaultApiV1DeleteWebhookConfigurationRequest {
|
|
1227
|
+
/**
|
|
1228
|
+
* webhook id
|
|
1229
|
+
* @type {string}
|
|
1230
|
+
* @memberof DefaultApiV1DeleteWebhookConfiguration
|
|
1231
|
+
*/
|
|
1232
|
+
readonly id: string;
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* Request parameters for v1GetImageSet operation in DefaultApi.
|
|
1236
|
+
* @export
|
|
1237
|
+
* @interface DefaultApiV1GetImageSetRequest
|
|
1238
|
+
*/
|
|
1239
|
+
export interface DefaultApiV1GetImageSetRequest {
|
|
1240
|
+
/**
|
|
1241
|
+
*
|
|
1242
|
+
* @type {string}
|
|
1243
|
+
* @memberof DefaultApiV1GetImageSet
|
|
1244
|
+
*/
|
|
1245
|
+
readonly id: string;
|
|
1246
|
+
}
|
|
1247
|
+
/**
|
|
1248
|
+
* Request parameters for v1GetImageSetImage operation in DefaultApi.
|
|
1249
|
+
* @export
|
|
1250
|
+
* @interface DefaultApiV1GetImageSetImageRequest
|
|
1251
|
+
*/
|
|
1252
|
+
export interface DefaultApiV1GetImageSetImageRequest {
|
|
1253
|
+
/**
|
|
1254
|
+
*
|
|
1255
|
+
* @type {string}
|
|
1256
|
+
* @memberof DefaultApiV1GetImageSetImage
|
|
1257
|
+
*/
|
|
1258
|
+
readonly imageId: string;
|
|
1259
|
+
}
|
|
1260
|
+
/**
|
|
1261
|
+
* Request parameters for v1GetImageSetImages operation in DefaultApi.
|
|
1262
|
+
* @export
|
|
1263
|
+
* @interface DefaultApiV1GetImageSetImagesRequest
|
|
1264
|
+
*/
|
|
1265
|
+
export interface DefaultApiV1GetImageSetImagesRequest {
|
|
1266
|
+
/**
|
|
1267
|
+
*
|
|
1268
|
+
* @type {Array<string>}
|
|
1269
|
+
* @memberof DefaultApiV1GetImageSetImages
|
|
1270
|
+
*/
|
|
1271
|
+
readonly imageSets: Array<string>;
|
|
1272
|
+
}
|
|
1273
|
+
/**
|
|
1274
|
+
* Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
|
|
1275
|
+
* @export
|
|
1276
|
+
* @interface DefaultApiV1GetObservationSequenceResultsRequest
|
|
1277
|
+
*/
|
|
1278
|
+
export interface DefaultApiV1GetObservationSequenceResultsRequest {
|
|
1279
|
+
/**
|
|
1280
|
+
*
|
|
1281
|
+
* @type {string}
|
|
1282
|
+
* @memberof DefaultApiV1GetObservationSequenceResults
|
|
1283
|
+
*/
|
|
1284
|
+
readonly targetId?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
*
|
|
1287
|
+
* @type {string}
|
|
1288
|
+
* @memberof DefaultApiV1GetObservationSequenceResults
|
|
1289
|
+
*/
|
|
1290
|
+
readonly after?: string;
|
|
1291
|
+
}
|
|
1292
|
+
/**
|
|
1293
|
+
* Request parameters for v1GetSatelliteTargets operation in DefaultApi.
|
|
1294
|
+
* @export
|
|
1295
|
+
* @interface DefaultApiV1GetSatelliteTargetsRequest
|
|
1296
|
+
*/
|
|
1297
|
+
export interface DefaultApiV1GetSatelliteTargetsRequest {
|
|
1298
|
+
/**
|
|
1299
|
+
* orbit type
|
|
1300
|
+
* @type {OrbitType}
|
|
1301
|
+
* @memberof DefaultApiV1GetSatelliteTargets
|
|
1302
|
+
*/
|
|
1303
|
+
readonly orbitType?: OrbitType;
|
|
1304
|
+
/**
|
|
1305
|
+
* norad id
|
|
1306
|
+
* @type {string}
|
|
1307
|
+
* @memberof DefaultApiV1GetSatelliteTargets
|
|
1308
|
+
*/
|
|
1309
|
+
readonly noradId?: string;
|
|
1310
|
+
}
|
|
1311
|
+
/**
|
|
1312
|
+
* Request parameters for v1GetTdm operation in DefaultApi.
|
|
1313
|
+
* @export
|
|
1314
|
+
* @interface DefaultApiV1GetTdmRequest
|
|
1315
|
+
*/
|
|
1316
|
+
export interface DefaultApiV1GetTdmRequest {
|
|
1317
|
+
/**
|
|
1318
|
+
*
|
|
1319
|
+
* @type {string}
|
|
1320
|
+
* @memberof DefaultApiV1GetTdm
|
|
1321
|
+
*/
|
|
1322
|
+
readonly tdmId: string;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* Request parameters for v1GetTdms operation in DefaultApi.
|
|
1326
|
+
* @export
|
|
1327
|
+
* @interface DefaultApiV1GetTdmsRequest
|
|
1328
|
+
*/
|
|
1329
|
+
export interface DefaultApiV1GetTdmsRequest {
|
|
1330
|
+
/**
|
|
1331
|
+
*
|
|
1332
|
+
* @type {string}
|
|
1333
|
+
* @memberof DefaultApiV1GetTdms
|
|
1334
|
+
*/
|
|
1335
|
+
readonly targetId?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
*
|
|
1338
|
+
* @type {string}
|
|
1339
|
+
* @memberof DefaultApiV1GetTdms
|
|
1340
|
+
*/
|
|
1341
|
+
readonly after?: string;
|
|
1342
|
+
}
|
|
1343
|
+
/**
|
|
1344
|
+
* Request parameters for v1UpdateEmailConfiguration operation in DefaultApi.
|
|
1345
|
+
* @export
|
|
1346
|
+
* @interface DefaultApiV1UpdateEmailConfigurationRequest
|
|
1347
|
+
*/
|
|
1348
|
+
export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
1349
|
+
/**
|
|
1350
|
+
* request to update an organization email preference
|
|
1351
|
+
* @type {V1UpdateEmailConfiguration}
|
|
1352
|
+
* @memberof DefaultApiV1UpdateEmailConfiguration
|
|
1353
|
+
*/
|
|
1354
|
+
readonly v1UpdateEmailConfiguration: V1UpdateEmailConfiguration;
|
|
1355
|
+
}
|
|
1356
|
+
/**
|
|
1357
|
+
* DefaultApi - object-oriented interface
|
|
1358
|
+
* @export
|
|
1359
|
+
* @class DefaultApi
|
|
1360
|
+
* @extends {BaseAPI}
|
|
1361
|
+
*/
|
|
1362
|
+
export declare class DefaultApi extends BaseAPI {
|
|
1363
|
+
/**
|
|
1364
|
+
* create an image set
|
|
1365
|
+
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
1366
|
+
* @param {*} [options] Override http request option.
|
|
1367
|
+
* @throws {RequiredError}
|
|
1368
|
+
* @memberof DefaultApi
|
|
1369
|
+
*/
|
|
1370
|
+
v1CreateImageSet(requestParameters: DefaultApiV1CreateImageSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1371
|
+
/**
|
|
1372
|
+
* create an image set image
|
|
1373
|
+
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
1374
|
+
* @param {*} [options] Override http request option.
|
|
1375
|
+
* @throws {RequiredError}
|
|
1376
|
+
* @memberof DefaultApi
|
|
1377
|
+
*/
|
|
1378
|
+
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1CreateImageSetImageResponse, any>>;
|
|
1379
|
+
/**
|
|
1380
|
+
* Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#default/v1GetSatelliteTargets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
|
|
1381
|
+
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
1382
|
+
* @param {*} [options] Override http request option.
|
|
1383
|
+
* @throws {RequiredError}
|
|
1384
|
+
* @memberof DefaultApi
|
|
1385
|
+
*/
|
|
1386
|
+
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1387
|
+
/**
|
|
1388
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"X-OurSky-Signature\" which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded.
|
|
1389
|
+
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1390
|
+
* @param {*} [options] Override http request option.
|
|
1391
|
+
* @throws {RequiredError}
|
|
1392
|
+
* @memberof DefaultApi
|
|
1393
|
+
*/
|
|
1394
|
+
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1395
|
+
/**
|
|
1396
|
+
* delete an organization target
|
|
1397
|
+
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
1398
|
+
* @param {*} [options] Override http request option.
|
|
1399
|
+
* @throws {RequiredError}
|
|
1400
|
+
* @memberof DefaultApi
|
|
1401
|
+
*/
|
|
1402
|
+
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1403
|
+
/**
|
|
1404
|
+
* Delete an existing webhook configuration
|
|
1405
|
+
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1406
|
+
* @param {*} [options] Override http request option.
|
|
1407
|
+
* @throws {RequiredError}
|
|
1408
|
+
* @memberof DefaultApi
|
|
1409
|
+
*/
|
|
1410
|
+
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1411
|
+
/**
|
|
1412
|
+
* get an image set
|
|
1413
|
+
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
1414
|
+
* @param {*} [options] Override http request option.
|
|
1415
|
+
* @throws {RequiredError}
|
|
1416
|
+
* @memberof DefaultApi
|
|
1417
|
+
*/
|
|
1418
|
+
v1GetImageSet(requestParameters: DefaultApiV1GetImageSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSet, any>>;
|
|
1419
|
+
/**
|
|
1420
|
+
* get an image
|
|
1421
|
+
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
1422
|
+
* @param {*} [options] Override http request option.
|
|
1423
|
+
* @throws {RequiredError}
|
|
1424
|
+
* @memberof DefaultApi
|
|
1425
|
+
*/
|
|
1426
|
+
v1GetImageSetImage(requestParameters: DefaultApiV1GetImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSetImage, any>>;
|
|
1427
|
+
/**
|
|
1428
|
+
* get image set images
|
|
1429
|
+
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
1430
|
+
* @param {*} [options] Override http request option.
|
|
1431
|
+
* @throws {RequiredError}
|
|
1432
|
+
* @memberof DefaultApi
|
|
1433
|
+
*/
|
|
1434
|
+
v1GetImageSetImages(requestParameters: DefaultApiV1GetImageSetImagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSetImage[], any>>;
|
|
1435
|
+
/**
|
|
1436
|
+
* get image sets for targets observed for your organization
|
|
1437
|
+
* @param {*} [options] Override http request option.
|
|
1438
|
+
* @throws {RequiredError}
|
|
1439
|
+
* @memberof DefaultApi
|
|
1440
|
+
*/
|
|
1441
|
+
v1GetImageSets(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSet[], any>>;
|
|
1442
|
+
/**
|
|
1443
|
+
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1444
|
+
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
1445
|
+
* @param {*} [options] Override http request option.
|
|
1446
|
+
* @throws {RequiredError}
|
|
1447
|
+
* @memberof DefaultApi
|
|
1448
|
+
*/
|
|
1449
|
+
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
|
|
1450
|
+
/**
|
|
1451
|
+
* get organization targets see the [create](#default/v1CreateOrganizationTarget) endpoint for more details
|
|
1452
|
+
* @param {*} [options] Override http request option.
|
|
1453
|
+
* @throws {RequiredError}
|
|
1454
|
+
* @memberof DefaultApi
|
|
1455
|
+
*/
|
|
1456
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GetOrganizationTarget[], any>>;
|
|
1457
|
+
/**
|
|
1458
|
+
* The available satellite objects that the OurSky platform can currently track.
|
|
1459
|
+
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
1460
|
+
* @param {*} [options] Override http request option.
|
|
1461
|
+
* @throws {RequiredError}
|
|
1462
|
+
* @memberof DefaultApi
|
|
1463
|
+
*/
|
|
1464
|
+
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GetSatelliteTargets, any>>;
|
|
1465
|
+
/**
|
|
1466
|
+
* get tdm
|
|
1467
|
+
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1468
|
+
* @param {*} [options] Override http request option.
|
|
1469
|
+
* @throws {RequiredError}
|
|
1470
|
+
* @memberof DefaultApi
|
|
1471
|
+
*/
|
|
1472
|
+
v1GetTdm(requestParameters: DefaultApiV1GetTdmRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Tdm, any>>;
|
|
1473
|
+
/**
|
|
1474
|
+
* Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1475
|
+
* @param {DefaultApiV1GetTdmsRequest} requestParameters Request parameters.
|
|
1476
|
+
* @param {*} [options] Override http request option.
|
|
1477
|
+
* @throws {RequiredError}
|
|
1478
|
+
* @memberof DefaultApi
|
|
1479
|
+
*/
|
|
1480
|
+
v1GetTdms(requestParameters?: DefaultApiV1GetTdmsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Tdm[], any>>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Get the currently configured webhooks
|
|
1483
|
+
* @param {*} [options] Override http request option.
|
|
1484
|
+
* @throws {RequiredError}
|
|
1485
|
+
* @memberof DefaultApi
|
|
1486
|
+
*/
|
|
1487
|
+
v1GetWebhookConfigurations(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1WebhookConfiguration[], any>>;
|
|
1488
|
+
/**
|
|
1489
|
+
* Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
|
|
1490
|
+
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
1491
|
+
* @param {*} [options] Override http request option.
|
|
1492
|
+
* @throws {RequiredError}
|
|
1493
|
+
* @memberof DefaultApi
|
|
1494
|
+
*/
|
|
1495
|
+
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1496
|
+
}
|