@ourskyai/sda-api 1.4.133 → 1.4.188
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/.openapi-generator/FILES +6 -0
- package/README.md +10 -2
- package/api.ts +305 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +175 -1
- package/dist/api.js +188 -2
- 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 +175 -1
- package/dist/esm/api.js +187 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DefaultApi.md +116 -0
- package/docs/LightcurveDataType.md +11 -0
- package/docs/PeriodDetectionStatus.md +17 -0
- package/docs/PeriodicityAlgorithm.md +15 -0
- package/docs/V1GetLightcurvesResponse.md +22 -0
- package/docs/V1Lightcurve.md +50 -0
- package/docs/V1LightcurveDataPoint.md +28 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -12,6 +12,7 @@ docs/EmptySuccess.md
|
|
|
12
12
|
docs/FilterType.md
|
|
13
13
|
docs/FitsHeader.md
|
|
14
14
|
docs/ImageSetType.md
|
|
15
|
+
docs/LightcurveDataType.md
|
|
15
16
|
docs/Location.md
|
|
16
17
|
docs/MountGeometry.md
|
|
17
18
|
docs/MountType.md
|
|
@@ -20,6 +21,8 @@ docs/ObservationQuality.md
|
|
|
20
21
|
docs/ObservationResult.md
|
|
21
22
|
docs/ObservationState.md
|
|
22
23
|
docs/OrbitType.md
|
|
24
|
+
docs/PeriodDetectionStatus.md
|
|
25
|
+
docs/PeriodicityAlgorithm.md
|
|
23
26
|
docs/SatelliteTargetTrackingStatus.md
|
|
24
27
|
docs/SearchCompletedReason.md
|
|
25
28
|
docs/ShutterType.md
|
|
@@ -39,6 +42,7 @@ docs/V1CreateSearchInstructionRequest.md
|
|
|
39
42
|
docs/V1CreateSurveyInstructionRequest.md
|
|
40
43
|
docs/V1CreateWebhookConfigurationRequest.md
|
|
41
44
|
docs/V1CreateWebhookTestRequest.md
|
|
45
|
+
docs/V1GetLightcurvesResponse.md
|
|
42
46
|
docs/V1GetSatelliteTargetsResponse.md
|
|
43
47
|
docs/V1GroundStationParticipant.md
|
|
44
48
|
docs/V1HFRStar.md
|
|
@@ -47,6 +51,8 @@ docs/V1ImageMetadata.md
|
|
|
47
51
|
docs/V1ImageRejectionReason.md
|
|
48
52
|
docs/V1ImageSet.md
|
|
49
53
|
docs/V1ImageSetImage.md
|
|
54
|
+
docs/V1Lightcurve.md
|
|
55
|
+
docs/V1LightcurveDataPoint.md
|
|
50
56
|
docs/V1MatchedStar.md
|
|
51
57
|
docs/V1NodeCalibrationResult.md
|
|
52
58
|
docs/V1ObservationFeature.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @ourskyai/sda-api@1.4.
|
|
1
|
+
## @ourskyai/sda-api@1.4.188
|
|
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.4.
|
|
39
|
+
npm install @ourskyai/sda-api@1.4.188 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -84,6 +84,8 @@ Class | Method | HTTP request | Description
|
|
|
84
84
|
*DefaultApi* | [**v1GetObservationStatuses**](docs/DefaultApi.md#v1getobservationstatuses) | **GET** /v1/observation-statuses |
|
|
85
85
|
*DefaultApi* | [**v1GetOrganizationSatellitePotentials**](docs/DefaultApi.md#v1getorganizationsatellitepotentials) | **GET** /v1/organization-target-potentials |
|
|
86
86
|
*DefaultApi* | [**v1GetOrganizationTarget**](docs/DefaultApi.md#v1getorganizationtarget) | **GET** /v1/organization-target |
|
|
87
|
+
*DefaultApi* | [**v1GetOrganizationTargetLightcurve**](docs/DefaultApi.md#v1getorganizationtargetlightcurve) | **GET** /v1/organization-target/lightcurve |
|
|
88
|
+
*DefaultApi* | [**v1GetOrganizationTargetLightcurves**](docs/DefaultApi.md#v1getorganizationtargetlightcurves) | **GET** /v1/organization-target/lightcurves |
|
|
87
89
|
*DefaultApi* | [**v1GetOrganizationTargets**](docs/DefaultApi.md#v1getorganizationtargets) | **GET** /v1/organization-targets |
|
|
88
90
|
*DefaultApi* | [**v1GetResolvedImageMetadata**](docs/DefaultApi.md#v1getresolvedimagemetadata) | **GET** /v1/resolved-image-metadata |
|
|
89
91
|
*DefaultApi* | [**v1GetResolvedImageObservations**](docs/DefaultApi.md#v1getresolvedimageobservations) | **GET** /v1/resolved-image-observations |
|
|
@@ -119,6 +121,7 @@ Class | Method | HTTP request | Description
|
|
|
119
121
|
- [FilterType](docs/FilterType.md)
|
|
120
122
|
- [FitsHeader](docs/FitsHeader.md)
|
|
121
123
|
- [ImageSetType](docs/ImageSetType.md)
|
|
124
|
+
- [LightcurveDataType](docs/LightcurveDataType.md)
|
|
122
125
|
- [Location](docs/Location.md)
|
|
123
126
|
- [MountGeometry](docs/MountGeometry.md)
|
|
124
127
|
- [MountType](docs/MountType.md)
|
|
@@ -127,6 +130,8 @@ Class | Method | HTTP request | Description
|
|
|
127
130
|
- [ObservationResult](docs/ObservationResult.md)
|
|
128
131
|
- [ObservationState](docs/ObservationState.md)
|
|
129
132
|
- [OrbitType](docs/OrbitType.md)
|
|
133
|
+
- [PeriodDetectionStatus](docs/PeriodDetectionStatus.md)
|
|
134
|
+
- [PeriodicityAlgorithm](docs/PeriodicityAlgorithm.md)
|
|
130
135
|
- [SatelliteTargetTrackingStatus](docs/SatelliteTargetTrackingStatus.md)
|
|
131
136
|
- [SearchCompletedReason](docs/SearchCompletedReason.md)
|
|
132
137
|
- [ShutterType](docs/ShutterType.md)
|
|
@@ -146,6 +151,7 @@ Class | Method | HTTP request | Description
|
|
|
146
151
|
- [V1CreateSurveyInstructionRequest](docs/V1CreateSurveyInstructionRequest.md)
|
|
147
152
|
- [V1CreateWebhookConfigurationRequest](docs/V1CreateWebhookConfigurationRequest.md)
|
|
148
153
|
- [V1CreateWebhookTestRequest](docs/V1CreateWebhookTestRequest.md)
|
|
154
|
+
- [V1GetLightcurvesResponse](docs/V1GetLightcurvesResponse.md)
|
|
149
155
|
- [V1GetSatelliteTargetsResponse](docs/V1GetSatelliteTargetsResponse.md)
|
|
150
156
|
- [V1GroundStationParticipant](docs/V1GroundStationParticipant.md)
|
|
151
157
|
- [V1HFRStar](docs/V1HFRStar.md)
|
|
@@ -154,6 +160,8 @@ Class | Method | HTTP request | Description
|
|
|
154
160
|
- [V1ImageRejectionReason](docs/V1ImageRejectionReason.md)
|
|
155
161
|
- [V1ImageSet](docs/V1ImageSet.md)
|
|
156
162
|
- [V1ImageSetImage](docs/V1ImageSetImage.md)
|
|
163
|
+
- [V1Lightcurve](docs/V1Lightcurve.md)
|
|
164
|
+
- [V1LightcurveDataPoint](docs/V1LightcurveDataPoint.md)
|
|
157
165
|
- [V1MatchedStar](docs/V1MatchedStar.md)
|
|
158
166
|
- [V1NodeCalibrationResult](docs/V1NodeCalibrationResult.md)
|
|
159
167
|
- [V1ObservationFeature](docs/V1ObservationFeature.md)
|
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.4.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.188
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -109,6 +109,18 @@ export const ImageSetType = {
|
|
|
109
109
|
export type ImageSetType = typeof ImageSetType[keyof typeof ImageSetType];
|
|
110
110
|
|
|
111
111
|
|
|
112
|
+
/**
|
|
113
|
+
* RAW for time-series photometry data with timestamps, PHASE_FOLDED for phase-folded data by rotation period
|
|
114
|
+
*/
|
|
115
|
+
|
|
116
|
+
export const LightcurveDataType = {
|
|
117
|
+
RAW: 'RAW',
|
|
118
|
+
PHASE_FOLDED: 'PHASE_FOLDED'
|
|
119
|
+
} as const;
|
|
120
|
+
|
|
121
|
+
export type LightcurveDataType = typeof LightcurveDataType[keyof typeof LightcurveDataType];
|
|
122
|
+
|
|
123
|
+
|
|
112
124
|
/**
|
|
113
125
|
* Location
|
|
114
126
|
*/
|
|
@@ -253,6 +265,35 @@ export const OrbitType = {
|
|
|
253
265
|
export type OrbitType = typeof OrbitType[keyof typeof OrbitType];
|
|
254
266
|
|
|
255
267
|
|
|
268
|
+
/**
|
|
269
|
+
* Outcome of period detection attempt
|
|
270
|
+
*/
|
|
271
|
+
|
|
272
|
+
export const PeriodDetectionStatus = {
|
|
273
|
+
NOT_ATTEMPTED: 'NOT_ATTEMPTED',
|
|
274
|
+
INSUFFICIENT_DATA: 'INSUFFICIENT_DATA',
|
|
275
|
+
SUCCESS: 'SUCCESS',
|
|
276
|
+
LOW_CONFIDENCE: 'LOW_CONFIDENCE',
|
|
277
|
+
AMBIGUOUS: 'AMBIGUOUS'
|
|
278
|
+
} as const;
|
|
279
|
+
|
|
280
|
+
export type PeriodDetectionStatus = typeof PeriodDetectionStatus[keyof typeof PeriodDetectionStatus];
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Algorithm used to detect rotation period. NONE if period detection was not attempted.
|
|
285
|
+
*/
|
|
286
|
+
|
|
287
|
+
export const PeriodicityAlgorithm = {
|
|
288
|
+
NONE: 'NONE',
|
|
289
|
+
STRING_LENGTH: 'STRING_LENGTH',
|
|
290
|
+
PHASE_DISPERSION_MINIMIZATION: 'PHASE_DISPERSION_MINIMIZATION',
|
|
291
|
+
BAYESIAN_PERIOD_SEARCH: 'BAYESIAN_PERIOD_SEARCH'
|
|
292
|
+
} as const;
|
|
293
|
+
|
|
294
|
+
export type PeriodicityAlgorithm = typeof PeriodicityAlgorithm[keyof typeof PeriodicityAlgorithm];
|
|
295
|
+
|
|
296
|
+
|
|
256
297
|
|
|
257
298
|
export const SatelliteTargetTrackingStatus = {
|
|
258
299
|
ACTIVE: 'ACTIVE',
|
|
@@ -454,6 +495,10 @@ export interface V1CreateWebhookConfigurationRequest {
|
|
|
454
495
|
export interface V1CreateWebhookTestRequest {
|
|
455
496
|
'events': Array<WebhookEvent>;
|
|
456
497
|
}
|
|
498
|
+
export interface V1GetLightcurvesResponse {
|
|
499
|
+
'lightcurves': Array<V1Lightcurve>;
|
|
500
|
+
'total': number;
|
|
501
|
+
}
|
|
457
502
|
export interface V1GetSatelliteTargetsResponse {
|
|
458
503
|
'targets': Array<V1SatelliteTarget>;
|
|
459
504
|
}
|
|
@@ -613,6 +658,69 @@ export interface V1ImageSetImage {
|
|
|
613
658
|
}
|
|
614
659
|
|
|
615
660
|
|
|
661
|
+
export interface V1Lightcurve {
|
|
662
|
+
'id': string;
|
|
663
|
+
'targetId': string;
|
|
664
|
+
'createdAt': string;
|
|
665
|
+
'dataSpanStart': string;
|
|
666
|
+
'dataSpanEnd': string;
|
|
667
|
+
'dataType': LightcurveDataType;
|
|
668
|
+
/**
|
|
669
|
+
* For phase-folded lightcurves, references the source raw lightcurve
|
|
670
|
+
*/
|
|
671
|
+
'rawLightcurveId'?: string | null;
|
|
672
|
+
/**
|
|
673
|
+
* Total number of points in the raw lightcurve
|
|
674
|
+
*/
|
|
675
|
+
'totalPointCount': number;
|
|
676
|
+
'periodDetectionStatus': PeriodDetectionStatus;
|
|
677
|
+
'periodicityAlgorithm'?: PeriodicityAlgorithm;
|
|
678
|
+
/**
|
|
679
|
+
* Detected rotation period in seconds (null if not periodic)
|
|
680
|
+
*/
|
|
681
|
+
'periodSeconds'?: number | null;
|
|
682
|
+
/**
|
|
683
|
+
* Confidence score 0-1 for the detected period
|
|
684
|
+
*/
|
|
685
|
+
'periodConfidence'?: number | null;
|
|
686
|
+
/**
|
|
687
|
+
* Minimum period searched
|
|
688
|
+
*/
|
|
689
|
+
'periodSearchMinSeconds'?: number | null;
|
|
690
|
+
/**
|
|
691
|
+
* Maximum period searched
|
|
692
|
+
*/
|
|
693
|
+
'periodSearchMaxSeconds'?: number | null;
|
|
694
|
+
/**
|
|
695
|
+
* Number of points that passed Nyquist filtering for the best period
|
|
696
|
+
*/
|
|
697
|
+
'validPointCount'?: number | null;
|
|
698
|
+
/**
|
|
699
|
+
* Photometry measurements
|
|
700
|
+
*/
|
|
701
|
+
'points': Array<V1LightcurveDataPoint>;
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
export interface V1LightcurveDataPoint {
|
|
706
|
+
'timestamp': string;
|
|
707
|
+
/**
|
|
708
|
+
* Phase within the rotation period (0.0-1.0). Only present for PHASE_FOLDED data.
|
|
709
|
+
*/
|
|
710
|
+
'fractionalPeriod'?: number | null;
|
|
711
|
+
/**
|
|
712
|
+
* Magnitude normalized to standard range (1000 km) and solar phase angle (90 degrees)
|
|
713
|
+
*/
|
|
714
|
+
'standardMagnitude': number;
|
|
715
|
+
/**
|
|
716
|
+
* Observed apparent magnitude
|
|
717
|
+
*/
|
|
718
|
+
'rawMagnitude': number;
|
|
719
|
+
/**
|
|
720
|
+
* Sun-satellite-observer angle in radians
|
|
721
|
+
*/
|
|
722
|
+
'solarPhaseAngleRadians': number;
|
|
723
|
+
}
|
|
616
724
|
/**
|
|
617
725
|
* Extracted stars that matched during plate solving
|
|
618
726
|
*/
|
|
@@ -3071,6 +3179,114 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3071
3179
|
options: localVarRequestOptions,
|
|
3072
3180
|
};
|
|
3073
3181
|
},
|
|
3182
|
+
/**
|
|
3183
|
+
* Get the latest lightcurve for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
3184
|
+
* @param {string} organizationTargetId
|
|
3185
|
+
* @param {*} [options] Override http request option.
|
|
3186
|
+
* @throws {RequiredError}
|
|
3187
|
+
*/
|
|
3188
|
+
v1GetOrganizationTargetLightcurve: async (organizationTargetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3189
|
+
// verify required parameter 'organizationTargetId' is not null or undefined
|
|
3190
|
+
assertParamExists('v1GetOrganizationTargetLightcurve', 'organizationTargetId', organizationTargetId)
|
|
3191
|
+
const localVarPath = `/v1/organization-target/lightcurve`;
|
|
3192
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3193
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3194
|
+
let baseOptions;
|
|
3195
|
+
if (configuration) {
|
|
3196
|
+
baseOptions = configuration.baseOptions;
|
|
3197
|
+
}
|
|
3198
|
+
|
|
3199
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3200
|
+
const localVarHeaderParameter = {} as any;
|
|
3201
|
+
const localVarQueryParameter = {} as any;
|
|
3202
|
+
|
|
3203
|
+
// authentication Roles required
|
|
3204
|
+
|
|
3205
|
+
// authentication BearerToken required
|
|
3206
|
+
// http bearer authentication required
|
|
3207
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3208
|
+
|
|
3209
|
+
if (organizationTargetId !== undefined) {
|
|
3210
|
+
localVarQueryParameter['organizationTargetId'] = organizationTargetId;
|
|
3211
|
+
}
|
|
3212
|
+
|
|
3213
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3214
|
+
|
|
3215
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3216
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3217
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3218
|
+
|
|
3219
|
+
return {
|
|
3220
|
+
url: toPathString(localVarUrlObj),
|
|
3221
|
+
options: localVarRequestOptions,
|
|
3222
|
+
};
|
|
3223
|
+
},
|
|
3224
|
+
/**
|
|
3225
|
+
* Get lightcurves for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
3226
|
+
* @param {string} organizationTargetId
|
|
3227
|
+
* @param {string} [startDate]
|
|
3228
|
+
* @param {string} [endDate]
|
|
3229
|
+
* @param {number} [offset]
|
|
3230
|
+
* @param {number} [limit]
|
|
3231
|
+
* @param {*} [options] Override http request option.
|
|
3232
|
+
* @throws {RequiredError}
|
|
3233
|
+
*/
|
|
3234
|
+
v1GetOrganizationTargetLightcurves: async (organizationTargetId: string, startDate?: string, endDate?: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3235
|
+
// verify required parameter 'organizationTargetId' is not null or undefined
|
|
3236
|
+
assertParamExists('v1GetOrganizationTargetLightcurves', 'organizationTargetId', organizationTargetId)
|
|
3237
|
+
const localVarPath = `/v1/organization-target/lightcurves`;
|
|
3238
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3239
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3240
|
+
let baseOptions;
|
|
3241
|
+
if (configuration) {
|
|
3242
|
+
baseOptions = configuration.baseOptions;
|
|
3243
|
+
}
|
|
3244
|
+
|
|
3245
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3246
|
+
const localVarHeaderParameter = {} as any;
|
|
3247
|
+
const localVarQueryParameter = {} as any;
|
|
3248
|
+
|
|
3249
|
+
// authentication Roles required
|
|
3250
|
+
|
|
3251
|
+
// authentication BearerToken required
|
|
3252
|
+
// http bearer authentication required
|
|
3253
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3254
|
+
|
|
3255
|
+
if (organizationTargetId !== undefined) {
|
|
3256
|
+
localVarQueryParameter['organizationTargetId'] = organizationTargetId;
|
|
3257
|
+
}
|
|
3258
|
+
|
|
3259
|
+
if (startDate !== undefined) {
|
|
3260
|
+
localVarQueryParameter['startDate'] = (startDate as any instanceof Date) ?
|
|
3261
|
+
(startDate as any).toISOString() :
|
|
3262
|
+
startDate;
|
|
3263
|
+
}
|
|
3264
|
+
|
|
3265
|
+
if (endDate !== undefined) {
|
|
3266
|
+
localVarQueryParameter['endDate'] = (endDate as any instanceof Date) ?
|
|
3267
|
+
(endDate as any).toISOString() :
|
|
3268
|
+
endDate;
|
|
3269
|
+
}
|
|
3270
|
+
|
|
3271
|
+
if (offset !== undefined) {
|
|
3272
|
+
localVarQueryParameter['offset'] = offset;
|
|
3273
|
+
}
|
|
3274
|
+
|
|
3275
|
+
if (limit !== undefined) {
|
|
3276
|
+
localVarQueryParameter['limit'] = limit;
|
|
3277
|
+
}
|
|
3278
|
+
|
|
3279
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3280
|
+
|
|
3281
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3282
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3283
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3284
|
+
|
|
3285
|
+
return {
|
|
3286
|
+
url: toPathString(localVarUrlObj),
|
|
3287
|
+
options: localVarRequestOptions,
|
|
3288
|
+
};
|
|
3289
|
+
},
|
|
3074
3290
|
/**
|
|
3075
3291
|
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
3076
3292
|
* @param {*} [options] Override http request option.
|
|
@@ -4639,6 +4855,34 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
4639
4855
|
const localVarOperationServerBasePath = operationServerMap['DefaultApi.v1GetOrganizationTarget']?.[localVarOperationServerIndex]?.url;
|
|
4640
4856
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4641
4857
|
},
|
|
4858
|
+
/**
|
|
4859
|
+
* Get the latest lightcurve for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
4860
|
+
* @param {string} organizationTargetId
|
|
4861
|
+
* @param {*} [options] Override http request option.
|
|
4862
|
+
* @throws {RequiredError}
|
|
4863
|
+
*/
|
|
4864
|
+
async v1GetOrganizationTargetLightcurve(organizationTargetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1Lightcurve>> {
|
|
4865
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetOrganizationTargetLightcurve(organizationTargetId, options);
|
|
4866
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4867
|
+
const localVarOperationServerBasePath = operationServerMap['DefaultApi.v1GetOrganizationTargetLightcurve']?.[localVarOperationServerIndex]?.url;
|
|
4868
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4869
|
+
},
|
|
4870
|
+
/**
|
|
4871
|
+
* Get lightcurves for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
4872
|
+
* @param {string} organizationTargetId
|
|
4873
|
+
* @param {string} [startDate]
|
|
4874
|
+
* @param {string} [endDate]
|
|
4875
|
+
* @param {number} [offset]
|
|
4876
|
+
* @param {number} [limit]
|
|
4877
|
+
* @param {*} [options] Override http request option.
|
|
4878
|
+
* @throws {RequiredError}
|
|
4879
|
+
*/
|
|
4880
|
+
async v1GetOrganizationTargetLightcurves(organizationTargetId: string, startDate?: string, endDate?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetLightcurvesResponse>> {
|
|
4881
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetOrganizationTargetLightcurves(organizationTargetId, startDate, endDate, offset, limit, options);
|
|
4882
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4883
|
+
const localVarOperationServerBasePath = operationServerMap['DefaultApi.v1GetOrganizationTargetLightcurves']?.[localVarOperationServerIndex]?.url;
|
|
4884
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4885
|
+
},
|
|
4642
4886
|
/**
|
|
4643
4887
|
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
4644
4888
|
* @param {*} [options] Override http request option.
|
|
@@ -5272,6 +5516,24 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
5272
5516
|
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1OrganizationTarget> {
|
|
5273
5517
|
return localVarFp.v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(axios, basePath));
|
|
5274
5518
|
},
|
|
5519
|
+
/**
|
|
5520
|
+
* Get the latest lightcurve for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
5521
|
+
* @param {DefaultApiV1GetOrganizationTargetLightcurveRequest} requestParameters Request parameters.
|
|
5522
|
+
* @param {*} [options] Override http request option.
|
|
5523
|
+
* @throws {RequiredError}
|
|
5524
|
+
*/
|
|
5525
|
+
v1GetOrganizationTargetLightcurve(requestParameters: DefaultApiV1GetOrganizationTargetLightcurveRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1Lightcurve> {
|
|
5526
|
+
return localVarFp.v1GetOrganizationTargetLightcurve(requestParameters.organizationTargetId, options).then((request) => request(axios, basePath));
|
|
5527
|
+
},
|
|
5528
|
+
/**
|
|
5529
|
+
* Get lightcurves for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
5530
|
+
* @param {DefaultApiV1GetOrganizationTargetLightcurvesRequest} requestParameters Request parameters.
|
|
5531
|
+
* @param {*} [options] Override http request option.
|
|
5532
|
+
* @throws {RequiredError}
|
|
5533
|
+
*/
|
|
5534
|
+
v1GetOrganizationTargetLightcurves(requestParameters: DefaultApiV1GetOrganizationTargetLightcurvesRequest, options?: RawAxiosRequestConfig): AxiosPromise<V1GetLightcurvesResponse> {
|
|
5535
|
+
return localVarFp.v1GetOrganizationTargetLightcurves(requestParameters.organizationTargetId, requestParameters.startDate, requestParameters.endDate, requestParameters.offset, requestParameters.limit, options).then((request) => request(axios, basePath));
|
|
5536
|
+
},
|
|
5275
5537
|
/**
|
|
5276
5538
|
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
5277
5539
|
* @param {*} [options] Override http request option.
|
|
@@ -5775,6 +6037,28 @@ export interface DefaultApiV1GetOrganizationTargetRequest {
|
|
|
5775
6037
|
readonly organizationTargetId: string
|
|
5776
6038
|
}
|
|
5777
6039
|
|
|
6040
|
+
/**
|
|
6041
|
+
* Request parameters for v1GetOrganizationTargetLightcurve operation in DefaultApi.
|
|
6042
|
+
*/
|
|
6043
|
+
export interface DefaultApiV1GetOrganizationTargetLightcurveRequest {
|
|
6044
|
+
readonly organizationTargetId: string
|
|
6045
|
+
}
|
|
6046
|
+
|
|
6047
|
+
/**
|
|
6048
|
+
* Request parameters for v1GetOrganizationTargetLightcurves operation in DefaultApi.
|
|
6049
|
+
*/
|
|
6050
|
+
export interface DefaultApiV1GetOrganizationTargetLightcurvesRequest {
|
|
6051
|
+
readonly organizationTargetId: string
|
|
6052
|
+
|
|
6053
|
+
readonly startDate?: string
|
|
6054
|
+
|
|
6055
|
+
readonly endDate?: string
|
|
6056
|
+
|
|
6057
|
+
readonly offset?: number
|
|
6058
|
+
|
|
6059
|
+
readonly limit?: number
|
|
6060
|
+
}
|
|
6061
|
+
|
|
5778
6062
|
/**
|
|
5779
6063
|
* Request parameters for v1GetResolvedImageMetadata operation in DefaultApi.
|
|
5780
6064
|
*/
|
|
@@ -6339,6 +6623,26 @@ export class DefaultApi extends BaseAPI {
|
|
|
6339
6623
|
return DefaultApiFp(this.configuration).v1GetOrganizationTarget(requestParameters.organizationTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
6340
6624
|
}
|
|
6341
6625
|
|
|
6626
|
+
/**
|
|
6627
|
+
* Get the latest lightcurve for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
6628
|
+
* @param {DefaultApiV1GetOrganizationTargetLightcurveRequest} requestParameters Request parameters.
|
|
6629
|
+
* @param {*} [options] Override http request option.
|
|
6630
|
+
* @throws {RequiredError}
|
|
6631
|
+
*/
|
|
6632
|
+
public v1GetOrganizationTargetLightcurve(requestParameters: DefaultApiV1GetOrganizationTargetLightcurveRequest, options?: RawAxiosRequestConfig) {
|
|
6633
|
+
return DefaultApiFp(this.configuration).v1GetOrganizationTargetLightcurve(requestParameters.organizationTargetId, options).then((request) => request(this.axios, this.basePath));
|
|
6634
|
+
}
|
|
6635
|
+
|
|
6636
|
+
/**
|
|
6637
|
+
* Get lightcurves for a satellite target the organization is tracking. Requires the light curves product feature.
|
|
6638
|
+
* @param {DefaultApiV1GetOrganizationTargetLightcurvesRequest} requestParameters Request parameters.
|
|
6639
|
+
* @param {*} [options] Override http request option.
|
|
6640
|
+
* @throws {RequiredError}
|
|
6641
|
+
*/
|
|
6642
|
+
public v1GetOrganizationTargetLightcurves(requestParameters: DefaultApiV1GetOrganizationTargetLightcurvesRequest, options?: RawAxiosRequestConfig) {
|
|
6643
|
+
return DefaultApiFp(this.configuration).v1GetOrganizationTargetLightcurves(requestParameters.organizationTargetId, requestParameters.startDate, requestParameters.endDate, requestParameters.offset, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
|
|
6644
|
+
}
|
|
6645
|
+
|
|
6342
6646
|
/**
|
|
6343
6647
|
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
6344
6648
|
* @param {*} [options] Override http request option.
|
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.4.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.188
|
|
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.4.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.188
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* OurSky SDA
|
|
4
4
|
* 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.4.
|
|
6
|
+
* The version of the OpenAPI document: 1.4.188
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|