@ourskyai/platform-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.
Files changed (189) hide show
  1. package/.openapi-generator/FILES +160 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +265 -4
  4. package/api.ts +1568 -5774
  5. package/base.ts +14 -24
  6. package/common.ts +20 -44
  7. package/configuration.ts +37 -17
  8. package/dist/api.d.ts +978 -5071
  9. package/dist/api.js +968 -1150
  10. package/dist/base.d.ts +11 -23
  11. package/dist/base.js +5 -18
  12. package/dist/common.d.ts +6 -37
  13. package/dist/common.js +18 -40
  14. package/dist/configuration.d.ts +30 -15
  15. package/dist/configuration.js +5 -3
  16. package/dist/esm/api.d.ts +978 -5071
  17. package/dist/esm/api.js +968 -1150
  18. package/dist/esm/base.d.ts +11 -23
  19. package/dist/esm/base.js +4 -17
  20. package/dist/esm/common.d.ts +6 -37
  21. package/dist/esm/common.js +16 -39
  22. package/dist/esm/configuration.d.ts +30 -15
  23. package/dist/esm/configuration.js +5 -3
  24. package/dist/esm/index.d.ts +1 -1
  25. package/dist/esm/index.js +1 -1
  26. package/dist/index.d.ts +1 -1
  27. package/dist/index.js +1 -1
  28. package/docs/CameraMode.md +10 -0
  29. package/docs/DefaultApi.md +3904 -0
  30. package/docs/EmptySuccess.md +20 -0
  31. package/docs/FilterType.md +60 -0
  32. package/docs/FitsHeader.md +22 -0
  33. package/docs/ImageSetType.md +24 -0
  34. package/docs/Location.md +25 -0
  35. package/docs/MetricType.md +14 -0
  36. package/docs/ModelType.md +10 -0
  37. package/docs/MountGeometry.md +10 -0
  38. package/docs/MountType.md +10 -0
  39. package/docs/NetworkInterface.md +15 -0
  40. package/docs/NodeState.md +20 -0
  41. package/docs/OrbitType.md +42 -0
  42. package/docs/PKICertificate.md +30 -0
  43. package/docs/PlateSolveParameters.md +26 -0
  44. package/docs/ShutterType.md +10 -0
  45. package/docs/StreakExtractionSource.md +35 -0
  46. package/docs/SuccessfulCreate.md +20 -0
  47. package/docs/TrackingType.md +12 -0
  48. package/docs/UploadPriority.md +10 -0
  49. package/docs/V1AccessToken.md +43 -0
  50. package/docs/V1AccessTokenType.md +12 -0
  51. package/docs/V1AllSkyCameraConfig.md +22 -0
  52. package/docs/V1AllSkyImageForImage.md +28 -0
  53. package/docs/V1AllSkyPrediction.md +30 -0
  54. package/docs/V1AllSkyPredictionLabel.md +16 -0
  55. package/docs/V1ApexChartsTimeline.md +20 -0
  56. package/docs/V1ApexChartsTimelineElement.md +24 -0
  57. package/docs/V1AssetSize.md +10 -0
  58. package/docs/V1AutoFocusInstruction.md +23 -0
  59. package/docs/V1AutoFocusInstructionCoordinatesInner.md +23 -0
  60. package/docs/V1BlackoutBox.md +26 -0
  61. package/docs/V1Camera.md +47 -0
  62. package/docs/V1CameraRollImage.md +34 -0
  63. package/docs/V1ClientToken.md +22 -0
  64. package/docs/V1CompleteNodeControllerCrashReportRequest.md +20 -0
  65. package/docs/V1CompleteNodeFlareRequest.md +20 -0
  66. package/docs/V1CompleteObservationRequest.md +20 -0
  67. package/docs/V1CreateAllSkyPredictionRequest.md +24 -0
  68. package/docs/V1CreateAutofocusResultRequest.md +28 -0
  69. package/docs/V1CreateImageMetadataRequest.md +26 -0
  70. package/docs/V1CreateImageSetImageRequest.md +32 -0
  71. package/docs/V1CreateImageSetImageResponse.md +23 -0
  72. package/docs/V1CreateImageSetImageUploadUrlRequest.md +26 -0
  73. package/docs/V1CreateImageSetImageUploadUrlResponse.md +20 -0
  74. package/docs/V1CreateImageSetRequest.md +28 -0
  75. package/docs/V1CreateNodeControllerArtifactRequest.md +20 -0
  76. package/docs/V1CreateNodeControllerCrashReportRequest.md +37 -0
  77. package/docs/V1CreateNodeControllerCrashReportResponse.md +22 -0
  78. package/docs/V1CreateNodeDiagnostic.md +28 -0
  79. package/docs/V1CreateNodeDiagnosticsRequest.md +22 -0
  80. package/docs/V1CreateNodeEvent.md +24 -0
  81. package/docs/V1CreateNodeEventsRequest.md +22 -0
  82. package/docs/V1CreateNodeFlareRequest.md +22 -0
  83. package/docs/V1CreateNodeFlareResponse.md +22 -0
  84. package/docs/V1CreateNodeRequest.md +37 -0
  85. package/docs/V1CreateProcessedImageSetImageRequest.md +67 -0
  86. package/docs/V1CreateTimeWindowedAssetRequest.md +34 -0
  87. package/docs/V1CreateTimeWindowedAssetResponse.md +22 -0
  88. package/docs/V1DataSource.md +10 -0
  89. package/docs/V1DiagnosticInstruction.md +21 -0
  90. package/docs/V1DisableDebugServices.md +22 -0
  91. package/docs/V1DurationMeasured.md +24 -0
  92. package/docs/V1ElevationMaskPoint.md +25 -0
  93. package/docs/V1EnableAutonomousOperation.md +22 -0
  94. package/docs/V1EnableDebugServices.md +26 -0
  95. package/docs/V1EnableManualOperation.md +22 -0
  96. package/docs/V1FileType.md +8 -0
  97. package/docs/V1Focuser.md +27 -0
  98. package/docs/V1GainCurve.md +25 -0
  99. package/docs/V1GainCurvePoint.md +22 -0
  100. package/docs/V1GenerateEdgeTokenResponse.md +22 -0
  101. package/docs/V1GetInstructionRequest.md +28 -0
  102. package/docs/V1GetInstructionRequestUploadHealth.md +24 -0
  103. package/docs/V1GetNodeCommandsResponse.md +20 -0
  104. package/docs/V1GetNodes.md +20 -0
  105. package/docs/V1GetOrCreateCameraRequest.md +60 -0
  106. package/docs/V1GetOrCreateFocuserRequest.md +24 -0
  107. package/docs/V1GetOrCreateMountRequest.md +24 -0
  108. package/docs/V1GetPlateSolveCatalogDiffRequest.md +20 -0
  109. package/docs/V1GetSuntimesResponse.md +36 -0
  110. package/docs/V1HFRStar.md +25 -0
  111. package/docs/V1ImageFileType.md +10 -0
  112. package/docs/V1ImageMetadata.md +32 -0
  113. package/docs/V1ImageRejectionReason.md +64 -0
  114. package/docs/V1ImageSet.md +43 -0
  115. package/docs/V1ImageSetImage.md +77 -0
  116. package/docs/V1ImageSetImageDot.md +45 -0
  117. package/docs/V1ImageSetImageStreak.md +57 -0
  118. package/docs/V1Instruction.md +31 -0
  119. package/docs/V1JobStatus.md +16 -0
  120. package/docs/V1LastInstructionResponse.md +24 -0
  121. package/docs/V1LatestHfrResponse.md +24 -0
  122. package/docs/V1LogRecorded.md +20 -0
  123. package/docs/V1MLModel.md +30 -0
  124. package/docs/V1MatchedStar.md +39 -0
  125. package/docs/V1Metric.md +30 -0
  126. package/docs/V1Mount.md +23 -0
  127. package/docs/V1Node.md +59 -0
  128. package/docs/V1NodeCommand.md +34 -0
  129. package/docs/V1NodeComponentType.md +34 -0
  130. package/docs/V1NodeConfigBody.md +20 -0
  131. package/docs/V1NodeConfigKeyMetadata.md +26 -0
  132. package/docs/V1NodeConfigScopeType.md +12 -0
  133. package/docs/V1NodeController.md +36 -0
  134. package/docs/V1NodeControllerArtifact.md +20 -0
  135. package/docs/V1NodeControllerBootstrapRequest.md +20 -0
  136. package/docs/V1NodeControllerIssueCertificateResponse.md +32 -0
  137. package/docs/V1NodeControllerIssueCertificateResponseRsaKeyPair.md +24 -0
  138. package/docs/V1NodeControllerMacAddressesInner.md +22 -0
  139. package/docs/V1NodeControllerStatus.md +13 -0
  140. package/docs/V1NodeDiagnosticType.md +80 -0
  141. package/docs/V1NodeEventType.md +32 -0
  142. package/docs/V1NodeFlare.md +25 -0
  143. package/docs/V1NodeWithLocation.md +23 -0
  144. package/docs/V1OAuthAuthorizeRequest.md +26 -0
  145. package/docs/V1OAuthAuthorizeResponse.md +20 -0
  146. package/docs/V1OAuthTokenRequest.md +24 -0
  147. package/docs/V1OAuthTokenResponse.md +22 -0
  148. package/docs/V1OTAEncryptionRequestLatest.md +20 -0
  149. package/docs/V1OTAEncryptionResult.md +30 -0
  150. package/docs/V1ObservationInstruction.md +79 -0
  151. package/docs/V1ObservationInstructionAscomAxisRates.md +35 -0
  152. package/docs/V1ObservationInstructionSatellitePassEphemerisInner.md +25 -0
  153. package/docs/V1ObservationMetrics.md +30 -0
  154. package/docs/V1OpticalTube.md +27 -0
  155. package/docs/V1PixelCoordinates.md +23 -0
  156. package/docs/V1PlateSolveCatalogFile.md +22 -0
  157. package/docs/V1PlateSolveCatalogFileDownload.md +26 -0
  158. package/docs/V1PlateSolveResult.md +40 -0
  159. package/docs/V1PlateSolveStatus.md +12 -0
  160. package/docs/V1PredictedStreakLocation.md +26 -0
  161. package/docs/V1PrincipalRoleType.md +20 -0
  162. package/docs/V1ProductRevision.md +12 -0
  163. package/docs/V1ReadNoisePoint.md +22 -0
  164. package/docs/V1RebootSystem.md +22 -0
  165. package/docs/V1RefreshCertificateRequest.md +20 -0
  166. package/docs/V1RegisterNodeControllerRequest.md +24 -0
  167. package/docs/V1RequestMacAddressesRequest.md +22 -0
  168. package/docs/V1RequestMacAddressesResponse.md +20 -0
  169. package/docs/V1RequestMacAddressesResponseMacAddressesInner.md +22 -0
  170. package/docs/V1ResolvedInstruction.md +85 -0
  171. package/docs/V1SIPCoefficients.md +40 -0
  172. package/docs/V1SafetyStatusUpdated.md +20 -0
  173. package/docs/V1SendFlare.md +40 -0
  174. package/docs/V1SetupAction.md +23 -0
  175. package/docs/V1SoftwarePackageType.md +8 -0
  176. package/docs/V1SoftwareRelease.md +34 -0
  177. package/docs/V1SoftwareRuntimeEnvironmentType.md +9 -0
  178. package/docs/V1SystemVariant.md +34 -0
  179. package/docs/V1TerrestrialDownlinkInstruction.md +33 -0
  180. package/docs/V1TimeWindowedAsset.md +37 -0
  181. package/docs/V1TimeWindowedAssetType.md +10 -0
  182. package/docs/V1Transformation.md +77 -0
  183. package/docs/V1UpdateNodeRequest.md +51 -0
  184. package/docs/V1VideoModeFramerateProperty.md +28 -0
  185. package/docs/V2CompleteObservationRequest.md +24 -0
  186. package/docs/V2NodeControllerIssueCertificateResponse.md +22 -0
  187. package/docs/V2UpdateNodeRequest.md +43 -0
  188. package/index.ts +1 -1
  189. package/package.json +4 -4
