incidentio

package
v0.0.8 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2023 License: MPL-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const HostURL string = "https://api.incident.io"

Variables

This section is empty.

Functions

func IsErrorStatus added in v0.0.4 

func IsErrorStatus(err error, statusCode int) bool

IsErrorStatus returns true if the error is an Incident.io error with the matching status code.

func NewErrors 

func NewErrors(body []byte) error

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(apiKey string) *Client

func (*Client) CustomFieldOptions added in v0.0.4 

func (c *Client) CustomFieldOptions() *CustomFieldOptions

func (*Client) CustomFields added in v0.0.4 

func (c *Client) CustomFields() *CustomFields

func (*Client) IncidentRoles 

func (c *Client) IncidentRoles() *IncidentRoles

func (*Client) Severities added in v0.0.3 

func (c *Client) Severities() *Severities

func (*Client) WithDebug added in v0.0.3 

func (c *Client) WithDebug(debug bool) *Client

func (*Client) WithHostURL added in v0.0.3 

func (c *Client) WithHostURL(url string) *Client

type CustomField added in v0.0.4 

type CustomField struct {
	Name               string              `json:"name"`
	Description        string              `json:"description"`
	Required           FieldRequirement    `json:"required"`
	ShowBeforeClosure  bool                `json:"show_before_closure"`
	ShowBeforeCreation bool                `json:"show_before_creation"`
	ShowBeforeUpdate   bool                `json:"show_before_update"`
	FieldType          FieldType           `json:"field_type"`
	Options            []CustomFieldOption `json:"options"`
}

type CustomFieldMetadata added in v0.0.4 

type CustomFieldMetadata struct {
	CustomField

	Id        string `json:"id"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type CustomFieldOption added in v0.0.4 

type CustomFieldOption struct {
	CustomFieldId string `json:"custom_field_id"`
	SortKey       int64  `json:"sort_key"`
	Value         string `json:"value"`
}

type CustomFieldOptionMetadata added in v0.0.4 

type CustomFieldOptionMetadata struct {
	CustomFieldOption

	Id string `json:"id"`
}

type CustomFieldOptionResponse added in v0.0.4 

type CustomFieldOptionResponse struct {
	CustomFieldOption CustomFieldOptionMetadata `json:"custom_field_option"`
}

type CustomFieldOptions added in v0.0.4 

type CustomFieldOptions struct {
	// contains filtered or unexported fields
}

CustomFieldOptions is used to query custom field options

func (*CustomFieldOptions) Create added in v0.0.4 

func (i *CustomFieldOptions) Create(customFieldOption CustomFieldOption) (*CustomFieldOptionResponse, error)

func (*CustomFieldOptions) Delete added in v0.0.4 

func (i *CustomFieldOptions) Delete(id string) error

func (*CustomFieldOptions) Get added in v0.0.4 

func (i *CustomFieldOptions) Get(id string) (*CustomFieldOptionResponse, error)

func (*CustomFieldOptions) Update added in v0.0.4 

func (i *CustomFieldOptions) Update(id string, customFieldOption CustomFieldOption) (*CustomFieldOptionResponse, error)

type CustomFieldResponse added in v0.0.4 

type CustomFieldResponse struct {
	CustomField CustomFieldMetadata `json:"custom_field"`
}

type CustomFields added in v0.0.4 

type CustomFields struct {
	// contains filtered or unexported fields
}

CustomFields is used to query custom field options

func (*CustomFields) Create added in v0.0.4 

func (i *CustomFields) Create(field CustomField) (*CustomFieldResponse, error)

func (*CustomFields) Delete added in v0.0.4 

func (i *CustomFields) Delete(id string) error

func (*CustomFields) Get added in v0.0.4 

func (i *CustomFields) Get(id string) (*CustomFieldResponse, error)

func (*CustomFields) Update added in v0.0.4 

func (i *CustomFields) Update(id string, field CustomField) (*CustomFieldResponse, error)

type FieldRequirement added in v0.0.4 

type FieldRequirement string
const (
	Never         FieldRequirement = "never"
	BeforeClosure FieldRequirement = "before_closure"
	Always        FieldRequirement = "always"
)

func ParseFieldRequirement added in v0.0.4 

func ParseFieldRequirement(s string) (*FieldRequirement, error)

type FieldType added in v0.0.4 

type FieldType string
const (
	SingleSelect FieldType = "single_select"
	MultiSelect  FieldType = "multi_select"
	Text         FieldType = "text"
	Link         FieldType = "link"
	Numeric      FieldType = "numeric"
)

func ParseFieldType added in v0.0.4 

func ParseFieldType(s string) (*FieldType, error)

type IncidentIOError 

type IncidentIOError struct {
	Code    string      `json:"code"`
	Message string      `json:"message"`
	Source  SourceError `json:"source"`
}

type IncidentIOErrorResponse 

type IncidentIOErrorResponse struct {
	Type      string            `json:"type"`
	Status    int               `json:"status"`
	RequestID string            `json:"request_id"`
	Errors    []IncidentIOError `json:"errors"`
}

func (*IncidentIOErrorResponse) Error 

func (e *IncidentIOErrorResponse) Error() string

type IncidentRole 

type IncidentRole struct {
	Name         string `json:"name"`
	Description  string `json:"description"`
	Required     bool   `json:"required"`
	Instructions string `json:"instructions"`
	ShortForm    string `json:"shortform"`
}

type IncidentRoleMetadata 

type IncidentRoleMetadata struct {
	IncidentRole

	Id        string `json:"id"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
	RoleType  string `json:"role_type"`
}

type IncidentRoleResponse 

type IncidentRoleResponse struct {
	IncidentRole IncidentRoleMetadata `json:"incident_role"`
}

type IncidentRoles 

type IncidentRoles struct {
	// contains filtered or unexported fields
}

IncidentRoles is used to query incident roles

func (*IncidentRoles) Create 

func (i *IncidentRoles) Create(role IncidentRole) (*IncidentRoleResponse, error)

func (*IncidentRoles) Delete 

func (i *IncidentRoles) Delete(id string) error

func (*IncidentRoles) Get 

func (i *IncidentRoles) Get(id string) (*IncidentRoleResponse, error)

func (*IncidentRoles) Update 

func (i *IncidentRoles) Update(id string, role IncidentRole) (*IncidentRoleResponse, error)

type Severities added in v0.0.3 

type Severities struct {
	// contains filtered or unexported fields
}

Severities is used to query severities

func (*Severities) Create added in v0.0.3 

func (i *Severities) Create(severity Severity) (*SeverityResponse, error)

func (*Severities) Delete added in v0.0.3 

func (i *Severities) Delete(id string) error

func (*Severities) Get added in v0.0.3 

func (i *Severities) Get(id string) (*SeverityResponse, error)

func (*Severities) Update added in v0.0.3 

func (i *Severities) Update(id string, severity Severity) (*SeverityResponse, error)

type Severity added in v0.0.3 

type Severity struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Rank        int64  `json:"rank"`
}

type SeverityMetadata added in v0.0.3 

type SeverityMetadata struct {
	Severity

	Id        string `json:"id"`
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type SeverityResponse added in v0.0.3 

type SeverityResponse struct {
	Severity SeverityMetadata `json:"severity"`
}

type SourceError added in v0.0.3 

type SourceError struct {
	Field   string `json:"field"`
	Pointer string `json:"pointer"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.