noresponse 7.0.5 → 7.1.1

data/lib/no_response/models/shared/settings.rb

@@ -0,0 +1,116 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One environment's settings: how long its assessments are kept, and for each flow the risk thresholds that decide it and the depth a request that names none is served at, and the sources it refuses. Live and test each have their own. A flow without thresholds of its own uses account_creation's (inherits_account_creation). Every change is recorded in the audit log as settings.updated, with who made it.
+      class Settings
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The workspace id, which is also its live environment's workspace id; the test environment's is the same id with :test appended. A workspace created through the API is tnt_ and a 26-character ULID.
+        field(
+          :workspace_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("workspace_id"), required: true}}
+        )
+        # The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.
+        field(
+          :environment,
+          Models::Shared::KeyEnvironment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::KeyEnvironment, false)
+            }
+          }
+        )
+        # Days an assessment is kept after it is created, 1 to 365 (default 365). Shortening hides older assessments at once.
+        field(
+          :retention_days,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retention_days"), required: true}}
+        )
+        # How many times this environment's policy has changed; 0 while the defaults apply. A served risk.policy_version ends in +t<policy_version> once it is above 0.
+        field(
+          :policy_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("policy_version"), required: true}}
+        )
+
+        field(
+          :flows,
+          Models::Shared::SettingsFlows,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("flows"), required: true}}
+        )
+        # The sources this environment refuses, sorted; empty, the default, refuses none. An assessment leaves a refused source out: its coverage is missing (an identifier with no other source lists coverage-unavailable as unavailable) rather than not_found, and a stored result of a refused source is not reused.
+        field(
+          :refused_sources,
+          Crystalline::Array.new(Models::Shared::SourceId),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("refused_sources"), required: true}}
+        )
+        # Who last changed the policy: the member's external user id for a change made through the console, the prefix (nrk_<environment>_<key id>) of the management key that made it, or NoResponse. Absent while the defaults apply.
+        field(
+          :updated_by,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("updated_by")}}
+        )
+        # When the policy last changed. Absent while the defaults apply.
+        field(
+          :updated_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("updated_at")}}
+        )
+
+        sig {
+          params(
+            workspace_id: ::String,
+            environment: Models::Shared::KeyEnvironment,
+            retention_days: ::Integer,
+            policy_version: ::Integer,
+            flows: Models::Shared::SettingsFlows,
+            refused_sources: T::Array[Models::Shared::SourceId],
+            updated_by: T.nilable(::String),
+            updated_at: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          workspace_id:,
+          environment:,
+          retention_days:,
+          policy_version:,
+          flows:,
+          refused_sources:,
+          updated_by: nil,
+          updated_at: nil
+        )
+          @workspace_id = workspace_id
+          @environment = environment
+          @retention_days = retention_days
+          @policy_version = policy_version
+          @flows = flows
+          @refused_sources = refused_sources
+          @updated_by = updated_by
+          @updated_at = updated_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @workspace_id == other.workspace_id
+          return false unless @environment == other.environment
+          return false unless @retention_days == other.retention_days
+          return false unless @policy_version == other.policy_version
+          return false unless @flows == other.flows
+          return false unless @refused_sources == other.refused_sources
+          return false unless @updated_by == other.updated_by
+          return false unless @updated_at == other.updated_at
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/settings.rbi

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Settings
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Settings
+  def workspace_id
+  end
+
+  def workspace_id=(str_)
+  end
+
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def retention_days
+  end
+
+  def retention_days=(str_)
+  end
+
+  def policy_version
+  end
+
+  def policy_version=(str_)
+  end
+
+  def flows
+  end
+
+  def flows=(str_)
+  end
+
+  def refused_sources
+  end
+
+  def refused_sources=(str_)
+  end
+
+  def updated_by
+  end
+
+  def updated_by=(str_)
+  end
+
+  def updated_at
+  end
+
+  def updated_at=(str_)
+  end
+end

data/lib/no_response/models/shared/settingsflows.rb

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class SettingsFlows
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # One flow's policy in force. A score below step_up is allow, below review step_up, and from review review; from block, when present, the decision is block. admission says when the flow's decision is final.
+        field(
+          :account_creation,
+          Models::Shared::FlowSettings,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_creation"), required: true}}
+        )
+        # One flow's policy in force. A score below step_up is allow, below review step_up, and from review review; from block, when present, the decision is block. admission says when the flow's decision is final.
+        field(
+          :login,
+          Models::Shared::FlowSettings,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("login"), required: true}}
+        )
+        # One flow's policy in force. A score below step_up is allow, below review step_up, and from review review; from block, when present, the decision is block. admission says when the flow's decision is final.
+        field(
+          :purchase,
+          Models::Shared::FlowSettings,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("purchase"), required: true}}
+        )
+
+        sig {
+          params(
+            account_creation: Models::Shared::FlowSettings,
+            login: Models::Shared::FlowSettings,
+            purchase: Models::Shared::FlowSettings
+          )
+            .void
+        }
+        def initialize(account_creation:, login:, purchase:)
+          @account_creation = account_creation
+          @login = login
+          @purchase = purchase
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @account_creation == other.account_creation
+          return false unless @login == other.login
+          return false unless @purchase == other.purchase
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/settingsflows.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::SettingsFlows
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::SettingsFlows
+  def account_creation
+  end
+
+  def account_creation=(str_)
+  end
+
+  def login
+  end
+
+  def login=(str_)
+  end
+
+  def purchase
+  end
+
+  def purchase=(str_)
+  end
+end

data/lib/no_response/models/shared/settingsrequest.rb

@@ -0,0 +1,55 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # PATCH /v1/workspaces/{workspace_id}/settings/{environment} body. Changes only what it names, in one transaction; a policy change is one new policy_version. Needs the admin or owner role, or an API key with the management scope for its own environment.
+      class SettingsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :retention_days,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retention_days")}}
+        )
+        # Replaces the refused sources; [] refuses none. A change applies to new assessments within a minute.
+        field(
+          :refused_sources,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::SourceId)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("refused_sources")}}
+        )
+        # Use account_creation or its deprecated alias signup, not both.
+        field(
+          :flows,
+          Crystalline::Nilable.new(Models::Shared::SettingsRequestFlows),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("flows")}}
+        )
+
+        sig {
+          params(
+            retention_days: T.nilable(::Integer),
+            refused_sources: T.nilable(T::Array[Models::Shared::SourceId]),
+            flows: T.nilable(Models::Shared::SettingsRequestFlows)
+          )
+            .void
+        }
+        def initialize(retention_days: nil, refused_sources: nil, flows: nil)
+          @retention_days = retention_days
+          @refused_sources = refused_sources
+          @flows = flows
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @retention_days == other.retention_days
+          return false unless @refused_sources == other.refused_sources
+          return false unless @flows == other.flows
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/settingsrequest.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::SettingsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::SettingsRequest
+  def retention_days
+  end
+
+  def retention_days=(str_)
+  end
+
+  def refused_sources
+  end
+
+  def refused_sources=(str_)
+  end
+
+  def flows
+  end
+
+  def flows=(str_)
+  end
+end

data/lib/no_response/models/shared/settingsrequestflows.rb

@@ -0,0 +1,65 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Use account_creation or its deprecated alias signup, not both.
+      class SettingsRequestFlows
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # A change to one flow. A field left out keeps the value in force. Thresholds set on login or purchase start from the values in force, account_creation's while it inherits them. After the change, 0 < step_up < review <= 100 and block is off or review <= block <= 100.
+        field(
+          :account_creation,
+          Crystalline::Nilable.new(Models::Shared::FlowChange),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_creation")}}
+        )
+        # A change to one flow. A field left out keeps the value in force. Thresholds set on login or purchase start from the values in force, account_creation's while it inherits them. After the change, 0 < step_up < review <= 100 and block is off or review <= block <= 100.
+        field(
+          :login,
+          Crystalline::Nilable.new(Models::Shared::FlowChange),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("login")}}
+        )
+        # A change to one flow. A field left out keeps the value in force. Thresholds set on login or purchase start from the values in force, account_creation's while it inherits them. After the change, 0 < step_up < review <= 100 and block is off or review <= block <= 100.
+        field(
+          :purchase,
+          Crystalline::Nilable.new(Models::Shared::FlowChange),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("purchase")}}
+        )
+        # A change to one flow. A field left out keeps the value in force. Thresholds set on login or purchase start from the values in force, account_creation's while it inherits them. After the change, 0 < step_up < review <= 100 and block is off or review <= block <= 100.
+        field(
+          :signup,
+          Crystalline::Nilable.new(Models::Shared::FlowChange),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("signup")}}
+        )
+
+        sig {
+          params(
+            account_creation: T.nilable(Models::Shared::FlowChange),
+            login: T.nilable(Models::Shared::FlowChange),
+            purchase: T.nilable(Models::Shared::FlowChange),
+            signup: T.nilable(Models::Shared::FlowChange)
+          )
+            .void
+        }
+        def initialize(account_creation: nil, login: nil, purchase: nil, signup: nil)
+          @account_creation = account_creation
+          @login = login
+          @purchase = purchase
+          @signup = signup
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @account_creation == other.account_creation
+          return false unless @login == other.login
+          return false unless @purchase == other.purchase
+          return false unless @signup == other.signup
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/settingsrequestflows.rbi

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::SettingsRequestFlows
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::SettingsRequestFlows
+  def account_creation
+  end
+
+  def account_creation=(str_)
+  end
+
+  def login
+  end
+
+  def login=(str_)
+  end
+
+  def purchase
+  end
+
+  def purchase=(str_)
+  end
+
+  def signup
+  end
+
+  def signup=(str_)
+  end
+end

data/lib/no_response/models/shared/sourceid.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # SourceId - A NoResponse source: github (GitHub accounts), phone (the phone lookup), breach (breach exposure), rdap (the email domain's registration), mx (the email domain's mail servers) or ipintel (IP intelligence).
+      class SourceId
+        include ::Crystalline::Enum
+        enums do
+          GITHUB = new("github")
+          PHONE = new("phone")
+          BREACH = new("breach")
+          RDAP = new("rdap")
+          MX = new("mx")
+          IPINTEL = new("ipintel")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/sourceid.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::SourceId
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::SourceId
+end

data/lib/no_response/models/shared.rb

@@ -15,6 +15,7 @@ module NoResponse
       autoload :AccountRiskChanged, "no_response/models/shared/accountriskchanged.rb"
       autoload :AccountRiskChangedEvent, "no_response/models/shared/accountriskchangedevent.rb"
       autoload :AccountRiskReason, "no_response/models/shared/accountriskreason.rb"
+      autoload :Admission, "no_response/models/shared/admission.rb"
       autoload :Assessment, "no_response/models/shared/assessment.rb"
       autoload :AssessmentDeletion, "no_response/models/shared/assessmentdeletion.rb"
       autoload :AssessmentDeletionAccount, "no_response/models/shared/assessmentdeletionaccount.rb"
@@ -49,6 +50,7 @@ module NoResponse
       autoload :Consistency, "no_response/models/shared/consistency.rb"
       autoload :ConsistencyValue, "no_response/models/shared/consistencyvalue.rb"
       autoload :Country, "no_response/models/shared/country.rb"
+      autoload :DefaultDepth, "no_response/models/shared/defaultdepth.rb"
       autoload :Depth, "no_response/models/shared/depth.rb"
       autoload :EndpointVerification, "no_response/models/shared/endpointverification.rb"
       autoload :EndpointVerificationEvent, "no_response/models/shared/endpointverificationevent.rb"
@@ -62,6 +64,8 @@ module NoResponse
       autoload :Failure, "no_response/models/shared/failure.rb"
       autoload :FailureReason, "no_response/models/shared/failurereason.rb"
       autoload :Flow, "no_response/models/shared/flow.rb"
+      autoload :FlowChange, "no_response/models/shared/flowchange.rb"
+      autoload :FlowSettings, "no_response/models/shared/flowsettings.rb"
       autoload :Freshness, "no_response/models/shared/freshness.rb"
       autoload :HookPoint, "no_response/models/shared/hookpoint.rb"
       autoload :IdentifierKind, "no_response/models/shared/identifierkind.rb"
@@ -75,14 +79,23 @@ module NoResponse
       autoload :IntegrationRotationRequest, "no_response/models/shared/integrationrotationrequest.rb"
       autoload :IpSummary, "no_response/models/shared/ipsummary.rb"
       autoload :IpSummaryType, "no_response/models/shared/ipsummarytype.rb"
+      autoload :Key, "no_response/models/shared/key.rb"
+      autoload :KeyEnvironment, "no_response/models/shared/keyenvironment.rb"
+      autoload :KeyList, "no_response/models/shared/keylist.rb"
+      autoload :KeyRequest, "no_response/models/shared/keyrequest.rb"
+      autoload :KeyRequestScope, "no_response/models/shared/keyrequest_scope.rb"
       autoload :KeyRotation, "no_response/models/shared/keyrotation.rb"
       autoload :KeyRotationRequest, "no_response/models/shared/keyrotationrequest.rb"
