robotteammembership

Documentation

Index

• Constants
• type Client
  • func NewClient(cfg *up.Config) *Client
  • func (c *Client) Create(ctx context.Context, robotId string, params *ResourceIdentifier) error
  • func (c *Client) Delete(ctx context.Context, robotId string, params *DeleteParameters) error
  • func (c *Client) Get(ctx context.Context, robotId, teamId string) error
• type DeleteParameters
• type RelationshipList
• type ResourceIdentifier

Constants

const (
	RobotMembershipTypeTeam string = "teams"
)

Robot scope types.

Types

type Client

type Client struct {
	*up.Config
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *up.Config) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, robotId string, params *ResourceIdentifier) error

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, robotId string, params *DeleteParameters) error

func (*Client) Get

func (c *Client) Get(ctx context.Context, robotId, teamId string) error

type DeleteParameters

type DeleteParameters struct {
	Type string `json:"type"`
	ID   string `json:"id"`
}

type RelationshipList

type RelationshipList struct {
	Data []ResourceIdentifier `json:"data"`
}

A RelationshipList represents JSON API relationships. https://jsonapi.org/format/#document-resource-object-relationships

type ResourceIdentifier

type ResourceIdentifier struct {
	Type string `json:"type"`
	ID   string `json:"id"`
}