client

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Aug 24, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

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"`
	Slug        string `jsonapi:"attr,slug,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
	Position    int    `jsonapi:"attr,position,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(d *Cause) (*Cause, error)

func (*Client) CreateCustomField added in v0.1.5

func (c *Client) CreateCustomField(d *CustomField) (*CustomField, error)

func (*Client) CreateCustomFieldOption added in v0.1.5

func (c *Client) CreateCustomFieldOption(d *CustomFieldOption) (*CustomFieldOption, error)

func (*Client) CreateDashboard added in v0.1.15

func (c *Client) CreateDashboard(dashboard *Dashboard) (*Dashboard, error)

func (*Client) CreateDashboardPanel added in v0.1.15

func (c *Client) CreateDashboardPanel(dashboardId string, dashboard_panel *DashboardPanel) (*DashboardPanel, error)

func (*Client) CreateEnvironment added in v0.1.5

func (c *Client) CreateEnvironment(d *Environment) (*Environment, error)

func (*Client) CreateFormField added in v0.1.48

func (c *Client) CreateFormField(d *FormField) (*FormField, error)

func (*Client) CreateFormFieldOption added in v0.1.48

func (c *Client) CreateFormFieldOption(d *FormFieldOption) (*FormFieldOption, error)

func (*Client) CreateFormFieldPosition added in v0.1.49

func (c *Client) CreateFormFieldPosition(d *FormFieldPosition) (*FormFieldPosition, error)

func (*Client) CreateFunctionality

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

func (*Client) CreateIncident added in v1.0.7

func (c *Client) CreateIncident(d *Incident) (*Incident, error)

func (*Client) CreateIncidentFormFieldSelection added in v0.1.48

func (c *Client) CreateIncidentFormFieldSelection(d *IncidentFormFieldSelection) (*IncidentFormFieldSelection, error)

func (*Client) CreateIncidentRole

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

func (*Client) CreateIncidentRoleTask added in v0.1.33

func (c *Client) CreateIncidentRoleTask(d *IncidentRoleTask) (*IncidentRoleTask, error)

func (*Client) CreateIncidentType

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

func (*Client) CreatePlaybook added in v0.1.26

func (c *Client) CreatePlaybook(d *Playbook) (*Playbook, error)

func (*Client) CreatePlaybookTask added in v0.1.62

func (c *Client) CreatePlaybookTask(d *PlaybookTask) (*PlaybookTask, error)

func (*Client) CreatePostmortemTemplate added in v0.1.39

func (c *Client) CreatePostmortemTemplate(d *PostmortemTemplate) (*PostmortemTemplate, error)

func (*Client) CreateSecret added in v0.1.58

func (c *Client) CreateSecret(d *Secret) (*Secret, error)

func (*Client) CreateService

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

func (*Client) CreateSeverity

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

func (*Client) CreateStatusPage added in v0.1.26

func (c *Client) CreateStatusPage(d *StatusPage) (*StatusPage, error)

func (*Client) CreateStatusPageTemplate added in v0.1.26

func (c *Client) CreateStatusPageTemplate(d *StatusPageTemplate) (*StatusPageTemplate, error)

func (*Client) CreateTeam

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

func (*Client) CreateWebhooksEndpoint added in v0.1.54

func (c *Client) CreateWebhooksEndpoint(d *WebhooksEndpoint) (*WebhooksEndpoint, error)

func (*Client) CreateWorkflow added in v0.1.5

func (c *Client) CreateWorkflow(d *Workflow) (*Workflow, error)

func (*Client) CreateWorkflowCustomFieldSelection added in v0.1.25

func (c *Client) CreateWorkflowCustomFieldSelection(d *WorkflowCustomFieldSelection) (*WorkflowCustomFieldSelection, error)

func (*Client) CreateWorkflowFormFieldCondition added in v0.1.48

func (c *Client) CreateWorkflowFormFieldCondition(d *WorkflowFormFieldCondition) (*WorkflowFormFieldCondition, error)

func (*Client) CreateWorkflowGroup added in v0.1.12

func (c *Client) CreateWorkflowGroup(d *WorkflowGroup) (*WorkflowGroup, error)

func (*Client) CreateWorkflowTask added in v0.1.5

func (c *Client) CreateWorkflowTask(i *WorkflowTask) (*WorkflowTask, error)

func (*Client) DeleteCause

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

func (*Client) DeleteCustomField added in v0.1.5

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

func (*Client) DeleteCustomFieldOption added in v0.1.5

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

func (*Client) DeleteDashboard added in v0.1.15

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

func (*Client) DeleteDashboardPanel added in v0.1.15

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

func (*Client) DeleteEnvironment added in v0.1.5

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

func (*Client) DeleteFormField added in v0.1.48

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

func (*Client) DeleteFormFieldOption added in v0.1.48

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

func (*Client) DeleteFormFieldPosition added in v0.1.49

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

func (*Client) DeleteFunctionality

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

func (*Client) DeleteIncident added in v1.0.7

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

func (*Client) DeleteIncidentFormFieldSelection added in v0.1.48

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

func (*Client) DeleteIncidentRole

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

func (*Client) DeleteIncidentRoleTask added in v0.1.33

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

func (*Client) DeleteIncidentType

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

func (*Client) DeletePlaybook added in v0.1.26

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

func (*Client) DeletePlaybookTask added in v0.1.62

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

func (*Client) DeletePostmortemTemplate added in v0.1.39

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

func (*Client) DeleteSecret added in v0.1.58

func (c *Client) DeleteSecret(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) DeleteStatusPage added in v0.1.26

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

func (*Client) DeleteStatusPageTemplate added in v0.1.26

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

