auth0 6.2.0 → 6.3.0

data/lib/auth0/organizations/organization_template/client.rb

@@ -23,6 +23,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :id
         #
+        # @example
+        #   client.organizations.organization_template.get(id: "id")
+        #
         # @return [Auth0::Types::OrganizationTemplate]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -39,7 +42,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::OrganizationTemplate.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::OrganizationTemplate.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -58,6 +61,12 @@ module Auth0
         # @option params [String] :id
         # @option params [String] :template_id
         #
+        # @example
+        #   client.organizations.organization_template.assign_organization_template(
+        #     id: "id",
+        #     template_id: "template_id"
+        #   )
+        #
         # @return [untyped]
         def assign_organization_template(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -91,6 +100,12 @@ module Auth0
         # @option params [String] :id
         # @option params [String] :template_id
         #
+        # @example
+        #   client.organizations.organization_template.unassign_organization_template(
+        #     id: "id",
+        #     template_id: "template_id"
+        #   )
+        #
         # @return [untyped]
         def unassign_organization_template(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)

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

@@ -26,6 +26,14 @@ module Auth0
           # @option params [String, nil] :from
           # @option params [Integer, nil] :take
           #
+          # @example
+          #   client.organizations.roles.groups.list(
+          #     organization_id: "organization_id",
+          #     role_id: "role_id",
+          #     from: "from",
+          #     take: 1
+          #   )
+          #
           # @return [Auth0::Types::ListOrganizationRoleGroupsResponseContent]
           def list(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -53,7 +61,7 @@ module Auth0
               end
               code = response.code.to_i
               if code.between?(200, 299)
-                parsed_response = Auth0::Types::ListOrganizationRoleGroupsResponseContent.load(response.body)
+                parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListOrganizationRoleGroupsResponseContent.load(response.body))
                 [parsed_response, response]
               else
                 error_class = Auth0::Errors::ResponseError.subclass_for_code(code)

data/lib/auth0/organizations/roles/members/client.rb

@@ -34,6 +34,16 @@ module Auth0
           # @option params [String, nil] :fields
           # @option params [Boolean, nil] :include_fields
           #
+          # @example
+          #   client.organizations.roles.members.list(
+          #     id: "id",
+          #     role_id: "role_id",
+          #     from: "from",
+          #     take: 1,
+          #     fields: "fields",
+          #     include_fields: true
+          #   )
+          #
           # @return [Auth0::Types::ListOrganizationRoleMembersResponseContent]
           def list(request_options: {}, **params)
             params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -63,7 +73,7 @@ module Auth0
               end
               code = response.code.to_i
               if code.between?(200, 299)
-                parsed_response = Auth0::Types::ListOrganizationRoleMembersResponseContent.load(response.body)
+                parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListOrganizationRoleMembersResponseContent.load(response.body))
                 [parsed_response, response]
               else
                 error_class = Auth0::Errors::ResponseError.subclass_for_code(code)

data/lib/auth0/organizations/types/search_organizations_request_parameters.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Organizations
+    module Types
+      class SearchOrganizationsRequestParameters < Internal::Types::Model
+        field :q, -> { String }, optional: true, nullable: false
+
+        field :parser, -> { Auth0::Types::SearchParserEnum }, optional: true, nullable: false
+
+        field :take, -> { Integer }, optional: true, nullable: false
+
+        field :from, -> { String }, optional: true, nullable: false
+
+        field :sort, -> { Auth0::Types::OrganizationSortFieldEnum }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/auth0/prompts/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.prompts.get_settings
+      #
       # @return [Auth0::Types::GetSettingsResponseContent]
       def get_settings(request_options: {}, **_params)
         request = Auth0::Internal::JSON::Request.new(
@@ -39,7 +42,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetSettingsResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetSettingsResponseContent.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 [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.prompts.update_settings
+      #
       # @return [Auth0::Types::UpdateSettingsResponseContent]
       def update_settings(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -77,7 +83,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateSettingsResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateSettingsResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/prompts/custom_text/client.rb

@@ -23,6 +23,12 @@ module Auth0
         # @option params [Auth0::Types::PromptGroupNameEnum] :prompt
         # @option params [Auth0::Types::PromptLanguageEnum] :language
         #
+        # @example
+        #   client.prompts.custom_text.get(
+        #     prompt: "login",
+        #     language: "am"
+        #   )
+        #
         # @return [Hash[String, Object]]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -39,7 +45,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetCustomTextsByLanguageResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetCustomTextsByLanguageResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -58,14 +64,26 @@ module Auth0
         # @option params [Auth0::Types::PromptGroupNameEnum] :prompt
         # @option params [Auth0::Types::PromptLanguageEnum] :language
         #
+        # @example
+        #   client.prompts.custom_text.set(
+        #     prompt: "login",
+        #     language: "am",
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
         # @return [untyped]
         def set(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[prompt language]
+          body_params = params.except(*path_param_names)
+
           request = Auth0::Internal::JSON::Request.new(
             base_url: request_options[:base_url],
             method: "PUT",
             path: "prompts/#{URI.encode_uri_component(params[:prompt].to_s)}/custom-text/#{URI.encode_uri_component(params[:language].to_s)}",
-            body: params,
+            body: body_params,
             request_options: request_options
           )
           begin

data/lib/auth0/prompts/partials/client.rb

@@ -22,6 +22,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [Auth0::Types::PartialGroupsEnum] :prompt
         #
+        # @example
+        #   client.prompts.partials.get(prompt: "login")
+        #
         # @return [Hash[String, Object]]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -38,7 +41,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetPartialsResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetPartialsResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -56,14 +59,25 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [Auth0::Types::PartialGroupsEnum] :prompt
         #
+        # @example
+        #   client.prompts.partials.set(
+        #     prompt: "login",
+        #     request: {
+        #       key: "value"
+        #     }
+        #   )
+        #
         # @return [untyped]
         def set(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          path_param_names = %i[prompt]
+          body_params = params.except(*path_param_names)
+
           request = Auth0::Internal::JSON::Request.new(
             base_url: request_options[:base_url],
             method: "PUT",
             path: "prompts/#{URI.encode_uri_component(params[:prompt].to_s)}/partials",
-            body: params,
+            body: body_params,
             request_options: request_options
           )
           begin

data/lib/auth0/prompts/rendering/client.rb

@@ -29,6 +29,18 @@ module Auth0
         # @option params [String, nil] :screen
         # @option params [Auth0::Types::AculRenderingModeEnum, nil] :rendering_mode
         #
+        # @example
+        #   client.prompts.rendering.list(
+        #     fields: "fields",
+        #     include_fields: true,
+        #     page: 1,
+        #     per_page: 1,
+        #     include_totals: true,
+        #     prompt: "prompt",
+        #     screen: "screen",
+        #     rendering_mode: "advanced"
+        #   )
+        #
         # @return [Auth0::Types::ListAculsOffsetPaginatedResponseContent]
         def list(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -63,7 +75,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              parsed_response = Auth0::Types::ListAculsOffsetPaginatedResponseContent.load(response.body)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListAculsOffsetPaginatedResponseContent.load(response.body))
               [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -84,6 +96,12 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.prompts.rendering.bulk_update(configs: [{
+        #     prompt: "login",
+        #     screen: "login"
+        #   }])
+        #
         # @return [Auth0::Types::BulkUpdateAculResponseContent]
         def bulk_update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -101,7 +119,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::BulkUpdateAculResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::BulkUpdateAculResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -120,6 +138,12 @@ module Auth0
         # @option params [Auth0::Types::PromptGroupNameEnum] :prompt
         # @option params [Auth0::Types::ScreenGroupNameEnum] :screen
         #
+        # @example
+        #   client.prompts.rendering.get(
+        #     prompt: "login",
+        #     screen: "login"
+        #   )
+        #
         # @return [Auth0::Types::GetAculResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -136,7 +160,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetAculResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetAculResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -157,6 +181,12 @@ module Auth0
         # @option params [Auth0::Types::PromptGroupNameEnum] :prompt
         # @option params [Auth0::Types::ScreenGroupNameEnum] :screen
         #
+        # @example
+        #   client.prompts.rendering.update(
+        #     prompt: "login",
+        #     screen: "login"
+        #   )
+        #
         # @return [Auth0::Types::UpdateAculResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -178,7 +208,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateAculResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateAculResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/rate_limit_policies/client.rb

@@ -23,6 +23,15 @@ module Auth0
       # @option params [Integer, nil] :take
       # @option params [String, nil] :from
       #
+      # @example
+      #   client.rate_limit_policies.list(
+      #     resource: "oauth_authentication_api",
+      #     consumer: "client",
+      #     consumer_selector: "consumer_selector",
+      #     take: 1,
+      #     from: "from"
+      #   )
+      #
       # @return [Auth0::Types::ListRateLimitPoliciesPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -53,7 +62,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::ListRateLimitPoliciesPaginatedResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListRateLimitPoliciesPaginatedResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -70,6 +79,16 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.rate_limit_policies.create(
+      #     resource: "oauth_authentication_api",
+      #     consumer: "client",
+      #     consumer_selector: "consumer_selector",
+      #     configuration: {
+      #       action: "allow"
+      #     }
+      #   )
+      #
       # @return [Auth0::Types::CreateRateLimitPolicyResponseContent]
       def create(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -87,7 +106,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::CreateRateLimitPolicyResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::CreateRateLimitPolicyResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -103,6 +122,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.rate_limit_policies.get(id: "id")
+      #
       # @return [Auth0::Types::GetRateLimitPolicyResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -119,7 +141,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetRateLimitPolicyResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetRateLimitPolicyResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -135,6 +157,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.rate_limit_policies.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -165,6 +190,14 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.rate_limit_policies.update(
+      #     id: "id",
+      #     configuration: {
+      #       action: "allow"
+      #     }
+      #   )
+      #
       # @return [Auth0::Types::UpdateRateLimitPolicyResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -186,7 +219,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateRateLimitPolicyResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRateLimitPolicyResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/refresh_tokens/client.rb

@@ -27,6 +27,16 @@ module Auth0
       # @option params [String, nil] :fields
       # @option params [Boolean, nil] :include_fields
       #
+      # @example
+      #   client.refresh_tokens.list(
+      #     user_id: "user_id",
+      #     client_id: "client_id",
+      #     from: "from",
+      #     take: 1,
+      #     fields: "fields",
+      #     include_fields: true
+      #   )
+      #
       # @return [Auth0::Types::GetRefreshTokensPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -58,7 +68,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::GetRefreshTokensPaginatedResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::GetRefreshTokensPaginatedResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -77,6 +87,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.refresh_tokens.revoke
+      #
       # @return [untyped]
       def revoke(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -110,6 +123,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.refresh_tokens.get(id: "id")
+      #
       # @return [Auth0::Types::GetRefreshTokenResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -126,7 +142,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetRefreshTokenResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetRefreshTokenResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -144,6 +160,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.refresh_tokens.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -176,6 +195,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.refresh_tokens.update(id: "id")
+      #
       # @return [Auth0::Types::UpdateRefreshTokenResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -197,7 +219,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateRefreshTokenResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateRefreshTokenResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)