messagemedia_messages_sdk 1.1.0 → 2.0.0

data/lib/message_media_messages/http/http_context.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -7,8 +9,8 @@ module MessageMediaMessages
     attr_accessor :request, :response
 
     # The constructor.
-    # @param [HttpRequest] request An HttpRequest object representing the HTTP request.
-    # @param [HttpResponse] response An HttpResponse object representing the HTTP
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
     # response.
     def initialize(request, response)
       @request = request

data/lib/message_media_messages/http/http_method_enum.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -6,6 +8,6 @@ module MessageMediaMessages
   class HttpMethodEnum
     HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
                       PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
-                      DELETE = 'DELETE'.freeze].freeze
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
   end
 end

data/lib/message_media_messages/http/http_request.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -8,10 +10,10 @@ module MessageMediaMessages
                   :parameters, :username, :password
 
     # The constructor.
-    # @param [HttpMethodEnum] http_method The HTTP method.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
-    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
     def initialize(http_method,
                    query_url,
                    headers: {},
@@ -23,22 +25,22 @@ module MessageMediaMessages
     end
 
     # Add a header to the HttpRequest.
-    # @param [String] name The name of the header.
-    # @param [String] value The value of the header.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
     def add_header(name, value)
       @headers[name] = value
     end
 
     # Add a parameter to the HttpRequest.
-    # @param [String] name The name of the parameter.
-    # @param [String] value The value of the parameter.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
     def add_parameter(name, value)
       @parameters[name] = value
     end
 
     # Add a query parameter to the HttpRequest.
-    # @param [String] name The name of the query parameter.
-    # @param [String] value The value of the query parameter.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
     def add_query_parameter(name, value)
       @query_url = APIHelper.append_url_with_query_parameters(@query_url,
                                                               name => value)

data/lib/message_media_messages/http/http_response.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -7,9 +9,9 @@ module MessageMediaMessages
     attr_accessor :status_code, :headers, :raw_body
 
     # The constructor
-    # @param [Integer] status_code The status code returned by the server.
-    # @param [Hash] headers The headers sent by the server in the response.
-    # @param [String] raw_body The raw body of the response.
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
     def initialize(status_code,
                    headers,
                    raw_body)

data/lib/message_media_messages/message_media_messages_client.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -29,13 +31,14 @@ module MessageMediaMessages
     end
 
     # Initializer with authentication and configuration parameters.
-    def initialize(auth_user_name: nil, auth_password: nil, use_hmac: false)
-      if (use_hmac == false)
-        Configuration.basic_auth_user_name = auth_user_name
-        Configuration.basic_auth_password = auth_password
-      else
+    def initialize(auth_user_name: nil, auth_password: nil,
+                   use_hmac_authentication: false)
+      if use_hmac_authentication
         Configuration.hmac_auth_user_name = auth_user_name
         Configuration.hmac_auth_password = auth_password
+      else
+        Configuration.basic_auth_user_name = auth_user_name
+        Configuration.basic_auth_password = auth_password
       end
     end
   end

data/lib/message_media_messages/models/base_model.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -9,6 +11,7 @@ module MessageMediaMessages
       hash = {}
       instance_variables.each do |name|
         value = instance_variable_get(name)
+        next if value.nil?
         name = name[1..-1]
         key = self.class.names.key?(name) ? self.class.names[name] : name
         if value.instance_of? Array

data/lib/message_media_messages/models/cancel_scheduled_message_request.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -10,14 +12,12 @@ module MessageMediaMessages
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['status'] = 'status'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
       @_hash
     end
 
-    def initialize(status = nil)
+    def initialize(status = 'cancelled')
       @status = status
     end
 
@@ -26,7 +26,7 @@ module MessageMediaMessages
       return nil unless hash
 
       # Extract variables from the hash.
-      status = hash['status']
+      status = hash['status'] ||= 'cancelled'
 
       # Create object from extracted values.
       CancelScheduledMessageRequest.new(status)

data/lib/message_media_messages/models/check_delivery_reports_response.rb

@@ -1,19 +1,19 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # CheckDeliveryReportsResponse Model.
   class CheckDeliveryReportsResponse < BaseModel
-    # TODO: Write general description for this method
-    # @return [List of Object]
+    # The oldest 100 unconfirmed delivery reports
+    # @return [List of DeliveryReport]
     attr_accessor :delivery_reports
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['delivery_reports'] = 'delivery_reports'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_reports'] = 'delivery_reports'
       @_hash
     end
 
@@ -26,7 +26,14 @@ module MessageMediaMessages
       return nil unless hash
 
       # Extract variables from the hash.
-      delivery_reports = hash['delivery_reports']
+      # Parameter is an array, so we need to iterate through it
+      delivery_reports = nil
+      unless hash['delivery_reports'].nil?
+        delivery_reports = []
+        hash['delivery_reports'].each do |structure|
+          delivery_reports << (DeliveryReport.from_hash(structure) if structure)
+        end
+      end
 
       # Create object from extracted values.
       CheckDeliveryReportsResponse.new(delivery_reports)

data/lib/message_media_messages/models/check_replies_response.rb

@@ -1,19 +1,19 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # CheckRepliesResponse Model.
   class CheckRepliesResponse < BaseModel
-    # TODO: Write general description for this method
-    # @return [List of Object]
+    # The oldest 100 unconfirmed replies
+    # @return [List of Reply]
     attr_accessor :replies
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['replies'] = 'replies'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['replies'] = 'replies'
       @_hash
     end
 
@@ -26,7 +26,14 @@ module MessageMediaMessages
       return nil unless hash
 
       # Extract variables from the hash.
-      replies = hash['replies']
+      # Parameter is an array, so we need to iterate through it
+      replies = nil
+      unless hash['replies'].nil?
+        replies = []
+        hash['replies'].each do |structure|
+          replies << (Reply.from_hash(structure) if structure)
+        end
+      end
 
       # Create object from extracted values.
       CheckRepliesResponse.new(replies)

data/lib/message_media_messages/models/confirm_delivery_reports_as_received_request.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -10,10 +12,8 @@ module MessageMediaMessages
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['delivery_report_ids'] = 'delivery_report_ids'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_report_ids'] = 'delivery_report_ids'
       @_hash
     end
 

data/lib/message_media_messages/models/{confirm_delivery_reports_as_received_request_11.rb → confirm_delivery_reports_as_received_request1.rb}

@@ -1,19 +1,19 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
-  # ConfirmDeliveryReportsAsReceivedRequest11 Model.
-  class ConfirmDeliveryReportsAsReceivedRequest11 < BaseModel
+  # ConfirmDeliveryReportsAsReceivedRequest1 Model.
+  class ConfirmDeliveryReportsAsReceivedRequest1 < BaseModel
     # TODO: Write general description for this method
     # @return [List of UUID | String]
     attr_accessor :delivery_report_ids
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['delivery_report_ids'] = 'delivery_report_ids'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_report_ids'] = 'delivery_report_ids'
       @_hash
     end
 
@@ -29,7 +29,7 @@ module MessageMediaMessages
       delivery_report_ids = hash['delivery_report_ids']
 
       # Create object from extracted values.
-      ConfirmDeliveryReportsAsReceivedRequest11.new(delivery_report_ids)
+      ConfirmDeliveryReportsAsReceivedRequest1.new(delivery_report_ids)
     end
   end
 end

data/lib/message_media_messages/models/confirm_replies_as_received_request.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -10,10 +12,8 @@ module MessageMediaMessages
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['reply_ids'] = 'reply_ids'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['reply_ids'] = 'reply_ids'
       @_hash
     end
 

data/lib/message_media_messages/models/{confirm_replies_as_received_request_8.rb → confirm_replies_as_received_request1.rb}

@@ -1,19 +1,19 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
-  # ConfirmRepliesAsReceivedRequest8 Model.
-  class ConfirmRepliesAsReceivedRequest8 < BaseModel
+  # ConfirmRepliesAsReceivedRequest1 Model.
+  class ConfirmRepliesAsReceivedRequest1 < BaseModel
     # TODO: Write general description for this method
     # @return [List of UUID | String]
     attr_accessor :reply_ids
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['reply_ids'] = 'reply_ids'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['reply_ids'] = 'reply_ids'
       @_hash
     end
 
@@ -29,7 +29,7 @@ module MessageMediaMessages
       reply_ids = hash['reply_ids']
 
       # Create object from extracted values.
-      ConfirmRepliesAsReceivedRequest8.new(reply_ids)
+      ConfirmRepliesAsReceivedRequest1.new(reply_ids)
     end
   end
 end

data/lib/message_media_messages/models/delivery_report.rb

@@ -0,0 +1,135 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module MessageMediaMessages
+  # DeliveryReport Model.
+  class DeliveryReport < BaseModel
+    # The URL specified as the callback URL in the original submit message
+    # request
+    # @return [String]
+    attr_accessor :callback_url
+
+    # The date and time at which this delivery report was generated in UTC.
+    # @return [DateTime]
+    attr_accessor :date_received
+
+    # Deprecated, no longer in use
+    # @return [Integer]
+    attr_accessor :delay
+
+    # Unique ID for this delivery report
+    # @return [UUID | String]
+    attr_accessor :delivery_report_id
+
+    # Unique ID of the original message
+    # @return [UUID | String]
+    attr_accessor :message_id
+
+    # Any metadata that was included in the original submit message request
+    # @return [Object]
+    attr_accessor :metadata
+
+    # Text of the original message.
+    # @return [String]
+    attr_accessor :original_text
+
+    # Address from which this delivery report was received
+    # @return [String]
+    attr_accessor :source_number
+
+    # The status of the message as per the delivery report
+    # @return [Status2Enum]
+    attr_accessor :status
+
+    # The date and time when the message status changed in UTC. For a delivered
+    # DR this may indicate the time at which the message was received on the
+    # handset.
+    # @return [DateTime]
+    attr_accessor :submitted_date
+
+    # The date and time when the message status changed in UTC. For a delivered
+    # DR this may indicate the time at which the message was received on the
+    # handset.
+    # @return [VendorAccountId]
+    attr_accessor :vendor_account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['callback_url'] = 'callback_url'
+      @_hash['date_received'] = 'date_received'
+      @_hash['delay'] = 'delay'
+      @_hash['delivery_report_id'] = 'delivery_report_id'
+      @_hash['message_id'] = 'message_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash['original_text'] = 'original_text'
+      @_hash['source_number'] = 'source_number'
+      @_hash['status'] = 'status'
+      @_hash['submitted_date'] = 'submitted_date'
+      @_hash['vendor_account_id'] = 'vendor_account_id'
+      @_hash
+    end
+
+    def initialize(callback_url = nil,
+                   date_received = nil,
+                   delay = nil,
+                   delivery_report_id = nil,
+                   message_id = nil,
+                   metadata = nil,
+                   original_text = nil,
+                   source_number = nil,
+                   status = nil,
+                   submitted_date = nil,
+                   vendor_account_id = nil)
+      @callback_url = callback_url
+      @date_received = date_received
+      @delay = delay
+      @delivery_report_id = delivery_report_id
+      @message_id = message_id
+      @metadata = metadata
+      @original_text = original_text
+      @source_number = source_number
+      @status = status
+      @submitted_date = submitted_date
+      @vendor_account_id = vendor_account_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      callback_url = hash['callback_url']
+      date_received = APIHelper.rfc3339(hash['date_received']) if
+        hash['date_received']
+      delay = hash['delay']
+      delivery_report_id = hash['delivery_report_id']
+      message_id = hash['message_id']
+      metadata = hash['metadata']
+      original_text = hash['original_text']
+      source_number = hash['source_number']
+      status = hash['status']
+      submitted_date = APIHelper.rfc3339(hash['submitted_date']) if
+        hash['submitted_date']
+      if hash['vendor_account_id']
+        vendor_account_id = VendorAccountId.from_hash(hash['vendor_account_id'])
+      end
+
+      # Create object from extracted values.
+      DeliveryReport.new(callback_url,
+                         date_received,
+                         delay,
+                         delivery_report_id,
+                         message_id,
+                         metadata,
+                         original_text,
+                         source_number,
+                         status,
+                         submitted_date,
+                         vendor_account_id)
+    end
+  end
+end