auth0 6.3.0 → 6.4.0

data/lib/auth0/experimentation/segments/client.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Experimentation
+    module Segments
+      class Client
+        # @param client [Auth0::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Retrieve a paginated list of segments for the tenant.
+        #
+        # @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
+        # @option params [String, nil] :from
+        # @option params [Integer, nil] :take
+        # @option params [Auth0::Types::SegmentTypeFilterEnum, nil] :type
+        #
+        # @example
+        #   client.experimentation.segments.list(
+        #     from: "from",
+        #     take: 1,
+        #     type: "auth0"
+        #   )
+        #
+        # @return [Auth0::Types::ListSegmentsResponseContent]
+        def list(request_options: {}, **params)
+          params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["from"] = params[:from] if params.key?(:from)
+          query_params["take"] = params.fetch(:take, 50)
+          query_params["type"] = params[:type] if params.key?(:type)
+
+          Auth0::Internal::CursorItemIterator.new(
+            cursor_field: :next_,
+            item_field: :segments,
+            initial_cursor: query_params["from"]
+          ) do |next_cursor|
+            query_params["from"] = next_cursor
+            request = Auth0::Internal::JSON::Request.new(
+              base_url: request_options[:base_url],
+              method: "GET",
+              path: "experimentation/segments",
+              query: query_params,
+              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)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListSegmentsResponseContent.load(response.body))
+              [parsed_response, response]
+            else
+              error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+        end
+
+        # Create a new segment with rule-based membership criteria for use in experiments.
+        #
+        # @param request_options [Hash]
+        # @param params [Auth0::Experimentation::Segments::Types::CreateSegmentRequestContent]
+        # @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.experimentation.segments.create(
+        #     name: "name",
+        #     rules: [{}]
+        #   )
+        #
+        # @return [Auth0::Types::CreateSegmentResponseContent]
+        def create(request_options: {}, **params)
+          params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "experimentation/segments",
+            body: Auth0::Experimentation::Segments::Types::CreateSegmentRequestContent.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::CreateSegmentResponseContent.load(response.body))
+          else
+            error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Retrieve a single segment by its ID.
+        #
+        # @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
+        # @option params [String] :id
+        #
+        # @example
+        #   client.experimentation.segments.get(id: "id")
+        #
+        # @return [Auth0::Types::GetSegmentResponseContent]
+        def get(request_options: {}, **params)
+          params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "experimentation/segments/#{URI.encode_uri_component(params[:id].to_s)}",
+            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::GetSegmentResponseContent.load(response.body))
+          else
+            error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Delete a segment by ID. Idempotent: returns 204 even if segment does not exist.
+        #
+        # @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
+        # @option params [String] :id
+        #
+        # @example
+        #   client.experimentation.segments.delete(id: "id")
+        #
+        # @return [untyped]
+        def delete(request_options: {}, **params)
+          params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "DELETE",
+            path: "experimentation/segments/#{URI.encode_uri_component(params[:id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            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)
+        end
+
+        # Partially update a segment by ID. Only provided fields are updated. Sending rules replaces the entire rules
+        # array.
+        #
+        # @param request_options [Hash]
+        # @param params [Auth0::Experimentation::Segments::Types::UpdateSegmentRequestContent]
+        # @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
+        # @option params [String] :id
+        #
+        # @example
+        #   client.experimentation.segments.update(id: "id")
+        #
+        # @return [Auth0::Types::UpdateSegmentResponseContent]
+        def update(request_options: {}, **params)
+          params = Auth0::Internal::Types::Utils.normalize_keys(params)
+          request_data = Auth0::Experimentation::Segments::Types::UpdateSegmentRequestContent.new(params).to_h
+          non_body_param_names = %w[id]
+          body = request_data.except(*non_body_param_names)
+
+          request = Auth0::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "PATCH",
+            path: "experimentation/segments/#{URI.encode_uri_component(params[:id].to_s)}",
+            body: body,
+            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::UpdateSegmentResponseContent.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

