Skip to content

Commit 87d46b9

Browse files
committed
fix spaces in docs
1 parent 48ef48c commit 87d46b9

File tree

5 files changed

+38
-38
lines changed

5 files changed

+38
-38
lines changed

bandwidth.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1357,7 +1357,7 @@ components:
13571357
example: default
13581358
messageStatusEnum:
13591359
type: string
1360-
description: >
1360+
description: >-
13611361
The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED
13621362
DELIVERED ACCEPTED UNDELIVERED.
13631363
enum:
@@ -1590,7 +1590,7 @@ components:
15901590
example: 2024-12-02T20:15:57.278Z
15911591
segmentCount:
15921592
type: integer
1593-
description: >
1593+
description: >-
15941594
The number of segments the original message from the user is broken
15951595
into before sending over to carrier networks.
15961596
example: 2
@@ -1613,7 +1613,7 @@ components:
16131613
type: array
16141614
items:
16151615
type: string
1616-
description: >
1616+
description: >-
16171617
The list of media URLs sent in the message. Including a `filename`
16181618
field in the `Content-Disposition` header of the media linked with a
16191619
URL will set the displayed file name. This is a best practice to
@@ -1660,7 +1660,7 @@ components:
16601660
type: string
16611661
from:
16621662
type: string
1663-
description: >
1663+
description: >-
16641664
Either an alphanumeric sender ID or the sender's Bandwidth phone
16651665
number in E.164 format, which must be hosted within Bandwidth and
16661666
linked to the account that is generating the message.
@@ -1681,7 +1681,7 @@ components:
16811681
type: string
16821682
format: uri
16831683
maxLength: 4096
1684-
description: >
1684+
description: >-
16851685
A list of URLs to include as media attachments as part of the
16861686
message.
16871687
@@ -1700,7 +1700,7 @@ components:
17001700
expiration:
17011701
type: string
17021702
format: date-time
1703-
description: >
1703+
description: >-
17041704
A string with the date/time value that the message will
17051705
automatically expire by. This must be a valid RFC-3339 value, e.g.,
17061706
2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a
@@ -4891,7 +4891,7 @@ components:
48914891
name: Cache-Control
48924892
style: simple
48934893
explode: false
4894-
description: >
4894+
description: >-
48954895
General-header field is used to specify directives that MUST be obeyed
48964896
by all caching mechanisms along the request/response chain.
48974897
example: no-cache
@@ -4909,7 +4909,7 @@ components:
49094909
in: query
49104910
name: messageId
49114911
required: false
4912-
description: >
4912+
description: >-
49134913
The ID of the message to search for. Special characters need to be
49144914
encoded using URL encoding. Message IDs could come in different formats,
49154915
e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and
@@ -4922,7 +4922,7 @@ components:
49224922
in: query
49234923
name: sourceTn
49244924
required: false
4925-
description: >
4925+
description: >-
49264926
The phone number that sent the message. Accepted values are: a single
49274927
full phone number a comma separated list of full phone numbers (maximum
49284928
of 10) or a single partial phone number (minimum of 5 characters e.g.
@@ -4934,7 +4934,7 @@ components:
49344934
in: query
49354935
name: destinationTn
49364936
required: false
4937-
description: >
4937+
description: >-
49384938
The phone number that received the message. Accepted values are: a
49394939
single full phone number a comma separated list of full phone numbers
49404940
(maximum of 10) or a single partial phone number (minimum of 5
@@ -4946,7 +4946,7 @@ components:
49464946
in: query
49474947
name: messageStatus
49484948
required: false
4949-
description: >
4949+
description: >-
49504950
The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED
49514951
DELIVERED ACCEPTED UNDELIVERED.
49524952
schema:
@@ -4962,7 +4962,7 @@ components:
49624962
in: query
49634963
name: carrierName
49644964
required: false
4965-
description: >
4965+
description: >-
49664966
The name of the carrier used for this message. Possible values include
49674967
but are not limited to Verizon and TMobile. Special characters need to
49684968
be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
@@ -4988,7 +4988,7 @@ components:
49884988
in: query
49894989
name: fromDateTime
49904990
required: false
4991-
description: >
4991+
description: >-
49924992
The start of the date range to search in ISO 8601 format. Uses the
49934993
message receive time. The date range to search in is currently 14 days.
49944994
example: 2022-09-14T18:20:16.000Z
@@ -4998,7 +4998,7 @@ components:
49984998
in: query
49994999
name: toDateTime
50005000
required: false
5001-
description: >
5001+
description: >-
50025002
The end of the date range to search in ISO 8601 format. Uses the message
50035003
receive time. The date range to search in is currently 14 days.
50045004
example: 2022-09-14T18:20:16.000Z
@@ -5034,7 +5034,7 @@ components:
50345034
in: query
50355035
name: limit
50365036
required: false
5037-
description: >
5037+
description: >-
50385038
The maximum records requested in search result. Default 100. The sum of
50395039
limit and after cannot be more than 10000.
50405040
schema:

docs/MediaApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retri
253253
body = File.new('/path/to/some/file') # File |
254254
opts = {
255255
content_type: 'audio/wav', # String | The media type of the entity-body.
256-
cache_control: 'no-cache' # String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
256+
cache_control: 'no-cache' # String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
257257
}
258258

259259
begin
@@ -290,7 +290,7 @@ end
290290
| **media_id** | **String** | Media ID to retrieve. | |
291291
| **body** | **File** | | |
292292
| **content_type** | **String** | The media type of the entity-body. | [optional] |
293-
| **cache_control** | **String** | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
293+
| **cache_control** | **String** | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
294294

295295
### Return type
296296

docs/Message.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
| **owner** | **String** | The Bandwidth phone number associated with the message. | [optional] |
99
| **application_id** | **String** | The application ID associated with the message. | [optional] |
1010
| **time** | **Time** | The datetime stamp of the message in ISO 8601 | [optional] |
11-
| **segment_count** | **Integer** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] |
11+
| **segment_count** | **Integer** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] |
1212
| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] |
1313
| **to** | **Array<String>** | The phone number recipients of the message. | [optional] |
1414
| **from** | **String** | The phone number the message was sent from. | [optional] |
15-
| **media** | **Array<String>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] |
15+
| **media** | **Array<String>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] |
1616
| **text** | **String** | The contents of the message. | [optional] |
1717
| **tag** | **String** | The custom string set by the user. | [optional] |
1818
| **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |

docs/MessageRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
| ---- | ---- | ----------- | ----- |
77
| **application_id** | **String** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. | |
88
| **to** | **Array<String>** | The phone number(s) the message should be sent to in E164 format. | |
9-
| **from** | **String** | Either an alphanumeric sender ID or the sender'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 &. Alphanumeric Sender IDs must contain at least one letter. | |
9+
| **from** | **String** | Either an alphanumeric sender ID or the sender'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 &. Alphanumeric Sender IDs must contain at least one letter. | |
1010
| **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
11-
| **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
11+
| **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
1212
| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
1313
| **priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] |
14-
| **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. | [optional] |
14+
| **expiration** | **Time** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. | [optional] |
1515

1616
## Example
1717

docs/MessagesApi.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -103,20 +103,20 @@ end
103103
api_instance = Bandwidth::MessagesApi.new
104104
account_id = '9900000' # String | Your Bandwidth Account ID.
105105
opts = {
106-
message_id: '9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # String | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
107-
source_tn: '%2B15554443333', # String | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
108-
destination_tn: '%2B15554443333', # String | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
109-
message_status: Bandwidth::MessageStatusEnum::RECEIVED, # MessageStatusEnum | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
106+
message_id: '9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # String | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.
107+
source_tn: '%2B15554443333', # String | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
108+
destination_tn: '%2B15554443333', # String | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919').
109+
message_status: Bandwidth::MessageStatusEnum::RECEIVED, # MessageStatusEnum | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
110110
message_direction: Bandwidth::ListMessageDirectionEnum::INBOUND, # ListMessageDirectionEnum | The direction of the message. One of INBOUND OUTBOUND.
111-
carrier_name: 'Verizon', # String | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
111+
carrier_name: 'Verizon', # String | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T).
112112
message_type: Bandwidth::MessageTypeEnum::SMS, # MessageTypeEnum | The type of message. Either sms or mms.
113113
error_code: 9902, # Integer | The error code of the message.
114-
from_date_time: '2022-09-14T18:20:16.000Z', # String | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
115-
to_date_time: '2022-09-14T18:20:16.000Z', # String | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
114+
from_date_time: '2022-09-14T18:20:16.000Z', # String | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
115+
to_date_time: '2022-09-14T18:20:16.000Z', # String | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.
116116
campaign_id: 'CJEUMDK', # String | The campaign ID of the message.
117117
sort: 'sourceTn:desc', # String | The field and direction to sort by combined with a colon. Direction is either asc or desc.
118118
page_token: 'gdEewhcJLQRB5', # String | A base64 encoded value used for pagination of results.
119-
limit: 50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
119+
limit: 50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
120120
limit_total_count: true # Boolean | When set to true, the response's totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.
121121
}
122122

@@ -152,20 +152,20 @@ end
152152
| Name | Type | Description | Notes |
153153
| ---- | ---- | ----------- | ----- |
154154
| **account_id** | **String** | Your Bandwidth Account ID. | |
155-
| **message_id** | **String** | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | [optional] |
156-
| **source_tn** | **String** | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
157-
| **destination_tn** | **String** | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
158-
| **message_status** | [**MessageStatusEnum**](.md) | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. | [optional] |
155+
| **message_id** | **String** | The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter. | [optional] |
156+
| **source_tn** | **String** | The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
157+
| **destination_tn** | **String** | The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). | [optional] |
158+
| **message_status** | [**MessageStatusEnum**](.md) | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. | [optional] |
159159
| **message_direction** | [**ListMessageDirectionEnum**](.md) | The direction of the message. One of INBOUND OUTBOUND. | [optional] |
160-
| **carrier_name** | **String** | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T). | [optional] |
160+
| **carrier_name** | **String** | The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&T should be passed as AT%26T). | [optional] |
161161
| **message_type** | [**MessageTypeEnum**](.md) | The type of message. Either sms or mms. | [optional] |
162162
| **error_code** | **Integer** | The error code of the message. | [optional] |
163-
| **from_date_time** | **String** | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
164-
| **to_date_time** | **String** | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
163+
| **from_date_time** | **String** | The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
164+
| **to_date_time** | **String** | The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. | [optional] |
165165
| **campaign_id** | **String** | The campaign ID of the message. | [optional] |
166166
| **sort** | **String** | The field and direction to sort by combined with a colon. Direction is either asc or desc. | [optional] |
167167
| **page_token** | **String** | A base64 encoded value used for pagination of results. | [optional] |
168-
| **limit** | **Integer** | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | [optional] |
168+
| **limit** | **Integer** | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. | [optional] |
169169
| **limit_total_count** | **Boolean** | When set to true, the response's totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results. | [optional] |
170170

171171
### Return type

0 commit comments

Comments
 (0)