bandwidth-sdk 3.13.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a79b2f744a1044c7312833760914829637f9c7d21aa8b670102d83b2e810f8b
-  data.tar.gz: e12d0c3e1d70547f90a1bdbad47e76425823b85bc8d5f838ca15e2e9d3dfe1d8
+  metadata.gz: 26c4cadeb77f88938cc4adac87254af331797646e475f2985dbe93078c128058
+  data.tar.gz: 26e318c93cff54b0d8d47f36dabd4bfcfa66ec33ecd2eaa8a3d6013216f5a635
 SHA512:
-  metadata.gz: 71871be37311133b4c09b4b157d800cf94e622399907625fab8dc6ebff41aaed8b6c1dc8f931c819d2e9172e8998842fa3cbbd5d48982685bac0b72f64205b62
-  data.tar.gz: 6236ac41293f9e5f5453b9db12e50ff1c07eb632d61af71d8929b568f36c13ddd1205cd775fe717cc2668b8ff16dae76f91a2295bdf78fe06c1567b58c03266e
+  metadata.gz: 05ed430d18e6bdfffa1400a86d2a92d841d3340aa9bf838a9647c534354585992bd273978008a5161b51bd6b2616d06cf4fbb4ae638f5631d2999459817d6cf4
+  data.tar.gz: 5595927b80c12008edb1d1527ac407ca97f431a1dff0acc6984ec2dcfcb9b1e11573af76a4ec40b894ff8b17033f0e226f742ea0505a353d370ad0407f36ff8e

data/LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2016 APIMATIC Limited
+Copyright (c) 2014 - 2020 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -72,7 +72,7 @@ body.from = '+18888888888'
 body.text = 'Hello from Bandwidth'
 
 begin
-    response = messaging_client.create_message(account_id, :body => body)
+    response = messaging_client.create_message(account_id, body)
     puts response.data.id #1570740275373xbn7mbhsfewasdr
     puts response.status_code #202
 rescue Bandwidth::GenericClientException => e

data/lib/bandwidth/configuration.rb

@@ -156,7 +156,7 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
+        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com',
         Server::WEBRTCDEFAULT => 'https://api.webrtc.bandwidth.com/v1'
       },

data/lib/bandwidth/http/api_response.rb

@@ -25,10 +25,12 @@ module Bandwidth
       @errors = errors
     end
 
+    # returns true if status_code is between 200-300
     def success?
       status_code >= 200 && status_code < 300
     end
 
+    # returns true if status_code is between 400-600
     def error?
       status_code >= 400 && status_code < 600
     end

data/lib/bandwidth/http/faraday_client.rb

@@ -15,6 +15,7 @@ module Bandwidth
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use :gzip
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where
@@ -34,7 +35,10 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        request.body = http_request.parameters
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
       end
       convert_response(response, http_request)
     end
@@ -46,7 +50,10 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        request.body = http_request.parameters
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
       end
       convert_response(response, http_request)
     end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -7,12 +7,16 @@
 require_relative 'messaging/client.rb'
 
 # Models
+require_relative 'messaging/models/bandwidth_messages_list.rb'
+require_relative 'messaging/models/bandwidth_message_item.rb'
+require_relative 'messaging/models/page_info.rb'
 require_relative 'messaging/models/media.rb'
 require_relative 'messaging/models/tag.rb'
 require_relative 'messaging/models/deferred_result.rb'
 require_relative 'messaging/models/bandwidth_callback_message.rb'
 require_relative 'messaging/models/bandwidth_message.rb'
 require_relative 'messaging/models/message_request.rb'
+require_relative 'messaging/models/priority_enum.rb'
 
 # Exceptions
 require_relative 'messaging/exceptions/messaging_exception.rb'

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

@@ -12,8 +12,9 @@ module Messaging
     end
 
     # listMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] continuation_token Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] continuation_token Optional parameter: Continuation token
+    # used to retrieve subsequent media.
     # @return [List of Media] response from the API call
     def list_media(user_id,
                    continuation_token: nil)
@@ -22,7 +23,7 @@ module Messaging
       _query_builder << '/users/{userId}/media'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => true }
+        'userId' => { 'value' => user_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -83,8 +84,8 @@ module Messaging
     end
 
     # getMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: Media ID to retrieve
     # @return [Binary] response from the API call
     def get_media(user_id,
                   media_id)
@@ -93,8 +94,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => true },
-        'mediaId' => { 'value' => media_id, 'encode' => true }
+        'userId' => { 'value' => user_id, 'encode' => false },
+        'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -146,13 +147,17 @@ module Messaging
     end
 
     # uploadMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
-    # @param [Long] content_length Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: The user supplied custom
+    # media ID
+    # @param [Long] content_length Required parameter: The size of the
+    # entity-body
     # @param [File | UploadIO] body Required parameter: Example:
-    # @param [String] content_type Optional parameter:
-    # Example:application/octet-stream
-    # @param [String] cache_control Optional parameter: Example:
+    # @param [String] content_type Optional parameter: The media type of the
+    # entity-body
+    # @param [String] cache_control Optional parameter: General-header field is
+    # used to specify directives that MUST be obeyed by all caching mechanisms
+    # along the request/response chain.
     # @return [void] response from the API call
     def upload_media(user_id,
                      media_id,
@@ -165,8 +170,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => true },
-        'mediaId' => { 'value' => media_id, 'encode' => true }
+        'userId' => { 'value' => user_id, 'encode' => false },
+        'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -234,8 +239,8 @@ module Messaging
     end
 
     # deleteMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: The media ID to delete
     # @return [void] response from the API call
     def delete_media(user_id,
                      media_id)
@@ -244,8 +249,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => true },
-        'mediaId' => { 'value' => media_id, 'encode' => true }
+        'userId' => { 'value' => user_id, 'encode' => false },
+        'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -294,18 +299,128 @@ module Messaging
       ApiResponse.new(_response)
     end
 
+    # getMessages
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] message_id Optional parameter: The ID of the message to
+    # search for. Special characters need to be encoded using URL encoding
+    # @param [String] source_tn Optional parameter: The phone number that sent
+    # the message
+    # @param [String] destination_tn Optional parameter: The phone number that
+    # received the message
+    # @param [String] message_status Optional parameter: The status of the
+    # message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED,
+    # DLR_EXPIRED
+    # @param [Integer] error_code Optional parameter: The error code of the
+    # message
+    # @param [String] from_date_time Optional parameter: 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.
+    # @param [String] to_date_time Optional parameter: 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.
+    # @param [String] page_token Optional parameter: A base64 encoded value used
+    # for pagination of results
+    # @param [Integer] limit Optional parameter: The maximum records requested
+    # in search result. Default 100. The sum of limit and after cannot be more
+    # than 10000
+    # @return [BandwidthMessagesList] response from the API call
+    def get_messages(user_id,
+                     message_id: nil,
+                     source_tn: nil,
+                     destination_tn: nil,
+                     message_status: nil,
+                     error_code: nil,
+                     from_date_time: nil,
+                     to_date_time: nil,
+                     page_token: nil,
+                     limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
+      _query_builder << '/users/{userId}/messages'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => { 'value' => user_id, 'encode' => false }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'messageId' => message_id,
+        'sourceTn' => source_tn,
+        'destinationTn' => destination_tn,
+        'messageStatus' => message_status,
+        'errorCode' => error_code,
+        'fromDateTime' => from_date_time,
+        'toDateTime' => to_date_time,
+        'pageToken' => page_token,
+        'limit' => limit
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      MessagingBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise MessagingException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise MessagingException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise MessagingException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise MessagingException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise MessagingException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise MessagingException.new(
+          '429 The rate limit has been reached',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: BandwidthMessagesList.from_hash(decoded)
+      )
+    end
+
     # createMessage
-    # @param [String] user_id Required parameter: Example:
-    # @param [MessageRequest] body Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [MessageRequest] body Required parameter: Example:
     # @return [BandwidthMessage] response from the API call
     def create_message(user_id,
-                       body: nil)
+                       body)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
       _query_builder << '/users/{userId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => true }
+        'userId' => { 'value' => user_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 

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

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.1'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb

@@ -6,50 +6,55 @@
 module Bandwidth
   # BandwidthMessage Model.
   class BandwidthMessage < BaseModel
-    # TODO: Write general description for this method
+    # The id of the message
     # @return [String]
     attr_accessor :id
 
-    # TODO: Write general description for this method
+    # The Bandwidth phone number associated with the message
     # @return [String]
     attr_accessor :owner
 
-    # TODO: Write general description for this method
+    # The application ID associated with the message
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # The datetime stamp of the message in ISO 8601
     # @return [String]
     attr_accessor :time
 
-    # TODO: Write general description for this method
+    # The number of segments the original message from the user is broken into
+    # before sending over to carrier networks
     # @return [Integer]
     attr_accessor :segment_count
 
-    # TODO: Write general description for this method
+    # The direction of the message relative to Bandwidth. Can be in or out
     # @return [String]
     attr_accessor :direction
 
-    # TODO: Write general description for this method
+    # The phone number recipients of the message
     # @return [List of String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The phone number the message was sent from
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The list of media URLs sent in the message
     # @return [List of String]
     attr_accessor :media
 
-    # TODO: Write general description for this method
+    # The contents of the message
     # @return [String]
     attr_accessor :text
 
-    # TODO: Write general description for this method
+    # The custom string set by the user
     # @return [String]
     attr_accessor :tag
 
+    # The priority specified by the user
+    # @return [String]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -64,6 +69,7 @@ module Bandwidth
       @_hash['media'] = 'media'
       @_hash['text'] = 'text'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -77,7 +83,8 @@ module Bandwidth
                    from = nil,
                    media = nil,
                    text = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @id = id
       @owner = owner
       @application_id = application_id
@@ -89,6 +96,7 @@ module Bandwidth
       @media = media
       @text = text
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -107,6 +115,7 @@ module Bandwidth
       media = hash['media']
       text = hash['text']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       BandwidthMessage.new(id,
@@ -119,7 +128,8 @@ module Bandwidth
                            from,
                            media,
                            text,
-                           tag)
+                           tag,
+                           priority)
     end
   end
 end