noresponse 8.4.1 → 9.0.0

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

@@ -0,0 +1,74 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AuditEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AuditEvent
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def workspace_id
+  end
+
+  def workspace_id=(str_)
+  end
+
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def action
+  end
+
+  def action=(str_)
+  end
+
+  def outcome
+  end
+
+  def outcome=(str_)
+  end
+
+  def actor
+  end
+
+  def actor=(str_)
+  end
+
+  def target
+  end
+
+  def target=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def detail
+  end
+
+  def detail=(str_)
+  end
+
+  def affected_environment
+  end
+
+  def affected_environment=(str_)
+  end
+
+  def request_id
+  end
+
+  def request_id=(str_)
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The audit.event event.
+      class AuditEventEvent
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The event id, equal to the NR-Webhook-Id header and across redeliveries and every endpoint the event fans out to.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # When the event was created. Equal across redeliveries; the signing timestamp header is per delivery.
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # One privileged workspace action with its actor, target, outcome and time. Successful data changes commit their audit evidence atomically. Sensitive exports record access before returning bytes. Details exclude secrets and subject identifiers.
+        field(
+          :data,
+          Models::Shared::AuditEvent,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true}}
+        )
+        # Always audit.event.
+        field :type, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("type"), required: true}}
+        # Present, and true, only on an event sent by POST /v1/webhooks/{endpoint_id}/test: its data is a fixed example assessment, not one of the workspace's, so a receiver acknowledges it and applies nothing. Real events have no test member.
+        field(
+          :test,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("test")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            created_at: ::String,
+            data: Models::Shared::AuditEvent,
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "audit.event", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "audit.event"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "audit.event"
+          @test = test
+        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 @created_at == other.created_at
+          return false unless @data == other.data
+          return false unless @type == other.type
+          return false unless @test == other.test
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AuditEventEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AuditEventEvent
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def data
+  end
+
+  def data=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def test
+  end
+
+  def test=(str_)
+  end
+end

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

@@ -0,0 +1,52 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # GET /v1/workspaces/{workspace_id}/audit_events: one page of the workspace's audit log, both environments, newest first. Events are kept for as long as the workspace exists and are deleted with it. next_cursor is present only when another page exists.
+      class AuditEventList
+        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}}
+        )
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::AuditEvent),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+        # Opaque cursor for the next page, MAC'd by the server and bound to the workspace it was issued for. Pass it back unchanged as cursor; a tampered, foreign or expired cursor answers 400 invalid_cursor.
+        field(
+          :next_cursor,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("next_cursor")}}
+        )
+
+        sig {
+          params(workspace_id: ::String, items: T::Array[Models::Shared::AuditEvent], next_cursor: T.nilable(::String))
+            .void
+        }
+        def initialize(workspace_id:, items:, next_cursor: nil)
+          @workspace_id = workspace_id
+          @items = items
+          @next_cursor = next_cursor
+        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 @items == other.items
+          return false unless @next_cursor == other.next_cursor
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,47 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class AuditEventTarget
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The kind of resource the change acted on.
+        field(
+          :type,
+          Models::Shared::AuditEventTargetType,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("type"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AuditEventTargetType, false)
+            }
+          }
+        )
+        # The resource's id, when it has one.
+        field(
+          :id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id")}}
+        )
+
+        sig { params(type: Models::Shared::AuditEventTargetType, id: T.nilable(::String)).void }
+        def initialize(type:, id: nil)
+          @type = type
+          @id = id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @id == other.id
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # AuditEventTargetType - The kind of resource the change acted on.
+      class AuditEventTargetType
+        include ::Crystalline::Enum
+        enums do
+          WORKSPACE = new("workspace")
+          MEMBER = new("member")
+          INVITE = new("invite")
+          KEY = new("key")
+          SETTING = new("setting")
+          WEBHOOK_ENDPOINT = new("webhook_endpoint")
+          INTEGRATION = new("integration")
+          BILLING = new("billing")
+          REVIEW = new("review")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,74 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Read audit retention and available history.
+      class AuditSettings
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :environment,
+          Models::Shared::AuditSettingsEnvironment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AuditSettingsEnvironment, false)
+            }
+          }
+        )
+
+        field(
+          :retention_days,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retention_days"), required: true}}
+        )
+
+        field(
+          :oldest_available_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("oldest_available_at")}}
+        )
+
+        field(
+          :capture,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("capture"), required: true}}
+        )
+
+        sig {
+          params(
+            environment: Models::Shared::AuditSettingsEnvironment,
+            retention_days: ::Integer,
+            oldest_available_at: T.nilable(::String),
+            capture: ::String
+          )
+            .void
+        }
+        def initialize(environment:, retention_days:, oldest_available_at: nil, capture: "available_events_only")
+          @environment = environment
+          @retention_days = retention_days
+          @oldest_available_at = oldest_available_at
+          unless capture == "available_events_only"
+            raise ArgumentError, "Invalid value for capture"
+          end
+
+          @capture = "available_events_only"
+        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 @retention_days == other.retention_days
+          return false unless @oldest_available_at == other.oldest_available_at
+          return false unless @capture == other.capture
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AuditSettings
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AuditSettings
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def retention_days
+  end
+
+  def retention_days=(str_)
+  end
+
+  def oldest_available_at
+  end
+
+  def oldest_available_at=(str_)
+  end
+
+  def capture
+  end
+
+  def capture=(str_)
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class AuditSettingsEnvironment
+        include ::Crystalline::Enum
+        enums do
+          LIVE = new("live")
+          TEST = new("test")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class AuditSettingsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :retention_days,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retention_days"), required: true}}
+        )
+
+        sig { params(retention_days: ::Integer).void }
+        def initialize(retention_days:)
+          @retention_days = retention_days
+        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
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,111 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class AuditStream
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :endpoint_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("endpoint_id"), required: true}}
+        )
+
+        field(
+          :environment,
+          Models::Shared::Environment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Environment, false)
+            }
+          }
+        )
+
+        field(
+          :actions,
+          Crystalline::Array.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("actions"), required: true}}
+        )
+
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # unverified until the endpoint echoes an endpoint.verification challenge (send one with POST /v1/webhooks/{endpoint_id}/test); verified receives assessment.updated events; disabled after 72 hours of continuous delivery failure, and verified again by the same challenge.
+        field(
+          :endpoint_state,
+          Models::Shared::WebhookEndpointState,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("endpoint_state"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::WebhookEndpointState, false)
+            }
+          }
+        )
+
+        field(
+          :last_attempt_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("last_attempt_at")}}
+        )
+
+        field(
+          :last_delivered_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("last_delivered_at")}}
+        )
+
+        sig {
+          params(
+            endpoint_id: ::String,
+            environment: Models::Shared::Environment,
+            actions: T::Array[::String],
+            created_at: ::String,
+            endpoint_state: Models::Shared::WebhookEndpointState,
+            last_attempt_at: T.nilable(::String),
+            last_delivered_at: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          endpoint_id:,
+          environment:,
+          actions:,
+          created_at:,
+          endpoint_state:,
+          last_attempt_at: nil,
+          last_delivered_at: nil
+        )
+          @endpoint_id = endpoint_id
+          @environment = environment
+          @actions = actions
+          @created_at = created_at
+          @endpoint_state = endpoint_state
+          @last_attempt_at = last_attempt_at
+          @last_delivered_at = last_delivered_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @endpoint_id == other.endpoint_id
+          return false unless @environment == other.environment
+          return false unless @actions == other.actions
+          return false unless @created_at == other.created_at
+          return false unless @endpoint_state == other.endpoint_state
+          return false unless @last_attempt_at == other.last_attempt_at
+          return false unless @last_delivered_at == other.last_delivered_at
+          true
+        end
+      end
+    end
+  end
+end