@ourskyai/sda-api 1.3.2437 → 1.3.2765

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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.2437
7
+ * The version of the OpenAPI document: 1.3.2765
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -179,6 +179,86 @@ export interface ObservationBoundingBox {
179
179
  */
180
180
  'endY': number;
181
181
  }
182
+ /**
183
+ * Observation Feature
184
+ * @export
185
+ * @interface ObservationFeature
186
+ */
187
+ export interface ObservationFeature {
188
+ /**
189
+ *
190
+ * @type {number}
191
+ * @memberof ObservationFeature
192
+ */
193
+ 'ra': number;
194
+ /**
195
+ *
196
+ * @type {number}
197
+ * @memberof ObservationFeature
198
+ */
199
+ 'dec': number;
200
+ /**
201
+ *
202
+ * @type {string}
203
+ * @memberof ObservationFeature
204
+ */
205
+ 'timestamp': string;
206
+ /**
207
+ *
208
+ * @type {ObservationBoundingBox}
209
+ * @memberof ObservationFeature
210
+ */
211
+ 'boundingBox'?: ObservationBoundingBox;
212
+ /**
213
+ * BETA: the apparent magnitude of the target at the time of the observation
214
+ * @type {number}
215
+ * @memberof ObservationFeature
216
+ */
217
+ 'apparentMagnitude'?: number;
218
+ /**
219
+ *
220
+ * @type {number}
221
+ * @memberof ObservationFeature
222
+ */
223
+ 'distanceFromPrediction'?: number;
224
+ /**
225
+ *
226
+ * @type {Array<TargetCorrelation>}
227
+ * @memberof ObservationFeature
228
+ */
229
+ 'targetCorrelations'?: Array<TargetCorrelation>;
230
+ }
231
+ /**
232
+ *
233
+ * @export
234
+ * @interface ObservationQuality
235
+ */
236
+ export interface ObservationQuality {
237
+ /**
238
+ * Standard deviation for the line fit of the observation positions over time
239
+ * @type {number}
240
+ * @memberof ObservationQuality
241
+ */
242
+ 'lineFitOffsetStdDev': number;
243
+ /**
244
+ * Average of the distances beween observation and prediction, in arcsec
245
+ * @type {number}
246
+ * @memberof ObservationQuality
247
+ */
248
+ 'distanceFromPredictionAverage'?: number;
249
+ /**
250
+ * Slope of the linear fit of distances, in arcsec per second
251
+ * @type {number}
252
+ * @memberof ObservationQuality
253
+ */
254
+ 'distanceFromPredictionLineFitSlope'?: number;
255
+ /**
256
+ * Standard deviation of the offsets of the linear fit
257
+ * @type {number}
258
+ * @memberof ObservationQuality
259
+ */
260
+ 'distanceFromPredictionLineFitStdDev'?: number;
261
+ }
182
262
  /**
183
263
  * A single observation result. This is a 1:1 mapping with a single image
184
264
  * @export
@@ -239,6 +319,18 @@ export interface ObservationResult {
239
319
  * @memberof ObservationResult
240
320
  */
241
321
  'apparentMagnitude'?: number;
322
+ /**
323
+ *
324
+ * @type {number}
325
+ * @memberof ObservationResult
326
+ */
327
+ 'distanceFromPrediction'?: number;
328
+ /**
329
+ *
330
+ * @type {Array<ObservationFeature>}
331
+ * @memberof ObservationResult
332
+ */
333
+ 'features'?: Array<ObservationFeature>;
242
334
  }
243
335
  /**
244
336
  *
@@ -302,6 +394,31 @@ export interface SuccessfulCreate {
302
394
  */
303
395
  'id': string;
304
396
  }
