event

Documentation

Overview

Package event provides the /events APIs

Index

• func Get(id string) (*stripe.Event, error)
• type Client
  • func (c Client) Get(id string) (*stripe.Event, error)
  • func (c Client) List(params *stripe.EventListParams) *Iter
• type Iter
  • func List(params *stripe.EventListParams) *Iter
  • func (i *Iter) Meta() *stripe.ListMeta
  • func (i *Iter) Next() (*stripe.Event, error)
  • func (i *Iter) Stop() bool

Functions

func Get

func Get(id string) (*stripe.Event, error)

Get returns the details of an event For more details see https://stripe.com/docs/api#retrieve_event.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /events APIs.

func (Client) Get

func (c Client) Get(id string) (*stripe.Event, error)

func (Client) List

func (c Client) List(params *stripe.EventListParams) *Iter

type Iter

type Iter struct {
	Iter *stripe.Iter
}

Iter is a iterator for list responses.

func List

func List(params *stripe.EventListParams) *Iter

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

func (*Iter) Meta

func (i *Iter) Meta() *stripe.ListMeta

Meta returns the list metadata.

func (*Iter) Next

func (i *Iter) Next() (*stripe.Event, error)

Next returns the next value in the list.

func (*Iter) Stop

func (i *Iter) Stop() bool

Stop returns true if there are no more iterations to be performed.