configuration

Documentation

Overview

Package configuration provides the /terminal/configurations APIs

Index

• func Del(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
• func Get(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
• func New(params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
• func Update(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
• type Client
  • func (c Client) Del(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
  • func (c Client) Get(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
  • func (c Client) List(listParams *stripe.TerminalConfigurationListParams) *Iter
  • func (c Client) New(params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
  • func (c Client) Update(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)
• type Iter
  • func List(params *stripe.TerminalConfigurationListParams) *Iter
  • func (i *Iter) TerminalConfiguration() *stripe.TerminalConfiguration
  • func (i *Iter) TerminalConfigurationList() *stripe.TerminalConfigurationList

Functions

func Del

func Del(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Deletes a Configuration object.

func Get

func Get(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Retrieves a Configuration object.

func New

func New(params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Creates a new Configuration object.

func Update

func Update(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Updates a new Configuration object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /terminal/configurations APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Deletes a Configuration object.

func (Client) Get

func (c Client) Get(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Retrieves a Configuration object.

func (Client) List

func (c Client) List(listParams *stripe.TerminalConfigurationListParams) *Iter

Returns a list of Configuration objects.

func (Client) New

func (c Client) New(params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Creates a new Configuration object.

func (Client) Update

func (c Client) Update(id string, params *stripe.TerminalConfigurationParams) (*stripe.TerminalConfiguration, error)

Updates a new Configuration object.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for terminal configurations.

func List

func List(params *stripe.TerminalConfigurationListParams) *Iter

Returns a list of Configuration objects.

func (*Iter) TerminalConfiguration

func (i *Iter) TerminalConfiguration() *stripe.TerminalConfiguration

TerminalConfiguration returns the terminal configuration which the iterator is currently pointing to.

func (*Iter) TerminalConfigurationList

func (i *Iter) TerminalConfigurationList() *stripe.TerminalConfigurationList

TerminalConfigurationList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.