auth0 4.0.0 → 4.1.0

data/lib/auth0/api/v2/clients.rb

@@ -8,7 +8,7 @@ module Auth0
         # Retrieves a list of all client applications. Accepts a list of fields to include or exclude.
         # @see https://auth0.com/docs/api/v2#!/clients/get_clients
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
         # @return [json] Returns the clients applications.
         def clients(fields: nil, include_fields: nil)
@@ -19,15 +19,15 @@ module Auth0
           }
           get(clients_path, request_params)
         end
-        alias_method :get_clients, :clients
+        alias get_clients clients
 
         # Creates a new client application.
         # @see https://auth0.com/docs/api/v2#!/clients/post_clients
-        # @param name [string] The name of the client. Must contain at least one character. Does not allow '<' or '>'
+        # @param name [string] The name of the client. Must contain at least one character. Does not allow '<' or '>'.
         # @param options [hash] The Hash options used to define the client's properties.
-        # @return  [json] Returns the created client application.
+        # @return [json] Returns the created client application.
         def create_client(name, options = {})
-          fail Auth0::MissingParameter, 'Must specify a valid client name' if name.to_s.empty?
+          raise Auth0::MissingParameter, 'Must specify a valid client name' if name.to_s.empty?
           request_params = Hash[options.map { |(k, v)| [k.to_sym, v] }]
           request_params[:name] = name
           post(clients_path, request_params)
@@ -35,12 +35,12 @@ module Auth0
 
         # Retrieves a client by its id.
         # @see https://auth0.com/docs/api/v2#!/Clients/get_clients_by_id
-        # @param client_id [string] The id of the client to retrieve
+        # @param client_id [string] The id of the client to retrieve.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] If the fields specified are to be included in the result, false otherwise
-        # @return  [json] Returns the requested client application.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        # @return [json] Returns the requested client application.
         def client(client_id, fields: nil, include_fields: nil)
-          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          raise Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
           include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
             fields: fields,
@@ -52,20 +52,20 @@ module Auth0
 
         # Deletes a client and all its related assets (like rules, connections, etc) given its id.
         # @see https://auth0.com/docs/api/v2#!/Clients/delete_clients_by_id
-        # @param client_id [string] The id of the client to delete
+        # @param client_id [string] The id of the client to delete.
         def delete_client(client_id)
-          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          raise Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
           path = "#{clients_path}/#{client_id}"
           delete(path)
         end
 
         # Updates a client.
         # @see https://auth0.com/docs/api/v2#!/Clients/patch_clients_by_id
-        # @param client_id [string] The id of the client to update
+        # @param client_id [string] The id of the client to update.
         # @param options [hash] The Hash options used to define the client's properties.
         def patch_client(client_id, options)
-          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
-          fail Auth0::MissingParameter, 'Must specify a valid body' if options.to_s.empty?
+          raise Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          raise Auth0::MissingParameter, 'Must specify a valid body' if options.to_s.empty?
           path = "#{clients_path}/#{client_id}"
           patch(path, options)
         end

data/lib/auth0/api/v2/connections.rb

@@ -8,9 +8,10 @@ module Auth0
         # Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is
         # being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
         # @see https://auth0.com/docs/api/v2#!/Connections/get_connections
-        # @param strategy [string] Provide a type of strategy to only retrieve connections with that strategy
+        # @param strategy [string] Provide a type of strategy to only retrieve connections with that strategy (e.g. 'ad',
+        # 'facebook', 'twitter').
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
         # @return [json] Returns the existing connections matching the strategy.
         def connections(strategy: nil, fields: nil, include_fields: true)
@@ -21,28 +22,28 @@ module Auth0
           }
           get(connections_path, request_params)
         end
-        alias_method :get_connections, :connections
+        alias get_connections connections
 
         # Creates a new connection according to the JSON object received in body.
         # @see https://auth0.com/docs/api/v2#!/Connections/post_connections
         # @param body [hash] The Hash options used to define the conecctions's properties.
         #
-        # @return  [json] Returns the created connection.
+        # @return [json] Returns the created connection.
         def create_connection(body)
-          fail Auth0::InvalidParameter, 'Must specify a body to create a connection' if body.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a body to create a connection' if body.to_s.empty?
           request_params = body
           post(connections_path, request_params)
         end
 
         # Retrieves a connection by its id.
         # @see https://auth0.com/docs/api/v2#!/Connections/get_connections_by_id
-        # @param connection_id [string] The id of the connection to retrieve
+        # @param connection_id [string] The id of the connection to retrieve.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
-        # @return [json] Returns the matching connection
+        # @return [json] Returns the matching connection.
         def connection(connection_id, fields: nil, include_fields: true)
