org

Documentation

Overview

Package org provides the /orgs APIs

Package org provides the /orgs APIs

Index

• Constants
• func DeleteMember(ctx context.Context, orgId, userId string) error
• func Get(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)
• func GetMember(ctx context.Context, orgId, userId string) (*trimmer.Member, error)
• func ListEvents(ctx context.Context, orgId string, params *trimmer.EventListParams) *event.Iter
• func ListMedia(ctx context.Context, orgId string, params *trimmer.MediaListParams) *media.Iter
• func ListMembers(ctx context.Context, orgId string, params *trimmer.MemberListParams) *member.Iter
• func ListVolumes(ctx context.Context, orgId string, params *trimmer.VolumeListParams) *volume.Iter
• func ListWorkspaces(ctx context.Context, orgId string, params *trimmer.WorkspaceListParams) *workspace.Iter
• func NewMember(ctx context.Context, orgId, userId string, params *trimmer.MemberParams) (*trimmer.Member, error)
• func NewVolume(ctx context.Context, orgId string, params *trimmer.VolumeParams) (*trimmer.Volume, error)
• func NewWorkspace(ctx context.Context, orgId string, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)
• func Update(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)
• func UploadImage(ctx context.Context, orgId string, params *trimmer.FileInfo, src io.Reader) (*trimmer.Media, error)
• type Client
  • func (c Client) DeleteMember(ctx context.Context, orgId, userId string) error
  • func (c Client) Get(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)
  • func (c Client) GetMember(ctx context.Context, orgId, userId string) (*trimmer.Member, error)
  • func (c Client) ListEvents(ctx context.Context, orgId string, params *trimmer.EventListParams) *event.Iter
  • func (c Client) ListMedia(ctx context.Context, orgId string, params *trimmer.MediaListParams) *media.Iter
  • func (c Client) ListMembers(ctx context.Context, orgId string, params *trimmer.MemberListParams) *member.Iter
  • func (c Client) ListVolumes(ctx context.Context, orgId string, params *trimmer.VolumeListParams) *volume.Iter
  • func (c Client) ListWorkspaces(ctx context.Context, orgId string, params *trimmer.WorkspaceListParams) *workspace.Iter
  • func (c Client) NewMember(ctx context.Context, orgId, userId string, params *trimmer.MemberParams) (*trimmer.Member, error)
  • func (c Client) NewVolume(ctx context.Context, orgId string, params *trimmer.VolumeParams) (*trimmer.Volume, error)
  • func (c Client) NewWorkspace(ctx context.Context, orgId string, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)
  • func (c Client) Update(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)
• type Iter
  • func (i *Iter) Org() *trimmer.Org

Constants

const (
	OrgStateParked   trimmer.OrgState = "parked"
	OrgStateCreated  trimmer.OrgState = "created"
	OrgStateActive   trimmer.OrgState = "active"
	OrgStateInactive trimmer.OrgState = "inactive"
	OrgStateExpired  trimmer.OrgState = "expired"
	OrgStateBlocked  trimmer.OrgState = "blocked"
	OrgStateBanned   trimmer.OrgState = "banned"
	OrgStateDeleting trimmer.OrgState = "deleting"
	OrgStateCleaning trimmer.OrgState = "cleaning"
	OrgStateDeleted  trimmer.OrgState = "deleted"
)

Functions

func DeleteMember

func DeleteMember(ctx context.Context, orgId, userId string) error

func Get

func Get(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)

func GetMember

func GetMember(ctx context.Context, orgId, userId string) (*trimmer.Member, error)

func ListEvents

func ListEvents(ctx context.Context, orgId string, params *trimmer.EventListParams) *event.Iter

func ListMedia

func ListMedia(ctx context.Context, orgId string, params *trimmer.MediaListParams) *media.Iter

func ListMembers

func ListMembers(ctx context.Context, orgId string, params *trimmer.MemberListParams) *member.Iter

func ListVolumes

func ListVolumes(ctx context.Context, orgId string, params *trimmer.VolumeListParams) *volume.Iter

func ListWorkspaces

func ListWorkspaces(ctx context.Context, orgId string, params *trimmer.WorkspaceListParams) *workspace.Iter

func NewMember

func NewMember(ctx context.Context, orgId, userId string, params *trimmer.MemberParams) (*trimmer.Member, error)

func NewVolume

func NewVolume(ctx context.Context, orgId string, params *trimmer.VolumeParams) (*trimmer.Volume, error)

func NewWorkspace

func NewWorkspace(ctx context.Context, orgId string, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)

func Update

func Update(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)

func UploadImage

func UploadImage(ctx context.Context, orgId string, params *trimmer.FileInfo, src io.Reader) (*trimmer.Media, error)

Types

type Client

type Client struct {
	B    trimmer.Backend
	Key  trimmer.ApiKey
	Sess *trimmer.Session
}

Client is used to invoke /orgs APIs.

func (Client) DeleteMember

func (c Client) DeleteMember(ctx context.Context, orgId, userId string) error

func (Client) Get

func (c Client) Get(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)

func (Client) GetMember

func (c Client) GetMember(ctx context.Context, orgId, userId string) (*trimmer.Member, error)

func (Client) ListEvents

func (c Client) ListEvents(ctx context.Context, orgId string, params *trimmer.EventListParams) *event.Iter

func (Client) ListMedia

func (c Client) ListMedia(ctx context.Context, orgId string, params *trimmer.MediaListParams) *media.Iter

func (Client) ListMembers

func (c Client) ListMembers(ctx context.Context, orgId string, params *trimmer.MemberListParams) *member.Iter

func (Client) ListVolumes

func (c Client) ListVolumes(ctx context.Context, orgId string, params *trimmer.VolumeListParams) *volume.Iter

func (Client) ListWorkspaces

func (c Client) ListWorkspaces(ctx context.Context, orgId string, params *trimmer.WorkspaceListParams) *workspace.Iter

func (Client) NewMember

func (c Client) NewMember(ctx context.Context, orgId, userId string, params *trimmer.MemberParams) (*trimmer.Member, error)

func (Client) NewVolume

func (c Client) NewVolume(ctx context.Context, orgId string, params *trimmer.VolumeParams) (*trimmer.Volume, error)

func (Client) NewWorkspace

func (c Client) NewWorkspace(ctx context.Context, orgId string, params *trimmer.WorkspaceParams) (*trimmer.Workspace, error)

func (Client) Update

func (c Client) Update(ctx context.Context, orgId string, params *trimmer.OrgParams) (*trimmer.Org, error)

type Iter

type Iter struct {
	*trimmer.Iter
}

Iter is an iterator for lists of Orgs. The embedded Iter carries methods with it; see its documentation for details.

func (*Iter) Org

func (i *Iter) Org() *trimmer.Org

Org returns the most recent Org visited by a call to Next.