notification

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType 

type ActionType string
const (
	CreateAlert         ActionType = "create-alert"
	AcknowledgedAlert   ActionType = "acknowledged-alert"
	ClosedAlert         ActionType = "closed-alert"
	AssignedAlert       ActionType = "assigned-alert"
	AddNote             ActionType = "add-note"
	ScheduleStart       ActionType = "schedule-start"
	ScheduleEnd         ActionType = "schedule-end"
	IncomingCallRouting ActionType = "incoming-call-routing"
)

type Client 

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

func NewClient 

func NewClient(config *client.Config) (*Client, error)

func (*Client) CopyRule 

func (c *Client) CopyRule(context context.Context, request *CopyNotificationRulesRequest) (*CopyNotificationRulesResult, error)

func (*Client) CreateRule 

func (c *Client) CreateRule(context context.Context, request *CreateRuleRequest) (*CreateRuleResult, error)

func (*Client) CreateRuleStep 

func (c *Client) CreateRuleStep(context context.Context, request *CreateRuleStepRequest) (*CreateRuleStepResult, error)

func (*Client) DeleteRule 

func (c *Client) DeleteRule(context context.Context, request *DeleteRuleRequest) (*DeleteRuleResult, error)

func (*Client) DeleteRuleStep 

func (c *Client) DeleteRuleStep(context context.Context, request *DeleteRuleStepRequest) (*DeleteRuleStepResult, error)

func (*Client) DisableRule 

func (c *Client) DisableRule(context context.Context, request *DisableRuleRequest) (*DisableRuleResult, error)

func (*Client) DisableRuleStep 

func (c *Client) DisableRuleStep(context context.Context, request *DisableRuleStepRequest) (*DisableRuleStepResult, error)

func (*Client) EnableRule 

func (c *Client) EnableRule(context context.Context, request *EnableRuleRequest) (*EnableRuleResult, error)

func (*Client) EnableRuleStep 

func (c *Client) EnableRuleStep(context context.Context, request *EnableRuleStepRequest) (*EnableRuleStepResult, error)

func (*Client) GetRule 

func (c *Client) GetRule(context context.Context, request *GetRuleRequest) (*GetRuleResult, error)

func (*Client) GetRuleStep 

func (c *Client) GetRuleStep(context context.Context, request *GetRuleStepRequest) (*GetRuleStepResult, error)

func (*Client) ListRule 

func (c *Client) ListRule(context context.Context, request *ListRuleRequest) (*ListRuleResult, error)

func (*Client) ListRuleStep 

func (c *Client) ListRuleStep(context context.Context, request *ListRuleStepsRequest) (*ListRuleStepResult, error)

func (*Client) UpdateRule 

func (c *Client) UpdateRule(context context.Context, request *UpdateRuleRequest) (*UpdateRuleResult, error)

func (*Client) UpdateRuleStep 

func (c *Client) UpdateRuleStep(context context.Context, request *UpdateRuleStepRequest) (*UpdateRuleStepResult, error)

type CopyNotificationRulesRequest 

type CopyNotificationRulesRequest struct {
	client.BaseRequest
	UserIdentifier string
	ToUsers        []string    `json:"toUsers"`
	RuleTypes      []RuleTypes `json:"ruleTypes"`
}

func (*CopyNotificationRulesRequest) Method 

func (r *CopyNotificationRulesRequest) Method() string

func (*CopyNotificationRulesRequest) ResourcePath 

func (r *CopyNotificationRulesRequest) ResourcePath() string

func (*CopyNotificationRulesRequest) Validate 

func (r *CopyNotificationRulesRequest) Validate() error

type CopyNotificationRulesResult 

type CopyNotificationRulesResult struct {
	client.ResultMetadata
	Result string `json:"result,omitempty"`
}

type CreateRuleRequest 

