@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/README.md +2 -2
- package/api.ts +259 -24
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +162 -21
- package/dist/api.js +144 -10
- 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 +162 -21
- package/dist/esm/api.js +144 -10
- 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.8639
|
|
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.8639 --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 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8639
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -530,6 +530,39 @@ export const V1BlackoutVolumeRequestReferenceFrameEnum = {
|
|
|
530
530
|
|
|
531
531
|
export type V1BlackoutVolumeRequestReferenceFrameEnum = typeof V1BlackoutVolumeRequestReferenceFrameEnum[keyof typeof V1BlackoutVolumeRequestReferenceFrameEnum];
|
|
532
532
|
|
|
533
|
+
/**
|
|
534
|
+
*
|
|
535
|
+
* @export
|
|
536
|
+
* @interface V1CreateDirectTaskInstructionRequest
|
|
537
|
+
*/
|
|
538
|
+
export interface V1CreateDirectTaskInstructionRequest {
|
|
539
|
+
/**
|
|
540
|
+
* NET time after which the instruction can be executed (expressed in UTC). If null, the instruction can be executed immediately.
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof V1CreateDirectTaskInstructionRequest
|
|
543
|
+
*/
|
|
544
|
+
'executableAfter'?: string;
|
|
545
|
+
/**
|
|
546
|
+
* Latest time the instruction can be executed (expressed in UTC). If null, the instruction will not have an expiration.
|
|
547
|
+
* @type {string}
|
|
548
|
+
* @memberof V1CreateDirectTaskInstructionRequest
|
|
549
|
+
*/
|
|
550
|
+
'executableUntil'?: string;
|
|
551
|
+
/**
|
|
552
|
+
*
|
|
553
|
+
* @type {string}
|
|
554
|
+
* @memberof V1CreateDirectTaskInstructionRequest
|
|
555
|
+
*/
|
|
556
|
+
'targetId': string;
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
* @type {TrackingType}
|
|
560
|
+
* @memberof V1CreateDirectTaskInstructionRequest
|
|
561
|
+
*/
|
|
562
|
+
'trackingType': TrackingType;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
|
|
533
566
|
/**
|
|
534
567
|
*
|
|
535
568
|
* @export
|
|
@@ -1563,11 +1596,11 @@ export interface V1ObservationSequenceResultImageSetsInner {
|
|
|
1563
1596
|
*/
|
|
1564
1597
|
export interface V1ObservationStatus {
|
|
1565
1598
|
/**
|
|
1566
|
-
*
|
|
1599
|
+
* The ID of the observation, null if the observation has not happened yet
|
|
1567
1600
|
* @type {string}
|
|
1568
1601
|
* @memberof V1ObservationStatus
|
|
1569
1602
|
*/
|
|
1570
|
-
'
|
|
1603
|
+
'observationId'?: string;
|
|
1571
1604
|
/**
|
|
1572
1605
|
*
|
|
1573
1606
|
* @type {string}
|
|
@@ -1581,41 +1614,41 @@ export interface V1ObservationStatus {
|
|
|
1581
1614
|
*/
|
|
1582
1615
|
'trackingType'?: TrackingType;
|
|
1583
1616
|
/**
|
|
1584
|
-
*
|
|
1617
|
+
* The expected RA at the time of the observation, null if the observation has not happened yet
|
|
1585
1618
|
* @type {number}
|
|
1586
1619
|
* @memberof V1ObservationStatus
|
|
1587
1620
|
*/
|
|
1588
|
-
'ra'
|
|
1621
|
+
'ra'?: number;
|
|
1589
1622
|
/**
|
|
1590
|
-
*
|
|
1623
|
+
* The expected Dec at the time of the observation, null if the observation has not happened yet
|
|
1591
1624
|
* @type {number}
|
|
1592
1625
|
* @memberof V1ObservationStatus
|
|
1593
1626
|
*/
|
|
1594
|
-
'dec'
|
|
1627
|
+
'dec'?: number;
|
|
1595
1628
|
/**
|
|
1596
|
-
*
|
|
1629
|
+
* Time the observation was executed at, null if the observation has not happened yet
|
|
1597
1630
|
* @type {string}
|
|
1598
1631
|
* @memberof V1ObservationStatus
|
|
1599
1632
|
*/
|
|
1600
|
-
'observationTime'
|
|
1633
|
+
'observationTime'?: string;
|
|
1601
1634
|
/**
|
|
1602
|
-
* TLE line 1 of when the observation was tasked
|
|
1635
|
+
* TLE line 1 of when the observation was tasked, null if the observation has not happened yet
|
|
1603
1636
|
* @type {string}
|
|
1604
1637
|
* @memberof V1ObservationStatus
|
|
1605
1638
|
*/
|
|
1606
|
-
'tleLine1'
|
|
1639
|
+
'tleLine1'?: string;
|
|
1607
1640
|
/**
|
|
1608
|
-
* TLE line 2 of when the observation was tasked
|
|
1641
|
+
* TLE line 2 of when the observation was tasked, null if the observation has not happened yet
|
|
1609
1642
|
* @type {string}
|
|
1610
1643
|
* @memberof V1ObservationStatus
|
|
1611
1644
|
*/
|
|
1612
|
-
'tleLine2'
|
|
1645
|
+
'tleLine2'?: string;
|
|
1613
1646
|
/**
|
|
1614
|
-
*
|
|
1647
|
+
* TLE Epoch of when the observation was tasked, null if the observation has not happened yet
|
|
1615
1648
|
* @type {string}
|
|
1616
1649
|
* @memberof V1ObservationStatus
|
|
1617
1650
|
*/
|
|
1618
|
-
'tleEpoch'
|
|
1651
|
+
'tleEpoch'?: string;
|
|
1619
1652
|
/**
|
|
1620
1653
|
*
|
|
1621
1654
|
* @type {string}
|
|
@@ -1645,7 +1678,25 @@ export interface V1ObservationStatus {
|
|
|
1645
1678
|
* @type {string}
|
|
1646
1679
|
* @memberof V1ObservationStatus
|
|
1647
1680
|
*/
|
|
1681
|
+
'directTaskId'?: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* The time the observation was completed in our system, null if the observation has not happened yet
|
|
1684
|
+
* @type {string}
|
|
1685
|
+
* @memberof V1ObservationStatus
|
|
1686
|
+
*/
|
|
1648
1687
|
'completedAt'?: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* The time the instruction was scheduled for, if applicable (direct tasked instructions only)
|
|
1690
|
+
* @type {string}
|
|
1691
|
+
* @memberof V1ObservationStatus
|
|
1692
|
+
*/
|
|
1693
|
+
'scheduledAt'?: string;
|
|
1694
|
+
/**
|
|
1695
|
+
* The time the instruction was valid until, if applicable (direct tasked instructions only)
|
|
1696
|
+
* @type {string}
|
|
1697
|
+
* @memberof V1ObservationStatus
|
|
1698
|
+
*/
|
|
1699
|
+
'validUntil'?: string;
|
|
1649
1700
|
/**
|
|
1650
1701
|
*
|
|
1651
1702
|
* @type {ObservationState}
|
|
@@ -3311,6 +3362,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3311
3362
|
options: localVarRequestOptions,
|
|
3312
3363
|
};
|
|
3313
3364
|
},
|
|
3365
|
+
/**
|
|
3366
|
+
* Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
|
|
3367
|
+
* @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
|
|
3368
|
+
* @param {*} [options] Override http request option.
|
|
3369
|
+
* @throws {RequiredError}
|
|
3370
|
+
*/
|
|
3371
|
+
v1CreateDirectTaskInstruction: async (v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3372
|
+
// verify required parameter 'v1CreateDirectTaskInstructionRequest' is not null or undefined
|
|
3373
|
+
assertParamExists('v1CreateDirectTaskInstruction', 'v1CreateDirectTaskInstructionRequest', v1CreateDirectTaskInstructionRequest)
|
|
3374
|
+
const localVarPath = `/v1/direct-task-instruction`;
|
|
3375
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3376
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3377
|
+
let baseOptions;
|
|
3378
|
+
if (configuration) {
|
|
3379
|
+
baseOptions = configuration.baseOptions;
|
|
3380
|
+
}
|
|
3381
|
+
|
|
3382
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3383
|
+
const localVarHeaderParameter = {} as any;
|
|
3384
|
+
const localVarQueryParameter = {} as any;
|
|
3385
|
+
|
|
3386
|
+
// authentication Roles required
|
|
3387
|
+
|
|
3388
|
+
// authentication BearerToken required
|
|
3389
|
+
// http bearer authentication required
|
|
3390
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3391
|
+
|
|
3392
|
+
|
|
3393
|
+
|
|
3394
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3395
|
+
|
|
3396
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3397
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3398
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3399
|
+
localVarRequestOptions.data = serializeDataIfNeeded(v1CreateDirectTaskInstructionRequest, localVarRequestOptions, configuration)
|
|
3400
|
+
|
|
3401
|
+
return {
|
|
3402
|
+
url: toPathString(localVarUrlObj),
|
|
3403
|
+
options: localVarRequestOptions,
|
|
3404
|
+
};
|
|
3405
|
+
},
|
|
3314
3406
|
/**
|
|
3315
3407
|
* Create an image set.
|
|
3316
3408
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -3673,6 +3765,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3673
3765
|
|
|
3674
3766
|
|
|
3675
3767
|
|
|
3768
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3769
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3770
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3771
|
+
|
|
3772
|
+
return {
|
|
3773
|
+
url: toPathString(localVarUrlObj),
|
|
3774
|
+
options: localVarRequestOptions,
|
|
3775
|
+
};
|
|
3776
|
+
},
|
|
3777
|
+
/**
|
|
3778
|
+
* Delete a direct task instruction.
|
|
3779
|
+
* @param {string} id
|
|
3780
|
+
* @param {*} [options] Override http request option.
|
|
3781
|
+
* @throws {RequiredError}
|
|
3782
|
+
*/
|
|
3783
|
+
v1DeleteDirectTaskInstruction: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3784
|
+
// verify required parameter 'id' is not null or undefined
|
|
3785
|
+
assertParamExists('v1DeleteDirectTaskInstruction', 'id', id)
|
|
3786
|
+
const localVarPath = `/v1/direct-task-instruction`;
|
|
3787
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3788
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3789
|
+
let baseOptions;
|
|
3790
|
+
if (configuration) {
|
|
3791
|
+
baseOptions = configuration.baseOptions;
|
|
3792
|
+
}
|
|
3793
|
+
|
|
3794
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
3795
|
+
const localVarHeaderParameter = {} as any;
|
|
3796
|
+
const localVarQueryParameter = {} as any;
|
|
3797
|
+
|
|
3798
|
+
// authentication Roles required
|
|
3799
|
+
|
|
3800
|
+
// authentication BearerToken required
|
|
3801
|
+
// http bearer authentication required
|
|
3802
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3803
|
+
|
|
3804
|
+
if (id !== undefined) {
|
|
3805
|
+
localVarQueryParameter['id'] = id;
|
|
3806
|
+
}
|
|
3807
|
+
|
|
3808
|
+
|
|
3809
|
+
|
|
3676
3810
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3677
3811
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3678
3812
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -4368,17 +4502,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
4368
4502
|
};
|
|
4369
4503
|
},
|
|
4370
4504
|
/**
|
|
4371
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
4505
|
+
* 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.
|
|
4372
4506
|
* @param {string} [targetId]
|
|
4373
4507
|
* @param {string} [before]
|
|
4374
4508
|
* @param {string} [searchInstructionId]
|
|
4375
4509
|
* @param {string} [surveyInstructionId]
|
|
4376
4510
|
* @param {string} [resolvedImageInstructionId]
|
|
4511
|
+
* @param {string} [directTaskId]
|
|
4377
4512
|
* @param {string} [imageId]
|
|
4378
4513
|
* @param {*} [options] Override http request option.
|
|
4379
4514
|
* @throws {RequiredError}
|
|
4380
4515
|
*/
|
|
4381
|
-
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4516
|
+
v1GetObservationStatuses: async (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, directTaskId?: string, imageId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4382
4517
|
const localVarPath = `/v1/observation-statuses`;
|
|
4383
4518
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4384
4519
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -4419,6 +4554,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
4419
4554
|
localVarQueryParameter['resolvedImageInstructionId'] = resolvedImageInstructionId;
|
|
4420
4555
|
}
|
|
4421
4556
|
|
|
4557
|
+
if (directTaskId !== undefined) {
|
|
4558
|
+
localVarQueryParameter['directTaskId'] = directTaskId;
|
|
4559
|
+
}
|
|
4560
|
+
|
|
4422
4561
|
if (imageId !== undefined) {
|
|
4423
4562
|
localVarQueryParameter['imageId'] = imageId;
|
|
4424
4563
|
}
|
|
@@ -5530,6 +5669,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
5530
5669
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateBlackoutVolume(v1BlackoutVolumeRequest, options);
|
|
5531
5670
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5532
5671
|
},
|
|
5672
|
+
/**
|
|
5673
|
+
* Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
|
|
5674
|
+
* @param {V1CreateDirectTaskInstructionRequest} v1CreateDirectTaskInstructionRequest
|
|
5675
|
+
* @param {*} [options] Override http request option.
|
|
5676
|
+
* @throws {RequiredError}
|
|
5677
|
+
*/
|
|
5678
|
+
async v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>> {
|
|
5679
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest, options);
|
|
5680
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5681
|
+
},
|
|
5533
5682
|
/**
|
|
5534
5683
|
* Create an image set.
|
|
5535
5684
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -5621,6 +5770,16 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
5621
5770
|
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteBlackoutVolume(id, options);
|
|
5622
5771
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5623
5772
|
},
|
|
5773
|
+
/**
|
|
5774
|
+
* Delete a direct task instruction.
|
|
5775
|
+
* @param {string} id
|
|
5776
|
+
* @param {*} [options] Override http request option.
|
|
5777
|
+
* @throws {RequiredError}
|
|
5778
|
+
*/
|
|
5779
|
+
async v1DeleteDirectTaskInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>> {
|
|
5780
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteDirectTaskInstruction(id, options);
|
|
5781
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5782
|
+
},
|
|
5624
5783
|
/**
|
|
5625
5784
|
* Delete an image set.
|
|
5626
5785
|
* @param {string} id
|
|
@@ -5785,18 +5944,19 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
5785
5944
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5786
5945
|
},
|
|
5787
5946
|
/**
|
|
5788
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
5947
|
+
* 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.
|
|
5789
5948
|
* @param {string} [targetId]
|
|
5790
5949
|
* @param {string} [before]
|
|
5791
5950
|
* @param {string} [searchInstructionId]
|
|
5792
5951
|
* @param {string} [surveyInstructionId]
|
|
5793
5952
|
* @param {string} [resolvedImageInstructionId]
|
|
5953
|
+
* @param {string} [directTaskId]
|
|
5794
5954
|
* @param {string} [imageId]
|
|
5795
5955
|
* @param {*} [options] Override http request option.
|
|
5796
5956
|
* @throws {RequiredError}
|
|
5797
5957
|
*/
|
|
5798
|
-
async v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>> {
|
|
5799
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, imageId, options);
|
|
5958
|
+
async 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>>> {
|
|
5959
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetObservationStatuses(targetId, before, searchInstructionId, surveyInstructionId, resolvedImageInstructionId, directTaskId, imageId, options);
|
|
5800
5960
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5801
5961
|
},
|
|
5802
5962
|
/**
|
|
@@ -6080,6 +6240,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
6080
6240
|
v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
6081
6241
|
return localVarFp.v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(axios, basePath));
|
|
6082
6242
|
},
|
|
6243
|
+
/**
|
|
6244
|
+
* Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
|
|
6245
|
+
* @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
|
|
6246
|
+
* @param {*} [options] Override http request option.
|
|
6247
|
+
* @throws {RequiredError}
|
|
6248
|
+
*/
|
|
6249
|
+
v1CreateDirectTaskInstruction(requestParameters: DefaultApiV1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate> {
|
|
6250
|
+
return localVarFp.v1CreateDirectTaskInstruction(requestParameters.v1CreateDirectTaskInstructionRequest, options).then((request) => request(axios, basePath));
|
|
6251
|
+
},
|
|
6083
6252
|
/**
|
|
6084
6253
|
* Create an image set.
|
|
6085
6254
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -6162,6 +6331,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
6162
6331
|
v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulDelete> {
|
|
6163
6332
|
return localVarFp.v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
6164
6333
|
},
|
|
6334
|
+
/**
|
|
6335
|
+
* Delete a direct task instruction.
|
|
6336
|
+
* @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
|
|
6337
|
+
* @param {*} [options] Override http request option.
|
|
6338
|
+
* @throws {RequiredError}
|
|
6339
|
+
*/
|
|
6340
|
+
v1DeleteDirectTaskInstruction(requestParameters: DefaultApiV1DeleteDirectTaskInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess> {
|
|
6341
|
+
return localVarFp.v1DeleteDirectTaskInstruction(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
6342
|
+
},
|
|
6165
6343
|
/**
|
|
6166
6344
|
* Delete an image set.
|
|
6167
6345
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -6306,13 +6484,13 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
6306
6484
|
return localVarFp.v1GetObservationSequenceResults(requestParameters.targetId, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
6307
6485
|
},
|
|
6308
6486
|
/**
|
|
6309
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
6487
|
+
* 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.
|
|
6310
6488
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
6311
6489
|
* @param {*} [options] Override http request option.
|
|
6312
6490
|
* @throws {RequiredError}
|
|
6313
6491
|
*/
|
|
6314
6492
|
v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>> {
|
|
6315
|
-
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
6493
|
+
return localVarFp.v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.directTaskId, requestParameters.imageId, options).then((request) => request(axios, basePath));
|
|
6316
6494
|
},
|
|
6317
6495
|
/**
|
|
6318
6496
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
@@ -6559,6 +6737,20 @@ export interface DefaultApiV1CreateBlackoutVolumeRequest {
|
|
|
6559
6737
|
readonly v1BlackoutVolumeRequest: V1BlackoutVolumeRequest
|
|
6560
6738
|
}
|
|
6561
6739
|
|
|
6740
|
+
/**
|
|
6741
|
+
* Request parameters for v1CreateDirectTaskInstruction operation in DefaultApi.
|
|
6742
|
+
* @export
|
|
6743
|
+
* @interface DefaultApiV1CreateDirectTaskInstructionRequest
|
|
6744
|
+
*/
|
|
6745
|
+
export interface DefaultApiV1CreateDirectTaskInstructionRequest {
|
|
6746
|
+
/**
|
|
6747
|
+
*
|
|
6748
|
+
* @type {V1CreateDirectTaskInstructionRequest}
|
|
6749
|
+
* @memberof DefaultApiV1CreateDirectTaskInstruction
|
|
6750
|
+
*/
|
|
6751
|
+
readonly v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest
|
|
6752
|
+
}
|
|
6753
|
+
|
|
6562
6754
|
/**
|
|
6563
6755
|
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
6564
6756
|
* @export
|
|
@@ -6685,6 +6877,20 @@ export interface DefaultApiV1DeleteBlackoutVolumeRequest {
|
|
|
6685
6877
|
readonly id: string
|
|
6686
6878
|
}
|
|
6687
6879
|
|
|
6880
|
+
/**
|
|
6881
|
+
* Request parameters for v1DeleteDirectTaskInstruction operation in DefaultApi.
|
|
6882
|
+
* @export
|
|
6883
|
+
* @interface DefaultApiV1DeleteDirectTaskInstructionRequest
|
|
6884
|
+
*/
|
|
6885
|
+
export interface DefaultApiV1DeleteDirectTaskInstructionRequest {
|
|
6886
|
+
/**
|
|
6887
|
+
*
|
|
6888
|
+
* @type {string}
|
|
6889
|
+
* @memberof DefaultApiV1DeleteDirectTaskInstruction
|
|
6890
|
+
*/
|
|
6891
|
+
readonly id: string
|
|
6892
|
+
}
|
|
6893
|
+
|
|
6688
6894
|
/**
|
|
6689
6895
|
* Request parameters for v1DeleteImageSet operation in DefaultApi.
|
|
6690
6896
|
* @export
|
|
@@ -6964,6 +7170,13 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
6964
7170
|
*/
|
|
6965
7171
|
readonly resolvedImageInstructionId?: string
|
|
6966
7172
|
|
|
7173
|
+
/**
|
|
7174
|
+
*
|
|
7175
|
+
* @type {string}
|
|
7176
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
7177
|
+
*/
|
|
7178
|
+
readonly directTaskId?: string
|
|
7179
|
+
|
|
6967
7180
|
/**
|
|
6968
7181
|
*
|
|
6969
7182
|
* @type {string}
|
|
@@ -7408,6 +7621,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
7408
7621
|
return DefaultApiFp(this.configuration).v1CreateBlackoutVolume(requestParameters.v1BlackoutVolumeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7409
7622
|
}
|
|
7410
7623
|
|
|
7624
|
+
/**
|
|
7625
|
+
* Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
|
|
7626
|
+
* @param {DefaultApiV1CreateDirectTaskInstructionRequest} requestParameters Request parameters.
|
|
7627
|
+
* @param {*} [options] Override http request option.
|
|
7628
|
+
* @throws {RequiredError}
|
|
7629
|
+
* @memberof DefaultApi
|
|
7630
|
+
*/
|
|
7631
|
+
public v1CreateDirectTaskInstruction(requestParameters: DefaultApiV1CreateDirectTaskInstructionRequest, options?: AxiosRequestConfig) {
|
|
7632
|
+
return DefaultApiFp(this.configuration).v1CreateDirectTaskInstruction(requestParameters.v1CreateDirectTaskInstructionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7633
|
+
}
|
|
7634
|
+
|
|
7411
7635
|
/**
|
|
7412
7636
|
* Create an image set.
|
|
7413
7637
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -7508,6 +7732,17 @@ export class DefaultApi extends BaseAPI {
|
|
|
7508
7732
|
return DefaultApiFp(this.configuration).v1DeleteBlackoutVolume(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
7509
7733
|
}
|
|
7510
7734
|
|
|
7735
|
+
/**
|
|
7736
|
+
* Delete a direct task instruction.
|
|
7737
|
+
* @param {DefaultApiV1DeleteDirectTaskInstructionRequest} requestParameters Request parameters.
|
|
7738
|
+
* @param {*} [options] Override http request option.
|
|
7739
|
+
* @throws {RequiredError}
|
|
7740
|
+
* @memberof DefaultApi
|
|
7741
|
+
*/
|
|
7742
|
+
public v1DeleteDirectTaskInstruction(requestParameters: DefaultApiV1DeleteDirectTaskInstructionRequest, options?: AxiosRequestConfig) {
|
|
7743
|
+
return DefaultApiFp(this.configuration).v1DeleteDirectTaskInstruction(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
7744
|
+
}
|
|
7745
|
+
|
|
7511
7746
|
/**
|
|
7512
7747
|
* Delete an image set.
|
|
7513
7748
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -7684,14 +7919,14 @@ export class DefaultApi extends BaseAPI {
|
|
|
7684
7919
|
}
|
|
7685
7920
|
|
|
7686
7921
|
/**
|
|
7687
|
-
* Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`,
|
|
7922
|
+
* 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.
|
|
7688
7923
|
* @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
|
|
7689
7924
|
* @param {*} [options] Override http request option.
|
|
7690
7925
|
* @throws {RequiredError}
|
|
7691
7926
|
* @memberof DefaultApi
|
|
7692
7927
|
*/
|
|
7693
7928
|
public v1GetObservationStatuses(requestParameters: DefaultApiV1GetObservationStatusesRequest = {}, options?: AxiosRequestConfig) {
|
|
7694
|
-
return DefaultApiFp(this.configuration).v1GetObservationStatuses(requestParameters.targetId, requestParameters.before, requestParameters.searchInstructionId, requestParameters.surveyInstructionId, requestParameters.resolvedImageInstructionId, requestParameters.imageId, options).then((request) => request(this.axios, this.basePath));
|
|
7929
|
+
return 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));
|
|
7695
7930
|
}
|
|
7696
7931
|
|
|
7697
7932
|
/**
|
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 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8639
|
|
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 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8639
|
|
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 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.3.
|
|
7
|
+
* The version of the OpenAPI document: 1.3.8639
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|