request

Documentation

Overview

Package request provides the /forwarding/requests APIs

Index

• func Get(id string, params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)
• func New(params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)
• type Client
  • func (c Client) Get(id string, params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)
  • func (c Client) List(listParams *stripe.ForwardingRequestListParams) *Iter
  • func (c Client) New(params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)
• type Iter
  • func List(params *stripe.ForwardingRequestListParams) *Iter
  • func (i *Iter) ForwardingRequest() *stripe.ForwardingRequest
  • func (i *Iter) ForwardingRequestList() *stripe.ForwardingRequestList

Functions

func Get

func Get(id string, params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)

Retrieves a ForwardingRequest object.

func New

func New(params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)

Creates a ForwardingRequest object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /forwarding/requests APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)

Retrieves a ForwardingRequest object.

func (Client) List

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

Lists all ForwardingRequest objects.

func (Client) New

func (c Client) New(params *stripe.ForwardingRequestParams) (*stripe.ForwardingRequest, error)

Creates a ForwardingRequest object.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for forwarding requests.

func List

func List(params *stripe.ForwardingRequestListParams) *Iter

Lists all ForwardingRequest objects.

func (*Iter) ForwardingRequest

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

ForwardingRequest returns the forwarding request which the iterator is currently pointing to.

func (*Iter) ForwardingRequestList

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

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