m2x 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f99957f1081641ba2aa36bcb42ba14d060f870f
-  data.tar.gz: 12a42074fdd8c1508bde7f1873efb9afeade3d64
+  metadata.gz: 2ea07ea414cc4c26575f1aca0d20265043bb9b64
+  data.tar.gz: 978b08f9a138f519a2a319c870a1fb9dc4cb52a9
 SHA512:
-  metadata.gz: 4cd1e7dfc0385584032cf6380a8af2499b3fb14c245c1f978eba890afe0bf68360fefd7005194bb3d23d638fee1b02a417b4c18da2b13587eb3387b91185fd91
-  data.tar.gz: fa53b1cd4087a9379ac136e07ab49c721584afc7d287b6d36d4941b6feb51dac0549f9c8241b6f8abbfed8504964ee5a87277ebe8b424c39a85bc0ba4a9379b3
+  metadata.gz: 42d87fd2aeb30f4a33e71940e5afe5c3955d77c9c0af7f7c5697fac4ac97f797aeaf6577b845399caf83c9aa7cadbad7b0c76ea984db771de080d2ef7f97986d
+  data.tar.gz: ff4e72e6ff9f442e8a5ab981636d45aa106eb278790e8d764e97c801e2bb82208549486800489035b06a719c85c8e035da973d4080aa6daedf6dac0f5b91650a

data/README.md

@@ -60,6 +60,13 @@ This provides an interface to your data in M2X
   job = m2x.job("<JOB-ID>")
   ```
 
+- [Integration](lib/m2x/integration.rb)
+  ```ruby
+  integration = m2x.integration("<INTEGRATION-ID>")
+
+  integrations = m2x.integrations
+  ```
+
 Refer to the documentation on each class for further usage instructions.
 
 ## Time
@@ -80,79 +87,19 @@ m2x.time_iso8601
 => "2015-07-04T00:40:37.504Z"
 ```
 
-## Example
+## Examples
 
-In order to run this example, you will need a `Device ID` and `API Key`. If you don't have any, access your M2X account, create a new [Device](https://m2x.att.com/devices), and copy the `Device ID` and `API Key` values. The following script will send your CPU load average to three different streams named `load_1m`, `load_5m` and `load_15`. Check that there's no need to create a stream in order to write values into it.
+Scripts demonstrating usage of the M2X Ruby Client Library can be found in the [examples](/examples) directory. Each example leverages system environment variables to inject user specific information such as the M2X `API Key` or `Device ID`. Review the example you would like to try first to determine which environment variables are required (hint: search for `ENV.fetch` in the example). Then make sure to set the required environment variable(s) when running the script.
 
-In order to execute this script, run:
+For example, in order to run the [m2x-uptime](/examples/m2x-uptime.rb) script, you will need a `Device ID` and `API Key`. If you have yet to create an M2X Device, access your M2X account, create a new [Device](https://m2x.att.com/devices), and copy the `Device ID` and `API Key` values. The script will send your CPU load average to three different streams named `load_1m`, `load_5m` and `load_15`. In order to execute this script, run:
 
 ```bash
-API_KEY=<YOUR-API-KEY> DEVICE=<YOUR-DEVICE-ID> ./m2x-uptime.rb
+$ API_KEY=<YOUR-API-KEY> DEVICE=<YOUR-DEVICE-ID> ruby ./m2x-uptime.rb
 ```
 
-```ruby
-#! /usr/bin/env ruby
-
-#
-# See https://github.com/attm2x/m2x-ruby#example for instructions
-#
-
-require "time"
-require "m2x"
-
-API_KEY = ENV.fetch("API_KEY")
-DEVICE  = ENV.fetch("DEVICE")
-
-puts "M2X::Client/#{M2X::Client::VERSION} example"
-
-@run = true
-
-stop = Proc.new { @run = false }
-
-trap(:INT,  &stop)
-trap(:TERM, &stop)
-
-# Match `uptime` load averages output for both Linux and OSX
-UPTIME_RE = /(\d+\.\d+),? (\d+\.\d+),? (\d+\.\d+)$/
-
-def load_avg
-  `uptime`.match(UPTIME_RE).captures
-end
-
-m2x = M2X::Client.new(API_KEY)
-
-# Get the device
-device = m2x.device(DEVICE)
-
-# Create the streams if they don't exist
-device.create_stream("load_1m")
-device.create_stream("load_5m")
-device.create_stream("load_15m")
-
-while @run
-  load_1m, load_5m, load_15m = load_avg
-
-  # Write the different values into AT&T M2X
-  now = Time.now.iso8601
-
-  values = {
-    load_1m:  [ { value: load_1m,  timestamp: now } ],
-    load_5m:  [ { value: load_5m,  timestamp: now } ],
-    load_15m: [ { value: load_15m, timestamp: now } ]
-  }
-
-  res = device.post_updates(values: values)
-
-  abort res.json["message"] unless res.success?
-
-  sleep 1
-end
-
-puts
-
-```
+## Tutorials
 
-You can find this script in [`examples/m2x-uptime.rb`](examples/m2x-uptime.rb).
+Please refer to the [M2X Ruby Client Tutorials](TUTORIAL.md) for additional hands on examples.
 
 ## Versioning
 

data/lib/m2x.rb

@@ -8,6 +8,7 @@ require_relative "m2x/collection"
 require_relative "m2x/command"
 require_relative "m2x/device"
 require_relative "m2x/distribution"
+require_relative "m2x/integration"
 require_relative "m2x/job"
 require_relative "m2x/key"
 require_relative "m2x/stream"

data/lib/m2x/client.rb

@@ -9,7 +9,6 @@ require "openssl"
 #
 #     m2x = M2X::Client.new("<YOUR-API-KEY>")
 #     m2x.get("/some_path")
-#
 class M2X::Client
   DEFAULT_API_BASE    = "https://api-m2x.att.com".freeze
   DEFAULT_API_VERSION = "v2".freeze
@@ -33,6 +32,8 @@ class M2X::Client
   #
   # The response to this endpoint is an object in which each of its attributes
   # represents an M2X subsystem and its current status.
+  #
+  # @return {Response} the API Status
   def status
     get("/status")
   end
@@ -46,20 +47,22 @@ class M2X::Client
   end
 
   # Creates a new collection on M2X with the specified parameters
+  #
+  # See {M2X::Client::Collection.create!} for more details
   def create_collection(params)
     M2X::Client::Collection.create!(self, params)
   end
 
   # Retrieve the list of collections accessible by the authenticated API key
   #
-  # See M2X::Client::Collection.list for more details
+  # See {M2X::Client::Collection.list} for more details
   def collections(params={})
     M2X::Client::Collection.list(self, params)
   end
 
   # List Sent Commands
   #
-  # See M2X::Client::Command.list for more details
+  # See {M2X::Client::Command.list} for more details
   def commands(params={})
     M2X::Client::Command.list(self, params)
   end
@@ -73,6 +76,8 @@ class M2X::Client
   end
 
   # Send command
+  #
+  # See {M2X::Client::Command.send!} for more details
   def send_command(params)
     M2X::Client::Command.send!(self, params)
   end
@@ -86,13 +91,15 @@ class M2X::Client
   end
 
   # Creates a new device on M2X with the specified parameters
+  #
+  # See {M2X::Client::Device.create!} for more details
   def create_device(params)
     M2X::Client::Device.create!(self, params)
   end
 
   # Retrieve the list of devices accessible by the authenticated API key
   #
-  # See M2X::Client::Device.list for more details
+  # See {M2X::Client::Device.list} for more details
   def devices(params={})
     M2X::Client::Device.list(self, params)
   end
@@ -100,7 +107,7 @@ class M2X::Client
   # Retrieve the list of devices accessible by the authenticated API key that
   # meet the search criteria.
   #
-  # See M2X::Client::Device.search for more details
+  # See {M2X::Client::Device.search} for more details
   def search_devices(params={})
     M2X::Client::Device.list(self, params)
   end
@@ -112,7 +119,7 @@ class M2X::Client
   # locations, streams list, and view each Devices' stream metadata and its
   # values.
   #
-  # See M2X::Client::Device.catalog for more details
+  # See {M2X::Client::Device.catalog} for more details
   def device_catalog(params={})
     M2X::Client::Device.catalog(self, params)
   end
@@ -127,6 +134,8 @@ class M2X::Client
   end
 
   # Creates a new device distribution on M2X with the specified parameters
+  #
+  # See {M2X::Client::Distribution.create!} for more details.
   def create_distribution(params)
     M2X::Client::Distribution.create!(self, params)
   end
@@ -134,7 +143,7 @@ class M2X::Client
   # Retrieve list of device distributions accessible by the authenticated
   # API key.
   #
-  # See M2X::Client::Distribution.list for more details
+  # See {M2X::Client::Distribution.list} for more details
   def distributions(params={})
     M2X::Client::Distribution.list(self, params)
   end
@@ -161,30 +170,65 @@ class M2X::Client
   # Note that, according to the parameters sent, you can create a
   # Master API Key or a Device/Stream API Key.
   #
-  # See M2X::Client::Key.create! for more details
+  # See {M2X::Client::Key.create!} for more details
   def create_key(params)
     M2X::Client::Key.create!(self, params)
   end
 
   # Retrieve list of keys associated with the user account.
   #
-  # See M2X::Client::Key.list for more details
+  # See {M2X::Client::Key.list} for more details
   def keys
     M2X::Client::Key.list(self)
   end
 
+  # Obtain an Integration from M2X
+  #
+  # This method instantiates an instance of Integration and calls
+  # `Integration#view` method, returning the integration instance with all its
+  # attributes initialized
+  def integration(id)
+    M2X::Client::Integration.new(self, "id" => id).tap(&:view)
+  end
+
+  # Creates a new integration on M2X with the specified parameters
+  #
+  # See {M2X::Client::Integration.create!} for more details
+  def create_integration(params)
+    M2X::Client::Integration.create!(self, params)
+  end
+
+  # Retrieve list of integrations associated with the user account.
+  #
+  # See {M2X::Client::Integration.list} for more details
+  def integrations
+    M2X::Client::Integration.list(self)
+  end
+
+  # Method for {https://m2x.att.com/developer/documentation/v2/time Time} API
+  #
+  # @return (Response) text/plain response of the server time in all three formats
   def time
     get("/time").json
   end
 
+  # Method for {https://m2x.att.com/developer/documentation/v2/time Time} API
+  #
+  # @return (Response) text/plain response of the server time in seconds
   def time_seconds
     get("/time/seconds").raw
   end
 
+  # Method for {https://m2x.att.com/developer/documentation/v2/time Time} API
+  #
+  # @return (Response) text/plain response of the server time in millis
   def time_millis
     get("/time/millis").raw
   end
 
+  # Method for {https://m2x.att.com/developer/documentation/v2/time Time} API
+  #
+  # @return (Response) text/plain response of the server time in ISO 8601 Format
   def time_iso8601
     get("/time/iso8601").raw
   end

data/lib/m2x/collection.rb

@@ -1,26 +1,33 @@
 require_relative "./resource"
 require_relative "./metadata"
 
-# Wrapper for AT&T M2X Collections API
-# https://m2x.att.com/developer/documentation/v2/collections
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/collections M2X Collections} API
 class M2X::Client::Collection < M2X::Client::Resource
   include M2X::Client::Metadata
 
   PATH = "/collections"
 
   class << self
-    # Retrieve the list of collections accessible by the authenticated API key
     #
-    # https://m2x.att.com/developer/documentation/v2/collections#List-collections
+    # Method for {https://m2x.att.com/developer/documentation/v2/collections#List-collections List Collections} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Collection} objects
+    #
     def list(client, params={})
       res = client.get(PATH, params)
 
       res.json["collections"].map{ |atts| new(client, atts) } if res.success?
     end
 
-    # Create a new collection
     #
-    # https://m2x.att.com/developer/documentation/v2/collections#Create-Collection
+    # Method for {https://m2x.att.com/developer/documentation/v2/collections#Create-Collection Create Collection} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Collection} The newly created Collection.
+    #
     def create!(client, params)
       res = client.post(PATH, nil, params, "Content-Type" => "application/json")
 
@@ -33,22 +40,33 @@ class M2X::Client::Collection < M2X::Client::Resource
     @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
   end
 
+  #
+  # Method for {https://m2x.att.com/developer/documentation/v2/collections#List-Devices-from-an-existing-Collection List Devices from an existing collection} endpoint.
+  #
+  # @return (Array) List of Device objects
+  #
   def devices
     res = @client.get("#{path}/devices")
 
     res.json["devices"].map{ |atts| M2X::Client::Device.new(@client, atts) } if res.success?
   end
 
-  # Add device to collection
   #
-  # https://m2x.att.com/developer/documentation/v2/collections#Add-device-to-collection
+  # Method for {https://m2x.att.com/developer/documentation/v2/collections#Add-device-to-collection Add a device to the collection} endpoint.
+  #
+  # @param (String) device_id ID of the Device being added to Collection
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def add_device(device_id)
     @client.put("#{ path }/devices/#{ device_id }")
   end
 
-  # Remove device from collection
   #
-  # https://m2x.att.com/developer/documentation/v2/collections#Remove-device-from-collection
+  # Method for {https://m2x.att.com/developer/documentation/v2/collections#Remove-device-from-collection Remove a device from the collection} endpoint.
+  #
+  # @param (String) device_id ID of the Device being removed from Collection
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def remove_device(device_id)
     @client.delete("#{ path }/devices/#{ device_id }")
   end

data/lib/m2x/command.rb

@@ -1,5 +1,4 @@
-# Wrapper for AT&T M2X Commands API
-# https://m2x.att.com/developer/documentation/v2/commands
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/commands M2X Commands} API
 class M2X::Client::Command
   extend Forwardable
 
@@ -18,12 +17,13 @@ class M2X::Client::Command
     @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
   end
 
-  # View Command Details
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/commands#View-Command-Details View Command Details} endpoint.
   # Get details of a sent command including the delivery information for all
   # devices that were targetted by the command at the time it was sent.
   #
-  # https://m2x.att.com/developer/documentation/v2/commands#View-Command-Details
+  # @return {Command} The retrieved Command
+  #
   def view
     res = @client.get(path)
 
@@ -35,25 +35,31 @@ class M2X::Client::Command
   end
 
   class << self
-    # List Sent Commands
     #
+    # Method for {https://m2x.att.com/developer/documentation/v2/commands#List-Sent-Commands List Sent Commands} endpoint.
     # Retrieve the list of recent commands sent by the current user
     # (as given by the API key).
     #
-    # https://m2x.att.com/developer/documentation/v2/commands#List-Sent-Commands
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Command} objects
+    #
     def list(client, params={})
       res = client.get(PATH, params)
 
       res.json["commands"].map { |atts| new(client, atts) } if res.success?
     end
 
-    # Send Command
     #
+    # Method for {https://m2x.att.com/developer/documentation/v2/commands#Send-Command Send Command} endpoint.
     # Send a command with the given name to the given target devices.
     # The name should be a custom string defined by the user and understood by
     # the device.
     #
-    # https://m2x.att.com/developer/documentation/v2/commands#Send-Command
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Command} The Command that was just sent.
+    #
     def send!(client, params)
       client.post(PATH, nil, params, "Content-Type" => "application/json")
     end

data/lib/m2x/device.rb

@@ -1,58 +1,72 @@
 require_relative "./resource"
 require_relative "./metadata"
 
