losant_rest 1.0.5 → 1.0.6

data/docs/device.md

@@ -10,6 +10,7 @@ parameters and the potential responses.
 *   [Export](#export)
 *   [Get](#get)
 *   [Get Command](#get-command)
+*   [Get Composite State](#get-composite-state)
 *   [Get Log Entries](#get-log-entries)
 *   [Get State](#get-state)
 *   [Patch](#patch)
@@ -55,7 +56,7 @@ puts result
 
 ## Export
 
-Creates a device data export (to be emailed to the requestor). Defaults to all data.
+Creates a device data export. Defaults to all data.
 
 ```ruby
 result = client.device.export(
@@ -73,6 +74,8 @@ puts result
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | 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 |
 
 #### Successful Responses
 
@@ -159,6 +162,42 @@ puts result
 
 <br/>
 
+## Get Composite State
+
+Retrieve the composite last complete state of the device
+
+```ruby
+result = client.device.get_composite_state(
+  applicationId: my_application_id,
+  deviceId: my_device_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
+| start | string | N | Start of time range to look at to build composite state | 1 | 1465790400000 |
+| end | string | N | End of time range to look at to build composite state | 0 | 1465790400000 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Composite Device State](_schemas.md#composite-device-state) | Composite last state of the device |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if device was not found |
+
+<br/>
+
 ## Get Log Entries
 
 Retrieve the recent log entries about the device

data/docs/me.md

@@ -16,6 +16,7 @@ parameters and the potential responses.
 *   [Get](#get)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
+*   [Transfer Resources](#transfer-resources)
 *   [Verify Email](#verify-email)
 
 <br/>
@@ -211,7 +212,7 @@ puts result
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | parentId | string | N | Parent id of the recent list |  | 575ec8687ae143cd83dc4a97 |
-| itemType | undefined | Y | Item type to get the recent list of. Accepted values are: application, device, flow, dashboard |  | application |
+| itemType | undefined | Y | Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization |  | application |
 
 #### Successful Responses
 
@@ -300,8 +301,8 @@ puts result
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| start | string | N | Start of range for payload count query (ms since epoch) | -2592000000 | 0 |
-| end | string | N | End of range for payload count query (ms since epoch) | 0 | 1465790400000 |
+| start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
+| end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
 
 #### Successful Responses
 
@@ -314,7 +315,36 @@ puts result
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Transfer Resources
+
+Moves resources to a new owner
+
+```ruby
+result = client.me.transfer_resources(transfer: my_transfer)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| transfer | [Resource Transfer](_schemas.md#resource-transfer) | Y | Object containing properties of the transfer |  | [Resource Transfer Example](_schemas.md#resource-transfer-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If resource transfer was successful |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
 
 <br/>
 

data/docs/org.md

@@ -15,6 +15,7 @@ parameters and the potential responses.
 *   [Pending Invites](#pending-invites)
 *   [Remove Member](#remove-member)
 *   [Revoke Invite](#revoke-invite)
+*   [Transfer Resources](#transfer-resources)
 
 <br/>
 
@@ -197,8 +198,8 @@ puts result
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
-| start | string | N | Start of range for payload count query (ms since epoch) | -2592000000 | 0 |
-| end | string | N | End of range for payload count query (ms since epoch) | 0 | 1465790400000 |
+| start | string | N | Start of range for payload count query (ms since epoch) |  | 0 |
+| end | string | N | End of range for payload count query (ms since epoch) |  | 1465790400000 |
 
 #### Successful Responses
 
@@ -211,7 +212,7 @@ puts result
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
-| 404 | [Error](_schemas.md#error) | Error if application was not found |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |
 
 <br/>
 
@@ -311,3 +312,37 @@ puts result
 | ---- | ---- | ----------- |
 | 400 | [Error](_schemas.md#error) | Error if malformed request |
 | 404 | [Error](_schemas.md#error) | Error if organization not found |
+
+<br/>
+
+## Transfer Resources
+
+Moves resources to a new owner
+
+```ruby
+result = client.org.transfer_resources(
+  orgId: my_org_id,
+  transfer: my_transfer)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| transfer | [Resource Transfer](_schemas.md#resource-transfer) | Y | Object containing properties of the transfer |  | [Resource Transfer Example](_schemas.md#resource-transfer-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If resource transfer was successful |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if organization was not found |

data/lib/losant_rest/client.rb

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

data/lib/losant_rest/device.rb

@@ -47,13 +47,15 @@ module LosantRest
         body: body)
     end
 
-    # Creates a device data export (to be emailed to the requestor). Defaults to all data.
+    # Creates a device data export. Defaults to all data.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
     # *  {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} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -76,6 +78,8 @@ module LosantRest
 
       query_params[:start] = params[:start] if params.has_key?(:start)
       query_params[:end] = params[:end] if params.has_key?(:end)
+      query_params[:email] = params[:email] if params.has_key?(:email)
+      query_params[:callbackUrl] = params[:callbackUrl] if params.has_key?(:callbackUrl)
       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)
@@ -175,6 +179,50 @@ module LosantRest
         body: body)
     end
 
+    # Retrieve the composite last complete state of the device
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} deviceId - ID associated with the device
+    # *  {string} start - Start of time range to look at to build composite state
+    # *  {string} end - End of time range to look at to build composite state
+    # *  {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 - Composite last state of the device (https://api.losant.com/#/definitions/compositeDeviceState)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if device was not found (https://api.losant.com/#/definitions/error)
+    def get_composite_state(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)
+      raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
+
+      query_params[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      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/#{params[:deviceId]}/compositeState"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Retrieve the recent log entries about the device
     #
     # Parameters:

data/lib/losant_rest/me.rb

@@ -233,7 +233,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} parentId - Parent id of the recent list
-    # *  {undefined} itemType - Item type to get the recent list of. Accepted values are: application, device, flow, dashboard
+    # *  {undefined} itemType - Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -358,7 +358,6 @@ module LosantRest
     #
     # 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 payload_counts(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -383,6 +382,44 @@ module LosantRest
         body: body)
     end
 
+    # Moves resources to a new owner
+    #
+    # Parameters:
+    # *  {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)
+    # *  {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 - If resource transfer was successful (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    def transfer_resources(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("transfer is required") unless params.has_key?(:transfer)
+
+      body = params[:transfer] if params.has_key?(:transfer)
+      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/transferResources"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Sends an email verification to the user
     #
     # Parameters:

data/lib/losant_rest/org.rb

@@ -222,7 +222,7 @@ module LosantRest
     #
     # 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)
+    # *  404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
     def payload_counts(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
@@ -368,5 +368,46 @@ module LosantRest
         body: body)
     end
 
+    # Moves resources to a new owner
+    #
+    # Parameters:
+    # *  {string} orgId - ID associated with the organization
+    # *  {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)
+    # *  {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 - If resource transfer was successful (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
+    def transfer_resources(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
+      raise ArgumentError.new("transfer is required") unless params.has_key?(:transfer)
+
+      body = params[:transfer] if params.has_key?(:transfer)
+      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 = "/orgs/#{params[:orgId]}/transferResources"
+
+      @client.request(
+        method: :patch,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/losant_rest/version.rb

@@ -1,3 +1,3 @@
 module LosantRest
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/schemas/compositeDeviceState.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "patternProperties": {
+    "^[0-9a-zA-Z_-]{1,255}$": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": [
+            "number",
+            "string",
+            "boolean"
+          ]
+        },
+        "time": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$date": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "$date"
+              ]
+            }
+          ]
+        },
+        "relayId": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "additionalProperties": false
+}