@ourskyai/sda-api 1.3.8106 → 1.3.8639

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/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * OurSky SDA
3
3
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
4
4
  *
5
- * The version of the OpenAPI document: 1.3.8106
5
+ * The version of the OpenAPI document: 1.3.8639
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -481,6 +481,37 @@ export declare const V1BlackoutVolumeRequestReferenceFrameEnum: {
481
481
  readonly ECEF: "ECEF";
482
482
  };
483
483
  export type V1BlackoutVolumeRequestReferenceFrameEnum = typeof V1BlackoutVolumeRequestReferenceFrameEnum[keyof typeof V1BlackoutVolumeRequestReferenceFrameEnum];
484
+ /**
485
+ *
486
+ * @export
487
+ * @interface V1CreateDirectTaskInstructionRequest
488
+ */
489
+ export interface V1CreateDirectTaskInstructionRequest {
490
+ /**
491
+ * NET time after which the instruction can be executed (expressed in UTC). If null, the instruction can be executed immediately.
492
+ * @type {string}
493
+ * @memberof V1CreateDirectTaskInstructionRequest
494
+ */
495
+ 'executableAfter'?: string;
496
+ /**
497
+ * Latest time the instruction can be executed (expressed in UTC). If null, the instruction will not have an expiration.
498
+ * @type {string}
499
+ * @memberof V1CreateDirectTaskInstructionRequest
500
+ */
501
+ 'executableUntil'?: string;
502
+ /**
503
+ *
504
+ * @type {string}
505
+ * @memberof V1CreateDirectTaskInstructionRequest
506
+ */
507
+ 'targetId': string;
508
+ /**
509
+ *
510
+ * @type {TrackingType}
511
+ * @memberof V1CreateDirectTaskInstructionRequest
512
+ */
513
+ 'trackingType': TrackingType;
514
+ }
484
515
  /**
485
516
  *
486
517
  * @export
@@ -1496,11 +1527,11 @@ export interface V1ObservationSequenceResultImageSetsInner {
1496
1527
  */
