ring

type AuthContext struct {
	AccessToken string
	HardwareID  string
}

type AuthenticateRequest struct {
	Username   string
	Password   string
	OTPCode    string
	HardwareID string
}

type BatteryReading float64

type CapturedTickets struct {
	Host               string   `json:"host"`
	Ticket             string   `json:"ticket"`
	SubscriptionTopics []string `json:"subscriptionTopics,omitempty"`
}

type CapturedTicketsParams struct {
	AllowUserOnly                    *bool
	LocationID                       *string
	LocationSubscription             *string
	EnableExtendedEmergencyCellUsage *bool
	RequestedTransport               *SignalingTransport
}

type Client struct {
	// contains filtered or unexported fields
}

type ClientAPI interface {
	// Close is retained for source compatibility; returned connections and
	// sessions have their own Close methods and lifetimes.
	Close() error

	// Authentication and authorization
	Authenticate(ctx context.Context, request AuthenticateRequest) (*ringapimodels.AuthResponse, error)
	Request2FACode(ctx context.Context, request Request2FACodeRequest) error
	RefreshToken(ctx context.Context, request RefreshTokenRequest) (*ringapimodels.AuthResponse, error)
	NewLoginSession(request LoginSessionRequest) (*LoginSession, error)

	// APIs for enumerating and getting data
	ListDevices(ctx context.Context, request ListDevicesRequest) (*ringapimodels.DevicesResponse, error)
	GetDevice(ctx context.Context, request GetDeviceRequest) (*ringapimodels.Device, error)
	GetDeviceSettings(ctx context.Context, request GetDeviceSettingsRequest) (DeviceSettings, error)
	GetDeviceDetail(ctx context.Context, request GetDeviceDetailRequest) (*DeviceDetail, error)
	GetDeviceStatus(ctx context.Context, request GetDeviceDetailRequest) (*DeviceStatus, error)
	ListLocations(ctx context.Context, request ListLocationsRequest) (*LocationList, error)
	GetLocation(ctx context.Context, request GetLocationRequest) (*LocationDetail, error)
	ListLocationGroups(ctx context.Context, request LocationRequest) (*LocationGroups, error)
	ListLocationDevices(ctx context.Context, request LocationRequest) (*LocationGroupDevices, error)
	GetDeviceTimeline(ctx context.Context, request GetDeviceTimelineRequest) (*DeviceTimeline, error)
	GetHistoryDevices(ctx context.Context, request GetHistoryDevicesRequest) (*HistoryDevices, error)
	GetCapturedTickets(ctx context.Context, request GetCapturedTicketsRequest) (*CapturedTickets, error)

	// APIs for modifying or sending requests to a device
	UpdateDeviceHealth(ctx context.Context, request UpdateDeviceHealthRequest) (*ringapimodels.DeviceHealth, error)
	PatchDeviceSettings(ctx context.Context, request PatchDeviceSettingsRequest) error
	GetSnapshot(ctx context.Context, request GetSnapshotRequest) (*Snapshot, error)
	SetVolume(ctx context.Context, request SetVolumeRequest) error
	SetLights(ctx context.Context, request SetLightsRequest) error
	SetMotionDetection(ctx context.Context, request SetMotionDetectionRequest) error
	SetSiren(ctx context.Context, request SetSirenRequest) error
	TestSound(ctx context.Context, request TestSoundRequest) error
	SetInHomeChime(ctx context.Context, request SetInHomeChimeRequest) error
	RebootDevice(ctx context.Context, request DeviceIDRequest) error
	UnlockIntercom(ctx context.Context, request DeviceIDRequest) error
	SetPersistentLiveViewEnabled(ctx context.Context, request SetPersistentLiveViewEnabledRequest) error

	// Various recording APIs
	GetDeviceHistory(ctx context.Context, request GetDeviceHistoryRequest) (*ringapimodels.RecordingHistoryResponse, error)
	GetActiveDings(ctx context.Context, request GetActiveDingsRequest) (*ringapimodels.RecordingHistoryResponse, error)
	GetRecording(ctx context.Context, request GetRecordingRequest) (*ringapimodels.VideoStream, error)
	GetRecordingShareURL(ctx context.Context, request GetRecordingShareURLRequest) (string, error)
	GetLastRecordingID(ctx context.Context, request GetLastRecordingIDRequest) (int64, error)
	FavoriteRecording(ctx context.Context, request RecordingIDRequest) error
	DeleteRecording(ctx context.Context, request DeleteRecordingRequest) error

	// Event and signaling connections
	OpenSignaling(ctx context.Context, request OpenSignalingRequest) (*SignalingConnection, error)
	ConnectEvents(ctx context.Context, request ConnectEventsRequest) (*EventConnection, error)
	ConnectPush(ctx context.Context, request ConnectPushRequest) (*PushConnection, error)
	RegisterPushDevice(ctx context.Context, request RegisterPushDeviceRequest) error
	SubscribeDeviceDing(ctx context.Context, request DeviceIDRequest) error
	SubscribeDeviceMotion(ctx context.Context, request DeviceIDRequest) error
	Listen(ctx context.Context, callback ringapimodels.EventCallback, request ConnectEventsRequest) error
}

