Twilio/sync

@keeb/twilio/syncv2026.08.25.2· 16d agoMODELS

01README

Twilio sync API models

02Release Notes

Updated: document_permission, document, service, sync_list_item, sync_list_permission, sync_list, sync_map_item, sync_map_permission, sync_map, sync_stream

03Models11

@keeb/twilio/sync/documentv2026.08.25.2document.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the document: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
data?	string	no	A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Document expires and is deleted (the Sync Document's time-to-live).
unique_name?	string	no	An application-defined string that uniquely identifies the Sync Document
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a document

fn get(id: string)

Get a document

Argument	Type	Required	Description
id	string	yes	The sid of the document

fn lookup(max_items?: number)

List documents and record each as a data artifact (capped at 200 by default; writes a document_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the document_lookup record reports truncated: true.

fn update()

Update document attributes

fn delete(id: string)

Delete the document

Argument	Type	Required	Description
id	string	yes	The sid of the document

fn sync()

Sync document state from Twilio

Resources

state(infinite)— Document resource state

document_lookup(infinite)— Document lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/document-permissionv2026.08.25.2document_permission.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the document permission: service_sid
document_sid	string	yes	Path scope for the document permission: document_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
read	boolean	yes	Whether the identity can read the Sync Document. Default value is `false`.
write	boolean	yes	Whether the identity can update the Sync Document. Default value is `false`.
manage	boolean	yes	Whether the identity can delete the Sync Document. Default value is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a document permission

Argument	Type	Required	Description
id	string	yes	The identity of the document permission

fn lookup(max_items?: number)

List document permissions and record each as a data artifact (capped at 200 by default; writes a document_permission_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the document_permission_lookup record reports truncated: true.

fn update()

Update document permission attributes

fn delete(id: string)

Delete the document permission

Argument	Type	Required	Description
id	string	yes	The identity of the document permission

fn sync()

Sync document permission state from Twilio

Resources

state(infinite)— Document permission resource state

document_permission_lookup(infinite)— Document permission lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/servicev2026.08.25.2service.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
webhook_url?	string	no	The URL we should call when Sync objects are manipulated.
friendly_name?	string	no	A string that you assign to describe the resource.
reachability_webhooks_enabled?	boolean	no	Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.
acl_enabled?	boolean	no	Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
reachability_debouncing_enabled?	boolean	no	Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.
reachability_debouncing_window?	number	no	The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the `webhook_url` is calle
webhooks_from_rest_enabled?	boolean	no	Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a service

fn get(id: string)

Get a service

Argument	Type	Required	Description
id	string	yes	The sid of the service

fn lookup(max_items?: number)

List services and record each as a data artifact (capped at 200 by default; writes a service_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the service_lookup record reports truncated: true.

fn update()

Update service attributes

fn delete(id: string)

Delete the service

Argument	Type	Required	Description
id	string	yes	The sid of the service

fn sync()

Sync service state from Twilio

Resources

state(infinite)— Service resource state

service_lookup(infinite)— Service lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/stream-messagev2026.08.25.1stream_message.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the stream message: service_sid
stream_sid	string	yes	Path scope for the stream message: stream_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
data	string	yes	A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a stream message

Resources

state(infinite)— Stream message resource state

@keeb/twilio/sync/sync-listv2026.08.25.2sync_list.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync list: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ttl?	number	no	Alias for collection_ttl. If both are provided, this value is ignored.
collection_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted.
unique_name?	string	no	An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sync list

fn get(id: string)

Get a sync list

Argument	Type	Required	Description
id	string	yes	The sid of the sync list

fn lookup(max_items?: number)

List sync lists and record each as a data artifact (capped at 200 by default; writes a sync_list_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_list_lookup record reports truncated: true.

fn update()

Update sync list attributes

fn delete(id: string)

Delete the sync list

Argument	Type	Required	Description
id	string	yes	The sid of the sync list

fn sync()

Sync sync list state from Twilio

Resources

state(infinite)— Sync list resource state

sync_list_lookup(infinite)— Sync list lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-list-itemv2026.08.25.2sync_list_item.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync list item: service_sid
list_sid	string	yes	Path scope for the sync list item: list_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
data	string	yes	A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.
ttl?	number	no	An alias for `item_ttl`. If both parameters are provided, this value is ignored.
item_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted.
collection_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sync list item

fn get(id: string)

Get a sync list item

Argument	Type	Required	Description
id	string	yes	The index of the sync list item

fn lookup(order?: enum, from?: string, bounds?: enum, max_items?: number)

List sync list items and record each as a data artifact (capped at 200 by default; writes a sync_list_item_lookup record with the coverage of the walk)

Argument	Type	Required	Description
order?	enum	no	How to order the List Items returned by their `index` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending.
from?	string	no	The `index` of the first Sync List Item resource to read. See also `bounds`.
bounds?	enum	no	Whether to include the List Item referenced by the `from` parameter. Can be: `inclusive` to include the List Item referenced by the `from` parameter or `exclusive` to start with the next List Item. The default value is `inclusive`.
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_list_item_lookup record reports truncated: true.

fn update()

Update sync list item attributes

fn delete(id: string)

Delete the sync list item

Argument	Type	Required	Description
id	string	yes	The index of the sync list item

fn sync()

Sync sync list item state from Twilio

Resources

state(infinite)— Sync list item resource state

sync_list_item_lookup(infinite)— Sync list item lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-list-permissionv2026.08.25.2sync_list_permission.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync list permission: service_sid
list_sid	string	yes	Path scope for the sync list permission: list_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
read	boolean	yes	Whether the identity can read the Sync List and its Items. Default value is `false`.
write	boolean	yes	Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`.
manage	boolean	yes	Whether the identity can delete the Sync List. Default value is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a sync list permission

Argument	Type	Required	Description
id	string	yes	The identity of the sync list permission

fn lookup(max_items?: number)

List sync list permissions and record each as a data artifact (capped at 200 by default; writes a sync_list_permission_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_list_permission_lookup record reports truncated: true.

fn update()

Update sync list permission attributes

fn delete(id: string)

Delete the sync list permission

Argument	Type	Required	Description
id	string	yes	The identity of the sync list permission

fn sync()

Sync sync list permission state from Twilio

Resources

state(infinite)— Sync list permission resource state

sync_list_permission_lookup(infinite)— Sync list permission lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-mapv2026.08.25.2sync_map.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync map: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ttl?	number	no	An alias for `collection_ttl`. If both parameters are provided, this value is ignored.
collection_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted.
unique_name?	string	no	An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sync map

fn get(id: string)

Get a sync map

Argument	Type	Required	Description
id	string	yes	The sid of the sync map

fn lookup(max_items?: number)

List sync maps and record each as a data artifact (capped at 200 by default; writes a sync_map_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_map_lookup record reports truncated: true.

fn update()

Update sync map attributes

fn delete(id: string)

Delete the sync map

Argument	Type	Required	Description
id	string	yes	The sid of the sync map

fn sync()

Sync sync map state from Twilio

Resources

state(infinite)— Sync map resource state

sync_map_lookup(infinite)— Sync map lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-map-itemv2026.08.25.2sync_map_item.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync map item: service_sid
map_sid	string	yes	Path scope for the sync map item: map_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
data	string	yes	A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
ttl?	number	no	An alias for `item_ttl`. If both parameters are provided, this value is ignored.
item_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
collection_ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
key	string	yes	The unique, user-defined key for the Map Item. Can be up to 320 characters long.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sync map item

fn get(id: string)

Get a sync map item

Argument	Type	Required	Description
id	string	yes	The key of the sync map item

fn lookup(order?: enum, from?: string, bounds?: enum, max_items?: number)

List sync map items and record each as a data artifact (capped at 200 by default; writes a sync_map_item_lookup record with the coverage of the walk)

Argument	Type	Required	Description
order?	enum	no	How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
from?	string	no	The `key` of the first Sync Map Item resource to read. See also `bounds`.
bounds?	enum	no	Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_map_item_lookup record reports truncated: true.

fn update()

Update sync map item attributes

fn delete(id: string)

Delete the sync map item

Argument	Type	Required	Description
id	string	yes	The key of the sync map item

fn sync()

Sync sync map item state from Twilio

Resources

state(infinite)— Sync map item resource state

sync_map_item_lookup(infinite)— Sync map item lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-map-permissionv2026.08.25.2sync_map_permission.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync map permission: service_sid
map_sid	string	yes	Path scope for the sync map permission: map_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
read	boolean	yes	Whether the identity can read the Sync Map and its Items. Default value is `false`.
write	boolean	yes	Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`.
manage	boolean	yes	Whether the identity can delete the Sync Map. Default value is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a sync map permission

Argument	Type	Required	Description
id	string	yes	The identity of the sync map permission

fn lookup(max_items?: number)

List sync map permissions and record each as a data artifact (capped at 200 by default; writes a sync_map_permission_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_map_permission_lookup record reports truncated: true.

fn update()

Update sync map permission attributes

fn delete(id: string)

Delete the sync map permission

Argument	Type	Required	Description
id	string	yes	The identity of the sync map permission

fn sync()

Sync sync map permission state from Twilio

Resources

state(infinite)— Sync map permission resource state

sync_map_permission_lookup(infinite)— Sync map permission lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/sync/sync-streamv2026.08.25.2sync_stream.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the sync stream: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
ttl?	number	no	How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live).
unique_name?	string	no	An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a sync stream

fn get(id: string)

Get a sync stream

Argument	Type	Required	Description
id	string	yes	The sid of the sync stream

fn lookup(max_items?: number)

List sync streams and record each as a data artifact (capped at 200 by default; writes a sync_stream_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the sync_stream_lookup record reports truncated: true.

fn update()

Update sync stream attributes

fn delete(id: string)

Delete the sync stream

Argument	Type	Required	Description
id	string	yes	The sid of the sync stream

fn sync()

Sync sync stream state from Twilio

Resources

state(infinite)— Sync stream resource state

sync_stream_lookup(infinite)— Sync stream lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

53.4 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository0/2missing

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #sync #communications #saas