losant_rest 1.19.0 → 1.19.1

data/docs/applications.md

@@ -8,6 +8,7 @@ parameters and the potential responses.
 
 *   [Get](#get)
 *   [Import](#import)
+*   [Period Summaries](#period-summaries)
 *   [Post](#post)
 
 <br/>
@@ -102,6 +103,54 @@ all.Organization, all.User, applications.*, or applications.import.
 
 <br/>
 
+## Period Summaries
+
+Returns application usage summaries over a selected date range
+
+```ruby
+result = client.applications.period_summaries(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.User, applications.*, or applications.periodSummaries.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| start | string | N | Start of range for resource count queries (ms since epoch) |  | 0 |
+| end | string | N | End of range for resource count queries (ms since epoch) |  | 1465790400000 |
+| asBytes | string | N | If the resulting payload counts should be returned as bytes | false | true |
+| includeNonBillable | string | N | If non-billable payloads should be included in the result | false | true |
+| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated | 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 |  | 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 |
+| exclude | string | N | Comma-separated list of resources to exclude from summary |  | payloadCounts, deviceCounts, notebookMinuteCounts |
+| include | string | N | Comma-separated list of summary fields to include in application summary |  | deviceCounts |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Application Period Summaries](_schemas.md#application-period-summaries) | Collection of application period summaries |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
 ## Post
 
 Create a new application

data/docs/device.md

@@ -175,8 +175,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | limit | string | N | Maximum number of command entries to return | 1 | 10 |
-| since | string | N | Look for command entries since this time (ms since epoch) |  | 1465790400000 |
+| since | string | N | (deprecated) Look for command entries since this time (ms since epoch) |  | 1465790400000 |
 | sortDirection | string | N | Direction to sort the command entries (by time). Accepted values are: asc, desc | desc | desc |
+| duration | string | N | Duration of time range to query in milliseconds |  | 86400000 |
+| start | string | N | Start of time range to query in milliseconds since epoch |  | 1465790400000 |
+| end | string | N | End of time range to query in milliseconds since epoch |  | 0 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -261,8 +264,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | limit | string | N | Maximum number of log entries to return | 1 | 10 |
-| since | string | N | Look for log entries since this time (ms since epoch) |  | 1465790400000 |
+| since | string | N | (deprecated) Look for log entries since this time (ms since epoch) |  | 1465790400000 |
 | sortDirection | string | N | Direction to sort the log entries (by time). Accepted values are: asc, desc | desc | desc |
+| duration | string | N | Duration of time range to query in milliseconds |  | 86400000 |
+| start | string | N | Start of time range to query in milliseconds since epoch |  | 1465790400000 |
+| end | string | N | End of time range to query in milliseconds since epoch |  | 0 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -304,8 +310,11 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 | applicationId | string | Y | ID associated with the application |  | 575ec8687ae143cd83dc4a97 |
 | deviceId | string | Y | ID associated with the device |  | 575ecf887ae143cd83dc4aa2 |
 | limit | string | N | Maximum number of state entries to return | 1 | 10 |
-| since | string | N | Look for state entries since this time (ms since epoch) |  | 1465790400000 |
+| since | string | N | (deprecated) Look for state entries since this time (ms since epoch) |  | 1465790400000 |
 | sortDirection | string | N | Direction to sort the state entries (by time). Accepted values are: asc, desc | desc | desc |
+| duration | string | N | Duration of time range to query in milliseconds |  | 86400000 |
+| start | string | N | Start of time range to query in milliseconds since epoch |  | 1465790400000 |
+| end | string | N | End of time range to query in milliseconds since epoch |  | 0 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/me.md

@@ -16,11 +16,14 @@ parameters and the potential responses.
 *   [Fetch Recent Items](#fetch-recent-items)
 *   [Generate Two Factor Auth](#generate-two-factor-auth)
 *   [Get](#get)
+*   [Invite](#invite)
+*   [Invites](#invites)
 *   [Notebook Minute Counts](#notebook-minute-counts)
 *   [Patch](#patch)
 *   [Payload Counts](#payload-counts)
 *   [Payload Counts Breakdown](#payload-counts-breakdown)
 *   [Refresh Token](#refresh-token)
+*   [Respond to Invite](#respond-to-invite)
 *   [Transfer Resources](#transfer-resources)
 *   [Verify Email](#verify-email)
 
@@ -387,6 +390,78 @@ all.User, all.User.read, me.*, or me.get.
 
 <br/>
 
+## Invite
+
+Retrieves information for an invitation to an organization
+
+```ruby
+result = client.me.invite(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.User, me.*, or me.invite.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| inviteId | string | Y | ID associated with the invitation |  | 575ec8687ae143cd83dc4a97 |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitation Information For User](_schemas.md#organization-invitation-information-for-user) | Information about invitation |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if invite not found |
+
+<br/>
+
+## Invites
+
+Retrieves pending organization invitations for a user
+
+```ruby
+result = client.me.invites(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, me.*, or me.invites.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [User Organization Invitations](_schemas.md#user-organization-invitations) | Information about invitations |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+
+<br/>
+
 ## Notebook Minute Counts
 
 Returns notebook execution usage by day for the time range specified for all applications the current user owns
@@ -575,6 +650,47 @@ all.User, or me.*.
 
 <br/>
 
+## Respond to Invite
+
+Accepts or rejects an invitation to an organization
+
+```ruby
+result = client.me.respond_to_invite(
+  inviteId: my_invite_id,
+  response: my_response)
+
+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, me.*, or me.respondToInvite.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| inviteId | string | Y | ID associated with the invitation |  | 575ec8687ae143cd83dc4a97 |
+| response | [Organization Invitation Action For User](_schemas.md#organization-invitation-action-for-user) | Y | Response to invitation |  | [Organization Invitation Action For User Example](_schemas.md#organization-invitation-action-for-user-example) |
+| losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
+
+#### Successful Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 200 | [Organization Invitation Result For User](_schemas.md#organization-invitation-result-for-user) | Acceptance or rejection of invitation |
+
+#### Error Responses
+
+| Code | Type | Description |
+| ---- | ---- | ----------- |
+| 400 | [Error](_schemas.md#error) | Error if malformed request |
+| 404 | [Error](_schemas.md#error) | Error if invitation not found |
+| 410 | [Error](_schemas.md#error) | Error if invitation has expired |
+
+<br/>
+
 ## Transfer Resources
 
 Moves resources to a new owner

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.19.0"
+  VERSION = "1.19.1"
 end