type CompleteLoginRequest struct{ OTPCode string }

type ConnectEventsRequest struct{ Auth AuthContext }

type ConnectPushRequest struct {
	Auth        AuthContext
	Credentials json.RawMessage
	DeviceIDs   []string
	Ding        bool
	Motion      bool
}

type ConnectionState string

type DeleteRecordingRequest struct {
	Auth                  AuthContext
	RecordingID           int64
	ConfirmDeleteFavorite *bool
}

type DeviceAlerts struct {
	Connection *ConnectionState `json:"connection,omitempty"`
}

type DeviceDetail struct {
	Device        DeviceDetailDevice  `json:"device"`
	OperationSets map[string][]string `json:"-"`
}

type DeviceDetailDevice struct {
	ID                     int64                 `json:"id"`
	DeviceID               *string               `json:"device_id,omitempty"`
	Description            string                `json:"description"`
	Kind                   DeviceKind            `json:"kind"`
	Family                 *DeviceFamily         `json:"family,omitempty"`
	CreatedAt              *time.Time            `json:"created_at,omitempty"`
	DeactivatedAt          *time.Time            `json:"deactivated_at,omitempty"`
	Name                   *string               `json:"name,omitempty"`
	Address                *string               `json:"address,omitempty"`
	LocationID             *string               `json:"location_id,omitempty"`
	OperationSet           *string               `json:"operation_set,omitempty"`
	Owner                  *DeviceOwner          `json:"owner,omitempty"`
	Settings               *DeviceLegacySettings `json:"settings,omitempty"`
	Features               *DeviceFeatures       `json:"features,omitempty"`
	TimeZone               *string               `json:"time_zone,omitempty"`
	Timezone               *string               `json:"timezone,omitempty"`
	WifiName               *string               `json:"wifi_name,omitempty"`
	WifiSignalStrength     *int                  `json:"wifi_signal_strength,omitempty"`
	Owned                  *bool                 `json:"owned,omitempty"`
	MotionDetectionEnabled *bool                 `json:"motion_detection_enabled,omitempty"`
	HasLight               *bool                 `json:"has_light,omitempty"`
	LightBrightness        *int                  `json:"light_brightness,omitempty"`
	Volume                 *int                  `json:"volume,omitempty"`
	Health                 *DeviceDetailHealth   `json:"health,omitempty"`
	Alerts                 *DeviceAlerts         `json:"alerts,omitempty"`
	BatteryLife            *BatteryReading       `json:"battery_life,omitempty"`
	BatteryLife2           *BatteryReading       `json:"battery_life_2,omitempty"`
	ExternalConnection     *bool                 `json:"external_connection,omitempty"`
}

type DeviceDetailHealth struct {
	BatteryLevel              *int     `json:"battery_level,omitempty"`
	BatteryPercentage         *float64 `json:"battery_percentage,omitempty"`
	BatteryPresent            *bool    `json:"battery_present,omitempty"`
	BatteryPercentageCategory *string  `json:"battery_percentage_category,omitempty"`
	BatteryStatus             *string  `json:"battery_status,omitempty"`
	Connected                 *bool    `json:"connected,omitempty"`
	FirmwareVersion           *string  `json:"firmware_version,omitempty"`
	LastUpdate                *string  `json:"last_update,omitempty"`
	PTZConnected              *string  `json:"ptz_connected,omitempty"`
	RSSI                      *float32 `json:"rssi,omitempty"`
	SignalStrength            *int     `json:"signal_strength,omitempty"`
	SupportedRPCCommands      []string `json:"supported_rpc_commands,omitempty"`
}

type DeviceFamily string

type DeviceFeatures struct {
	AutoTrack      *FeatureAvailability   `json:"auto_track,omitempty"`
	AutoZoomTrack  *FeatureAvailability   `json:"auto_zoom_track,omitempty"`
	MotionsEnabled *bool                  `json:"motions_enabled,omitempty"`
	VideoRendering *VideoRenderingFeature `json:"video_rendering,omitempty"`
}

type DeviceIDRequest struct {
	Auth     AuthContext
	DeviceID string
}

type DeviceKind string

type DeviceLegacySettings struct {
	DoorbellVolume         *int       `json:"doorbell_volume,omitempty"`
	LiveViewDisabled       *bool      `json:"live_view_disabled,omitempty"`
	MotionDetectionEnabled *bool      `json:"motion_detection_enabled,omitempty"`
	PowerMode              *PowerMode `json:"power_mode,omitempty"`
}

type DeviceOwner struct {
	ID        *OwnerID `json:"id,omitempty"`
	FirstName *string  `json:"first_name,omitempty"`
	LastName  *string  `json:"last_name,omitempty"`
	Email     *string  `json:"email,omitempty"`
}

type DeviceSession struct {
	// contains filtered or unexported fields
}

type DeviceSessionAPI interface {
	Answer() SessionDescription
	State() SessionState
	Wait(ctx context.Context) error
	Receive(ctx context.Context) (*SessionEvent, error)
	SendICE(ctx context.Context, request ICECandidateRequest) error
	PanStep(ctx context.Context, request PanStepRequest) (*PTZResult, error)
	TiltStep(ctx context.Context, request TiltStepRequest) (*PTZResult, error)
	PanContinuous(ctx context.Context, request PanContinuousRequest) (*PTZResult, error)
	TiltContinuous(ctx context.Context, request TiltContinuousRequest) (*PTZResult, error)
	StopPTZ(ctx context.Context, request StopPTZRequest) (*PTZResult, error)
	SetMicrophone(ctx context.Context, request SetMicrophoneRequest) error
	SetStreamOptions(ctx context.Context, request SetStreamOptionsRequest) error
	Close() error
}

type DeviceSettings struct {
	// MotionDetectionEnabled is nil when the response omits or nulls the field.
	MotionDetectionEnabled *bool
}

type DeviceStatus struct {
	BatteryPercent *float64         `json:"battery_percent,omitempty"`
	Connection     *ConnectionState `json:"connection,omitempty"`
	IsOffline      bool             `json:"is_offline"`
	PowerMode      *PowerMode       `json:"power_mode,omitempty"`
}

type DeviceTimeline struct {
	Items         []TimelineEvent `json:"items"`
	PaginationKey *string         `json:"pagination_key,omitempty"`
}

type Endpoints struct {
	OAuthBaseURL     string
	APIBaseURL       string
	SolutionsBaseURL string
	SignalingURL     string
}

type EventCapability string

type EventConnection struct {
	// contains filtered or unexported fields
}

type EventConnectionAPI interface {
	Receive() (*ringapimodels.Event, error)
	Close() error
}

type FCMDialContext func(context.Context, string, string) (net.Conn, error)

type FCMEvent struct {
	Kind        FCMEventKind
	Token       string
	DeviceID    string
	Action      PushAction
	Credentials json.RawMessage
	Data        json.RawMessage
	Err         error
}

type FCMEventKind string

type FCMSource func(context.Context, json.RawMessage) (<-chan FCMEvent, error)

