noresponse 7.0.5 → 7.1.1

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

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!