@ourskyai/sda-api 1.3.2816 → 1.3.3197
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 +798 -116
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +479 -71
- package/dist/api.js +434 -29
- 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 +479 -71
- package/dist/esm/api.js +433 -28
- 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.3197
|
|
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.WebhookAuthType = 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.ObservationState = 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
|
|
@@ -63,6 +63,17 @@ exports.MountType = {
|
|
|
63
63
|
ALT_AZ: 'ALT_AZ',
|
|
64
64
|
EQUITORIAL: 'EQUITORIAL'
|
|
65
65
|
};
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @export
|
|
69
|
+
* @enum {string}
|
|
70
|
+
*/
|
|
71
|
+
exports.ObservationState = {
|
|
72
|
+
PENDING: 'PENDING',
|
|
73
|
+
UNDERWAY: 'UNDERWAY',
|
|
74
|
+
COMPLETED: 'COMPLETED',
|
|
75
|
+
FAILED: 'FAILED'
|
|
76
|
+
};
|
|
66
77
|
/**
|
|
67
78
|
*
|
|
68
79
|
* @export
|
|
@@ -269,14 +280,14 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
269
280
|
};
|
|
270
281
|
}),
|
|
271
282
|
/**
|
|
272
|
-
*
|
|
273
|
-
* @param {
|
|
283
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
284
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
274
285
|
* @param {*} [options] Override http request option.
|
|
275
286
|
* @throws {RequiredError}
|
|
276
287
|
*/
|
|
277
|
-
|
|
278
|
-
// verify required parameter '
|
|
279
|
-
(0, common_1.assertParamExists)('
|
|
288
|
+
v1CreateSearchInstruction: (v1CreateSearchInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
289
|
+
// verify required parameter 'v1CreateSearchInstructionRequest' is not null or undefined
|
|
290
|
+
(0, common_1.assertParamExists)('v1CreateSearchInstruction', 'v1CreateSearchInstructionRequest', v1CreateSearchInstructionRequest);
|
|
280
291
|
const localVarPath = `/v1/search-instruction`;
|
|
281
292
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
282
293
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -295,7 +306,40 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
295
306
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
296
307
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
297
308
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
298
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
309
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSearchInstructionRequest, localVarRequestOptions, configuration);
|
|
310
|
+
return {
|
|
311
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
312
|
+
options: localVarRequestOptions,
|
|
313
|
+
};
|
|
314
|
+
}),
|
|
315
|
+
/**
|
|
316
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
317
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
318
|
+
* @param {*} [options] Override http request option.
|
|
319
|
+
* @throws {RequiredError}
|
|
320
|
+
*/
|
|
321
|
+
v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
322
|
+
// verify required parameter 'v1CreateSurveyInstructionRequest' is not null or undefined
|
|
323
|
+
(0, common_1.assertParamExists)('v1CreateSurveyInstruction', 'v1CreateSurveyInstructionRequest', v1CreateSurveyInstructionRequest);
|
|
324
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
325
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
326
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
327
|
+
let baseOptions;
|
|
328
|
+
if (configuration) {
|
|
329
|
+
baseOptions = configuration.baseOptions;
|
|
330
|
+
}
|
|
331
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
332
|
+
const localVarHeaderParameter = {};
|
|
333
|
+
const localVarQueryParameter = {};
|
|
334
|
+
// authentication Roles required
|
|
335
|
+
// authentication BearerToken required
|
|
336
|
+
// http bearer authentication required
|
|
337
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
338
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
339
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
340
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
341
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
342
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateSurveyInstructionRequest, localVarRequestOptions, configuration);
|
|
299
343
|
return {
|
|
300
344
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
301
345
|
options: localVarRequestOptions,
|
|
@@ -436,6 +480,74 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
436
480
|
options: localVarRequestOptions,
|
|
437
481
|
};
|
|
438
482
|
}),
|
|
483
|
+
/**
|
|
484
|
+
* Delete a search instruction.
|
|
485
|
+
* @param {string} id
|
|
486
|
+
* @param {*} [options] Override http request option.
|
|
487
|
+
* @throws {RequiredError}
|
|
488
|
+
*/
|
|
489
|
+
v1DeleteSearchInstruction: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
490
|
+
// verify required parameter 'id' is not null or undefined
|
|
491
|
+
(0, common_1.assertParamExists)('v1DeleteSearchInstruction', 'id', id);
|
|
492
|
+
const localVarPath = `/v1/search-instruction`;
|
|
493
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
494
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
495
|
+
let baseOptions;
|
|
496
|
+
if (configuration) {
|
|
497
|
+
baseOptions = configuration.baseOptions;
|
|
498
|
+
}
|
|
499
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
500
|
+
const localVarHeaderParameter = {};
|
|
501
|
+
const localVarQueryParameter = {};
|
|
502
|
+
// authentication Roles required
|
|
503
|
+
// authentication BearerToken required
|
|
504
|
+
// http bearer authentication required
|
|
505
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
506
|
+
if (id !== undefined) {
|
|
507
|
+
localVarQueryParameter['id'] = id;
|
|
508
|
+
}
|
|
509
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
510
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
511
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
512
|
+
return {
|
|
513
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
514
|
+
options: localVarRequestOptions,
|
|
515
|
+
};
|
|
516
|
+
}),
|
|
517
|
+
/**
|
|
518
|
+
* Delete a survey instruction.
|
|
519
|
+
* @param {string} id
|
|
520
|
+
* @param {*} [options] Override http request option.
|
|
521
|
+
* @throws {RequiredError}
|
|
522
|
+
*/
|
|
523
|
+
v1DeleteSurveyInstruction: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
524
|
+
// verify required parameter 'id' is not null or undefined
|
|
525
|
+
(0, common_1.assertParamExists)('v1DeleteSurveyInstruction', 'id', id);
|
|
526
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
527
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
528
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
529
|
+
let baseOptions;
|
|
530
|
+
if (configuration) {
|
|
531
|
+
baseOptions = configuration.baseOptions;
|
|
532
|
+
}
|
|
533
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
534
|
+
const localVarHeaderParameter = {};
|
|
535
|
+
const localVarQueryParameter = {};
|
|
536
|
+
// authentication Roles required
|
|
537
|
+
// authentication BearerToken required
|
|
538
|
+
// http bearer authentication required
|
|
539
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
540
|
+
if (id !== undefined) {
|
|
541
|
+
localVarQueryParameter['id'] = id;
|
|
542
|
+
}
|
|
543
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
544
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
545
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
546
|
+
return {
|
|
547
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
548
|
+
options: localVarRequestOptions,
|
|
549
|
+
};
|
|
550
|
+
}),
|
|
439
551
|
/**
|
|
440
552
|
* Delete a webhook configuration.
|
|
441
553
|
* @param {string} id
|
|
@@ -707,14 +819,15 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
707
819
|
};
|
|
708
820
|
}),
|
|
709
821
|
/**
|
|
710
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
822
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, or by `surveyInstructionId`. 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
711
823
|
* @param {string} [targetId]
|
|
712
824
|
* @param {string} [before]
|
|
713
825
|
* @param {string} [searchInstructionId]
|
|
826
|
+
* @param {string} [surveyInstructionId]
|
|
714
827
|
* @param {*} [options] Override http request option.
|
|
715
828
|
* @throws {RequiredError}
|
|
716
829
|
*/
|
|
717
|
-
v1GetObservationStatuses: (targetId, before, searchInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
830
|
+
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
718
831
|
const localVarPath = `/v1/observation-statuses`;
|
|
719
832
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
720
833
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -740,6 +853,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
740
853
|
if (searchInstructionId !== undefined) {
|
|
741
854
|
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
742
855
|
}
|
|
856
|
+
if (surveyInstructionId !== undefined) {
|
|
857
|
+
localVarQueryParameter['surveyInstructionId'] = surveyInstructionId;
|
|
858
|
+
}
|
|
743
859
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
744
860
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
745
861
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -818,6 +934,40 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
818
934
|
options: localVarRequestOptions,
|
|
819
935
|
};
|
|
820
936
|
}),
|
|
937
|
+
/**
|
|
938
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
939
|
+
* @param {string} id
|
|
940
|
+
* @param {*} [options] Override http request option.
|
|
941
|
+
* @throws {RequiredError}
|
|
942
|
+
*/
|
|
943
|
+
v1GetSatelliteTarget: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
944
|
+
// verify required parameter 'id' is not null or undefined
|
|
945
|
+
(0, common_1.assertParamExists)('v1GetSatelliteTarget', 'id', id);
|
|
946
|
+
const localVarPath = `/v1/satellite-target`;
|
|
947
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
948
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
949
|
+
let baseOptions;
|
|
950
|
+
if (configuration) {
|
|
951
|
+
baseOptions = configuration.baseOptions;
|
|
952
|
+
}
|
|
953
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
954
|
+
const localVarHeaderParameter = {};
|
|
955
|
+
const localVarQueryParameter = {};
|
|
956
|
+
// authentication Roles required
|
|
957
|
+
// authentication BearerToken required
|
|
958
|
+
// http bearer authentication required
|
|
959
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
960
|
+
if (id !== undefined) {
|
|
961
|
+
localVarQueryParameter['id'] = id;
|
|
962
|
+
}
|
|
963
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
964
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
965
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
966
|
+
return {
|
|
967
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
968
|
+
options: localVarRequestOptions,
|
|
969
|
+
};
|
|
970
|
+
}),
|
|
821
971
|
/**
|
|
822
972
|
* The available satellite objects that the OurSky platform can currently track.
|
|
823
973
|
* @param {OrbitType} [orbitType]
|
|
@@ -854,6 +1004,74 @@ const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
854
1004
|
options: localVarRequestOptions,
|
|
855
1005
|
};
|
|
856
1006
|
}),
|
|
1007
|
+
/**
|
|
1008
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1009
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1010
|
+
* @param {*} [options] Override http request option.
|
|
1011
|
+
* @throws {RequiredError}
|
|
1012
|
+
*/
|
|
1013
|
+
v1GetSearchInstructions: (before, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1014
|
+
const localVarPath = `/v1/search-instructions`;
|
|
1015
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1016
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1017
|
+
let baseOptions;
|
|
1018
|
+
if (configuration) {
|
|
1019
|
+
baseOptions = configuration.baseOptions;
|
|
1020
|
+
}
|
|
1021
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1022
|
+
const localVarHeaderParameter = {};
|
|
1023
|
+
const localVarQueryParameter = {};
|
|
1024
|
+
// authentication Roles required
|
|
1025
|
+
// authentication BearerToken required
|
|
1026
|
+
// http bearer authentication required
|
|
1027
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1028
|
+
if (before !== undefined) {
|
|
1029
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
1030
|
+
before.toISOString() :
|
|
1031
|
+
before;
|
|
1032
|
+
}
|
|
1033
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1035
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1036
|
+
return {
|
|
1037
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1038
|
+
options: localVarRequestOptions,
|
|
1039
|
+
};
|
|
1040
|
+
}),
|
|
1041
|
+
/**
|
|
1042
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1043
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1044
|
+
* @param {*} [options] Override http request option.
|
|
1045
|
+
* @throws {RequiredError}
|
|
1046
|
+
*/
|
|
1047
|
+
v1GetSurveyInstructions: (before, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1048
|
+
const localVarPath = `/v1/survey-instructions`;
|
|
1049
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1050
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1051
|
+
let baseOptions;
|
|
1052
|
+
if (configuration) {
|
|
1053
|
+
baseOptions = configuration.baseOptions;
|
|
1054
|
+
}
|
|
1055
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1056
|
+
const localVarHeaderParameter = {};
|
|
1057
|
+
const localVarQueryParameter = {};
|
|
1058
|
+
// authentication Roles required
|
|
1059
|
+
// authentication BearerToken required
|
|
1060
|
+
// http bearer authentication required
|
|
1061
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1062
|
+
if (before !== undefined) {
|
|
1063
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
1064
|
+
before.toISOString() :
|
|
1065
|
+
before;
|
|
1066
|
+
}
|
|
1067
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1068
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1069
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1070
|
+
return {
|
|
1071
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1072
|
+
options: localVarRequestOptions,
|
|
1073
|
+
};
|
|
1074
|
+
}),
|
|
857
1075
|
/**
|
|
858
1076
|
* Get a TDM.
|
|
859
1077
|
* @param {string} tdmId
|
|
@@ -1079,14 +1297,26 @@ const DefaultApiFp = function (configuration) {
|
|
|
1079
1297
|
});
|
|
1080
1298
|
},
|
|
1081
1299
|
/**
|
|
1082
|
-
*
|
|
1083
|
-
* @param {
|
|
1300
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
1301
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
1302
|
+
* @param {*} [options] Override http request option.
|
|
1303
|
+
* @throws {RequiredError}
|
|
1304
|
+
*/
|
|
1305
|
+
v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options) {
|
|
1306
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1307
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options);
|
|
1308
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1309
|
+
});
|
|
1310
|
+
},
|
|
1311
|
+
/**
|
|
1312
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
1313
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
1084
1314
|
* @param {*} [options] Override http request option.
|
|
1085
1315
|
* @throws {RequiredError}
|
|
1086
1316
|
*/
|
|
1087
|
-
|
|
1317
|
+
v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest, options) {
|
|
1088
1318
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1089
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1319
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest, options);
|
|
1090
1320
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1091
1321
|
});
|
|
1092
1322
|
},
|
|
@@ -1138,6 +1368,30 @@ const DefaultApiFp = function (configuration) {
|
|
|
1138
1368
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1139
1369
|
});
|
|
1140
1370
|
},
|
|
1371
|
+
/**
|
|
1372
|
+
* Delete a search instruction.
|
|
1373
|
+
* @param {string} id
|
|
1374
|
+
* @param {*} [options] Override http request option.
|
|
1375
|
+
* @throws {RequiredError}
|
|
1376
|
+
*/
|
|
1377
|
+
v1DeleteSearchInstruction(id, options) {
|
|
1378
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1379
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteSearchInstruction(id, options);
|
|
1380
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1381
|
+
});
|
|
1382
|
+
},
|
|
1383
|
+
/**
|
|
1384
|
+
* Delete a survey instruction.
|
|
1385
|
+
* @param {string} id
|
|
1386
|
+
* @param {*} [options] Override http request option.
|
|
1387
|
+
* @throws {RequiredError}
|
|
1388
|
+
*/
|
|
1389
|
+
v1DeleteSurveyInstruction(id, options) {
|
|
1390
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1391
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteSurveyInstruction(id, options);
|
|
1392
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1393
|
+
});
|
|
1394
|
+
},
|
|
1141
1395
|
/**
|
|
1142
1396
|
* Delete a webhook configuration.
|
|
1143
1397
|
* @param {string} id
|
|
@@ -1235,16 +1489,17 @@ const DefaultApiFp = function (configuration) {
|
|
|
1235
1489
|
});
|
|
1236
1490
|
},
|
|
1237
1491
|
/**
|
|
1238
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
1492
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, or by `surveyInstructionId`. 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
1239
1493
|
* @param {string} [targetId]
|
|
1240
1494
|
* @param {string} [before]
|
|
1241
1495
|
* @param {string} [searchInstructionId]
|
|
1496
|
+
* @param {string} [surveyInstructionId]
|
|
1242
1497
|
* @param {*} [options] Override http request option.
|
|
1243
1498
|
* @throws {RequiredError}
|
|
1244
1499
|
*/
|
|
1245
|
-
v1GetObservationStatuses(targetId, before, searchInstructionId, options) {
|
|
1500
|
+
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options) {
|
|
1246
1501
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1247
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, options);
|
|
1502
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options);
|
|
1248
1503
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1249
1504
|
});
|
|
1250
1505
|
},
|
|
@@ -1272,6 +1527,18 @@ const DefaultApiFp = function (configuration) {
|
|
|
1272
1527
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1273
1528
|
});
|
|
1274
1529
|
},
|
|
1530
|
+
/**
|
|
1531
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1532
|
+
* @param {string} id
|
|
1533
|
+
* @param {*} [options] Override http request option.
|
|
1534
|
+
* @throws {RequiredError}
|
|
1535
|
+
*/
|
|
1536
|
+
v1GetSatelliteTarget(id, options) {
|
|
1537
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1538
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSatelliteTarget(id, options);
|
|
1539
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1540
|
+
});
|
|
1541
|
+
},
|
|
1275
1542
|
/**
|
|
1276
1543
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1277
1544
|
* @param {OrbitType} [orbitType]
|
|
@@ -1285,6 +1552,30 @@ const DefaultApiFp = function (configuration) {
|
|
|
1285
1552
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1286
1553
|
});
|
|
1287
1554
|
},
|
|
1555
|
+
/**
|
|
1556
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1557
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1558
|
+
* @param {*} [options] Override http request option.
|
|
1559
|
+
* @throws {RequiredError}
|
|
1560
|
+
*/
|
|
1561
|
+
v1GetSearchInstructions(before, options) {
|
|
1562
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1563
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSearchInstructions(before, options);
|
|
1564
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1565
|
+
});
|
|
1566
|
+
},
|
|
1567
|
+
/**
|
|
1568
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1569
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1570
|
+
* @param {*} [options] Override http request option.
|
|
1571
|
+
* @throws {RequiredError}
|
|
1572
|
+
*/
|
|
1573
|
+
v1GetSurveyInstructions(before, options) {
|
|
1574
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1575
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSurveyInstructions(before, options);
|
|
1576
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
1577
|
+
});
|
|
1578
|
+
},
|
|
1288
1579
|
/**
|
|
1289
1580
|
* Get a TDM.
|
|
1290
1581
|
* @param {string} tdmId
|
|
@@ -1392,13 +1683,22 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1392
1683
|
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1393
1684
|
},
|
|
1394
1685
|
/**
|
|
1395
|
-
*
|
|
1396
|
-
* @param {
|
|
1686
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
1687
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
1397
1688
|
* @param {*} [options] Override http request option.
|
|
1398
1689
|
* @throws {RequiredError}
|
|
1399
1690
|
*/
|
|
1400
|
-
|
|
1401
|
-
return localVarFp.
|
|
1691
|
+
v1CreateSearchInstruction(requestParameters, options) {
|
|
1692
|
+
return localVarFp.v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(axios, basePath));
|
|
1693
|
+
},
|
|
1694
|
+
/**
|
|
1695
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
1696
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
1697
|
+
* @param {*} [options] Override http request option.
|
|
1698
|
+
* @throws {RequiredError}
|
|
1699
|
+
*/
|
|
1700
|
+
v1CreateSurveyInstruction(requestParameters, options) {
|
|
1701
|
+
return localVarFp.v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(axios, basePath));
|
|
1402
1702
|
},
|
|
1403
1703
|
/**
|
|
1404
1704
|
* 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.
|
|
@@ -1436,6 +1736,24 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1436
1736
|
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
1437
1737
|
return localVarFp.v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(axios, basePath));
|
|
1438
1738
|
},
|
|
1739
|
+
/**
|
|
1740
|
+
* Delete a search instruction.
|
|
1741
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
1742
|
+
* @param {*} [options] Override http request option.
|
|
1743
|
+
* @throws {RequiredError}
|
|
1744
|
+
*/
|
|
1745
|
+
v1DeleteSearchInstruction(requestParameters, options) {
|
|
1746
|
+
return localVarFp.v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1747
|
+
},
|
|
1748
|
+
/**
|
|
1749
|
+
* Delete a survey instruction.
|
|
1750
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
1751
|
+
* @param {*} [options] Override http request option.
|
|
1752
|
+
* @throws {RequiredError}
|
|
1753
|
+
*/
|
|
1754
|
+
v1DeleteSurveyInstruction(requestParameters, options) {
|
|
1755
|
+
return localVarFp.v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1756
|
+
},
|
|
1439
1757
|
/**
|
|
1440
1758
|
* Delete a webhook configuration.
|
|
1441
1759
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1508,13 +1826,13 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1508
1826
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
1509
1827
|
},
|
|
1510
1828
|
/**
|
|
1511
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
1829
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, or by `surveyInstructionId`. 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
1512
1830
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1513
1831
|
* @param {*} [options] Override http request option.
|
|
1514
1832
|
* @throws {RequiredError}
|
|
1515
1833
|
*/
|
|
1516
1834
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1517
|
-
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(axios, basePath));
|
|
1835
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
|
|
1518
1836
|
},
|
|
1519
1837
|
/**
|
|
1520
1838
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
@@ -1533,6 +1851,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1533
1851
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
1534
1852
|
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
|
|
1535
1853
|
},
|
|
1854
|
+
/**
|
|
1855
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1856
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
1857
|
+
* @param {*} [options] Override http request option.
|
|
1858
|
+
* @throws {RequiredError}
|
|
1859
|
+
*/
|
|
1860
|
+
v1GetSatelliteTarget(requestParameters, options) {
|
|
1861
|
+
return localVarFp.v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1862
|
+
},
|
|
1536
1863
|
/**
|
|
1537
1864
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1538
1865
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -1542,6 +1869,24 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1542
1869
|
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1543
1870
|
return localVarFp.v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(axios, basePath));
|
|
1544
1871
|
},
|
|
1872
|
+
/**
|
|
1873
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1874
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
1875
|
+
* @param {*} [options] Override http request option.
|
|
1876
|
+
* @throws {RequiredError}
|
|
1877
|
+
*/
|
|
1878
|
+
v1GetSearchInstructions(requestParameters = {}, options) {
|
|
1879
|
+
return localVarFp.v1GetSearchInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
1880
|
+
},
|
|
1881
|
+
/**
|
|
1882
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
1883
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
1884
|
+
* @param {*} [options] Override http request option.
|
|
1885
|
+
* @throws {RequiredError}
|
|
1886
|
+
*/
|
|
1887
|
+
v1GetSurveyInstructions(requestParameters = {}, options) {
|
|
1888
|
+
return localVarFp.v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
1889
|
+
},
|
|
1545
1890
|
/**
|
|
1546
1891
|
* Get a TDM.
|
|
1547
1892
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
@@ -1637,14 +1982,24 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1637
1982
|
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1638
1983
|
}
|
|
1639
1984
|
/**
|
|
1640
|
-
*
|
|
1641
|
-
* @param {
|
|
1985
|
+
* Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
|
|
1986
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
1987
|
+
* @param {*} [options] Override http request option.
|
|
1988
|
+
* @throws {RequiredError}
|
|
1989
|
+
* @memberof DefaultApi
|
|
1990
|
+
*/
|
|
1991
|
+
v1CreateSearchInstruction(requestParameters, options) {
|
|
1992
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1993
|
+
}
|
|
1994
|
+
/**
|
|
1995
|
+
* Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint.
|
|
1996
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
1642
1997
|
* @param {*} [options] Override http request option.
|
|
1643
1998
|
* @throws {RequiredError}
|
|
1644
1999
|
* @memberof DefaultApi
|
|
1645
2000
|
*/
|
|
1646
|
-
|
|
1647
|
-
return (0, exports.DefaultApiFp)(this.configuration).
|
|
2001
|
+
v1CreateSurveyInstruction(requestParameters, options) {
|
|
2002
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1648
2003
|
}
|
|
1649
2004
|
/**
|
|
1650
2005
|
* 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.
|
|
@@ -1686,6 +2041,26 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1686
2041
|
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
1687
2042
|
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
1688
2043
|
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Delete a search instruction.
|
|
2046
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
2047
|
+
* @param {*} [options] Override http request option.
|
|
2048
|
+
* @throws {RequiredError}
|
|
2049
|
+
* @memberof DefaultApi
|
|
2050
|
+
*/
|
|
2051
|
+
v1DeleteSearchInstruction(requestParameters, options) {
|
|
2052
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2053
|
+
}
|
|
2054
|
+
/**
|
|
2055
|
+
* Delete a survey instruction.
|
|
2056
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
2057
|
+
* @param {*} [options] Override http request option.
|
|
2058
|
+
* @throws {RequiredError}
|
|
2059
|
+
* @memberof DefaultApi
|
|
2060
|
+
*/
|
|
2061
|
+
v1DeleteSurveyInstruction(requestParameters, options) {
|
|
2062
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2063
|
+
}
|
|
1689
2064
|
/**
|
|
1690
2065
|
* Delete a webhook configuration.
|
|
1691
2066
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1766,14 +2141,14 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1766
2141
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
1767
2142
|
}
|
|
1768
2143
|
/**
|
|
1769
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId` or by
|
|
2144
|
+
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, or by `surveyInstructionId`. 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` or `surveyInstructionId`, a `before` timestamp is not required.
|
|
1770
2145
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1771
2146
|
* @param {*} [options] Override http request option.
|
|
1772
2147
|
* @throws {RequiredError}
|
|
1773
2148
|
* @memberof DefaultApi
|
|
1774
2149
|
*/
|
|
1775
2150
|
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1776
|
-
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
2151
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
1777
2152
|
}
|
|
1778
2153
|
/**
|
|
1779
2154
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
@@ -1794,6 +2169,16 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1794
2169
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
1795
2170
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
|
|
1796
2171
|
}
|
|
2172
|
+
/**
|
|
2173
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
2174
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
2175
|
+
* @param {*} [options] Override http request option.
|
|
2176
|
+
* @throws {RequiredError}
|
|
2177
|
+
* @memberof DefaultApi
|
|
2178
|
+
*/
|
|
2179
|
+
v1GetSatelliteTarget(requestParameters, options) {
|
|
2180
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2181
|
+
}
|
|
1797
2182
|
/**
|
|
1798
2183
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1799
2184
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -1804,6 +2189,26 @@ class DefaultApi extends base_1.BaseAPI {
|
|
|
1804
2189
|
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1805
2190
|
return (0, exports.DefaultApiFp)(this.configuration).v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(this.axios, this.basePath));
|
|
1806
2191
|
}
|
|
2192
|
+
/**
|
|
2193
|
+
* Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
2194
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
2195
|
+
* @param {*} [options] Override http request option.
|
|
2196
|
+
* @throws {RequiredError}
|
|
2197
|
+
* @memberof DefaultApi
|
|
2198
|
+
*/
|
|
2199
|
+
v1GetSearchInstructions(requestParameters = {}, options) {
|
|
2200
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetSearchInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
|
|
2204
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
2205
|
+
* @param {*} [options] Override http request option.
|
|
2206
|
+
* @throws {RequiredError}
|
|
2207
|
+
* @memberof DefaultApi
|
|
2208
|
+
*/
|
|
2209
|
+
v1GetSurveyInstructions(requestParameters = {}, options) {
|
|
2210
|
+
return (0, exports.DefaultApiFp)(this.configuration).v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
2211
|
+
}
|
|
1807
2212
|
/**
|
|
1808
2213
|
* Get a TDM.
|
|
1809
2214
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|