auth0 6.2.0 → 6.4.0

data/lib/auth0/agents/client.rb

@@ -22,6 +22,12 @@ module Auth0
       # @option params [String, nil] :from
       # @option params [Integer, nil] :take
       #
+      # @example
+      #   client.agents.list(
+      #     from: "from",
+      #     take: 1
+      #   )
+      #
       # @return [Auth0::Types::ListAgentsResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -49,7 +55,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::ListAgentsResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListAgentsResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -68,6 +74,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.agents.create(name: "name")
+      #
       # @return [Auth0::Types::AgentResponseContent]
       def create(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -85,7 +94,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::AgentResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::AgentResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -103,6 +112,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.agents.read(id: "id")
+      #
       # @return [Auth0::Types::AgentResponseContent]
       def read(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -119,7 +131,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::AgentResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::AgentResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -137,6 +149,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.agents.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -169,6 +184,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.agents.update(id: "id")
+      #
       # @return [Auth0::Types::AgentResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -190,7 +208,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::AgentResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::AgentResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/anomaly/blocks/client.rb

@@ -24,6 +24,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [Auth0::Types::AnomalyIPFormat] :id
         #
+        # @example
+        #   client.anomaly.blocks.check_ip(id: "id")
+        #
         # @return [untyped]
         def check_ip(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -58,6 +61,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [Auth0::Types::AnomalyIPFormat] :id
         #
+        # @example
+        #   client.anomaly.blocks.unblock_ip(id: "id")
+        #
         # @return [untyped]
         def unblock_ip(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)

data/lib/auth0/api/authentication_endpoints.rb

@@ -74,6 +74,46 @@ module Auth0
         ::Auth0::AccessToken.from_response request_with_retry(:post, '/oauth/token', request_params)
       end
 
+      # Start a Device Authorization flow.
+      #
+      # Device flow runs as a public client: no client_secret or client assertion is
+      # sent, and Auth0 rejects the request with `unauthorized_client` if one is.
+      # @see https://auth0.com/docs/api/authentication#device-authorization-flow
+      # @param scope [string] Space-separated list of requested scopes.
+      # @param audience [string] Unique identifier of the target API.
+      # @param client_id [string] Client ID for the application
+      # @return [json] Returns device_code, user_code, verification_uri,
+      #   verification_uri_complete, expires_in and interval.
+      def start_device_flow(scope: nil, audience: nil, client_id: @client_id)
+        request_params = {
+          client_id: client_id,
+          scope: scope,
+          audience: audience
+        }
+
+        request_with_retry(:post, '/oauth/device/code', request_params)
+      end
+
+      # Get access and ID tokens using a device code.
+      #
+      # Device flow runs as a public client: no client_secret or client assertion is
+      # sent, and Auth0 rejects the request with `unauthorized_client` if one is.
+      # @see https://auth0.com/docs/api/authentication#device-authorization-flow
+      # @param device_code [string] The device code returned by start_device_flow.
+      # @param client_id [string] Client ID for the application
+      # @return [Auth0::AccessToken] Returns the access_token and id_token
+      def exchange_device_code_for_tokens(device_code, client_id: @client_id)
+        raise Auth0::InvalidParameter, 'Must provide a device code' if device_code.to_s.empty?
+
+        request_params = {
+          grant_type: 'urn:ietf:params:oauth:grant-type:device_code',
+          client_id: client_id,
+          device_code: device_code
+        }
+
+        ::Auth0::AccessToken.from_response request_with_retry(:post, '/oauth/token', request_params)
+      end
+
       # Get access and ID tokens using a refresh token.
       # @see https://auth0.com/docs/api/authentication#refresh-token
       # @param refresh_token [string] Refresh token to use. Request this with

data/lib/auth0/attack_protection/bot_detection/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.bot_detection.get
+        #
         # @return [Auth0::Types::GetBotDetectionSettingsResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetBotDetectionSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetBotDetectionSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.bot_detection.update
+        #
         # @return [Auth0::Types::UpdateBotDetectionSettingsResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateBotDetectionSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBotDetectionSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/attack_protection/breached_password_detection/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.breached_password_detection.get
+        #
         # @return [Auth0::Types::GetBreachedPasswordDetectionSettingsResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetBreachedPasswordDetectionSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetBreachedPasswordDetectionSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.breached_password_detection.update
+        #
         # @return [Auth0::Types::UpdateBreachedPasswordDetectionSettingsResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateBreachedPasswordDetectionSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBreachedPasswordDetectionSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/attack_protection/brute_force_protection/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.brute_force_protection.get
+        #
         # @return [Auth0::Types::GetBruteForceSettingsResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetBruteForceSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetBruteForceSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.brute_force_protection.update
+        #
         # @return [Auth0::Types::UpdateBruteForceSettingsResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateBruteForceSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBruteForceSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/attack_protection/captcha/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.captcha.get
+        #
         # @return [Auth0::Types::GetAttackProtectionCaptchaResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetAttackProtectionCaptchaResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetAttackProtectionCaptchaResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.captcha.update
+        #
         # @return [Auth0::Types::UpdateAttackProtectionCaptchaResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateAttackProtectionCaptchaResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateAttackProtectionCaptchaResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/attack_protection/phone_provider_protection/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.phone_provider_protection.get
+        #
         # @return [Auth0::Types::GetPhoneProviderProtectionResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetPhoneProviderProtectionResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetPhoneProviderProtectionResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.phone_provider_protection.patch(type: "exponential")
+        #
         # @return [Auth0::Types::PatchPhoneProviderProtectionResponseContent]
         def patch(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::PatchPhoneProviderProtectionResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::PatchPhoneProviderProtectionResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/attack_protection/suspicious_ip_throttling/client.rb

@@ -21,6 +21,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.suspicious_ip_throttling.get
+        #
         # @return [Auth0::Types::GetSuspiciousIPThrottlingSettingsResponseContent]
         def get(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -36,7 +39,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetSuspiciousIPThrottlingSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetSuspiciousIPThrottlingSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -53,6 +56,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.attack_protection.suspicious_ip_throttling.update
+        #
         # @return [Auth0::Types::UpdateSuspiciousIPThrottlingSettingsResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -70,7 +76,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateSuspiciousIPThrottlingSettingsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateSuspiciousIPThrottlingSettingsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/branding/client.rb

@@ -20,6 +20,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.branding.get
+      #
       # @return [Auth0::Types::GetBrandingResponseContent]
       def get(request_options: {}, **_params)
         request = Auth0::Internal::JSON::Request.new(
@@ -35,7 +38,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetBrandingResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetBrandingResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -52,6 +55,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.branding.update
+      #
       # @return [Auth0::Types::UpdateBrandingResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -69,7 +75,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateBrandingResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBrandingResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/branding/phone/providers/client.rb

@@ -25,6 +25,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [Boolean, nil] :disabled
           #
+          # @example
+          #   client.branding.phone.providers.list(disabled: true)
+          #
           # @return [Auth0::Types::ListBrandingPhoneProvidersResponseContent]
           def list(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -45,7 +48,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::ListBrandingPhoneProvidersResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::ListBrandingPhoneProvidersResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -65,6 +68,14 @@ module Auth0
           # @option request_options [Hash{String => Object}] :additional_body_parameters
           # @option request_options [Integer] :timeout_in_seconds
           #
+          # @example
+          #   client.branding.phone.providers.create(
+          #     name: "twilio",
+          #     credentials: {
+          #       auth_token: "auth_token"
+          #     }
+          #   )
+          #
           # @return [Auth0::Types::CreateBrandingPhoneProviderResponseContent]
           def create(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -82,7 +93,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::CreateBrandingPhoneProviderResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::CreateBrandingPhoneProviderResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -102,6 +113,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.providers.get(id: "id")
+          #
           # @return [Auth0::Types::GetBrandingPhoneProviderResponseContent]
           def get(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -118,7 +132,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::GetBrandingPhoneProviderResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::GetBrandingPhoneProviderResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -136,6 +150,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.providers.delete(id: "id")
+          #
           # @return [untyped]
           def delete(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -171,6 +188,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.providers.update(id: "id")
+          #
           # @return [Auth0::Types::UpdateBrandingPhoneProviderResponseContent]
           def update(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -192,7 +212,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::UpdateBrandingPhoneProviderResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBrandingPhoneProviderResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -208,6 +228,12 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.providers.test(
+          #     id: "id",
+          #     to: "to"
+          #   )
+          #
           # @return [Auth0::Types::CreatePhoneProviderSendTestResponseContent]
           def test(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -229,7 +255,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::CreatePhoneProviderSendTestResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::CreatePhoneProviderSendTestResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)

data/lib/auth0/branding/phone/templates/client.rb

@@ -21,6 +21,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [Boolean, nil] :disabled
           #
+          # @example
+          #   client.branding.phone.templates.list(disabled: true)
+          #
           # @return [Auth0::Types::ListPhoneTemplatesResponseContent]
           def list(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::ListPhoneTemplatesResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::ListPhoneTemplatesResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -56,6 +59,9 @@ module Auth0
           # @option request_options [Hash{String => Object}] :additional_body_parameters
           # @option request_options [Integer] :timeout_in_seconds
           #
+          # @example
+          #   client.branding.phone.templates.create
+          #
           # @return [Auth0::Types::CreatePhoneTemplateResponseContent]
           def create(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -73,7 +79,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::CreatePhoneTemplateResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::CreatePhoneTemplateResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -89,6 +95,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.templates.get(id: "id")
+          #
           # @return [Auth0::Types::GetPhoneTemplateResponseContent]
           def get(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -105,7 +114,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::GetPhoneTemplateResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::GetPhoneTemplateResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -121,6 +130,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.templates.delete(id: "id")
+          #
           # @return [untyped]
           def delete(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -151,6 +163,9 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.templates.update(id: "id")
+          #
           # @return [Auth0::Types::UpdatePhoneTemplateResponseContent]
           def update(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -172,7 +187,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::UpdatePhoneTemplateResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::UpdatePhoneTemplateResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -188,14 +203,25 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.templates.reset(
+          #     id: "id",
+          #     request: {
+          #       key: "value"
+          #     }
+          #   )
+          #
           # @return [Auth0::Types::ResetPhoneTemplateResponseContent]
           def reset(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
+            path_param_names = %i[id]
+            body_params = params.except(*path_param_names)
+
             request = Auth0::Internal::JSON::Request.new(
               base_url: request_options[:base_url],
               method: "PATCH",
               path: "branding/phone/templates/#{URI.encode_uri_component(params[:id].to_s)}/reset",
-              body: params,
+              body: body_params,
               request_options: request_options
             )
             begin
@@ -205,7 +231,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::ResetPhoneTemplateResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::ResetPhoneTemplateResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)
@@ -221,6 +247,12 @@ module Auth0
           # @option request_options [Integer] :timeout_in_seconds
           # @option params [String] :id
           #
+          # @example
+          #   client.branding.phone.templates.test(
+          #     id: "id",
+          #     to: "to"
+          #   )
+          #
           # @return [Auth0::Types::CreatePhoneTemplateTestNotificationResponseContent]
           def test(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -242,7 +274,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              Auth0::Types::CreatePhoneTemplateTestNotificationResponseContent.load(response.body)
+              (response.body.to_s.empty? ? nil : Auth0::Types::CreatePhoneTemplateTestNotificationResponseContent.load(response.body))
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
               raise error_class.new(response.body, code: code)