location

Documentation

Overview

Package location provides the /terminal/locations APIs

Index

• func Del(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
• func Get(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
• func New(params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
• func Update(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
• type Client
  • func (c Client) Del(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
  • func (c Client) Get(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
  • func (c Client) List(listParams *stripe.TerminalLocationListParams) *Iter
  • func (c Client) New(params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
  • func (c Client) Update(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)
• type Iter
  • func List(params *stripe.TerminalLocationListParams) *Iter
  • func (i *Iter) TerminalLocation() *stripe.TerminalLocation
  • func (i *Iter) TerminalLocationList() *stripe.TerminalLocationList

Functions

func Del

func Del(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Deletes a Location object.

func Get

func Get(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Retrieves a Location object.

func New

func New(params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Creates a new Location object. For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide.

func Update

func Update(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /terminal/locations APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Deletes a Location object.

func (Client) Get

func (c Client) Get(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Retrieves a Location object.

func (Client) List

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

Returns a list of Location objects.

func (Client) New

func (c Client) New(params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Creates a new Location object. For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide.

func (Client) Update

func (c Client) Update(id string, params *stripe.TerminalLocationParams) (*stripe.TerminalLocation, error)

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for terminal locations.

func List

func List(params *stripe.TerminalLocationListParams) *Iter

Returns a list of Location objects.

func (*Iter) TerminalLocation

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

TerminalLocation returns the terminal location which the iterator is currently pointing to.

func (*Iter) TerminalLocationList

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

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