397
+ /**
398
+ * Target Correlation
399
+ * @export
400
+ * @interface TargetCorrelation
401
+ */
402
+ export interface TargetCorrelation {
403
+ /**
404
+ *
405
+ * @type {string}
406
+ * @memberof TargetCorrelation
407
+ */
408
+ 'targetId': string;
409
+ /**
410
+ *
411
+ * @type {number}
412
+ * @memberof TargetCorrelation
413
+ */
414
+ 'ra': number;
415
+ /**
416
+ *
417
+ * @type {number}
418
+ * @memberof TargetCorrelation
419
+ */
420
+ 'dec': number;
421
+ }
305
422
  /**
306
423
  *
307
424
  * @export
@@ -400,6 +517,107 @@ export interface V1CreateOrganizationTargetRequest {
400
517
  */
401
518
  'satelliteTargetId': string;
402
519
  }
520
+ /**
521
+ *
522
+ * @export
523
+ * @interface V1CreateSatelliteTargetRequest
524
+ */
525
+ export interface V1CreateSatelliteTargetRequest {
526
+ /**
527
+ *
528
+ * @type {string}
529
+ * @memberof V1CreateSatelliteTargetRequest
530
+ */
531
+ 'tleName': string;
532
+ /**
533
+ *
534
+ * @type {string}
535
+ * @memberof V1CreateSatelliteTargetRequest
536
+ */
537
+ 'tleLine1': string;
538
+ /**
539
+ *
540
+ * @type {string}
541
+ * @memberof V1CreateSatelliteTargetRequest
542
+ */
543
+ 'tleLine2': string;
544
+ }
545
+ /**
546
+ *
547
+ * @export
548
+ * @interface V1CreateSearchTaskRequest
549
+ */
550
+ export interface V1CreateSearchTaskRequest {
551
+ /**
552
+ *
553
+ * @type {string}
554
+ * @memberof V1CreateSearchTaskRequest
555
+ */
556
+ 'nodeId': string;
557
+ /**
558
+ *
559
+ * @type {string}
560
+ * @memberof V1CreateSearchTaskRequest
561
+ */
562
+ 'targetId': string;
563
+ /**
564
+ *
565
+ * @type {TrackingType}
566
+ * @memberof V1CreateSearchTaskRequest
567
+ */
568
+ 'trackingType'?: TrackingType;
569
+ /**
570
+ *
571
+ * @type {Array<V1CreateSearchTaskRequestStepsInner>}
572
+ * @memberof V1CreateSearchTaskRequest
573
+ */
574
+ 'steps': Array<V1CreateSearchTaskRequestStepsInner>;
575
+ }
576
+
577
+
578
+ /**
579
+ * Search steps
580
+ * @export
581
+ * @interface V1CreateSearchTaskRequestStepsInner
582
+ */
583
+ export interface V1CreateSearchTaskRequestStepsInner {
584
+ /**
585
+ * Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
586
+ * @type {number}
587
+ * @memberof V1CreateSearchTaskRequestStepsInner
588
+ */
589
+ 'ra'?: number;
590
+ /**
591
+ * Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
592
+ * @type {number}
593
+ * @memberof V1CreateSearchTaskRequestStepsInner
594
+ */
595
+ 'dec'?: number;
596
+ /**
597
+ * Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
598
+ * @type {number}
599
+ * @memberof V1CreateSearchTaskRequestStepsInner
600
+ */
601
+ 'raOffset'?: number;
602
+ /**
603
+ * Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
604
+ * @type {number}
605
+ * @memberof V1CreateSearchTaskRequestStepsInner
606
+ */
607
+ 'decOffset'?: number;
608
+ /**
609
+ *
610
+ * @type {string}
611
+ * @memberof V1CreateSearchTaskRequestStepsInner
612
+ */
613
+ 'startTime': string;
614
+ /**
615
+ *
616
+ * @type {string}
617
+ * @memberof V1CreateSearchTaskRequestStepsInner
618
+ */
619
+ 'endTime': string;
620
+ }
403
621
  /**
404
622
  *
405
623
  * @export
@@ -793,6 +1011,12 @@ export interface V1ObservationSequenceResultImageSetsInner {
793
1011
  * @memberof V1ObservationSequenceResultImageSetsInner
794
1012
  */
795
1013
  'observationResults': Array<ObservationResult>;
1014
+ /**
1015
+ *
1016
+ * @type {ObservationQuality}
1017
+ * @memberof V1ObservationSequenceResultImageSetsInner
1018
+ */
1019
+ 'observationQuality'?: ObservationQuality;
796
1020
  }
797
1021
  /**
798
1022
  *
@@ -989,6 +1213,37 @@ export interface V1UpdateEmailConfigurationRequest {
989
1213
  */
990
1214
  'emails': Array<string>;
991
1215
  }
1216
+ /**
1217
+ *
1218
+ * @export
1219
+ * @interface V1UpdateSatelliteTargetRequest
1220
+ */
1221
+ export interface V1UpdateSatelliteTargetRequest {
1222
+ /**
1223
+ *
1224
+ * @type {string}
1225
+ * @memberof V1UpdateSatelliteTargetRequest
1226
+ */
1227
+ 'targetId': string;
1228
+ /**
1229
+ *
1230
+ * @type {string}
1231
+ * @memberof V1UpdateSatelliteTargetRequest
1232
+ */
1233
+ 'tleName'?: string;
1234
+ /**
1235
+ *
1236
+ * @type {string}
1237
+ * @memberof V1UpdateSatelliteTargetRequest
1238
+ */
1239
+ 'tleLine1': string;
1240
+ /**
1241
+ *
1242
+ * @type {string}
1243
+ * @memberof V1UpdateSatelliteTargetRequest
1244
+ */
1245
+ 'tleLine2': string;
1246
+ }
992
1247
  /**
993
1248
  *
994
1249
  * @export
@@ -1013,7 +1268,21 @@ export interface V1UpdateWebhookConfigurationRequest {
1013
1268
  * @memberof V1UpdateWebhookConfigurationRequest
1014
1269
  */
1015
1270
  'events': Array<WebhookEvent>;
1271
+ /**
1272
+ *
1273
+ * @type {WebhookAuthType}
1274
+ * @memberof V1UpdateWebhookConfigurationRequest
1275
+ */
1276
+ 'authType'?: WebhookAuthType;
1277
+ /**
1278
+ *
1279
+ * @type {string}
1280
+ * @memberof V1UpdateWebhookConfigurationRequest
1281
+ */
1282
+ 'authorization'?: string;
1016
1283
  }
1284
+
1285
+
1017
1286
  /**
1018
1287
  *
1019
1288
  * @export
@@ -1052,7 +1321,22 @@ export interface V1WebhookConfiguration {
1052
1321
  'createdAt': string;
1053
1322
  }
1054
1323
  /**
1055
- *
1324
+ * Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
1325
+ * @export
1326
+ * @enum {string}
1327
+ */
1328
+
1329
+ export const WebhookAuthType = {
1330
+ NONE: 'NONE',
1331
+ BASIC: 'BASIC',
1332
+ BEARER: 'BEARER'
1333
+ } as const;
1334
+
1335
+ export type WebhookAuthType = typeof WebhookAuthType[keyof typeof WebhookAuthType];
1336
+
1337
+
1338
+ /**
1339
+ * Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
1056
1340
  * @export
1057
1341
  * @enum {string}
1058
1342
  */
@@ -1063,7 +1347,8 @@ export const WebhookEvent = {
1063
1347
  V1_OBSERVATION_CREATED: 'V1_OBSERVATION_CREATED',
1064
1348
  V1_IMAGE_CREATED: 'V1_IMAGE_CREATED',
1065
1349
  V1_STREAK_CREATED: 'V1_STREAK_CREATED',
1066
- V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'
1350
+ V1_SATELLITE_TARGET_TRACKING_DEACTIVATED: 'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED',
1351
+ V1_EO_OBSERVATION_CREATED: 'V1_EO_OBSERVATION_CREATED'
1067
1352
  } as const;
1068
1353
 
1069
1354
  export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
@@ -1200,7 +1485,89 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
1200
1485
  };
1201
1486
  },
