bandwidth-sdk 10.3.0 → 11.0.0.pre.beta.1

data/docs/MediaApi.md

@@ -0,0 +1,307 @@
+# Bandwidth::MediaApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_media**](MediaApi.md#delete_media) | **DELETE** /users/{accountId}/media/{mediaId} | Delete Media |
+| [**get_media**](MediaApi.md#get_media) | **GET** /users/{accountId}/media/{mediaId} | Get Media |
+| [**list_media**](MediaApi.md#list_media) | **GET** /users/{accountId}/media | List Media |
+| [**upload_media**](MediaApi.md#upload_media) | **PUT** /users/{accountId}/media/{mediaId} | Upload Media |
+
+
+## delete_media
+
+> delete_media(account_id, media_id)
+
+Delete Media
+
+Deletes a media file from Bandwidth API server. Make sure you don't have any application scripts still using the media before you delete.  If you accidentally delete a media file you can immediately upload a new file with the same name.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MediaApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
+
+begin
+  # Delete Media
+  api_instance.delete_media(account_id, media_id)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->delete_media: #{e}"
+end
+```
+
+#### Using the delete_media_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_media_with_http_info(account_id, media_id)
+
+```ruby
+begin
+  # Delete Media
+  data, status_code, headers = api_instance.delete_media_with_http_info(account_id, media_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->delete_media_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **media_id** | **String** | Media ID to retrieve. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_media
+
+> File get_media(account_id, media_id)
+
+Get Media
+
+Downloads a media file you previously uploaded.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MediaApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
+
+begin
+  # Get Media
+  result = api_instance.get_media(account_id, media_id)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->get_media: #{e}"
+end
+```
+
+#### Using the get_media_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_media_with_http_info(account_id, media_id)
+
+```ruby
+begin
+  # Get Media
+  data, status_code, headers = api_instance.get_media_with_http_info(account_id, media_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->get_media_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **media_id** | **String** | Media ID to retrieve. |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
+## list_media
+
+> <Array<Media>> list_media(account_id, opts)
+
+List Media
+
+Gets a list of your media files. No query parameters are supported.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MediaApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+opts = {
+  continuation_token: '1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39' # String | Continuation token used to retrieve subsequent media.
+}
+
+begin
+  # List Media
+  result = api_instance.list_media(account_id, opts)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->list_media: #{e}"
+end
+```
+
+#### Using the list_media_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Media>>, Integer, Hash)> list_media_with_http_info(account_id, opts)
+
+```ruby
+begin
+  # List Media
+  data, status_code, headers = api_instance.list_media_with_http_info(account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Media>>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->list_media_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **continuation_token** | **String** | Continuation token used to retrieve subsequent media. | [optional] |
+
+### Return type
+
+[**Array&lt;Media&gt;**](Media.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## upload_media
+
+> upload_media(account_id, media_id, body, opts)
+
+Upload Media
+
+Upload a file. You may add headers to the request in order to provide some control to your media file.  If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten.  A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::MediaApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retrieve.
+body = File.new('/path/to/some/file') # File | 
+opts = {
+  content_type: 'audio/wav', # String | The media type of the entity-body.
+  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.
+}
+
+begin
+  # Upload Media
+  api_instance.upload_media(account_id, media_id, body, opts)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->upload_media: #{e}"
+end
+```
+
+#### Using the upload_media_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> upload_media_with_http_info(account_id, media_id, body, opts)
+
+```ruby
+begin
+  # Upload Media
+  data, status_code, headers = api_instance.upload_media_with_http_info(account_id, media_id, body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MediaApi->upload_media_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **media_id** | **String** | Media ID to retrieve. |  |
+| **body** | **File** |  |  |
+| **content_type** | **String** | The media type of the entity-body. | [optional] |
+| **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] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/ogg, application/pdf, application/rtf, application/zip, application/x-tar, application/xml, application/gzip, application/x-bzip2, application/x-gzip, application/smil, application/javascript, audio/mp4, audio/mpeg, audio/ogg, audio/flac, audio/webm, audio/wav, audio/amr, audio/3gpp, image/bmp, image/gif, image/jpeg, image/pjpeg, image/png, image/svg+xml, image/tiff, image/webp, image/x-icon, text/css, text/csv, text/calendar, text/plain, text/javascript, text/vcard, text/vnd.wap.wml, text/xml, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-ms-wmv
+- **Accept**: application/json
+

data/docs/Message.md

@@ -0,0 +1,40 @@
+# Bandwidth::Message
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the message. | [optional] |
+| **owner** | **String** | The Bandwidth phone number associated with the message. | [optional] |
+| **application_id** | **String** | The application ID associated with the message. | [optional] |
+| **time** | **String** | The datetime stamp of the message in ISO 8601 | [optional] |
+| **segment_count** | **Integer** | The number of segments the original message from the user is broken into before sending over to carrier networks. | [optional] |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  | [optional] |
+| **to** | **Array<String>** | The phone number recipients of the message. | [optional] |
+| **from** | **String** | The phone number the message was sent from. | [optional] |
+| **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] |
+| **text** | **String** | The contents of the message. | [optional] |
+| **tag** | **String** | The custom string set by the user. | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Message.new(
+  id: 1589228074636lm4k2je7j7jklbn2,
+  owner: +15554443333,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  time: 2022-09-14T18:20:16.000Z,
+  segment_count: 2,
+  direction: null,
+  to: ["+15552223333"],
+  from: +15553332222,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png"],
+  text: Hello world,
+  tag: custom tag,
+  priority: null
+)
+```
+

data/docs/MessageDeliveredCallback.md

@@ -0,0 +1,26 @@
+# Bandwidth::MessageDeliveredCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **type** | **String** |  |  |
+| **to** | **String** |  |  |
+| **description** | **String** |  |  |
+| **message** | [**MessageDeliveredCallbackMessage**](MessageDeliveredCallbackMessage.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageDeliveredCallback.new(
+  time: 2016-09-14T18:20:16Z,
+  type: message-delivered,
+  to: +15552223333,
+  description: Message delivered to carrier.,
+  message: null
+)
+```
+

data/docs/MessageDeliveredCallbackMessage.md

@@ -0,0 +1,40 @@
+# Bandwidth::MessageDeliveredCallbackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **owner** | **String** |  |  |
+| **application_id** | **String** |  |  |
+| **time** | **Time** |  |  |
+| **segment_count** | **Integer** |  |  |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
+| **to** | **Array<String>** |  |  |
+| **from** | **String** |  |  |
+| **text** | **String** |  |  |
+| **tag** | **String** |  |  |
+| **media** | **Array<String>** |  | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageDeliveredCallbackMessage.new(
+  id: 1661365814859loidf7mcwd4qacn7,
+  owner: +15553332222,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  time: 2016-09-14T18:20:16Z,
+  segment_count: 1,
+  direction: null,
+  to: ["+15552223333"],
+  from: +15553332222,
+  text: ,
+  tag: custom string,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
+  priority: null
+)
+```
+

data/docs/MessageDirectionEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::MessageDirectionEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageDirectionEnum.new()
+```
+

data/docs/MessageFailedCallback.md

@@ -0,0 +1,28 @@
+# Bandwidth::MessageFailedCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **type** | **String** |  |  |
+| **to** | **String** |  |  |
+| **description** | **String** |  |  |
+| **message** | [**MessageFailedCallbackMessage**](MessageFailedCallbackMessage.md) |  |  |
+| **error_code** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageFailedCallback.new(
+  time: 2016-09-14T18:20:16Z,
+  type: message-failed,
+  to: +15552223333,
+  description: rejected-unallocated-from-number,
+  message: null,
+  error_code: 9902
+)
+```
+

data/docs/MessageFailedCallbackMessage.md

@@ -0,0 +1,40 @@
+# Bandwidth::MessageFailedCallbackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **owner** | **String** |  |  |
+| **application_id** | **String** |  |  |
+| **time** | **Time** |  |  |
+| **segment_count** | **Integer** |  |  |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
+| **to** | **Array<String>** |  |  |
+| **from** | **String** |  |  |
+| **text** | **String** |  |  |
+| **tag** | **String** |  |  |
+| **media** | **Array<String>** |  | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageFailedCallbackMessage.new(
+  id: 1661365814859loidf7mcwd4qacn7,
+  owner: +15553332222,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  time: 2016-09-14T18:20:16Z,
+  segment_count: 1,
+  direction: null,
+  to: ["+15552223333"],
+  from: +15553332222,
+  text: ,
+  tag: custom string,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
+  priority: null
+)
+```
+

data/docs/MessageRequest.md

@@ -0,0 +1,32 @@
+# Bandwidth::MessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **to** | **Array<String>** | The phone number(s) the message should be sent to in E164 format. |  |
+| **from** | **String** | One of your telephone numbers the message should come from in E164 format. |  |
+| **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
+| **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] |
+| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
+| **expiration** | **String** | 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. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageRequest.new(
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  to: ["+15554443333","+15552223333"],
+  from: +15551113333,
+  text: Hello world,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
+  tag: custom string,
+  priority: null,
+  expiration: 2021-02-01T11:29:18-05:00
+)
+```
+

data/docs/MessageSendingCallback.md

@@ -0,0 +1,26 @@
+# Bandwidth::MessageSendingCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **type** | **String** |  |  |
+| **to** | **String** |  |  |
+| **description** | **String** |  |  |
+| **message** | [**MessageSendingCallbackMessage**](MessageSendingCallbackMessage.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageSendingCallback.new(
+  time: 2016-09-14T18:20:16Z,
+  type: message-sending,
+  to: +15552223333,
+  description: Message is sending to carrier,
+  message: null
+)
+```
+

data/docs/MessageSendingCallbackMessage.md

@@ -0,0 +1,40 @@
+# Bandwidth::MessageSendingCallbackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **owner** | **String** |  |  |
+| **application_id** | **String** |  |  |
+| **time** | **Time** |  |  |
+| **segment_count** | **Integer** |  |  |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
+| **to** | **Array<String>** |  |  |
+| **from** | **String** |  |  |
+| **text** | **String** |  |  |
+| **tag** | **String** |  | [optional] |
+| **media** | **Array<String>** |  |  |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageSendingCallbackMessage.new(
+  id: 1661365814859loidf7mcwd4qacn7,
+  owner: +15553332222,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  time: 2016-09-14T18:20:16Z,
+  segment_count: 1,
+  direction: null,
+  to: ["+15552223333"],
+  from: +15553332222,
+  text: ,
+  tag: custom string,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
+  priority: null
+)
+```
+

data/docs/MessageStatusEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::MessageStatusEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageStatusEnum.new()
+```
+

data/docs/MessageTypeEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::MessageTypeEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageTypeEnum.new()
+```
+