messagemedia_messages_sdk 1.0.0

data/lib/message_media_messages/models/check_replies_response.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia 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]
+    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
+    end
+
+    def initialize(replies = nil)
+      @replies = replies
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      replies = hash['replies']
+
+      # Create object from extracted values.
+      CheckRepliesResponse.new(replies)
+    end
+  end
+end

data/lib/message_media_messages/models/confirm_delivery_reports_as_received_request.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # ConfirmDeliveryReportsAsReceivedRequest Model.
+  class ConfirmDeliveryReportsAsReceivedRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [List of 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
+    end
+
+    def initialize(delivery_report_ids = nil)
+      @delivery_report_ids = delivery_report_ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      delivery_report_ids = hash['delivery_report_ids']
+
+      # Create object from extracted values.
+      ConfirmDeliveryReportsAsReceivedRequest.new(delivery_report_ids)
+    end
+  end
+end

data/lib/message_media_messages/models/confirm_delivery_reports_as_received_request_11.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # ConfirmDeliveryReportsAsReceivedRequest11 Model.
+  class ConfirmDeliveryReportsAsReceivedRequest11 < 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
+    end
+
+    def initialize(delivery_report_ids = nil)
+      @delivery_report_ids = delivery_report_ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      delivery_report_ids = hash['delivery_report_ids']
+
+      # Create object from extracted values.
+      ConfirmDeliveryReportsAsReceivedRequest11.new(delivery_report_ids)
+    end
+  end
+end

data/lib/message_media_messages/models/confirm_replies_as_received_request.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # ConfirmRepliesAsReceivedRequest Model.
+  class ConfirmRepliesAsReceivedRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [List of 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
+    end
+
+    def initialize(reply_ids = nil)
+      @reply_ids = reply_ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reply_ids = hash['reply_ids']
+
+      # Create object from extracted values.
+      ConfirmRepliesAsReceivedRequest.new(reply_ids)
+    end
+  end
+end

data/lib/message_media_messages/models/confirm_replies_as_received_request_8.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # ConfirmRepliesAsReceivedRequest8 Model.
+  class ConfirmRepliesAsReceivedRequest8 < 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
+    end
+
+    def initialize(reply_ids = nil)
+      @reply_ids = reply_ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reply_ids = hash['reply_ids']
+
+      # Create object from extracted values.
+      ConfirmRepliesAsReceivedRequest8.new(reply_ids)
+    end
+  end
+end

data/lib/message_media_messages/models/send_messages_request.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # SendMessagesRequest Model.
+  class SendMessagesRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [List of Object]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      if @_hash.nil?
+        @_hash = {}
+        @_hash['messages'] = 'messages'
+      end
+      @_hash
+    end
+
+    def initialize(messages = nil)
+      @messages = messages
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      messages = hash['messages']
+
+      # Create object from extracted values.
+      SendMessagesRequest.new(messages)
+    end
+  end
+end

data/lib/message_media_messages/models/send_messages_response.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # SendMessagesResponse Model.
+  class SendMessagesResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [List of Object]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      if @_hash.nil?
+        @_hash = {}
+        @_hash['messages'] = 'messages'
+      end
+      @_hash
+    end
+
+    def initialize(messages = nil)
+      @messages = messages
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      messages = hash['messages']
+
+      # Create object from extracted values.
+      SendMessagesResponse.new(messages)
+    end
+  end
+end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,30 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require 'json'
+require 'test/unit'
+require 'message_media_messages.rb'
+require_relative '../test_helper.rb'
+require_relative '../http_response_catcher.rb'
+
+class ControllerTestBase < Test::Unit::TestCase
+  include MessageMediaMessages
+
+  class << self
+    attr_accessor :controller
+  end
+
+  # Called only once for a test class before any test has executed.
+  def self.startup		
+    @@api_client = MessageMediaMessagesClient.new
+    @@request_timeout = 30
+    @@assert_precision = 0.01
+
+
+  end
+
+  # Called once before every test case.
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    self.class.controller.http_call_back = @response_catcher
+  end
+end

data/test/controllers/test_delivery_reports_controller.rb

@@ -0,0 +1,131 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class DeliveryReportsControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.delivery_reports
+  end
+
+  # Check for any delivery reports that have been received.
+  #Delivery reports are a notification of the change in status of a message as it is being processed.
+  #Each request to the check delivery reports endpoint will return any delivery reports received that
+  #have not yet been confirmed using the confirm delivery reports endpoint. A response from the check
+  #delivery reports endpoint will have the following structure:
+  #```json
+  #{
+  #    "delivery_reports": [
+  #        {
+  #            "callback_url": "https://my.callback.url.com",
+  #            "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",
+  #            "source_number": "+61491570157",
+  #            "date_received": "2017-05-20T06:30:37.642Z",
+  #            "status": "enroute",
+  #            "delay": 0,
+  #            "submitted_date": "2017-05-20T06:30:37.639Z",
+  #            "original_text": "My first message!",
+  #            "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",
+  #            "vendor_account_id": {
+  #                "vendor_id": "MessageMedia",
+  #                "account_id": "MyAccount"
+  #            },
+  #            "metadata": {
+  #                "key1": "value1",
+  #                "key2": "value2"
+  #            }
+  #        },
+  #        {
+  #            "callback_url": "https://my.callback.url.com",
+  #            "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",
+  #            "source_number": "+61491570158",
+  #            "date_received": "2017-05-21T01:46:42.579Z",
+  #            "status": "enroute",
+  #            "delay": 0,
+  #            "submitted_date": "2017-05-21T01:46:42.574Z",
+  #            "original_text": "My second message!",
+  #            "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",
+  #            "vendor_account_id": {
+  #                "vendor_id": "MessageMedia",
+  #                "account_id": "MyAccount"
+  #            },
+  #            "metadata": {
+  #                "key1": "value1",
+  #                "key2": "value2"
+  #            }
+  #        }
+  #    ]
+  #}
+  #```
+  #Each delivery report will contain details about the message, including any metadata specified
+  #and the new status of the message (as each delivery report indicates a change in status of a
+  #message) and the timestamp at which the status changed. Every delivery report will have a 
+  #unique delivery report ID for use with the confirm delivery reports endpoint.
+  #*Note: The source number and destination number properties in a delivery report are the inverse of
+  #those specified in the message that the delivery report relates to. The source number of the
+  #delivery report is the destination number of the original message.*
+  #Subsequent requests to the check delivery reports endpoint will return the same delivery reports
+  #and a maximum of 100 delivery reports will be returned in each request. Applications should use the
+  #confirm delivery reports endpoint in the following pattern so that delivery reports that have been
+  #processed are no longer returned in subsequent check delivery reports requests.
+  #1. Call check delivery reports endpoint
+  #2. Process each delivery report
+  #3. Confirm all processed delivery reports using the confirm delivery reports endpoint
+  #*Note: It is recommended to use the Webhooks feature to receive reply messages rather than
+  #polling the check delivery reports endpoint.*
+  def test_check_delivery_reports_1()
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.get_check_delivery_reports()
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 200)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    assert_not_nil(result)
+    assert_equal('{    "delivery_reports": [        {            "callback_url": "https://my.callback.url.com",            "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",            "source_number": "+61491570157",            "date_received": "2017-05-20T06:30:37.642Z",            "status": "enroute",            "delay": 0,            "submitted_date": "2017-05-20T06:30:37.639Z",            "original_text": "My first message!",            "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",            "vendor_account_id": {                "vendor_id": "MessageMedia",                "account_id": "MyAccount"            },            "metadata": {                "key1": "value1",                "key2": "value2"            }        },        {            "callback_url": "https://my.callback.url.com",            "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",            "source_number": "+61491570158",            "date_received": "2017-05-21T01:46:42.579Z",            "status": "enroute",            "delay": 0,            "submitted_date": "2017-05-21T01:46:42.574Z",            "original_text": "My second message!",            "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",            "vendor_account_id": {                "vendor_id": "MessageMedia",                "account_id": "MyAccount"            },            "metadata": {                "key1": "value1",                "key2": "value2"            }        }    ]}', @response_catcher.response.raw_body)
+  end
+
+  # Mark a delivery report as confirmed so it is no longer return in check delivery reports requests.
+  #The confirm delivery reports endpoint is intended to be used in conjunction with the check delivery
+  #reports endpoint to allow for robust processing of delivery reports. Once one or more delivery
+  #reports have been processed, they can then be confirmed using the confirm delivery reports endpoint so they
+  #are no longer returned in subsequent check delivery reports requests.
+  #The confirm delivery reports endpoint takes a list of delivery report IDs as follows:
+  #```json
+  #{
+  #    "delivery_report_ids": [
+  #        "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
+  #        "3487b3fa-6586-4979-a233-2d1b095c7718",
+  #        "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
+  #    ]
+  #}
+  #```
+  #Up to 100 delivery reports can be confirmed in a single confirm delivery reports request.
+  def test_confirm_delivery_reports_as_received_1()
+    # Parameters for the API call
+    body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
+      '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
+      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
+      ))
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.create_confirm_delivery_reports_as_received(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 202)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+end

data/test/controllers/test_messages_controller.rb

@@ -0,0 +1,105 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class MessagesControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.messages
+  end
+
+  # Submit one or more (up to 100 per request) SMS or text to voice messages for delivery.
+  #The most basic message has the following structure:
+  #```json
+  #{
+  #    "messages": [
+  #        {
+  #            "content": "My first message!",
+  #            "destination_number": "+61491570156"
+  #        }
+  #    ]
+  #}
+  #```
+  #More advanced delivery features can be specified by setting the following properties in a message:
+  #- ```callback_url``` A URL can be included with each message to which Webhooks will be pushed to
+  #  via a HTTP POST request. Webhooks will be sent if and when the status of the message changes as
+  #  it is processed (if the delivery report property of the request is set to ```true```) and when replies
+  #  are received. Specifying a callback URL is optional.
+  #- ```content``` The content of the message. This can be a Unicode string, up to 5,000 characters long.
+  #  Message content is required.
+  #- ```delivery_report``` Delivery reports can be requested with each message. If delivery reports are requested, a webhook
+  #  will be submitted to the ```callback_url``` property specified for the message (or to the webhooks)
+  #  specified for the account every time the status of the message changes as it is processed. The
+  #  current status of the message can also be retrieved via the Delivery Reports endpoint of the
+  #  Messages API. Delivery reports are optional and by default will not be requested.
+  #- ```destination_number``` The destination number the message should be delivered to. This should be specified in E.164
+  #  international format. For information on E.164, please refer to http://en.wikipedia.org/wiki/E.164.
+  #  A destination number is required.
+  #- ```format``` The format specifies which format the message will be sent as, ```SMS``` (text message)
+  #  or ```TTS``` (text to speech). With ```TTS``` format, we will call the destination number and read out the
+  #  message using a computer generated voice. Specifying a format is optional, by default ```SMS``` will be used.
+  #- ```source_number``` A source number may be specified for the message, this will be the number that
+  #  the message appears from on the handset. By default this feature is _not_ available and will be ignored
+  #  in the request. Please contact <support@messagemeda.com> for more information. Specifying a source
+  #  number is optional and a by default a source number will be assigned to the message.
+  #- ```source_number_type``` If a source number is specified, the type of source number may also be
+  #  specified. This is recommended when using a source address type that is not an internationally
+  #  formatted number, available options are ```INTERNATIONAL```, ```ALPHANUMERIC``` or ```SHORTCODE```. Specifying a
+  #  source number type is only valid when the ```source_number``` parameter is specified and is optional.
+  #  If a source number is specified and no source number type is specified, the source number type will be
+  #  inferred from the source number, however this may be inaccurate.
+  #- ```scheduled``` A message can be scheduled for delivery in the future by setting the scheduled property.
+  #  The scheduled property expects a date time specified in ISO 8601 format. The scheduled time must be
+  #  provided in UTC and is optional. If no scheduled property is set, the message will be delivered immediately.
+  #- ```message_expiry_timestamp``` A message expiry timestamp can be provided to specify the latest time
+  #  at which the message should be delivered. If the message cannot be delivered before the specified
+  #  message expiry timestamp elapses, the message will be discarded. Specifying a message expiry 
+  #  timestamp is optional.
+  #- ```metadata``` Metadata can be included with the message which will then be included with any delivery
+  #  reports or replies matched to the message. This can be used to create powerful two-way messaging
+  #  applications without having to store persistent data in the application. Up to 10 key / value metadata data
+  #  pairs can be specified in a message. Each key can be up to 100 characters long, and each value up to 
+  #  256 characters long. Specifying metadata for a message is optional.
+  #The response body of a successful POST request to the messages endpoint will include a ```messages```
+  #property which contains a list of all messages submitted. The list of messages submitted will
+  #reflect the list of messages included in the request, but each message will also contain two new
+  #properties, ```message_id``` and ```status```. The returned message ID will be a 36 character UUID
+  #which can be used to check the status of the message via the Get Message Status endpoint. The status
+  #of the message which reflect the status of the message at submission time which will always be
+  #```queued```. See the Delivery Reports section of this documentation for more information on message
+  #statues.
+  #*Note: when sending multiple messages in a request, all messages must be valid for the request to be successful.
+  #If any messages in the request are invalid, no messages will be sent.*
+  def test_send_messages_1()
+    # Parameters for the API call
+    body = SendMessagesRequest.from_hash(JSON.parse(
+      '{"messages":[{"callback_url":"https://my.callback.url.com","content":"My fi'\
+      'rst message","destination_number":"+61491570156","delivery_report":true,"fo'\
+      'rmat":"SMS","message_expiry_timestamp":"2016-11-03T11:49:02.807Z","metadata'\
+      '":{"key1":"value1","key2":"value2"},"scheduled":"2016-11-03T11:49:02.807Z",'\
+      '"source_number":"+61491570157","source_number_type":"INTERNATIONAL"},{"call'\
+      'back_url":"https://my.callback.url.com","content":"My second message","dest'\
+      'ination_number":"+61491570158","delivery_report":true,"format":"SMS","messa'\
+      'ge_expiry_timestamp":"2016-11-03T11:49:02.807Z","metadata":{"key1":"value1"'\
+      ',"key2":"value2"},"scheduled":"2016-11-03T11:49:02.807Z","source_number":"+'\
+      '61491570159","source_number_type":"INTERNATIONAL"}]}'
+      ))
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.create_send_messages(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 202)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    assert_not_nil(result)
+    assert_equal('{  "messages": [    {      "message_id": "04fe9a97-a579-43c5-bb1a-58ed29bf0a6a",      "callback_url": "https://my.url.com",      "status": "delivered",      "content": "My first message",      "destination_number": "+61491570156",      "delivery_report": true,      "format": "SMS",      "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",      "metadata": {        "key1": "value1",        "key2": "value2"      },      "scheduled": "2016-11-03T11:49:02.807Z",      "source_number": "+61491570157",      "source_number_type": "INTERNATIONAL"    }  ]}', @response_catcher.response.raw_body)
+  end
+
+end