accounts

Documentation

Index

• func ExtractMetadata(gr GetResult) map[string]string
• func Update(c *storage.Client, opts UpdateOpts) error
• type GetOpts
• type GetResult
  • func Get(c *storage.Client, opts GetOpts) (GetResult, error)
• type UpdateOpts

Functions

func ExtractMetadata

func ExtractMetadata(gr GetResult) map[string]string

ExtractMetadata is a function that takes a GetResult (of type *http.Response) and returns the custom metatdata associated with the account.

func Update

func Update(c *storage.Client, opts UpdateOpts) error

Update is a function that creates, updates, or deletes an account's metadata.

Types

type GetOpts

type GetOpts struct {
	Headers map[string]string
}

GetOpts is a structure that contains parameters for getting an account's metadata.

type GetResult

type GetResult *http.Response

GetResult is a *http.Response that is returned from a call to the Get function.

func Get

func Get(c *storage.Client, opts GetOpts) (GetResult, error)

Get is a function that retrieves an account's metadata. To extract just the custom metadata, pass the GetResult response to the ExtractMetadata function.

type UpdateOpts

type UpdateOpts struct {
	Metadata map[string]string
	Headers  map[string]string
}

UpdateOpts is a structure that contains parameters for updating, creating, or deleting an account's metadata.