@ourskyai/node_platform-api 1.4.123

package/docs/V1ResetRotatorMotorSystemSettingsToDefaultRequest.md

@@ -0,0 +1,27 @@
+# V1ResetRotatorMotorSystemSettingsToDefaultRequest
+
+Specifies which rotator motor settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accelerationDegreesPerSecondSquared** | **boolean** | When true, resets the acceleration setting for the specific motor to its factory default value. | [optional] [default to undefined]
+**negativeLimitDegrees** | **boolean** | When true, resets the negative travel limit setting for the specific motor to its factory default value. | [optional] [default to undefined]
+**positiveLimitDegrees** | **boolean** | When true, resets the positive travel limit setting for the specific motor to its factory default value. | [optional] [default to undefined]
+**velocityDegreesPerSecond** | **boolean** | When true, resets the slew velocity setting for the specific motor to its factory default value. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1ResetRotatorMotorSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1ResetRotatorMotorSystemSettingsToDefaultRequest = {
+    accelerationDegreesPerSecondSquared,
+    negativeLimitDegrees,
+    positiveLimitDegrees,
+    velocityDegreesPerSecond,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ResetRotatorSystemSettingsToDefaultRequest.md

@@ -0,0 +1,23 @@
+# V1ResetRotatorSystemSettingsToDefaultRequest
+
+Specifies which rotator settings should be reset to their factory default values. Set each flag to true to reset that particular setting.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rotatorA** | [**V1ResetRotatorMotorSystemSettingsToDefaultRequest**](V1ResetRotatorMotorSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+**rotatorB** | [**V1ResetRotatorMotorSystemSettingsToDefaultRequest**](V1ResetRotatorMotorSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1ResetRotatorSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1ResetRotatorSystemSettingsToDefaultRequest = {
+    rotatorA,
+    rotatorB,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1ResetSystemSettingsToDefaultRequest.md

@@ -0,0 +1,27 @@
+# V1ResetSystemSettingsToDefaultRequest
+
+Request specifying which system settings should be reset to their factory default values. Include only the subsystems and settings you want to reset.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enclosure** | [**V1ResetEnclosureSystemSettingsToDefaultRequest**](V1ResetEnclosureSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+**focuser** | [**V1ResetFocuserSystemSettingsToDefaultRequest**](V1ResetFocuserSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+**mount** | [**V1ResetMountSystemSettingsToDefaultRequest**](V1ResetMountSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+**rotator** | [**V1ResetRotatorSystemSettingsToDefaultRequest**](V1ResetRotatorSystemSettingsToDefaultRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1ResetSystemSettingsToDefaultRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1ResetSystemSettingsToDefaultRequest = {
+    enclosure,
+    focuser,
+    mount,
+    rotator,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RoofStatus.md

@@ -0,0 +1,27 @@
+# V1RoofStatus
+
+Contains the complete status information for the roll-off roof system (deprecated, see V1EnclosureStatus). This object provides connectivity, operational state, and panel positions for legacy integrations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connected** | **boolean** | Indicates whether the roof controller is currently connected and communicating. A false value means commands cannot be sent to the roof system. | [default to undefined]
+**frontPosition** | **number** | The current position of the front roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations. | [default to undefined]
+**rearPosition** | **number** | The current position of the rear roof panel as encoder counts. Higher values indicate more open positions. Use this to track movement progress during open/close operations. | [default to undefined]
+**state** | [**RoofState**](RoofState.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1RoofStatus } from '@ourskyai/node_platform-api';
+
+const instance: V1RoofStatus = {
+    connected,
+    frontPosition,
+    rearPosition,
+    state,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RotatorMotorSystemSettings.md

@@ -0,0 +1,27 @@
+# V1RotatorMotorSystemSettings
+
+Configuration settings for a rotator motor including slew speed, acceleration, and negative and positive travel limits in degrees.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accelerationDegreesPerSecondSquared** | **number** | Maximum acceleration of the motor in degrees per second squared. Controls how quickly the motor ramps up to slew speed. | [optional] [default to undefined]
+**negativeLimitDegrees** | **number** | Negative travel limit of the motor in degrees. The motor should not move below this position. | [optional] [default to undefined]
+**positiveLimitDegrees** | **number** | Positive travel limit of the motor in degrees. The motor should not move above this position. | [optional] [default to undefined]
+**velocityDegreesPerSecond** | **number** | Maximum slew velocity of the motor in degrees per second. Higher values enable faster positioning but may reduce accuracy or increase mechanical stress. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1RotatorMotorSystemSettings } from '@ourskyai/node_platform-api';
+
+const instance: V1RotatorMotorSystemSettings = {
+    accelerationDegreesPerSecondSquared,
+    negativeLimitDegrees,
+    positiveLimitDegrees,
+    velocityDegreesPerSecond,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RotatorSelectorRequest.md

@@ -0,0 +1,21 @@
+# V1RotatorSelectorRequest
+
+Optional rotator selector. If omitted, the default rotator is used.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rotatorId** | **string** | Unique identifier of the rotator to command. Obtain valid rotator IDs from the rotator statuses endpoint. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1RotatorSelectorRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1RotatorSelectorRequest = {
+    rotatorId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RotatorStatus.md

@@ -0,0 +1,33 @@
+# V1RotatorStatus
+
+Current operational status of the field rotator including position, movement state, and de-rotation compensation mode.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**canHome** | **boolean** | Indicates whether the rotator supports a homing operation. When false, the home command is unavailable for this device and the UI should not offer it. | [optional] [default to undefined]
+**connected** | **boolean** | Indicates whether the rotator is currently connected and communicating. When false, rotator commands will fail and position data may be stale. | [default to undefined]
+**hasHomed** | **boolean** | Indicates whether the rotator has successfully completed a homing procedure since power-on. When false, the mechanical reference position is not yet established and positions may be unreliable until the rotator is homed. | [optional] [default to undefined]
+**id** | **string** | Unique identifier of the rotator within the system. | [optional] [default to undefined]
+**isDerotationEnabled** | **boolean** | Indicates whether automatic field de-rotation compensation is active. When true, the rotator continuously adjusts to maintain consistent sky orientation. | [optional] [default to undefined]
+**moving** | **boolean** | Indicates whether the rotator is currently in motion. True during position changes or active de-rotation compensation adjustments. | [default to undefined]
+**position** | [**RotatorPosition**](RotatorPosition.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1RotatorStatus } from '@ourskyai/node_platform-api';
+
+const instance: V1RotatorStatus = {
+    canHome,
+    connected,
+    hasHomed,
+    id,
+    isDerotationEnabled,
+    moving,
+    position,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RotatorStatuses.md

@@ -0,0 +1,21 @@
+# V1RotatorStatuses
+
+Container object holding the list of all rotator statuses.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statuses** | [**Array<V1RotatorStatus>**](V1RotatorStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1RotatorStatuses } from '@ourskyai/node_platform-api';
+
+const instance: V1RotatorStatuses = {
+    statuses,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RotatorSystemSettings.md

@@ -0,0 +1,23 @@
+# V1RotatorSystemSettings
+
+Configuration settings for rotator motors including slew speed, acceleration, and travel limits in degrees.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rotatorA** | [**V1RotatorMotorSystemSettings**](V1RotatorMotorSystemSettings.md) |  | [optional] [default to undefined]
+**rotatorB** | [**V1RotatorMotorSystemSettings**](V1RotatorMotorSystemSettings.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1RotatorSystemSettings } from '@ourskyai/node_platform-api';
+
+const instance: V1RotatorSystemSettings = {
+    rotatorA,
+    rotatorB,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RunAutofocusRequest.md

@@ -0,0 +1,32 @@
+# V1RunAutofocusRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**autofocusMethods** | [**Array<AutofocusMethod>**](AutofocusMethod.md) | The autofocus method to use | [optional] [default to undefined]
+**blindFallback** | **boolean** | Whether to find the focus position using a blind search | [default to false]
+**focuserId** | **string** | Unique identifier of the focuser to use for autofocus. If omitted, the default focuser is used. | [optional] [default to undefined]
+**maxSteps** | **number** | The number of steps to measure for the run | [optional] [default to undefined]
+**rSquaredThreshold** | **number** | The r-squared threshold to use for the autofocus | [optional] [default to 0.7]
+**startPosition** | **number** | The starting position of the focuser | [optional] [default to undefined]
+**stepSize** | **number** | The step size to use for moving the focuser | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1RunAutofocusRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1RunAutofocusRequest = {
+    autofocusMethods,
+    blindFallback,
+    focuserId,
+    maxSteps,
+    rSquaredThreshold,
+    startPosition,
+    stepSize,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1RunBlindAutofocusRequest.md

@@ -0,0 +1,24 @@
+# V1RunBlindAutofocusRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**focuserId** | **string** | Unique identifier of the focuser to use for blind autofocus. If omitted, the default focuser is used. | [optional] [default to undefined]
+**rSquaredThreshold** | **number** | The r-squared threshold to use for the blind autofocus | [optional] [default to 0.7]
+**stepSize** | **number** | The step size to use for moving the focuser | [default to undefined]
+
+## Example
+
+```typescript
+import { V1RunBlindAutofocusRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1RunBlindAutofocusRequest = {
+    focuserId,
+    rSquaredThreshold,
+    stepSize,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SafetyStatus.md

@@ -0,0 +1,33 @@
+# V1SafetyStatus
+
+Comprehensive safety assessment for the observatory including individual safety factors and overall status. This information is critical for determining whether conditions allow safe telescope operations.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isAllSkySafe** | **boolean** | Indicates whether the all-sky camera analysis shows safe sky conditions. This includes cloud cover assessment and sky brightness. False suggests cloudy or otherwise unsuitable sky conditions. | [default to undefined]
+**isAlpacaSafe** | **boolean** | Indicates the safety status as reported by ALPACA-compatible safety devices. This provides an additional safety signal from external safety monitoring equipment when available. | [optional] [default to undefined]
+**isManualOperationMode** | **boolean** | Indicates whether the observatory is in manual operation mode. When true, safety interlocks may be overridden to allow manual control. Use with caution as automated safety protections are reduced. | [default to undefined]
+**isNight** | **boolean** | Indicates whether it is currently astronomical night at the observatory location. True means the sun is sufficiently below the horizon for observations. The threshold is typically astronomical twilight. | [default to undefined]
+**isRoofOpen** | **boolean** | Indicates whether the enclosure roof or shutters are currently open. True means the telescope has sky access. This is informational and does not directly affect the safety determination. | [default to undefined]
+**isSafe** | **boolean** | The overall safety determination combining all safety factors. True indicates conditions are safe for observations with the enclosure open. False indicates at least one safety condition is not met and the enclosure should remain closed or be closed. | [default to undefined]
+**isWeatherSafe** | **boolean** | Indicates whether current weather conditions are safe for observations. Factors include wind speed, humidity, rain detection, and temperature. False will contribute to an unsafe overall status. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SafetyStatus } from '@ourskyai/node_platform-api';
+
+const instance: V1SafetyStatus = {
+    isAllSkySafe,
+    isAlpacaSafe,
+    isManualOperationMode,
+    isNight,
+    isRoofOpen,
+    isSafe,
+    isWeatherSafe,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SaveImageRequest.md

@@ -0,0 +1,21 @@
+# V1SaveImageRequest
+
+Request object to mark an image as saved and protected from automatic deletion. Contains the identifier of the image to preserve.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier of the image to save. Once saved, the image will not be automatically deleted during storage cleanup operations. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SaveImageRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SaveImageRequest = {
+    id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SaveVideoRequest.md

@@ -0,0 +1,21 @@
+# V1SaveVideoRequest
+
+Request object to mark a video as saved and protected from automatic deletion. Contains the identifier of the video to preserve.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier of the video to save. Once saved, the video will not be automatically deleted during storage cleanup operations. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SaveVideoRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SaveVideoRequest = {
+    id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetEnclosureHvacFanSpeedRequest.md

@@ -0,0 +1,21 @@
+# V1SetEnclosureHvacFanSpeedRequest
+
+Request to set the HVAC unit fan speed.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fanSpeed** | [**EnclosureHvacFanSpeed**](EnclosureHvacFanSpeed.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetEnclosureHvacFanSpeedRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetEnclosureHvacFanSpeedRequest = {
+    fanSpeed,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetEnclosureHvacModeRequest.md

@@ -0,0 +1,21 @@
+# V1SetEnclosureHvacModeRequest
+
+Request to set the HVAC unit operating mode.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mode** | [**EnclosureHvacMode**](EnclosureHvacMode.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetEnclosureHvacModeRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetEnclosureHvacModeRequest = {
+    mode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetEnclosureHvacTargetTemperatureRequest.md

@@ -0,0 +1,21 @@
+# V1SetEnclosureHvacTargetTemperatureRequest
+
+Request to set the HVAC unit target temperature in degrees Celsius.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetTemperatureCelsius** | **number** | Target temperature setpoint in degrees Celsius. Valid ranges depend on mode: Cool 18-32, Heat 16-30, Auto 18-30. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetEnclosureHvacTargetTemperatureRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetEnclosureHvacTargetTemperatureRequest = {
+    targetTemperatureCelsius,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetMountParkPositionRequest.md

@@ -0,0 +1,23 @@
+# V1SetMountParkPositionRequest
+
+Request to set the mount park position using specific motor coordinates. The park position defines where the mount will move when the park command is issued.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**motorAPositionDegrees** | **number** | Target position for motor A (azimuth/RA axis) in degrees. This is the raw motor position the mount will move to when parking. | [default to undefined]
+**motorBPositionDegrees** | **number** | Target position for motor B (altitude/Dec axis) in degrees. This is the raw motor position the mount will move to when parking. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetMountParkPositionRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetMountParkPositionRequest = {
+    motorAPositionDegrees,
+    motorBPositionDegrees,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetOpticalTubeHeaterPowerRequest.md

@@ -0,0 +1,25 @@
+# V1SetOpticalTubeHeaterPowerRequest
+
+Request to set the power level for a specific dew heater identified by its role.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opticalTubeId** | **string** | Unique identifier of the optical tube whose heater power should be set. If omitted, the default optical tube is used. | [optional] [default to undefined]
+**power** | **number** | Heater power level as a percentage from 0 (off) to 100 (full power). Adjust based on environmental conditions to balance dew prevention with thermal effects on imaging. | [default to undefined]
+**role** | [**V1OpticalTubeHeaterRole**](V1OpticalTubeHeaterRole.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetOpticalTubeHeaterPowerRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetOpticalTubeHeaterPowerRequest = {
+    opticalTubeId,
+    power,
+    role,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetPeerStatusRequest.md

@@ -0,0 +1,29 @@
+# V1SetPeerStatusRequest
+
+Set peer status request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraId** | **string** | Optional camera identifier for multi-camera nodes | [optional] [default to undefined]
+**meta** | **{ [key: string]: string; }** | Optional metadata map | [optional] [default to undefined]
+**peerId** | **string** | optional peer ID | [optional] [default to undefined]
+**roles** | [**Array<PeerRole>**](PeerRole.md) | List of roles for the peer | [default to undefined]
+**type** | **string** | Type of message | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetPeerStatusRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetPeerStatusRequest = {
+    cameraId,
+    meta,
+    peerId,
+    roles,
+    type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SetRelayStateRequest.md

@@ -0,0 +1,23 @@
+# V1SetRelayStateRequest
+
+Request parameters for setting the power state of a specific relay channel (deprecated). Use this to turn equipment on or off by specifying the channel and desired state.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel** | [**RelayChannel**](RelayChannel.md) |  | [default to undefined]
+**relayOn** | **boolean** | The desired power state for the relay. True turns power on to the equipment, false turns power off. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1SetRelayStateRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SetRelayStateRequest = {
+    channel,
+    relayOn,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SignalMessageRequest.md

@@ -0,0 +1,27 @@
+# V1SignalMessageRequest
+
+WebRTC Signaling message (SDP or ICE)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ice** | [**IceMessage**](IceMessage.md) |  | [optional] [default to undefined]
+**sdp** | [**SdpMessage**](SdpMessage.md) |  | [optional] [default to undefined]
+**sessionId** | **string** | session ID | [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1SignalMessageRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SignalMessageRequest = {
+    ice,
+    sdp,
+    sessionId,
+    type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1SignallingRequest.md

@@ -0,0 +1,40 @@
+# V1SignallingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraId** | **string** | Optional camera identifier for multi-camera nodes | [optional] [default to undefined]
+**meta** | **{ [key: string]: string; }** | Optional metadata map | [optional] [default to undefined]
+**peerId** | **string** | optional consumer ID | [default to undefined]
+**roles** | [**Array<PeerRole>**](PeerRole.md) | List of roles for the peer | [default to undefined]
+**lineageId** | **string** | Node to get list of producers from | [optional] [default to undefined]
+**type** | [**MessageType**](MessageType.md) |  | [default to undefined]
+**producers** | [**Array<Peer>**](Peer.md) | list of peers | [default to undefined]
+**consumerId** | **string** | optional consumer ID | [optional] [default to undefined]
+**sessionId** | **string** | session ID | [default to undefined]
+**ice** | [**IceMessage**](IceMessage.md) |  | [optional] [default to undefined]
+**sdp** | [**SdpMessage**](SdpMessage.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1SignallingRequest } from '@ourskyai/node_platform-api';
+
+const instance: V1SignallingRequest = {
+    cameraId,
+    meta,
+    peerId,
+    roles,
+    lineageId,
+    type,
+    producers,
+    consumerId,
+    sessionId,
+    ice,
+    sdp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/V1StackedAstroImage.md

@@ -0,0 +1,25 @@
+# V1StackedAstroImage
+
+Complete metadata for a stacked astro image including timing information and the associated image file reference.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** | ISO 8601 timestamp indicating when this stacked astro image record was created in the database. Used for pagination with the before parameter. | [default to undefined]
+**id** | **string** | Unique identifier for this stacked astro image. Use this ID with the file endpoint to download the actual image data or with other image-related operations. | [default to undefined]
+**image** | [**V1Image**](V1Image.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1StackedAstroImage } from '@ourskyai/node_platform-api';
+
+const instance: V1StackedAstroImage = {
+    createdAt,
+    id,
+    image,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)