file

Documentation

Overview

Package file provides the /files APIs

Index

• func Get(id string, params *stripe.FileParams) (*stripe.File, error)
• func New(params *stripe.FileParams) (*stripe.File, error)
• type Client
  • func (c Client) Get(id string, params *stripe.FileParams) (*stripe.File, error)
  • func (c Client) List(listParams *stripe.FileListParams) *Iter
  • func (c Client) New(params *stripe.FileParams) (*stripe.File, error)
• type Iter
  • func List(params *stripe.FileListParams) *Iter
  • func (i *Iter) File() *stripe.File
  • func (i *Iter) FileList() *stripe.FileList

Functions

func Get

func Get(id string, params *stripe.FileParams) (*stripe.File, error)

Get returns the details of a file.

func New

func New(params *stripe.FileParams) (*stripe.File, error)

New creates a new file.

Types

type Client

type Client struct {
	B        stripe.Backend
	BUploads stripe.Backend
	Key      string
}

Client is used to invoke /files APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.FileParams) (*stripe.File, error)

Get returns the details of a file.

func (Client) List

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

List returns a list of files.

func (Client) New

func (c Client) New(params *stripe.FileParams) (*stripe.File, error)

New creates a new file.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for files.

func List

func List(params *stripe.FileListParams) *Iter

List returns a list of files.

func (*Iter) File

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

File returns the file which the iterator is currently pointing to.

func (*Iter) FileList

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

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