Company methods: create, get, list
The Company Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Company, one group of Company methods.
Company.create
Creates a Company. Verb page.
interface CompanyVerbs {
create(input: CompanyCreateInput, options?: SB.CallOptions): SB.Call<Company>
}Emits Company.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
name | string | required | The legal or personal name. |
legalName | string | required | The registered name. |
jurisdiction | string | required | Where it is incorporated. |
studio | Studio | A Studio controls the holding Companies that are owner of record for its Startups. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
company | Company | required | The Company. |
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
import { $ } from 'startup-builder'
const company = await $.Company.create({ name: 'Leaseline', legalName: 'Leaseline Inc.', jurisdiction: 'US-DE' })Company.get
Returns one Company by id. Verb page.
interface CompanyVerbs {
get(input: CompanyGetInput, options?: SB.CallOptions): SB.Call<Company>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Company. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
company | Company | required | The Company. |
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
import { $ } from 'startup-builder'
const company = await $.Company.get({ id: 'company_28zYNZEno0' })Company.list
Returns Companies, newest first, one page at a time. Verb page.
interface CompanyVerbs {
list(input?: CompanyListInput, options?: SB.CallOptions): SB.ListCall<Company>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
companies | list of Company | required | One page of Companies. |
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
import { $ } from 'startup-builder'
const companies = await $.Company.list({ limit: 20 })