quote

Documentation

Overview

Package quote provides the /quotes APIs

Index

• func Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)
• func Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)
• func FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)
• func Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• func New(params *stripe.QuoteParams) (*stripe.Quote, error)
• func PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)
• func Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• type Client
  • func (c Client) Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)
  • func (c Client) Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)
  • func (c Client) FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)
  • func (c Client) Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
  • func (c Client) List(listParams *stripe.QuoteListParams) *Iter
  • func (c Client) ListComputedUpfrontLineItems(listParams *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter
  • func (c Client) ListLineItems(listParams *stripe.QuoteListLineItemsParams) *LineItemIter
  • func (c Client) New(params *stripe.QuoteParams) (*stripe.Quote, error)
  • func (c Client) PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)
  • func (c Client) Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• type Iter
  • func List(params *stripe.QuoteListParams) *Iter
  • func (i *Iter) Quote() *stripe.Quote
  • func (i *Iter) QuoteList() *stripe.QuoteList
• type LineItemIter
  • func ListComputedUpfrontLineItems(params *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter
  • func ListLineItems(params *stripe.QuoteListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) LineItem() *stripe.LineItem
  • func (i *LineItemIter) LineItemList() *stripe.LineItemList

Functions

func Accept

func Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)

Accept is the method for the `POST /v1/quotes/{quote}/accept` API.

func Cancel

func Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)

Cancel is the method for the `POST /v1/quotes/{quote}/cancel` API.

func FinalizeQuote

func FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)

FinalizeQuote is the method for the `POST /v1/quotes/{quote}/finalize` API.

func Get

func Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Get returns the details of a quote.

func New

func New(params *stripe.QuoteParams) (*stripe.Quote, error)

New creates a new quote.

func PDF

func PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)

PDF is the method for the `GET /v1/quotes/{quote}/pdf` API.

func Update

func Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Update updates a quote's properties.

Types

type Client

type Client struct {
	B          stripe.Backend
	PDFBackend stripe.Backend
	Key        string
}

Client is used to invoke /quotes APIs.

func (Client) Accept

func (c Client) Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)

Accept is the method for the `POST /v1/quotes/{quote}/accept` API.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)

Cancel is the method for the `POST /v1/quotes/{quote}/cancel` API.

func (Client) FinalizeQuote

func (c Client) FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)

FinalizeQuote is the method for the `POST /v1/quotes/{quote}/finalize` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Get returns the details of a quote.

func (Client) List

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

List returns a list of quotes.

func (Client) ListComputedUpfrontLineItems

func (c Client) ListComputedUpfrontLineItems(listParams *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter

ListComputedUpfrontLineItems is the method for the `GET /v1/quotes/{quote}/computed_upfront_line_items` API.

func (Client) ListLineItems

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

ListLineItems is the method for the `GET /v1/quotes/{quote}/line_items` API.

func (Client) New

func (c Client) New(params *stripe.QuoteParams) (*stripe.Quote, error)

New creates a new quote.

func (Client) PDF

func (c Client) PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)

PDF is the method for the `GET /v1/quotes/{quote}/pdf` API.

func (Client) Update

func (c Client) Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Update updates a quote's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for quotes.

func List

func List(params *stripe.QuoteListParams) *Iter

List returns a list of quotes.

func (*Iter) Quote

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

Quote returns the quote which the iterator is currently pointing to.

func (*Iter) QuoteList

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

QuoteList 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 ListComputedUpfrontLineItems

func ListComputedUpfrontLineItems(params *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter

ListComputedUpfrontLineItems is the method for the `GET /v1/quotes/{quote}/computed_upfront_line_items` API.

func ListLineItems

func ListLineItems(params *stripe.QuoteListLineItemsParams) *LineItemIter

ListLineItems is the method for the `GET /v1/quotes/{quote}/line_items` API.

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.