alert

Documentation

Overview

Package alert contains auto-generated files. DO NOT MODIFY

Package alert contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchAlertResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchAlertResponse, error)
• type ClientProperties
• type FetchAlertResponse

Types

type Client

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

Client for managing a specific alert resource See https://www.twilio.com/docs/usage/monitor-alert for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the alert client

func (Client) Fetch

func (c Client) Fetch() (*FetchAlertResponse, error)

Fetch retrieves an alert resource See https://www.twilio.com/docs/usage/monitor-alert#fetch-an-alert-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchAlertResponse, error)

FetchWithContext retrieves an alert resource See https://www.twilio.com/docs/usage/monitor-alert#fetch-an-alert-resource for more details

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the alert resources

type FetchAlertResponse

type FetchAlertResponse struct {
	APIVersion       *string    `json:"api_version,omitempty"`
	AccountSid       string     `json:"account_sid"`
	AlertText        *string    `json:"alert_text,omitempty"`
	DateCreated      time.Time  `json:"date_created"`
	DateGenerated    time.Time  `json:"date_generated"`
	DateUpdated      *time.Time `json:"date_updated,omitempty"`
	ErrorCode        string     `json:"error_code"`
	LogLevel         string     `json:"log_level"`
	MoreInfo         string     `json:"more_info"`
	RequestHeaders   *string    `json:"request_headers,omitempty"`
	RequestMethod    *string    `json:"request_method,omitempty"`
	RequestURL       *string    `json:"request_url,omitempty"`
	RequestVariables *string    `json:"request_variables,omitempty"`
	ResourceSid      string     `json:"resource_sid"`
	ResponseBody     *string    `json:"response_body,omitempty"`
	ResponseHeaders  *string    `json:"response_headers,omitempty"`
	ServiceSid       string     `json:"service_sid"`
	Sid              string     `json:"sid"`
	URL              string     `json:"url"`
}

FetchAlertResponse defines the response fields for the retrieved alert