losant_rest 1.11.1 → 1.14.0

data/docs/flows.md

@@ -43,6 +43,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. |  | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
 | includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
 | query | [Advanced Workflow Query](_schemas.md#advanced-workflow-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. |  | [Advanced Workflow Query Example](_schemas.md#advanced-workflow-query-example) |
+| allVersions | string | N | If the request should also return flows with matching versions. Only applicable for requests with an advanced query. | false | true |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/instance.md

@@ -0,0 +1,166 @@
+# Instance Actions
+
+Details on the various actions that can be performed on the
+Instance resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Generate Report](#generate-report)
+*   [Get](#get)
+*   [Historical Summaries](#historical-summaries)
+*   [Patch](#patch)
+
+<br/>
+
+## Generate Report
+
+Generates a CSV report on instance stats
+
+```ruby
+result = client.instance.generate_report(instanceId: my_instance_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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.generateReport.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| options | [Instance Report Options Post](_schemas.md#instance-report-options-post) | N | Object containing report configuration |  | [Instance Report Options Post Example](_schemas.md#instance-report-options-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If generation of report was successfully started |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Get
+
+Returns an instance
+
+```ruby
+result = client.instance.get(instanceId: my_instance_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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance](_schemas.md#instance) | A single instance |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance was not found |
+
+<br/>
+
+## Historical Summaries
+
+Return historical summary entries for an instance
+
+```ruby
+result = client.instance.historical_summaries(instanceId: my_instance_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.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.historicalSummaries.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| month | string | N | Timestamp within the month to report a summary for. | now | 1609459204518 |
+| sortField | string | N | Field to sort the results by. Accepted values are: resourceId, currentPeriodStart | currentPeriodStart | resourceId |
+| sortDirection | string | N | Direction to sort the results in. 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 | 100 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: resourceType, resourceId, ownerId, ownerType |  | resourceType |
+| filter | string | N | Filter to apply against the filtered field. Blank or not provided means no filtering. |  | organization |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Historical Summaries](_schemas.md#historical-summaries) | Collection of historical summaries |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
+## Patch
+
+Updates information about an instance
+
+```ruby
+result = client.instance.patch(instanceId: my_instance_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.Instance, all.User, instance.*, or instance.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| instance | [Instance Patch](_schemas.md#instance-patch) | N | Updated instance information |  | [Instance Patch Example](_schemas.md#instance-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance](_schemas.md#instance) | The updated instance object |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |

data/docs/instanceApiToken.md

@@ -0,0 +1,133 @@
+# Instance Api Token Actions
+
+Details on the various actions that can be performed on the
+Instance 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.instance_api_token.delete(
+  instanceId: my_instance_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.Instance, all.User, instanceApiToken.*, or instanceApiToken.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### 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.instance_api_token.get(
+  instanceId: my_instance_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.Instance, all.Instance.read, all.User, all.User.read, instanceApiToken.*, or instanceApiToken.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| apiTokenId | string | Y | ID associated with the API token |  | 575ec7417ae143cd83dc4a95 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### 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.instance_api_token.patch(
+  instanceId: my_instance_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.Instance, all.User, instanceApiToken.*, or instanceApiToken.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| 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) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### 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/instanceApiTokens.md

@@ -0,0 +1,91 @@
+# Instance Api Tokens Actions
+
+Details on the various actions that can be performed on the
+Instance Api Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the API tokens for an instance
+
+```ruby
+result = client.instance_api_tokens.get(instanceId: my_instance_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.Instance, all.Instance.read, all.User, all.User.read, instanceApiTokens.*, or instanceApiTokens.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, status, id, creationDate, lastUpdated, expirationDate | 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 | 100 | 10 |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status |  | key |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*token |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### 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 instance
+
+```ruby
+result = client.instance_api_tokens.post(
+  instanceId: my_instance_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.Instance, all.User, instanceApiTokens.*, or instanceApiTokens.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec7417ae143cd83dc4a96 |
+| apiToken | [API Token Post](_schemas.md#api-token-post) | Y | API token information |  | [API Token Post Example](_schemas.md#api-token-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### 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/instanceMember.md

@@ -0,0 +1,133 @@
+# Instance Member Actions
+
+Details on the various actions that can be performed on the
+Instance Member resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Patch](#patch)
+
+<br/>
+
+## Delete
+
+Deletes an instance member
+
+```ruby
+result = client.instance_member.delete(
+  instanceId: my_instance_id,
+  userId: my_user_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.Instance, all.User, instanceMember.*, or instanceMember.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If member was successfully deleted |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |
+
+<br/>
+
+## Get
+
+Returns an instance member
+
+```ruby
+result = client.instance_member.get(
+  instanceId: my_instance_id,
+  userId: my_user_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.Instance, all.Instance.read, all.User, all.User.read, instanceMember.*, or instanceMember.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Member](_schemas.md#instance-member) | A single instance member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |
+
+<br/>
+
+## Patch
+
+Modifies the role of an instance member
+
+```ruby
+result = client.instance_member.patch(
+  instanceId: my_instance_id,
+  userId: my_user_id,
+  member: my_member)
+
+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.Instance, all.User, instanceMember.*, or instanceMember.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| userId | string | Y | ID associated with the instance member |  | 575ec8687ae143cd83dc4a94 |
+| member | [Instance Member Patch](_schemas.md#instance-member-patch) | Y | Object containing new member info |  | [Instance Member Patch Example](_schemas.md#instance-member-patch-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Member Patch](_schemas.md#instance-member-patch) | The modified instance member |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or member was not found |