Skip to content

Commit 15a29a4

Browse files
committed
formatting
1 parent db3d62f commit 15a29a4

18 files changed

Lines changed: 32 additions & 32 deletions

bandwidth.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2161,7 +2161,7 @@ components:
21612161
type: string
21622162
description: >-
21632163
The name of the Authorized Message Provider (AMP) that handled this
2164-
message.
2164+
message.
21652165
21662166
In the US, this is the carrier that the message was sent to.
21672167
@@ -2248,7 +2248,7 @@ components:
22482248
description: >-
22492249
Either an alphanumeric sender ID or the sender's Bandwidth phone
22502250
number in E.164 format, which must be hosted within Bandwidth and
2251-
linked to the account that is generating the message.
2251+
linked to the account that is generating the message.
22522252
22532253
Alphanumeric Sender IDs can contain up to 11 characters, upper-case
22542254
letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -,
@@ -2571,8 +2571,8 @@ components:
25712571
Specifies how the URL should be opened on a mobile device.
25722572
25732573
- `BROWSER` Opens the URL in the device's default browser. If
2574-
application is not set or the device doesnt support WebView, this
2575-
option is used by default.
2574+
application is not set or the device doesn't support WebView, this
2575+
option is used by default.
25762576
25772577
- `WEBVIEW` Opens the URL in an in-app WebView.
25782578
enum:
@@ -2585,7 +2585,7 @@ components:
25852585
Defines the layout of the WebView on a mobile device. It must be defined
25862586
when application is set to `WEBVIEW`
25872587
2588-
- `FULL` WebView takes the full screen.
2588+
- `FULL` WebView takes the full screen.
25892589
25902590
- `HALF` WebView takes half of the screen.
25912591
@@ -2987,7 +2987,7 @@ components:
29872987
to:
29882988
type: string
29892989
description: >
2990-
The destination phone number the message was sent to.
2990+
The destination phone number the message was sent to.
29912991
29922992
For inbound callbacks, this is the Bandwidth number or alphanumeric
29932993
identifier that received the message.
@@ -3038,7 +3038,7 @@ components:
30383038
client to a Bandwidth number.
30393039
30403040
- `request-location-response` indicates a response to a location request
3041-
sent by the Bandwidth user's client after receiving an RBM message.
3041+
sent by the Bandwidth user's client after receiving an RBM message.
30423042
30433043
- `suggestion-response` indicates a response to a suggestion sent by the
30443044
Bandwidth user's client after receiving an RBM message.
@@ -3277,7 +3277,7 @@ components:
32773277
nullable: true
32783278
type: string
32793279
description: >-
3280-
The caller display name to use when the call is created.
3280+
The caller display name to use when the call is created.
32813281
32823282
May not exceed 256 characters nor contain control characters such as
32833283
new lines.
@@ -4214,7 +4214,7 @@ components:
42144214
format: double
42154215
description: >-
42164216
When an answering machine is detected, the amount of silence (in
4217-
seconds) before assuming the message has finished playing.
4217+
seconds) before assuming the message has finished playing.
42184218
42194219
If not provided it will default to the speechEndThreshold value.
42204220
example: 5
@@ -9627,12 +9627,12 @@ components:
96279627
required: true
96289628
description: >-
96299629
<p>This Inbound Message Webhook is an envelope containing either a
9630-
received (MO) message to your
9630+
received (MO) message to your
96319631
96329632
message-enabled Bandwidth telephone number or a multichannel
9633-
client's response to a suggestion response
9633+
client's response to a suggestion response
96349634
9635-
or location request.
9635+
or location request.
96369636
96379637
<p>The payload type will be one of <code>message-received</code>,
96389638
<code>suggestion-response</code>, or

docs/Callback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
99
**time** | **string** | | [default to undefined]
1010
**eventTime** | **string** | Represents the time at which the message was read, for &#x60;message-read&#x60; callbacks. | [optional] [default to undefined]
1111
**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
12-
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
12+
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
1313
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
1414
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
1515
**errorCode** | **number** | Optional error code, applicable only when type is &#x60;message-failed&#x60;. | [optional] [default to undefined]
16-
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
16+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
1717

1818
## Example
1919

docs/CreateCall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**to** | **string** | The destination to call (must be an E.164 formatted number (e.g. &#x60;+15555551212&#x60;) or a SIP URI (e.g. &#x60;sip:user@server.example&#x60;)). | [default to undefined]
99
**from** | **string** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like &#x60;+15555551212&#x60;) even if &#x60;privacy&#x60; is set to true. | [default to undefined]
1010
**privacy** | **boolean** | Hide the calling number. The &#x60;displayName&#x60; field can be used to customize the displayed name. | [optional] [default to undefined]
11-
**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If &#x60;privacy&#x60; is true, only the following values are valid: &#x60;Restricted&#x60;, &#x60;Anonymous&#x60;, &#x60;Private&#x60;, or &#x60;Unavailable&#x60;. | [optional] [default to undefined]
11+
**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If &#x60;privacy&#x60; is true, only the following values are valid: &#x60;Restricted&#x60;, &#x60;Anonymous&#x60;, &#x60;Private&#x60;, or &#x60;Unavailable&#x60;. | [optional] [default to undefined]
1212
**uui** | **string** | A comma-separated list of \&#39;User-To-User\&#39; headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \&#39;encoding\&#39; parameter as described in &lt;a href&#x3D;\&#39;https://tools.ietf.org/html/rfc7433\&#39;&gt;RFC 7433&lt;/a&gt;. Only \&#39;jwt\&#39;, \&#39;base64\&#39; and \&#39;hex\&#39; encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] [default to undefined]
1313
**applicationId** | **string** | The id of the application associated with the &#x60;from&#x60; number. | [default to undefined]
1414
**answerUrl** | **string** | The full URL to send the &lt;a href&#x3D;\&#39;/docs/voice/webhooks/answer\&#39;&gt;Answer&lt;/a&gt; event to when the called party answers. This endpoint should return the first &lt;a href&#x3D;\&#39;/docs/voice/bxml\&#39;&gt;BXML document&lt;/a&gt; to be executed in the call. Must use &#x60;https&#x60; if specifying &#x60;username&#x60; and &#x60;password&#x60;. | [default to undefined]

docs/InboundCallback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**time** | **string** | | [default to undefined]
1010
**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
11-
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
11+
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
1212
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
1313
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
14-
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
14+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
1515

1616
## Example
1717

docs/InboundCallbackTypeEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# InboundCallbackTypeEnum
22

3-
The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
3+
The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
44

55
## Enum
66

docs/MachineDetectionConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**silenceTimeout** | **number** | If no speech is detected in this period, a callback with a \&#39;silence\&#39; result is sent. | [optional] [default to 10]
1212
**speechThreshold** | **number** | When speech has ended and a result couldn\&#39;t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \&#39;answering-machine\&#39;. If the length of speech detected is below this threshold, the result will be \&#39;human\&#39;. | [optional] [default to 10]
1313
**speechEndThreshold** | **number** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional] [default to 5]
14-
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional] [default to undefined]
14+
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional] [default to undefined]
1515
**delayResult** | **boolean** | If set to \&#39;true\&#39; and if an answering machine is detected, the \&#39;answering-machine\&#39; callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \&#39;detectionTimeout\&#39; is exceeded. If false, the \&#39;answering-machine\&#39; result is sent immediately. | [optional] [default to false]
1616
**callbackUrl** | **string** | The URL to send the \&#39;machineDetectionComplete\&#39; webhook when the detection is completed. Only for \&#39;async\&#39; mode. | [optional] [default to undefined]
1717
**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional] [default to undefined]

docs/MessageRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [default to undefined]
99
**to** | **Set&lt;string&gt;** | The phone number(s) the message should be sent to in E164 format. | [default to undefined]
10-
**from** | **string** | Either an alphanumeric sender ID or the sender\&#39;s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &amp;. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined]
10+
**from** | **string** | Either an alphanumeric sender ID or the sender\&#39;s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &amp;. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined]
1111
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined]
1212
**media** | **Array&lt;string&gt;** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] [default to undefined]
1313
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]

docs/RbmOpenUrlEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RbmOpenUrlEnum
22

3-
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesnt support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
3+
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn\'t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
44

55
## Enum
66

docs/RbmWebViewEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RbmWebViewEnum
22

3-
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
3+
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
44

55
## Enum
66

docs/StatusCallback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
1414
**message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | [default to undefined]
1515
**errorCode** | **number** | Optional error code, applicable only when type is &#x60;message-failed&#x60;. | [optional] [default to undefined]
16-
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
16+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
1717

1818
## Example
1919

0 commit comments

Comments
 (0)