-# Wrapper for AT&T M2X Device API
-# https://m2x.att.com/developer/documentation/v2/device
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/device M2X Device} API
 class M2X::Client::Device < M2X::Client::Resource
   include M2X::Client::Metadata
 
   PATH = "/devices"
 
   class << self
-    # Retrieve the list of devices accessible by the authenticated API key
     #
-    # https://m2x.att.com/developer/documentation/v2/device#List-Devices
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Devices List Devices} endpoint.
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Device} objects
+    #
     def list(client, params={})
       res = client.get(PATH, params)
 
       res.json["devices"].map{ |atts| new(client, atts) } if res.success?
     end
 
-    # Retrieve the list of devices accessible by the authenticated API key that
-    # meet the search criteria.
     #
-    # https://m2x.att.com/developer/documentation/v2/device#Search-Devices
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#Search-Devices Search Devices} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Device} objects.
+    #
     def search(client, params={})
       res = client.get("#{PATH}/search", params)
 
       res.json["devices"].map{ |atts| new(client, atts) } if res.success?
     end
 
-    # Search the catalog of public Devices.
     #
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Search-Public-Devices-Catalog List Search Public Devices Catalog} endpoint.
     # This allows unauthenticated users to search Devices from other users
     # that have been marked as public, allowing them to read public Device
     # metadata, locations, streams list, and view each Devices' stream metadata
     # and its values.
     #
-    # https://m2x.att.com/developer/documentation/v2/device#List-Search-Public-Devices-Catalog
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Device} objects.
+    #
     def catalog(client, params={})
       res = client.get("#{PATH}/catalog", params)
 
       res.json["devices"].map{ |atts| new(client, atts) } if res.success?
     end
 
-    # List Device Tags
-    # Retrieve the list of device tags for the authenticated user.
     #
-    # https://m2x.att.com/developer/documentation/v2/device#List-Device-Tags
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Device-Tags List Device Tags} endpoint.
+    #
+    # @param {Client} client Client API
+    # @return (Array) Device Tags associated with the account
+    #
     def tags(client)
       client.get("#{PATH}/tags")
     end
 
-    # Create a new device
     #
-    # https://m2x.att.com/developer/documentation/v2/device#Create-Device
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#Create-Device Create Device} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Device} newly created device.
+    #
     def create!(client, params)
       res = client.post(PATH, nil, params, "Content-Type" => "application/json")
 
@@ -64,153 +78,142 @@ class M2X::Client::Device < M2X::Client::Resource
     @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
   end
 
-  # View Request Log
+  #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#View-Request-Log View Request Log} endpoint.
   # Retrieve list of HTTP requests received lately by the specified device
   # (up to 100 entries).
   #
-  # https://m2x.att.com/developer/documentation/v2/device#View-Request-Log
+  # @return (Array) Most recent API requests made against this Device
+  #
   def log
     @client.get("#{path}/log")
   end
 
-  # Get location details of an existing Device.
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location Read Device Location} endpoint.
   # Note that this method can return an empty value (response status
   # of 204) if the device has no location defined.
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location
+  # @return {Response} Most recently logged location of the Device, see M2X API docs for details
+  #
   def location
     @client.get("#{path}/location")
   end
 
-  # Read Device Location History
   #
-  # Get location history details of an existing Device. Returns the 30 most
-  # recently logged locations by default.
-  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location-History
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Read-Device-Location-History Read Device Location History} endpoint.
+  # Returns the 30 most recently logged locations by default.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) Location history of the Device
+  #
   def location_history(params = {})
     @client.get("#{path}/location/waypoints", params)
   end
 
-  # Update the current location of the specified device.
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Location
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Update-Device-Location Update Device Location} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details.
+  #
   def update_location(params)
     @client.put("#{path}/location", nil, params, "Content-Type" => "application/json")
   end
 
-  # Delete waypoints in a device's location history by a date range
+  #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Delete-Location-History Delete Location History} endpoint.
   # The `start` and `stop` parameters should be ISO8601 timestamps
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Delete-Location-History
+  # @param (String) start from time to delete the location history
+  # @param (String) stop end time to delete the location history
+  # @return {Response} The API response, see M2X API docs for details.
+  #
   def delete_locations!(start, stop)
     params = { from: start, end: stop }
 
     @client.delete("#{path}/location/waypoints", nil, params, "Content-Type" => "application/json")
   end
 
-  # Post Device Updates (Multiple Values to Multiple Streams)
-  #
-  # This method allows posting multiple values to multiple streams
-  # belonging to a device and optionally, the device location.
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Post-Device-Updates--Multiple-Values-to-Multiple-Streams- Post Device Updates (Multiple Values to Multiple Streams)} endpoint.
   # All the streams should be created before posting values using this method.
   #
-  # The `values` parameter contains an object with one attribute per each stream to be updated.
-  # The value of each one of these attributes is an array of timestamped values.
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} the API response, see M2X API docs for details
   #
