bandwidth-sdk 3.12.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957c708a64fbff873ec8eabc221cd4832deaf4d68ac4d29c1200104ddf1a9320
-  data.tar.gz: dff8ddef5916e696798d712f257be3f9ef471ec2fadc42567ffa248b119e9e3d
+  metadata.gz: bc4d4b047d53e1e8c3f34b37696455d916a753aa3566dad6d6fb666fc2b3fa61
+  data.tar.gz: b5cdf37c09788e890f36ef3c78ccf41f0ba18a69291f1424be7f798f207881f9
 SHA512:
-  metadata.gz: ef6d3e69a46cf27463b1bc72cea88a0a2e4dd78558758ca6c72eceedd99c48c5c304e08914cecd8e3f5919bb617d501930dc81d8fc28aeba47148ecf0a214f7f
-  data.tar.gz: 487a7c3d36817d419e482ac89d98927803789b03b3be3148eeeb246f7fbfdae1da74bf500918b4eac1f8a7c7cce890290be1da843ca632c9ee26719d232e6b12
+  metadata.gz: 59761140cdddf9f6cda37d7aeeaeff6341a5c0bcc357cf577ae29e8fff0a6cf347f1070536f99db3b2f3f6baae3c2b93edbefb2e94468036c57ffd7a65c279b0
+  data.tar.gz: bdf68653a8640403d2bc5402c9f5af06055079640ab9229b16ac12cf48290ccffbe2ac38e40c11c3e6b518b1ebaad05344779249d0f79c940d32c3a57b36f5ed

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/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,6 +7,9 @@
 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'

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,47 +6,48 @@
 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
 

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

@@ -0,0 +1,125 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BandwidthMessageItem Model.
+  class BandwidthMessageItem < BaseModel
+    # The message id
+    # @return [String]
+    attr_accessor :message_id
+
+    # The account id of the message
+    # @return [String]
+    attr_accessor :account_id
+
+    # The source phone number of the message
+    # @return [String]
+    attr_accessor :source_tn
+
+    # The recipient phone number of the message
+    # @return [String]
+    attr_accessor :destination_tn
+
+    # The status of the message
+    # @return [String]
+    attr_accessor :message_status
+
+    # The direction of the message relative to Bandwidth. INBOUND or OUTBOUND
+    # @return [String]
+    attr_accessor :message_direction
+
+    # The type of message. sms or mms
+    # @return [String]
+    attr_accessor :message_type
+
+    # The number of segments the message was sent as
+    # @return [Integer]
+    attr_accessor :segment_count
+
+    # The numeric error code of the message
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # The ISO 8601 datetime of the message
+    # @return [String]
+    attr_accessor :receive_time
+
+    # The name of the carrier. Not currently supported for MMS, coming soon
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'messageId'
+      @_hash['account_id'] = 'accountId'
+      @_hash['source_tn'] = 'sourceTn'
+      @_hash['destination_tn'] = 'destinationTn'
+      @_hash['message_status'] = 'messageStatus'
+      @_hash['message_direction'] = 'messageDirection'
+      @_hash['message_type'] = 'messageType'
+      @_hash['segment_count'] = 'segmentCount'
+      @_hash['error_code'] = 'errorCode'
+      @_hash['receive_time'] = 'receiveTime'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash
+    end
+
+    def initialize(message_id = nil,
+                   account_id = nil,
+                   source_tn = nil,
+                   destination_tn = nil,
+                   message_status = nil,
+                   message_direction = nil,
+                   message_type = nil,
+                   segment_count = nil,
+                   error_code = nil,
+                   receive_time = nil,
+                   carrier_name = nil)
+      @message_id = message_id
+      @account_id = account_id
+      @source_tn = source_tn
+      @destination_tn = destination_tn
+      @message_status = message_status
+      @message_direction = message_direction
+      @message_type = message_type
+      @segment_count = segment_count
+      @error_code = error_code
+      @receive_time = receive_time
+      @carrier_name = carrier_name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      message_id = hash['messageId']
+      account_id = hash['accountId']
+      source_tn = hash['sourceTn']
+      destination_tn = hash['destinationTn']
+      message_status = hash['messageStatus']
+      message_direction = hash['messageDirection']
+      message_type = hash['messageType']
+      segment_count = hash['segmentCount']
+      error_code = hash['errorCode']
+      receive_time = hash['receiveTime']
+      carrier_name = hash['carrierName']
+
+      # Create object from extracted values.
+      BandwidthMessageItem.new(message_id,
+                               account_id,
+                               source_tn,
+                               destination_tn,
+                               message_status,
+                               message_direction,
+                               message_type,
+                               segment_count,
+                               error_code,
+                               receive_time,
+                               carrier_name)
+    end
+  end
+end