client

package

v0.0.18 Latest Latest Go to latest Published: Nov 20, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Details

View Source

const (
	V1ItemsRoute string = "/v1/items"
)

This section is empty.

func TranslateItem(i rest.Item) (*assets.Item, error)

TranslateItem translates a network item into an assets item.

func TranslateItemChange(i assets.ItemChange) (rest.ItemRequest, error)

TranslateItemChange translates an asset item change struct to a network item request.

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

Client provides a client for the assets api.

func New(baseURL string, opts ...ClientOption) *Client

New returns a new client for the assets API.

func (c Client) CreateItem(ctx context.Context, item assets.ItemCreate) (*assets.Item, error)

CreateItem creates an item.

func (c Client) GetItem(ctx context.Context, id assets.ItemID) (*assets.Item, error)

GetItem returns an item for the given item id.

func (c Client) ListItems(ctx context.Context, filter assets.ItemFilter) ([]*assets.Item, error)

ListItems returns a list of items for the given item filter.

func (c Client) RemoveItem(ctx context.Context, id assets.ItemID) error

RemoveItem deletes an item.

func (c Client) UpdateItem(ctx context.Context, id assets.ItemID, item assets.ItemUpdate) (*assets.Item, error)

UpdateItem updates the item with the given item update.

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

ClientOption provides options for configuring the creation of an assets client.

func WithTimeout(timeout time.Duration) ClientOption

WithTime sets the client timeout.