settingsapi

Documentation

Index

• func Get(params GetParams) (*models.ProxiesSettings, error)
• func Patch(params UpdateParams) (*models.ProxiesSettings, error)
• func Set(params UpdateParams) (*models.ProxiesSettings, error)
• type GetParams
  • func (params GetParams) Validate() error
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Get

func Get(params GetParams) (*models.ProxiesSettings, error)

Get retrieves the settings for all proxies

func Patch

func Patch(params UpdateParams) (*models.ProxiesSettings, error)

Patch updates only specific settings attributes for all proxies

func Set

func Set(params UpdateParams) (*models.ProxiesSettings, error)

Set sets the settings for all proxies

Types

type GetParams

type GetParams struct {
	*api.API

	Region string
}

GetParams is the set of parameters required for retrieving the settings for all proxies

func (GetParams) Validate

func (params GetParams) Validate() error

Validate parameters for get functions

type UpdateParams

type UpdateParams struct {
	*api.API
	*models.ProxiesSettings

	Region, Version string
}

UpdateParams is the set of parameters required for setting the settings for all proxies

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate parameters for set function