noresponse 7.0.5 → 7.1.0

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # DefaultDepth - The depth a request for this flow that names none is served at. Defaults: full for account_creation and purchase, quick for login.
+      class DefaultDepth
+        include ::Crystalline::Enum
+        enums do
+          QUICK = new("quick")
+          FULL = new("full")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,136 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # 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.
+      class FlowChange
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :step_up,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("step_up")}}
+        )
+
+        field(
+          :review,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("review")}}
+        )
+        # The depth a request for this flow that names none is served at. Defaults: full for account_creation and purchase, quick for login.
+        field(
+          :default_depth,
+          Crystalline::Nilable.new(Models::Shared::DefaultDepth),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("default_depth"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::DefaultDepth, true)
+            }
+          }
+        )
+        # Login or purchase only: drop the flow's own thresholds so it uses account_creation's again. Not combined with step_up, review or block. Send true; false is refused.
+        field(
+          :inherits_account_creation,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("inherits_account_creation")}}
+        )
+        # Alias of inherits_account_creation, still accepted. Send true; false is refused.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field(
+          :inherits_signup,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("inherits_signup")}}
+        )
+        # immediate (the default): an assessment of this flow is decided from the evidence its answer has, and later evidence may change the decision. held: while the account's current assessment of this flow has not completed, the account's decision for the flow is held, and the final decision arrives as account.risk_changed when the investigation completes or hold_seconds pass, whichever is first. Each flow has its own admission.
+        field(
+          :admission,
+          Crystalline::Nilable.new(Models::Shared::Admission),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("admission"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Admission, true)
+            }
+          }
+        )
+        # How long a held flow's assessment is held after it was created, 30 to 86400 seconds (default 300). Kept while the flow is immediate.
+        field(
+          :hold_seconds,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("hold_seconds")}}
+        )
+        # The decision a held assessment takes when hold_seconds pass before its investigation completes, unless the evidence so far gives a stricter one (default review). It is announced as account.risk_changed like any other change, so an expired hold is always announced. A hosted provider hook, which cannot wait, answers a held account by it at once: deny for block, allow otherwise. Kept while the flow is immediate.
+        field(
+          :on_expiry,
+          Crystalline::Nilable.new(Models::Shared::OnExpiry),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("on_expiry"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::OnExpiry, true)
+            }
+          }
+        )
+        # The score from which the decision is block; null turns blocking off.
+        field(
+          :block,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("block")}}
+        )
+
+        sig {
+          params(
+            step_up: T.nilable(::Integer),
+            review: T.nilable(::Integer),
+            default_depth: T.nilable(Models::Shared::DefaultDepth),
+            inherits_account_creation: T.nilable(T::Boolean),
+            inherits_signup: T.nilable(T::Boolean),
+            admission: T.nilable(Models::Shared::Admission),
+            hold_seconds: T.nilable(::Integer),
+            on_expiry: T.nilable(Models::Shared::OnExpiry),
+            block: T.nilable(::Integer)
+          )
+            .void
+        }
+        def initialize(
+          step_up: nil,
+          review: nil,
+          default_depth: nil,
+          inherits_account_creation: nil,
+          inherits_signup: nil,
+          admission: nil,
+          hold_seconds: nil,
+          on_expiry: nil,
+          block: nil
+        )
+          @step_up = step_up
+          @review = review
+          @default_depth = default_depth
+          @inherits_account_creation = inherits_account_creation
+          @inherits_signup = inherits_signup
+          @admission = admission
+          @hold_seconds = hold_seconds
+          @on_expiry = on_expiry
+          @block = block
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @step_up == other.step_up
+          return false unless @review == other.review
+          return false unless @default_depth == other.default_depth
+          return false unless @inherits_account_creation == other.inherits_account_creation
+          return false unless @inherits_signup == other.inherits_signup
+          return false unless @admission == other.admission
+          return false unless @hold_seconds == other.hold_seconds
+          return false unless @on_expiry == other.on_expiry
+          return false unless @block == other.block
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::FlowChange
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::FlowChange
+  def step_up
+  end
+
+  def step_up=(str_)
+  end
+
+  def review
+  end
+
+  def review=(str_)
+  end
+
+  def default_depth
+  end
+
+  def default_depth=(str_)
+  end
+
+  def inherits_account_creation
+  end
+
+  def inherits_account_creation=(str_)
+  end
+
+  def inherits_signup
+  end
+
+  def inherits_signup=(str_)
+  end
+
+  def admission
+  end
+
+  def admission=(str_)
+  end
+
+  def hold_seconds
+  end
+
+  def hold_seconds=(str_)
+  end
+
+  def on_expiry
+  end
+
+  def on_expiry=(str_)
+  end
+
+  def block
+  end
+
+  def block=(str_)
+  end
+end

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

