miro

Documentation

Index

• Constants
• func WithCursor(cursor string) queryFunction
• func WithLimit(limit int32) queryFunction
• type Client
  • func New(accessToken string, httpClient *http.Client) *Client
  • func (c *Client) GetContext(ctx context.Context) (*Context, *http.Response, error)
  • func (c *Client) GetOrganizationMember(ctx context.Context, organizationId, userId string) (*User, *http.Response, error)
  • func (c *Client) GetOrganizationMembers(ctx context.Context, organizationId, cursor string, limit int32, ...) (*GetOrganizationMembersResponse, *http.Response, error)
  • func (c *Client) GetTeamMembers(ctx context.Context, organizationId, teamId, cursor string, limit int32, ...) (*GetTeamMembersResponse, *http.Response, error)
  • func (c *Client) GetTeams(ctx context.Context, organizationId, cursor string, limit int32, ...) (*GetTeamsResponse, *http.Response, error)
  • func (c *Client) InviteTeamMember(ctx context.Context, organizationId, teamId, email, role string) (*InviteTeamMemberResponse, *http.Response, error)
  • func (c *Client) RemoveTeamMember(ctx context.Context, organizationId, teamId, userId string) (*http.Response, error)
• type Context
• type GetOrganizationMembersResponse
• type GetTeamMembersResponse
• type GetTeamsResponse
• type InviteTeamMemberBody
• type InviteTeamMemberResponse
• type Organization
• type Team
• type TeamMember
• type User

Constants

const BaseUrl = "https://api.miro.com"

Functions

func WithCursor

func WithCursor(cursor string) queryFunction

func WithLimit

func WithLimit(limit int32) queryFunction

Types

type Client

type Client struct {
	uhttp.BaseHttpClient
	// contains filtered or unexported fields
}

func New

func New(accessToken string, httpClient *http.Client) *Client

func (*Client) GetContext

func (c *Client) GetContext(ctx context.Context) (*Context, *http.Response, error)

func (*Client) GetOrganizationMember

func (c *Client) GetOrganizationMember(ctx context.Context, organizationId, userId string) (*User, *http.Response, error)

func (*Client) GetOrganizationMembers

func (c *Client) GetOrganizationMembers(ctx context.Context, organizationId, cursor string, limit int32, query ...queryFunction) (*GetOrganizationMembersResponse, *http.Response, error)

func (*Client) GetTeamMembers

func (c *Client) GetTeamMembers(ctx context.Context, organizationId, teamId, cursor string, limit int32, query ...queryFunction) (*GetTeamMembersResponse, *http.Response, error)

func (*Client) GetTeams

func (c *Client) GetTeams(ctx context.Context, organizationId, cursor string, limit int32, query ...queryFunction) (*GetTeamsResponse, *http.Response, error)

func (*Client) InviteTeamMember

func (c *Client) InviteTeamMember(ctx context.Context, organizationId, teamId, email, role string) (*InviteTeamMemberResponse, *http.Response, error)

func (*Client) RemoveTeamMember

func (c *Client) RemoveTeamMember(ctx context.Context, organizationId, teamId, userId string) (*http.Response, error)

type Context

type Context struct {
	Type         string        `json:"type"`
	Team         *Team         `json:"team"`
	Scopes       []string      `json:"scopes"`
	User         *User         `json:"user"`
	Organization *Organization `json:"organization"`
}

type GetOrganizationMembersResponse

type GetOrganizationMembersResponse struct {
	Limit  int32  `json:"limit"`
	Size   int32  `json:"size"`
	Cursor string `json:"cursor"`
	Data   []User `json:"data"`
}

type GetTeamMembersResponse

type GetTeamMembersResponse struct {
	Limit  int32        `json:"limit"`
	Size   int32        `json:"size"`
	Cursor string       `json:"cursor"`
	Data   []TeamMember `json:"data"`
}

type GetTeamsResponse

type GetTeamsResponse struct {
	Limit  int32  `json:"limit"`
	Size   int32  `json:"size"`
	Cursor string `json:"cursor"`
	Data   []Team `json:"data"`
}

type InviteTeamMemberBody

type InviteTeamMemberBody struct {
	Email string `json:"email"`
	Role  string `json:"role"`
}

type InviteTeamMemberResponse

type InviteTeamMemberResponse struct {
	TeamId string `json:"teamId"`
	Role   string `json:"role"`
	UserId string `json:"id"`
}

type Organization

type Organization struct {
	Id   string `json:"id"`
	Name string `json:"name"`
	Type string `json:"type"`
}

type Team

type Team struct {
	Id   string `json:"id"`
	Name string `json:"name"`
	Type string `json:"type"`
}

type TeamMember

type TeamMember struct {
	Id   string `json:"id"`
	Role string `json:"role"`
}

type User

type User struct {
	Id             string `json:"id"`
	Type           string `json:"type"`
	Active         bool   `json:"active"`
	License        string `json:"license"`
	Role           string `json:"role"`
	Email          string `json:"email"`
	LastActivityAt string `json:"lastActivityAt"`
}