@@ -0,0 +1,30 @@
1
+ # V1OTAEncryptionResult
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **jobStatus** | [**V1JobStatus**](V1JobStatus.md) | | [default to undefined]
10
+ **createdAt** | **string** | | [default to undefined]
11
+ **startedAt** | **string** | | [optional] [default to undefined]
12
+ **finishedAt** | **string** | | [optional] [default to undefined]
13
+ **url** | **string** | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { V1OTAEncryptionResult } from '@ourskyai/platform-api';
19
+
20
+ const instance: V1OTAEncryptionResult = {
21
+ id,
22
+ jobStatus,
23
+ createdAt,
24
+ startedAt,
25
+ finishedAt,
26
+ url,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,79 @@
1
+ # V1ObservationInstruction
2
+
3
+ Observation Instruction
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | | [default to undefined]
10
+ **noradId** | **string** | | [optional] [default to undefined]
11
+ **orbitType** | [**OrbitType**](OrbitType.md) | | [optional] [default to undefined]
12
+ **imageSetId** | **string** | | [default to undefined]
13
+ **targetId** | **string** | | [default to undefined]
14
+ **trackingType** | [**TrackingType**](TrackingType.md) | | [default to undefined]
15
+ **exposureDuration** | **number** | | [default to undefined]
16
+ **binning** | **number** | | [default to undefined]
17
+ **gain** | **number** | | [default to undefined]
18
+ **gainMode** | **number** | | [default to undefined]
19
+ **gainOffset** | **number** | | [default to undefined]
20
+ **ra** | **number** | Represents the Right Ascension of the target at captureStart when `trackingType` is equal to `SIDEREAL`. When `trackingType` is equal to `TARGET_RATE`, however this is an offset from the RA and is better represented by the `tleOffsetRa` value. | [default to undefined]
21
+ **dec** | **number** | Represents the Declination of the target at captureStart when `trackingType` is equal to `SIDEREAL`. When `trackingType` is equal to `TARGET_RATE`, however this is an offset from the Dec and is better represented by the `tleOffsetDec` value. | [default to undefined]
22
+ **captureStart** | **string** | | [default to undefined]
23
+ **captureEnd** | **string** | | [default to undefined]
24
+ **preCaptureWait** | **number** | | [default to undefined]
25
+ **startSlewAt** | **string** | | [default to undefined]
26
+ **cameraMode** | [**CameraMode**](CameraMode.md) | | [default to undefined]
27
+ **tleName** | **string** | | [optional] [default to undefined]
28
+ **tleLine1** | **string** | | [default to undefined]
29
+ **tleLine2** | **string** | | [default to undefined]
30
+ **tleOffsetDec** | **number** | | [optional] [default to undefined]
31
+ **tleOffsetRa** | **number** | | [optional] [default to undefined]
32
+ **blackoutBoxes** | [**Array<V1BlackoutBox>**](V1BlackoutBox.md) | | [optional] [default to undefined]
33
+ **plateSolveParameters** | [**PlateSolveParameters**](PlateSolveParameters.md) | | [optional] [default to undefined]
34
+ **uploadPriority** | [**UploadPriority**](UploadPriority.md) | | [optional] [default to undefined]
35
+ **satellitePassEphemeris** | [**Array<V1ObservationInstructionSatellitePassEphemerisInner>**](V1ObservationInstructionSatellitePassEphemerisInner.md) | | [optional] [default to undefined]
36
+ **ascomAxisRates** | [**V1ObservationInstructionAscomAxisRates**](V1ObservationInstructionAscomAxisRates.md) | | [optional] [default to undefined]
37
+ **cadenceIntervalSeconds** | **number** | Minimum seconds between frame captures. Calculated by backend from node hardware constraints. Null means capture as fast as possible. | [optional] [default to undefined]
38
+ **maxImageCount** | **number** | Hard safety cap on total images for this observation. Calculated by backend. Node must stop after this many frames regardless of captureEnd. Null means no cap. | [optional] [default to undefined]
39
+
40
+ ## Example
41
+
42
+ ```typescript
43
+ import { V1ObservationInstruction } from '@ourskyai/platform-api';
44
+
45
+ const instance: V1ObservationInstruction = {
46
+ id,
47
+ noradId,
48
+ orbitType,
49
+ imageSetId,
50
+ targetId,
51
+ trackingType,
52
+ exposureDuration,
53
+ binning,
54
+ gain,
55
+ gainMode,
56
+ gainOffset,
57
+ ra,
58
+ dec,
59
+ captureStart,
60
+ captureEnd,
61
+ preCaptureWait,
62
+ startSlewAt,
63
+ cameraMode,
64
+ tleName,
65
+ tleLine1,
66
+ tleLine2,
67
+ tleOffsetDec,
68
+ tleOffsetRa,
69
+ blackoutBoxes,
70
+ plateSolveParameters,
71
+ uploadPriority,
72
+ satellitePassEphemeris,
73
+ ascomAxisRates,
74
+ cadenceIntervalSeconds,
75
+ maxImageCount,
76
+ };
77
+ ```
78
+
79
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,35 @@
1
+ # V1ObservationInstructionAscomAxisRates
2
+
3
+ ASCOM mount properties for rate tracking based on previous diagnostics
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **maxPrimarySpeed** | **number** | | [optional] [default to undefined]
10
+ **maxSecondarySpeed** | **number** | | [optional] [default to undefined]
11
+ **primarySignWest** | **number** | | [optional] [default to undefined]
12
+ **primarySignEast** | **number** | | [optional] [default to undefined]
13
+ **secondarySignWest** | **number** | | [optional] [default to undefined]
14
+ **secondarySignEast** | **number** | | [optional] [default to undefined]
15
+ **primaryReversed** | **boolean** | | [optional] [default to undefined]
16
+ **secondaryReversed** | **boolean** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { V1ObservationInstructionAscomAxisRates } from '@ourskyai/platform-api';
22
+
23
+ const instance: V1ObservationInstructionAscomAxisRates = {
24
+ maxPrimarySpeed,
25
+ maxSecondarySpeed,
26
+ primarySignWest,
27
+ primarySignEast,
28
+ secondarySignWest,
29
+ secondarySignEast,
30
+ primaryReversed,
31
+ secondaryReversed,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # V1ObservationInstructionSatellitePassEphemerisInner
2
+
3
+ Satellite position data in topocentric azimuth/elevation frame for the local observer
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **timeUtc** | **string** | | [optional] [default to undefined]
10
+ **azimuth** | **number** | | [optional] [default to undefined]
11
+ **elevation** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1ObservationInstructionSatellitePassEphemerisInner } from '@ourskyai/platform-api';
17
+
18
+ const instance: V1ObservationInstructionSatellitePassEphemerisInner = {
19
+ timeUtc,
20
+ azimuth,
21
+ elevation,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,30 @@
1
+ # V1ObservationMetrics
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **waitingForSlewMountMs** | **number** | | [default to undefined]
9
+ **slewMountMs** | **number** | | [default to undefined]
10
+ **centerMountMs** | **number** | | [default to undefined]
11
+ **waitingForCaptureImagesMs** | **number** | | [default to undefined]
12
+ **missedCaptureImagesMs** | **number** | | [default to undefined]
13
+ **captureImagesMs** | **number** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { V1ObservationMetrics } from '@ourskyai/platform-api';
19
+
20
+ const instance: V1ObservationMetrics = {
21
+ waitingForSlewMountMs,
22
+ slewMountMs,
23
+ centerMountMs,
24
+ waitingForCaptureImagesMs,
25
+ missedCaptureImagesMs,
26
+ captureImagesMs,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # V1OpticalTube
2
+
3
+ Optical Tube
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | | [default to undefined]
10
+ **model** | **string** | | [default to undefined]
11
+ **focalLengthMm** | **number** | | [default to undefined]
12
+ **apertureMm** | **number** | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { V1OpticalTube } from '@ourskyai/platform-api';
18
+
19
+ const instance: V1OpticalTube = {
20
+ id,
21
+ model,
22
+ focalLengthMm,
23
+ apertureMm,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # V1PixelCoordinates
2
+
3
+ An (x,y) pixel location in the image
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **x** | **number** | | [default to undefined]
10
+ **y** | **number** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1PixelCoordinates } from '@ourskyai/platform-api';
16
+
17
+ const instance: V1PixelCoordinates = {
18
+ x,
19
+ y,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # V1PlateSolveCatalogFile
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [default to undefined]
9
+ **base64Sha256Checksum** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1PlateSolveCatalogFile } from '@ourskyai/platform-api';
15
+
16
+ const instance: V1PlateSolveCatalogFile = {
17
+ name,
18
+ base64Sha256Checksum,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # V1PlateSolveCatalogFileDownload
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [default to undefined]
9
+ **url** | **string** | | [default to undefined]
10
+ **base64Sha256Checksum** | **string** | | [default to undefined]
11
+ **action** | **string** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1PlateSolveCatalogFileDownload } from '@ourskyai/platform-api';
17
+
18
+ const instance: V1PlateSolveCatalogFileDownload = {
19
+ name,
20
+ url,
21
+ base64Sha256Checksum,
22
+ action,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,40 @@
1
+ # V1PlateSolveResult
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | [**V1PlateSolveStatus**](V1PlateSolveStatus.md) | | [optional] [default to undefined]
9
+ **matchedStars** | [**Array<V1MatchedStar>**](V1MatchedStar.md) | | [optional] [default to undefined]
10
+ **pixelWidth** | **number** | The number of pixels in X directions | [default to undefined]
11
+ **pixelHeight** | **number** | The number of pixels in Y directions | [default to undefined]
12
+ **numberMatchedStars** | **number** | The number of matched stars | [default to undefined]
13
+ **centerRightAscensionRadians** | **number** | In radians, the exact RA center when matched | [default to undefined]
14
+ **centerDeclinationRadians** | **number** | In radians, the exact Dec center when matched | [default to undefined]
15
+ **xSizeRadians** | **number** | The approximate plate size in X-direction, in radians | [default to undefined]
16
+ **ySizeRadians** | **number** | The approximate plate size in Y-direction, in radians | [default to undefined]
17
+ **isMatched** | **boolean** | True if there is a valid plate match | [default to undefined]
18
+ **transformation** | [**V1Transformation**](V1Transformation.md) | | [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { V1PlateSolveResult } from '@ourskyai/platform-api';
24
+
25
+ const instance: V1PlateSolveResult = {
26
+ status,
27
+ matchedStars,
28
+ pixelWidth,
29
+ pixelHeight,
30
+ numberMatchedStars,
31
+ centerRightAscensionRadians,
32
+ centerDeclinationRadians,
33
+ xSizeRadians,
34
+ ySizeRadians,
35
+ isMatched,
36
+ transformation,
37
+ };
38
+ ```
39
+
40
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # V1PlateSolveStatus
2
+
3
+
4
+ ## Enum
5
+
6
+ * `MATCH_FOUND` (value: `'MATCH_FOUND'`)
7
+
8
+ * `NO_MATCH_FOUND` (value: `'NO_MATCH_FOUND'`)
9
+
10
+ * `CANCELLED` (value: `'CANCELLED'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # V1PredictedStreakLocation
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **startX** | **number** | | [optional] [default to undefined]
9
+ **startY** | **number** | | [optional] [default to undefined]
10
+ **endX** | **number** | | [optional] [default to undefined]
11
+ **endY** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { V1PredictedStreakLocation } from '@ourskyai/platform-api';
17
+
18
+ const instance: V1PredictedStreakLocation = {
19
+ startX,
20
+ startY,
21
+ endX,
22
+ endY,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # V1PrincipalRoleType
2
+
3
+
4
+ ## Enum
5
+
6
+ * `ADMIN` (value: `'ADMIN'`)
7
+
8
+ * `SERVICE` (value: `'SERVICE'`)
9
+
10
+ * `ASTRO_USER` (value: `'ASTRO_USER'`)
11
+
12
+ * `CUSTOMER_ADMIN` (value: `'CUSTOMER_ADMIN'`)
13
+
14
+ * `NODE_CONTROLLER` (value: `'NODE_CONTROLLER'`)
15
+
16
+ * `ORBIT_SOURCE_PROVIDER` (value: `'ORBIT_SOURCE_PROVIDER'`)
17
+
18
+ * `UNKNOWN` (value: `'UNKNOWN'`)
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,12 @@
1
+ # V1ProductRevision
2
+
3
+
4
+ ## Enum
5
+
6
+ * `EC_01` (value: `'EC_01'`)
7
+
8
+ * `OPM_IGUANA` (value: `'OPM_IGUANA'`)
9
+
10
+ * `CAMERA_MANTIS` (value: `'CAMERA_MANTIS'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # V1ReadNoisePoint
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **gain** | **number** | | [default to undefined]
9
+ **eRMS** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1ReadNoisePoint } from '@ourskyai/platform-api';
15
+
16
+ const instance: V1ReadNoisePoint = {
17
+ gain,
18
+ eRMS,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # V1RebootSystem
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **nodeId** | **string** | | [default to undefined]
9
+ **executableAt** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1RebootSystem } from '@ourskyai/platform-api';
15
+
16
+ const instance: V1RebootSystem = {
17
+ nodeId,
18
+ executableAt,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # V1RefreshCertificateRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **lineageId** | **string** | Optional lineageId of the node controller. Required for ADMIN role, ignored for NODE_CONTROLLER role. | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { V1RefreshCertificateRequest } from '@ourskyai/platform-api';
14
+
15
+ const instance: V1RefreshCertificateRequest = {
16
+ lineageId,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # V1RegisterNodeControllerRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **chipSerialNumber** | **number** | | [default to undefined]
9
+ **hardwareRevision** | **number** | Monotonically increasing numeric identifier for the board type. Matches the `HardwareRevision` enum reported by hardware-daemon. Optional for backwards compatibility — controllers shipped before this field existed do not report it, and the server backfills them to the default revision (EB5G2_STARFIELD, EC_01). | [optional] [default to undefined]
10
+ **interfaces** | [**Array<NetworkInterface>**](NetworkInterface.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { V1RegisterNodeControllerRequest } from '@ourskyai/platform-api';
16
+
17
+ const instance: V1RegisterNodeControllerRequest = {
18
+ chipSerialNumber,
19
+ hardwareRevision,
20
+ interfaces,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # V1RequestMacAddressesRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **lineageId** | **string** | | [default to undefined]
9
+ **interfaces** | [**Array<NetworkInterface>**](NetworkInterface.md) | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1RequestMacAddressesRequest } from '@ourskyai/platform-api';
15
+
16
+ const instance: V1RequestMacAddressesRequest = {
17
+ lineageId,
18
+ interfaces,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # V1RequestMacAddressesResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **macAddresses** | [**Array<V1RequestMacAddressesResponseMacAddressesInner>**](V1RequestMacAddressesResponseMacAddressesInner.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { V1RequestMacAddressesResponse } from '@ourskyai/platform-api';
14
+
15
+ const instance: V1RequestMacAddressesResponse = {
16
+ macAddresses,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # V1RequestMacAddressesResponseMacAddressesInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **macAddress** | **string** | The MAC address of the node controller. | [default to undefined]
9
+ **_interface** | [**NetworkInterface**](NetworkInterface.md) | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { V1RequestMacAddressesResponseMacAddressesInner } from '@ourskyai/platform-api';
15
+
16
+ const instance: V1RequestMacAddressesResponseMacAddressesInner = {
17
+ macAddress,
18
+ _interface,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,85 @@
1
+ # V1ResolvedInstruction
2
+
3
+ Resolved Observation Instruction with additional resolution fields
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | | [default to undefined]
10
+ **noradId** | **string** | | [optional] [default to undefined]
11
+ **orbitType** | [**OrbitType**](OrbitType.md) | | [optional] [default to undefined]
12
+ **imageSetId** | **string** | | [default to undefined]
13
+ **targetId** | **string** | | [default to undefined]
14
+ **trackingType** | [**TrackingType**](TrackingType.md) | | [default to undefined]
15
+ **exposureDuration** | **number** | | [default to undefined]
16
+ **binning** | **number** | | [default to undefined]
17
+ **gain** | **number** | | [default to undefined]
18
+ **gainMode** | **number** | | [default to undefined]
19
+ **gainOffset** | **number** | | [default to undefined]
20
+ **ra** | **number** | Represents the Right Ascension of the target at captureStart when `trackingType` is equal to `SIDEREAL`. When `trackingType` is equal to `TARGET_RATE`, however this is an offset from the RA and is better represented by the `tleOffsetRa` value. | [default to undefined]
21
+ **dec** | **number** | Represents the Declination of the target at captureStart when `trackingType` is equal to `SIDEREAL`. When `trackingType` is equal to `TARGET_RATE`, however this is an offset from the Dec and is better represented by the `tleOffsetDec` value. | [default to undefined]
22
+ **captureStart** | **string** | | [default to undefined]
23
+ **captureEnd** | **string** | | [default to undefined]
24
+ **preCaptureWait** | **number** | | [default to undefined]
25
+ **startSlewAt** | **string** | | [default to undefined]
26
+ **cameraMode** | [**CameraMode**](CameraMode.md) | | [default to undefined]
27
+ **tleName** | **string** | | [optional] [default to undefined]
28
+ **tleLine1** | **string** | | [default to undefined]
29
+ **tleLine2** | **string** | | [default to undefined]
30
+ **tleOffsetDec** | **number** | | [optional] [default to undefined]
31
+ **tleOffsetRa** | **number** | | [optional] [default to undefined]
32
+ **blackoutBoxes** | [**Array<V1BlackoutBox>**](V1BlackoutBox.md) | | [optional] [default to undefined]
33
+ **plateSolveParameters** | [**PlateSolveParameters**](PlateSolveParameters.md) | | [optional] [default to undefined]
34
+ **uploadPriority** | [**UploadPriority**](UploadPriority.md) | | [optional] [default to undefined]
35
+ **satellitePassEphemeris** | [**Array<V1ObservationInstructionSatellitePassEphemerisInner>**](V1ObservationInstructionSatellitePassEphemerisInner.md) | | [optional] [default to undefined]
36
+ **ascomAxisRates** | [**V1ObservationInstructionAscomAxisRates**](V1ObservationInstructionAscomAxisRates.md) | | [optional] [default to undefined]
37
+ **cadenceIntervalSeconds** | **number** | Minimum seconds between frame captures. Calculated by backend from node hardware constraints. Null means capture as fast as possible. | [optional] [default to undefined]
38
+ **maxImageCount** | **number** | Hard safety cap on total images for this observation. Calculated by backend. Node must stop after this many frames regardless of captureEnd. Null means no cap. | [optional] [default to undefined]
39
+ **cropSizeWidthPx** | **number** | x size of the square cropped area, in pixels | [optional] [default to undefined]
40
+ **cropSizeHeightPx** | **number** | y size of the square cropped area, in pixels | [optional] [default to undefined]
41
+ **resolvedImageAutoExposure** | **boolean** | Whether the resolved image should be auto-exposed | [default to undefined]
42
+
43
+ ## Example
44
+
45
+ ```typescript
46
+ import { V1ResolvedInstruction } from '@ourskyai/platform-api';
47
+
48
+ const instance: V1ResolvedInstruction = {
49
+ id,
50
+ noradId,
51
+ orbitType,
52
+ imageSetId,
53
+ targetId,
54
+ trackingType,
55
+ exposureDuration,
56
+ binning,
57
+ gain,
58
+ gainMode,
59
+ gainOffset,
60
+ ra,
61
+ dec,
62
+ captureStart,
63
+ captureEnd,
64
+ preCaptureWait,
65
+ startSlewAt,
66
+ cameraMode,
67
+ tleName,
68
+ tleLine1,
69
+ tleLine2,
70
+ tleOffsetDec,
71
+ tleOffsetRa,
72
+ blackoutBoxes,
73
+ plateSolveParameters,
74
+ uploadPriority,
75
+ satellitePassEphemeris,
76
+ ascomAxisRates,
77
+ cadenceIntervalSeconds,
78
+ maxImageCount,
79
+ cropSizeWidthPx,
80
+ cropSizeHeightPx,
81
+ resolvedImageAutoExposure,
82
+ };
83
+ ```
84
+
85
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)