generatedhttp

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package generatedhttp provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

View Source
const (
	Accept                                                                = restmodels.Accept
	Authorization                                                         = restmodels.Authorization
	AuthorizationCode                                                     = restmodels.AuthorizationCode
	BeamsCt200Transformer                                                 = restmodels.BeamsCt200Transformer
	Chime                                                                 = restmodels.Chime
	ChimePro                                                              = restmodels.ChimePro
	ChimeProV2                                                            = restmodels.ChimeProV2
	ChimeV2                                                               = restmodels.ChimeV2
	Chimes                                                                = restmodels.Chimes
	ClientSessionRegistrationDeviceOsAndroid                              = restmodels.ClientSessionRegistrationDeviceOsAndroid
	CocoaCamera                                                           = restmodels.CocoaCamera
	CocoaDoorbell                                                         = restmodels.CocoaDoorbell
	CocoaDoorbellV2                                                       = restmodels.CocoaDoorbellV2
	CocoaFloodlight                                                       = restmodels.CocoaFloodlight
	CocoaSpotlight                                                        = restmodels.CocoaSpotlight
	Code                                                                  = restmodels.Code
	ContentType                                                           = restmodels.ContentType
	DeviceRpc                                                             = restmodels.DeviceRpc
	DfDoorbellClownfish                                                   = restmodels.DfDoorbellClownfish
	Ding                                                                  = restmodels.Ding
	Doorbell                                                              = restmodels.Doorbell
	DoorbellGrahamCracker                                                 = restmodels.DoorbellGrahamCracker
	DoorbellOyster                                                        = restmodels.DoorbellOyster
	DoorbellPortal                                                        = restmodels.DoorbellPortal
	DoorbellScallop                                                       = restmodels.DoorbellScallop
	DoorbellScallopLite                                                   = restmodels.DoorbellScallopLite
	DoorbellV3                                                            = restmodels.DoorbellV3
	DoorbellV4                                                            = restmodels.DoorbellV4
	DoorbellV5                                                            = restmodels.DoorbellV5
	Doorbot                                                               = restmodels.Doorbot
	Doorbots                                                              = restmodels.Doorbots
	False                                                                 = restmodels.False
	Fcm                                                                   = restmodels.Fcm
	FloodlightPro                                                         = restmodels.FloodlightPro
	FloodlightV2                                                          = restmodels.FloodlightV2
	GoRing                                                                = restmodels.GoRing
	HardwareId                                                            = restmodels.HardwareId
	HpCamV1                                                               = restmodels.HpCamV1
	HpCamV2                                                               = restmodels.HpCamV2
	IntercomHandsetAudio                                                  = restmodels.IntercomHandsetAudio
	IntercomHandsetVideo                                                  = restmodels.IntercomHandsetVideo
	IntercomUnlockParamsDoorIdN0                                          = restmodels.IntercomUnlockParamsDoorIdN0
	IntercomUnlockParamsUserIdN0                                          = restmodels.IntercomUnlockParamsUserIdN0
	JboxV1                                                                = restmodels.JboxV1
	LpdV1                                                                 = restmodels.LpdV1
	LpdV2                                                                 = restmodels.LpdV2
	LpdV3                                                                 = restmodels.LpdV3
	LpdV4                                                                 = restmodels.LpdV4
	Motion                                                                = restmodels.Motion
	N11                                                                   = restmodels.N11
	N20                                                                   = restmodels.N20
	N200                                                                  = restmodels.N200
	N2faCode                                                              = restmodels.N2faCode
	N2faSupport                                                           = restmodels.N2faSupport
	Other                                                                 = restmodels.Other
	Password                                                              = restmodels.Password
	PushDeviceRegistrationDeviceOsAndroid                                 = restmodels.PushDeviceRegistrationDeviceOsAndroid
	Reboot                                                                = restmodels.Reboot
	RefreshToken                                                          = restmodels.RefreshToken
	S256                                                                  = restmodels.S256
	SpotlightwV2                                                          = restmodels.SpotlightwV2
	StickupCam                                                            = restmodels.StickupCam
	StickupCamElite                                                       = restmodels.StickupCamElite
	StickupCamLongfin                                                     = restmodels.StickupCamLongfin
	StickupCamLunar                                                       = restmodels.StickupCamLunar
	StickupCamMini                                                        = restmodels.StickupCamMini
	StickupCamMiniPtzV1                                                   = restmodels.StickupCamMiniPtzV1
	StickupCamMiniV2                                                      = restmodels.StickupCamMiniV2
	StickupCamV3                                                          = restmodels.StickupCamV3
	StickupCamV4                                                          = restmodels.StickupCamV4
	StickupCamWired                                                       = restmodels.StickupCamWired
	StickupCams                                                           = restmodels.StickupCams
	UnlockDoor                                                            = restmodels.UnlockDoor
	UpdateLegacyDoorbotControlsParamsDoorbotSettingsChimeSettingsEnableN0 = restmodels.UpdateLegacyDoorbotControlsParamsDoorbotSettingsChimeSettingsEnableN0
	UpdateLegacyDoorbotControlsParamsDoorbotSettingsChimeSettingsEnableN1 = restmodels.UpdateLegacyDoorbotControlsParamsDoorbotSettingsChimeSettingsEnableN1
	UserAgent                                                             = restmodels.UserAgent
)

Variables

This section is empty.

Functions

func NewBeginOrContinueOAuthAuthorizationRequest

func NewBeginOrContinueOAuthAuthorizationRequest(server string, params *BeginOrContinueOAuthAuthorizationParams) (*http.Request, error)

NewBeginOrContinueOAuthAuthorizationRequest constructs an http.Request for the BeginOrContinueOAuthAuthorization method

func NewDeleteRecordingRequest

func NewDeleteRecordingRequest(server string, recordingId RecordingId, params *DeleteRecordingParams) (*http.Request, error)

NewDeleteRecordingRequest constructs an http.Request for the DeleteRecording method

func NewExchangeOrRefreshOAuthTokenRequestWithBody

func NewExchangeOrRefreshOAuthTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExchangeOrRefreshOAuthTokenRequestWithBody constructs an http.Request for the ExchangeOrRefreshOAuthToken method, with any body, and a specified content type

func NewExchangeOrRefreshOAuthTokenRequestWithFormdataBody

func NewExchangeOrRefreshOAuthTokenRequestWithFormdataBody(server string, body ExchangeOrRefreshOAuthTokenFormdataRequestBody) (*http.Request, error)

NewExchangeOrRefreshOAuthTokenRequestWithFormdataBody calls the generic ExchangeOrRefreshOAuthToken builder with application/x-www-form-urlencoded body

func NewFavoriteRecordingRequest

func NewFavoriteRecordingRequest(server string, recordingId RecordingId) (*http.Request, error)

NewFavoriteRecordingRequest constructs an http.Request for the FavoriteRecording method

func NewGetActiveDingsRequest

func NewGetActiveDingsRequest(server string) (*http.Request, error)

NewGetActiveDingsRequest constructs an http.Request for the GetActiveDings method

func NewGetCapturedLocationTicketsRequest

func NewGetCapturedLocationTicketsRequest(server string, params *GetCapturedLocationTicketsParams) (*http.Request, error)

NewGetCapturedLocationTicketsRequest constructs an http.Request for the GetCapturedLocationTickets method

func NewGetDeviceRequest

func NewGetDeviceRequest(server string, deviceId DeviceId) (*http.Request, error)

NewGetDeviceRequest constructs an http.Request for the GetDevice method

func NewGetDeviceSettingsRequest

func NewGetDeviceSettingsRequest(server string, deviceId DeviceId) (*http.Request, error)

NewGetDeviceSettingsRequest constructs an http.Request for the GetDeviceSettings method

func NewGetDeviceTimelineRequest

func NewGetDeviceTimelineRequest(server string, deviceId DeviceId, params *GetDeviceTimelineParams) (*http.Request, error)

NewGetDeviceTimelineRequest constructs an http.Request for the GetDeviceTimeline method

func NewGetHistoryDevicesRequest

func NewGetHistoryDevicesRequest(server string, params *GetHistoryDevicesParams) (*http.Request, error)

NewGetHistoryDevicesRequest constructs an http.Request for the GetHistoryDevices method

func NewGetLegacyDeviceHealthRequest

func NewGetLegacyDeviceHealthRequest(server string, deviceId DeviceId) (*http.Request, error)

NewGetLegacyDeviceHealthRequest constructs an http.Request for the GetLegacyDeviceHealth method

func NewGetLegacyDeviceHistoryRequest

func NewGetLegacyDeviceHistoryRequest(server string, deviceId DeviceId, params *GetLegacyDeviceHistoryParams) (*http.Request, error)

NewGetLegacyDeviceHistoryRequest constructs an http.Request for the GetLegacyDeviceHistory method

func NewGetLegacyRecordingShareURLRequest

func NewGetLegacyRecordingShareURLRequest(server string, recordingId RecordingId) (*http.Request, error)

NewGetLegacyRecordingShareURLRequest constructs an http.Request for the GetLegacyRecordingShareURL method

func NewGetLegacySnapshotImageRequest

func NewGetLegacySnapshotImageRequest(server string, deviceId DeviceId) (*http.Request, error)

NewGetLegacySnapshotImageRequest constructs an http.Request for the GetLegacySnapshotImage method

func NewGetLocationRequest

func NewGetLocationRequest(server string, locationId LocationId, params *GetLocationParams) (*http.Request, error)

NewGetLocationRequest constructs an http.Request for the GetLocation method

func NewListDevicesRequest

func NewListDevicesRequest(server string) (*http.Request, error)

NewListDevicesRequest constructs an http.Request for the ListDevices method

func NewListLocationDevicesRequest

func NewListLocationDevicesRequest(server string, locationId LocationId) (*http.Request, error)

NewListLocationDevicesRequest constructs an http.Request for the ListLocationDevices method

func NewListLocationGroupsRequest

func NewListLocationGroupsRequest(server string, locationId LocationId) (*http.Request, error)

NewListLocationGroupsRequest constructs an http.Request for the ListLocationGroups method

func NewListLocationsRequest

func NewListLocationsRequest(server string) (*http.Request, error)

NewListLocationsRequest constructs an http.Request for the ListLocations method

func NewPatchDeviceSettingsRequest

func NewPatchDeviceSettingsRequest(server string, deviceId DeviceId, body PatchDeviceSettingsJSONRequestBody) (*http.Request, error)

NewPatchDeviceSettingsRequest calls the generic PatchDeviceSettings builder with application/json body

func NewPatchDeviceSettingsRequestWithBody

func NewPatchDeviceSettingsRequestWithBody(server string, deviceId DeviceId, contentType string, body io.Reader) (*http.Request, error)

NewPatchDeviceSettingsRequestWithBody constructs an http.Request for the PatchDeviceSettings method, with any body, and a specified content type

func NewRefreshLegacySnapshotTimestampRequest

func NewRefreshLegacySnapshotTimestampRequest(server string, body RefreshLegacySnapshotTimestampJSONRequestBody) (*http.Request, error)

NewRefreshLegacySnapshotTimestampRequest calls the generic RefreshLegacySnapshotTimestamp builder with application/json body

func NewRefreshLegacySnapshotTimestampRequestWithBody

func NewRefreshLegacySnapshotTimestampRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRefreshLegacySnapshotTimestampRequestWithBody constructs an http.Request for the RefreshLegacySnapshotTimestamp method, with any body, and a specified content type

func NewRegisterClientSessionRequest

func NewRegisterClientSessionRequest(server string, body RegisterClientSessionJSONRequestBody) (*http.Request, error)

NewRegisterClientSessionRequest calls the generic RegisterClientSession builder with application/json body

func NewRegisterClientSessionRequestWithBody

func NewRegisterClientSessionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRegisterClientSessionRequestWithBody constructs an http.Request for the RegisterClientSession method, with any body, and a specified content type

func NewRegisterPushDeviceRequest

func NewRegisterPushDeviceRequest(server string, body RegisterPushDeviceJSONRequestBody) (*http.Request, error)

NewRegisterPushDeviceRequest calls the generic RegisterPushDevice builder with application/json body

func NewRegisterPushDeviceRequestWithBody

func NewRegisterPushDeviceRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewRegisterPushDeviceRequestWithBody constructs an http.Request for the RegisterPushDevice method, with any body, and a specified content type

func NewRequestLegacySignalingTicketRequest

func NewRequestLegacySignalingTicketRequest(server string) (*http.Request, error)

NewRequestLegacySignalingTicketRequest constructs an http.Request for the RequestLegacySignalingTicket method

func NewSendDeviceCommandRequest

func NewSendDeviceCommandRequest(server string, deviceId DeviceId, body SendDeviceCommandJSONRequestBody) (*http.Request, error)

NewSendDeviceCommandRequest calls the generic SendDeviceCommand builder with application/json body

func NewSendDeviceCommandRequestWithBody

func NewSendDeviceCommandRequestWithBody(server string, deviceId DeviceId, contentType string, body io.Reader) (*http.Request, error)

NewSendDeviceCommandRequestWithBody constructs an http.Request for the SendDeviceCommand method, with any body, and a specified content type

func NewSetChimeVolumeRequest

func NewSetChimeVolumeRequest(server string, deviceId DeviceId, params *SetChimeVolumeParams) (*http.Request, error)

NewSetChimeVolumeRequest constructs an http.Request for the SetChimeVolume method

func NewSetLiveViewEnabledRequest

func NewSetLiveViewEnabledRequest(server string, deviceId DeviceId, body SetLiveViewEnabledJSONRequestBody) (*http.Request, error)

NewSetLiveViewEnabledRequest calls the generic SetLiveViewEnabled builder with application/json body

func NewSetLiveViewEnabledRequestWithBody

func NewSetLiveViewEnabledRequestWithBody(server string, deviceId DeviceId, contentType string, body io.Reader) (*http.Request, error)

NewSetLiveViewEnabledRequestWithBody constructs an http.Request for the SetLiveViewEnabled method, with any body, and a specified content type

func NewStreamRecordingRequest

func NewStreamRecordingRequest(server string, recordingId RecordingId) (*http.Request, error)

NewStreamRecordingRequest constructs an http.Request for the StreamRecording method

func NewSubmitOAuthCredentialsRequestWithBody

func NewSubmitOAuthCredentialsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSubmitOAuthCredentialsRequestWithBody constructs an http.Request for the SubmitOAuthCredentials method, with any body, and a specified content type

func NewSubmitOAuthCredentialsRequestWithFormdataBody

func NewSubmitOAuthCredentialsRequestWithFormdataBody(server string, body SubmitOAuthCredentialsFormdataRequestBody) (*http.Request, error)

NewSubmitOAuthCredentialsRequestWithFormdataBody calls the generic SubmitOAuthCredentials builder with application/x-www-form-urlencoded body

func NewSubscribeDeviceDingRequest

func NewSubscribeDeviceDingRequest(server string, deviceId DeviceId) (*http.Request, error)

NewSubscribeDeviceDingRequest constructs an http.Request for the SubscribeDeviceDing method

func NewSubscribeDeviceMotionRequest

func NewSubscribeDeviceMotionRequest(server string, deviceId DeviceId) (*http.Request, error)

NewSubscribeDeviceMotionRequest constructs an http.Request for the SubscribeDeviceMotion method

func NewTestChimeSoundRequest

func NewTestChimeSoundRequest(server string, deviceId DeviceId, params *TestChimeSoundParams) (*http.Request, error)

NewTestChimeSoundRequest constructs an http.Request for the TestChimeSound method

func NewTurnFloodlightOffRequest

func NewTurnFloodlightOffRequest(server string, deviceId DeviceId) (*http.Request, error)

