losant_rest 1.13.1 → 1.14.0

data/docs/application.md

@@ -568,7 +568,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Payload Counts](_schemas.md#payload-counts) | Payload counts, by type and source |
+| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
 
 #### Error Responses
 

data/docs/device.md

@@ -14,6 +14,7 @@ parameters and the potential responses.
 *   [Get Log Entries](#get-log-entries)
 *   [Get State](#get-state)
 *   [Patch](#patch)
+*   [Payload Counts](#payload-counts)
 *   [Remove Data](#remove-data)
 *   [Send Command](#send-command)
 *   [Send State](#send-state)
@@ -361,6 +362,48 @@ all.Application, all.Organization, all.User, device.*, or device.patch.
 
 <br/>
 
+## Payload Counts
+
+Returns payload counts for the time range specified for this device
+
+```ruby
+result = client.device.payload_counts(
+  applicationId: my_application_id,
+  deviceId: my_device_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, device.*, or device.payloadCounts.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
+| start | string | N | Start of range for payload count query (ms since epoch) | -2592000000 | 0 |
+| end | string | N | End of range for payload count query (ms since epoch) | 0 | 1465790400000 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Device Payload Counts](_schemas.md#device-payload-counts) | Payload counts, by type |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if device was not found |
+
+<br/>
+
 ## Remove Data
 
 Removes all device data for the specified time range. Defaults to all data.

data/docs/devices.md

@@ -11,6 +11,7 @@ parameters and the potential responses.
 *   [Export](#export)
 *   [Get](#get)
 *   [Patch](#patch)
+*   [Payload Counts](#payload-counts)
 *   [Post](#post)
 *   [Remove Data](#remove-data)
 *   [Send Command](#send-command)
@@ -229,6 +230,44 @@ all.Application, all.Organization, all.User, devices.*, or devices.patch.
 
 <br/>
 
+## Payload Counts
+
+Creates an export of payload count information for the matching devices
+
+```ruby
+result = client.devices.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, devices.*, or devices.payloadCounts.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| options | [Devices Payload Count Export Post](_schemas.md#devices-payload-count-export-post) | N | Object containing export configuration |  | [Devices Payload Count Export Post Example](_schemas.md#devices-payload-count-export-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 export was successfully started |
+
+#### 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 device for an application

data/docs/edgeDeployment.md

@@ -0,0 +1,49 @@
+# Edge Deployment Actions
+
+Details on the various actions that can be performed on the
+Edge Deployment resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+
+<br/>
+
+## Get
+
+Retrieves information on an edge deployment
+
+```ruby
+result = client.edge_deployment.get(
+  applicationId: my_application_id,
+  edgeDeploymentId: my_edge_deployment_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, edgeDeployment.*, or edgeDeployment.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
+| edgeDeploymentId | string | Y | ID associated with the edge deployment |  | 575ed78e7ae143cd83dc4aab |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Edge Deployment](_schemas.md#edge-deployment) | Edge deployment information |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if edge deployment was not found |

data/docs/flow.md

@@ -284,7 +284,7 @@ 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.getStorageEntriesMetadata.
+all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.getStorageEntriesMetadata.
 
 #### Available Parameters
 

data/docs/instanceOrg.md

@@ -75,6 +75,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or inst
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -116,6 +117,7 @@ all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
 | orgId | string | Y | ID associated with the organization |  | 575ed6e87ae143cd83dc4aa8 |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary |  | payloadCount |
 | organization | [Instance Owned Organization Patch](_schemas.md#instance-owned-organization-patch) | Y | Object containing new organization properties |  | [Instance Owned Organization Patch Example](_schemas.md#instance-owned-organization-patch-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 

data/docs/instanceOrgInvite.md

@@ -0,0 +1,139 @@
+# Instance Org Invite Actions
+
+Details on the various actions that can be performed on the
+Instance Org Invite resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Delete](#delete)
+*   [Get](#get)
+*   [Resend Invite](#resend-invite)
+
+<br/>
+
+## Delete
+
+Revokes an instance org invitation
+
+```ruby
+result = client.instance_org_invite.delete(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  inviteId: my_invite_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, instanceOrgInvite.*, or instanceOrgInvite.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| inviteId | string | Y | ID associated with the organization invite |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Success](_schemas.md#success) | If an invite 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, organization or invite was not found |
+
+<br/>
+
+## Get
+
+Returns an organization invite
+
+```ruby
+result = client.instance_org_invite.get(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  inviteId: my_invite_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, instanceOrgInvite.*, or instanceOrgInvite.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| inviteId | string | Y | ID associated with the organization invite |  | 575ec8687ae143cd83dc4a94 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitation](_schemas.md#organization-invitation) | A single organization invite |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |
+
+<br/>
+
+## Resend Invite
+
+Resend an organization invite with modified role info
+
+```ruby
+result = client.instance_org_invite.resend_invite(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  inviteId: my_invite_id,
+  roleInfo: my_role_info)
+
+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, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a95 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| inviteId | string | Y | ID associated with the organization invite |  | 575ec8687ae143cd83dc4a94 |
+| roleInfo | [Organization Role Info](_schemas.md#organization-role-info) | Y | Object containing updated role info |  | [Organization Role Info Example](_schemas.md#organization-role-info-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Organization Invitation](_schemas.md#organization-invitation) | The new org invite |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance, organization, or invite was not found |

data/docs/instanceOrgInvites.md

@@ -0,0 +1,96 @@
+# Instance Org Invites Actions
+
+Details on the various actions that can be performed on the
+Instance Org Invites resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns a collection of instance organization invites
+
+```ruby
+result = client.instance_org_invites.get(
+  instanceId: my_instance_id,
+  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.Instance, all.Instance.read, all.User, all.User.read, instanceOrgInvites.*, or instanceOrgInvites.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| sortField | string | N | Field to sort the results by. Accepted values are: email, role, inviteDate | inviteDate | role |
+| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
+| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role |  | email |
+| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my * instance |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Instance Organization Invitations](_schemas.md#instance-organization-invitations) | A collection of instance organization invitations |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or organization was not found |
+
+<br/>
+
+## Post
+
+Invites a member to an instance organization
+
+```ruby
+result = client.instance_org_invites.post(
+  instanceId: my_instance_id,
+  orgId: my_org_id,
+  invite: my_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.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
+| invite | [Organization Invitation Post](_schemas.md#organization-invitation-post) | Y | Object containing new invite info |  | [Organization Invitation Post Example](_schemas.md#organization-invitation-post-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 201 | [Instance Organization Invitations](_schemas.md#instance-organization-invitations) | The new organization invite |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if instance or organization was not found |

data/docs/instanceOrgMembers.md

@@ -33,7 +33,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMembers.*,
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
-| orgId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
 | sortField | string | N | Field to sort the results by. Accepted values are: email, role | email | role |
 | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role |  | email |
@@ -78,7 +78,7 @@ all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
-| orgId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| orgId | string | Y | ID associated with the organization |  | 575ec8687ae143cd83dc4a97 |
 | member | [Instance Org Member Post](_schemas.md#instance-org-member-post) | Y | Object containing new member info |  | [Instance Org Member Post Example](_schemas.md#instance-org-member-post-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |