losant_rest 1.13.0 → 1.15.0

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

@@ -13,7 +13,7 @@ parameters and the potential responses.
 
 ## Get
 
-Returns an instance member
+Returns a collection of instance organization members
 
 ```ruby
 result = client.instance_org_members.get(
@@ -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 |
 

data/docs/instanceOrgs.md

@@ -37,7 +37,6 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or ins
 | 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*org |
-| summaryExclude | string | N | Comma-separated list of summary fields to exclude from org summaries |  | payloadCount |
 | 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 |
 
@@ -75,6 +74,7 @@ all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | instanceId | string | Y | ID associated with the instance |  | 575ec8687ae143cd83dc4a97 |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary |  | payloadCount |
 | orgConfig | [Instance Owned Organization Post](_schemas.md#instance-owned-organization-post) | N | Object containing configurations for the new organization |  | [Instance Owned Organization Post Example](_schemas.md#instance-owned-organization-post-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 

data/docs/me.md

@@ -376,7 +376,7 @@ all.User, all.User.read, me.*, or me.payloadCounts.
 
 | 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/org.md

@@ -247,7 +247,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
 
 | 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/userApiToken.md

@@ -0,0 +1,125 @@
+# User Api Token Actions
+
+Details on the various actions that can be performed on the
+User 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.user_api_token.delete(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.User, userApiToken.*, or userApiToken.delete.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| 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.user_api_token.get(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.User, all.User.read, userApiToken.*, or userApiToken.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| 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.user_api_token.patch(
+  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.User, userApiToken.*, or userApiToken.patch.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| 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/userApiTokens.md

@@ -0,0 +1,87 @@
+# User Api Tokens Actions
+
+Details on the various actions that can be performed on the
+User Api Tokens resource, including the expected
+parameters and the potential responses.
+
+##### Contents
+
+*   [Get](#get)
+*   [Post](#post)
+
+<br/>
+
+## Get
+
+Returns the API tokens for a user
+
+```ruby
+result = client.user_api_tokens.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, userApiTokens.*, or userApiTokens.get.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| 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 user
+
+```ruby
+result = client.user_api_tokens.post(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.User, userApiTokens.*, or userApiTokens.post.
+
+#### Available Parameters
+
+| Name | Type | Required | Description | Default | Example |
+| ---- | ---- | -------- | ----------- | ------- | ------- |
+| 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/lib/losant_rest/application.rb

@@ -405,7 +405,7 @@ module LosantRest
     # 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, application.*, or application.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -453,7 +453,7 @@ module LosantRest
     # 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, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -547,7 +547,7 @@ module LosantRest
     # 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, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -646,7 +646,7 @@ module LosantRest
     # 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, application.*, or application.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
@@ -690,7 +690,7 @@ module LosantRest
     # 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, application.*, or application.patch.
+    # all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.
     #
     # Parameters:
     # *  {string} applicationId - ID of the associated application

data/lib/losant_rest/application_api_tokens.rb

@@ -96,7 +96,7 @@ module LosantRest
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
-    # *  {hash} apiToken - API token information (https://api.losant.com/#/definitions/applicationApiTokenPost)
+    # *  {hash} apiToken - API token information (https://api.losant.com/#/definitions/apiTokenPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/losant_rest/applications.rb

@@ -37,7 +37,7 @@ module LosantRest
     # 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, applications.*, or applications.get.
+    # all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, applications.*, or applications.get.
     #
     # Parameters:
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, lastUpdated

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.20.0
+  # Built For Version 1.22.0
   class Client
     attr_accessor :auth_token, :url
 
@@ -148,10 +148,22 @@ module LosantRest
       @devices ||= Devices.new(self)
     end
 
+    def edge_deployment
+      @edge_deployment ||= EdgeDeployment.new(self)
+    end
+
     def edge_deployments
       @edge_deployments ||= EdgeDeployments.new(self)
     end
 
+    def embedded_deployment
+      @embedded_deployment ||= EmbeddedDeployment.new(self)
+    end
+
+    def embedded_deployments
+      @embedded_deployments ||= EmbeddedDeployments.new(self)
+    end
+
     def event
       @event ||= Event.new(self)
     end
@@ -248,6 +260,14 @@ module LosantRest
       @instance ||= Instance.new(self)
     end
 
+    def instance_api_token
+      @instance_api_token ||= InstanceApiToken.new(self)
+    end
+
+    def instance_api_tokens
+      @instance_api_tokens ||= InstanceApiTokens.new(self)
+    end
+
     def instance_member
       @instance_member ||= InstanceMember.new(self)
     end
@@ -260,6 +280,14 @@ module LosantRest
       @instance_org ||= InstanceOrg.new(self)
     end
 
+    def instance_org_invite
+      @instance_org_invite ||= InstanceOrgInvite.new(self)
+    end
+
+    def instance_org_invites
+      @instance_org_invites ||= InstanceOrgInvites.new(self)
+    end
+
     def instance_org_member
       @instance_org_member ||= InstanceOrgMember.new(self)
     end
@@ -308,6 +336,14 @@ module LosantRest
       @orgs ||= Orgs.new(self)
     end
 
+    def user_api_token
+      @user_api_token ||= UserApiToken.new(self)
+    end
+
+    def user_api_tokens
+      @user_api_tokens ||= UserApiTokens.new(self)
+    end
+
     def webhook
       @webhook ||= Webhook.new(self)
     end
@@ -322,7 +358,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.20.0"
+      headers["Accept-Version"] = "^1.22.0"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/data_table.rb

@@ -132,7 +132,7 @@ module LosantRest
     # 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, dataTable.*, or dataTable.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTable.*, or dataTable.get.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application

data/lib/losant_rest/data_table_rows.rb

@@ -136,7 +136,7 @@ module LosantRest
     # 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, dataTableRows.*, or dataTableRows.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTableRows.*, or dataTableRows.get.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application

data/lib/losant_rest/data_tables.rb

@@ -37,7 +37,7 @@ module LosantRest
     # 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, dataTables.*, or dataTables.get.
+    # all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, dataTables.*, or dataTables.get.
     #
     # Parameters:
     # *  {string} applicationId - ID associated with the application

data/lib/losant_rest/device.rb

@@ -438,6 +438,56 @@ module LosantRest
         body: body)
     end
 
+    # Returns payload counts for the time range specified for this device
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} deviceId - ID associated with the device
+    # *  {string} start - Start of range for payload count query (ms since epoch)
+    # *  {string} end - End of range for payload count query (ms since epoch)
+    # *  {string} losantdomain - Domain scope of request (rarely needed)
+    # *  {boolean} _actions - Return resource actions in response
+    # *  {boolean} _links - Return resource link in response
+    # *  {boolean} _embedded - Return embedded resources in response
+    #
+    # Responses:
+    # *  200 - Payload counts, by type (https://api.losant.com/#/definitions/devicePayloadCounts)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if device was not found (https://api.losant.com/#/definitions/error)
+    def payload_counts(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { _actions: false, _links: true, _embedded: true }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("deviceId is required") unless params.has_key?(:deviceId)
+
+      query_params[:start] = params[:start] if params.has_key?(:start)
+      query_params[:end] = params[:end] if params.has_key?(:end)
+      headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
+      query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
+      query_params[:_links] = params[:_links] if params.has_key?(:_links)
+      query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
+
+      path = "/applications/#{params[:applicationId]}/devices/#{params[:deviceId]}/payloadCounts"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Removes all device data for the specified time range. Defaults to all data.
     #
     # Authentication: