urbanairship 5.4.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f260b6f4cd6af338f251cc34c473eeb49063c7eb0daa5ad3a569f0d90a3584d
-  data.tar.gz: 160fcdd2a23b6dea6008b09b03f22a65d601555590810b3d951394aa24d8f51e
+  metadata.gz: 6d4dc107770392a93c88c327e14122fc56cb6ec8fbd17f58984df43d2661d630
+  data.tar.gz: 75c8ff88b54de9ad97fa3dbf503333bc49cd29c0fcfea2e937fe7cce5a4f3c92
 SHA512:
-  metadata.gz: 4103a2061061355627af7cfee8879fd231a8eccda95a1f5ad1a4af3be9471d8177844e8de8b9a5ba832607249cbf67928df77951da03317d8e9a6c9df209ec0b
-  data.tar.gz: 4c0e50e54f17166a734c929f33b912b9afcdb593edadf7549bf2a55b548e10b21cbcca69d687fa58dfcae2fa31579a28f355485a6034055933cd6229fdf85e49
+  metadata.gz: e6203f67400dd7581568c1307c688ae842c32c1b67532ead780a62cd3ca9aa9256511a5d6a7f0b9e68f58acc5a3e56bfc4172f5ec4bf24c622285f94f04d4bd3
+  data.tar.gz: 4c6660cdd60ed9628151f19a448ecbbdde3b43a0bff521c95ef1903874f17610c3194c467623bd37a67f95f9fea9139e1b60acaf818aa2899f0ba7f6c022591d

data/.gitignore

@@ -9,6 +9,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/csv_file
 
 # App
 urbanairship.log

data/CHANGELOG

@@ -1,3 +1,33 @@
+--------------------
+5.7.0
+--------------------
+- Adds Automation support
+- Adds A/B test support
+
+--------------------
+5.6.1
+--------------------
+- Updates EmailNotification templating 
+
+--------------------
+5.6.0
+--------------------
+- Refactors EmailNotification class
+- Adds Create and Send implementation to Open Channel class
+
+--------------------
+5.5.1
+--------------------
+- Updates validate_url method 
+
+--------------------
+5.5.0
+--------------------
+- Add Create and Send Functionality for Email
+- Add endpoints for Create and Send Validation and Scheduling
+- Add Create and Send Functionality for SMS
+- Update Rake version from 10.0 to 12.3.3
+
 --------------------
 5.4.0
 --------------------

data/docs/ab_tests.rst

@@ -0,0 +1,162 @@
+A/B Tests
+=========
+
+In this client, we format A/B tests with three nesting components. The first is the Variant,
+the difference between one kind of push and another. The Variant is a part of the Experiment
+object, with many variants in an array. Lastly. AbTest handles what Experiments along with their Variants 
+get sent to the various API endpoints. Basic pushes can be added straight to the Variant object
+on the push instance variable, or a Push object can be created, and the payload applied to the
+Variant object. For more information on this please visit: https://docs.airship.com/api/ua/#tag/a/b-tests
+
+List Existing A/B Tests
+-----------------------
+
+This endpoint will return the existing A/B tests on a project. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.limit = 5
+    ab_test.list_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code as well as a list of existing A/B tests with a
+  default offset and a limit of 5. The limit and offset are optional here. 
+
+Create A/B Test
+----------------
+
+As described above, the creation of an A/B Test consists of creating a few objects, grabbing
+pertinent data out of them, and creating an A/B Test that is as complicated or as simple as you
+like. In some cases, it might be easier to assign the payload values yourself, but as pushes,
+and the tests themselves get more complicated, it is easier to let the objects do the work for you.
+
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    variant_one = UA::Variant.new(client: airship)
+    variant_one.push = {
+        "notification": {
+            "alert": "I love cereal"
+        }
+    }
+    variant_two = UA::Variant.new(client: airship)
+    variant_two.push = {
+        "notification": {
+            "alert": "I prefer oatmeal"
+        }
+    }
+    experiment = UA::Experiment.new(client: airship)
+    experiment.name = 'Neat experiment'
+    experiment.description = 'See how neat we can get'
+    experiment.audience = 'all'
+    experiment.device_types = 'all'
+    experiment.variants << variant_one.payload
+    experiment.variants << variant_two.payload 
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_object = experiment.payload 
+    ab_test.create_ab_test
+    
+.. note::
+  
+  Should return a 201 HTTP status code as well as other information detailing specific
+  information (such as push_id) for the newly created A/B Test. 
+
+List Scheduled A/B Tests
+------------------------
+
+This will list all the scheduled A/B Tests for a project. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.list_scheduled_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code. Here, you can also apply limit and offset by assigning
+  values to the instance variables on the AbTest object. 
+
+Delete A/B Test
+----------------
+
+This will delete an A/B Test with a given experiment ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_id = '<experiment_id>'
+    ab_test.delete_ab_test
+
+.. note::
+
+    Response should be a 200 HTTP Response
+
+Validate A/B Test
+------------------
+
+Very similar to the create A/B Test endpoint, this will validate an A/B Test to 
+see if it is formatted properly. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    variant_one = UA::Variant.new(client: airship)
+    variant_one.push = {
+        "notification": {
+            "alert": "I love cereal"
+        }
+    }
+    variant_two = UA::Variant.new(client: airship)
+    variant_two.push = {
+        "notification": {
+            "alert": "I prefer oatmeal"
+        }
+    }
+    experiment = UA::Experiment.new(client: airship)
+    experiment.name = 'Neat experiment'
+    experiment.description = 'See how neat we can get'
+    experiment.audience = 'all'
+    experiment.device_types = 'all'
+    experiment.variants << variant_one.payload
+    experiment.variants << variant_two.payload 
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_object = experiment.payload 
+    ab_test.validate_ab_test
+
+.. note::
+  
+  Should return a 200 HTTP status code. 
+
+Individual A/B Test Lookup
+--------------------------
+
+This will lookup a specific A/B Test with a given experiment_id
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    ab_test = UA::AbTest.new(client: airship)
+    ab_test.experiment_id = '<experiment_id>'
+    ab_test.lookup_ab_test
+
+.. note::
+
+  Should return a 200 HTTP status code