type CreateRuleRequest struct {
	client.BaseRequest
	UserIdentifier   string
	Name             string                 `json:"name"`
	ActionType       ActionType             `json:"actionType"`
	Criteria         *og.Criteria           `json:"criteria,omitempty"`
	NotificationTime []NotificationTimeType `json:"notificationTime,omitempty"`
	TimeRestriction  *og.TimeRestriction    `json:"timeRestriction,omitempty"`
	Schedules        []Schedule             `json:"schedules,omitempty"`
	Steps            []*og.Step             `json:"steps,omitempty"`
	Order            uint32                 `json:"order,omitempty"`
	Repeat           *Repeat                `json:"repeat,omitempty"`
	Enabled          *bool                  `json:"enabled,omitempty"`
}

func (*CreateRuleRequest) Method 

func (r *CreateRuleRequest) Method() string

func (*CreateRuleRequest) ResourcePath 

func (r *CreateRuleRequest) ResourcePath() string

func (*CreateRuleRequest) Validate 

func (r *CreateRuleRequest) Validate() error

type CreateRuleResult 

type CreateRuleResult struct {
	client.ResultMetadata
	SimpleNotificationRule SimpleNotificationRuleResult `json:"data,omitempty"`
}

type CreateRuleStepRequest 

type CreateRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	Contact        og.Contact    `json:"contact"`
	SendAfter      *og.SendAfter `json:"sendAfter,omitempty"`
	Enabled        *bool         `json:"enabled,omitempty"`
}

func (*CreateRuleStepRequest) Method 

func (r *CreateRuleStepRequest) Method() string

func (*CreateRuleStepRequest) ResourcePath 

func (r *CreateRuleStepRequest) ResourcePath() string

func (*CreateRuleStepRequest) Validate 

func (r *CreateRuleStepRequest) Validate() error

type CreateRuleStepResult 

type CreateRuleStepResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

type DeleteRuleRequest 

type DeleteRuleRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
}

func (*DeleteRuleRequest) Method 

func (r *DeleteRuleRequest) Method() string

func (*DeleteRuleRequest) ResourcePath 

func (r *DeleteRuleRequest) ResourcePath() string

func (*DeleteRuleRequest) Validate 

func (r *DeleteRuleRequest) Validate() error

type DeleteRuleResult 

type DeleteRuleResult struct {
	client.ResultMetadata
	Result string `json:"result,omitempty"`
}

type DeleteRuleStepRequest 

type DeleteRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	RuleStepId     string
}

func (*DeleteRuleStepRequest) Method 

func (r *DeleteRuleStepRequest) Method() string

func (*DeleteRuleStepRequest) ResourcePath 

func (r *DeleteRuleStepRequest) ResourcePath() string

func (*DeleteRuleStepRequest) Validate 

func (r *DeleteRuleStepRequest) Validate() error

type DeleteRuleStepResult 

type DeleteRuleStepResult struct {
	client.ResultMetadata
	Result string `json:"result,omitempty"`
}

type DisableRuleRequest 

type DisableRuleRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
}

func (*DisableRuleRequest) Method 

func (r *DisableRuleRequest) Method() string

func (*DisableRuleRequest) ResourcePath 

func (r *DisableRuleRequest) ResourcePath() string

func (*DisableRuleRequest) Validate 

func (r *DisableRuleRequest) Validate() error

type DisableRuleResult 

type DisableRuleResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

type DisableRuleStepRequest 

type DisableRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	RuleStepId     string
}

func (*DisableRuleStepRequest) Method 

func (r *DisableRuleStepRequest) Method() string

func (*DisableRuleStepRequest) ResourcePath 

func (r *DisableRuleStepRequest) ResourcePath() string

func (*DisableRuleStepRequest) Validate 

func (r *DisableRuleStepRequest) Validate() error

type DisableRuleStepResult 

type DisableRuleStepResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

type EnableRuleRequest 

type EnableRuleRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
}

func (*EnableRuleRequest) Method 

func (r *EnableRuleRequest) Method() string

