noresponse 7.0.4 → 7.1.0

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # KeyEnvironment - The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.
+      class KeyEnvironment
+        include ::Crystalline::Enum
+        enums do
+          LIVE = new("live")
+          TEST = new("test")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # GET /v1/workspaces/{workspace_id}/keys: the keys of both of the workspace's environments, newest first, at most 200 of each, revoked and expired keys included. No item carries a secret.
+      class KeyList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::Key),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+
+        sig { params(items: T::Array[Models::Shared::Key]).void }
+        def initialize(items:)
+          @items = items
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @items == other.items
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::KeyList
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::KeyList
+  def items
+  end
+
+  def items=(str_)
+  end
+end

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

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # POST /v1/workspaces/{workspace_id}/keys body. Creates an API key in one environment of the workspace with the scopes named, and returns its secret once. A live key needs the admin or owner role; a test key needs developer or above. An API key with the management scope creates keys in its own environment with scopes it holds itself. Each scope may appear once.
+      class KeyRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # 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 key's scopes, each at most once.
+        field(
+          :scopes,
+          Crystalline::Array.new(Models::Shared::KeyRequestScope),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("scopes"), required: true}}
+        )
+
+        sig {
+          params(environment: Models::Shared::KeyEnvironment, scopes: T::Array[Models::Shared::KeyRequestScope]).void
+        }
+        def initialize(environment:, scopes:)
+          @environment = environment
+          @scopes = scopes
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @environment == other.environment
+          return false unless @scopes == other.scopes
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::KeyRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::KeyRequest
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def scopes
+  end
+
+  def scopes=(str_)
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class KeyRequestScope < T::Enum
+        enums do
+          ASSESS = new("assess")
+          HISTORY = new("history")
+          DELETE = new("delete")
+          WEBHOOKS = new("webhooks")
+          DETAILED = new("detailed")
+          INTEGRATIONS = new("integrations")
+          MANAGEMENT = new("management")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -20,7 +20,7 @@ module NoResponse
         # The scopes of the new key: those of the presented key.
         field(
           :scopes,
-          Crystalline::Array.new(Models::Shared::Scope),
+          Crystalline::Array.new(Models::Shared::KeyRotationScope),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("scopes"), required: true}}
         )
 
@@ -46,7 +46,7 @@ module NoResponse
           params(
             key: ::String,
             key_id: ::String,
-            scopes: T::Array[Models::Shared::Scope],
+            scopes: T::Array[Models::Shared::KeyRotationScope],
             created_at: ::String,
             previous_key_id: ::String,
             previous_key_expires_at: ::String

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

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class KeyRotationScope
+        include ::Crystalline::Enum
+        enums do
+          ASSESS = new("assess")
+          HISTORY = new("history")
+          DELETE = new("delete")
+          WEBHOOKS = new("webhooks")
+          DETAILED = new("detailed")
+          INTEGRATIONS = new("integrations")
+          MANAGEMENT = new("management")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # KeyStatus - active: the key authenticates. expired: a rotation's overlap window has ended (expires_at). revoked: the key was revoked (revoked_at) and answers 401.
+      class KeyStatus
+        include ::Crystalline::Enum
+        enums do
+          ACTIVE = new("active")
+          EXPIRED = new("expired")
+          REVOKED = new("revoked")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # OnExpiry - 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.
+      class OnExpiry
+        include ::Crystalline::Enum
+        enums do
+          ALLOW = new("allow")
+          REVIEW = new("review")
+          BLOCK = new("block")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -9,6 +9,7 @@ module NoResponse
         include ::Crystalline::Enum
         enums do
           WORKSPACE_FORBIDDEN = new("workspace_forbidden")
+          ROLE_FORBIDDEN = new("role_forbidden")
         end
 
         open!

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