losant_rest 1.0.8 → 1.1.0

data/lib/losant_rest/applications.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the applications the current user has permission to see
     #
+    # 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, applications.*, or applications.get.
+    #
     # Parameters:
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
@@ -80,6 +86,12 @@ module LosantRest
 
     # Create a new 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.Organization, all.User, applications.*, or applications.post.
+    #
     # Parameters:
     # *  {hash} application - New application information (https://api.losant.com/#/definitions/applicationPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)

data/lib/losant_rest/audit_log.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Retrieves information on an audit log
     #
+    # 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, auditLog.*, or auditLog.get.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} auditLogId - ID associated with the audit log

data/lib/losant_rest/audit_logs.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the audit logs 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, auditLogs.*, or auditLogs.get.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} sortField - Field to sort the results by. Accepted values are: creationDate, responseStatus, actorName

data/lib/losant_rest/auth.rb

@@ -29,7 +29,10 @@ module LosantRest
       @client = client
     end
 
-    # Authenticates a device using the provided credentials
+    # Authenticates a device using the provided credentials.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
     #
     # Parameters:
     # *  {hash} credentials - Device authentication credentials (https://api.losant.com/#/definitions/deviceCredentials)
@@ -39,7 +42,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedDevice)
+    # *  200 - Successful authentication. The included api access token has the scope 'all.Device'. (https://api.losant.com/#/definitions/authedDevice)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -68,10 +71,13 @@ module LosantRest
         body: body)
     end
 
-    # Authenticates a solution user using the provided credentials
+    # Authenticates a solution user using the provided credentials.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
     #
     # Parameters:
-    # *  {hash} credentials - Solution user authentication credentials (https://api.losant.com/#/definitions/solutionUserCredentials)
+    # *  {hash} credentials - Solution user authentication credentials. The included api access token has the scope 'all.SolutionUser'. (https://api.losant.com/#/definitions/solutionUserCredentials)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -107,7 +113,10 @@ module LosantRest
         body: body)
     end
 
-    # Authenticates a user using the provided credentials
+    # Authenticates a user using the provided credentials.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
     #
     # Parameters:
     # *  {hash} credentials - User authentication credentials (https://api.losant.com/#/definitions/userCredentials)
@@ -117,7 +126,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedUser)
+    # *  200 - Successful authentication. The included api access token has the scope 'all.User'. (https://api.losant.com/#/definitions/authedUser)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -146,7 +155,10 @@ module LosantRest
         body: body)
     end
 
-    # Authenticates a user via GitHub OAuth
+    # Authenticates a user via GitHub OAuth.
+    #
+    # Authentication:
+    # No api access token is required to call this action.
     #
     # Parameters:
     # *  {hash} oauth - User authentication credentials (access token) (https://api.losant.com/#/definitions/githubLogin)
