quotephase

Documentation

Overview

Package quotephase provides the /quote_phases APIs

Index

• func Get(id string, params *stripe.QuotePhaseParams) (*stripe.QuotePhase, error)
• type Client
  • func (c Client) Get(id string, params *stripe.QuotePhaseParams) (*stripe.QuotePhase, error)
  • func (c Client) List(listParams *stripe.QuotePhaseListParams) *Iter
  • func (c Client) ListLineItems(listParams *stripe.QuotePhaseListLineItemsParams) *LineItemIter
• type Iter
  • func List(params *stripe.QuotePhaseListParams) *Iter
  • func (i *Iter) QuotePhase() *stripe.QuotePhase
  • func (i *Iter) QuotePhaseList() *stripe.QuotePhaseList
• type LineItemIter
  • func ListLineItems(params *stripe.QuotePhaseListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) LineItem() *stripe.LineItem
  • func (i *LineItemIter) LineItemList() *stripe.LineItemList

Functions

func Get

func Get(id string, params *stripe.QuotePhaseParams) (*stripe.QuotePhase, error)

Retrieves the quote phase with the given ID.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /quote_phases APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.QuotePhaseParams) (*stripe.QuotePhase, error)

Retrieves the quote phase with the given ID.

func (Client) List

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

Returns a list of quote phases.

func (Client) ListLineItems

func (c Client) ListLineItems(listParams *stripe.QuotePhaseListLineItemsParams) *LineItemIter

When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for quote phases.

func List

func List(params *stripe.QuotePhaseListParams) *Iter

Returns a list of quote phases.

func (*Iter) QuotePhase

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

QuotePhase returns the quote phase which the iterator is currently pointing to.

func (*Iter) QuotePhaseList

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

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

type LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for line items.

func ListLineItems

func ListLineItems(params *stripe.QuotePhaseListLineItemsParams) *LineItemIter

When retrieving a quote phase, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

func (*LineItemIter) LineItem

func (i *LineItemIter) LineItem() *stripe.LineItem

LineItem returns the line item which the iterator is currently pointing to.

func (*LineItemIter) LineItemList

func (i *LineItemIter) LineItemList() *stripe.LineItemList

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