settingsapi

package

v1.2.30 Latest Latest Go to latest Published: Feb 19, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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

Get retrieves the settings for all proxies

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

Patch updates only specific settings attributes for all proxies

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

Set sets the settings for all proxies

type GetParams struct {
	*api.API

	Region string
}

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

func (params GetParams) Validate() error

Validate parameters for get functions

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 (params UpdateParams) Validate() error

Validate parameters for set function