@ourskyai/sda-api 1.3.2765 → 1.3.3181
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 +1147 -186
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +744 -157
- package/dist/api.js +565 -20
- 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 +744 -157
- package/dist/esm/api.js +564 -19
- 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.3181
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -60,6 +60,17 @@ export const MountType = {
|
|
|
60
60
|
ALT_AZ: 'ALT_AZ',
|
|
61
61
|
EQUITORIAL: 'EQUITORIAL'
|
|
62
62
|
};
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @export
|
|
66
|
+
* @enum {string}
|
|
67
|
+
*/
|
|
68
|
+
export const ObservationState = {
|
|
69
|
+
PENDING: 'PENDING',
|
|
70
|
+
UNDERWAY: 'UNDERWAY',
|
|
71
|
+
COMPLETED: 'COMPLETED',
|
|
72
|
+
FAILED: 'FAILED'
|
|
73
|
+
};
|
|
63
74
|
/**
|
|
64
75
|
*
|
|
65
76
|
* @export
|
|
@@ -266,14 +277,14 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
266
277
|
};
|
|
267
278
|
}),
|
|
268
279
|
/**
|
|
269
|
-
*
|
|
270
|
-
* @param {
|
|
280
|
+
* 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.
|
|
281
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
271
282
|
* @param {*} [options] Override http request option.
|
|
272
283
|
* @throws {RequiredError}
|
|
273
284
|
*/
|
|
274
|
-
|
|
275
|
-
// verify required parameter '
|
|
276
|
-
assertParamExists('
|
|
285
|
+
v1CreateSearchInstruction: (v1CreateSearchInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
286
|
+
// verify required parameter 'v1CreateSearchInstructionRequest' is not null or undefined
|
|
287
|
+
assertParamExists('v1CreateSearchInstruction', 'v1CreateSearchInstructionRequest', v1CreateSearchInstructionRequest);
|
|
277
288
|
const localVarPath = `/v1/search-instruction`;
|
|
278
289
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
279
290
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -292,7 +303,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
292
303
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
293
304
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
294
305
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
295
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
306
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSearchInstructionRequest, localVarRequestOptions, configuration);
|
|
307
|
+
return {
|
|
308
|
+
url: toPathString(localVarUrlObj),
|
|
309
|
+
options: localVarRequestOptions,
|
|
310
|
+
};
|
|
311
|
+
}),
|
|
312
|
+
/**
|
|
313
|
+
* 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.
|
|
314
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
317
|
+
*/
|
|
318
|
+
v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
319
|
+
// verify required parameter 'v1CreateSurveyInstructionRequest' is not null or undefined
|
|
320
|
+
assertParamExists('v1CreateSurveyInstruction', 'v1CreateSurveyInstructionRequest', v1CreateSurveyInstructionRequest);
|
|
321
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
322
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
323
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
324
|
+
let baseOptions;
|
|
325
|
+
if (configuration) {
|
|
326
|
+
baseOptions = configuration.baseOptions;
|
|
327
|
+
}
|
|
328
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
329
|
+
const localVarHeaderParameter = {};
|
|
330
|
+
const localVarQueryParameter = {};
|
|
331
|
+
// authentication Roles required
|
|
332
|
+
// authentication BearerToken required
|
|
333
|
+
// http bearer authentication required
|
|
334
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
335
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
336
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
337
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
338
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
339
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSurveyInstructionRequest, localVarRequestOptions, configuration);
|
|
296
340
|
return {
|
|
297
341
|
url: toPathString(localVarUrlObj),
|
|
298
342
|
options: localVarRequestOptions,
|
|
@@ -433,6 +477,74 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
433
477
|
options: localVarRequestOptions,
|
|
434
478
|
};
|
|
435
479
|
}),
|
|
480
|
+
/**
|
|
481
|
+
* Delete a search instruction.
|
|
482
|
+
* @param {string} id
|
|
483
|
+
* @param {*} [options] Override http request option.
|
|
484
|
+
* @throws {RequiredError}
|
|
485
|
+
*/
|
|
486
|
+
v1DeleteSearchInstruction: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
487
|
+
// verify required parameter 'id' is not null or undefined
|
|
488
|
+
assertParamExists('v1DeleteSearchInstruction', 'id', id);
|
|
489
|
+
const localVarPath = `/v1/search-instruction`;
|
|
490
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
491
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
492
|
+
let baseOptions;
|
|
493
|
+
if (configuration) {
|
|
494
|
+
baseOptions = configuration.baseOptions;
|
|
495
|
+
}
|
|
496
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
497
|
+
const localVarHeaderParameter = {};
|
|
498
|
+
const localVarQueryParameter = {};
|
|
499
|
+
// authentication Roles required
|
|
500
|
+
// authentication BearerToken required
|
|
501
|
+
// http bearer authentication required
|
|
502
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
503
|
+
if (id !== undefined) {
|
|
504
|
+
localVarQueryParameter['id'] = id;
|
|
505
|
+
}
|
|
506
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
507
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
508
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
509
|
+
return {
|
|
510
|
+
url: toPathString(localVarUrlObj),
|
|
511
|
+
options: localVarRequestOptions,
|
|
512
|
+
};
|
|
513
|
+
}),
|
|
514
|
+
/**
|
|
515
|
+
* Delete a survey instruction.
|
|
516
|
+
* @param {string} id
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
v1DeleteSurveyInstruction: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
521
|
+
// verify required parameter 'id' is not null or undefined
|
|
522
|
+
assertParamExists('v1DeleteSurveyInstruction', 'id', id);
|
|
523
|
+
const localVarPath = `/v1/survey-instruction`;
|
|
524
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
525
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
526
|
+
let baseOptions;
|
|
527
|
+
if (configuration) {
|
|
528
|
+
baseOptions = configuration.baseOptions;
|
|
529
|
+
}
|
|
530
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
531
|
+
const localVarHeaderParameter = {};
|
|
532
|
+
const localVarQueryParameter = {};
|
|
533
|
+
// authentication Roles required
|
|
534
|
+
// authentication BearerToken required
|
|
535
|
+
// http bearer authentication required
|
|
536
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
537
|
+
if (id !== undefined) {
|
|
538
|
+
localVarQueryParameter['id'] = id;
|
|
539
|
+
}
|
|
540
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
541
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
542
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
543
|
+
return {
|
|
544
|
+
url: toPathString(localVarUrlObj),
|
|
545
|
+
options: localVarRequestOptions,
|
|
546
|
+
};
|
|
547
|
+
}),
|
|
436
548
|
/**
|
|
437
549
|
* Delete a webhook configuration.
|
|
438
550
|
* @param {string} id
|
|
@@ -631,6 +743,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
631
743
|
options: localVarRequestOptions,
|
|
632
744
|
};
|
|
633
745
|
}),
|
|
746
|
+
/**
|
|
747
|
+
* Get observation features.
|
|
748
|
+
* @param {string} imageId
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
v1GetObservationFeatures: (imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
753
|
+
// verify required parameter 'imageId' is not null or undefined
|
|
754
|
+
assertParamExists('v1GetObservationFeatures', 'imageId', imageId);
|
|
755
|
+
const localVarPath = `/v1/observation-features`;
|
|
756
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
757
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
758
|
+
let baseOptions;
|
|
759
|
+
if (configuration) {
|
|
760
|
+
baseOptions = configuration.baseOptions;
|
|
761
|
+
}
|
|
762
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
763
|
+
const localVarHeaderParameter = {};
|
|
764
|
+
const localVarQueryParameter = {};
|
|
765
|
+
// authentication Roles required
|
|
766
|
+
// authentication BearerToken required
|
|
767
|
+
// http bearer authentication required
|
|
768
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
769
|
+
if (imageId !== undefined) {
|
|
770
|
+
localVarQueryParameter['imageId'] = imageId;
|
|
771
|
+
}
|
|
772
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
773
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
774
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
775
|
+
return {
|
|
776
|
+
url: toPathString(localVarUrlObj),
|
|
777
|
+
options: localVarRequestOptions,
|
|
778
|
+
};
|
|
779
|
+
}),
|
|
634
780
|
/**
|
|
635
781
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
636
782
|
* @param {string} [targetId]
|
|
@@ -669,6 +815,52 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
669
815
|
options: localVarRequestOptions,
|
|
670
816
|
};
|
|
671
817
|
}),
|
|
818
|
+
/**
|
|
819
|
+
* 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.
|
|
820
|
+
* @param {string} [targetId]
|
|
821
|
+
* @param {string} [before]
|
|
822
|
+
* @param {string} [searchInstructionId]
|
|
823
|
+
* @param {string} [surveyInstructionId]
|
|
824
|
+
* @param {*} [options] Override http request option.
|
|
825
|
+
* @throws {RequiredError}
|
|
826
|
+
*/
|
|
827
|
+
v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
828
|
+
const localVarPath = `/v1/observation-statuses`;
|
|
829
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
830
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
831
|
+
let baseOptions;
|
|
832
|
+
if (configuration) {
|
|
833
|
+
baseOptions = configuration.baseOptions;
|
|
834
|
+
}
|
|
835
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
836
|
+
const localVarHeaderParameter = {};
|
|
837
|
+
const localVarQueryParameter = {};
|
|
838
|
+
// authentication Roles required
|
|
839
|
+
// authentication BearerToken required
|
|
840
|
+
// http bearer authentication required
|
|
841
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
842
|
+
if (targetId !== undefined) {
|
|
843
|
+
localVarQueryParameter['targetId'] = targetId;
|
|
844
|
+
}
|
|
845
|
+
if (before !== undefined) {
|
|
846
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
847
|
+
before.toISOString() :
|
|
848
|
+
before;
|
|
849
|
+
}
|
|
850
|
+
if (searchInstructionId !== undefined) {
|
|
851
|
+
localVarQueryParameter['searchInstructionId'] = searchInstructionId;
|
|
852
|
+
}
|
|
853
|
+
if (surveyInstructionId !== undefined) {
|
|
854
|
+
localVarQueryParameter['surveyInstructionId'] = surveyInstructionId;
|
|
855
|
+
}
|
|
856
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
857
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
858
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
859
|
+
return {
|
|
860
|
+
url: toPathString(localVarUrlObj),
|
|
861
|
+
options: localVarRequestOptions,
|
|
862
|
+
};
|
|
863
|
+
}),
|
|
672
864
|
/**
|
|
673
865
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
674
866
|
* @param {*} [options] Override http request option.
|
|
@@ -739,6 +931,40 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
739
931
|
options: localVarRequestOptions,
|
|
740
932
|
};
|
|
741
933
|
}),
|
|
934
|
+
/**
|
|
935
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
936
|
+
* @param {string} id
|
|
937
|
+
* @param {*} [options] Override http request option.
|
|
938
|
+
* @throws {RequiredError}
|
|
939
|
+
*/
|
|
940
|
+
v1GetSatelliteTarget: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
941
|
+
// verify required parameter 'id' is not null or undefined
|
|
942
|
+
assertParamExists('v1GetSatelliteTarget', 'id', id);
|
|
943
|
+
const localVarPath = `/v1/satellite-target`;
|
|
944
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
945
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
946
|
+
let baseOptions;
|
|
947
|
+
if (configuration) {
|
|
948
|
+
baseOptions = configuration.baseOptions;
|
|
949
|
+
}
|
|
950
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
951
|
+
const localVarHeaderParameter = {};
|
|
952
|
+
const localVarQueryParameter = {};
|
|
953
|
+
// authentication Roles required
|
|
954
|
+
// authentication BearerToken required
|
|
955
|
+
// http bearer authentication required
|
|
956
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
957
|
+
if (id !== undefined) {
|
|
958
|
+
localVarQueryParameter['id'] = id;
|
|
959
|
+
}
|
|
960
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
961
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
962
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
963
|
+
return {
|
|
964
|
+
url: toPathString(localVarUrlObj),
|
|
965
|
+
options: localVarRequestOptions,
|
|
966
|
+
};
|
|
967
|
+
}),
|
|
742
968
|
/**
|
|
743
969
|
* The available satellite objects that the OurSky platform can currently track.
|
|
744
970
|
* @param {OrbitType} [orbitType]
|
|
@@ -775,6 +1001,74 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
|
|
|
775
1001
|
options: localVarRequestOptions,
|
|
776
1002
|
};
|
|
777
1003
|
}),
|
|
1004
|
+
/**
|
|
1005
|
+
* 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.
|
|
1006
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1007
|
+
* @param {*} [options] Override http request option.
|
|
1008
|
+
* @throws {RequiredError}
|
|
1009
|
+
*/
|
|
1010
|
+
v1GetSearchInstructions: (before, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1011
|
+
const localVarPath = `/v1/search-instructions`;
|
|
1012
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1013
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1014
|
+
let baseOptions;
|
|
1015
|
+
if (configuration) {
|
|
1016
|
+
baseOptions = configuration.baseOptions;
|
|
1017
|
+
}
|
|
1018
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1019
|
+
const localVarHeaderParameter = {};
|
|
1020
|
+
const localVarQueryParameter = {};
|
|
1021
|
+
// authentication Roles required
|
|
1022
|
+
// authentication BearerToken required
|
|
1023
|
+
// http bearer authentication required
|
|
1024
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1025
|
+
if (before !== undefined) {
|
|
1026
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
1027
|
+
before.toISOString() :
|
|
1028
|
+
before;
|
|
1029
|
+
}
|
|
1030
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1031
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1032
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1033
|
+
return {
|
|
1034
|
+
url: toPathString(localVarUrlObj),
|
|
1035
|
+
options: localVarRequestOptions,
|
|
1036
|
+
};
|
|
1037
|
+
}),
|
|
1038
|
+
/**
|
|
1039
|
+
* 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.
|
|
1040
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1041
|
+
* @param {*} [options] Override http request option.
|
|
1042
|
+
* @throws {RequiredError}
|
|
1043
|
+
*/
|
|
1044
|
+
v1GetSurveyInstructions: (before, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
1045
|
+
const localVarPath = `/v1/survey-instructions`;
|
|
1046
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1047
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1048
|
+
let baseOptions;
|
|
1049
|
+
if (configuration) {
|
|
1050
|
+
baseOptions = configuration.baseOptions;
|
|
1051
|
+
}
|
|
1052
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1053
|
+
const localVarHeaderParameter = {};
|
|
1054
|
+
const localVarQueryParameter = {};
|
|
1055
|
+
// authentication Roles required
|
|
1056
|
+
// authentication BearerToken required
|
|
1057
|
+
// http bearer authentication required
|
|
1058
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1059
|
+
if (before !== undefined) {
|
|
1060
|
+
localVarQueryParameter['before'] = (before instanceof Date) ?
|
|
1061
|
+
before.toISOString() :
|
|
1062
|
+
before;
|
|
1063
|
+
}
|
|
1064
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1065
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1066
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1067
|
+
return {
|
|
1068
|
+
url: toPathString(localVarUrlObj),
|
|
1069
|
+
options: localVarRequestOptions,
|
|
1070
|
+
};
|
|
1071
|
+
}),
|
|
778
1072
|
/**
|
|
779
1073
|
* Get a TDM.
|
|
780
1074
|
* @param {string} tdmId
|
|
@@ -999,14 +1293,26 @@ export const DefaultApiFp = function (configuration) {
|
|
|
999
1293
|
});
|
|
1000
1294
|
},
|
|
1001
1295
|
/**
|
|
1002
|
-
*
|
|
1003
|
-
* @param {
|
|
1296
|
+
* 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.
|
|
1297
|
+
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
1298
|
+
* @param {*} [options] Override http request option.
|
|
1299
|
+
* @throws {RequiredError}
|
|
1300
|
+
*/
|
|
1301
|
+
v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options) {
|
|
1302
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1303
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSearchInstruction(v1CreateSearchInstructionRequest, options);
|
|
1304
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1305
|
+
});
|
|
1306
|
+
},
|
|
1307
|
+
/**
|
|
1308
|
+
* 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.
|
|
1309
|
+
* @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
|
|
1004
1310
|
* @param {*} [options] Override http request option.
|
|
1005
1311
|
* @throws {RequiredError}
|
|
1006
1312
|
*/
|
|
1007
|
-
|
|
1313
|
+
v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest, options) {
|
|
1008
1314
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1009
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
1315
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest, options);
|
|
1010
1316
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1011
1317
|
});
|
|
1012
1318
|
},
|
|
@@ -1058,6 +1364,30 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1058
1364
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1059
1365
|
});
|
|
1060
1366
|
},
|
|
1367
|
+
/**
|
|
1368
|
+
* Delete a search instruction.
|
|
1369
|
+
* @param {string} id
|
|
1370
|
+
* @param {*} [options] Override http request option.
|
|
1371
|
+
* @throws {RequiredError}
|
|
1372
|
+
*/
|
|
1373
|
+
v1DeleteSearchInstruction(id, options) {
|
|
1374
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1375
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteSearchInstruction(id, options);
|
|
1376
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1377
|
+
});
|
|
1378
|
+
},
|
|
1379
|
+
/**
|
|
1380
|
+
* Delete a survey instruction.
|
|
1381
|
+
* @param {string} id
|
|
1382
|
+
* @param {*} [options] Override http request option.
|
|
1383
|
+
* @throws {RequiredError}
|
|
1384
|
+
*/
|
|
1385
|
+
v1DeleteSurveyInstruction(id, options) {
|
|
1386
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1387
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteSurveyInstruction(id, options);
|
|
1388
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1389
|
+
});
|
|
1390
|
+
},
|
|
1061
1391
|
/**
|
|
1062
1392
|
* Delete a webhook configuration.
|
|
1063
1393
|
* @param {string} id
|
|
@@ -1129,6 +1459,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1129
1459
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1130
1460
|
});
|
|
1131
1461
|
},
|
|
1462
|
+
/**
|
|
1463
|
+
* Get observation features.
|
|
1464
|
+
* @param {string} imageId
|
|
1465
|
+
* @param {*} [options] Override http request option.
|
|
1466
|
+
* @throws {RequiredError}
|
|
1467
|
+
*/
|
|
1468
|
+
v1GetObservationFeatures(imageId, options) {
|
|
1469
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1470
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationFeatures(imageId, options);
|
|
1471
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1472
|
+
});
|
|
1473
|
+
},
|
|
1132
1474
|
/**
|
|
1133
1475
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1134
1476
|
* @param {string} [targetId]
|
|
@@ -1142,6 +1484,21 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1142
1484
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1143
1485
|
});
|
|
1144
1486
|
},
|
|
1487
|
+
/**
|
|
1488
|
+
* 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.
|
|
1489
|
+
* @param {string} [targetId]
|
|
1490
|
+
* @param {string} [before]
|
|
1491
|
+
* @param {string} [searchInstructionId]
|
|
1492
|
+
* @param {string} [surveyInstructionId]
|
|
1493
|
+
* @param {*} [options] Override http request option.
|
|
1494
|
+
* @throws {RequiredError}
|
|
1495
|
+
*/
|
|
1496
|
+
v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options) {
|
|
1497
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1498
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, options);
|
|
1499
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1500
|
+
});
|
|
1501
|
+
},
|
|
1145
1502
|
/**
|
|
1146
1503
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1147
1504
|
* @param {*} [options] Override http request option.
|
|
@@ -1166,6 +1523,18 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1166
1523
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1167
1524
|
});
|
|
1168
1525
|
},
|
|
1526
|
+
/**
|
|
1527
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1528
|
+
* @param {string} id
|
|
1529
|
+
* @param {*} [options] Override http request option.
|
|
1530
|
+
* @throws {RequiredError}
|
|
1531
|
+
*/
|
|
1532
|
+
v1GetSatelliteTarget(id, options) {
|
|
1533
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1534
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSatelliteTarget(id, options);
|
|
1535
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1536
|
+
});
|
|
1537
|
+
},
|
|
1169
1538
|
/**
|
|
1170
1539
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1171
1540
|
* @param {OrbitType} [orbitType]
|
|
@@ -1179,6 +1548,30 @@ export const DefaultApiFp = function (configuration) {
|
|
|
1179
1548
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1180
1549
|
});
|
|
1181
1550
|
},
|
|
1551
|
+
/**
|
|
1552
|
+
* 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.
|
|
1553
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1554
|
+
* @param {*} [options] Override http request option.
|
|
1555
|
+
* @throws {RequiredError}
|
|
1556
|
+
*/
|
|
1557
|
+
v1GetSearchInstructions(before, options) {
|
|
1558
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1559
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSearchInstructions(before, options);
|
|
1560
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1561
|
+
});
|
|
1562
|
+
},
|
|
1563
|
+
/**
|
|
1564
|
+
* 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.
|
|
1565
|
+
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
1566
|
+
* @param {*} [options] Override http request option.
|
|
1567
|
+
* @throws {RequiredError}
|
|
1568
|
+
*/
|
|
1569
|
+
v1GetSurveyInstructions(before, options) {
|
|
1570
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1571
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetSurveyInstructions(before, options);
|
|
1572
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1573
|
+
});
|
|
1574
|
+
},
|
|
1182
1575
|
/**
|
|
1183
1576
|
* Get a TDM.
|
|
1184
1577
|
* @param {string} tdmId
|
|
@@ -1285,13 +1678,22 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1285
1678
|
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
1286
1679
|
},
|
|
1287
1680
|
/**
|
|
1288
|
-
*
|
|
1289
|
-
* @param {
|
|
1681
|
+
* 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.
|
|
1682
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
1290
1683
|
* @param {*} [options] Override http request option.
|
|
1291
1684
|
* @throws {RequiredError}
|
|
1292
1685
|
*/
|
|
1293
|
-
|
|
1294
|
-
return localVarFp.
|
|
1686
|
+
v1CreateSearchInstruction(requestParameters, options) {
|
|
1687
|
+
return localVarFp.v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(axios, basePath));
|
|
1688
|
+
},
|
|
1689
|
+
/**
|
|
1690
|
+
* 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.
|
|
1691
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
1692
|
+
* @param {*} [options] Override http request option.
|
|
1693
|
+
* @throws {RequiredError}
|
|
1694
|
+
*/
|
|
1695
|
+
v1CreateSurveyInstruction(requestParameters, options) {
|
|
1696
|
+
return localVarFp.v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(axios, basePath));
|
|
1295
1697
|
},
|
|
1296
1698
|
/**
|
|
1297
1699
|
* 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.
|
|
@@ -1329,6 +1731,24 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1329
1731
|
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
1330
1732
|
return localVarFp.v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(axios, basePath));
|
|
1331
1733
|
},
|
|
1734
|
+
/**
|
|
1735
|
+
* Delete a search instruction.
|
|
1736
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
1737
|
+
* @param {*} [options] Override http request option.
|
|
1738
|
+
* @throws {RequiredError}
|
|
1739
|
+
*/
|
|
1740
|
+
v1DeleteSearchInstruction(requestParameters, options) {
|
|
1741
|
+
return localVarFp.v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1742
|
+
},
|
|
1743
|
+
/**
|
|
1744
|
+
* Delete a survey instruction.
|
|
1745
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
1746
|
+
* @param {*} [options] Override http request option.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
v1DeleteSurveyInstruction(requestParameters, options) {
|
|
1750
|
+
return localVarFp.v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1751
|
+
},
|
|
1332
1752
|
/**
|
|
1333
1753
|
* Delete a webhook configuration.
|
|
1334
1754
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1382,6 +1802,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1382
1802
|
v1GetNodeProperties(requestParameters, options) {
|
|
1383
1803
|
return localVarFp.v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(axios, basePath));
|
|
1384
1804
|
},
|
|
1805
|
+
/**
|
|
1806
|
+
* Get observation features.
|
|
1807
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
1808
|
+
* @param {*} [options] Override http request option.
|
|
1809
|
+
* @throws {RequiredError}
|
|
1810
|
+
*/
|
|
1811
|
+
v1GetObservationFeatures(requestParameters, options) {
|
|
1812
|
+
return localVarFp.v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
1813
|
+
},
|
|
1385
1814
|
/**
|
|
1386
1815
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1387
1816
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -1391,6 +1820,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1391
1820
|
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
1392
1821
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
1393
1822
|
},
|
|
1823
|
+
/**
|
|
1824
|
+
* 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.
|
|
1825
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
1826
|
+
* @param {*} [options] Override http request option.
|
|
1827
|
+
* @throws {RequiredError}
|
|
1828
|
+
*/
|
|
1829
|
+
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
1830
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(axios, basePath));
|
|
1831
|
+
},
|
|
1394
1832
|
/**
|
|
1395
1833
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1396
1834
|
* @param {*} [options] Override http request option.
|
|
@@ -1408,6 +1846,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1408
1846
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
1409
1847
|
return localVarFp.v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(axios, basePath));
|
|
1410
1848
|
},
|
|
1849
|
+
/**
|
|
1850
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
1851
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
1852
|
+
* @param {*} [options] Override http request option.
|
|
1853
|
+
* @throws {RequiredError}
|
|
1854
|
+
*/
|
|
1855
|
+
v1GetSatelliteTarget(requestParameters, options) {
|
|
1856
|
+
return localVarFp.v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1857
|
+
},
|
|
1411
1858
|
/**
|
|
1412
1859
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1413
1860
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -1417,6 +1864,24 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
|
|
|
1417
1864
|
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1418
1865
|
return localVarFp.v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(axios, basePath));
|
|
1419
1866
|
},
|
|
1867
|
+
/**
|
|
1868
|
+
* 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.
|
|
1869
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
1870
|
+
* @param {*} [options] Override http request option.
|
|
1871
|
+
* @throws {RequiredError}
|
|
1872
|
+
*/
|
|
1873
|
+
v1GetSearchInstructions(requestParameters = {}, options) {
|
|
1874
|
+
return localVarFp.v1GetSearchInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
1875
|
+
},
|
|
1876
|
+
/**
|
|
1877
|
+
* 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.
|
|
1878
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
1879
|
+
* @param {*} [options] Override http request option.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
v1GetSurveyInstructions(requestParameters = {}, options) {
|
|
1883
|
+
return localVarFp.v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(axios, basePath));
|
|
1884
|
+
},
|
|
1420
1885
|
/**
|
|
1421
1886
|
* Get a TDM.
|
|
1422
1887
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|
|
@@ -1511,14 +1976,24 @@ export class DefaultApi extends BaseAPI {
|
|
|
1511
1976
|
return DefaultApiFp(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1512
1977
|
}
|
|
1513
1978
|
/**
|
|
1514
|
-
*
|
|
1515
|
-
* @param {
|
|
1979
|
+
* 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.
|
|
1980
|
+
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
1981
|
+
* @param {*} [options] Override http request option.
|
|
1982
|
+
* @throws {RequiredError}
|
|
1983
|
+
* @memberof DefaultApi
|
|
1984
|
+
*/
|
|
1985
|
+
v1CreateSearchInstruction(requestParameters, options) {
|
|
1986
|
+
return DefaultApiFp(this.configuration).v1CreateSearchInstruction(requestParameters.v1CreateSearchInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1987
|
+
}
|
|
1988
|
+
/**
|
|
1989
|
+
* 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.
|
|
1990
|
+
* @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
|
|
1516
1991
|
* @param {*} [options] Override http request option.
|
|
1517
1992
|
* @throws {RequiredError}
|
|
1518
1993
|
* @memberof DefaultApi
|
|
1519
1994
|
*/
|
|
1520
|
-
|
|
1521
|
-
return DefaultApiFp(this.configuration).
|
|
1995
|
+
v1CreateSurveyInstruction(requestParameters, options) {
|
|
1996
|
+
return DefaultApiFp(this.configuration).v1CreateSurveyInstruction(requestParameters.v1CreateSurveyInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1522
1997
|
}
|
|
1523
1998
|
/**
|
|
1524
1999
|
* 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.
|
|
@@ -1560,6 +2035,26 @@ export class DefaultApi extends BaseAPI {
|
|
|
1560
2035
|
v1DeleteOrganizationTarget(requestParameters, options) {
|
|
1561
2036
|
return DefaultApiFp(this.configuration).v1DeleteOrganizationTarget(requestParameters.satelliteTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
1562
2037
|
}
|
|
2038
|
+
/**
|
|
2039
|
+
* Delete a search instruction.
|
|
2040
|
+
* @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
|
|
2041
|
+
* @param {*} [options] Override http request option.
|
|
2042
|
+
* @throws {RequiredError}
|
|
2043
|
+
* @memberof DefaultApi
|
|
2044
|
+
*/
|
|
2045
|
+
v1DeleteSearchInstruction(requestParameters, options) {
|
|
2046
|
+
return DefaultApiFp(this.configuration).v1DeleteSearchInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2047
|
+
}
|
|
2048
|
+
/**
|
|
2049
|
+
* Delete a survey instruction.
|
|
2050
|
+
* @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
|
|
2051
|
+
* @param {*} [options] Override http request option.
|
|
2052
|
+
* @throws {RequiredError}
|
|
2053
|
+
* @memberof DefaultApi
|
|
2054
|
+
*/
|
|
2055
|
+
v1DeleteSurveyInstruction(requestParameters, options) {
|
|
2056
|
+
return DefaultApiFp(this.configuration).v1DeleteSurveyInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2057
|
+
}
|
|
1563
2058
|
/**
|
|
1564
2059
|
* Delete a webhook configuration.
|
|
1565
2060
|
* @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -1619,6 +2114,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
1619
2114
|
v1GetNodeProperties(requestParameters, options) {
|
|
1620
2115
|
return DefaultApiFp(this.configuration).v1GetNodeProperties(requestParameters.nodeId, options).then((request) => request(this.axios, this.basePath));
|
|
1621
2116
|
}
|
|
2117
|
+
/**
|
|
2118
|
+
* Get observation features.
|
|
2119
|
+
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
2120
|
+
* @param {*} [options] Override http request option.
|
|
2121
|
+
* @throws {RequiredError}
|
|
2122
|
+
* @memberof DefaultApi
|
|
2123
|
+
*/
|
|
2124
|
+
v1GetObservationFeatures(requestParameters, options) {
|
|
2125
|
+
return DefaultApiFp(this.configuration).v1GetObservationFeatures(requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
2126
|
+
}
|
|
1622
2127
|
/**
|
|
1623
2128
|
* Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
|
|
1624
2129
|
* @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
|
|
@@ -1629,6 +2134,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
1629
2134
|
v1GetObservationSequenceResults(requestParameters = {}, options) {
|
|
1630
2135
|
return DefaultApiFp(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
1631
2136
|
}
|
|
2137
|
+
/**
|
|
2138
|
+
* 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.
|
|
2139
|
+
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
2140
|
+
* @param {*} [options] Override http request option.
|
|
2141
|
+
* @throws {RequiredError}
|
|
2142
|
+
* @memberof DefaultApi
|
|
2143
|
+
*/
|
|
2144
|
+
v1GetObservationStatuses(requestParameters = {}, options) {
|
|
2145
|
+
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, options).then((request) => request(this.axios, this.basePath));
|
|
2146
|
+
}
|
|
1632
2147
|
/**
|
|
1633
2148
|
* Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
|
|
1634
2149
|
* @param {*} [options] Override http request option.
|
|
@@ -1648,6 +2163,16 @@ export class DefaultApi extends BaseAPI {
|
|
|
1648
2163
|
v1GetSatellitePotentials(requestParameters, options) {
|
|
1649
2164
|
return DefaultApiFp(this.configuration).v1GetSatellitePotentials(requestParameters.satelliteTargetId, requestParameters.until, options).then((request) => request(this.axios, this.basePath));
|
|
1650
2165
|
}
|
|
2166
|
+
/**
|
|
2167
|
+
* Get a satellite target that the OurSky platform can currently track by id.
|
|
2168
|
+
* @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
|
|
2169
|
+
* @param {*} [options] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
* @memberof DefaultApi
|
|
2172
|
+
*/
|
|
2173
|
+
v1GetSatelliteTarget(requestParameters, options) {
|
|
2174
|
+
return DefaultApiFp(this.configuration).v1GetSatelliteTarget(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2175
|
+
}
|
|
1651
2176
|
/**
|
|
1652
2177
|
* The available satellite objects that the OurSky platform can currently track.
|
|
1653
2178
|
* @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
|
|
@@ -1658,6 +2183,26 @@ export class DefaultApi extends BaseAPI {
|
|
|
1658
2183
|
v1GetSatelliteTargets(requestParameters = {}, options) {
|
|
1659
2184
|
return DefaultApiFp(this.configuration).v1GetSatelliteTargets(requestParameters.orbitType, requestParameters.noradId, options).then((request) => request(this.axios, this.basePath));
|
|
1660
2185
|
}
|
|
2186
|
+
/**
|
|
2187
|
+
* 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.
|
|
2188
|
+
* @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
|
|
2189
|
+
* @param {*} [options] Override http request option.
|
|
2190
|
+
* @throws {RequiredError}
|
|
2191
|
+
* @memberof DefaultApi
|
|
2192
|
+
*/
|
|
2193
|
+
v1GetSearchInstructions(requestParameters = {}, options) {
|
|
2194
|
+
return DefaultApiFp(this.configuration).v1GetSearchInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* 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.
|
|
2198
|
+
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
2199
|
+
* @param {*} [options] Override http request option.
|
|
2200
|
+
* @throws {RequiredError}
|
|
2201
|
+
* @memberof DefaultApi
|
|
2202
|
+
*/
|
|
2203
|
+
v1GetSurveyInstructions(requestParameters = {}, options) {
|
|
2204
|
+
return DefaultApiFp(this.configuration).v1GetSurveyInstructions(requestParameters.before, options).then((request) => request(this.axios, this.basePath));
|
|
2205
|
+
}
|
|
1661
2206
|
/**
|
|
1662
2207
|
* Get a TDM.
|
|
1663
2208
|
* @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
|