@ourskyai/sda-api 1.3.2437 → 1.3.2584
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 +431 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +300 -1
- package/dist/api.js +193 -1
- 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 +300 -1
- package/dist/esm/api.js +193 -1
- 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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @ourskyai/sda-api@1.3.
|
|
1
|
+
## @ourskyai/sda-api@1.3.2584
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @ourskyai/sda-api@1.3.
|
|
39
|
+
npm install @ourskyai/sda-api@1.3.2584 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -179,6 +179,37 @@ export interface ObservationBoundingBox {
|
|
|
179
179
|
*/
|
|
180
180
|
'endY': number;
|
|
181
181
|
}
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @export
|
|
185
|
+
* @interface ObservationQuality
|
|
186
|
+
*/
|
|
187
|
+
export interface ObservationQuality {
|
|
188
|
+
/**
|
|
189
|
+
* Standard deviation for the line fit of the observation positions over time
|
|
190
|
+
* @type {number}
|
|
191
|
+
* @memberof ObservationQuality
|
|
192
|
+
*/
|
|
193
|
+
'lineFitOffsetStdDev': number;
|
|
194
|
+
/**
|
|
195
|
+
* Average of the distances beween observation and prediction, in arcsec
|
|
196
|
+
* @type {number}
|
|
197
|
+
* @memberof ObservationQuality
|
|
198
|
+
*/
|
|
199
|
+
'distanceFromPredictionAverage'?: number;
|
|
200
|
+
/**
|
|
201
|
+
* Slope of the linear fit of distances, in arcsec per second
|
|
202
|
+
* @type {number}
|
|
203
|
+
* @memberof ObservationQuality
|
|
204
|
+
*/
|
|
205
|
+
'distanceFromPredictionLineFitSlope'?: number;
|
|
206
|
+
/**
|
|
207
|
+
* Standard deviation of the offsets of the linear fit
|
|
208
|
+
* @type {number}
|
|
209
|
+
* @memberof ObservationQuality
|
|
210
|
+
*/
|
|
211
|
+
'distanceFromPredictionLineFitStdDev'?: number;
|
|
212
|
+
}
|
|
182
213
|
/**
|
|
183
214
|
* A single observation result. This is a 1:1 mapping with a single image
|
|
184
215
|
* @export
|
|
@@ -239,6 +270,12 @@ export interface ObservationResult {
|
|
|
239
270
|
* @memberof ObservationResult
|
|
240
271
|
*/
|
|
241
272
|
'apparentMagnitude'?: number;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof ObservationResult
|
|
277
|
+
*/
|
|
278
|
+
'distanceFromPrediction'?: number;
|
|
242
279
|
}
|
|
243
280
|
/**
|
|
244
281
|
*
|
|
@@ -400,6 +437,107 @@ export interface V1CreateOrganizationTargetRequest {
|
|
|
400
437
|
*/
|
|
401
438
|
'satelliteTargetId': string;
|
|
402
439
|
}
|
|
440
|
+
/**
|
|
441
|
+
*
|
|
442
|
+
* @export
|
|
443
|
+
* @interface V1CreateSatelliteTargetRequest
|
|
444
|
+
*/
|
|
445
|
+
export interface V1CreateSatelliteTargetRequest {
|
|
446
|
+
/**
|
|
447
|
+
*
|
|
448
|
+
* @type {string}
|
|
449
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
450
|
+
*/
|
|
451
|
+
'tleName': string;
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
456
|
+
*/
|
|
457
|
+
'tleLine1': string;
|
|
458
|
+
/**
|
|
459
|
+
*
|
|
460
|
+
* @type {string}
|
|
461
|
+
* @memberof V1CreateSatelliteTargetRequest
|
|
462
|
+
*/
|
|
463
|
+
'tleLine2': string;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
*
|
|
467
|
+
* @export
|
|
468
|
+
* @interface V1CreateSearchTaskRequest
|
|
469
|
+
*/
|
|
470
|
+
export interface V1CreateSearchTaskRequest {
|
|
471
|
+
/**
|
|
472
|
+
*
|
|
473
|
+
* @type {string}
|
|
474
|
+
* @memberof V1CreateSearchTaskRequest
|
|
475
|
+
*/
|
|
476
|
+
'nodeId': string;
|
|
477
|
+
/**
|
|
478
|
+
*
|
|
479
|
+
* @type {string}
|
|
480
|
+
* @memberof V1CreateSearchTaskRequest
|
|
481
|
+
*/
|
|
482
|
+
'targetId': string;
|
|
483
|
+
/**
|
|
484
|
+
*
|
|
485
|
+
* @type {TrackingType}
|
|
486
|
+
* @memberof V1CreateSearchTaskRequest
|
|
487
|
+
*/
|
|
488
|
+
'trackingType'?: TrackingType;
|
|
489
|
+
/**
|
|
490
|
+
*
|
|
491
|
+
* @type {Array<V1CreateSearchTaskRequestStepsInner>}
|
|
492
|
+
* @memberof V1CreateSearchTaskRequest
|
|
493
|
+
*/
|
|
494
|
+
'steps': Array<V1CreateSearchTaskRequestStepsInner>;
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Search steps
|
|
500
|
+
* @export
|
|
501
|
+
* @interface V1CreateSearchTaskRequestStepsInner
|
|
502
|
+
*/
|
|
503
|
+
export interface V1CreateSearchTaskRequestStepsInner {
|
|
504
|
+
/**
|
|
505
|
+
* Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
506
|
+
* @type {number}
|
|
507
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
508
|
+
*/
|
|
509
|
+
'ra'?: number;
|
|
510
|
+
/**
|
|
511
|
+
* Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
|
|
512
|
+
* @type {number}
|
|
513
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
514
|
+
*/
|
|
515
|
+
'dec'?: number;
|
|
516
|
+
/**
|
|
517
|
+
* Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
518
|
+
* @type {number}
|
|
519
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
520
|
+
*/
|
|
521
|
+
'raOffset'?: number;
|
|
522
|
+
/**
|
|
523
|
+
* Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
|
|
524
|
+
* @type {number}
|
|
525
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
526
|
+
*/
|
|
527
|
+
'decOffset'?: number;
|
|
528
|
+
/**
|
|
529
|
+
*
|
|
530
|
+
* @type {string}
|
|
531
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
532
|
+
*/
|
|
533
|
+
'startTime': string;
|
|
534
|
+
/**
|
|
535
|
+
*
|
|
536
|
+
* @type {string}
|
|
537
|
+
* @memberof V1CreateSearchTaskRequestStepsInner
|
|
538
|
+
*/
|
|
539
|
+
'endTime': string;
|
|
540
|
+
}
|
|
403
541
|
/**
|
|
404
542
|
*
|
|
405
543
|
* @export
|
|
@@ -793,6 +931,12 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
793
931
|
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
794
932
|
*/
|
|
795
933
|
'observationResults': Array<ObservationResult>;
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @type {ObservationQuality}
|
|
937
|
+
* @memberof V1ObservationSequenceResultImageSetsInner
|
|
938
|
+
*/
|
|
939
|
+
'observationQuality'?: ObservationQuality;
|
|
796
940
|
}
|
|
797
941
|
/**
|
|
798
942
|
*
|
|
@@ -989,6 +1133,37 @@ export interface V1UpdateEmailConfigurationRequest {
|
|
|
989
1133
|
*/
|
|
990
1134
|
'emails': Array<string>;
|
|
991
1135
|
}
|
|
1136
|
+
/**
|
|
1137
|
+
*
|
|
1138
|
+
* @export
|
|
1139
|
+
* @interface V1UpdateSatelliteTargetRequest
|
|
1140
|
+
*/
|
|
1141
|
+
export interface V1UpdateSatelliteTargetRequest {
|
|
1142
|
+
/**
|
|
1143
|
+
*
|
|
1144
|
+
* @type {string}
|
|
1145
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1146
|
+
*/
|
|
1147
|
+
'targetId': string;
|
|
1148
|
+
/**
|
|
1149
|
+
*
|
|
1150
|
+
* @type {string}
|
|
1151
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1152
|
+
*/
|
|
1153
|
+
'tleName'?: string;
|
|
1154
|
+
/**
|
|
1155
|
+
*
|
|
1156
|
+
* @type {string}
|
|
1157
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1158
|
+
*/
|
|
1159
|
+
'tleLine1': string;
|
|
1160
|
+
/**
|
|
1161
|
+
*
|
|
1162
|
+
* @type {string}
|
|
1163
|
+
* @memberof V1UpdateSatelliteTargetRequest
|
|
1164
|
+
*/
|
|
1165
|
+
'tleLine2': string;
|
|
1166
|
+
}
|
|
992
1167
|
/**
|
|
993
1168
|
*
|
|
994
1169
|
* @export
|
|
@@ -1199,6 +1374,88 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1199
1374
|
options: localVarRequestOptions,
|
|
1200
1375
|
};
|
|
1201
1376
|
},
|
|
1377
|
+
/**
|
|
1378
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
1379
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
1380
|
+
* @param {*} [options] Override http request option.
|
|
1381
|
+
* @throws {RequiredError}
|
|
1382
|
+
*/
|
|
1383
|
+
v1CreateSatelliteTarget: async (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1384
|
+
// verify required parameter 'v1CreateSatelliteTargetRequest' is not null or undefined
|
|
1385
|
+
assertParamExists('v1CreateSatelliteTarget', 'v1CreateSatelliteTargetRequest', v1CreateSatelliteTargetRequest)
|
|
1386
|
+
const localVarPath = `/v1/satellite-target`;
|
|
1387
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1388
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1389
|
+
let baseOptions;
|
|
1390
|
+
if (configuration) {
|
|
1391
|
+
baseOptions = configuration.baseOptions;
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1394
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1395
|
+
const localVarHeaderParameter = {} as any;
|
|
1396
|
+
const localVarQueryParameter = {} as any;
|
|
1397
|
+
|
|
1398
|
+
// authentication Roles required
|
|
1399
|
+
|
|
1400
|
+
// authentication BearerToken required
|
|
1401
|
+
// http bearer authentication required
|
|
1402
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1407
|
+
|
|
1408
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1409
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1410
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1411
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSatelliteTargetRequest, localVarRequestOptions, configuration)
|
|
1412
|
+
|
|
1413
|
+
return {
|
|
1414
|
+
url: toPathString(localVarUrlObj),
|
|
1415
|
+
options: localVarRequestOptions,
|
|
1416
|
+
};
|
|
1417
|
+
},
|
|
1418
|
+
/**
|
|
1419
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
1420
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
1421
|
+
* @param {*} [options] Override http request option.
|
|
1422
|
+
* @throws {RequiredError}
|
|
1423
|
+
*/
|
|
1424
|
+
v1CreateSearchTask: async (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1425
|
+
// verify required parameter 'v1CreateSearchTaskRequest' is not null or undefined
|
|
1426
|
+
assertParamExists('v1CreateSearchTask', 'v1CreateSearchTaskRequest', v1CreateSearchTaskRequest)
|
|
1427
|
+
const localVarPath = `/v1/search-instruction`;
|
|
1428
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1429
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1430
|
+
let baseOptions;
|
|
1431
|
+
if (configuration) {
|
|
1432
|
+
baseOptions = configuration.baseOptions;
|
|
1433
|
+
}
|
|
1434
|
+
|
|
1435
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1436
|
+
const localVarHeaderParameter = {} as any;
|
|
1437
|
+
const localVarQueryParameter = {} as any;
|
|
1438
|
+
|
|
1439
|
+
// authentication Roles required
|
|
1440
|
+
|
|
1441
|
+
// authentication BearerToken required
|
|
1442
|
+
// http bearer authentication required
|
|
1443
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1448
|
+
|
|
1449
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1450
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1451
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1452
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSearchTaskRequest, localVarRequestOptions, configuration)
|
|
1453
|
+
|
|
1454
|
+
return {
|
|
1455
|
+
url: toPathString(localVarUrlObj),
|
|
1456
|
+
options: localVarRequestOptions,
|
|
1457
|
+
};
|
|
1458
|
+
},
|
|
1202
1459
|
/**
|
|
1203
1460
|
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"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.
|
|
1204
1461
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -1949,6 +2206,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1949
2206
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1950
2207
|
localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateEmailConfigurationRequest, localVarRequestOptions, configuration)
|
|
1951
2208
|
|
|
2209
|
+
return {
|
|
2210
|
+
url: toPathString(localVarUrlObj),
|
|
2211
|
+
options: localVarRequestOptions,
|
|
2212
|
+
};
|
|
2213
|
+
},
|
|
2214
|
+
/**
|
|
2215
|
+
* Update satellite target.
|
|
2216
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
2217
|
+
* @param {*} [options] Override http request option.
|
|
2218
|
+
* @throws {RequiredError}
|
|
2219
|
+
*/
|
|
2220
|
+
v1UpdateSatelliteTarget: async (v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2221
|
+
// verify required parameter 'v1UpdateSatelliteTargetRequest' is not null or undefined
|
|
2222
|
+
assertParamExists('v1UpdateSatelliteTarget', 'v1UpdateSatelliteTargetRequest', v1UpdateSatelliteTargetRequest)
|
|
2223
|
+
const localVarPath = `/v1/satellite-target`;
|
|
2224
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2225
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2226
|
+
let baseOptions;
|
|
2227
|
+
if (configuration) {
|
|
2228
|
+
baseOptions = configuration.baseOptions;
|
|
2229
|
+
}
|
|
2230
|
+
|
|
2231
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
2232
|
+
const localVarHeaderParameter = {} as any;
|
|
2233
|
+
const localVarQueryParameter = {} as any;
|
|
2234
|
+
|
|
2235
|
+
// authentication Roles required
|
|
2236
|
+
|
|
2237
|
+
// authentication BearerToken required
|
|
2238
|
+
// http bearer authentication required
|
|
2239
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2244
|
+
|
|
2245
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2246
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2247
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2248
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateSatelliteTargetRequest, localVarRequestOptions, configuration)
|
|
2249
|
+
|
|
1952
2250
|
return {
|
|
1953
2251
|
url: toPathString(localVarUrlObj),
|
|
1954
2252
|
options: localVarRequestOptions,
|
|
@@ -1994,6 +2292,26 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
1994
2292
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateOrganizationTarget(v1CreateOrganizationTargetRequest, options);
|
|
1995
2293
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1996
2294
|
},
|
|
2295
|
+
/**
|
|
2296
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
2297
|
+
* @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
|
|
2298
|
+
* @param {*} [options] Override http request option.
|
|
2299
|
+
* @throws {RequiredError}
|
|
2300
|
+
*/
|
|
2301
|
+
async v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
|
|
2302
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options);
|
|
2303
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2304
|
+
},
|
|
2305
|
+
/**
|
|
2306
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
2307
|
+
* @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
|
|
2308
|
+
* @param {*} [options] Override http request option.
|
|
2309
|
+
* @throws {RequiredError}
|
|
2310
|
+
*/
|
|
2311
|
+
async v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
|
|
2312
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSearchTask(v1CreateSearchTaskRequest, options);
|
|
2313
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2314
|
+
},
|
|
1997
2315
|
/**
|
|
1998
2316
|
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"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.
|
|
1999
2317
|
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
@@ -2175,6 +2493,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
2175
2493
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest, options);
|
|
2176
2494
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2177
2495
|
},
|
|
2496
|
+
/**
|
|
2497
|
+
* Update satellite target.
|
|
2498
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
2499
|
+
* @param {*} [options] Override http request option.
|
|
2500
|
+
* @throws {RequiredError}
|
|
2501
|
+
*/
|
|
2502
|
+
async v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
2503
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options);
|
|
2504
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2505
|
+
},
|
|
2178
2506
|
}
|
|
2179
2507
|
};
|
|
2180
2508
|
|
|
@@ -2212,6 +2540,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2212
2540
|
v1CreateOrganizationTarget(requestParameters: DefaultApiV1CreateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2213
2541
|
return localVarFp.v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
|
|
2214
2542
|
},
|
|
2543
|
+
/**
|
|
2544
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
2545
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2546
|
+
* @param {*} [options] Override http request option.
|
|
2547
|
+
* @throws {RequiredError}
|
|
2548
|
+
*/
|
|
2549
|
+
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
2550
|
+
return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
2551
|
+
},
|
|
2552
|
+
/**
|
|
2553
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
2554
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
2555
|
+
* @param {*} [options] Override http request option.
|
|
2556
|
+
* @throws {RequiredError}
|
|
2557
|
+
*/
|
|
2558
|
+
v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
2559
|
+
return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
|
|
2560
|
+
},
|
|
2215
2561
|
/**
|
|
2216
2562
|
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"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.
|
|
2217
2563
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -2371,6 +2717,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
2371
2717
|
v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2372
2718
|
return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
2373
2719
|
},
|
|
2720
|
+
/**
|
|
2721
|
+
* Update satellite target.
|
|
2722
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2723
|
+
* @param {*} [options] Override http request option.
|
|
2724
|
+
* @throws {RequiredError}
|
|
2725
|
+
*/
|
|
2726
|
+
v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
2727
|
+
return localVarFp.v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
|
|
2728
|
+
},
|
|
2374
2729
|
};
|
|
2375
2730
|
};
|
|
2376
2731
|
|
|
@@ -2416,6 +2771,34 @@ export interface DefaultApiV1CreateOrganizationTargetRequest {
|
|
|
2416
2771
|
readonly v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest
|
|
2417
2772
|
}
|
|
2418
2773
|
|
|
2774
|
+
/**
|
|
2775
|
+
* Request parameters for v1CreateSatelliteTarget operation in DefaultApi.
|
|
2776
|
+
* @export
|
|
2777
|
+
* @interface DefaultApiV1CreateSatelliteTargetRequest
|
|
2778
|
+
*/
|
|
2779
|
+
export interface DefaultApiV1CreateSatelliteTargetRequest {
|
|
2780
|
+
/**
|
|
2781
|
+
*
|
|
2782
|
+
* @type {V1CreateSatelliteTargetRequest}
|
|
2783
|
+
* @memberof DefaultApiV1CreateSatelliteTarget
|
|
2784
|
+
*/
|
|
2785
|
+
readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest
|
|
2786
|
+
}
|
|
2787
|
+
|
|
2788
|
+
/**
|
|
2789
|
+
* Request parameters for v1CreateSearchTask operation in DefaultApi.
|
|
2790
|
+
* @export
|
|
2791
|
+
* @interface DefaultApiV1CreateSearchTaskRequest
|
|
2792
|
+
*/
|
|
2793
|
+
export interface DefaultApiV1CreateSearchTaskRequest {
|
|
2794
|
+
/**
|
|
2795
|
+
*
|
|
2796
|
+
* @type {V1CreateSearchTaskRequest}
|
|
2797
|
+
* @memberof DefaultApiV1CreateSearchTask
|
|
2798
|
+
*/
|
|
2799
|
+
readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest
|
|
2800
|
+
}
|
|
2801
|
+
|
|
2419
2802
|
/**
|
|
2420
2803
|
* Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
|
|
2421
2804
|
* @export
|
|
@@ -2654,6 +3037,20 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
|
|
|
2654
3037
|
readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest
|
|
2655
3038
|
}
|
|
2656
3039
|
|
|
3040
|
+
/**
|
|
3041
|
+
* Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
|
|
3042
|
+
* @export
|
|
3043
|
+
* @interface DefaultApiV1UpdateSatelliteTargetRequest
|
|
3044
|
+
*/
|
|
3045
|
+
export interface DefaultApiV1UpdateSatelliteTargetRequest {
|
|
3046
|
+
/**
|
|
3047
|
+
*
|
|
3048
|
+
* @type {V1UpdateSatelliteTargetRequest}
|
|
3049
|
+
* @memberof DefaultApiV1UpdateSatelliteTarget
|
|
3050
|
+
*/
|
|
3051
|
+
readonly v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest
|
|
3052
|
+
}
|
|
3053
|
+
|
|
2657
3054
|
/**
|
|
2658
3055
|
* DefaultApi - object-oriented interface
|
|
2659
3056
|
* @export
|
|
@@ -2694,6 +3091,28 @@ export class DefaultApi extends BaseAPI {
|
|
|
2694
3091
|
return DefaultApiFp(this.configuration).v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2695
3092
|
}
|
|
2696
3093
|
|
|
3094
|
+
/**
|
|
3095
|
+
* Create a private satellite target. This target will only be visible to your organization
|
|
3096
|
+
* @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
|
|
3097
|
+
* @param {*} [options] Override http request option.
|
|
3098
|
+
* @throws {RequiredError}
|
|
3099
|
+
* @memberof DefaultApi
|
|
3100
|
+
*/
|
|
3101
|
+
public v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) {
|
|
3102
|
+
return DefaultApiFp(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3103
|
+
}
|
|
3104
|
+
|
|
3105
|
+
/**
|
|
3106
|
+
* \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
|
|
3107
|
+
* @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
|
|
3108
|
+
* @param {*} [options] Override http request option.
|
|
3109
|
+
* @throws {RequiredError}
|
|
3110
|
+
* @memberof DefaultApi
|
|
3111
|
+
*/
|
|
3112
|
+
public v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig) {
|
|
3113
|
+
return DefaultApiFp(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3114
|
+
}
|
|
3115
|
+
|
|
2697
3116
|
/**
|
|
2698
3117
|
* Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> GET /v1/tdm?id={id} The payload sent to the webhook endpoint will include a header field \"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.
|
|
2699
3118
|
* @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
|
|
@@ -2888,6 +3307,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
2888
3307
|
public v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) {
|
|
2889
3308
|
return DefaultApiFp(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2890
3309
|
}
|
|
3310
|
+
|
|
3311
|
+
/**
|
|
3312
|
+
* Update satellite target.
|
|
3313
|
+
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
3314
|
+
* @param {*} [options] Override http request option.
|
|
3315
|
+
* @throws {RequiredError}
|
|
3316
|
+
* @memberof DefaultApi
|
|
3317
|
+
*/
|
|
3318
|
+
public v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig) {
|
|
3319
|
+
return DefaultApiFp(this.configuration).v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3320
|
+
}
|
|
2891
3321
|
}
|
|
2892
3322
|
|
|
2893
3323
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.2584
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|