@@ -0,0 +1,127 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # 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.
+      class FlowSettings
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :step_up,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("step_up"), required: true}}
+        )
+
+        field(
+          :review,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("review"), required: true}}
+        )
+        # The depth a request for this flow that names none is served at. Defaults: full for account_creation and purchase, quick for login.
+        field(
+          :default_depth,
+          Models::Shared::DefaultDepth,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("default_depth"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::DefaultDepth, false)
+            }
+          }
+        )
+        # true while this flow has no thresholds of its own and uses account_creation's, the default for login and purchase. Always false for signup.
+        field(
+          :inherits_account_creation,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("inherits_account_creation"), required: true}}
+        )
+        # immediate (the default): an assessment of this flow is decided from the evidence its answer has, and later evidence may change the decision. held: while the account's current assessment of this flow has not completed, the account's decision for the flow is held, and the final decision arrives as account.risk_changed when the investigation completes or hold_seconds pass, whichever is first. Each flow has its own admission.
+        field(
+          :admission,
+          Models::Shared::Admission,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("admission"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Admission, false)
+            }
+          }
+        )
+        # How long a held flow's assessment is held after it was created, 30 to 86400 seconds (default 300). Kept while the flow is immediate.
+        field(
+          :hold_seconds,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("hold_seconds"), required: true}}
+        )
+        # The decision a held assessment takes when hold_seconds pass before its investigation completes, unless the evidence so far gives a stricter one (default review). It is announced as account.risk_changed like any other change, so an expired hold is always announced. A hosted provider hook, which cannot wait, answers a held account by it at once: deny for block, allow otherwise. Kept while the flow is immediate.
+        field(
+          :on_expiry,
+          Models::Shared::OnExpiry,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("on_expiry"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::OnExpiry, false)
+            }
+          }
+        )
+        # The score from which the decision is block. Absent while blocking is off, the default.
+        field(
+          :block,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("block")}}
+        )
+
+        sig {
+          params(
+            step_up: ::Integer,
+            review: ::Integer,
+            default_depth: Models::Shared::DefaultDepth,
+            inherits_account_creation: T::Boolean,
+            admission: Models::Shared::Admission,
+            hold_seconds: ::Integer,
+            on_expiry: Models::Shared::OnExpiry,
+            block: T.nilable(::Integer)
+          )
+            .void
+        }
+        def initialize(
+          step_up:,
+          review:,
+          default_depth:,
+          inherits_account_creation:,
+          admission:,
+          hold_seconds:,
+          on_expiry:,
+          block: nil
+        )
+          @step_up = step_up
+          @review = review
+          @default_depth = default_depth
+          @inherits_account_creation = inherits_account_creation
+          @admission = admission
+          @hold_seconds = hold_seconds
+          @on_expiry = on_expiry
+          @block = block
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @step_up == other.step_up
+          return false unless @review == other.review
+          return false unless @default_depth == other.default_depth
+          return false unless @inherits_account_creation == other.inherits_account_creation
+          return false unless @admission == other.admission
+          return false unless @hold_seconds == other.hold_seconds
+          return false unless @on_expiry == other.on_expiry
+          return false unless @block == other.block
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::FlowSettings
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::FlowSettings
+  def step_up
+  end
+
+  def step_up=(str_)
+  end
+
+  def review
+  end
+
+  def review=(str_)
+  end
+
+  def default_depth
+  end
+
+  def default_depth=(str_)
+  end
+
+  def inherits_account_creation
+  end
+
+  def inherits_account_creation=(str_)
+  end
+
+  def admission
+  end
+
+  def admission=(str_)
+  end
+
+  def hold_seconds
+  end
+
+  def hold_seconds=(str_)
+  end
+
+  def on_expiry
+  end
+
+  def on_expiry=(str_)
+  end
+
+  def block
+  end
+
+  def block=(str_)
+  end
+end

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