@@ -156,7 +168,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Successful authentication (https://api.losant.com/#/definitions/authedUser)
+    # *  200 - Successful authentication. The included api access token has the scope 'all.User'. (https://api.losant.com/#/definitions/authedUser)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/client.rb

@@ -27,7 +27,7 @@ module LosantRest
   #
   # User API for accessing Losant data
   #
-  # Built For Version 1.5.2
+  # Built For Version 1.5.3
   class Client
     attr_accessor :auth_token, :url
 
@@ -36,16 +36,16 @@ module LosantRest
       self.url        = options.fetch(:url, "https://api.losant.com")
     end
 
-    def access_token
-      @access_token ||= AccessToken.new(self)
+    def application
+      @application ||= Application.new(self)
     end
 
-    def access_tokens
-      @access_tokens ||= AccessTokens.new(self)
+    def application_api_token
+      @application_api_token ||= ApplicationApiToken.new(self)
     end
 
-    def application
-      @application ||= Application.new(self)
+    def application_api_tokens
+      @application_api_tokens ||= ApplicationApiTokens.new(self)
     end
 
     def application_key
@@ -162,7 +162,7 @@ module LosantRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.5.2"
+      headers["Accept-Version"] = "^1.5.3"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/losant_rest/dashboard.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a dashboard
     #
+    # 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, dashboard.*, or dashboard.delete.
+    #
     # Parameters:
     # *  {string} dashboardId - ID of the associated dashboard
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -69,6 +75,9 @@ module LosantRest
 
     # Retrieves information on a dashboard
     #
+    # Authentication:
+    # No api access token is required to call this action.
+    #
     # Parameters:
     # *  {string} dashboardId - ID of the associated dashboard
     # *  {string} password - Password for password-protected dashboards
@@ -109,6 +118,12 @@ module LosantRest
 
     # Updates information about a dashboard
     #
+    # 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, dashboard.*, or dashboard.patch.
+    #
     # Parameters:
     # *  {string} dashboardId - ID of the associated dashboard
     # *  {hash} dashboard - Object containing new dashboard properties (https://api.losant.com/#/definitions/dashboardPatch)

data/lib/losant_rest/dashboards.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the dashboards the current user has permission to see
     #
+    # 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.SolutionUser, all.SolutionUser.read, all.User, dashboards.*, or dashboards.get.
+    #
     # Parameters:
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, ownerId
     # *  {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
@@ -80,6 +86,12 @@ module LosantRest
 
     # Create a new dashboard
     #
+    # 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, dashboards.*, or dashboards.post.
+    #
     # Parameters:
     # *  {hash} dashboard - New dashboard information (https://api.losant.com/#/definitions/dashboardPost)
     # *  {string} losantdomain - Domain scope of request (rarely needed)

data/lib/losant_rest/data.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the last known data for the given attribute
     #
+    # 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.lastValueQuery.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/lastValueQuery)
@@ -72,6 +78,12 @@ module LosantRest
 
     # Returns the data for the given query
     #
+    # 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, data.*, or data.timeSeriesQuery.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} query - The query parameters (https://api.losant.com/#/definitions/timeSeriesQuery)

data/lib/losant_rest/device.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a 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.Organization, all.User, device.*, or device.delete.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -71,6 +77,12 @@ module LosantRest
 
     # Creates a device data export. Defaults to all data.
     #
+    # 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.export.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -119,6 +131,12 @@ module LosantRest
 
     # Retrieves information on a 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -159,6 +177,12 @@ module LosantRest
 
     # Retrieve the last known commands(s) sent to the 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCommand.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -203,6 +227,12 @@ module LosantRest
 
     # Retrieve the composite last complete state of the 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getCompositeState.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -247,6 +277,12 @@ module LosantRest
 
     # Retrieve the recent log entries about the 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getLogEntries.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -291,6 +327,12 @@ module LosantRest
 
     # Retrieve the last known state(s) of the 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, device.*, or device.getState.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -335,6 +377,12 @@ module LosantRest
 
     # Updates information about a 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.Organization, all.User, device.*, or device.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -378,6 +426,12 @@ module LosantRest
 
     # Removes all device data for the specified time range. Defaults to all data.
     #
+    # 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, device.*, or device.removeData.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -422,6 +476,12 @@ module LosantRest
 
     # Send a command to a 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.Device, all.Organization, all.User, device.*, or device.sendCommand.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device
@@ -465,6 +525,12 @@ module LosantRest
 
     # Send the current state of the 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.Device, all.Organization, all.User, device.*, or device.sendState.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceId - ID associated with the device

data/lib/losant_rest/device_recipe.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Bulk creates devices using this recipe from a CSV
     #
+    # 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, deviceRecipe.*, or deviceRecipe.bulkCreate.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceRecipeId - ID associated with the device recipe
@@ -74,6 +80,12 @@ module LosantRest
 
     # Deletes a device recipe
     #
+    # 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, deviceRecipe.*, or deviceRecipe.delete.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceRecipeId - ID associated with the device recipe
@@ -114,6 +126,12 @@ module LosantRest
 
     # Retrieves information on a device recipe
     #
+    # 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, deviceRecipe.*, or deviceRecipe.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceRecipeId - ID associated with the device recipe
@@ -154,6 +172,12 @@ module LosantRest
 
     # Updates information about a device recipe
     #
+    # 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, deviceRecipe.*, or deviceRecipe.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} deviceRecipeId - ID associated with the device recipe

data/lib/losant_rest/device_recipes.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the device recipes 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, deviceRecipes.*, or deviceRecipes.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 device recipe 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, deviceRecipes.*, or deviceRecipes.post.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} deviceRecipe - New device recipe information (https://api.losant.com/#/definitions/deviceRecipePost)