api

Documentation

Index

• Constants
• type API
  • func NewAPI(name string, endpoint string, proxy string) (*API, error)
  • func (a *API) ApplyUpdatersToUserByID(userID string, updaters []UserUpdater) (*user.User, error)
  • func (a *API) ApplyUpdatersToUserByObject(updateUser *user.User, updaters []UserUpdater) (*user.User, error)
  • func (a *API) CheckToken(token string) (*Token, error)
  • func (a *API) DeleteDataset(datasetID string) error
  • func (a *API) DeleteUserByID(userID string, password string) error
  • func (a *API) FindUsers(query *UsersQuery) ([]*user.User, error)
  • func (a *API) GetUserByEmail(email string) (*user.User, error)
  • func (a *API) GetUserByID(userID string) (*user.User, error)
  • func (a *API) IsSessionUserID(userID string) bool
  • func (a *API) ListDatasets(userID string, filter *Filter, pagination *Pagination) (*ResponseArray, error)
  • func (a *API) Login(email string, password string) (*user.User, error)
  • func (a *API) Logout() error
  • func (a *API) RefreshToken() (*Token, error)
  • func (a *API) ServerLogin() error
  • func (a *API) UpdateUserByID(userID string, userUpdates *UserUpdates) (*user.User, error)
  • func (a *API) UpdateUserByObject(updateUser *user.User, userUpdates *UserUpdates) (*user.User, error)
• type AddRolesUserUpdater
  • func NewAddRolesUserUpdater(roles []string) (*AddRolesUserUpdater, error)
  • func (a *AddRolesUserUpdater) Update(updateUser *user.User, userUpdates *UserUpdates) error
• type Error
• type Filter
• type Meta
• type Pagination
• type RemoveRolesUserUpdater
  • func NewRemoveRolesUserUpdater(roles []string) (*RemoveRolesUserUpdater, error)
  • func (r *RemoveRolesUserUpdater) Update(updateUser *user.User, userUpdates *UserUpdates) error
• type ResponseArray
• type ResponseObject
• type Session
• type Source
• type Token
• type Trace
• type UserDelete
• type UserUpdater
• type UserUpdates
  • func (u *UserUpdates) HasUpdates() bool
• type UsersQuery

Constants

const (
	ConfigDirectoryName = ".tidepool"
	SessionFileName     = "session"
)

const (
	TidepoolServerName   = "X-Tidepool-Server-Name"
	TidepoolServerSecret = "X-Tidepool-Server-Secret"
)

Types

type API

type API struct {
	Name     string
	Endpoint string
	Writer   io.Writer
	Verbose  bool
	// contains filtered or unexported fields
}

func NewAPI

func NewAPI(name string, endpoint string, proxy string) (*API, error)

func (*API) ApplyUpdatersToUserByID

func (a *API) ApplyUpdatersToUserByID(userID string, updaters []UserUpdater) (*user.User, error)

func (*API) ApplyUpdatersToUserByObject

func (a *API) ApplyUpdatersToUserByObject(updateUser *user.User, updaters []UserUpdater) (*user.User, error)

func (*API) CheckToken

func (a *API) CheckToken(token string) (*Token, error)

func (*API) DeleteDataset

func (a *API) DeleteDataset(datasetID string) error

func (*API) DeleteUserByID

func (a *API) DeleteUserByID(userID string, password string) error

func (*API) FindUsers

func (a *API) FindUsers(query *UsersQuery) ([]*user.User, error)

func (*API) GetUserByEmail

func (a *API) GetUserByEmail(email string) (*user.User, error)

func (*API) GetUserByID

func (a *API) GetUserByID(userID string) (*user.User, error)

func (*API) IsSessionUserID

func (a *API) IsSessionUserID(userID string) bool

func (*API) ListDatasets

func (a *API) ListDatasets(userID string, filter *Filter, pagination *Pagination) (*ResponseArray, error)

func (*API) Login

func (a *API) Login(email string, password string) (*user.User, error)

func (*API) Logout

func (a *API) Logout() error

func (*API) RefreshToken

func (a *API) RefreshToken() (*Token, error)

func (*API) ServerLogin

func (a *API) ServerLogin() error

func (*API) UpdateUserByID

func (a *API) UpdateUserByID(userID string, userUpdates *UserUpdates) (*user.User, error)

func (*API) UpdateUserByObject

func (a *API) UpdateUserByObject(updateUser *user.User, userUpdates *UserUpdates) (*user.User, error)

type AddRolesUserUpdater

type AddRolesUserUpdater struct {
	Roles []string
}

func NewAddRolesUserUpdater

func NewAddRolesUserUpdater(roles []string) (*AddRolesUserUpdater, error)

func (*AddRolesUserUpdater) Update

func (a *AddRolesUserUpdater) Update(updateUser *user.User, userUpdates *UserUpdates) error

type Error

type Error struct {
	Code   string      `json:"code,omitempty"`
	Title  string      `json:"title,omitempty"`
	Detail string      `json:"detail,omitempty"`
	Status int         `json:"status,string,omitempty"`
	Source *Source     `json:"source,omitempty"`
	Meta   interface{} `json:"meta,omitempty"`
}

type Filter

type Filter struct {
	Deleted *bool
}

type Meta

type Meta struct {
	Trace *Trace `json:"trace,omitempty"`
}

type Pagination

type Pagination struct {
	Page *int
	Size *int
}

type RemoveRolesUserUpdater

type RemoveRolesUserUpdater struct {
	Roles []string
}

func NewRemoveRolesUserUpdater

func NewRemoveRolesUserUpdater(roles []string) (*RemoveRolesUserUpdater, error)

func (*RemoveRolesUserUpdater) Update

func (r *RemoveRolesUserUpdater) Update(updateUser *user.User, userUpdates *UserUpdates) error

type ResponseArray

type ResponseArray struct {
	Data   []interface{} `json:"data,omitempty"`
	Errors []*Error      `json:"errors,omitempty"`
	Meta   *Meta         `json:"meta,omitempty"`
}

type ResponseObject

type ResponseObject struct {
	Data   interface{} `json:"data,omitempty"`
	Errors []*Error    `json:"errors,omitempty"`
	Meta   *Meta       `json:"meta,omitempty"`
}

type Session

type Session struct {
	Token    string `json:"token"`
	IsServer bool   `json:"isServer"`
	UserID   string `json:"userId,omitempty"`
}

type Source

type Source struct {
	Parameter string `json:"parameter,omitempty"`
	Pointer   string `json:"pointer,omitempty"`
}

type Token

type Token struct {
	IsServer bool   `json:"isserver"`
	UserID   string `json:"userid"`
}

type Trace

type Trace struct {
	Request string `json:"request,omitempty"`
	Session string `json:"session,omitempty"`
}

type UserDelete

type UserDelete struct {
	Password *string `json:"password,omitempty"`
}

type UserUpdater

type UserUpdater interface {
	Update(updateUser *user.User, userUpdates *UserUpdates) error
}

type UserUpdates

type UserUpdates struct {
	Username      *string   `json:"username,omitempty"`
	Emails        *[]string `json:"emails,omitempty"`
	Password      *string   `json:"password,omitempty"`
	Roles         *[]string `json:"roles,omitempty"`
	TermsAccepted *string   `json:"termsAccepted,omitempty"`
	EmailVerified *bool     `json:"emailVerified,omitempty"`
}

func (*UserUpdates) HasUpdates

func (u *UserUpdates) HasUpdates() bool

type UsersQuery

type UsersQuery struct {
	Role *string `json:"role,omitempty"`
}