Add expiration field for messages to v10 (#86)

Author: ckoegel

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

@@ -61,6 +61,10 @@ class BandwidthMessage < BaseModel
     # @return [String]
     attr_accessor :priority
 
+    # A string with the date/time value that the message will automatically expire by.
+    # @return [String]
+    attr_accessor :expiration
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -76,6 +80,7 @@ def self.names
       @_hash['text'] = 'text'
       @_hash['tag'] = 'tag'
       @_hash['priority'] = 'priority'
+      @_hash['expiration'] = 'expiration'
       @_hash
     end
 
@@ -94,6 +99,7 @@ def optionals
         text
         tag
         priority
+        expiration
       ]
     end
 
@@ -113,7 +119,8 @@ def initialize(id = nil,
                    media = nil,
                    text = nil,
                    tag = nil,
-                   priority = nil)
+                   priority = nil,
+                   expiration = nil)
       @id = id unless id == SKIP
       @owner = owner unless owner == SKIP
       @application_id = application_id unless application_id == SKIP
@@ -126,6 +133,7 @@ def initialize(id = nil,
       @text = text unless text == SKIP
       @tag = tag unless tag == SKIP
       @priority = priority unless priority == SKIP
+      @expiration = expiration unless expiration == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -145,6 +153,7 @@ def self.from_hash(hash)
       text = hash.key?('text') ? hash['text'] : SKIP
       tag = hash.key?('tag') ? hash['tag'] : SKIP
       priority = hash.key?('priority') ? hash['priority'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
 
       # Create object from extracted values.
       BandwidthMessage.new(id,
@@ -158,7 +167,8 @@ def self.from_hash(hash)
                            media,
                            text,
                            tag,
-                           priority)
+                           priority,
+                           expiration)
     end
   end
 end

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

@@ -41,6 +41,11 @@ class MessageRequest < BaseModel
     # @return [PriorityEnum]
     attr_accessor :priority
 
+    # A string with the date/time value that the message will automatically expire by.
+    # This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
+    # @return [String]
+    attr_accessor :expiration
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -51,6 +56,7 @@ def self.names
       @_hash['media'] = 'media'
       @_hash['tag'] = 'tag'
       @_hash['priority'] = 'priority'
+      @_hash['expiration'] = 'expiration'
       @_hash
     end
 
@@ -61,6 +67,7 @@ def optionals
         media
         tag
         priority
+        expiration
       ]
     end
 
@@ -75,14 +82,16 @@ def initialize(application_id = nil,
                    text = nil,
                    media = nil,
                    tag = nil,
-                   priority = nil)
+                   priority = nil,
+                   expiration = nil)
       @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
+      @expiration = expiration unless expiration == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -97,6 +106,7 @@ def self.from_hash(hash)
       media = hash.key?('media') ? hash['media'] : SKIP
       tag = hash.key?('tag') ? hash['tag'] : SKIP
       priority = hash.key?('priority') ? hash['priority'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
 
       # Create object from extracted values.
       MessageRequest.new(application_id,
@@ -105,7 +115,8 @@ def self.from_hash(hash)
                          text,
                          media,
                          tag,
-                         priority)
+                         priority,
+                         expiration)
     end
   end
 end

test/integration/test_integration.rb

@@ -57,7 +57,14 @@ def test_create_message
         body.to = [USER_NUMBER]
         body.from = BW_NUMBER
         body.text = "Ruby Integration"
+        body.priority = "high"
+        body.expiration = "2091-02-01T11:29:18-05:00"
         response = @bandwidth_client.messaging_client.client.create_message(BW_ACCOUNT_ID, body)
+        assert(response.data.to == [USER_NUMBER])
+        assert(response.data.from == BW_NUMBER)
+        assert(response.data.text == "Ruby Integration")
+        assert(response.data.priority == "high")
+        assert(response.data.expiration == "2091-02-01T11:29:18-05:00")
         assert(response.data.id.length > 0, "id value not set") #validate that _some_ id was returned
     end