Channel methods: create, get, list

Reference for Channel, one group of Channel methods.

Channel.create

Creates a Channel. Verb page.

TypeScript

interface ChannelVerbs {
  create(input: ChannelCreateInput, options?: SB.CallOptions): SB.Call<Channel>
}

Emits Channel.created.

Inputs

Input	Type	Required	Description
`medium`	`string`	required	The platform type, such as `email`, `sms`, or `chat`.
`organization`	Organization		The outside Organization the Channel is shared with; its new Messages open Conversations for that Customer.
`external`	`boolean`		True when people from another Organization post in it, as in a channel two companies share.
`areaCode`	`string`		For an `sms` Channel, the phone area code its number is drawn from, such as `512`.
`number`	`string`		For an `sms` Channel, its phone number in international form, assigned when it is created.

Returns

Output	Type	Required	Description
`channel`	Channel	required	The Channel.

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 channel = await $.Channel.create({ medium: 'email' })

Returns one Channel by id. Verb page.

TypeScript

interface ChannelVerbs {
  get(input: ChannelGetInput, options?: SB.CallOptions): SB.Call<Channel>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Channel.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`channel`	Channel	required	The Channel.

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 channel = await $.Channel.get({ id: 'channel_EQ8se34AOW' })

Returns Channels, newest first, one page at a time. Verb page.

TypeScript

interface ChannelVerbs {
  list(input?: ChannelListInput, options?: SB.CallOptions): SB.ListCall<Channel>
}

Reads only: it emits no Event.

Inputs

Input	Type	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
`channels`	list of Channel	required	One page of Channels.

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 channels = await $.Channel.list({ limit: 20 })