1497
1528
  export interface V1ObservationStatus {
1498
1529
  /**
1499
- *
1530
+ * The ID of the observation, null if the observation has not happened yet
1500
1531
  * @type {string}
1501
1532
  * @memberof V1ObservationStatus
1502
1533
  */
1503
- 'id': string;
1534
+ 'observationId'?: string;
1504
1535
  /**
1505
1536
  *
1506
1537
  * @type {string}
@@ -1514,41 +1545,41 @@ export interface V1ObservationStatus {
1514
1545
  */
1515
1546
  'trackingType'?: TrackingType;
1516
1547
  /**
1517
- *
1548
+ * The expected RA at the time of the observation, null if the observation has not happened yet
1518
1549
  * @type {number}
1519
1550
  * @memberof V1ObservationStatus
1520
1551
  */
1521
- 'ra': number;
1552
+ 'ra'?: number;
1522
1553
  /**
1523
- *
1554
+ * The expected Dec at the time of the observation, null if the observation has not happened yet
1524
1555
  * @type {number}
1525
1556
  * @memberof V1ObservationStatus
1526
1557
  */
1527
- 'dec': number;
1558
+ 'dec'?: number;
1528
1559
  /**
1529
- *
1560
+ * Time the observation was executed at, null if the observation has not happened yet
1530
1561
  * @type {string}
1531
1562
  * @memberof V1ObservationStatus
1532
1563
  */
1533
- 'observationTime': string;
1564
+ 'observationTime'?: string;
1534
1565
  /**
1535
- * TLE line 1 of when the observation was tasked
1566
+ * TLE line 1 of when the observation was tasked, null if the observation has not happened yet
1536
1567
  * @type {string}
1537
1568
  * @memberof V1ObservationStatus
1538
1569
  */
1539
- 'tleLine1': string;
1570
+ 'tleLine1'?: string;
1540
1571
  /**
1541
- * TLE line 2 of when the observation was tasked
1572
+ * TLE line 2 of when the observation was tasked, null if the observation has not happened yet
1542
1573
  * @type {string}
1543
1574
  * @memberof V1ObservationStatus
1544
1575
  */
1545
- 'tleLine2': string;
1576
+ 'tleLine2'?: string;
1546
1577
  /**
1547
- *
1578
+ * TLE Epoch of when the observation was tasked, null if the observation has not happened yet
1548
1579
  * @type {string}
1549
1580
  * @memberof V1ObservationStatus
1550
1581
  */
1551
- 'tleEpoch': string;
1582
+ 'tleEpoch'?: string;
1552
1583
  /**
1553
1584
  *
1554
1585
  * @type {string}
@@ -1578,7 +1609,25 @@ export interface V1ObservationStatus {
1578
1609
  * @type {string}
1579
1610
  * @memberof V1ObservationStatus
1580
1611
  */
1612
+ 'directTaskId'?: string;
1613
+ /**
1614
+ * The time the observation was completed in our system, null if the observation has not happened yet
1615
+ * @type {string}
1616
+ * @memberof V1ObservationStatus
1617
+ */
1581
1618
  'completedAt'?: string;
1619
+ /**
1620
+ * The time the instruction was scheduled for, if applicable (direct tasked instructions only)
1621
+ * @type {string}
1622
+ * @memberof V1ObservationStatus
1623
+ */
1624
+ 'scheduledAt'?: string;
1625
+ /**
1626
+ * The time the instruction was valid until, if applicable (direct tasked instructions only)
1627
+ * @type {string}
1628
+ * @memberof V1ObservationStatus
1629
+ */
1630
+ 'validUntil'?: string;
1582
1631
  /**
1583
1632
  *
1584
1633
  * @type {ObservationState}
@@ -3138,6 +3187,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3138
3187
  * @throws {RequiredError}
3139
3188
  */
3140
3189
  v1CreateBlackoutVolume: (v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3190
+ /**
3191
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
3192
+ * @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
3193
+ * @param {*} [options] Override http request option.
3194
+ * @throws {RequiredError}
3195
+ */
3196
+ v1CreateDirectTaskInstruction: (v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3141
3197
  /**
3142
3198
  * Create an image set.
3143
3199
  * @param {V1CreateImageSetRequest} v1CreateImageSetRequest
@@ -3202,6 +3258,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3202
3258
  * @throws {RequiredError}
3203
3259
  */
3204
3260
  v1DeleteBlackoutVolume: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3261
+ /**
3262
+ * Delete a direct task instruction.
3263
+ * @param {string} id
3264
+ * @param {*} [options] Override http request option.
3265
+ * @throws {RequiredError}
3266
+ */
3267
+ v1DeleteDirectTaskInstruction: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3205
3268
  /**
3206
3269
  * Delete an image set.
3207
3270
  * @param {string} id
@@ -3318,17 +3381,18 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3318
3381
  */
3319
3382
  v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3320
3383
  /**
3321
- * 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.
3384
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
3322
3385
  * @param {string} [targetId]
3323
3386
  * @param {string} [before]
3324
3387
  * @param {string} [searchInstructionId]
3325
3388
  * @param {string} [surveyInstructionId]
3326
3389
  * @param {string} [resolvedImageInstructionId]
3390
+ * @param {string} [directTaskId]
3327
3391
  * @param {string} [imageId]
3328
3392
  * @param {*} [options] Override http request option.
3329
3393
  * @throws {RequiredError}
3330
3394
  */
3331
- v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3395
+ v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, directTaskId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3332
3396
  /**
3333
3397
  * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
3334
3398
  * @param {string} until
@@ -3530,6 +3594,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3530
3594
  * @throws {RequiredError}
3531
3595
  */
3532
3596
  v1CreateBlackoutVolume(v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
3597
+ /**
3598
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
3599
+ * @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
3600
+ * @param {*} [options] Override http request option.
3601
+ * @throws {RequiredError}
3602
+ */
3603
+ v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
3533
3604
  /**
3534
3605
  * Create an image set.
3535
3606
  * @param {V1CreateImageSetRequest} v1CreateImageSetRequest
@@ -3594,6 +3665,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3594
3665
  * @throws {RequiredError}
3595
3666
  */
3596
3667
  v1DeleteBlackoutVolume(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulDelete>>;
3668
+ /**
3669
+ * Delete a direct task instruction.
3670
+ * @param {string} id
3671
+ * @param {*} [options] Override http request option.
3672
+ * @throws {RequiredError}
3673
+ */
3674
+ v1DeleteDirectTaskInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
3597
3675
  /**
3598
3676
  * Delete an image set.
3599
3677
  * @param {string} id
@@ -3710,17 +3788,18 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3710
3788
  */
3711
3789
  v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
3712
3790
  /**
3713
- * 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.
3791
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
3714
3792
  * @param {string} [targetId]
3715
3793
  * @param {string} [before]
3716
3794
  * @param {string} [searchInstructionId]
3717
3795
  * @param {string} [surveyInstructionId]
3718
3796
  * @param {string} [resolvedImageInstructionId]
3797
+ * @param {string} [directTaskId]
3719
3798
  * @param {string} [imageId]
3720
3799
  * @param {*} [options] Override http request option.
3721
3800
  * @throws {RequiredError}
3722
3801
  */
3723
- v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
3802
+ v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, directTaskId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
3724
3803
  /**
3725
3804
  * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
3726
3805
  * @param {string} until
@@ -3922,6 +4001,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3922
4001
  * @throws {RequiredError}
3923
4002
  */
3924
4003
  v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
4004
+ /**
4005
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
4006
+ * @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
4007
+ * @param {*} [options] Override http request option.
4008
+ * @throws {RequiredError}
4009
+ */
4010
+ v1CreateDirectTaskInstruction(requestParameters: DefaultApiV1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
3925
4011
  /**
3926
4012
  * Create an image set.
3927
4013
  * @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
@@ -3986,6 +4072,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
3986
4072
  * @throws {RequiredError}
3987
4073
  */
3988
4074
  v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulDelete>;
4075
+ /**
4076
+ * Delete a direct task instruction.
4077
+ * @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
4078
+ * @param {*} [options] Override http request option.
4079
+ * @throws {RequiredError}
4080
+ */
4081
+ v1DeleteDirectTaskInstruction(requestParameters: DefaultApiV1DeleteDirectTaskInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
3989
4082
  /**
3990
4083
  * Delete an image set.
3991
4084
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -4098,7 +4191,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
4098
4191
  */
4099
4192
  v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
4100
4193
  /**
4101
- * 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.
4194
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
4102
4195
  * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
4103
4196
  * @param {*} [options] Override http request option.
4104
4197
  * @throws {RequiredError}
@@ -4297,6 +4390,19 @@ export interface DefaultApiV1CreateBlackoutVolumeRequest {
4297
4390
  */
4298
4391
  readonly v1BlackoutVolumeRequest: V1BlackoutVolumeRequest;
4299
4392
  }
4393
+ /**
4394
+ * Request parameters for v1CreateDirectTaskInstruction operation in DefaultApi.
4395
+ * @export
4396
+ * @interface DefaultApiV1CreateDirectTaskInstructionRequest
4397
+ */
4398
+ export interface DefaultApiV1CreateDirectTaskInstructionRequest {
4399
+ /**
4400
+ *
4401
+ * @type {V1CreateDirectTaskInstructionRequest}
4402
+ * @memberof DefaultApiV1CreateDirectTaskInstruction
4403
+ */
4404
+ readonly v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest;
4405
+ }
4300
4406
  /**
4301
4407
  * Request parameters for v1CreateImageSet operation in DefaultApi.
4302
4408
  * @export
@@ -4414,6 +4520,19 @@ export interface DefaultApiV1DeleteBlackoutVolumeRequest {
4414
4520
  */
4415
4521
  readonly id: string;
4416
4522
  }
4523
+ /**
4524
+ * Request parameters for v1DeleteDirectTaskInstruction operation in DefaultApi.
4525
+ * @export
4526
+ * @interface DefaultApiV1DeleteDirectTaskInstructionRequest
4527
+ */
4528
+ export interface DefaultApiV1DeleteDirectTaskInstructionRequest {
4529
+ /**
4530
+ *
4531
+ * @type {string}
4532
+ * @memberof DefaultApiV1DeleteDirectTaskInstruction
4533
+ */
4534
+ readonly id: string;
4535
+ }
4417
4536
  /**
4418
4537
  * Request parameters for v1DeleteImageSet operation in DefaultApi.
4419
4538
  * @export
@@ -4669,6 +4788,12 @@ export interface DefaultApiV1GetObservationStatusesRequest {
4669
4788
  * @memberof DefaultApiV1GetObservationStatuses
4670
4789
  */
4671
4790
  readonly resolvedImageInstructionId?: string;
4791
+ /**
4792
+ *
4793
+ * @type {string}
4794
+ * @memberof DefaultApiV1GetObservationStatuses
4795
+ */
4796
+ readonly directTaskId?: string;
4672
4797
  /**
4673
4798
  *
4674
4799
  * @type {string}
@@ -5070,6 +5195,14 @@ export declare class DefaultApi extends BaseAPI {
5070
5195
  * @memberof DefaultApi
5071
5196
  */
5072
5197
  v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
5198
+ /**
5199
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
5200
+ * @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
5201
+ * @param {*} [options] Override http request option.
5202
+ * @throws {RequiredError}
5203
+ * @memberof DefaultApi
5204
+ */
5205
+ v1CreateDirectTaskInstruction(requestParameters: DefaultApiV1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
5073
5206
  /**
5074
5207
  * Create an image set.
5075
5208
  * @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
@@ -5143,6 +5276,14 @@ export declare class DefaultApi extends BaseAPI {
5143
5276
  * @memberof DefaultApi
5144
5277
  */
5145
5278
  v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulDelete, any>>;
5279
+ /**
5280
+ * Delete a direct task instruction.
5281
+ * @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
5282
+ * @param {*} [options] Override http request option.
5283
+ * @throws {RequiredError}
5284
+ * @memberof DefaultApi
5285
+ */
5286
+ v1DeleteDirectTaskInstruction(requestParameters: DefaultApiV1DeleteDirectTaskInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
5146
5287
  /**
5147
5288
  * Delete an image set.
5148
5289
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -5271,7 +5412,7 @@ export declare class DefaultApi extends BaseAPI {
5271
5412
  */
5272
5413
  v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
5273
5414
  /**
5274
- * 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.
5415
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
5275
5416
  * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
5276
5417
  * @param {*} [options] Override http request option.
5277
5418
  * @throws {RequiredError}
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * OurSky SDA
6
6
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/GET/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/POST/v1/communications/webhook) endpoint to receive OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
7
7
  *
8
- * The version of the OpenAPI document: 1.3.8106
8
+ * The version of the OpenAPI document: 1.3.8639
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -317,6 +317,39 @@ const DefaultApiAxiosParamCreator = function (configuration) {
317
317
  options: localVarRequestOptions,
318
318
  };
319
319
  }),
320
+ /**
321
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
322
+ * @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ v1CreateDirectTaskInstruction: (v1CreateDirectTaskInstructionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
327
+ // verify required parameter 'v1CreateDirectTaskInstructionRequest' is not null or undefined
328
+ (0, common_1.assertParamExists)('v1CreateDirectTaskInstruction', 'v1CreateDirectTaskInstructionRequest', v1CreateDirectTaskInstructionRequest);
329
+ const localVarPath = `/v1/direct-task-instruction`;
330
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
331
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
332
+ let baseOptions;
333
+ if (configuration) {
334
+ baseOptions = configuration.baseOptions;
335
+ }
336
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
337
+ const localVarHeaderParameter = {};
338
+ const localVarQueryParameter = {};
339
+ // authentication Roles required
340
+ // authentication BearerToken required
341
+ // http bearer authentication required
342
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
343
+ localVarHeaderParameter['Content-Type'] = 'application/json';
344
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
345
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
346
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
347
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(v1CreateDirectTaskInstructionRequest, localVarRequestOptions, configuration);
348
+ return {
349
+ url: (0, common_1.toPathString)(localVarUrlObj),
350
+ options: localVarRequestOptions,
351
+ };
352
+ }),
320
353
  /**
321
354
  * Create an image set.
322
355
  * @param {V1CreateImageSetRequest} v1CreateImageSetRequest
@@ -616,6 +649,40 @@ const DefaultApiAxiosParamCreator = function (configuration) {
616
649
  options: localVarRequestOptions,
617
650
  };
618
651
  }),
652
+ /**
653
+ * Delete a direct task instruction.
654
+ * @param {string} id
655
+ * @param {*} [options] Override http request option.
656
+ * @throws {RequiredError}
657
+ */
658
+ v1DeleteDirectTaskInstruction: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
659
+ // verify required parameter 'id' is not null or undefined
660
+ (0, common_1.assertParamExists)('v1DeleteDirectTaskInstruction', 'id', id);
661
+ const localVarPath = `/v1/direct-task-instruction`;
662
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
663
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
664
+ let baseOptions;
665
+ if (configuration) {
666
+ baseOptions = configuration.baseOptions;
667
+ }
668
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
669
+ const localVarHeaderParameter = {};
670
+ const localVarQueryParameter = {};
671
+ // authentication Roles required
672
+ // authentication BearerToken required
673
+ // http bearer authentication required
674
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
675
+ if (id !== undefined) {
676
+ localVarQueryParameter['id'] = id;
677
+ }
678
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
679
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
680
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
681
+ return {
682
+ url: (0, common_1.toPathString)(localVarUrlObj),
683
+ options: localVarRequestOptions,
684
+ };
685
+ }),
619
686
  /**
620
687
  * Delete an image set.
621
688
  * @param {string} id
@@ -1171,17 +1238,18 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1171
1238
  };
1172
1239
  }),
1173
1240
  /**
1174
- * 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.
1241
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
1175
1242
  * @param {string} [targetId]
1176
1243
  * @param {string} [before]
1177
1244
  * @param {string} [searchInstructionId]
1178
1245
  * @param {string} [surveyInstructionId]
1179
1246
  * @param {string} [resolvedImageInstructionId]
1247
+ * @param {string} [directTaskId]
1180
1248
  * @param {string} [imageId]
1181
1249
  * @param {*} [options] Override http request option.
1182
1250
  * @throws {RequiredError}
1183
1251
  */
1184
- v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1252
+ v1GetObservationStatuses: (targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1185
1253
  const localVarPath = `/v1/observation-statuses`;
1186
1254
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1187
1255
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -1213,6 +1281,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
1213
1281
  if (resolvedImageInstructionId !== undefined) {
1214
1282
  localVarQueryParameter['resolvedImageInstructionId'] = resolvedImageInstructionId;
1215
1283
  }
1284
+ if (directTaskId !== undefined) {
1285
+ localVarQueryParameter['directTaskId'] = directTaskId;
1286
+ }
1216
1287
  if (imageId !== undefined) {
1217
1288
  localVarQueryParameter['imageId'] = imageId;
1218
1289
  }
@@ -2120,6 +2191,18 @@ const DefaultApiFp = function (configuration) {
2120
2191
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2121
2192
  });
2122
2193
  },
2194
+ /**
2195
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
2196
+ * @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
2197
+ * @param {*} [options] Override http request option.
2198
+ * @throws {RequiredError}
2199
+ */
2200
+ v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest, options) {
2201
+ return __awaiter(this, void 0, void 0, function* () {
2202
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest, options);
2203
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2204
+ });
2205
+ },
2123
2206
  /**
2124
2207
  * Create an image set.
2125
2208
  * @param {V1CreateImageSetRequest} v1CreateImageSetRequest
@@ -2229,6 +2312,18 @@ const DefaultApiFp = function (configuration) {
2229
2312
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2230
2313
  });
2231
2314
  },
2315
+ /**
2316
+ * Delete a direct task instruction.
2317
+ * @param {string} id
2318
+ * @param {*} [options] Override http request option.
2319
+ * @throws {RequiredError}
2320
+ */
2321
+ v1DeleteDirectTaskInstruction(id, options) {
2322
+ return __awaiter(this, void 0, void 0, function* () {
2323
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DeleteDirectTaskInstruction(id, options);
2324
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2325
+ });
2326
+ },
2232
2327
  /**
2233
2328
  * Delete an image set.
2234
2329
  * @param {string} id
@@ -2425,19 +2520,20 @@ const DefaultApiFp = function (configuration) {
2425
2520
  });
2426
2521
  },
2427
2522
  /**
2428
- * 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.
2523
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
2429
2524
  * @param {string} [targetId]
2430
2525
  * @param {string} [before]
2431
2526
  * @param {string} [searchInstructionId]
2432
2527
  * @param {string} [surveyInstructionId]
2433
2528
  * @param {string} [resolvedImageInstructionId]
2529
+ * @param {string} [directTaskId]
2434
2530
  * @param {string} [imageId]
2435
2531
  * @param {*} [options] Override http request option.
2436
2532
  * @throws {RequiredError}
2437
2533
  */
2438
- v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options) {
2534
+ v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options) {
2439
2535
  return __awaiter(this, void 0, void 0, function* () {
2440
- const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options);
2536
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options);
2441
2537
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2442
2538
  });
