watcheradmin

type AdminStreamsListQuery struct {
	Cursor string
	Limit  int
	// Comma-separated list of preferred zones. Returns streams, belonging to at least one preferred zone from the list.
	PreferredZones string
	// Comma-separated list of required zones. Returns streams, belonging to at least one required zone from the list.
	RequiredZones string
	Select        []string
	Sort          []string
	Extra         map[string]string
}

type AgentsListQuery struct {
	Cursor string
	Limit  int
	// Organization identifier to select agents only available for this organization. If the `organization_id` is not transferred, all available agents will be returned.
	OrganizationId int
	Select         []string
	Sort           []string
	// Filter agents by stream presence. If any stream has the agent in its inputs, the agent will not be returned with filter `stream_is=null`.
	Stream string
	// Filter agents by stream title using partial match. The search is case-insensitive and matches any part of the stream title.
	TitleLike string
	Extra     map[string]string
}

type BaseClientFactory func(cfg *config.Config, apiURL string, authKey authorization.AuthKey) baseclient.BaseClient

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

type ClusterStatsGetQuery struct {
	// This parameter is used instead of the Accept header to select of non-JSON response content format.
	Format string
	Extra  map[string]string
}

type EventsListQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type PresetsListQuery struct {
	Cursor string
	Limit  int
	// Organization identifier to select presets only available for this organization. If the `organization_id` is not transferred, all available presets will be returned.
	OrganizationId int
	Select         []string
	Sort           []string
	Extra          map[string]string
}

type PreviewLayoutChangeForStreamConfigQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type PreviewLayoutChangeForStreamerConfigQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type SharedTokensListQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type StreamDeleteQuery struct {
	// part of config to delete
	Part  string
	Extra map[string]string
}

type StreamLayoutsGetQuery struct {
	// Get layouts created after this timestamp
	CreatedAtGt int
	// Get layouts created before this timestamp
	CreatedAtLt int
	// A properly encoded equivalent of offset allowing you to read the next bunch of items.  We do not offer common `offset` fields, so please use cursor for predictable fetching of quickly changing list of items.
	Cursor string
	// Limit the number of returned layouts
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type StreamSaveQuery struct {
	// The stream is configured by several origins of configuration. It may be `config_on_disk` or temporary runtime `config_override` that can be provided via `on_play` or `on_publish` backend, or edited via this API call if you pass `config_override` to this parameter.
	Part  string
	Extra map[string]string
}

type StreamerSaveQuery struct {
	// This flag enables some checks before saving streamer. List of checks:   - Watcher can reach the streamer (get its config);    If a request with `checks_enable=true` is sent,  then if at least one of the checks fails, the streamer will not be saved.
	ChecksEnable bool
	Extra        map[string]string
}

type StreamersListQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}

type UsersListQuery struct {
	Cursor string
	Limit  int
	// Organization identifier to select users only available for this organization. If the `organization_id` is not transferred, all available users will be returned.
	OrganizationId int
	Select         []string
	Sort           []string
	Extra          map[string]string
}

