@ourskyai/sda-api 1.3.1734 → 1.3.1767
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 +212 -219
- package/base.ts +3 -3
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +182 -189
- package/dist/api.js +109 -109
- package/dist/base.d.ts +2 -2
- package/dist/base.js +3 -3
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +182 -189
- package/dist/esm/api.js +109 -109
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
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](#operation/v1GetSatelliteTargets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#operation/v1CreateOrganizationTarget) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#operation/v1CreateWebhookConfiguration) endpoint to receive TDMs automatically (preferred) or use the [tdms](#operation/v1GetTdms) 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.1767
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -57,7 +57,7 @@ export interface AstrometricOffsets {
|
|
|
57
57
|
'fwhmAverage': number;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
*
|
|
61
61
|
* @export
|
|
62
62
|
* @interface EmptySuccess
|
|
63
63
|
*/
|
|
@@ -145,7 +145,7 @@ export interface ObservationResult {
|
|
|
145
145
|
'apparentMagnitude'?: number;
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
*
|
|
148
|
+
*
|
|
149
149
|
* @export
|
|
150
150
|
* @enum {string}
|
|
151
151
|
*/
|
|
@@ -161,7 +161,7 @@ export declare const OrbitType: {
|
|
|
161
161
|
};
|
|
162
162
|
export type OrbitType = typeof OrbitType[keyof typeof OrbitType];
|
|
163
163
|
/**
|
|
164
|
-
*
|
|
164
|
+
*
|
|
165
165
|
* @export
|
|
166
166
|
* @interface SuccessfulCreate
|
|
167
167
|
*/
|
|
@@ -174,7 +174,7 @@ export interface SuccessfulCreate {
|
|
|
174
174
|
'id': string;
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
*
|
|
178
178
|
* @export
|
|
179
179
|
* @enum {string}
|
|
180
180
|
*/
|
|
@@ -184,64 +184,20 @@ export declare const TrackingType: {
|
|
|
184
184
|
};
|
|
185
185
|
export type TrackingType = typeof TrackingType[keyof typeof TrackingType];
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
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
|
|
187
|
+
*
|
|
232
188
|
* @export
|
|
233
|
-
* @interface
|
|
189
|
+
* @interface V1CreateImageSetImageRequest
|
|
234
190
|
*/
|
|
235
|
-
export interface
|
|
191
|
+
export interface V1CreateImageSetImageRequest {
|
|
236
192
|
/**
|
|
237
193
|
*
|
|
238
194
|
* @type {string}
|
|
239
|
-
* @memberof
|
|
195
|
+
* @memberof V1CreateImageSetImageRequest
|
|
240
196
|
*/
|
|
241
197
|
'imageSetId': string;
|
|
242
198
|
}
|
|
243
199
|
/**
|
|
244
|
-
*
|
|
200
|
+
*
|
|
245
201
|
* @export
|
|
246
202
|
* @interface V1CreateImageSetImageResponse
|
|
247
203
|
*/
|
|
@@ -262,49 +218,68 @@ export interface V1CreateImageSetImageResponse {
|
|
|
262
218
|
/**
|
|
263
219
|
*
|
|
264
220
|
* @export
|
|
265
|
-
* @interface
|
|
221
|
+
* @interface V1CreateImageSetRequest
|
|
266
222
|
*/
|
|
267
|
-
export interface
|
|
223
|
+
export interface V1CreateImageSetRequest {
|
|
268
224
|
/**
|
|
269
225
|
*
|
|
270
226
|
* @type {string}
|
|
271
|
-
* @memberof
|
|
227
|
+
* @memberof V1CreateImageSetRequest
|
|
272
228
|
*/
|
|
273
|
-
'
|
|
229
|
+
'targetId': string;
|
|
274
230
|
/**
|
|
275
231
|
*
|
|
276
|
-
* @type {
|
|
277
|
-
* @memberof
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof V1CreateImageSetRequest
|
|
278
234
|
*/
|
|
279
|
-
'
|
|
235
|
+
'nodeId': string;
|
|
280
236
|
/**
|
|
281
237
|
*
|
|
282
238
|
* @type {string}
|
|
283
|
-
* @memberof
|
|
239
|
+
* @memberof V1CreateImageSetRequest
|
|
284
240
|
*/
|
|
285
|
-
'
|
|
241
|
+
'observationId'?: string;
|
|
242
|
+
/**
|
|
243
|
+
*
|
|
244
|
+
* @type {TrackingType}
|
|
245
|
+
* @memberof V1CreateImageSetRequest
|
|
246
|
+
*/
|
|
247
|
+
'trackingType'?: TrackingType;
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {FilterType}
|
|
251
|
+
* @memberof V1CreateImageSetRequest
|
|
252
|
+
*/
|
|
253
|
+
'filterType'?: FilterType;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
*
|
|
257
|
+
* @export
|
|
258
|
+
* @interface V1CreateOrganizationTargetRequest
|
|
259
|
+
*/
|
|
260
|
+
export interface V1CreateOrganizationTargetRequest {
|
|
286
261
|
/**
|
|
287
262
|
*
|
|
288
263
|
* @type {string}
|
|
289
|
-
* @memberof
|
|
264
|
+
* @memberof V1CreateOrganizationTargetRequest
|
|
290
265
|
*/
|
|
291
|
-
'
|
|
266
|
+
'satelliteTargetId': string;
|
|
292
267
|
}
|
|
293
268
|
/**
|
|
294
|
-
*
|
|
269
|
+
*
|
|
295
270
|
* @export
|
|
296
|
-
* @interface
|
|
271
|
+
* @interface V1GetSatelliteTargetsResponse
|
|
297
272
|
*/
|
|
298
|
-
export interface
|
|
273
|
+
export interface V1GetSatelliteTargetsResponse {
|
|
299
274
|
/**
|
|
300
275
|
*
|
|
301
276
|
* @type {Array<V1SatelliteTarget>}
|
|
302
|
-
* @memberof
|
|
277
|
+
* @memberof V1GetSatelliteTargetsResponse
|
|
303
278
|
*/
|
|
304
279
|
'targets': Array<V1SatelliteTarget>;
|
|
305
280
|
}
|
|
306
281
|
/**
|
|
307
|
-
*
|
|
282
|
+
* An image set represents a contiguous set of observations of the same target captured by the same node.
|
|
308
283
|
* @export
|
|
309
284
|
* @interface V1ImageSet
|
|
310
285
|
*/
|
|
@@ -377,7 +352,7 @@ export interface V1ImageSet {
|
|
|
377
352
|
'ourskyPluginVersion'?: string;
|
|
378
353
|
}
|
|
379
354
|
/**
|
|
380
|
-
*
|
|
355
|
+
* Image Set Image
|
|
381
356
|
* @export
|
|
382
357
|
* @interface V1ImageSetImage
|
|
383
358
|
*/
|
|
@@ -522,7 +497,7 @@ export interface V1ImageSetImage {
|
|
|
522
497
|
'exposureLength': number;
|
|
523
498
|
}
|
|
524
499
|
/**
|
|
525
|
-
*
|
|
500
|
+
* Observation Sequence Result
|
|
526
501
|
* @export
|
|
527
502
|
* @interface V1ObservationSequenceResult
|
|
528
503
|
*/
|
|
@@ -540,13 +515,13 @@ export interface V1ObservationSequenceResult {
|
|
|
540
515
|
*/
|
|
541
516
|
'targetId': string;
|
|
542
517
|
/**
|
|
543
|
-
*
|
|
518
|
+
*
|
|
544
519
|
* @type {string}
|
|
545
520
|
* @memberof V1ObservationSequenceResult
|
|
546
521
|
*/
|
|
547
522
|
'noradId'?: string;
|
|
548
523
|
/**
|
|
549
|
-
*
|
|
524
|
+
*
|
|
550
525
|
* @type {Array<V1ObservationSequenceResultImageSetsInner>}
|
|
551
526
|
* @memberof V1ObservationSequenceResult
|
|
552
527
|
*/
|
|
@@ -596,7 +571,7 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
596
571
|
'observationResults': Array<ObservationResult>;
|
|
597
572
|
}
|
|
598
573
|
/**
|
|
599
|
-
*
|
|
574
|
+
*
|
|
600
575
|
* @export
|
|
601
576
|
* @interface V1OrganizationTarget
|
|
602
577
|
*/
|
|
@@ -606,10 +581,28 @@ export interface V1OrganizationTarget {
|
|
|
606
581
|
* @type {string}
|
|
607
582
|
* @memberof V1OrganizationTarget
|
|
608
583
|
*/
|
|
609
|
-
'
|
|
584
|
+
'id': string;
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @type {V1SatelliteTarget}
|
|
588
|
+
* @memberof V1OrganizationTarget
|
|
589
|
+
*/
|
|
590
|
+
'satelliteTarget': V1SatelliteTarget;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof V1OrganizationTarget
|
|
595
|
+
*/
|
|
596
|
+
'createdBy': string;
|
|
597
|
+
/**
|
|
598
|
+
*
|
|
599
|
+
* @type {string}
|
|
600
|
+
* @memberof V1OrganizationTarget
|
|
601
|
+
*/
|
|
602
|
+
'createdAt': string;
|
|
610
603
|
}
|
|
611
604
|
/**
|
|
612
|
-
*
|
|
605
|
+
* Satellite Target
|
|
613
606
|
* @export
|
|
614
607
|
* @interface V1SatelliteTarget
|
|
615
608
|
*/
|
|
@@ -640,7 +633,7 @@ export interface V1SatelliteTarget {
|
|
|
640
633
|
'orbitType': OrbitType;
|
|
641
634
|
}
|
|
642
635
|
/**
|
|
643
|
-
*
|
|
636
|
+
* TDM
|
|
644
637
|
* @export
|
|
645
638
|
* @interface V1Tdm
|
|
646
639
|
*/
|
|
@@ -695,45 +688,45 @@ export interface V1Tdm {
|
|
|
695
688
|
'createdBy': string;
|
|
696
689
|
}
|
|
697
690
|
/**
|
|
698
|
-
*
|
|
691
|
+
*
|
|
699
692
|
* @export
|
|
700
|
-
* @interface
|
|
693
|
+
* @interface V1UpdateEmailConfigurationRequest
|
|
701
694
|
*/
|
|
702
|
-
export interface
|
|
695
|
+
export interface V1UpdateEmailConfigurationRequest {
|
|
703
696
|
/**
|
|
704
697
|
*
|
|
705
698
|
* @type {Array<string>}
|
|
706
|
-
* @memberof
|
|
699
|
+
* @memberof V1UpdateEmailConfigurationRequest
|
|
707
700
|
*/
|
|
708
701
|
'emails': Array<string>;
|
|
709
702
|
}
|
|
710
703
|
/**
|
|
711
|
-
*
|
|
704
|
+
*
|
|
712
705
|
* @export
|
|
713
|
-
* @interface
|
|
706
|
+
* @interface V1UpdateWebhookConfigurationRequest
|
|
714
707
|
*/
|
|
715
|
-
export interface
|
|
708
|
+
export interface V1UpdateWebhookConfigurationRequest {
|
|
716
709
|
/**
|
|
717
710
|
*
|
|
718
711
|
* @type {string}
|
|
719
|
-
* @memberof
|
|
712
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
720
713
|
*/
|
|
721
714
|
'url': string;
|
|
722
715
|
/**
|
|
723
716
|
*
|
|
724
717
|
* @type {string}
|
|
725
|
-
* @memberof
|
|
718
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
726
719
|
*/
|
|
727
720
|
'secret': string;
|
|
728
721
|
/**
|
|
729
722
|
*
|
|
730
723
|
* @type {Array<WebhookEvent>}
|
|
731
|
-
* @memberof
|
|
724
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
732
725
|
*/
|
|
733
726
|
'events': Array<WebhookEvent>;
|
|
734
727
|
}
|
|
735
728
|
/**
|
|
736
|
-
*
|
|
729
|
+
*
|
|
737
730
|
* @export
|
|
738
731
|
* @interface V1WebhookConfiguration
|
|
739
732
|
*/
|
|
@@ -770,7 +763,7 @@ export interface V1WebhookConfiguration {
|
|
|
770
763
|
'createdAt': string;
|
|
771
764
|
}
|
|
772
765
|
/**
|
|
773
|
-
*
|
|
766
|
+
*
|
|
774
767
|
* @export
|
|
775
768
|
* @enum {string}
|
|
776
769
|
*/
|
|
@@ -787,70 +780,70 @@ export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
|
787
780
|
*/
|
|
788
781
|
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
789
782
|
/**
|
|
790
|
-
*
|
|
791
|
-
* @param {
|
|
783
|
+
* Create an image set.
|
|
784
|
+
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
792
785
|
* @param {*} [options] Override http request option.
|
|
793
786
|
* @throws {RequiredError}
|
|
794
787
|
*/
|
|
795
|
-
v1CreateImageSet: (
|
|
788
|
+
v1CreateImageSet: (v1CreateImageSetRequest: V1CreateImageSetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
796
789
|
/**
|
|
797
|
-
*
|
|
798
|
-
* @param {
|
|
790
|
+
* Create an image set image.
|
|
791
|
+
* @param {V1CreateImageSetImageRequest} v1CreateImageSetImageRequest
|
|
799
792
|
* @param {*} [options] Override http request option.
|
|
800
793
|
* @throws {RequiredError}
|
|
801
794
|
*/
|
|
802
|
-
v1CreateImageSetImage: (
|
|
795
|
+
v1CreateImageSetImage: (v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
803
796
|
/**
|
|
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](#
|
|
805
|
-
* @param {
|
|
797
|
+
* 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](#operation/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.
|
|
798
|
+
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
806
799
|
* @param {*} [options] Override http request option.
|
|
807
800
|
* @throws {RequiredError}
|
|
808
801
|
*/
|
|
809
|
-
v1CreateOrganizationTarget: (
|
|
802
|
+
v1CreateOrganizationTarget: (v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
810
803
|
/**
|
|
811
804
|
* 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 {
|
|
805
|
+
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
813
806
|
* @param {*} [options] Override http request option.
|
|
814
807
|
* @throws {RequiredError}
|
|
815
808
|
*/
|
|
816
|
-
v1CreateWebhookConfiguration: (
|
|
809
|
+
v1CreateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
817
810
|
/**
|
|
818
|
-
*
|
|
811
|
+
* Delete an organization target.
|
|
819
812
|
* @param {string} satelliteTargetId
|
|
820
813
|
* @param {*} [options] Override http request option.
|
|
821
814
|
* @throws {RequiredError}
|
|
822
815
|
*/
|
|
823
816
|
v1DeleteOrganizationTarget: (satelliteTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
824
817
|
/**
|
|
825
|
-
* Delete
|
|
826
|
-
* @param {string} id
|
|
818
|
+
* Delete a webhook configuration.
|
|
819
|
+
* @param {string} id
|
|
827
820
|
* @param {*} [options] Override http request option.
|
|
828
821
|
* @throws {RequiredError}
|
|
829
822
|
*/
|
|
830
823
|
v1DeleteWebhookConfiguration: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
831
824
|
/**
|
|
832
|
-
*
|
|
825
|
+
* Get an image set.
|
|
833
826
|
* @param {string} id
|
|
834
827
|
* @param {*} [options] Override http request option.
|
|
835
828
|
* @throws {RequiredError}
|
|
836
829
|
*/
|
|
837
830
|
v1GetImageSet: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
838
831
|
/**
|
|
839
|
-
*
|
|
832
|
+
* Get an image.
|
|
840
833
|
* @param {string} imageId
|
|
841
834
|
* @param {*} [options] Override http request option.
|
|
842
835
|
* @throws {RequiredError}
|
|
843
836
|
*/
|
|
844
837
|
v1GetImageSetImage: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
845
838
|
/**
|
|
846
|
-
*
|
|
839
|
+
* Get image set images.
|
|
847
840
|
* @param {Array<string>} imageSets
|
|
848
841
|
* @param {*} [options] Override http request option.
|
|
849
842
|
* @throws {RequiredError}
|
|
850
843
|
*/
|
|
851
844
|
v1GetImageSetImages: (imageSets: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
852
845
|
/**
|
|
853
|
-
*
|
|
846
|
+
* Get image sets.
|
|
854
847
|
* @param {*} [options] Override http request option.
|
|
855
848
|
* @throws {RequiredError}
|
|
856
849
|
*/
|
|
@@ -864,21 +857,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
864
857
|
*/
|
|
865
858
|
v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
866
859
|
/**
|
|
867
|
-
*
|
|
860
|
+
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
868
861
|
* @param {*} [options] Override http request option.
|
|
869
862
|
* @throws {RequiredError}
|
|
870
863
|
*/
|
|
871
864
|
v1GetOrganizationTargets: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
872
865
|
/**
|
|
873
866
|
* The available satellite objects that the OurSky platform can currently track.
|
|
874
|
-
* @param {OrbitType} [orbitType]
|
|
875
|
-
* @param {string} [noradId]
|
|
867
|
+
* @param {OrbitType} [orbitType]
|
|
868
|
+
* @param {string} [noradId]
|
|
876
869
|
* @param {*} [options] Override http request option.
|
|
877
870
|
* @throws {RequiredError}
|
|
878
871
|
*/
|
|
879
872
|
v1GetSatelliteTargets: (orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
880
873
|
/**
|
|
881
|
-
*
|
|
874
|
+
* Get a TDM.
|
|
882
875
|
* @param {string} tdmId
|
|
883
876
|
* @param {*} [options] Override http request option.
|
|
884
877
|
* @throws {RequiredError}
|
|
@@ -893,18 +886,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
893
886
|
*/
|
|
894
887
|
v1GetTdms: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
895
888
|
/**
|
|
896
|
-
* Get
|
|
889
|
+
* Get webhook configurations.
|
|
897
890
|
* @param {*} [options] Override http request option.
|
|
898
891
|
* @throws {RequiredError}
|
|
899
892
|
*/
|
|
900
893
|
v1GetWebhookConfigurations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
901
894
|
/**
|
|
902
895
|
* 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 {
|
|
896
|
+
* @param {V1UpdateEmailConfigurationRequest} v1UpdateEmailConfigurationRequest
|
|
904
897
|
* @param {*} [options] Override http request option.
|
|
905
898
|
* @throws {RequiredError}
|
|
906
899
|
*/
|
|
907
|
-
v1UpdateEmailConfiguration: (
|
|
900
|
+
v1UpdateEmailConfiguration: (v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
908
901
|
};
|
|
909
902
|
/**
|
|
910
903
|
* DefaultApi - functional programming interface
|
|
@@ -912,70 +905,70 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
912
905
|
*/
|
|
913
906
|
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
914
907
|
/**
|
|
915
|
-
*
|
|
916
|
-
* @param {
|
|
908
|
+
* Create an image set.
|
|
909
|
+
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
917
910
|
* @param {*} [options] Override http request option.
|
|
918
911
|
* @throws {RequiredError}
|
|
919
912
|
*/
|
|
920
|
-
v1CreateImageSet(
|
|
913
|
+
v1CreateImageSet(v1CreateImageSetRequest: V1CreateImageSetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
921
914
|
/**
|
|
922
|
-
*
|
|
923
|
-
* @param {
|
|
915
|
+
* Create an image set image.
|
|
916
|
+
* @param {V1CreateImageSetImageRequest} v1CreateImageSetImageRequest
|
|
924
917
|
* @param {*} [options] Override http request option.
|
|
925
918
|
* @throws {RequiredError}
|
|
926
919
|
*/
|
|
927
|
-
v1CreateImageSetImage(
|
|
920
|
+
v1CreateImageSetImage(v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1CreateImageSetImageResponse>>;
|
|
928
921
|
/**
|
|
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](#
|
|
930
|
-
* @param {
|
|
922
|
+
* 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](#operation/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.
|
|
923
|
+
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
931
924
|
* @param {*} [options] Override http request option.
|
|
932
925
|
* @throws {RequiredError}
|
|
933
926
|
*/
|
|
934
|
-
v1CreateOrganizationTarget(
|
|
927
|
+
v1CreateOrganizationTarget(v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
935
928
|
/**
|
|
936
929
|
* 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 {
|
|
930
|
+
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
938
931
|
* @param {*} [options] Override http request option.
|
|
939
932
|
* @throws {RequiredError}
|
|
940
933
|
*/
|
|
941
|
-
v1CreateWebhookConfiguration(
|
|
934
|
+
v1CreateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
942
935
|
/**
|
|
943
|
-
*
|
|
936
|
+
* Delete an organization target.
|
|
944
937
|
* @param {string} satelliteTargetId
|
|
945
938
|
* @param {*} [options] Override http request option.
|
|
946
939
|
* @throws {RequiredError}
|
|
947
940
|
*/
|
|
948
941
|
v1DeleteOrganizationTarget(satelliteTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
949
942
|
/**
|
|
950
|
-
* Delete
|
|
951
|
-
* @param {string} id
|
|
943
|
+
* Delete a webhook configuration.
|
|
944
|
+
* @param {string} id
|
|
952
945
|
* @param {*} [options] Override http request option.
|
|
953
946
|
* @throws {RequiredError}
|
|
954
947
|
*/
|
|
955
948
|
v1DeleteWebhookConfiguration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
956
949
|
/**
|
|
957
|
-
*
|
|
950
|
+
* Get an image set.
|
|
958
951
|
* @param {string} id
|
|
959
952
|
* @param {*} [options] Override http request option.
|
|
960
953
|
* @throws {RequiredError}
|
|
961
954
|
*/
|
|
962
955
|
v1GetImageSet(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageSet>>;
|
|
963
956
|
/**
|
|
964
|
-
*
|
|
957
|
+
* Get an image.
|
|
965
958
|
* @param {string} imageId
|
|
966
959
|
* @param {*} [options] Override http request option.
|
|
967
960
|
* @throws {RequiredError}
|
|
968
961
|
*/
|
|
969
962
|
v1GetImageSetImage(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageSetImage>>;
|
|
970
963
|
/**
|
|
971
|
-
*
|
|
964
|
+
* Get image set images.
|
|
972
965
|
* @param {Array<string>} imageSets
|
|
973
966
|
* @param {*} [options] Override http request option.
|
|
974
967
|
* @throws {RequiredError}
|
|
975
968
|
*/
|
|
976
969
|
v1GetImageSetImages(imageSets: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ImageSetImage>>>;
|
|
977
970
|
/**
|
|
978
|
-
*
|
|
971
|
+
* Get image sets.
|
|
979
972
|
* @param {*} [options] Override http request option.
|
|
980
973
|
* @throws {RequiredError}
|
|
981
974
|
*/
|
|
@@ -989,21 +982,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
989
982
|
*/
|
|
990
983
|
v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
|
|
991
984
|
/**
|
|
992
|
-
*
|
|
985
|
+
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
993
986
|
* @param {*} [options] Override http request option.
|
|
994
987
|
* @throws {RequiredError}
|
|
995
988
|
*/
|
|
996
|
-
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
989
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1OrganizationTarget>>>;
|
|
997
990
|
/**
|
|
998
991
|
* The available satellite objects that the OurSky platform can currently track.
|
|
999
|
-
* @param {OrbitType} [orbitType]
|
|
1000
|
-
* @param {string} [noradId]
|
|
992
|
+
* @param {OrbitType} [orbitType]
|
|
993
|
+
* @param {string} [noradId]
|
|
1001
994
|
* @param {*} [options] Override http request option.
|
|
1002
995
|
* @throws {RequiredError}
|
|
1003
996
|
*/
|
|
1004
|
-
v1GetSatelliteTargets(orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
997
|
+
v1GetSatelliteTargets(orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetSatelliteTargetsResponse>>;
|
|
1005
998
|
/**
|
|
1006
|
-
*
|
|
999
|
+
* Get a TDM.
|
|
1007
1000
|
* @param {string} tdmId
|
|
1008
1001
|
* @param {*} [options] Override http request option.
|
|
1009
1002
|
* @throws {RequiredError}
|
|
@@ -1018,18 +1011,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1018
1011
|
*/
|
|
1019
1012
|
v1GetTdms(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1Tdm>>>;
|
|
1020
1013
|
/**
|
|
1021
|
-
* Get
|
|
1014
|
+
* Get webhook configurations.
|
|
1022
1015
|
* @param {*} [options] Override http request option.
|
|
1023
1016
|
* @throws {RequiredError}
|
|
1024
1017
|
*/
|
|
1025
1018
|
v1GetWebhookConfigurations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1WebhookConfiguration>>>;
|
|
1026
1019
|
/**
|
|
1027
1020
|
* 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 {
|
|
1021
|
+
* @param {V1UpdateEmailConfigurationRequest} v1UpdateEmailConfigurationRequest
|
|
1029
1022
|
* @param {*} [options] Override http request option.
|
|
1030
1023
|
* @throws {RequiredError}
|
|
1031
1024
|
*/
|
|
1032
|
-
v1UpdateEmailConfiguration(
|
|
1025
|
+
v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1033
1026
|
};
|
|
1034
1027
|
/**
|
|
1035
1028
|
* DefaultApi - factory interface
|
|
@@ -1037,21 +1030,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1037
1030
|
*/
|
|
1038
1031
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1039
1032
|
/**
|
|
1040
|
-
*
|
|
1033
|
+
* Create an image set.
|
|
1041
1034
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
1042
1035
|
* @param {*} [options] Override http request option.
|
|
1043
1036
|
* @throws {RequiredError}
|
|
1044
1037
|
*/
|
|
1045
1038
|
v1CreateImageSet(requestParameters: DefaultApiV1CreateImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1046
1039
|
/**
|
|
1047
|
-
*
|
|
1040
|
+
* Create an image set image.
|
|
1048
1041
|
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
1049
1042
|
* @param {*} [options] Override http request option.
|
|
1050
1043
|
* @throws {RequiredError}
|
|
1051
1044
|
*/
|
|
1052
1045
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1CreateImageSetImageResponse>;
|
|
1053
1046
|
/**
|
|
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](#
|
|
1047
|
+
* 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](#operation/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
1048
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
1056
1049
|
* @param {*} [options] Override http request option.
|
|
1057
1050
|
* @throws {RequiredError}
|
|
@@ -1065,42 +1058,42 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1065
1058
|
*/
|
|
1066
1059
|
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1067
1060
|
/**
|
|
1068
|
-
*
|
|
1061
|
+
* Delete an organization target.
|
|
1069
1062
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
1070
1063
|
* @param {*} [options] Override http request option.
|
|
1071
1064
|
* @throws {RequiredError}
|
|
1072
1065
|
*/
|
|
1073
1066
|
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1074
1067
|
/**
|
|
1075
|
-
* Delete
|
|
1068
|
+
* Delete a webhook configuration.
|
|
1076
1069
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1077
1070
|
* @param {*} [options] Override http request option.
|
|
1078
1071
|
* @throws {RequiredError}
|
|
1079
1072
|
*/
|
|
1080
1073
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1081
1074
|
/**
|
|
1082
|
-
*
|
|
1075
|
+
* Get an image set.
|
|
1083
1076
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
1084
1077
|
* @param {*} [options] Override http request option.
|
|
1085
1078
|
* @throws {RequiredError}
|
|
1086
1079
|
*/
|
|
1087
1080
|
v1GetImageSet(requestParameters: DefaultApiV1GetImageSetRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageSet>;
|
|
1088
1081
|
/**
|
|
1089
|
-
*
|
|
1082
|
+
* Get an image.
|
|
1090
1083
|
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
1091
1084
|
* @param {*} [options] Override http request option.
|
|
1092
1085
|
* @throws {RequiredError}
|
|
1093
1086
|
*/
|
|
1094
1087
|
v1GetImageSetImage(requestParameters: DefaultApiV1GetImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageSetImage>;
|
|
1095
1088
|
/**
|
|
1096
|
-
*
|
|
1089
|
+
* Get image set images.
|
|
1097
1090
|
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
1098
1091
|
* @param {*} [options] Override http request option.
|
|
1099
1092
|
* @throws {RequiredError}
|
|
1100
1093
|
*/
|
|
1101
1094
|
v1GetImageSetImages(requestParameters: DefaultApiV1GetImageSetImagesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ImageSetImage>>;
|
|
1102
1095
|
/**
|
|
1103
|
-
*
|
|
1096
|
+
* Get image sets.
|
|
1104
1097
|
* @param {*} [options] Override http request option.
|
|
1105
1098
|
* @throws {RequiredError}
|
|
1106
1099
|
*/
|
|
@@ -1113,20 +1106,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1113
1106
|
*/
|
|
1114
1107
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
|
|
1115
1108
|
/**
|
|
1116
|
-
*
|
|
1109
|
+
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1117
1110
|
* @param {*} [options] Override http request option.
|
|
1118
1111
|
* @throws {RequiredError}
|
|
1119
1112
|
*/
|
|
1120
|
-
v1GetOrganizationTargets(options?: AxiosRequestConfig): AxiosPromise<Array<
|
|
1113
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): AxiosPromise<Array<V1OrganizationTarget>>;
|
|
1121
1114
|
/**
|
|
1122
1115
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1123
1116
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
1124
1117
|
* @param {*} [options] Override http request option.
|
|
1125
1118
|
* @throws {RequiredError}
|
|
1126
1119
|
*/
|
|
1127
|
-
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
1120
|
+
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargetsResponse>;
|
|
1128
1121
|
/**
|
|
1129
|
-
*
|
|
1122
|
+
* Get a TDM.
|
|
1130
1123
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1131
1124
|
* @param {*} [options] Override http request option.
|
|
1132
1125
|
* @throws {RequiredError}
|
|
@@ -1140,7 +1133,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1140
1133
|
*/
|
|
1141
1134
|
v1GetTdms(requestParameters?: DefaultApiV1GetTdmsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1Tdm>>;
|
|
1142
1135
|
/**
|
|
1143
|
-
* Get
|
|
1136
|
+
* Get webhook configurations.
|
|
1144
1137
|
* @param {*} [options] Override http request option.
|
|
1145
1138
|
* @throws {RequiredError}
|
|
1146
1139
|
*/
|
|
@@ -1160,11 +1153,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1160
1153
|
*/
|
|
1161
1154
|
export interface DefaultApiV1CreateImageSetRequest {
|
|
1162
1155
|
/**
|
|
1163
|
-
*
|
|
1164
|
-
* @type {
|
|
1156
|
+
*
|
|
1157
|
+
* @type {V1CreateImageSetRequest}
|
|
1165
1158
|
* @memberof DefaultApiV1CreateImageSet
|
|
1166
1159
|
*/
|
|
1167
|
-
readonly
|
|
1160
|
+
readonly v1CreateImageSetRequest: V1CreateImageSetRequest;
|
|
1168
1161
|
}
|
|
1169
1162
|
/**
|
|
1170
1163
|
* Request parameters for v1CreateImageSetImage operation in DefaultApi.
|
|
@@ -1173,11 +1166,11 @@ export interface DefaultApiV1CreateImageSetRequest {
|
|
|
1173
1166
|
*/
|
|
1174
1167
|
export interface DefaultApiV1CreateImageSetImageRequest {
|
|
1175
1168
|
/**
|
|
1176
|
-
*
|
|
1177
|
-
* @type {
|
|
1169
|
+
*
|
|
1170
|
+
* @type {V1CreateImageSetImageRequest}
|
|
1178
1171
|
* @memberof DefaultApiV1CreateImageSetImage
|
|
1179
1172
|
*/
|
|
1180
|
-
readonly
|
|
1173
|
+
readonly v1CreateImageSetImageRequest: V1CreateImageSetImageRequest;
|
|
1181
1174
|
}
|
|
1182
1175
|
/**
|
|
1183
1176
|
* Request parameters for v1CreateOrganizationTarget operation in DefaultApi.
|
|
@@ -1186,11 +1179,11 @@ export interface DefaultApiV1CreateImageSetImageRequest {
|
|
|
1186
1179
|
*/
|
|
1187
1180
|
export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
1188
1181
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
* @type {
|
|
1182
|
+
*
|
|
1183
|
+
* @type {V1CreateOrganizationTargetRequest}
|
|
1191
1184
|
* @memberof DefaultApiV1CreateOrganizationTarget
|
|
1192
1185
|
*/
|
|
1193
|
-
readonly
|
|
1186
|
+
readonly v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest;
|
|
1194
1187
|
}
|
|
1195
1188
|
/**
|
|
1196
1189
|
* Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
|
|
@@ -1199,11 +1192,11 @@ export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
|
1199
1192
|
*/
|
|
1200
1193
|
export interface DefaultApiV1CreateWebhookConfigurationRequest {
|
|
1201
1194
|
/**
|
|
1202
|
-
*
|
|
1203
|
-
* @type {
|
|
1195
|
+
*
|
|
1196
|
+
* @type {V1UpdateWebhookConfigurationRequest}
|
|
1204
1197
|
* @memberof DefaultApiV1CreateWebhookConfiguration
|
|
1205
1198
|
*/
|
|
1206
|
-
readonly
|
|
1199
|
+
readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
|
|
1207
1200
|
}
|
|
1208
1201
|
/**
|
|
1209
1202
|
* Request parameters for v1DeleteOrganizationTarget operation in DefaultApi.
|
|
@@ -1225,7 +1218,7 @@ export interface DefaultApiV1DeleteOrganizationTargetRequest {
|
|
|
1225
1218
|
*/
|
|
1226
1219
|
export interface DefaultApiV1DeleteWebhookConfigurationRequest {
|
|
1227
1220
|
/**
|
|
1228
|
-
*
|
|
1221
|
+
*
|
|
1229
1222
|
* @type {string}
|
|
1230
1223
|
* @memberof DefaultApiV1DeleteWebhookConfiguration
|
|
1231
1224
|
*/
|
|
@@ -1296,13 +1289,13 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
|
|
|
1296
1289
|
*/
|
|
1297
1290
|
export interface DefaultApiV1GetSatelliteTargetsRequest {
|
|
1298
1291
|
/**
|
|
1299
|
-
*
|
|
1292
|
+
*
|
|
1300
1293
|
* @type {OrbitType}
|
|
1301
1294
|
* @memberof DefaultApiV1GetSatelliteTargets
|
|
1302
1295
|
*/
|
|
1303
1296
|
readonly orbitType?: OrbitType;
|
|
1304
1297
|
/**
|
|
1305
|
-
*
|
|
1298
|
+
*
|
|
1306
1299
|
* @type {string}
|
|
1307
1300
|
* @memberof DefaultApiV1GetSatelliteTargets
|
|
1308
1301
|
*/
|
|
@@ -1347,11 +1340,11 @@ export interface DefaultApiV1GetTdmsRequest {
|
|
|
1347
1340
|
*/
|
|
1348
1341
|
export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
1349
1342
|
/**
|
|
1350
|
-
*
|
|
1351
|
-
* @type {
|
|
1343
|
+
*
|
|
1344
|
+
* @type {V1UpdateEmailConfigurationRequest}
|
|
1352
1345
|
* @memberof DefaultApiV1UpdateEmailConfiguration
|
|
1353
1346
|
*/
|
|
1354
|
-
readonly
|
|
1347
|
+
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest;
|
|
1355
1348
|
}
|
|
1356
1349
|
/**
|
|
1357
1350
|
* DefaultApi - object-oriented interface
|
|
@@ -1361,7 +1354,7 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
1361
1354
|
*/
|
|
1362
1355
|
export declare class DefaultApi extends BaseAPI {
|
|
1363
1356
|
/**
|
|
1364
|
-
*
|
|
1357
|
+
* Create an image set.
|
|
1365
1358
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
1366
1359
|
* @param {*} [options] Override http request option.
|
|
1367
1360
|
* @throws {RequiredError}
|
|
@@ -1369,7 +1362,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1369
1362
|
*/
|
|
1370
1363
|
v1CreateImageSet(requestParameters: DefaultApiV1CreateImageSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1371
1364
|
/**
|
|
1372
|
-
*
|
|
1365
|
+
* Create an image set image.
|
|
1373
1366
|
* @param {DefaultApiV1CreateImageSetImageRequest} requestParameters Request parameters.
|
|
1374
1367
|
* @param {*} [options] Override http request option.
|
|
1375
1368
|
* @throws {RequiredError}
|
|
@@ -1377,7 +1370,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1377
1370
|
*/
|
|
1378
1371
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1CreateImageSetImageResponse, any>>;
|
|
1379
1372
|
/**
|
|
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](#
|
|
1373
|
+
* 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](#operation/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
1374
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
1382
1375
|
* @param {*} [options] Override http request option.
|
|
1383
1376
|
* @throws {RequiredError}
|
|
@@ -1393,7 +1386,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1393
1386
|
*/
|
|
1394
1387
|
v1CreateWebhookConfiguration(requestParameters: DefaultApiV1CreateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1395
1388
|
/**
|
|
1396
|
-
*
|
|
1389
|
+
* Delete an organization target.
|
|
1397
1390
|
* @param {DefaultApiV1DeleteOrganizationTargetRequest} requestParameters Request parameters.
|
|
1398
1391
|
* @param {*} [options] Override http request option.
|
|
1399
1392
|
* @throws {RequiredError}
|
|
@@ -1401,7 +1394,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1401
1394
|
*/
|
|
1402
1395
|
v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1403
1396
|
/**
|
|
1404
|
-
* Delete
|
|
1397
|
+
* Delete a webhook configuration.
|
|
1405
1398
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1406
1399
|
* @param {*} [options] Override http request option.
|
|
1407
1400
|
* @throws {RequiredError}
|
|
@@ -1409,7 +1402,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1409
1402
|
*/
|
|
1410
1403
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1411
1404
|
/**
|
|
1412
|
-
*
|
|
1405
|
+
* Get an image set.
|
|
1413
1406
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
1414
1407
|
* @param {*} [options] Override http request option.
|
|
1415
1408
|
* @throws {RequiredError}
|
|
@@ -1417,7 +1410,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1417
1410
|
*/
|
|
1418
1411
|
v1GetImageSet(requestParameters: DefaultApiV1GetImageSetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSet, any>>;
|
|
1419
1412
|
/**
|
|
1420
|
-
*
|
|
1413
|
+
* Get an image.
|
|
1421
1414
|
* @param {DefaultApiV1GetImageSetImageRequest} requestParameters Request parameters.
|
|
1422
1415
|
* @param {*} [options] Override http request option.
|
|
1423
1416
|
* @throws {RequiredError}
|
|
@@ -1425,7 +1418,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1425
1418
|
*/
|
|
1426
1419
|
v1GetImageSetImage(requestParameters: DefaultApiV1GetImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSetImage, any>>;
|
|
1427
1420
|
/**
|
|
1428
|
-
*
|
|
1421
|
+
* Get image set images.
|
|
1429
1422
|
* @param {DefaultApiV1GetImageSetImagesRequest} requestParameters Request parameters.
|
|
1430
1423
|
* @param {*} [options] Override http request option.
|
|
1431
1424
|
* @throws {RequiredError}
|
|
@@ -1433,7 +1426,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1433
1426
|
*/
|
|
1434
1427
|
v1GetImageSetImages(requestParameters: DefaultApiV1GetImageSetImagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageSetImage[], any>>;
|
|
1435
1428
|
/**
|
|
1436
|
-
*
|
|
1429
|
+
* Get image sets.
|
|
1437
1430
|
* @param {*} [options] Override http request option.
|
|
1438
1431
|
* @throws {RequiredError}
|
|
1439
1432
|
* @memberof DefaultApi
|
|
@@ -1448,12 +1441,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1448
1441
|
*/
|
|
1449
1442
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
|
|
1450
1443
|
/**
|
|
1451
|
-
*
|
|
1444
|
+
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1452
1445
|
* @param {*} [options] Override http request option.
|
|
1453
1446
|
* @throws {RequiredError}
|
|
1454
1447
|
* @memberof DefaultApi
|
|
1455
1448
|
*/
|
|
1456
|
-
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1449
|
+
v1GetOrganizationTargets(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget[], any>>;
|
|
1457
1450
|
/**
|
|
1458
1451
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1459
1452
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -1461,9 +1454,9 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1461
1454
|
* @throws {RequiredError}
|
|
1462
1455
|
* @memberof DefaultApi
|
|
1463
1456
|
*/
|
|
1464
|
-
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1457
|
+
v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GetSatelliteTargetsResponse, any>>;
|
|
1465
1458
|
/**
|
|
1466
|
-
*
|
|
1459
|
+
* Get a TDM.
|
|
1467
1460
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
1468
1461
|
* @param {*} [options] Override http request option.
|
|
1469
1462
|
* @throws {RequiredError}
|
|
@@ -1479,7 +1472,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1479
1472
|
*/
|
|
1480
1473
|
v1GetTdms(requestParameters?: DefaultApiV1GetTdmsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Tdm[], any>>;
|
|
1481
1474
|
/**
|
|
1482
|
-
* Get
|
|
1475
|
+
* Get webhook configurations.
|
|
1483
1476
|
* @param {*} [options] Override http request option.
|
|
1484
1477
|
* @throws {RequiredError}
|
|
1485
1478
|
* @memberof DefaultApi
|