2443
2539
  },
@@ -2770,6 +2866,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
2770
2866
  v1CreateBlackoutVolume(requestParameters, options) {
2771
2867
  return localVarFp.v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(axios, basePath));
2772
2868
  },
2869
+ /**
2870
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
2871
+ * @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
2872
+ * @param {*} [options] Override http request option.
2873
+ * @throws {RequiredError}
2874
+ */
2875
+ v1CreateDirectTaskInstruction(requestParameters, options) {
2876
+ return localVarFp.v1CreateDirectTaskInstruction(requestParameters.v1CreateDirectTaskInstructionRequest, options).then((request) => request(axios, basePath));
2877
+ },
2773
2878
  /**
2774
2879
  * Create an image set.
2775
2880
  * @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
@@ -2852,6 +2957,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
2852
2957
  v1DeleteBlackoutVolume(requestParameters, options) {
2853
2958
  return localVarFp.v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(axios, basePath));
2854
2959
  },
2960
+ /**
2961
+ * Delete a direct task instruction.
2962
+ * @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
2963
+ * @param {*} [options] Override http request option.
2964
+ * @throws {RequiredError}
2965
+ */
2966
+ v1DeleteDirectTaskInstruction(requestParameters, options) {
2967
+ return localVarFp.v1DeleteDirectTaskInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
2968
+ },
2855
2969
  /**
2856
2970
  * Delete an image set.
2857
2971
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -2996,13 +3110,13 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
2996
3110
  return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
2997
3111
  },
2998
3112
  /**
2999
- * 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.
3113
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
3000
3114
  * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
3001
3115
  * @param {*} [options] Override http request option.
3002
3116
  * @throws {RequiredError}
3003
3117
  */
