losant_rest 1.0.8 → 1.1.0

data/lib/losant_rest/devices.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Creates an export of all device metadata.
     #
+    # 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.export.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} email - Email address to send export to. Defaults to current user's email.
@@ -73,6 +79,12 @@ module LosantRest
 
     # Returns the devices 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.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate
@@ -125,6 +137,12 @@ module LosantRest
 
     # Create a new device 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, devices.*, or devices.post.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} device - New device information (https://api.losant.com/#/definitions/devicePost)
@@ -166,6 +184,12 @@ module LosantRest
 
     # Send a command to multiple 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.Device, all.Organization, all.User, devices.*, or devices.sendCommand.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} multiDeviceCommand - Command to send to the device (https://api.losant.com/#/definitions/multiDeviceCommand)

data/lib/losant_rest/event.rb

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

data/lib/losant_rest/events.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the events 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, events.*, or events.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} sortField - Field to sort the results by. Accepted values are: subject, id, creationDate
@@ -83,6 +89,12 @@ module LosantRest
 
     # Returns the first new event ordered by severity and then creation
     #
+    # 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, events.*, or events.mostRecentBySeverity.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} filter - Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering.
@@ -122,6 +134,12 @@ module LosantRest
 
     # Asynchronously updates information for matching events by subject and/or current state
     #
+    # 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, events.*, or events.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} filterField - Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject
@@ -169,6 +187,12 @@ module LosantRest
 
     # Create a new event 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, events.*, or events.post.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} event - New event information (https://api.losant.com/#/definitions/eventPost)

data/lib/losant_rest/flow.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes a flow
     #
+    # 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, flow.*, or flow.delete.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -71,6 +77,12 @@ module LosantRest
 
     # Retrieves information on a flow
     #
+    # 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, flow.*, or flow.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -111,6 +123,12 @@ module LosantRest
 
     # Retrieve the recent log entries about the flows
     #
+    # 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, flow.*, or flow.log.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -155,6 +173,12 @@ module LosantRest
 
     # Gets the current values in persistent storage
     #
+    # 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, flow.*, or flow.getStorageEntries.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -195,6 +219,12 @@ module LosantRest
 
     # Updates information about a flow
     #
+    # 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, flow.*, or flow.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -238,6 +268,12 @@ module LosantRest
 
     # Presses the specified virtual button on the flow
     #
+    # 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, flow.*, or flow.pressVirtualButton.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow
@@ -281,6 +317,12 @@ module LosantRest
 
     # Sets a storage value
     #
+    # 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, flow.*, or flow.setStorageEntry.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} flowId - ID associated with the flow

data/lib/losant_rest/flows.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Returns the flows 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, flows.*, or flows.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 flow 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, flows.*, or flows.create.
+    #
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {hash} flow - New flow information (https://api.losant.com/#/definitions/flowPost)

data/lib/losant_rest/me.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Adds an item to a recent item list
     #
+    # 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.SolutionUser, all.User, me.*, or me.addRecentItem.
+    #
     # Parameters:
     # *  {hash} data - Object containing recent item info (https://api.losant.com/#/definitions/recentItem)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -69,6 +75,12 @@ module LosantRest
 
     # Deletes 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.SolutionUser, all.User, me.*, or me.delete.
+    #
     # Parameters:
     # *  {hash} credentials - User authentication credentials (https://api.losant.com/#/definitions/userCredentials)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -107,6 +119,12 @@ module LosantRest
 
     # Disables two factor auth for 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.SolutionUser, all.User, me.*, or me.disableTwoFactorAuth.
+    #
     # Parameters:
     # *  {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/disableTwoFactorAuth)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -145,6 +163,12 @@ module LosantRest
 
     # Disconnects the user from Github
     #
+    # 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.SolutionUser, all.User, me.*, or me.disconnectGithub.
+    #
     # Parameters:
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
@@ -180,6 +204,12 @@ module LosantRest
 
     # Disconnects the user from Twitter
     #
+    # 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.SolutionUser, all.User, me.*, or me.disconnectTwitter.
+    #
     # Parameters:
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
@@ -215,6 +245,12 @@ module LosantRest
 
     # Enables two factor auth for 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.SolutionUser, all.User, me.*, or me.enableTwoFactorAuth.
+    #
     # Parameters:
     # *  {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/enableTwoFactorAuth)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -253,6 +289,12 @@ module LosantRest
 
     # Gets a recent item list
     #
+    # 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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.fetchRecentItems.
+    #
     # Parameters:
     # *  {string} parentId - Parent id of the recent list
     # *  {undefined} itemType - Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization
@@ -293,8 +335,15 @@ module LosantRest
 
     # Retrieves information on 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.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.get.
+    #
     # Parameters:
     # *  {undefined} includeRecent - Should the user include recent app/dashboard info
+    # *  {string} summaryExclude - List of summary fields to exclude from user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -312,6 +361,7 @@ module LosantRest
 
 
       query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
+      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)
@@ -329,6 +379,12 @@ module LosantRest
 
     # Updates information about 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.SolutionUser, all.User, me.*, or me.patch.