-  #      {
-  #         temperature: [
-  #                        { "timestamp": <Time in ISO8601>, "value": x },
-  #                        { "timestamp": <Time in ISO8601>, "value": y },
-  #                      ],
-  #         humidity:    [
-  #                        { "timestamp": <Time in ISO8601>, "value": x },
-  #                        { "timestamp": <Time in ISO8601>, "value": y },
-  #                      ]
-  #
-  #      }
-  #
-  # The optional location attribute can contain location information that will
-  # be used to update the current location of the specified device
-  #
-  # https://m2x.att.com/developer/documentation/v2/device#Post-Device-Updates--Multiple-Values-to-Multiple-Streams-
   def post_updates(params)
     @client.post("#{path}/updates", nil, params, "Content-Type" => "application/json")
   end
 
-  # Post Device Update (Single Value to Multiple Streams)
-  #
-  # This method allows posting a single value to multiple streams
-  # belonging to a device and optionally, the device's location.
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Post-Device-Update--Single-Values-to-Multiple-Streams- Post Device Update (Single Value to Multiple Streams)} endpoint.
   # All the streams should be created before posting values using this method.
   #
-  # The `params` parameter accepts a Hash which can contain the following keys:
-  #   - values:    A Hash in which the keys are the stream names and the values
-  #                hold the stream values.
-  #   - location:  (optional) A hash with the current location of the specified
-  #                device.
-  #   - timestamp: (optional) The timestamp for all the passed values and
-  #                location. If ommited, the M2X server's time will be used.
-  #
-  #      {
-  #         values: {
-  #             temperature: 30,
-  #             humidity:    80
-  #         },
-  #         location: {
-  #           name:      "Storage Room",
-  #           latitude:  -37.9788423562422,
-  #           longitude: -57.5478776916862,
-  #           elevation: 5
-  #         }
-  #      }
-  #
-  # https://m2x.att.com/developer/documentation/v2/device#Post-Device-Update--Single-Values-to-Multiple-Streams-
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} the API response, see M2X API docs for details
+  #
   def post_update(params)
     @client.post("#{path}/update", nil, params, "Content-Type" => "application/json")
   end
 
-  # List Values from all Data Streams of a Device
   #
-  # https://m2x.att.com/developer/documentation/v2/device#List-Values-from-all-Data-Streams-of-a-Device
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Values-from-all-Data-Streams-of-a-Device List Values from all Data Streams} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of values from all the streams.
+  #
   def values(params = {})
     @client.get("#{path}/values", params)
   end
 
-  # Export Values from all Data Streams of a Device
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Export-Values-from-all-Data-Streams-of-a-Device
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Export-Values-from-all-Data-Streams-of-a-Device Export Values from all Data Streams of a Device} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} the API response, see M2X API docs for details
+  #
   def values_export(params = {})
     @client.get("#{path}/values/export.csv", params)
   end
 
-  # Search Values from all Data Streams of a Device
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Search-Values-from-all-Data-Streams-of-a-Device
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Search-Values-from-all-Data-Streams-of-a-Device Search Values from all Data Streams of a Device} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of values matching the search criteria.
+  #
   def values_search(params)
     @client.get("#{path}/values/search", nil, params, "Content-Type" => "application/json")
   end
 
-  # Retrieve list of data streams associated with the device.
   #
-  # https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams List Data Streams} endpoint.
+  #
+  # @return (Array) List of {Stream} objects.
+  #
   def streams
     ::M2X::Client::Stream.list(@client, self)
   end
 
-  # Get details of a specific data Stream associated with the device
   #
-  # https://m2x.att.com/developer/documentation/v2/device#View-Data-Stream
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#View-Data-Stream View Data Stream} endpoint.
+  #
+  # @param (String) name name of the stream to be fetched
+  # @return {Stream} The matching stream
+  #
   def stream(name)
     ::M2X::Client::Stream.fetch(@client, self, name)
   end
 
-  # Update a data stream associated with the Device
+  #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Create-Update-Data-Stream Create Update Data Stream} endpoint.
   # (if a stream with this name does not exist it gets created).
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Create-Update-Data-Stream
+  # @param (String) name Name of the stream to be updated
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Stream} The Stream being updated
+  #
   def update_stream(name, params={})
     stream = ::M2X::Client::Stream.new(@client, self, "name" => name)
 
@@ -218,51 +221,70 @@ class M2X::Client::Device < M2X::Client::Resource
   end
   alias_method :create_stream, :update_stream
 
-  # Returns a list of API keys associated with the device
+  #
+  # Method for {https://m2x.att.com/developer/documentation/v2/keys#List-Keys List Keys} endpoint.
+  #
+  # @return (Array) List of {Key} objects.
+  #
   def keys
     ::M2X::Client::Key.list(@client, params.merge(device: self["id"]))
   end
 
-  # Creates a new API key associated to the device
   #
-  # If a parameter named `stream` is supplied with a stream name, it
-  # will create an API key associated with that stream only.
+  # Method for {https://m2x.att.com/developer/documentation/v2/keys#Create-Key Create Key} endpoint.
+  # Note that, according to the parameters sent, you can create a
+  # Master API Key or a Device/Stream API Key.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Key} The newly created Key.
+  #
   def create_key(params)
     ::M2X::Client::Key.create!(@client, params.merge(device: self["id"]))
   end
 
-  # Device's List of Received Commands
   #
-  # Retrieve the list of recent commands sent to the current device (as given by the API key).
+  # Method for {https://m2x.att.com/developer/documentation/v2/commands#Device-s-List-of-Received-Commands Device's List of Recieved Commands} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of {Command} objects.
   #