3004
3118
  v1GetObservationStatuses(requestParameters = {}, options) {
3005
- return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(axios, basePath));
3119
+ return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(axios, basePath));
3006
3120
  },
3007
3121
  /**
3008
3122
  * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
@@ -3249,6 +3363,16 @@ class DefaultApi extends base_1.BaseAPI {
3249
3363
  v1CreateBlackoutVolume(requestParameters, options) {
3250
3364
  return (0, exports.DefaultApiFp)(this.configuration).v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(this.axios, this.basePath));
3251
3365
  }
3366
+ /**
3367
+ * Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
3368
+ * @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
3369
+ * @param {*} [options] Override http request option.
3370
+ * @throws {RequiredError}
3371
+ * @memberof DefaultApi
3372
+ */
3373
+ v1CreateDirectTaskInstruction(requestParameters, options) {
3374
+ return (0, exports.DefaultApiFp)(this.configuration).v1CreateDirectTaskInstruction(requestParameters.v1CreateDirectTaskInstructionRequest, options).then((request) => request(this.axios, this.basePath));
3375
+ }
3252
3376
  /**
3253
3377
  * Create an image set.
3254
3378
  * @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
@@ -3340,6 +3464,16 @@ class DefaultApi extends base_1.BaseAPI {
3340
3464
  v1DeleteBlackoutVolume(requestParameters, options) {
3341
3465
  return (0, exports.DefaultApiFp)(this.configuration).v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
3342
3466
  }
3467
+ /**
3468
+ * Delete a direct task instruction.
3469
+ * @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
3470
+ * @param {*} [options] Override http request option.
3471
+ * @throws {RequiredError}
3472
+ * @memberof DefaultApi
3473
+ */
3474
+ v1DeleteDirectTaskInstruction(requestParameters, options) {
3475
+ return (0, exports.DefaultApiFp)(this.configuration).v1DeleteDirectTaskInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
3476
+ }
3343
3477
  /**
3344
3478
  * Delete an image set.
3345
3479
  * @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
@@ -3500,14 +3634,14 @@ class DefaultApi extends base_1.BaseAPI {
3500
3634
  return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
3501
3635
  }
3502
3636
  /**
3503
- * 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.
3637
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, 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`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
3504
3638
  * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
3505
3639
  * @param {*} [options] Override http request option.
3506
3640
  * @throws {RequiredError}
3507
3641
  * @memberof DefaultApi
3508
3642
  */
3509
3643
  v1GetObservationStatuses(requestParameters = {}, options) {
3510
- return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
3644
+ return (0, exports.DefaultApiFp)(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
3511
3645
  }
3512
3646
  /**
3513
3647
  * Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime