@ourskyai/sda-api 1.3.2584 → 1.3.2816
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 +396 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +289 -6
- package/dist/api.js +159 -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 +289 -6
- package/dist/esm/api.js +158 -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/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.2816
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -258,6 +258,12 @@ export interface ObservationResult {
|
|
|
258
258
|
* @memberof ObservationResult
|
|
259
259
|
*/
|
|
260
260
|
'distanceFromPrediction'?: number;
|
|
261
|
+
/**
|
|
262
|
+
*
|
|
263
|
+
* @type {Array<V1ObservationFeature>}
|
|
264
|
+
* @memberof ObservationResult
|
|
265
|
+
*/
|
|
266
|
+
'features'?: Array<V1ObservationFeature>;
|
|
261
267
|
}
|
|
262
268
|
/**
|
|
263
269
|
*
|
|
@@ -816,6 +822,55 @@ export interface V1ImageSetImage {
|
|
|
816
822
|
*/
|
|
817
823
|
'exposureLength': number;
|
|
818
824
|
}
|
|
825
|
+
/**
|
|
826
|
+
* Observation Feature
|
|
827
|
+
* @export
|
|
828
|
+
* @interface V1ObservationFeature
|
|
829
|
+
*/
|
|
830
|
+
export interface V1ObservationFeature {
|
|
831
|
+
/**
|
|
832
|
+
*
|
|
833
|
+
* @type {number}
|
|
834
|
+
* @memberof V1ObservationFeature
|
|
835
|
+
*/
|
|
836
|
+
'ra': number;
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
* @type {number}
|
|
840
|
+
* @memberof V1ObservationFeature
|
|
841
|
+
*/
|
|
842
|
+
'dec': number;
|
|
843
|
+
/**
|
|
844
|
+
*
|
|
845
|
+
* @type {string}
|
|
846
|
+
* @memberof V1ObservationFeature
|
|
847
|
+
*/
|
|
848
|
+
'timestamp': string;
|
|
849
|
+
/**
|
|
850
|
+
*
|
|
851
|
+
* @type {ObservationBoundingBox}
|
|
852
|
+
* @memberof V1ObservationFeature
|
|
853
|
+
*/
|
|
854
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
855
|
+
/**
|
|
856
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
857
|
+
* @type {number}
|
|
858
|
+
* @memberof V1ObservationFeature
|
|
859
|
+
*/
|
|
860
|
+
'apparentMagnitude'?: number;
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @type {number}
|
|
864
|
+
* @memberof V1ObservationFeature
|
|
865
|
+
*/
|
|
866
|
+
'distanceFromPrediction'?: number;
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @type {Array<V1TargetCorrelation>}
|
|
870
|
+
* @memberof V1ObservationFeature
|
|
871
|
+
*/
|
|
872
|
+
'targetCorrelations'?: Array<V1TargetCorrelation>;
|
|
873
|
+
}
|
|
819
874
|
/**
|
|
820
875
|
* Observation Sequence Result
|
|
821
876
|
* @export
|
|
@@ -896,6 +951,85 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
896
951
|
*/
|
|
897
952
|
'observationQuality'?: ObservationQuality;
|
|
898
953
|
}
|
|
954
|
+
/**
|
|
955
|
+
*
|
|
956
|
+
* @export
|
|
957
|
+
* @interface V1ObservationStatus
|
|
958
|
+
*/
|
|
959
|
+
export interface V1ObservationStatus {
|
|
960
|
+
/**
|
|
961
|
+
*
|
|
962
|
+
* @type {string}
|
|
963
|
+
* @memberof V1ObservationStatus
|
|
964
|
+
*/
|
|
965
|
+
'id': string;
|
|
966
|
+
/**
|
|
967
|
+
*
|
|
968
|
+
* @type {string}
|
|
969
|
+
* @memberof V1ObservationStatus
|
|
970
|
+
*/
|
|
971
|
+
'targetId': string;
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {TrackingType}
|
|
975
|
+
* @memberof V1ObservationStatus
|
|
976
|
+
*/
|
|
977
|
+
'trackingType'?: TrackingType;
|
|
978
|
+
/**
|
|
979
|
+
*
|
|
980
|
+
* @type {number}
|
|
981
|
+
* @memberof V1ObservationStatus
|
|
982
|
+
*/
|
|
983
|
+
'ra': number;
|
|
984
|
+
/**
|
|
985
|
+
*
|
|
986
|
+
* @type {number}
|
|
987
|
+
* @memberof V1ObservationStatus
|
|
988
|
+
*/
|
|
989
|
+
'dec': number;
|
|
990
|
+
/**
|
|
991
|
+
*
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof V1ObservationStatus
|
|
994
|
+
*/
|
|
995
|
+
'observationTime': string;
|
|
996
|
+
/**
|
|
997
|
+
* TLE line 1 of when the observation was tasked
|
|
998
|
+
* @type {string}
|
|
999
|
+
* @memberof V1ObservationStatus
|
|
1000
|
+
*/
|
|
1001
|
+
'tleLine1': string;
|
|
1002
|
+
/**
|
|
1003
|
+
* TLE line 2 of when the observation was tasked
|
|
1004
|
+
* @type {string}
|
|
1005
|
+
* @memberof V1ObservationStatus
|
|
1006
|
+
*/
|
|
1007
|
+
'tleLine2': string;
|
|
1008
|
+
/**
|
|
1009
|
+
*
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof V1ObservationStatus
|
|
1012
|
+
*/
|
|
1013
|
+
'tleEpoch': string;
|
|
1014
|
+
/**
|
|
1015
|
+
*
|
|
1016
|
+
* @type {string}
|
|
1017
|
+
* @memberof V1ObservationStatus
|
|
1018
|
+
*/
|
|
1019
|
+
'imageSetId'?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
*
|
|
1022
|
+
* @type {string}
|
|
1023
|
+
* @memberof V1ObservationStatus
|
|
1024
|
+
*/
|
|
1025
|
+
'observationSequenceResultId'?: string;
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @type {string}
|
|
1029
|
+
* @memberof V1ObservationStatus
|
|
1030
|
+
*/
|
|
1031
|
+
'searchInstructionId'?: string;
|
|
1032
|
+
}
|
|
899
1033
|
/**
|
|
900
1034
|
*
|
|
901
1035
|
* @export
|
|
@@ -1019,6 +1153,31 @@ export interface V1SatelliteTarget {
|
|
|
1019
1153
|
*/
|
|
1020
1154
|
'trackingStatus'?: SatelliteTargetTrackingStatus;
|
|
1021
1155
|
}
|
|
1156
|
+
/**
|
|
1157
|
+
* Target Correlation
|
|
1158
|
+
* @export
|
|
1159
|
+
* @interface V1TargetCorrelation
|
|
1160
|
+
*/
|
|
1161
|
+
export interface V1TargetCorrelation {
|
|
1162
|
+
/**
|
|
1163
|
+
*
|
|
1164
|
+
* @type {string}
|
|
1165
|
+
* @memberof V1TargetCorrelation
|
|
1166
|
+
*/
|
|
1167
|
+
'targetId': string;
|
|
1168
|
+
/**
|
|
1169
|
+
*
|
|
1170
|
+
* @type {number}
|
|
1171
|
+
* @memberof V1TargetCorrelation
|
|
1172
|
+
*/
|
|
1173
|
+
'ra': number;
|
|
1174
|
+
/**
|
|
1175
|
+
*
|
|
1176
|
+
* @type {number}
|
|
1177
|
+
* @memberof V1TargetCorrelation
|
|
1178
|
+
*/
|
|
1179
|
+
'dec': number;
|
|
1180
|
+
}
|
|
1022
1181
|
/**
|
|
1023
1182
|
* TDM
|
|
1024
1183
|
* @export
|
|
@@ -1142,6 +1301,18 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
1142
1301
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1143
1302
|
*/
|
|
1144
1303
|
'events': Array<WebhookEvent>;
|
|
1304
|
+
/**
|
|
1305
|
+
*
|
|
1306
|
+
* @type {WebhookAuthType}
|
|
1307
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1308
|
+
*/
|
|
1309
|
+
'authType'?: WebhookAuthType;
|
|
1310
|
+
/**
|
|
1311
|
+
*
|
|
1312
|
+
* @type {string}
|
|
1313
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1314
|
+
*/
|
|
1315
|
+
'authorization'?: string;
|
|
1145
1316
|
}
|
|
1146
1317
|
/**
|
|
1147
1318
|
*
|
|
@@ -1181,7 +1352,18 @@ export interface V1WebhookConfiguration {
|
|
|
1181
1352
|
'createdAt': string;
|
|
1182
1353
|
}
|
|
1183
1354
|
/**
|
|
1184
|
-
*
|
|
1355
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1356
|
+
* @export
|
|
1357
|
+
* @enum {string}
|
|
1358
|
+
*/
|
|
1359
|
+
export declare const WebhookAuthType: {
|
|
1360
|
+
readonly NONE: "NONE";
|
|
1361
|
+
readonly BASIC: "BASIC";
|
|
1362
|
+
readonly BEARER: "BEARER";
|
|
1363
|
+
};
|
|
1364
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1365
|
+
/**
|
|
1366
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1185
1367
|
* @export
|
|
1186
1368
|
* @enum {string}
|
|
1187
1369
|
*/
|
|
@@ -1192,6 +1374,7 @@ export declare const WebhookEvent: {
|
|
|
1192
1374
|
readonly V1_IMAGE_CREATED: "V1_IMAGE_CREATED";
|
|
1193
1375
|
readonly V1_STREAK_CREATED: "V1_STREAK_CREATED";
|
|
1194
1376
|
readonly V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: "V1_SATELLITE_TARGET_TRACKING_DEACTIVATED";
|
|
1377
|
+
readonly V1_EO_OBSERVATION_CREATED: "V1_EO_OBSERVATION_CREATED";
|
|
1195
1378
|
};
|
|
1196
1379
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
1197
1380
|
/**
|
|
@@ -1235,7 +1418,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1235
1418
|
*/
|
|
1236
1419
|
v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1237
1420
|
/**
|
|
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
|
|
1421
|
+
* 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.
|
|
1239
1422
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1240
1423
|
* @param {*} [options] Override http request option.
|
|
1241
1424
|
* @throws {RequiredError}
|
|
@@ -1303,6 +1486,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1303
1486
|
* @throws {RequiredError}
|
|
1304
1487
|
*/
|
|
1305
1488
|
v1GetNodeProperties: (nodeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1489
|
+
/**
|
|
1490
|
+
* Get observation features.
|
|
1491
|
+
* @param {string} imageId
|
|
1492
|
+
* @param {*} [options] Override http request option.
|
|
1493
|
+
* @throws {RequiredError}
|
|
1494
|
+
*/
|
|
1495
|
+
v1GetObservationFeatures: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1306
1496
|
/**
|
|
1307
1497
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1308
1498
|
* @param {string} [targetId]
|
|
@@ -1311,6 +1501,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1311
1501
|
* @throws {RequiredError}
|
|
1312
1502
|
*/
|
|
1313
1503
|
v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1504
|
+
/**
|
|
1505
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`. By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter. When searching by `searchInstructionId`, a `before` timestamp is not required.
|
|
1506
|
+
* @param {string} [targetId]
|
|
1507
|
+
* @param {string} [before]
|
|
1508
|
+
* @param {string} [searchInstructionId]
|
|
1509
|
+
* @param {*} [options] Override http request option.
|
|
1510
|
+
* @throws {RequiredError}
|
|
1511
|
+
*/
|
|
1512
|
+
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1314
1513
|
/**
|
|
1315
1514
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1316
1515
|
* @param {*} [options] Override http request option.
|
|
@@ -1410,7 +1609,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1410
1609
|
*/
|
|
1411
1610
|
v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1412
1611
|
/**
|
|
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
|
|
1612
|
+
* 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.
|
|
1414
1613
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1415
1614
|
* @param {*} [options] Override http request option.
|
|
1416
1615
|
* @throws {RequiredError}
|
|
@@ -1478,6 +1677,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1478
1677
|
* @throws {RequiredError}
|
|
1479
1678
|
*/
|
|
1480
1679
|
v1GetNodeProperties(nodeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GroundStationParticipant>>;
|
|
1680
|
+
/**
|
|
1681
|
+
* Get observation features.
|
|
1682
|
+
* @param {string} imageId
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
v1GetObservationFeatures(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationFeature>>>;
|
|
1481
1687
|
/**
|
|
1482
1688
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1483
1689
|
* @param {string} [targetId]
|
|
@@ -1486,6 +1692,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1486
1692
|
* @throws {RequiredError}
|
|
1487
1693
|
*/
|
|
1488
1694
|
v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
|
|
1695
|
+
/**
|
|
1696
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`. By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter. When searching by `searchInstructionId`, a `before` timestamp is not required.
|
|
1697
|
+
* @param {string} [targetId]
|
|
1698
|
+
* @param {string} [before]
|
|
1699
|
+
* @param {string} [searchInstructionId]
|
|
1700
|
+
* @param {*} [options] Override http request option.
|
|
1701
|
+
* @throws {RequiredError}
|
|
1702
|
+
*/
|
|
1703
|
+
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
1489
1704
|
/**
|
|
1490
1705
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1491
1706
|
* @param {*} [options] Override http request option.
|
|
@@ -1585,7 +1800,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1585
1800
|
*/
|
|
1586
1801
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1587
1802
|
/**
|
|
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
|
|
1803
|
+
* 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.
|
|
1589
1804
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1590
1805
|
* @param {*} [options] Override http request option.
|
|
1591
1806
|
* @throws {RequiredError}
|
|
@@ -1653,6 +1868,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1653
1868
|
* @throws {RequiredError}
|
|
1654
1869
|
*/
|
|
1655
1870
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Get observation features.
|
|
1873
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
1874
|
+
* @param {*} [options] Override http request option.
|
|
1875
|
+
* @throws {RequiredError}
|
|
1876
|
+
*/
|
|
1877
|
+
v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationFeature>>;
|
|
1656
1878
|
/**
|
|
1657
1879
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1658
1880
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -1660,6 +1882,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1660
1882
|
* @throws {RequiredError}
|
|
1661
1883
|
*/
|
|
1662
1884
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
|
|
1885
|
+
/**
|
|
1886
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`. By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter. When searching by `searchInstructionId`, a `before` timestamp is not required.
|
|
1887
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1888
|
+
* @param {*} [options] Override http request option.
|
|
1889
|
+
* @throws {RequiredError}
|
|
1890
|
+
*/
|
|
1891
|
+
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>>;
|
|
1663
1892
|
/**
|
|
1664
1893
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1665
1894
|
* @param {*} [options] Override http request option.
|
|
@@ -1897,6 +2126,19 @@ export interface DefaultApiV1GetNodePropertiesRequest {
|
|
|
1897
2126
|
*/
|
|
1898
2127
|
readonly nodeId: string;
|
|
1899
2128
|
}
|
|
2129
|
+
/**
|
|
2130
|
+
* Request parameters for v1GetObservationFeatures operation in DefaultApi.
|
|
2131
|
+
* @export
|
|
2132
|
+
* @interface DefaultApiV1GetObservationFeaturesRequest
|
|
2133
|
+
*/
|
|
2134
|
+
export interface DefaultApiV1GetObservationFeaturesRequest {
|
|
2135
|
+
/**
|
|
2136
|
+
*
|
|
2137
|
+
* @type {string}
|
|
2138
|
+
* @memberof DefaultApiV1GetObservationFeatures
|
|
2139
|
+
*/
|
|
2140
|
+
readonly imageId: string;
|
|
2141
|
+
}
|
|
1900
2142
|
/**
|
|
1901
2143
|
* Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
|
|
1902
2144
|
* @export
|
|
@@ -1916,6 +2158,31 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
|
|
|
1916
2158
|
*/
|
|
1917
2159
|
readonly after?: string;
|
|
1918
2160
|
}
|
|
2161
|
+
/**
|
|
2162
|
+
* Request parameters for v1GetObservationStatuses operation in DefaultApi.
|
|
2163
|
+
* @export
|
|
2164
|
+
* @interface DefaultApiV1GetObservationStatusesRequest
|
|
2165
|
+
*/
|
|
2166
|
+
export interface DefaultApiV1GetObservationStatusesRequest {
|
|
2167
|
+
/**
|
|
2168
|
+
*
|
|
2169
|
+
* @type {string}
|
|
2170
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
2171
|
+
*/
|
|
2172
|
+
readonly targetId?: string;
|
|
2173
|
+
/**
|
|
2174
|
+
*
|
|
2175
|
+
* @type {string}
|
|
2176
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
2177
|
+
*/
|
|
2178
|
+
readonly before?: string;
|
|
2179
|
+
/**
|
|
2180
|
+
*
|
|
2181
|
+
* @type {string}
|
|
2182
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
2183
|
+
*/
|
|
2184
|
+
readonly searchInstructionId?: string;
|
|
2185
|
+
}
|
|
1919
2186
|
/**
|
|
1920
2187
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
1921
2188
|
* @export
|
|
@@ -2060,7 +2327,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2060
2327
|
*/
|
|
2061
2328
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2062
2329
|
/**
|
|
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
|
|
2330
|
+
* 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.
|
|
2064
2331
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
2065
2332
|
* @param {*} [options] Override http request option.
|
|
2066
2333
|
* @throws {RequiredError}
|
|
@@ -2138,6 +2405,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2138
2405
|
* @memberof DefaultApi
|
|
2139
2406
|
*/
|
|
2140
2407
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GroundStationParticipant, any>>;
|
|
2408
|
+
/**
|
|
2409
|
+
* Get observation features.
|
|
2410
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
2411
|
+
* @param {*} [options] Override http request option.
|
|
2412
|
+
* @throws {RequiredError}
|
|
2413
|
+
* @memberof DefaultApi
|
|
2414
|
+
*/
|
|
2415
|
+
v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationFeature[], any>>;
|
|
2141
2416
|
/**
|
|
2142
2417
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
2143
2418
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -2146,6 +2421,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2146
2421
|
* @memberof DefaultApi
|
|
2147
2422
|
*/
|
|
2148
2423
|
v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
|
|
2424
|
+
/**
|
|
2425
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by a specific `searchInstructionId`. By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter. When searching by `searchInstructionId`, a `before` timestamp is not required.
|
|
2426
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
2427
|
+
* @param {*} [options] Override http request option.
|
|
2428
|
+
* @throws {RequiredError}
|
|
2429
|
+
* @memberof DefaultApi
|
|
2430
|
+
*/
|
|
2431
|
+
v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationStatus[], any>>;
|
|
2149
2432
|
/**
|
|
2150
2433
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2151
2434
|
* @param {*} [options] Override http request option.
|