-  # https://m2x.att.com/developer/documentation/v2/commands#Device-s-List-of-Received-Commands
   def commands(params = {})
     res = @client.get("#{path}/commands", params)
 
     res.json["commands"].map { |atts| M2X::Client::Command.new(@client, atts) } if res.success?
   end
 
-  # Device's View of Command Details
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/commands#Device-s-View-of-Command-Details Device's View of Command Details} endpoint.
   # Get details of a received command including the delivery information for this device.
   #
-  # https://m2x.att.com/developer/documentation/v2/commands#Device-s-View-of-Command-Details
+  # @param (String) id Command ID to get
+  # @return {Command} object retrieved
+  #
   def command(id)
     res = @client.get("#{path}/commands/#{id}")
 
     M2X::Client::Command.new(@client, res.json) if res.success?
   end
 
-  # Process a command
   #
-  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Processed
+  # Method for {https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Processed Process Command} endpoint.
+  #
+  # @param (String) id Command ID to process
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def process_command(id, params = {})
     @client.post("#{path}/commands/#{id}/process", nil, params)
   end
 
-  # Reject a command
   #
-  # https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Rejected
+  # Method for {https://m2x.att.com/developer/documentation/v2/commands#Device-Marks-a-Command-as-Rejected Reject Command} endpoint.
+  #
+  # @param (String) id Command ID to process
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def reject_command(id, params = {})
     @client.post("#{path}/commands/#{id}/reject", nil, params)
   end

data/lib/m2x/distribution.rb

@@ -1,18 +1,22 @@
 require_relative "./resource"
 require_relative "./metadata"
 
-# Wrapper for AT&T M2X Distribution API
-# https://m2x.att.com/developer/documentation/v2/distribution
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/distribution M2X Distribution} API
 class M2X::Client::Distribution < M2X::Client::Resource
   include M2X::Client::Metadata
 
   PATH = "/distributions"
 
   class << self
+    #
+    # Method for {https://m2x.att.com/developer/documentation/v2/distribution#List-Distributions List Distributions} endpoint.
     # Retrieve list of device distributions accessible by the authenticated
     # API key.
     #
-    # https://m2x.att.com/developer/documentation/v2/distribution#List-Distributions
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Distribution} objects
+    #
     def list(client, params={})
       res = client.get(PATH, params)
 
@@ -20,9 +24,13 @@ class M2X::Client::Distribution < M2X::Client::Resource
     end
     alias_method :search, :list
 
-    # Create a new device distribution
     #
-    # https://m2x.att.com/developer/documentation/v2/distribution#Create-Distribution
+    # Method for {https://m2x.att.com/developer/documentation/v2/distribution#Create-Distribution Create Distribution} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Distribution} The newly created Distribution.
+    #
     def create!(client, params)
       res = client.post(PATH, nil, params, "Content-Type" => "application/json")
 
@@ -34,21 +42,24 @@ class M2X::Client::Distribution < M2X::Client::Resource
     @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
   end
 
-  # Retrieve list of devices added to the specified distribution.
   #
-  # https://m2x.att.com/developer/documentation/v2/distribution#List-Devices-from-an-existing-Distribution
+  # Method for {https://m2x.att.com/developer/documentation/v2/distribution#List-Devices-from-an-existing-Distribution List Devices from an existing Distribution} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of Device objects
+  #
   def devices(params={})
     res = @client.get("#{path}/devices", params)
 
     res.json["devices"].map{ |atts| ::M2X::Client::Device.new(@client, atts) } if res.success?
   end
 
-  # Add a new device to an existing distribution
   #
-  # Accepts a `serial` parameter, that must be a unique identifier
-  # within this distribution.
+  # Method for {https://m2x.att.com/developer/documentation/v2/distribution#Add-Device-to-an-existing-Distribution Add Device to an existing Distribution} endpoint.
+  #
+  # @param (String) serial The unique (account-wide) serial for the DistributionDevice being added
+  # @return {Device} The newly created DistributionDevice
   #
-  # https://m2x.att.com/developer/documentation/v2/distribution#Add-Device-to-an-existing-Distribution
   def add_device(serial)
     res = @client.post("#{path}/devices", nil, { serial: serial }, "Content-Type" => "application/json")
 

data/lib/m2x/integration.rb

@@ -0,0 +1,55 @@
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/integrations M2X Integrations} API
+class M2X::Client::Integration < M2X::Client::Resource
+  PATH = "/integrations"
+
+  class << self
+    #
+    # Method for {https://m2x.att.com/developer/documentation/v2/integrations#List-Integrations List Integrations} endpoint.
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Integration} objects
+    #
+    def list(client, params={})
+      res = client.get(PATH, params)
+
+      res.json["integrations"].map{ |atts| new(client, atts) } if res.success?
+    end
+
+    #
+    # Method for {https://m2x.att.com/developer/documentation/v2/integrations#Create-Integration Create Integration} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Device} newly created device.
+    #
+    def create!(client, params)
+      res = client.post(PATH, nil, params, "Content-Type" => "application/json")
+
+      new(client, res.json) if res.success?
+    end
+  end
+
+  def path
+    @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("id")) }"
+  end
+
+  # Method for {https://m2x.att.com/developer/documentation/v2/integrations#Update-Integration-Status Update Integration Status} endpoint.
+  #
+  # @param (String) id Command ID to process
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details
+  #
+  def update_status(params = {})
+    @client.put("#{path}/status", nil, params)
+  end
+
+  # Method for {https://m2x.att.com/developer/documentation/v2/integrations#View-Integration-Status-Details View Integration Status Details} endpoint.
+  #
+  # @param (String) id Command ID to process
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details
+  #
+  def view_status
+    @client.get("#{path}/status")
+  end
+end

data/lib/m2x/job.rb

@@ -1,7 +1,6 @@
 require_relative "./resource"
 
-# Wrapper for AT&T M2X Job API
-# https://m2x.att.com/developer/documentation/v2/jobs
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/jobs M2X Job} API.
 class M2X::Client::Job < M2X::Client::Resource
 
   PATH = "/jobs"

data/lib/m2x/key.rb

@@ -1,27 +1,33 @@
 require_relative "./resource"
 
-# Wrapper for AT&T M2X Keys API
-# https://m2x.att.com/developer/documentation/v2/keys
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/keys M2X Keys} API
 class M2X::Client::Key < M2X::Client::Resource
 
   PATH = "/keys"
 
   class << self
-    # Retrieve list of keys associated with the user account.
     #
-    # https://m2x.att.com/developer/documentation/v2/keys#List-Keys
+    # Method for {https://m2x.att.com/developer/documentation/v2/keys#List-Keys List Keys} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return (Array) List of {Key} objects.
+    #
     def list(client, params={})
       res = client.get(PATH, params)
 
       res.json["keys"].map{ |atts| new(client, atts) } if res.success?
     end
 
-    # Create a new API Key
     #
+    # Method for {https://m2x.att.com/developer/documentation/v2/keys#Create-Key Create Key} endpoint.
     # Note that, according to the parameters sent, you can create a
     # Master API Key or a Device/Stream API Key.
     #
-    # https://m2x.att.com/developer/documentation/v2/keys#Create-Key
+    # @param {Client} client Client API
+    # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+    # @return {Key} The newly created Key.
+    #
     def create!(client, params={})
       res = client.post(PATH, nil, params, "Content-Type" => "application/json")
 
@@ -33,13 +39,14 @@ class M2X::Client::Key < M2X::Client::Resource
     @path ||= "#{ PATH }/#{ URI.encode(@attributes.fetch("key")) }"
   end
 
-  # Regenerate an API Key token
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/keys#Regenerate-Key Regenerate Key} endpoint.
   # Note that if you regenerate the key that you're using for
   # authentication then you would need to change your scripts to
   # start using the new key token for all subsequent requests.
   #
-  # https://m2x.att.com/developer/documentation/v2/keys#Regenerate-Key
+  # @return {Key} The regenerated key.
+  #
   def regenerate
     res = @client.post("#{path}/regenerate", nil, {})
 

data/lib/m2x/metadata.rb

@@ -1,37 +1,52 @@
 module M2X::Client::Metadata
 
-  # Read an object's metadata
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata
-  # https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata
-  # https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata
+  # Method for
+  # {https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata Read Device Metadata},
+  # {https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata Read Distribution Metadata},
+  # {https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata Read Collection Metadata} endpoints.
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def read_metadata
     @client.get(metadata_path)
   end
 
-  # Read a single field of an object's metadata
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata-Field
-  # https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field
-  # https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata-Field
+  # Method for
+  # {https://m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata-Field Read Device Metadata Field},
+  # {https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field Read Distribution Metadata Field},
+  # {https://m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata-Field Read Collection Metadata Field} endpoints.
+  #
+  # @param (String) field_name The metada field to be read
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def read_metadata_field(field_name)
     @client.get("#{metadata_path}/#{field_name}")
   end
 
-  # Update an object's metadata
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata
-  # https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata
-  # https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata
+  # Method for
+  # {https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata Update Device Metadata},
+  # {https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata Update Distribution Metadata},
+  # {https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata Update Collection Metadata} endpoints.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def update_metadata(params)
     @client.put(metadata_path, nil, params, "Content-Type" => "application/json")
   end
 
-  # Update a single field of an object's metadata
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata-Field
-  # https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field
-  # https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata-Field
+  # Method for
+  # {https://m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata-Field Update Device Metadata Field},
+  # {https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field Update Distribution Metadata Field},
+  # {https://m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata-Field Update Collection Metadata Field} endpoints.
+  #
+  # @param (String) field_name The metadata field to be updated
+  # @param (String) value The value to be updated
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def update_metadata_field(field_name, value)
     @client.put("#{metadata_path}/#{field_name}", nil, { value: value }, "Content-Type" => "application/json")
   end

data/lib/m2x/stream.rb

@@ -1,22 +1,30 @@
 require_relative "./resource"
 
-# Wrapper for AT&T M2X Data Streams API
-# https://m2x.att.com/developer/documentation/v2/device
+# Wrapper for {https://m2x.att.com/developer/documentation/v2/device M2X Data Streams} API.
 class M2X::Client::Stream < M2X::Client::Resource
 
   class << self
-    # Get details of a specific data Stream associated with a device
     #
