capability

Documentation

Overview

Package capability provides the /accounts/{account}/capabilities APIs

Index

• func Get(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)
• func Update(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)
• type Client
  • func (c Client) Get(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)
  • func (c Client) List(listParams *stripe.CapabilityListParams) *Iter
  • func (c Client) Update(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)
• type Iter
  • func List(params *stripe.CapabilityListParams) *Iter
  • func (i *Iter) Capability() *stripe.Capability
  • func (i *Iter) CapabilityList() *stripe.CapabilityList

Functions

func Get

func Get(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)

Retrieves information about the specified Account Capability.

func Update

func Update(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /accounts/{account}/capabilities APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)

Retrieves information about the specified Account Capability.

func (Client) List

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

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

func (Client) Update

func (c Client) Update(id string, params *stripe.CapabilityParams) (*stripe.Capability, error)

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for capabilities.

func List

func List(params *stripe.CapabilityListParams) *Iter

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

func (*Iter) Capability

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

Capability returns the capability which the iterator is currently pointing to.

func (*Iter) CapabilityList

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

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