+      autoload :KeyRotationScope, "no_response/models/shared/keyrotation_scope.rb"
+      autoload :KeyStatus, "no_response/models/shared/keystatus.rb"
       autoload :KeyUsageBatch, "no_response/models/shared/keyusagebatch.rb"
       autoload :KeyUsageBatchRequest, "no_response/models/shared/keyusagebatchrequest.rb"
       autoload :KeyUsageEvent, "no_response/models/shared/keyusageevent.rb"
+      autoload :KeyScope, "no_response/models/shared/key_scope.rb"
       autoload :Lane, "no_response/models/shared/lane.rb"
       autoload :LineType, "no_response/models/shared/linetype.rb"
       autoload :NotFoundErrorCode, "no_response/models/shared/notfounderrorcode.rb"
+      autoload :OnExpiry, "no_response/models/shared/onexpiry.rb"
       autoload :Outcome, "no_response/models/shared/outcome.rb"
       autoload :PermissionDeniedErrorCode, "no_response/models/shared/permissiondeniederrorcode.rb"
       autoload :PhoneEnrichment, "no_response/models/shared/phoneenrichment.rb"
@@ -106,10 +119,15 @@ module NoResponse
       autoload :RiskSummaryPhone, "no_response/models/shared/risksummaryphone.rb"
       autoload :RiskSummaryUsername, "no_response/models/shared/risksummaryusername.rb"
       autoload :Security, "no_response/models/shared/security.rb"
+      autoload :Settings, "no_response/models/shared/settings.rb"
+      autoload :SettingsFlows, "no_response/models/shared/settingsflows.rb"
+      autoload :SettingsRequest, "no_response/models/shared/settingsrequest.rb"
+      autoload :SettingsRequestFlows, "no_response/models/shared/settingsrequestflows.rb"
       autoload :Signal, "no_response/models/shared/signal.rb"
       autoload :SignalOutcome, "no_response/models/shared/signaloutcome.rb"
       autoload :SigningKey, "no_response/models/shared/signingkey.rb"
       autoload :SigningSecret, "no_response/models/shared/signingsecret.rb"
+      autoload :SourceId, "no_response/models/shared/sourceid.rb"
       autoload :Status, "no_response/models/shared/status.rb"
       autoload :Transport, "no_response/models/shared/transport.rb"
       autoload :WebhookDeliveryAttempt, "no_response/models/shared/webhookdeliveryattempt.rb"
@@ -141,7 +159,6 @@ module NoResponse
       autoload :LocationUnion, "no_response/models/shared/location_union.rb"
       autoload :NameCandidate, "no_response/models/shared/name_candidate.rb"
       autoload :NameCandidateUnion, "no_response/models/shared/name_candidate_union.rb"
-      autoload :Scope, "no_response/models/shared/scope.rb"
       autoload :SocialProfile, "no_response/models/shared/social_profile.rb"
       autoload :SocialProfileUnion, "no_response/models/shared/social_profile_union.rb"
       autoload :Timezone, "no_response/models/shared/timezone.rb"

data/lib/no_response/noresponseclient.rb

@@ -15,7 +15,7 @@ module NoResponse
   class NoResponseClient
     extend T::Sig
 
-    attr_accessor :assessments, :accounts, :key_usage, :keys, :integrations, :webhook_endpoints
+    attr_accessor :assessments, :accounts, :key_usage, :keys, :integrations, :webhook_endpoints, :settings
 
     # Instantiates the SDK, configuring it with the provided parameters.
     #
@@ -93,6 +93,7 @@ module NoResponse
       @keys = Keys.new(@sdk_configuration)
       @integrations = Integrations.new(@sdk_configuration)
       @webhook_endpoints = WebhookEndpoints.new(@sdk_configuration)
+      @settings = Settings.new(@sdk_configuration)
     end
 
     sig { params(base_url: String, url_variables: T.nilable(T::Hash[Symbol, T.any(String, T::Enum)])).returns(String) }

data/lib/no_response/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module NoResponse
 
       @language = "ruby"
       @openapi_doc_version = "1"
-      @sdk_version = "7.0.5"
+      @sdk_version = "7.1.1"
       @gen_version = "internal"
-      @user_agent = "noresponse-sdk/ruby 7.0.5 internal 1 noresponse"
+      @user_agent = "noresponse-sdk/ruby 7.1.1 internal 1 noresponse"
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }