miro

package
v1.0.5 Latest Latest
Warning

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

 Go to latest Published: Apr 29, 2023 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// EndpointOAUTHToken /oauth-token endpoint
	EndpointOAUTHToken = "oauth-token"
	// EndpointOAUTH /oauth endpoint
	EndpointOAUTH = "oauth"
)
View Source 
const (
	// EndpointBoards /boards endpoint
	EndpointBoards = "boards"

	// QueryParamCopyFrom Unique identifier (ID) of the board that you want to copy (required).
	QueryParamCopyFrom = "copy_from"
)
View Source 
const (
	AccessPrivate Access = "private"
	AccessView    Access = "view"
	AccessEdit    Access = "edit"
	AccessComment Access = "comment"

	InviteAccessNoAccess  InviteAccess = "no_access"
	InviteAccessViewer    InviteAccess = "viewer"
	InviteAccessCommenter InviteAccess = "commenter"
	InviteAccessEditor    InviteAccess = "editor"
)
View Source 
const (
	CollabAccessAllEditors             CollabAccess = "all_editors"
	CollabAccessBoardOwnersAndCoOwners CollabAccess = "board_owners_and_coowners"

	CopyAccessAnyone      CopyAccess = "anyone"
	CopyAccessTeamMembers CopyAccess = "team_members"
	CopyAccessTeamEditors CopyAccess = "team_editors"
	CopyAccessBoardOwner  CopyAccess = "board_owner"

	SharingAccessTeamMemberWithEditingRights SharingAccess = "team_members_with_editing_rights"
	SharingAccessOwnersAndCoOwners           SharingAccess = "owner_and_coowners"
)

Variables

This section is empty.

Functions

func EncodeQueryParams 

func EncodeQueryParams(queryParams []Parameter) string

Types

type Access added in v1.0.4 

type Access string

type AccessToken added in v1.0.4 

type AccessToken struct {
	Type         string          `json:"type"`
	Team         BasicEntityInfo `json:"team"`
	CreatedBy    BasicEntityInfo `json:"createdBy"`
	Scopes       []string        `json:"scopes"`
	Organization BasicEntityInfo `json:"organization"`
	User         BasicEntityInfo `json:"user"`
}

type AccessTokenService added in v1.0.4 

type AccessTokenService struct {
	APIVersion string
	// contains filtered or unexported fields
}

func (*AccessTokenService) Get added in v1.0.4 

func (a *AccessTokenService) Get() (*AccessToken, error)

Get information about an access token, such as the token type, scopes, team, user, token creation date and time, and the user who created the token.

func (*AccessTokenService) Revoke added in v1.0.4 

func (a *AccessTokenService) Revoke(accessToken string) error

Revoke Revoking an access token means that the access token will no longer work. When an access token is revoked, the refresh token is also revoked and no longer valid. This does not uninstall the application for the user.

type AppCardItem added in v1.0.5 

type AppCardItem struct {
	ID   string `json:"id"`
	Data struct {
		Description string   `json:"description"`
		Fields      []Fields `json:"fields"`
		Owned       bool     `json:"owned"`
		Status      string   `json:"status"`
		Title       string   `json:"title"`
	} `json:"data"`
	Style      Style           `json:"style"`
	Position   Position        `json:"position"`
	Geometry   Geometry        `json:"geometry"`
	CreatedAt  time.Time       `json:"createdAt"`
	CreatedBy  BasicEntityInfo `json:"createdBy"`
	ModifiedAt time.Time       `json:"modifiedAt"`
	ModifiedBy BasicEntityInfo `json:"modifiedBy"`
	Parent     Parent          `json:"parent"`
	Links      Links           `json:"links"`
	Type       string          `json:"type"`
}

type AppCardItemData added in v1.0.5 

type AppCardItemData struct {
	// Fields Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
	Fields []Fields `json:"fields"`
	//Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns disabled.
	Status Status `json:"status"`
	// Title A short text header to identify the app card.
	Title string `json:"title"`
	// Description A short text description to add context about the app card.
	Description string `json:"description"`
}

type AppCardItemsService added in v1.0.5 

type AppCardItemsService struct {
	APIVersion  string
	SubResource string
	// contains filtered or unexported fields
}

func (*AppCardItemsService) Create added in v1.0.5 