type FeatureAvailability struct {
	Eligibility *FeatureEligibility `json:"eligibility,omitempty"`
	Enablement  *FeatureEnablement  `json:"enablement,omitempty"`
}

type FeatureEligibility struct {
	Eligible             *bool    `json:"eligible,omitempty"`
	IneligibilityReasons []string `json:"ineligibility_reasons,omitempty"`
}

type FeatureEnablement struct {
	Allowed         *bool    `json:"allowed,omitempty"`
	Enabled         *bool    `json:"enabled,omitempty"`
	DisallowReasons []string `json:"disallow_reasons,omitempty"`
}

type GeoCoordinates struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
}

type GetActiveDingsRequest struct{ Auth AuthContext }

type GetCapturedTicketsRequest struct {
	Auth   AuthContext
	Params CapturedTicketsParams
}

type GetDeviceDetailRequest struct {
	Auth     AuthContext
	DeviceID string
}

type GetDeviceHistoryRequest struct {
	Auth     AuthContext
	DeviceID string
	Limit    int
	// OlderThan is an optional Unix timestamp cursor for older recordings.
	OlderThan *int64
	// Kind is an open server value; unfamiliar history kinds are forwarded.
	Kind HistoryKind
}

type GetDeviceRequest struct {
	Auth     AuthContext
	DeviceID string
}

type GetDeviceSettingsRequest struct {
	Auth     AuthContext
	DeviceID string
}

type GetDeviceTimelineRequest struct {
	Auth     AuthContext
	DeviceID string
	Params   TimelineParams
}

type GetHistoryDevicesRequest struct {
	Auth   AuthContext
	Params HistoryDevicesParams
}

type GetLastRecordingIDRequest struct {
	Auth     AuthContext
	DeviceID string
}

type GetLocationRequest struct {
	Auth       AuthContext
	LocationID string
	Params     LocationParams
}

type GetRecordingRequest struct {
	Auth        AuthContext
	RecordingID int64
}

type GetRecordingShareURLRequest struct {
	Auth        AuthContext
	RecordingID int64
}

type GetSnapshotRequest struct {
	Auth         AuthContext
	DeviceID     string
	MaxAttempts  int
	PollInterval time.Duration
}

type HistoryDevices struct {
	Events        []TimelineEvent   `json:"events"`
	Feed          []HistoryFeedItem `json:"feed,omitempty"`
	PaginationKey *string           `json:"pagination_key,omitempty"`
	Schema        *string           `json:"schema,omitempty"`
}

type HistoryDevicesParams struct {
	SourceIDs    []string
	Capabilities []EventCapability
}

type HistoryFeedItem struct {
	ID   *string          `json:"id,omitempty"`
	Type *HistoryFeedType `json:"type,omitempty"`
}

type HistoryFeedType string

type HistoryKind string

type ICECandidateMode string

type ICECandidateRequest struct {
	Candidate  string
	MID        string
	MLineIndex int
}

type ListDevicesRequest struct{ Auth AuthContext }

type ListLocationsRequest struct{ Auth AuthContext }

type LocationAddress struct {
	Address1 *string `json:"address1,omitempty"`
	Address2 *string `json:"address2,omitempty"`
	City     *string `json:"city,omitempty"`
	Country  *string `json:"country,omitempty"`
	State    *string `json:"state,omitempty"`
	Timezone *string `json:"timezone,omitempty"`
	ZipCode  *string `json:"zip_code,omitempty"`
}

type LocationAttributes struct {
	Name      *string  `json:"name,omitempty"`
	City      *string  `json:"city,omitempty"`
	Country   *string  `json:"country,omitempty"`
	State     *string  `json:"state,omitempty"`
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
	TimeZone  *string  `json:"time_zone,omitempty"`
}

type LocationDetail struct {
	Data     LocationResource   `json:"data"`
	Included []LocationResource `json:"included,omitempty"`
	Meta     *LocationMeta      `json:"meta,omitempty"`
}

type LocationExpansion string

type LocationGroup struct {
	ID   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

type LocationGroupDevices struct {
	Groups []LocationGroup `json:"groups"`
}

type LocationGroups struct {
	DeviceGroups []LocationGroup `json:"device_groups,omitempty"`
	IsOwner      *bool           `json:"is_owner,omitempty"`
}

type LocationList struct {
	Locations     []LocationSummary   `json:"user_locations"`
	OperationSets map[string][]string `json:"-"`
}

type LocationMeta struct {
	Time *time.Time `json:"time,omitempty"`
}

type LocationParams struct {
	Include []LocationExpansion
}

type LocationRequest struct {
	Auth       AuthContext
	LocationID string
}

type LocationResource struct {
	ID         string               `json:"id"`
	Type       LocationResourceType `json:"type"`
	Attributes *LocationAttributes  `json:"attributes,omitempty"`
}

type LocationResourceType string

type LocationSummary struct {
	ID             string           `json:"location_id"`
	Name           string           `json:"name"`
	LocationType   *string          `json:"location_type,omitempty"`
	IsOwner        *bool            `json:"is_owner,omitempty"`
	OwnerID        *int64           `json:"owner_id,omitempty"`
	Address        *LocationAddress `json:"address,omitempty"`
	GeoCoordinates *GeoCoordinates  `json:"geo_coordinates,omitempty"`
}

type LoginSession struct {
	// contains filtered or unexported fields
}

type LoginSessionAPI interface {
	HardwareID() string
	Request2FACode(ctx context.Context) error
	Authenticate(ctx context.Context, request CompleteLoginRequest) (*ringapimodels.AuthResponse, error)
	Close() error
}

type LoginSessionRequest struct {
	Username   string
	Password   string
	HardwareID string
}

type OpenSignalingRequest struct{ Auth AuthContext }

type Option interface {
	// contains filtered or unexported methods
}

type OwnerID string

type PTZAxis string

type PTZResult struct {
	SessionID string          `json:"sessionId"`
	Timestamp float64         `json:"timestamp"`
	Version   float64         `json:"version"`
	Raw       json.RawMessage `json:"-"`
}

type PanContinuousRequest struct {
	Direction PanDirection
	// Speed is normalized from 0 (stop) to 1 (full requested speed).
	Speed float64
}

type PanDirection string

type PanStepRequest struct{ Direction PanDirection }

type PatchDeviceSettingsRequest struct {
	Auth                   AuthContext
	DeviceID               string
	MotionDetectionEnabled *bool
}

type PlaybackSession struct {
	// contains filtered or unexported fields
}

type PlaybackSessionAPI interface {
	Answer() SessionDescription
	SendICE(ctx context.Context, request ICECandidateRequest) error
	Receive(ctx context.Context) (SessionEvent, error)
	Close() error
}

type PowerMode string

type PushAction string

type PushConnection struct {
	// contains filtered or unexported fields
}

type PushEvent struct {
	FilterIdentifiers []string        `json:"filter_identifiers"`
	IngestionTimeMS   int64           `json:"ingestion_time_ms"`
	NotificationScope string          `json:"notification_scope"`
	NotificationType  string          `json:"notification_type"`
	Payload           json.RawMessage `json:"payload"`
	SubscriptionID    string          `json:"subscription_id"`
}

type PushFilter struct {
	FilterIdentifier  string      `json:"filter_identifier"`
	Filters           PushFilters `json:"filters"`
	NotificationScope string      `json:"notification_scope"`
	NotificationType  string      `json:"notification_type"`
}

type PushFilters struct {
	DoorbotIDs []int64 `json:"doorbot_ids"`
}

type PushSubscription struct {
	// contains filtered or unexported fields
}

type PushSubscriptionAPI interface {
	Receive(ctx context.Context) (PushEvent, error)
	Close() error
}

type RPCError = signaling.RPCError

type RecordingIDRequest struct {
	Auth        AuthContext
	RecordingID int64
}

type RecordingStatus string

type RefreshTokenRequest struct {
	RefreshToken string
	HardwareID   string
}

type Region string

type RegisterPushDeviceRequest struct {
	Auth  AuthContext
	Token string
}

type Request2FACodeRequest struct {
	Username   string
	Password   string
	HardwareID string
}

type SDPType uint8

type SessionDescription struct {
	Type SDPType `json:"type"`
	SDP  string  `json:"sdp"`
}

type SessionEvent struct {
	Method string
	Body   json.RawMessage
}

type SessionState string

type SetInHomeChimeRequest struct {
	Auth        AuthContext
	DeviceID    string
	Description string
	Settings    ringapimodels.InHomeChimeSettings
}

type SetLightsRequest struct {
	Auth     AuthContext
	DeviceID string
	Enabled  bool
}

type SetMicrophoneRequest struct{ Enabled bool }

type SetMotionDetectionRequest struct {
	Auth     AuthContext
	DeviceID string
	Enabled  bool
}

type SetPersistentLiveViewEnabledRequest struct {
	Auth     AuthContext
	DeviceID string
	Enabled  bool
}

type SetSirenRequest struct {
	Auth     AuthContext
	DeviceID string
	Enabled  bool
}

type SetStreamOptionsRequest struct {
	AudioEnabled *bool
	VideoEnabled *bool
}

type SetVolumeRequest struct {
	Auth        AuthContext
	DeviceID    string
	Kind        ringapimodels.VolumeKind
	Description string
	Volume      int
}

type SignalingConnection struct {
	// contains filtered or unexported fields
}

type SignalingConnectionAPI interface {
	StartDeviceSession(ctx context.Context, request StartDeviceSessionRequest) (*DeviceSession, error)
	StartPlayback(ctx context.Context, request StartPlaybackRequest) (*PlaybackSession, error)
	SubscribePush(ctx context.Context, filters []PushFilter) (*PushSubscription, error)
	Err() error
	Close() error
}

type SignalingTransport string

type Snapshot struct {
	Bytes       []byte
	Timestamp   time.Time
	ContentType string
}

type StartDeviceSessionRequest struct {
	DeviceID     string
	Offer        SessionDescription
	AudioEnabled bool
	VideoEnabled bool
	MaxAge       time.Duration
	ICEMode      ICECandidateMode
}

type StartPlaybackRequest struct {
	DeviceID   string
	Offer      SessionDescription
	EntryPoint string
}

type StopPTZRequest struct{ Axis PTZAxis }

type TestSoundRequest struct {
	Auth     AuthContext
	DeviceID string
	Sound    ringapimodels.SoundKind
}

type TiltContinuousRequest struct {
	Direction TiltDirection
	// Speed is normalized from 0 (stop) to 1 (full requested speed).
	Speed float64
}

type TiltDirection string

type TiltStepRequest struct{ Direction TiltDirection }

type TimelineDevice struct {
	ID          *int64  `json:"id,omitempty"`
	Description *string `json:"description,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type TimelineEvent struct {
	ID              string            `json:"event_id"`
	Type            TimelineEventType `json:"event_type"`
	StartTime       time.Time         `json:"start_time"`
	EndTime         *time.Time        `json:"end_time,omitempty"`
	DurationMS      *int              `json:"duration_ms,omitempty"`
	Device          *TimelineDevice   `json:"device,omitempty"`
	SourceID        *string           `json:"source_id,omitempty"`
	IsFavorite      *bool             `json:"is_favorite,omitempty"`
	RecordingStatus *RecordingStatus  `json:"recording_status,omitempty"`
	State           *TimelineState    `json:"state,omitempty"`
	Schema          *string           `json:"schema,omitempty"`
}

type TimelineEventType string

type TimelineOrder string

type TimelineParams struct {
	StartTime    *time.Time
	EndTime      *time.Time
	Order        *TimelineOrder
	Limit        *int
	Capabilities []EventCapability
}

type TimelineState string

type UpdateDeviceHealthRequest struct {
	Auth     AuthContext
	DeviceID string
}

type VideoRenderingFeature struct {
	MaxDigitalZoomLevel *float32 `json:"max_digital_zoom_level,omitempty"`
}

type WebSocketDialer interface {
	DialContext(ctx context.Context, url string, headers http.Header) (*websocket.Conn, *http.Response, error)
}