Video methods: create, get, list

Reference for Video, one group of Video methods.

Video.create

Creates a Video. Verb page.

TypeScript

interface VideoVerbs {
  create(input: VideoCreateInput, options?: SB.CallOptions): SB.Call<Video>
}

Emits Video.created.

Inputs

Input	Type	Required	Description
`timeline`	`json`	required	The ordered scenes on a fixed grid, the only timing truth for picture, voice and captions.
`brand`	Brand	required	The Brand whose voice, palette and type the Video uses.
`offer`	Offer		The Offer the Video presents, when it presents one.

Returns

Output	Type	Required	Description
`video`	Video	required	The Video.

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 video = await $.Video.create({ timeline: {}, brand: 'brand_PluVQrB1HF' })

Returns one Video by id. Verb page.

TypeScript

interface VideoVerbs {
  get(input: VideoGetInput, options?: SB.CallOptions): SB.Call<Video>
}

Reads only: it emits no Event.

Inputs

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

Returns

Output	Type	Required	Description
`video`	Video	required	The Video.

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 video = await $.Video.get({ id: 'video_xVlGG2TxBA' })

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

TypeScript

interface VideoVerbs {
  list(input?: VideoListInput, options?: SB.CallOptions): SB.ListCall<Video>
}

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
`videos`	list of Video	required	One page of Videos.

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