mirror of
https://github.com/harness/drone.git
synced 2025-05-04 08:12:12 +08:00
50 lines
1.5 KiB
Go
50 lines
1.5 KiB
Go
// Copyright 2022 Harness Inc. All rights reserved.
|
|
// Use of this source code is governed by the Polyform Free Trial License
|
|
// that can be found in the LICENSE.md file for this repository.
|
|
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/harness/gitness/types"
|
|
)
|
|
|
|
// Client to access the remote APIs.
|
|
type Client interface {
|
|
// Login authenticates the user and returns a JWT token.
|
|
Login(ctx context.Context, username, password string) (*types.TokenResponse, error)
|
|
|
|
// Register registers a new user and returns a JWT token.
|
|
Register(ctx context.Context, username, name, email, password string) (*types.TokenResponse, error)
|
|
|
|
// Self returns the currently authenticated user.
|
|
Self(ctx context.Context) (*types.User, error)
|
|
|
|
// User returns a user by ID or email.
|
|
User(ctx context.Context, key string) (*types.User, error)
|
|
|
|
// UserList returns a list of all registered users.
|
|
UserList(ctx context.Context, params types.Params) ([]types.User, error)
|
|
|
|
// UserCreate creates a new user account.
|
|
UserCreate(ctx context.Context, user *types.User) (*types.User, error)
|
|
|
|
// UserUpdate updates a user account by ID or email.
|
|
UserUpdate(ctx context.Context, key string, input *types.UserInput) (*types.User, error)
|
|
|
|
// UserDelete deletes a user account by ID or email.
|
|
UserDelete(ctx context.Context, key string) error
|
|
}
|
|
|
|
// remoteError store the error payload returned
|
|
// fro the remote API.
|
|
type remoteError struct {
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// Error returns the error message.
|
|
func (e *remoteError) Error() string {
|
|
return e.Message
|
|
}
|