messagemedia_messages_sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef2e715371702201b6a82045b12fe6236a4abed
-  data.tar.gz: d5e0e979766af4f86e67837289fc5877ccbc3445
+  metadata.gz: 64507452df46cd3053f21a48c11d2de7a73a1e75
+  data.tar.gz: bcef3fa3ac201bd1873b3114dd7a3294de9d7001
 SHA512:
-  metadata.gz: f6485aee0b4ab324ee4c587194f7fabdafba9d88b2a803b9b6bb86aa7088dc1a2c1996d6596ef1d3e40953d8178db60e585079efdc3b73610135692f3b5fc3d6
-  data.tar.gz: 17b11c77f4a7958c87c79f7d41254376cd3073368f761104b62319d17f043cc6f48382cc8ac00c48806967b0aee5e7dc1debbbcea17bc16036531e357110871e
+  metadata.gz: 208053caf2e5f80b12ccd4e8ca814dce587954e2d1a614036a6cb80a568814324da33c4806b16ea0ea671071338a05176e784c651e188d945e859e49693f0123
+  data.tar.gz: adea3750c6ea3f266bc46d7a3104417f8a9e7f6a08c17600dd594945f1150f6f16086716d93ab78d19cc4bf75db2314fc2c5bef496d54cf76dcdf7597e14abb2

data/README.md