NewTurnFloodlightOffRequest constructs an http.Request for the TurnFloodlightOff method

func NewTurnFloodlightOnRequest

func NewTurnFloodlightOnRequest(server string, deviceId DeviceId) (*http.Request, error)

NewTurnFloodlightOnRequest constructs an http.Request for the TurnFloodlightOn method

func NewTurnSirenOffRequest

func NewTurnSirenOffRequest(server string, deviceId DeviceId) (*http.Request, error)

NewTurnSirenOffRequest constructs an http.Request for the TurnSirenOff method

func NewTurnSirenOnRequest

func NewTurnSirenOnRequest(server string, deviceId DeviceId) (*http.Request, error)

NewTurnSirenOnRequest constructs an http.Request for the TurnSirenOn method

func NewUnlockIntercomRequest

func NewUnlockIntercomRequest(server string, deviceId DeviceId, body UnlockIntercomJSONRequestBody) (*http.Request, error)

NewUnlockIntercomRequest calls the generic UnlockIntercom builder with application/json body

func NewUnlockIntercomRequestWithBody

func NewUnlockIntercomRequestWithBody(server string, deviceId DeviceId, contentType string, body io.Reader) (*http.Request, error)

NewUnlockIntercomRequestWithBody constructs an http.Request for the UnlockIntercom method, with any body, and a specified content type

func NewUpdateLegacyDoorbotControlsRequest

func NewUpdateLegacyDoorbotControlsRequest(server string, deviceId DeviceId, params *UpdateLegacyDoorbotControlsParams) (*http.Request, error)

NewUpdateLegacyDoorbotControlsRequest constructs an http.Request for the UpdateLegacyDoorbotControls method

func NewVerifyOAuthTwoFactorCodeRequestWithBody

func NewVerifyOAuthTwoFactorCodeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewVerifyOAuthTwoFactorCodeRequestWithBody constructs an http.Request for the VerifyOAuthTwoFactorCode method, with any body, and a specified content type

func NewVerifyOAuthTwoFactorCodeRequestWithFormdataBody

func NewVerifyOAuthTwoFactorCodeRequestWithFormdataBody(server string, body VerifyOAuthTwoFactorCodeFormdataRequestBody) (*http.Request, error)

NewVerifyOAuthTwoFactorCodeRequestWithFormdataBody calls the generic VerifyOAuthTwoFactorCode builder with application/x-www-form-urlencoded body

Types

type AllowUserOnly

type AllowUserOnly = restmodels.AllowUserOnly

type AuthFailure

type AuthFailure = restmodels.AuthFailure

type AuthorizationCodeGrant

type AuthorizationCodeGrant = restmodels.AuthorizationCodeGrant

type BeginOrContinueOAuthAuthorizationResponse

type BeginOrContinueOAuthAuthorizationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *AuthFailure
	// Headers302 the parsed response headers for an HTTP 302 response
	Headers302 *BeginOrContinueOAuthAuthorizationResponse302Headers
}

func ParseBeginOrContinueOAuthAuthorizationResponse

func ParseBeginOrContinueOAuthAuthorizationResponse(rsp *http.Response) (*BeginOrContinueOAuthAuthorizationResponse, error)

ParseBeginOrContinueOAuthAuthorizationResponse parses an HTTP response from a BeginOrContinueOAuthAuthorizationWithResponse call

func (BeginOrContinueOAuthAuthorizationResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (BeginOrContinueOAuthAuthorizationResponse) GetBody

GetBody returns the raw response body bytes

func (BeginOrContinueOAuthAuthorizationResponse) GetJSONDefault

GetJSONDefault returns the response for an HTTP default `application/json` response

func (BeginOrContinueOAuthAuthorizationResponse) Status

Status returns HTTPResponse.Status

func (BeginOrContinueOAuthAuthorizationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type BeginOrContinueOAuthAuthorizationResponse302Headers

type BeginOrContinueOAuthAuthorizationResponse302Headers struct {
	Location string
}

BeginOrContinueOAuthAuthorizationResponse302Headers the declared response headers of an HTTP 302 response for BeginOrContinueOAuthAuthorization

type CameraDeviceKind

type CameraDeviceKind = restmodels.CameraDeviceKind

type Capabilities

type Capabilities = restmodels.Capabilities

type CapturedTickets

type CapturedTickets = restmodels.CapturedTickets

type ChimeDeviceKind

type ChimeDeviceKind = restmodels.ChimeDeviceKind

type ChimeSettings

type ChimeSettings = restmodels.ChimeSettings

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BeginOrContinueOAuthAuthorization

func (c *Client) BeginOrContinueOAuthAuthorization(ctx context.Context, params *BeginOrContinueOAuthAuthorizationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

BeginOrContinueOAuthAuthorization Start or continue OAuth sign-in

Starts an OAuth authorization session and requests an authorization code. Redirects may continue an existing sign-in session.

Corresponds with GET /oauth/v2/authorize (the `BeginOrContinueOAuthAuthorization` operationId).

func (*Client) DeleteRecording

func (c *Client) DeleteRecording(ctx context.Context, recordingId RecordingId, params *DeleteRecordingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteRecording Delete a recording

Deletes a recording. A confirmation parameter may be required for a favorited recording.

Corresponds with DELETE /clients_api/dings/{recording_id} (the `DeleteRecording` operationId).

func (*Client) ExchangeOrRefreshOAuthTokenWithBody

func (c *Client) ExchangeOrRefreshOAuthTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ExchangeOrRefreshOAuthTokenWithBody Exchange or refresh an OAuth token

Exchanges an authorization grant for access tokens or refreshes an existing token.

Takes any type of body and a specified content type.

Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).

func (*Client) ExchangeOrRefreshOAuthTokenWithFormdataBody

func (c *Client) ExchangeOrRefreshOAuthTokenWithFormdataBody(ctx context.Context, body ExchangeOrRefreshOAuthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ExchangeOrRefreshOAuthTokenWithFormdataBody Exchange or refresh an OAuth token

Exchanges an authorization grant for access tokens or refreshes an existing token.

Takes a body of the `application/x-www-form-urlencoded` content type.

Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).

func (*Client) FavoriteRecording

func (c *Client) FavoriteRecording(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

FavoriteRecording Favorite a recording

Marks a recording as a favorite.

Corresponds with PUT /clients_api/dings/{recording_id}/favorite (the `FavoriteRecording` operationId).

func (*Client) GetActiveDings

func (c *Client) GetActiveDings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetActiveDings List active alerts

Retrieves currently active Ring alerts.

Corresponds with GET /clients_api/dings/active (the `GetActiveDings` operationId).

func (*Client) GetCapturedLocationTickets

func (c *Client) GetCapturedLocationTickets(ctx context.Context, params *GetCapturedLocationTicketsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetCapturedLocationTickets Get location signaling tickets

Retrieves signaling tickets and connection metadata for a location.

Corresponds with GET /api/v1/clap/tickets (the `GetCapturedLocationTickets` operationId).

func (*Client) GetDevice

func (c *Client) GetDevice(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetDevice Get a device

Retrieves details for a specific device.

Corresponds with GET /device_info/v3/devices/{device_id} (the `GetDevice` operationId).

func (*Client) GetDeviceSettings

func (c *Client) GetDeviceSettings(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetDeviceSettings Get device settings

Retrieves the current settings for a device.

Corresponds with GET /devices/v1/devices/{device_id}/settings (the `GetDeviceSettings` operationId).

func (*Client) GetDeviceTimeline

func (c *Client) GetDeviceTimeline(ctx context.Context, deviceId DeviceId, params *GetDeviceTimelineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetDeviceTimeline Get a device timeline

Retrieves timeline events for a device within an optional time range.

Corresponds with GET /evm/v2/timeline/devices/{device_id} (the `GetDeviceTimeline` operationId).

func (*Client) GetHistoryDevices

func (c *Client) GetHistoryDevices(ctx context.Context, params *GetHistoryDevicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetHistoryDevices List account history events

Retrieves account history events and feed items, with optional source and capability filters.

Corresponds with GET /evm/v3/history/devices (the `GetHistoryDevices` operationId).

func (*Client) GetLegacyDeviceHealth

func (c *Client) GetLegacyDeviceHealth(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLegacyDeviceHealth Get device health

Retrieves health information for a Ring device.

Corresponds with GET /clients_api/ring_devices/{device_id}/health (the `GetLegacyDeviceHealth` operationId).

func (*Client) GetLegacyDeviceHistory

func (c *Client) GetLegacyDeviceHistory(ctx context.Context, deviceId DeviceId, params *GetLegacyDeviceHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLegacyDeviceHistory List doorbell recordings

Retrieves recordings associated with a doorbell, with optional filters and pagination.

Corresponds with GET /clients_api/doorbots/{device_id}/history (the `GetLegacyDeviceHistory` operationId).

func (*Client) GetLegacyRecordingShareURL

func (c *Client) GetLegacyRecordingShareURL(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLegacyRecordingShareURL Get a recording share URL

Retrieves the playback share link for a recording.

Corresponds with GET /clients_api/dings/{recording_id}/share/play (the `GetLegacyRecordingShareURL` operationId).

func (*Client) GetLegacySnapshotImage

func (c *Client) GetLegacySnapshotImage(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLegacySnapshotImage Get a snapshot image

Retrieves a device snapshot as JPEG image data.

Corresponds with GET /clients_api/snapshots/image/{device_id} (the `GetLegacySnapshotImage` operationId).

func (*Client) GetLocation

func (c *Client) GetLocation(ctx context.Context, locationId LocationId, params *GetLocationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetLocation Get a location

Retrieves details for a specific location, with optional related resources.

Corresponds with GET /location_info/v4/locations/{location_id} (the `GetLocation` operationId).

func (*Client) ListDevices

func (c *Client) ListDevices(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ListDevices List devices

Retrieves the devices available to the authenticated account.

Corresponds with GET /device_info/v3/devices (the `ListDevices` operationId).

func (*Client) ListLocationDevices

func (c *Client) ListLocationDevices(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*http.Response, error)

ListLocationDevices List devices at a location

Retrieves the devices assigned to a location.

Corresponds with GET /groups/v1/locations/{location_id}/devices (the `ListLocationDevices` operationId).

func (*Client) ListLocationGroups

func (c *Client) ListLocationGroups(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*http.Response, error)

ListLocationGroups List device groups at a location

Retrieves device groups configured for a location.

Corresponds with GET /groups/v1/locations/{location_id}/groups (the `ListLocationGroups` operationId).

func (*Client) ListLocations

func (c *Client) ListLocations(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ListLocations List locations

Retrieves locations available to the authenticated account.

Corresponds with GET /location_info/v3/locations (the `ListLocations` operationId).

func (*Client) PatchDeviceSettings

func (c *Client) PatchDeviceSettings(ctx context.Context, deviceId DeviceId, body PatchDeviceSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchDeviceSettings Update device settings

Updates one or more supported settings for a device.

Takes a body of the `application/json` content type.

Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).

func (*Client) PatchDeviceSettingsWithBody

func (c *Client) PatchDeviceSettingsWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PatchDeviceSettingsWithBody Update device settings

Updates one or more supported settings for a device.

Takes any type of body and a specified content type.

Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).

func (*Client) RefreshLegacySnapshotTimestamp

func (c *Client) RefreshLegacySnapshotTimestamp(ctx context.Context, body RefreshLegacySnapshotTimestampJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RefreshLegacySnapshotTimestamp Request a snapshot timestamp

Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.

Takes a body of the `application/json` content type.

Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).

func (*Client) RefreshLegacySnapshotTimestampWithBody

func (c *Client) RefreshLegacySnapshotTimestampWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RefreshLegacySnapshotTimestampWithBody Request a snapshot timestamp

Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.

Takes any type of body and a specified content type.

Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).

func (*Client) RegisterClientSession

func (c *Client) RegisterClientSession(ctx context.Context, body RegisterClientSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterClientSession Register a client session

Registers a client session that can be used for device inventory and signaling requests.

Takes a body of the `application/json` content type.

Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).

func (*Client) RegisterClientSessionWithBody

func (c *Client) RegisterClientSessionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterClientSessionWithBody Register a client session

Registers a client session that can be used for device inventory and signaling requests.

Takes any type of body and a specified content type.

Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).

func (*Client) RegisterPushDevice

func (c *Client) RegisterPushDevice(ctx context.Context, body RegisterPushDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterPushDevice Register a push notification device

Registers a push notification token so the device can receive Ring alerts.

Takes a body of the `application/json` content type.

Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).

func (*Client) RegisterPushDeviceWithBody

func (c *Client) RegisterPushDeviceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

RegisterPushDeviceWithBody Register a push notification device

Registers a push notification token so the device can receive Ring alerts.

Takes any type of body and a specified content type.

Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).

func (*Client) RequestLegacySignalingTicket

func (c *Client) RequestLegacySignalingTicket(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

RequestLegacySignalingTicket Request a signaling ticket

Requests a signaling ticket used to establish a device connection.

Corresponds with POST /api/v1/clap/ticket/request/signalsocket (the `RequestLegacySignalingTicket` operationId).

func (*Client) SendDeviceCommand

func (c *Client) SendDeviceCommand(ctx context.Context, deviceId DeviceId, body SendDeviceCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SendDeviceCommand Send a device command

Sends a command to a device and returns when Ring accepts it.

Takes a body of the `application/json` content type.

Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).

func (*Client) SendDeviceCommandWithBody

func (c *Client) SendDeviceCommandWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SendDeviceCommandWithBody Send a device command

Sends a command to a device and returns when Ring accepts it.

Takes any type of body and a specified content type.

Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).

func (*Client) SetChimeVolume

func (c *Client) SetChimeVolume(ctx context.Context, deviceId DeviceId, params *SetChimeVolumeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SetChimeVolume Set chime volume

Changes a chime device’s playback volume.

Corresponds with PUT /clients_api/chimes/{device_id} (the `SetChimeVolume` operationId).

func (*Client) SetLiveViewEnabled

func (c *Client) SetLiveViewEnabled(ctx context.Context, deviceId DeviceId, body SetLiveViewEnabledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SetLiveViewEnabled Set live view availability

Enables or disables live view for a device.

Takes a body of the `application/json` content type.

Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).

func (*Client) SetLiveViewEnabledWithBody

func (c *Client) SetLiveViewEnabledWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SetLiveViewEnabledWithBody Set live view availability

Enables or disables live view for a device.

Takes any type of body and a specified content type.

Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).

func (*Client) StreamRecording

func (c *Client) StreamRecording(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

StreamRecording Stream a recording

Returns the recording media as an MP4 stream.

Corresponds with GET /clients_api/dings/{recording_id}/recording (the `StreamRecording` operationId).

func (*Client) SubmitOAuthCredentialsWithBody

func (c *Client) SubmitOAuthCredentialsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SubmitOAuthCredentialsWithBody Submit OAuth credentials

Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.

Takes any type of body and a specified content type.

Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).

func (*Client) SubmitOAuthCredentialsWithFormdataBody

func (c *Client) SubmitOAuthCredentialsWithFormdataBody(ctx context.Context, body SubmitOAuthCredentialsFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SubmitOAuthCredentialsWithFormdataBody Submit OAuth credentials

Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.

Takes a body of the `application/x-www-form-urlencoded` content type.

Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).

func (*Client) SubscribeDeviceDing

func (c *Client) SubscribeDeviceDing(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

SubscribeDeviceDing Subscribe to device alerts

Subscribes to alert notifications from a doorbell device.

Corresponds with POST /clients_api/doorbots/{device_id}/subscribe (the `SubscribeDeviceDing` operationId).

func (*Client) SubscribeDeviceMotion

func (c *Client) SubscribeDeviceMotion(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

SubscribeDeviceMotion Subscribe to motion alerts

Subscribes to motion notifications from a doorbell device.

Corresponds with POST /clients_api/doorbots/{device_id}/motions_subscribe (the `SubscribeDeviceMotion` operationId).

func (*Client) TestChimeSound

func (c *Client) TestChimeSound(ctx context.Context, deviceId DeviceId, params *TestChimeSoundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

TestChimeSound Play a chime sound

Plays a selected test sound on a chime device.

Corresponds with POST /clients_api/chimes/{device_id}/play_sound (the `TestChimeSound` operationId).

func (*Client) TurnFloodlightOff

func (c *Client) TurnFloodlightOff(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

TurnFloodlightOff Turn off a floodlight

Turns off a device’s floodlight.

Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_off (the `TurnFloodlightOff` operationId).

func (*Client) TurnFloodlightOn

func (c *Client) TurnFloodlightOn(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

TurnFloodlightOn Turn on a floodlight

Turns on a device’s floodlight.

Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_on (the `TurnFloodlightOn` operationId).

func (*Client) TurnSirenOff

func (c *Client) TurnSirenOff(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

TurnSirenOff Turn off a siren

Stops the siren on a doorbell device.

Corresponds with PUT /clients_api/doorbots/{device_id}/siren_off (the `TurnSirenOff` operationId).

func (*Client) TurnSirenOn

func (c *Client) TurnSirenOn(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

TurnSirenOn Turn on a siren

Activates the siren on a doorbell device.

Corresponds with PUT /clients_api/doorbots/{device_id}/siren_on (the `TurnSirenOn` operationId).

func (*Client) UnlockIntercom

func (c *Client) UnlockIntercom(ctx context.Context, deviceId DeviceId, body UnlockIntercomJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UnlockIntercom Unlock an intercom

Sends an unlock command to an intercom device.

Takes a body of the `application/json` content type.

Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).

func (*Client) UnlockIntercomWithBody

func (c *Client) UnlockIntercomWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UnlockIntercomWithBody Unlock an intercom

Sends an unlock command to an intercom device.

Takes any type of body and a specified content type.

Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).

func (*Client) UpdateLegacyDoorbotControls

func (c *Client) UpdateLegacyDoorbotControls(ctx context.Context, deviceId DeviceId, params *UpdateLegacyDoorbotControlsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateLegacyDoorbotControls Update doorbell and chime settings

Changes supported doorbell volume or in-home chime settings.

Corresponds with PUT /clients_api/doorbots/{device_id} (the `UpdateLegacyDoorbotControls` operationId).

func (*Client) VerifyOAuthTwoFactorCodeWithBody

func (c *Client) VerifyOAuthTwoFactorCodeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

VerifyOAuthTwoFactorCodeWithBody Verify an OAuth two-factor code

Submits a two-factor authentication code to complete OAuth sign-in.

Takes any type of body and a specified content type.

Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).

func (*Client) VerifyOAuthTwoFactorCodeWithFormdataBody

func (c *Client) VerifyOAuthTwoFactorCodeWithFormdataBody(ctx context.Context, body VerifyOAuthTwoFactorCodeFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

VerifyOAuthTwoFactorCodeWithFormdataBody Verify an OAuth two-factor code

Submits a two-factor authentication code to complete OAuth sign-in.

Takes a body of the `application/x-www-form-urlencoded` content type.

Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).

type ClientDeviceModel added in v0.7.0

type ClientDeviceModel = restmodels.ClientDeviceModel

type ClientInterface

type ClientInterface interface {

	// RequestLegacySignalingTicket Request a signaling ticket
	//
	// Requests a signaling ticket used to establish a device connection.
	//
	// Corresponds with POST /api/v1/clap/ticket/request/signalsocket (the `RequestLegacySignalingTicket` operationId).
	RequestLegacySignalingTicket(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCapturedLocationTickets Get location signaling tickets
	//
	// Retrieves signaling tickets and connection metadata for a location.
	//
	// Corresponds with GET /api/v1/clap/tickets (the `GetCapturedLocationTickets` operationId).
	GetCapturedLocationTickets(ctx context.Context, params *GetCapturedLocationTicketsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetChimeVolume Set chime volume
	//
	// Changes a chime device’s playback volume.
	//
	// Corresponds with PUT /clients_api/chimes/{device_id} (the `SetChimeVolume` operationId).
	SetChimeVolume(ctx context.Context, deviceId DeviceId, params *SetChimeVolumeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TestChimeSound Play a chime sound
	//
	// Plays a selected test sound on a chime device.
	//
	// Corresponds with POST /clients_api/chimes/{device_id}/play_sound (the `TestChimeSound` operationId).
	TestChimeSound(ctx context.Context, deviceId DeviceId, params *TestChimeSoundParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterPushDeviceWithBody Register a push notification device
	//
	// Registers a push notification token so the device can receive Ring alerts.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).
	RegisterPushDeviceWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterPushDevice Register a push notification device
	//
	// Registers a push notification token so the device can receive Ring alerts.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).
	RegisterPushDevice(ctx context.Context, body RegisterPushDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetActiveDings List active alerts
	//
	// Retrieves currently active Ring alerts.
	//
	// Corresponds with GET /clients_api/dings/active (the `GetActiveDings` operationId).
	GetActiveDings(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteRecording Delete a recording
	//
	// Deletes a recording. A confirmation parameter may be required for a favorited recording.
	//
	// Corresponds with DELETE /clients_api/dings/{recording_id} (the `DeleteRecording` operationId).
	DeleteRecording(ctx context.Context, recordingId RecordingId, params *DeleteRecordingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// FavoriteRecording Favorite a recording
	//
	// Marks a recording as a favorite.
	//
	// Corresponds with PUT /clients_api/dings/{recording_id}/favorite (the `FavoriteRecording` operationId).
	FavoriteRecording(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StreamRecording Stream a recording
	//
	// Returns the recording media as an MP4 stream.
	//
	// Corresponds with GET /clients_api/dings/{recording_id}/recording (the `StreamRecording` operationId).
	StreamRecording(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLegacyRecordingShareURL Get a recording share URL
	//
	// Retrieves the playback share link for a recording.
	//
	// Corresponds with GET /clients_api/dings/{recording_id}/share/play (the `GetLegacyRecordingShareURL` operationId).
	GetLegacyRecordingShareURL(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateLegacyDoorbotControls Update doorbell and chime settings
	//
	// Changes supported doorbell volume or in-home chime settings.
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id} (the `UpdateLegacyDoorbotControls` operationId).
	UpdateLegacyDoorbotControls(ctx context.Context, deviceId DeviceId, params *UpdateLegacyDoorbotControlsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TurnFloodlightOff Turn off a floodlight
	//
	// Turns off a device’s floodlight.
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_off (the `TurnFloodlightOff` operationId).
	TurnFloodlightOff(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TurnFloodlightOn Turn on a floodlight
	//
	// Turns on a device’s floodlight.
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_on (the `TurnFloodlightOn` operationId).
	TurnFloodlightOn(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLegacyDeviceHistory List doorbell recordings
	//
	// Retrieves recordings associated with a doorbell, with optional filters and pagination.
	//
	// Corresponds with GET /clients_api/doorbots/{device_id}/history (the `GetLegacyDeviceHistory` operationId).
	GetLegacyDeviceHistory(ctx context.Context, deviceId DeviceId, params *GetLegacyDeviceHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubscribeDeviceMotion Subscribe to motion alerts
	//
	// Subscribes to motion notifications from a doorbell device.
	//
	// Corresponds with POST /clients_api/doorbots/{device_id}/motions_subscribe (the `SubscribeDeviceMotion` operationId).
	SubscribeDeviceMotion(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TurnSirenOff Turn off a siren
	//
	// Stops the siren on a doorbell device.
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/siren_off (the `TurnSirenOff` operationId).
	TurnSirenOff(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TurnSirenOn Turn on a siren
	//
	// Activates the siren on a doorbell device.
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/siren_on (the `TurnSirenOn` operationId).
	TurnSirenOn(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubscribeDeviceDing Subscribe to device alerts
	//
	// Subscribes to alert notifications from a doorbell device.
	//
	// Corresponds with POST /clients_api/doorbots/{device_id}/subscribe (the `SubscribeDeviceDing` operationId).
	SubscribeDeviceDing(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLegacyDeviceHealth Get device health
	//
	// Retrieves health information for a Ring device.
	//
	// Corresponds with GET /clients_api/ring_devices/{device_id}/health (the `GetLegacyDeviceHealth` operationId).
	GetLegacyDeviceHealth(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterClientSessionWithBody Register a client session
	//
	// Registers a client session that can be used for device inventory and signaling requests.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).
	RegisterClientSessionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterClientSession Register a client session
	//
	// Registers a client session that can be used for device inventory and signaling requests.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).
	RegisterClientSession(ctx context.Context, body RegisterClientSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLegacySnapshotImage Get a snapshot image
	//
	// Retrieves a device snapshot as JPEG image data.
	//
	// Corresponds with GET /clients_api/snapshots/image/{device_id} (the `GetLegacySnapshotImage` operationId).
	GetLegacySnapshotImage(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RefreshLegacySnapshotTimestampWithBody Request a snapshot timestamp
	//
	// Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).
	RefreshLegacySnapshotTimestampWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RefreshLegacySnapshotTimestamp Request a snapshot timestamp
	//
	// Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).
	RefreshLegacySnapshotTimestamp(ctx context.Context, body RefreshLegacySnapshotTimestampJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SendDeviceCommandWithBody Send a device command
	//
	// Sends a command to a device and returns when Ring accepts it.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).
	SendDeviceCommandWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SendDeviceCommand Send a device command
	//
	// Sends a command to a device and returns when Ring accepts it.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).
	SendDeviceCommand(ctx context.Context, deviceId DeviceId, body SendDeviceCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnlockIntercomWithBody Unlock an intercom
	//
	// Sends an unlock command to an intercom device.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).
	UnlockIntercomWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnlockIntercom Unlock an intercom
	//
	// Sends an unlock command to an intercom device.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).
	UnlockIntercom(ctx context.Context, deviceId DeviceId, body UnlockIntercomJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDevices List devices
	//
	// Retrieves the devices available to the authenticated account.
	//
	// Corresponds with GET /device_info/v3/devices (the `ListDevices` operationId).
	ListDevices(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDevice Get a device
	//
	// Retrieves details for a specific device.
	//
	// Corresponds with GET /device_info/v3/devices/{device_id} (the `GetDevice` operationId).
	GetDevice(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDeviceSettings Get device settings
	//
	// Retrieves the current settings for a device.
	//
	// Corresponds with GET /devices/v1/devices/{device_id}/settings (the `GetDeviceSettings` operationId).
	GetDeviceSettings(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchDeviceSettingsWithBody Update device settings
	//
	// Updates one or more supported settings for a device.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).
	PatchDeviceSettingsWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchDeviceSettings Update device settings
	//
	// Updates one or more supported settings for a device.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).
	PatchDeviceSettings(ctx context.Context, deviceId DeviceId, body PatchDeviceSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetLiveViewEnabledWithBody Set live view availability
	//
	// Enables or disables live view for a device.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).
	SetLiveViewEnabledWithBody(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetLiveViewEnabled Set live view availability
	//
	// Enables or disables live view for a device.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).
	SetLiveViewEnabled(ctx context.Context, deviceId DeviceId, body SetLiveViewEnabledJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetDeviceTimeline Get a device timeline
	//
	// Retrieves timeline events for a device within an optional time range.
	//
	// Corresponds with GET /evm/v2/timeline/devices/{device_id} (the `GetDeviceTimeline` operationId).
	GetDeviceTimeline(ctx context.Context, deviceId DeviceId, params *GetDeviceTimelineParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoryDevices List account history events
	//
	// Retrieves account history events and feed items, with optional source and capability filters.
	//
	// Corresponds with GET /evm/v3/history/devices (the `GetHistoryDevices` operationId).
	GetHistoryDevices(ctx context.Context, params *GetHistoryDevicesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListLocationDevices List devices at a location
	//
	// Retrieves the devices assigned to a location.
	//
	// Corresponds with GET /groups/v1/locations/{location_id}/devices (the `ListLocationDevices` operationId).
	ListLocationDevices(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListLocationGroups List device groups at a location
	//
	// Retrieves device groups configured for a location.
	//
	// Corresponds with GET /groups/v1/locations/{location_id}/groups (the `ListLocationGroups` operationId).
	ListLocationGroups(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListLocations List locations
	//
	// Retrieves locations available to the authenticated account.
	//
	// Corresponds with GET /location_info/v3/locations (the `ListLocations` operationId).
	ListLocations(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLocation Get a location
	//
	// Retrieves details for a specific location, with optional related resources.
	//
	// Corresponds with GET /location_info/v4/locations/{location_id} (the `GetLocation` operationId).
	GetLocation(ctx context.Context, locationId LocationId, params *GetLocationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeOrRefreshOAuthTokenWithBody Exchange or refresh an OAuth token
	//
	// Exchanges an authorization grant for access tokens or refreshes an existing token.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).
	ExchangeOrRefreshOAuthTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExchangeOrRefreshOAuthTokenWithFormdataBody Exchange or refresh an OAuth token
	//
	// Exchanges an authorization grant for access tokens or refreshes an existing token.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type.
	//
	// Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).
	ExchangeOrRefreshOAuthTokenWithFormdataBody(ctx context.Context, body ExchangeOrRefreshOAuthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// VerifyOAuthTwoFactorCodeWithBody Verify an OAuth two-factor code
	//
	// Submits a two-factor authentication code to complete OAuth sign-in.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).
	VerifyOAuthTwoFactorCodeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// VerifyOAuthTwoFactorCodeWithFormdataBody Verify an OAuth two-factor code
	//
	// Submits a two-factor authentication code to complete OAuth sign-in.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type.
	//
	// Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).
	VerifyOAuthTwoFactorCodeWithFormdataBody(ctx context.Context, body VerifyOAuthTwoFactorCodeFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BeginOrContinueOAuthAuthorization Start or continue OAuth sign-in
	//
	// Starts an OAuth authorization session and requests an authorization code. Redirects may continue an existing sign-in session.
	//
	// Corresponds with GET /oauth/v2/authorize (the `BeginOrContinueOAuthAuthorization` operationId).
	BeginOrContinueOAuthAuthorization(ctx context.Context, params *BeginOrContinueOAuthAuthorizationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubmitOAuthCredentialsWithBody Submit OAuth credentials
	//
	// Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).
	SubmitOAuthCredentialsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubmitOAuthCredentialsWithFormdataBody Submit OAuth credentials
	//
	// Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type.
	//
	// Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).
	SubmitOAuthCredentialsWithFormdataBody(ctx context.Context, body SubmitOAuthCredentialsFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientSessionRegistration

type ClientSessionRegistration = restmodels.ClientSessionRegistration

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) BeginOrContinueOAuthAuthorizationWithResponse

func (c *ClientWithResponses) BeginOrContinueOAuthAuthorizationWithResponse(ctx context.Context, params *BeginOrContinueOAuthAuthorizationParams, reqEditors ...RequestEditorFn) (*BeginOrContinueOAuthAuthorizationResponse, error)

BeginOrContinueOAuthAuthorizationWithResponse Start or continue OAuth sign-in

Starts an OAuth authorization session and requests an authorization code. Redirects may continue an existing sign-in session.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /oauth/v2/authorize (the `BeginOrContinueOAuthAuthorization` operationId).

func (*ClientWithResponses) DeleteRecordingWithResponse

func (c *ClientWithResponses) DeleteRecordingWithResponse(ctx context.Context, recordingId RecordingId, params *DeleteRecordingParams, reqEditors ...RequestEditorFn) (*DeleteRecordingResponse, error)

DeleteRecordingWithResponse Delete a recording

Deletes a recording. A confirmation parameter may be required for a favorited recording.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /clients_api/dings/{recording_id} (the `DeleteRecording` operationId).

func (*ClientWithResponses) ExchangeOrRefreshOAuthTokenWithBodyWithResponse

func (c *ClientWithResponses) ExchangeOrRefreshOAuthTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExchangeOrRefreshOAuthTokenResponse, error)

ExchangeOrRefreshOAuthTokenWithBodyWithResponse Exchange or refresh an OAuth token

Exchanges an authorization grant for access tokens or refreshes an existing token.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).

func (*ClientWithResponses) ExchangeOrRefreshOAuthTokenWithFormdataBodyWithResponse

func (c *ClientWithResponses) ExchangeOrRefreshOAuthTokenWithFormdataBodyWithResponse(ctx context.Context, body ExchangeOrRefreshOAuthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*ExchangeOrRefreshOAuthTokenResponse, error)

ExchangeOrRefreshOAuthTokenWithFormdataBodyWithResponse Exchange or refresh an OAuth token

Exchanges an authorization grant for access tokens or refreshes an existing token.

Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).

func (*ClientWithResponses) FavoriteRecordingWithResponse

func (c *ClientWithResponses) FavoriteRecordingWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*FavoriteRecordingResponse, error)

FavoriteRecordingWithResponse Favorite a recording

Marks a recording as a favorite.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/dings/{recording_id}/favorite (the `FavoriteRecording` operationId).

func (*ClientWithResponses) GetActiveDingsWithResponse

func (c *ClientWithResponses) GetActiveDingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetActiveDingsResponse, error)

GetActiveDingsWithResponse List active alerts

Retrieves currently active Ring alerts.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/dings/active (the `GetActiveDings` operationId).

func (*ClientWithResponses) GetCapturedLocationTicketsWithResponse

func (c *ClientWithResponses) GetCapturedLocationTicketsWithResponse(ctx context.Context, params *GetCapturedLocationTicketsParams, reqEditors ...RequestEditorFn) (*GetCapturedLocationTicketsResponse, error)

GetCapturedLocationTicketsWithResponse Get location signaling tickets

Retrieves signaling tickets and connection metadata for a location.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/clap/tickets (the `GetCapturedLocationTickets` operationId).

func (*ClientWithResponses) GetDeviceSettingsWithResponse

func (c *ClientWithResponses) GetDeviceSettingsWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetDeviceSettingsResponse, error)

GetDeviceSettingsWithResponse Get device settings

Retrieves the current settings for a device.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /devices/v1/devices/{device_id}/settings (the `GetDeviceSettings` operationId).

func (*ClientWithResponses) GetDeviceTimelineWithResponse

func (c *ClientWithResponses) GetDeviceTimelineWithResponse(ctx context.Context, deviceId DeviceId, params *GetDeviceTimelineParams, reqEditors ...RequestEditorFn) (*GetDeviceTimelineResponse, error)

GetDeviceTimelineWithResponse Get a device timeline

Retrieves timeline events for a device within an optional time range.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /evm/v2/timeline/devices/{device_id} (the `GetDeviceTimeline` operationId).

func (*ClientWithResponses) GetDeviceWithResponse

func (c *ClientWithResponses) GetDeviceWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetDeviceResponse, error)

GetDeviceWithResponse Get a device

Retrieves details for a specific device.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /device_info/v3/devices/{device_id} (the `GetDevice` operationId).

func (*ClientWithResponses) GetHistoryDevicesWithResponse

func (c *ClientWithResponses) GetHistoryDevicesWithResponse(ctx context.Context, params *GetHistoryDevicesParams, reqEditors ...RequestEditorFn) (*GetHistoryDevicesResponse, error)

GetHistoryDevicesWithResponse List account history events

Retrieves account history events and feed items, with optional source and capability filters.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /evm/v3/history/devices (the `GetHistoryDevices` operationId).

func (*ClientWithResponses) GetLegacyDeviceHealthWithResponse

func (c *ClientWithResponses) GetLegacyDeviceHealthWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetLegacyDeviceHealthResponse, error)

GetLegacyDeviceHealthWithResponse Get device health

Retrieves health information for a Ring device.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/ring_devices/{device_id}/health (the `GetLegacyDeviceHealth` operationId).

func (*ClientWithResponses) GetLegacyDeviceHistoryWithResponse

func (c *ClientWithResponses) GetLegacyDeviceHistoryWithResponse(ctx context.Context, deviceId DeviceId, params *GetLegacyDeviceHistoryParams, reqEditors ...RequestEditorFn) (*GetLegacyDeviceHistoryResponse, error)

GetLegacyDeviceHistoryWithResponse List doorbell recordings

Retrieves recordings associated with a doorbell, with optional filters and pagination.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/doorbots/{device_id}/history (the `GetLegacyDeviceHistory` operationId).

func (*ClientWithResponses) GetLegacyRecordingShareURLWithResponse

func (c *ClientWithResponses) GetLegacyRecordingShareURLWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*GetLegacyRecordingShareURLResponse, error)

GetLegacyRecordingShareURLWithResponse Get a recording share URL

Retrieves the playback share link for a recording.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/dings/{recording_id}/share/play (the `GetLegacyRecordingShareURL` operationId).

func (*ClientWithResponses) GetLegacySnapshotImageWithResponse

func (c *ClientWithResponses) GetLegacySnapshotImageWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetLegacySnapshotImageResponse, error)

GetLegacySnapshotImageWithResponse Get a snapshot image

Retrieves a device snapshot as JPEG image data.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/snapshots/image/{device_id} (the `GetLegacySnapshotImage` operationId).

func (*ClientWithResponses) GetLocationWithResponse

func (c *ClientWithResponses) GetLocationWithResponse(ctx context.Context, locationId LocationId, params *GetLocationParams, reqEditors ...RequestEditorFn) (*GetLocationResponse, error)

GetLocationWithResponse Get a location

Retrieves details for a specific location, with optional related resources.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /location_info/v4/locations/{location_id} (the `GetLocation` operationId).

func (*ClientWithResponses) ListDevicesWithResponse

func (c *ClientWithResponses) ListDevicesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDevicesResponse, error)

ListDevicesWithResponse List devices

Retrieves the devices available to the authenticated account.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /device_info/v3/devices (the `ListDevices` operationId).

func (*ClientWithResponses) ListLocationDevicesWithResponse

func (c *ClientWithResponses) ListLocationDevicesWithResponse(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*ListLocationDevicesResponse, error)

ListLocationDevicesWithResponse List devices at a location

Retrieves the devices assigned to a location.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /groups/v1/locations/{location_id}/devices (the `ListLocationDevices` operationId).

func (*ClientWithResponses) ListLocationGroupsWithResponse

func (c *ClientWithResponses) ListLocationGroupsWithResponse(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*ListLocationGroupsResponse, error)

ListLocationGroupsWithResponse List device groups at a location

Retrieves device groups configured for a location.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /groups/v1/locations/{location_id}/groups (the `ListLocationGroups` operationId).

func (*ClientWithResponses) ListLocationsWithResponse

func (c *ClientWithResponses) ListLocationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListLocationsResponse, error)

ListLocationsWithResponse List locations

Retrieves locations available to the authenticated account.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /location_info/v3/locations (the `ListLocations` operationId).

func (*ClientWithResponses) PatchDeviceSettingsWithBodyWithResponse

func (c *ClientWithResponses) PatchDeviceSettingsWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchDeviceSettingsResponse, error)

PatchDeviceSettingsWithBodyWithResponse Update device settings

Updates one or more supported settings for a device.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).

func (*ClientWithResponses) PatchDeviceSettingsWithResponse

func (c *ClientWithResponses) PatchDeviceSettingsWithResponse(ctx context.Context, deviceId DeviceId, body PatchDeviceSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchDeviceSettingsResponse, error)

PatchDeviceSettingsWithResponse Update device settings

Updates one or more supported settings for a device.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).

func (*ClientWithResponses) RefreshLegacySnapshotTimestampWithBodyWithResponse

func (c *ClientWithResponses) RefreshLegacySnapshotTimestampWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshLegacySnapshotTimestampResponse, error)

RefreshLegacySnapshotTimestampWithBodyWithResponse Request a snapshot timestamp

Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).

func (*ClientWithResponses) RefreshLegacySnapshotTimestampWithResponse

func (c *ClientWithResponses) RefreshLegacySnapshotTimestampWithResponse(ctx context.Context, body RefreshLegacySnapshotTimestampJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshLegacySnapshotTimestampResponse, error)

RefreshLegacySnapshotTimestampWithResponse Request a snapshot timestamp

Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).

func (*ClientWithResponses) RegisterClientSessionWithBodyWithResponse

func (c *ClientWithResponses) RegisterClientSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterClientSessionResponse, error)

RegisterClientSessionWithBodyWithResponse Register a client session

Registers a client session that can be used for device inventory and signaling requests.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).

func (*ClientWithResponses) RegisterClientSessionWithResponse

func (c *ClientWithResponses) RegisterClientSessionWithResponse(ctx context.Context, body RegisterClientSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterClientSessionResponse, error)

RegisterClientSessionWithResponse Register a client session

Registers a client session that can be used for device inventory and signaling requests.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).

func (*ClientWithResponses) RegisterPushDeviceWithBodyWithResponse

func (c *ClientWithResponses) RegisterPushDeviceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterPushDeviceResponse, error)

RegisterPushDeviceWithBodyWithResponse Register a push notification device

Registers a push notification token so the device can receive Ring alerts.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).

func (*ClientWithResponses) RegisterPushDeviceWithResponse

func (c *ClientWithResponses) RegisterPushDeviceWithResponse(ctx context.Context, body RegisterPushDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterPushDeviceResponse, error)

RegisterPushDeviceWithResponse Register a push notification device

Registers a push notification token so the device can receive Ring alerts.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).

func (*ClientWithResponses) RequestLegacySignalingTicketWithResponse

func (c *ClientWithResponses) RequestLegacySignalingTicketWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RequestLegacySignalingTicketResponse, error)

RequestLegacySignalingTicketWithResponse Request a signaling ticket

Requests a signaling ticket used to establish a device connection.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/clap/ticket/request/signalsocket (the `RequestLegacySignalingTicket` operationId).

func (*ClientWithResponses) SendDeviceCommandWithBodyWithResponse

func (c *ClientWithResponses) SendDeviceCommandWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendDeviceCommandResponse, error)

SendDeviceCommandWithBodyWithResponse Send a device command

Sends a command to a device and returns when Ring accepts it.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).

func (*ClientWithResponses) SendDeviceCommandWithResponse

func (c *ClientWithResponses) SendDeviceCommandWithResponse(ctx context.Context, deviceId DeviceId, body SendDeviceCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*SendDeviceCommandResponse, error)

SendDeviceCommandWithResponse Send a device command

Sends a command to a device and returns when Ring accepts it.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).

func (*ClientWithResponses) SetChimeVolumeWithResponse

func (c *ClientWithResponses) SetChimeVolumeWithResponse(ctx context.Context, deviceId DeviceId, params *SetChimeVolumeParams, reqEditors ...RequestEditorFn) (*SetChimeVolumeResponse, error)

SetChimeVolumeWithResponse Set chime volume

Changes a chime device’s playback volume.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/chimes/{device_id} (the `SetChimeVolume` operationId).

func (*ClientWithResponses) SetLiveViewEnabledWithBodyWithResponse

func (c *ClientWithResponses) SetLiveViewEnabledWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetLiveViewEnabledResponse, error)

SetLiveViewEnabledWithBodyWithResponse Set live view availability

Enables or disables live view for a device.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).

func (*ClientWithResponses) SetLiveViewEnabledWithResponse

func (c *ClientWithResponses) SetLiveViewEnabledWithResponse(ctx context.Context, deviceId DeviceId, body SetLiveViewEnabledJSONRequestBody, reqEditors ...RequestEditorFn) (*SetLiveViewEnabledResponse, error)

SetLiveViewEnabledWithResponse Set live view availability

Enables or disables live view for a device.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).

func (*ClientWithResponses) StreamRecordingWithResponse

func (c *ClientWithResponses) StreamRecordingWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*StreamRecordingResponse, error)

StreamRecordingWithResponse Stream a recording

Returns the recording media as an MP4 stream.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /clients_api/dings/{recording_id}/recording (the `StreamRecording` operationId).

func (*ClientWithResponses) SubmitOAuthCredentialsWithBodyWithResponse

func (c *ClientWithResponses) SubmitOAuthCredentialsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitOAuthCredentialsResponse, error)

SubmitOAuthCredentialsWithBodyWithResponse Submit OAuth credentials

Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).

func (*ClientWithResponses) SubmitOAuthCredentialsWithFormdataBodyWithResponse

func (c *ClientWithResponses) SubmitOAuthCredentialsWithFormdataBodyWithResponse(ctx context.Context, body SubmitOAuthCredentialsFormdataRequestBody, reqEditors ...RequestEditorFn) (*SubmitOAuthCredentialsResponse, error)

SubmitOAuthCredentialsWithFormdataBodyWithResponse Submit OAuth credentials

Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.

Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).

func (*ClientWithResponses) SubscribeDeviceDingWithResponse

func (c *ClientWithResponses) SubscribeDeviceDingWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*SubscribeDeviceDingResponse, error)

SubscribeDeviceDingWithResponse Subscribe to device alerts

Subscribes to alert notifications from a doorbell device.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/doorbots/{device_id}/subscribe (the `SubscribeDeviceDing` operationId).

func (*ClientWithResponses) SubscribeDeviceMotionWithResponse

func (c *ClientWithResponses) SubscribeDeviceMotionWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*SubscribeDeviceMotionResponse, error)

SubscribeDeviceMotionWithResponse Subscribe to motion alerts

Subscribes to motion notifications from a doorbell device.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/doorbots/{device_id}/motions_subscribe (the `SubscribeDeviceMotion` operationId).

func (*ClientWithResponses) TestChimeSoundWithResponse

func (c *ClientWithResponses) TestChimeSoundWithResponse(ctx context.Context, deviceId DeviceId, params *TestChimeSoundParams, reqEditors ...RequestEditorFn) (*TestChimeSoundResponse, error)

TestChimeSoundWithResponse Play a chime sound

Plays a selected test sound on a chime device.

Returns a wrapper object for the known response body format(s).

Corresponds with POST /clients_api/chimes/{device_id}/play_sound (the `TestChimeSound` operationId).

func (*ClientWithResponses) TurnFloodlightOffWithResponse

func (c *ClientWithResponses) TurnFloodlightOffWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnFloodlightOffResponse, error)

TurnFloodlightOffWithResponse Turn off a floodlight

Turns off a device’s floodlight.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_off (the `TurnFloodlightOff` operationId).

func (*ClientWithResponses) TurnFloodlightOnWithResponse

func (c *ClientWithResponses) TurnFloodlightOnWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnFloodlightOnResponse, error)

TurnFloodlightOnWithResponse Turn on a floodlight

Turns on a device’s floodlight.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_on (the `TurnFloodlightOn` operationId).

func (*ClientWithResponses) TurnSirenOffWithResponse

func (c *ClientWithResponses) TurnSirenOffWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnSirenOffResponse, error)

TurnSirenOffWithResponse Turn off a siren

Stops the siren on a doorbell device.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/doorbots/{device_id}/siren_off (the `TurnSirenOff` operationId).

func (*ClientWithResponses) TurnSirenOnWithResponse

func (c *ClientWithResponses) TurnSirenOnWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnSirenOnResponse, error)

TurnSirenOnWithResponse Turn on a siren

Activates the siren on a doorbell device.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/doorbots/{device_id}/siren_on (the `TurnSirenOn` operationId).

func (*ClientWithResponses) UnlockIntercomWithBodyWithResponse

func (c *ClientWithResponses) UnlockIntercomWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnlockIntercomResponse, error)

UnlockIntercomWithBodyWithResponse Unlock an intercom

Sends an unlock command to an intercom device.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).

func (*ClientWithResponses) UnlockIntercomWithResponse

func (c *ClientWithResponses) UnlockIntercomWithResponse(ctx context.Context, deviceId DeviceId, body UnlockIntercomJSONRequestBody, reqEditors ...RequestEditorFn) (*UnlockIntercomResponse, error)

UnlockIntercomWithResponse Unlock an intercom

Sends an unlock command to an intercom device.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).

func (*ClientWithResponses) UpdateLegacyDoorbotControlsWithResponse

func (c *ClientWithResponses) UpdateLegacyDoorbotControlsWithResponse(ctx context.Context, deviceId DeviceId, params *UpdateLegacyDoorbotControlsParams, reqEditors ...RequestEditorFn) (*UpdateLegacyDoorbotControlsResponse, error)

UpdateLegacyDoorbotControlsWithResponse Update doorbell and chime settings

Changes supported doorbell volume or in-home chime settings.

Returns a wrapper object for the known response body format(s).

Corresponds with PUT /clients_api/doorbots/{device_id} (the `UpdateLegacyDoorbotControls` operationId).

func (*ClientWithResponses) VerifyOAuthTwoFactorCodeWithBodyWithResponse

func (c *ClientWithResponses) VerifyOAuthTwoFactorCodeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*VerifyOAuthTwoFactorCodeResponse, error)

VerifyOAuthTwoFactorCodeWithBodyWithResponse Verify an OAuth two-factor code

Submits a two-factor authentication code to complete OAuth sign-in.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).

func (*ClientWithResponses) VerifyOAuthTwoFactorCodeWithFormdataBodyWithResponse

func (c *ClientWithResponses) VerifyOAuthTwoFactorCodeWithFormdataBodyWithResponse(ctx context.Context, body VerifyOAuthTwoFactorCodeFormdataRequestBody, reqEditors ...RequestEditorFn) (*VerifyOAuthTwoFactorCodeResponse, error)

VerifyOAuthTwoFactorCodeWithFormdataBodyWithResponse Verify an OAuth two-factor code

Submits a two-factor authentication code to complete OAuth sign-in.

Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// RequestLegacySignalingTicketWithResponse Request a signaling ticket
	//
	// Requests a signaling ticket used to establish a device connection.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/clap/ticket/request/signalsocket (the `RequestLegacySignalingTicket` operationId).
	RequestLegacySignalingTicketWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RequestLegacySignalingTicketResponse, error)

	// GetCapturedLocationTicketsWithResponse Get location signaling tickets
	//
	// Retrieves signaling tickets and connection metadata for a location.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/clap/tickets (the `GetCapturedLocationTickets` operationId).
	GetCapturedLocationTicketsWithResponse(ctx context.Context, params *GetCapturedLocationTicketsParams, reqEditors ...RequestEditorFn) (*GetCapturedLocationTicketsResponse, error)

	// SetChimeVolumeWithResponse Set chime volume
	//
	// Changes a chime device’s playback volume.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/chimes/{device_id} (the `SetChimeVolume` operationId).
	SetChimeVolumeWithResponse(ctx context.Context, deviceId DeviceId, params *SetChimeVolumeParams, reqEditors ...RequestEditorFn) (*SetChimeVolumeResponse, error)

	// TestChimeSoundWithResponse Play a chime sound
	//
	// Plays a selected test sound on a chime device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/chimes/{device_id}/play_sound (the `TestChimeSound` operationId).
	TestChimeSoundWithResponse(ctx context.Context, deviceId DeviceId, params *TestChimeSoundParams, reqEditors ...RequestEditorFn) (*TestChimeSoundResponse, error)

	// RegisterPushDeviceWithBodyWithResponse Register a push notification device
	//
	// Registers a push notification token so the device can receive Ring alerts.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).
	RegisterPushDeviceWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterPushDeviceResponse, error)

	// RegisterPushDeviceWithResponse Register a push notification device
	//
	// Registers a push notification token so the device can receive Ring alerts.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /clients_api/device (the `RegisterPushDevice` operationId).
	RegisterPushDeviceWithResponse(ctx context.Context, body RegisterPushDeviceJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterPushDeviceResponse, error)

	// GetActiveDingsWithResponse List active alerts
	//
	// Retrieves currently active Ring alerts.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/dings/active (the `GetActiveDings` operationId).
	GetActiveDingsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetActiveDingsResponse, error)

	// DeleteRecordingWithResponse Delete a recording
	//
	// Deletes a recording. A confirmation parameter may be required for a favorited recording.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /clients_api/dings/{recording_id} (the `DeleteRecording` operationId).
	DeleteRecordingWithResponse(ctx context.Context, recordingId RecordingId, params *DeleteRecordingParams, reqEditors ...RequestEditorFn) (*DeleteRecordingResponse, error)

	// FavoriteRecordingWithResponse Favorite a recording
	//
	// Marks a recording as a favorite.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/dings/{recording_id}/favorite (the `FavoriteRecording` operationId).
	FavoriteRecordingWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*FavoriteRecordingResponse, error)

	// StreamRecordingWithResponse Stream a recording
	//
	// Returns the recording media as an MP4 stream.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/dings/{recording_id}/recording (the `StreamRecording` operationId).
	StreamRecordingWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*StreamRecordingResponse, error)

	// GetLegacyRecordingShareURLWithResponse Get a recording share URL
	//
	// Retrieves the playback share link for a recording.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/dings/{recording_id}/share/play (the `GetLegacyRecordingShareURL` operationId).
	GetLegacyRecordingShareURLWithResponse(ctx context.Context, recordingId RecordingId, reqEditors ...RequestEditorFn) (*GetLegacyRecordingShareURLResponse, error)

	// UpdateLegacyDoorbotControlsWithResponse Update doorbell and chime settings
	//
	// Changes supported doorbell volume or in-home chime settings.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id} (the `UpdateLegacyDoorbotControls` operationId).
	UpdateLegacyDoorbotControlsWithResponse(ctx context.Context, deviceId DeviceId, params *UpdateLegacyDoorbotControlsParams, reqEditors ...RequestEditorFn) (*UpdateLegacyDoorbotControlsResponse, error)

	// TurnFloodlightOffWithResponse Turn off a floodlight
	//
	// Turns off a device’s floodlight.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_off (the `TurnFloodlightOff` operationId).
	TurnFloodlightOffWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnFloodlightOffResponse, error)

	// TurnFloodlightOnWithResponse Turn on a floodlight
	//
	// Turns on a device’s floodlight.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/floodlight_light_on (the `TurnFloodlightOn` operationId).
	TurnFloodlightOnWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnFloodlightOnResponse, error)

	// GetLegacyDeviceHistoryWithResponse List doorbell recordings
	//
	// Retrieves recordings associated with a doorbell, with optional filters and pagination.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/doorbots/{device_id}/history (the `GetLegacyDeviceHistory` operationId).
	GetLegacyDeviceHistoryWithResponse(ctx context.Context, deviceId DeviceId, params *GetLegacyDeviceHistoryParams, reqEditors ...RequestEditorFn) (*GetLegacyDeviceHistoryResponse, error)

	// SubscribeDeviceMotionWithResponse Subscribe to motion alerts
	//
	// Subscribes to motion notifications from a doorbell device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/doorbots/{device_id}/motions_subscribe (the `SubscribeDeviceMotion` operationId).
	SubscribeDeviceMotionWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*SubscribeDeviceMotionResponse, error)

	// TurnSirenOffWithResponse Turn off a siren
	//
	// Stops the siren on a doorbell device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/siren_off (the `TurnSirenOff` operationId).
	TurnSirenOffWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnSirenOffResponse, error)

	// TurnSirenOnWithResponse Turn on a siren
	//
	// Activates the siren on a doorbell device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /clients_api/doorbots/{device_id}/siren_on (the `TurnSirenOn` operationId).
	TurnSirenOnWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*TurnSirenOnResponse, error)

	// SubscribeDeviceDingWithResponse Subscribe to device alerts
	//
	// Subscribes to alert notifications from a doorbell device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/doorbots/{device_id}/subscribe (the `SubscribeDeviceDing` operationId).
	SubscribeDeviceDingWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*SubscribeDeviceDingResponse, error)

	// GetLegacyDeviceHealthWithResponse Get device health
	//
	// Retrieves health information for a Ring device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/ring_devices/{device_id}/health (the `GetLegacyDeviceHealth` operationId).
	GetLegacyDeviceHealthWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetLegacyDeviceHealthResponse, error)

	// RegisterClientSessionWithBodyWithResponse Register a client session
	//
	// Registers a client session that can be used for device inventory and signaling requests.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).
	RegisterClientSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterClientSessionResponse, error)

	// RegisterClientSessionWithResponse Register a client session
	//
	// Registers a client session that can be used for device inventory and signaling requests.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/session (the `RegisterClientSession` operationId).
	RegisterClientSessionWithResponse(ctx context.Context, body RegisterClientSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterClientSessionResponse, error)

	// GetLegacySnapshotImageWithResponse Get a snapshot image
	//
	// Retrieves a device snapshot as JPEG image data.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /clients_api/snapshots/image/{device_id} (the `GetLegacySnapshotImage` operationId).
	GetLegacySnapshotImageWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetLegacySnapshotImageResponse, error)

	// RefreshLegacySnapshotTimestampWithBodyWithResponse Request a snapshot timestamp
	//
	// Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).
	RefreshLegacySnapshotTimestampWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RefreshLegacySnapshotTimestampResponse, error)

	// RefreshLegacySnapshotTimestampWithResponse Request a snapshot timestamp
	//
	// Requests the latest snapshot timestamp for a device. A timestamp can be used to retrieve the corresponding image.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /clients_api/snapshots/timestamps (the `RefreshLegacySnapshotTimestamp` operationId).
	RefreshLegacySnapshotTimestampWithResponse(ctx context.Context, body RefreshLegacySnapshotTimestampJSONRequestBody, reqEditors ...RequestEditorFn) (*RefreshLegacySnapshotTimestampResponse, error)

	// SendDeviceCommandWithBodyWithResponse Send a device command
	//
	// Sends a command to a device and returns when Ring accepts it.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).
	SendDeviceCommandWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendDeviceCommandResponse, error)

	// SendDeviceCommandWithResponse Send a device command
	//
	// Sends a command to a device and returns when Ring accepts it.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /commands/v1/devices/{device_id} (the `SendDeviceCommand` operationId).
	SendDeviceCommandWithResponse(ctx context.Context, deviceId DeviceId, body SendDeviceCommandJSONRequestBody, reqEditors ...RequestEditorFn) (*SendDeviceCommandResponse, error)

	// UnlockIntercomWithBodyWithResponse Unlock an intercom
	//
	// Sends an unlock command to an intercom device.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).
	UnlockIntercomWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnlockIntercomResponse, error)

	// UnlockIntercomWithResponse Unlock an intercom
	//
	// Sends an unlock command to an intercom device.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /commands/v1/devices/{device_id}/device_rpc (the `UnlockIntercom` operationId).
	UnlockIntercomWithResponse(ctx context.Context, deviceId DeviceId, body UnlockIntercomJSONRequestBody, reqEditors ...RequestEditorFn) (*UnlockIntercomResponse, error)

	// ListDevicesWithResponse List devices
	//
	// Retrieves the devices available to the authenticated account.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /device_info/v3/devices (the `ListDevices` operationId).
	ListDevicesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListDevicesResponse, error)

	// GetDeviceWithResponse Get a device
	//
	// Retrieves details for a specific device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /device_info/v3/devices/{device_id} (the `GetDevice` operationId).
	GetDeviceWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetDeviceResponse, error)

	// GetDeviceSettingsWithResponse Get device settings
	//
	// Retrieves the current settings for a device.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /devices/v1/devices/{device_id}/settings (the `GetDeviceSettings` operationId).
	GetDeviceSettingsWithResponse(ctx context.Context, deviceId DeviceId, reqEditors ...RequestEditorFn) (*GetDeviceSettingsResponse, error)

	// PatchDeviceSettingsWithBodyWithResponse Update device settings
	//
	// Updates one or more supported settings for a device.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).
	PatchDeviceSettingsWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchDeviceSettingsResponse, error)

	// PatchDeviceSettingsWithResponse Update device settings
	//
	// Updates one or more supported settings for a device.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /devices/v1/devices/{device_id}/settings (the `PatchDeviceSettings` operationId).
	PatchDeviceSettingsWithResponse(ctx context.Context, deviceId DeviceId, body PatchDeviceSettingsJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchDeviceSettingsResponse, error)

	// SetLiveViewEnabledWithBodyWithResponse Set live view availability
	//
	// Enables or disables live view for a device.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).
	SetLiveViewEnabledWithBodyWithResponse(ctx context.Context, deviceId DeviceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetLiveViewEnabledResponse, error)

	// SetLiveViewEnabledWithResponse Set live view availability
	//
	// Enables or disables live view for a device.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PUT /duos/v1/devices/{device_id}/update (the `SetLiveViewEnabled` operationId).
	SetLiveViewEnabledWithResponse(ctx context.Context, deviceId DeviceId, body SetLiveViewEnabledJSONRequestBody, reqEditors ...RequestEditorFn) (*SetLiveViewEnabledResponse, error)

	// GetDeviceTimelineWithResponse Get a device timeline
	//
	// Retrieves timeline events for a device within an optional time range.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /evm/v2/timeline/devices/{device_id} (the `GetDeviceTimeline` operationId).
	GetDeviceTimelineWithResponse(ctx context.Context, deviceId DeviceId, params *GetDeviceTimelineParams, reqEditors ...RequestEditorFn) (*GetDeviceTimelineResponse, error)

	// GetHistoryDevicesWithResponse List account history events
	//
	// Retrieves account history events and feed items, with optional source and capability filters.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /evm/v3/history/devices (the `GetHistoryDevices` operationId).
	GetHistoryDevicesWithResponse(ctx context.Context, params *GetHistoryDevicesParams, reqEditors ...RequestEditorFn) (*GetHistoryDevicesResponse, error)

	// ListLocationDevicesWithResponse List devices at a location
	//
	// Retrieves the devices assigned to a location.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /groups/v1/locations/{location_id}/devices (the `ListLocationDevices` operationId).
	ListLocationDevicesWithResponse(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*ListLocationDevicesResponse, error)

	// ListLocationGroupsWithResponse List device groups at a location
	//
	// Retrieves device groups configured for a location.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /groups/v1/locations/{location_id}/groups (the `ListLocationGroups` operationId).
	ListLocationGroupsWithResponse(ctx context.Context, locationId LocationId, reqEditors ...RequestEditorFn) (*ListLocationGroupsResponse, error)

	// ListLocationsWithResponse List locations
	//
	// Retrieves locations available to the authenticated account.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location_info/v3/locations (the `ListLocations` operationId).
	ListLocationsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListLocationsResponse, error)

	// GetLocationWithResponse Get a location
	//
	// Retrieves details for a specific location, with optional related resources.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /location_info/v4/locations/{location_id} (the `GetLocation` operationId).
	GetLocationWithResponse(ctx context.Context, locationId LocationId, params *GetLocationParams, reqEditors ...RequestEditorFn) (*GetLocationResponse, error)

	// ExchangeOrRefreshOAuthTokenWithBodyWithResponse Exchange or refresh an OAuth token
	//
	// Exchanges an authorization grant for access tokens or refreshes an existing token.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).
	ExchangeOrRefreshOAuthTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExchangeOrRefreshOAuthTokenResponse, error)

	// ExchangeOrRefreshOAuthTokenWithFormdataBodyWithResponse Exchange or refresh an OAuth token
	//
	// Exchanges an authorization grant for access tokens or refreshes an existing token.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/token (the `ExchangeOrRefreshOAuthToken` operationId).
	ExchangeOrRefreshOAuthTokenWithFormdataBodyWithResponse(ctx context.Context, body ExchangeOrRefreshOAuthTokenFormdataRequestBody, reqEditors ...RequestEditorFn) (*ExchangeOrRefreshOAuthTokenResponse, error)

	// VerifyOAuthTwoFactorCodeWithBodyWithResponse Verify an OAuth two-factor code
	//
	// Submits a two-factor authentication code to complete OAuth sign-in.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).
	VerifyOAuthTwoFactorCodeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*VerifyOAuthTwoFactorCodeResponse, error)

	// VerifyOAuthTwoFactorCodeWithFormdataBodyWithResponse Verify an OAuth two-factor code
	//
	// Submits a two-factor authentication code to complete OAuth sign-in.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/v2/2fa/verify (the `VerifyOAuthTwoFactorCode` operationId).
	VerifyOAuthTwoFactorCodeWithFormdataBodyWithResponse(ctx context.Context, body VerifyOAuthTwoFactorCodeFormdataRequestBody, reqEditors ...RequestEditorFn) (*VerifyOAuthTwoFactorCodeResponse, error)

	// BeginOrContinueOAuthAuthorizationWithResponse Start or continue OAuth sign-in
	//
	// Starts an OAuth authorization session and requests an authorization code. Redirects may continue an existing sign-in session.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /oauth/v2/authorize (the `BeginOrContinueOAuthAuthorization` operationId).
	BeginOrContinueOAuthAuthorizationWithResponse(ctx context.Context, params *BeginOrContinueOAuthAuthorizationParams, reqEditors ...RequestEditorFn) (*BeginOrContinueOAuthAuthorizationResponse, error)

	// SubmitOAuthCredentialsWithBodyWithResponse Submit OAuth credentials
	//
	// Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).
	SubmitOAuthCredentialsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitOAuthCredentialsResponse, error)

	// SubmitOAuthCredentialsWithFormdataBodyWithResponse Submit OAuth credentials
	//
	// Submits sign-in credentials to continue OAuth authorization. The response may indicate that a two-factor code is required.
	//
	// Takes a body of the `application/x-www-form-urlencoded` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /oauth/v2/signin (the `SubmitOAuthCredentials` operationId).
	SubmitOAuthCredentialsWithFormdataBodyWithResponse(ctx context.Context, body SubmitOAuthCredentialsFormdataRequestBody, reqEditors ...RequestEditorFn) (*SubmitOAuthCredentialsResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type ConfirmDeleteFavorite

type ConfirmDeleteFavorite = restmodels.ConfirmDeleteFavorite

type DeleteRecordingParams

type DeleteRecordingParams = restmodels.DeleteRecordingParams

type DeleteRecordingResponse

type DeleteRecordingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteRecordingResponse

func ParseDeleteRecordingResponse(rsp *http.Response) (*DeleteRecordingResponse, error)

ParseDeleteRecordingResponse parses an HTTP response from a DeleteRecordingWithResponse call

func (DeleteRecordingResponse) ContentType

func (r DeleteRecordingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteRecordingResponse) GetBody

func (r DeleteRecordingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteRecordingResponse) Status

func (r DeleteRecordingResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteRecordingResponse) StatusCode

func (r DeleteRecordingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Device

type Device = restmodels.Device

type DeviceBatteryLife0

type DeviceBatteryLife0 = restmodels.DeviceBatteryLife0

type DeviceBatteryLife1

type DeviceBatteryLife1 = restmodels.DeviceBatteryLife1

type DeviceBatteryLife20

type DeviceBatteryLife20 = restmodels.DeviceBatteryLife20

type DeviceBatteryLife21

type DeviceBatteryLife21 = restmodels.DeviceBatteryLife21

type DeviceCommand

type DeviceCommand = restmodels.DeviceCommand

type DeviceCommandCommandName

type DeviceCommandCommandName = restmodels.DeviceCommandCommandName

type DeviceDetail

type DeviceDetail = restmodels.DeviceDetail

type DeviceFamilyCode

type DeviceFamilyCode = restmodels.DeviceFamilyCode

type DeviceFeatures

type DeviceFeatures = restmodels.DeviceFeatures

type DeviceFeatures_AiLabsDailyClip

type DeviceFeatures_AiLabsDailyClip = restmodels.DeviceFeatures_AiLabsDailyClip

type DeviceFeatures_ChimeSettings

type DeviceFeatures_ChimeSettings = restmodels.DeviceFeatures_ChimeSettings

type DeviceFeatures_NetworkBackup

type DeviceFeatures_NetworkBackup = restmodels.DeviceFeatures_NetworkBackup

type DeviceFeatures_PropertyView

type DeviceFeatures_PropertyView = restmodels.DeviceFeatures_PropertyView

type DeviceFeatures_RetinalTuning

type DeviceFeatures_RetinalTuning = restmodels.DeviceFeatures_RetinalTuning

type DeviceFeatures_SingleAlert

type DeviceFeatures_SingleAlert = restmodels.DeviceFeatures_SingleAlert

type DeviceFeatures_UnusualAlert

type DeviceFeatures_UnusualAlert = restmodels.DeviceFeatures_UnusualAlert

type DeviceFeatures_VideoDonation

type DeviceFeatures_VideoDonation = restmodels.DeviceFeatures_VideoDonation

type DeviceFeatures_VideoRecording

type DeviceFeatures_VideoRecording = restmodels.DeviceFeatures_VideoRecording

type DeviceHealth

type DeviceHealth = restmodels.DeviceHealth

type DeviceId

type DeviceId = restmodels.DeviceId

type DeviceLegacySettings

type DeviceLegacySettings = restmodels.DeviceLegacySettings

type DeviceLegacySettingsEnableVod0

type DeviceLegacySettingsEnableVod0 = restmodels.DeviceLegacySettingsEnableVod0

type DeviceLegacySettingsEnableVod1

type DeviceLegacySettingsEnableVod1 = restmodels.DeviceLegacySettingsEnableVod1

type DeviceLegacySettings_EnableVod

type DeviceLegacySettings_EnableVod = restmodels.DeviceLegacySettings_EnableVod

type DeviceLegacySettings_Lite24x7

type DeviceLegacySettings_Lite24x7 = restmodels.DeviceLegacySettings_Lite24x7

type DeviceList

type DeviceList = restmodels.DeviceList

type DeviceOperationSet

type DeviceOperationSet = restmodels.DeviceOperationSet

type DeviceOwner

type DeviceOwner = restmodels.DeviceOwner

type DeviceOwnerId0

type DeviceOwnerId0 = restmodels.DeviceOwnerId0

type DeviceOwnerId1

type DeviceOwnerId1 = restmodels.DeviceOwnerId1

type DeviceOwner_Id

type DeviceOwner_Id = restmodels.DeviceOwner_Id

type DeviceSettings

type DeviceSettings = restmodels.DeviceSettings

type DeviceSettingsPatch

type DeviceSettingsPatch = restmodels.DeviceSettingsPatch

type DeviceTimeline

type DeviceTimeline = restmodels.DeviceTimeline

type Device_Alerts

type Device_Alerts = restmodels.Device_Alerts

type Device_BatteryLife

type Device_BatteryLife = restmodels.Device_BatteryLife

type Device_BatteryLife2

type Device_BatteryLife2 = restmodels.Device_BatteryLife2

type Device_EncryptionGroup

type Device_EncryptionGroup = restmodels.Device_EncryptionGroup

type Device_MotionSnooze

type Device_MotionSnooze = restmodels.Device_MotionSnooze

type Device_SirenStatus

type Device_SirenStatus = restmodels.Device_SirenStatus

type DoorbellDeviceKind

type DoorbellDeviceKind = restmodels.DoorbellDeviceKind

type EndTime

type EndTime = restmodels.EndTime

type ExchangeOrRefreshOAuthTokenResponse

type ExchangeOrRefreshOAuthTokenResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OAuthToken
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *AuthFailure
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthFailure
	// JSON412 the response for an HTTP 412 `application/json` response
	JSON412 *TwoFactorRequired
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *RateLimited
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *AuthFailure
}

func ParseExchangeOrRefreshOAuthTokenResponse

func ParseExchangeOrRefreshOAuthTokenResponse(rsp *http.Response) (*ExchangeOrRefreshOAuthTokenResponse, error)

ParseExchangeOrRefreshOAuthTokenResponse parses an HTTP response from a ExchangeOrRefreshOAuthTokenWithResponse call

func (ExchangeOrRefreshOAuthTokenResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExchangeOrRefreshOAuthTokenResponse) GetBody

GetBody returns the raw response body bytes

func (ExchangeOrRefreshOAuthTokenResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) GetJSON412

GetJSON412 returns the response for an HTTP 412 `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) GetJSON429

GetJSON429 returns the response for an HTTP 429 `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) GetJSONDefault

