noresponse 5.1.1 → 6.0.1

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The account.risk_changed event.
+      class AccountRiskChangedEvent
+        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}}
+        )
+        # The account's decision for at least one flow changed. account is the account as GET /v1/accounts/{account_id} answers it for the revision that made the change: its new score, decision, reasons and decisions_by_flow, and the assessment the risk comes from. previous_decisions_by_flow are the decisions it replaced, so account.decisions_by_flow differs from them for at least one flow. On the account's first decision, previous_decisions_by_flow is allow for every flow. Events of one account are not ordered: account.risk_version orders them, so keep the account with the highest risk_version and ignore an event whose account is older than the one held.
+        field(
+          :data,
+          Models::Shared::AccountRiskChanged,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true}}
+        )
+        # Always account.risk_changed.
+        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::AccountRiskChanged,
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "account.risk_changed", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "account.risk_changed"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "account.risk_changed"
+          @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/accountriskchangedevent.rbi

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AccountRiskChangedEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AccountRiskChangedEvent
+  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/assessmentexpired.rb

@@ -0,0 +1,82 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Terminal. Nothing to fetch; the consumer deletes its state for assessment_id.
+      class AssessmentExpired
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Opaque, server-assigned assessment id: 'asm_' and a 26-character Crockford base32 ULID. Unique within the workspace; another workspace's assessment id answers 404.
+        field(
+          :assessment_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_id"), required: true}}
+        )
+        # Your own opaque identifier for the account being checked, scoped to your workspace. Use an id you mint, with no direct identifier (email, phone, name or national id) in it. '|' is accepted so an Auth0 user id such as 'auth0|64abc' passes unchanged; '@', '+', '$' and whitespace are refused by the pattern, as is an exact-shape JWT; a hex digest such as a SHA-256 is allowed, because hashing an internal id is a common pseudonymous scheme. A value such as '07700900123' or 'jane.doe.gmail.com' cannot be told apart from an opaque id. It travels in bodies, and in a URL only as the path segment of GET /v1/accounts/{account_id} and its /assessments. An assessment requested by a provider hook at pre_registration, which has no account yet, carries the server-issued account_id pre: followed by its assessment_id.
+        field(
+          :account_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_id"), required: true}}
+        )
+        # The last served version: expiry is not a revision.
+        field(
+          :assessment_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_version"), required: true}}
+        )
+
+        field(
+          :status,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("status"), required: true}}
+        )
+
+        field(
+          :change_reason,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("change_reason"), required: true}}
+        )
+
+        sig {
+          params(
+            assessment_id: ::String,
+            account_id: ::String,
+            assessment_version: ::Integer,
+            status: ::String,
+            change_reason: ::String
+          )
+            .void
+        }
+        def initialize(assessment_id:, account_id:, assessment_version:, status: "expired", change_reason: "expired")
+          @assessment_id = assessment_id
+          @account_id = account_id
+          @assessment_version = assessment_version
+          unless status == "expired"
+            raise ArgumentError, "Invalid value for status"
+          end
+
+          @status = "expired"
+          unless change_reason == "expired"
+            raise ArgumentError, "Invalid value for change_reason"
+          end
+
+          @change_reason = "expired"
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @assessment_id == other.assessment_id
+          return false unless @account_id == other.account_id
+          return false unless @assessment_version == other.assessment_version
+          return false unless @status == other.status
+          return false unless @change_reason == other.change_reason
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AssessmentExpired
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AssessmentExpired
+  def assessment_id
+  end
+
+  def assessment_id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def assessment_version
+  end
+
+  def assessment_version=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def change_reason
+  end
+
+  def change_reason=(str_)
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The assessment, or the minimal notice that it expired.
+      class AssessmentUpdatedData
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,79 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The assessment.updated event.
+      class AssessmentUpdatedEvent
+        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}}
+        )
+        # The assessment, or the minimal notice that it expired.
+        field(
+          :data,
+          Crystalline::Union.new(Models::Shared::Assessment, Models::Shared::AssessmentExpired),
+          {
+            'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true},
+            'discriminator': "status",
+            'discriminator_mapping': {
+              "complete" => Models::Shared::Assessment,
+              "partial" => Models::Shared::Assessment,
+              "pending" => Models::Shared::Assessment,
+              "expired" => Models::Shared::AssessmentExpired
+            }
+          }
+        )
+        # Always assessment.updated.
+        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: T.any(Models::Shared::Assessment, Models::Shared::AssessmentExpired),
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "assessment.updated", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "assessment.updated"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "assessment.updated"
+          @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/assessmentupdatedevent.rbi

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AssessmentUpdatedEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AssessmentUpdatedEvent
+  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/conflicterrorcode.rb

@@ -13,6 +13,7 @@ module NoResponse
           WEBHOOK_ENDPOINT_LIMIT_REACHED = new("webhook_endpoint_limit_reached")
           WEBHOOK_ENDPOINT_UNVERIFIED = new("webhook_endpoint_unverified")
           TOO_MANY_INTEGRATIONS = new("too_many_integrations")
+          RISK_VERSION_AHEAD = new("risk_version_ahead")
         end
 
         open!

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

@@ -0,0 +1,41 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class EndpointVerification
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Opaque id of the endpoint registration being verified.
+        field(
+          :endpoint_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("endpoint_id"), required: true}}
+        )
+        # Endpoint verification nonce: 32 random bytes, unpadded base64url (43 characters). Fresh per verification.
+        field(
+          :challenge,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("challenge"), required: true}}
+        )
+
+        sig { params(endpoint_id: ::String, challenge: ::String).void }
+        def initialize(endpoint_id:, challenge:)
+          @endpoint_id = endpoint_id
+          @challenge = challenge
+        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 @challenge == other.challenge
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The endpoint.verification event.
+      class EndpointVerificationEvent
+        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}}
+        )
+
+        field(
+          :data,
+          Models::Shared::EndpointVerification,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true}}
+        )
+        # Always endpoint.verification.
+        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::EndpointVerification,
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "endpoint.verification", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "endpoint.verification"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "endpoint.verification"
+          @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/endpointverificationevent.rbi

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::EndpointVerificationEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::EndpointVerificationEvent
+  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