filelink

Documentation

Overview

Package filelink provides the /file_links APIs

Index

• func Get(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)
• func New(params *stripe.FileLinkParams) (*stripe.FileLink, error)
• func Update(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)
• type Client
  • func (c Client) Get(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)
  • func (c Client) List(listParams *stripe.FileLinkListParams) *Iter
  • func (c Client) New(params *stripe.FileLinkParams) (*stripe.FileLink, error)
  • func (c Client) Update(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)
• type Iter
  • func List(params *stripe.FileLinkListParams) *Iter
  • func (i *Iter) FileLink() *stripe.FileLink
  • func (i *Iter) FileLinkList() *stripe.FileLinkList

Functions

func Get

func Get(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)

Retrieves the file link with the given ID.

func New

func New(params *stripe.FileLinkParams) (*stripe.FileLink, error)

Creates a new file link object.

func Update

func Update(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)

Updates an existing file link object. Expired links can no longer be updated.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /file_links APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)

Retrieves the file link with the given ID.

func (Client) List

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

Returns a list of file links.

func (Client) New

func (c Client) New(params *stripe.FileLinkParams) (*stripe.FileLink, error)

Creates a new file link object.

func (Client) Update

func (c Client) Update(id string, params *stripe.FileLinkParams) (*stripe.FileLink, error)

Updates an existing file link object. Expired links can no longer be updated.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for file links.

func List

func List(params *stripe.FileLinkListParams) *Iter

Returns a list of file links.

func (*Iter) FileLink

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

FileLink returns the file link which the iterator is currently pointing to.

func (*Iter) FileLinkList

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

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