func (*EnableRuleRequest) ResourcePath 

func (r *EnableRuleRequest) ResourcePath() string

func (*EnableRuleRequest) Validate 

func (r *EnableRuleRequest) Validate() error

type EnableRuleResult 

type EnableRuleResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

type EnableRuleStepRequest 

type EnableRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	RuleStepId     string
}

func (*EnableRuleStepRequest) Method 

func (r *EnableRuleStepRequest) Method() string

func (*EnableRuleStepRequest) ResourcePath 

func (r *EnableRuleStepRequest) ResourcePath() string

func (*EnableRuleStepRequest) Validate 

func (r *EnableRuleStepRequest) Validate() error

type EnableRuleStepResult 

type EnableRuleStepResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

type GetRuleRequest 

type GetRuleRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
}

func (*GetRuleRequest) Method 

func (r *GetRuleRequest) Method() string

func (*GetRuleRequest) ResourcePath 

func (r *GetRuleRequest) ResourcePath() string

func (*GetRuleRequest) Validate 

func (r *GetRuleRequest) Validate() error

type GetRuleResult 

type GetRuleResult struct {
	client.ResultMetadata
	Id               string                 `json:"id,omitempty"`
	Name             string                 `json:"name,omitempty"`
	ActionType       ActionType             `json:"actionType,omitempty"`
	Order            uint32                 `json:"order,omitempty"`
	Enabled          bool                   `json:"enabled,omitempty"`
	NotificationTime []NotificationTimeType `json:"notificationTime,omitempty"`
	TimeRestriction  *og.TimeRestriction    `json:"timeRestriction,omitempty"`
	Steps            []*StepResult          `json:"steps,omitempty"`
	Schedules        []*Schedule            `json:"schedules,omitempty"`
}

type GetRuleStepRequest 

type GetRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	RuleStepId     string
}

func (*GetRuleStepRequest) Method 

func (r *GetRuleStepRequest) Method() string

func (*GetRuleStepRequest) ResourcePath 

func (r *GetRuleStepRequest) ResourcePath() string

func (*GetRuleStepRequest) Validate 

func (r *GetRuleStepRequest) Validate() error

type GetRuleStepResult 

type GetRuleStepResult struct {
	client.ResultMetadata
	RuleStep RuleStep `json:"data,omitempty"`
}

type ListRuleRequest 

type ListRuleRequest struct {
	client.BaseRequest
	UserIdentifier string
}

func (*ListRuleRequest) Method 

func (r *ListRuleRequest) Method() string

func (*ListRuleRequest) ResourcePath 

func (r *ListRuleRequest) ResourcePath() string

func (*ListRuleRequest) Validate 

func (r *ListRuleRequest) Validate() error

type ListRuleResult 

type ListRuleResult struct {
	client.ResultMetadata
	SimpleNotificationRules []SimpleNotificationRuleResult `json:"data,omitempty"`
}

type ListRuleStepResult 

type ListRuleStepResult struct {
	client.ResultMetadata
	RuleSteps []RuleStep `json:"data,omitempty"`
}

type ListRuleStepsRequest 

type ListRuleStepsRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
}

func (*ListRuleStepsRequest) Method 

func (r *ListRuleStepsRequest) Method() string

func (*ListRuleStepsRequest) ResourcePath 

func (r *ListRuleStepsRequest) ResourcePath() string

func (*ListRuleStepsRequest) Validate 

func (r *ListRuleStepsRequest) Validate() error

type NotificationTimeType 

type NotificationTimeType string
const (
	JustBefore        NotificationTimeType = "just-before"
	FifteenMinutesAgo NotificationTimeType = "15-minutes-ago"
	OneHourAgo        NotificationTimeType = "1-hour-ago"
	OneDayAgo         NotificationTimeType = "1-day-ago"
)

type Parent 

type Parent struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type Repeat 

