Quote methods: update, delete

Reference for Quote, one group of Quote methods.

Quote.update

Changes the given properties of a Quote. Verb page.

TypeScript

interface QuoteVerbs {
  update(input: QuoteUpdateInput, options?: SB.CallOptions): SB.Call<Quote>
}

Emits Quote.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Quote.
`total`	`money`		The quoted total.
`validUntil`	`date`		The last day it may be accepted.
`lines`	`json`		One line per Offer: quantity, list Price, discount percent, net amount, term, and start, one line per ramp year.
`concessions`	`string[]`		Concessions granted, each from the Startup’s fixed concession list, such as a 60-day termination for convenience.
`paymentTerms`	`json`		The `collection`, `terms` and `purchaseOrder` every Invoice from the accepted Quote carries.

Returns

Output	Type	Required	Description
`quote`	Quote	required	The Quote.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const quote = await $.Quote.update({ id: 'qt_GZnH5OK100', total: { amount: 29, currency: 'USD' } })

Deletes a Quote: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface QuoteVerbs {
  delete(input: QuoteDeleteInput, options?: SB.CallOptions): SB.Call<Quote>
}

Emits Quote.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Quote.

Returns

Output	Type	Required	Description
`quote`	Quote	required	The Quote.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const quote = await $.Quote.delete({ id: 'qt_GZnH5OK100' })