func (a *AppCardItemsService) Create(boardID string, payload CreateAppCardItem) (*AppCardItem, error)

Create Adds an app card item to a board. Required scope: boards:write | Rate limiting: Level 2

func (*AppCardItemsService) Delete added in v1.0.5 

func (a *AppCardItemsService) Delete(boardID, itemID string) error

Delete an app card item from a board. Required scope: boards:write | Rate limiting: Level 3

func (*AppCardItemsService) Get added in v1.0.5 

func (a *AppCardItemsService) Get(boardID, itemID string) (*AppCardItem, error)

Get Retrieves information for a specific app card item on a board. Required scope: boards:read | Rate limiting: Level 1

func (*AppCardItemsService) Update added in v1.0.5 

func (a *AppCardItemsService) Update(boardID, itemID string, appCardItemUpdate CreateAppCardItem) (*AppCardItem, error)

Update an app card item on a board based on the data and style properties provided in the request body. Required scope: boards:write | Rate limiting: Level 2

type BasicEntityInfo added in v1.0.4 

type BasicEntityInfo struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

BasicEntityInfo info type for different entities (i.e. users, teams & organizations)

type Board 

type Board struct {
	ID                    string                 `json:"id"`
	Name                  string                 `json:"name"`
	Description           string                 `json:"description"`
	Team                  BasicEntityInfo        `json:"team"`
	Picture               *Picture               `json:"picture,omitempty"`
	Policy                Policy                 `json:"policy"`
	PermissionsPolicy     PermissionsPolicy      `json:"permissionsPolicy,omitempty"`
	SharingPolicy         SharingPolicy          `json:"sharingPolicy"`
	ViewLink              string                 `json:"viewLink"`
	Owner                 BasicEntityInfo        `json:"owner"`
	CurrentUserMembership *CurrentUserMembership `json:"currentUserMembership,omitempty"`
	CreatedAt             time.Time              `json:"createdAt"`
	CreatedBy             BasicEntityInfo        `json:"createdBy"`
	ModifiedAt            time.Time              `json:"modifiedAt"`
	ModifiedBy            BasicEntityInfo        `json:"modifiedBy"`
	Links                 Links                  `json:"links"`
	Type                  string                 `json:"type"`
	Project               *Project               `json:"project,omitempty"`
}

type BoardInvitationResponse added in v1.0.4 

type BoardInvitationResponse struct {
	Failed []struct {
		Email  string `json:"email,omitempty"`
		Reason string `json:"reason,omitempty"`
	} `json:"failed,omitempty"`
	Successful string `json:"successful,omitempty"`
}

type BoardMember added in v1.0.4 

type BoardMember struct {
	BasicEntityInfo
	Role  Role            `json:"role"`
	Links PaginationLinks `json:"links,omitempty"`
}

type BoardMemberSearchParams added in v1.0.4 

type BoardMemberSearchParams struct {
	// Limit The maximum number of board members to retrieve.
	// Default: 20.
	Limit string `query:"limit,omitempty"`
	// Offset The (zero-based) offset of the first item in the collection to return.
	// Default: 0.
	Offset string `query:"offset,omitempty"`
}

type BoardMembersService 

type BoardMembersService struct {
	APIVersion  string
	SubResource string
	// contains filtered or unexported fields
}

func (*BoardMembersService) Delete added in v1.0.4 

func (b *BoardMembersService) Delete(boardID, boardMemberID string) error

Delete Removes a board member from a board. Required scope: boards:write | Rate limiting: Level 2

func (*BoardMembersService) Get added in v1.0.4 

func (b *BoardMembersService) Get(boardID, boardMemberID string) (*BoardMember, error)

Get Retrieves information for a board member. Required scope: boards:read | Rate limiting: Level 1

func (*BoardMembersService) GetAll added in v1.0.4 

func (b *BoardMembersService) GetAll(boardID string, queryParams ...BoardMemberSearchParams) (*ListBoardMembers, error)

GetAll Retrieves a pageable list of members for a board. Required scope: boards:read | Rate limiting: Level 1 Search query params: BoardMemberSearchParams{}

func (*BoardMembersService) ShareBoard added in v1.0.4 

func (b *BoardMembersService) ShareBoard(boardID string, payload ShareBoardInvitation) (*BoardInvitationResponse, error)

