auth0 6.2.0 → 6.3.0

data/lib/auth0/groups/client.rb

@@ -29,6 +29,19 @@ module Auth0
       # @option params [String, nil] :from
       # @option params [Integer, nil] :take
       #
+      # @example
+      #   client.groups.list(
+      #     connection_id: "connection_id",
+      #     name: "name",
+      #     external_id: "external_id",
+      #     search: "search",
+      #     fields: "fields",
+      #     include_fields: true,
+      #     include_totals: true,
+      #     from: "from",
+      #     take: 1
+      #   )
+      #
       # @return [Auth0::Types::ListGroupsPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -63,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::ListGroupsPaginatedResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListGroupsPaginatedResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -83,6 +96,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.groups.get(id: "id")
+      #
       # @return [Auth0::Types::GetGroupResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -99,7 +115,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetGroupResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetGroupResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -117,6 +133,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.groups.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)

data/lib/auth0/groups/members/client.rb

@@ -26,6 +26,15 @@ module Auth0
         # @option params [String, nil] :from
         # @option params [Integer, nil] :take
         #
+        # @example
+        #   client.groups.members.get(
+        #     id: "id",
+        #     fields: "fields",
+        #     include_fields: true,
+        #     from: "from",
+        #     take: 1
+        #   )
+        #
         # @return [Auth0::Types::GetGroupMembersResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -55,7 +64,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              parsed_response = Auth0::Types::GetGroupMembersResponseContent.load(response.body)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::GetGroupMembersResponseContent.load(response.body))
               [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)

data/lib/auth0/groups/roles/client.rb

@@ -24,6 +24,13 @@ module Auth0
         # @option params [String, nil] :from
         # @option params [Integer, nil] :take
         #
+        # @example
+        #   client.groups.roles.list(
+        #     id: "id",
+        #     from: "from",
+        #     take: 1
+        #   )
+        #
         # @return [Auth0::Types::ListGroupRolesResponseContent]
         def list(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -51,7 +58,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              parsed_response = Auth0::Types::ListGroupRolesResponseContent.load(response.body)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListGroupRolesResponseContent.load(response.body))
               [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -71,6 +78,12 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :id
         #
+        # @example
+        #   client.groups.roles.create(
+        #     id: "id",
+        #     roles: ["roles"]
+        #   )
+        #
         # @return [untyped]
         def create(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -108,6 +121,12 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :id
         #
+        # @example
+        #   client.groups.roles.delete(
+        #     id: "id",
+        #     roles: ["roles"]
+        #   )
+        #
         # @return [untyped]
         def delete(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)

data/lib/auth0/guardian/client.rb

@@ -10,6 +10,83 @@ module Auth0
         @client = client
       end
 
+      # TODO: Link this endpoint to relevant documentation when available.
+      #
+      # @param request_options [Hash]
+      # @param _params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.guardian.get
+      #
+      # @return [Auth0::Types::GetGuardianSettingsResponseContent]
+      def get(request_options: {}, **_params)
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "guardian/settings",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianSettingsResponseContent.load(response.body))
+        else
+          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Update a tenant's guardian settings such as Remember Me
+      #
+      # @param request_options [Hash]
+      # @param params [Auth0::Guardian::Types::SetGuardianSettingsRequestContent]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.guardian.set(
+      #     display_remember_me_checkbox: true,
+      #     remember_me_default_value: true,
+      #     mfa_session_inactivity_timeout: 1,
+      #     mfa_session_overall_timeout: 1
+      #   )
+      #
+      # @return [Auth0::Types::SetGuardianSettingsResponseContent]
+      def set(request_options: {}, **params)
+        params = Auth0::Internal::Types::Utils.normalize_keys(params)
+        request = Auth0::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "guardian/settings",
+          body: Auth0::Guardian::Types::SetGuardianSettingsRequestContent.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Auth0::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianSettingsResponseContent.load(response.body))
+        else
+          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # @return [Auth0::Enrollments::Client]
       def enrollments
         @enrollments ||= Auth0::Guardian::Enrollments::Client.new(client: @client)

data/lib/auth0/guardian/enrollments/client.rb

