losant_rest 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feef8330911e8b103858f9a7c52fab99d5d6d6ce
-  data.tar.gz: ed34d8331125fc2376651d1266ae60d18bfe0bde
+  metadata.gz: 1a8febd9df2e048e29e135b1db4c17e2132a6485
+  data.tar.gz: 78e7a33f4159244aedd42ea3b6c0defd5d4c078b
 SHA512:
-  metadata.gz: 0612fe46ccdb7b55d93c2abd3c5f7c3e9be3581d7aafe0d7306829a05fd54d0fa70104c343c3e4ae98179cac3429c1cc37285d978abbbc0f74316ed5d14c04c2
-  data.tar.gz: 27a4ab8e19548f3b6d596630325e5bacd422d0740f049360033a2f505e19477587583095ae192bc3989dce7d7da045a83f8cd0e637629eb062db21865c49627a
+  metadata.gz: 63b50ed6cd120c8abfa915b45b074574f778d214a7c7461a5e48a14b61a40e0686ad6c0c1b640b7e034f90ec40e33ccc5138a35955aad5ca15273db17a89e2ac
+  data.tar.gz: 4ddf7b70d5ae181504c00cd5bc0febaa458951d3fb98d2a9a65ab2fd37833c6e50a955f0675ae8fef76ba9aab20c7491c9b08cdf905743d011f1864e02df6fe3

data/docs/_schemas.md

@@ -2874,6 +2874,7 @@ Schema for a single Device state
     "relayId": {
       "type": "string"
     },