data/docs/automations.rst

@@ -0,0 +1,212 @@
+Automations
+===========
+
+The Automation class harnesses the Pipeline class in order to provide functionality
+for creating, listing, validating, updating, and deleting pipelines. There are a lot 
+of moving parts that go into creating a pipeline, so please view our docs on that 
+topic here: https://docs.airship.com/api/ua/#schemas%2fpipelineobject
+
+List Existing Automations
+-------------------------
+
+This is for viewing existing pipeleines for a project. There are optional parameters
+that can be passed into the URI to have control over what pipelines are returned. In the
+following example a limit query of 5 will be added to the URI. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.limit = 5
+    automation.list_automations
+
+.. note::
+
+  Should return a 200 HTTP status code, and 5 of the most recent Automations
+
+Create Automation 
+-----------------
+
+This will use the Pipeline model to create an automation. You may add several
+pipelines objects to create several automations/pipelines at once. The example 
+below adds two. If you would like to just add one pipeline, forgo the array,
+and assign the pipeline payload directly to automation.pipeline_object.  
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<app_secret>')
+    pipeline_one = UA::Pipeline.new(client: airship)
+    pipeline_one.enabled = true
+    pipeline_one.immediate_trigger = {
+        "tag_added": {
+            "tag": "new_customer",
+            "group": "crm"
+        }
+    }
+    pipeline_one.outcome = {
+        "push": {
+            "audience": "triggered",
+            "device_types": "all",
+            "notification": {
+                "alert": "Hello new customer!"
+            }
+        }
+    }
+    pipeline_two = UA::Pipeline.new(client: airship)
+    pipeline_two.enabled = true
+    pipeline_two.immediate_trigger = {
+        "tag_added": {
+            "tag": "new_customer",
+            "group": "crm"
+        }
+    }
+    pipeline_two.outcome = {
+        "push": {
+            "audience": "triggered",
+            "device_types": "all",
+            "notification": {
+                "alert": "Here is a different second alert!"
+            }
+        }
+    }
+    pipelines = [pipeline_one.payload, pipeline_two.payload]
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_object = pipelines 
+    automation.create_automation
+
+.. note::
+  
+  Should return a 201 HTTP status code. 
+
+List Deleted Automations
+------------------------
+
+This is for viewing deleted pipeleines for a project. The optional param here is for "start";
+a timestamp of the starting element for paginating results in the format of YYYY-MM-DD. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.start = 2020-02-20
+    automation.list_deleted_automations
+
+.. note::
+
+  Should return a 200 HTTP status code, and the deleted automations from either most current
+  or from a given start date.
+
+Validate Automation
+-------------------
+
+This endpoint is a lot like the create automation endpoint, the basic set up is the same,
+only difference here is the method selected. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<app_secret>')
+  pipeline = UA::Pipeline.new(client: airship)
+  pipeline.enabled = true
+  pipeline.immediate_trigger = {
+      "tag_added": {
+          "tag": "new_customer",
+          "group": "crm"
+      }
+  }
+  pipeline.outcome = {
+      "push": {
+          "audience": "triggered",
+          "device_types": "all",
+          "notification": {
+              "alert": "Hello new customer!"
+          }
+      }
+  }
+  automation = UA::Automation.new(client: airship)
+  automation.pipeline_object = pipeline.payload
+  automation.validate_automation 
+
+.. note::
+  
+  Should return a 200 HTTP status code. 
+
+Individual Automation Lookup
+----------------------------
+
+This is for looking up a single automation with a given ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '86ad9239-373d-d0a5-d5d8-04fed18f79bc'
+    automation.lookup_automation
+
+.. note::
+
+  Should return a 200 HTTP status code, and the payload for the automation in question. 
+
+Update Automation
+-----------------
+
+This is for updating an existing automation. You must include the full payload from a POST 
+response, with the updates that you want to make within the payload. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    pipeline = UA::Pipeline.new(client: airship)
+    pipeline.enabled = true
+    pipeline.immediate_trigger = {
+      "tag_added": {
+         "tag": "new_tag_update",
+         "group": "Locale"
+        }
+    }
+    pipeline.outcome = {
+      "push": {
+         "audience": "triggered",
+         "device_types": "all",
+         "notification": {
+             "alert": "Newly created alert message!"
+            }
+        }
+    }
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '0f927674-918c-31ef-51ca-e96fdd234da4'
+    automation.pipeline_object = pipeline.payload 
+    automation.update_automation
+
+.. note::
+  
+  Should return a 200 HTTP status code.   
+
+Delete Automation
+-----------------
+
+This is for deleting a pipeline with a given ID. 
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    automation = UA::Automation.new(client: airship)
+    automation.pipeline_id = '86ad9239-373d-d0a5-d5d8-04fed18f79bc'
+    automation.delete_automation
+
+.. note::
+
+    Response should be a 204 No Content

