@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/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
|
|
@@ -222,7 +233,73 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
222
233
|
};
|
|
223
234
|
}),
|
|
224
235
|
/**
|
|
225
|
-
* Create
|
|
236
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
237
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
*/
|
|
241
|
+
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
242
|
+
// verify required parameter 'v1CreateSatelliteTargetRequest' is not null or undefined
|
|
243
|
+
assertParamExists('v1CreateSatelliteTarget', 'v1CreateSatelliteTargetRequest', v1CreateSatelliteTargetRequest);
|
|
244
|
+
const localVarPath = `/v1/satellite-target`;
|
|
245
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
246
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
247
|
+
let baseOptions;
|
|
248
|
+
if (configuration) {
|
|
249
|
+
baseOptions = configuration.baseOptions;
|
|
250
|
+
}
|
|
251
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
252
|
+
const localVarHeaderParameter = {};
|
|
253
|
+
const localVarQueryParameter = {};
|
|
254
|
+
// authentication Roles required
|
|
255
|
+
// authentication BearerToken required
|
|
256
|
+
// http bearer authentication required
|
|
257
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
258
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
259
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
260
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
261
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
262
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
263
|
+
return {
|
|
264
|
+
url: toPathString(localVarUrlObj),
|
|
265
|
+
options: localVarRequestOptions,
|
|
266
|
+
};
|
|
267
|
+
}),
|
|
268
|
+
/**
|
|
269
|
+
* \' 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. \'
|
|
270
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
271
|
+
* @param {*} [options] Override http request option.
|
|
272
|
+
* @throws {RequiredError}
|
|
273
|
+
*/
|
|
274
|
+
v1CreateSearchTask: (v1CreateSearchTaskRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
275
|
+
// verify required parameter 'v1CreateSearchTaskRequest' is not null or undefined
|
|
276
|
+
assertParamExists('v1CreateSearchTask', 'v1CreateSearchTaskRequest', v1CreateSearchTaskRequest);
|
|
277
|
+
const localVarPath = `/v1/search-instruction`;
|
|
278
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
279
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
280
|
+
let baseOptions;
|
|
281
|
+
if (configuration) {
|
|
282
|
+
baseOptions = configuration.baseOptions;
|
|
283
|
+
}
|
|
284
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
285
|
+
const localVarHeaderParameter = {};
|
|
286
|
+
const localVarQueryParameter = {};
|
|
287
|
+
// authentication Roles required
|
|
288
|
+
// authentication BearerToken required
|
|
289
|
+
// http bearer authentication required
|
|
290
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
291
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
294
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
295
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSearchTaskRequest, localVarRequestOptions, configuration);
|
|
296
|
+
return {
|
|
297
|
+
url: toPathString(localVarUrlObj),
|
|
298
|
+
options: localVarRequestOptions,
|
|
299
|
+
};
|
|
300
|
+
}),
|
|
301
|
+
/**
|
|
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.
|
|
226
303
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
227
304
|
* @param {*} [options] Override http request option.
|
|
228
305
|
* @throws {RequiredError}
|
|
@@ -831,6 +908,39 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
831
908
|
options: localVarRequestOptions,
|
|
832
909
|
};
|
|
833
910
|
}),
|
|
911
|
+
/**
|
|
912
|
+
* Update satellite target.
|
|
913
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
914
|
+
* @param {*} [options] Override http request option.
|
|
915
|
+
* @throws {RequiredError}
|
|
916
|
+
*/
|
|
917
|
+
v1UpdateSatelliteTarget: (v1UpdateSatelliteTargetRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
918
|
+
// verify required parameter 'v1UpdateSatelliteTargetRequest' is not null or undefined
|
|
919
|
+
assertParamExists('v1UpdateSatelliteTarget', 'v1UpdateSatelliteTargetRequest', v1UpdateSatelliteTargetRequest);
|
|
920
|
+
const localVarPath = `/v1/satellite-target`;
|
|
921
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
922
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
923
|
+
let baseOptions;
|
|
924
|
+
if (configuration) {
|
|
925
|
+
baseOptions = configuration.baseOptions;
|
|
926
|
+
}
|
|
927
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
928
|
+
const localVarHeaderParameter = {};
|
|
929
|
+
const localVarQueryParameter = {};
|
|
930
|
+
// authentication Roles required
|
|
931
|
+
// authentication BearerToken required
|
|
932
|
+
// http bearer authentication required
|
|
933
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
934
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
935
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
936
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
937
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
938
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateSatelliteTargetRequest, localVarRequestOptions, configuration);
|
|
939
|
+
return {
|
|
940
|
+
url: toPathString(localVarUrlObj),
|
|
941
|
+
options: localVarRequestOptions,
|
|
942
|
+
};
|
|
943
|
+
}),
|
|
834
944
|
};
|
|
835
945
|
};
|
|
836
946
|
/**
|
|
@@ -877,7 +987,31 @@ export const DefaultApiFp = function (configuration) {
|
|
|
877
987
|
});
|
|
878
988
|
},
|
|
879
989
|
/**
|
|
880
|
-
* Create
|
|
990
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
991
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
992
|
+
* @param {*} [options] Override http request option.
|
|
993
|
+
* @throws {RequiredError}
|
|
994
|
+
*/
|
|
995
|
+
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options) {
|
|
996
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
997
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options);
|
|
998
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
999
|
+
});
|
|
1000
|
+
},
|
|
1001
|
+
/**
|
|
1002
|
+
* \' 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. \'
|
|
1003
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1004
|
+
* @param {*} [options] Override http request option.
|
|
1005
|
+
* @throws {RequiredError}
|
|
1006
|
+
*/
|
|
1007
|
+
v1CreateSearchTask(v1CreateSearchTaskRequest, options) {
|
|
1008
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1009
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSearchTask(v1CreateSearchTaskRequest, options);
|
|
1010
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1011
|
+
});
|
|
1012
|
+
},
|
|
1013
|
+
/**
|
|
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.
|
|
881
1015
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
882
1016
|
* @param {*} [options] Override http request option.
|
|
883
1017
|
* @throws {RequiredError}
|
|
@@ -1093,6 +1227,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1093
1227
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1094
1228
|
});
|
|
1095
1229
|
},
|
|
1230
|
+
/**
|
|
1231
|
+
* Update satellite target.
|
|
1232
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
1233
|
+
* @param {*} [options] Override http request option.
|
|
1234
|
+
* @throws {RequiredError}
|
|
1235
|
+
*/
|
|
1236
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options) {
|
|
1237
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1238
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options);
|
|
1239
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1240
|
+
});
|
|
1241
|
+
},
|
|
1096
1242
|
};
|
|
1097
1243
|
};
|
|
1098
1244
|
/**
|
|
@@ -1130,7 +1276,25 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1130
1276
|
return localVarFp.v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
|
|
1131
1277
|
},
|
|
1132
1278
|
/**
|
|
1133
|
-
* Create
|
|
1279
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1280
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1281
|
+
* @param {*} [options] Override http request option.
|
|
1282
|
+
* @throws {RequiredError}
|
|
1283
|
+
*/
|
|
1284
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1285
|
+
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1286
|
+
},
|
|
1287
|
+
/**
|
|
1288
|
+
* \' 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. \'
|
|
1289
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1290
|
+
* @param {*} [options] Override http request option.
|
|
1291
|
+
* @throws {RequiredError}
|
|
1292
|
+
*/
|
|
1293
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1294
|
+
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
1295
|
+
},
|
|
1296
|
+
/**
|
|
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.
|
|
1134
1298
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1135
1299
|
* @param {*} [options] Override http request option.
|
|
1136
1300
|
* @throws {RequiredError}
|
|
@@ -1288,6 +1452,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1288
1452
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1289
1453
|
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
1290
1454
|
},
|
|
1455
|
+
/**
|
|
1456
|
+
* Update satellite target.
|
|
1457
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1458
|
+
* @param {*} [options] Override http request option.
|
|
1459
|
+
* @throws {RequiredError}
|
|
1460
|
+
*/
|
|
1461
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1462
|
+
return localVarFp.v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1463
|
+
},
|
|
1291
1464
|
};
|
|
1292
1465
|
};
|
|
1293
1466
|
/**
|
|
@@ -1328,7 +1501,27 @@ export class DefaultApi extends BaseAPI {
|
|
|
1328
1501
|
return DefaultApiFp(this.configuration).v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1329
1502
|
}
|
|
1330
1503
|
/**
|
|
1331
|
-
* Create
|
|
1504
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1505
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1506
|
+
* @param {*} [options] Override http request option.
|
|
1507
|
+
* @throws {RequiredError}
|
|
1508
|
+
* @memberof DefaultApi
|
|
1509
|
+
*/
|
|
1510
|
+
v1CreateSatelliteTarget(requestParameters, options) {
|
|
1511
|
+
return DefaultApiFp(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* \' 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. \'
|
|
1515
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
1516
|
+
* @param {*} [options] Override http request option.
|
|
1517
|
+
* @throws {RequiredError}
|
|
1518
|
+
* @memberof DefaultApi
|
|
1519
|
+
*/
|
|
1520
|
+
v1CreateSearchTask(requestParameters, options) {
|
|
1521
|
+
return DefaultApiFp(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1522
|
+
}
|
|
1523
|
+
/**
|
|
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.
|
|
1332
1525
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
1333
1526
|
* @param {*} [options] Override http request option.
|
|
1334
1527
|
* @throws {RequiredError}
|
|
@@ -1504,4 +1697,14 @@ export class DefaultApi extends BaseAPI {
|
|
|
1504
1697
|
v1UpdateEmailConfiguration(requestParameters, options) {
|
|
1505
1698
|
return DefaultApiFp(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1506
1699
|
}
|
|
1700
|
+
/**
|
|
1701
|
+
* Update satellite target.
|
|
1702
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
1703
|
+
* @param {*} [options] Override http request option.
|
|
1704
|
+
* @throws {RequiredError}
|
|
1705
|
+
* @memberof DefaultApi
|
|
1706
|
+
*/
|
|
1707
|
+
v1UpdateSatelliteTarget(requestParameters, options) {
|
|
1708
|
+
return DefaultApiFp(this.configuration).v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1709
|
+
}
|
|
1507
1710
|
}
|
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).
|