losant_rest 1.0.8 → 1.1.0

data/docs/dashboard.md

@@ -22,6 +22,11 @@ result = client.dashboard.delete(dashboardId: my_dashboard_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.Organization, all.User, dashboard.*, or dashboard.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -53,6 +58,9 @@ result = client.dashboard.get(dashboardId: my_dashboard_id)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -87,6 +95,11 @@ result = client.dashboard.patch(
 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.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/dashboards.md

@@ -21,6 +21,11 @@ result = client.dashboards.get(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.Organization, all.SolutionUser, all.SolutionUser.read, all.User, dashboards.*, or dashboards.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -57,6 +62,11 @@ result = client.dashboards.post(dashboard: my_dashboard)
 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, dashboards.*, or dashboards.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/data.md

@@ -23,6 +23,11 @@ result = client.data.last_value_query(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.lastValueQuery.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -57,6 +62,11 @@ result = client.data.time_series_query(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.timeSeriesQuery.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/device.md

@@ -32,6 +32,11 @@ result = client.device.delete(
 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, device.*, or device.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -66,6 +71,11 @@ result = client.device.export(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.export.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -104,6 +114,11 @@ result = client.device.get(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -138,6 +153,11 @@ result = client.device.get_command(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCommand.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -174,6 +194,11 @@ result = client.device.get_composite_state(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCompositeState.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -210,6 +235,11 @@ result = client.device.get_log_entries(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getLogEntries.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -246,6 +276,11 @@ result = client.device.get_state(
 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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getState.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -283,6 +318,11 @@ result = client.device.patch(
 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, device.*, or device.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -318,6 +358,11 @@ result = client.device.remove_data(
 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, device.*, or device.removeData.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -355,6 +400,11 @@ result = client.device.send_command(
 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.Device, all.Organization, all.User, device.*, or device.sendCommand.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -391,6 +441,11 @@ result = client.device.send_state(
 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.Device, all.Organization, all.User, device.*, or device.sendState.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/deviceRecipe.md

@@ -26,6 +26,11 @@ result = client.device_recipe.bulk_create(
 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, deviceRecipe.*, or deviceRecipe.bulkCreate.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.device_recipe.delete(
 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, deviceRecipe.*, or deviceRecipe.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -95,6 +105,11 @@ result = client.device_recipe.get(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipe.*, or deviceRecipe.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -130,6 +145,11 @@ result = client.device_recipe.patch(
 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, deviceRecipe.*, or deviceRecipe.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/deviceRecipes.md

@@ -21,6 +21,11 @@ result = client.device_recipes.get(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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceRecipes.*, or deviceRecipes.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -60,6 +65,11 @@ result = client.device_recipes.post(
 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, deviceRecipes.*, or deviceRecipes.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/devices.md

@@ -23,6 +23,11 @@ result = client.devices.export(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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.export.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -56,6 +61,11 @@ result = client.devices.get(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.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -96,6 +106,11 @@ result = client.devices.post(
 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.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -130,6 +145,11 @@ result = client.devices.send_command(
 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.Device, all.Organization, all.User, devices.*, or devices.sendCommand.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/event.md

@@ -24,6 +24,11 @@ result = client.event.delete(
 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, event.*, or event.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -58,6 +63,11 @@ result = client.event.get(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, event.*, or event.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -93,6 +103,11 @@ result = client.event.patch(
 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, event.*, or event.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/events.md

@@ -23,6 +23,11 @@ result = client.events.get(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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.events.most_recent_by_severity(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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, events.*, or events.mostRecentBySeverity.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -94,6 +104,11 @@ result = client.events.patch(
 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, events.*, or events.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -131,6 +146,11 @@ result = client.events.post(
 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, events.*, or events.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/flow.md

@@ -28,6 +28,11 @@ result = client.flow.delete(
 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, flow.*, or flow.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -62,6 +67,11 @@ result = client.flow.get(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -96,6 +106,11 @@ result = client.flow.get_log_entries(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.log.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -132,6 +147,11 @@ result = client.flow.get_storage_entries(
 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.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntries.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -167,6 +187,11 @@ result = client.flow.patch(
 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, flow.*, or flow.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -203,6 +228,11 @@ result = client.flow.press_virtual_button(
 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, flow.*, or flow.pressVirtualButton.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -239,6 +269,11 @@ result = client.flow.set_storage_entry(
 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, flow.*, or flow.setStorageEntry.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |