TwilioClientRegistration
Defined in: lib/utils/twilio.interface.ts:78
A named client registered with TwilioModule.registerClient().
Every field except name is optional: anything omitted is inherited from
the options given to forRoot(). A field set to undefined also inherits.
Only a defined value overrides. Supply full credentials when no forRoot()
is registered.
Example
Section titled “Example”// Inherits region and edge from forRoot; overrides the credentials.TwilioModule.registerClient({ name: 'billing', accountSid: process.env.TWILIO_BILLING_ACCOUNT_SID, authToken: process.env.TWILIO_BILLING_AUTH_TOKEN,});Extends
Section titled “Extends”Partial<TwilioModuleOptions>
Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
accountSid? |
string |
Twilio Account SID. Required. | TwilioClientOpts.accountSid |
lib/utils/twilio.interface.ts:42 |
apiKey? |
string |
Twilio API Key SID. Used in place of authToken for certain operations. | TwilioClientOpts.apiKey |
lib/utils/twilio.interface.ts:52 |
apiSecret? |
string |
Twilio API Key Secret. Required if apiKey is provided. | TwilioClientOpts.apiSecret |
lib/utils/twilio.interface.ts:57 |
authToken? |
string |
Twilio Auth Token. Required when using auth-token authentication. | TwilioClientOpts.authToken |
lib/utils/twilio.interface.ts:47 |
autoRetry? |
boolean |
- | TwilioClientOpts.autoRetry |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:17 |
ca? |
string | Buffer<ArrayBufferLike> |
- | TwilioClientOpts.ca |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:31 |
edge? |
string |
- | TwilioClientOpts.edge |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:12 |
env? |
ProcessEnv |
- | TwilioClientOpts.env |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:11 |
httpClient? |
RequestClient |
- | TwilioClientOpts.httpClient |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:9 |
keepAlive? |
boolean |
- | TwilioClientOpts.keepAlive |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:25 |
keepAliveMsecs? |
number |
- | TwilioClientOpts.keepAliveMsecs |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:26 |
lazyLoading? |
boolean |
- | TwilioClientOpts.lazyLoading |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:14 |
logLevel? |
string |
- | TwilioClientOpts.logLevel |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:15 |
maxFreeSockets? |
number |
- | TwilioClientOpts.maxFreeSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:29 |
maxRetries? |
number |
- | TwilioClientOpts.maxRetries |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:19 |
maxRetryDelay? |
number |
- | TwilioClientOpts.maxRetryDelay |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:18 |
maxSockets? |
number |
- | TwilioClientOpts.maxSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:27 |
maxTotalSockets? |
number |
- | TwilioClientOpts.maxTotalSockets |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:28 |
name |
string |
Identifies the client. Inject it with @InjectTwilio(name), or resolve its token with getTwilioClientToken(name). Matched case-insensitively. |
- | lib/utils/twilio.interface.ts:83 |
region? |
string |
- | TwilioClientOpts.region |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:13 |
scheduling? |
"fifo" | "lifo" |
- | TwilioClientOpts.scheduling |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:30 |
timeout? |
number |
https.Agent options | TwilioClientOpts.timeout |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:24 |
userAgentExtensions? |
string[] |
- | TwilioClientOpts.userAgentExtensions |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:16 |
validationClient? |
ValidationClientOptions |
- | TwilioClientOpts.validationClient |
node_modules/.pnpm/twilio@6.1.1_debug@4.4.3_supports-color@7.2.0__supports-color@7.2.0/node_modules/twilio/lib/base/BaseTwilio.d.ts:20 |
webhookAuthToken? |
string |
Default auth token for webhook validation. Can be overridden per-route. | TwilioModuleOptions.webhookAuthToken |
lib/utils/twilio.interface.ts:129 |
webhookUrl? |
string |
Default public URL for webhook validation (when behind a proxy). | TwilioModuleOptions.webhookUrl |
lib/utils/twilio.interface.ts:134 |