1202
1487
  /**
1203
- * 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.
1488
+ * Create a private satellite target. This target will only be visible to your organization
1489
+ * @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
1490
+ * @param {*} [options] Override http request option.
1491
+ * @throws {RequiredError}
1492
+ */
1493
+ v1CreateSatelliteTarget: async (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
1494
+ // verify required parameter 'v1CreateSatelliteTargetRequest' is not null or undefined
1495
+ assertParamExists('v1CreateSatelliteTarget', 'v1CreateSatelliteTargetRequest', v1CreateSatelliteTargetRequest)
1496
+ const localVarPath = `/v1/satellite-target`;
1497
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1498
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1499
+ let baseOptions;
1500
+ if (configuration) {
1501
+ baseOptions = configuration.baseOptions;
1502
+ }
1503
+
1504
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1505
+ const localVarHeaderParameter = {} as any;
1506
+ const localVarQueryParameter = {} as any;
1507
+
1508
+ // authentication Roles required
1509
+
1510
+ // authentication BearerToken required
1511
+ // http bearer authentication required
1512
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1513
+
1514
+
1515
+
1516
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1517
+
1518
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1519
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1520
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1521
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSatelliteTargetRequest, localVarRequestOptions, configuration)
1522
+
1523
+ return {
1524
+ url: toPathString(localVarUrlObj),
1525
+ options: localVarRequestOptions,
1526
+ };
1527
+ },
1528
+ /**
1529
+ * \' 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. \'
1530
+ * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
1531
+ * @param {*} [options] Override http request option.
1532
+ * @throws {RequiredError}
1533
+ */
1534
+ v1CreateSearchTask: async (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
1535
+ // verify required parameter 'v1CreateSearchTaskRequest' is not null or undefined
1536
+ assertParamExists('v1CreateSearchTask', 'v1CreateSearchTaskRequest', v1CreateSearchTaskRequest)
1537
+ const localVarPath = `/v1/search-instruction`;
1538
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1539
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1540
+ let baseOptions;
1541
+ if (configuration) {
1542
+ baseOptions = configuration.baseOptions;
1543
+ }
1544
+
1545
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1546
+ const localVarHeaderParameter = {} as any;
1547
+ const localVarQueryParameter = {} as any;
1548
+
1549
+ // authentication Roles required
1550
+
1551
+ // authentication BearerToken required
1552
+ // http bearer authentication required
1553
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1554
+
1555
+
1556
+
1557
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1558
+
1559
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1560
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1561
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1562
+ localVarRequestOptions.data = serializeDataIfNeeded(v1CreateSearchTaskRequest, localVarRequestOptions, configuration)
1563
+
1564
+ return {
1565
+ url: toPathString(localVarUrlObj),
1566
+ options: localVarRequestOptions,
1567
+ };
1568
+ },
1569
+ /**
1570
+ * 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.
1204
1571
  * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
1205
1572
  * @param {*} [options] Override http request option.
1206
1573
  * @throws {RequiredError}
@@ -1949,6 +2316,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
1949
2316
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1950
2317
  localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateEmailConfigurationRequest, localVarRequestOptions, configuration)
1951
2318
 
2319
+ return {
2320
+ url: toPathString(localVarUrlObj),
2321
+ options: localVarRequestOptions,
2322
+ };
2323
+ },
2324
+ /**
2325
+ * Update satellite target.
2326
+ * @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
2327
+ * @param {*} [options] Override http request option.
2328
+ * @throws {RequiredError}
2329
+ */
2330
+ v1UpdateSatelliteTarget: async (v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
2331
+ // verify required parameter 'v1UpdateSatelliteTargetRequest' is not null or undefined
2332
+ assertParamExists('v1UpdateSatelliteTarget', 'v1UpdateSatelliteTargetRequest', v1UpdateSatelliteTargetRequest)
2333
+ const localVarPath = `/v1/satellite-target`;
2334
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2335
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2336
+ let baseOptions;
2337
+ if (configuration) {
2338
+ baseOptions = configuration.baseOptions;
2339
+ }
2340
+
2341
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
2342
+ const localVarHeaderParameter = {} as any;
2343
+ const localVarQueryParameter = {} as any;
2344
+
2345
+ // authentication Roles required
2346
+
2347
+ // authentication BearerToken required
2348
+ // http bearer authentication required
2349
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2350
+
2351
+
2352
+
2353
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2354
+
2355
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2356
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2357
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2358
+ localVarRequestOptions.data = serializeDataIfNeeded(v1UpdateSatelliteTargetRequest, localVarRequestOptions, configuration)
2359
+
1952
2360
  return {
1953
2361
  url: toPathString(localVarUrlObj),
1954
2362
  options: localVarRequestOptions,
@@ -1995,7 +2403,27 @@ export const DefaultApiFp = function(configuration?: Configuration) {
1995
2403
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1996
2404
  },
1997
2405
  /**
1998
- * 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.
2406
+ * Create a private satellite target. This target will only be visible to your organization
2407
+ * @param {V1CreateSatelliteTargetRequest} v1CreateSatelliteTargetRequest
2408
+ * @param {*} [options] Override http request option.
2409
+ * @throws {RequiredError}
2410
+ */
2411
+ async v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
2412
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest, options);
2413
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2414
+ },
2415
+ /**
2416
+ * \' 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. \'
2417
+ * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
2418
+ * @param {*} [options] Override http request option.
2419
+ * @throws {RequiredError}
2420
+ */
2421
+ async v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
2422
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateSearchTask(v1CreateSearchTaskRequest, options);
2423
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2424
+ },
2425
+ /**
2426
+ * 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.
1999
2427
  * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
2000
2428
  * @param {*} [options] Override http request option.
2001
2429
  * @throws {RequiredError}
@@ -2175,6 +2603,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
2175
2603
  const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest, options);
2176
2604
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2177
2605
  },
2606
+ /**
2607
+ * Update satellite target.
2608
+ * @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
2609
+ * @param {*} [options] Override http request option.
2610
+ * @throws {RequiredError}
2611
+ */
2612
+ async v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
2613
+ const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest, options);
2614
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2615
+ },
2178
2616
  }