-    # https://m2x.att.com/developer/documentation/v2/device#View-Data-Stream
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#View-Data-Stream View Data Streams} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param (String) device device to fetch
+    # @param (String) name of the stream to be fetched
+    # @return {Stream} fetched stream
+    #
     def fetch(client, device, name)
       res = client.get("#{device.path}/streams/#{URI.encode(name)}")
 
       new(client, device, res.json) if res.success?
     end
 
-    # Retrieve list of data streams associated with a device.
     #
-    # https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams
+    # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Data-Streams List Data Streams} endpoint.
+    #
+    # @param {Client} client Client API
+    # @param (String) device device to get its data streams
+    # @return (Array) List of {Stream} objects
+    #
     def list(client, device)
       res = client.get("#{device.path}/streams")
 
@@ -34,48 +42,60 @@ class M2X::Client::Stream < M2X::Client::Resource
     @path ||= "#{@device.path}/streams/#{ URI.encode(@attributes.fetch("name")) }"
   end
 
-  # Update stream properties
-  # (if the stream does not exist it gets created).
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Create-Update-Data-Stream
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Create-Update-Data-Stream Create Update Data Stream} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return {Stream} The newly created stream
+  #
   def update!(params)
-    res = @client.put(path, {}, params, "Content-Type" => "application/json")
-
-    @attributes = res.json if res.status == 201
+    @client.put(path, {}, params, "Content-Type" => "application/json").tap do |res|
+      @attributes = res.json if res.status == 201
+    end
   end
 
-  # List values from the stream, sorted in reverse chronological order
-  # (most recent values first).
   #
-  # https://m2x.att.com/developer/documentation/v2/device#List-Data-Stream-Values
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#List-Data-Stream-Values List Data Stream Values} endpoint.
+  #
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of values from the stream
+  #
   def values(params={})
     @client.get("#{path}/values", params)
   end
 
-  # Sample values from the stream, sorted in reverse chronological order
-  # (most recent values first).
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Sampling Data Stream Sampling} endpoint.
   # This method only works for numeric streams
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Sampling
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) List of sample values from the stream
+  #
   def sampling(params)
     @client.get("#{path}/sampling", params)
   end
 
-  # Return count, min, max, average and standard deviation stats for the
-  # values of the stream.
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Stats Data Stream Stats} endpoint.
+  # Returns the count, min, max, average and standard deviation stats for the
+  # values of the stream.
   # This method only works for numeric streams
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Data-Stream-Stats
+  # @param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
+  # @return (Array) Stats of the stream
+  #
   def stats(params={})
     @client.get("#{path}/stats", params)
   end
 
-  # Update the current value of the stream. The timestamp
-  # is optional. If omitted, the current server time will be used
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Update-Data-Stream-Value
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Update-Data-Stream-Value Update Data Stream Value} endpoint.
+  # The timestamp is optional. If omitted, the current server time will be used
+  #
+  # @param (String) value Value to be updated
+  # @param (String) timestamp Current Timestamp
+  # @return void
+  #
   def update_value(value, timestamp=nil)
     params = { value: value }
 
@@ -84,27 +104,33 @@ class M2X::Client::Stream < M2X::Client::Resource
     @client.put("#{path}/value", nil, params, "Content-Type" => "application/json")
   end
 
-  # Post multiple values to the stream
   #
+  # Method for {https://m2x.att.com/developer/documentation/v2/device#Post-Data-Stream-Values Post Data Stream Values} endpoint.
+  # Post multiple values to the stream
   # The `values` parameter is an array with the following format:
-  #
   #     [
   #       { "timestamp": <Time in ISO8601>, "value": x },
   #       { "timestamp": <Time in ISO8601>, "value": y },
   #       [ ... ]
   #     ]
   #
-  # https://m2x.att.com/developer/documentation/v2/device#Post-Data-Stream-Values
+  # @param values The values being posted, formatted according to the API docs
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def post_values(values)
     params = { values: values }
 
     @client.post("#{path}/values", nil, params, "Content-Type" => "application/json")
   end
 
-  # Delete values in a stream by a date range
+  #
+  # Method for {https://m2x.com/developer/documentation/v2/device#Delete-Data-Stream-Values Delete Data Stream Values} endpoint.
   # The `start` and `stop` parameters should be ISO8601 timestamps
   #
-  # https://m2x.com/developer/documentation/v2/device#Delete-Data-Stream-Values
+  # @param (String) start from time to delete the data
+  # @param (String) stop end time to delete the data
+  # @return {Response} The API response, see M2X API docs for details
+  #
   def delete_values!(start, stop)
     params = { from: start, end: stop }
 

data/lib/m2x/version.rb

@@ -1,5 +1,5 @@
 module M2X
   class Client
-    VERSION = "2.7.0"
+    VERSION = "2.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m2x
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Leandro López
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies: []
 description: AT&T’s M2X is a cloud-based fully managed data storage service for network
   connected machine-to-machine (M2M) devices. From trucks and turbines to vending
@@ -33,6 +33,7 @@ files:
 - lib/m2x/command.rb
 - lib/m2x/device.rb
 - lib/m2x/distribution.rb
+- lib/m2x/integration.rb
 - lib/m2x/job.rb
 - lib/m2x/key.rb
 - lib/m2x/metadata.rb
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby client for AT&T M2X