+    #
     # Parameters:
     # *  {hash} user - Object containing new user properties (https://api.losant.com/#/definitions/mePatch)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -367,6 +423,12 @@ module LosantRest
 
     # Returns payload counts for the time range specified for all applications the current user owns
     #
+    # 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.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts.
+    #
     # Parameters:
     # *  {string} start - Start of range for payload count query (ms since epoch)
     # *  {string} end - End of range for payload count query (ms since epoch)
@@ -406,6 +468,12 @@ module LosantRest
 
     # Moves resources to a new owner
     #
+    # 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.SolutionUser, all.User, me.*, or me.transferResources.
+    #
     # Parameters:
     # *  {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -444,6 +512,12 @@ module LosantRest
 
     # Sends an email verification to the 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.SolutionUser, all.User, me.*, or me.verifyEmail.
+    #
     # Parameters:
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response

data/lib/losant_rest/org.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes an 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.User, org.*, or org.delete.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -69,8 +75,15 @@ module LosantRest
 
     # Retrieves information on an 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, org.*, or org.get.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
+    # *  {string} summaryExclude - List of summary fields to exclude from org summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -90,6 +103,7 @@ module LosantRest
 
       raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
 
+      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)
@@ -107,6 +121,12 @@ module LosantRest
 
     # Invites a person to an 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.User, org.*, or org.inviteMember.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {hash} invite - Object containing new invite info (https://api.losant.com/#/definitions/orgInvitePost)
@@ -148,6 +168,12 @@ module LosantRest
 
     # Modifies a current org member's role
     #
+    # 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, org.*, or org.modifyMember.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {hash} member - Object containing new member pair (https://api.losant.com/#/definitions/orgMemberPatch)
@@ -189,6 +215,12 @@ module LosantRest
 
     # Updates information about an 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.User, org.*, or org.patch.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {hash} organization - Object containing new organization properties (https://api.losant.com/#/definitions/orgPatch)
@@ -230,6 +262,12 @@ module LosantRest
 
     # Returns payload counts for the time range specified for all applications this organization owns
     #
+    # 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, org.*, or org.payloadCounts.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} start - Start of range for payload count query (ms since epoch)
@@ -272,6 +310,12 @@ module LosantRest
 
     # Gets the current pending invites
     #
+    # 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, org.*, or org.pendingInvites.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -310,6 +354,12 @@ module LosantRest
 
     # Removes a member from the org
     #
+    # 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, org.*, or org.removeMember.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} userId - Id of user to remove
@@ -351,6 +401,12 @@ module LosantRest
 
     # Revokes an existing invite
     #
+    # 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, org.*, or org.revokeInvite.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {string} inviteId - Id of invite to revoke
@@ -392,6 +448,12 @@ module LosantRest
 
     # Moves resources to a new owner
     #
+    # 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, org.*, or org.transferResources.
+    #
     # Parameters:
     # *  {string} orgId - ID associated with the organization
     # *  {hash} transfer - Object containing properties of the transfer (https://api.losant.com/#/definitions/resourceTransfer)