losant_rest 1.0.0

data/docs/accessToken.md

@@ -0,0 +1,107 @@
+# Access Token Actions
+
+Details on the various actions that can be performed on the
+Access Token resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an accessToken
+
+```ruby
+result = client.access_token.delete(accessTokenId: my_access_token_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| accessTokenId | string | Y | ID associated with the accessToken |  | 575ec7417ae143cd83dc4a95 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If accessToken was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if accessToken was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an accessToken
+
+```ruby
+result = client.access_token.get(accessTokenId: my_access_token_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| accessTokenId | string | Y | ID associated with the accessToken |  | 575ec7417ae143cd83dc4a95 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Access Token](_schemas.md#access-token) | Access token information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if accessToken was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an accessToken
+
+```ruby
+result = client.access_token.patch(
+  accessTokenId: my_access_token_id,
+  accessToken: my_access_token)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| accessTokenId | string | Y | ID associated with the accessToken |  | 575ec7417ae143cd83dc4a95 |
+| accessToken | [Access Token Patch](_schemas.md#access-token-patch) | Y | Object containing new properties of the accessToken |  | [Access Token Patch Example](_schemas.md#access-token-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Access Token](_schemas.md#access-token) | Updated accessToken information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if accessToken was not found |

data/docs/accessTokens.md

@@ -0,0 +1,68 @@
+# Access Tokens Actions
+
+Details on the various actions that can be performed on the
+Access Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the accessTokens for a user
+
+```ruby
+result = client.access_tokens.get
+
+puts result
+```
+
+#### Available Parameters
+
+No parameters needed for this call.
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Access Tokens](_schemas.md#access-tokens) | Collection of accessTokens |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new accessToken for a user
+
+```ruby
+result = client.access_tokens.post(accessToken: my_access_token)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| accessToken | [Access Token Post](_schemas.md#access-token-post) | Y | AccessToken information |  | [Access Token Post Example](_schemas.md#access-token-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Access Token](_schemas.md#access-token) | The successfully created accessToken |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/application.md

@@ -0,0 +1,107 @@
+# Application Actions
+
+Details on the various actions that can be performed on the
+Application resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an application
+
+```ruby
+result = client.application.delete(applicationId: my_application_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If application was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an application
+
+```ruby
+result = client.application.get(applicationId: my_application_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application](_schemas.md#application) | Application information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an application
+
+```ruby
+result = client.application.patch(
+  applicationId: my_application_id,
+  application: my_application)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID of the associated application |  | 575ec8687ae143cd83dc4a97 |
+| application | [Application Patch](_schemas.md#application-patch) | Y | Object containing new application properties |  | [Application Patch Example](_schemas.md#application-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application](_schemas.md#application) | Updated application information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |

data/docs/applicationKey.md

@@ -0,0 +1,115 @@
+# Application Key Actions
+
+Details on the various actions that can be performed on the
+Application Key resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an applicationKey
+
+```ruby
+result = client.application_key.delete(
+  applicationId: my_application_id,
+  applicationKeyId: my_application_key_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| applicationKeyId | string | Y | ID associated with the applicationKey |  | 575ec76c7ae143cd83dc4a96 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If applicationKey was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if applicationKey was not found |
+
+<br/>
+
+## Get
+
+Retrieves information on an applicationKey
+
+```ruby
+result = client.application_key.get(
+  applicationId: my_application_id,
+  applicationKeyId: my_application_key_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| applicationKeyId | string | Y | ID associated with the applicationKey |  | 575ec76c7ae143cd83dc4a96 |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Key](_schemas.md#application-key) | applicationKey information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if applicationKey was not found |
+
+<br/>
+
+## Patch
+
+Updates information about an applicationKey
+
+```ruby
+result = client.application_key.patch(
+  applicationId: my_application_id,
+  applicationKeyId: my_application_key_id,
+  applicationKey: my_application_key)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| applicationKeyId | string | Y | ID associated with the applicationKey |  | 575ec76c7ae143cd83dc4a96 |
+| applicationKey | [Application Key Patch](_schemas.md#application-key-patch) | Y | Object containing new properties of the applicationKey |  | [Application Key Patch Example](_schemas.md#application-key-patch-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Key](_schemas.md#application-key) | Updated applicationKey information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if applicationKey was not found |

data/docs/applicationKeys.md

@@ -0,0 +1,81 @@
+# Application Keys Actions
+
+Details on the various actions that can be performed on the
+Application Keys resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the applicationKeys for an application
+
+```ruby
+result = client.application_keys.get(applicationId: my_application_id)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: key, status, id, creationDate | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 1000 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status |  | key |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | the*key |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Keys](_schemas.md#application-keys) | Collection of applicationKeys |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |
+
+<br/>
+
+## Post
+
+Create a new applicationKey for an application
+
+```ruby
+result = client.application_keys.post(
+  applicationId: my_application_id,
+  applicationKey: my_application_key)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| applicationKey | [Application Key Post](_schemas.md#application-key-post) | Y | ApplicationKey information |  | [Application Key Post Example](_schemas.md#application-key-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Application Key](_schemas.md#application-key) | Successfully created applicationKey |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if application was not found |

data/docs/applications.md

@@ -0,0 +1,76 @@
+# Applications Actions
+
+Details on the various actions that can be performed on the
+Applications resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the applications the current user has permission to see
+
+```ruby
+result = client.applications.get(optional_params)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId | name | name |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
+| page | string | N | Which page of results to return | 0 | 0 |
+| perPage | string | N | How many items to return per page | 1000 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * app |
+| orgId | string | N | 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. |  | 575ecdf07ae143cd83dc4a9a |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Applications](_schemas.md#applications) | Collection of applications |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Post
+
+Create a new application
+
+```ruby
+result = client.applications.post(application: my_application)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| application | [Application Post](_schemas.md#application-post) | Y | New application information |  | [Application Post Example](_schemas.md#application-post-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Application](_schemas.md#application) | Successfully created application |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/auth.md

@@ -0,0 +1,104 @@
+# Auth Actions
+
+Details on the various actions that can be performed on the
+Auth resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Authenticate Device](#authenticate-device)
+*   [Authenticate User](#authenticate-user)
+*   [Authenticate User Github](#authenticate-user-github)
+
+<br/>
+
+## Authenticate Device
+
+Authenticates a device using the provided credentials
+
+```ruby
+result = client.auth.authenticate_device(credentials: my_credentials)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| credentials | [Device Credentials](_schemas.md#device-credentials) | Y | Device authentication credentials |  | [Device Credentials Example](_schemas.md#device-credentials-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Authenticated Device](_schemas.md#authenticated-device) | Successful authentication |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
+
+<br/>
+
+## Authenticate User
+
+Authenticates a user using the provided credentials
+
+```ruby
+result = client.auth.authenticate_user(credentials: my_credentials)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| credentials | [User Credentials](_schemas.md#user-credentials) | Y | User authentication credentials |  | [User Credentials Example](_schemas.md#user-credentials-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |
+
+<br/>
+
+## Authenticate User Github
+
+Authenticates a user via GitHub OAuth
+
+```ruby
+result = client.auth.authenticate_user_github(oauth: my_oauth)
+
+puts result
+```
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| oauth | [Github Login](_schemas.md#github-login) | Y | User authentication credentials (access token) |  | [Github Login Example](_schemas.md#github-login-example) |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful authentication |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails |