losant_rest 1.13.1 → 1.15.1

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 |
 

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/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.20.1
+  # Built For Version 1.22.1
   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
@@ -268,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
@@ -338,7 +358,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.20.1"
+      headers["Accept-Version"] = "^1.22.1"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

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:

data/lib/losant_rest/devices.rb

@@ -295,6 +295,52 @@ module LosantRest
         body: body)
     end
 
+    # Creates an export of payload count information for the matching devices
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} options - Object containing export configuration (https://api.losant.com/#/definitions/devicesExportPayloadCountPost)
+    # *  {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 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if application 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)
+
+      body = params[:options] if params.has_key?(:options)
+      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/payloadCounts"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
     # Create a new device for an application
     #
     # Authentication:

data/lib/losant_rest/edge_deployment.rb

@@ -0,0 +1,81 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2021 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module LosantRest
+
+  # Class containing all the actions for the Edge Deployment Resource
+  class EdgeDeployment
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieves information on an edge deployment
+    #
+    # 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.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} edgeDeploymentId - ID associated with the edge deployment
+    # *  {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 - Edge deployment information (https://api.losant.com/#/definitions/edgeDeployment)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if edge deployment was not found (https://api.losant.com/#/definitions/error)
+    def get(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("edgeDeploymentId is required") unless params.has_key?(:edgeDeploymentId)
+
+      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]}/edge/deployments/#{params[:edgeDeploymentId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end

data/lib/losant_rest/embedded_deployment.rb

@@ -0,0 +1,81 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2021 Losant IoT, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module LosantRest
+
+  # Class containing all the actions for the Embedded Deployment Resource
+  class EmbeddedDeployment
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieves information on an embedded deployment
+    #
+    # 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, embeddedDeployment.*, or embeddedDeployment.get.
+    #
+    # Parameters:
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} embeddedDeploymentId - ID associated with the embedded deployment
+    # *  {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 - Embedded deployment information (https://api.losant.com/#/definitions/embeddedDeployment)
+    #
+    # Errors:
+    # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if embedded deployment was not found (https://api.losant.com/#/definitions/error)
+    def get(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("embeddedDeploymentId is required") unless params.has_key?(:embeddedDeploymentId)
+
+      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]}/embedded/deployments/#{params[:embeddedDeploymentId]}"
+
+      @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+  end
+end