@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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @ourskyai/sda-api@1.3.
|
|
1
|
+
## @ourskyai/sda-api@1.3.2816
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @ourskyai/sda-api@1.3.
|
|
39
|
+
npm install @ourskyai/sda-api@1.3.2816 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.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.2816
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -276,6 +276,12 @@ export interface ObservationResult {
|
|
|
276
276
|
* @memberof ObservationResult
|
|
277
277
|
*/
|
|
278
278
|
'distanceFromPrediction'?: number;
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @type {Array<V1ObservationFeature>}
|
|
282
|
+
* @memberof ObservationResult
|
|
283
|
+
*/
|
|
284
|
+
'features'?: Array<V1ObservationFeature>;
|
|
279
285
|
}
|
|
280
286
|
/**
|
|
281
287
|
*
|
|
@@ -858,6 +864,55 @@ export interface V1ImageSetImage {
|
|
|
858
864
|
*/
|
|
859
865
|
'exposureLength': number;
|
|
860
866
|
}
|
|
867
|
+
/**
|
|
868
|
+
* Observation Feature
|
|
869
|
+
* @export
|
|
870
|
+
* @interface V1ObservationFeature
|
|
871
|
+
*/
|
|
872
|
+
export interface V1ObservationFeature {
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {number}
|
|
876
|
+
* @memberof V1ObservationFeature
|
|
877
|
+
*/
|
|
878
|
+
'ra': number;
|
|
879
|
+
/**
|
|
880
|
+
*
|
|
881
|
+
* @type {number}
|
|
882
|
+
* @memberof V1ObservationFeature
|
|
883
|
+
*/
|
|
884
|
+
'dec': number;
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof V1ObservationFeature
|
|
889
|
+
*/
|
|
890
|
+
'timestamp': string;
|
|
891
|
+
/**
|
|
892
|
+
*
|
|
893
|
+
* @type {ObservationBoundingBox}
|
|
894
|
+
* @memberof V1ObservationFeature
|
|
895
|
+
*/
|
|
896
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
897
|
+
/**
|
|
898
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
899
|
+
* @type {number}
|
|
900
|
+
* @memberof V1ObservationFeature
|
|
901
|
+
*/
|
|
902
|
+
'apparentMagnitude'?: number;
|
|
903
|
+
/**
|
|
904
|
+
*
|
|
905
|
+
* @type {number}
|
|
906
|
+
* @memberof V1ObservationFeature
|
|
907
|
+
*/
|
|
908
|
+
'distanceFromPrediction'?: number;
|
|
909
|
+
/**
|
|
910
|
+
*
|
|
911
|
+
* @type {Array<V1TargetCorrelation>}
|
|
912
|
+
* @memberof V1ObservationFeature
|
|
913
|
+
*/
|
|
914
|
+
'targetCorrelations'?: Array<V1TargetCorrelation>;
|
|
915
|
+
}
|
|
861
916
|
/**
|
|
862
917
|
* Observation Sequence Result
|
|
863
918
|
* @export
|
|
@@ -938,6 +993,87 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
938
993
|
*/
|
|
939
994
|
'observationQuality'?: ObservationQuality;
|
|
940
995
|
}
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @export
|
|
999
|
+
* @interface V1ObservationStatus
|
|
1000
|
+
*/
|
|
1001
|
+
export interface V1ObservationStatus {
|
|
1002
|
+
/**
|
|
1003
|
+
*
|
|
1004
|
+
* @type {string}
|
|
1005
|
+
* @memberof V1ObservationStatus
|
|
1006
|
+
*/
|
|
1007
|
+
'id': string;
|
|
1008
|
+
/**
|
|
1009
|
+
*
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof V1ObservationStatus
|
|
1012
|
+
*/
|
|
1013
|
+
'targetId': string;
|
|
1014
|
+
/**
|
|
1015
|
+
*
|
|
1016
|
+
* @type {TrackingType}
|
|
1017
|
+
* @memberof V1ObservationStatus
|
|
1018
|
+
*/
|
|
1019
|
+
'trackingType'?: TrackingType;
|
|
1020
|
+
/**
|
|
1021
|
+
*
|
|
1022
|
+
* @type {number}
|
|
1023
|
+
* @memberof V1ObservationStatus
|
|
1024
|
+
*/
|
|
1025
|
+
'ra': number;
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @type {number}
|
|
1029
|
+
* @memberof V1ObservationStatus
|
|
1030
|
+
*/
|
|
1031
|
+
'dec': number;
|
|
1032
|
+
/**
|
|
1033
|
+
*
|
|
1034
|
+
* @type {string}
|
|
1035
|
+
* @memberof V1ObservationStatus
|
|
1036
|
+
*/
|
|
1037
|
+
'observationTime': string;
|
|
1038
|
+
/**
|
|
1039
|
+
* TLE line 1 of when the observation was tasked
|
|
1040
|
+
* @type {string}
|
|
1041
|
+
* @memberof V1ObservationStatus
|
|
1042
|
+
*/
|
|
1043
|
+
'tleLine1': string;
|
|
1044
|
+
/**
|
|
1045
|
+
* TLE line 2 of when the observation was tasked
|
|
1046
|
+
* @type {string}
|
|
1047
|
+
* @memberof V1ObservationStatus
|
|
1048
|
+
*/
|
|
1049
|
+
'tleLine2': string;
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @type {string}
|
|
1053
|
+
* @memberof V1ObservationStatus
|
|
1054
|
+
*/
|
|
1055
|
+
'tleEpoch': string;
|
|
1056
|
+
/**
|
|
1057
|
+
*
|
|
1058
|
+
* @type {string}
|
|
1059
|
+
* @memberof V1ObservationStatus
|
|
1060
|
+
*/
|
|
1061
|
+
'imageSetId'?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
*
|
|
1064
|
+
* @type {string}
|
|
1065
|
+
* @memberof V1ObservationStatus
|
|
1066
|
+
*/
|
|
1067
|
+
'observationSequenceResultId'?: string;
|
|
1068
|
+
/**
|
|
1069
|
+
*
|
|
1070
|
+
* @type {string}
|
|
1071
|
+
* @memberof V1ObservationStatus
|
|
1072
|
+
*/
|
|
1073
|
+
'searchInstructionId'?: string;
|
|
1074
|
+
}
|
|
1075
|
+
|
|
1076
|
+
|
|
941
1077
|
/**
|
|
942
1078
|
*
|
|
943
1079
|
* @export
|
|
@@ -1065,6 +1201,31 @@ export interface V1SatelliteTarget {
|
|
|
1065
1201
|
}
|
|
1066
1202
|
|
|
1067
1203
|
|
|
1204
|
+
/**
|
|
1205
|
+
* Target Correlation
|
|
1206
|
+
* @export
|
|
1207
|
+
* @interface V1TargetCorrelation
|
|
1208
|
+
*/
|
|
1209
|
+
export interface V1TargetCorrelation {
|
|
1210
|
+
/**
|
|
1211
|
+
*
|
|
1212
|
+
* @type {string}
|
|
1213
|
+
* @memberof V1TargetCorrelation
|
|
1214
|
+
*/
|
|
1215
|
+
'targetId': string;
|
|
1216
|
+
/**
|
|
1217
|
+
*
|
|
1218
|
+
* @type {number}
|
|
1219
|
+
* @memberof V1TargetCorrelation
|
|
1220
|
+
*/
|
|
1221
|
+
'ra': number;
|
|
1222
|
+
/**
|
|
1223
|
+
*
|
|
1224
|
+
* @type {number}
|
|
1225
|
+
* @memberof V1TargetCorrelation
|
|
1226
|
+
*/
|
|
1227
|
+
'dec': number;
|
|
1228
|
+
}
|
|
1068
1229
|
/**
|
|
1069
1230
|
* TDM
|
|
1070
1231
|
* @export
|
|
@@ -1188,7 +1349,21 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
1188
1349
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1189
1350
|
*/
|
|
1190
1351
|
'events': Array<WebhookEvent>;
|
|
1352
|
+
/**
|
|
1353
|
+
*
|
|
1354
|
+
* @type {WebhookAuthType}
|
|
1355
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1356
|
+
*/
|
|
1357
|
+
'authType'?: WebhookAuthType;
|
|
1358
|
+
/**
|
|
1359
|
+
*
|
|
1360
|
+
* @type {string}
|
|
1361
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1362
|
+
*/
|
|
1363
|
+
'authorization'?: string;
|
|
1191
1364
|
}
|
|
1365
|
+
|
|
1366
|
+
|
|
1192
1367
|
/**
|
|
1193
1368
|
*
|
|
1194
1369
|
* @export
|
|
@@ -1227,7 +1402,22 @@ export interface V1WebhookConfiguration {
|
|
|
1227
1402
|
'createdAt': string;
|
|
1228
1403
|
}
|
|
1229
1404
|
/**
|
|
1230
|
-
*
|
|
1405
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1406
|
+
* @export
|
|
1407
|
+
* @enum {string}
|
|
1408
|
+
*/
|
|
1409
|
+
|
|
1410
|
+
export const WebhookAuthType = {
|
|
1411
|
+
NONE: 'NONE',
|
|
1412
|
+
BASIC: 'BASIC',
|
|
1413
|
+
BEARER: 'BEARER'
|
|
1414
|
+
} as const;
|
|
1415
|
+
|
|
1416
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1231
1421
|
* @export
|
|
1232
1422
|
* @enum {string}
|
|
1233
1423
|
*/
|
|
@@ -1238,7 +1428,8 @@ export const WebhookEvent = {
|
|
|
1238
1428
|
V1_OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
|
|
1239
1429
|
V1_IMAGE_CREATED: 'V1_IMAGE_CREATED',
|
|
1240
1430
|
V1_STREAK_CREATED: 'V1_STREAK_CREATED',
|
|
1241
|
-
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'
|
|
1431
|
+
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED',
|
|
1432
|
+
V1_EO_OBSERVATION_CREATED: 'V1_EO_OBSERVATION_CREATED'
|
|
1242
1433
|
} as const;
|
|
1243
1434
|
|
|
1244
1435
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
@@ -1457,7 +1648,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1457
1648
|
};
|
|
1458
1649
|
},
|
|
1459
1650
|
/**
|
|
1460
|
-
* 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
|
|
1651
|
+
* 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.
|
|
1461
1652
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1462
1653
|
* @param {*} [options] Override http request option.
|
|
1463
1654
|
* @throws {RequiredError}
|
|
@@ -1859,6 +2050,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1859
2050
|
|
|
1860
2051
|
|
|
1861
2052
|
|
|
2053
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2054
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2055
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2056
|
+
|
|
2057
|
+
return {
|
|
2058
|
+
url: toPathString(localVarUrlObj),
|
|
2059
|
+
options: localVarRequestOptions,
|
|
2060
|
+
};
|
|
2061
|
+
},
|
|
2062
|
+
/**
|
|
2063
|
+
* Get observation features.
|
|
2064
|
+
* @param {string} imageId
|
|
2065
|
+
* @param {*} [options] Override http request option.
|
|
2066
|
+
* @throws {RequiredError}
|
|
2067
|
+
*/
|
|
2068
|
+
v1GetObservationFeatures: async (imageId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2069
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
2070
|
+
assertParamExists('v1GetObservationFeatures', 'imageId', imageId)
|
|
2071
|
+
const localVarPath = `/v1/observation-features`;
|
|
2072
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2073
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2074
|
+
let baseOptions;
|
|
2075
|
+
if (configuration) {
|
|
2076
|
+
baseOptions = configuration.baseOptions;
|
|
2077
|
+
}
|
|
2078
|
+
|
|
2079
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2080
|
+
const localVarHeaderParameter = {} as any;
|
|
2081
|
+
const localVarQueryParameter = {} as any;
|
|
2082
|
+
|
|
2083
|
+
// authentication Roles required
|
|
2084
|
+
|
|
2085
|
+
// authentication BearerToken required
|
|
2086
|
+
// http bearer authentication required
|
|
2087
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2088
|
+
|
|
2089
|
+
if (imageId !== undefined) {
|
|
2090
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
2091
|
+
}
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
|
|
1862
2095
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1863
2096
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1864
2097
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -1906,6 +2139,58 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1906
2139
|
|
|
1907
2140
|
|
|
1908
2141
|
|
|
2142
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2143
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2144
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2145
|
+
|
|
2146
|
+
return {
|
|
2147
|
+
url: toPathString(localVarUrlObj),
|
|
2148
|
+
options: localVarRequestOptions,
|
|
2149
|
+
};
|
|
2150
|
+
},
|
|
2151
|
+
/**
|
|
2152
|
+
* 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.
|
|
2153
|
+
* @param {string} [targetId]
|
|
2154
|
+
* @param {string} [before]
|
|
2155
|
+
* @param {string} [searchInstructionId]
|
|
2156
|
+
* @param {*} [options] Override http request option.
|
|
2157
|
+
* @throws {RequiredError}
|
|
2158
|
+
*/
|
|
2159
|
+
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2160
|
+
const localVarPath = `/v1/observation-statuses`;
|
|
2161
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2162
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2163
|
+
let baseOptions;
|
|
2164
|
+
if (configuration) {
|
|
2165
|
+
baseOptions = configuration.baseOptions;
|
|
2166
|
+
}
|
|
2167
|
+
|
|
2168
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2169
|
+
const localVarHeaderParameter = {} as any;
|
|
2170
|
+
const localVarQueryParameter = {} as any;
|
|
2171
|
+
|
|
2172
|
+
// authentication Roles required
|
|
2173
|
+
|
|
2174
|
+
// authentication BearerToken required
|
|
2175
|
+
// http bearer authentication required
|
|
2176
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2177
|
+
|
|
2178
|
+
if (targetId !== undefined) {
|
|
2179
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
2180
|
+
}
|
|
2181
|
+
|
|
2182
|
+
if (before !== undefined) {
|
|
2183
|
+
localVarQueryParameter['before'] = (before as any instanceof Date) ?
|
|
2184
|
+
(before as any).toISOString() :
|
|
2185
|
+
before;
|
|
2186
|
+
}
|
|
2187
|
+
|
|
2188
|
+
if (searchInstructionId !== undefined) {
|
|
2189
|
+
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
2190
|
+
}
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
1909
2194
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1910
2195
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1911
2196
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2313,7 +2598,7 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2313
2598
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2314
2599
|
},
|
|
2315
2600
|
/**
|
|
2316
|
-
* 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
|
|
2601
|
+
* 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.
|
|
2317
2602
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
2318
2603
|
* @param {*} [options] Override http request option.
|
|
2319
2604
|
* @throws {RequiredError}
|
|
@@ -2411,6 +2696,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2411
2696
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetNodeProperties(nodeId, options);
|
|
2412
2697
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2413
2698
|
},
|
|
2699
|
+
/**
|
|
2700
|
+
* Get observation features.
|
|
2701
|
+
* @param {string} imageId
|
|
2702
|
+
* @param {*} [options] Override http request option.
|
|
2703
|
+
* @throws {RequiredError}
|
|
2704
|
+
*/
|
|
2705
|
+
async v1GetObservationFeatures(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationFeature>>> {
|
|
2706
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationFeatures(imageId, options);
|
|
2707
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2708
|
+
},
|
|
2414
2709
|
/**
|
|
2415
2710
|
* 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.
|
|
2416
2711
|
* @param {string} [targetId]
|
|
@@ -2422,6 +2717,18 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2422
2717
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationSequenceResults(targetId, after, options);
|
|
2423
2718
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2424
2719
|
},
|
|
2720
|
+
/**
|
|
2721
|
+
* 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.
|
|
2722
|
+
* @param {string} [targetId]
|
|
2723
|
+
* @param {string} [before]
|
|
2724
|
+
* @param {string} [searchInstructionId]
|
|
2725
|
+
* @param {*} [options] Override http request option.
|
|
2726
|
+
* @throws {RequiredError}
|
|
2727
|
+
*/
|
|
2728
|
+
async v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>> {
|
|
2729
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, options);
|
|
2730
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2731
|
+
},
|
|
2425
2732
|
/**
|
|
2426
2733
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2427
2734
|
* @param {*} [options] Override http request option.
|
|
@@ -2559,7 +2866,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2559
2866
|
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
2560
2867
|
},
|
|
2561
2868
|
/**
|
|
2562
|
-
* 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
|
|
2869
|
+
* 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.
|
|
2563
2870
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
2564
2871
|
* @param {*} [options] Override http request option.
|
|
2565
2872
|
* @throws {RequiredError}
|
|
@@ -2647,6 +2954,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2647
2954
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant> {
|
|
2648
2955
|
return localVarFp.v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(axios, basePath));
|
|
2649
2956
|
},
|
|
2957
|
+
/**
|
|
2958
|
+
* Get observation features.
|
|
2959
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
2960
|
+
* @param {*} [options] Override http request option.
|
|
2961
|
+
* @throws {RequiredError}
|
|
2962
|
+
*/
|
|
2963
|
+
v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationFeature>> {
|
|
2964
|
+
return localVarFp.v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
2965
|
+
},
|
|
2650
2966
|
/**
|
|
2651
2967
|
* 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.
|
|
2652
2968
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -2656,6 +2972,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2656
2972
|
v1GetObservationSequenceResults(requestParameters: DefaultApiV1GetObservationSequenceResultsRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>> {
|
|
2657
2973
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
2658
2974
|
},
|
|
2975
|
+
/**
|
|
2976
|
+
* 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.
|
|
2977
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
2978
|
+
* @param {*} [options] Override http request option.
|
|
2979
|
+
* @throws {RequiredError}
|
|
2980
|
+
*/
|
|
2981
|
+
v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
|
|
2982
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(axios, basePath));
|
|
2983
|
+
},
|
|
2659
2984
|
/**
|
|
2660
2985
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
2661
2986
|
* @param {*} [options] Override http request option.
|
|
@@ -2925,6 +3250,20 @@ export interface DefaultApiV1GetNodePropertiesRequest {
|
|
|
2925
3250
|
readonly nodeId: string
|
|
2926
3251
|
}
|
|
2927
3252
|
|
|
3253
|
+
/**
|
|
3254
|
+
* Request parameters for v1GetObservationFeatures operation in DefaultApi.
|
|
3255
|
+
* @export
|
|
3256
|
+
* @interface DefaultApiV1GetObservationFeaturesRequest
|
|
3257
|
+
*/
|
|
3258
|
+
export interface DefaultApiV1GetObservationFeaturesRequest {
|
|
3259
|
+
/**
|
|
3260
|
+
*
|
|
3261
|
+
* @type {string}
|
|
3262
|
+
* @memberof DefaultApiV1GetObservationFeatures
|
|
3263
|
+
*/
|
|
3264
|
+
readonly imageId: string
|
|
3265
|
+
}
|
|
3266
|
+
|
|
2928
3267
|
/**
|
|
2929
3268
|
* Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
|
|
2930
3269
|
* @export
|
|
@@ -2946,6 +3285,34 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
|
|
|
2946
3285
|
readonly after?: string
|
|
2947
3286
|
}
|
|
2948
3287
|
|
|
3288
|
+
/**
|
|
3289
|
+
* Request parameters for v1GetObservationStatuses operation in DefaultApi.
|
|
3290
|
+
* @export
|
|
3291
|
+
* @interface DefaultApiV1GetObservationStatusesRequest
|
|
3292
|
+
*/
|
|
3293
|
+
export interface DefaultApiV1GetObservationStatusesRequest {
|
|
3294
|
+
/**
|
|
3295
|
+
*
|
|
3296
|
+
* @type {string}
|
|
3297
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3298
|
+
*/
|
|
3299
|
+
readonly targetId?: string
|
|
3300
|
+
|
|
3301
|
+
/**
|
|
3302
|
+
*
|
|
3303
|
+
* @type {string}
|
|
3304
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3305
|
+
*/
|
|
3306
|
+
readonly before?: string
|
|
3307
|
+
|
|
3308
|
+
/**
|
|
3309
|
+
*
|
|
3310
|
+
* @type {string}
|
|
3311
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
3312
|
+
*/
|
|
3313
|
+
readonly searchInstructionId?: string
|
|
3314
|
+
}
|
|
3315
|
+
|
|
2949
3316
|
/**
|
|
2950
3317
|
* Request parameters for v1GetSatellitePotentials operation in DefaultApi.
|
|
2951
3318
|
* @export
|
|
@@ -3114,7 +3481,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
3114
3481
|
}
|
|
3115
3482
|
|
|
3116
3483
|
/**
|
|
3117
|
-
* 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
|
|
3484
|
+
* 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.
|
|
3118
3485
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
3119
3486
|
* @param {*} [options] Override http request option.
|
|
3120
3487
|
* @throws {RequiredError}
|
|
@@ -3222,6 +3589,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3222
3589
|
return DefaultApiFp(this.configuration).v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(this.axios, this.basePath));
|
|
3223
3590
|
}
|
|
3224
3591
|
|
|
3592
|
+
/**
|
|
3593
|
+
* Get observation features.
|
|
3594
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
3595
|
+
* @param {*} [options] Override http request option.
|
|
3596
|
+
* @throws {RequiredError}
|
|
3597
|
+
* @memberof DefaultApi
|
|
3598
|
+
*/
|
|
3599
|
+
public v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig) {
|
|
3600
|
+
return DefaultApiFp(this.configuration).v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
3601
|
+
}
|
|
3602
|
+
|
|
3225
3603
|
/**
|
|
3226
3604
|
* 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.
|
|
3227
3605
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -3233,6 +3611,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
3233
3611
|
return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3234
3612
|
}
|
|
3235
3613
|
|
|
3614
|
+
/**
|
|
3615
|
+
* 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.
|
|
3616
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
3617
|
+
* @param {*} [options] Override http request option.
|
|
3618
|
+
* @throws {RequiredError}
|
|
3619
|
+
* @memberof DefaultApi
|
|
3620
|
+
*/
|
|
3621
|
+
public v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig) {
|
|
3622
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
3623
|
+
}
|
|
3624
|
+
|
|
3236
3625
|
/**
|
|
3237
3626
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
3238
3627
|
* @param {*} [options] Override http request option.
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|