recipient

Documentation

Overview

package recipient provides the /recipients APIs

Index

• func Create(params *RecipientParams) (*Recipient, error)
• func Delete(id string) error
• func Get(id string, params *RecipientParams) (*Recipient, error)
• func List(params *RecipientListParams) *RecipientIter
• func Update(id string, params *RecipientParams) (*Recipient, error)
• type Client
  • func (c Client) Create(params *RecipientParams) (*Recipient, error)
  • func (c Client) Delete(id string) error
  • func (c Client) Get(id string, params *RecipientParams) (*Recipient, error)
  • func (c Client) List(params *RecipientListParams) *RecipientIter
  • func (c Client) Update(id string, params *RecipientParams) (*Recipient, error)

Functions

func Create

func Create(params *RecipientParams) (*Recipient, error)

Create POSTs a new recipient. For more details see https://stripe.com/docs/api#create_recipient.

func Delete

func Delete(id string) error

Delete removes a recipient. For more details see https://stripe.com/docs/api#delete_recipient.

func Get

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

Get returns the details of a recipient. For more details see https://stripe.com/docs/api#retrieve_recipient.

func List

func List(params *RecipientListParams) *RecipientIter

List returns a list of recipients. For more details see https://stripe.com/docs/api#list_recipients.

func Update

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

Update updates a recipient's properties. For more details see https://stripe.com/docs/api#update_recipient.

Types

type Client

type Client struct {
	B   Backend
	Tok string
}

Client is used to invoke /recipients APIs.

func (Client) Create

func (c Client) Create(params *RecipientParams) (*Recipient, error)

func (Client) Delete

func (c Client) Delete(id string) error

func (Client) Get

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

func (Client) List

func (c Client) List(params *RecipientListParams) *RecipientIter

func (Client) Update

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