losant_rest 1.0.8 → 1.1.0

data/docs/webhook.md

@@ -24,6 +24,11 @@ result = client.webhook.delete(
 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.Application, all.Organization, all.User, webhook.*, or webhook.delete.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -58,6 +63,11 @@ result = client.webhook.get(
 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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -93,6 +103,11 @@ result = client.webhook.patch(
 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.Application, all.Organization, all.User, webhook.*, or webhook.patch.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/docs/webhooks.md

@@ -21,6 +21,11 @@ result = client.webhooks.get(applicationId: my_application_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhooks.*, or webhooks.get.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |
@@ -60,6 +65,11 @@ result = client.webhooks.post(
 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.Application, all.Organization, all.User, webhooks.*, or webhooks.post.
+
 #### Available Parameters
 
 | Name | Type | Required | Description | Default | Example |

data/lib/losant_rest.rb

@@ -23,9 +23,9 @@
 require_relative "losant_rest/version"
 require_relative "losant_rest/error"
 require_relative "losant_rest/utils"
-require_relative "losant_rest/access_token"
-require_relative "losant_rest/access_tokens"
 require_relative "losant_rest/application"
+require_relative "losant_rest/application_api_token"
+require_relative "losant_rest/application_api_tokens"
 require_relative "losant_rest/application_key"
 require_relative "losant_rest/application_keys"
 require_relative "losant_rest/applications"

data/lib/losant_rest/application.rb

@@ -31,6 +31,12 @@ module LosantRest
 
     # Deletes 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, application.*, or application.delete.
+    #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -69,6 +75,12 @@ module LosantRest
 
     # Retrieves information on 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, application.*, or application.get.
+    #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -107,6 +119,12 @@ module LosantRest
 
     # Updates information about 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, application.*, or application.patch.
+    #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
     # *  {hash} application - Object containing new application properties (https://api.losant.com/#/definitions/applicationPatch)
@@ -148,6 +166,12 @@ module LosantRest
 
     # Returns payload counts for the time range specified for this 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, application.*, or application.payloadCounts.
+    #
     # Parameters:
     # *  {string} applicationId - ID of the associated application
     # *  {string} start - Start of range for payload count query (ms since epoch)

data/lib/losant_rest/{access_token.rb → application_api_token.rb}

@@ -22,42 +22,50 @@
 
 module LosantRest
 
-  # Class containing all the actions for the Access Token Resource
-  class AccessToken
+  # Class containing all the actions for the Application Api Token Resource
+  class ApplicationApiToken
 
     def initialize(client)
       @client = client
     end
 
-    # Deletes an accessToken
+    # Deletes an API Token
+    #
+    # 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, applicationApiToken.*, or applicationApiToken.delete.
     #
     # Parameters:
-    # *  {string} accessTokenId - ID associated with the accessToken
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} apiTokenId - ID associated with the API token
     # *  {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 accessToken was successfully deleted (https://api.losant.com/#/definitions/success)
+    # *  200 - If API token was successfully deleted (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if accessToken was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
     def delete(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
       headers = {}
       body = nil
 
-      raise ArgumentError.new("accessTokenId is required") unless params.has_key?(:accessTokenId)
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
 
       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 = "/access-tokens/#{params[:accessTokenId]}"
+      path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
 
       @client.request(
         method: :delete,
@@ -67,35 +75,43 @@ module LosantRest
         body: body)
     end
 
-    # Retrieves information on an accessToken
+    # Retrieves information on an API token
+    #
+    # 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, applicationApiToken.*, or applicationApiToken.get.
     #
     # Parameters:
-    # *  {string} accessTokenId - ID associated with the accessToken
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} apiTokenId - ID associated with the API token
     # *  {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 - Access token information (https://api.losant.com/#/definitions/accessToken)
+    # *  200 - API token information (https://api.losant.com/#/definitions/apiToken)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if accessToken was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if API token 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("accessTokenId is required") unless params.has_key?(:accessTokenId)
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
 
       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 = "/access-tokens/#{params[:accessTokenId]}"
+      path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
 
       @client.request(
         method: :get,
@@ -105,38 +121,46 @@ module LosantRest
         body: body)
     end
 
-    # Updates information about an accessToken
+    # Updates information about an API token
+    #
+    # 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, applicationApiToken.*, or applicationApiToken.patch.
     #
     # Parameters:
-    # *  {string} accessTokenId - ID associated with the accessToken
-    # *  {hash} accessToken - Object containing new properties of the accessToken (https://api.losant.com/#/definitions/accessTokenPatch)
+    # *  {string} applicationId - ID associated with the application
+    # *  {string} apiTokenId - ID associated with the API token
+    # *  {hash} apiToken - Object containing new properties of the API token (https://api.losant.com/#/definitions/apiTokenPatch)
     # *  {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 - Updated accessToken information (https://api.losant.com/#/definitions/accessToken)
+    # *  200 - Updated API token information (https://api.losant.com/#/definitions/apiToken)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
-    # *  404 - Error if accessToken was not found (https://api.losant.com/#/definitions/error)
+    # *  404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
     def patch(params = {})
       params = Utils.symbolize_hash_keys(params)
       query_params = { _actions: false, _links: true, _embedded: true }
       headers = {}
       body = nil
 
-      raise ArgumentError.new("accessTokenId is required") unless params.has_key?(:accessTokenId)
-      raise ArgumentError.new("accessToken is required") unless params.has_key?(:accessToken)
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
+      raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
 
-      body = params[:accessToken] if params.has_key?(:accessToken)
+      body = params[:apiToken] if params.has_key?(:apiToken)
       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 = "/access-tokens/#{params[:accessTokenId]}"
+      path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
 
       @client.request(
         method: :patch,

data/lib/losant_rest/{access_tokens.rb → application_api_tokens.rb}

@@ -22,23 +22,30 @@
 
 module LosantRest
 
-  # Class containing all the actions for the Access Tokens Resource
-  class AccessTokens
+  # Class containing all the actions for the Application Api Tokens Resource
+  class ApplicationApiTokens
 
     def initialize(client)
       @client = client
     end
 
-    # Returns the accessTokens for a user
+    # Returns the API tokens 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, applicationApiTokens.*, or applicationApiTokens.get.
     #
     # Parameters:
+    # *  {string} applicationId - ID associated with the application
     # *  {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 - Collection of accessTokens (https://api.losant.com/#/definitions/accessTokens)
+    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -48,13 +55,14 @@ module LosantRest
       headers = {}
       body = nil
 
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
 
       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 = "/access-tokens"
+      path = "/applications/#{params[:applicationId]}/tokens"
 
       @client.request(
         method: :get,
@@ -64,17 +72,24 @@ module LosantRest
         body: body)
     end
 
-    # Create a new accessToken for a user
+    # Create a new API token 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, applicationApiTokens.*, or applicationApiTokens.post.
     #
     # Parameters:
-    # *  {hash} accessToken - AccessToken information (https://api.losant.com/#/definitions/accessTokenPost)
+    # *  {string} applicationId - ID associated with the application
+    # *  {hash} apiToken - API token information (https://api.losant.com/#/definitions/applicationApiTokenPost)
     # *  {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:
-    # *  201 - The successfully created accessToken (https://api.losant.com/#/definitions/accessToken)
+    # *  201 - The successfully created API token (https://api.losant.com/#/definitions/apiToken)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -84,15 +99,16 @@ module LosantRest
       headers = {}
       body = nil
 
-      raise ArgumentError.new("accessToken is required") unless params.has_key?(:accessToken)
+      raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
+      raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
 
-      body = params[:accessToken] if params.has_key?(:accessToken)
+      body = params[:apiToken] if params.has_key?(:apiToken)
       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 = "/access-tokens"
+      path = "/applications/#{params[:applicationId]}/tokens"
 
       @client.request(
         method: :post,

data/lib/losant_rest/application_key.rb

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

data/lib/losant_rest/application_keys.rb

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