team

package
v1.2.22 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2023 License: Apache-2.0 Imports: 6 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddTeamMemberRequest

type AddTeamMemberRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	User                User   `json:"user,omitempty"`
	Role                string `json:"role,omitempty"`
}

team member api

func (*AddTeamMemberRequest) Method

func (r *AddTeamMemberRequest) Method() string

func (*AddTeamMemberRequest) RequestParams

func (r *AddTeamMemberRequest) RequestParams() map[string]string

func (*AddTeamMemberRequest) ResourcePath

func (r *AddTeamMemberRequest) ResourcePath() string

func (*AddTeamMemberRequest) Validate

func (r *AddTeamMemberRequest) Validate() error

type AddTeamMemberResult

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

type ChangeRoutingRuleOrderRequest

type ChangeRoutingRuleOrderRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	RoutingRuleId       string
	Order               *int `json:"order"`
}

func (*ChangeRoutingRuleOrderRequest) Method

func (*ChangeRoutingRuleOrderRequest) RequestParams

func (r *ChangeRoutingRuleOrderRequest) RequestParams() map[string]string

func (*ChangeRoutingRuleOrderRequest) ResourcePath

func (r *ChangeRoutingRuleOrderRequest) ResourcePath() string

func (*ChangeRoutingRuleOrderRequest) Validate

func (r *ChangeRoutingRuleOrderRequest) Validate() error

type Client

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

func NewClient

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

func (*Client) AddMember

team member api

func (*Client) ChangeRoutingRuleOrder

func (c *Client) ChangeRoutingRuleOrder(ctx context.Context, req *ChangeRoutingRuleOrderRequest) (*RoutingRuleResult, error)

func (*Client) Create

func (c *Client) Create(ctx context.Context, req *CreateTeamRequest) (*CreateTeamResult, error)

func (*Client) CreateRole

team role api

func (*Client) CreateRoutingRule

func (c *Client) CreateRoutingRule(ctx context.Context, req *CreateRoutingRuleRequest) (*RoutingRuleResult, error)

team routing rule api

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, req *DeleteTeamRequest) (*DeleteTeamResult, error)

func (*Client) DeleteRole

func (*Client) DeleteRoutingRule

func (c *Client) DeleteRoutingRule(ctx context.Context, req *DeleteRoutingRuleRequest) (*DeleteRoutingRuleResult, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, req *GetTeamRequest) (*GetTeamResult, error)

func (*Client) GetRole

func (c *Client) GetRole(ctx context.Context, req *GetTeamRoleRequest) (*GetTeamRoleResult, error)

func (*Client) GetRoutingRule

func (c *Client) GetRoutingRule(ctx context.Context, req *GetRoutingRuleRequest) (*GetRoutingRuleResult, error)

func (*Client) List

func (c *Client) List(ctx context.Context, req *ListTeamRequest) (*ListTeamResult, error)

func (*Client) ListRole

func (*Client) ListRoutingRules

func (c *Client) ListRoutingRules(ctx context.Context, req *ListRoutingRulesRequest) (*ListRoutingRulesResult, error)

func (*Client) ListTeamLogs

func (c *Client) ListTeamLogs(ctx context.Context, req *ListTeamLogsRequest) (*ListTeamLogsResult, error)

func (*Client) RemoveMember

func (*Client) Update

func (c *Client) Update(ctx context.Context, req *UpdateTeamRequest) (*UpdateTeamResult, error)

func (*Client) UpdateRole

func (*Client) UpdateRoutingRule

func (c *Client) UpdateRoutingRule(ctx context.Context, req *UpdateRoutingRuleRequest) (*RoutingRuleResult, error)

type CreateRoutingRuleRequest

type CreateRoutingRuleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	Name                string              `json:"name,omitempty"`
	Order               *int                `json:"order,omitempty"`
	Timezone            string              `json:"timezone,omitempty"`
	Criteria            *og.Criteria        `json:"criteria,omitempty"`
	TimeRestriction     *og.TimeRestriction `json:"timeRestriction,omitempty"`
	Notify              *Notify             `json:"notify"`
}

func (*CreateRoutingRuleRequest) Method

func (r *CreateRoutingRuleRequest) Method() string

func (*CreateRoutingRuleRequest) RequestParams

func (r *CreateRoutingRuleRequest) RequestParams() map[string]string

func (*CreateRoutingRuleRequest) ResourcePath

func (r *CreateRoutingRuleRequest) ResourcePath() string

func (*CreateRoutingRuleRequest) Validate

func (r *CreateRoutingRuleRequest) Validate() error

func (*CreateRoutingRuleRequest) WithTimeRestriction

func (r *CreateRoutingRuleRequest) WithTimeRestriction(timeRestriction og.TimeRestriction) CreateRoutingRuleRequest

