client

package

v0.3.6 Latest Latest Go to latest Published: Apr 13, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Details

This section is empty.

View Source

var (
	ErrClient = errors.New("users client api failed")
)

This section is empty.

type Option interface {
	// contains filtered or unexported methods
}

Option provides options for configuring the creation of a users client.

func WithTLSConfig(cfg *tls.Config) Option

WithTLSConfig sets the http client's tls config.

func WithTimeout(timeout time.Duration) Option

WithTimeout sets the client timeout.

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

UsersClient provides a client for the users api.

func New(baseURL string, opts ...Option) (*UsersClient, error)

New returns a new client for the users api.

func (c UsersClient) AssociatePlayer(ctx context.Context, id user.ID, req user.AssociatePlayer) (*user.User, error)

AssociatePlayer associates a player with the given user.

func (c UsersClient) Create(ctx context.Context, req user.Create) (*user.User, error)

Create create a new user.

func (c UsersClient) Get(ctx context.Context, id user.ID) (*user.User, error)

Get returns a user for the give user id.

func (c UsersClient) List(ctx context.Context, filter user.Filter) ([]*user.User, error)

List returns a list of users for the given item filter.

func (c UsersClient) Remove(ctx context.Context, id user.ID) error

Remove delete the given user.

func (c UsersClient) Update(ctx context.Context, id user.ID, req user.Update) (*user.User, error)

Update updates an existing user.