ShareBoard Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user. Required scope: boards:write | Rate limiting: Level 3

func (*BoardMembersService) Update added in v1.0.4 

func (b *BoardMembersService) Update(boardID, boardMemberID string, role Role) (*BoardMember, error)

Update Updates the role of a board member. Required scope: boards:write | Rate limiting: Level 2

type BoardSearchParams added in v1.0.2 

type BoardSearchParams struct {
	// TeamID The team_id for which you want to retrieve the list of boards. If this parameter is sent in the request,
	// the query and owner parameters are ignored.
	TeamID string `query:"team_id,omitempty"`
	// Query Retrieves a list of boards that contain the query string provided in the board content or board name.
	// For example, if you want to retrieve a list of boards that contain the word beta within the board itself (board content),
	// add beta as the query parameter value. You can use the query parameter with the owner parameter to narrow down the board search results.
	Query string `query:"query,omitempty"`
	// Owner Retrieves a list of boards that belong to a specific owner ID. You must pass the owner ID (for example,
	//3074457353169356300), not the owner name. You can use the 'owner' parameter with the query parameter to narrow
	//down the board search results. Note that if you pass the team_id in the same request, the owner parameter is ignored.
	Owner string `query:"owner,omitempty"`
	// Limit The maximum number of boards to retrieve.
	// Default: 20
	Limit string `query:"limit,omitempty"`
	// The (zero-based) offset of the first item in the collection to return.
	// Default: 0.
	Offset string `query:"offset,omitempty"`
	// Sort The order in which you want to view the result set.
	// Options last_created and alphabetically are applicable only when you search for boards by team.
	Sort Sort `query:"sort,omitempty"`
}

type BoardsService 

type BoardsService struct {
	APIVersion string
	// contains filtered or unexported fields
}

func (*BoardsService) Copy 

func (b *BoardsService) Copy(payload CreateBoard, copyFrom string) (*Board, error)

Copy Creates a copy of an existing board. You can also update the name, description, sharing policy, and permissions policy for the new board in the request body. Required scope: boards:write | Rate limiting: Level 4

func (*BoardsService) Create 

func (b *BoardsService) Create(payload CreateBoard) (*Board, error)

Create a board with the specified name and sharing policies. Required scope: boards:write | Rate limiting: Level 3

func (*BoardsService) Delete added in v1.0.3 

func (b *BoardsService) Delete(boardID string) error

Delete Deletes a board. Required scope: boards:write | Rate limiting: Level 3

func (*BoardsService) Get 

func (b *BoardsService) Get(boardID string) (*Board, error)

Get Retrieves information about a board. Required scope: boards:read | Rate limiting: Level 1

func (*BoardsService) GetAll 

func (b *BoardsService) GetAll(queryParams ...BoardSearchParams) (*ListBoards, error)

GetAll Retrieves a list of boards that match the search criteria provided in the request. Required scope: boards:read | Rate limiting: Level 1 Search query params: BoardSearchParams{}

func (*BoardsService) Update added in v1.0.2 

func (b *BoardsService) Update(boardID string, payload CreateBoard) (*Board, error)

Update a specific board. Required scope: boards:write | Rate limiting: Level 2

type CardItem added in v1.0.5 

type CardItem struct {
	ID         string          `json:"id"`
	Data       CardItemData    `json:"data"`
	Style      CardItemStyle   `json:"style"`
	Position   Position        `json:"position"`
	Geometry   Geometry        `json:"geometry"`
	CreatedAt  time.Time       `json:"createdAt"`
	CreatedBy  BasicEntityInfo `json:"createdBy"`
	ModifiedAt time.Time       `json:"modifiedAt"`
	ModifiedBy BasicEntityInfo `json:"modifiedBy"`
	Parent     Parent          `json:"parent"`
	Links      Links           `json:"links"`
	Type       string          `json:"type"`
}

type CardItemData added in v1.0.5 

type CardItemData struct {
	Title       string    `json:"title"`
	AssigneeId  string    `json:"assigneeId"`
	Description string    `json:"description"`
	DueDate     time.Time `json:"dueDate"`
}

type CardItemStyle added in v1.0.5 

type CardItemStyle struct {
	CardTheme string `json:"cardTheme"`
}

type CardItemsService added in v1.0.5 