@@ -0,0 +1,158 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One API key of your workspace. A key belongs to exactly one environment. key, the secret credential, is present only in the answer that created the key: NoResponse keeps a peppered digest of it, so store it now. Every other field is safe to show.
+      class Key
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The key's public id, a 26-character ULID.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # 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)
+            }
+          }
+        )
+        # The public start of the credential, nrk_<environment>_<key id>, which identifies the key in logs and secret stores without its secret.
+        field(
+          :prefix,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("prefix"), required: true}}
+        )
+        # The key's scopes, each at most once.
+        field(
+          :scopes,
+          Crystalline::Array.new(Models::Shared::KeyScope),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("scopes"), required: true}}
+        )
+        # active: the key authenticates. expired: a rotation's overlap window has ended (expires_at). revoked: the key was revoked (revoked_at) and answers 401.
+        field(
+          :status,
+          Models::Shared::KeyStatus,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("status"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::KeyStatus, false)
+            }
+          }
+        )
+
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # The external user id of the member who created the key through the console, or the prefix (nrk_<environment>_<key id>) of the management key that created it. Absent for a key NoResponse issued or a rotation made.
+        field(
+          :created_by,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_by")}}
+        )
+        # When a rotated key stops authenticating (POST /v1/keys/rotate). Absent for a key with no end.
+        field(
+          :expires_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("expires_at")}}
+        )
+
+        field(
+          :revoked_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("revoked_at")}}
+        )
+        # The external user id of the member who revoked the key through the console, or the prefix of the management key that revoked it. Absent when the key is not revoked or NoResponse revoked it.
+        field(
+          :revoked_by,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("revoked_by")}}
+        )
+        # The credential, nrk_<environment>_<key id>_<secret>. Present only in the 201 answer that created the key.
+        field(
+          :key,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("key")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            workspace_id: ::String,
+            environment: Models::Shared::KeyEnvironment,
+            prefix: ::String,
+            scopes: T::Array[Models::Shared::KeyScope],
+            status: Models::Shared::KeyStatus,
+            created_at: ::String,
+            created_by: T.nilable(::String),
+            expires_at: T.nilable(::String),
+            revoked_at: T.nilable(::String),
+            revoked_by: T.nilable(::String),
+            key: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          id:,
+          workspace_id:,
+          environment:,
+          prefix:,
+          scopes:,
+          status:,
+          created_at:,
+          created_by: nil,
+          expires_at: nil,
+          revoked_at: nil,
+          revoked_by: nil,
+          key: nil
+        )
+          @id = id
+          @workspace_id = workspace_id
+          @environment = environment
+          @prefix = prefix
+          @scopes = scopes
+          @status = status
+          @created_at = created_at
+          @created_by = created_by
+          @expires_at = expires_at
+          @revoked_at = revoked_at
+          @revoked_by = revoked_by
+          @key = key
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @workspace_id == other.workspace_id
+          return false unless @environment == other.environment
+          return false unless @prefix == other.prefix
+          return false unless @scopes == other.scopes
+          return false unless @status == other.status
+          return false unless @created_at == other.created_at
+          return false unless @created_by == other.created_by
+          return false unless @expires_at == other.expires_at
+          return false unless @revoked_at == other.revoked_at
+          return false unless @revoked_by == other.revoked_by
+          return false unless @key == other.key
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Key
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Key
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def workspace_id
+  end
+
+  def workspace_id=(str_)
+  end
+
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def prefix
+  end
+
+  def prefix=(str_)
+  end
+
+  def scopes
+  end
+
+  def scopes=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def created_by
+  end
+
+  def created_by=(str_)
+  end
+
+  def expires_at
+  end
+
+  def expires_at=(str_)
+  end
+
+  def revoked_at
+  end
+
+  def revoked_at=(str_)
+  end
+
+  def revoked_by
+  end
+
+  def revoked_by=(str_)
+  end
+
+  def key
+  end
+
+  def key=(str_)
+  end
+end

data/lib/no_response/models/shared/{scope.rb → key_scope.rb}

@@ -5,7 +5,7 @@ module NoResponse
   module Models
     module Shared
 
-      class Scope
+      class KeyScope
         include ::Crystalline::Enum
         enums do
           ASSESS = new("assess")
@@ -14,6 +14,7 @@ module NoResponse
           WEBHOOKS = new("webhooks")
           DETAILED = new("detailed")
           INTEGRATIONS = new("integrations")
+          MANAGEMENT = new("management")
         end
 
         open!

data/lib/no_response/models/shared/{scope.rbi → key_scope.rbi}

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