+    "meta": {},
     "data": {
       "type": "object",
       "patternProperties": {
@@ -2929,6 +2930,7 @@ Schema for an array of Device states
       "relayId": {
         "type": "string"
       },
+      "meta": {},
       "data": {
         "type": "object",
         "patternProperties": {
@@ -6039,7 +6041,8 @@ Schema for the body of a request to press a Workflow virtual button
     "key": {
       "type": "string"
     },
-    "payload": {}
+    "payload": {},
+    "meta": {}
   },
   "required": [
     "key"
@@ -6110,7 +6113,8 @@ Schema for a single Webhook
       "enum": [
         "facebook",
         "fitbit",
-        "none"
+        "none",
+        "twilio"
       ]
     },
     "verificationCode": {
@@ -6163,7 +6167,8 @@ Schema for the body of a Webhook modification request
       "enum": [
         "facebook",
         "fitbit",
-        "none"
+        "none",
+        "twilio"
       ]
     },
     "verificationCode": {
@@ -6211,7 +6216,8 @@ Schema for the body of a Webhook creation request
       "enum": [
         "facebook",
         "fitbit",
-        "none"
+        "none",
+        "twilio"
       ]
     },
     "verificationCode": {
@@ -6292,7 +6298,8 @@ Schema for a collection of Webhooks
             "enum": [
               "facebook",
               "fitbit",
-              "none"
+              "none",
+              "twilio"
             ]
           },
           "verificationCode": {

data/docs/accessTokens.md

@@ -16,7 +16,7 @@ parameters and the potential responses.
 Returns the accessTokens for a user
 
 ```ruby
-result = client.access_tokens.get
+result = client.access_tokens.get(optional_params)
 
 puts result
 ```

data/docs/dashboard.md

@@ -58,7 +58,7 @@ puts result
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | dashboardId | string | Y | ID of the associated dashboard |  | 575ece2b7ae143cd83dc4a9b |
-| password | string | N | Password for password-protected dashboards |  | undefined |
+| password | string | N | Password for password-protected dashboards |  | myPassword |
 
 #### Successful Responses
 

data/docs/device.md

@@ -7,11 +7,13 @@ parameters and the potential responses.
 ##### Contents
 
 *   [Delete](#delete)
+*   [Export](#export)
 *   [Get](#get)
 *   [Get Command](#get-command)
 *   [Get Log Entries](#get-log-entries)
 *   [Get State](#get-state)
 *   [Patch](#patch)
+*   [Remove Data](#remove-data)
 *   [Send Command](#send-command)
 *   [Send State](#send-state)
 
@@ -51,6 +53,42 @@ puts result
 
 <br/>
 
+## Export
+
+Creates a device data export (to be emailed to the requestor). Defaults to all data.
+
+```ruby
+result = client.device.export(
+  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 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 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+
+#### 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
 
 Retrieves information on a device
@@ -229,6 +267,42 @@ puts result
 
 <br/>
 
+## Remove Data
+
+Removes all device data for the specified time range. Defaults to all data.
+
+```ruby
+result = client.device.remove_data(
+  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 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 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If data removal was successfully started |
+
+#### 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/>
+
 ## Send Command
 
 Send a command to a device

data/docs/me.md

@@ -114,7 +114,7 @@ puts result
 Disconnects the user from Github
 
 ```ruby
-result = client.me.disconnect_github
+result = client.me.disconnect_github(optional_params)
 
 puts result
 ```
@@ -142,7 +142,7 @@ No parameters needed for this call.
 Disconnects the user from Twitter
 
 ```ruby
-result = client.me.disconnect_twitter
+result = client.me.disconnect_twitter(optional_params)
 
 puts result
 ```
@@ -290,7 +290,7 @@ puts result
 Sends an email verification to the user
 
 ```ruby
-result = client.me.verify_email
+result = client.me.verify_email(optional_params)
 
 puts result
 ```

data/lib/losant_rest/access_token.rb

@@ -11,6 +11,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} accessTokenId - ID associated with the accessToken
+    # *  {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
@@ -29,6 +30,7 @@ module LosantRest
 
       raise ArgumentError.new("accessTokenId is required") unless params.has_key?(:accessTokenId)
 
+      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)
@@ -47,6 +49,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} accessTokenId - ID associated with the accessToken
+    # *  {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
@@ -65,6 +68,7 @@ module LosantRest
 
       raise ArgumentError.new("accessTokenId is required") unless params.has_key?(:accessTokenId)
 
+      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)
@@ -84,6 +88,7 @@ module LosantRest
     # Parameters:
     # *  {string} accessTokenId - ID associated with the accessToken
     # *  {hash} accessToken - Object containing new properties of the accessToken (https://api.losant.com/#/definitions/accessTokenPatch)
+    # *  {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
@@ -104,6 +109,7 @@ module LosantRest
       raise ArgumentError.new("accessToken is required") unless params.has_key?(:accessToken)
 
       body = params[:accessToken] if params.has_key?(:accessToken)
+      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)

data/lib/losant_rest/access_tokens.rb

@@ -10,6 +10,7 @@ module LosantRest
     # Returns the accessTokens for a user
     #
     # 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
@@ -26,6 +27,7 @@ module LosantRest
       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)
@@ -44,6 +46,7 @@ module LosantRest
     #
     # Parameters:
     # *  {hash} accessToken - AccessToken information (https://api.losant.com/#/definitions/accessTokenPost)
+    # *  {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
@@ -62,6 +65,7 @@ module LosantRest
       raise ArgumentError.new("accessToken is required") unless params.has_key?(:accessToken)
 
       body = params[:accessToken] if params.has_key?(:accessToken)
+      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)

data/lib/losant_rest/application.rb

@@ -11,6 +11,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
+    # *  {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
@@ -29,6 +30,7 @@ module LosantRest
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
 
+      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)
@@ -47,6 +49,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
+    # *  {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
@@ -65,6 +68,7 @@ module LosantRest
 
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
 
+      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)
@@ -84,6 +88,7 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID of the associated application
     # *  {hash} application - Object containing new application properties (https://api.losant.com/#/definitions/applicationPatch)
+    # *  {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
@@ -104,6 +109,7 @@ module LosantRest
       raise ArgumentError.new("application is required") unless params.has_key?(:application)
 
       body = params[:application] if params.has_key?(:application)
+      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)

data/lib/losant_rest/application_key.rb

@@ -12,6 +12,7 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} applicationKeyId - ID associated with the applicationKey
+    # *  {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
@@ -31,6 +32,7 @@ module LosantRest
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
       raise ArgumentError.new("applicationKeyId is required") unless params.has_key?(:applicationKeyId)
 
+      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)
@@ -50,6 +52,7 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} applicationKeyId - ID associated with the applicationKey
+    # *  {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
@@ -69,6 +72,7 @@ module LosantRest
       raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
       raise ArgumentError.new("applicationKeyId is required") unless params.has_key?(:applicationKeyId)
 
+      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)
@@ -89,6 +93,7 @@ module LosantRest
     # *  {string} applicationId - ID associated with the application
     # *  {string} applicationKeyId - ID associated with the applicationKey
     # *  {hash} applicationKey - Object containing new properties of the applicationKey (https://api.losant.com/#/definitions/applicationKeyPatch)
+    # *  {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
@@ -110,6 +115,7 @@ module LosantRest
       raise ArgumentError.new("applicationKey is required") unless params.has_key?(:applicationKey)
 
       body = params[:applicationKey] if params.has_key?(:applicationKey)
+      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)

data/lib/losant_rest/application_keys.rb

@@ -17,6 +17,7 @@ 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: key, status
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {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
@@ -41,6 +42,7 @@ module LosantRest
       query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      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)
@@ -60,6 +62,7 @@ module LosantRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} applicationKey - ApplicationKey information (https://api.losant.com/#/definitions/applicationKeyPost)
+    # *  {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
@@ -80,6 +83,7 @@ module LosantRest
       raise ArgumentError.new("applicationKey is required") unless params.has_key?(:applicationKey)
 
       body = params[:applicationKey] if params.has_key?(:applicationKey)
+      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)

data/lib/losant_rest/applications.rb

@@ -17,6 +17,7 @@ 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} 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
@@ -40,6 +41,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[:orgId] = params[:orgId] if params.has_key?(:orgId)
+      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)
@@ -58,6 +60,7 @@ module LosantRest
     #
     # Parameters:
     # *  {hash} application - New application information (https://api.losant.com/#/definitions/applicationPost)
+    # *  {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
@@ -76,6 +79,7 @@ module LosantRest
       raise ArgumentError.new("application is required") unless params.has_key?(:application)
 
       body = params[:application] if params.has_key?(:application)
+      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)