func (*Client) DeleteTeam

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

func (*Client) DeleteWebhooksEndpoint added in v0.1.54

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

func (*Client) DeleteWorkflow added in v0.1.5

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

func (*Client) DeleteWorkflowCustomFieldSelection added in v0.1.25

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

func (*Client) DeleteWorkflowFormFieldCondition added in v0.1.48

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

func (*Client) DeleteWorkflowGroup added in v0.1.12

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

func (*Client) DeleteWorkflowTask added in v0.1.5

func (c *Client) DeleteWorkflowTask(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) GetCustomField added in v0.1.5

func (c *Client) GetCustomField(id string) (*CustomField, error)

func (*Client) GetCustomFieldOption added in v0.1.5

func (c *Client) GetCustomFieldOption(id string) (*CustomFieldOption, error)

func (*Client) GetDashboard added in v0.1.15

func (c *Client) GetDashboard(id string) (*Dashboard, error)

func (*Client) GetDashboardPanel added in v0.1.15

func (c *Client) GetDashboardPanel(id string, params *rootlygo.GetDashboardPanelParams) (*DashboardPanel, error)

func (*Client) GetEnvironment added in v0.1.5

func (c *Client) GetEnvironment(id string) (*Environment, error)

func (*Client) GetFormField added in v0.1.48

func (c *Client) GetFormField(id string) (*FormField, error)

func (*Client) GetFormFieldOption added in v0.1.48

func (c *Client) GetFormFieldOption(id string) (*FormFieldOption, error)

func (*Client) GetFormFieldPosition added in v0.1.49

func (c *Client) GetFormFieldPosition(id string) (*FormFieldPosition, error)

func (*Client) GetFunctionality

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

func (*Client) GetIncident added in v1.0.7

func (c *Client) GetIncident(id string) (*Incident, error)

func (*Client) GetIncidentFormFieldSelection added in v0.1.48

func (c *Client) GetIncidentFormFieldSelection(id string) (*IncidentFormFieldSelection, error)

func (*Client) GetIncidentRole

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

func (*Client) GetIncidentRoleTask added in v0.1.33

func (c *Client) GetIncidentRoleTask(id string) (*IncidentRoleTask, error)

func (*Client) GetIncidentType

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

func (*Client) GetPlaybook added in v0.1.26

func (c *Client) GetPlaybook(id string) (*Playbook, error)

func (*Client) GetPlaybookTask added in v0.1.62

func (c *Client) GetPlaybookTask(id string) (*PlaybookTask, error)

func (*Client) GetPostmortemTemplate added in v0.1.39

func (c *Client) GetPostmortemTemplate(id string) (*PostmortemTemplate, error)

func (*Client) GetSecret added in v0.1.58

func (c *Client) GetSecret(id string) (*Secret, 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) GetStatusPage added in v0.1.26

func (c *Client) GetStatusPage(id string) (*StatusPage, error)

func (*Client) GetStatusPageTemplate added in v0.1.26

func (c *Client) GetStatusPageTemplate(id string) (*StatusPageTemplate, error)

func (*Client) GetTeam

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

func (*Client) GetWebhooksEndpoint added in v0.1.54

func (c *Client) GetWebhooksEndpoint(id string) (*WebhooksEndpoint, error)

func (*Client) GetWorkflow added in v0.1.5

func (c *Client) GetWorkflow(id string) (*Workflow, error)

func (*Client) GetWorkflowCustomFieldSelection added in v0.1.25

func (c *Client) GetWorkflowCustomFieldSelection(id string) (*WorkflowCustomFieldSelection, error)

func (*Client) GetWorkflowFormFieldCondition added in v0.1.48

func (c *Client) GetWorkflowFormFieldCondition(id string) (*WorkflowFormFieldCondition, error)

func (*Client) GetWorkflowGroup added in v0.1.12

func (c *Client) GetWorkflowGroup(id string) (*WorkflowGroup, error)

func (*Client) GetWorkflowTask added in v0.1.5

func (c *Client) GetWorkflowTask(id string) (*WorkflowTask, error)

func (*Client) ListCauses added in v0.1.15

func (c *Client) ListCauses(params *rootlygo.ListCausesParams) ([]interface{}, error)

func (*Client) ListCustomFieldOptions added in v0.1.15

func (c *Client) ListCustomFieldOptions(id string, params *rootlygo.ListCustomFieldOptionsParams) ([]interface{}, error)

func (*Client) ListCustomFields added in v0.1.15

func (c *Client) ListCustomFields(params *rootlygo.ListCustomFieldsParams) ([]interface{}, error)

func (*Client) ListDashboardPanels added in v0.1.15

func (c *Client) ListDashboardPanels(dashboardId string, params *rootlygo.ListDashboardPanelsParams) ([]interface{}, error)

func (*Client) ListDashboards added in v0.1.15

func (c *Client) ListDashboards(params *rootlygo.ListDashboardsParams) ([]interface{}, error)

func (*Client) ListEnvironments added in v0.1.15

func (c *Client) ListEnvironments(params *rootlygo.ListEnvironmentsParams) ([]interface{}, error)

func (*Client) ListFormFieldOptions added in v0.1.48

func (c *Client) ListFormFieldOptions(id string, params *rootlygo.ListFormFieldOptionsParams) ([]interface{}, error)

func (*Client) ListFormFieldPositions added in v0.1.49

func (c *Client) ListFormFieldPositions(id string, params *rootlygo.ListFormFieldPositionsParams) ([]interface{}, error)

func (*Client) ListFormFields added in v0.1.48

func (c *Client) ListFormFields(params *rootlygo.ListFormFieldsParams) ([]interface{}, error)

func (*Client) ListFunctionalities added in v0.1.15

func (c *Client) ListFunctionalities(params *rootlygo.ListFunctionalitiesParams) ([]interface{}, error)

func (*Client) ListIncidentFormFieldSelections added in v0.1.48

func (c *Client) ListIncidentFormFieldSelections(id string, params *rootlygo.ListIncidentFormFieldSelectionsParams) ([]interface{}, error)

func (*Client) ListIncidentPostMortems added in v1.0.7

func (c *Client) ListIncidentPostMortems(params *rootlygo.ListIncidentPostMortemsParams) ([]interface{}, error)

func (*Client) ListIncidentRoleTasks added in v0.1.33

func (c *Client) ListIncidentRoleTasks(id string, params *rootlygo.ListIncidentRoleTasksParams) ([]interface{}, error)

func (*Client) ListIncidentRoles added in v0.1.15

func (c *Client) ListIncidentRoles(params *rootlygo.ListIncidentRolesParams) ([]interface{}, error)

func (*Client) ListIncidentTypes added in v0.1.15

func (c *Client) ListIncidentTypes(params *rootlygo.ListIncidentTypesParams) ([]interface{}, error)

func (*Client) ListIncidents added in v1.0.7

func (c *Client) ListIncidents(params *rootlygo.ListIncidentsParams) ([]interface{}, error)

func (*Client) ListPlaybookTasks added in v0.1.62

func (c *Client) ListPlaybookTasks(id string, params *rootlygo.ListPlaybookTasksParams) ([]interface{}, error)

func (*Client) ListPlaybooks added in v0.1.26

func (c *Client) ListPlaybooks(params *rootlygo.ListPlaybooksParams) ([]interface{}, error)

func (*Client) ListPostmortemTemplates added in v0.1.39

func (c *Client) ListPostmortemTemplates(params *rootlygo.ListPostmortemTemplatesParams) ([]interface{}, error)

func (*Client) ListSecrets added in v0.1.58

func (c *Client) ListSecrets(params *rootlygo.ListSecretsParams) ([]interface{}, error)

func (*Client) ListServices added in v0.1.15

func (c *Client) ListServices(params *rootlygo.ListServicesParams) ([]interface{}, error)

func (*Client) ListSeverities added in v0.1.15

func (c *Client) ListSeverities(params *rootlygo.ListSeveritiesParams) ([]interface{}, error)

func (*Client) ListStatusPageTemplates added in v0.1.26

func (c *Client) ListStatusPageTemplates(id string, params *rootlygo.ListStatusPageTemplatesParams) ([]interface{}, error)

func (*Client) ListStatusPages added in v0.1.26

func (c *Client) ListStatusPages(params *rootlygo.ListStatusPagesParams) ([]interface{}, error)

func (*Client) ListTeams added in v0.1.15

func (c *Client) ListTeams(params *rootlygo.ListTeamsParams) ([]interface{}, error)

func (*Client) ListUsers added in v1.0.4

func (c *Client) ListUsers(params *rootlygo.ListUsersParams) ([]interface{}, error)

func (*Client) ListWebhooksEndpoints added in v0.1.54

func (c *Client) ListWebhooksEndpoints(params *rootlygo.ListWebhooksEndpointsParams) ([]interface{}, error)

func (*Client) ListWorkflowCustomFieldSelections added in v0.1.25

func (c *Client) ListWorkflowCustomFieldSelections(id string, params *rootlygo.ListWorkflowCustomFieldSelectionsParams) ([]interface{}, error)

func (*Client) ListWorkflowFormFieldConditions added in v0.1.48

func (c *Client) ListWorkflowFormFieldConditions(id string, params *rootlygo.ListWorkflowFormFieldConditionsParams) ([]interface{}, error)

func (*Client) ListWorkflowGroups added in v0.1.26

func (c *Client) ListWorkflowGroups(params *rootlygo.ListWorkflowGroupsParams) ([]interface{}, error)

func (*Client) ListWorkflowTasks added in v0.1.52

func (c *Client) ListWorkflowTasks(workflowId string, params *rootlygo.ListWorkflowTasksParams) ([]interface{}, error)

func (*Client) ListWorkflows added in v0.1.26

func (c *Client) ListWorkflows(params *rootlygo.ListWorkflowsParams) ([]interface{}, error)

func (*Client) UpdateCause

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

func (*Client) UpdateCustomField added in v0.1.5

func (c *Client) UpdateCustomField(id string, custom_field *CustomField) (*CustomField, error)

func (*Client) UpdateCustomFieldOption added in v0.1.5

func (c *Client) UpdateCustomFieldOption(id string, custom_field_option *CustomFieldOption) (*CustomFieldOption, error)

func (*Client) UpdateDashboard added in v0.1.15

func (c *Client) UpdateDashboard(id string, dashboard *Dashboard) (*Dashboard, error)

func (*Client) UpdateDashboardPanel added in v0.1.15

func (c *Client) UpdateDashboardPanel(id string, dashboard_panel *DashboardPanel) (*DashboardPanel, error)

func (*Client) UpdateEnvironment added in v0.1.5

func (c *Client) UpdateEnvironment(id string, environment *Environment) (*Environment, error)

func (*Client) UpdateFormField added in v0.1.48

func (c *Client) UpdateFormField(id string, form_field *FormField) (*FormField, error)

func (*Client) UpdateFormFieldOption added in v0.1.48

func (c *Client) UpdateFormFieldOption(id string, form_field_option *FormFieldOption) (*FormFieldOption, error)

func (*Client) UpdateFormFieldPosition added in v0.1.49

func (c *Client) UpdateFormFieldPosition(id string, form_field_position *FormFieldPosition) (*FormFieldPosition, error)

func (*Client) UpdateFunctionality

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

func (*Client) UpdateIncident added in v1.0.7

func (c *Client) UpdateIncident(id string, incident *Incident) (*Incident, error)

func (*Client) UpdateIncidentFormFieldSelection added in v0.1.48

func (c *Client) UpdateIncidentFormFieldSelection(id string, incident_form_field_selection *IncidentFormFieldSelection) (*IncidentFormFieldSelection, error)

func (*Client) UpdateIncidentRole

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

func (*Client) UpdateIncidentRoleTask added in v0.1.33

func (c *Client) UpdateIncidentRoleTask(id string, incident_role_task *IncidentRoleTask) (*IncidentRoleTask, error)

func (*Client) UpdateIncidentType

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

func (*Client) UpdatePlaybook added in v0.1.26

func (c *Client) UpdatePlaybook(id string, playbook *Playbook) (*Playbook, error)

func (*Client) UpdatePlaybookTask added in v0.1.62

func (c *Client) UpdatePlaybookTask(id string, playbook_task *PlaybookTask) (*PlaybookTask, error)

func (*Client) UpdatePostmortemTemplate added in v0.1.39

func (c *Client) UpdatePostmortemTemplate(id string, post_mortem_template *PostmortemTemplate) (*PostmortemTemplate, error)

func (*Client) UpdateSecret added in v0.1.58

func (c *Client) UpdateSecret(id string, secret *Secret) (*Secret, error)

func (*Client) UpdateService

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

func (*Client) UpdateSeverity

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

func (*Client) UpdateStatusPage added in v0.1.26

func (c *Client) UpdateStatusPage(id string, status_page *StatusPage) (*StatusPage, error)

func (*Client) UpdateStatusPageTemplate added in v0.1.26

func (c *Client) UpdateStatusPageTemplate(id string, status_page_template *StatusPageTemplate) (*StatusPageTemplate, error)

func (*Client) UpdateTeam

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

func (*Client) UpdateWebhooksEndpoint added in v0.1.54

func (c *Client) UpdateWebhooksEndpoint(id string, webhooks_endpoint *WebhooksEndpoint) (*WebhooksEndpoint, error)

func (*Client) UpdateWorkflow added in v0.1.5

func (c *Client) UpdateWorkflow(id string, workflow *Workflow) (*Workflow, error)

func (*Client) UpdateWorkflowCustomFieldSelection added in v0.1.25

func (c *Client) UpdateWorkflowCustomFieldSelection(id string, workflow_custom_field_selection *WorkflowCustomFieldSelection) (*WorkflowCustomFieldSelection, error)

func (*Client) UpdateWorkflowFormFieldCondition added in v0.1.48

func (c *Client) UpdateWorkflowFormFieldCondition(id string, workflow_form_field_condition *WorkflowFormFieldCondition) (*WorkflowFormFieldCondition, error)

func (*Client) UpdateWorkflowGroup added in v0.1.12

func (c *Client) UpdateWorkflowGroup(id string, workflow_group *WorkflowGroup) (*WorkflowGroup, error)

func (*Client) UpdateWorkflowTask added in v0.1.5

func (c *Client) UpdateWorkflowTask(id string, i *WorkflowTask) (*WorkflowTask, error)

type CustomField added in v0.1.5

type CustomField struct {
	ID          string        `jsonapi:"primary,custom_fields"`
	Label       string        `jsonapi:"attr,label,omitempty"`
	Kind        string        `jsonapi:"attr,kind,omitempty"`
	Enabled     *bool         `jsonapi:"attr,enabled,omitempty"`
	Slug        string        `jsonapi:"attr,slug,omitempty"`
	Description string        `jsonapi:"attr,description,omitempty"`
	Shown       []interface{} `jsonapi:"attr,shown,omitempty"`
	Required    []interface{} `jsonapi:"attr,required,omitempty"`
	Default     string        `jsonapi:"attr,default,omitempty"`
	Position    int           `jsonapi:"attr,position,omitempty"`
}

type CustomFieldOption added in v0.1.5

type CustomFieldOption struct {
	ID            string `jsonapi:"primary,custom_field_options"`
	CustomFieldId int    `jsonapi:"attr,custom_field_id,omitempty"`
	Value         string `jsonapi:"attr,value,omitempty"`
	Color         string `jsonapi:"attr,color,omitempty"`
	Default       *bool  `jsonapi:"attr,default,omitempty"`
	Position      int    `jsonapi:"attr,position,omitempty"`
}

type Dashboard added in v0.1.15

type Dashboard struct {
	ID     string `jsonapi:"primary,dashboards"`
	Slug   string `jsonapi:"attr,slug,omitempty"`
	Name   string `jsonapi:"attr,name,omitempty"`
	Owner  string `jsonapi:"attr,owner,omitempty"`
	UserId int    `jsonapi:"attr,user_id,omitempty"`
	Public *bool  `jsonapi:"attr,public,omitempty"`
}

type DashboardPanel added in v0.1.15

type DashboardPanel struct {
	ID     string                 `jsonapi:"primary,dashboard_panels"`
	Name   string                 `jsonapi:"attr,name,omitempty"`
	Params map[string]interface{} `jsonapi:"attr,params,omitempty"`
}

type Environment added in v0.1.5

type Environment struct {
	ID            string        `jsonapi:"primary,environments"`
	Name          string        `jsonapi:"attr,name,omitempty"`
	Slug          string        `jsonapi:"attr,slug,omitempty"`
	Description   string        `jsonapi:"attr,description,omitempty"`
	NotifyEmails  []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	Color         string        `jsonapi:"attr,color,omitempty"`
	Position      int           `jsonapi:"attr,position,omitempty"`
	SlackChannels []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases  []interface{} `jsonapi:"attr,slack_aliases,omitempty"`
}

