losant_rest 1.8.4 → 1.8.5

data/docs/application.md

@@ -151,6 +151,8 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| summaryExclude | string | N | Comma seperated list of summary fields to exclude from application summary |  | payloadCount |
+| summaryInclude | string | N | Comma seperated list of summary fields to include in application summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/applications.md

@@ -37,6 +37,8 @@ all.Organization, all.Organization.read, all.User, all.User.read, applications.*
 | 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 * app |
 | orgId | string | N | If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id. |  | 575ecdf07ae143cd83dc4a9a |
+| summaryExclude | string | N | Comma seperated list of summary fields to exclude from application summary |  | payloadCount |
+| summaryInclude | string | N | Comma seperated list of summary fields to include in application summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/dashboard.md

@@ -9,6 +9,7 @@ parameters and the potential responses.
 *   [Delete](#delete)
 *   [Get](#get)
 *   [Patch](#patch)
+*   [Send Report](#send-report)
 *   [Validate Context](#validate-context)
 
 <br/>
@@ -126,6 +127,46 @@ all.Organization, all.User, dashboard.*, or dashboard.patch.
 
 <br/>
 
+## Send Report
+
+Sends a snapshot of a dashboard
+
+```ruby
+result = client.dashboard.send_report(
+  dashboardId: my_dashboard_id,
+  reportConfig: my_report_config)
+
+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.Organization, all.User, dashboard.*, or dashboard.sendReport.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| dashboardId | string | Y | ID of the associated dashboard |  | 575ece2b7ae143cd83dc4a9b |
+| reportConfig | [Dashboard Send Report](_schemas.md#dashboard-send-report) | Y | Object containing report options |  | [Dashboard Send Report Example](_schemas.md#dashboard-send-report-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | Send dashboard report |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if dashboard was not found |
+
+<br/>
+
 ## Validate Context
 
 Validates a context object against the dashboard&#x27;s context configuration
@@ -154,11 +195,11 @@ No api access token is required to call this action.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If context is valid |
+| 200 | [Validate Context Success](_schemas.md#validate-context-success) | If context is valid |
 
 #### Error Responses
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 400 | [Error](_schemas.md#error) | Error if context is invalid |
+| 400 | [Validate Context Error](_schemas.md#validate-context-error) | Error if context is invalid |
 | 404 | [Error](_schemas.md#error) | Error if dashboard or application was not found |

data/docs/me.md

@@ -329,7 +329,8 @@ all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.ge
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | includeRecent | undefined | N | Should the user include recent app/dashboard info |  | true |
-| summaryExclude | string | N | List of summary fields to exclude from user summary |  | payloadCount |
+| summaryExclude | string | N | Comma seperated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma seperated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/org.md

@@ -76,7 +76,8 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
-| summaryExclude | string | N | List of summary fields to exclude from org summary |  | payloadCount |
+| summaryExclude | string | N | Comma seperated list of summary fields to exclude from org summary |  | payloadCount |
+| summaryInclude | string | N | Comma seperated list of summary fields to include in org summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/orgs.md

@@ -36,7 +36,8 @@ all.User, all.User.read, orgs.*, or orgs.get.
 | 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*org |
-| summaryExclude | string | N | List of summary fields to exclude from org summaries |  | payloadCount |
+| summaryExclude | string | N | Comma seperated list of summary fields to exclude from org summaries |  | payloadCount |
+| summaryInclude | string | N | Comma seperated list of summary fields to include in org summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/lib/losant_rest/application.rb

@@ -174,6 +174,8 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
+    # *  {string} summaryExclude - Comma seperated list of summary fields to exclude from application summary
+    # *  {string} summaryInclude - Comma seperated list of summary fields to include in application summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -193,6 +195,8 @@ module LosantRest
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
 
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)

data/lib/losant_rest/applications.rb

@@ -45,6 +45,8 @@ module LosantRest
     # *  {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} orgId - If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id.
+    # *  {string} summaryExclude - Comma seperated list of summary fields to exclude from application summary
+    # *  {string} summaryInclude - Comma seperated list of summary fields to include in application summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -69,6 +71,8 @@ module LosantRest
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
       query_params[:orgId] = params[:orgId] if params.has_key?(:orgId)
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)

data/lib/losant_rest/client.rb

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

data/lib/losant_rest/dashboard.rb

@@ -163,6 +163,53 @@ module LosantRest
         body: body)
     end
 
+    # Sends a snapshot of a dashboard
+    #
+    # 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.Organization, all.User, dashboard.*, or dashboard.sendReport.
+    #
+    # Parameters:
+    # *  {string} dashboardId - ID of the associated dashboard
+    # *  {hash} reportConfig - Object containing report options (https://api.losant.com/#/definitions/dashboardSendReport)
+    # *  {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:
+    # *  200 - Send dashboard report (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if dashboard was not found (https://api.losant.com/#/definitions/error)
+    def send_report(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("dashboardId is required") unless params.has_key?(:dashboardId)
+      raise ArgumentError.new("reportConfig is required") unless params.has_key?(:reportConfig)
+
+      body = params[:reportConfig] if params.has_key?(:reportConfig)
+      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 = "/dashboards/#{params[:dashboardId]}"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Validates a context object against the dashboard's context configuration
     #
     # Authentication:
@@ -178,10 +225,10 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If context is valid (https://api.losant.com/#/definitions/success)
+    # *  200 - If context is valid (https://api.losant.com/#/definitions/validateContextSuccess)
     #
     # Errors:
-    # *  400 - Error if context is invalid (https://api.losant.com/#/definitions/error)
+    # *  400 - Error if context is invalid (https://api.losant.com/#/definitions/validateContextError)
     # *  404 - Error if dashboard or application was not found (https://api.losant.com/#/definitions/error)
     def validate_context(params = {})
       params = Utils.symbolize_hash_keys(params)

data/lib/losant_rest/me.rb

@@ -387,7 +387,8 @@ module LosantRest
     #
     # Parameters:
     # *  {undefined} includeRecent - Should the user include recent app/dashboard info
-    # *  {string} summaryExclude - List of summary fields to exclude from user summary
+    # *  {string} summaryExclude - Comma seperated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma seperated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -406,6 +407,7 @@ module LosantRest
 
       query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
       query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)

data/lib/losant_rest/org.rb

@@ -83,7 +83,8 @@ module LosantRest
     #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
-    # *  {string} summaryExclude - List of summary fields to exclude from org summary
+    # *  {string} summaryExclude - Comma seperated list of summary fields to exclude from org summary
+    # *  {string} summaryInclude - Comma seperated list of summary fields to include in org summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -104,6 +105,7 @@ module LosantRest
       raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
 
       query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)

data/lib/losant_rest/orgs.rb

@@ -44,7 +44,8 @@ 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} summaryExclude - List of summary fields to exclude from org summaries
+    # *  {string} summaryExclude - Comma seperated list of summary fields to exclude from org summaries
+    # *  {string} summaryInclude - Comma seperated list of summary fields to include in org summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -69,6 +70,7 @@ module LosantRest
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
       query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.8.4"
+  VERSION = "1.8.5"
 end

data/schemas/compositeDeviceState.json

@@ -33,9 +33,6 @@
               ]
             }
           ]
-        },
-        "relayId": {
-          "type": "string"
         }
       }
     }

data/schemas/dashboard.json

@@ -297,6 +297,9 @@
                   "additionalProperties": false
                 },
                 "maxItems": 100
+              },
+              "includeFullDevice": {
+                "type": "boolean"
               }
             },
             "additionalProperties": false

data/schemas/dashboardPatch.json

@@ -256,6 +256,9 @@
                   "additionalProperties": false
                 },
                 "maxItems": 100
+              },
+              "includeFullDevice": {
+                "type": "boolean"
               }
             },
             "additionalProperties": false

data/schemas/dashboardPost.json

@@ -264,6 +264,9 @@
                   "additionalProperties": false
                 },
                 "maxItems": 100
+              },
+              "includeFullDevice": {
+                "type": "boolean"
               }
             },
             "additionalProperties": false

data/schemas/dashboardSendReport.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "required": [
+    "toEmail"
+  ],
+  "properties": {
+    "toEmail": {
+      "type": "array",
+      "min": 1,
+      "max": 10,
+      "items": {
+        "type": "string",
+        "format": "email",
+        "maxLength": 1024
+      }
+    },
+    "subject": {
+      "type": "string",
+      "max": 255
+    },
+    "message": {
+      "type": "string",
+      "max": 32767
+    },
+    "theme": {
+      "type": "string",
+      "enum": [
+        "dark",
+        "light"
+      ]
+    },
+    "time": {
+      "type": "number"
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/dashboards.json

@@ -304,6 +304,9 @@
                         "additionalProperties": false
                       },
                       "maxItems": 100
+                    },
+                    "includeFullDevice": {
+                      "type": "boolean"
                     }
                   },
                   "additionalProperties": false

data/schemas/deviceState.json

@@ -24,9 +24,6 @@
         }
       ]
     },
-    "relayId": {
-      "type": "string"
-    },
     "meta": {},
     "data": {
       "type": "object",

data/schemas/deviceStateOrStates.json

@@ -28,9 +28,6 @@
             }
           ]
         },
-        "relayId": {
-          "type": "string"
-        },
         "meta": {},
         "data": {
           "type": "object",
@@ -87,9 +84,6 @@
               }
             ]
           },
-          "relayId": {
-            "type": "string"
-          },
           "meta": {},
           "data": {
             "type": "object",

data/schemas/deviceStates.json

@@ -28,9 +28,6 @@
           }
         ]
       },
-      "relayId": {
-        "type": "string"
-      },
       "meta": {},
       "data": {
         "type": "object",