teams

Documentation

Index

• type Client
  • func NewClient(cfg *up.Config) *Client
  • func (c *Client) Create(ctx context.Context, params *TeamCreateParameters) (*TeamResponse, error)
  • func (c *Client) Delete(ctx context.Context, id uuid.UUID) error
  • func (c *Client) Get(ctx context.Context, id uuid.UUID) (*TeamResponse, error)
• type TeamAttributes
• type TeamCreateParameters
• type TeamResponse

Types

type Client

type Client struct {
	*up.Config
}

Client is an teams client.

func NewClient

func NewClient(cfg *up.Config) *Client

NewClient builds an teams client from the passed config.

func (*Client) Create

func (c *Client) Create(ctx context.Context, params *TeamCreateParameters) (*TeamResponse, error)

Create creates a team on Upbound.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id uuid.UUID) error

Delete delete an team on Upbound.

func (*Client) Get

func (c *Client) Get(ctx context.Context, id uuid.UUID) (*TeamResponse, error)

Get gets a team on Upbound.

type TeamAttributes

type TeamAttributes struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

TeamAttributes are the attributes of a team.

type TeamCreateParameters

type TeamCreateParameters struct {
	Name           string `json:"name"`
	OrganizationID uint   `json:"organizationId"`
}

TeamCreateParameters are the parameters for creating a team.

type TeamResponse

type TeamResponse struct {
	ID             uuid.UUID  `json:"id"`
	OrganizationID uint       `json:"organizationId"`
	AccountID      uint       `json:"accountId"`
	Name           string     `json:"name"`
	CreatorID      uint       `json:"creatorId"`
	CreatedAt      *time.Time `json:"createdAt,omitempty"`
}

TeamResponse is the response returned from team operations.