type CreateTeamRequest

type CreateTeamRequest struct {
	client.BaseRequest
	Description string   `json:"description,omitempty"`
	Name        string   `json:"name,omitempty"`
	Members     []Member `json:"members,omitempty"`
}

func (*CreateTeamRequest) Method

func (r *CreateTeamRequest) Method() string

func (*CreateTeamRequest) ResourcePath

func (r *CreateTeamRequest) ResourcePath() string

func (*CreateTeamRequest) Validate

func (r *CreateTeamRequest) Validate() error

type CreateTeamResult

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

type CreateTeamRoleRequest

type CreateTeamRoleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	Name                string  `json:"name"`
	Rights              []Right `json:"rights"`
}

func (*CreateTeamRoleRequest) Method

func (r *CreateTeamRoleRequest) Method() string

func (*CreateTeamRoleRequest) RequestParams

func (r *CreateTeamRoleRequest) RequestParams() map[string]string

func (*CreateTeamRoleRequest) ResourcePath

func (r *CreateTeamRoleRequest) ResourcePath() string

func (*CreateTeamRoleRequest) Validate

func (r *CreateTeamRoleRequest) Validate() error

type CreateTeamRoleResult

type CreateTeamRoleResult struct {
	client.ResultMetadata
	RoleMeta
}

type DeleteRoutingRuleRequest

type DeleteRoutingRuleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	RoutingRuleId       string
}

func (*DeleteRoutingRuleRequest) Method

func (r *DeleteRoutingRuleRequest) Method() string

func (*DeleteRoutingRuleRequest) RequestParams

func (r *DeleteRoutingRuleRequest) RequestParams() map[string]string

func (*DeleteRoutingRuleRequest) ResourcePath

func (r *DeleteRoutingRuleRequest) ResourcePath() string

func (*DeleteRoutingRuleRequest) Validate

func (r *DeleteRoutingRuleRequest) Validate() error

type DeleteRoutingRuleResult

type DeleteRoutingRuleResult struct {
	client.ResultMetadata
	Result string `json:"result"`
}

type DeleteTeamRequest

type DeleteTeamRequest struct {
	client.BaseRequest
	IdentifierType  Identifier
	IdentifierValue string
}

func (*DeleteTeamRequest) Method

func (r *DeleteTeamRequest) Method() string

func (*DeleteTeamRequest) RequestParams

func (r *DeleteTeamRequest) RequestParams() map[string]string

func (*DeleteTeamRequest) ResourcePath

func (r *DeleteTeamRequest) ResourcePath() string

func (*DeleteTeamRequest) Validate

func (r *DeleteTeamRequest) Validate() error

type DeleteTeamResult

type DeleteTeamResult struct {
	client.ResultMetadata
	Result string `json:"result"`
}

type DeleteTeamRoleRequest

type DeleteTeamRoleRequest struct {
	client.BaseRequest
	TeamID   string
	TeamName string
	RoleID   string
	RoleName string
}

func (*DeleteTeamRoleRequest) Method

func (r *DeleteTeamRoleRequest) Method() string

func (*DeleteTeamRoleRequest) RequestParams

func (r *DeleteTeamRoleRequest) RequestParams() map[string]string

func (*DeleteTeamRoleRequest) ResourcePath

func (r *DeleteTeamRoleRequest) ResourcePath() string

func (*DeleteTeamRoleRequest) Validate

func (r *DeleteTeamRoleRequest) Validate() error

type DeleteTeamRoleResult

type DeleteTeamRoleResult struct {
	client.ResultMetadata
	Result string `json:"result"`
}

type GetRoleInfo

type GetRoleInfo struct {
	RoleMeta
	Rights []Right `json:"rights"`
}

type GetRoutingRuleRequest

type GetRoutingRuleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	RoutingRuleId       string
}

func (*GetRoutingRuleRequest) Method

func (r *GetRoutingRuleRequest) Method() string

func (*GetRoutingRuleRequest) RequestParams

func (r *GetRoutingRuleRequest) RequestParams() map[string]string

func (*GetRoutingRuleRequest) ResourcePath

func (r *GetRoutingRuleRequest) ResourcePath() string

func (*GetRoutingRuleRequest) Validate

func (r *GetRoutingRuleRequest) Validate() error

type GetRoutingRuleResult

type GetRoutingRuleResult struct {
	client.ResultMetadata
	RoutingRuleMeta
}

type GetTeamRequest

type GetTeamRequest struct {
	client.BaseRequest
	IdentifierType  Identifier
	IdentifierValue string
}

func (*GetTeamRequest) Method

func (r *GetTeamRequest) Method() string

func (*GetTeamRequest) RequestParams

