Twilio/numbers

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

01README

Twilio numbers API models

02Release Notes

Updated: application, authorization_document, bundle_copy, bundle, dependent_hosted_number_order, end_user_type, end_user, evaluation, hosted_number_order, item_assignment, porting_all_port_ins, regulation, signing_request_configuration, supporting_document_type, supporting_document, webhook

03Models31

@keeb/twilio/numbers/applicationv2026.08.25.2application.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)
friendly_name	string	yes	The friendly name for the short code application.
iso_country	string	yes	The ISO country code.
business_information	object	yes	Business information associated with the application.
setup	object	yes
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 application

fn get(id: string)

Get a application

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

fn lookup(account_sid?: string, iso_country?: string, status?: string, friendly_name?: string, sid?: string, max_items?: number)

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

Argument	Type	Required	Description
account_sid?	string	no	The Account SID to filter by.
iso_country?	string	no	The ISO country to filter by.
status?	string	no	The application status to filter by.
friendly_name?	string	no	The friendly name to filter by.
sid?	string	no	The application SID to filter by.
max_items?	number	no	Stop after this many results (default 200, ceiling 50000). 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 application_lookup record reports truncated: true.

fn sync()

Sync application state from Twilio

Resources

state(infinite)— Application resource state

application_lookup(infinite)— Application lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/authorization-documentv2026.08.25.2authorization_document.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)
address_sid	string	yes	A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
email	string	yes	Email that this AuthorizationDocument will be sent to for signing.
contact_phone_number	string	yes	The contact phone number of the person authorized to sign the Authorization Document.
hosted_number_order_sids	array	yes	A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
contact_title?	string	no	The title of the person authorized to sign the Authorization Document for this phone number.
cc_emails?	array	no	Email recipients who will be informed when an Authorization Document has been sent and signed.
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 authorization document

fn get(id: string)

Get a authorization document

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

fn lookup(email?: string, status?: enum, max_items?: number)

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

Argument	Type	Required	Description
email?	string	no	Email that this AuthorizationDocument will be sent to for signing.
status?	enum	no	Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more inf
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 authorization_document_lookup record reports truncated: true.

fn delete(id: string)

Delete the authorization document

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

fn sync()

Sync authorization document state from Twilio

Resources

state(infinite)— Authorization document resource state

authorization_document_lookup(infinite)— Authorization document lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/bulk-eligibilityv2026.08.25.1bulk_eligibility.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)
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 bulk eligibility

fn get(id: string)

Get a bulk eligibility

Argument	Type	Required	Description
id	string	yes	The request_id of the bulk eligibility

fn sync()

Sync bulk eligibility state from Twilio

Resources

state(infinite)— Bulk eligibility resource state

@keeb/twilio/numbers/bulk-hosted-number-orderv2026.08.25.1bulk_hosted_number_order.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)
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 bulk hosted number order

fn get(id: string)

Get a bulk hosted number order

Argument	Type	Required	Description
id	string	yes	The sid of the bulk hosted number order

fn sync()

Sync bulk hosted number order state from Twilio

Resources

state(infinite)— Bulk hosted number order resource state

@keeb/twilio/numbers/bundlev2026.08.25.2bundle.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)
status?	enum	no	The verification status of the Bundle resource.
status_callback?	string	no	The URL we call to inform your application of status changes.
friendly_name	string	yes	The string that you assigned to describe the resource.
email	string	yes	The email address that will receive updates when the Bundle resource changes status.
regulation_sid?	string	no	The unique string of a regulation that is associated to the Bundle resource.
iso_country?	string	no	The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
end_user_type?	enum	no
number_type?	string	no	The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
is_test?	boolean	no	Indicates that Bundle is a Test Bundle and will be Auto-Rejected
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 bundle

fn get(id: string)

Get a bundle

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

fn lookup(status?: enum, bundle_sids?: string, friendly_name?: string, regulation_sid?: string, iso_country?: string, number_type?: string, end_user_type?: enum, has_valid_until_date?: boolean, sort_by?: enum, sort_direction?: enum, valid_until_date?: string, valid_until_date_before?: string, valid_until_date_after?: string, max_items?: number)

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

Argument	Type	Required	Description
status?	enum	no	The verification status of the Bundle resource. Please refer to [Bundle Statuses](https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.
bundle_sids?	string	no	A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match `^BU[0-9a-fA-F]{32}$`.
friendly_name?	string	no	The string that you assigned to describe the resource. The column can contain 255 variable characters.
regulation_sid?	string	no	The unique string of a [Regulation resource](https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.
iso_country?	string	no	The 2-digit [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle's phone number country ownership request.
number_type?	string	no	The type of phone number of the Bundle's ownership request. Can be `local`, `mobile`, `national`, or `toll-free`.
end_user_type?	enum	no	The end user type of the regulation of the Bundle. Can be `business` or `individual`.
has_valid_until_date?	boolean	no	Indicates that the Bundle is a valid Bundle until a specified expiration date.
sort_by?	enum	no	Can be `valid-until` or `date-updated`. Defaults to `date-created`.
sort_direction?	enum	no	Default is `DESC`. Can be `ASC` or `DESC`.
valid_until_date?	string	no	Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
valid_until_date_before?	string	no	Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
valid_until_date_after?	string	no	Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 bundle_lookup record reports truncated: true.

fn update()

Update bundle attributes

fn delete(id: string)

Delete the bundle

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

fn sync()

Sync bundle state from Twilio

Resources

state(infinite)— Bundle resource state

bundle_lookup(infinite)— Bundle lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/bundle-clonev2026.08.25.1bundle_clone.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.
bundle_sid	string	yes	Path scope for the bundle clone: bundle_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
target_account_sid	string	yes	The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned.
move_to_draft?	boolean	no	If set to true, the cloned bundle will be in the DRAFT state, else it will be twilio-approved
friendly_name?	string	no	The string that you assigned to describe the cloned bundle.
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 update()

Update bundle clone attributes

Resources

state(infinite)— Bundle clone resource state

@keeb/twilio/numbers/bundle-copyv2026.08.25.2bundle_copy.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.
bundle_sid	string	yes	Path scope for the bundle copy: bundle_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name?	string	no	The string that you assigned to describe the copied bundle.
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 bundle copy

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 bundle_copy_lookup record reports truncated: true.

Resources

state(infinite)— Bundle copy resource state

bundle_copy_lookup(infinite)— Bundle copy lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/dependent-hosted-number-orderv2026.08.25.2dependent_hosted_number_order.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.
signing_document_sid	string	yes	Path scope for the dependent hosted number order: signing_document_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 lookup(status?: enum, phone_number?: string, incoming_phone_number_sid?: string, friendly_name?: string, max_items?: number)

List dependent hosted number orders and record each as a data artifact (capped at 200 by default; writes a dependent_hosted_number_order_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more inf
phone_number?	string	no	An E164 formatted phone number hosted by this HostedNumberOrder.
incoming_phone_number_sid?	string	no	A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
friendly_name?	string	no	A human readable description of this resource, up to 128 characters.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 dependent_hosted_number_order_lookup record reports truncated: true.

Resources

state(infinite)— Dependent hosted number order resource state

dependent_hosted_number_order_lookup(infinite)— Dependent hosted number order lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/eligibilityv2026.08.25.1eligibility.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)
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 eligibility

Resources

state(infinite)— Eligibility resource state

@keeb/twilio/numbers/embedded-sessionv2026.08.25.1embedded_session.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.
bundle_sid	string	yes	Path scope for the embedded session: bundle_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
theme_set_id?	string	no	Theme ID for the Compliance Embeddable UI. Overrides the theme set during registration creation.
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 embedded session

Resources

state(infinite)— Embedded session resource state

@keeb/twilio/numbers/end-userv2026.08.25.2end_user.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)
friendly_name	string	yes	The string that you assigned to describe the resource.
attributes?	string	no	The set of parameters that are the attributes of the End User resource which are derived End User Types.
type	enum	yes	The type of end user of the Bundle resource - can be `individual` or `business`.
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 end user

fn get(id: string)

Get a end user

Argument	Type	Required	Description
id	string	yes	The sid of the end user

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 end_user_lookup record reports truncated: true.

fn update()

Update end user attributes

fn delete(id: string)

Delete the end user

Argument	Type	Required	Description
id	string	yes	The sid of the end user

fn sync()

Sync end user state from Twilio

Resources

state(infinite)— End user resource state

end_user_lookup(infinite)— End user lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/end-user-typev2026.08.25.2end_user_type.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	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 end user type

Argument	Type	Required	Description
id	string	yes	The sid of the end user type

fn lookup(max_items?: number)

List end user types and record each as a data artifact (capped at 200 by default; writes a end_user_type_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 end_user_type_lookup record reports truncated: true.

fn sync()

Sync end user type state from Twilio

Resources

state(infinite)— End user type resource state

end_user_type_lookup(infinite)— End user type lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/evaluationv2026.08.25.2evaluation.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.
bundle_sid	string	yes	Path scope for the evaluation: bundle_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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 evaluation

fn get(id: string)

Get a evaluation

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

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 evaluation_lookup record reports truncated: true.

fn sync()

Sync evaluation state from Twilio

Resources

state(infinite)— Evaluation resource state

evaluation_lookup(infinite)— Evaluation lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/hosted-number-orderv2026.08.25.2hosted_number_order.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)
status	enum	yes
verification_call_delay?	number	no	The number of seconds to wait before initiating the ownership verification call. Can be a value between 0 and 60, inclusive.
verification_call_extension?	string	no	The numerical extension to dial when making the ownership verification call.
phone_number	string	yes	The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
contact_phone_number	string	yes	The contact phone number of the person authorized to sign the Authorization Document.
address_sid	string	yes	Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
email	string	yes	Optional. Email of the owner of this phone number that is being hosted.
friendly_name?	string	no	A 128 character string that is a human readable text that describes this resource.
cc_emails?	array	no	Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
sms_url?	string	no	The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
sms_method?	enum	no	The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
sms_fallback_url?	string	no	A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
sms_capability?	boolean	no	Used to specify that the SMS capability will be hosted on Twilio's platform.
sms_fallback_method?	enum	no	The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
status_callback_url?	string	no	Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
status_callback_method?	enum	no	Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
sms_application_sid?	string	no	Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
contact_title?	string	no	The title of the person authorized to sign the Authorization Document for this phone number.
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 hosted number order

fn get(id: string)

Get a hosted number order

Argument	Type	Required	Description
id	string	yes	The sid of the hosted number order

fn lookup(status?: enum, sms_capability?: boolean, phone_number?: string, incoming_phone_number_sid?: string, friendly_name?: string, max_items?: number)

List hosted number orders and record each as a data artifact (capped at 200 by default; writes a hosted_number_order_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.
sms_capability?	boolean	no	Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.
phone_number?	string	no	An E164 formatted phone number hosted by this HostedNumberOrder.
incoming_phone_number_sid?	string	no	A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
friendly_name?	string	no	A human readable description of this resource, up to 128 characters.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 hosted_number_order_lookup record reports truncated: true.

fn update()

Update hosted number order attributes

fn delete(id: string)

Delete the hosted number order

Argument	Type	Required	Description
id	string	yes	The sid of the hosted number order

fn sync()

Sync hosted number order state from Twilio

Resources

state(infinite)— Hosted number order resource state

hosted_number_order_lookup(infinite)— Hosted number order lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/hosted-number-order-v3v2026.08.25.1hosted_number_order_v3.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)
phone_number	string	yes	The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format
sms_capability	boolean	yes	Used to specify that the SMS capability will be hosted on Twilio's platform.
friendly_name?	string	no	A 64 character string that is a human readable text that describes this resource.
unique_name?	string	no	Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
cc_emails?	array	no	Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.
sms_url?	string	no	The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.
sms_method?	enum	no	The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
sms_fallback_url?	string	no	A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.
sms_fallback_method?	enum	no	The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.
status_callback_url?	string	no	Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.
status_callback_method?	enum	no	Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.
sms_application_sid?	string	no	Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.
address_sid?	string	no	Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
email?	string	no	Optional. Email of the owner of this phone number that is being hosted.
verification_type?	enum	no	Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.
verification_document_sid?	string	no	Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.
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 hosted number order v3

Resources

state(infinite)— Hosted number order v3 resource state

@keeb/twilio/numbers/item-assignmentv2026.08.25.2item_assignment.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.
bundle_sid	string	yes	Path scope for the item assignment: bundle_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
object_sid	string	yes	The SID of an object bag that holds information of the different items.
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 item assignment

fn get(id: string)

Get a item assignment

Argument	Type	Required	Description
id	string	yes	The sid of the item assignment

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 item_assignment_lookup record reports truncated: true.

fn delete(id: string)

Delete the item assignment

Argument	Type	Required	Description
id	string	yes	The sid of the item assignment

fn sync()

Sync item assignment state from Twilio

Resources

state(infinite)— Item assignment resource state

item_assignment_lookup(infinite)— Item assignment lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/porting-all-port-insv2026.08.25.2porting_all_port_ins.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	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 lookup(token?: string, size?: number, port_in_request_sid?: string, port_in_request_status?: string, created_before?: string, created_after?: string, max_items?: number)

List porting all port inss and record each as a data artifact (capped at 200 by default; writes a porting_all_port_ins_lookup record with the coverage of the walk)

Argument	Type	Required	Description
token?	string	no	Page start token, if null then it will start from the beginning
size?	number	no	Number of items per page
port_in_request_sid?	string	no	Filter by Port in request SID, supports multiple values separated by comma
port_in_request_status?	string	no	Filter by Port In request status
created_before?	string	no	Find all created before a certain date
created_after?	string	no	Find all created after a certain date
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 porting_all_port_ins_lookup record reports truncated: true.

Resources

state(infinite)— Porting all port ins resource state

porting_all_port_ins_lookup(infinite)— Porting all port ins lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/porting-port-in-phone-numberv2026.08.25.1porting_port_in_phone_number.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.
port_in_request_sid	string	yes	Path scope for the porting port in phone number: port_in_request_sid
phone_number_sid	string	yes	Path scope for the porting port in phone number: phone_number_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 porting port in phone number

Argument	Type	Required	Description
id	string	yes	The sid of the porting port in phone number

fn delete(id: string)

Delete the porting port in phone number

Argument	Type	Required	Description
id	string	yes	The sid of the porting port in phone number

fn sync()

Sync porting port in phone number state from Twilio

Resources

state(infinite)— Porting port in phone number resource state

@keeb/twilio/numbers/porting-port-insv2026.08.25.1porting_port_ins.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)
documents	array	yes	List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.
phone_numbers?	array	no	List of phone numbers to be ported. Maximum of 1,000 phone numbers per request.
losing_carrier_information	object	yes	Details regarding the customer's information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier's data as closely as possible to ensure the port is accepted.
notification_emails?	array	no	Additional emails to send a copy of the signed LOA to.
target_port_in_date?	string	no	Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for
target_port_in_time_range_start?	string	no	The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
target_port_in_time_range_end?	string	no	The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier
bundle_sid?	string	no	The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.
portability_advance_carrier?	string	no	A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.
auto_cancel_approval_numbers?	string	no	Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.
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 porting port ins

fn get(id: string)

Get a porting port ins

Argument	Type	Required	Description
id	string	yes	The sid of the porting port ins

fn delete(id: string)

Delete the porting port ins

Argument	Type	Required	Description
id	string	yes	The sid of the porting port ins

fn sync()

Sync porting port ins state from Twilio

Resources

state(infinite)— Porting port ins resource state

@keeb/twilio/numbers/porting-portabilityv2026.08.25.1porting_portability.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.
phone_number	string	yes	Path scope for the porting portability: phone_number
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 porting portability

Argument	Type	Required	Description
id	string	yes	The phone_number of the porting portability

fn sync()

Sync porting portability state from Twilio

Resources

state(infinite)— Porting portability resource state

@keeb/twilio/numbers/regulationv2026.08.25.2regulation.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	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 regulation

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

fn lookup(end_user_type?: enum, iso_country?: string, number_type?: string, include_constraints?: boolean, max_items?: number)

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

Argument	Type	Required	Description
end_user_type?	enum	no	The type of End User the regulation requires - can be `individual` or `business`.
iso_country?	string	no	The ISO country code of the phone number's country.
number_type?	string	no	The type of phone number that the regulatory requiremnt is restricting.
include_constraints?	boolean	no	A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 regulation_lookup record reports truncated: true.

fn sync()

Sync regulation state from Twilio

Resources

state(infinite)— Regulation resource state

regulation_lookup(infinite)— Regulation lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/replace-itemv2026.08.25.1replace_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.
bundle_sid	string	yes	Path scope for the replace item: bundle_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
from_bundle_sid	string	yes	The source bundle sid to copy the item assignments from.
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 replace item

Resources

state(infinite)— Replace item resource state

@keeb/twilio/numbers/sender-id-registrationv2026.08.25.1sender_id_registration.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)
regulation_id	string	yes	The regulation for this registration.
regulation_version	number	yes	The regulation version.
friendly_name	string	yes	Human-readable name for the registration.
status_notification_email?	string	no	Email address for registration status notifications.
status_callback_url?	string	no	The URL of this resource.
comments?	string	no	Additional comments about the registration.
theme_set_id?	string	no	Theme ID for the Compliance Embeddable UI.
data	record	yes	Registration data organized by section (alphanumericSender, business, useCase, authorizedRepresentative, officer, businessAddress).
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 sender id registration

Resources

state(infinite)— Sender id registration resource state

@keeb/twilio/numbers/signing-request-configurationv2026.08.25.2signing_request_configuration.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)
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 signing request configuration

fn lookup(country?: string, product?: string, max_items?: number)

List signing request configurations and record each as a data artifact (capped at 200 by default; writes a signing_request_configuration_lookup record with the coverage of the walk)

Argument	Type	Required	Description
country?	string	no	The country ISO code to apply this configuration, this is an optional field, Example: US, MX
product?	string	no	The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 signing_request_configuration_lookup record reports truncated: true.

Resources

state(infinite)— Signing request configuration resource state

signing_request_configuration_lookup(infinite)— Signing request configuration lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/sms-verificationv2026.08.25.1sms_verification.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)
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 sms verification

Resources

state(infinite)— Sms verification resource state

@keeb/twilio/numbers/sms-verification-checkv2026.08.25.1sms_verification_check.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)
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 sms verification check

Resources

state(infinite)— Sms verification check resource state

@keeb/twilio/numbers/supporting-documentv2026.08.25.2supporting_document.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)
friendly_name	string	yes	The string that you assigned to describe the resource.
attributes?	string	no	The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.
type	string	yes	The type of the Supporting 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 supporting document

fn get(id: string)

Get a supporting document

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