@@ -1,608 +1,108 @@
-# Getting started
+# MessageMedia Messages Ruby SDK
+[![Travis Build Status](https://api.travis-ci.org/messagemedia/messages-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/messages-ruby-sdk)
+[![gem](https://img.shields.io/badge/gem-v1.1.0-red.svg)](https://rubygems.org/gems/messagemedia_messages_sdk)
 
 The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.
-
-## How to Build
-
-This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.
-
-1. Open the command line interface or the terminal and navigate to the folder containing the source code.
-2. Run ``` gem build message_media_messages.gemspec ``` to build the gem.
-3. Once built, the gem can be installed on the current work environment using ``` gem install message_media_messages-1.0.0.gem ```
-
-![Building Gem](https://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages-Ruby&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-## How to Use
-
-The following section explains how to use the MessageMediaMessages Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
-
-### 1. Starting a new project
-
-Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
-
-![Create a new project in RubyMine](https://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 1](https://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
-
-![Create a new Rails Application in RubyMine - step 2](https://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-This will create a new Rails Application project with an existing set of files and folder.
-
-### 2. Add reference of the gem
-
-In order to use the MessageMediaMessages gem in the new project we must add a gem reference. Locate the ```Gemfile``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'message_media_messages', '~> 1.0.0' ```
-
-![Add references of the Gemfile](https://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-### 3. Adding a new Rails Controller
-
-Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
-
-![Run Rails Generator on Controllers Folder](https://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
-
-![Create a new Controller](https://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
-
-![Add a new Controller](https://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
-
-![Initialize the library](https://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=MessageMediaMessages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0)
-
-## How to Test
-
-You can test the generated SDK and the server with automatically generated test
-cases as follows:
-
-  1. From terminal/cmd navigate to the root directory of the SDK.
-  2. Invoke: `bundle exec rake`
-
-## Initialization
-
-### Authentication
-In order to setup authentication and initialization of the API client, you need the following information.
-
-| Parameter | Description |
-|-----------|-------------|
-| basic_auth_user_name | The username to use with basic authentication |
-| basic_auth_password | The password to use with basic authentication |
-
-
-
-API client can be initialized as following.
-
-```ruby
-# Configuration parameters and credentials
-basic_auth_user_name = 'basic_auth_user_name' # The username to use with basic authentication
-basic_auth_password = 'basic_auth_password' # The password to use with basic authentication
-
-client = MessageMediaMessages::MessageMediaMessagesClient.new(
-  basic_auth_user_name: basic_auth_user_name,
-  basic_auth_password: basic_auth_password
-)
-```
-
-The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
-
-![Debug the TestApp](https://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=Messages-Ruby&workspaceName=MessageMediaMessages&projectName=message_media_messages&gemName=message_media_messages&gemVer=1.0.0&initLine=client%2520%253D%2520MessageMediaMessagesClient.new%2528%2527basic_auth_user_name%2527%252C%2520%2527basic_auth_password%2527%2529)
-
-
-
-# Class Reference
-
-## <a name="list_of_controllers"></a>List of Controllers
-
-* [MessagesController](#messages_controller)
-* [DeliveryReportsController](#delivery_reports_controller)
-* [RepliesController](#replies_controller)
-
-## <a name="messages_controller"></a>![Class: ](https://apidocs.io/img/class.png ".MessagesController") MessagesController
-
-### Get singleton instance
-
-The singleton instance of the ``` MessagesController ``` class can be accessed from the API Client.
-
-```ruby
-messages = client.messages
-```
-
-### <a name="update_cancel_scheduled_message"></a>![Method: ](https://apidocs.io/img/method.png ".MessagesController.update_cancel_scheduled_message") update_cancel_scheduled_message
-
-> Cancel a scheduled message that has not yet been delivered.
-> A scheduled message can be cancelled by updating the status of a message from ```scheduled```
-> to ```cancelled```. This is done by submitting a PUT request to the messages endpoint using
-> the message ID as a parameter (the same endpoint used above to retrieve the status of a message).
-> The body of the request simply needs to contain a ```status``` property with the value set
-> to ```cancelled```.
-> ```json
-> {
->     "status": "cancelled"
-> }
-> ```
-> *Note: Only messages with a status of scheduled can be cancelled. If an invalid or non existent
-> message ID parameter is specified in the request, then a HTTP 404 Not Found response will be 
-> returned*
-
-
-```ruby
-def update_cancel_scheduled_message(message_id,
-                                        body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| message_id |  ``` Required ```  | TODO: Add a parameter description |
-| body |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-message_id = 'messageId'
-body = CancelScheduledMessageRequest.new
-
-result = messages.update_cancel_scheduled_message(message_id, body)
-
-```
-
-#### Errors
-
-| Error Code | Error Description |
-|------------|-------------------|
-| 400 | TODO: Add an error description |
-| 404 | TODO: Add an error description |
-
-
-
-### <a name="get_message_status"></a>![Method: ](https://apidocs.io/img/method.png ".MessagesController.get_message_status") get_message_status
-
-> Retrieve the current status of a message using the message ID returned in the send messages end point.
-> A successful request to the get message status endpoint will return a response body as follows:
-> ```json
-> {
->     "format": "SMS",
->     "content": "My first message!",
->     "metadata": {
->         "key1": "value1",
->         "key2": "value2"
->     },
->     "message_id": "877c19ef-fa2e-4cec-827a-e1df9b5509f7",
->     "callback_url": "https://my.callback.url.com",
->     "delivery_report": true,
->     "destination_number": "+61401760575",
->     "scheduled": "2016-11-03T11:49:02.807Z",
->     "source_number": "+61491570157",
->     "source_number_type": "INTERNATIONAL"
->     "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
->     "status": "enroute"
-> }
-> ```
-> The status property of the response indicates the current status of the message. See the Delivery
-> Reports section of this documentation for more information on message statues.
-> *Note: If an invalid or non existent message ID parameter is specified in the request, then
-> a HTTP 404 Not Found response will be returned*
-
-
-```ruby
-def get_message_status(message_id); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| message_id |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-message_id = 'messageId'
-
-result = messages.get_message_status(message_id)
-
-```
-
-#### Errors
-
-| Error Code | Error Description |
-|------------|-------------------|
-| 404 | TODO: Add an error description |
-
-
-
-### <a name="create_send_messages"></a>![Method: ](https://apidocs.io/img/method.png ".MessagesController.create_send_messages") create_send_messages
-
-> 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.*
-
-
-```ruby
-def create_send_messages(body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| body |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-body_value = "{    \"messages\": [        {            \"callback_url\": \"https://my.callback.url.com\",            \"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\"        },        {            \"callback_url\": \"https://my.callback.url.com\",            \"content\": \"My second message\",            \"destination_number\": \"+61491570158\",            \"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\": \"+61491570159\",            \"source_number_type\": \"INTERNATIONAL\"        }    ]}";
-body = JSON.parse(body_value);
-
-result = messages.create_send_messages(body)
-
-```
-
-#### Errors
-
-| Error Code | Error Description |
-|------------|-------------------|
-| 400 | TODO: Add an error description |
-
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="delivery_reports_controller"></a>![Class: ](https://apidocs.io/img/class.png ".DeliveryReportsController") DeliveryReportsController
-
-### Get singleton instance
-
-The singleton instance of the ``` DeliveryReportsController ``` class can be accessed from the API Client.
-
-```ruby
-deliveryReports = client.delivery_reports
-```
-
-### <a name="get_check_delivery_reports"></a>![Method: ](https://apidocs.io/img/method.png ".DeliveryReportsController.get_check_delivery_reports") get_check_delivery_reports
-
-> 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.*
-
-
-```ruby
-def get_check_delivery_reports; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = deliveryReports.get_check_delivery_reports()
-
-```
-
-
-### <a name="create_confirm_delivery_reports_as_received"></a>![Method: ](https://apidocs.io/img/method.png ".DeliveryReportsController.create_confirm_delivery_reports_as_received") create_confirm_delivery_reports_as_received
-
-> 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.
-
-
-```ruby
-def create_confirm_delivery_reports_as_received(body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| body |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-body_value = "{    \"delivery_report_ids\": [        \"011dcead-6988-4ad6-a1c7-6b6c68ea628d\",        \"3487b3fa-6586-4979-a233-2d1b095c7718\",        \"ba28e94b-c83d-4759-98e7-ff9c7edb87a1\"    ]}";
-body = JSON.parse(body_value);
-
-result = deliveryReports.create_confirm_delivery_reports_as_received(body)
-
-```
-
-#### Errors
-
-| Error Code | Error Description |
-|------------|-------------------|
-| 400 | TODO: Add an error description |
-
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-## <a name="replies_controller"></a>![Class: ](https://apidocs.io/img/class.png ".RepliesController") RepliesController
-
-### Get singleton instance
-
-The singleton instance of the ``` RepliesController ``` class can be accessed from the API Client.
-
-```ruby
-replies = client.replies
-```
-
-### <a name="create_confirm_replies_as_received"></a>![Method: ](https://apidocs.io/img/method.png ".RepliesController.create_confirm_replies_as_received") create_confirm_replies_as_received
-
-> Mark a reply message as confirmed so it is no longer returned in check replies requests.
-> The confirm replies endpoint is intended to be used in conjunction with the check replies endpoint
-> to allow for robust processing of reply messages. Once one or more reply messages have been processed
-> they can then be confirmed using the confirm replies endpoint so they are no longer returned in
-> subsequent check replies requests.
-> The confirm replies endpoint takes a list of reply IDs as follows:
-> ```json
-> {
->     "reply_ids": [
->         "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
->         "3487b3fa-6586-4979-a233-2d1b095c7718",
->         "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
->     ]
-> }
-> ```
-> Up to 100 replies can be confirmed in a single confirm replies request.
-
-
-```ruby
-def create_confirm_replies_as_received(body); end
-```
-
-#### Parameters
-
-| Parameter | Tags | Description |
-|-----------|------|-------------|
-| body |  ``` Required ```  | TODO: Add a parameter description |
-
-
-#### Example Usage
-
-```ruby
-body_value = "{    \"reply_ids\": [        \"011dcead-6988-4ad6-a1c7-6b6c68ea628d\",        \"3487b3fa-6586-4979-a233-2d1b095c7718\",        \"ba28e94b-c83d-4759-98e7-ff9c7edb87a1\"    ]}";
-body = JSON.parse(body_value);
-
-result = replies.create_confirm_replies_as_received(body)
-
-```
-
-#### Errors
-
-| Error Code | Error Description |
-|------------|-------------------|
-| 400 | TODO: Add an error description |
-
-
-
-### <a name="get_check_replies"></a>![Method: ](https://apidocs.io/img/method.png ".RepliesController.get_check_replies") get_check_replies
-
-> Check for any replies that have been received.
-> Replies are messages that have been sent from a handset in response to a message sent by an
-> application or messages that have been sent from a handset to a inbound number associated with
-> an account, known as a dedicated inbound number (contact <support@messagemedia.com> for more
-> information on dedicated inbound numbers).
-> Each request to the check replies endpoint will return any replies received that have not yet
-> been confirmed using the confirm replies endpoint. A response from the check replies endpoint
-> will have the following structure:
-> ```json
-> {
->     "replies": [
->         {
->             "metadata": {
->                 "key1": "value1",
->                 "key2": "value2"
->             },
->             "message_id": "877c19ef-fa2e-4cec-827a-e1df9b5509f7",
->             "reply_id": "a175e797-2b54-468b-9850-41a3eab32f74",
->             "date_received": "2016-12-07T08:43:00.850Z",
->             "callback_url": "https://my.callback.url.com",
->             "destination_number": "+61491570156",
->             "source_number": "+61491570157",
->             "vendor_account_id": {
->                 "vendor_id": "MessageMedia",
->                 "account_id": "MyAccount"
->             },
->             "content": "My first reply!"
->         },
->         {
->             "metadata": {
->                 "key1": "value1",
->                 "key2": "value2"
->             },
->             "message_id": "8f2f5927-2e16-4f1c-bd43-47dbe2a77ae4",
->             "reply_id": "3d8d53d8-01d3-45dd-8cfa-4dfc81600f7f",
->             "date_received": "2016-12-07T08:43:00.850Z",
->             "callback_url": "https://my.callback.url.com",
->             "destination_number": "+61491570157",
->             "source_number": "+61491570158",
->             "vendor_account_id": {
->                 "vendor_id": "MessageMedia",
->                 "account_id": "MyAccount"
->             },
->             "content": "My second reply!"
->         }
->     ]
-> }
-> ```
-> Each reply will contain details about the reply message, as well as details of the message the reply was sent
-> in response to, including any metadata specified. Every reply will have a reply ID to be used with the
-> confirm replies endpoint.
-> *Note: The source number and destination number properties in a reply are the inverse of those
-> specified in the message the reply is in response to. The source number of the reply message is the
-> same as the destination number of the original message, and the destination number of the reply
-> message is the same as the source number of the original message. If a source number
-> wasn't specified in the original message, then the destination number property will not be present
-> in the reply message.*
-> Subsequent requests to the check replies endpoint will return the same reply messages and a maximum
-> of 100 replies will be returned in each request. Applications should use the confirm replies endpoint
-> in the following pattern so that replies that have been processed are no longer returned in
-> subsequent check replies requests.
-> 1. Call check replies endpoint
-> 2. Process each reply message
-> 3. Confirm all processed reply messages using the confirm replies endpoint
-> *Note: It is recommended to use the Webhooks feature to receive reply messages rather than polling
-> the check replies endpoint.*
-
-
-```ruby
-def get_check_replies; end
-```
-
-#### Example Usage
-
-```ruby
-
-result = replies.get_check_replies()
-
-```
-
-
-[Back to List of Controllers](#list_of_controllers)
-
-
-
+
+![Alt Text](https://media.giphy.com/media/l0Exov2QmxF5Xwjkc/giphy.gif)
+
+## ⭐️ Install via .gem file
+* Download [messagemedia_messages_sdk-1.0.0.gem](https://github.com/messagemedia/messages-ruby-sdk/releases/download/v1.0.0/messagemedia_messages_sdk-1.0.0.gem)
+run `gem install messagemedia_messages_sdk-1.0.0.gem`
+
+## 🎬 Get Started
+It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.
+
+### 🚀 Send an SMS
+* Destination numbers (`destination_number`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156`.
+```ruby
+require 'message_media_messages'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
+basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+messages = client.messages
+body_value = '{
+   "messages":[
+      {
+         "content":"My first message",
+         "destination_number":"YOUR_MOBILE_NUMBER"
+      }
+   ]
+}';
+
+body = JSON.parse(body_value);
+
+result = messages.create_send_messages(body)
+```
+
+### 🕓 Get Status of a Message
+You can get a messsage ID from a sent message by looking at the `message_id` from the response of the above example.
+```ruby
+require 'message_media_messages'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
+basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+messages = client.messages
+message_id = 'YOUR_MESSAGE_ID'
+
+result = messages.get_message_status(message_id)
+print result
+```
+
+### 💬 Get replies to a message
+You can check for replies that are sent to your messages
+```ruby
+require 'message_media_messages'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
+basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+replies = client.replies
+
+result = replies.get_check_replies()
+```
+
+### ✅ Check Delivery Reports
+This endpoint allows you to check for delivery reports to inbound and outbound messages.
+```ruby
+require 'message_media_messages'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
+basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+deliveryReports = client.delivery_reports
+
+result = deliveryReports.get_check_delivery_reports()
+```
+
+## 📕 Documentation
+The Ruby SDK Documentation can be viewed [here](DOCUMENTATION.md)
+
+## 😕 Got Stuck?
+Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)