func (r *GetTeamRequest) RequestParams() map[string]string

func (*GetTeamRequest) ResourcePath

func (r *GetTeamRequest) ResourcePath() string

func (*GetTeamRequest) Validate

func (r *GetTeamRequest) Validate() error

type GetTeamResult

type GetTeamResult struct {
	client.ResultMetadata
	TeamMeta
	Description string   `json:"description,omitempty"`
	Members     []Member `json:"members,omitempty"`
}

type GetTeamRoleRequest

type GetTeamRoleRequest struct {
	client.BaseRequest
	TeamID   string
	TeamName string
	RoleID   string
	RoleName string
}

func (*GetTeamRoleRequest) Method

func (r *GetTeamRoleRequest) Method() string

func (*GetTeamRoleRequest) RequestParams

func (r *GetTeamRoleRequest) RequestParams() map[string]string

func (*GetTeamRoleRequest) ResourcePath

func (r *GetTeamRoleRequest) ResourcePath() string

func (*GetTeamRoleRequest) Validate

func (r *GetTeamRoleRequest) Validate() error

type GetTeamRoleResult

type GetTeamRoleResult struct {
	client.ResultMetadata
	RoleMeta
	Rights []Right `json:"rights"`
}

type Identifier

type Identifier uint32
const (
	Name Identifier = iota
	Id
	Username
)

type ListRoutingRulesRequest

type ListRoutingRulesRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
}

func (*ListRoutingRulesRequest) Method

func (r *ListRoutingRulesRequest) Method() string

func (*ListRoutingRulesRequest) RequestParams

func (r *ListRoutingRulesRequest) RequestParams() map[string]string

func (*ListRoutingRulesRequest) ResourcePath

func (r *ListRoutingRulesRequest) ResourcePath() string

func (*ListRoutingRulesRequest) Validate

func (r *ListRoutingRulesRequest) Validate() error

type ListRoutingRulesResult

type ListRoutingRulesResult struct {
	client.ResultMetadata
	RoutingRules []RoutingRuleMeta `json:"data"`
}

type ListTeamLogsRequest

type ListTeamLogsRequest struct {
	client.BaseRequest
	IdentifierType  Identifier
	IdentifierValue string
	Limit           int    `json:"limit,omitempty"`
	Order           string `json:"order,omitempty"`
	Offset          int    `json:"offset,omitempty"`
}

func (*ListTeamLogsRequest) Method

func (r *ListTeamLogsRequest) Method() string

func (*ListTeamLogsRequest) RequestParams

func (r *ListTeamLogsRequest) RequestParams() map[string]string

func (*ListTeamLogsRequest) ResourcePath

func (r *ListTeamLogsRequest) ResourcePath() string

func (*ListTeamLogsRequest) Validate

func (r *ListTeamLogsRequest) Validate() error

type ListTeamLogsResult

type ListTeamLogsResult struct {
	client.ResultMetadata
	Offset string     `json:"offset,omitempty"`
	Logs   []LogEntry `json:logs,omitempty`
}

type ListTeamRequest

type ListTeamRequest struct {
	client.BaseRequest
}

func (*ListTeamRequest) Method

func (r *ListTeamRequest) Method() string

func (*ListTeamRequest) ResourcePath

func (r *ListTeamRequest) ResourcePath() string

func (*ListTeamRequest) Validate

func (r *ListTeamRequest) Validate() error

type ListTeamResult

type ListTeamResult struct {
	client.ResultMetadata
	Teams []ListedTeams `json:"data"`
}

type ListTeamRoleRequest

type ListTeamRoleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
}

func (*ListTeamRoleRequest) Method

func (r *ListTeamRoleRequest) Method() string

func (*ListTeamRoleRequest) RequestParams

func (r *ListTeamRoleRequest) RequestParams() map[string]string

func (*ListTeamRoleRequest) ResourcePath

func (r *ListTeamRoleRequest) ResourcePath() string

func (*ListTeamRoleRequest) Validate

func (r *ListTeamRoleRequest) Validate() error

type ListTeamRoleResult

type ListTeamRoleResult struct {
	client.ResultMetadata
	TeamRoles []GetRoleInfo `json:"data"`
}

type ListedTeams

type ListedTeams struct {
	TeamMeta
	Description string `json:"description,omitempty"`
}

type LogEntry

type LogEntry struct {
	Log         string `json:"log"`
	Owner       string `json:"owner"`
	CreatedDate string `json:"createdDate"`
}

type Member

type Member struct {
	User User   `json:"user,omitempty"`
	Role string `json:"role,omitempty"`
}

type Notify

type Notify struct {
	Type NotifyType `json:"type, omitempty"`
	Name string     `json:"name,omitempty"`
	Id   string     `json:"id,omitempty"`
}

