invitations

package
v0.3.6 Latest Latest
Warning

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

Go to latest
Published: Feb 20, 2023 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error

type Error struct {
	Detail string `json:"detail"`
}

type InvitationsClient

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

func NewClient

func NewClient(opts ...client.ClientOption) (*InvitationsClient, error)

func (*InvitationsClient) Create

func (*InvitationsClient) Delete

func (c *InvitationsClient) Delete(InvitationId int) (*InvitationsDeleteResult, error)

func (*InvitationsClient) List

func (*InvitationsClient) Resend

func (c *InvitationsClient) Resend(InvitationId int) (*InvitationsResendResult, error)

type InvitationsCreateOptions

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

type InvitationsCreateResponse

type InvitationsCreateResponse struct {
	ID        int64                 `json:"id"`
	Email     string                `json:"email"`
	Role      InvitationsCreateRole `json:"role"`
	CreatedAt string                `json:"created_at"`
}

type InvitationsCreateResult

type InvitationsCreateResult struct {
	Result []InvitationsCreateResponse `json:"result"`
	Error  *Error                      `json:"error"`
}

type InvitationsCreateRole

type InvitationsCreateRole string
const (
	Manager    InvitationsCreateRole = "manager"
	Member     InvitationsCreateRole = "member"
	Viewer     InvitationsCreateRole = "viewer"
	Restricted InvitationsCreateRole = "restricted"
)

type InvitationsDeleteResult

type InvitationsDeleteResult struct {
	Error *Error `json:"error"`
}

type InvitationsListResponse

type InvitationsListResponse struct {
	ID        int64  `json:"id"`
	Email     string `json:"email"`
	Role      string `json:"role"`
	CreatedAt string `json:"created_at"`
}

type InvitationsListResult

type InvitationsListResult struct {
	Result []InvitationsListResponse `json:"result"`
	Error  *Error                    `json:"error"`
}

type InvitationsResendResult

type InvitationsResendResult struct {
	Error *Error `json:"error"`
}

type ListOptions

type ListOptions struct {
	Cursor  string `json:"cursor"`   // Pagination cursor.
	PerPage *int   `json:"per_page"` // Number of items to list per page.	[ 1 .. 100 ]
}

Jump to

Keyboard shortcuts

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