@ourskyai/sda-api 1.3.2584 → 1.3.2816
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +396 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +289 -6
- package/dist/api.js +159 -8
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +289 -6
- package/dist/esm/api.js +158 -7
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/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.2816
|
|
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}
|
|
@@ -620,6 +631,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
620
631
|
options: localVarRequestOptions,
|
|
621
632
|
};
|
|
622
633
|
}),
|
|
634
|
+
/**
|
|
635
|
+
* Get observation features.
|
|
636
|
+
* @param {string} imageId
|
|
637
|
+
* @param {*} [options] Override http request option.
|
|
638
|
+
* @throws {RequiredError}
|
|
639
|
+
*/
|
|
640
|
+
v1GetObservationFeatures: (imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
641
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
642
|
+
assertParamExists('v1GetObservationFeatures', 'imageId', imageId);
|
|
643
|
+
const localVarPath = `/v1/observation-features`;
|
|
644
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
645
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
646
|
+
let baseOptions;
|
|
647
|
+
if (configuration) {
|
|
648
|
+
baseOptions = configuration.baseOptions;
|
|
649
|
+
}
|
|
650
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
651
|
+
const localVarHeaderParameter = {};
|
|
652
|
+
const localVarQueryParameter = {};
|
|
653
|
+
// authentication Roles required
|
|
654
|
+
// authentication BearerToken required
|
|
655
|
+
// http bearer authentication required
|
|
656
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
657
|
+
if (imageId !== undefined) {
|
|
658
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
659
|
+
}
|
|
660
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
661
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
662
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
663
|
+
return {
|
|
664
|
+
url: toPathString(localVarUrlObj),
|
|
665
|
+
options: localVarRequestOptions,
|
|
666
|
+
};
|
|
667
|
+
}),
|
|
623
668
|
/**
|
|
624
669
|
* 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.
|
|
625
670
|
* @param {string} [targetId]
|
|
@@ -658,6 +703,48 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
658
703
|
options: localVarRequestOptions,
|
|
659
704
|
};
|
|
660
705
|
}),
|
|
706
|
+
/**
|
|
707
|
+
* 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.
|
|
708
|
+
* @param {string} [targetId]
|
|
709
|
+
* @param {string} [before]
|
|
710
|
+
* @param {string} [searchInstructionId]
|
|
711
|
+
* @param {*} [options] Override http request option.
|
|
712
|
+
* @throws {RequiredError}
|
|
713
|
+
*/
|
|
714
|
+
v1GetObservationStatuses: (targetId, before, searchInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
715
|
+
const localVarPath = `/v1/observation-statuses`;
|
|
716
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
717
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
718
|
+
let baseOptions;
|
|
719
|
+
if (configuration) {
|
|
720
|
+
baseOptions = configuration.baseOptions;
|
|
721
|
+
}
|
|
722
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
723
|
+
const localVarHeaderParameter = {};
|
|
724
|
+
const localVarQueryParameter = {};
|
|
725
|
+
// authentication Roles required
|
|
726
|
+
// authentication BearerToken required
|
|
727
|
+
// http bearer authentication required
|
|
728
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
729
|
+
if (targetId !== undefined) {
|
|
730
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
731
|
+
}
|
|
732
|
+
if (before !== undefined) {
|
|
733
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
734
|
+
before.toISOString() :
|
|
735
|
+
before;
|
|
736
|
+
}
|
|
737
|
+
if (searchInstructionId !== undefined) {
|
|
738
|
+
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
739
|
+
}
|
|
740
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
741
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
742
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
743
|
+
return {
|
|
744
|
+
url: toPathString(localVarUrlObj),
|
|
745
|
+
options: localVarRequestOptions,
|
|
746
|
+
};
|
|
747
|
+
}),
|
|
661
748
|
/**
|
|
662
749
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
663
750
|
* @param {*} [options] Override http request option.
|
|
@@ -1000,7 +1087,7 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1000
1087
|
});
|
|
1001
1088
|
},
|
|
1002
1089
|
/**
|
|
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
|
|
1090
|
+
* 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
1091
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
1005
1092
|
* @param {*} [options] Override http request option.
|
|
1006
1093
|
* @throws {RequiredError}
|
|
@@ -1118,6 +1205,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1118
1205
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1119
1206
|
});
|
|
1120
1207
|
},
|
|
1208
|
+
/**
|
|
1209
|
+
* Get observation features.
|
|
1210
|
+
* @param {string} imageId
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
*/
|
|
1214
|
+
v1GetObservationFeatures(imageId, options) {
|
|
1215
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1216
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationFeatures(imageId, options);
|
|
1217
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1218
|
+
});
|
|
1219
|
+
},
|
|
1121
1220
|
/**
|
|
1122
1221
|
* 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.
|
|
1123
1222
|
* @param {string} [targetId]
|
|
@@ -1131,6 +1230,20 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1131
1230
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1132
1231
|
});
|
|
1133
1232
|
},
|
|
1233
|
+
/**
|
|
1234
|
+
* 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.
|
|
1235
|
+
* @param {string} [targetId]
|
|
1236
|
+
* @param {string} [before]
|
|
1237
|
+
* @param {string} [searchInstructionId]
|
|
1238
|
+
* @param {*} [options] Override http request option.
|
|
1239
|
+
* @throws {RequiredError}
|
|
1240
|
+
*/
|
|
1241
|
+
v1GetObservationStatuses(targetId, before, searchInstructionId, options) {
|
|
1242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1243
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, options);
|
|
1244
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1245
|
+
});
|
|
1246
|
+
},
|
|
1134
1247
|
/**
|
|
1135
1248
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1136
1249
|
* @param {*} [options] Override http request option.
|
|
@@ -1283,7 +1396,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1283
1396
|
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1284
1397
|
},
|
|
1285
1398
|
/**
|
|
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
|
|
1399
|
+
* 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
1400
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1288
1401
|
* @param {*} [options] Override http request option.
|
|
1289
1402
|
* @throws {RequiredError}
|
|
@@ -1371,6 +1484,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1371
1484
|
v1GetNodeProperties(requestParameters, options) {
|
|
1372
1485
|
return localVarFp.v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(axios, basePath));
|
|
1373
1486
|
},
|
|
1487
|
+
/**
|
|
1488
|
+
* Get observation features.
|
|
1489
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
1490
|
+
* @param {*} [options] Override http request option.
|
|
1491
|
+
* @throws {RequiredError}
|
|
1492
|
+
*/
|
|
1493
|
+
v1GetObservationFeatures(requestParameters, options) {
|
|
1494
|
+
return localVarFp.v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
1495
|
+
},
|
|
1374
1496
|
/**
|
|
1375
1497
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1376
1498
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -1380,6 +1502,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1380
1502
|
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
1381
1503
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
1382
1504
|
},
|
|
1505
|
+
/**
|
|
1506
|
+
* 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.
|
|
1507
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1508
|
+
* @param {*} [options] Override http request option.
|
|
1509
|
+
* @throws {RequiredError}
|
|
1510
|
+
*/
|
|
1511
|
+
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1512
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(axios, basePath));
|
|
1513
|
+
},
|
|
1383
1514
|
/**
|
|
1384
1515
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1385
1516
|
* @param {*} [options] Override http request option.
|
|
@@ -1510,7 +1641,7 @@ export class DefaultApi extends BaseAPI {
|
|
|
1510
1641
|
return DefaultApiFp(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1511
1642
|
}
|
|
1512
1643
|
/**
|
|
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
|
|
1644
|
+
* 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
1645
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1515
1646
|
* @param {*} [options] Override http request option.
|
|
1516
1647
|
* @throws {RequiredError}
|
|
@@ -1608,6 +1739,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
1608
1739
|
v1GetNodeProperties(requestParameters, options) {
|
|
1609
1740
|
return DefaultApiFp(this.configuration).v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(this.axios, this.basePath));
|
|
1610
1741
|
}
|
|
1742
|
+
/**
|
|
1743
|
+
* Get observation features.
|
|
1744
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
1745
|
+
* @param {*} [options] Override http request option.
|
|
1746
|
+
* @throws {RequiredError}
|
|
1747
|
+
* @memberof DefaultApi
|
|
1748
|
+
*/
|
|
1749
|
+
v1GetObservationFeatures(requestParameters, options) {
|
|
1750
|
+
return DefaultApiFp(this.configuration).v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
1751
|
+
}
|
|
1611
1752
|
/**
|
|
1612
1753
|
* 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.
|
|
1613
1754
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -1618,6 +1759,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
1618
1759
|
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
1619
1760
|
return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
1620
1761
|
}
|
|
1762
|
+
/**
|
|
1763
|
+
* 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.
|
|
1764
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1765
|
+
* @param {*} [options] Override http request option.
|
|
1766
|
+
* @throws {RequiredError}
|
|
1767
|
+
* @memberof DefaultApi
|
|
1768
|
+
*/
|
|
1769
|
+
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1770
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
1771
|
+
}
|
|
1621
1772
|
/**
|
|
1622
1773
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1623
1774
|
* @param {*} [options] Override http request option.
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
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.2816
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|