type CardItemsService struct {
	APIVersion  string
	SubResource string
	// contains filtered or unexported fields
}

func (*CardItemsService) Create added in v1.0.5 

func (c *CardItemsService) Create(boardID string, payload CreateCardItem) (*CardItem, error)

Create Adds a card item to a board Required scope: boards:write | Rate limiting: Level 2

func (*CardItemsService) Delete added in v1.0.5 

func (c *CardItemsService) Delete(boardID, itemID string) error

Delete a card item from the board. Required scope: boards:write | Rate limiting: Level 3

func (*CardItemsService) Get added in v1.0.5 

func (c *CardItemsService) Get(boardID, itemID string) (*CardItem, error)

Get Retrieves information for a specific card item on a board Required scope: boards:read | Rate limiting: Level 1

func (*CardItemsService) Update added in v1.0.5 

func (c *CardItemsService) Update(boardID, itemID string, itemUpdate CreateCardItem) (*CardItem, error)

Update a card item on a board based on the data and style properties provided in the request body. Required scope: boards:write | Rate limiting: Level 2

type Client 

type Client struct {
	BaseURL string

	// HTTPClient a fine-tuned HTTP client, but you can inject your own if, for example, you wanted to lower the timeouts
	HTTPClient *http.Client

	AccessToken  *AccessTokenService
	Boards       *BoardsService
	BoardMembers *BoardMembersService
	Items        *ItemsService
	AppCardItems *AppCardItemsService
	CardItems    *CardItemsService
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(token string) *Client

func (*Client) Delete added in v1.0.3 

func (c *Client) Delete(url string) error

Delete Native DELETE function

func (*Client) Get 

func (c *Client) Get(url string, response interface{}, queryParams ...Parameter) error

Get Native GET function

func (*Client) Patch added in v1.0.2 

func (c *Client) Patch(url string, payload, response interface{}) error

Patch Native PATCH function

func (*Client) Post 

func (c *Client) Post(url string, payload, response interface{}) error

Post Native POST function

func (*Client) PostNoContent added in v1.0.4 

func (c *Client) PostNoContent(url string, queryParams ...Parameter) error

PostNoContent Native POST function (pretending to be a DELETE method... but with query params?!)

func (*Client) Put 

func (c *Client) Put(url string, payload, response interface{}, queryParams ...Parameter) error

Put Native PUT function

type CollabAccess added in v1.0.4 

type CollabAccess string

type CopyAccess added in v1.0.4 

type CopyAccess string

type CreateAppCardItem added in v1.0.5 

type CreateAppCardItem struct {
	// Data Contains app card item data, such as the title, description, or fields.
	Data AppCardItemData `json:"data"`
	// Style Contains information about the style of an app card item, such as the fill color.
	Style Style `json:"style"`
	// Position Contains location information about the item, such as its x coordinate, y coordinate, and theorigin of the x and y coordinates.
	Position PositionUpdate `json:"position"`
	// Geometry Contains geometrical information about the item, such as its width or height.
	Geometry Geometry `json:"geometry"`
	// Parent Contains information about the parent this item attached to. Passing null for ID will attach widget to the canvas directly.
	Parent ParentUpdate `json:"parent"`
}

type CreateBoard 

type CreateBoard struct {
	// Description of the board.
	Description string `json:"description"`
	// Name for the board.
	Name string `json:"name"`
	// Policy Defines the permissions policies and sharing policies for the board.
	Policy Policy `json:"policy"`
	// TeamID Unique identifier (ID) of the team where the board must be placed.
	TeamID string `json:"teamId"`
}

type CreateCardItem added in v1.0.5 

type CreateCardItem struct {
	Data     CardItemData   `json:"data"`
	Style    CardItemStyle  `json:"style"`
	Position PositionUpdate `json:"position"`
	Geometry Geometry       `json:"geometry"`
	Parent   ParentUpdate   `json:"parent"`
}

type CurrentUserMembership 

type CurrentUserMembership struct {
	BasicEntityInfo
	Role string `json:"role"`
}

type Fields added in v1.0.5 

type Fields struct {
	// IconShape The shape of the icon on the preview field.
	IconShape string `json:"iconShape"`
	// FillColor Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.
	FillColor string `json:"fillColor"`
	// IconURL A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.
	IconUrl string `json:"iconUrl"`
	// TextColor Hex value representing the color of the text string assigned to value.
	TextColor string `json:"textColor"`
	// Tooltip A short text displayed in a tooltip when clicking or hovering over the preview field.
	Tooltip string `json:"tooltip"`
	// Value The actual data value of the custom field. It can be any type of information that you want to convey.
	Value string `json:"value"`
}

type Geometry added in v1.0.5 

type Geometry struct {
	Height   float64 `json:"height,omitempty"`
	Rotation float64 `json:"rotation,omitempty"`
	Width    float64 `json:"width,omitempty"`
}

type InviteAccess added in v1.0.4 

type InviteAccess string

type Item added in v1.0.5 

type Item struct {
	CreatedAt  time.Time        `json:"createdAt"`
	CreatedBy  BasicEntityInfo  `json:"createdBy"`
	Data       ItemData         `json:"data"`
	Geometry   Geometry         `json:"geometry"`
	ID         string           `json:"id"`
	Links      Links            `json:"links"`
	ModifiedAt time.Time        `json:"modifiedAt"`
	ModifiedBy *BasicEntityInfo `json:"modifiedBy"`
	Parent     *Parent          `json:"parent,omitempty"`
	Position   Position         `json:"position"`
	Style      Style            `json:"style"`
	Type       string           `json:"type"`
}

type ItemData added in v1.0.5 

type ItemData struct {
	Format      string `json:"format,omitempty"`
	ShowContent bool   `json:"showContent,omitempty"`
	Title       string `json:"title,omitempty"`
	Type        string `json:"type,omitempty"`
	Content     string `json:"content,omitempty"`
	Shape       string `json:"shape,omitempty"`
}

type ItemSearchParams added in v1.0.5 

type ItemSearchParams struct {
	// Limit The maximum number of results to return per call. If the number of items in the response is greater than
	// the limit specified, the response returns the cursor parameter with a value.
	// Default: 20.
	Limit string `query:"limit,omitempty"`
	// Type If you want to get a list of items of a specific type, specify an item type. For example,
	// if you want to retrieve the list of card items, set type to cards. Possible values: app_card, card, document,
	// embed, frame, image, shape, sticky_note, text
	Type ItemType `query:"type,omitempty"`
	// Cursor A cursor-paginated method returns a portion of the total set of results based on the limit specified and a
	// cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor
	// parameter equal to the cursor value you received in the response of the previous request.
	Cursor string `query:"cursor,omitempty"`
}

type ItemType added in v1.0.5 

type ItemType string
const (
	AppCard    ItemType = "app_card"
	Card       ItemType = "card"
	Document   ItemType = "document"
	Embed      ItemType = "embed"
	Frame      ItemType = "frame"
	Image      ItemType = "image"
	Shape      ItemType = "shape"
	StickyNote ItemType = "sticky_note"
	Text       ItemType = "text"
)

type ItemUpdate added in v1.0.5 

type ItemUpdate struct {
	// Parent Contains information about the parent this item attached to.
	// Passing null for ID will attach widget to the canvas directly.
	Parent *ParentUpdate `json:"parent,omitempty"`
	// Position Contains location information about the item, such as its x coordinate, y coordinate,
	// and the origin of the x and y coordinates.
	Position *PositionUpdate `json:"position,omitempty"`
}

type ItemsService added in v1.0.5 

type ItemsService struct {
	APIVersion  string
	SubResource string
	// contains filtered or unexported fields
}

func (*ItemsService) Delete added in v1.0.5 

func (i *ItemsService) Delete(boardID, itemID string) error

Delete an item from a board. Required scope: boards:write | Rate limiting: Level 3

func (*ItemsService) Get added in v1.0.5 

func (i *ItemsService) Get(boardID, itemID string) (*Item, error)

Get Retrieves information for a specific item on a board. Required scope: boards:read | Rate limiting: Level 1

func (*ItemsService) GetAll added in v1.0.5 

func (i *ItemsService) GetAll(boardID string, queryParams ...ItemSearchParams) (*ListItems, error)

GetAll Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values.

This method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the cursor parameter equal to the cursor value you received in the response of the previous request. For example, if you set the limit query parameter to 10 and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is foo. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to foo. Required scope: boards:read | Rate limiting: Level 2

func (*ItemsService) Update added in v1.0.5 

func (i *ItemsService) Update(boardID, itemID string, itemUpdate ItemUpdate) (*Item, error)

Update item position or parent Required scope: boards:write | Rate limiting: Level 2 

type Links struct {
	Related string `json:"related,omitempty"`
	Self    string `json:"self,omitempty"`
}

type ListBoardMembers added in v1.0.5 

type ListBoardMembers struct {
	Data   []*BoardMember   `json:"data"`
	Total  int              `json:"total"`
	Size   int              `json:"size"`
	Offset int              `json:"offset"`
	Limit  int              `json:"limit"`
	Links  *PaginationLinks `json:"links"`
	Type   string           `json:"type"`
}

type ListBoards 

type ListBoards struct {
	Data   []*Board         `json:"data"`
	Total  int              `json:"total"`
	Size   int              `json:"size"`
	Offset int              `json:"offset"`
	Limit  int              `json:"limit"`
	Links  *PaginationLinks `json:"links"`
	Type   string           `json:"type"`
}

type ListItems added in v1.0.5 

type ListItems struct {
	Data   []Item          `json:"data"`
	Total  int             `json:"total"`
	Size   int             `json:"size"`
	Cursor string          `json:"cursor,omitempty"`
	Limit  int             `json:"limit"`
	Links  PaginationLinks `json:"links"`
	Type   string          `json:"type"`
}

type Origin added in v1.0.5 

type Origin string
const Center Origin = "center"
type PaginationLinks struct {
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Self  string `json:"self,omitempty"`
}

type Parameter 

type Parameter map[string]string

func ParseQueryTags 

func ParseQueryTags(v interface{}) []Parameter

type Parent added in v1.0.5 

type Parent struct {
	ID    string          `json:"id,omitempty"`
	Links PaginationLinks `json:"links,omitempty"`
}

type ParentUpdate added in v1.0.5 

type ParentUpdate struct {
	ID string `json:"id"`
}

type PermissionsPolicy 

type PermissionsPolicy struct {
	// CollaborationToolsStartAccess Defines who can start or stop timer, voting, video chat, screen sharing, attention management.
	// Others will only be able to join. To change the value for the collaborationToolsStartAccess parameter, contact Miro Customer Support.
	// Valid options: all_editors | board_owners_and_coowners
	CollaborationToolsStartAccess CollabAccess `json:"collaborationToolsStartAccess,omitempty"`
	// CopyAccess Defines who can copy the board, copy objects, download images, and save the board as a template or PDF.
	// Valid options: anyone | team_members | team_editors | board_owner
	CopyAccess CopyAccess `json:"copyAccess,omitempty"`
	// CopyAccessLevel ...
	CopyAccessLevel string `json:"copyAccessLevel,omitempty"`
	// SharingAccess Defines who can change access and invite users to this board. To change the value for the sharingAccess
	// parameter, contact Miro Customer Support.
	// Valid options: team_members_with_editing_rights | board_owners_and_coowners
	SharingAccess SharingAccess `json:"sharingAccess,omitempty"`
}

PermissionsPolicy Defines the permissions policies for the board.

type Picture 

type Picture struct {
	ID       string `json:"id"`
	ImageURL string `json:"imageURL"`
}

type Policy 

type Policy struct {
	// PermissionsPolicy Defines the permissions policies for the board.
	PermissionsPolicy `json:"permissionsPolicy,omitempty"`
	// SharingPolicy Defines the public-level, organization-level, and team-level access for the board. The access level
	// that a user gets depends on the highest level of access that results from considering the public-level, team-level,
	// organization-level, and direct sharing access.
	SharingPolicy `json:"sharingPolicy,omitempty"`
}

type Position added in v1.0.5 

type Position struct {
	Origin     string  `json:"origin,omitempty"`
	RelativeTo string  `json:"relativeTo"`
	X          float64 `json:"x,omitempty"`
	Y          float64 `json:"y,omitempty"`
}

type PositionUpdate added in v1.0.5 

type PositionUpdate struct {
	// Origin Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will
	// have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates.
	// Currently, only one option is supported: center
	Origin Origin `json:"origin,omitempty"`
	// X-axis coordinate of the location of the item on the board.
	// By default, all items have absolute positioning to the board, not the current viewport.
	// The center point of the board has x: 0 and y: 0 coordinates.
	X float64 `json:"x,omitempty"`
	// Y-axis coordinate of the location of the item on the board.
	// By default, all items have absolute positioning to the board, not the current viewport.
	// The center point of the board has x: 0 and y: 0 coordinates.
	Y float64 `json:"y,omitempty"`
}

type Project 

type Project struct {
	ID   string `json:"id,omitempty"`
	Type string `json:"type,omitempty"`
}

type ResponseError 

type ResponseError struct {
	// Status code of the error
	Status int `json:"status"`
	// Code of the error
	Code string `json:"code"`
	// Description of the error
	Message string `json:"message"`
	// Type of the error
	Type string `json:"type"`
}

type Role added in v1.0.4 

type Role string
const (
	RoleViewer    Role = "viewer"
	RoleCommenter Role = "commenter"
	RoleEditor    Role = "editor"
	RoleCoOwner   Role = "coowner"
	RoleOwner     Role = "owner"
	RoleGuest     Role = "guest"
)

type RoleUpdate added in v1.0.4 

type RoleUpdate struct {
	Role Role `json:"role"`
}

type ShareBoardInvitation added in v1.0.4 

type ShareBoardInvitation struct {
	// Emails Email IDs of the users you want to invite to the board. You can invite up to 20 members per call (required).
	Emails []string `json:"emails"`
	// Role of the board member.
	Role Role `json:"role,omitempty"`
	// Message The message that will be sent in the invitation email.
	Message string `json:"message,omitempty"`
}

type SharingAccess added in v1.0.4 

type SharingAccess string

type SharingPolicy 

type SharingPolicy struct {
	// Access Defines the public-level access to the board.
	// Valid options: private | view | edit | comment
	Access Access `json:"access,omitempty"`
	// InviteToAccountAndBoardLinkAccess Defines the user role when inviting a user via the invite to team and board link.
	// For Enterprise users, this parameter is always set to no_access regardless of the value that you assign for this parameter.
	// Valid options: viewer | commenter | editor | no_access
	InviteToAccountAndBoardLinkAccess InviteAccess `json:"inviteToAccountAndBoardLinkAccess,omitempty"`
	// OrganizationAccess Defines the organization-level access to the board. If the board is created for a team that does
	// not belong to an organization, the organizationAccess parameter is always set to the default value.
	// Warning: may result in a "One of the requested features is not supported. (4.0408)" error message if you don't have the necessary access level.
	// Valid options: private | view | edit | comment
	OrganizationAccess Access `json:"organizationAccess,omitempty"`
	// TeamAccess Defines the team-level access to the board.
	// Valid options: private | view | edit | comment
	TeamAccess Access `json:"teamAccess,omitempty"`
}

type Sort added in v1.0.4 

type Sort string
const (
	// SortDefault If team_id is present, last_created. Otherwise, last_opened
	SortDefault Sort = "default"
	// SortLastModified sort by the date and time when the board was last modified
	SortLastModified Sort = "last_modified"
	// SortLastOpened sort by the date and time when the board was last opened
	SortLastOpened Sort = "last_opened"
	// SortLastCreated sort by the date and time when the board was created
	SortLastCreated Sort = "last_created"
	// SortAlphabetically sort by the board name (alphabetically)
	SortAlphabetically Sort = "alphabetically"
)

type Status added in v1.0.5 

type Status string
const (
	StatusConnected    Status = "connected"
	StatusDisconnected Status = "disconnected"
	StatusDisabled     Status = "disabled"
)

type Style added in v1.0.5 

type Style struct {
	BorderColor       string `json:"borderColor,omitempty"`
	BorderOpacity     string `json:"borderOpacity,omitempty"`
	BorderStyle       string `json:"borderStyle,omitempty"`
	BorderWidth       string `json:"borderWidth,omitempty"`
	Color             string `json:"color,omitempty"`
	FillColor         string `json:"fillColor,omitempty"`
	FillOpacity       string `json:"fillOpacity,omitempty"`
	FontFamily        string `json:"fontFamily,omitempty"`
	FontSize          string `json:"fontSize,omitempty"`
	TextAlign         string `json:"textAlign,omitempty"`
	TextAlignVertical string `json:"textAlignVertical,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.