fn lookup(max_items?: number)

List supporting documents and record each as a data artifact (capped at 200 by default; writes a supporting_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 1000000). 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 supporting_document_lookup record reports truncated: true.

fn update()

Update supporting document attributes

fn delete(id: string)

Delete the supporting document

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

fn sync()

Sync supporting document state from Twilio

Resources

state(infinite)— Supporting document resource state

supporting_document_lookup(infinite)— Supporting document lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/supporting-document-typev2026.08.25.2supporting_document_type.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	no	Instance name for this resource (used as the unique identifier in the factory pattern)
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 supporting document type

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

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 supporting_document_type_lookup record reports truncated: true.

fn sync()

Sync supporting document type state from Twilio

Resources

state(infinite)— Supporting document type resource state

supporting_document_type_lookup(infinite)— Supporting document type lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/numbers/voice-verificationv2026.08.25.1voice_verification.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)
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 voice verification

Resources

state(infinite)— Voice verification resource state

@keeb/twilio/numbers/voice-verification-checkv2026.08.25.1voice_verification_check.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)
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 voice verification check

Resources

state(infinite)— Voice verification check resource state

@keeb/twilio/numbers/webhookv2026.08.25.2webhook.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)
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 webhook

fn lookup(max_items?: number)

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

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). 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 webhook_lookup record reports truncated: true.

fn delete(id: string)

Delete the webhook

Argument	Type	Required	Description
id	string	yes	The webhook_type of the webhook

Resources

state(infinite)— Webhook resource state

webhook_lookup(infinite)— Webhook lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

106.5 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 #numbers #communications #saas