@ourskyai/sda-api 1.3.2407 → 1.3.2584
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 +431 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +300 -1
- package/dist/api.js +193 -1
- 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 +300 -1
- package/dist/esm/api.js +193 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/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.2584
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -161,6 +161,37 @@ export interface ObservationBoundingBox {
|
|
|
161
161
|
*/
|
|
162
162
|
'endY': number;
|
|
163
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
*
|
|
166
|
+
* @export
|
|
167
|
+
* @interface ObservationQuality
|
|
168
|
+
*/
|
|
169
|
+
export interface ObservationQuality {
|
|
170
|
+
/**
|
|
171
|
+
* Standard deviation for the line fit of the observation positions over time
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof ObservationQuality
|
|
174
|
+
*/
|
|
175
|
+
'lineFitOffsetStdDev': number;
|
|
176
|
+
/**
|
|
177
|
+
* Average of the distances beween observation and prediction, in arcsec
|
|
178
|
+
* @type {number}
|
|
179
|
+
* @memberof ObservationQuality
|
|
180
|
+
*/
|
|
181
|
+
'distanceFromPredictionAverage'?: number;
|
|
182
|
+
/**
|
|
183
|
+
* Slope of the linear fit of distances, in arcsec per second
|
|
184
|
+
* @type {number}
|
|
185
|
+
* @memberof ObservationQuality
|
|
186
|
+
*/
|
|
187
|
+
'distanceFromPredictionLineFitSlope'?: number;
|
|
188
|
+
/**
|
|
189
|
+
* Standard deviation of the offsets of the linear fit
|
|
190
|
+
* @type {number}
|
|
191
|
+
* @memberof ObservationQuality
|
|
192
|
+
*/
|
|
193
|
+
'distanceFromPredictionLineFitStdDev'?: number;
|
|
194
|
+
}
|
|
164
195
|
/**
|
|
165
196
|
* A single observation result. This is a 1:1 mapping with a single image
|
|
166
197
|
* @export
|
|
@@ -221,6 +252,12 @@ export interface ObservationResult {
|
|
|
221
252
|
* @memberof ObservationResult
|
|
222
253
|
*/
|
|
223
254
|
'apparentMagnitude'?: number;
|
|
255
|
+
/**
|
|
256
|
+
*
|
|
257
|
+
* @type {number}
|
|
258
|
+
* @memberof ObservationResult
|
|
259
|
+
*/
|
|
260
|
+
'distanceFromPrediction'?: number;
|
|
224
261
|
}
|
|
225
262
|
/**
|
|
226
263
|
*
|
|
@@ -364,6 +401,105 @@ export interface V1CreateOrganizationTargetRequest {
|
|
|
364
401
|
*/
|
|
365
402
|
'satelliteTargetId': string;
|
|
366
403
|
}
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @export
|
|
407
|
+
* @interface V1CreateSatelliteTargetRequest
|
|
408
|
+
*/
|
|
409
|
+
export interface V1CreateSatelliteTargetRequest {
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
414
|
+
*/
|
|
415
|
+
'tleName': string;
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {string}
|
|
419
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
420
|
+
*/
|
|
421
|
+
'tleLine1': string;
|
|
422
|
+
/**
|
|
423
|
+
*
|
|
424
|
+
* @type {string}
|
|
425
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
426
|
+
*/
|
|
427
|
+
'tleLine2': string;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
*
|
|
431
|
+
* @export
|
|
432
|
+
* @interface V1CreateSearchTaskRequest
|
|
433
|
+
*/
|
|
434
|
+
export interface V1CreateSearchTaskRequest {
|
|
435
|
+
/**
|
|
436
|
+
*
|
|
437
|
+
* @type {string}
|
|
438
|
+
* @memberof V1CreateSearchTaskRequest
|
|
439
|
+
*/
|
|
440
|
+
'nodeId': string;
|
|
441
|
+
/**
|
|
442
|
+
*
|
|
443
|
+
* @type {string}
|
|
444
|
+
* @memberof V1CreateSearchTaskRequest
|
|
445
|
+
*/
|
|
446
|
+
'targetId': string;
|
|
447
|
+
/**
|
|
448
|
+
*
|
|
449
|
+
* @type {TrackingType}
|
|
450
|
+
* @memberof V1CreateSearchTaskRequest
|
|
451
|
+
*/
|
|
452
|
+
'trackingType'?: TrackingType;
|
|
453
|
+
/**
|
|
454
|
+
*
|
|
455
|
+
* @type {Array<V1CreateSearchTaskRequestStepsInner>}
|
|
456
|
+
* @memberof V1CreateSearchTaskRequest
|
|
457
|
+
*/
|
|
458
|
+
'steps': Array<V1CreateSearchTaskRequestStepsInner>;
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* Search steps
|
|
462
|
+
* @export
|
|
463
|
+
* @interface V1CreateSearchTaskRequestStepsInner
|
|
464
|
+
*/
|
|
465
|
+
export interface V1CreateSearchTaskRequestStepsInner {
|
|
466
|
+
/**
|
|
467
|
+
* Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
468
|
+
* @type {number}
|
|
469
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
470
|
+
*/
|
|
471
|
+
'ra'?: number;
|
|
472
|
+
/**
|
|
473
|
+
* Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
474
|
+
* @type {number}
|
|
475
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
476
|
+
*/
|
|
477
|
+
'dec'?: number;
|
|
478
|
+
/**
|
|
479
|
+
* Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
480
|
+
* @type {number}
|
|
481
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
482
|
+
*/
|
|
483
|
+
'raOffset'?: number;
|
|
484
|
+
/**
|
|
485
|
+
* Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
486
|
+
* @type {number}
|
|
487
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
488
|
+
*/
|
|
489
|
+
'decOffset'?: number;
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @type {string}
|
|
493
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
494
|
+
*/
|
|
495
|
+
'startTime': string;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
500
|
+
*/
|
|
501
|
+
'endTime': string;
|
|
502
|
+
}
|
|
367
503
|
/**
|
|
368
504
|
*
|
|
369
505
|
* @export
|
|
@@ -753,6 +889,12 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
753
889
|
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
754
890
|
*/
|
|
755
891
|
'observationResults': Array<ObservationResult>;
|
|
892
|
+
/**
|
|
893
|
+
*
|
|
894
|
+
* @type {ObservationQuality}
|
|
895
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
896
|
+
*/
|
|
897
|
+
'observationQuality'?: ObservationQuality;
|
|
756
898
|
}
|
|
757
899
|
/**
|
|
758
900
|
*
|
|
@@ -945,6 +1087,37 @@ export interface V1UpdateEmailConfigurationRequest {
|
|
|
945
1087
|
*/
|
|
946
1088
|
'emails': Array<string>;
|
|
947
1089
|
}
|
|
1090
|
+
/**
|
|
1091
|
+
*
|
|
1092
|
+
* @export
|
|
1093
|
+
* @interface V1UpdateSatelliteTargetRequest
|
|
1094
|
+
*/
|
|
1095
|
+
export interface V1UpdateSatelliteTargetRequest {
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1100
|
+
*/
|
|
1101
|
+
'targetId': string;
|
|
1102
|
+
/**
|
|
1103
|
+
*
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1106
|
+
*/
|
|
1107
|
+
'tleName'?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
*
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1112
|
+
*/
|
|
1113
|
+
'tleLine1': string;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
* @type {string}
|
|
1117
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1118
|
+
*/
|
|
1119
|
+
'tleLine2': string;
|
|
1120
|
+
}
|
|
948
1121
|
/**
|
|
949
1122
|
*
|
|
950
1123
|
* @export
|
|
@@ -1047,6 +1220,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1047
1220
|
* @throws {RequiredError}
|
|
1048
1221
|
*/
|
|
1049
1222
|
v1CreateOrganizationTarget: (v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1223
|
+
/**
|
|
1224
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1225
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1230
|
+
/**
|
|
1231
|
+
* \' 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. \'
|
|
1232
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1233
|
+
* @param {*} [options] Override http request option.
|
|
1234
|
+
* @throws {RequiredError}
|
|
1235
|
+
*/
|
|
1236
|
+
v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1050
1237
|
/**
|
|
1051
1238
|
* 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.
|
|
1052
1239
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -1174,6 +1361,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1174
1361
|
* @throws {RequiredError}
|
|
1175
1362
|
*/
|
|
1176
1363
|
v1UpdateEmailConfiguration: (v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1364
|
+
/**
|
|
1365
|
+
* Update satellite target.
|
|
1366
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1367
|
+
* @param {*} [options] Override http request option.
|
|
1368
|
+
* @throws {RequiredError}
|
|
1369
|
+
*/
|
|
1370
|
+
v1UpdateSatelliteTarget: (v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1177
1371
|
};
|
|
1178
1372
|
/**
|
|
1179
1373
|
* DefaultApi - functional programming interface
|
|
@@ -1201,6 +1395,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1201
1395
|
* @throws {RequiredError}
|
|
1202
1396
|
*/
|
|
1203
1397
|
v1CreateOrganizationTarget(v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1398
|
+
/**
|
|
1399
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1400
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
1401
|
+
* @param {*} [options] Override http request option.
|
|
1402
|
+
* @throws {RequiredError}
|
|
1403
|
+
*/
|
|
1404
|
+
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1405
|
+
/**
|
|
1406
|
+
* \' 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. \'
|
|
1407
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1408
|
+
* @param {*} [options] Override http request option.
|
|
1409
|
+
* @throws {RequiredError}
|
|
1410
|
+
*/
|
|
1411
|
+
v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1204
1412
|
/**
|
|
1205
1413
|
* 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.
|
|
1206
1414
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -1328,6 +1536,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1328
1536
|
* @throws {RequiredError}
|
|
1329
1537
|
*/
|
|
1330
1538
|
v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Update satellite target.
|
|
1541
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1542
|
+
* @param {*} [options] Override http request option.
|
|
1543
|
+
* @throws {RequiredError}
|
|
1544
|
+
*/
|
|
1545
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
1331
1546
|
};
|
|
1332
1547
|
/**
|
|
1333
1548
|
* DefaultApi - factory interface
|
|
@@ -1355,6 +1570,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1355
1570
|
* @throws {RequiredError}
|
|
1356
1571
|
*/
|
|
1357
1572
|
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1575
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1576
|
+
* @param {*} [options] Override http request option.
|
|
1577
|
+
* @throws {RequiredError}
|
|
1578
|
+
*/
|
|
1579
|
+
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1580
|
+
/**
|
|
1581
|
+
* \' 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. \'
|
|
1582
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1583
|
+
* @param {*} [options] Override http request option.
|
|
1584
|
+
* @throws {RequiredError}
|
|
1585
|
+
*/
|
|
1586
|
+
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1358
1587
|
/**
|
|
1359
1588
|
* 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.
|
|
1360
1589
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1478,6 +1707,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1478
1707
|
* @throws {RequiredError}
|
|
1479
1708
|
*/
|
|
1480
1709
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1710
|
+
/**
|
|
1711
|
+
* Update satellite target.
|
|
1712
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1713
|
+
* @param {*} [options] Override http request option.
|
|
1714
|
+
* @throws {RequiredError}
|
|
1715
|
+
*/
|
|
1716
|
+
v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
1481
1717
|
};
|
|
1482
1718
|
/**
|
|
1483
1719
|
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
@@ -1518,6 +1754,32 @@ export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
|
1518
1754
|
*/
|
|
1519
1755
|
readonly v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest;
|
|
1520
1756
|
}
|
|
1757
|
+
/**
|
|
1758
|
+
* Request parameters for v1CreateSatelliteTarget operation in DefaultApi.
|
|
1759
|
+
* @export
|
|
1760
|
+
* @interface DefaultApiV1CreateSatelliteTargetRequest
|
|
1761
|
+
*/
|
|
1762
|
+
export interface DefaultApiV1CreateSatelliteTargetRequest {
|
|
1763
|
+
/**
|
|
1764
|
+
*
|
|
1765
|
+
* @type {V1CreateSatelliteTargetRequest}
|
|
1766
|
+
* @memberof DefaultApiV1CreateSatelliteTarget
|
|
1767
|
+
*/
|
|
1768
|
+
readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest;
|
|
1769
|
+
}
|
|
1770
|
+
/**
|
|
1771
|
+
* Request parameters for v1CreateSearchTask operation in DefaultApi.
|
|
1772
|
+
* @export
|
|
1773
|
+
* @interface DefaultApiV1CreateSearchTaskRequest
|
|
1774
|
+
*/
|
|
1775
|
+
export interface DefaultApiV1CreateSearchTaskRequest {
|
|
1776
|
+
/**
|
|
1777
|
+
*
|
|
1778
|
+
* @type {V1CreateSearchTaskRequest}
|
|
1779
|
+
* @memberof DefaultApiV1CreateSearchTask
|
|
1780
|
+
*/
|
|
1781
|
+
readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest;
|
|
1782
|
+
}
|
|
1521
1783
|
/**
|
|
1522
1784
|
* Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
|
|
1523
1785
|
* @export
|
|
@@ -1737,6 +1999,19 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
1737
1999
|
*/
|
|
1738
2000
|
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest;
|
|
1739
2001
|
}
|
|
2002
|
+
/**
|
|
2003
|
+
* Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
|
|
2004
|
+
* @export
|
|
2005
|
+
* @interface DefaultApiV1UpdateSatelliteTargetRequest
|
|
2006
|
+
*/
|
|
2007
|
+
export interface DefaultApiV1UpdateSatelliteTargetRequest {
|
|
2008
|
+
/**
|
|
2009
|
+
*
|
|
2010
|
+
* @type {V1UpdateSatelliteTargetRequest}
|
|
2011
|
+
* @memberof DefaultApiV1UpdateSatelliteTarget
|
|
2012
|
+
*/
|
|
2013
|
+
readonly v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest;
|
|
2014
|
+
}
|
|
1740
2015
|
/**
|
|
1741
2016
|
* DefaultApi - object-oriented interface
|
|
1742
2017
|
* @export
|
|
@@ -1768,6 +2043,22 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1768
2043
|
* @memberof DefaultApi
|
|
1769
2044
|
*/
|
|
1770
2045
|
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
2046
|
+
/**
|
|
2047
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
2048
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2049
|
+
* @param {*} [options] Override http request option.
|
|
2050
|
+
* @throws {RequiredError}
|
|
2051
|
+
* @memberof DefaultApi
|
|
2052
|
+
*/
|
|
2053
|
+
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2054
|
+
/**
|
|
2055
|
+
* \' 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. \'
|
|
2056
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
* @memberof DefaultApi
|
|
2060
|
+
*/
|
|
2061
|
+
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
1771
2062
|
/**
|
|
1772
2063
|
* 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.
|
|
1773
2064
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1909,4 +2200,12 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
1909
2200
|
* @memberof DefaultApi
|
|
1910
2201
|
*/
|
|
1911
2202
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
2203
|
+
/**
|
|
2204
|
+
* Update satellite target.
|
|
2205
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2206
|
+
* @param {*} [options] Override http request option.
|
|
2207
|
+
* @throws {RequiredError}
|
|
2208
|
+
* @memberof DefaultApi
|
|
2209
|
+
*/
|
|
2210
|
+
v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
1912
2211
|
}
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* OurSky SDA
|
|
6
6
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.3.
|
|
8
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -224,6 +224,72 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
224
224
|
options: localVarRequestOptions,
|
|
225
225
|
};
|
|
226
226
|
}),
|
|
227
|
+
/**
|
|
228
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
229
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
*/
|
|
233
|
+
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
234
|
+
// verify required parameter 'v1CreateSatelliteTargetRequest' is not null or undefined
|
|
235
|
+
(0, common_1.assertParamExists)('v1CreateSatelliteTarget', 'v1CreateSatelliteTargetRequest', v1CreateSatelliteTargetRequest);
|
|
236
|
+
const localVarPath = `/v1/satellite-target`;
|
|
237
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
238
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
239
|
+
let baseOptions;
|
|
240
|
+
if (configuration) {
|
|
241
|
+
baseOptions = configuration.baseOptions;
|
|
242
|
+
}
|
|
243
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
244
|
+
const localVarHeaderParameter = {};
|
|
245
|
+
const localVarQueryParameter = {};
|
|
246
|
+
// authentication Roles required
|
|
247
|
+
// authentication BearerToken required
|
|
248
|
+
// http bearer authentication required
|
|
249
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
250
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
251
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
252
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
253
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
254
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
255
|
+
return {
|
|
256
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
257
|
+
options: localVarRequestOptions,
|
|
258
|
+
};
|
|
259
|
+
}),
|
|
260
|
+
/**
|
|
261
|
+
* \' 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. \'
|
|
262
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
v1CreateSearchTask: (v1CreateSearchTaskRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
267
|
+
// verify required parameter 'v1CreateSearchTaskRequest' is not null or undefined
|
|
268
|
+
(0, common_1.assertParamExists)('v1CreateSearchTask', 'v1CreateSearchTaskRequest', v1CreateSearchTaskRequest);
|
|
269
|
+
const localVarPath = `/v1/search-instruction`;
|
|
270
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
271
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
272
|
+
let baseOptions;
|
|
273
|
+
if (configuration) {
|
|
274
|
+
baseOptions = configuration.baseOptions;
|
|
275
|
+
}
|
|
276
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
277
|
+
const localVarHeaderParameter = {};
|
|
278
|
+
const localVarQueryParameter = {};
|
|
279
|
+
// authentication Roles required
|
|
280
|
+
// authentication BearerToken required
|
|
281
|
+
// http bearer authentication required
|
|
282
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
283
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
284
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
285
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
286
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
287
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSearchTaskRequest, localVarRequestOptions, configuration);
|
|
288
|
+
return {
|
|
289
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
290
|
+
options: localVarRequestOptions,
|
|
291
|
+
};
|
|
292
|
+
}),
|
|
227
293
|
/**
|
|
228
294
|
* 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.
|
|
229
295
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -834,6 +900,39 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
834
900
|
options: localVarRequestOptions,
|
|
835
901
|
};
|
|
836
902
|
}),
|
|
903
|
+
/**
|
|
904
|
+
* Update satellite target.
|
|
905
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
906
|
+
* @param {*} [options] Override http request option.
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
*/
|
|
909
|
+
v1UpdateSatelliteTarget: (v1UpdateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
910
|
+
// verify required parameter 'v1UpdateSatelliteTargetRequest' is not null or undefined
|
|
911
|
+
(0, common_1.assertParamExists)('v1UpdateSatelliteTarget', 'v1UpdateSatelliteTargetRequest', v1UpdateSatelliteTargetRequest);
|
|
912
|
+
const localVarPath = `/v1/satellite-target`;
|
|
913
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
914
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
915
|
+
let baseOptions;
|
|
916
|
+
if (configuration) {
|
|
917
|
+
baseOptions = configuration.baseOptions;
|
|
918
|
+
}
|
|
919
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
920
|
+
const localVarHeaderParameter = {};
|
|
921
|
+
const localVarQueryParameter = {};
|
|
922
|
+
// authentication Roles required
|
|
923
|
+
// authentication BearerToken required
|
|
924
|
+
// http bearer authentication required
|
|
925
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
926
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
927
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
928
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
929
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
930
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
931
|
+
return {
|
|
932
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
933
|
+
options: localVarRequestOptions,
|
|
934
|
+
};
|
|
935
|
+
}),
|
|
837
936
|
};
|
|
838
937
|
};
|
|
839
938
|
exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
|
|
@@ -880,6 +979,30 @@ const DefaultApiFp = function (configuration) {
|
|
|
880
979
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
881
980
|
});
|
|
882
981
|
},
|
|
982
|
+
/**
|
|
983
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
984
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
985
|
+
* @param {*} [options] Override http request option.
|
|
986
|
+
* @throws {RequiredError}
|
|
987
|
+
*/
|
|
988
|
+
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options) {
|
|
989
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
990
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options);
|
|
991
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
992
|
+
});
|
|
993
|
+
},
|
|
994
|
+
/**
|
|
995
|
+
* \' 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. \'
|
|
996
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
997
|
+
* @param {*} [options] Override http request option.
|
|
998
|
+
* @throws {RequiredError}
|
|
999
|
+
*/
|
|
1000
|
+
v1CreateSearchTask(v1CreateSearchTaskRequest, options) {
|
|
1001
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1002
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSearchTask(v1CreateSearchTaskRequest, options);
|
|
1003
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1004
|
+
});
|
|
1005
|
+
},
|
|
883
1006
|
/**
|
|
884
1007
|
* 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.
|
|
885
1008
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -1097,6 +1220,18 @@ const DefaultApiFp = function (configuration) {
|
|
|
1097
1220
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1098
1221
|
});
|
|
1099
1222
|
},
|
|
1223
|
+
/**
|
|
1224
|
+
* Update satellite target.
|
|
1225
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options) {
|
|
1230
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1231
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options);
|
|
1232
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1233
|
+
});
|
|
1234
|
+
},
|
|
1100
1235
|
};
|
|
1101
1236
|
};
|
|
1102
1237
|
exports.DefaultApiFp = DefaultApiFp;
|
|
@@ -1134,6 +1269,24 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1134
1269
|
v1CreateOrganizationTarget(requestParameters, options) {
|
|
1135
1270
|
return localVarFp.v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
|
|
1136
1271
|
},
|
|
1272
|
+
/**
|
|
1273
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1274
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1275
|
+
* @param {*} [options] Override http request option.
|
|
1276
|
+
* @throws {RequiredError}
|
|
1277
|
+
*/
|
|
1278
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1279
|
+
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1280
|
+
},
|
|
1281
|
+
/**
|
|
1282
|
+
* \' 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. \'
|
|
1283
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1284
|
+
* @param {*} [options] Override http request option.
|
|
1285
|
+
* @throws {RequiredError}
|
|
1286
|
+
*/
|
|
1287
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1288
|
+
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1289
|
+
},
|
|
1137
1290
|
/**
|
|
1138
1291
|
* 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.
|
|
1139
1292
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1293,6 +1446,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1293
1446
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1294
1447
|
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
1295
1448
|
},
|
|
1449
|
+
/**
|
|
1450
|
+
* Update satellite target.
|
|
1451
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1452
|
+
* @param {*} [options] Override http request option.
|
|
1453
|
+
* @throws {RequiredError}
|
|
1454
|
+
*/
|
|
1455
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1456
|
+
return localVarFp.v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1457
|
+
},
|
|
1296
1458
|
};
|
|
1297
1459
|
};
|
|
1298
1460
|
exports.DefaultApiFactory = DefaultApiFactory;
|
|
@@ -1333,6 +1495,26 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1333
1495
|
v1CreateOrganizationTarget(requestParameters, options) {
|
|
1334
1496
|
return (0, exports.DefaultApiFp)(this.configuration).v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1335
1497
|
}
|
|
1498
|
+
/**
|
|
1499
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1500
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1501
|
+
* @param {*} [options] Override http request option.
|
|
1502
|
+
* @throws {RequiredError}
|
|
1503
|
+
* @memberof DefaultApi
|
|
1504
|
+
*/
|
|
1505
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1506
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* \' 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. \'
|
|
1510
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1511
|
+
* @param {*} [options] Override http request option.
|
|
1512
|
+
* @throws {RequiredError}
|
|
1513
|
+
* @memberof DefaultApi
|
|
1514
|
+
*/
|
|
1515
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1516
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1517
|
+
}
|
|
1336
1518
|
/**
|
|
1337
1519
|
* 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.
|
|
1338
1520
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1510,5 +1692,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1510
1692
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1511
1693
|
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1512
1694
|
}
|
|
1695
|
+
/**
|
|
1696
|
+
* Update satellite target.
|
|
1697
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1698
|
+
* @param {*} [options] Override http request option.
|
|
1699
|
+
* @throws {RequiredError}
|
|
1700
|
+
* @memberof DefaultApi
|
|
1701
|
+
*/
|
|
1702
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1703
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1704
|
+
}
|
|
1513
1705
|
}
|
|
1514
1706
|
exports.DefaultApi = DefaultApi;
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|