2179
2617
  };
2180
2618
 
@@ -2213,7 +2651,25 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
2213
2651
  return localVarFp.v1CreateOrganizationTarget(requestParameters.v1CreateOrganizationTargetRequest, options).then((request) => request(axios, basePath));
2214
2652
  },
2215
2653
  /**
2216
- * 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.
2654
+ * Create a private satellite target. This target will only be visible to your organization
2655
+ * @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
2656
+ * @param {*} [options] Override http request option.
2657
+ * @throws {RequiredError}
2658
+ */
2659
+ v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
2660
+ return localVarFp.v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
2661
+ },
2662
+ /**
2663
+ * \' 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. \'
2664
+ * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
2665
+ * @param {*} [options] Override http request option.
2666
+ * @throws {RequiredError}
2667
+ */
2668
+ v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
2669
+ return localVarFp.v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(axios, basePath));
2670
+ },
2671
+ /**
2672
+ * 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.
2217
2673
  * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
2218
2674
  * @param {*} [options] Override http request option.
2219
2675
  * @throws {RequiredError}
@@ -2371,6 +2827,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
2371
2827
  v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
2372
2828
  return localVarFp.v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(axios, basePath));
2373
2829
  },
2830
+ /**
2831
+ * Update satellite target.
2832
+ * @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
2833
+ * @param {*} [options] Override http request option.
2834
+ * @throws {RequiredError}
2835
+ */
2836
+ v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
2837
+ return localVarFp.v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(axios, basePath));
2838
+ },
2374
2839
  };
2375
2840
  };
2376
2841
 
@@ -2416,6 +2881,34 @@ export interface DefaultApiV1CreateOrganizationTargetRequest {
2416
2881
  readonly v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest
2417
2882
  }
2418
2883
 
2884
+ /**
2885
+ * Request parameters for v1CreateSatelliteTarget operation in DefaultApi.
2886
+ * @export
2887
+ * @interface DefaultApiV1CreateSatelliteTargetRequest
2888
+ */
2889
+ export interface DefaultApiV1CreateSatelliteTargetRequest {
2890
+ /**
2891
+ *
2892
+ * @type {V1CreateSatelliteTargetRequest}
2893
+ * @memberof DefaultApiV1CreateSatelliteTarget
2894
+ */
2895
+ readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest
2896
+ }
2897
+
2898
+ /**
2899
+ * Request parameters for v1CreateSearchTask operation in DefaultApi.
2900
+ * @export
2901
+ * @interface DefaultApiV1CreateSearchTaskRequest
2902
+ */
2903
+ export interface DefaultApiV1CreateSearchTaskRequest {
2904
+ /**
2905
+ *
2906
+ * @type {V1CreateSearchTaskRequest}
2907
+ * @memberof DefaultApiV1CreateSearchTask
2908
+ */
2909
+ readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest
2910
+ }
2911
+
2419
2912
  /**
2420
2913
  * Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
2421
2914
  * @export
@@ -2654,6 +3147,20 @@ export interface DefaultApiV1UpdateEmailConfigurationRequest {
2654
3147
  readonly v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest
2655
3148
  }
2656
3149
 
3150
+ /**
3151
+ * Request parameters for v1UpdateSatelliteTarget operation in DefaultApi.
3152
+ * @export
3153
+ * @interface DefaultApiV1UpdateSatelliteTargetRequest
3154
+ */
3155
+ export interface DefaultApiV1UpdateSatelliteTargetRequest {
3156
+ /**
3157
+ *
3158
+ * @type {V1UpdateSatelliteTargetRequest}
3159
+ * @memberof DefaultApiV1UpdateSatelliteTarget
3160
+ */
3161
+ readonly v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest
3162
+ }
3163
+
2657
3164
  /**
2658
3165
  * DefaultApi - object-oriented interface
2659
3166
  * @export
@@ -2695,7 +3202,29 @@ export class DefaultApi extends BaseAPI {
2695
3202
  }
2696
3203
 
2697
3204
  /**
2698
- * 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.
3205
+ * Create a private satellite target. This target will only be visible to your organization
3206
+ * @param {DefaultApiV1CreateSatelliteTargetRequest} requestParameters Request parameters.
3207
+ * @param {*} [options] Override http request option.
3208
+ * @throws {RequiredError}
3209
+ * @memberof DefaultApi
3210
+ */
3211
+ public v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) {
3212
+ return DefaultApiFp(this.configuration).v1CreateSatelliteTarget(requestParameters.v1CreateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
3213
+ }
3214
+
3215
+ /**
3216
+ * \' 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. \'
3217
+ * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
3218
+ * @param {*} [options] Override http request option.
3219
+ * @throws {RequiredError}
3220
+ * @memberof DefaultApi
3221
+ */
3222
+ public v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig) {
3223
+ return DefaultApiFp(this.configuration).v1CreateSearchTask(requestParameters.v1CreateSearchTaskRequest, options).then((request) => request(this.axios, this.basePath));
3224
+ }
3225
+
3226
+ /**
3227
+ * 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.
2699
3228
  * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
2700
3229
  * @param {*} [options] Override http request option.
2701
3230
  * @throws {RequiredError}
@@ -2888,6 +3417,17 @@ export class DefaultApi extends BaseAPI {
2888
3417
  public v1UpdateEmailConfiguration(requestParameters: DefaultApiV1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig) {
2889
3418
  return DefaultApiFp(this.configuration).v1UpdateEmailConfiguration(requestParameters.v1UpdateEmailConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
2890
3419
  }
3420
+
3421
+ /**
3422
+ * Update satellite target.
3423
+ * @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
3424
+ * @param {*} [options] Override http request option.
3425
+ * @throws {RequiredError}
3426
+ * @memberof DefaultApi
3427
+ */
3428
+ public v1UpdateSatelliteTarget(requestParameters: DefaultApiV1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig) {
3429
+ return DefaultApiFp(this.configuration).v1UpdateSatelliteTarget(requestParameters.v1UpdateSatelliteTargetRequest, options).then((request) => request(this.axios, this.basePath));
3430
+ }
2891
3431
  }
2892
3432
 
2893
3433