bandwidth-sdk 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ac6cedf8f46960bdc51af5b2c1cb7084f303ba4b757373538186ca932997ba
-  data.tar.gz: 1bac73b1c867feec6a21b3b985bbe15b3a163c3319538313453928e39a66806a
+  metadata.gz: 9b03c113c9fff659a7bbc0d7c174b59a0f0bd3ac6e5ae83801bd7f412cf1bcf9
+  data.tar.gz: 2dcf6a85620d519d62ba6192adcfa241ad8dfc70cf3e1f2fae5102c188640e69
 SHA512:
-  metadata.gz: 7883069c08c868dcddd095be404121878adacd67dce7adbab68cc3e2af858d7534f2bd16410b64786a496372f0d1f81b6ffe456ea0b4c6434b4594cb997b0fb3
-  data.tar.gz: f32337f52e22bad320f06fa789cfcd8618a4973fea80155ac626cef225c9c063cc2d27c7927354e14ed4f50b6185d139c303b0690d325f6d8dcb4c9514fbb484
+  metadata.gz: 94e42d80d90c7211fb629ba2f68d68685185a6f9bd9cdb85049742c78757bd7402021ab30da2ed7d71eeb1269d87406ad466c0a4bab799510988bff664f7d973
+  data.tar.gz: 38163d3789373e3efe9180c37204136cd1047442828b63a7543a1e84814e9266b60fb5e0151a4c2027b2e90356a2d4aa003b9cfa9271a2c2b5e1874e14d53131

data/README.md

@@ -1,70 +1,85 @@
-# Getting Started with bandwidth
-
-Bandwidth's set of APIs
-
-## Install the Package
-
-Install the gem from the command line:
-
-```ruby
-gem install bandwidth-sdk -v 2.2.0
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'bandwidth-sdk', '2.2.0'
-```
-
-For additional gem details, see the [RubyGems page for the bandwidth-sdk gem](https://rubygems.org/gems/bandwidth-sdk/versions/2.2.0).
-
-## Initialize the API Client
-
-The following parameters are configurable for the API Client.
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| `messaging_basic_auth_user_name` | `String` | The username to use with basic authentication |
-| `messaging_basic_auth_password` | `String` | The password to use with basic authentication |
-| `voice_basic_auth_user_name` | `String` | The username to use with basic authentication |
-| `voice_basic_auth_password` | `String` | The password to use with basic authentication |
-| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
-| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
-| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
-| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
-| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 1** |
-
-The API client can be initialized as following.
-
-```ruby
-client = Bandwidth::Client.new(
-  messaging_basic_auth_user_name: 'MessagingBasicAuthUserName',
-  messaging_basic_auth_password: 'MessagingBasicAuthPassword',
-  voice_basic_auth_user_name: 'VoiceBasicAuthUserName',
-  voice_basic_auth_password: 'VoiceBasicAuthPassword',
-  environment: Environment::PRODUCTION,
-)
-```
-
-API calls return an `ApiResponse` object that includes the following fields:
-
-| Field | Description |
-|  --- | --- |
-| `status_code` | Status code of the HTTP response |
-| `reason_phrase` | Reason phrase of the HTTP response |
-| `headers` | Headers of the HTTP response as a Hash |
-| `raw_body` | The body of the HTTP response as a String |
-| `request` | HTTP request info |
-| `errors` | Errors, if they exist |
-| `data` | The deserialized body of the HTTP response |
-
-## Authorization
-
-This API does not require authentication.
-
-## API Reference
-
-### List of APIs
-
-*
-
+# Bandwidth Ruby SDK
+  
+Bandwidth's API docs can be found at https://dev.bandwidth.com
+
+Ruby specific docs can be found at https://dev.bandwidth.com/sdks/ruby.html
+
+## Download & Install
+
+```
+gem install bandwidth-sdk
+```
+
+## Initialize Bandwidth Client
+
+```ruby
+require 'bandwidth'
+
+include Bandwidth
+include Bandwidth::Voice
+include Bandwidth::Messaging
+
+bandwidth_client = Bandwidth::Client.new(
+    voice_basic_auth_user_name: 'username',
+    voice_basic_auth_password: 'password',
+    messaging_basic_auth_user_name: 'token',
+    messaging_basic_auth_password: 'secret',
+)
+```
+
+## Create Phone Call
+
+```ruby
+voice_client = bandwidth_client.voice_client.client
+
+account_id = '1'
+body = ApiCreateCallRequest.new
+body.from = '+16666666666'
+body.to = '+17777777777'
+body.answer_url = 'https://test.com'
+body.application_id = '3-d-4-b-5'
+
+begin
+    response = voice_client.create_call(account_id,:body => body)
+    puts response.data.call_id #c-d45a41e5-bcb12581-b18e-4bdc-9874-6r3235dfweao
+    puts response.status_code #201
+rescue Bandwidth::ErrorResponseException => e
+    puts e.description #Invalid to: must be an E164 telephone number
+    puts e.response_code #400
+end
+```
+
+## Generate BXML
+
+```ruby
+response = Bandwidth::Voice::Response.new()
+hangup = Bandwidth::Voice::Hangup.new()
+
+response.push(hangup)
+puts response.to_bxml()
+```
+
+## Send Text Message
+
+```ruby
+messaging_client = bandwidth_client.messaging_client.client
+
+account_id = '1'
+body = MessageRequest.new
+body.application_id = '1-2-3'
+body.to = ['+17777777777']
+body.from = '+18888888888'
+body.text = 'Hello from Bandwidth'
+
+begin
+    response = messaging_client.create_message(account_id, :body => body)
+    puts response.data.id #1570740275373xbn7mbhsfewasdr
+    puts response.status_code #202
+rescue Bandwidth::GenericClientException => e
+    puts e.description #Access is denied
+    puts e.response_code #403
+rescue Bandwidth::PathClientException => e
+    puts e.message #Your request could not be accepted.
+    puts e.response_code #400
+end
+```

data/lib/bandwidth.rb

@@ -12,6 +12,9 @@ require 'logging'
 require_relative 'bandwidth/api_helper.rb'
 require_relative 'bandwidth/client.rb'
 
+# Utilities
+require_relative 'bandwidth/utilities/file_wrapper.rb'
+
 # Http
 require_relative 'bandwidth/http/api_response.rb'
 require_relative 'bandwidth/http/http_call_back.rb'

data/lib/bandwidth/http/faraday_client.rb

@@ -34,9 +34,7 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end
@@ -48,9 +46,7 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
-          request.body = http_request.parameters
-        end
+        request.body = http_request.parameters
       end
       convert_response(response, http_request)
     end

data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -198,15 +198,16 @@ module Messaging
     # @param [String] user_id Required parameter: Example:
     # @param [String] media_id Required parameter: Example:
     # @param [Long] content_length Required parameter: Example:
-    # @param [String] body Required parameter: Example:
-    # @param [String] content_type Optional parameter: Example:
+    # @param [File | UploadIO] body Required parameter: Example:
+    # @param [String] content_type Optional parameter:
+    # Example:application/octet-stream
     # @param [String] cache_control Optional parameter: Example:
     # @return [void] response from the API call
     def upload_media(user_id,
                      media_id,
                      content_length,
                      body,
-                     content_type: nil,
+                     content_type: 'application/octet-stream',
                      cache_control: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
@@ -218,10 +219,19 @@ module Messaging
       )
       _query_url = APIHelper.clean_url _query_builder
 
+      if body.is_a? FileWrapper
+        body_wrapper = body.file
+        body_content_type = body.content_type
+      else
+        body_wrapper = body
+        body_content_type = content_type
+      end
+
       # Prepare headers.
       _headers = {
+        'content-type' => body_content_type,
+        'content-length' => body_wrapper.size.to_s,
         'Content-Length' => content_length,
-        'Content-Type' => content_type,
         'Cache-Control' => cache_control
       }
 
@@ -229,7 +239,7 @@ module Messaging
       _request = config.http_client.put(
         _query_url,
         headers: _headers,
-        parameters: body
+        parameters: body_wrapper
       )
       MessagingBasicAuth.apply(config, _request)
       _response = execute_request(_request)

data/lib/bandwidth/utilities/file_wrapper.rb

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # A utility to allow users to set the content-type for files
+  class FileWrapper
+    attr_reader :content_type
+    attr_reader :file
+
+    def initialize(file, content_type: 'application/octet-stream')
+      @file = file
+      @content_type = content_type
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/phone_number.rb

@@ -8,6 +8,8 @@ module Bandwidth
         xml.PhoneNumber(number, compact_hash({
           'transferAnswerUrl' => transfer_answer_url,
           'transferAnswerMethod' => transfer_answer_method,
+          'transferDisconnectUrl' => transfer_disconnect_url,
+          'transferDisconnectMethod' => transfer_disconnect_method,
           'username' => username,
           'password' => password,
           'tag' => tag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -116,6 +116,7 @@ files:
 - lib/bandwidth/messaging_lib/messaging/models/message_request.rb
 - lib/bandwidth/messaging_lib/messaging/models/tag.rb
 - lib/bandwidth/models/base_model.rb
+- lib/bandwidth/utilities/file_wrapper.rb
 - lib/bandwidth/voice_lib/bxml/bxml.rb
 - lib/bandwidth/voice_lib/bxml/verbs/forward.rb
 - lib/bandwidth/voice_lib/bxml/verbs/gather.rb