Deal methods: advance, assign, lose

Reference for Deal, one group of Deal methods.

Deal.advance

Advance moves a Deal to its next stage once every field that stage requires is filled. Verb page.

TypeScript

interface DealVerbs {
  advance(input: DealAdvanceInput, options?: SB.CallOptions): SB.Call<Deal>
}

Inputs

Input	Type	Required	Description
`deal`	Deal	required	The Deal.
`stage`	`string`		The target stage; omitted, the next one.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The Deal in its new stage.

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 deal = await $.Deal.advance({ deal: 'deal_NgACZ6DcII' })

Assign gives a Deal one owner Worker, who carries its next step until it is won or lost. Verb page.

TypeScript

interface DealVerbs {
  assign(input: DealAssignInput, options?: SB.CallOptions): SB.Call<Deal>
}

Inputs

Input	Type	Required	Description
`deal`	Deal	required	The Deal.
`owner`	Worker		The Worker to own it; omitted, the routing Policy picks.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The Deal, with its owner.

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 deal = await $.Deal.assign({ deal: 'deal_NgACZ6DcII' })

Lose closes a Deal as lost and records the reason the buyer gave. Verb page.

TypeScript

interface DealVerbs {
  lose(input: DealLoseInput, options?: SB.CallOptions): SB.Call<Deal>
}

Inputs

Input	Type	Required	Description
`deal`	Deal	required	The open Deal.
`reason`	`text`	required	Why the buyer passed.

Returns

Output	Type	Required	Description
`deal`	Deal	required	The lost Deal.

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.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const deal = await $.Deal.lose({ deal: 'deal_NgACZ6DcII', reason: 'Example reason' })