client

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2022 License: MPL-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MarshalData

func MarshalData(entity interface{}) (io.Reader, error)

func UnmarshalData

func UnmarshalData(data io.ReadCloser, entity interface{}) (interface{}, error)

Types

type Cause

type Cause struct {
	ID          string `jsonapi:"primary,causes"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
}

type Client

type Client struct {
	Token       string
	ContentType string
	UserAgent   string
	Rootly      rootlygo.Client
}

func NewClient

func NewClient(endpoint, token, userAgent string) (*Client, error)

NewClient returns a new rootly.Client which can be used to access the API methods.

func (*Client) CreateCause

func (c *Client) CreateCause(cause *Cause) (*Cause, error)

func (*Client) CreateFunctionality

func (c *Client) CreateFunctionality(f *Functionality) (*Functionality, error)

func (*Client) CreateIncidentRole

func (c *Client) CreateIncidentRole(i *IncidentRole) (*IncidentRole, error)

func (*Client) CreateIncidentType

func (c *Client) CreateIncidentType(i *IncidentType) (*IncidentType, error)

func (*Client) CreateService

func (c *Client) CreateService(s *Service) (*Service, error)

func (*Client) CreateSeverity

func (c *Client) CreateSeverity(s *Severity) (*Severity, error)

func (*Client) CreateTeam

func (c *Client) CreateTeam(t *Team) (*Team, error)

func (*Client) DeleteCause

func (c *Client) DeleteCause(id string) error

func (*Client) DeleteFunctionality

func (c *Client) DeleteFunctionality(id string) error

func (*Client) DeleteIncidentRole

func (c *Client) DeleteIncidentRole(id string) error

func (*Client) DeleteIncidentType

func (c *Client) DeleteIncidentType(id string) error

func (*Client) DeleteService

func (c *Client) DeleteService(id string) error

func (*Client) DeleteSeverity

func (c *Client) DeleteSeverity(id string) error

func (*Client) DeleteTeam

func (c *Client) DeleteTeam(id string) error

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do Intercepts the Request and enriches it with the required information.

func (*Client) GetCause

func (c *Client) GetCause(id string) (*Cause, error)

func (*Client) GetFunctionality

func (c *Client) GetFunctionality(id string) (*Functionality, error)

func (*Client) GetIncidentRole

func (c *Client) GetIncidentRole(id string) (*IncidentRole, error)

func (*Client) GetIncidentType

func (c *Client) GetIncidentType(id string) (*IncidentType, error)

func (*Client) GetService

func (c *Client) GetService(id string) (*Service, error)

func (*Client) GetSeverity

func (c *Client) GetSeverity(id string) (*Severity, error)

func (*Client) GetTeam

func (c *Client) GetTeam(id string) (*Team, error)

func (*Client) UpdateCause

func (c *Client) UpdateCause(id string, cause *Cause) (*Cause, error)

func (*Client) UpdateFunctionality

func (c *Client) UpdateFunctionality(id string, f *Functionality) (*Functionality, error)

func (*Client) UpdateIncidentRole

func (c *Client) UpdateIncidentRole(id string, i *IncidentRole) (*IncidentRole, error)

func (*Client) UpdateIncidentType

func (c *Client) UpdateIncidentType(id string, i *IncidentType) (*IncidentType, error)

func (*Client) UpdateService

func (c *Client) UpdateService(id string, s *Service) (*Service, error)

func (*Client) UpdateSeverity

func (c *Client) UpdateSeverity(id string, s *Severity) (*Severity, error)

func (*Client) UpdateTeam

func (c *Client) UpdateTeam(id string, t *Team) (*Team, error)

type Functionality

type Functionality struct {
	ID          string `jsonapi:"primary,functionalities"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Slug        string `jsonapi:"attr,slug,omitempty"`
	Color       string `jsonapi:"attr,color,omitempty"`
}

type IncidentRole

type IncidentRole struct {
	ID          string `jsonapi:"primary,incident_roles"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Summary     string `jsonapi:"attr,summary,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Enabled     *bool  `jsonapi:"attr,enabled,omitempty"`
}

type IncidentType

type IncidentType struct {
	ID          string `jsonapi:"primary,incident_types"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Color       string `jsonapi:"attr,color,omitempty"`
}

type NotFoundError

type NotFoundError struct {
	Message    string
	StatusCode int
}

func NewNotFoundError

func NewNotFoundError(message string) NotFoundError

func (NotFoundError) Error

func (err NotFoundError) Error() string

type RequestError

type RequestError struct {
	Message    string
	StatusCode int
}

func NewRequestError

func NewRequestError(StatusCode int, message string) RequestError

func (RequestError) Error

func (err RequestError) Error() string

type Service

type Service struct {
	ID                string `jsonapi:"primary,services"`
	Name              string `jsonapi:"attr,name,omitempty"`
	Slug              string `jsonapi:"attr,slug,omitempty"`
	Color             string `jsonapi:"attr,color,omitempty"`
	Description       string `jsonapi:"attr,description,omitempty"`
	PublicDescription string `jsonapi:"attr,public_description,omitempty"`
}

type Severity

type Severity struct {
	ID          string `jsonapi:"primary,severities"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Slug        string `jsonapi:"attr,slug,omitempty"`
	Color       string `jsonapi:"attr,color,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Severity    string `jsonapi:"attr,severity,omitempty"`
}

type Team

type Team struct {
	ID          string `jsonapi:"primary,groups"`
	Name        string `jsonapi:"attr,name,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Color       string `jsonapi:"attr,color,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL