losant_rest 1.0.8 → 1.1.0

data/docs/application.md

@@ -23,6 +23,11 @@ result = client.application.delete(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.Organization, all.User, application.*, or application.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -54,6 +59,11 @@ result = client.application.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, application.*, or application.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -87,6 +97,11 @@ result = client.application.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, application.*, or application.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -119,6 +134,11 @@ result = client.application.payload_counts(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, application.*, or application.payloadCounts.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/applicationApiToken.md

@@ -0,0 +1,130 @@
+# Application Api Token Actions
+
+Details on the various actions that can be performed on the
+Application Api Token resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an API Token
+
+```ruby
+result = client.application_api_token.delete(
+  applicationId: my_application_id,
+  apiTokenId: my_api_token_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.Organization, all.User, applicationApiToken.*, or applicationApiToken.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If API token was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an API token
+
+```ruby
+result = client.application_api_token.get(
+  applicationId: my_application_id,
+  apiTokenId: my_api_token_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, applicationApiToken.*, or applicationApiToken.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | API token information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an API token
+
+```ruby
+result = client.application_api_token.patch(
+  applicationId: my_application_id,
+  apiTokenId: my_api_token_id,
+  apiToken: my_api_token)
+
+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, applicationApiToken.*, or applicationApiToken.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| apiToken | [API Token Patch](_schemas.md#api-token-patch) | Y | Object containing new properties of the API token |  | [API Token Patch Example](_schemas.md#api-token-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | Updated API token information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if API token was not found |

data/docs/applicationApiTokens.md

@@ -0,0 +1,83 @@
+# Application Api Tokens Actions
+
+Details on the various actions that can be performed on the
+Application Api Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the API tokens for an application
+
+```ruby
+result = client.application_api_tokens.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, applicationApiTokens.*, or applicationApiTokens.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new API token for an application
+
+```ruby
+result = client.application_api_tokens.post(
+  applicationId: my_application_id,
+  apiToken: my_api_token)
+
+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, applicationApiTokens.*, or applicationApiTokens.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| apiToken | [Application API Token Post](_schemas.md#application-api-token-post) | Y | API token information |  | [Application API Token Post Example](_schemas.md#application-api-token-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [API Token](_schemas.md#api-token) | The successfully created API token |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/applicationKey.md

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

data/docs/applicationKeys.md

@@ -21,6 +21,11 @@ result = client.application_keys.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, applicationKeys.*, or applicationKeys.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -60,6 +65,11 @@ result = client.application_keys.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, applicationKeys.*, or applicationKeys.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/applications.md

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

data/docs/auditLog.md

@@ -22,6 +22,11 @@ result = client.audit_log.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.Organization, all.Organization.read, all.User, all.User.read, auditLog.*, or auditLog.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/auditLogs.md

@@ -20,6 +20,11 @@ result = client.audit_logs.get(orgId: my_org_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.Organization.read, all.User, all.User.read, auditLogs.*, or auditLogs.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/auth.md

@@ -15,7 +15,7 @@ parameters and the potential responses.
 
 ## Authenticate Device
 
-Authenticates a device using the provided credentials
+Authenticates a device using the provided credentials.
 
 ```ruby
 result = client.auth.authenticate_device(credentials: my_credentials)
@@ -23,6 +23,9 @@ result = client.auth.authenticate_device(credentials: my_credentials)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -33,7 +36,7 @@ puts result
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Authenticated Device](_schemas.md#authenticated-device) | Successful authentication |
+| 200 | [Authenticated Device](_schemas.md#authenticated-device) | Successful authentication. The included api access token has the scope 'all.Device'. |
 
 #### Error Responses
 
@@ -46,7 +49,7 @@ puts result
 
 ## Authenticate Solution User
 
-Authenticates a solution user using the provided credentials
+Authenticates a solution user using the provided credentials.
 
 ```ruby
 result = client.auth.authenticate_solution_user(credentials: my_credentials)
@@ -54,11 +57,14 @@ result = client.auth.authenticate_solution_user(credentials: my_credentials)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| credentials | [User Credentials](_schemas.md#user-credentials) | Y | Solution user authentication credentials |  | [User Credentials Example](_schemas.md#user-credentials-example) |
+| credentials | [User Credentials](_schemas.md#user-credentials) | Y | Solution user authentication credentials. The included api access token has the scope 'all.SolutionUser'. |  | [User Credentials Example](_schemas.md#user-credentials-example) |
 
 #### Successful Responses
 
@@ -77,7 +83,7 @@ puts result
 
 ## Authenticate User
 
-Authenticates a user using the provided credentials
+Authenticates a user using the provided credentials.
 
 ```ruby
 result = client.auth.authenticate_user(credentials: my_credentials)
@@ -85,6 +91,9 @@ result = client.auth.authenticate_user(credentials: my_credentials)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -95,7 +104,7 @@ puts result
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication. The included api access token has the scope 'all.User'. |
 
 #### Error Responses
 
@@ -108,7 +117,7 @@ puts result
 
 ## Authenticate User Github
 
-Authenticates a user via GitHub OAuth
+Authenticates a user via GitHub OAuth.
 
 ```ruby
 result = client.auth.authenticate_user_github(oauth: my_oauth)
@@ -116,6 +125,9 @@ result = client.auth.authenticate_user_github(oauth: my_oauth)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -126,7 +138,7 @@ puts result
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication. The included api access token has the scope 'all.User'. |
 
 #### Error Responses