losant_rest 1.0.8 → 1.1.0

data/lib/losant_rest/org_invites.rb

@@ -31,6 +31,9 @@ module LosantRest
 
     # Gets information about an invite
     #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
     # Parameters:
     # *  {string} token - The token associated with the invite
     # *  {string} email - The email associated with the invite
@@ -74,6 +77,9 @@ module LosantRest
 
     # Accepts/Rejects an invite
     #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
     # Parameters:
     # *  {hash} invite - Invite info and acceptance (https://api.losant.com/#/definitions/orgInviteAction)
     # *  {string} losantdomain - Domain scope of request (rarely needed)

data/lib/losant_rest/orgs.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the organizations associated with the current user
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
@@ -38,6 +44,7 @@ module LosantRest
     # *  {string} perPage - How many items to return per page
     # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {string} summaryExclude - List of summary fields to exclude from org summaries
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -61,6 +68,7 @@ module LosantRest
       query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
       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)
@@ -78,6 +86,12 @@ module LosantRest
 
     # Create a new organization
     #
+    # 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.
+    #
     # Parameters:
     # *  {hash} organization - New organization information (https://api.losant.com/#/definitions/orgPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)

data/lib/losant_rest/solution.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a solution
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution
@@ -71,6 +77,12 @@ module LosantRest
 
     # Retrieves information on a solution
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution
@@ -111,6 +123,12 @@ module LosantRest
 
     # Updates information about a solution
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution

data/lib/losant_rest/solution_user.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a solution user
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution
@@ -73,6 +79,12 @@ module LosantRest
 
     # Retrieves information on a solution user
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution
@@ -115,6 +127,12 @@ module LosantRest
 
     # Updates information about a solution user
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution

data/lib/losant_rest/solution_users.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the users for the solution
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution
@@ -82,6 +88,12 @@ module LosantRest
 
     # Create a new solution user
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} solutionId - ID associated with the solution

data/lib/losant_rest/solutions.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the solutions for the organization
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
@@ -80,6 +86,12 @@ module LosantRest
 
     # Create a new solution
     #
+    # 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.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {hash} solution - New solution information (https://api.losant.com/#/definitions/solutionPost)

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.0.8"
+  VERSION = "1.1.0"
 end

data/lib/losant_rest/webhook.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a webhook
     #
+    # 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, webhook.*, or webhook.delete.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} webhookId - ID associated with the webhook
@@ -71,6 +77,12 @@ module LosantRest
 
     # Retrieves information on a webhook
     #
+    # 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, webhook.*, or webhook.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} webhookId - ID associated with the webhook
@@ -111,6 +123,12 @@ module LosantRest
 
     # Updates information about a webhook
     #
+    # 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, webhook.*, or webhook.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} webhookId - ID associated with the webhook

data/lib/losant_rest/webhooks.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the webhooks for an application
     #
+    # 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, webhooks.*, or webhooks.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
@@ -81,6 +87,12 @@ module LosantRest
 
     # Create a new webhook for an application
     #
+    # 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, webhooks.*, or webhooks.post.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} webhook - New webhook information (https://api.losant.com/#/definitions/webhookPost)

data/losant_rest.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.1"
 
-  gem.add_dependency "httparty", "~> 0.13.0"
+  gem.add_dependency "httparty", "~> 0.14.0"
 
   gem.add_development_dependency "minitest", "~> 5.9"
-  gem.add_development_dependency "rake", "~> 11"
-  gem.add_development_dependency "webmock", "~> 2.1"
+  gem.add_development_dependency "rake", "~> 12"
+  gem.add_development_dependency "webmock", "~> 2.3"
 end

data/schemas/{accessToken.json → apiToken.json}

@@ -6,19 +6,45 @@
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
-    "accessTokenId": {
+    "apiTokenId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
-    "userId": {
+    "ownerId": {
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "ownerType": {
+      "type": "string",
+      "enum": [
+        "application"
+      ]
+    },
+    "creatorId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "creatorType": {
+      "type": "string",
+      "enum": [
+        "apiToken",
+        "user",
+        "flow"
+      ]
+    },
+    "creatorName": {
+      "type": "string",
+      "maxLength": 1024
+    },
     "name": {
       "type": "string",
       "minLength": 1,
       "maxLength": 255
     },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
     "creationDate": {
       "type": "string",
       "format": "date-time"
@@ -34,7 +60,9 @@
     "scope": {
       "type": "array",
       "items": {
-        "type": "string"
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 1024
       }
     },
     "status": {

data/schemas/{accessTokenPatch.json → apiTokenPatch.json}

@@ -7,6 +7,10 @@
       "minLength": 1,
       "maxLength": 255
     },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
     "status": {
       "type": "string",
       "enum": [

data/schemas/applicationApiTokenPost.json

@@ -0,0 +1,116 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 32767
+    },
+    "expirationDate": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "scope": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "all.Application",
+          "all.Application.read",
+          "all.Device",
+          "all.Device.read",
+          "application.*",
+          "applicationApiToken.*",
+          "applicationApiTokens.*",
+          "applicationKey.*",
+          "applicationKeys.*",
+          "data.*",
+          "device.*",
+          "deviceRecipe.*",
+          "deviceRecipes.*",
+          "devices.*",
+          "event.*",
+          "events.*",
+          "flow.*",
+          "flows.*",
+          "webhook.*",
+          "webhooks.*",
+          "application.delete",
+          "application.get",
+          "application.patch",
+          "application.payloadCounts",
+          "applicationApiToken.delete",
+          "applicationApiToken.get",
+          "applicationApiToken.patch",
+          "applicationApiTokens.get",
+          "applicationApiTokens.post",
+          "applicationKey.delete",
+          "applicationKey.get",
+          "applicationKey.patch",
+          "applicationKeys.get",
+          "applicationKeys.post",
+          "data.lastValueQuery",
+          "data.timeSeriesQuery",
+          "device.delete",
+          "device.export",
+          "device.get",
+          "device.getCommand",
+          "device.getCompositeState",
+          "device.getLogEntries",
+          "device.getState",
+          "device.patch",
+          "device.removeData",
+          "device.sendCommand",
+          "device.sendState",
+          "deviceRecipe.bulkCreate",
+          "deviceRecipe.delete",
+          "deviceRecipe.get",
+          "deviceRecipe.patch",
+          "deviceRecipes.get",
+          "deviceRecipes.post",
+          "devices.export",
+          "devices.get",
+          "devices.post",
+          "devices.sendCommand",
+          "event.delete",
+          "event.get",
+          "event.patch",
+          "events.get",
+          "events.mostRecentBySeverity",
+          "events.patch",
+          "events.post",
+          "flow.delete",
+          "flow.get",
+          "flow.getStorageEntries",
+          "flow.log",
+          "flow.patch",
+          "flow.pressVirtualButton",
+          "flow.setStorageEntry",
+          "flows.create",
+          "flows.get",
+          "webhook.delete",
+          "webhook.get",
+          "webhook.patch",
+          "webhooks.get",
+          "webhooks.post"
+        ]
+      }
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "inactive"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name"
+  ]
+}