accounts

Documentation

Overview

Code generated by "make api"; DO NOT EDIT.

Code generated by "make api"; DO NOT EDIT.

Index

• type Account
  • func (n Account) ResponseBody() *bytes.Buffer
  • func (n Account) ResponseMap() map[string]interface{}
• type AccountCreateResult
• type AccountDeleteResult
  • func (n AccountDeleteResult) GetResponseBody() *bytes.Buffer
  • func (n AccountDeleteResult) GetResponseMap() map[string]interface{}
• type AccountListResult
  • func (n AccountListResult) GetItems() interface{}
  • func (n AccountListResult) GetResponseBody() *bytes.Buffer
  • func (n AccountListResult) GetResponseMap() map[string]interface{}
• type AccountReadResult
  • func (n AccountReadResult) GetItem() interface{}
  • func (n AccountReadResult) GetResponseBody() *bytes.Buffer
  • func (n AccountReadResult) GetResponseMap() map[string]interface{}
• type AccountUpdateResult
• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) ChangePassword(ctx context.Context, accountId, currentPassword, newPassword string, ...) (*AccountUpdateResult, error)
  • func (c *Client) Create(ctx context.Context, authMethodId string, opt ...Option) (*AccountCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, accountId string, opt ...Option) (*AccountDeleteResult, error)
  • func (c *Client) List(ctx context.Context, authMethodId string, opt ...Option) (*AccountListResult, error)
  • func (c *Client) Read(ctx context.Context, accountId string, opt ...Option) (*AccountReadResult, error)
  • func (c *Client) SetPassword(ctx context.Context, accountId, password string, version uint32, opt ...Option) (*AccountUpdateResult, error)
  • func (c *Client) Update(ctx context.Context, accountId string, version uint32, opt ...Option) (*AccountUpdateResult, error)
• type Option
  • func DefaultAttributes() Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func DefaultPasswordAccountLoginName() Option
  • func DefaultPasswordAccountPassword() Option
  • func WithAttributes(inAttributes map[string]interface{}) Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithName(inName string) Option
  • func WithPasswordAccountLoginName(inLoginName string) Option
  • func WithPasswordAccountPassword(inPassword string) Option
• type PasswordAccountAttributes

Types

type Account

type Account struct {
	Id           string                 `json:"id,omitempty"`
	Scope        *scopes.ScopeInfo      `json:"scope,omitempty"`
	Name         string                 `json:"name,omitempty"`
	Description  string                 `json:"description,omitempty"`
	CreatedTime  time.Time              `json:"created_time,omitempty"`
	UpdatedTime  time.Time              `json:"updated_time,omitempty"`
	Version      uint32                 `json:"version,omitempty"`
	Type         string                 `json:"type,omitempty"`
	AuthMethodId string                 `json:"auth_method_id,omitempty"`
	Attributes   map[string]interface{} `json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (Account) ResponseBody

func (n Account) ResponseBody() *bytes.Buffer

func (Account) ResponseMap

func (n Account) ResponseMap() map[string]interface{}

type AccountCreateResult

type AccountCreateResult = AccountReadResult

type AccountDeleteResult

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

func (AccountDeleteResult) GetResponseBody

func (n AccountDeleteResult) GetResponseBody() *bytes.Buffer

func (AccountDeleteResult) GetResponseMap

func (n AccountDeleteResult) GetResponseMap() map[string]interface{}

type AccountListResult

type AccountListResult struct {
	Items []*Account
	// contains filtered or unexported fields
}

func (AccountListResult) GetItems

func (n AccountListResult) GetItems() interface{}

func (AccountListResult) GetResponseBody

func (n AccountListResult) GetResponseBody() *bytes.Buffer

func (AccountListResult) GetResponseMap

func (n AccountListResult) GetResponseMap() map[string]interface{}

type AccountReadResult

type AccountReadResult struct {
	Item *Account
	// contains filtered or unexported fields
}

func (AccountReadResult) GetItem

func (n AccountReadResult) GetItem() interface{}

func (AccountReadResult) GetResponseBody

func (n AccountReadResult) GetResponseBody() *bytes.Buffer

func (AccountReadResult) GetResponseMap

func (n AccountReadResult) GetResponseMap() map[string]interface{}

type AccountUpdateResult

type AccountUpdateResult = AccountReadResult

type Client

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

Client is a client for this collection

func NewClient

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) ApiClient

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) ChangePassword

func (c *Client) ChangePassword(ctx context.Context, accountId, currentPassword, newPassword string, version uint32, opt ...Option) (*AccountUpdateResult, error)

func (*Client) Create

func (c *Client) Create(ctx context.Context, authMethodId string, opt ...Option) (*AccountCreateResult, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, accountId string, opt ...Option) (*AccountDeleteResult, error)

func (*Client) List

func (c *Client) List(ctx context.Context, authMethodId string, opt ...Option) (*AccountListResult, error)

func (*Client) Read

func (c *Client) Read(ctx context.Context, accountId string, opt ...Option) (*AccountReadResult, error)

func (*Client) SetPassword

func (c *Client) SetPassword(ctx context.Context, accountId, password string, version uint32, opt ...Option) (*AccountUpdateResult, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, accountId string, version uint32, opt ...Option) (*AccountUpdateResult, error)

type Option

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in ther order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultAttributes

func DefaultAttributes() Option

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func DefaultPasswordAccountLoginName

func DefaultPasswordAccountLoginName() Option

func DefaultPasswordAccountPassword

func DefaultPasswordAccountPassword() Option

func WithAttributes

func WithAttributes(inAttributes map[string]interface{}) Option

func WithAutomaticVersioning

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithDescription

func WithDescription(inDescription string) Option

func WithName

func WithName(inName string) Option

func WithPasswordAccountLoginName

func WithPasswordAccountLoginName(inLoginName string) Option

func WithPasswordAccountPassword

func WithPasswordAccountPassword(inPassword string) Option

type PasswordAccountAttributes

type PasswordAccountAttributes struct {
	LoginName string `json:"login_name,omitempty"`
	Password  string `json:"password,omitempty"`
}