data/lib/auth0/experimentation/segments/types/create_segment_request_content.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Experimentation
+    module Segments
+      module Types
+        class CreateSegmentRequestContent < Internal::Types::Model
+          field :name, -> { String }, optional: false, nullable: false
+
+          field :description, -> { String }, optional: true, nullable: false
+
+          field :rules, -> { Internal::Types::Array[Auth0::Types::SegmentRule] }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/auth0/experimentation/segments/types/list_segments_request_parameters.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Experimentation
+    module Segments
+      module Types
+        class ListSegmentsRequestParameters < Internal::Types::Model
+          field :from, -> { String }, optional: true, nullable: false
+
+          field :take, -> { Integer }, optional: true, nullable: false
+
+          field :type, -> { Auth0::Types::SegmentTypeFilterEnum }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/auth0/experimentation/segments/types/update_segment_request_content.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Experimentation
+    module Segments
+      module Types
+        class UpdateSegmentRequestContent < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+
+          field :name, -> { String }, optional: true, nullable: false
+
+          field :description, -> { String }, optional: true, nullable: false
+
+          field :rules, -> { Internal::Types::Array[Auth0::Types::SegmentRule] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/auth0/organizations/client.rb

@@ -402,11 +402,6 @@ module Auth0
         @members ||= Auth0::Organizations::Members::Client.new(client: @client)
       end
 
-      # @return [Auth0::OrganizationTemplate::Client]
-      def organization_template
-        @organization_template ||= Auth0::Organizations::OrganizationTemplate::Client.new(client: @client)
-      end
-
       # @return [Auth0::Groups::Client]
       def groups
         @groups ||= Auth0::Organizations::Groups::Client.new(client: @client)

data/lib/auth0/resource_servers/types/create_resource_server_request_content.rb

@@ -36,6 +36,8 @@ module Auth0
 
         field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
 
+        field :require_consent_non_repudiation, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
         field :authorization_details, -> { Internal::Types::Array[Object] }, optional: true, nullable: false
 
         field :proof_of_possession, -> { Auth0::Types::ResourceServerProofOfPossession }, optional: true, nullable: false

data/lib/auth0/resource_servers/types/update_resource_server_request_content.rb

@@ -36,6 +36,8 @@ module Auth0
 
         field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
 
+        field :require_consent_non_repudiation, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
         field :authorization_details, -> { Internal::Types::Array[Object] }, optional: true, nullable: false
 
         field :proof_of_possession, -> { Auth0::Types::ResourceServerProofOfPossession }, optional: true, nullable: false

data/lib/auth0/types/allocation_item.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class AllocationItem < Internal::Types::Model
+      field :variation_id, -> { String }, optional: true, nullable: false
+
+      field :variation_name, -> { String }, optional: true, nullable: false
+
+      field :segment_id, -> { String }, optional: true, nullable: false
+
+      field :segment_name, -> { String }, optional: true, nullable: false
+
+      field :weight, -> { Integer }, optional: true, nullable: false
+
+      field :priority, -> { Integer }, optional: true, nullable: false
+
+      field :is_control, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :is_fallback, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :variation_snapshot, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :segment_snapshot, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/auth0/types/allocation_request_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class AllocationRequestItem < Internal::Types::Model
+      field :variation_id, -> { String }, optional: false, nullable: false
+
+      field :weight, -> { Integer }, optional: true, nullable: false
+
+      field :segment_id, -> { String }, optional: true, nullable: false
+
+      field :priority, -> { Integer }, optional: true, nullable: false
+
+      field :is_control, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :is_fallback, -> { Internal::Types::Boolean }, optional: true, nullable: false
+    end
+  end
+end

data/lib/auth0/types/{connection_deletion_behavior_enum.rb → allocation_strategy_enum.rb}

@@ -2,11 +2,11 @@
 
 module Auth0
   module Types
-    module ConnectionDeletionBehaviorEnum
+    module AllocationStrategyEnum
       extend Auth0::Internal::Types::Enum
 
-      ALLOW = "allow"
-      ALLOW_IF_EMPTY = "allow_if_empty"
+      PERCENTAGE = "percentage"
+      SEGMENT = "segment"
     end
   end
 end

data/lib/auth0/types/async_approval_notifications_channels_enum.rb

@@ -7,6 +7,7 @@ module Auth0
 
       GUARDIAN_PUSH = "guardian-push"
       EMAIL = "email"
+      MY_ACCOUNT = "my-account"
     end
   end
 end

data/lib/auth0/types/authentication_flow_enum.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    module AuthenticationFlowEnum
+      extend Auth0::Internal::Types::Enum
+
+      AUTHENTICATION = "authentication"
+      MFA_ENROLLMENT = "mfa_enrollment"
+      MFA_CHALLENGE = "mfa_challenge"
+      PASSWORD_RESET = "password_reset"
+      PASSKEY_ENROLLMENT = "passkey_enrollment"
+      ALL = "all"
+    end
+  end
+end

data/lib/auth0/types/client_oidc_backchannel_logout_initiators_enum.rb

@@ -14,6 +14,7 @@ module Auth0
       EMAIL_IDENTIFIER_CHANGED = "email-identifier-changed"
       MFA_PHONE_UNENROLLED = "mfa-phone-unenrolled"
       ACCOUNT_DEACTIVATED = "account-deactivated"
+      PROFILE_CHANGED = "profile-changed"
     end
   end
 end

data/lib/auth0/types/client_oidc_support_allowed_scopes_enum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    module ClientOidcSupportAllowedScopesEnum
+      extend Auth0::Internal::Types::Enum
+
+      PROFILE = "profile"
+      EMAIL = "email"
+      ADDRESS = "address"
+      PHONE = "phone"
+    end
+  end
+end

data/lib/auth0/types/client_oidc_support_post.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    # OIDC support configuration for a client. Controls whether OIDC flows are allowed and which scopes the client may
+    # request.
+    class ClientOidcSupportPost < Internal::Types::Model
+      field :is_allowed, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :allow_all_scopes, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :allowed_scopes, -> { Internal::Types::Array[Auth0::Types::ClientOidcSupportAllowedScopesEnum] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/auth0/types/create_experiment_response_content.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class CreateExperimentResponseContent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :feature_flag_id, -> { String }, optional: false, nullable: false
+
+      field :feature_flag_name, -> { String }, optional: true, nullable: false
+
+      field :authentication_flow, -> { String }, optional: false, nullable: false
+
+      field :allocation_strategy, -> { Auth0::Types::AllocationStrategyEnum }, optional: false, nullable: false
+
+      field :status, -> { Auth0::Types::ExperimentStatusEnum }, optional: false, nullable: false
+
+      field :is_valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :default_config, -> { Auth0::Types::DefaultConfigEnum }, optional: true, nullable: false
+
+      field :feature_flag_snapshot, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :allocations, -> { Internal::Types::Array[Auth0::Types::AllocationItem] }, optional: false, nullable: false
+
+      field :editable_fields, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :levels, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false
+
+      field :current_level, -> { Integer }, optional: true, nullable: false
+
+      field :started_at, -> { String }, optional: true, nullable: false
+
+      field :ended_at, -> { String }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/auth0/types/create_feature_flag_parameters.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    module CreateFeatureFlagParameters
+      # CreateFeatureFlagParameters is an alias for Hash
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/auth0/types/create_feature_flag_response_content.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class CreateFeatureFlagResponseContent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :type, -> { Auth0::Types::FeatureFlagTypeEnum }, optional: false, nullable: false
+
+      field :status, -> { Auth0::Types::FeatureFlagStatusEnum }, optional: false, nullable: false
+
+      field :parameters, -> { Internal::Types::Hash[String, Auth0::Types::FeatureFlagConfigParam] }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/auth0/types/create_resource_server_response_content.rb

@@ -41,6 +41,8 @@ module Auth0
 
       field :consent_policy, -> { Auth0::Types::ResourceServerConsentPolicyEnum }, optional: true, nullable: false
 
+      field :require_consent_non_repudiation, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
       field :authorization_details, -> { Internal::Types::Array[Object] }, optional: true, nullable: false
 
       field :proof_of_possession, -> { Auth0::Types::ResourceServerProofOfPossession }, optional: true, nullable: false

data/lib/auth0/types/create_segment_response_content.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class CreateSegmentResponseContent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :type, -> { Auth0::Types::SegmentTypeEnum }, optional: false, nullable: false
+
+      field :rules, -> { Internal::Types::Array[Auth0::Types::SegmentRule] }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/auth0/types/create_variation_response_content.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class CreateVariationResponseContent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :feature_flag_id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :overrides, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/auth0/types/{organization_deletion_behavior_enum.rb → default_config_enum.rb}

@@ -2,11 +2,11 @@
 
 module Auth0
   module Types
-    module OrganizationDeletionBehaviorEnum
+    module DefaultConfigEnum
       extend Auth0::Internal::Types::Enum
 
-      ALLOW = "allow"
-      ALLOW_IF_EMPTY = "allow_if_empty"
+      TENANT = "tenant"
+      FLAG = "flag"
     end
   end
 end

data/lib/auth0/types/experiment_list_item.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Auth0
+  module Types
+    class ExperimentListItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :feature_flag_id, -> { String }, optional: false, nullable: false
+
+      field :feature_flag_name, -> { String }, optional: true, nullable: false
+
+      field :authentication_flow, -> { String }, optional: false, nullable: false
+
+      field :allocation_strategy, -> { Auth0::Types::AllocationStrategyEnum }, optional: false, nullable: false
+
+      field :status, -> { Auth0::Types::ExperimentStatusEnum }, optional: false, nullable: false
+
+      field :is_valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :default_config, -> { Auth0::Types::DefaultConfigEnum }, optional: true, nullable: false
+
+      field :feature_flag_snapshot, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :allocations, -> { Internal::Types::Array[Auth0::Types::AllocationItem] }, optional: false, nullable: false
+
+      field :editable_fields, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :levels, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false
+
+      field :current_level, -> { Integer }, optional: true, nullable: false
+
+      field :started_at, -> { String }, optional: true, nullable: false
+
+      field :ended_at, -> { String }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end