@ourskyai/sda-api 1.3.2437 → 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 +547 -7
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +409 -6
- package/dist/api.js +211 -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 +409 -6
- package/dist/esm/api.js +210 -7
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.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
|
|
@@ -225,7 +236,73 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
225
236
|
};
|
|
226
237
|
}),
|
|
227
238
|
/**
|
|
228
|
-
* Create
|
|
239
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
240
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
241
|
+
* @param {*} [options] Override http request option.
|
|
242
|
+
* @throws {RequiredError}
|
|
243
|
+
*/
|
|
244
|
+
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
245
|
+
// verify required parameter 'v1CreateSatelliteTargetRequest' is not null or undefined
|
|
246
|
+
(0, common_1.assertParamExists)('v1CreateSatelliteTarget', 'v1CreateSatelliteTargetRequest', v1CreateSatelliteTargetRequest);
|
|
247
|
+
const localVarPath = `/v1/satellite-target`;
|
|
248
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
249
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
250
|
+
let baseOptions;
|
|
251
|
+
if (configuration) {
|
|
252
|
+
baseOptions = configuration.baseOptions;
|
|
253
|
+
}
|
|
254
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
255
|
+
const localVarHeaderParameter = {};
|
|
256
|
+
const localVarQueryParameter = {};
|
|
257
|
+
// authentication Roles required
|
|
258
|
+
// authentication BearerToken required
|
|
259
|
+
// http bearer authentication required
|
|
260
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
261
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
262
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
263
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
264
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
265
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
266
|
+
return {
|
|
267
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
268
|
+
options: localVarRequestOptions,
|
|
269
|
+
};
|
|
270
|
+
}),
|
|
271
|
+
/**
|
|
272
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
273
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
v1CreateSearchTask: (v1CreateSearchTaskRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
278
|
+
// verify required parameter 'v1CreateSearchTaskRequest' is not null or undefined
|
|
279
|
+
(0, common_1.assertParamExists)('v1CreateSearchTask', 'v1CreateSearchTaskRequest', v1CreateSearchTaskRequest);
|
|
280
|
+
const localVarPath = `/v1/search-instruction`;
|
|
281
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
282
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
283
|
+
let baseOptions;
|
|
284
|
+
if (configuration) {
|
|
285
|
+
baseOptions = configuration.baseOptions;
|
|
286
|
+
}
|
|
287
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
288
|
+
const localVarHeaderParameter = {};
|
|
289
|
+
const localVarQueryParameter = {};
|
|
290
|
+
// authentication Roles required
|
|
291
|
+
// authentication BearerToken required
|
|
292
|
+
// http bearer authentication required
|
|
293
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
294
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
295
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
296
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
297
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
298
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSearchTaskRequest, localVarRequestOptions, configuration);
|
|
299
|
+
return {
|
|
300
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
301
|
+
options: localVarRequestOptions,
|
|
302
|
+
};
|
|
303
|
+
}),
|
|
304
|
+
/**
|
|
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.
|
|
229
306
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
230
307
|
* @param {*} [options] Override http request option.
|
|
231
308
|
* @throws {RequiredError}
|
|
@@ -834,6 +911,39 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
834
911
|
options: localVarRequestOptions,
|
|
835
912
|
};
|
|
836
913
|
}),
|
|
914
|
+
/**
|
|
915
|
+
* Update satellite target.
|
|
916
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
917
|
+
* @param {*} [options] Override http request option.
|
|
918
|
+
* @throws {RequiredError}
|
|
919
|
+
*/
|
|
920
|
+
v1UpdateSatelliteTarget: (v1UpdateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
921
|
+
// verify required parameter 'v1UpdateSatelliteTargetRequest' is not null or undefined
|
|
922
|
+
(0, common_1.assertParamExists)('v1UpdateSatelliteTarget', 'v1UpdateSatelliteTargetRequest', v1UpdateSatelliteTargetRequest);
|
|
923
|
+
const localVarPath = `/v1/satellite-target`;
|
|
924
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
925
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
926
|
+
let baseOptions;
|
|
927
|
+
if (configuration) {
|
|
928
|
+
baseOptions = configuration.baseOptions;
|
|
929
|
+
}
|
|
930
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
931
|
+
const localVarHeaderParameter = {};
|
|
932
|
+
const localVarQueryParameter = {};
|
|
933
|
+
// authentication Roles required
|
|
934
|
+
// authentication BearerToken required
|
|
935
|
+
// http bearer authentication required
|
|
936
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
937
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
938
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
939
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
940
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
941
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1UpdateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
942
|
+
return {
|
|
943
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
944
|
+
options: localVarRequestOptions,
|
|
945
|
+
};
|
|
946
|
+
}),
|
|
837
947
|
};
|
|
838
948
|
};
|
|
839
949
|
exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
|
|
@@ -881,7 +991,31 @@ const DefaultApiFp = function (configuration) {
|
|
|
881
991
|
});
|
|
882
992
|
},
|
|
883
993
|
/**
|
|
884
|
-
* Create
|
|
994
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
995
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
996
|
+
* @param {*} [options] Override http request option.
|
|
997
|
+
* @throws {RequiredError}
|
|
998
|
+
*/
|
|
999
|
+
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options) {
|
|
1000
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1001
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options);
|
|
1002
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1003
|
+
});
|
|
1004
|
+
},
|
|
1005
|
+
/**
|
|
1006
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1007
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1008
|
+
* @param {*} [options] Override http request option.
|
|
1009
|
+
* @throws {RequiredError}
|
|
1010
|
+
*/
|
|
1011
|
+
v1CreateSearchTask(v1CreateSearchTaskRequest, options) {
|
|
1012
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1013
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSearchTask(v1CreateSearchTaskRequest, options);
|
|
1014
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1015
|
+
});
|
|
1016
|
+
},
|
|
1017
|
+
/**
|
|
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.
|
|
885
1019
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
886
1020
|
* @param {*} [options] Override http request option.
|
|
887
1021
|
* @throws {RequiredError}
|
|
@@ -1097,6 +1231,18 @@ const DefaultApiFp = function (configuration) {
|
|
|
1097
1231
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1098
1232
|
});
|
|
1099
1233
|
},
|
|
1234
|
+
/**
|
|
1235
|
+
* Update satellite target.
|
|
1236
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1237
|
+
* @param {*} [options] Override http request option.
|
|
1238
|
+
* @throws {RequiredError}
|
|
1239
|
+
*/
|
|
1240
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options) {
|
|
1241
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1242
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options);
|
|
1243
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1244
|
+
});
|
|
1245
|
+
},
|
|
1100
1246
|
};
|
|
1101
1247
|
};
|
|
1102
1248
|
exports.DefaultApiFp = DefaultApiFp;
|
|
@@ -1135,7 +1281,25 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1135
1281
|
return localVarFp.v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
|
|
1136
1282
|
},
|
|
1137
1283
|
/**
|
|
1138
|
-
* Create
|
|
1284
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1285
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1286
|
+
* @param {*} [options] Override http request option.
|
|
1287
|
+
* @throws {RequiredError}
|
|
1288
|
+
*/
|
|
1289
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1290
|
+
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1291
|
+
},
|
|
1292
|
+
/**
|
|
1293
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1294
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1299
|
+
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1300
|
+
},
|
|
1301
|
+
/**
|
|
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.
|
|
1139
1303
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1140
1304
|
* @param {*} [options] Override http request option.
|
|
1141
1305
|
* @throws {RequiredError}
|
|
@@ -1293,6 +1457,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1293
1457
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1294
1458
|
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
1295
1459
|
},
|
|
1460
|
+
/**
|
|
1461
|
+
* Update satellite target.
|
|
1462
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1463
|
+
* @param {*} [options] Override http request option.
|
|
1464
|
+
* @throws {RequiredError}
|
|
1465
|
+
*/
|
|
1466
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1467
|
+
return localVarFp.v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1468
|
+
},
|
|
1296
1469
|
};
|
|
1297
1470
|
};
|
|
1298
1471
|
exports.DefaultApiFactory = DefaultApiFactory;
|
|
@@ -1334,7 +1507,27 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1334
1507
|
return (0, exports.DefaultApiFp)(this.configuration).v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1335
1508
|
}
|
|
1336
1509
|
/**
|
|
1337
|
-
* Create
|
|
1510
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1511
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
* @memberof DefaultApi
|
|
1515
|
+
*/
|
|
1516
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1517
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1521
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1522
|
+
* @param {*} [options] Override http request option.
|
|
1523
|
+
* @throws {RequiredError}
|
|
1524
|
+
* @memberof DefaultApi
|
|
1525
|
+
*/
|
|
1526
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1527
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1528
|
+
}
|
|
1529
|
+
/**
|
|
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.
|
|
1338
1531
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1339
1532
|
* @param {*} [options] Override http request option.
|
|
1340
1533
|
* @throws {RequiredError}
|
|
@@ -1510,5 +1703,15 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1510
1703
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1511
1704
|
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1512
1705
|
}
|
|
1706
|
+
/**
|
|
1707
|
+
* Update satellite target.
|
|
1708
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1709
|
+
* @param {*} [options] Override http request option.
|
|
1710
|
+
* @throws {RequiredError}
|
|
1711
|
+
* @memberof DefaultApi
|
|
1712
|
+
*/
|
|
1713
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1714
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1715
|
+
}
|
|
1513
1716
|
}
|
|
1514
1717
|
exports.DefaultApi = DefaultApi;
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* OurSky SDA
|
|
3
3
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.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).
|