type FormField added in v0.1.48

type FormField struct {
	ID            string        `jsonapi:"primary,form_fields"`
	Kind          string        `jsonapi:"attr,kind,omitempty"`
	InputKind     string        `jsonapi:"attr,input_kind,omitempty"`
	Name          string        `jsonapi:"attr,name,omitempty"`
	Slug          string        `jsonapi:"attr,slug,omitempty"`
	Description   string        `jsonapi:"attr,description,omitempty"`
	Shown         []interface{} `jsonapi:"attr,shown,omitempty"`
	Required      []interface{} `jsonapi:"attr,required,omitempty"`
	Enabled       *bool         `jsonapi:"attr,enabled,omitempty"`
	DefaultValues []interface{} `jsonapi:"attr,default_values,omitempty"`
}

type FormFieldOption added in v0.1.48

type FormFieldOption struct {
	ID          string `jsonapi:"primary,form_field_options"`
	FormFieldId string `jsonapi:"attr,form_field_id,omitempty"`
	Value       string `jsonapi:"attr,value,omitempty"`
	Color       string `jsonapi:"attr,color,omitempty"`
	Default     *bool  `jsonapi:"attr,default,omitempty"`
	Position    int    `jsonapi:"attr,position,omitempty"`
}

type FormFieldPosition added in v0.1.49

type FormFieldPosition struct {
	ID          string `jsonapi:"primary,form_field_positions"`
	FormFieldId string `jsonapi:"attr,form_field_id,omitempty"`
	Form        string `jsonapi:"attr,form,omitempty"`
	Position    int    `jsonapi:"attr,position,omitempty"`
}

type Functionality

type Functionality struct {
	ID                string        `jsonapi:"primary,functionalities"`
	Name              string        `jsonapi:"attr,name,omitempty"`
	Slug              string        `jsonapi:"attr,slug,omitempty"`
	Description       string        `jsonapi:"attr,description,omitempty"`
	PublicDescription string        `jsonapi:"attr,public_description,omitempty"`
	NotifyEmails      []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	Color             string        `jsonapi:"attr,color,omitempty"`
	Status            string        `jsonapi:"attr,status,omitempty"`
	Position          int           `jsonapi:"attr,position,omitempty"`
	EnvironmentIds    []interface{} `jsonapi:"attr,environment_ids,omitempty"`
	ServiceIds        []interface{} `jsonapi:"attr,service_ids,omitempty"`
	OwnersGroupIds    []interface{} `jsonapi:"attr,owners_group_ids,omitempty"`
	OwnersUserIds     []interface{} `jsonapi:"attr,owners_user_ids,omitempty"`
	SlackChannels     []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases      []interface{} `jsonapi:"attr,slack_aliases,omitempty"`
}

type Incident added in v1.0.7

type Incident struct {
	ID                  string                 `jsonapi:"primary,incidents"`
	Title               string                 `jsonapi:"attr,title,omitempty"`
	Kind                string                 `jsonapi:"attr,kind,omitempty"`
	Slug                string                 `jsonapi:"attr,slug,omitempty"`
	ParentIncidentId    string                 `jsonapi:"attr,parent_incident_id,omitempty"`
	Summary             string                 `jsonapi:"attr,summary,omitempty"`
	Private             *bool                  `jsonapi:"attr,private,omitempty"`
	Severity            map[string]interface{} `jsonapi:"attr,severity,omitempty"`
	Environments        []interface{}          `jsonapi:"attr,environments,omitempty"`
	IncidentTypes       []interface{}          `jsonapi:"attr,incident_types,omitempty"`
	Services            []interface{}          `jsonapi:"attr,services,omitempty"`
	Functionalities     []interface{}          `jsonapi:"attr,functionalities,omitempty"`
	Groups              []interface{}          `jsonapi:"attr,groups,omitempty"`
	Labels              map[string]interface{} `jsonapi:"attr,labels,omitempty"`
	SlackChannelId      string                 `jsonapi:"attr,slack_channel_id,omitempty"`
	SlackChannelName    string                 `jsonapi:"attr,slack_channel_name,omitempty"`
	SlackChannelUrl     string                 `jsonapi:"attr,slack_channel_url,omitempty"`
	MitigationMessage   string                 `jsonapi:"attr,mitigation_message,omitempty"`
	ResolutionMessage   string                 `jsonapi:"attr,resolution_message,omitempty"`
	CancellationMessage string                 `jsonapi:"attr,cancellation_message,omitempty"`
	ScheduledFor        string                 `jsonapi:"attr,scheduled_for,omitempty"`
	ScheduledUntil      string                 `jsonapi:"attr,scheduled_until,omitempty"`
	InTriageAt          string                 `jsonapi:"attr,in_triage_at,omitempty"`
	StartedAt           string                 `jsonapi:"attr,started_at,omitempty"`
	DetectedAt          string                 `jsonapi:"attr,detected_at,omitempty"`
	AcknowledgedAt      string                 `jsonapi:"attr,acknowledged_at,omitempty"`
	MitigatedAt         string                 `jsonapi:"attr,mitigated_at,omitempty"`
	ResolvedAt          string                 `jsonapi:"attr,resolved_at,omitempty"`
	CancelledAt         string                 `jsonapi:"attr,cancelled_at,omitempty"`
}

type IncidentFormFieldSelection added in v0.1.48