GetJSONDefault returns the response for an HTTP default `application/json` response

func (ExchangeOrRefreshOAuthTokenResponse) Status

Status returns HTTPResponse.Status

func (ExchangeOrRefreshOAuthTokenResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ExtensibleObject

type ExtensibleObject = restmodels.ExtensibleObject

type FavoriteRecordingResponse

type FavoriteRecordingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseFavoriteRecordingResponse

func ParseFavoriteRecordingResponse(rsp *http.Response) (*FavoriteRecordingResponse, error)

ParseFavoriteRecordingResponse parses an HTTP response from a FavoriteRecordingWithResponse call

func (FavoriteRecordingResponse) ContentType

func (r FavoriteRecordingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (FavoriteRecordingResponse) GetBody

func (r FavoriteRecordingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (FavoriteRecordingResponse) Status

func (r FavoriteRecordingResponse) Status() string

Status returns HTTPResponse.Status

func (FavoriteRecordingResponse) StatusCode

func (r FavoriteRecordingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type FeatureAvailability

type FeatureAvailability = restmodels.FeatureAvailability

type FeatureEligibility

type FeatureEligibility = restmodels.FeatureEligibility

type FeatureEnablement

type FeatureEnablement = restmodels.FeatureEnablement

type GeoCoordinates

type GeoCoordinates = restmodels.GeoCoordinates

type GetActiveDingsResponse

type GetActiveDingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RecordingArray
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseGetActiveDingsResponse

func ParseGetActiveDingsResponse(rsp *http.Response) (*GetActiveDingsResponse, error)

ParseGetActiveDingsResponse parses an HTTP response from a GetActiveDingsWithResponse call

func (GetActiveDingsResponse) ContentType

func (r GetActiveDingsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetActiveDingsResponse) GetBody

func (r GetActiveDingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetActiveDingsResponse) GetJSON200

func (r GetActiveDingsResponse) GetJSON200() *RecordingArray

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetActiveDingsResponse) GetJSONDefault

func (r GetActiveDingsResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (GetActiveDingsResponse) Status

func (r GetActiveDingsResponse) Status() string

Status returns HTTPResponse.Status

func (GetActiveDingsResponse) StatusCode

func (r GetActiveDingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCapturedLocationTicketsResponse

type GetCapturedLocationTicketsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CapturedTickets
}

func ParseGetCapturedLocationTicketsResponse

func ParseGetCapturedLocationTicketsResponse(rsp *http.Response) (*GetCapturedLocationTicketsResponse, error)

ParseGetCapturedLocationTicketsResponse parses an HTTP response from a GetCapturedLocationTicketsWithResponse call

func (GetCapturedLocationTicketsResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCapturedLocationTicketsResponse) GetBody

GetBody returns the raw response body bytes

func (GetCapturedLocationTicketsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetCapturedLocationTicketsResponse) Status

Status returns HTTPResponse.Status

func (GetCapturedLocationTicketsResponse) StatusCode

func (r GetCapturedLocationTicketsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDeviceResponse

type GetDeviceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeviceDetail
}

func ParseGetDeviceResponse

func ParseGetDeviceResponse(rsp *http.Response) (*GetDeviceResponse, error)

ParseGetDeviceResponse parses an HTTP response from a GetDeviceWithResponse call

func (GetDeviceResponse) ContentType

func (r GetDeviceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetDeviceResponse) GetBody

func (r GetDeviceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDeviceResponse) GetJSON200

func (r GetDeviceResponse) GetJSON200() *DeviceDetail

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDeviceResponse) Status

func (r GetDeviceResponse) Status() string

Status returns HTTPResponse.Status

func (GetDeviceResponse) StatusCode

func (r GetDeviceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDeviceSettingsResponse

type GetDeviceSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeviceSettings
}

func ParseGetDeviceSettingsResponse

func ParseGetDeviceSettingsResponse(rsp *http.Response) (*GetDeviceSettingsResponse, error)

ParseGetDeviceSettingsResponse parses an HTTP response from a GetDeviceSettingsWithResponse call

func (GetDeviceSettingsResponse) ContentType

func (r GetDeviceSettingsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetDeviceSettingsResponse) GetBody

func (r GetDeviceSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDeviceSettingsResponse) GetJSON200

func (r GetDeviceSettingsResponse) GetJSON200() *DeviceSettings

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDeviceSettingsResponse) Status

func (r GetDeviceSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (GetDeviceSettingsResponse) StatusCode

func (r GetDeviceSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetDeviceTimelineParams

type GetDeviceTimelineParams = restmodels.GetDeviceTimelineParams

type GetDeviceTimelineResponse

type GetDeviceTimelineResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeviceTimeline
}

func ParseGetDeviceTimelineResponse

func ParseGetDeviceTimelineResponse(rsp *http.Response) (*GetDeviceTimelineResponse, error)

ParseGetDeviceTimelineResponse parses an HTTP response from a GetDeviceTimelineWithResponse call

func (GetDeviceTimelineResponse) ContentType

func (r GetDeviceTimelineResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetDeviceTimelineResponse) GetBody

func (r GetDeviceTimelineResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetDeviceTimelineResponse) GetJSON200

func (r GetDeviceTimelineResponse) GetJSON200() *DeviceTimeline

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetDeviceTimelineResponse) Status

func (r GetDeviceTimelineResponse) Status() string

Status returns HTTPResponse.Status

func (GetDeviceTimelineResponse) StatusCode

func (r GetDeviceTimelineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoryDevicesParams

type GetHistoryDevicesParams = restmodels.GetHistoryDevicesParams

type GetHistoryDevicesResponse

type GetHistoryDevicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HistoryDevices
}

func ParseGetHistoryDevicesResponse

func ParseGetHistoryDevicesResponse(rsp *http.Response) (*GetHistoryDevicesResponse, error)

ParseGetHistoryDevicesResponse parses an HTTP response from a GetHistoryDevicesWithResponse call

func (GetHistoryDevicesResponse) ContentType

func (r GetHistoryDevicesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetHistoryDevicesResponse) GetBody

func (r GetHistoryDevicesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoryDevicesResponse) GetJSON200

func (r GetHistoryDevicesResponse) GetJSON200() *HistoryDevices

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoryDevicesResponse) Status

func (r GetHistoryDevicesResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoryDevicesResponse) StatusCode

func (r GetHistoryDevicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLegacyDeviceHealthResponse

type GetLegacyDeviceHealthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LegacyDeviceHealth
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseGetLegacyDeviceHealthResponse

func ParseGetLegacyDeviceHealthResponse(rsp *http.Response) (*GetLegacyDeviceHealthResponse, error)

ParseGetLegacyDeviceHealthResponse parses an HTTP response from a GetLegacyDeviceHealthWithResponse call

func (GetLegacyDeviceHealthResponse) ContentType

func (r GetLegacyDeviceHealthResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLegacyDeviceHealthResponse) GetBody

func (r GetLegacyDeviceHealthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLegacyDeviceHealthResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLegacyDeviceHealthResponse) GetJSONDefault

func (r GetLegacyDeviceHealthResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (GetLegacyDeviceHealthResponse) Status

Status returns HTTPResponse.Status

func (GetLegacyDeviceHealthResponse) StatusCode

func (r GetLegacyDeviceHealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLegacyDeviceHistoryParams

type GetLegacyDeviceHistoryParams = restmodels.GetLegacyDeviceHistoryParams

type GetLegacyDeviceHistoryResponse

type GetLegacyDeviceHistoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RecordingArray
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseGetLegacyDeviceHistoryResponse

func ParseGetLegacyDeviceHistoryResponse(rsp *http.Response) (*GetLegacyDeviceHistoryResponse, error)

ParseGetLegacyDeviceHistoryResponse parses an HTTP response from a GetLegacyDeviceHistoryWithResponse call

func (GetLegacyDeviceHistoryResponse) ContentType

func (r GetLegacyDeviceHistoryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLegacyDeviceHistoryResponse) GetBody

func (r GetLegacyDeviceHistoryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLegacyDeviceHistoryResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLegacyDeviceHistoryResponse) GetJSONDefault

func (r GetLegacyDeviceHistoryResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (GetLegacyDeviceHistoryResponse) Status

Status returns HTTPResponse.Status

func (GetLegacyDeviceHistoryResponse) StatusCode

func (r GetLegacyDeviceHistoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLegacyRecordingShareURLResponse

type GetLegacyRecordingShareURLResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RecordingShare
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseGetLegacyRecordingShareURLResponse

func ParseGetLegacyRecordingShareURLResponse(rsp *http.Response) (*GetLegacyRecordingShareURLResponse, error)

ParseGetLegacyRecordingShareURLResponse parses an HTTP response from a GetLegacyRecordingShareURLWithResponse call

func (GetLegacyRecordingShareURLResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLegacyRecordingShareURLResponse) GetBody

GetBody returns the raw response body bytes

func (GetLegacyRecordingShareURLResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLegacyRecordingShareURLResponse) GetJSONDefault

func (r GetLegacyRecordingShareURLResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (GetLegacyRecordingShareURLResponse) Status

Status returns HTTPResponse.Status

func (GetLegacyRecordingShareURLResponse) StatusCode

func (r GetLegacyRecordingShareURLResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLegacySnapshotImageResponse

type GetLegacySnapshotImageResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseGetLegacySnapshotImageResponse

func ParseGetLegacySnapshotImageResponse(rsp *http.Response) (*GetLegacySnapshotImageResponse, error)

ParseGetLegacySnapshotImageResponse parses an HTTP response from a GetLegacySnapshotImageWithResponse call

func (GetLegacySnapshotImageResponse) ContentType

func (r GetLegacySnapshotImageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLegacySnapshotImageResponse) GetBody

func (r GetLegacySnapshotImageResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLegacySnapshotImageResponse) GetJSONDefault

func (r GetLegacySnapshotImageResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (GetLegacySnapshotImageResponse) Status

Status returns HTTPResponse.Status

func (GetLegacySnapshotImageResponse) StatusCode

func (r GetLegacySnapshotImageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLocationParams

type GetLocationParams = restmodels.GetLocationParams

type GetLocationResponse

type GetLocationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LocationDetail
}

func ParseGetLocationResponse

func ParseGetLocationResponse(rsp *http.Response) (*GetLocationResponse, error)

ParseGetLocationResponse parses an HTTP response from a GetLocationWithResponse call

func (GetLocationResponse) ContentType

func (r GetLocationResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetLocationResponse) GetBody

func (r GetLocationResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetLocationResponse) GetJSON200

func (r GetLocationResponse) GetJSON200() *LocationDetail

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetLocationResponse) Status

func (r GetLocationResponse) Status() string

Status returns HTTPResponse.Status

func (GetLocationResponse) StatusCode

func (r GetLocationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HTTPFailure

type HTTPFailure = restmodels.HTTPFailure

type HistoryDevices

type HistoryDevices = restmodels.HistoryDevices

type HistoryFeedItem

type HistoryFeedItem = restmodels.HistoryFeedItem

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Include

type Include = restmodels.Include

type IntercomUnlockCommand

type IntercomUnlockCommand = restmodels.IntercomUnlockCommand

type IntercomUnlockParams

type IntercomUnlockParams = restmodels.IntercomUnlockParams

type IntercomUnlockParamsDoorId

type IntercomUnlockParamsDoorId = restmodels.IntercomUnlockParamsDoorId

type IntercomUnlockParamsUserId

type IntercomUnlockParamsUserId = restmodels.IntercomUnlockParamsUserId

type IntercomUnlockRPC

type IntercomUnlockRPC = restmodels.IntercomUnlockRPC

type IntercomUnlockRPCJsonrpc

type IntercomUnlockRPCJsonrpc = restmodels.IntercomUnlockRPCJsonrpc

type IntercomUnlockRPCMethod

type IntercomUnlockRPCMethod = restmodels.IntercomUnlockRPCMethod

type Json

type Json = restmodels.Json

type JsonValue

type JsonValue = restmodels.JsonValue

type Kind

type Kind = restmodels.Kind

type LegacyDeviceHealth

type LegacyDeviceHealth = restmodels.LegacyDeviceHealth

type LegacyPasswordGrant

type LegacyPasswordGrant = restmodels.LegacyPasswordGrant

type LegacyPasswordGrantGrantType

type LegacyPasswordGrantGrantType = restmodels.LegacyPasswordGrantGrantType

type LegacySignalingTicket

type LegacySignalingTicket = restmodels.LegacySignalingTicket

type Limit

type Limit = restmodels.Limit

type ListDevicesResponse

type ListDevicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeviceList
}

func ParseListDevicesResponse

func ParseListDevicesResponse(rsp *http.Response) (*ListDevicesResponse, error)

ParseListDevicesResponse parses an HTTP response from a ListDevicesWithResponse call

func (ListDevicesResponse) ContentType

func (r ListDevicesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListDevicesResponse) GetBody

func (r ListDevicesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListDevicesResponse) GetJSON200

func (r ListDevicesResponse) GetJSON200() *DeviceList

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListDevicesResponse) Status

func (r ListDevicesResponse) Status() string

Status returns HTTPResponse.Status

func (ListDevicesResponse) StatusCode

func (r ListDevicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListLocationDevicesResponse

type ListLocationDevicesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LocationGroupDevices
}

func ParseListLocationDevicesResponse

func ParseListLocationDevicesResponse(rsp *http.Response) (*ListLocationDevicesResponse, error)

ParseListLocationDevicesResponse parses an HTTP response from a ListLocationDevicesWithResponse call

func (ListLocationDevicesResponse) ContentType

func (r ListLocationDevicesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListLocationDevicesResponse) GetBody

func (r ListLocationDevicesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListLocationDevicesResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListLocationDevicesResponse) Status

Status returns HTTPResponse.Status

func (ListLocationDevicesResponse) StatusCode

func (r ListLocationDevicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListLocationGroupsResponse

type ListLocationGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LocationGroups
}

func ParseListLocationGroupsResponse

func ParseListLocationGroupsResponse(rsp *http.Response) (*ListLocationGroupsResponse, error)

ParseListLocationGroupsResponse parses an HTTP response from a ListLocationGroupsWithResponse call

func (ListLocationGroupsResponse) ContentType

func (r ListLocationGroupsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListLocationGroupsResponse) GetBody

func (r ListLocationGroupsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListLocationGroupsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListLocationGroupsResponse) Status

Status returns HTTPResponse.Status

func (ListLocationGroupsResponse) StatusCode

func (r ListLocationGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListLocationsResponse

type ListLocationsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LocationList
}

func ParseListLocationsResponse

func ParseListLocationsResponse(rsp *http.Response) (*ListLocationsResponse, error)

ParseListLocationsResponse parses an HTTP response from a ListLocationsWithResponse call

func (ListLocationsResponse) ContentType

func (r ListLocationsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListLocationsResponse) GetBody

func (r ListLocationsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListLocationsResponse) GetJSON200

func (r ListLocationsResponse) GetJSON200() *LocationList

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListLocationsResponse) Status

func (r ListLocationsResponse) Status() string

Status returns HTTPResponse.Status

func (ListLocationsResponse) StatusCode

func (r ListLocationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LiveViewSetting

type LiveViewSetting = restmodels.LiveViewSetting

type LiveViewSettingRequest

type LiveViewSettingRequest = restmodels.LiveViewSettingRequest

type LocationAddress

type LocationAddress = restmodels.LocationAddress

type LocationAttributes

type LocationAttributes = restmodels.LocationAttributes

type LocationDetail

type LocationDetail = restmodels.LocationDetail

type LocationGroup

type LocationGroup = restmodels.LocationGroup

type LocationGroupDevices

type LocationGroupDevices = restmodels.LocationGroupDevices

type LocationGroups

type LocationGroups = restmodels.LocationGroups

type LocationID

type LocationID = restmodels.LocationID

type LocationId

type LocationId = restmodels.LocationId

type LocationList

type LocationList = restmodels.LocationList

type LocationMeta

type LocationMeta = restmodels.LocationMeta

type LocationResource

type LocationResource = restmodels.LocationResource

type LocationSubscription

type LocationSubscription = restmodels.LocationSubscription

type LocationSummary

type LocationSummary = restmodels.LocationSummary

type MotionSettings

type MotionSettings = restmodels.MotionSettings

type MotionSettingsPatch

type MotionSettingsPatch = restmodels.MotionSettingsPatch

type OAuthToken

type OAuthToken = restmodels.OAuthToken

type OAuthTokenGrant

type OAuthTokenGrant = restmodels.OAuthTokenGrant

type OlderThan

type OlderThan = restmodels.OlderThan

type Order

type Order = restmodels.Order

type OtherDeviceKind

type OtherDeviceKind = restmodels.OtherDeviceKind

type PTZAutoScan

type PTZAutoScan = restmodels.PTZAutoScan

type PTZAxisSettings

type PTZAxisSettings = restmodels.PTZAxisSettings

type PTZMovement

type PTZMovement = restmodels.PTZMovement

type PTZPositions

type PTZPositions = restmodels.PTZPositions

type PTZSettings

type PTZSettings = restmodels.PTZSettings

type PatchDeviceSettingsResponse

type PatchDeviceSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeviceSettings
}

func ParsePatchDeviceSettingsResponse

func ParsePatchDeviceSettingsResponse(rsp *http.Response) (*PatchDeviceSettingsResponse, error)

ParsePatchDeviceSettingsResponse parses an HTTP response from a PatchDeviceSettingsWithResponse call

func (PatchDeviceSettingsResponse) ContentType

func (r PatchDeviceSettingsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PatchDeviceSettingsResponse) GetBody

func (r PatchDeviceSettingsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PatchDeviceSettingsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PatchDeviceSettingsResponse) Status

Status returns HTTPResponse.Status

func (PatchDeviceSettingsResponse) StatusCode

func (r PatchDeviceSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PushDeviceMetadata

type PushDeviceMetadata = restmodels.PushDeviceMetadata

type PushDeviceMetadataPnService

type PushDeviceMetadataPnService = restmodels.PushDeviceMetadataPnService

type PushDeviceRegistration

type PushDeviceRegistration = restmodels.PushDeviceRegistration

type PushDeviceRegistrationDevice

type PushDeviceRegistrationDevice = restmodels.PushDeviceRegistrationDevice

type PushDeviceRegistrationDeviceOs

type PushDeviceRegistrationDeviceOs = restmodels.PushDeviceRegistrationDeviceOs

type RateLimited

type RateLimited = restmodels.RateLimited

type Recording

type Recording = restmodels.Recording

type RecordingArray

type RecordingArray = restmodels.RecordingArray

type RecordingId

type RecordingId = restmodels.RecordingId

type RecordingShare

type RecordingShare = restmodels.RecordingShare

type Recording_Doorbot

type Recording_Doorbot = restmodels.Recording_Doorbot

type RefreshLegacySnapshotTimestampResponse

type RefreshLegacySnapshotTimestampResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SnapshotTimestampResponse
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseRefreshLegacySnapshotTimestampResponse

func ParseRefreshLegacySnapshotTimestampResponse(rsp *http.Response) (*RefreshLegacySnapshotTimestampResponse, error)

ParseRefreshLegacySnapshotTimestampResponse parses an HTTP response from a RefreshLegacySnapshotTimestampWithResponse call

func (RefreshLegacySnapshotTimestampResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RefreshLegacySnapshotTimestampResponse) GetBody

GetBody returns the raw response body bytes

func (RefreshLegacySnapshotTimestampResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RefreshLegacySnapshotTimestampResponse) GetJSONDefault

GetJSONDefault returns the response for an HTTP default `application/json` response

func (RefreshLegacySnapshotTimestampResponse) Status

Status returns HTTPResponse.Status

func (RefreshLegacySnapshotTimestampResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type RefreshTokenGrant

type RefreshTokenGrant = restmodels.RefreshTokenGrant

type RefreshTokenGrantGrantType

type RefreshTokenGrantGrantType = restmodels.RefreshTokenGrantGrantType

type RegisterClientSessionResponse

type RegisterClientSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseRegisterClientSessionResponse

func ParseRegisterClientSessionResponse(rsp *http.Response) (*RegisterClientSessionResponse, error)

ParseRegisterClientSessionResponse parses an HTTP response from a RegisterClientSessionWithResponse call

func (RegisterClientSessionResponse) ContentType

func (r RegisterClientSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterClientSessionResponse) GetBody

func (r RegisterClientSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RegisterClientSessionResponse) GetJSON200

func (r RegisterClientSessionResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RegisterClientSessionResponse) GetJSONDefault

func (r RegisterClientSessionResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (RegisterClientSessionResponse) Status

Status returns HTTPResponse.Status

func (RegisterClientSessionResponse) StatusCode

func (r RegisterClientSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RegisterPushDeviceResponse

type RegisterPushDeviceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseRegisterPushDeviceResponse

func ParseRegisterPushDeviceResponse(rsp *http.Response) (*RegisterPushDeviceResponse, error)

ParseRegisterPushDeviceResponse parses an HTTP response from a RegisterPushDeviceWithResponse call

func (RegisterPushDeviceResponse) ContentType

func (r RegisterPushDeviceResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RegisterPushDeviceResponse) GetBody

func (r RegisterPushDeviceResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (RegisterPushDeviceResponse) Status

Status returns HTTPResponse.Status

func (RegisterPushDeviceResponse) StatusCode

func (r RegisterPushDeviceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestLegacySignalingTicketResponse

type RequestLegacySignalingTicketResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LegacySignalingTicket
}

func ParseRequestLegacySignalingTicketResponse

func ParseRequestLegacySignalingTicketResponse(rsp *http.Response) (*RequestLegacySignalingTicketResponse, error)

ParseRequestLegacySignalingTicketResponse parses an HTTP response from a RequestLegacySignalingTicketWithResponse call

func (RequestLegacySignalingTicketResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RequestLegacySignalingTicketResponse) GetBody

GetBody returns the raw response body bytes

func (RequestLegacySignalingTicketResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (RequestLegacySignalingTicketResponse) Status

Status returns HTTPResponse.Status

func (RequestLegacySignalingTicketResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type RequestedTransport

type RequestedTransport = restmodels.RequestedTransport

type RingHeaderName

type RingHeaderName = restmodels.RingHeaderName

type SendDeviceCommandResponse

type SendDeviceCommandResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseSendDeviceCommandResponse

func ParseSendDeviceCommandResponse(rsp *http.Response) (*SendDeviceCommandResponse, error)

ParseSendDeviceCommandResponse parses an HTTP response from a SendDeviceCommandWithResponse call

func (SendDeviceCommandResponse) ContentType

func (r SendDeviceCommandResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SendDeviceCommandResponse) GetBody

func (r SendDeviceCommandResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SendDeviceCommandResponse) Status

func (r SendDeviceCommandResponse) Status() string

Status returns HTTPResponse.Status

func (SendDeviceCommandResponse) StatusCode

func (r SendDeviceCommandResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetChimeVolumeParams

type SetChimeVolumeParams = restmodels.SetChimeVolumeParams

type SetChimeVolumeResponse

type SetChimeVolumeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseSetChimeVolumeResponse

func ParseSetChimeVolumeResponse(rsp *http.Response) (*SetChimeVolumeResponse, error)

ParseSetChimeVolumeResponse parses an HTTP response from a SetChimeVolumeWithResponse call

func (SetChimeVolumeResponse) ContentType

func (r SetChimeVolumeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetChimeVolumeResponse) GetBody

func (r SetChimeVolumeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetChimeVolumeResponse) GetJSON200

func (r SetChimeVolumeResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SetChimeVolumeResponse) GetJSONDefault

func (r SetChimeVolumeResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (SetChimeVolumeResponse) Status

func (r SetChimeVolumeResponse) Status() string

Status returns HTTPResponse.Status

func (SetChimeVolumeResponse) StatusCode

func (r SetChimeVolumeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SetLiveViewEnabledResponse

type SetLiveViewEnabledResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseSetLiveViewEnabledResponse

func ParseSetLiveViewEnabledResponse(rsp *http.Response) (*SetLiveViewEnabledResponse, error)

ParseSetLiveViewEnabledResponse parses an HTTP response from a SetLiveViewEnabledWithResponse call

func (SetLiveViewEnabledResponse) ContentType

func (r SetLiveViewEnabledResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SetLiveViewEnabledResponse) GetBody

func (r SetLiveViewEnabledResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SetLiveViewEnabledResponse) Status

Status returns HTTPResponse.Status

func (SetLiveViewEnabledResponse) StatusCode

func (r SetLiveViewEnabledResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SettingsObject

type SettingsObject = restmodels.SettingsObject

type SignInForm

type SignInForm = restmodels.SignInForm

type SignInState

type SignInState = restmodels.SignInState

type SirenOn

type SirenOn = restmodels.SirenOn

type SirenStatus

type SirenStatus = restmodels.SirenStatus

type SnapshotTimestamp

type SnapshotTimestamp = restmodels.SnapshotTimestamp

type SnapshotTimestampRequest

type SnapshotTimestampRequest = restmodels.SnapshotTimestampRequest

type SnapshotTimestampResponse

type SnapshotTimestampResponse = restmodels.SnapshotTimestampResponse

type SourceIds

type SourceIds = restmodels.SourceIds

type StartTime

type StartTime = restmodels.StartTime

type StreamRecordingResponse

type StreamRecordingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
	// Headers302 the parsed response headers for an HTTP 302 response
	Headers302 *StreamRecordingResponse302Headers
}

func ParseStreamRecordingResponse

func ParseStreamRecordingResponse(rsp *http.Response) (*StreamRecordingResponse, error)

ParseStreamRecordingResponse parses an HTTP response from a StreamRecordingWithResponse call

func (StreamRecordingResponse) ContentType

func (r StreamRecordingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StreamRecordingResponse) GetBody

func (r StreamRecordingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StreamRecordingResponse) GetJSONDefault

func (r StreamRecordingResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (StreamRecordingResponse) Status

func (r StreamRecordingResponse) Status() string

Status returns HTTPResponse.Status

func (StreamRecordingResponse) StatusCode

func (r StreamRecordingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StreamRecordingResponse302Headers

type StreamRecordingResponse302Headers struct {
	Location *string
}

StreamRecordingResponse302Headers the declared response headers of an HTTP 302 response for StreamRecording

type SubmitOAuthCredentialsResponse

type SubmitOAuthCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SignInState
	// JSON412 the response for an HTTP 412 `application/json` response
	JSON412 *TwoFactorRequired
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *AuthFailure
	// Headers302 the parsed response headers for an HTTP 302 response
	Headers302 *SubmitOAuthCredentialsResponse302Headers
}

func ParseSubmitOAuthCredentialsResponse

func ParseSubmitOAuthCredentialsResponse(rsp *http.Response) (*SubmitOAuthCredentialsResponse, error)

ParseSubmitOAuthCredentialsResponse parses an HTTP response from a SubmitOAuthCredentialsWithResponse call

func (SubmitOAuthCredentialsResponse) ContentType

func (r SubmitOAuthCredentialsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubmitOAuthCredentialsResponse) GetBody

func (r SubmitOAuthCredentialsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SubmitOAuthCredentialsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SubmitOAuthCredentialsResponse) GetJSON412

GetJSON412 returns the response for an HTTP 412 `application/json` response

func (SubmitOAuthCredentialsResponse) GetJSONDefault

func (r SubmitOAuthCredentialsResponse) GetJSONDefault() *AuthFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (SubmitOAuthCredentialsResponse) Status

Status returns HTTPResponse.Status

func (SubmitOAuthCredentialsResponse) StatusCode

func (r SubmitOAuthCredentialsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitOAuthCredentialsResponse302Headers

type SubmitOAuthCredentialsResponse302Headers struct {
	Location string
}

SubmitOAuthCredentialsResponse302Headers the declared response headers of an HTTP 302 response for SubmitOAuthCredentials

type SubscribeDeviceDingResponse

type SubscribeDeviceDingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseSubscribeDeviceDingResponse

func ParseSubscribeDeviceDingResponse(rsp *http.Response) (*SubscribeDeviceDingResponse, error)

ParseSubscribeDeviceDingResponse parses an HTTP response from a SubscribeDeviceDingWithResponse call

func (SubscribeDeviceDingResponse) ContentType

func (r SubscribeDeviceDingResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubscribeDeviceDingResponse) GetBody

func (r SubscribeDeviceDingResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SubscribeDeviceDingResponse) Status

Status returns HTTPResponse.Status

func (SubscribeDeviceDingResponse) StatusCode

func (r SubscribeDeviceDingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubscribeDeviceMotionResponse

type SubscribeDeviceMotionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseSubscribeDeviceMotionResponse

func ParseSubscribeDeviceMotionResponse(rsp *http.Response) (*SubscribeDeviceMotionResponse, error)

ParseSubscribeDeviceMotionResponse parses an HTTP response from a SubscribeDeviceMotionWithResponse call

func (SubscribeDeviceMotionResponse) ContentType

func (r SubscribeDeviceMotionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SubscribeDeviceMotionResponse) GetBody

func (r SubscribeDeviceMotionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SubscribeDeviceMotionResponse) Status

Status returns HTTPResponse.Status

func (SubscribeDeviceMotionResponse) StatusCode

func (r SubscribeDeviceMotionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TestChimeSoundParams

type TestChimeSoundParams = restmodels.TestChimeSoundParams

type TestChimeSoundParamsKind

type TestChimeSoundParamsKind = restmodels.TestChimeSoundParamsKind

type TestChimeSoundResponse

type TestChimeSoundResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseTestChimeSoundResponse

func ParseTestChimeSoundResponse(rsp *http.Response) (*TestChimeSoundResponse, error)

ParseTestChimeSoundResponse parses an HTTP response from a TestChimeSoundWithResponse call

func (TestChimeSoundResponse) ContentType

func (r TestChimeSoundResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TestChimeSoundResponse) GetBody

func (r TestChimeSoundResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TestChimeSoundResponse) GetJSON200

func (r TestChimeSoundResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TestChimeSoundResponse) GetJSONDefault

func (r TestChimeSoundResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (TestChimeSoundResponse) Status

func (r TestChimeSoundResponse) Status() string

Status returns HTTPResponse.Status

func (TestChimeSoundResponse) StatusCode

func (r TestChimeSoundResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TimelineDevice

type TimelineDevice = restmodels.TimelineDevice

type TimelineEvent

type TimelineEvent = restmodels.TimelineEvent

type TurnFloodlightOffResponse

type TurnFloodlightOffResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseTurnFloodlightOffResponse

func ParseTurnFloodlightOffResponse(rsp *http.Response) (*TurnFloodlightOffResponse, error)

ParseTurnFloodlightOffResponse parses an HTTP response from a TurnFloodlightOffWithResponse call

func (TurnFloodlightOffResponse) ContentType

func (r TurnFloodlightOffResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TurnFloodlightOffResponse) GetBody

func (r TurnFloodlightOffResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TurnFloodlightOffResponse) GetJSON200

func (r TurnFloodlightOffResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TurnFloodlightOffResponse) GetJSONDefault

func (r TurnFloodlightOffResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (TurnFloodlightOffResponse) Status

func (r TurnFloodlightOffResponse) Status() string

Status returns HTTPResponse.Status

func (TurnFloodlightOffResponse) StatusCode

func (r TurnFloodlightOffResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TurnFloodlightOnResponse

type TurnFloodlightOnResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseTurnFloodlightOnResponse

func ParseTurnFloodlightOnResponse(rsp *http.Response) (*TurnFloodlightOnResponse, error)

ParseTurnFloodlightOnResponse parses an HTTP response from a TurnFloodlightOnWithResponse call

func (TurnFloodlightOnResponse) ContentType

func (r TurnFloodlightOnResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TurnFloodlightOnResponse) GetBody

func (r TurnFloodlightOnResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TurnFloodlightOnResponse) GetJSON200

func (r TurnFloodlightOnResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TurnFloodlightOnResponse) GetJSONDefault

func (r TurnFloodlightOnResponse) GetJSONDefault() *HTTPFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (TurnFloodlightOnResponse) Status

func (r TurnFloodlightOnResponse) Status() string

Status returns HTTPResponse.Status

func (TurnFloodlightOnResponse) StatusCode

func (r TurnFloodlightOnResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TurnSirenOffResponse

type TurnSirenOffResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseTurnSirenOffResponse

func ParseTurnSirenOffResponse(rsp *http.Response) (*TurnSirenOffResponse, error)

ParseTurnSirenOffResponse parses an HTTP response from a TurnSirenOffWithResponse call

func (TurnSirenOffResponse) ContentType

func (r TurnSirenOffResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TurnSirenOffResponse) GetBody

func (r TurnSirenOffResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TurnSirenOffResponse) Status

func (r TurnSirenOffResponse) Status() string

Status returns HTTPResponse.Status

func (TurnSirenOffResponse) StatusCode

func (r TurnSirenOffResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TurnSirenOnResponse

type TurnSirenOnResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SirenOn
}

func ParseTurnSirenOnResponse

func ParseTurnSirenOnResponse(rsp *http.Response) (*TurnSirenOnResponse, error)

ParseTurnSirenOnResponse parses an HTTP response from a TurnSirenOnWithResponse call

func (TurnSirenOnResponse) ContentType

func (r TurnSirenOnResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (TurnSirenOnResponse) GetBody

func (r TurnSirenOnResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (TurnSirenOnResponse) GetJSON200

func (r TurnSirenOnResponse) GetJSON200() *SirenOn

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (TurnSirenOnResponse) Status

func (r TurnSirenOnResponse) Status() string

Status returns HTTPResponse.Status

func (TurnSirenOnResponse) StatusCode

func (r TurnSirenOnResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TwoFactorForm

type TwoFactorForm = restmodels.TwoFactorForm

type TwoFactorFormRememberMe

type TwoFactorFormRememberMe = restmodels.TwoFactorFormRememberMe

type TwoFactorRequired

type TwoFactorRequired = restmodels.TwoFactorRequired

type UnlockIntercomJSONRequestBody

type UnlockIntercomJSONRequestBody = restmodels.UnlockIntercomJSONRequestBody

type UnlockIntercomResponse

type UnlockIntercomResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseUnlockIntercomResponse

func ParseUnlockIntercomResponse(rsp *http.Response) (*UnlockIntercomResponse, error)

ParseUnlockIntercomResponse parses an HTTP response from a UnlockIntercomWithResponse call

func (UnlockIntercomResponse) ContentType

func (r UnlockIntercomResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UnlockIntercomResponse) GetBody

func (r UnlockIntercomResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UnlockIntercomResponse) Status

func (r UnlockIntercomResponse) Status() string

Status returns HTTPResponse.Status

func (UnlockIntercomResponse) StatusCode

func (r UnlockIntercomResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateLegacyDoorbotControlsResponse

type UpdateLegacyDoorbotControlsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *HTTPFailure
}

func ParseUpdateLegacyDoorbotControlsResponse

func ParseUpdateLegacyDoorbotControlsResponse(rsp *http.Response) (*UpdateLegacyDoorbotControlsResponse, error)

ParseUpdateLegacyDoorbotControlsResponse parses an HTTP response from a UpdateLegacyDoorbotControlsWithResponse call

func (UpdateLegacyDoorbotControlsResponse) ContentType

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateLegacyDoorbotControlsResponse) GetBody

GetBody returns the raw response body bytes

func (UpdateLegacyDoorbotControlsResponse) GetJSON200

func (r UpdateLegacyDoorbotControlsResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateLegacyDoorbotControlsResponse) GetJSONDefault

GetJSONDefault returns the response for an HTTP default `application/json` response

func (UpdateLegacyDoorbotControlsResponse) Status

Status returns HTTPResponse.Status

func (UpdateLegacyDoorbotControlsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type VerifyOAuthTwoFactorCodeResponse

type VerifyOAuthTwoFactorCodeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Json
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *Json
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *AuthFailure
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *AuthFailure
	// JSONDefault the response for an HTTP default `application/json` response
	JSONDefault *AuthFailure
}

func ParseVerifyOAuthTwoFactorCodeResponse

func ParseVerifyOAuthTwoFactorCodeResponse(rsp *http.Response) (*VerifyOAuthTwoFactorCodeResponse, error)

ParseVerifyOAuthTwoFactorCodeResponse parses an HTTP response from a VerifyOAuthTwoFactorCodeWithResponse call

func (VerifyOAuthTwoFactorCodeResponse) ContentType

func (r VerifyOAuthTwoFactorCodeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (VerifyOAuthTwoFactorCodeResponse) GetBody

func (r VerifyOAuthTwoFactorCodeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (VerifyOAuthTwoFactorCodeResponse) GetJSON200

func (r VerifyOAuthTwoFactorCodeResponse) GetJSON200() *Json

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (VerifyOAuthTwoFactorCodeResponse) GetJSON201

func (r VerifyOAuthTwoFactorCodeResponse) GetJSON201() *Json

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (VerifyOAuthTwoFactorCodeResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (VerifyOAuthTwoFactorCodeResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (VerifyOAuthTwoFactorCodeResponse) GetJSONDefault

func (r VerifyOAuthTwoFactorCodeResponse) GetJSONDefault() *AuthFailure

GetJSONDefault returns the response for an HTTP default `application/json` response

func (VerifyOAuthTwoFactorCodeResponse) Status

Status returns HTTPResponse.Status

func (VerifyOAuthTwoFactorCodeResponse) StatusCode

func (r VerifyOAuthTwoFactorCodeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type VideoRenderingFeature

type VideoRenderingFeature = restmodels.VideoRenderingFeature

type VideoSettings

type VideoSettings = restmodels.VideoSettings

type VolumeSettings

type VolumeSettings = restmodels.VolumeSettings

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL