Documentation
¶
Index ¶
- func Client(config *configuration.Config) *resty.Client
- func DeleteComponent(client *resty.Client, pageID string, componentID string) error
- func DeleteGroup(client *resty.Client, pageID string, groupID string) error
- func GetComponents(client *resty.Client, pageID string) (*[]statuspagetypes.Component, error)
- func GetGroups(client *resty.Client, pageID string) (*[]statuspagetypes.Group, error)
- func PatchComponent(client *resty.Client, pageID string, componentID string, ...) (*statuspagetypes.Component, error)
- func PatchComponentStatus(client *resty.Client, pageID string, componentID string, ...) (*statuspagetypes.Component, error)
- func PatchGroup(client *resty.Client, pageID string, groupID string, ...) (*statuspagetypes.Group, error)
- func PostComponent(client *resty.Client, pageID string, component statuspagetypes.Component) (*statuspagetypes.Component, error)
- func PostGroup(client *resty.Client, pageID string, group statuspagetypes.Group) (*statuspagetypes.Group, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Client ¶
func Client(config *configuration.Config) *resty.Client
Client within the statuspage package contains Resty config specific to interacting with statuspage.io
func DeleteComponent ¶
DeleteComponent deletes an existing component on the remote page by the component's ID, not name
func DeleteGroup ¶
DeleteGroup deletes an existing group on the remote page by the group's ID, not name
func GetComponents ¶
func GetComponents(client *resty.Client, pageID string) (*[]statuspagetypes.Component, error)
GetComponents provides a slice of all components (NOT groups) on the remote page
func GetGroups ¶
func GetGroups(client *resty.Client, pageID string) (*[]statuspagetypes.Group, error)
GetGroups provides a slice of all groups on the remote page
func PatchComponent ¶
func PatchComponent(client *resty.Client, pageID string, componentID string, component statuspagetypes.Component) (*statuspagetypes.Component, error)
PatchComponent updates an existing component on the remote page by the component's ID, not name
func PatchComponentStatus ¶ added in v1.0.0
func PatchComponentStatus(client *resty.Client, pageID string, componentID string, newStatus statuspagetypes.Status) (*statuspagetypes.Component, error)
PatchComponentStatus updates an existing component's status only
func PatchGroup ¶
func PatchGroup(client *resty.Client, pageID string, groupID string, group statuspagetypes.Group) (*statuspagetypes.Group, error)
PatchGroup updates an existing group on the remote page by the group's ID, not name
func PostComponent ¶
func PostComponent(client *resty.Client, pageID string, component statuspagetypes.Component) (*statuspagetypes.Component, error)
PostComponent creates a new component on the remote page
func PostGroup ¶
func PostGroup(client *resty.Client, pageID string, group statuspagetypes.Group) (*statuspagetypes.Group, error)
PostGroup creates a new group on the remote page
Types ¶
This section is empty.
Source Files