proxies

Documentation

Index

• Constants
• type AddProxyCommandInput
• type DeleteProxyCommandInput
• type GetProxiesCommandInput
• type GetProxyCommandInput
• type ProxiesAPI
• type ProxiesService
  • func New(cfg *config.Config) *ProxiesService
  • func (s *ProxiesService) AddProxyCommand(input *AddProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
  • func (s *ProxiesService) DeleteProxyCommand(input *DeleteProxyCommandInput) (resp *http.Response, err error)
  • func (s *ProxiesService) GetProxiesCommand(input *GetProxiesCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
  • func (s *ProxiesService) GetProxyCommand(input *GetProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
  • func (s *ProxiesService) UpdateProxyCommand(input *UpdateProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
• type UpdateProxyCommandInput

Constants

const (
	// ServiceName - The name of service.
	ServiceName = "Proxies"
)

Types

type AddProxyCommandInput

type AddProxyCommandInput struct {
	Body models.HttpClientProxyView
}

AddProxyCommandInput - Inputs for AddProxyCommand

type DeleteProxyCommandInput

type DeleteProxyCommandInput struct {
	Id string
}

DeleteProxyCommandInput - Inputs for DeleteProxyCommand

type GetProxiesCommandInput

type GetProxiesCommandInput struct {
	Page          string
	NumberPerPage string
	Filter        string
	Name          string
	SortKey       string
	Order         string
}

GetProxiesCommandInput - Inputs for GetProxiesCommand

type GetProxyCommandInput

type GetProxyCommandInput struct {
	Id string
}

GetProxyCommandInput - Inputs for GetProxyCommand

type ProxiesAPI

type ProxiesAPI interface {
	GetProxiesCommand(input *GetProxiesCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
	AddProxyCommand(input *AddProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
	DeleteProxyCommand(input *DeleteProxyCommandInput) (resp *http.Response, err error)
	GetProxyCommand(input *GetProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
	UpdateProxyCommand(input *UpdateProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)
}

type ProxiesService

type ProxiesService struct {
	*client.Client
}

ProxiesService provides the API operations for making requests to Proxies endpoint.

func New

func New(cfg *config.Config) *ProxiesService

New createa a new instance of the ProxiesService client.

Example:

cfg := config.NewConfig().WithUsername("Administrator").WithPassword("2Access").WithEndpoint(paURL)

//Create a ProxiesService from the configuration
svc := proxies.New(cfg)

func (*ProxiesService) AddProxyCommand

func (s *ProxiesService) AddProxyCommand(input *AddProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)

AddProxyCommand - Create a Proxy RequestType: POST Input: input *AddProxyCommandInput

func (*ProxiesService) DeleteProxyCommand

func (s *ProxiesService) DeleteProxyCommand(input *DeleteProxyCommandInput) (resp *http.Response, err error)

DeleteProxyCommand - Delete a Proxy RequestType: DELETE Input: input *DeleteProxyCommandInput

func (*ProxiesService) GetProxiesCommand

func (s *ProxiesService) GetProxiesCommand(input *GetProxiesCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)

GetProxiesCommand - Get all Proxies RequestType: GET Input: input *GetProxiesCommandInput

func (*ProxiesService) GetProxyCommand

func (s *ProxiesService) GetProxyCommand(input *GetProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)

GetProxyCommand - Get a Proxy RequestType: GET Input: input *GetProxyCommandInput

func (*ProxiesService) UpdateProxyCommand

func (s *ProxiesService) UpdateProxyCommand(input *UpdateProxyCommandInput) (output *models.HttpClientProxyView, resp *http.Response, err error)

UpdateProxyCommand - Update a Proxy RequestType: PUT Input: input *UpdateProxyCommandInput

type UpdateProxyCommandInput

type UpdateProxyCommandInput struct {
	Body models.HttpClientProxyView
	Id   string
}

UpdateProxyCommandInput - Inputs for UpdateProxyCommand