type WatcherAdmin interface {
	// AdminStreamsList List streams for admin
	// The key difference between this method and streams_list is the additional parameters. These additional parameters are available only for admin (e.g. 'required_zones' and 'preferred_zones').  This API method is one of the most important in whole API, because it gives the list of all streams.  `streams_list` in Watcher Admin API: * can list all streams within the Watcher. * admin is not allowed to watch content from any cameras for security reasons.  `streams_list` in Watcher Client API: * return streams from organizations where you're member * provives a playback token that allows play video from the camera.
	AdminStreamsList(ctx context.Context, query *AdminStreamsListQuery) (model.StreamsList, error)
	// AdminStreamsListIterator iterates through all items using cursor pagination
	AdminStreamsListIterator(ctx context.Context, query *AdminStreamsListQuery) iter.Seq2[model.StreamConfig, error]
	// AgentGet Get one Agent
	// The method allows you to fetch a single Agent.  The returned data are the same as for `agents_list` operation.
	AgentGet(ctx context.Context, id string) (model.WatcherAgentConfig, error)
	// AgentsList List Agents
	// The list of configured and provisioned Agents, i.e. Agents that connected to your server at least once.
	AgentsList(ctx context.Context, query *AgentsListQuery) (model.AgentsList, error)
	// AgentsListIterator iterates through all items using cursor pagination
	AgentsListIterator(ctx context.Context, query *AgentsListQuery) iter.Seq2[model.Agent, error]
	// CameraAuthGet Get auth for camera
	// Create or update a auth for camera by its name.
	CameraAuthGet(ctx context.Context, name string) (model.Auth, error)
	// CameraAuthSave Save auth for camera
	// Create or update a auth for camera by its name.
	CameraAuthSave(ctx context.Context, name string) (model.Auth, error)
	// CameraConfigGet Get one stream camera config
	// This method allows to fetch a single stream camera config info.
	CameraConfigGet(ctx context.Context, name string) (model.CameraConfig, error)
	// CameraConfigSave Save stream camera config
	// Create or update a stream config by its name.
	CameraConfigSave(ctx context.Context, name string, body model.CameraConfig) (model.CameraConfig, error)
	// CameraReboot Reboot camera
	// Reboot camera
	CameraReboot(ctx context.Context, name string) error
	// ClusterStatsGet Get current health of cluster
	// This method allows you to fetch cluster's health
	ClusterStatsGet(ctx context.Context, query *ClusterStatsGetQuery) (model.ClusterHealthStats, error)
	// DeleteOrganizationPreset Delete preset from organization
	// This method allows to remove a specific preset from organization.
	DeleteOrganizationPreset(ctx context.Context, organization_id string, preset_id string) error
	// DomainConfigGet Get domain settings
	// The method allows you to get the domain settings
	DomainConfigGet(ctx context.Context) (model.DomainConfig, error)
	// DomainConfigSave Save domain settings
	// The method allows you to save the domain settings
	DomainConfigSave(ctx context.Context, body model.DomainConfig) error
	// EventsList Get events of Watcher
	// This method allows to get the batch of events. Currently this method is not implemented yet. However, its schema can be used for understanding Watcher logging.
	EventsList(ctx context.Context, query *EventsListQuery) (model.EventsList, error)
	// EventsListIterator iterates through all items using cursor pagination
	EventsListIterator(ctx context.Context, query *EventsListQuery) iter.Seq2[model.Event, error]
	// LetsencryptIssue Issue letsencrypt certificate
	// Issue letsencrypt certificate
	LetsencryptIssue(ctx context.Context, body model.LetsencryptRequest) (model.TlsCertificate, error)
	// LivenessProbe Liveness probe
	// K8s liveness probe.
	LivenessProbe(ctx context.Context) (model.ServerStatsWhoami, error)
	// LoginCreate Get an auth token
	// The method creates a new temporary auth-token (JWT). The JTW token used as Bearer token in requests other than `/login`.
	LoginCreate(ctx context.Context) (model.LoginInfoAdditional, error)
	// OrganizationPresetSave Update organizations preset
	// Save organization preset by its id or adds new preset to organization.
	OrganizationPresetSave(ctx context.Context, organization_id string, body model.OrganizationPreset) (model.Preset, error)
	// PresetGet Get one preset
	// This method is used to get info about preset by its id.
	PresetGet(ctx context.Context, id string) (model.Preset, error)
	// PresetSave Update preset
	// This method will update the existing preset with the specified id.
	PresetSave(ctx context.Context, id string, body model.Preset) (model.Preset, error)
	// PresetsCreate Create preset
	// This method will create a new preset.
	PresetsCreate(ctx context.Context, body model.Preset) (model.Preset, error)
	// PresetsList List presets
	// The presets in Watcher is a set of DVR and analytics parameters that you can use as a template when creating and configuring cameras. When you select a preset in the camera settings, the parameters from the preset are populated to the camera settings. A set of presets on the camera is defined by the set of presets selected for the camera's Organization. https://flussonic.com/doc/manage-presets-in-watcher-ui/  This method is used to get info about presets. If the `organization_id` is transferred this method will return presets only allowed in organization with that Id.
	PresetsList(ctx context.Context, query *PresetsListQuery) (model.PresetsList, error)
	// PresetsListIterator iterates through all items using cursor pagination
	PresetsListIterator(ctx context.Context, query *PresetsListQuery) iter.Seq2[model.Preset, error]
	// PreviewLayoutChangeForStreamConfig Dry run layouter for changed stream configuration
	// This method allows you to see how the overall layout will be changed due to changes into stream configuration. Note that if [Layouter](https://flussonic.com/doc/api/layouter/) is [disabled](https://flussonic.com/doc/api/central/#tag/config/operation/config_save%7Cbody%7Clayouter_enabled), this method will return an error.
	PreviewLayoutChangeForStreamConfig(ctx context.Context, name string, query *PreviewLayoutChangeForStreamConfigQuery, body model.StreamConfig) (model.CentralStreamLayoutPrediction, error)
	// PreviewLayoutChangeForStreamConfigIterator iterates through all items using cursor pagination
	PreviewLayoutChangeForStreamConfigIterator(ctx context.Context, name string, query *PreviewLayoutChangeForStreamConfigQuery, body model.StreamConfig) iter.Seq2[model.CentralStreamLayoutListItem, error]
	// PreviewLayoutChangeForStreamerConfig Dry run layouter for changed streamer configuration
	// This method allows you to see how the overall layout will be changed due to changes into streamer configuration. Note that if [Layouter](https://flussonic.com/doc/api/layouter/) is [disabled](https://flussonic.com/doc/api/central/#tag/config/operation/config_save%7Cbody%7Clayouter_enabled), this method will return an error.
	PreviewLayoutChangeForStreamerConfig(ctx context.Context, hostname string, query *PreviewLayoutChangeForStreamerConfigQuery, body model.StreamerLayoutPrediction) (model.CentralStreamerLayoutPrediction, error)
	// PreviewLayoutChangeForStreamerConfigIterator iterates through all items using cursor pagination
	PreviewLayoutChangeForStreamerConfigIterator(ctx context.Context, hostname string, query *PreviewLayoutChangeForStreamerConfigQuery, body model.StreamerLayoutPrediction) iter.Seq2[model.CentralStreamerLayoutPredictionItem, error]
	// ReadinessProbe Readiness probe
	// K8s readiness probe.
	ReadinessProbe(ctx context.Context) (model.ServerStatsWhoami, error)
	// SharedTokenCreate Create Shared token
	// Method to create shared token
	SharedTokenCreate(ctx context.Context, body model.SharedToken) (model.SharedToken, error)
	// SharedTokenDelete Delete Shared token
	// This method allows to delete a single shared token.
	SharedTokenDelete(ctx context.Context, key string) error
	// SharedTokensList List Shared tokens
	// Method allows to fetch configured Shared tokens
	SharedTokensList(ctx context.Context, query *SharedTokensListQuery) (model.SharedTokensList, error)
	// SharedTokensListIterator iterates through all items using cursor pagination
	SharedTokensListIterator(ctx context.Context, query *SharedTokensListQuery) iter.Seq2[model.SharedToken, error]
	// StreamDelete Delete the stream
	// This method allows to delete a single stream. You can delete `config_override` by this API call if you want to remove all runtime overrides.  If you do not specify any `part` parameter, this stream will be deleted from `config_on_disk` and if it was `named_by: config`, then it will immediately stop.
	StreamDelete(ctx context.Context, name string, query *StreamDeleteQuery) error
	// StreamFirmwareUpdate Update camera firmware
	// This method allows you to update camera firmware
	StreamFirmwareUpdate(ctx context.Context, name string, body model.FirmwareUpdate) error
	// StreamGet Get one stream
	// This method allows to fetch a single stream. Refer to the `streams_list` operation to find out what data will be returned in this method.
	StreamGet(ctx context.Context, name string) (model.StreamConfig, error)
	// StreamLayoutsGet Get layouts of stream
	// This method allows you to fetch stream layouts list
	StreamLayoutsGet(ctx context.Context, name string, query *StreamLayoutsGetQuery) (model.CentralStreamLayouts, error)
	// StreamLayoutsGetIterator iterates through all items using cursor pagination
	StreamLayoutsGetIterator(ctx context.Context, name string, query *StreamLayoutsGetQuery) iter.Seq2[model.CentralStreamLayout, error]
	// StreamSave Save stream
	// Create or update a stream by its name. If the stream doesn't exists in the disk config, it will be created.  If you try to update a stream that is started from a template by a user request having `named_by=user`, a new stream will be created in the disk config.  If you pass only a partial stream configuration, this field will be updated, not the whole stream.  To create a new stream the property `name` is required.  Pass the `"$reset": true` option to replace the stream configuration with the provided one.
	StreamSave(ctx context.Context, name string, query *StreamSaveQuery, body model.StreamConfig) (model.StreamConfig, error)
	// StreamerDelete Delete the streamer
	// Delete the streamer by its hostname.
	StreamerDelete(ctx context.Context, hostname string) error
	// StreamerGet Get the streamer
	// This method allows you to fetch the main parameters and current metrics of a single streamer
	StreamerGet(ctx context.Context, hostname string) (model.Streamer, error)
	// StreamerSave Save the streamer
	// This method will either create a new streamer (if there is no streamer with the hostname specified in the request), or update the existing streamer having the specified hostname.
	StreamerSave(ctx context.Context, hostname string, query *StreamerSaveQuery, body model.Streamer) (model.Streamer, error)
	// StreamersList List streamers
	// Returns the list of all streamers with main parameters and current metric values.
	StreamersList(ctx context.Context, query *StreamersListQuery) (model.StreamersList, error)
	// StreamersListIterator iterates through all items using cursor pagination
	StreamersListIterator(ctx context.Context, query *StreamersListQuery) iter.Seq2[model.Streamer, error]
	// StreamsMultiedit Save streams settings
	// Create or update settings for each stream. This operation does everything or nothing. If at least one stream has an invalid configuration or can't be processed, the request will fail.
	StreamsMultiedit(ctx context.Context, body model.StreamsMultieditConfig) error
	// StreamsZonesSettings Save streams with zone settings
	// Create or update zone settings for each stream. This operation does everything or nothing. If at least one stream has an invalid configuration or can't be processed, the request will fail.
	StreamsZonesSettings(ctx context.Context, body model.StreamsZoneSettings) error
	// SystemConfigGet Get system settings
	// The method allows you to get the system settings
	SystemConfigGet(ctx context.Context) (model.SystemConfig, error)
	// TlsCertificateGet Get tls certificate
	// Get current tls certificate
	TlsCertificateGet(ctx context.Context) (model.TlsCertificate, error)
	// UserCreate Create user
	// This method allows you to create a user
	UserCreate(ctx context.Context, body any) (model.User, error)
	// UserDelete Delete a user
	// This method allows you to delete a user
	UserDelete(ctx context.Context, user_id string) error
	// UserGet Get a user
	// This method allows you to fetch the user by its identifier
	UserGet(ctx context.Context, user_id string) (model.User, error)
	// UserSave Save user
	// This method allows you to update user data
	UserSave(ctx context.Context, user_id string, body model.User) (model.User, error)
	// UsersApikeyCreate Create new API key for user
	// The API key is used for authentication in API requests, allowing access to protected resources without using a password.
	UsersApikeyCreate(ctx context.Context, user_id string) (model.Apikey, error)
	// UsersApikeyGet Get user's API key
	// The API key is used for authentication in API requests, allowing access to protected resources without using a password.
	UsersApikeyGet(ctx context.Context, user_id string) (model.Apikey, error)
	// UsersList List of users
	// List of available users
	UsersList(ctx context.Context, query *UsersListQuery) (model.Users, error)
	// UsersListIterator iterates through all items using cursor pagination
	UsersListIterator(ctx context.Context, query *UsersListQuery) iter.Seq2[model.User, error]
	// WatcherProvision The operator identifier creation
	// This method allows you to create the operator identifier
	WatcherProvision(ctx context.Context) (model.WatcherStatus, error)
	// WatcherStatusGet Get the Watcher status
	// Get the Watcher status on the agent server.
	WatcherStatusGet(ctx context.Context) (model.WatcherStatus, error)
	// ZoneDelete Delete the zone
	// Delete the zone by its name.
	ZoneDelete(ctx context.Context, name string) error
	// ZoneGet Get the zone
	// This method allows you to fetch the main parameters and current metrics of a single zone
	ZoneGet(ctx context.Context, name string) (model.Zone, error)
	// ZoneSave Save the zone
	// This method will either create a new zone (if there is no zone with the name specified in the request), or update the existing zone having the specified name.
	ZoneSave(ctx context.Context, name string, body model.Zone) (model.Zone, error)
	// ZonesList List zones
	// Returns the list of all zones with main parameters and current metric values.
	ZonesList(ctx context.Context, query *ZonesListQuery) (model.ZonesList, error)
	// ZonesListIterator iterates through all items using cursor pagination
	ZonesListIterator(ctx context.Context, query *ZonesListQuery) iter.Seq2[model.Zone, error]
}

type ZonesListQuery struct {
	Cursor string
	Limit  int
	Select []string
	Sort   []string
	Extra  map[string]string
}