@@ -24,6 +24,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.guardian.enrollments.create_ticket(user_id: "user_id")
+        #
         # @return [Auth0::Types::CreateGuardianEnrollmentTicketResponseContent]
         def create_ticket(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -41,7 +44,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::CreateGuardianEnrollmentTicketResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::CreateGuardianEnrollmentTicketResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -60,6 +63,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :id
         #
+        # @example
+        #   client.guardian.enrollments.get(id: "id")
+        #
         # @return [Auth0::Types::GetGuardianEnrollmentResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -76,7 +82,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetGuardianEnrollmentResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianEnrollmentResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -96,6 +102,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :id
         #
+        # @example
+        #   client.guardian.enrollments.delete(id: "id")
+        #
         # @return [untyped]
         def delete(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)

data/lib/auth0/guardian/factors/client.rb

@@ -23,6 +23,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.guardian.factors.list
+        #
         # @return [Array[Auth0::Types::GuardianFactor]]
         def list(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -37,10 +40,12 @@ module Auth0
             raise Auth0::Errors::TimeoutError
           end
           code = response.code.to_i
-          return if code.between?(200, 299)
-
-          error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
+          if code.between?(200, 299)
+            Auth0::Internal::Types::Utils.coerce(Internal::Types::Array[Auth0::Types::GuardianFactor], (response.body.to_s.empty? ? nil : JSON.parse(response.body, symbolize_names: true)))
+          else
+            error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
         end
 
         # Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.
@@ -54,6 +59,12 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [Auth0::Types::GuardianFactorNameEnum] :name
         #
+        # @example
+        #   client.guardian.factors.set(
+        #     name: "push-notification",
+        #     enabled: true
+        #   )
+        #
         # @return [Auth0::Types::SetGuardianFactorResponseContent]
         def set(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -75,13 +86,18 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::SetGuardianFactorResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
           end
         end
 
+        # @return [Auth0::Email::Client]
+        def email
+          @email ||= Auth0::Guardian::Factors::Email::Client.new(client: @client)
+        end
+
         # @return [Auth0::Phone::Client]
         def phone
           @phone ||= Auth0::Guardian::Factors::Phone::Client.new(client: @client)

data/lib/auth0/guardian/factors/duo/settings/client.rb

@@ -23,6 +23,9 @@ module Auth0
             # @option request_options [Hash{String => Object}] :additional_body_parameters
             # @option request_options [Integer] :timeout_in_seconds
             #
+            # @example
+            #   client.guardian.factors.duo.settings.get
+            #
             # @return [Auth0::Types::GetGuardianFactorDuoSettingsResponseContent]
             def get(request_options: {}, **_params)
               request = Auth0::Internal::JSON::Request.new(
@@ -38,7 +41,7 @@ module Auth0
               end
               code = response.code.to_i
               if code.between?(200, 299)
-                Auth0::Types::GetGuardianFactorDuoSettingsResponseContent.load(response.body)
+                (response.body.to_s.empty? ? nil : Auth0::Types::GetGuardianFactorDuoSettingsResponseContent.load(response.body))
               else
                 error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
                 raise error_class.new(response.body, code: code)
@@ -55,6 +58,9 @@ module Auth0
             # @option request_options [Hash{String => Object}] :additional_body_parameters
             # @option request_options [Integer] :timeout_in_seconds
             #
+            # @example
+            #   client.guardian.factors.duo.settings.set
+            #
             # @return [Auth0::Types::SetGuardianFactorDuoSettingsResponseContent]
             def set(request_options: {}, **params)
               params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -72,7 +78,7 @@ module Auth0
               end
               code = response.code.to_i
               if code.between?(200, 299)
-                Auth0::Types::SetGuardianFactorDuoSettingsResponseContent.load(response.body)
+                (response.body.to_s.empty? ? nil : Auth0::Types::SetGuardianFactorDuoSettingsResponseContent.load(response.body))
               else
                 error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
                 raise error_class.new(response.body, code: code)
@@ -87,6 +93,9 @@ module Auth0
             # @option request_options [Hash{String => Object}] :additional_body_parameters
             # @option request_options [Integer] :timeout_in_seconds
             #
+            # @example
+            #   client.guardian.factors.duo.settings.update
+            #
             # @return [Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent]
             def update(request_options: {}, **params)
               params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -104,7 +113,7 @@ module Auth0
               end
               code = response.code.to_i
               if code.between?(200, 299)
-                Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent.load(response.body)
+                (response.body.to_s.empty? ? nil : Auth0::Types::UpdateGuardianFactorDuoSettingsResponseContent.load(response.body))
               else
                 error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
                 raise error_class.new(response.body, code: code)

data/lib/auth0/guardian/factors/email/client.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Guardian
+    module Factors
+      module Email
+        class Client
+          # @param client [Auth0::Internal::Http::RawClient]
+          #
+          # @return [void]
+          def initialize(client:)
+            @client = client
+          end
+
+          # TODO: Link this endpoint to relevant documentation when available.
+          #
+          # @param request_options [Hash]
+          # @param _params [Hash]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          #
+          # @example
+          #   client.guardian.factors.email.get
+          #
+          # @return [Auth0::Types::GetEmailFactorSettingsResponseContent]
+          def get(request_options: {}, **_params)
+            request = Auth0::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "GET",
+              path: "guardian/factors/email/settings",
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Auth0::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              (response.body.to_s.empty? ? nil : Auth0::Types::GetEmailFactorSettingsResponseContent.load(response.body))
+            else
+              error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+
+          # TODO: Link this endpoint to relevant documentation when available.
+          #
+          # @param request_options [Hash]
+          # @param params [Auth0::Guardian::Factors::Email::Types::SetEmailFactorSettingsRequestContent]
+          # @option request_options [String] :base_url
+          # @option request_options [Hash{String => Object}] :additional_headers
+          # @option request_options [Hash{String => Object}] :additional_query_parameters
+          # @option request_options [Hash{String => Object}] :additional_body_parameters
+          # @option request_options [Integer] :timeout_in_seconds
+          #
+          # @example
+          #   client.guardian.factors.email.set(
+          #     otp_length: 1,
+          #     otp_expiration_time: 1
+          #   )
+          #
+          # @return [Auth0::Types::SetEmailFactorSettingsResponseContent]
+          def set(request_options: {}, **params)
+            params = Auth0::Internal::Types::Utils.normalize_keys(params)
+            request = Auth0::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "PUT",
+              path: "guardian/factors/email/settings",
+              body: Auth0::Guardian::Factors::Email::Types::SetEmailFactorSettingsRequestContent.new(params).to_h,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Auth0::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              (response.body.to_s.empty? ? nil : Auth0::Types::SetEmailFactorSettingsResponseContent.load(response.body))
+            else
+              error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auth0/guardian/factors/email/types/set_email_factor_settings_request_content.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Guardian
+    module Factors
+      module Email
+        module Types
+          class SetEmailFactorSettingsRequestContent < Internal::Types::Model
+            field :otp_length, -> { Integer }, optional: false, nullable: false
+
+            field :otp_expiration_time, -> { Integer }, optional: false, nullable: false
+          end
+        end
+      end
+    end
+  end
+end