sites

Documentation

Index

• Constants
• type AddSiteCommandInput
• type DeleteSiteCommandInput
• type GetSiteCommandInput
• type GetSitesCommandInput
• type SitesAPI
• type SitesService
  • func New(cfg *config.Config) *SitesService
  • func (s *SitesService) AddSiteCommand(input *AddSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
  • func (s *SitesService) DeleteSiteCommand(input *DeleteSiteCommandInput) (resp *http.Response, err error)
  • func (s *SitesService) GetSiteCommand(input *GetSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
  • func (s *SitesService) GetSitesCommand(input *GetSitesCommandInput) (output *models.SitesView, resp *http.Response, err error)
  • func (s *SitesService) UpdateSiteCommand(input *UpdateSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
• type UpdateSiteCommandInput

Constants

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

Types

type AddSiteCommandInput

type AddSiteCommandInput struct {
	Body models.SiteView
}

AddSiteCommandInput - Inputs for AddSiteCommand

type DeleteSiteCommandInput

type DeleteSiteCommandInput struct {
	Id string
}

DeleteSiteCommandInput - Inputs for DeleteSiteCommand

type GetSiteCommandInput

type GetSiteCommandInput struct {
	Id string
}

GetSiteCommandInput - Inputs for GetSiteCommand

type GetSitesCommandInput

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

GetSitesCommandInput - Inputs for GetSitesCommand

type SitesAPI

type SitesAPI interface {
	GetSitesCommand(input *GetSitesCommandInput) (output *models.SitesView, resp *http.Response, err error)
	AddSiteCommand(input *AddSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
	DeleteSiteCommand(input *DeleteSiteCommandInput) (resp *http.Response, err error)
	GetSiteCommand(input *GetSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
	UpdateSiteCommand(input *UpdateSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)
}

type SitesService

type SitesService struct {
	*client.Client
}

SitesService provides the API operations for making requests to Sites endpoint.

func New

func New(cfg *config.Config) *SitesService

New createa a new instance of the SitesService client.

Example:

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

//Create a SitesService from the configuration
svc := sites.New(cfg)

func (*SitesService) AddSiteCommand

func (s *SitesService) AddSiteCommand(input *AddSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)

AddSiteCommand - Create a Site RequestType: POST Input: input *AddSiteCommandInput

func (*SitesService) DeleteSiteCommand

func (s *SitesService) DeleteSiteCommand(input *DeleteSiteCommandInput) (resp *http.Response, err error)

DeleteSiteCommand - Delete a Site RequestType: DELETE Input: input *DeleteSiteCommandInput

func (*SitesService) GetSiteCommand

func (s *SitesService) GetSiteCommand(input *GetSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)

GetSiteCommand - Get a Site RequestType: GET Input: input *GetSiteCommandInput

func (*SitesService) GetSitesCommand

func (s *SitesService) GetSitesCommand(input *GetSitesCommandInput) (output *models.SitesView, resp *http.Response, err error)

GetSitesCommand - Get all Sites RequestType: GET Input: input *GetSitesCommandInput

func (*SitesService) UpdateSiteCommand

func (s *SitesService) UpdateSiteCommand(input *UpdateSiteCommandInput) (output *models.SiteView, resp *http.Response, err error)

UpdateSiteCommand - Update a Site RequestType: PUT Input: input *UpdateSiteCommandInput

type UpdateSiteCommandInput

type UpdateSiteCommandInput struct {
	Body models.SiteView
	Id   string
}

UpdateSiteCommandInput - Inputs for UpdateSiteCommand