-          fail Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
           path = "#{connections_path}/#{connection_id}"
           request_params = {
             fields:         fields,
@@ -53,9 +54,9 @@ module Auth0
 
         # Deletes a connection and all its users.
         # @see https://auth0.com/docs/api/v2#!/Connections/delete_connections_by_id
-        # @param connection_id [string] The id of the connection to delete
+        # @param connection_id [string] The id of the connection to delete.
         def delete_connection(connection_id)
-          fail Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
           path = "#{connections_path}/#{connection_id}"
           delete(path)
         end
@@ -63,25 +64,23 @@ module Auth0
         # Deletes a specified connection user by its email (currently only database connections are supported and you
         # cannot delete all users from specific connection).
         # @see https://auth0.com/docs/api/v2#!/Connections/delete_users
-        # @param connection_id [string] The id of the connection
-        # @param user_email [string] The email of the user to delete
-        #
-        # @return  [json] Returns the updated connection.
+        # @param connection_id [string] The id of the connection.
+        # @param user_email [string] The email of the user to delete.
         def delete_connection_user(connection_id, user_email)
-          fail Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid user email' if user_email.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid user email' if user_email.to_s.empty?
           path = "#{connections_path}/#{connection_id}/users?email=#{user_email}"
           delete(path)
         end
 
         # Updates a connection. Updates the fields specified in the body parameter.
         # @see https://auth0.com/docs/api/v2#!/Connections/patch_connections_by_id
-        # @param connection_id [string] The id of the connection to delete
+        # @param connection_id [string] The id of the connection to delete.
         # @param body [hash] The Hash options used to update the conecctions's properties.
         #
-        # @return  [json] Returns the updated connection.
+        # @return [json] Returns the updated connection.
         def update_connection(connection_id, body)
-          fail Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid connection id' if connection_id.to_s.empty?
           path = "#{connections_path}/#{connection_id}"
           patch(path, body)
         end

data/lib/auth0/api/v2/device_credentials.rb

@@ -0,0 +1,76 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the device crenditials endpoints
+      module DeviceCredentials
+        attr_reader :device_credentials_path
+
+        # Retrieves log entries that match the specified search criteria.
+        # @see https://auth0.com/docs/api/v2#!/device_credentials/get_device_credentials
+        # @param fields [string] A comma separated list of fields to include or exclude from the result.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        # @param user_id [string] The user_id of the devices to retrieve.
+        # @param client_id [string] The client_id of the devices to retrieve.
+        # @param type [string] The type of credentials. Possible values: 'public_key' or 'refresh_token'.
+        #
+        # @return [json] Returns the list of existing devices for the specified client_id.
+        # rubocop:disable Metrics/AbcSize
+        def device_credentials(client_id, options = {})
+          request_params = {
+            fields: options.fetch(:fields, nil),
+            include_fields: options.fetch(:include_fields, nil),
+            user_id: options.fetch(:user_id, nil),
+            client_id: client_id,
+            type: options.fetch(:type, nil)
+          }
+          raise Auth0::InvalidParameter, 'Must supply a valid client_id' if client_id.to_s.empty?
+          if !request_params[:type].nil? && !%w(public_key refresh_token).include?(request_params[:type])
+            raise Auth0::InvalidParameter, 'Type must be one of \'public_key\', \'refresh_token\''
+          end
+          get(device_credentials_path, request_params)
+        end
+        alias list_device_credentials device_credentials
+
+        # Creates a new device public key.
+        # @see https://auth0.com/docs/api/v2#!/device_credentials/post_device_credentials
+        # @param device_name [string] The device's name, a value that must be easily recognized by the device's owner.
+        # @param value [string] A base64 encoded string with the value of the credential.
+        # @param device_id [string] A unique identifier for the device.
+        # @param client_id [string] The client_id of the client for which the credential will be created.
+        #
+        # @return [json] Returns the created public key.
+        def create_device_credential(device_name, value, device_id, client_id)
+          raise Auth0::InvalidParameter, 'Must supply a valid device_name' if device_name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid value' if value.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid device_id' if device_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid client_id' if client_id.to_s.empty?
+          request_params = {
+            device_name:  device_name,
+            type:         'public_key',
+            value:        value,
+            device_id:    device_id,
+            client_id:    client_id
+          }
+          post(device_credentials_path, request_params)
+        end
+        alias create_device_public_key create_device_credential
+
+        # Deletes a single device credential given its id.
+        # @see https://auth0.com/docs/api/v2#!/device_credentials/delete_device_credentials_by_id
+        # @param id [string] The id of the credential to delete.
+        def delete_device_credential(id)
+          raise Auth0::InvalidParameter, 'Must supply a valid id' if id.to_s.empty?
+          path = "#{device_credentials_path}/#{id}"
+          delete(path)
+        end
+
+        private
+
+        # Device Credentials API path
+        def device_credentials_path
+          @device_credentials_path ||= '/api/v2/device-credentials'
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/emails.rb

@@ -8,7 +8,7 @@ module Auth0
         # Get all the email providers.
         # @see https://auth0.com/docs/api/v2#!/Emails/get_provider
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
         # @return [json] Returns the existing email providers.
         def get_provider(fields: nil, include_fields: nil)
@@ -21,11 +21,9 @@ module Auth0
 
         # Configure a new email provider.
         # @see https://auth0.com/docs/api/v2#!/Emails/post_provider
-        # @param body [hash] The Hash options used to spcify the email provider's properties.
-        #
-        # @return [json] Returns the created email provider.
+        # @param body [hash] The Hash options used to specify the email provider's properties.
         def configure_provider(body)
-          fail Auth0::InvalidParameter, 'Must supply a valid body to create an email provider' if body.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body to create an email provider' if body.to_s.empty?
           post(email_path, body)
         end
 
@@ -39,11 +37,11 @@ module Auth0
 
         # Updates the configured email provider.
         # @see https://auth0.com/docs/api/v2#!/Emails/patch_provider
-        # @param body [hash] The Hash options used to spcify the email provider's properties.
+        # @param body [hash] The Hash options used to specify the email provider's properties.
         #
         # @return [json] Returns the updated email provider.
         def update_provider(body)
-          fail Auth0::InvalidParameter, 'Must supply a valid body to update an email provider' if body.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body to update an email provider' if body.to_s.empty?
           patch(email_path, body)
         end
 

data/lib/auth0/api/v2/jobs.rb

@@ -7,11 +7,11 @@ module Auth0
 
         # Retrieves a job. Useful to check its status.
         # @see https://auth0.com/docs/api/v2#!/Jobs/get_jobs_by_job_id
-        # @param job_id [string] The id of the job
+        # @param job_id [string] The id of the job.
         #
-        # @return [json] the job status and properties
+        # @return [json] Returns the job status and properties.
         def get_job(job_id)
-          fail Auth0::InvalidParameter, 'Must specify a job id' if job_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a job id' if job_id.to_s.empty?
           path = "#{jobs_path}/#{job_id}"
           get(path)
         end
@@ -19,13 +19,13 @@ module Auth0
         # Imports users to a connection from a file using a long running job.
         # Important: The documentation for the file format is at https://docs.auth0.com/bulk-import.
         # @see https://auth0.com/docs/api/v2#!/Jobs/post_users_imports
-        # @param users_file [file] A file containing the users to import
-        # @param connection_id [string] The connection id of the connection to which users will be inserted
+        # @param users_file [file] A file containing the users to import.
+        # @param connection_id [string] The connection id of the connection to which users will be inserted.
         #
-        # @return [json] the job status and properties
+        # @return [json] Returns the job status and properties.
         def import_users(users_file, connection_id)
-          fail Auth0::InvalidParameter, 'Must specify a valid file' if users_file.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must specify a connection_id' if connection_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid file' if users_file.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a connection_id' if connection_id.to_s.empty?
           request_params = {
             users: users_file,
             connection_id: connection_id
@@ -36,13 +36,16 @@ module Auth0
 
         # Send an email to the specified user that asks them to click a link to verify their email address.
         # @see https://auth0.com/docs/api/v2#!/Jobs/post_verification_email
-        # @param user_id [string] The user_id of the user to whom the email will be sent
+        # @param user_id [string] The user_id of the user to whom the email will be sent.
         #
-        # @return [json] the job status and properties
+        # @return [json] Returns the job status and properties.
         def send_verification_email(user_id)
-          fail Auth0::InvalidParameter, 'Must specify a user id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a user id' if user_id.to_s.empty?
+          request_params = {
+            user_id: user_id
+          }
           path = "#{jobs_path}/verification-email"
-          post(path, user_id)
+          post(path, request_params)
         end
 
         private

data/lib/auth0/api/v2/logs.rb

@@ -0,0 +1,65 @@
+# rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+module Auth0
+  module Api
+    module V2
+      # Methods to use the logs endpoints
+      module Logs
+        attr_reader :logs_path
+
+        # Retrieves log entries that match the specified search criteria.
+        # @see https://auth0.com/docs/api/v2#!/Logs/get_logs
+        # @param q [string] Query in Lucene query string syntax.
+        # @param page [integer] The page number. Zero based.
+        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
+        # @param fields [string] A comma separated list of fields to include or exclude from the result.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        # @param include_totals [string] True if a query summary must be included in the result, false otherwise.
+        # @param from [string] Log Event Id to start retrieving logs. You can limit the amount of logs using the take
+        # parameter.
+        # @param take [integer] The total amount of entries to retrieve when using the from parameter.
+        # Default: 50. Max value: 100.
+        #
+        # @return [json] Returns the list of existing log entries.
+        def logs(options = {})
+          request_params = {
+            q: options.fetch(:q, nil),
+            page: options.fetch(:page, nil),
+            per_page: options.fetch(:per_page, nil),
+            sort: options.fetch(:sort, nil),
+            fields: options.fetch(:fields, nil),
+            include_fields: options.fetch(:include_fields, nil),
+            include_totals: options.fetch(:include_totals, nil),
+            from: options.fetch(:from, nil),
+            take: options.fetch(:take, nil)
+          }
+          if request_params[:take].to_i > 100
+            raise Auth0::InvalidParameter, 'The total amount of entries to retrieve should be less than 100'
+          end
+          if request_params[:per_page].to_i > 100
+            raise Auth0::InvalidParameter, 'The total amount of entries per page should be less than 100'
+          end
+          get(logs_path, request_params)
+        end
+        alias get_logs logs
+
+        # Retrieves log entries that match the specified search criteria.
+        # @see https://auth0.com/docs/api/v2#!/Logs/get_logs_by_id
+        # @param id [string] The log_id of the log to retrieve.
+        #
+        # @return [json] Returns the log with the given id if exists.
+        def log(log_id)
+          raise Auth0::MissingParameter, 'Must supply a valid log_id' if log_id.to_s.empty?
+          path = "#{logs_path}/#{log_id}"
+          get(path)
+        end
+        alias get_logs_by_id log
+
+        # Logs API path
+        def logs_path
+          @logs_path ||= '/api/v2/logs'
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/resource_servers.rb

@@ -0,0 +1,61 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the resource servers endpoints
+      module ResourceServers
+        attr_reader :resource_servers_path
+
+        # Retrieves a resource server by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Resource_Servers/get_resource_servers_by_id
+        # @param resource_server_id [string] The id of the resource server to retrieve.
+        #
+        # @return [json] Returns the resource server.
+        def resource_server(resource_server_id)
+          raise Auth0::InvalidParameter, 'Must supply a valid resource server id' if resource_server_id.to_s.empty?
+          path = "#{resource_servers_path}/#{resource_server_id}"
+          get(path)
+        end
+
+        alias get_resource_server resource_server
+
+        # Creates a new resource server according to the JSON object received in body.
+        # @see https://auth0.com/docs/api/management/v2#!/Resource_Servers/post_resource_servers
+        # @param identifier [string] The identifier of the resource server.
+        # @param name [string] The name of the resource server. Must contain at least one character.
+        # Does not allow '<' or '>'.
+        # @param signing_alg [string] The algorithm used to sign tokens.
+        # @param signing_secret [string] The secret used to sign tokens when using symmetric algorithms.
+        # @param token_lifetime [integer] The amount of time (in seconds) that the token will be valid
+        # after being issued.
+        # @param scopes [array] The scope of the resource server.
+        #
+        # @return [json] Returns the resource server.
+        def create_resource_server(identifier, options = {})
+          raise Auth0::InvalidParameter, 'Must supply a valid resource server id' if identifier.to_s.empty?
+          if ['<', '>'].include?(options.fetch(:name, ''))
+            raise Auth0::InvalidParameter, 'Name must contain at least one character. Does not allow "<" or ">"'
+          end
+          request_params = Hash[options.map { |(k, v)| [k.to_sym, v] }]
+          request_params[:identifier] = identifier
+          post(resource_servers_path, request_params)
+        end
+
+        # Deletes a resource server  by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Resource_Servers/delete_resource_servers_by_id
+        # @param resource_server_id [string] The id of the resource server to delete.
+        def delete_resource_server(resource_server_id)
+          raise Auth0::InvalidParameter, 'Must supply a valid resource server id' if resource_server_id.to_s.empty?
+          path = "#{resource_servers_path}/#{resource_server_id}"
+          delete(path)
+        end
+
+        private
+
+        # Resource Servers API path
+        def resource_servers_path
+          @resource_servers_path ||= '/api/v2/resource-servers'
+        end
+      end
+    end
+  end
+end