@ourskyai/sda-api 1.3.2437 → 1.3.2765
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 +547 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +409 -6
- package/dist/api.js +211 -8
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +409 -6
- package/dist/esm/api.js +210 -7
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -161,6 +161,86 @@ export interface ObservationBoundingBox {
|
|
|
161
161
|
*/
|
|
162
162
|
'endY': number;
|
|
163
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Observation Feature
|
|
166
|
+
* @export
|
|
167
|
+
* @interface ObservationFeature
|
|
168
|
+
*/
|
|
169
|
+
export interface ObservationFeature {
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof ObservationFeature
|
|
174
|
+
*/
|
|
175
|
+
'ra': number;
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @type {number}
|
|
179
|
+
* @memberof ObservationFeature
|
|
180
|
+
*/
|
|
181
|
+
'dec': number;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof ObservationFeature
|
|
186
|
+
*/
|
|
187
|
+
'timestamp': string;
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @type {ObservationBoundingBox}
|
|
191
|
+
* @memberof ObservationFeature
|
|
192
|
+
*/
|
|
193
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
194
|
+
/**
|
|
195
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof ObservationFeature
|
|
198
|
+
*/
|
|
199
|
+
'apparentMagnitude'?: number;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {number}
|
|
203
|
+
* @memberof ObservationFeature
|
|
204
|
+
*/
|
|
205
|
+
'distanceFromPrediction'?: number;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {Array<TargetCorrelation>}
|
|
209
|
+
* @memberof ObservationFeature
|
|
210
|
+
*/
|
|
211
|
+
'targetCorrelations'?: Array<TargetCorrelation>;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @export
|
|
216
|
+
* @interface ObservationQuality
|
|
217
|
+
*/
|
|
218
|
+
export interface ObservationQuality {
|
|
219
|
+
/**
|
|
220
|
+
* Standard deviation for the line fit of the observation positions over time
|
|
221
|
+
* @type {number}
|
|
222
|
+
* @memberof ObservationQuality
|
|
223
|
+
*/
|
|
224
|
+
'lineFitOffsetStdDev': number;
|
|
225
|
+
/**
|
|
226
|
+
* Average of the distances beween observation and prediction, in arcsec
|
|
227
|
+
* @type {number}
|
|
228
|
+
* @memberof ObservationQuality
|
|
229
|
+
*/
|
|
230
|
+
'distanceFromPredictionAverage'?: number;
|
|
231
|
+
/**
|
|
232
|
+
* Slope of the linear fit of distances, in arcsec per second
|
|
233
|
+
* @type {number}
|
|
234
|
+
* @memberof ObservationQuality
|
|
235
|
+
*/
|
|
236
|
+
'distanceFromPredictionLineFitSlope'?: number;
|
|
237
|
+
/**
|
|
238
|
+
* Standard deviation of the offsets of the linear fit
|
|
239
|
+
* @type {number}
|
|
240
|
+
* @memberof ObservationQuality
|
|
241
|
+
*/
|
|
242
|
+
'distanceFromPredictionLineFitStdDev'?: number;
|
|
243
|
+
}
|
|
164
244
|
/**
|
|
165
245
|
* A single observation result. This is a 1:1 mapping with a single image
|
|
166
246
|
* @export
|
|
@@ -221,6 +301,18 @@ export interface ObservationResult {
|
|
|
221
301
|
* @memberof ObservationResult
|
|
222
302
|
*/
|
|
223
303
|
'apparentMagnitude'?: number;
|
|
304
|
+
/**
|
|
305
|
+
*
|
|
306
|
+
* @type {number}
|
|
307
|
+
* @memberof ObservationResult
|
|
308
|
+
*/
|
|
309
|
+
'distanceFromPrediction'?: number;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {Array<ObservationFeature>}
|
|
313
|
+
* @memberof ObservationResult
|
|
314
|
+
*/
|
|
315
|
+
'features'?: Array<ObservationFeature>;
|
|
224
316
|
}
|
|
225
317
|
/**
|
|
226
318
|
*
|
|
@@ -272,6 +364,31 @@ export interface SuccessfulCreate {
|
|
|
272
364
|
*/
|
|
273
365
|
'id': string;
|
|
274
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Target Correlation
|
|
369
|
+
* @export
|
|
370
|
+
* @interface TargetCorrelation
|
|
371
|
+
*/
|
|
372
|
+
export interface TargetCorrelation {
|
|
373
|
+
/**
|
|
374
|
+
*
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof TargetCorrelation
|
|
377
|
+
*/
|
|
378
|
+
'targetId': string;
|
|
379
|
+
/**
|
|
380
|
+
*
|
|
381
|
+
* @type {number}
|
|
382
|
+
* @memberof TargetCorrelation
|
|
383
|
+
*/
|
|
384
|
+
'ra': number;
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @type {number}
|
|
388
|
+
* @memberof TargetCorrelation
|
|
389
|
+
*/
|
|
390
|
+
'dec': number;
|
|
391
|
+
}
|
|
275
392
|
/**
|
|
276
393
|
*
|
|
277
394
|
* @export
|
|
@@ -364,6 +481,105 @@ export interface V1CreateOrganizationTargetRequest {
|
|
|
364
481
|
*/
|
|
365
482
|
'satelliteTargetId': string;
|
|
366
483
|
}
|
|
484
|
+
/**
|
|
485
|
+
*
|
|
486
|
+
* @export
|
|
487
|
+
* @interface V1CreateSatelliteTargetRequest
|
|
488
|
+
*/
|
|
489
|
+
export interface V1CreateSatelliteTargetRequest {
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @type {string}
|
|
493
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
494
|
+
*/
|
|
495
|
+
'tleName': string;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
500
|
+
*/
|
|
501
|
+
'tleLine1': string;
|
|
502
|
+
/**
|
|
503
|
+
*
|
|
504
|
+
* @type {string}
|
|
505
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
506
|
+
*/
|
|
507
|
+
'tleLine2': string;
|
|
508
|
+
}
|
|
509
|
+
/**
|
|
510
|
+
*
|
|
511
|
+
* @export
|
|
512
|
+
* @interface V1CreateSearchTaskRequest
|
|
513
|
+
*/
|
|
514
|
+
export interface V1CreateSearchTaskRequest {
|
|
515
|
+
/**
|
|
516
|
+
*
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof V1CreateSearchTaskRequest
|
|
519
|
+
*/
|
|
520
|
+
'nodeId': string;
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @type {string}
|
|
524
|
+
* @memberof V1CreateSearchTaskRequest
|
|
525
|
+
*/
|
|
526
|
+
'targetId': string;
|
|
527
|
+
/**
|
|
528
|
+
*
|
|
529
|
+
* @type {TrackingType}
|
|
530
|
+
* @memberof V1CreateSearchTaskRequest
|
|
531
|
+
*/
|
|
532
|
+
'trackingType'?: TrackingType;
|
|
533
|
+
/**
|
|
534
|
+
*
|
|
535
|
+
* @type {Array<V1CreateSearchTaskRequestStepsInner>}
|
|
536
|
+
* @memberof V1CreateSearchTaskRequest
|
|
537
|
+
*/
|
|
538
|
+
'steps': Array<V1CreateSearchTaskRequestStepsInner>;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
* Search steps
|
|
542
|
+
* @export
|
|
543
|
+
* @interface V1CreateSearchTaskRequestStepsInner
|
|
544
|
+
*/
|
|
545
|
+
export interface V1CreateSearchTaskRequestStepsInner {
|
|
546
|
+
/**
|
|
547
|
+
* Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
548
|
+
* @type {number}
|
|
549
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
550
|
+
*/
|
|
551
|
+
'ra'?: number;
|
|
552
|
+
/**
|
|
553
|
+
* Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
554
|
+
* @type {number}
|
|
555
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
556
|
+
*/
|
|
557
|
+
'dec'?: number;
|
|
558
|
+
/**
|
|
559
|
+
* Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
560
|
+
* @type {number}
|
|
561
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
562
|
+
*/
|
|
563
|
+
'raOffset'?: number;
|
|
564
|
+
/**
|
|
565
|
+
* Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
566
|
+
* @type {number}
|
|
567
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
568
|
+
*/
|
|
569
|
+
'decOffset'?: number;
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
574
|
+
*/
|
|
575
|
+
'startTime': string;
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @type {string}
|
|
579
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
580
|
+
*/
|
|
581
|
+
'endTime': string;
|
|
582
|
+
}
|
|
367
583
|
/**
|
|
368
584
|
*
|
|
369
585
|
* @export
|
|
@@ -753,6 +969,12 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
753
969
|
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
754
970
|
*/
|
|
755
971
|
'observationResults': Array<ObservationResult>;
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {ObservationQuality}
|
|
975
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
976
|
+
*/
|
|
977
|
+
'observationQuality'?: ObservationQuality;
|
|
756
978
|
}
|
|
757
979
|
/**
|
|
758
980
|
*
|
|
@@ -945,6 +1167,37 @@ export interface V1UpdateEmailConfigurationRequest {
|
|
|
945
1167
|
*/
|
|
946
1168
|
'emails': Array<string>;
|
|
947
1169
|
}
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface V1UpdateSatelliteTargetRequest
|
|
1174
|
+
*/
|
|
1175
|
+
export interface V1UpdateSatelliteTargetRequest {
|
|
1176
|
+
/**
|
|
1177
|
+
*
|
|
1178
|
+
* @type {string}
|
|
1179
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1180
|
+
*/
|
|
1181
|
+
'targetId': string;
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1186
|
+
*/
|
|
1187
|
+
'tleName'?: string;
|
|
1188
|
+
/**
|
|
1189
|
+
*
|
|
1190
|
+
* @type {string}
|
|
1191
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1192
|
+
*/
|
|
1193
|
+
'tleLine1': string;
|
|
1194
|
+
/**
|
|
1195
|
+
*
|
|
1196
|
+
* @type {string}
|
|
1197
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1198
|
+
*/
|
|
1199
|
+
'tleLine2': string;
|
|
1200
|
+
}
|
|
948
1201
|
/**
|
|
949
1202
|
*
|
|
950
1203
|
* @export
|
|
@@ -969,6 +1222,18 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
969
1222
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
970
1223
|
*/
|
|
971
1224
|
'events': Array<WebhookEvent>;
|
|
1225
|
+
/**
|
|
1226
|
+
*
|
|
1227
|
+
* @type {WebhookAuthType}
|
|
1228
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1229
|
+
*/
|
|
1230
|
+
'authType'?: WebhookAuthType;
|
|
1231
|
+
/**
|
|
1232
|
+
*
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1235
|
+
*/
|
|
1236
|
+
'authorization'?: string;
|
|
972
1237
|
}
|
|
973
1238
|
/**
|
|
974
1239
|
*
|
|
@@ -1008,7 +1273,18 @@ export interface V1WebhookConfiguration {
|
|
|
1008
1273
|
'createdAt': string;
|
|
1009
1274
|
}
|
|
1010
1275
|
/**
|
|
1011
|
-
*
|
|
1276
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1277
|
+
* @export
|
|
1278
|
+
* @enum {string}
|
|
1279
|
+
*/
|
|
1280
|
+
export declare const WebhookAuthType: {
|
|
1281
|
+
readonly NONE: "NONE";
|
|
1282
|
+
readonly BASIC: "BASIC";
|
|
1283
|
+
readonly BEARER: "BEARER";
|
|
1284
|
+
};
|
|
1285
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1286
|
+
/**
|
|
1287
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1012
1288
|
* @export
|
|
1013
1289
|
* @enum {string}
|
|
1014
1290
|
*/
|
|
@@ -1019,6 +1295,7 @@ export declare const WebhookEvent: {
|
|
|
1019
1295
|
readonly V1_IMAGE_CREATED: "V1_IMAGE_CREATED";
|
|
1020
1296
|
readonly V1_STREAK_CREATED: "V1_STREAK_CREATED";
|
|
1021
1297
|
readonly V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: "V1_SATELLITE_TARGET_TRACKING_DEACTIVATED";
|
|
1298
|
+
readonly V1_EO_OBSERVATION_CREATED: "V1_EO_OBSERVATION_CREATED";
|
|
1022
1299
|
};
|
|
1023
1300
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
1024
1301
|
/**
|
|
@@ -1048,7 +1325,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1048
1325
|
*/
|
|
1049
1326
|
v1CreateOrganizationTarget: (v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1050
1327
|
/**
|
|
1051
|
-
* Create
|
|
1328
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1329
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
1330
|
+
* @param {*} [options] Override http request option.
|
|
1331
|
+
* @throws {RequiredError}
|
|
1332
|
+
*/
|
|
1333
|
+
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1334
|
+
/**
|
|
1335
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1336
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1337
|
+
* @param {*} [options] Override http request option.
|
|
1338
|
+
* @throws {RequiredError}
|
|
1339
|
+
*/
|
|
1340
|
+
v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1341
|
+
/**
|
|
1342
|
+
* 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1052
1343
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1053
1344
|
* @param {*} [options] Override http request option.
|
|
1054
1345
|
* @throws {RequiredError}
|
|
@@ -1174,6 +1465,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1174
1465
|
* @throws {RequiredError}
|
|
1175
1466
|
*/
|
|
1176
1467
|
v1UpdateEmailConfiguration: (v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1468
|
+
/**
|
|
1469
|
+
* Update satellite target.
|
|
1470
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1471
|
+
* @param {*} [options] Override http request option.
|
|
1472
|
+
* @throws {RequiredError}
|
|
1473
|
+
*/
|
|
1474
|
+
v1UpdateSatelliteTarget: (v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1177
1475
|
};
|
|
1178
1476
|
/**
|
|
1179
1477
|
* DefaultApi - functional programming interface
|
|
@@ -1202,7 +1500,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1202
1500
|
*/
|
|
1203
1501
|
v1CreateOrganizationTarget(v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1204
1502
|
/**
|
|
1205
|
-
* Create
|
|
1503
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1504
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
1505
|
+
* @param {*} [options] Override http request option.
|
|
1506
|
+
* @throws {RequiredError}
|
|
1507
|
+
*/
|
|
1508
|
+
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1509
|
+
/**
|
|
1510
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1511
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
*/
|
|
1515
|
+
v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1516
|
+
/**
|
|
1517
|
+
* 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1206
1518
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1207
1519
|
* @param {*} [options] Override http request option.
|
|
1208
1520
|
* @throws {RequiredError}
|
|
@@ -1328,6 +1640,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1328
1640
|
* @throws {RequiredError}
|
|
1329
1641
|
*/
|
|
1330
1642
|
v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1643
|
+
/**
|
|
1644
|
+
* Update satellite target.
|
|
1645
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1646
|
+
* @param {*} [options] Override http request option.
|
|
1647
|
+
* @throws {RequiredError}
|
|
1648
|
+
*/
|
|
1649
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1331
1650
|
};
|
|
1332
1651
|
/**
|
|
1333
1652
|
* DefaultApi - factory interface
|
|
@@ -1356,7 +1675,21 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1356
1675
|
*/
|
|
1357
1676
|
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1358
1677
|
/**
|
|
1359
|
-
* Create
|
|
1678
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1679
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1680
|
+
* @param {*} [options] Override http request option.
|
|
1681
|
+
* @throws {RequiredError}
|
|
1682
|
+
*/
|
|
1683
|
+
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1684
|
+
/**
|
|
1685
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1686
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1687
|
+
* @param {*} [options] Override http request option.
|
|
1688
|
+
* @throws {RequiredError}
|
|
1689
|
+
*/
|
|
1690
|
+
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1691
|
+
/**
|
|
1692
|
+
* 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1360
1693
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1361
1694
|
* @param {*} [options] Override http request option.
|
|
1362
1695
|
* @throws {RequiredError}
|
|
@@ -1478,6 +1811,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1478
1811
|
* @throws {RequiredError}
|
|
1479
1812
|
*/
|
|
1480
1813
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1814
|
+
/**
|
|
1815
|
+
* Update satellite target.
|
|
1816
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1817
|
+
* @param {*} [options] Override http request option.
|
|
1818
|
+
* @throws {RequiredError}
|
|
1819
|
+
*/
|
|
1820
|
+
v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1481
1821
|
};
|
|
1482
1822
|
/**
|
|
1483
1823
|
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
@@ -1518,6 +1858,32 @@ export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
|
1518
1858
|
*/
|
|
1519
1859
|
readonly v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest;
|
|
1520
1860
|
}
|
|
1861
|
+
/**
|
|
1862
|
+
* Request parameters for v1CreateSatelliteTarget operation in DefaultApi.
|
|
1863
|
+
* @export
|
|
1864
|
+
* @interface DefaultApiV1CreateSatelliteTargetRequest
|
|
1865
|
+
*/
|
|
1866
|
+
export interface DefaultApiV1CreateSatelliteTargetRequest {
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @type {V1CreateSatelliteTargetRequest}
|
|
1870
|
+
* @memberof DefaultApiV1CreateSatelliteTarget
|
|
1871
|
+
*/
|
|
1872
|
+
readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest;
|
|
1873
|
+
}
|
|
1874
|
+
/**
|
|
1875
|
+
* Request parameters for v1CreateSearchTask operation in DefaultApi.
|
|
1876
|
+
* @export
|
|
1877
|
+
* @interface DefaultApiV1CreateSearchTaskRequest
|
|
1878
|
+
*/
|
|
1879
|
+
export interface DefaultApiV1CreateSearchTaskRequest {
|
|
1880
|
+
/**
|
|
1881
|
+
*
|
|
1882
|
+
* @type {V1CreateSearchTaskRequest}
|
|
1883
|
+
* @memberof DefaultApiV1CreateSearchTask
|
|
1884
|
+
*/
|
|
1885
|
+
readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest;
|
|
1886
|
+
}
|
|
1521
1887
|
/**
|
|
1522
1888
|
* Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
|
|
1523
1889
|
* @export
|
|
@@ -1737,6 +2103,19 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
1737
2103
|
*/
|
|
1738
2104
|
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest;
|
|
1739
2105
|
}
|
|
2106
|
+
/**
|
|
2107
|
+
* Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
|
|
2108
|
+
* @export
|
|
2109
|
+
* @interface DefaultApiV1UpdateSatelliteTargetRequest
|
|
2110
|
+
*/
|
|
2111
|
+
export interface DefaultApiV1UpdateSatelliteTargetRequest {
|
|
2112
|
+
/**
|
|
2113
|
+
*
|
|
2114
|
+
* @type {V1UpdateSatelliteTargetRequest}
|
|
2115
|
+
* @memberof DefaultApiV1UpdateSatelliteTarget
|
|
2116
|
+
*/
|
|
2117
|
+
readonly v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest;
|
|
2118
|
+
}
|
|
1740
2119
|
/**
|
|
1741
2120
|
* DefaultApi - object-oriented interface
|
|
1742
2121
|
* @export
|
|
@@ -1769,7 +2148,23 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1769
2148
|
*/
|
|
1770
2149
|
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1771
2150
|
/**
|
|
1772
|
-
* Create
|
|
2151
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
2152
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2153
|
+
* @param {*} [options] Override http request option.
|
|
2154
|
+
* @throws {RequiredError}
|
|
2155
|
+
* @memberof DefaultApi
|
|
2156
|
+
*/
|
|
2157
|
+
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2158
|
+
/**
|
|
2159
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
2160
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
2161
|
+
* @param {*} [options] Override http request option.
|
|
2162
|
+
* @throws {RequiredError}
|
|
2163
|
+
* @memberof DefaultApi
|
|
2164
|
+
*/
|
|
2165
|
+
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2166
|
+
/**
|
|
2167
|
+
* 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}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com 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. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1773
2168
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1774
2169
|
* @param {*} [options] Override http request option.
|
|
1775
2170
|
* @throws {RequiredError}
|
|
@@ -1909,4 +2304,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1909
2304
|
* @memberof DefaultApi
|
|
1910
2305
|
*/
|
|
1911
2306
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
2307
|
+
/**
|
|
2308
|
+
* Update satellite target.
|
|
2309
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2310
|
+
* @param {*} [options] Override http request option.
|
|
2311
|
+
* @throws {RequiredError}
|
|
2312
|
+
* @memberof DefaultApi
|
|
2313
|
+
*/
|
|
2314
|
+
v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1912
2315
|
}
|