card

Documentation

Overview

Package card provides the /gift_cards/cards APIs

Index

• func Get(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
• func New(params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
• func Update(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
• func Validate(params *stripe.GiftCardsCardValidateParams) (*stripe.GiftCardsCard, error)
• type Client
  • func (c Client) Get(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
  • func (c Client) List(listParams *stripe.GiftCardsCardListParams) *Iter
  • func (c Client) New(params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
  • func (c Client) Update(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)
  • func (c Client) Validate(params *stripe.GiftCardsCardValidateParams) (*stripe.GiftCardsCard, error)
• type Iter
  • func List(params *stripe.GiftCardsCardListParams) *Iter
  • func (i *Iter) GiftCardsCard() *stripe.GiftCardsCard
  • func (i *Iter) GiftCardsCardList() *stripe.GiftCardsCardList

Functions

func Get

func Get(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Retrieve a gift card by id

func New

func New(params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Creates a new gift card object.

func Update

func Update(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Update a gift card

func Validate

func Validate(params *stripe.GiftCardsCardValidateParams) (*stripe.GiftCardsCard, error)

Validates a gift card code, returning the matching gift card object if it exists.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /gift_cards/cards APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Retrieve a gift card by id

func (Client) List

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

List gift cards for an account

func (Client) New

func (c Client) New(params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Creates a new gift card object.

func (Client) Update

func (c Client) Update(id string, params *stripe.GiftCardsCardParams) (*stripe.GiftCardsCard, error)

Update a gift card

func (Client) Validate

func (c Client) Validate(params *stripe.GiftCardsCardValidateParams) (*stripe.GiftCardsCard, error)

Validates a gift card code, returning the matching gift card object if it exists.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for gift cards cards.

func List

func List(params *stripe.GiftCardsCardListParams) *Iter

List gift cards for an account

func (*Iter) GiftCardsCard

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

GiftCardsCard returns the gift cards card which the iterator is currently pointing to.

func (*Iter) GiftCardsCardList

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

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