recipient

Documentation

Overview

Package recipient provides the /recipients APIs

Index

• func Del(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Client
  • func (c Client) Del(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
  • func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
  • func (c Client) List(listParams *stripe.RecipientListParams) *Iter
  • func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Iter
  • func List(params *stripe.RecipientListParams) *Iter
  • func (i *Iter) Recipient() *stripe.Recipient
  • func (i *Iter) RecipientList() *stripe.RecipientList

Functions

func Del

func Del(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Del removes a recipient.

func Get

func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Get returns the details of a recipient.

func Update

func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Update updates a recipient's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /recipients APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Del removes a recipient.

func (Client) Get

func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Get returns the details of a recipient.

func (Client) List

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

List returns a list of recipients.

func (Client) Update

func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

Update updates a recipient's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for recipients.

func List

func List(params *stripe.RecipientListParams) *Iter

List returns a list of recipients.

func (*Iter) Recipient

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

Recipient returns the recipient which the iterator is currently pointing to.

func (*Iter) RecipientList

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

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