bandwidth-sdk 6.2.0 → 9.0.0

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

@@ -11,19 +11,19 @@ module Messaging
       super(config, http_call_back: http_call_back)
     end
 
-    # listMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # Gets a list of your media files. No query parameters are supported.
+    # @param [String] account_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,
+    def list_media(account_id,
                    continuation_token: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media'
+      _query_builder << '/users/{accountId}/media'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -42,32 +42,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -83,18 +84,18 @@ module Messaging
       )
     end
 
-    # getMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # Downloads a media file you previously uploaded.
+    # @param [String] account_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,
+    def get_media(account_id,
                   media_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -107,32 +108,33 @@ module Messaging
       _response = execute_request(_request, binary: true)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -146,12 +148,11 @@ module Messaging
       )
     end
 
-    # uploadMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # Uploads a file the normal HTTP way. You may add headers to the request in
+    # order to provide some control to your media-file.
+    # @param [String] account_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: The media type of the
     # entity-body
@@ -159,18 +160,17 @@ module Messaging
     # 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,
+    def upload_media(account_id,
                      media_id,
-                     content_length,
                      body,
                      content_type: 'application/octet-stream',
                      cache_control: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -187,7 +187,6 @@ module Messaging
       _headers = {
         'content-type' => body_content_type,
         'content-length' => body_wrapper.size.to_s,
-        'Content-Length' => content_length,
         'Cache-Control' => cache_control
       }
 
@@ -201,32 +200,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -238,18 +238,21 @@ module Messaging
       ApiResponse.new(_response)
     end
 
-    # deleteMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # 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.
+    # @param [String] account_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,
+    def delete_media(account_id,
                      media_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -262,32 +265,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -299,8 +303,8 @@ module Messaging
       ApiResponse.new(_response)
     end
 
-    # getMessages
-    # @param [String] user_id Required parameter: User's account ID
+    # Gets a list of messages based on query parameters.
+    # @param [String] account_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
@@ -309,7 +313,7 @@ module Messaging
     # received the message
     # @param [String] message_status Optional parameter: The status of the
     # message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED,
-    # DLR_EXPIRED
+    # ACCEPTED, UNDELIVERED
     # @param [Integer] error_code Optional parameter: The error code of the
     # message
     # @param [String] from_date_time Optional parameter: The start of the date
@@ -324,7 +328,7 @@ module Messaging
     # 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,
+    def get_messages(account_id,
                      message_id: nil,
                      source_tn: nil,
                      destination_tn: nil,
@@ -336,10 +340,10 @@ module Messaging
                      limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/messages'
+      _query_builder << '/users/{accountId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -369,32 +373,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
@@ -409,18 +414,19 @@ module Messaging
       )
     end
 
-    # createMessage
-    # @param [String] user_id Required parameter: User's account ID
+    # Endpoint for sending text messages and picture messages using V2
+    # messaging.
+    # @param [String] account_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,
+    def create_message(account_id,
                        body)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/messages'
+      _query_builder << '/users/{accountId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -440,32 +446,33 @@ module Messaging
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise MessagingException.new(
           '404 Path not found',
           _response
         )
-      elsif _response.status_code == 415
+      when 415
         raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise MessagingException.new(
           '429 The rate limit has been reached',
           _response

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

@@ -19,14 +19,12 @@ module Bandwidth
 
     def validate_parameters(args)
       args.each do |_name, value|
-        if value.nil?
-          raise ArgumentError, "Required parameter #{_name} cannot be nil."
-        end
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
       end
     end
 
     def execute_request(request, binary: false)
-      @http_call_back.on_before_request(request) if @http_call_back
+      @http_call_back&.on_before_request(request)
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
@@ -36,7 +34,7 @@ module Bandwidth
                  else
                    config.http_client.execute_as_string(request)
                  end
-      @http_call_back.on_after_response(response) if @http_call_back
+      @http_call_back&.on_after_response(response)
 
       response
     end

data/lib/bandwidth/messaging_lib/messaging/exceptions/messaging_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # MessagingException class.
   class MessagingException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :type
@@ -27,8 +30,8 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @type = hash['type']
-      @description = hash['description']
+      @type = hash.key?('type') ? hash['type'] : SKIP
+      @description = hash.key?('description') ? hash['description'] : SKIP
     end
   end
 end

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # BandwidthCallbackMessage Model.
   class BandwidthCallbackMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :time
@@ -42,18 +45,35 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        time
+        type
+        to
+        error_code
+        description
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(time = nil,
                    type = nil,
                    to = nil,
                    error_code = nil,
                    description = nil,
                    message = nil)
-      @time = time
-      @type = type
-      @to = to
-      @error_code = error_code
-      @description = description
-      @message = message
+      @time = time unless time == SKIP
+      @type = type unless type == SKIP
+      @to = to unless to == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @description = description unless description == SKIP
+      @message = message unless message == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -61,11 +81,11 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      time = hash['time']
-      type = hash['type']
-      to = hash['to']
-      error_code = hash['errorCode']
-      description = hash['description']
+      time = hash.key?('time') ? hash['time'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
       message = BandwidthMessage.from_hash(hash['message']) if hash['message']
 
       # Create object from extracted values.

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # BandwidthMessage Model.
   class BandwidthMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The id of the message
     # @return [String]
     attr_accessor :id
@@ -39,7 +42,10 @@ module Bandwidth
     # @return [String]
     attr_accessor :from
 
-    # The list of media URLs sent in the message
+    # 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.
     # @return [List of String]
     attr_accessor :media
 
@@ -73,6 +79,29 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        id
+        owner
+        application_id
+        time
+        segment_count
+        direction
+        to
+        from
+        media
+        text
+        tag
+        priority
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(id = nil,
                    owner = nil,
                    application_id = nil,
@@ -85,18 +114,18 @@ module Bandwidth
                    text = nil,
                    tag = nil,
                    priority = nil)
-      @id = id
-      @owner = owner
-      @application_id = application_id
-      @time = time
-      @segment_count = segment_count
-      @direction = direction
-      @to = to
-      @from = from
-      @media = media
-      @text = text
-      @tag = tag
-      @priority = priority
+      @id = id unless id == SKIP
+      @owner = owner unless owner == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @time = time unless time == SKIP
+      @segment_count = segment_count unless segment_count == SKIP
+      @direction = direction unless direction == SKIP
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @media = media unless media == SKIP
+      @text = text unless text == SKIP
+      @tag = tag unless tag == SKIP
+      @priority = priority unless priority == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -104,18 +133,18 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      id = hash['id']
-      owner = hash['owner']
-      application_id = hash['applicationId']
-      time = hash['time']
-      segment_count = hash['segmentCount']
-      direction = hash['direction']
-      to = hash['to']
-      from = hash['from']
-      media = hash['media']
-      text = hash['text']
-      tag = hash['tag']
-      priority = hash['priority']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      owner = hash.key?('owner') ? hash['owner'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      time = hash.key?('time') ? hash['time'] : SKIP
+      segment_count = hash.key?('segmentCount') ? hash['segmentCount'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      media = hash.key?('media') ? hash['media'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
 
       # Create object from extracted values.
       BandwidthMessage.new(id,