losant_rest 1.16.3 → 1.16.5

data/docs/dashboard.md

@@ -189,6 +189,8 @@ No api access token is required to call this action.
 | dashboardId | string | Y | ID of the associated dashboard |  | 575ece2b7ae143cd83dc4a9b |
 | ctx | [Dashboard Context Instance](_schemas.md#dashboard-context-instance) | Y | The context object to validate |  | [Dashboard Context Instance Example](_schemas.md#dashboard-context-instance-example) |
 | password | string | N | Password for password-protected dashboards |  | myPassword |
+| duration | string | N | Duration of data to fetch in milliseconds |  | 3600000 |
+| resolution | string | N | Resolution in milliseconds |  | 60000 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/device.md

@@ -131,6 +131,8 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -345,6 +347,8 @@ all.Application, all.Organization, all.User, device.*, or device.patch.
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | device | [Device Patch](_schemas.md#device-patch) | Y | Object containing new properties of the device |  | [Device Patch Example](_schemas.md#device-patch-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/devices.md

@@ -212,6 +212,8 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | excludeConnectionInfo | string | N | If set, do not return connection info |  | true |
 | parentId | string | N | Filter devices as children of a given system id |  | 575ecf887ae143cd83dc4aa2 |
 | query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. |  | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -331,6 +333,8 @@ all.Application, all.Organization, all.User, devices.*, or devices.post.
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | device | [Device Post](_schemas.md#device-post) | Y | New device information |  | [Device Post Example](_schemas.md#device-post-example) |
+| tagsAsObject | string | N | Return tags as an object map instead of an array. |  | true |
+| attributesAsObject | string | N | Return attributes as an object map instead of an array. |  | false |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/me.md

@@ -13,6 +13,7 @@ parameters and the potential responses.
 *   [Disconnect Github](#disconnect-github)
 *   [Enable Two Factor Auth](#enable-two-factor-auth)
 *   [Fetch Recent Items](#fetch-recent-items)
+*   [Generate Two Factor Auth](#generate-two-factor-auth)
 *   [Get](#get)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
@@ -274,6 +275,41 @@ all.User, all.User.read, me.*, or me.fetchRecentItems.
 
 <br/>
 
+## Generate Two Factor Auth
+
+Returns the two factor auth key for a user
+
+```ruby
+result = client.me.generate_two_factor_auth(optional_params)
+
+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.User, me.*, or me.generateTwoFactorAuth.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Two Factor Auth Info](_schemas.md#two-factor-auth-info) | Updated user information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
 ## Get
 
 Retrieves information on the current user

data/lib/losant_rest/client.rb

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

data/lib/losant_rest/dashboard.rb

@@ -221,6 +221,8 @@ module LosantRest
     # *  {string} dashboardId - ID of the associated dashboard
     # *  {hash} ctx - The context object to validate (https://api.losant.com/#/definitions/dashboardContextInstance)
     # *  {string} password - Password for password-protected dashboards
+    # *  {string} duration - Duration of data to fetch in milliseconds
+    # *  {string} resolution - Resolution in milliseconds
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -243,6 +245,8 @@ module LosantRest
 
       body = params[:ctx] if params.has_key?(:ctx)
       query_params[:password] = params[:password] if params.has_key?(:password)
+      query_params[:duration] = params[:duration] if params.has_key?(:duration)
+      query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
       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/device.rb

@@ -145,6 +145,8 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
     # *  {string} excludeConnectionInfo - If set, do not return connection info
+    # *  {string} tagsAsObject - Return tags as an object map instead of an array.
+    # *  {string} attributesAsObject - Return attributes as an object map instead of an array.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -166,6 +168,8 @@ module LosantRest
       raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
 
       query_params[:excludeConnectionInfo] = params[:excludeConnectionInfo] if params.has_key?(:excludeConnectionInfo)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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)
@@ -401,6 +405,8 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
     # *  {hash} device - Object containing new properties of the device (https://api.losant.com/#/definitions/devicePatch)
+    # *  {string} tagsAsObject - Return tags as an object map instead of an array.
+    # *  {string} attributesAsObject - Return attributes as an object map instead of an array.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -423,6 +429,8 @@ module LosantRest
       raise ArgumentError.new("device is required") unless params.has_key?(:device)
 
       body = params[:device] if params.has_key?(:device)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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/devices.rb

@@ -250,6 +250,8 @@ module LosantRest
     # *  {string} excludeConnectionInfo - If set, do not return connection info
     # *  {string} parentId - Filter devices as children of a given system id
     # *  {hash} query - Device filter JSON object which overrides the filterField, filter, deviceClass, tagFilter, and parentId parameters. (https://api.losant.com/#/definitions/advancedDeviceQuery)
+    # *  {string} tagsAsObject - Return tags as an object map instead of an array.
+    # *  {string} attributesAsObject - Return attributes as an object map instead of an array.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -281,6 +283,8 @@ module LosantRest
       query_params[:parentId] = params[:parentId] if params.has_key?(:parentId)
       query_params[:query] = params[:query] if params.has_key?(:query)
       query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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)
@@ -401,6 +405,8 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} device - New device information (https://api.losant.com/#/definitions/devicePost)
+    # *  {string} tagsAsObject - Return tags as an object map instead of an array.
+    # *  {string} attributesAsObject - Return attributes as an object map instead of an array.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -422,6 +428,8 @@ module LosantRest
       raise ArgumentError.new("device is required") unless params.has_key?(:device)
 
       body = params[:device] if params.has_key?(:device)
+      query_params[:tagsAsObject] = params[:tagsAsObject] if params.has_key?(:tagsAsObject)
+      query_params[:attributesAsObject] = params[:attributesAsObject] if params.has_key?(:attributesAsObject)
       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/me.rb

@@ -338,6 +338,47 @@ module LosantRest
         body: body)
     end
 
+    # Returns the two factor auth key for a user
+    #
+    # 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.User, me.*, or me.generateTwoFactorAuth.
+    #
+    # Parameters:
+    # *  {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 - Updated user information (https://api.losant.com/#/definitions/twoFactorAuthInfo)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def generate_two_factor_auth(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+
+      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 = "/me/generateTwoFactorAuth"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieves information on the current user
     #
     # Authentication:

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.16.3"
+  VERSION = "1.16.5"
 end

data/schemas/apiTokenPost.json

@@ -426,6 +426,7 @@
               "me.delete",
               "me.verifyEmail",
               "me.changePassword",
+              "me.generateTwoFactorAuth",
               "me.enableTwoFactorAuth",
               "me.disableTwoFactorAuth",
               "me.disconnectGithub",

data/schemas/applicationDashboardPost.json

@@ -112,8 +112,18 @@
                     "type": "boolean"
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "xAxisFormat": {
                     "type": "string",
@@ -554,8 +564,18 @@
                               }
                             },
                             "duration": {
-                              "type": "integer",
-                              "minimum": 0
+                              "oneOf": [
+                                {
+                                  "type": "integer",
+                                  "minimum": 0
+                                },
+                                {
+                                  "type": "string",
+                                  "enum": [
+                                    "{{dashboard.duration}}"
+                                  ]
+                                }
+                              ]
                             },
                             "resolution": {
                               "oneOf": [
@@ -727,8 +747,18 @@
                               }
                             },
                             "duration": {
-                              "type": "integer",
-                              "minimum": 0
+                              "oneOf": [
+                                {
+                                  "type": "integer",
+                                  "minimum": 0
+                                },
+                                {
+                                  "type": "string",
+                                  "enum": [
+                                    "{{dashboard.duration}}"
+                                  ]
+                                }
+                              ]
                             }
                           },
                           "additionalProperties": false
@@ -1463,8 +1493,18 @@
                     }
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "sortDirection": {
                     "type": "integer",
@@ -1713,8 +1753,18 @@
                     "type": "boolean"
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "gaugeMax": {
                     "oneOf": [
@@ -2035,8 +2085,18 @@
                     "type": "boolean"
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "resolution": {
                     "oneOf": [
@@ -2411,8 +2471,18 @@
                     }
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "locationTagKey": {
                     "oneOf": [
@@ -2800,8 +2870,18 @@
                               }
                             },
                             "duration": {
-                              "type": "integer",
-                              "minimum": 0
+                              "oneOf": [
+                                {
+                                  "type": "integer",
+                                  "minimum": 0
+                                },
+                                {
+                                  "type": "string",
+                                  "enum": [
+                                    "{{dashboard.duration}}"
+                                  ]
+                                }
+                              ]
                             }
                           },
                           "additionalProperties": false
@@ -3256,8 +3336,18 @@
                     "type": "boolean"
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "segments": {
                     "type": "array",
@@ -4685,8 +4775,18 @@
                     }
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "endColor": {
                     "type": "string",
@@ -4881,8 +4981,18 @@
                     "type": "boolean"
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "percentFormat": {
                     "type": "string",
@@ -5196,8 +5306,18 @@
                     }
                   },
                   "duration": {
-                    "type": "integer",
-                    "minimum": 0
+                    "oneOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "{{dashboard.duration}}"
+                        ]
+                      }
+                    ]
                   },
                   "endColor": {
                     "type": "string",
@@ -5428,6 +5548,14 @@
       "minimum": 5,
       "maximum": 600
     },
+    "duration": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "resolution": {
+      "type": "integer",
+      "minimum": 1
+    },
     "defaultTheme": {
       "type": "string",
       "enum": [