type IncidentFormFieldSelection struct {
	ID                string        `jsonapi:"primary,incident_form_field_selections"`
	IncidentId        string        `jsonapi:"attr,incident_id,omitempty"`
	FormFieldId       string        `jsonapi:"attr,form_field_id,omitempty"`
	Value             string        `jsonapi:"attr,value,omitempty"`
	SelectedOptionIds []interface{} `jsonapi:"attr,selected_option_ids,omitempty"`
	SelectedUserIds   []interface{} `jsonapi:"attr,selected_user_ids,omitempty"`
}

type IncidentPostMortem added in v1.0.7

type IncidentPostMortem struct {
	ID                          string `jsonapi:"primary,incident_post_mortems"`
	Title                       string `jsonapi:"attr,title,omitempty"`
	Content                     string `jsonapi:"attr,content,omitempty"`
	Status                      string `jsonapi:"attr,status,omitempty"`
	StartedAt                   string `jsonapi:"attr,started_at,omitempty"`
	MitigatedAt                 string `jsonapi:"attr,mitigated_at,omitempty"`
	ResolvedAt                  string `jsonapi:"attr,resolved_at,omitempty"`
	ShowTimeline                *bool  `jsonapi:"attr,show_timeline,omitempty"`
	ShowTimelineTrail           *bool  `jsonapi:"attr,show_timeline_trail,omitempty"`
	ShowTimelineGenius          *bool  `jsonapi:"attr,show_timeline_genius,omitempty"`
	ShowTimelineTasks           *bool  `jsonapi:"attr,show_timeline_tasks,omitempty"`
	ShowTimelineActionItems     *bool  `jsonapi:"attr,show_timeline_action_items,omitempty"`
	ShowTimelineOrder           string `jsonapi:"attr,show_timeline_order,omitempty"`
	ShowServicesImpacted        *bool  `jsonapi:"attr,show_services_impacted,omitempty"`
	ShowFunctionalitiesImpacted *bool  `jsonapi:"attr,show_functionalities_impacted,omitempty"`
	ShowGroupsImpacted          *bool  `jsonapi:"attr,show_groups_impacted,omitempty"`
	ShowAlertsAttached          *bool  `jsonapi:"attr,show_alerts_attached,omitempty"`
	Url                         string `jsonapi:"attr,url,omitempty"`
}

type IncidentRole

type IncidentRole struct {
	ID                       string `jsonapi:"primary,incident_roles"`
	Name                     string `jsonapi:"attr,name,omitempty"`
	Slug                     string `jsonapi:"attr,slug,omitempty"`
	Summary                  string `jsonapi:"attr,summary,omitempty"`
	Description              string `jsonapi:"attr,description,omitempty"`
	Position                 int    `jsonapi:"attr,position,omitempty"`
	Optional                 *bool  `jsonapi:"attr,optional,omitempty"`
	Enabled                  *bool  `jsonapi:"attr,enabled,omitempty"`
	AllowMultiUserAssignment *bool  `jsonapi:"attr,allow_multi_user_assignment,omitempty"`
}

type IncidentRoleTask added in v0.1.33

type IncidentRoleTask struct {
	ID             string `jsonapi:"primary,incident_role_tasks"`
	IncidentRoleId string `jsonapi:"attr,incident_role_id,omitempty"`
	Task           string `jsonapi:"attr,task,omitempty"`
	Description    string `jsonapi:"attr,description,omitempty"`
	Priority       string `jsonapi:"attr,priority,omitempty"`
}

type IncidentType