data/docs/create_and_send.rst

@@ -0,0 +1,551 @@
+Create and Send
+===============
+
+The CreateAndSend class uses various notification classes as the portion of the notification
+part of the payload. Different channels that harness Create and Send will require slightly different
+implementation, and therefore, a different notification object.
+
+For more context see EmailNotification and SmsNotification to see how each class method
+operates, and how that is used to create the notification portion of the Create and Send payload.
+
+For background information visit out docs here: https://docs.airship.com/api/ua/#tag/create-and-send
+
+Create and Send Validation
+--------------------------
+
+Here, the payload that is being validated is one that would be used for email override.
+However, this validation method should work on any other create and send notification objects.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = email_notification.email_override
+    send_it.validate
+
+.. note::
+
+  Should return a 200 HTTP status code.
+
+Schedule Create and Send Operation
+----------------------------------
+
+Here, the payload that is being scheduled is one that would be used for email override.
+However, this operation method should schedule any other create and send notification objects.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = email_notification.email_override
+    send_it.name = 'Name for scheduled create and send'
+    send_it.scheduled_time =  "2019-13-29T10:34:22"
+    send_it.schedule
+
+.. note::
+
+  Should return a 201  HTTP status code.
+
+Create and Send to Email Channels
+=================================
+
+You will need to create an EmailNotification object before adding that to the notification
+field as the create and send object.
+
+Create and Send with Email Override
+-----------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to the object. The line of code here:
+`override = email_notification.email_override`
+is using a class method on EmailNotification specific for an email override in order
+to format the payload correctly for the notification portion of the CreateAndSend object.
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.bypass_opt_in_level = false
+    email_notification.html_body = "<h2>Richtext body goes here</h2><p>Wow!</p><p><a data-ua-unsubscribe=\"1\" title=\"unsubscribe\" href=\"http://unsubscribe.urbanairship.com/email/success.html\">Unsubscribe</a></p>"
+    email_notification.message_type = 'transactional'
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    email_notification.reply_to = '<reply_to address>'
+    email_notification.sender_address = '<sender_address>'
+    email_notification.sender_name = 'Sender Name'
+    email_notification.subject = 'Subject Line'
+    override = email_notification.email_override
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "test@example.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = override
+    send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send with Email Inline Template/Template ID
+------------------------------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to the object. The line of code here:
+`inline_template = email_notification.email_with_inline_template`
+is using a class method on EmailNotification specific for an inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  email_notification = UA::EmailNotification.new(client: airship)
+  email_notification.message_type = 'transactional'
+  email_notification.reply_to = 'reply_to_this@email.com'
+  email_notification.sender_address = 'sends_from_this@email.com'
+  email_notification.sender_name = 'Sender Name'
+  email_notification.template_id = "<template_id>"
+  inline_template = email_notification.email_with_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "test@example.com",
+      "ua_commercial_opted_in": "2019-12-29T10:34:22"
+    }
+  ]
+  send_it.device_types = [ "email" ]
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.notification = inline_template
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send with Email Inline Template/Fields
+-------------------------------------------------
+
+The first few lines of code are creating a EmailNotification object, and assigning
+instance variables to that object. The line of code here:
+`inline_template = email_notification.email_with_inline_template`
+is using a class method on EmailNotification specific for an inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+    require 'urbanairship'
+    UA = Urbanairship
+    airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+    email_notification = UA::EmailNotification.new(client: airship)
+    email_notification.message_type = 'transactional'
+    email_notification.reply_to = 'reply_to_this@email.com'
+    email_notification.sender_address = 'sends_from_this@email.com'
+    email_notification.sender_name = 'Sender Name''
+    email_notification.subject= "I'm sending some stuff"
+    email_notification.plaintext_body = 'Plaintext version goes here [[ua-unsubscribe href=\"http://unsubscribe.urbanairship.com/email/success.html\"]]'
+    inline_template = email_notification.email_with_inline_template
+    send_it = UA::CreateAndSend.new(client: airship)
+    send_it.addresses = [
+      {
+        "ua_address": "example@test.com",
+        "ua_commercial_opted_in": "2019-12-29T10:34:22"
+      }
+    ]
+    send_it.device_types = [ "email" ]
+    send_it.campaigns = ["winter sale", "west coast"]
+    send_it.notification = inline_template
+    send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS Channels
+================================
+
+Create and Send to SMS Override
+-------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`override = notification.sms_notification_override`
+is using a class method on SmsNotification specific for a sms override. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = inline_template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.sms_alert = "A shorter alert with a link for SMS users to click https://www.mysite.com/amazingly/long/url-that-takes-up-lots-of-characters"
+  notification.generic_alert = "A generic alert sent to all platforms without overrides in device_types"
+  notification.expiry = 172800
+  notification.shorten_links = true
+  override = notification.sms_notification_override
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_msisdn": "15558675309",
+      "ua_sender": "12345",
+      "ua_opted_in": "2018-11-11T18:45:30"
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = override
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS With Inline Template
+-------------------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`template = notification.sms_inline_template`
+is using a class method on SmsNotification specific for a sms inline template. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.sms_alert = "Hi, {{customer.first_name}}, your {{#each cart}}{{this.name}}{{/each}} are ready to pickup at our {{customer.location}} location!"
+  notification.expiry = 172800
+  notification.shorten_links = true
+  template = notification.sms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+      "customer": {
+          "first_name": "Customer Name",
+          "last_name": "Last Name",
+          "location": "Location",
+      },
+      "cart": [
+        {
+          "name": "Robot Unicorn",
+          "qty": 1
+        },
+        {
+          "name": "Holy Hand Grenade of Antioch",
+          "qty": 1
+        }
+      ]
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = template
+  send_it.campaigns = [ "order-pickup" ]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to SMS With Template ID
+---------------------------------------
+
+The first few lines of code are creating a SmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`template = notification.sms_inline_template`
+is using a class method on SmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = template`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  notification = UA::SmsNotification.new(client: airship)
+  notification.template_id = <sms_template_id_for_app>
+  notification.expiry = 172800
+  notification.shorten_links = true
+  template = notification.sms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+      "customer": {
+          "first_name": "Customer Name",
+          "last_name": "Last Name",
+          "location": "Your Location",
+      },
+      "cart": [
+        {
+          "name": "Robot Unicorn",
+          "qty": 1
+        },
+        {
+          "name": "Holy Hand Grenade of Antioch",
+          "qty": 1
+        }
+      ]
+    }
+  ]
+  send_it.device_types = [ "sms" ]
+  send_it.notification = template
+  send_it.campaigns = [ "order-pickup" ]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS Channels
+================================
+
+Create and Send to MMS Override
+-------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_override`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  override = UA::MmsNotification.new(client: airship)
+  override.fallback_text = "See https://urbanairship.com for double rainbows!"
+  override.shorten_links = true
+  override.content_length = 238686
+  override.content_type = "image/jpeg"
+  override.url = "https://www.metoffice.gov.uk/binaries/content/gallery/mohippo/images/learning/learn-about-the-weather/rainbows/full_featured_double_rainbow_at_savonlinna_1000px.jpg"
+  override.text = "A double rainbow is a wonderful sight where you get two spectacular natural displays for the price of one."
+  override.subject = "Double Rainbows"
+  mms_notification = override.mms_override
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "15558675309",
+    "ua_sender": "12345",
+    "ua_opted_in": "2018-11-11T18:45:30",
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS Template with ID
+---------------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_template_with_id`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<secret_key>')
+  override = UA::MmsNotification.new(client: airship)
+  override.template_id = "<existing_template_id>"
+  override.shorten_links = true
+  override.content_length = 19309
+  override.content_type = "image/jpeg"
+  override.url = "https://images-na.ssl-images-amazon.com/images/I/71eUHxwlMKL._AC_SX425_.jpg"
+  mms_notification = override.mms_template_with_id
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "123456789",
+    "ua_sender": "12345",
+    "ua_opted_in": "2020-01-30T18:45:30",
+    "customer": {
+              "first_name": "Phil",
+              "last_name": "Leash",
+          }
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.create_and_send
+
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to MMS with Inline Template
+-------------------------------------------
+
+The first few lines of code are creating a MmsNotification object, and assigning
+instance variables to that object. The line of code here:
+`mms_notification = override.mms_inline_template`
+is using a class method on MmsNotification specific for a sms template ID. This goes
+on to format the payload correctly for the notification portion of the CreateAndSend object
+shown in the line of code here:
+`send_it.notification = mms_notification`
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  override = UA::MmsNotification.new(client: airship)
+  override.subject = "Subject"
+  override.fallback_text = "Fallback text"
+  override.text = "Some slide text"
+  override.content_length = 123100
+  override.content_type = "image/jpeg"
+  override.url = 'image ending in allowed image types'
+  mms_notification = override.mms_inline_template
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+    "ua_msisdn": "123456789",
+    "ua_sender": "12345",
+    "ua_opted_in": "2020-01-30T18:45:30"
+    }
+  ]
+  send_it.device_types = [ "mms" ]
+  send_it.notification = mms_notification
+  send_it.create_and_send
+
+.. note::
+
+  Should return a 202 Accepted HTTP response.
+
+Create and Send to Open Channels
+================================
+
+Create and Send to Open Channels with Template ID
+-------------------------------------------------
+
+The first few lines of code are creating an OpenChannel object, and assigning
+instance variables to that object. This is essentially creating the payload that
+will be passed to notification portion of the CreateAndSend class, which ultimately
+is sending a fully constructed payload to the API. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  open_channel_notification = UA::OpenChannel.new(client:airship)
+  open_channel_notification.open_platform = 'smart_fridge'
+  open_channel_notification.template_id = "<template_id>"
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "<ua_address>",
+      "name": "Jane"
+    }
+  ]
+  send_it.device_types = [ 'open::smart_fridge' ]
+  send_it.notification = open_channel_notification.
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send
+
+Create and Send to Open Channels Override
+------------------------------------------
+
+The first few lines of code are creating an OpenChannel object, and assigning
+instance variables to that object. This is essentially creating the payload that
+will be passed to notification portion of the CreateAndSend class, which ultimately
+is sending a fully constructed payload to the API. 
+
+.. code-block:: ruby
+
+  require 'urbanairship'
+  UA = Urbanairship
+  airship = UA::Client.new(key:'<app_key>', secret:'<master_secret>')
+  open_channel_notification = UA::OpenChannel.new(client:airship)
+  open_channel_notification.open_platform = 'smart_fridge'
+  open_channel_notification.alert = 'a general alert for all open channels'
+  open_channel_notification.platform_alert = 'an alert for specific open channel platforms'
+  open_channel_notification.media_attachment = 'https://example.com/cat_standing_up.jpeg'
+  open_channel_notification.title = 'That\'s pretty neat!'
+  send_it = UA::CreateAndSend.new(client: airship)
+  send_it.addresses = [
+    {
+      "ua_address": "<ua_address>",
+      "name": "Jane"
+    }
+  ]
+  send_it.device_types = [ 'open::smart_fridge' ]
+  send_it.notification = open_channel_notification,open_channel_override
+  send_it.campaigns = ["winter sale", "west coast"]
+  send_it.create_and_send