bandwidth-sdk 6.2.0 → 9.0.0

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # BandwidthMessageItem Model.
   class BandwidthMessageItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The message id
     # @return [String]
     attr_accessor :message_id
@@ -50,6 +53,26 @@ module Bandwidth
     # @return [String]
     attr_accessor :carrier_name
 
+    # The size of the message including message content and headers
+    # @return [Integer]
+    attr_accessor :message_size
+
+    # The length of the message content
+    # @return [Integer]
+    attr_accessor :message_length
+
+    # The number of attachments the message has
+    # @return [Integer]
+    attr_accessor :attachment_count
+
+    # The number of recipients the message has
+    # @return [Integer]
+    attr_accessor :recipient_count
+
+    # The campaign class of the message, if it has one
+    # @return [String]
+    attr_accessor :campaign_class
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -64,9 +87,41 @@ module Bandwidth
       @_hash['error_code'] = 'errorCode'
       @_hash['receive_time'] = 'receiveTime'
       @_hash['carrier_name'] = 'carrierName'
+      @_hash['message_size'] = 'messageSize'
+      @_hash['message_length'] = 'messageLength'
+      @_hash['attachment_count'] = 'attachmentCount'
+      @_hash['recipient_count'] = 'recipientCount'
+      @_hash['campaign_class'] = 'campaignClass'
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        message_id
+        account_id
+        source_tn
+        destination_tn
+        message_status
+        message_direction
+        message_type
+        segment_count
+        error_code
+        receive_time
+        carrier_name
+        message_size
+        message_length
+        attachment_count
+        recipient_count
+        campaign_class
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(message_id = nil,
                    account_id = nil,
                    source_tn = nil,
@@ -77,18 +132,28 @@ module Bandwidth
                    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
+                   carrier_name = nil,
+                   message_size = nil,
+                   message_length = nil,
+                   attachment_count = nil,
+                   recipient_count = nil,
+                   campaign_class = nil)
+      @message_id = message_id unless message_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @source_tn = source_tn unless source_tn == SKIP
+      @destination_tn = destination_tn unless destination_tn == SKIP
+      @message_status = message_status unless message_status == SKIP
+      @message_direction = message_direction unless message_direction == SKIP
+      @message_type = message_type unless message_type == SKIP
+      @segment_count = segment_count unless segment_count == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @receive_time = receive_time unless receive_time == SKIP
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @message_size = message_size unless message_size == SKIP
+      @message_length = message_length unless message_length == SKIP
+      @attachment_count = attachment_count unless attachment_count == SKIP
+      @recipient_count = recipient_count unless recipient_count == SKIP
+      @campaign_class = campaign_class unless campaign_class == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -96,17 +161,25 @@ module Bandwidth
       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']
+      message_id = hash.key?('messageId') ? hash['messageId'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      source_tn = hash.key?('sourceTn') ? hash['sourceTn'] : SKIP
+      destination_tn = hash.key?('destinationTn') ? hash['destinationTn'] : SKIP
+      message_status = hash.key?('messageStatus') ? hash['messageStatus'] : SKIP
+      message_direction =
+        hash.key?('messageDirection') ? hash['messageDirection'] : SKIP
+      message_type = hash.key?('messageType') ? hash['messageType'] : SKIP
+      segment_count = hash.key?('segmentCount') ? hash['segmentCount'] : SKIP
+      error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
+      receive_time = hash.key?('receiveTime') ? hash['receiveTime'] : SKIP
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      message_size = hash.key?('messageSize') ? hash['messageSize'] : SKIP
+      message_length = hash.key?('messageLength') ? hash['messageLength'] : SKIP
+      attachment_count =
+        hash.key?('attachmentCount') ? hash['attachmentCount'] : SKIP
+      recipient_count =
+        hash.key?('recipientCount') ? hash['recipientCount'] : SKIP
+      campaign_class = hash.key?('campaignClass') ? hash['campaignClass'] : SKIP
 
       # Create object from extracted values.
       BandwidthMessageItem.new(message_id,
@@ -119,7 +192,12 @@ module Bandwidth
                                segment_count,
                                error_code,
                                receive_time,
-                               carrier_name)
+                               carrier_name,
+                               message_size,
+                               message_length,
+                               attachment_count,
+                               recipient_count,
+                               campaign_class)
     end
   end
 end

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # BandwidthMessagesList Model.
   class BandwidthMessagesList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # Total number of messages matched by the search
     # @return [Integer]
     attr_accessor :total_count