type IncidentType struct {
	ID            string        `jsonapi:"primary,incident_types"`
	Name          string        `jsonapi:"attr,name,omitempty"`
	Slug          string        `jsonapi:"attr,slug,omitempty"`
	Description   string        `jsonapi:"attr,description,omitempty"`
	Color         string        `jsonapi:"attr,color,omitempty"`
	Position      int           `jsonapi:"attr,position,omitempty"`
	NotifyEmails  []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	SlackChannels []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases  []interface{} `jsonapi:"attr,slack_aliases,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 Playbook added in v0.1.26

type Playbook struct {
	ID               string        `jsonapi:"primary,playbooks"`
	Title            string        `jsonapi:"attr,title,omitempty"`
	Summary          string        `jsonapi:"attr,summary,omitempty"`
	ExternalUrl      string        `jsonapi:"attr,external_url,omitempty"`
	SeverityIds      []interface{} `jsonapi:"attr,severity_ids,omitempty"`
	EnvironmentIds   []interface{} `jsonapi:"attr,environment_ids,omitempty"`
	FunctionalityIds []interface{} `jsonapi:"attr,functionality_ids,omitempty"`
	ServiceIds       []interface{} `jsonapi:"attr,service_ids,omitempty"`
	GroupIds         []interface{} `jsonapi:"attr,group_ids,omitempty"`
	IncidentTypeIds  []interface{} `jsonapi:"attr,incident_type_ids,omitempty"`
}

type PlaybookTask added in v0.1.62

type PlaybookTask struct {
	ID          string `jsonapi:"primary,playbook_tasks"`
	PlaybookId  string `jsonapi:"attr,playbook_id,omitempty"`
	Task        string `jsonapi:"attr,task,omitempty"`
	Description string `jsonapi:"attr,description,omitempty"`
}

type PostmortemTemplate added in v0.1.39

type PostmortemTemplate struct {
	ID      string `jsonapi:"primary,post_mortem_templates"`
	Name    string `jsonapi:"attr,name,omitempty"`
	Default *bool  `jsonapi:"attr,default,omitempty"`
	Content string `jsonapi:"attr,content,omitempty"`
	Format  string `jsonapi:"attr,format,omitempty"`
}

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 Secret added in v0.1.58

type Secret struct {
	ID                    string `jsonapi:"primary,secrets"`
	Name                  string `jsonapi:"attr,name,omitempty"`
	Secret                string `jsonapi:"attr,secret,omitempty"`
	HashicorpVaultMount   string `jsonapi:"attr,hashicorp_vault_mount,omitempty"`
	HashicorpVaultPath    string `jsonapi:"attr,hashicorp_vault_path,omitempty"`
	HashicorpVaultVersion int    `jsonapi:"attr,hashicorp_vault_version,omitempty"`
}

type Service

type Service struct {
	ID                     string        `jsonapi:"primary,services"`
	Name                   string        `jsonapi:"attr,name,omitempty"`
	Slug                   string        `jsonapi:"attr,slug,omitempty"`
	Description            string        `jsonapi:"attr,description,omitempty"`
	PublicDescription      string        `jsonapi:"attr,public_description,omitempty"`
	NotifyEmails           []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	Color                  string        `jsonapi:"attr,color,omitempty"`
	Status                 string        `jsonapi:"attr,status,omitempty"`
	Position               int           `jsonapi:"attr,position,omitempty"`
	BackstageId            string        `jsonapi:"attr,backstage_id,omitempty"`
	PagerdutyId            string        `jsonapi:"attr,pagerduty_id,omitempty"`
	OpsgenieId             string        `jsonapi:"attr,opsgenie_id,omitempty"`
	GithubRepositoryName   string        `jsonapi:"attr,github_repository_name,omitempty"`
	GithubRepositoryBranch string        `jsonapi:"attr,github_repository_branch,omitempty"`
	GitlabRepositoryName   string        `jsonapi:"attr,gitlab_repository_name,omitempty"`
	GitlabRepositoryBranch string        `jsonapi:"attr,gitlab_repository_branch,omitempty"`
	EnvironmentIds         []interface{} `jsonapi:"attr,environment_ids,omitempty"`
	ServiceIds             []interface{} `jsonapi:"attr,service_ids,omitempty"`
	OwnersGroupIds         []interface{} `jsonapi:"attr,owners_group_ids,omitempty"`
	OwnersUserIds          []interface{} `jsonapi:"attr,owners_user_ids,omitempty"`
	SlackChannels          []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases           []interface{} `jsonapi:"attr,slack_aliases,omitempty"`
}

type Severity

type Severity struct {
	ID            string        `jsonapi:"primary,severities"`
	Name          string        `jsonapi:"attr,name,omitempty"`
	Slug          string        `jsonapi:"attr,slug,omitempty"`
	Description   string        `jsonapi:"attr,description,omitempty"`
	Severity      string        `jsonapi:"attr,severity,omitempty"`
	Color         string        `jsonapi:"attr,color,omitempty"`
	Position      int           `jsonapi:"attr,position,omitempty"`
	NotifyEmails  []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	SlackChannels []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases  []interface{} `jsonapi:"attr,slack_aliases,omitempty"`
}

type StatusPage added in v0.1.26

type StatusPage struct {
	ID                     string        `jsonapi:"primary,status_pages"`
	Title                  string        `jsonapi:"attr,title,omitempty"`
	Description            string        `jsonapi:"attr,description,omitempty"`
	HeaderColor            string        `jsonapi:"attr,header_color,omitempty"`
	FooterColor            string        `jsonapi:"attr,footer_color,omitempty"`
	AllowSearchEngineIndex *bool         `jsonapi:"attr,allow_search_engine_index,omitempty"`
	ShowUptime             *bool         `jsonapi:"attr,show_uptime,omitempty"`
	ShowUptimeLastDays     int           `jsonapi:"attr,show_uptime_last_days,omitempty"`
	SuccessMessage         string        `jsonapi:"attr,success_message,omitempty"`
	FailureMessage         string        `jsonapi:"attr,failure_message,omitempty"`
	AuthenticationEnabled  *bool         `jsonapi:"attr,authentication_enabled,omitempty"`
	AuthenticationPassword string        `jsonapi:"attr,authentication_password,omitempty"`
	WebsiteUrl             string        `jsonapi:"attr,website_url,omitempty"`
	WebsitePrivacyUrl      string        `jsonapi:"attr,website_privacy_url,omitempty"`
	WebsiteSupportUrl      string        `jsonapi:"attr,website_support_url,omitempty"`
	GaTrackingId           string        `jsonapi:"attr,ga_tracking_id,omitempty"`
	TimeZone               string        `jsonapi:"attr,time_zone,omitempty"`
	Public                 *bool         `jsonapi:"attr,public,omitempty"`
	ServiceIds             []interface{} `jsonapi:"attr,service_ids,omitempty"`
	FunctionalityIds       []interface{} `jsonapi:"attr,functionality_ids,omitempty"`
	Enabled                *bool         `jsonapi:"attr,enabled,omitempty"`
}

type StatusPageTemplate added in v0.1.26

type StatusPageTemplate struct {
	ID                      string `jsonapi:"primary,status_page_templates"`
	StatusPageId            string `jsonapi:"attr,status_page_id,omitempty"`
	Title                   string `jsonapi:"attr,title,omitempty"`
	Body                    string `jsonapi:"attr,body,omitempty"`
	UpdateStatus            string `jsonapi:"attr,update_status,omitempty"`
	ShouldNotifySubscribers *bool  `jsonapi:"attr,should_notify_subscribers,omitempty"`
	Enabled                 *bool  `jsonapi:"attr,enabled,omitempty"`
	Position                int    `jsonapi:"attr,position,omitempty"`
}

type Team

type Team struct {
	ID            string        `jsonapi:"primary,groups"`
	Name          string        `jsonapi:"attr,name,omitempty"`
	Slug          string        `jsonapi:"attr,slug,omitempty"`
	Description   string        `jsonapi:"attr,description,omitempty"`
	NotifyEmails  []interface{} `jsonapi:"attr,notify_emails,omitempty"`
	Color         string        `jsonapi:"attr,color,omitempty"`
	Position      int           `jsonapi:"attr,position,omitempty"`
	SlackChannels []interface{} `jsonapi:"attr,slack_channels,omitempty"`
	SlackAliases  []interface{} `jsonapi:"attr,slack_aliases,omitempty"`
}

type User added in v1.0.4

type User struct {
	ID               string `jsonapi:"primary,users"`
	Email            string `jsonapi:"attr,email,omitempty"`
	FullName         string `jsonapi:"attr,full_name,omitempty"`
	FullNameWithTeam string `jsonapi:"attr,full_name_with_team,omitempty"`
}

type WebhooksEndpoint added in v0.1.54

type WebhooksEndpoint struct {
	ID         string        `jsonapi:"primary,webhooks_endpoints"`
	Name       string        `jsonapi:"attr,name,omitempty"`
	Slug       string        `jsonapi:"attr,slug,omitempty"`
	Url        string        `jsonapi:"attr,url,omitempty"`
	EventTypes []interface{} `jsonapi:"attr,event_types,omitempty"`
	Secret     string        `jsonapi:"attr,secret,omitempty"`
	Enabled    *bool         `jsonapi:"attr,enabled,omitempty"`
}

type Workflow added in v0.1.5

type Workflow struct {
	ID                     string                 `jsonapi:"primary,workflows"`
	Name                   string                 `jsonapi:"attr,name,omitempty"`
	Slug                   string                 `jsonapi:"attr,slug,omitempty"`
	Description            string                 `jsonapi:"attr,description,omitempty"`
	Command                string                 `jsonapi:"attr,command,omitempty"`
	CommandFeedbackEnabled *bool                  `jsonapi:"attr,command_feedback_enabled,omitempty"`
	Wait                   string                 `jsonapi:"attr,wait,omitempty"`
	RepeatEveryDuration    string                 `jsonapi:"attr,repeat_every_duration,omitempty"`
	RepeatOn               []interface{}          `jsonapi:"attr,repeat_on,omitempty"`
	Enabled                *bool                  `jsonapi:"attr,enabled,omitempty"`
	Position               int                    `jsonapi:"attr,position,omitempty"`
	WorkflowGroupId        string                 `jsonapi:"attr,workflow_group_id,omitempty"`
	TriggerParams          map[string]interface{} `jsonapi:"attr,trigger_params,omitempty"`
	EnvironmentIds         []interface{}          `jsonapi:"attr,environment_ids,omitempty"`
	SeverityIds            []interface{}          `jsonapi:"attr,severity_ids,omitempty"`
	IncidentTypeIds        []interface{}          `jsonapi:"attr,incident_type_ids,omitempty"`
	IncidentRoleIds        []interface{}          `jsonapi:"attr,incident_role_ids,omitempty"`
	ServiceIds             []interface{}          `jsonapi:"attr,service_ids,omitempty"`
	GroupIds               []interface{}          `jsonapi:"attr,group_ids,omitempty"`
}

type WorkflowCustomFieldSelection added in v0.1.25

type WorkflowCustomFieldSelection struct {
	ID                string        `jsonapi:"primary,workflow_custom_field_selections"`
	WorkflowId        string        `jsonapi:"attr,workflow_id,omitempty"`
	CustomFieldId     int           `jsonapi:"attr,custom_field_id,omitempty"`
	IncidentCondition string        `jsonapi:"attr,incident_condition,omitempty"`
	Values            []interface{} `jsonapi:"attr,values,omitempty"`
	SelectedOptionIds []interface{} `jsonapi:"attr,selected_option_ids,omitempty"`
}

type WorkflowFormFieldCondition added in v0.1.48

type WorkflowFormFieldCondition struct {
	ID                string        `jsonapi:"primary,workflow_form_field_conditions"`
	WorkflowId        string        `jsonapi:"attr,workflow_id,omitempty"`
	FormFieldId       string        `jsonapi:"attr,form_field_id,omitempty"`
	IncidentCondition string        `jsonapi:"attr,incident_condition,omitempty"`
	Values            []interface{} `jsonapi:"attr,values,omitempty"`
	SelectedOptionIds []interface{} `jsonapi:"attr,selected_option_ids,omitempty"`
	SelectedUserIds   []interface{} `jsonapi:"attr,selected_user_ids,omitempty"`
}

type WorkflowGroup added in v0.1.12

type WorkflowGroup struct {
	ID       string `jsonapi:"primary,workflow_groups"`
	Kind     string `jsonapi:"attr,kind,omitempty"`
	Name     string `jsonapi:"attr,name,omitempty"`
	Slug     string `jsonapi:"attr,slug,omitempty"`
	Expanded *bool  `jsonapi:"attr,expanded,omitempty"`
	Position int    `jsonapi:"attr,position,omitempty"`
}

type WorkflowTask added in v0.1.5

type WorkflowTask struct {
	ID            string                 `jsonapi:"primary,workflow_tasks"`
	WorkflowId    string                 `jsonapi:"attr,workflow_id,omitempty"`
	Name          string                 `jsonapi:"attr,name,omitempty"`
	Position      int                    `jsonapi:"attr,position,omitempty"`
	SkipOnFailure *bool                  `jsonapi:"attr,skip_on_failure,omitempty"`
	Enabled       *bool                  `jsonapi:"attr,enabled,omitempty"`
	TaskParams    map[string]interface{} `jsonapi:"attr,task_params,omitempty"`
}

Jump to

Keyboard shortcuts

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