quote

package
v74.22.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 1, 2023 License: MIT Imports: 3 Imported by: 1

Documentation

Overview

Package quote provides the /quotes APIs

Index

Constants

This section is empty.

Variables

This section is empty.

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 DraftQuote 

func DraftQuote(id string, params *stripe.QuoteDraftQuoteParams) (*stripe.Quote, error)

DraftQuote is the method for the `POST /v1/quotes/{quote}/mark_draft` 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 MarkStaleQuote 

func MarkStaleQuote(id string, params *stripe.QuoteMarkStaleQuoteParams) (*stripe.Quote, error)

MarkStaleQuote is the method for the `POST /v1/quotes/{quote}/mark_stale` API.

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 Reestimate 

func Reestimate(id string, params *stripe.QuoteReestimateParams) (*stripe.Quote, error)

Reestimate is the method for the `POST /v1/quotes/{quote}/reestimate` 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) DraftQuote 

func (c Client) DraftQuote(id string, params *stripe.QuoteDraftQuoteParams) (*stripe.Quote, error)

DraftQuote is the method for the `POST /v1/quotes/{quote}/mark_draft` 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) ListLines 

func (c Client) ListLines(listParams *stripe.QuoteListLinesParams) *LineIter

ListLines is the method for the `GET /v1/quotes/{quote}/lines` API.

func (Client) MarkStaleQuote 

func (c Client) MarkStaleQuote(id string, params *stripe.QuoteMarkStaleQuoteParams) (*stripe.Quote, error)

MarkStaleQuote is the method for the `POST /v1/quotes/{quote}/mark_stale` 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) PreviewInvoiceLines 

func (c Client) PreviewInvoiceLines(listParams *stripe.QuotePreviewInvoiceLinesParams) *InvoiceLineItemIter

PreviewInvoiceLines is the method for the `GET /v1/quotes/{quote}/preview_invoices/{preview_invoice}/lines` API.

func (Client) PreviewInvoices 

func (c Client) PreviewInvoices(listParams *stripe.QuotePreviewInvoicesParams) *InvoiceIter

PreviewInvoices is the method for the `GET /v1/quotes/{quote}/preview_invoices` API.

func (Client) PreviewSubscriptionSchedules 

func (c Client) PreviewSubscriptionSchedules(listParams *stripe.QuotePreviewSubscriptionSchedulesParams) *SubscriptionScheduleIter

PreviewSubscriptionSchedules is the method for the `GET /v1/quotes/{quote}/preview_subscription_schedules` API.

func (Client) Reestimate 

func (c Client) Reestimate(id string, params *stripe.QuoteReestimateParams) (*stripe.Quote, error)

Reestimate is the method for the `POST /v1/quotes/{quote}/reestimate` API.

func (Client) Update 

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

Update updates a quote's properties.

type InvoiceIter 

type InvoiceIter struct {
	*stripe.Iter
}

InvoiceIter is an iterator for invoices.

func PreviewInvoices 

func PreviewInvoices(params *stripe.QuotePreviewInvoicesParams) *InvoiceIter

PreviewInvoices is the method for the `GET /v1/quotes/{quote}/preview_invoices` API.

func (*InvoiceIter) Invoice 

func (i *InvoiceIter) Invoice() *stripe.Invoice

Invoice returns the invoice which the iterator is currently pointing to.

func (*InvoiceIter) InvoiceList 

func (i *InvoiceIter) InvoiceList() *stripe.InvoiceList

InvoiceList 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 InvoiceLineItemIter 

type InvoiceLineItemIter struct {
	*stripe.Iter
}

InvoiceLineItemIter is an iterator for invoice line items.

func PreviewInvoiceLines 

func PreviewInvoiceLines(params *stripe.QuotePreviewInvoiceLinesParams) *InvoiceLineItemIter

PreviewInvoiceLines is the method for the `GET /v1/quotes/{quote}/preview_invoices/{preview_invoice}/lines` API.

func (*InvoiceLineItemIter) InvoiceLineItem 

func (i *InvoiceLineItemIter) InvoiceLineItem() *stripe.InvoiceLineItem

InvoiceLineItem returns the invoice line item which the iterator is currently pointing to.

func (*InvoiceLineItemIter) InvoiceLineItemList 

func (i *InvoiceLineItemIter) InvoiceLineItemList() *stripe.InvoiceLineItemList

InvoiceLineItemList 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 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.

type LineIter 

type LineIter struct {
	*stripe.Iter
}

LineIter is an iterator for quote lines.

func ListLines 

func ListLines(params *stripe.QuoteListLinesParams) *LineIter

ListLines is the method for the `GET /v1/quotes/{quote}/lines` API.

func (*LineIter) QuoteLine 

func (i *LineIter) QuoteLine() *stripe.QuoteLine

QuoteLine returns the quote line which the iterator is currently pointing to.

func (*LineIter) QuoteLineList 

func (i *LineIter) QuoteLineList() *stripe.QuoteLineList

QuoteLineList 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 SubscriptionScheduleIter 

type SubscriptionScheduleIter struct {
	*stripe.Iter
}

SubscriptionScheduleIter is an iterator for subscription schedules.

func PreviewSubscriptionSchedules 

func PreviewSubscriptionSchedules(params *stripe.QuotePreviewSubscriptionSchedulesParams) *SubscriptionScheduleIter

PreviewSubscriptionSchedules is the method for the `GET /v1/quotes/{quote}/preview_subscription_schedules` API.

func (*SubscriptionScheduleIter) SubscriptionSchedule 

func (i *SubscriptionScheduleIter) SubscriptionSchedule() *stripe.SubscriptionSchedule

SubscriptionSchedule returns the subscription schedule which the iterator is currently pointing to.

func (*SubscriptionScheduleIter) SubscriptionScheduleList 

func (i *SubscriptionScheduleIter) SubscriptionScheduleList() *stripe.SubscriptionScheduleList

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.