type Repeat struct {
	LoopAfter uint32 `json:"loopAfter,omitempty"`
	Enabled   *bool  `json:"enabled,omitempty"`
}

type RuleStep 

type RuleStep struct {
	Parent    Parent       `json:"_parent,omitempty"`
	Id        string       `json:"id,omitempty"`
	SendAfter og.SendAfter `json:"sendAfter,omitempty"`
	Contact   og.Contact   `json:"contact,omitempty"`
	Enabled   bool         `json:"enabled,omitempty"`
}

type RuleTypes 

type RuleTypes string
const (
	All                   RuleTypes = "all"
	AcknowledgedAlertRule RuleTypes = "acknowledged-alert"
	RenotifiedAlertRule   RuleTypes = "renotified-alert"
	ClosedAlertRule       RuleTypes = "closed-alert"
	ScheduleStartRule     RuleTypes = "schedule-start"
	AssignedAlertRule     RuleTypes = "assigned-alert"
	AddNoteRule           RuleTypes = "add-note"
	NewAlertRule          RuleTypes = "new-alert"
)

type Schedule 

type Schedule struct {
	TypeOfSchedule string `json:"type"`
	Name           string `json:"name,omitempty"`
	Id             string `json:"id,omitempty"`
}

type SimpleNotificationRuleResult 

type SimpleNotificationRuleResult struct {
	Id         string     `json:"id,omitempty"`
	Name       string     `json:"name,omitempty"`
	ActionType ActionType `json:"actionType,omitempty"`
	Order      uint32     `json:"order,omitempty"`
	Enabled    bool       `json:"bool,omitempty"`
}

type StepResult 

type StepResult struct {
	Contact   og.Contact    `json:"contact,omitempty"`
	SendAfter *og.SendAfter `json:"sendAfter,omitempty"`
	Enabled   bool          `json:"enabled,omitempty"`
}

type UpdateRuleRequest 

type UpdateRuleRequest struct {
	client.BaseRequest
	UserIdentifier   string
	RuleId           string
	Criteria         *og.Criteria           `json:"criteria,omitempty"`
	NotificationTime []NotificationTimeType `json:"notificationTime,omitempty"`
	TimeRestriction  *og.TimeRestriction    `json:"timeRestriction,omitempty"`
	Schedules        []Schedule             `json:"schedules,omitempty"`
	Steps            []*og.Step             `json:"steps,omitempty"`
	Order            uint32                 `json:"order,omitempty"`
	Repeat           *Repeat                `json:"repeat,omitempty"`
	Enabled          *bool                  `json:"enabled,omitempty"`
}

func (*UpdateRuleRequest) Method 

func (r *UpdateRuleRequest) Method() string

func (*UpdateRuleRequest) ResourcePath 

func (r *UpdateRuleRequest) ResourcePath() string

func (*UpdateRuleRequest) Validate 

func (r *UpdateRuleRequest) Validate() error

type UpdateRuleResult 

type UpdateRuleResult struct {
	client.ResultMetadata
	SimpleNotificationRule SimpleNotificationRuleResult `json:"data,omitempty"`
}

type UpdateRuleStepRequest 

type UpdateRuleStepRequest struct {
	client.BaseRequest
	UserIdentifier string
	RuleId         string
	RuleStepId     string
	Contact        *og.Contact   `json:"contact,omitempty"`
	SendAfter      *og.SendAfter `json:"sendAfter,omitempty"`
	Enabled        *bool         `json:"enabled,omitempty"`
}

func (*UpdateRuleStepRequest) Method 

func (r *UpdateRuleStepRequest) Method() string

func (*UpdateRuleStepRequest) ResourcePath 

func (r *UpdateRuleStepRequest) ResourcePath() string

func (*UpdateRuleStepRequest) Validate 

func (r *UpdateRuleStepRequest) Validate() error

type UpdateRuleStepResult 

type UpdateRuleStepResult struct {
	client.ResultMetadata
	Id string `json:"id,omitempty"`
}

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.