@ourskyai/sda-api 1.3.2584 → 1.3.2765
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +117 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +110 -6
- package/dist/api.js +19 -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 +110 -6
- package/dist/esm/api.js +18 -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.2765
|
|
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.2765 --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.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -179,6 +179,55 @@ export interface ObservationBoundingBox {
|
|
|
179
179
|
*/
|
|
180
180
|
'endY': number;
|
|
181
181
|
}
|
|
182
|
+
/**
|
|
183
|
+
* Observation Feature
|
|
184
|
+
* @export
|
|
185
|
+
* @interface ObservationFeature
|
|
186
|
+
*/
|
|
187
|
+
export interface ObservationFeature {
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @type {number}
|
|
191
|
+
* @memberof ObservationFeature
|
|
192
|
+
*/
|
|
193
|
+
'ra': number;
|
|
194
|
+
/**
|
|
195
|
+
*
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof ObservationFeature
|
|
198
|
+
*/
|
|
199
|
+
'dec': number;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {string}
|
|
203
|
+
* @memberof ObservationFeature
|
|
204
|
+
*/
|
|
205
|
+
'timestamp': string;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {ObservationBoundingBox}
|
|
209
|
+
* @memberof ObservationFeature
|
|
210
|
+
*/
|
|
211
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
212
|
+
/**
|
|
213
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
214
|
+
* @type {number}
|
|
215
|
+
* @memberof ObservationFeature
|
|
216
|
+
*/
|
|
217
|
+
'apparentMagnitude'?: number;
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @type {number}
|
|
221
|
+
* @memberof ObservationFeature
|
|
222
|
+
*/
|
|
223
|
+
'distanceFromPrediction'?: number;
|
|
224
|
+
/**
|
|
225
|
+
*
|
|
226
|
+
* @type {Array<TargetCorrelation>}
|
|
227
|
+
* @memberof ObservationFeature
|
|
228
|
+
*/
|
|
229
|
+
'targetCorrelations'?: Array<TargetCorrelation>;
|
|
230
|
+
}
|
|
182
231
|
/**
|
|
183
232
|
*
|
|
184
233
|
* @export
|
|
@@ -276,6 +325,12 @@ export interface ObservationResult {
|
|
|
276
325
|
* @memberof ObservationResult
|
|
277
326
|
*/
|
|
278
327
|
'distanceFromPrediction'?: number;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {Array<ObservationFeature>}
|
|
331
|
+
* @memberof ObservationResult
|
|
332
|
+
*/
|
|
333
|
+
'features'?: Array<ObservationFeature>;
|
|
279
334
|
}
|
|
280
335
|
/**
|
|
281
336
|
*
|
|
@@ -339,6 +394,31 @@ export interface SuccessfulCreate {
|
|
|
339
394
|
*/
|
|
340
395
|
'id': string;
|
|
341
396
|
}
|
|
397
|
+
/**
|
|
398
|
+
* Target Correlation
|
|
399
|
+
* @export
|
|
400
|
+
* @interface TargetCorrelation
|
|
401
|
+
*/
|
|
402
|
+
export interface TargetCorrelation {
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @type {string}
|
|
406
|
+
* @memberof TargetCorrelation
|
|
407
|
+
*/
|
|
408
|
+
'targetId': string;
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @type {number}
|
|
412
|
+
* @memberof TargetCorrelation
|
|
413
|
+
*/
|
|
414
|
+
'ra': number;
|
|
415
|
+
/**
|
|
416
|
+
*
|
|
417
|
+
* @type {number}
|
|
418
|
+
* @memberof TargetCorrelation
|
|
419
|
+
*/
|
|
420
|
+
'dec': number;
|
|
421
|
+
}
|
|
342
422
|
/**
|
|
343
423
|
*
|
|
344
424
|
* @export
|
|
@@ -1188,7 +1268,21 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
1188
1268
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1189
1269
|
*/
|
|
1190
1270
|
'events': Array<WebhookEvent>;
|
|
1271
|
+
/**
|
|
1272
|
+
*
|
|
1273
|
+
* @type {WebhookAuthType}
|
|
1274
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1275
|
+
*/
|
|
1276
|
+
'authType'?: WebhookAuthType;
|
|
1277
|
+
/**
|
|
1278
|
+
*
|
|
1279
|
+
* @type {string}
|
|
1280
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1281
|
+
*/
|
|
1282
|
+
'authorization'?: string;
|
|
1191
1283
|
}
|
|
1284
|
+
|
|
1285
|
+
|
|
1192
1286
|
/**
|
|
1193
1287
|
*
|
|
1194
1288
|
* @export
|
|
@@ -1227,7 +1321,22 @@ export interface V1WebhookConfiguration {
|
|
|
1227
1321
|
'createdAt': string;
|
|
1228
1322
|
}
|
|
1229
1323
|
/**
|
|
1230
|
-
*
|
|
1324
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1325
|
+
* @export
|
|
1326
|
+
* @enum {string}
|
|
1327
|
+
*/
|
|
1328
|
+
|
|
1329
|
+
export const WebhookAuthType = {
|
|
1330
|
+
NONE: 'NONE',
|
|
1331
|
+
BASIC: 'BASIC',
|
|
1332
|
+
BEARER: 'BEARER'
|
|
1333
|
+
} as const;
|
|
1334
|
+
|
|
1335
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
/**
|
|
1339
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1231
1340
|
* @export
|
|
1232
1341
|
* @enum {string}
|
|
1233
1342
|
*/
|
|
@@ -1238,7 +1347,8 @@ export const WebhookEvent = {
|
|
|
1238
1347
|
V1_OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
|
|
1239
1348
|
V1_IMAGE_CREATED: 'V1_IMAGE_CREATED',
|
|
1240
1349
|
V1_STREAK_CREATED: 'V1_STREAK_CREATED',
|
|
1241
|
-
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'
|
|
1350
|
+
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED',
|
|
1351
|
+
V1_EO_OBSERVATION_CREATED: 'V1_EO_OBSERVATION_CREATED'
|
|
1242
1352
|
} as const;
|
|
1243
1353
|
|
|
1244
1354
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
@@ -1457,7 +1567,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1457
1567
|
};
|
|
1458
1568
|
},
|
|
1459
1569
|
/**
|
|
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
|
|
1570
|
+
* 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
1571
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1462
1572
|
* @param {*} [options] Override http request option.
|
|
1463
1573
|
* @throws {RequiredError}
|
|
@@ -2313,7 +2423,7 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2313
2423
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2314
2424
|
},
|
|
2315
2425
|
/**
|
|
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
|
|
2426
|
+
* 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
2427
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
2318
2428
|
* @param {*} [options] Override http request option.
|
|
2319
2429
|
* @throws {RequiredError}
|
|
@@ -2559,7 +2669,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2559
2669
|
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
2560
2670
|
},
|
|
2561
2671
|
/**
|
|
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
|
|
2672
|
+
* 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
2673
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
2564
2674
|
* @param {*} [options] Override http request option.
|
|
2565
2675
|
* @throws {RequiredError}
|
|
@@ -3114,7 +3224,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
3114
3224
|
}
|
|
3115
3225
|
|
|
3116
3226
|
/**
|
|
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
|
|
3227
|
+
* 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
3228
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
3119
3229
|
* @param {*} [options] Override http request option.
|
|
3120
3230
|
* @throws {RequiredError}
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -161,6 +161,55 @@ export interface ObservationBoundingBox {
|
|
|
161
161
|
*/
|
|
162
162
|
'endY': number;
|
|
163
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Observation Feature
|
|
166
|
+
* @export
|
|
167
|
+
* @interface ObservationFeature
|
|
168
|
+
*/
|
|
169
|
+
export interface ObservationFeature {
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof ObservationFeature
|
|
174
|
+
*/
|
|
175
|
+
'ra': number;
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @type {number}
|
|
179
|
+
* @memberof ObservationFeature
|
|
180
|
+
*/
|
|
181
|
+
'dec': number;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof ObservationFeature
|
|
186
|
+
*/
|
|
187
|
+
'timestamp': string;
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @type {ObservationBoundingBox}
|
|
191
|
+
* @memberof ObservationFeature
|
|
192
|
+
*/
|
|
193
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
194
|
+
/**
|
|
195
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof ObservationFeature
|
|
198
|
+
*/
|
|
199
|
+
'apparentMagnitude'?: number;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {number}
|
|
203
|
+
* @memberof ObservationFeature
|
|
204
|
+
*/
|
|
205
|
+
'distanceFromPrediction'?: number;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {Array<TargetCorrelation>}
|
|
209
|
+
* @memberof ObservationFeature
|
|
210
|
+
*/
|
|
211
|
+
'targetCorrelations'?: Array<TargetCorrelation>;
|
|
212
|
+
}
|
|
164
213
|
/**
|
|
165
214
|
*
|
|
166
215
|
* @export
|
|
@@ -258,6 +307,12 @@ export interface ObservationResult {
|
|
|
258
307
|
* @memberof ObservationResult
|
|
259
308
|
*/
|
|
260
309
|
'distanceFromPrediction'?: number;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {Array<ObservationFeature>}
|
|
313
|
+
* @memberof ObservationResult
|
|
314
|
+
*/
|
|
315
|
+
'features'?: Array<ObservationFeature>;
|
|
261
316
|
}
|
|
262
317
|
/**
|
|
263
318
|
*
|
|
@@ -309,6 +364,31 @@ export interface SuccessfulCreate {
|
|
|
309
364
|
*/
|
|
310
365
|
'id': string;
|
|
311
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Target Correlation
|
|
369
|
+
* @export
|
|
370
|
+
* @interface TargetCorrelation
|
|
371
|
+
*/
|
|
372
|
+
export interface TargetCorrelation {
|
|
373
|
+
/**
|
|
374
|
+
*
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof TargetCorrelation
|
|
377
|
+
*/
|
|
378
|
+
'targetId': string;
|
|
379
|
+
/**
|
|
380
|
+
*
|
|
381
|
+
* @type {number}
|
|
382
|
+
* @memberof TargetCorrelation
|
|
383
|
+
*/
|
|
384
|
+
'ra': number;
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @type {number}
|
|
388
|
+
* @memberof TargetCorrelation
|
|
389
|
+
*/
|
|
390
|
+
'dec': number;
|
|
391
|
+
}
|
|
312
392
|
/**
|
|
313
393
|
*
|
|
314
394
|
* @export
|
|
@@ -1142,6 +1222,18 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
1142
1222
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1143
1223
|
*/
|
|
1144
1224
|
'events': Array<WebhookEvent>;
|
|
1225
|
+
/**
|
|
1226
|
+
*
|
|
1227
|
+
* @type {WebhookAuthType}
|
|
1228
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1229
|
+
*/
|
|
1230
|
+
'authType'?: WebhookAuthType;
|
|
1231
|
+
/**
|
|
1232
|
+
*
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1235
|
+
*/
|
|
1236
|
+
'authorization'?: string;
|
|
1145
1237
|
}
|
|
1146
1238
|
/**
|
|
1147
1239
|
*
|
|
@@ -1181,7 +1273,18 @@ export interface V1WebhookConfiguration {
|
|
|
1181
1273
|
'createdAt': string;
|
|
1182
1274
|
}
|
|
1183
1275
|
/**
|
|
1184
|
-
*
|
|
1276
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1277
|
+
* @export
|
|
1278
|
+
* @enum {string}
|
|
1279
|
+
*/
|
|
1280
|
+
export declare const WebhookAuthType: {
|
|
1281
|
+
readonly NONE: "NONE";
|
|
1282
|
+
readonly BASIC: "BASIC";
|
|
1283
|
+
readonly BEARER: "BEARER";
|
|
1284
|
+
};
|
|
1285
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1286
|
+
/**
|
|
1287
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1185
1288
|
* @export
|
|
1186
1289
|
* @enum {string}
|
|
1187
1290
|
*/
|
|
@@ -1192,6 +1295,7 @@ export declare const WebhookEvent: {
|
|
|
1192
1295
|
readonly V1_IMAGE_CREATED: "V1_IMAGE_CREATED";
|
|
1193
1296
|
readonly V1_STREAK_CREATED: "V1_STREAK_CREATED";
|
|
1194
1297
|
readonly V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: "V1_SATELLITE_TARGET_TRACKING_DEACTIVATED";
|
|
1298
|
+
readonly V1_EO_OBSERVATION_CREATED: "V1_EO_OBSERVATION_CREATED";
|
|
1195
1299
|
};
|
|
1196
1300
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
1197
1301
|
/**
|
|
@@ -1235,7 +1339,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1235
1339
|
*/
|
|
1236
1340
|
v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1237
1341
|
/**
|
|
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
|
|
1342
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1239
1343
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1240
1344
|
* @param {*} [options] Override http request option.
|
|
1241
1345
|
* @throws {RequiredError}
|
|
@@ -1410,7 +1514,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1410
1514
|
*/
|
|
1411
1515
|
v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1412
1516
|
/**
|
|
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
|
|
1517
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1414
1518
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1415
1519
|
* @param {*} [options] Override http request option.
|
|
1416
1520
|
* @throws {RequiredError}
|
|
@@ -1585,7 +1689,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1585
1689
|
*/
|
|
1586
1690
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1587
1691
|
/**
|
|
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
|
|
1692
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1589
1693
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1590
1694
|
* @param {*} [options] Override http request option.
|
|
1591
1695
|
* @throws {RequiredError}
|
|
@@ -2060,7 +2164,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2060
2164
|
*/
|
|
2061
2165
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2062
2166
|
/**
|
|
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
|
|
2167
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
2064
2168
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
2065
2169
|
* @param {*} [options] Override http request option.
|
|
2066
2170
|
* @throws {RequiredError}
|
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.2765
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.TrackingType = exports.ShutterType = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.MountType = exports.FilterType = void 0;
|
|
25
|
+
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WebhookEvent = exports.WebhookAuthType = exports.TrackingType = exports.ShutterType = exports.SatelliteTargetTrackingStatus = exports.OrbitType = exports.MountType = exports.FilterType = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -107,7 +107,17 @@ exports.TrackingType = {
|
|
|
107
107
|
TARGET_RATE: 'TARGET_RATE'
|
|
108
108
|
};
|
|
109
109
|
/**
|
|
110
|
-
*
|
|
110
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
111
|
+
* @export
|
|
112
|
+
* @enum {string}
|
|
113
|
+
*/
|
|
114
|
+
exports.WebhookAuthType = {
|
|
115
|
+
NONE: 'NONE',
|
|
116
|
+
BASIC: 'BASIC',
|
|
117
|
+
BEARER: 'BEARER'
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
111
121
|
* @export
|
|
112
122
|
* @enum {string}
|
|
113
123
|
*/
|
|
@@ -117,7 +127,8 @@ exports.WebhookEvent = {
|
|
|
117
127
|
V1_OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
|
|
118
128
|
V1_IMAGE_CREATED: 'V1_IMAGE_CREATED',
|
|
119
129
|
V1_STREAK_CREATED: 'V1_STREAK_CREATED',
|
|
120
|
-
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'
|
|
130
|
+
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED',
|
|
131
|
+
V1_EO_OBSERVATION_CREATED: 'V1_EO_OBSERVATION_CREATED'
|
|
121
132
|
};
|
|
122
133
|
/**
|
|
123
134
|
* DefaultApi - axios parameter creator
|
|
@@ -291,7 +302,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
291
302
|
};
|
|
292
303
|
}),
|
|
293
304
|
/**
|
|
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
|
|
305
|
+
* 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.
|
|
295
306
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
296
307
|
* @param {*} [options] Override http request option.
|
|
297
308
|
* @throws {RequiredError}
|
|
@@ -1004,7 +1015,7 @@ const DefaultApiFp = function (configuration) {
|
|
|
1004
1015
|
});
|
|
1005
1016
|
},
|
|
1006
1017
|
/**
|
|
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
|
|
1018
|
+
* 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.
|
|
1008
1019
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1009
1020
|
* @param {*} [options] Override http request option.
|
|
1010
1021
|
* @throws {RequiredError}
|
|
@@ -1288,7 +1299,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1288
1299
|
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1289
1300
|
},
|
|
1290
1301
|
/**
|
|
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
|
|
1302
|
+
* 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.
|
|
1292
1303
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1293
1304
|
* @param {*} [options] Override http request option.
|
|
1294
1305
|
* @throws {RequiredError}
|
|
@@ -1516,7 +1527,7 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1516
1527
|
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1517
1528
|
}
|
|
1518
1529
|
/**
|
|
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
|
|
1530
|
+
* 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.
|
|
1520
1531
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1521
1532
|
* @param {*} [options] Override http request option.
|
|
1522
1533
|
* @throws {RequiredError}
|
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.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.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.2765
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.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.2765
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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.2765
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -161,6 +161,55 @@ export interface ObservationBoundingBox {
|
|
|
161
161
|
*/
|
|
162
162
|
'endY': number;
|
|
163
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Observation Feature
|
|
166
|
+
* @export
|
|
167
|
+
* @interface ObservationFeature
|
|
168
|
+
*/
|
|
169
|
+
export interface ObservationFeature {
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @type {number}
|
|
173
|
+
* @memberof ObservationFeature
|
|
174
|
+
*/
|
|
175
|
+
'ra': number;
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @type {number}
|
|
179
|
+
* @memberof ObservationFeature
|
|
180
|
+
*/
|
|
181
|
+
'dec': number;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof ObservationFeature
|
|
186
|
+
*/
|
|
187
|
+
'timestamp': string;
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @type {ObservationBoundingBox}
|
|
191
|
+
* @memberof ObservationFeature
|
|
192
|
+
*/
|
|
193
|
+
'boundingBox'?: ObservationBoundingBox;
|
|
194
|
+
/**
|
|
195
|
+
* BETA: the apparent magnitude of the target at the time of the observation
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof ObservationFeature
|
|
198
|
+
*/
|
|
199
|
+
'apparentMagnitude'?: number;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {number}
|
|
203
|
+
* @memberof ObservationFeature
|
|
204
|
+
*/
|
|
205
|
+
'distanceFromPrediction'?: number;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {Array<TargetCorrelation>}
|
|
209
|
+
* @memberof ObservationFeature
|
|
210
|
+
*/
|
|
211
|
+
'targetCorrelations'?: Array<TargetCorrelation>;
|
|
212
|
+
}
|
|
164
213
|
/**
|
|
165
214
|
*
|
|
166
215
|
* @export
|
|
@@ -258,6 +307,12 @@ export interface ObservationResult {
|
|
|
258
307
|
* @memberof ObservationResult
|
|
259
308
|
*/
|
|
260
309
|
'distanceFromPrediction'?: number;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {Array<ObservationFeature>}
|
|
313
|
+
* @memberof ObservationResult
|
|
314
|
+
*/
|
|
315
|
+
'features'?: Array<ObservationFeature>;
|
|
261
316
|
}
|
|
262
317
|
/**
|
|
263
318
|
*
|
|
@@ -309,6 +364,31 @@ export interface SuccessfulCreate {
|
|
|
309
364
|
*/
|
|
310
365
|
'id': string;
|
|
311
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Target Correlation
|
|
369
|
+
* @export
|
|
370
|
+
* @interface TargetCorrelation
|
|
371
|
+
*/
|
|
372
|
+
export interface TargetCorrelation {
|
|
373
|
+
/**
|
|
374
|
+
*
|
|
375
|
+
* @type {string}
|
|
376
|
+
* @memberof TargetCorrelation
|
|
377
|
+
*/
|
|
378
|
+
'targetId': string;
|
|
379
|
+
/**
|
|
380
|
+
*
|
|
381
|
+
* @type {number}
|
|
382
|
+
* @memberof TargetCorrelation
|
|
383
|
+
*/
|
|
384
|
+
'ra': number;
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @type {number}
|
|
388
|
+
* @memberof TargetCorrelation
|
|
389
|
+
*/
|
|
390
|
+
'dec': number;
|
|
391
|
+
}
|
|
312
392
|
/**
|
|
313
393
|
*
|
|
314
394
|
* @export
|
|
@@ -1142,6 +1222,18 @@ export interface V1UpdateWebhookConfigurationRequest {
|
|
|
1142
1222
|
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1143
1223
|
*/
|
|
1144
1224
|
'events': Array<WebhookEvent>;
|
|
1225
|
+
/**
|
|
1226
|
+
*
|
|
1227
|
+
* @type {WebhookAuthType}
|
|
1228
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1229
|
+
*/
|
|
1230
|
+
'authType'?: WebhookAuthType;
|
|
1231
|
+
/**
|
|
1232
|
+
*
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof V1UpdateWebhookConfigurationRequest
|
|
1235
|
+
*/
|
|
1236
|
+
'authorization'?: string;
|
|
1145
1237
|
}
|
|
1146
1238
|
/**
|
|
1147
1239
|
*
|
|
@@ -1181,7 +1273,18 @@ export interface V1WebhookConfiguration {
|
|
|
1181
1273
|
'createdAt': string;
|
|
1182
1274
|
}
|
|
1183
1275
|
/**
|
|
1184
|
-
*
|
|
1276
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
1277
|
+
* @export
|
|
1278
|
+
* @enum {string}
|
|
1279
|
+
*/
|
|
1280
|
+
export declare const WebhookAuthType: {
|
|
1281
|
+
readonly NONE: "NONE";
|
|
1282
|
+
readonly BASIC: "BASIC";
|
|
1283
|
+
readonly BEARER: "BEARER";
|
|
1284
|
+
};
|
|
1285
|
+
export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
|
|
1286
|
+
/**
|
|
1287
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
1185
1288
|
* @export
|
|
1186
1289
|
* @enum {string}
|
|
1187
1290
|
*/
|
|
@@ -1192,6 +1295,7 @@ export declare const WebhookEvent: {
|
|
|
1192
1295
|
readonly V1_IMAGE_CREATED: "V1_IMAGE_CREATED";
|
|
1193
1296
|
readonly V1_STREAK_CREATED: "V1_STREAK_CREATED";
|
|
1194
1297
|
readonly V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: "V1_SATELLITE_TARGET_TRACKING_DEACTIVATED";
|
|
1298
|
+
readonly V1_EO_OBSERVATION_CREATED: "V1_EO_OBSERVATION_CREATED";
|
|
1195
1299
|
};
|
|
1196
1300
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
1197
1301
|
/**
|
|
@@ -1235,7 +1339,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1235
1339
|
*/
|
|
1236
1340
|
v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1237
1341
|
/**
|
|
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
|
|
1342
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1239
1343
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1240
1344
|
* @param {*} [options] Override http request option.
|
|
1241
1345
|
* @throws {RequiredError}
|
|
@@ -1410,7 +1514,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
1410
1514
|
*/
|
|
1411
1515
|
v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
1412
1516
|
/**
|
|
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
|
|
1517
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1414
1518
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1415
1519
|
* @param {*} [options] Override http request option.
|
|
1416
1520
|
* @throws {RequiredError}
|
|
@@ -1585,7 +1689,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
1585
1689
|
*/
|
|
1586
1690
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
1587
1691
|
/**
|
|
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
|
|
1692
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
1589
1693
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1590
1694
|
* @param {*} [options] Override http request option.
|
|
1591
1695
|
* @throws {RequiredError}
|
|
@@ -2060,7 +2164,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
2060
2164
|
*/
|
|
2061
2165
|
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
2062
2166
|
/**
|
|
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
|
|
2167
|
+
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
|
|
2064
2168
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
2065
2169
|
* @param {*} [options] Override http request option.
|
|
2066
2170
|
* @throws {RequiredError}
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -104,7 +104,17 @@ export const TrackingType = {
|
|
|
104
104
|
TARGET_RATE: 'TARGET_RATE'
|
|
105
105
|
};
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
108
|
+
* @export
|
|
109
|
+
* @enum {string}
|
|
110
|
+
*/
|
|
111
|
+
export const WebhookAuthType = {
|
|
112
|
+
NONE: 'NONE',
|
|
113
|
+
BASIC: 'BASIC',
|
|
114
|
+
BEARER: 'BEARER'
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
108
118
|
* @export
|
|
109
119
|
* @enum {string}
|
|
110
120
|
*/
|
|
@@ -114,7 +124,8 @@ export const WebhookEvent = {
|
|
|
114
124
|
V1_OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
|
|
115
125
|
V1_IMAGE_CREATED: 'V1_IMAGE_CREATED',
|
|
116
126
|
V1_STREAK_CREATED: 'V1_STREAK_CREATED',
|
|
117
|
-
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'
|
|
127
|
+
V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED',
|
|
128
|
+
V1_EO_OBSERVATION_CREATED: 'V1_EO_OBSERVATION_CREATED'
|
|
118
129
|
};
|
|
119
130
|
/**
|
|
120
131
|
* DefaultApi - axios parameter creator
|
|
@@ -288,7 +299,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
288
299
|
};
|
|
289
300
|
}),
|
|
290
301
|
/**
|
|
291
|
-
* 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
|
|
302
|
+
* 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.
|
|
292
303
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
293
304
|
* @param {*} [options] Override http request option.
|
|
294
305
|
* @throws {RequiredError}
|
|
@@ -1000,7 +1011,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1000
1011
|
});
|
|
1001
1012
|
},
|
|
1002
1013
|
/**
|
|
1003
|
-
* 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
|
|
1014
|
+
* 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.
|
|
1004
1015
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1005
1016
|
* @param {*} [options] Override http request option.
|
|
1006
1017
|
* @throws {RequiredError}
|
|
@@ -1283,7 +1294,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1283
1294
|
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1284
1295
|
},
|
|
1285
1296
|
/**
|
|
1286
|
-
* 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
|
|
1297
|
+
* 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.
|
|
1287
1298
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1288
1299
|
* @param {*} [options] Override http request option.
|
|
1289
1300
|
* @throws {RequiredError}
|
|
@@ -1510,7 +1521,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
1510
1521
|
return DefaultApiFp(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1511
1522
|
}
|
|
1512
1523
|
/**
|
|
1513
|
-
* 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
|
|
1524
|
+
* 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.
|
|
1514
1525
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1515
1526
|
* @param {*} [options] Override http request option.
|
|
1516
1527
|
* @throws {RequiredError}
|
package/dist/esm/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.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.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.2765
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2765
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|