type NotifyType

type NotifyType string

team routing rule api

const (
	EscalationNotifyType NotifyType = "escalation"
	ScheduleNotifyType   NotifyType = "schedule"
	None                 NotifyType = "none"
)

type RemoveTeamMemberRequest

type RemoveTeamMemberRequest struct {
	client.BaseRequest
	TeamIdentifierType    Identifier
	TeamIdentifierValue   string
	MemberIdentifierType  Identifier
	MemberIdentifierValue string
}

func (*RemoveTeamMemberRequest) Method

func (r *RemoveTeamMemberRequest) Method() string

func (*RemoveTeamMemberRequest) RequestParams

func (r *RemoveTeamMemberRequest) RequestParams() map[string]string

func (*RemoveTeamMemberRequest) ResourcePath

func (r *RemoveTeamMemberRequest) ResourcePath() string

func (*RemoveTeamMemberRequest) Validate

func (r *RemoveTeamMemberRequest) Validate() error

type RemoveTeamMemberResult

type RemoveTeamMemberResult struct {
	client.ResultMetadata
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}
type Right struct {
	Right   string `json:"right"`
	Granted *bool  `json:"granted"`
}

team role api

type RightMeta

type RightMeta struct {
	Right   string `json:"right,omitempty"`
	Granted bool   `json:"granted,omitempty"`
}

type RoleMeta

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

team role api

type RoutingRuleMeta

type RoutingRuleMeta struct {
	Id              string             `json:"id,omitempty"`
	Name            string             `json:"name,omitempty"`
	IsDefault       bool               `json:"isDefault,omitempty"`
	Order           int                `json:"order,omitempty"`
	Criteria        og.Criteria        `json:"criteria,omitempty"`
	Timezone        string             `json:"timezone,omitempty"`
	TimeRestriction og.TimeRestriction `json:"timeRestriction,omitempty"`
	Notify          Notify             `json:"notify,omitempty"`
}

type RoutingRuleResult

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

type TeamMeta

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

type UpdateRoutingRuleRequest

type UpdateRoutingRuleRequest struct {
	client.BaseRequest
	TeamIdentifierType  Identifier
	TeamIdentifierValue string
	RoutingRuleId       string
	Name                string              `json:"name,omitempty"`
	Timezone            string              `json:"timezone,omitempty"`
	Criteria            *og.Criteria        `json:"criteria,omitempty"`
	TimeRestriction     *og.TimeRestriction `json:"timeRestriction,omitempty"`
	Notify              *Notify             `json:"notify,omitempty"`
}

func (*UpdateRoutingRuleRequest) Method

func (r *UpdateRoutingRuleRequest) Method() string

func (*UpdateRoutingRuleRequest) RequestParams

func (r *UpdateRoutingRuleRequest) RequestParams() map[string]string

func (*UpdateRoutingRuleRequest) ResourcePath

func (r *UpdateRoutingRuleRequest) ResourcePath() string

func (*UpdateRoutingRuleRequest) Validate

func (r *UpdateRoutingRuleRequest) Validate() error

type UpdateTeamRequest

type UpdateTeamRequest struct {
	client.BaseRequest
	Id          string   `json:"id,omitempty"`
	Description string   `json:"description,omitempty"`
	Name        string   `json:"name,omitempty"`
	Members     []Member `json:"members,omitempty"`
}

func (*UpdateTeamRequest) Method

func (r *UpdateTeamRequest) Method() string

func (*UpdateTeamRequest) ResourcePath

func (r *UpdateTeamRequest) ResourcePath() string

func (*UpdateTeamRequest) Validate

func (r *UpdateTeamRequest) Validate() error

type UpdateTeamResult

type UpdateTeamResult struct {
	client.ResultMetadata
	TeamMeta
}

type UpdateTeamRoleRequest

type UpdateTeamRoleRequest struct {
	client.BaseRequest
	TeamID   string
	TeamName string
	RoleID   string
	RoleName string
	Name     string  `json:"name"`
	Rights   []Right `json:"rights"`
}

func (*UpdateTeamRoleRequest) Method

func (r *UpdateTeamRoleRequest) Method() string

func (*UpdateTeamRoleRequest) RequestParams

func (r *UpdateTeamRoleRequest) RequestParams() map[string]string

func (*UpdateTeamRoleRequest) ResourcePath

func (r *UpdateTeamRoleRequest) ResourcePath() string

func (*UpdateTeamRoleRequest) Validate

func (r *UpdateTeamRoleRequest) Validate() error

type UpdateTeamRoleResult

type UpdateTeamRoleResult struct {
	client.ResultMetadata
	RoleMeta
}

type User

type User struct {
	ID       string `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
}

Jump to

Keyboard shortcuts

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