twilio 4.15.0 → 4.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -53,20 +53,20 @@ export declare class FeedbackInstance {
53
53
  protected _version: V2010;
54
54
  constructor(_version: V2010, payload: FeedbackResource, accountSid: string, messageSid: string);
55
55
  /**
56
- * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MessageFeedback resource.
56
+ * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) associated with this MessageFeedback resource.
57
57
  */
58
58
  accountSid: string;
59
59
  /**
60
- * The SID of the Message resource for which the feedback was provided.
60
+ * The SID of the Message resource associated with this MessageFeedback resource.
61
61
  */
62
62
  messageSid: string;
63
63
  outcome: FeedbackOutcome;
64
64
  /**
65
- * The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
65
+ * The date and time in GMT when this MessageFeedback resource was created, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
66
66
  */
67
67
  dateCreated: Date;
68
68
  /**
69
- * The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
69
+ * The date and time in GMT when this MessageFeedback resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
70
70
  */
71
71
  dateUpdated: Date;
72
72
  /**
@@ -8,6 +8,7 @@ import { MediaListInstance } from "./message/media";
8
8
  export type MessageAddressRetention = "retain" | "obfuscate";
9
9
  export type MessageContentRetention = "retain" | "discard";
10
10
  export type MessageDirection = "inbound" | "outbound-api" | "outbound-call" | "outbound-reply";
11
+ export type MessageRiskCheck = "enable" | "disable";
11
12
  export type MessageScheduleType = "fixed";
12
13
  export type MessageStatus = "queued" | "sending" | "sent" | "failed" | "delivered" | "undelivered" | "receiving" | "received" | "accepted" | "scheduled" | "read" | "partially_delivered" | "canceled";
13
14
  export type MessageUpdateStatus = "canceled";
@@ -24,9 +25,9 @@ export interface MessageContextUpdateOptions {
24
25
  * Options to pass to create a MessageInstance
25
26
  */
26
27
  export interface MessageListInstanceCreateOptions {
27
- /** The recipient\\\'s phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/sms/channels#channel-addresses), e.g. `whatsapp:+15552229999`. */
28
+ /** The recipient\\\'s phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`. */
28
29
  to: string;
29
- /** The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api). */
30
+ /** The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_service_sid`, Twilio uses this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource). */
30
31
  statusCallback?: string;
31
32
  /** The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App\\\'s `message_status_callback` URL. */
32
33
  applicationSid?: string;
@@ -58,7 +59,11 @@ export interface MessageListInstanceCreateOptions {
58
59
  sendAsMms?: boolean;
59
60
  /** For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_variables` parameter, the [Template\\\'s default placeholder values](https://www.twilio.com/docs/content/content-api-resources#create-templates) are used. */
60
61
  contentVariables?: string;
61
- /** The sender\\\'s Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/wireless/tutorials/communications-guides/how-to-send-and-receive-text-messages), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/sms/channels#channel-addresses) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belong to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service\\\'s Sender Pool) or you can provide a specific sender from your Sender Pool. */
62
+ /** A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. */
63
+ tags?: string;
64
+ /** */
65
+ riskCheck?: MessageRiskCheck;
66
+ /** The sender\\\'s Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). The value of the `from` parameter must be a sender that is hosted within Twilio and belong to the Account creating the Message. If you are using `messaging_service_sid`, this parameter can be empty (Twilio assigns a `from` value from the Messaging Service\\\'s Sender Pool) or you can provide a specific sender from your Sender Pool. */
62
67
  from?: string;
63
68
  /** The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service\\\'s Sender Pool. You may also provide a `from` parameter if you want to use a specific Sender from the Sender Pool. */
64
69
  messagingServiceSid?: string;
@@ -222,6 +227,7 @@ interface MessageResource {
222
227
  price_unit: string;
223
228
  api_version: string;
224
229
  subresource_uris: Record<string, string>;
230
+ tags: any;
225
231
  }
226
232
  export declare class MessageInstance {
227
233
  protected _version: V2010;
@@ -238,11 +244,11 @@ export declare class MessageInstance {
238
244
  numSegments: string;
239
245
  direction: MessageDirection;
240
246
  /**
241
- * The sender\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/wireless/tutorials/communications-guides/how-to-send-and-receive-text-messages), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/sms/channels#channel-addresses) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.
247
+ * The sender\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www.twilio.com/docs/sms/api/short-code), or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g., `whatsapp:+15554449999`). For incoming messages, this is the number or channel address of the sender. For outgoing messages, this value is a Twilio phone number, alphanumeric sender ID, short code, or channel address from which the message is sent.
242
248
  */
243
249
  from: string;
244
250
  /**
245
- * The recipient\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/sms/channels#channel-addresses) (e.g. `whatsapp:+15552229999`)
251
+ * The recipient\'s phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format) or [channel address](https://www.twilio.com/docs/messaging/channels) (e.g. `whatsapp:+15552229999`)
246
252
  */
247
253
  to: string;
248
254
  /**
@@ -271,7 +277,7 @@ export declare class MessageInstance {
271
277
  numMedia: string;
272
278
  status: MessageStatus;
273
279
  /**
274
- * The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) associated with the Message resource. The value is `null` if a Messaging Service was not used.
280
+ * The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. The value is `null` if a Messaging Service was not used.
275
281
  */
276
282
  messagingServiceSid: string;
277
283
  /**
@@ -302,6 +308,10 @@ export declare class MessageInstance {
302
308
  * A list of related resources identified by their URIs relative to `https://api.twilio.com`
303
309
  */
304
310
  subresourceUris: Record<string, string>;
311
+ /**
312
+ * A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message.
313
+ */
314
+ tags: any;
305
315
  private get _proxy();
306
316
  /**
307
317
  * Remove a MessageInstance
@@ -370,6 +380,7 @@ export declare class MessageInstance {
370
380
  priceUnit: string;
371
381
  apiVersion: string;
372
382
  subresourceUris: Record<string, string>;
383
+ tags: any;
373
384
  };
374
385
  [inspect.custom](_depth: any, options: InspectOptions): string;
375
386
  }
@@ -129,6 +129,7 @@ class MessageInstance {
129
129
  this.priceUnit = payload.price_unit;
130
130
  this.apiVersion = payload.api_version;
131
131
  this.subresourceUris = payload.subresource_uris;
132
+ this.tags = payload.tags;
132
133
  this._solution = { accountSid, sid: sid || this.sid };
133
134
  }
134
135
  get _proxy() {
@@ -199,6 +200,7 @@ class MessageInstance {
199
200
  priceUnit: this.priceUnit,
200
201
  apiVersion: this.apiVersion,
201
202
  subresourceUris: this.subresourceUris,
203
+ tags: this.tags,
202
204
  };
203
205
  }
204
206
  [util_1.inspect.custom](_depth, options) {
@@ -258,6 +260,10 @@ function MessageListInstance(version, accountSid) {
258
260
  data["SendAsMms"] = serialize.bool(params["sendAsMms"]);
259
261
  if (params["contentVariables"] !== undefined)
260
262
  data["ContentVariables"] = params["contentVariables"];
263
+ if (params["tags"] !== undefined)
264
+ data["Tags"] = params["tags"];
265
+ if (params["riskCheck"] !== undefined)
266
+ data["RiskCheck"] = params["riskCheck"];
261
267
  if (params["from"] !== undefined)
262
268
  data["From"] = params["from"];
263
269
  if (params["messagingServiceSid"] !== undefined)
@@ -17,13 +17,13 @@ export interface ParticipantContextRemoveOptions {
17
17
  export interface ParticipantContextUpdateOptions {
18
18
  /** The X-Twilio-Webhook-Enabled HTTP request header */
19
19
  xTwilioWebhookEnabled?: ParticipantWebhookEnabledType;
20
- /** The date that this resource was created. */
20
+ /** The date on which this resource was created. */
21
21
  dateCreated?: Date;
22
- /** The date that this resource was last updated. */
22
+ /** The date on which this resource was last updated. */
23
23
  dateUpdated?: Date;
24
- /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters. */
24
+ /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. */
25
25
  identity?: string;
26
- /** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
26
+ /** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. */
27
27
  attributes?: string;
28
28
  /** The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. */
29
29
  roleSid?: string;
@@ -42,19 +42,19 @@ export interface ParticipantContextUpdateOptions {
42
42
  export interface ParticipantListInstanceCreateOptions {
43
43
  /** The X-Twilio-Webhook-Enabled HTTP request header */
44
44
  xTwilioWebhookEnabled?: ParticipantWebhookEnabledType;
45
- /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters. */
45
+ /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. */
46
46
  identity?: string;
47
- /** The address of the participant\\\'s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the \\\'identity\\\' field). */
47
+ /** The address of the participant\\\'s device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field). */
48
48
  "messagingBinding.address"?: string;
49
- /** The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the \\\'identity\\\' field). */
49
+ /** The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field). */
50
50
  "messagingBinding.proxyAddress"?: string;
51
- /** The date that this resource was created. */
51
+ /** The date on which this resource was created. */
52
52
  dateCreated?: Date;
53
- /** The date that this resource was last updated. */
53
+ /** The date on which this resource was last updated. */
54
54
  dateUpdated?: Date;
55
- /** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \\\"{}\\\" will be returned. */
55
+ /** An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned. */
56
56
  attributes?: string;
57
- /** The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity. */
57
+ /** The address of the Twilio phone number that is used in Group MMS. */
58
58
  "messagingBinding.projectedAddress"?: string;
59
59
  /** The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. */
60
60
  roleSid?: string;
@@ -202,11 +202,11 @@ export declare class ParticipantInstance {
202
202
  */
203
203
  sid: string;
204
204
  /**
205
- * A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.
205
+ * A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
206
206
  */
207
207
  identity: string;
208
208
  /**
209
- * An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.
209
+ * An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set `{}` will be returned.
210
210
  */
211
211
  attributes: string;
212
212
  /**
@@ -218,11 +218,11 @@ export declare class ParticipantInstance {
218
218
  */
219
219
  roleSid: string;
220
220
  /**
221
- * The date that this resource was created.
221
+ * The date on which this resource was created.
222
222
  */
223
223
  dateCreated: Date;
224
224
  /**
225
- * The date that this resource was last updated.
225
+ * The date on which this resource was last updated.
226
226
  */
227
227
  dateUpdated: Date;
228
228
  /**
@@ -95,6 +95,7 @@ interface ConfigurationResource {
95
95
  channel_configs: Array<any>;
96
96
  debugger_integration: any;
97
97
  flex_ui_status_report: any;
98
+ agent_conv_end_methods: any;
98
99
  }
99
100
  export declare class ConfigurationInstance {
100
101
  protected _version: V1;
@@ -278,6 +279,10 @@ export declare class ConfigurationInstance {
278
279
  * Configurable parameters for Flex UI Status report.
279
280
  */
280
281
  flexUiStatusReport: any;
282
+ /**
283
+ * Agent conversation end methods.
284
+ */
285
+ agentConvEndMethods: any;
281
286
  private get _proxy();
282
287
  /**
283
288
  * Fetch a ConfigurationInstance
@@ -347,6 +352,7 @@ export declare class ConfigurationInstance {
347
352
  channelConfigs: any[];
348
353
  debuggerIntegration: any;
349
354
  flexUiStatusReport: any;
355
+ agentConvEndMethods: any;
350
356
  };
351
357
  [inspect.custom](_depth: any, options: InspectOptions): string;
352
358
  }
@@ -107,6 +107,7 @@ class ConfigurationInstance {
107
107
  this.channelConfigs = payload.channel_configs;
108
108
  this.debuggerIntegration = payload.debugger_integration;
109
109
  this.flexUiStatusReport = payload.flex_ui_status_report;
110
+ this.agentConvEndMethods = payload.agent_conv_end_methods;
110
111
  this._solution = {};
111
112
  }
112
113
  get _proxy() {
@@ -169,6 +170,7 @@ class ConfigurationInstance {
169
170
  channelConfigs: this.channelConfigs,
170
171
  debuggerIntegration: this.debuggerIntegration,
171
172
  flexUiStatusReport: this.flexUiStatusReport,
173
+ agentConvEndMethods: this.agentConvEndMethods,
172
174
  };
173
175
  }
174
176
  [util_1.inspect.custom](_depth, options) {
@@ -134,7 +134,7 @@ export declare class ParticipantInstance {
134
134
  */
135
135
  codecs: Array<ParticipantCodec>;
136
136
  /**
137
- * Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#end_reason).
137
+ * Reason the participant left the room. See [the list of possible values here](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#end_reason).
138
138
  */
139
139
  endReason: string;
140
140
  /**
@@ -147,12 +147,12 @@ export declare class ParticipantInstance {
147
147
  errorCodeUrl: string;
148
148
  mediaRegion: ParticipantTwilioRealm;
149
149
  /**
150
- * Object containing information about the participant\'s data from the room. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#properties) for more information.
150
+ * Object containing information about the participant\'s data from the room. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#properties) for more information.
151
151
  */
152
152
  properties: any;
153
153
  edgeLocation: ParticipantEdgeLocation;
154
154
  /**
155
- * Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/video-log-analyzer/video-log-analyzer-api#publisher_info) for more information.
155
+ * Object containing information about the SDK name and version. See [below](https://www.twilio.com/docs/video/troubleshooting/video-log-analyzer-api#publisher_info) for more information.
156
156
  */
157
157
  publisherInfo: any;
158
158
  /**
@@ -17,13 +17,13 @@ export interface MediaProcessorContextUpdateOptions {
17
17
  * Options to pass to create a MediaProcessorInstance
18
18
  */
19
19
  export interface MediaProcessorListInstanceCreateOptions {
20
- /** The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2` */
20
+ /** The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2` */
21
21
  extension: string;
22
- /** The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send. */
22
+ /** The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send. */
23
23
  extensionContext: string;
24
- /** User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about whether you need to provide this. */
24
+ /** User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about whether you need to provide this. */
25
25
  extensionEnvironment?: any;
26
- /** The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details. */
26
+ /** The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details. */
27
27
  statusCallback?: string;
28
28
  /** The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`. */
29
29
  statusCallbackMethod?: string;
@@ -156,11 +156,11 @@ export declare class MediaProcessorInstance {
156
156
  */
157
157
  dateUpdated: Date;
158
158
  /**
159
- * The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2`
159
+ * The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: `video-composer-v2`
160
160
  */
161
161
  extension: string;
162
162
  /**
163
- * The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send.
163
+ * The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.
164
164
  */
165
165
  extensionContext: string;
166
166
  status: MediaProcessorStatus;
@@ -173,7 +173,7 @@ export declare class MediaProcessorInstance {
173
173
  */
174
174
  endedReason: string;
175
175
  /**
176
- * The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details.
176
+ * The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/api/status-callbacks) for details.
177
177
  */
178
178
  statusCallback: string;
179
179
  /**
@@ -172,7 +172,7 @@ export declare class MediaRecordingInstance {
172
172
  mediaSize: number;
173
173
  status: MediaRecordingStatus;
174
174
  /**
175
- * The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
175
+ * The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
176
176
  */
177
177
  statusCallback: string;
178
178
  /**
@@ -21,7 +21,7 @@ export interface PlayerStreamerContextUpdateOptions {
21
21
  export interface PlayerStreamerListInstanceCreateOptions {
22
22
  /** Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`. */
23
23
  video?: boolean;
24
- /** The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details. */
24
+ /** The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details. */
25
25
  statusCallback?: string;
26
26
  /** The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`. */
27
27
  statusCallbackMethod?: string;
@@ -170,7 +170,7 @@ export declare class PlayerStreamerInstance {
170
170
  */
171
171
  url: string;
172
172
  /**
173
- * The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/status-callbacks) for more details.
173
+ * The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
174
174
  */
175
175
  statusCallback: string;
176
176
  /**
@@ -0,0 +1,234 @@
1
+ /// <reference types="node" />
2
+ import { inspect, InspectOptions } from "util";
3
+ import Page, { TwilioResponsePayload } from "../../../../base/Page";
4
+ import Response from "../../../../http/response";
5
+ import V1 from "../../V1";
6
+ /**
7
+ * Options to pass to each
8
+ */
9
+ export interface ChannelSenderListInstanceEachOptions {
10
+ /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
11
+ pageSize?: number;
12
+ /** Function to process each record. If this and a positional callback are passed, this one will be used */
13
+ callback?: (item: ChannelSenderInstance, done: (err?: Error) => void) => void;
14
+ /** Function to be called upon completion of streaming */
15
+ done?: Function;
16
+ /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
17
+ limit?: number;
18
+ }
19
+ /**
20
+ * Options to pass to list
21
+ */
22
+ export interface ChannelSenderListInstanceOptions {
23
+ /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
24
+ pageSize?: number;
25
+ /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
26
+ limit?: number;
27
+ }
28
+ /**
29
+ * Options to pass to page
30
+ */
31
+ export interface ChannelSenderListInstancePageOptions {
32
+ /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
33
+ pageSize?: number;
34
+ /** Page Number, this value is simply for client state */
35
+ pageNumber?: number;
36
+ /** PageToken provided by the API */
37
+ pageToken?: string;
38
+ }
39
+ export interface ChannelSenderContext {
40
+ /**
41
+ * Fetch a ChannelSenderInstance
42
+ *
43
+ * @param callback - Callback to handle processed record
44
+ *
45
+ * @returns Resolves to processed ChannelSenderInstance
46
+ */
47
+ fetch(callback?: (error: Error | null, item?: ChannelSenderInstance) => any): Promise<ChannelSenderInstance>;
48
+ /**
49
+ * Provide a user-friendly representation
50
+ */
51
+ toJSON(): any;
52
+ [inspect.custom](_depth: any, options: InspectOptions): any;
53
+ }
54
+ export interface ChannelSenderContextSolution {
55
+ messagingServiceSid: string;
56
+ sid: string;
57
+ }
58
+ export declare class ChannelSenderContextImpl implements ChannelSenderContext {
59
+ protected _version: V1;
60
+ protected _solution: ChannelSenderContextSolution;
61
+ protected _uri: string;
62
+ constructor(_version: V1, messagingServiceSid: string, sid: string);
63
+ fetch(callback?: (error: Error | null, item?: ChannelSenderInstance) => any): Promise<ChannelSenderInstance>;
64
+ /**
65
+ * Provide a user-friendly representation
66
+ *
67
+ * @returns Object
68
+ */
69
+ toJSON(): ChannelSenderContextSolution;
70
+ [inspect.custom](_depth: any, options: InspectOptions): string;
71
+ }
72
+ interface ChannelSenderPayload extends TwilioResponsePayload {
73
+ senders: ChannelSenderResource[];
74
+ }
75
+ interface ChannelSenderResource {
76
+ account_sid: string;
77
+ messaging_service_sid: string;
78
+ sid: string;
79
+ sender: string;
80
+ sender_type: string;
81
+ country_code: string;
82
+ date_created: Date;
83
+ date_updated: Date;
84
+ url: string;
85
+ }
86
+ export declare class ChannelSenderInstance {
87
+ protected _version: V1;
88
+ protected _solution: ChannelSenderContextSolution;
89
+ protected _context?: ChannelSenderContext;
90
+ constructor(_version: V1, payload: ChannelSenderResource, messagingServiceSid: string, sid?: string);
91
+ /**
92
+ * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ChannelSender resource.
93
+ */
94
+ accountSid: string;
95
+ /**
96
+ * The SID of the [Service](https://www.twilio.com/docs/messaging/services) the resource is associated with.
97
+ */
98
+ messagingServiceSid: string;
99
+ /**
100
+ * The unique string that we created to identify the ChannelSender resource.
101
+ */
102
+ sid: string;
103
+ /**
104
+ * The unique string that identifies the sender e.g whatsapp:+123456XXXX.
105
+ */
106
+ sender: string;
107
+ /**
108
+ * A string value that identifies the sender type e.g WhatsApp, Messenger.
109
+ */
110
+ senderType: string;
111
+ /**
112
+ * The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number.
113
+ */
114
+ countryCode: string;
115
+ /**
116
+ * The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
117
+ */
118
+ dateCreated: Date;
119
+ /**
120
+ * The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
121
+ */
122
+ dateUpdated: Date;
123
+ url: string;
124
+ private get _proxy();
125
+ /**
126
+ * Fetch a ChannelSenderInstance
127
+ *
128
+ * @param callback - Callback to handle processed record
129
+ *
130
+ * @returns Resolves to processed ChannelSenderInstance
131
+ */
132
+ fetch(callback?: (error: Error | null, item?: ChannelSenderInstance) => any): Promise<ChannelSenderInstance>;
133
+ /**
134
+ * Provide a user-friendly representation
135
+ *
136
+ * @returns Object
137
+ */
138
+ toJSON(): {
139
+ accountSid: string;
140
+ messagingServiceSid: string;
141
+ sid: string;
142
+ sender: string;
143
+ senderType: string;
144
+ countryCode: string;
145
+ dateCreated: Date;
146
+ dateUpdated: Date;
147
+ url: string;
148
+ };
149
+ [inspect.custom](_depth: any, options: InspectOptions): string;
150
+ }
151
+ export interface ChannelSenderSolution {
152
+ messagingServiceSid: string;
153
+ }
154
+ export interface ChannelSenderListInstance {
155
+ _version: V1;
156
+ _solution: ChannelSenderSolution;
157
+ _uri: string;
158
+ (sid: string): ChannelSenderContext;
159
+ get(sid: string): ChannelSenderContext;
160
+ /**
161
+ * Streams ChannelSenderInstance records from the API.
162
+ *
163
+ * This operation lazily loads records as efficiently as possible until the limit
164
+ * is reached.
165
+ *
166
+ * The results are passed into the callback function, so this operation is memory
167
+ * efficient.
168
+ *
169
+ * If a function is passed as the first argument, it will be used as the callback
170
+ * function.
171
+ *
172
+ * @param { ChannelSenderListInstanceEachOptions } [params] - Options for request
173
+ * @param { function } [callback] - Function to process each record
174
+ */
175
+ each(callback?: (item: ChannelSenderInstance, done: (err?: Error) => void) => void): void;
176
+ each(params: ChannelSenderListInstanceEachOptions, callback?: (item: ChannelSenderInstance, done: (err?: Error) => void) => void): void;
177
+ /**
178
+ * Retrieve a single target page of ChannelSenderInstance records from the API.
179
+ *
180
+ * The request is executed immediately.
181
+ *
182
+ * @param { string } [targetUrl] - API-generated URL for the requested results page
183
+ * @param { function } [callback] - Callback to handle list of records
184
+ */
185
+ getPage(targetUrl: string, callback?: (error: Error | null, items: ChannelSenderPage) => any): Promise<ChannelSenderPage>;
186
+ /**
187
+ * Lists ChannelSenderInstance records from the API as a list.
188
+ *
189
+ * If a function is passed as the first argument, it will be used as the callback
190
+ * function.
191
+ *
192
+ * @param { ChannelSenderListInstanceOptions } [params] - Options for request
193
+ * @param { function } [callback] - Callback to handle list of records
194
+ */
195
+ list(callback?: (error: Error | null, items: ChannelSenderInstance[]) => any): Promise<ChannelSenderInstance[]>;
196
+ list(params: ChannelSenderListInstanceOptions, callback?: (error: Error | null, items: ChannelSenderInstance[]) => any): Promise<ChannelSenderInstance[]>;
197
+ /**
198
+ * Retrieve a single page of ChannelSenderInstance records from the API.
199
+ *
200
+ * The request is executed immediately.
201
+ *
202
+ * If a function is passed as the first argument, it will be used as the callback
203
+ * function.
204
+ *
205
+ * @param { ChannelSenderListInstancePageOptions } [params] - Options for request
206
+ * @param { function } [callback] - Callback to handle list of records
207
+ */
208
+ page(callback?: (error: Error | null, items: ChannelSenderPage) => any): Promise<ChannelSenderPage>;
209
+ page(params: ChannelSenderListInstancePageOptions, callback?: (error: Error | null, items: ChannelSenderPage) => any): Promise<ChannelSenderPage>;
210
+ /**
211
+ * Provide a user-friendly representation
212
+ */
213
+ toJSON(): any;
214
+ [inspect.custom](_depth: any, options: InspectOptions): any;
215
+ }
216
+ export declare function ChannelSenderListInstance(version: V1, messagingServiceSid: string): ChannelSenderListInstance;
217
+ export declare class ChannelSenderPage extends Page<V1, ChannelSenderPayload, ChannelSenderResource, ChannelSenderInstance> {
218
+ /**
219
+ * Initialize the ChannelSenderPage
220
+ *
221
+ * @param version - Version of the resource
222
+ * @param response - Response from the API
223
+ * @param solution - Path solution
224
+ */
225
+ constructor(version: V1, response: Response<string>, solution: ChannelSenderSolution);
226
+ /**
227
+ * Build an instance of ChannelSenderInstance
228
+ *
229
+ * @param payload - Payload response from the API
230
+ */
231
+ getInstance(payload: ChannelSenderResource): ChannelSenderInstance;
232
+ [inspect.custom](depth: any, options: InspectOptions): string;
233
+ }
234
+ export {};