losant_rest 1.8.9 → 1.9.0

data/docs/device.md

@@ -87,7 +87,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | start | string | N | Start time of export (ms since epoch - 0 means now, negative is relative to now) | 1 | 1465790400000 |
 | end | string | N | End time of export (ms since epoch - 0 means now, negative is relative to now) | 0 | 1465790400000 |
 | email | string | N | Email address to send export to. Defaults to current user's email. |  | email@example.com |
-| callbackUrl | string | N | Callback URL to call with export result. |  | https://example.com/cburl |
+| callbackUrl | string | N | Callback URL to call with export result |  | https://example.com/cburl |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/devices.md

@@ -8,6 +8,7 @@ parameters and the potential responses.
 
 *   [Export](#export)
 *   [Get](#get)
+*   [Patch](#patch)
 *   [Post](#post)
 *   [Send Command](#send-command)
 
@@ -15,7 +16,7 @@ parameters and the potential responses.
 
 ## Export
 
-Creates an export of all device metadata.
+Creates an export of all device metadata
 
 ```ruby
 result = client.devices.export(applicationId: my_application_id)
@@ -34,7 +35,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | email | string | N | Email address to send export to. Defaults to current user's email. |  | email@example.com |
-| callbackUrl | string | N | Callback URL to call with export result. |  | https://example.com/cburl |
+| callbackUrl | string | N | Callback URL to call with export result |  | https://example.com/cburl |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -78,9 +79,10 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | perPage | string | N | How many items to return per page | 1000 | 10 |
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * device |
-| deviceClass | string | N | Filter the devices by the given device class. Accepted values are: standalone, gateway, peripheral, floating, edgeCompute |  | standalone |
-| tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by. |  | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
+| deviceClass | [Device Class Filter](_schemas.md#device-class-filter) | N | Filter the devices by the given device class or classes |  | [Device Class Filter Example](_schemas.md#device-class-filter-example) |
+| tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by |  | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
+| parentId | string | N | Filter devices as children of a given system id |  | 575ecf887ae143cd83dc4aa2 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -98,6 +100,44 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 
 <br/>
 
+## Patch
+
+Update the fields of one or more devices
+
+```ruby
+result = client.devices.patch(applicationId: my_application_id)
+
+puts result
+```
+
+#### Authentication
+The client must be configured with a valid api access token to call this
+action. The token must include at least one of the following scopes:
+all.Application, all.Organization, all.User, devices.*, or devices.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| patchInfo | [Devices Patch](_schemas.md#devices-patch) | N | Object containing device filter fields and updated properties |  | [Devices Patch Example](_schemas.md#devices-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Success](_schemas.md#success) | Successfully queued bulk update job |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
 ## Post
 
 Create a new device for an application

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.15.3
+  # Built For Version 1.16.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -274,7 +274,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.15.3"
+      headers["Accept-Version"] = "^1.16.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/device.rb

@@ -91,7 +91,7 @@ module LosantRest
     # *  {string} start - Start time of export (ms since epoch - 0 means now, negative is relative to now)
     # *  {string} end - End time of export (ms since epoch - 0 means now, negative is relative to now)
     # *  {string} email - Email address to send export to. Defaults to current user's email.
-    # *  {string} callbackUrl - Callback URL to call with export result.
+    # *  {string} callbackUrl - Callback URL to call with export result
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/losant_rest/devices.rb

@@ -31,7 +31,7 @@ module LosantRest
       @client = client
     end
 
-    # Creates an export of all device metadata.
+    # Creates an export of all device metadata
     #
     # Authentication:
     # The client must be configured with a valid api
@@ -42,7 +42,7 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} email - Email address to send export to. Defaults to current user's email.
-    # *  {string} callbackUrl - Callback URL to call with export result.
+    # *  {string} callbackUrl - Callback URL to call with export result
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -95,9 +95,10 @@ module LosantRest
     # *  {string} perPage - How many items to return per page
     # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-    # *  {string} deviceClass - Filter the devices by the given device class. Accepted values are: standalone, gateway, peripheral, floating, edgeCompute
-    # *  {hash} tagFilter - Array of tag pairs to filter by. (https://api.losant.com/#/definitions/deviceTagFilter)
+    # *  {hash} deviceClass - Filter the devices by the given device class or classes (https://api.losant.com/#/definitions/deviceClassFilter)
+    # *  {hash} tagFilter - Array of tag pairs to filter by (https://api.losant.com/#/definitions/deviceTagFilter)
     # *  {string} excludeConnectionInfo - If set, do not return connection info
+    # *  {string} parentId - Filter devices as children of a given system id
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -126,6 +127,7 @@ module LosantRest
       query_params[:deviceClass] = params[:deviceClass] if params.has_key?(:deviceClass)
       query_params[:tagFilter] = params[:tagFilter] if params.has_key?(:tagFilter)
       query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
+      query_params[:parentId] = params[:parentId] if params.has_key?(:parentId)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
       query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
       query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -141,6 +143,52 @@ module LosantRest
         body: body)
     end
 
+    # Update the fields of one or more devices
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action. The token
+    # must include at least one of the following scopes:
+    # all.Application, all.Organization, all.User, devices.*, or devices.patch.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} patchInfo - Object containing device filter fields and updated properties (https://api.losant.com/#/definitions/devicesPatch)
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  201 - Successfully queued bulk update job (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application was not found (https://api.losant.com/#/definitions/error)
+    def patch(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+
+      body = params[:patchInfo] if params.has_key?(:patchInfo)
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/devices"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Create a new device for an application
     #
     # Authentication:

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.8.9"
+  VERSION = "1.9.0"
 end

data/schemas/application.json

@@ -307,6 +307,31 @@
             "bucket"
           ],
           "additionalProperties": false
+        },
+        "azure": {
+          "type": "object",
+          "properties": {
+            "account": {
+              "type": "string",
+              "min": 3,
+              "max": 24
+            },
+            "accountKey": {
+              "type": "string",
+              "max": 255
+            },
+            "bucket": {
+              "type": "string",
+              "min": 3,
+              "max": 63
+            }
+          },
+          "required": [
+            "account",
+            "accountKey",
+            "bucket"
+          ],
+          "additionalProperties": false
         }
       },
       "additionalProperties": false

data/schemas/applicationApiTokenPost.json

@@ -145,6 +145,7 @@
           "deviceRecipe.patch",
           "deviceRecipes.get",
           "deviceRecipes.post",
+          "devices.patch",
           "devices.detailedSummary",
           "devices.export",
           "devices.get",

data/schemas/applicationPatch.json

@@ -204,6 +204,31 @@
             "bucket"
           ],
           "additionalProperties": false
+        },
+        "azure": {
+          "type": "object",
+          "properties": {
+            "account": {
+              "type": "string",
+              "min": 3,
+              "max": 24
+            },
+            "accountKey": {
+              "type": "string",
+              "max": 255
+            },
+            "bucket": {
+              "type": "string",
+              "min": 3,
+              "max": 63
+            }
+          },
+          "required": [
+            "account",
+            "accountKey",
+            "bucket"
+          ],
+          "additionalProperties": false
         }
       },
       "additionalProperties": false

data/schemas/applicationPost.json

@@ -179,6 +179,31 @@
             "bucket"
           ],
           "additionalProperties": false
+        },
+        "azure": {
+          "type": "object",
+          "properties": {
+            "account": {
+              "type": "string",
+              "min": 3,
+              "max": 24
+            },
+            "accountKey": {
+              "type": "string",
+              "max": 255
+            },
+            "bucket": {
+              "type": "string",
+              "min": 3,
+              "max": 63
+            }
+          },
+          "required": [
+            "account",
+            "accountKey",
+            "bucket"
+          ],
+          "additionalProperties": false
         }
       },
       "additionalProperties": false

data/schemas/applications.json

@@ -314,6 +314,31 @@
                   "bucket"
                 ],
                 "additionalProperties": false
+              },
+              "azure": {
+                "type": "object",
+                "properties": {
+                  "account": {
+                    "type": "string",
+                    "min": 3,
+                    "max": 24
+                  },
+                  "accountKey": {
+                    "type": "string",
+                    "max": 255
+                  },
+                  "bucket": {
+                    "type": "string",
+                    "min": 3,
+                    "max": 63
+                  }
+                },
+                "required": [
+                  "account",
+                  "accountKey",
+                  "bucket"
+                ],
+                "additionalProperties": false
               }
             },
             "additionalProperties": false

data/schemas/authedDevice.json

@@ -17,7 +17,8 @@
         "gateway",
         "peripheral",
         "floating",
-        "edgeCompute"
+        "edgeCompute",
+        "system"
       ]
     },
     "token": {

data/schemas/dashboard.json

@@ -82,11 +82,11 @@
         "properties": {
           "id": {
             "type": "string",
-            "max": 14
+            "maxLength": 48
           },
           "cron": {
             "type": "string",
-            "max": 255
+            "maxLength": 255
           },
           "toEmail": {
             "type": "array",
@@ -100,11 +100,11 @@
           },
           "subject": {
             "type": "string",
-            "max": 255
+            "maxLength": 255
           },
           "message": {
             "type": "string",
-            "max": 32767
+            "maxLength": 32767
           },
           "theme": {
             "type": "string",
@@ -115,7 +115,7 @@
           },
           "timezone": {
             "type": "string",
-            "max": 255
+            "maxLength": 255
           }
         },
         "additionalProperties": false,
@@ -191,7 +191,7 @@
             "properties": {
               "id": {
                 "type": "string",
-                "maxLength": 255
+                "maxLength": 48
               },
               "title": {
                 "type": "string",
@@ -393,15 +393,34 @@
               "blockType": {
                 "type": "string",
                 "enum": [
-                  "custom-chart"
+                  "custom-chart",
+                  "custom-html"
                 ]
               },
               "config": {
                 "type": "object",
                 "properties": {
                   "configuration": {
-                    "type": "string",
-                    "maxLength": 32767
+                    "oneOf": [
+                      {
+                        "type": "object",
+                        "properties": {
+                          "headContent": {
+                            "type": "string",
+                            "maxLength": 32767
+                          },
+                          "bodyContent": {
+                            "type": "string",
+                            "maxLength": 32767
+                          }
+                        },
+                        "additionalProperties": false
+                      },
+                      {
+                        "type": "string",
+                        "maxLength": 32767
+                      }
+                    ]
                   },
                   "segments": {
                     "type": "array",
@@ -1089,7 +1108,7 @@
             "properties": {
               "id": {
                 "type": "string",
-                "maxLength": 255
+                "maxLength": 48
               },
               "title": {
                 "type": "string",
@@ -1555,6 +1574,10 @@
                         "detectDataGaps": {
                           "type": "boolean"
                         },
+                        "expression": {
+                          "type": "string",
+                          "maxLength": 255
+                        },
                         "graphType": {
                           "type": "string",
                           "enum": [
@@ -2459,7 +2482,7 @@
             "properties": {
               "id": {
                 "type": "string",
-                "maxLength": 255
+                "maxLength": 48
               },
               "title": {
                 "type": "string",