@ourskyai/astro-api 1.3.8815 → 1.4.123
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 +76 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +155 -4
- package/api.ts +869 -3218
- package/base.ts +14 -24
- package/common.ts +20 -44
- package/configuration.ts +37 -17
- package/dist/api.d.ts +449 -2852
- package/dist/api.js +640 -619
- package/dist/base.d.ts +11 -23
- package/dist/base.js +5 -18
- package/dist/common.d.ts +6 -37
- package/dist/common.js +18 -40
- package/dist/configuration.d.ts +30 -15
- package/dist/configuration.js +5 -3
- package/dist/esm/api.d.ts +449 -2852
- package/dist/esm/api.js +640 -619
- package/dist/esm/base.d.ts +11 -23
- package/dist/esm/base.js +4 -17
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +16 -39
- package/dist/esm/configuration.d.ts +30 -15
- package/dist/esm/configuration.js +5 -3
- 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/AssetFileType.md +18 -0
- package/docs/AssetType.md +16 -0
- package/docs/CalibrationMasterType.md +12 -0
- package/docs/DailyWeatherCity.md +22 -0
- package/docs/DailyWeatherForecastItem.md +40 -0
- package/docs/DailyWeatherForecastItemTemp.md +26 -0
- package/docs/DailyWeatherForecastItemWeatherInner.md +26 -0
- package/docs/DailyWeatherForecastListResponse.md +22 -0
- package/docs/DefaultApi.md +2560 -0
- package/docs/EmptySuccess.md +20 -0
- package/docs/FilterType.md +60 -0
- package/docs/FitsHeader.md +22 -0
- package/docs/ImageSetType.md +24 -0
- package/docs/IntegrationTime.md +27 -0
- package/docs/Location.md +25 -0
- package/docs/MountGeometry.md +10 -0
- package/docs/MountType.md +10 -0
- package/docs/NodeState.md +20 -0
- package/docs/OpticalTubeType.md +16 -0
- package/docs/ShutterType.md +10 -0
- package/docs/SuccessfulCreate.md +20 -0
- package/docs/TrackingType.md +12 -0
- package/docs/V1AstroProject.md +43 -0
- package/docs/V1AstroProjectAsset.md +41 -0
- package/docs/V1AstroProjectAssetMetadata.md +22 -0
- package/docs/V1AstroProjectAssetMetadataColorCombination.md +24 -0
- package/docs/V1AstroProjectJobLog.md +31 -0
- package/docs/V1AstroTarget.md +33 -0
- package/docs/V1CalibrationMaster.md +43 -0
- package/docs/V1Camera.md +47 -0
- package/docs/V1CreateAstroProjectImageSetRequest.md +24 -0
- package/docs/V1CreateAstroProjectRequest.md +30 -0
- package/docs/V1CreateAstroProjectResponse.md +23 -0
- package/docs/V1CreateCalibrationMasterRequest.md +42 -0
- package/docs/V1CreateCalibrationMasterResponse.md +22 -0
- package/docs/V1CreateCalibrationSetImageRequest.md +22 -0
- package/docs/V1CreateCalibrationSetImageResponse.md +22 -0
- package/docs/V1CreateCalibrationSetRequest.md +40 -0
- package/docs/V1CreateCalibrationSetResponse.md +20 -0
- package/docs/V1CreateImageSetImageRequest.md +32 -0
- package/docs/V1CreateImageSetImageResponse.md +23 -0
- package/docs/V1CreateImageSetRequest.md +28 -0
- package/docs/V1CreateNodeRequest.md +37 -0
- package/docs/V1CreateOpticalTrainInstanceRequest.md +28 -0
- package/docs/V1ElevationMaskPoint.md +25 -0
- package/docs/V1Focuser.md +27 -0
- package/docs/V1GainCurve.md +25 -0
- package/docs/V1GainCurvePoint.md +22 -0
- package/docs/V1GetAstroPlatformCreditBalanceResponse.md +21 -0
- package/docs/V1GetNodes.md +20 -0
- package/docs/V1GetOrCreateCameraRequest.md +60 -0
- package/docs/V1GetOrCreateFocuserRequest.md +24 -0
- package/docs/V1GetOrCreateMountRequest.md +24 -0
- package/docs/V1GetOrCreateOpticalTubeRequest.md +26 -0
- package/docs/V1ImageFileType.md +10 -0
- package/docs/V1ImageRejectionReason.md +64 -0
- package/docs/V1ImageSet.md +43 -0
- package/docs/V1ImageSetImage.md +77 -0
- package/docs/V1JobStatus.md +16 -0
- package/docs/V1Mount.md +23 -0
- package/docs/V1Node.md +59 -0
- package/docs/V1NodeWithLocation.md +23 -0
- package/docs/V1OpticalTrainInstance.md +43 -0
- package/docs/V1OpticalTube.md +27 -0
- package/docs/V1PlatformCredit.md +37 -0
- package/docs/V1PlatformCreditSource.md +14 -0
- package/docs/V1PlatformCreditType.md +8 -0
- package/docs/V1PlatformCreditUnit.md +8 -0
- package/docs/V1PredictedStreakLocation.md +26 -0
- package/docs/V1PutStackAstroProjectRequest.md +20 -0
- package/docs/V1PutStackAstroProjectResponse.md +23 -0
- package/docs/V1ReadNoisePoint.md +22 -0
- package/docs/V1SetupAction.md +23 -0
- package/docs/V1UpdateNodeRequest.md +51 -0
- package/docs/V1VideoModeFramerateProperty.md +28 -0
- package/docs/V2UpdateNodeRequest.md +43 -0
- package/index.ts +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,2560 @@
|
|
|
1
|
+
# DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.prod.oursky.ai*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**v1CameraMatch**](#v1cameramatch) | **GET** /v1/camera-match | |
|
|
8
|
+
|[**v1CreateAstroProject**](#v1createastroproject) | **POST** /v1/astro-project | |
|
|
9
|
+
|[**v1CreateAstroProjectImageSet**](#v1createastroprojectimageset) | **POST** /v1/astro-project-image-set | |
|
|
10
|
+
|[**v1CreateCalibrationMaster**](#v1createcalibrationmaster) | **POST** /v1/calibration-master | |
|
|
11
|
+
|[**v1CreateCalibrationSet**](#v1createcalibrationset) | **POST** /v1/calibration-set | |
|
|
12
|
+
|[**v1CreateCalibrationSetImage**](#v1createcalibrationsetimage) | **POST** /v1/calibration-set-image | |
|
|
13
|
+
|[**v1CreateImageSet**](#v1createimageset) | **POST** /v1/image-set | |
|
|
14
|
+
|[**v1CreateImageSetImage**](#v1createimagesetimage) | **POST** /v1/image-set-image | |
|
|
15
|
+
|[**v1CreateNode**](#v1createnode) | **POST** /v1/node | |
|
|
16
|
+
|[**v1CreateOpticalTrainInstance**](#v1createopticaltraininstance) | **POST** /v1/node/optical-train-instances | |
|
|
17
|
+
|[**v1DeleteAstroProject**](#v1deleteastroproject) | **DELETE** /v1/astro-project | |
|
|
18
|
+
|[**v1DeleteCalibrationMaster**](#v1deletecalibrationmaster) | **DELETE** /v1/calibration-master | |
|
|
19
|
+
|[**v1DeleteImageSet**](#v1deleteimageset) | **DELETE** /v1/image-set | |
|
|
20
|
+
|[**v1DeleteImageSetImage**](#v1deleteimagesetimage) | **DELETE** /v1/image-set-image | |
|
|
21
|
+
|[**v1DeleteOpticalTrainInstance**](#v1deleteopticaltraininstance) | **DELETE** /v1/node/optical-train-instance | |
|
|
22
|
+
|[**v1FocuserMatch**](#v1focusermatch) | **GET** /v1/focuser-match | |
|
|
23
|
+
|[**v1GetAstroCamera**](#v1getastrocamera) | **GET** /v1/astro-camera | |
|
|
24
|
+
|[**v1GetAstroFocuser**](#v1getastrofocuser) | **GET** /v1/astro-focuser | |
|
|
25
|
+
|[**v1GetAstroMount**](#v1getastromount) | **GET** /v1/astro-mount | |
|
|
26
|
+
|[**v1GetAstroOpticalTube**](#v1getastroopticaltube) | **GET** /v1/astro-optical-tube | |
|
|
27
|
+
|[**v1GetAstroPlatformCreditBalance**](#v1getastroplatformcreditbalance) | **GET** /v1/astro-platform-credit-balance | |
|
|
28
|
+
|[**v1GetAstroProject**](#v1getastroproject) | **GET** /v1/astro-project | |
|
|
29
|
+
|[**v1GetAstroProjectAssets**](#v1getastroprojectassets) | **GET** /v1/astro-project-assets | |
|
|
30
|
+
|[**v1GetAstroProjectJobLogs**](#v1getastroprojectjoblogs) | **GET** /v1/job-logs | |
|
|
31
|
+
|[**v1GetAstroProjects**](#v1getastroprojects) | **GET** /v1/astro-projects | |
|
|
32
|
+
|[**v1GetAstroTarget**](#v1getastrotarget) | **GET** /v1/astro-target | |
|
|
33
|
+
|[**v1GetAstroTargets**](#v1getastrotargets) | **GET** /v1/astro-targets | |
|
|
34
|
+
|[**v1GetCalibrationMasters**](#v1getcalibrationmasters) | **GET** /v1/calibration-masters | |
|
|
35
|
+
|[**v1GetImageSet**](#v1getimageset) | **GET** /v1/image-set | |
|
|
36
|
+
|[**v1GetImageSetImage**](#v1getimagesetimage) | **GET** /v1/image-set-image | |
|
|
37
|
+
|[**v1GetImageSetImages**](#v1getimagesetimages) | **GET** /v1/image-set-images | |
|
|
38
|
+
|[**v1GetImageSets**](#v1getimagesets) | **GET** /v1/image-sets | |
|
|
39
|
+
|[**v1GetNode**](#v1getnode) | **GET** /v1/node | |
|
|
40
|
+
|[**v1GetNodes**](#v1getnodes) | **GET** /v1/nodes | |
|
|
41
|
+
|[**v1GetOpticalTrainInstance**](#v1getopticaltraininstance) | **GET** /v1/node/optical-train-instance | |
|
|
42
|
+
|[**v1GetOrCreateCamera**](#v1getorcreatecamera) | **PUT** /v1/camera-match | |
|
|
43
|
+
|[**v1GetOrCreateFocuser**](#v1getorcreatefocuser) | **PUT** /v1/focuser-match | |
|
|
44
|
+
|[**v1GetOrCreateMount**](#v1getorcreatemount) | **PUT** /v1/mount-match | |
|
|
45
|
+
|[**v1GetOrCreateOpticalTube**](#v1getorcreateopticaltube) | **PUT** /v1/optical-tube-match | |
|
|
46
|
+
|[**v1GetPlatformCredits**](#v1getplatformcredits) | **GET** /v1/platform-credits | |
|
|
47
|
+
|[**v1GetVisibleAstroTargets**](#v1getvisibleastrotargets) | **GET** /v1/visible-astro-targets | |
|
|
48
|
+
|[**v1GetWeather**](#v1getweather) | **GET** /v1/weather | |
|
|
49
|
+
|[**v1MatchAstroProject**](#v1matchastroproject) | **GET** /v1/astro-project-match | |
|
|
50
|
+
|[**v1MountMatch**](#v1mountmatch) | **GET** /v1/mount-match | |
|
|
51
|
+
|[**v1OpticalTubeMatch**](#v1opticaltubematch) | **GET** /v1/optical-tube-match | |
|
|
52
|
+
|[**v1PutStackAstroProject**](#v1putstackastroproject) | **PUT** /v1/stack-astro-project | |
|
|
53
|
+
|[**v1UpdateNode**](#v1updatenode) | **PUT** /v1/node | |
|
|
54
|
+
|[**v2UpdateNode**](#v2updatenode) | **PUT** /v2/node | |
|
|
55
|
+
|
|
56
|
+
# **v1CameraMatch**
|
|
57
|
+
> Array<V1Camera> v1CameraMatch()
|
|
58
|
+
|
|
59
|
+
Match camera.
|
|
60
|
+
|
|
61
|
+
### Example
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
import {
|
|
65
|
+
DefaultApi,
|
|
66
|
+
Configuration
|
|
67
|
+
} from '@ourskyai/astro-api';
|
|
68
|
+
|
|
69
|
+
const configuration = new Configuration();
|
|
70
|
+
const apiInstance = new DefaultApi(configuration);
|
|
71
|
+
|
|
72
|
+
let model: string; // (optional) (default to undefined)
|
|
73
|
+
let pixelSizeMicrons: number; // (optional) (default to undefined)
|
|
74
|
+
let pixelsX: number; // (optional) (default to undefined)
|
|
75
|
+
let pixelsY: number; // (optional) (default to undefined)
|
|
76
|
+
let megapixels: number; // (optional) (default to undefined)
|
|
77
|
+
let chilled: boolean; // (optional) (default to undefined)
|
|
78
|
+
let adcBitDepth: number; // (optional) (default to undefined)
|
|
79
|
+
let isColor: boolean; // (optional) (default to undefined)
|
|
80
|
+
|
|
81
|
+
const { status, data } = await apiInstance.v1CameraMatch(
|
|
82
|
+
model,
|
|
83
|
+
pixelSizeMicrons,
|
|
84
|
+
pixelsX,
|
|
85
|
+
pixelsY,
|
|
86
|
+
megapixels,
|
|
87
|
+
chilled,
|
|
88
|
+
adcBitDepth,
|
|
89
|
+
isColor
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
98
|
+
| **pixelSizeMicrons** | [**number**] | | (optional) defaults to undefined|
|
|
99
|
+
| **pixelsX** | [**number**] | | (optional) defaults to undefined|
|
|
100
|
+
| **pixelsY** | [**number**] | | (optional) defaults to undefined|
|
|
101
|
+
| **megapixels** | [**number**] | | (optional) defaults to undefined|
|
|
102
|
+
| **chilled** | [**boolean**] | | (optional) defaults to undefined|
|
|
103
|
+
| **adcBitDepth** | [**number**] | | (optional) defaults to undefined|
|
|
104
|
+
| **isColor** | [**boolean**] | | (optional) defaults to undefined|
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Return type
|
|
108
|
+
|
|
109
|
+
**Array<V1Camera>**
|
|
110
|
+
|
|
111
|
+
### Authorization
|
|
112
|
+
|
|
113
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
114
|
+
|
|
115
|
+
### HTTP request headers
|
|
116
|
+
|
|
117
|
+
- **Content-Type**: Not defined
|
|
118
|
+
- **Accept**: application/json
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### HTTP response details
|
|
122
|
+
| Status code | Description | Response headers |
|
|
123
|
+
|-------------|-------------|------------------|
|
|
124
|
+
|**200** | V1Camera[] | - |
|
|
125
|
+
|
|
126
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
|
+
|
|
128
|
+
# **v1CreateAstroProject**
|
|
129
|
+
> V1CreateAstroProjectResponse v1CreateAstroProject(v1CreateAstroProjectRequest)
|
|
130
|
+
|
|
131
|
+
Create an astro project.
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
DefaultApi,
|
|
138
|
+
Configuration,
|
|
139
|
+
V1CreateAstroProjectRequest
|
|
140
|
+
} from '@ourskyai/astro-api';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new DefaultApi(configuration);
|
|
144
|
+
|
|
145
|
+
let v1CreateAstroProjectRequest: V1CreateAstroProjectRequest; //
|
|
146
|
+
|
|
147
|
+
const { status, data } = await apiInstance.v1CreateAstroProject(
|
|
148
|
+
v1CreateAstroProjectRequest
|
|
149
|
+
);
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
|Name | Type | Description | Notes|
|
|
155
|
+
|------------- | ------------- | ------------- | -------------|
|
|
156
|
+
| **v1CreateAstroProjectRequest** | **V1CreateAstroProjectRequest**| | |
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
### Return type
|
|
160
|
+
|
|
161
|
+
**V1CreateAstroProjectResponse**
|
|
162
|
+
|
|
163
|
+
### Authorization
|
|
164
|
+
|
|
165
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
166
|
+
|
|
167
|
+
### HTTP request headers
|
|
168
|
+
|
|
169
|
+
- **Content-Type**: application/json
|
|
170
|
+
- **Accept**: application/json
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
### HTTP response details
|
|
174
|
+
| Status code | Description | Response headers |
|
|
175
|
+
|-------------|-------------|------------------|
|
|
176
|
+
|**200** | V1CreateAstroProjectResponse | - |
|
|
177
|
+
|
|
178
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
179
|
+
|
|
180
|
+
# **v1CreateAstroProjectImageSet**
|
|
181
|
+
> SuccessfulCreate v1CreateAstroProjectImageSet(v1CreateAstroProjectImageSetRequest)
|
|
182
|
+
|
|
183
|
+
Create an astro project image set.
|
|
184
|
+
|
|
185
|
+
### Example
|
|
186
|
+
|
|
187
|
+
```typescript
|
|
188
|
+
import {
|
|
189
|
+
DefaultApi,
|
|
190
|
+
Configuration,
|
|
191
|
+
V1CreateAstroProjectImageSetRequest
|
|
192
|
+
} from '@ourskyai/astro-api';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new DefaultApi(configuration);
|
|
196
|
+
|
|
197
|
+
let v1CreateAstroProjectImageSetRequest: V1CreateAstroProjectImageSetRequest; //
|
|
198
|
+
|
|
199
|
+
const { status, data } = await apiInstance.v1CreateAstroProjectImageSet(
|
|
200
|
+
v1CreateAstroProjectImageSetRequest
|
|
201
|
+
);
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
205
|
+
|
|
206
|
+
|Name | Type | Description | Notes|
|
|
207
|
+
|------------- | ------------- | ------------- | -------------|
|
|
208
|
+
| **v1CreateAstroProjectImageSetRequest** | **V1CreateAstroProjectImageSetRequest**| | |
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
### Return type
|
|
212
|
+
|
|
213
|
+
**SuccessfulCreate**
|
|
214
|
+
|
|
215
|
+
### Authorization
|
|
216
|
+
|
|
217
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
218
|
+
|
|
219
|
+
### HTTP request headers
|
|
220
|
+
|
|
221
|
+
- **Content-Type**: application/json
|
|
222
|
+
- **Accept**: application/json
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### HTTP response details
|
|
226
|
+
| Status code | Description | Response headers |
|
|
227
|
+
|-------------|-------------|------------------|
|
|
228
|
+
|**200** | Successful create | - |
|
|
229
|
+
|
|
230
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
231
|
+
|
|
232
|
+
# **v1CreateCalibrationMaster**
|
|
233
|
+
> V1CreateCalibrationMasterResponse v1CreateCalibrationMaster(v1CreateCalibrationMasterRequest)
|
|
234
|
+
|
|
235
|
+
Create a calibration master.
|
|
236
|
+
|
|
237
|
+
### Example
|
|
238
|
+
|
|
239
|
+
```typescript
|
|
240
|
+
import {
|
|
241
|
+
DefaultApi,
|
|
242
|
+
Configuration,
|
|
243
|
+
V1CreateCalibrationMasterRequest
|
|
244
|
+
} from '@ourskyai/astro-api';
|
|
245
|
+
|
|
246
|
+
const configuration = new Configuration();
|
|
247
|
+
const apiInstance = new DefaultApi(configuration);
|
|
248
|
+
|
|
249
|
+
let v1CreateCalibrationMasterRequest: V1CreateCalibrationMasterRequest; //
|
|
250
|
+
|
|
251
|
+
const { status, data } = await apiInstance.v1CreateCalibrationMaster(
|
|
252
|
+
v1CreateCalibrationMasterRequest
|
|
253
|
+
);
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Parameters
|
|
257
|
+
|
|
258
|
+
|Name | Type | Description | Notes|
|
|
259
|
+
|------------- | ------------- | ------------- | -------------|
|
|
260
|
+
| **v1CreateCalibrationMasterRequest** | **V1CreateCalibrationMasterRequest**| | |
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
### Return type
|
|
264
|
+
|
|
265
|
+
**V1CreateCalibrationMasterResponse**
|
|
266
|
+
|
|
267
|
+
### Authorization
|
|
268
|
+
|
|
269
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
270
|
+
|
|
271
|
+
### HTTP request headers
|
|
272
|
+
|
|
273
|
+
- **Content-Type**: application/json
|
|
274
|
+
- **Accept**: application/json
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
### HTTP response details
|
|
278
|
+
| Status code | Description | Response headers |
|
|
279
|
+
|-------------|-------------|------------------|
|
|
280
|
+
|**200** | V1CreateCalibrationMasterResponse | - |
|
|
281
|
+
|
|
282
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
283
|
+
|
|
284
|
+
# **v1CreateCalibrationSet**
|
|
285
|
+
> V1CreateCalibrationSetResponse v1CreateCalibrationSet(v1CreateCalibrationSetRequest)
|
|
286
|
+
|
|
287
|
+
Create a calibration set that should be stacked from individual calibration images.
|
|
288
|
+
|
|
289
|
+
### Example
|
|
290
|
+
|
|
291
|
+
```typescript
|
|
292
|
+
import {
|
|
293
|
+
DefaultApi,
|
|
294
|
+
Configuration,
|
|
295
|
+
V1CreateCalibrationSetRequest
|
|
296
|
+
} from '@ourskyai/astro-api';
|
|
297
|
+
|
|
298
|
+
const configuration = new Configuration();
|
|
299
|
+
const apiInstance = new DefaultApi(configuration);
|
|
300
|
+
|
|
301
|
+
let v1CreateCalibrationSetRequest: V1CreateCalibrationSetRequest; //
|
|
302
|
+
|
|
303
|
+
const { status, data } = await apiInstance.v1CreateCalibrationSet(
|
|
304
|
+
v1CreateCalibrationSetRequest
|
|
305
|
+
);
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
### Parameters
|
|
309
|
+
|
|
310
|
+
|Name | Type | Description | Notes|
|
|
311
|
+
|------------- | ------------- | ------------- | -------------|
|
|
312
|
+
| **v1CreateCalibrationSetRequest** | **V1CreateCalibrationSetRequest**| | |
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### Return type
|
|
316
|
+
|
|
317
|
+
**V1CreateCalibrationSetResponse**
|
|
318
|
+
|
|
319
|
+
### Authorization
|
|
320
|
+
|
|
321
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
322
|
+
|
|
323
|
+
### HTTP request headers
|
|
324
|
+
|
|
325
|
+
- **Content-Type**: application/json
|
|
326
|
+
- **Accept**: application/json
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
### HTTP response details
|
|
330
|
+
| Status code | Description | Response headers |
|
|
331
|
+
|-------------|-------------|------------------|
|
|
332
|
+
|**200** | V1CreateCalibrationSetResponse | - |
|
|
333
|
+
|
|
334
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
335
|
+
|
|
336
|
+
# **v1CreateCalibrationSetImage**
|
|
337
|
+
> V1CreateCalibrationSetImageResponse v1CreateCalibrationSetImage(v1CreateCalibrationSetImageRequest)
|
|
338
|
+
|
|
339
|
+
Create a calibration set image.
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
import {
|
|
345
|
+
DefaultApi,
|
|
346
|
+
Configuration,
|
|
347
|
+
V1CreateCalibrationSetImageRequest
|
|
348
|
+
} from '@ourskyai/astro-api';
|
|
349
|
+
|
|
350
|
+
const configuration = new Configuration();
|
|
351
|
+
const apiInstance = new DefaultApi(configuration);
|
|
352
|
+
|
|
353
|
+
let v1CreateCalibrationSetImageRequest: V1CreateCalibrationSetImageRequest; //
|
|
354
|
+
|
|
355
|
+
const { status, data } = await apiInstance.v1CreateCalibrationSetImage(
|
|
356
|
+
v1CreateCalibrationSetImageRequest
|
|
357
|
+
);
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
### Parameters
|
|
361
|
+
|
|
362
|
+
|Name | Type | Description | Notes|
|
|
363
|
+
|------------- | ------------- | ------------- | -------------|
|
|
364
|
+
| **v1CreateCalibrationSetImageRequest** | **V1CreateCalibrationSetImageRequest**| | |
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
### Return type
|
|
368
|
+
|
|
369
|
+
**V1CreateCalibrationSetImageResponse**
|
|
370
|
+
|
|
371
|
+
### Authorization
|
|
372
|
+
|
|
373
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
374
|
+
|
|
375
|
+
### HTTP request headers
|
|
376
|
+
|
|
377
|
+
- **Content-Type**: application/json
|
|
378
|
+
- **Accept**: application/json
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
### HTTP response details
|
|
382
|
+
| Status code | Description | Response headers |
|
|
383
|
+
|-------------|-------------|------------------|
|
|
384
|
+
|**200** | V1CreateCalibrationSetImageResponse | - |
|
|
385
|
+
|
|
386
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
387
|
+
|
|
388
|
+
# **v1CreateImageSet**
|
|
389
|
+
> SuccessfulCreate v1CreateImageSet(v1CreateImageSetRequest)
|
|
390
|
+
|
|
391
|
+
Create an image set.
|
|
392
|
+
|
|
393
|
+
### Example
|
|
394
|
+
|
|
395
|
+
```typescript
|
|
396
|
+
import {
|
|
397
|
+
DefaultApi,
|
|
398
|
+
Configuration,
|
|
399
|
+
V1CreateImageSetRequest
|
|
400
|
+
} from '@ourskyai/astro-api';
|
|
401
|
+
|
|
402
|
+
const configuration = new Configuration();
|
|
403
|
+
const apiInstance = new DefaultApi(configuration);
|
|
404
|
+
|
|
405
|
+
let v1CreateImageSetRequest: V1CreateImageSetRequest; //
|
|
406
|
+
|
|
407
|
+
const { status, data } = await apiInstance.v1CreateImageSet(
|
|
408
|
+
v1CreateImageSetRequest
|
|
409
|
+
);
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### Parameters
|
|
413
|
+
|
|
414
|
+
|Name | Type | Description | Notes|
|
|
415
|
+
|------------- | ------------- | ------------- | -------------|
|
|
416
|
+
| **v1CreateImageSetRequest** | **V1CreateImageSetRequest**| | |
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
### Return type
|
|
420
|
+
|
|
421
|
+
**SuccessfulCreate**
|
|
422
|
+
|
|
423
|
+
### Authorization
|
|
424
|
+
|
|
425
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
426
|
+
|
|
427
|
+
### HTTP request headers
|
|
428
|
+
|
|
429
|
+
- **Content-Type**: application/json
|
|
430
|
+
- **Accept**: application/json
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
### HTTP response details
|
|
434
|
+
| Status code | Description | Response headers |
|
|
435
|
+
|-------------|-------------|------------------|
|
|
436
|
+
|**200** | Successful create | - |
|
|
437
|
+
|
|
438
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
439
|
+
|
|
440
|
+
# **v1CreateImageSetImage**
|
|
441
|
+
> V1CreateImageSetImageResponse v1CreateImageSetImage(v1CreateImageSetImageRequest)
|
|
442
|
+
|
|
443
|
+
Create an image set image.
|
|
444
|
+
|
|
445
|
+
### Example
|
|
446
|
+
|
|
447
|
+
```typescript
|
|
448
|
+
import {
|
|
449
|
+
DefaultApi,
|
|
450
|
+
Configuration,
|
|
451
|
+
V1CreateImageSetImageRequest
|
|
452
|
+
} from '@ourskyai/astro-api';
|
|
453
|
+
|
|
454
|
+
const configuration = new Configuration();
|
|
455
|
+
const apiInstance = new DefaultApi(configuration);
|
|
456
|
+
|
|
457
|
+
let v1CreateImageSetImageRequest: V1CreateImageSetImageRequest; //
|
|
458
|
+
|
|
459
|
+
const { status, data } = await apiInstance.v1CreateImageSetImage(
|
|
460
|
+
v1CreateImageSetImageRequest
|
|
461
|
+
);
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
### Parameters
|
|
465
|
+
|
|
466
|
+
|Name | Type | Description | Notes|
|
|
467
|
+
|------------- | ------------- | ------------- | -------------|
|
|
468
|
+
| **v1CreateImageSetImageRequest** | **V1CreateImageSetImageRequest**| | |
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
### Return type
|
|
472
|
+
|
|
473
|
+
**V1CreateImageSetImageResponse**
|
|
474
|
+
|
|
475
|
+
### Authorization
|
|
476
|
+
|
|
477
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
478
|
+
|
|
479
|
+
### HTTP request headers
|
|
480
|
+
|
|
481
|
+
- **Content-Type**: application/json
|
|
482
|
+
- **Accept**: application/json
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
### HTTP response details
|
|
486
|
+
| Status code | Description | Response headers |
|
|
487
|
+
|-------------|-------------|------------------|
|
|
488
|
+
|**200** | V1CreateImageSetImageResponse | - |
|
|
489
|
+
|
|
490
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
491
|
+
|
|
492
|
+
# **v1CreateNode**
|
|
493
|
+
> SuccessfulCreate v1CreateNode(v1CreateNodeRequest)
|
|
494
|
+
|
|
495
|
+
Create a node.
|
|
496
|
+
|
|
497
|
+
### Example
|
|
498
|
+
|
|
499
|
+
```typescript
|
|
500
|
+
import {
|
|
501
|
+
DefaultApi,
|
|
502
|
+
Configuration,
|
|
503
|
+
V1CreateNodeRequest
|
|
504
|
+
} from '@ourskyai/astro-api';
|
|
505
|
+
|
|
506
|
+
const configuration = new Configuration();
|
|
507
|
+
const apiInstance = new DefaultApi(configuration);
|
|
508
|
+
|
|
509
|
+
let v1CreateNodeRequest: V1CreateNodeRequest; //
|
|
510
|
+
|
|
511
|
+
const { status, data } = await apiInstance.v1CreateNode(
|
|
512
|
+
v1CreateNodeRequest
|
|
513
|
+
);
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
### Parameters
|
|
517
|
+
|
|
518
|
+
|Name | Type | Description | Notes|
|
|
519
|
+
|------------- | ------------- | ------------- | -------------|
|
|
520
|
+
| **v1CreateNodeRequest** | **V1CreateNodeRequest**| | |
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
### Return type
|
|
524
|
+
|
|
525
|
+
**SuccessfulCreate**
|
|
526
|
+
|
|
527
|
+
### Authorization
|
|
528
|
+
|
|
529
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
530
|
+
|
|
531
|
+
### HTTP request headers
|
|
532
|
+
|
|
533
|
+
- **Content-Type**: application/json
|
|
534
|
+
- **Accept**: application/json
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
### HTTP response details
|
|
538
|
+
| Status code | Description | Response headers |
|
|
539
|
+
|-------------|-------------|------------------|
|
|
540
|
+
|**200** | Successful create | - |
|
|
541
|
+
|
|
542
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
543
|
+
|
|
544
|
+
# **v1CreateOpticalTrainInstance**
|
|
545
|
+
> V1OpticalTrainInstance v1CreateOpticalTrainInstance(v1CreateOpticalTrainInstanceRequest)
|
|
546
|
+
|
|
547
|
+
Create an optical train instance.
|
|
548
|
+
|
|
549
|
+
### Example
|
|
550
|
+
|
|
551
|
+
```typescript
|
|
552
|
+
import {
|
|
553
|
+
DefaultApi,
|
|
554
|
+
Configuration,
|
|
555
|
+
V1CreateOpticalTrainInstanceRequest
|
|
556
|
+
} from '@ourskyai/astro-api';
|
|
557
|
+
|
|
558
|
+
const configuration = new Configuration();
|
|
559
|
+
const apiInstance = new DefaultApi(configuration);
|
|
560
|
+
|
|
561
|
+
let v1CreateOpticalTrainInstanceRequest: V1CreateOpticalTrainInstanceRequest; //
|
|
562
|
+
|
|
563
|
+
const { status, data } = await apiInstance.v1CreateOpticalTrainInstance(
|
|
564
|
+
v1CreateOpticalTrainInstanceRequest
|
|
565
|
+
);
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
### Parameters
|
|
569
|
+
|
|
570
|
+
|Name | Type | Description | Notes|
|
|
571
|
+
|------------- | ------------- | ------------- | -------------|
|
|
572
|
+
| **v1CreateOpticalTrainInstanceRequest** | **V1CreateOpticalTrainInstanceRequest**| | |
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
### Return type
|
|
576
|
+
|
|
577
|
+
**V1OpticalTrainInstance**
|
|
578
|
+
|
|
579
|
+
### Authorization
|
|
580
|
+
|
|
581
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
582
|
+
|
|
583
|
+
### HTTP request headers
|
|
584
|
+
|
|
585
|
+
- **Content-Type**: application/json
|
|
586
|
+
- **Accept**: application/json
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
### HTTP response details
|
|
590
|
+
| Status code | Description | Response headers |
|
|
591
|
+
|-------------|-------------|------------------|
|
|
592
|
+
|**200** | V1OpticalTrainInstance | - |
|
|
593
|
+
|
|
594
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
595
|
+
|
|
596
|
+
# **v1DeleteAstroProject**
|
|
597
|
+
> EmptySuccess v1DeleteAstroProject()
|
|
598
|
+
|
|
599
|
+
Delete an astro project with all associated assets and images.
|
|
600
|
+
|
|
601
|
+
### Example
|
|
602
|
+
|
|
603
|
+
```typescript
|
|
604
|
+
import {
|
|
605
|
+
DefaultApi,
|
|
606
|
+
Configuration
|
|
607
|
+
} from '@ourskyai/astro-api';
|
|
608
|
+
|
|
609
|
+
const configuration = new Configuration();
|
|
610
|
+
const apiInstance = new DefaultApi(configuration);
|
|
611
|
+
|
|
612
|
+
let astroProjectId: string; // (default to undefined)
|
|
613
|
+
|
|
614
|
+
const { status, data } = await apiInstance.v1DeleteAstroProject(
|
|
615
|
+
astroProjectId
|
|
616
|
+
);
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### Parameters
|
|
620
|
+
|
|
621
|
+
|Name | Type | Description | Notes|
|
|
622
|
+
|------------- | ------------- | ------------- | -------------|
|
|
623
|
+
| **astroProjectId** | [**string**] | | defaults to undefined|
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
### Return type
|
|
627
|
+
|
|
628
|
+
**EmptySuccess**
|
|
629
|
+
|
|
630
|
+
### Authorization
|
|
631
|
+
|
|
632
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
633
|
+
|
|
634
|
+
### HTTP request headers
|
|
635
|
+
|
|
636
|
+
- **Content-Type**: Not defined
|
|
637
|
+
- **Accept**: application/json
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
### HTTP response details
|
|
641
|
+
| Status code | Description | Response headers |
|
|
642
|
+
|-------------|-------------|------------------|
|
|
643
|
+
|**200** | Successful action | - |
|
|
644
|
+
|
|
645
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
646
|
+
|
|
647
|
+
# **v1DeleteCalibrationMaster**
|
|
648
|
+
> EmptySuccess v1DeleteCalibrationMaster()
|
|
649
|
+
|
|
650
|
+
Delete a calibration master.
|
|
651
|
+
|
|
652
|
+
### Example
|
|
653
|
+
|
|
654
|
+
```typescript
|
|
655
|
+
import {
|
|
656
|
+
DefaultApi,
|
|
657
|
+
Configuration
|
|
658
|
+
} from '@ourskyai/astro-api';
|
|
659
|
+
|
|
660
|
+
const configuration = new Configuration();
|
|
661
|
+
const apiInstance = new DefaultApi(configuration);
|
|
662
|
+
|
|
663
|
+
let calibrationMasterId: string; // (default to undefined)
|
|
664
|
+
|
|
665
|
+
const { status, data } = await apiInstance.v1DeleteCalibrationMaster(
|
|
666
|
+
calibrationMasterId
|
|
667
|
+
);
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
### Parameters
|
|
671
|
+
|
|
672
|
+
|Name | Type | Description | Notes|
|
|
673
|
+
|------------- | ------------- | ------------- | -------------|
|
|
674
|
+
| **calibrationMasterId** | [**string**] | | defaults to undefined|
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
### Return type
|
|
678
|
+
|
|
679
|
+
**EmptySuccess**
|
|
680
|
+
|
|
681
|
+
### Authorization
|
|
682
|
+
|
|
683
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
684
|
+
|
|
685
|
+
### HTTP request headers
|
|
686
|
+
|
|
687
|
+
- **Content-Type**: Not defined
|
|
688
|
+
- **Accept**: application/json
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
### HTTP response details
|
|
692
|
+
| Status code | Description | Response headers |
|
|
693
|
+
|-------------|-------------|------------------|
|
|
694
|
+
|**200** | Successful action | - |
|
|
695
|
+
|
|
696
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
697
|
+
|
|
698
|
+
# **v1DeleteImageSet**
|
|
699
|
+
> EmptySuccess v1DeleteImageSet()
|
|
700
|
+
|
|
701
|
+
Delete an image set.
|
|
702
|
+
|
|
703
|
+
### Example
|
|
704
|
+
|
|
705
|
+
```typescript
|
|
706
|
+
import {
|
|
707
|
+
DefaultApi,
|
|
708
|
+
Configuration
|
|
709
|
+
} from '@ourskyai/astro-api';
|
|
710
|
+
|
|
711
|
+
const configuration = new Configuration();
|
|
712
|
+
const apiInstance = new DefaultApi(configuration);
|
|
713
|
+
|
|
714
|
+
let id: string; // (default to undefined)
|
|
715
|
+
|
|
716
|
+
const { status, data } = await apiInstance.v1DeleteImageSet(
|
|
717
|
+
id
|
|
718
|
+
);
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
### Parameters
|
|
722
|
+
|
|
723
|
+
|Name | Type | Description | Notes|
|
|
724
|
+
|------------- | ------------- | ------------- | -------------|
|
|
725
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
### Return type
|
|
729
|
+
|
|
730
|
+
**EmptySuccess**
|
|
731
|
+
|
|
732
|
+
### Authorization
|
|
733
|
+
|
|
734
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
735
|
+
|
|
736
|
+
### HTTP request headers
|
|
737
|
+
|
|
738
|
+
- **Content-Type**: Not defined
|
|
739
|
+
- **Accept**: application/json
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
### HTTP response details
|
|
743
|
+
| Status code | Description | Response headers |
|
|
744
|
+
|-------------|-------------|------------------|
|
|
745
|
+
|**200** | Successful action | - |
|
|
746
|
+
|
|
747
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
748
|
+
|
|
749
|
+
# **v1DeleteImageSetImage**
|
|
750
|
+
> EmptySuccess v1DeleteImageSetImage()
|
|
751
|
+
|
|
752
|
+
Delete an image.
|
|
753
|
+
|
|
754
|
+
### Example
|
|
755
|
+
|
|
756
|
+
```typescript
|
|
757
|
+
import {
|
|
758
|
+
DefaultApi,
|
|
759
|
+
Configuration
|
|
760
|
+
} from '@ourskyai/astro-api';
|
|
761
|
+
|
|
762
|
+
const configuration = new Configuration();
|
|
763
|
+
const apiInstance = new DefaultApi(configuration);
|
|
764
|
+
|
|
765
|
+
let imageId: string; // (default to undefined)
|
|
766
|
+
|
|
767
|
+
const { status, data } = await apiInstance.v1DeleteImageSetImage(
|
|
768
|
+
imageId
|
|
769
|
+
);
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
### Parameters
|
|
773
|
+
|
|
774
|
+
|Name | Type | Description | Notes|
|
|
775
|
+
|------------- | ------------- | ------------- | -------------|
|
|
776
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
**EmptySuccess**
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: Not defined
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
### HTTP response details
|
|
794
|
+
| Status code | Description | Response headers |
|
|
795
|
+
|-------------|-------------|------------------|
|
|
796
|
+
|**200** | Successful action | - |
|
|
797
|
+
|
|
798
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
799
|
+
|
|
800
|
+
# **v1DeleteOpticalTrainInstance**
|
|
801
|
+
> EmptySuccess v1DeleteOpticalTrainInstance()
|
|
802
|
+
|
|
803
|
+
Delete an optical train instance.
|
|
804
|
+
|
|
805
|
+
### Example
|
|
806
|
+
|
|
807
|
+
```typescript
|
|
808
|
+
import {
|
|
809
|
+
DefaultApi,
|
|
810
|
+
Configuration
|
|
811
|
+
} from '@ourskyai/astro-api';
|
|
812
|
+
|
|
813
|
+
const configuration = new Configuration();
|
|
814
|
+
const apiInstance = new DefaultApi(configuration);
|
|
815
|
+
|
|
816
|
+
let id: string; // (default to undefined)
|
|
817
|
+
|
|
818
|
+
const { status, data } = await apiInstance.v1DeleteOpticalTrainInstance(
|
|
819
|
+
id
|
|
820
|
+
);
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
### Parameters
|
|
824
|
+
|
|
825
|
+
|Name | Type | Description | Notes|
|
|
826
|
+
|------------- | ------------- | ------------- | -------------|
|
|
827
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
### Return type
|
|
831
|
+
|
|
832
|
+
**EmptySuccess**
|
|
833
|
+
|
|
834
|
+
### Authorization
|
|
835
|
+
|
|
836
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
837
|
+
|
|
838
|
+
### HTTP request headers
|
|
839
|
+
|
|
840
|
+
- **Content-Type**: Not defined
|
|
841
|
+
- **Accept**: application/json
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
### HTTP response details
|
|
845
|
+
| Status code | Description | Response headers |
|
|
846
|
+
|-------------|-------------|------------------|
|
|
847
|
+
|**200** | Successful action | - |
|
|
848
|
+
|
|
849
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
850
|
+
|
|
851
|
+
# **v1FocuserMatch**
|
|
852
|
+
> Array<V1Focuser> v1FocuserMatch()
|
|
853
|
+
|
|
854
|
+
Match focuser.
|
|
855
|
+
|
|
856
|
+
### Example
|
|
857
|
+
|
|
858
|
+
```typescript
|
|
859
|
+
import {
|
|
860
|
+
DefaultApi,
|
|
861
|
+
Configuration
|
|
862
|
+
} from '@ourskyai/astro-api';
|
|
863
|
+
|
|
864
|
+
const configuration = new Configuration();
|
|
865
|
+
const apiInstance = new DefaultApi(configuration);
|
|
866
|
+
|
|
867
|
+
let model: string; // (optional) (default to undefined)
|
|
868
|
+
let travelDistanceMm: number; // (optional) (default to undefined)
|
|
869
|
+
|
|
870
|
+
const { status, data } = await apiInstance.v1FocuserMatch(
|
|
871
|
+
model,
|
|
872
|
+
travelDistanceMm
|
|
873
|
+
);
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
### Parameters
|
|
877
|
+
|
|
878
|
+
|Name | Type | Description | Notes|
|
|
879
|
+
|------------- | ------------- | ------------- | -------------|
|
|
880
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
881
|
+
| **travelDistanceMm** | [**number**] | | (optional) defaults to undefined|
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
### Return type
|
|
885
|
+
|
|
886
|
+
**Array<V1Focuser>**
|
|
887
|
+
|
|
888
|
+
### Authorization
|
|
889
|
+
|
|
890
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
891
|
+
|
|
892
|
+
### HTTP request headers
|
|
893
|
+
|
|
894
|
+
- **Content-Type**: Not defined
|
|
895
|
+
- **Accept**: application/json
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
### HTTP response details
|
|
899
|
+
| Status code | Description | Response headers |
|
|
900
|
+
|-------------|-------------|------------------|
|
|
901
|
+
|**200** | V1Focuser[] | - |
|
|
902
|
+
|
|
903
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
904
|
+
|
|
905
|
+
# **v1GetAstroCamera**
|
|
906
|
+
> V1Camera v1GetAstroCamera()
|
|
907
|
+
|
|
908
|
+
Get an astro camera.
|
|
909
|
+
|
|
910
|
+
### Example
|
|
911
|
+
|
|
912
|
+
```typescript
|
|
913
|
+
import {
|
|
914
|
+
DefaultApi,
|
|
915
|
+
Configuration
|
|
916
|
+
} from '@ourskyai/astro-api';
|
|
917
|
+
|
|
918
|
+
const configuration = new Configuration();
|
|
919
|
+
const apiInstance = new DefaultApi(configuration);
|
|
920
|
+
|
|
921
|
+
let id: string; // (default to undefined)
|
|
922
|
+
|
|
923
|
+
const { status, data } = await apiInstance.v1GetAstroCamera(
|
|
924
|
+
id
|
|
925
|
+
);
|
|
926
|
+
```
|
|
927
|
+
|
|
928
|
+
### Parameters
|
|
929
|
+
|
|
930
|
+
|Name | Type | Description | Notes|
|
|
931
|
+
|------------- | ------------- | ------------- | -------------|
|
|
932
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
### Return type
|
|
936
|
+
|
|
937
|
+
**V1Camera**
|
|
938
|
+
|
|
939
|
+
### Authorization
|
|
940
|
+
|
|
941
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
942
|
+
|
|
943
|
+
### HTTP request headers
|
|
944
|
+
|
|
945
|
+
- **Content-Type**: Not defined
|
|
946
|
+
- **Accept**: application/json
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
### HTTP response details
|
|
950
|
+
| Status code | Description | Response headers |
|
|
951
|
+
|-------------|-------------|------------------|
|
|
952
|
+
|**200** | V1Camera | - |
|
|
953
|
+
|
|
954
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
955
|
+
|
|
956
|
+
# **v1GetAstroFocuser**
|
|
957
|
+
> V1Focuser v1GetAstroFocuser()
|
|
958
|
+
|
|
959
|
+
Get an astro focuser.
|
|
960
|
+
|
|
961
|
+
### Example
|
|
962
|
+
|
|
963
|
+
```typescript
|
|
964
|
+
import {
|
|
965
|
+
DefaultApi,
|
|
966
|
+
Configuration
|
|
967
|
+
} from '@ourskyai/astro-api';
|
|
968
|
+
|
|
969
|
+
const configuration = new Configuration();
|
|
970
|
+
const apiInstance = new DefaultApi(configuration);
|
|
971
|
+
|
|
972
|
+
let id: string; // (default to undefined)
|
|
973
|
+
|
|
974
|
+
const { status, data } = await apiInstance.v1GetAstroFocuser(
|
|
975
|
+
id
|
|
976
|
+
);
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
### Parameters
|
|
980
|
+
|
|
981
|
+
|Name | Type | Description | Notes|
|
|
982
|
+
|------------- | ------------- | ------------- | -------------|
|
|
983
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
### Return type
|
|
987
|
+
|
|
988
|
+
**V1Focuser**
|
|
989
|
+
|
|
990
|
+
### Authorization
|
|
991
|
+
|
|
992
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
993
|
+
|
|
994
|
+
### HTTP request headers
|
|
995
|
+
|
|
996
|
+
- **Content-Type**: Not defined
|
|
997
|
+
- **Accept**: application/json
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
### HTTP response details
|
|
1001
|
+
| Status code | Description | Response headers |
|
|
1002
|
+
|-------------|-------------|------------------|
|
|
1003
|
+
|**200** | V1Focuser | - |
|
|
1004
|
+
|
|
1005
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1006
|
+
|
|
1007
|
+
# **v1GetAstroMount**
|
|
1008
|
+
> V1Mount v1GetAstroMount()
|
|
1009
|
+
|
|
1010
|
+
Get an astro mount.
|
|
1011
|
+
|
|
1012
|
+
### Example
|
|
1013
|
+
|
|
1014
|
+
```typescript
|
|
1015
|
+
import {
|
|
1016
|
+
DefaultApi,
|
|
1017
|
+
Configuration
|
|
1018
|
+
} from '@ourskyai/astro-api';
|
|
1019
|
+
|
|
1020
|
+
const configuration = new Configuration();
|
|
1021
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1022
|
+
|
|
1023
|
+
let id: string; // (default to undefined)
|
|
1024
|
+
|
|
1025
|
+
const { status, data } = await apiInstance.v1GetAstroMount(
|
|
1026
|
+
id
|
|
1027
|
+
);
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
### Parameters
|
|
1031
|
+
|
|
1032
|
+
|Name | Type | Description | Notes|
|
|
1033
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1034
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
### Return type
|
|
1038
|
+
|
|
1039
|
+
**V1Mount**
|
|
1040
|
+
|
|
1041
|
+
### Authorization
|
|
1042
|
+
|
|
1043
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1044
|
+
|
|
1045
|
+
### HTTP request headers
|
|
1046
|
+
|
|
1047
|
+
- **Content-Type**: Not defined
|
|
1048
|
+
- **Accept**: application/json
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
### HTTP response details
|
|
1052
|
+
| Status code | Description | Response headers |
|
|
1053
|
+
|-------------|-------------|------------------|
|
|
1054
|
+
|**200** | V1Mount | - |
|
|
1055
|
+
|
|
1056
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1057
|
+
|
|
1058
|
+
# **v1GetAstroOpticalTube**
|
|
1059
|
+
> V1OpticalTube v1GetAstroOpticalTube()
|
|
1060
|
+
|
|
1061
|
+
Get an astro optical tube.
|
|
1062
|
+
|
|
1063
|
+
### Example
|
|
1064
|
+
|
|
1065
|
+
```typescript
|
|
1066
|
+
import {
|
|
1067
|
+
DefaultApi,
|
|
1068
|
+
Configuration
|
|
1069
|
+
} from '@ourskyai/astro-api';
|
|
1070
|
+
|
|
1071
|
+
const configuration = new Configuration();
|
|
1072
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1073
|
+
|
|
1074
|
+
let id: string; // (default to undefined)
|
|
1075
|
+
|
|
1076
|
+
const { status, data } = await apiInstance.v1GetAstroOpticalTube(
|
|
1077
|
+
id
|
|
1078
|
+
);
|
|
1079
|
+
```
|
|
1080
|
+
|
|
1081
|
+
### Parameters
|
|
1082
|
+
|
|
1083
|
+
|Name | Type | Description | Notes|
|
|
1084
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1085
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
### Return type
|
|
1089
|
+
|
|
1090
|
+
**V1OpticalTube**
|
|
1091
|
+
|
|
1092
|
+
### Authorization
|
|
1093
|
+
|
|
1094
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1095
|
+
|
|
1096
|
+
### HTTP request headers
|
|
1097
|
+
|
|
1098
|
+
- **Content-Type**: Not defined
|
|
1099
|
+
- **Accept**: application/json
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
### HTTP response details
|
|
1103
|
+
| Status code | Description | Response headers |
|
|
1104
|
+
|-------------|-------------|------------------|
|
|
1105
|
+
|**200** | V1OpticalTube | - |
|
|
1106
|
+
|
|
1107
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1108
|
+
|
|
1109
|
+
# **v1GetAstroPlatformCreditBalance**
|
|
1110
|
+
> V1GetAstroPlatformCreditBalanceResponse v1GetAstroPlatformCreditBalance()
|
|
1111
|
+
|
|
1112
|
+
Get astro platform credit balance.
|
|
1113
|
+
|
|
1114
|
+
### Example
|
|
1115
|
+
|
|
1116
|
+
```typescript
|
|
1117
|
+
import {
|
|
1118
|
+
DefaultApi,
|
|
1119
|
+
Configuration
|
|
1120
|
+
} from '@ourskyai/astro-api';
|
|
1121
|
+
|
|
1122
|
+
const configuration = new Configuration();
|
|
1123
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1124
|
+
|
|
1125
|
+
const { status, data } = await apiInstance.v1GetAstroPlatformCreditBalance();
|
|
1126
|
+
```
|
|
1127
|
+
|
|
1128
|
+
### Parameters
|
|
1129
|
+
This endpoint does not have any parameters.
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
### Return type
|
|
1133
|
+
|
|
1134
|
+
**V1GetAstroPlatformCreditBalanceResponse**
|
|
1135
|
+
|
|
1136
|
+
### Authorization
|
|
1137
|
+
|
|
1138
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1139
|
+
|
|
1140
|
+
### HTTP request headers
|
|
1141
|
+
|
|
1142
|
+
- **Content-Type**: Not defined
|
|
1143
|
+
- **Accept**: application/json
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
### HTTP response details
|
|
1147
|
+
| Status code | Description | Response headers |
|
|
1148
|
+
|-------------|-------------|------------------|
|
|
1149
|
+
|**200** | V1GetAstroPlatformCreditBalanceResponse | - |
|
|
1150
|
+
|
|
1151
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1152
|
+
|
|
1153
|
+
# **v1GetAstroProject**
|
|
1154
|
+
> V1AstroProject v1GetAstroProject()
|
|
1155
|
+
|
|
1156
|
+
Get an astro project.
|
|
1157
|
+
|
|
1158
|
+
### Example
|
|
1159
|
+
|
|
1160
|
+
```typescript
|
|
1161
|
+
import {
|
|
1162
|
+
DefaultApi,
|
|
1163
|
+
Configuration
|
|
1164
|
+
} from '@ourskyai/astro-api';
|
|
1165
|
+
|
|
1166
|
+
const configuration = new Configuration();
|
|
1167
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1168
|
+
|
|
1169
|
+
let astroProjectId: string; // (default to undefined)
|
|
1170
|
+
|
|
1171
|
+
const { status, data } = await apiInstance.v1GetAstroProject(
|
|
1172
|
+
astroProjectId
|
|
1173
|
+
);
|
|
1174
|
+
```
|
|
1175
|
+
|
|
1176
|
+
### Parameters
|
|
1177
|
+
|
|
1178
|
+
|Name | Type | Description | Notes|
|
|
1179
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1180
|
+
| **astroProjectId** | [**string**] | | defaults to undefined|
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
### Return type
|
|
1184
|
+
|
|
1185
|
+
**V1AstroProject**
|
|
1186
|
+
|
|
1187
|
+
### Authorization
|
|
1188
|
+
|
|
1189
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1190
|
+
|
|
1191
|
+
### HTTP request headers
|
|
1192
|
+
|
|
1193
|
+
- **Content-Type**: Not defined
|
|
1194
|
+
- **Accept**: application/json
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
### HTTP response details
|
|
1198
|
+
| Status code | Description | Response headers |
|
|
1199
|
+
|-------------|-------------|------------------|
|
|
1200
|
+
|**200** | V1AstroProject | - |
|
|
1201
|
+
|
|
1202
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1203
|
+
|
|
1204
|
+
# **v1GetAstroProjectAssets**
|
|
1205
|
+
> Array<V1AstroProjectAsset> v1GetAstroProjectAssets()
|
|
1206
|
+
|
|
1207
|
+
Get astro project assets.
|
|
1208
|
+
|
|
1209
|
+
### Example
|
|
1210
|
+
|
|
1211
|
+
```typescript
|
|
1212
|
+
import {
|
|
1213
|
+
DefaultApi,
|
|
1214
|
+
Configuration
|
|
1215
|
+
} from '@ourskyai/astro-api';
|
|
1216
|
+
|
|
1217
|
+
const configuration = new Configuration();
|
|
1218
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1219
|
+
|
|
1220
|
+
let astroProjectId: string; // (default to undefined)
|
|
1221
|
+
|
|
1222
|
+
const { status, data } = await apiInstance.v1GetAstroProjectAssets(
|
|
1223
|
+
astroProjectId
|
|
1224
|
+
);
|
|
1225
|
+
```
|
|
1226
|
+
|
|
1227
|
+
### Parameters
|
|
1228
|
+
|
|
1229
|
+
|Name | Type | Description | Notes|
|
|
1230
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1231
|
+
| **astroProjectId** | [**string**] | | defaults to undefined|
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
### Return type
|
|
1235
|
+
|
|
1236
|
+
**Array<V1AstroProjectAsset>**
|
|
1237
|
+
|
|
1238
|
+
### Authorization
|
|
1239
|
+
|
|
1240
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1241
|
+
|
|
1242
|
+
### HTTP request headers
|
|
1243
|
+
|
|
1244
|
+
- **Content-Type**: Not defined
|
|
1245
|
+
- **Accept**: application/json
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
### HTTP response details
|
|
1249
|
+
| Status code | Description | Response headers |
|
|
1250
|
+
|-------------|-------------|------------------|
|
|
1251
|
+
|**200** | V1AstroProjectAsset[] | - |
|
|
1252
|
+
|
|
1253
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1254
|
+
|
|
1255
|
+
# **v1GetAstroProjectJobLogs**
|
|
1256
|
+
> Array<V1AstroProjectJobLog> v1GetAstroProjectJobLogs()
|
|
1257
|
+
|
|
1258
|
+
Get astro project job logs.
|
|
1259
|
+
|
|
1260
|
+
### Example
|
|
1261
|
+
|
|
1262
|
+
```typescript
|
|
1263
|
+
import {
|
|
1264
|
+
DefaultApi,
|
|
1265
|
+
Configuration
|
|
1266
|
+
} from '@ourskyai/astro-api';
|
|
1267
|
+
|
|
1268
|
+
const configuration = new Configuration();
|
|
1269
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1270
|
+
|
|
1271
|
+
let astroProjectId: string; // (default to undefined)
|
|
1272
|
+
|
|
1273
|
+
const { status, data } = await apiInstance.v1GetAstroProjectJobLogs(
|
|
1274
|
+
astroProjectId
|
|
1275
|
+
);
|
|
1276
|
+
```
|
|
1277
|
+
|
|
1278
|
+
### Parameters
|
|
1279
|
+
|
|
1280
|
+
|Name | Type | Description | Notes|
|
|
1281
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1282
|
+
| **astroProjectId** | [**string**] | | defaults to undefined|
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
### Return type
|
|
1286
|
+
|
|
1287
|
+
**Array<V1AstroProjectJobLog>**
|
|
1288
|
+
|
|
1289
|
+
### Authorization
|
|
1290
|
+
|
|
1291
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1292
|
+
|
|
1293
|
+
### HTTP request headers
|
|
1294
|
+
|
|
1295
|
+
- **Content-Type**: Not defined
|
|
1296
|
+
- **Accept**: application/json
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
### HTTP response details
|
|
1300
|
+
| Status code | Description | Response headers |
|
|
1301
|
+
|-------------|-------------|------------------|
|
|
1302
|
+
|**200** | V1AstroProjectJobLog[] | - |
|
|
1303
|
+
|
|
1304
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1305
|
+
|
|
1306
|
+
# **v1GetAstroProjects**
|
|
1307
|
+
> Array<V1AstroProject> v1GetAstroProjects()
|
|
1308
|
+
|
|
1309
|
+
Get astro projects.
|
|
1310
|
+
|
|
1311
|
+
### Example
|
|
1312
|
+
|
|
1313
|
+
```typescript
|
|
1314
|
+
import {
|
|
1315
|
+
DefaultApi,
|
|
1316
|
+
Configuration
|
|
1317
|
+
} from '@ourskyai/astro-api';
|
|
1318
|
+
|
|
1319
|
+
const configuration = new Configuration();
|
|
1320
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1321
|
+
|
|
1322
|
+
const { status, data } = await apiInstance.v1GetAstroProjects();
|
|
1323
|
+
```
|
|
1324
|
+
|
|
1325
|
+
### Parameters
|
|
1326
|
+
This endpoint does not have any parameters.
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
### Return type
|
|
1330
|
+
|
|
1331
|
+
**Array<V1AstroProject>**
|
|
1332
|
+
|
|
1333
|
+
### Authorization
|
|
1334
|
+
|
|
1335
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1336
|
+
|
|
1337
|
+
### HTTP request headers
|
|
1338
|
+
|
|
1339
|
+
- **Content-Type**: Not defined
|
|
1340
|
+
- **Accept**: application/json
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
### HTTP response details
|
|
1344
|
+
| Status code | Description | Response headers |
|
|
1345
|
+
|-------------|-------------|------------------|
|
|
1346
|
+
|**200** | V1AstroProject[] | - |
|
|
1347
|
+
|
|
1348
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1349
|
+
|
|
1350
|
+
# **v1GetAstroTarget**
|
|
1351
|
+
> V1AstroTarget v1GetAstroTarget()
|
|
1352
|
+
|
|
1353
|
+
Get an astro target. Pass in an ID, an NGC ID or an IC ID.
|
|
1354
|
+
|
|
1355
|
+
### Example
|
|
1356
|
+
|
|
1357
|
+
```typescript
|
|
1358
|
+
import {
|
|
1359
|
+
DefaultApi,
|
|
1360
|
+
Configuration
|
|
1361
|
+
} from '@ourskyai/astro-api';
|
|
1362
|
+
|
|
1363
|
+
const configuration = new Configuration();
|
|
1364
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1365
|
+
|
|
1366
|
+
let id: string; // (optional) (default to undefined)
|
|
1367
|
+
let ngcId: string; // (optional) (default to undefined)
|
|
1368
|
+
let icId: string; // (optional) (default to undefined)
|
|
1369
|
+
|
|
1370
|
+
const { status, data } = await apiInstance.v1GetAstroTarget(
|
|
1371
|
+
id,
|
|
1372
|
+
ngcId,
|
|
1373
|
+
icId
|
|
1374
|
+
);
|
|
1375
|
+
```
|
|
1376
|
+
|
|
1377
|
+
### Parameters
|
|
1378
|
+
|
|
1379
|
+
|Name | Type | Description | Notes|
|
|
1380
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1381
|
+
| **id** | [**string**] | | (optional) defaults to undefined|
|
|
1382
|
+
| **ngcId** | [**string**] | | (optional) defaults to undefined|
|
|
1383
|
+
| **icId** | [**string**] | | (optional) defaults to undefined|
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
### Return type
|
|
1387
|
+
|
|
1388
|
+
**V1AstroTarget**
|
|
1389
|
+
|
|
1390
|
+
### Authorization
|
|
1391
|
+
|
|
1392
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1393
|
+
|
|
1394
|
+
### HTTP request headers
|
|
1395
|
+
|
|
1396
|
+
- **Content-Type**: Not defined
|
|
1397
|
+
- **Accept**: application/json
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
### HTTP response details
|
|
1401
|
+
| Status code | Description | Response headers |
|
|
1402
|
+
|-------------|-------------|------------------|
|
|
1403
|
+
|**200** | V1AstroTarget | - |
|
|
1404
|
+
|
|
1405
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1406
|
+
|
|
1407
|
+
# **v1GetAstroTargets**
|
|
1408
|
+
> Array<V1AstroTarget> v1GetAstroTargets()
|
|
1409
|
+
|
|
1410
|
+
Get all astro targets. This response is paginated. It will only return at most 100 at a time. To get the next page, pass in the `id` of the last target in the current page as the `lastId` query parameter. Omitting this field fetches the first page.
|
|
1411
|
+
|
|
1412
|
+
### Example
|
|
1413
|
+
|
|
1414
|
+
```typescript
|
|
1415
|
+
import {
|
|
1416
|
+
DefaultApi,
|
|
1417
|
+
Configuration
|
|
1418
|
+
} from '@ourskyai/astro-api';
|
|
1419
|
+
|
|
1420
|
+
const configuration = new Configuration();
|
|
1421
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1422
|
+
|
|
1423
|
+
let lastId: string; // (optional) (default to undefined)
|
|
1424
|
+
let catalogId: string; // (optional) (default to undefined)
|
|
1425
|
+
let ra: number; // (optional) (default to undefined)
|
|
1426
|
+
let dec: number; // (optional) (default to undefined)
|
|
1427
|
+
|
|
1428
|
+
const { status, data } = await apiInstance.v1GetAstroTargets(
|
|
1429
|
+
lastId,
|
|
1430
|
+
catalogId,
|
|
1431
|
+
ra,
|
|
1432
|
+
dec
|
|
1433
|
+
);
|
|
1434
|
+
```
|
|
1435
|
+
|
|
1436
|
+
### Parameters
|
|
1437
|
+
|
|
1438
|
+
|Name | Type | Description | Notes|
|
|
1439
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1440
|
+
| **lastId** | [**string**] | | (optional) defaults to undefined|
|
|
1441
|
+
| **catalogId** | [**string**] | | (optional) defaults to undefined|
|
|
1442
|
+
| **ra** | [**number**] | | (optional) defaults to undefined|
|
|
1443
|
+
| **dec** | [**number**] | | (optional) defaults to undefined|
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
### Return type
|
|
1447
|
+
|
|
1448
|
+
**Array<V1AstroTarget>**
|
|
1449
|
+
|
|
1450
|
+
### Authorization
|
|
1451
|
+
|
|
1452
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1453
|
+
|
|
1454
|
+
### HTTP request headers
|
|
1455
|
+
|
|
1456
|
+
- **Content-Type**: Not defined
|
|
1457
|
+
- **Accept**: application/json
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
### HTTP response details
|
|
1461
|
+
| Status code | Description | Response headers |
|
|
1462
|
+
|-------------|-------------|------------------|
|
|
1463
|
+
|**200** | V1AstroTarget[] | - |
|
|
1464
|
+
|
|
1465
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1466
|
+
|
|
1467
|
+
# **v1GetCalibrationMasters**
|
|
1468
|
+
> Array<V1CalibrationMaster> v1GetCalibrationMasters()
|
|
1469
|
+
|
|
1470
|
+
Get calibration masters.
|
|
1471
|
+
|
|
1472
|
+
### Example
|
|
1473
|
+
|
|
1474
|
+
```typescript
|
|
1475
|
+
import {
|
|
1476
|
+
DefaultApi,
|
|
1477
|
+
Configuration
|
|
1478
|
+
} from '@ourskyai/astro-api';
|
|
1479
|
+
|
|
1480
|
+
const configuration = new Configuration();
|
|
1481
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1482
|
+
|
|
1483
|
+
let nodeId: string; // (default to undefined)
|
|
1484
|
+
|
|
1485
|
+
const { status, data } = await apiInstance.v1GetCalibrationMasters(
|
|
1486
|
+
nodeId
|
|
1487
|
+
);
|
|
1488
|
+
```
|
|
1489
|
+
|
|
1490
|
+
### Parameters
|
|
1491
|
+
|
|
1492
|
+
|Name | Type | Description | Notes|
|
|
1493
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1494
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
### Return type
|
|
1498
|
+
|
|
1499
|
+
**Array<V1CalibrationMaster>**
|
|
1500
|
+
|
|
1501
|
+
### Authorization
|
|
1502
|
+
|
|
1503
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1504
|
+
|
|
1505
|
+
### HTTP request headers
|
|
1506
|
+
|
|
1507
|
+
- **Content-Type**: Not defined
|
|
1508
|
+
- **Accept**: application/json
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
### HTTP response details
|
|
1512
|
+
| Status code | Description | Response headers |
|
|
1513
|
+
|-------------|-------------|------------------|
|
|
1514
|
+
|**200** | V1CalibrationMaster[] | - |
|
|
1515
|
+
|
|
1516
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1517
|
+
|
|
1518
|
+
# **v1GetImageSet**
|
|
1519
|
+
> V1ImageSet v1GetImageSet()
|
|
1520
|
+
|
|
1521
|
+
Get an image set.
|
|
1522
|
+
|
|
1523
|
+
### Example
|
|
1524
|
+
|
|
1525
|
+
```typescript
|
|
1526
|
+
import {
|
|
1527
|
+
DefaultApi,
|
|
1528
|
+
Configuration
|
|
1529
|
+
} from '@ourskyai/astro-api';
|
|
1530
|
+
|
|
1531
|
+
const configuration = new Configuration();
|
|
1532
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1533
|
+
|
|
1534
|
+
let id: string; // (default to undefined)
|
|
1535
|
+
|
|
1536
|
+
const { status, data } = await apiInstance.v1GetImageSet(
|
|
1537
|
+
id
|
|
1538
|
+
);
|
|
1539
|
+
```
|
|
1540
|
+
|
|
1541
|
+
### Parameters
|
|
1542
|
+
|
|
1543
|
+
|Name | Type | Description | Notes|
|
|
1544
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1545
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
### Return type
|
|
1549
|
+
|
|
1550
|
+
**V1ImageSet**
|
|
1551
|
+
|
|
1552
|
+
### Authorization
|
|
1553
|
+
|
|
1554
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1555
|
+
|
|
1556
|
+
### HTTP request headers
|
|
1557
|
+
|
|
1558
|
+
- **Content-Type**: Not defined
|
|
1559
|
+
- **Accept**: application/json
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
### HTTP response details
|
|
1563
|
+
| Status code | Description | Response headers |
|
|
1564
|
+
|-------------|-------------|------------------|
|
|
1565
|
+
|**200** | V1ImageSet | - |
|
|
1566
|
+
|
|
1567
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1568
|
+
|
|
1569
|
+
# **v1GetImageSetImage**
|
|
1570
|
+
> V1ImageSetImage v1GetImageSetImage()
|
|
1571
|
+
|
|
1572
|
+
Get an image.
|
|
1573
|
+
|
|
1574
|
+
### Example
|
|
1575
|
+
|
|
1576
|
+
```typescript
|
|
1577
|
+
import {
|
|
1578
|
+
DefaultApi,
|
|
1579
|
+
Configuration
|
|
1580
|
+
} from '@ourskyai/astro-api';
|
|
1581
|
+
|
|
1582
|
+
const configuration = new Configuration();
|
|
1583
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1584
|
+
|
|
1585
|
+
let imageId: string; // (default to undefined)
|
|
1586
|
+
|
|
1587
|
+
const { status, data } = await apiInstance.v1GetImageSetImage(
|
|
1588
|
+
imageId
|
|
1589
|
+
);
|
|
1590
|
+
```
|
|
1591
|
+
|
|
1592
|
+
### Parameters
|
|
1593
|
+
|
|
1594
|
+
|Name | Type | Description | Notes|
|
|
1595
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1596
|
+
| **imageId** | [**string**] | | defaults to undefined|
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
### Return type
|
|
1600
|
+
|
|
1601
|
+
**V1ImageSetImage**
|
|
1602
|
+
|
|
1603
|
+
### Authorization
|
|
1604
|
+
|
|
1605
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1606
|
+
|
|
1607
|
+
### HTTP request headers
|
|
1608
|
+
|
|
1609
|
+
- **Content-Type**: Not defined
|
|
1610
|
+
- **Accept**: application/json
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
### HTTP response details
|
|
1614
|
+
| Status code | Description | Response headers |
|
|
1615
|
+
|-------------|-------------|------------------|
|
|
1616
|
+
|**200** | V1ImageSetImage | - |
|
|
1617
|
+
|
|
1618
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1619
|
+
|
|
1620
|
+
# **v1GetImageSetImages**
|
|
1621
|
+
> Array<V1ImageSetImage> v1GetImageSetImages()
|
|
1622
|
+
|
|
1623
|
+
Get image set images for an explicit list of image set ids. Star parties are owned by the edge controller, so the starPartyId param is not supported in the cloud API and returns 400 if provided; use the node-platform star party endpoints to resolve a party\'s image sets.
|
|
1624
|
+
|
|
1625
|
+
### Example
|
|
1626
|
+
|
|
1627
|
+
```typescript
|
|
1628
|
+
import {
|
|
1629
|
+
DefaultApi,
|
|
1630
|
+
Configuration
|
|
1631
|
+
} from '@ourskyai/astro-api';
|
|
1632
|
+
|
|
1633
|
+
const configuration = new Configuration();
|
|
1634
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1635
|
+
|
|
1636
|
+
let imageSets: Array<string>; // (optional) (default to undefined)
|
|
1637
|
+
let starPartyId: string; // (optional) (default to undefined)
|
|
1638
|
+
|
|
1639
|
+
const { status, data } = await apiInstance.v1GetImageSetImages(
|
|
1640
|
+
imageSets,
|
|
1641
|
+
starPartyId
|
|
1642
|
+
);
|
|
1643
|
+
```
|
|
1644
|
+
|
|
1645
|
+
### Parameters
|
|
1646
|
+
|
|
1647
|
+
|Name | Type | Description | Notes|
|
|
1648
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1649
|
+
| **imageSets** | **Array<string>** | | (optional) defaults to undefined|
|
|
1650
|
+
| **starPartyId** | [**string**] | | (optional) defaults to undefined|
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
### Return type
|
|
1654
|
+
|
|
1655
|
+
**Array<V1ImageSetImage>**
|
|
1656
|
+
|
|
1657
|
+
### Authorization
|
|
1658
|
+
|
|
1659
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1660
|
+
|
|
1661
|
+
### HTTP request headers
|
|
1662
|
+
|
|
1663
|
+
- **Content-Type**: Not defined
|
|
1664
|
+
- **Accept**: application/json
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
### HTTP response details
|
|
1668
|
+
| Status code | Description | Response headers |
|
|
1669
|
+
|-------------|-------------|------------------|
|
|
1670
|
+
|**200** | V1ImageSetImage[] | - |
|
|
1671
|
+
|
|
1672
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1673
|
+
|
|
1674
|
+
# **v1GetImageSets**
|
|
1675
|
+
> Array<V1ImageSet> v1GetImageSets()
|
|
1676
|
+
|
|
1677
|
+
Get image sets. Star parties are owned by the edge controller, so the starPartyId param is not supported in the cloud API and returns 400 if provided; use the node-platform star party endpoints to resolve a party\'s image sets.
|
|
1678
|
+
|
|
1679
|
+
### Example
|
|
1680
|
+
|
|
1681
|
+
```typescript
|
|
1682
|
+
import {
|
|
1683
|
+
DefaultApi,
|
|
1684
|
+
Configuration
|
|
1685
|
+
} from '@ourskyai/astro-api';
|
|
1686
|
+
|
|
1687
|
+
const configuration = new Configuration();
|
|
1688
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1689
|
+
|
|
1690
|
+
let starPartyId: string; // (optional) (default to undefined)
|
|
1691
|
+
|
|
1692
|
+
const { status, data } = await apiInstance.v1GetImageSets(
|
|
1693
|
+
starPartyId
|
|
1694
|
+
);
|
|
1695
|
+
```
|
|
1696
|
+
|
|
1697
|
+
### Parameters
|
|
1698
|
+
|
|
1699
|
+
|Name | Type | Description | Notes|
|
|
1700
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1701
|
+
| **starPartyId** | [**string**] | | (optional) defaults to undefined|
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
### Return type
|
|
1705
|
+
|
|
1706
|
+
**Array<V1ImageSet>**
|
|
1707
|
+
|
|
1708
|
+
### Authorization
|
|
1709
|
+
|
|
1710
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1711
|
+
|
|
1712
|
+
### HTTP request headers
|
|
1713
|
+
|
|
1714
|
+
- **Content-Type**: Not defined
|
|
1715
|
+
- **Accept**: application/json
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
### HTTP response details
|
|
1719
|
+
| Status code | Description | Response headers |
|
|
1720
|
+
|-------------|-------------|------------------|
|
|
1721
|
+
|**200** | V1ImageSet[] | - |
|
|
1722
|
+
|
|
1723
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1724
|
+
|
|
1725
|
+
# **v1GetNode**
|
|
1726
|
+
> V1Node v1GetNode()
|
|
1727
|
+
|
|
1728
|
+
Get node by lineage id or node id.
|
|
1729
|
+
|
|
1730
|
+
### Example
|
|
1731
|
+
|
|
1732
|
+
```typescript
|
|
1733
|
+
import {
|
|
1734
|
+
DefaultApi,
|
|
1735
|
+
Configuration
|
|
1736
|
+
} from '@ourskyai/astro-api';
|
|
1737
|
+
|
|
1738
|
+
const configuration = new Configuration();
|
|
1739
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1740
|
+
|
|
1741
|
+
let lineageId: string; // (optional) (default to undefined)
|
|
1742
|
+
let nodeId: string; // (optional) (default to undefined)
|
|
1743
|
+
|
|
1744
|
+
const { status, data } = await apiInstance.v1GetNode(
|
|
1745
|
+
lineageId,
|
|
1746
|
+
nodeId
|
|
1747
|
+
);
|
|
1748
|
+
```
|
|
1749
|
+
|
|
1750
|
+
### Parameters
|
|
1751
|
+
|
|
1752
|
+
|Name | Type | Description | Notes|
|
|
1753
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1754
|
+
| **lineageId** | [**string**] | | (optional) defaults to undefined|
|
|
1755
|
+
| **nodeId** | [**string**] | | (optional) defaults to undefined|
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
### Return type
|
|
1759
|
+
|
|
1760
|
+
**V1Node**
|
|
1761
|
+
|
|
1762
|
+
### Authorization
|
|
1763
|
+
|
|
1764
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1765
|
+
|
|
1766
|
+
### HTTP request headers
|
|
1767
|
+
|
|
1768
|
+
- **Content-Type**: Not defined
|
|
1769
|
+
- **Accept**: application/json
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
### HTTP response details
|
|
1773
|
+
| Status code | Description | Response headers |
|
|
1774
|
+
|-------------|-------------|------------------|
|
|
1775
|
+
|**200** | V1Node | - |
|
|
1776
|
+
|
|
1777
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1778
|
+
|
|
1779
|
+
# **v1GetNodes**
|
|
1780
|
+
> V1GetNodes v1GetNodes()
|
|
1781
|
+
|
|
1782
|
+
Get nodes.
|
|
1783
|
+
|
|
1784
|
+
### Example
|
|
1785
|
+
|
|
1786
|
+
```typescript
|
|
1787
|
+
import {
|
|
1788
|
+
DefaultApi,
|
|
1789
|
+
Configuration
|
|
1790
|
+
} from '@ourskyai/astro-api';
|
|
1791
|
+
|
|
1792
|
+
const configuration = new Configuration();
|
|
1793
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1794
|
+
|
|
1795
|
+
const { status, data } = await apiInstance.v1GetNodes();
|
|
1796
|
+
```
|
|
1797
|
+
|
|
1798
|
+
### Parameters
|
|
1799
|
+
This endpoint does not have any parameters.
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
### Return type
|
|
1803
|
+
|
|
1804
|
+
**V1GetNodes**
|
|
1805
|
+
|
|
1806
|
+
### Authorization
|
|
1807
|
+
|
|
1808
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1809
|
+
|
|
1810
|
+
### HTTP request headers
|
|
1811
|
+
|
|
1812
|
+
- **Content-Type**: Not defined
|
|
1813
|
+
- **Accept**: application/json
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
### HTTP response details
|
|
1817
|
+
| Status code | Description | Response headers |
|
|
1818
|
+
|-------------|-------------|------------------|
|
|
1819
|
+
|**200** | V1GetNodes | - |
|
|
1820
|
+
|
|
1821
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1822
|
+
|
|
1823
|
+
# **v1GetOpticalTrainInstance**
|
|
1824
|
+
> V1OpticalTrainInstance v1GetOpticalTrainInstance()
|
|
1825
|
+
|
|
1826
|
+
Get an optical train instance.
|
|
1827
|
+
|
|
1828
|
+
### Example
|
|
1829
|
+
|
|
1830
|
+
```typescript
|
|
1831
|
+
import {
|
|
1832
|
+
DefaultApi,
|
|
1833
|
+
Configuration
|
|
1834
|
+
} from '@ourskyai/astro-api';
|
|
1835
|
+
|
|
1836
|
+
const configuration = new Configuration();
|
|
1837
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1838
|
+
|
|
1839
|
+
let id: string; // (default to undefined)
|
|
1840
|
+
|
|
1841
|
+
const { status, data } = await apiInstance.v1GetOpticalTrainInstance(
|
|
1842
|
+
id
|
|
1843
|
+
);
|
|
1844
|
+
```
|
|
1845
|
+
|
|
1846
|
+
### Parameters
|
|
1847
|
+
|
|
1848
|
+
|Name | Type | Description | Notes|
|
|
1849
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1850
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
### Return type
|
|
1854
|
+
|
|
1855
|
+
**V1OpticalTrainInstance**
|
|
1856
|
+
|
|
1857
|
+
### Authorization
|
|
1858
|
+
|
|
1859
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1860
|
+
|
|
1861
|
+
### HTTP request headers
|
|
1862
|
+
|
|
1863
|
+
- **Content-Type**: Not defined
|
|
1864
|
+
- **Accept**: application/json
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
### HTTP response details
|
|
1868
|
+
| Status code | Description | Response headers |
|
|
1869
|
+
|-------------|-------------|------------------|
|
|
1870
|
+
|**200** | V1OpticalTrainInstance | - |
|
|
1871
|
+
|
|
1872
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1873
|
+
|
|
1874
|
+
# **v1GetOrCreateCamera**
|
|
1875
|
+
> V1Camera v1GetOrCreateCamera(v1GetOrCreateCameraRequest)
|
|
1876
|
+
|
|
1877
|
+
Get or create camera.
|
|
1878
|
+
|
|
1879
|
+
### Example
|
|
1880
|
+
|
|
1881
|
+
```typescript
|
|
1882
|
+
import {
|
|
1883
|
+
DefaultApi,
|
|
1884
|
+
Configuration,
|
|
1885
|
+
V1GetOrCreateCameraRequest
|
|
1886
|
+
} from '@ourskyai/astro-api';
|
|
1887
|
+
|
|
1888
|
+
const configuration = new Configuration();
|
|
1889
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1890
|
+
|
|
1891
|
+
let v1GetOrCreateCameraRequest: V1GetOrCreateCameraRequest; //
|
|
1892
|
+
|
|
1893
|
+
const { status, data } = await apiInstance.v1GetOrCreateCamera(
|
|
1894
|
+
v1GetOrCreateCameraRequest
|
|
1895
|
+
);
|
|
1896
|
+
```
|
|
1897
|
+
|
|
1898
|
+
### Parameters
|
|
1899
|
+
|
|
1900
|
+
|Name | Type | Description | Notes|
|
|
1901
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1902
|
+
| **v1GetOrCreateCameraRequest** | **V1GetOrCreateCameraRequest**| | |
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
### Return type
|
|
1906
|
+
|
|
1907
|
+
**V1Camera**
|
|
1908
|
+
|
|
1909
|
+
### Authorization
|
|
1910
|
+
|
|
1911
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1912
|
+
|
|
1913
|
+
### HTTP request headers
|
|
1914
|
+
|
|
1915
|
+
- **Content-Type**: application/json
|
|
1916
|
+
- **Accept**: application/json
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
### HTTP response details
|
|
1920
|
+
| Status code | Description | Response headers |
|
|
1921
|
+
|-------------|-------------|------------------|
|
|
1922
|
+
|**200** | V1Camera | - |
|
|
1923
|
+
|
|
1924
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1925
|
+
|
|
1926
|
+
# **v1GetOrCreateFocuser**
|
|
1927
|
+
> V1Focuser v1GetOrCreateFocuser(v1GetOrCreateFocuserRequest)
|
|
1928
|
+
|
|
1929
|
+
Get or create focuser.
|
|
1930
|
+
|
|
1931
|
+
### Example
|
|
1932
|
+
|
|
1933
|
+
```typescript
|
|
1934
|
+
import {
|
|
1935
|
+
DefaultApi,
|
|
1936
|
+
Configuration,
|
|
1937
|
+
V1GetOrCreateFocuserRequest
|
|
1938
|
+
} from '@ourskyai/astro-api';
|
|
1939
|
+
|
|
1940
|
+
const configuration = new Configuration();
|
|
1941
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1942
|
+
|
|
1943
|
+
let v1GetOrCreateFocuserRequest: V1GetOrCreateFocuserRequest; //
|
|
1944
|
+
|
|
1945
|
+
const { status, data } = await apiInstance.v1GetOrCreateFocuser(
|
|
1946
|
+
v1GetOrCreateFocuserRequest
|
|
1947
|
+
);
|
|
1948
|
+
```
|
|
1949
|
+
|
|
1950
|
+
### Parameters
|
|
1951
|
+
|
|
1952
|
+
|Name | Type | Description | Notes|
|
|
1953
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1954
|
+
| **v1GetOrCreateFocuserRequest** | **V1GetOrCreateFocuserRequest**| | |
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
### Return type
|
|
1958
|
+
|
|
1959
|
+
**V1Focuser**
|
|
1960
|
+
|
|
1961
|
+
### Authorization
|
|
1962
|
+
|
|
1963
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1964
|
+
|
|
1965
|
+
### HTTP request headers
|
|
1966
|
+
|
|
1967
|
+
- **Content-Type**: application/json
|
|
1968
|
+
- **Accept**: application/json
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
### HTTP response details
|
|
1972
|
+
| Status code | Description | Response headers |
|
|
1973
|
+
|-------------|-------------|------------------|
|
|
1974
|
+
|**200** | V1Focuser | - |
|
|
1975
|
+
|
|
1976
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1977
|
+
|
|
1978
|
+
# **v1GetOrCreateMount**
|
|
1979
|
+
> V1Mount v1GetOrCreateMount(v1GetOrCreateMountRequest)
|
|
1980
|
+
|
|
1981
|
+
Get or create mount.
|
|
1982
|
+
|
|
1983
|
+
### Example
|
|
1984
|
+
|
|
1985
|
+
```typescript
|
|
1986
|
+
import {
|
|
1987
|
+
DefaultApi,
|
|
1988
|
+
Configuration,
|
|
1989
|
+
V1GetOrCreateMountRequest
|
|
1990
|
+
} from '@ourskyai/astro-api';
|
|
1991
|
+
|
|
1992
|
+
const configuration = new Configuration();
|
|
1993
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1994
|
+
|
|
1995
|
+
let v1GetOrCreateMountRequest: V1GetOrCreateMountRequest; //
|
|
1996
|
+
|
|
1997
|
+
const { status, data } = await apiInstance.v1GetOrCreateMount(
|
|
1998
|
+
v1GetOrCreateMountRequest
|
|
1999
|
+
);
|
|
2000
|
+
```
|
|
2001
|
+
|
|
2002
|
+
### Parameters
|
|
2003
|
+
|
|
2004
|
+
|Name | Type | Description | Notes|
|
|
2005
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2006
|
+
| **v1GetOrCreateMountRequest** | **V1GetOrCreateMountRequest**| | |
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
### Return type
|
|
2010
|
+
|
|
2011
|
+
**V1Mount**
|
|
2012
|
+
|
|
2013
|
+
### Authorization
|
|
2014
|
+
|
|
2015
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2016
|
+
|
|
2017
|
+
### HTTP request headers
|
|
2018
|
+
|
|
2019
|
+
- **Content-Type**: application/json
|
|
2020
|
+
- **Accept**: application/json
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
### HTTP response details
|
|
2024
|
+
| Status code | Description | Response headers |
|
|
2025
|
+
|-------------|-------------|------------------|
|
|
2026
|
+
|**200** | V1Mount | - |
|
|
2027
|
+
|
|
2028
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2029
|
+
|
|
2030
|
+
# **v1GetOrCreateOpticalTube**
|
|
2031
|
+
> V1OpticalTube v1GetOrCreateOpticalTube(v1GetOrCreateOpticalTubeRequest)
|
|
2032
|
+
|
|
2033
|
+
Get or create optical tube.
|
|
2034
|
+
|
|
2035
|
+
### Example
|
|
2036
|
+
|
|
2037
|
+
```typescript
|
|
2038
|
+
import {
|
|
2039
|
+
DefaultApi,
|
|
2040
|
+
Configuration,
|
|
2041
|
+
V1GetOrCreateOpticalTubeRequest
|
|
2042
|
+
} from '@ourskyai/astro-api';
|
|
2043
|
+
|
|
2044
|
+
const configuration = new Configuration();
|
|
2045
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2046
|
+
|
|
2047
|
+
let v1GetOrCreateOpticalTubeRequest: V1GetOrCreateOpticalTubeRequest; //
|
|
2048
|
+
|
|
2049
|
+
const { status, data } = await apiInstance.v1GetOrCreateOpticalTube(
|
|
2050
|
+
v1GetOrCreateOpticalTubeRequest
|
|
2051
|
+
);
|
|
2052
|
+
```
|
|
2053
|
+
|
|
2054
|
+
### Parameters
|
|
2055
|
+
|
|
2056
|
+
|Name | Type | Description | Notes|
|
|
2057
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2058
|
+
| **v1GetOrCreateOpticalTubeRequest** | **V1GetOrCreateOpticalTubeRequest**| | |
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
### Return type
|
|
2062
|
+
|
|
2063
|
+
**V1OpticalTube**
|
|
2064
|
+
|
|
2065
|
+
### Authorization
|
|
2066
|
+
|
|
2067
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2068
|
+
|
|
2069
|
+
### HTTP request headers
|
|
2070
|
+
|
|
2071
|
+
- **Content-Type**: application/json
|
|
2072
|
+
- **Accept**: application/json
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
### HTTP response details
|
|
2076
|
+
| Status code | Description | Response headers |
|
|
2077
|
+
|-------------|-------------|------------------|
|
|
2078
|
+
|**200** | V1OpticalTube | - |
|
|
2079
|
+
|
|
2080
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2081
|
+
|
|
2082
|
+
# **v1GetPlatformCredits**
|
|
2083
|
+
> Array<V1PlatformCredit> v1GetPlatformCredits()
|
|
2084
|
+
|
|
2085
|
+
Get platform credits.
|
|
2086
|
+
|
|
2087
|
+
### Example
|
|
2088
|
+
|
|
2089
|
+
```typescript
|
|
2090
|
+
import {
|
|
2091
|
+
DefaultApi,
|
|
2092
|
+
Configuration
|
|
2093
|
+
} from '@ourskyai/astro-api';
|
|
2094
|
+
|
|
2095
|
+
const configuration = new Configuration();
|
|
2096
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2097
|
+
|
|
2098
|
+
const { status, data } = await apiInstance.v1GetPlatformCredits();
|
|
2099
|
+
```
|
|
2100
|
+
|
|
2101
|
+
### Parameters
|
|
2102
|
+
This endpoint does not have any parameters.
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
### Return type
|
|
2106
|
+
|
|
2107
|
+
**Array<V1PlatformCredit>**
|
|
2108
|
+
|
|
2109
|
+
### Authorization
|
|
2110
|
+
|
|
2111
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2112
|
+
|
|
2113
|
+
### HTTP request headers
|
|
2114
|
+
|
|
2115
|
+
- **Content-Type**: Not defined
|
|
2116
|
+
- **Accept**: application/json
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
### HTTP response details
|
|
2120
|
+
| Status code | Description | Response headers |
|
|
2121
|
+
|-------------|-------------|------------------|
|
|
2122
|
+
|**200** | V1PlatformCredit | - |
|
|
2123
|
+
|
|
2124
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2125
|
+
|
|
2126
|
+
# **v1GetVisibleAstroTargets**
|
|
2127
|
+
> Array<V1AstroTarget> v1GetVisibleAstroTargets()
|
|
2128
|
+
|
|
2129
|
+
Get all astro targets visible to this specific node. This response is paginated. It will only return at most 100 at a time. To get the next page, pass in the `id` of the last target in the current page as the `lastId` query parameter. Omitting this field fetches the first page.
|
|
2130
|
+
|
|
2131
|
+
### Example
|
|
2132
|
+
|
|
2133
|
+
```typescript
|
|
2134
|
+
import {
|
|
2135
|
+
DefaultApi,
|
|
2136
|
+
Configuration
|
|
2137
|
+
} from '@ourskyai/astro-api';
|
|
2138
|
+
|
|
2139
|
+
const configuration = new Configuration();
|
|
2140
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2141
|
+
|
|
2142
|
+
let timestamp: string; // (default to undefined)
|
|
2143
|
+
let nodeId: string; // (default to undefined)
|
|
2144
|
+
let offset: number; // (optional) (default to undefined)
|
|
2145
|
+
|
|
2146
|
+
const { status, data } = await apiInstance.v1GetVisibleAstroTargets(
|
|
2147
|
+
timestamp,
|
|
2148
|
+
nodeId,
|
|
2149
|
+
offset
|
|
2150
|
+
);
|
|
2151
|
+
```
|
|
2152
|
+
|
|
2153
|
+
### Parameters
|
|
2154
|
+
|
|
2155
|
+
|Name | Type | Description | Notes|
|
|
2156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2157
|
+
| **timestamp** | [**string**] | | defaults to undefined|
|
|
2158
|
+
| **nodeId** | [**string**] | | defaults to undefined|
|
|
2159
|
+
| **offset** | [**number**] | | (optional) defaults to undefined|
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
### Return type
|
|
2163
|
+
|
|
2164
|
+
**Array<V1AstroTarget>**
|
|
2165
|
+
|
|
2166
|
+
### Authorization
|
|
2167
|
+
|
|
2168
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2169
|
+
|
|
2170
|
+
### HTTP request headers
|
|
2171
|
+
|
|
2172
|
+
- **Content-Type**: Not defined
|
|
2173
|
+
- **Accept**: application/json
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
### HTTP response details
|
|
2177
|
+
| Status code | Description | Response headers |
|
|
2178
|
+
|-------------|-------------|------------------|
|
|
2179
|
+
|**200** | V1AstroTarget[] | - |
|
|
2180
|
+
|
|
2181
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2182
|
+
|
|
2183
|
+
# **v1GetWeather**
|
|
2184
|
+
> DailyWeatherForecastListResponse v1GetWeather()
|
|
2185
|
+
|
|
2186
|
+
Get weather.
|
|
2187
|
+
|
|
2188
|
+
### Example
|
|
2189
|
+
|
|
2190
|
+
```typescript
|
|
2191
|
+
import {
|
|
2192
|
+
DefaultApi,
|
|
2193
|
+
Configuration
|
|
2194
|
+
} from '@ourskyai/astro-api';
|
|
2195
|
+
|
|
2196
|
+
const configuration = new Configuration();
|
|
2197
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2198
|
+
|
|
2199
|
+
let latitude: number; // (default to undefined)
|
|
2200
|
+
let longitude: number; // (default to undefined)
|
|
2201
|
+
|
|
2202
|
+
const { status, data } = await apiInstance.v1GetWeather(
|
|
2203
|
+
latitude,
|
|
2204
|
+
longitude
|
|
2205
|
+
);
|
|
2206
|
+
```
|
|
2207
|
+
|
|
2208
|
+
### Parameters
|
|
2209
|
+
|
|
2210
|
+
|Name | Type | Description | Notes|
|
|
2211
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2212
|
+
| **latitude** | [**number**] | | defaults to undefined|
|
|
2213
|
+
| **longitude** | [**number**] | | defaults to undefined|
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
### Return type
|
|
2217
|
+
|
|
2218
|
+
**DailyWeatherForecastListResponse**
|
|
2219
|
+
|
|
2220
|
+
### Authorization
|
|
2221
|
+
|
|
2222
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2223
|
+
|
|
2224
|
+
### HTTP request headers
|
|
2225
|
+
|
|
2226
|
+
- **Content-Type**: Not defined
|
|
2227
|
+
- **Accept**: application/json
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
### HTTP response details
|
|
2231
|
+
| Status code | Description | Response headers |
|
|
2232
|
+
|-------------|-------------|------------------|
|
|
2233
|
+
|**200** | V1WeatherDaySummary | - |
|
|
2234
|
+
|
|
2235
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2236
|
+
|
|
2237
|
+
# **v1MatchAstroProject**
|
|
2238
|
+
> Array<V1AstroProject> v1MatchAstroProject()
|
|
2239
|
+
|
|
2240
|
+
Match astro project.
|
|
2241
|
+
|
|
2242
|
+
### Example
|
|
2243
|
+
|
|
2244
|
+
```typescript
|
|
2245
|
+
import {
|
|
2246
|
+
DefaultApi,
|
|
2247
|
+
Configuration
|
|
2248
|
+
} from '@ourskyai/astro-api';
|
|
2249
|
+
|
|
2250
|
+
const configuration = new Configuration();
|
|
2251
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2252
|
+
|
|
2253
|
+
let targetId: string; // (default to undefined)
|
|
2254
|
+
let cameraId: string; // (default to undefined)
|
|
2255
|
+
let otaId: string; // (default to undefined)
|
|
2256
|
+
|
|
2257
|
+
const { status, data } = await apiInstance.v1MatchAstroProject(
|
|
2258
|
+
targetId,
|
|
2259
|
+
cameraId,
|
|
2260
|
+
otaId
|
|
2261
|
+
);
|
|
2262
|
+
```
|
|
2263
|
+
|
|
2264
|
+
### Parameters
|
|
2265
|
+
|
|
2266
|
+
|Name | Type | Description | Notes|
|
|
2267
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2268
|
+
| **targetId** | [**string**] | | defaults to undefined|
|
|
2269
|
+
| **cameraId** | [**string**] | | defaults to undefined|
|
|
2270
|
+
| **otaId** | [**string**] | | defaults to undefined|
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
### Return type
|
|
2274
|
+
|
|
2275
|
+
**Array<V1AstroProject>**
|
|
2276
|
+
|
|
2277
|
+
### Authorization
|
|
2278
|
+
|
|
2279
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2280
|
+
|
|
2281
|
+
### HTTP request headers
|
|
2282
|
+
|
|
2283
|
+
- **Content-Type**: Not defined
|
|
2284
|
+
- **Accept**: application/json
|
|
2285
|
+
|
|
2286
|
+
|
|
2287
|
+
### HTTP response details
|
|
2288
|
+
| Status code | Description | Response headers |
|
|
2289
|
+
|-------------|-------------|------------------|
|
|
2290
|
+
|**200** | V1AstroProject | - |
|
|
2291
|
+
|
|
2292
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2293
|
+
|
|
2294
|
+
# **v1MountMatch**
|
|
2295
|
+
> Array<V1Mount> v1MountMatch()
|
|
2296
|
+
|
|
2297
|
+
Match mount.
|
|
2298
|
+
|
|
2299
|
+
### Example
|
|
2300
|
+
|
|
2301
|
+
```typescript
|
|
2302
|
+
import {
|
|
2303
|
+
DefaultApi,
|
|
2304
|
+
Configuration
|
|
2305
|
+
} from '@ourskyai/astro-api';
|
|
2306
|
+
|
|
2307
|
+
const configuration = new Configuration();
|
|
2308
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2309
|
+
|
|
2310
|
+
let model: string; // (optional) (default to undefined)
|
|
2311
|
+
|
|
2312
|
+
const { status, data } = await apiInstance.v1MountMatch(
|
|
2313
|
+
model
|
|
2314
|
+
);
|
|
2315
|
+
```
|
|
2316
|
+
|
|
2317
|
+
### Parameters
|
|
2318
|
+
|
|
2319
|
+
|Name | Type | Description | Notes|
|
|
2320
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2321
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
### Return type
|
|
2325
|
+
|
|
2326
|
+
**Array<V1Mount>**
|
|
2327
|
+
|
|
2328
|
+
### Authorization
|
|
2329
|
+
|
|
2330
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2331
|
+
|
|
2332
|
+
### HTTP request headers
|
|
2333
|
+
|
|
2334
|
+
- **Content-Type**: Not defined
|
|
2335
|
+
- **Accept**: application/json
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
### HTTP response details
|
|
2339
|
+
| Status code | Description | Response headers |
|
|
2340
|
+
|-------------|-------------|------------------|
|
|
2341
|
+
|**200** | V1Mount[] | - |
|
|
2342
|
+
|
|
2343
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2344
|
+
|
|
2345
|
+
# **v1OpticalTubeMatch**
|
|
2346
|
+
> Array<V1OpticalTube> v1OpticalTubeMatch()
|
|
2347
|
+
|
|
2348
|
+
Match optical tube.
|
|
2349
|
+
|
|
2350
|
+
### Example
|
|
2351
|
+
|
|
2352
|
+
```typescript
|
|
2353
|
+
import {
|
|
2354
|
+
DefaultApi,
|
|
2355
|
+
Configuration
|
|
2356
|
+
} from '@ourskyai/astro-api';
|
|
2357
|
+
|
|
2358
|
+
const configuration = new Configuration();
|
|
2359
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2360
|
+
|
|
2361
|
+
let model: string; // (optional) (default to undefined)
|
|
2362
|
+
let focalLengthMm: number; // (optional) (default to undefined)
|
|
2363
|
+
let apertureMm: number; // (optional) (default to undefined)
|
|
2364
|
+
let type: OpticalTubeType; // (optional) (default to undefined)
|
|
2365
|
+
|
|
2366
|
+
const { status, data } = await apiInstance.v1OpticalTubeMatch(
|
|
2367
|
+
model,
|
|
2368
|
+
focalLengthMm,
|
|
2369
|
+
apertureMm,
|
|
2370
|
+
type
|
|
2371
|
+
);
|
|
2372
|
+
```
|
|
2373
|
+
|
|
2374
|
+
### Parameters
|
|
2375
|
+
|
|
2376
|
+
|Name | Type | Description | Notes|
|
|
2377
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2378
|
+
| **model** | [**string**] | | (optional) defaults to undefined|
|
|
2379
|
+
| **focalLengthMm** | [**number**] | | (optional) defaults to undefined|
|
|
2380
|
+
| **apertureMm** | [**number**] | | (optional) defaults to undefined|
|
|
2381
|
+
| **type** | **OpticalTubeType** | | (optional) defaults to undefined|
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
### Return type
|
|
2385
|
+
|
|
2386
|
+
**Array<V1OpticalTube>**
|
|
2387
|
+
|
|
2388
|
+
### Authorization
|
|
2389
|
+
|
|
2390
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2391
|
+
|
|
2392
|
+
### HTTP request headers
|
|
2393
|
+
|
|
2394
|
+
- **Content-Type**: Not defined
|
|
2395
|
+
- **Accept**: application/json
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
### HTTP response details
|
|
2399
|
+
| Status code | Description | Response headers |
|
|
2400
|
+
|-------------|-------------|------------------|
|
|
2401
|
+
|**200** | V1OpticalTube[] | - |
|
|
2402
|
+
|
|
2403
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2404
|
+
|
|
2405
|
+
# **v1PutStackAstroProject**
|
|
2406
|
+
> V1PutStackAstroProjectResponse v1PutStackAstroProject(v1PutStackAstroProjectRequest)
|
|
2407
|
+
|
|
2408
|
+
Stack an astro project.
|
|
2409
|
+
|
|
2410
|
+
### Example
|
|
2411
|
+
|
|
2412
|
+
```typescript
|
|
2413
|
+
import {
|
|
2414
|
+
DefaultApi,
|
|
2415
|
+
Configuration,
|
|
2416
|
+
V1PutStackAstroProjectRequest
|
|
2417
|
+
} from '@ourskyai/astro-api';
|
|
2418
|
+
|
|
2419
|
+
const configuration = new Configuration();
|
|
2420
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2421
|
+
|
|
2422
|
+
let v1PutStackAstroProjectRequest: V1PutStackAstroProjectRequest; //
|
|
2423
|
+
|
|
2424
|
+
const { status, data } = await apiInstance.v1PutStackAstroProject(
|
|
2425
|
+
v1PutStackAstroProjectRequest
|
|
2426
|
+
);
|
|
2427
|
+
```
|
|
2428
|
+
|
|
2429
|
+
### Parameters
|
|
2430
|
+
|
|
2431
|
+
|Name | Type | Description | Notes|
|
|
2432
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2433
|
+
| **v1PutStackAstroProjectRequest** | **V1PutStackAstroProjectRequest**| | |
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
### Return type
|
|
2437
|
+
|
|
2438
|
+
**V1PutStackAstroProjectResponse**
|
|
2439
|
+
|
|
2440
|
+
### Authorization
|
|
2441
|
+
|
|
2442
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2443
|
+
|
|
2444
|
+
### HTTP request headers
|
|
2445
|
+
|
|
2446
|
+
- **Content-Type**: application/json
|
|
2447
|
+
- **Accept**: application/json
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
### HTTP response details
|
|
2451
|
+
| Status code | Description | Response headers |
|
|
2452
|
+
|-------------|-------------|------------------|
|
|
2453
|
+
|**200** | V1PutStackAstroProjectResponse | - |
|
|
2454
|
+
|
|
2455
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2456
|
+
|
|
2457
|
+
# **v1UpdateNode**
|
|
2458
|
+
> EmptySuccess v1UpdateNode(v1UpdateNodeRequest)
|
|
2459
|
+
|
|
2460
|
+
Update a node.
|
|
2461
|
+
|
|
2462
|
+
### Example
|
|
2463
|
+
|
|
2464
|
+
```typescript
|
|
2465
|
+
import {
|
|
2466
|
+
DefaultApi,
|
|
2467
|
+
Configuration,
|
|
2468
|
+
V1UpdateNodeRequest
|
|
2469
|
+
} from '@ourskyai/astro-api';
|
|
2470
|
+
|
|
2471
|
+
const configuration = new Configuration();
|
|
2472
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2473
|
+
|
|
2474
|
+
let v1UpdateNodeRequest: V1UpdateNodeRequest; //
|
|
2475
|
+
|
|
2476
|
+
const { status, data } = await apiInstance.v1UpdateNode(
|
|
2477
|
+
v1UpdateNodeRequest
|
|
2478
|
+
);
|
|
2479
|
+
```
|
|
2480
|
+
|
|
2481
|
+
### Parameters
|
|
2482
|
+
|
|
2483
|
+
|Name | Type | Description | Notes|
|
|
2484
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2485
|
+
| **v1UpdateNodeRequest** | **V1UpdateNodeRequest**| | |
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
### Return type
|
|
2489
|
+
|
|
2490
|
+
**EmptySuccess**
|
|
2491
|
+
|
|
2492
|
+
### Authorization
|
|
2493
|
+
|
|
2494
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2495
|
+
|
|
2496
|
+
### HTTP request headers
|
|
2497
|
+
|
|
2498
|
+
- **Content-Type**: application/json
|
|
2499
|
+
- **Accept**: application/json
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
### HTTP response details
|
|
2503
|
+
| Status code | Description | Response headers |
|
|
2504
|
+
|-------------|-------------|------------------|
|
|
2505
|
+
|**200** | Successful action | - |
|
|
2506
|
+
|
|
2507
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2508
|
+
|
|
2509
|
+
# **v2UpdateNode**
|
|
2510
|
+
> EmptySuccess v2UpdateNode(v2UpdateNodeRequest)
|
|
2511
|
+
|
|
2512
|
+
Update a node.
|
|
2513
|
+
|
|
2514
|
+
### Example
|
|
2515
|
+
|
|
2516
|
+
```typescript
|
|
2517
|
+
import {
|
|
2518
|
+
DefaultApi,
|
|
2519
|
+
Configuration,
|
|
2520
|
+
V2UpdateNodeRequest
|
|
2521
|
+
} from '@ourskyai/astro-api';
|
|
2522
|
+
|
|
2523
|
+
const configuration = new Configuration();
|
|
2524
|
+
const apiInstance = new DefaultApi(configuration);
|
|
2525
|
+
|
|
2526
|
+
let v2UpdateNodeRequest: V2UpdateNodeRequest; //
|
|
2527
|
+
|
|
2528
|
+
const { status, data } = await apiInstance.v2UpdateNode(
|
|
2529
|
+
v2UpdateNodeRequest
|
|
2530
|
+
);
|
|
2531
|
+
```
|
|
2532
|
+
|
|
2533
|
+
### Parameters
|
|
2534
|
+
|
|
2535
|
+
|Name | Type | Description | Notes|
|
|
2536
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2537
|
+
| **v2UpdateNodeRequest** | **V2UpdateNodeRequest**| | |
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
### Return type
|
|
2541
|
+
|
|
2542
|
+
**EmptySuccess**
|
|
2543
|
+
|
|
2544
|
+
### Authorization
|
|
2545
|
+
|
|
2546
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
2547
|
+
|
|
2548
|
+
### HTTP request headers
|
|
2549
|
+
|
|
2550
|
+
- **Content-Type**: application/json
|
|
2551
|
+
- **Accept**: application/json
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
### HTTP response details
|
|
2555
|
+
| Status code | Description | Response headers |
|
|
2556
|
+
|-------------|-------------|------------------|
|
|
2557
|
+
|**200** | Successful action | - |
|
|
2558
|
+
|
|
2559
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2560
|
+
|