@@ -27,12 +30,26 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        total_count
+        page_info
+        messages
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(total_count = nil,
                    page_info = nil,
                    messages = nil)
-      @total_count = total_count
-      @page_info = page_info
-      @messages = messages
+      @total_count = total_count unless total_count == SKIP
+      @page_info = page_info unless page_info == SKIP
+      @messages = messages unless messages == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -40,7 +57,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      total_count = hash['totalCount']
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
       page_info = PageInfo.from_hash(hash['pageInfo']) if hash['pageInfo']
       # Parameter is an array, so we need to iterate through it
       messages = nil
@@ -51,6 +68,8 @@ module Bandwidth
         end
       end
 
+      messages = SKIP unless hash.key?('messages')
+
       # Create object from extracted values.
       BandwidthMessagesList.new(total_count,
                                 page_info,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # DeferredResult Model.
   class DeferredResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [Object]
     attr_accessor :result
@@ -22,10 +25,23 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        result
+        set_or_expired
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(result = nil,
                    set_or_expired = nil)
-      @result = result
-      @set_or_expired = set_or_expired
+      @result = result unless result == SKIP
+      @set_or_expired = set_or_expired unless set_or_expired == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -33,8 +49,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      result = hash['result']
-      set_or_expired = hash['setOrExpired']
+      result = hash.key?('result') ? hash['result'] : SKIP
+      set_or_expired = hash.key?('setOrExpired') ? hash['setOrExpired'] : SKIP
 
       # Create object from extracted values.
       DeferredResult.new(result,

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

@@ -6,82 +6,50 @@
 module Bandwidth
   # Media Model.
   class Media < BaseModel
-    # TODO: Write general description for this method
-    # @return [Object]
-    attr_accessor :input_stream
+    SKIP = Object.new
+    private_constant :SKIP
 
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :content
 
     # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :url
-
-    # TODO: Write general description for this method
-    # @return [String]
+    # @return [Integer]
     attr_accessor :content_length
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :content_type
-
-    # TODO: Write general description for this method
-    # @return [List of Tag]
-    attr_accessor :tags
-
-    # User's account ID
-    # @return [String]
-    attr_accessor :user_id
-
-    # User's account ID
-    # @return [String]
     attr_accessor :media_name
 
-    # User's account ID
-    # @return [String]
-    attr_accessor :media_id
-
-    # User's account ID
-    # @return [String]
-    attr_accessor :cache_control
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['input_stream'] = 'inputStream'
       @_hash['content'] = 'content'
-      @_hash['url'] = 'url'
       @_hash['content_length'] = 'contentLength'
-      @_hash['content_type'] = 'contentType'
-      @_hash['tags'] = 'tags'
-      @_hash['user_id'] = 'userId'
       @_hash['media_name'] = 'mediaName'
-      @_hash['media_id'] = 'mediaId'
-      @_hash['cache_control'] = 'cacheControl'
       @_hash
     end
 
-    def initialize(input_stream = nil,
-                   content = nil,
-                   url = nil,
+    # An array for optional fields
+    def optionals
+      %w[
+        content
+        content_length
+        media_name
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(content = nil,
                    content_length = nil,
-                   content_type = nil,
-                   tags = nil,
-                   user_id = nil,
-                   media_name = nil,
-                   media_id = nil,
-                   cache_control = nil)
-      @input_stream = input_stream
-      @content = content
-      @url = url
-      @content_length = content_length
-      @content_type = content_type
-      @tags = tags
-      @user_id = user_id
-      @media_name = media_name
-      @media_id = media_id
-      @cache_control = cache_control
+                   media_name = nil)
+      @content = content unless content == SKIP
+      @content_length = content_length unless content_length == SKIP
+      @media_name = media_name unless media_name == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -89,35 +57,14 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      input_stream = hash['inputStream']
-      content = hash['content']
-      url = hash['url']
-      content_length = hash['contentLength']
-      content_type = hash['contentType']
-      # Parameter is an array, so we need to iterate through it
-      tags = nil
-      unless hash['tags'].nil?
-        tags = []
-        hash['tags'].each do |structure|
-          tags << (Tag.from_hash(structure) if structure)
-        end
-      end
-      user_id = hash['userId']
-      media_name = hash['mediaName']
-      media_id = hash['mediaId']
-      cache_control = hash['cacheControl']
+      content = hash.key?('content') ? hash['content'] : SKIP
+      content_length = hash.key?('contentLength') ? hash['contentLength'] : SKIP
+      media_name = hash.key?('mediaName') ? hash['mediaName'] : SKIP
 
       # Create object from extracted values.
-      Media.new(input_stream,
-                content,
-                url,
+      Media.new(content,
                 content_length,
-                content_type,
-                tags,
-                user_id,
-                media_name,
-                media_id,
-                cache_control)
+                media_name)
     end
   end
 end

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # MessageRequest Model.
   class MessageRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The ID of the Application your from number is associated with in the
     # Bandwidth Phone Number Dashboard.
     # @return [String]
@@ -51,6 +54,21 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        text
+        media
+        tag
+        priority
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(application_id = nil,
                    to = nil,
                    from = nil,
@@ -58,13 +76,13 @@ module Bandwidth
                    media = nil,
                    tag = nil,
                    priority = nil)
-      @application_id = application_id
-      @to = to
-      @from = from
-      @text = text
-      @media = media
-      @tag = tag
-      @priority = priority
+      @application_id = application_id unless application_id == SKIP
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @text = text unless text == SKIP
+      @media = media unless media == SKIP
+      @tag = tag unless tag == SKIP
+      @priority = priority unless priority == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -72,13 +90,13 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      application_id = hash['applicationId']
-      to = hash['to']
-      from = hash['from']
-      text = hash['text']
-      media = hash['media']
-      tag = hash['tag']
-      priority = hash['priority']
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+      media = hash.key?('media') ? hash['media'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
 
       # Create object from extracted values.
       MessageRequest.new(application_id,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # PageInfo Model.
   class PageInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The link to the previous page for pagination
     # @return [String]
     attr_accessor :prev_page
@@ -32,14 +35,29 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        prev_page
+        next_page
+        prev_page_token
+        next_page_token
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(prev_page = nil,
                    next_page = nil,
                    prev_page_token = nil,
                    next_page_token = nil)
-      @prev_page = prev_page
-      @next_page = next_page
-      @prev_page_token = prev_page_token
-      @next_page_token = next_page_token
+      @prev_page = prev_page unless prev_page == SKIP
+      @next_page = next_page unless next_page == SKIP
+      @prev_page_token = prev_page_token unless prev_page_token == SKIP
+      @next_page_token = next_page_token unless next_page_token == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -47,10 +65,12 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      prev_page = hash['prevPage']
-      next_page = hash['nextPage']
-      prev_page_token = hash['prevPageToken']
-      next_page_token = hash['nextPageToken']
+      prev_page = hash.key?('prevPage') ? hash['prevPage'] : SKIP
+      next_page = hash.key?('nextPage') ? hash['nextPage'] : SKIP
+      prev_page_token =
+        hash.key?('prevPageToken') ? hash['prevPageToken'] : SKIP
+      next_page_token =
+        hash.key?('nextPageToken') ? hash['nextPageToken'] : SKIP
 
       # Create object from extracted values.
       PageInfo.new(prev_page,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # Tag Model.
   class Tag < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :key
@@ -22,10 +25,23 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(key = nil,
                    value = nil)
-      @key = key
-      @value = value
+      @key = key unless key == SKIP
+      @value = value unless value == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -33,8 +49,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      key = hash['key']
-      value = hash['value']
+      key = hash.key?('key') ? hash['key'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
 
       # Create object from extracted values.
       Tag.new(key,

data/lib/bandwidth/models/base_model.rb

@@ -13,15 +13,37 @@ module Bandwidth
         value = instance_variable_get(name)
         name = name[1..-1]
         key = self.class.names.key?(name) ? self.class.names[name] : name
-        if value.instance_of? Array
-          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-        elsif value.instance_of? Hash
-          hash[key] = {}
-          value.each do |k, v|
-            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+
+        optional_fields = optionals if respond_to? 'optionals'
+        nullable_fields = nullables if respond_to? 'nullables'
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_#{name}", *params)
+            else
+              hash[key] = send("to_#{name}")
+            end
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
           end
-        else
-          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
         end
       end
       hash