losant_rest 1.0.8 → 1.1.0

data/docs/flows.md

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

data/docs/me.md

@@ -31,6 +31,11 @@ result = client.me.add_recent_item(data: my_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.SolutionUser, all.User, me.*, or me.addRecentItem.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.me.delete(credentials: my_credentials)
 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.SolutionUser, all.User, me.*, or me.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -91,6 +101,11 @@ result = client.me.disable_two_factor_auth(data: my_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.SolutionUser, all.User, me.*, or me.disableTwoFactorAuth.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -121,6 +136,11 @@ result = client.me.disconnect_github(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.SolutionUser, all.User, me.*, or me.disconnectGithub.
+
 #### Available Parameters
 
 No parameters needed for this call.
@@ -149,6 +169,11 @@ result = client.me.disconnect_twitter(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.SolutionUser, all.User, me.*, or me.disconnectTwitter.
+
 #### Available Parameters
 
 No parameters needed for this call.
@@ -177,6 +202,11 @@ result = client.me.enable_two_factor_auth(data: my_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.SolutionUser, all.User, me.*, or me.enableTwoFactorAuth.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -207,6 +237,11 @@ result = client.me.fetch_recent_items(itemType: my_item_type)
 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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.fetchRecentItems.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -238,11 +273,17 @@ result = client.me.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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | includeRecent | undefined | N | Should the user include recent app/dashboard info |  | true |
+| summaryExclude | string | N | List of summary fields to exclude from user summary |  | payloadCount |
 
 #### Successful Responses
 
@@ -267,6 +308,11 @@ result = client.me.patch(user: my_user)
 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.SolutionUser, all.User, me.*, or me.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -297,6 +343,11 @@ result = client.me.payload_counts(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.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -328,6 +379,11 @@ result = client.me.transfer_resources(transfer: my_transfer)
 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.SolutionUser, all.User, me.*, or me.transferResources.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -358,6 +414,11 @@ result = client.me.verify_email(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.SolutionUser, all.User, me.*, or me.verifyEmail.
+
 #### Available Parameters
 
 No parameters needed for this call.

data/docs/org.md

@@ -29,6 +29,11 @@ result = client.org.delete(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.User, org.*, or org.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -60,11 +65,17 @@ result = client.org.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, org.*, or org.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| summaryExclude | string | N | List of summary fields to exclude from org summary |  | payloadCount |
 
 #### Successful Responses
 
@@ -93,6 +104,11 @@ result = client.org.invite_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.Organization, all.User, org.*, or org.inviteMember.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -127,6 +143,11 @@ result = client.org.modify_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.Organization, all.User, org.*, or org.modifyMember.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -161,6 +182,11 @@ result = client.org.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, org.*, or org.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -193,6 +219,11 @@ result = client.org.payload_counts(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, org.*, or org.payloadCounts.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -226,6 +257,11 @@ result = client.org.pending_invites(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, org.*, or org.pendingInvites.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -259,6 +295,11 @@ result = client.org.remove_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.Organization, all.User, org.*, or org.removeMember.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -293,6 +334,11 @@ result = client.org.revoke_invite(
 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, org.*, or org.revokeInvite.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -327,6 +373,11 @@ result = client.org.transfer_resources(
 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, org.*, or org.transferResources.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/orgInvites.md

@@ -23,6 +23,9 @@ result = client.org_invites.get(
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -56,6 +59,9 @@ result = client.org_invites.post(invite: my_invite)
 puts result
 ```
 
+#### Authentication
+No api access token is required to call this action.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/orgs.md

@@ -21,6 +21,11 @@ result = client.orgs.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.User, all.User.read, orgs.*, or orgs.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -31,6 +36,7 @@ puts result
 | 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*org |
+| summaryExclude | string | N | List of summary fields to exclude from org summaries |  | payloadCount |
 
 #### Successful Responses
 
@@ -56,6 +62,11 @@ result = client.orgs.post(organization: my_organization)
 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.User, orgs.*, or orgs.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/solution.md

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

data/docs/solutionUser.md

@@ -25,6 +25,11 @@ result = client.solution_user.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.Organization, all.User, solutionUser.*, or solutionUser.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -61,6 +66,11 @@ result = client.solution_user.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, solutionUser.*, or solutionUser.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -98,6 +108,11 @@ result = client.solution_user.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, solutionUser.*, or solutionUser.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/solutionUsers.md

@@ -23,6 +23,11 @@ result = client.solution_users.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, solutionUsers.*, or solutionUsers.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -63,6 +68,11 @@ result = client.solution_users.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.Organization, all.User, solutionUsers.*, or solutionUsers.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/solutions.md

@@ -21,6 +21,11 @@ result = client.solutions.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, solutions.*, or solutions.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -59,6 +64,11 @@ result = client.solutions.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.Organization, all.User, solutions.*, or solutions.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |