noresponse 5.1.1 → 6.0.1

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

@@ -0,0 +1,156 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The answer of POST /v1/accounts/{account_id}/enforcements: one enforcement of one of the calling workspace's accounts, kept once per (account, risk_version, flow, action). The first report answers 201 with the new record. A repeat answers 200 with the record as first stored, whatever the repeat's state_before, status, provider or error_code. The one exception is a stored failed record followed by an applied report: the record becomes applied, keeps its id and created_at, takes the applied report's state_before and provider, drops error_code and answers 201, so a successful retry after a failure is recorded. Only an applied record at the account's current risk_version takes the account out of GET /v1/accounts?unenforced=true.
+      class Enforcement
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Opaque, server-assigned id of one recorded enforcement: 'enf_' and 26 Crockford base32 characters. Unique within the workspace.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # The account_id of the request path.
+        field(
+          :account_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_id"), required: true}}
+        )
+        # The account's risk_version the workspace acted on. It can be older than the account's current risk_version: such a record is kept and does not count for unenforced.
+        field(
+          :risk_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("risk_version"), required: true}}
+        )
+        # The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
+        field(
+          :flow,
+          Models::Shared::Flow,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("flow"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Flow, false)
+            }
+          }
+        )
+        # What the workspace did in its identity provider: revoke_sessions (signed the account out everywhere), restrict (limited what the account can do), unrestrict (lifted an earlier restriction), fail_onboarding (stopped an account that was still onboarding), reject_activation (refused to activate a provisional account) or none (decided to take no action).
+        field(
+          :action,
+          Models::Shared::EnforcementAction,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("action"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementAction, false)
+            }
+          }
+        )
+        # The account's state in the workspace's identity provider just before the action: onboarding, provisional (created, not yet activated), active, restricted or rejected.
+        field(
+          :state_before,
+          Models::Shared::EnforcementState,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("state_before"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementState, false)
+            }
+          }
+        )
+        # applied when the identity provider accepted the action, failed when it refused it or could not be reached. Only applied counts as enforced.
+        field(
+          :status,
+          Models::Shared::EnforcementStatus,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("status"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementStatus, false)
+            }
+          }
+        )
+        # The identity provider the action ran in; custom for the workspace's own user store.
+        field(
+          :provider,
+          Models::Shared::EnforcementProvider,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("provider"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementProvider, false)
+            }
+          }
+        )
+        # When NoResponse first recorded this enforcement, in UTC. A failed record that becomes applied keeps it.
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # Why a failed action failed, as a short code of the workspace's choosing (lower-case letters, digits, '_', '.' and '-'), such as the identity provider's error code. Allowed only with status failed: with status applied it answers 400 invalid_request. Keep personal data out of it.
+        field(
+          :error_code,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("error_code")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            account_id: ::String,
+            risk_version: ::Integer,
+            flow: Models::Shared::Flow,
+            action: Models::Shared::EnforcementAction,
+            state_before: Models::Shared::EnforcementState,
+            status: Models::Shared::EnforcementStatus,
+            provider: Models::Shared::EnforcementProvider,
+            created_at: ::String,
+            error_code: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          id:,
+          account_id:,
+          risk_version:,
+          flow:,
+          action:,
+          state_before:,
+          status:,
+          provider:,
+          created_at:,
+          error_code: nil
+        )
+          @id = id
+          @account_id = account_id
+          @risk_version = risk_version
+          @flow = flow
+          @action = action
+          @state_before = state_before
+          @status = status
+          @provider = provider
+          @created_at = created_at
+          @error_code = error_code
+        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 @account_id == other.account_id
+          return false unless @risk_version == other.risk_version
+          return false unless @flow == other.flow
+          return false unless @action == other.action
+          return false unless @state_before == other.state_before
+          return false unless @status == other.status
+          return false unless @provider == other.provider
+          return false unless @created_at == other.created_at
+          return false unless @error_code == other.error_code
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Enforcement
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Enforcement
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def risk_version
+  end
+
+  def risk_version=(str_)
+  end
+
+  def flow
+  end
+
+  def flow=(str_)
+  end
+
+  def action
+  end
+
+  def action=(str_)
+  end
+
+  def state_before
+  end
+
+  def state_before=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def provider
+  end
+
+  def provider=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def error_code
+  end
+
+  def error_code=(str_)
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # EnforcementAction - What the workspace did in its identity provider: revoke_sessions (signed the account out everywhere), restrict (limited what the account can do), unrestrict (lifted an earlier restriction), fail_onboarding (stopped an account that was still onboarding), reject_activation (refused to activate a provisional account) or none (decided to take no action).
+      class EnforcementAction
+        include ::Crystalline::Enum
+        enums do
+          REVOKE_SESSIONS = new("revoke_sessions")
+          RESTRICT = new("restrict")
+          UNRESTRICT = new("unrestrict")
+          FAIL_ONBOARDING = new("fail_onboarding")
+          REJECT_ACTIVATION = new("reject_activation")
+          NONE = new("none")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # EnforcementProvider - The identity provider the action ran in; custom for the workspace's own user store.
+      class EnforcementProvider
+        include ::Crystalline::Enum
+        enums do
+          CLERK = new("clerk")
+          WORKOS = new("workos")
+          AUTH0 = new("auth0")
+          CUSTOM = new("custom")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,122 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # POST /v1/accounts/{account_id}/enforcements body: what the workspace did to the account in its identity provider after reading the account's risk at risk_version. The account is named by the path and the workspace by the API key, so neither is a body member. An enforcement is the workspace's own action, not an outcome: what the workspace later learned about an assessment goes to POST /v1/assessments/{assessment_id}/outcomes. The record's key is (account, risk_version, flow, action), so a retry of the same report is safe and needs no Idempotency-Key.
+      class EnforcementRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The account's risk_version the workspace acted on, as read from GET /v1/accounts/{account_id}, GET /v1/accounts, an assessment answer or account.risk_changed. A version older than the account's current one is accepted and stored; a version newer than the current one answers 409 risk_version_ahead.
+        field(
+          :risk_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("risk_version"), required: true}}
+        )
+        # The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
+        field(
+          :flow,
+          Models::Shared::Flow,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("flow"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Flow, false)
+            }
+          }
+        )
+        # What the workspace did in its identity provider: revoke_sessions (signed the account out everywhere), restrict (limited what the account can do), unrestrict (lifted an earlier restriction), fail_onboarding (stopped an account that was still onboarding), reject_activation (refused to activate a provisional account) or none (decided to take no action).
+        field(
+          :action,
+          Models::Shared::EnforcementAction,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("action"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementAction, false)
+            }
+          }
+        )
+        # The account's state in the workspace's identity provider just before the action: onboarding, provisional (created, not yet activated), active, restricted or rejected.
+        field(
+          :state_before,
+          Models::Shared::EnforcementState,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("state_before"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementState, false)
+            }
+          }
+        )
+        # applied when the identity provider accepted the action, failed when it refused it or could not be reached. Only applied counts as enforced.
+        field(
+          :status,
+          Models::Shared::EnforcementStatus,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("status"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementStatus, false)
+            }
+          }
+        )
+        # The identity provider the action ran in; custom for the workspace's own user store.
+        field(
+          :provider,
+          Models::Shared::EnforcementProvider,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("provider"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::EnforcementProvider, false)
+            }
+          }
+        )
+        # Why a failed action failed, as a short code of the workspace's choosing (lower-case letters, digits, '_', '.' and '-'), such as the identity provider's error code. Allowed only with status failed: with status applied it answers 400 invalid_request. Keep personal data out of it.
+        field(
+          :error_code,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("error_code")}}
+        )
+
+        sig {
+          params(
+            risk_version: ::Integer,
+            flow: Models::Shared::Flow,
+            action: Models::Shared::EnforcementAction,
+            state_before: Models::Shared::EnforcementState,
+            status: Models::Shared::EnforcementStatus,
+            provider: Models::Shared::EnforcementProvider,
+            error_code: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(risk_version:, flow:, action:, state_before:, status:, provider:, error_code: nil)
+          @risk_version = risk_version
+          @flow = flow
+          @action = action
+          @state_before = state_before
+          @status = status
+          @provider = provider
+          @error_code = error_code
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @risk_version == other.risk_version
+          return false unless @flow == other.flow
+          return false unless @action == other.action
+          return false unless @state_before == other.state_before
+          return false unless @status == other.status
+          return false unless @provider == other.provider
+          return false unless @error_code == other.error_code
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::EnforcementRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::EnforcementRequest
+  def risk_version
+  end
+
+  def risk_version=(str_)
+  end
+
+  def flow
+  end
+
+  def flow=(str_)
+  end
+
+  def action
+  end
+
+  def action=(str_)
+  end
+
+  def state_before
+  end
+
+  def state_before=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def provider
+  end
+
+  def provider=(str_)
+  end
+
+  def error_code
+  end
+
+  def error_code=(str_)
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # EnforcementState - The account's state in the workspace's identity provider just before the action: onboarding, provisional (created, not yet activated), active, restricted or rejected.
+      class EnforcementState
+        include ::Crystalline::Enum
+        enums do
+          ONBOARDING = new("onboarding")
+          PROVISIONAL = new("provisional")
+          ACTIVE = new("active")
+          RESTRICTED = new("restricted")
+          REJECTED = new("rejected")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # EnforcementStatus - applied when the identity provider accepted the action, failed when it refused it or could not be reached. Only applied counts as enforced.
+      class EnforcementStatus
+        include ::Crystalline::Enum
+        enums do
+          APPLIED = new("applied")
+          FAILED = new("failed")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,16 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Environment - The environment whose endpoints receive this event: live, or test for the workspace's test environment.
+      class Environment < T::Enum
+        enums do
+          LIVE = new("live")
+          TEST = new("test")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One of the environment's endpoints stopped receiving events: every delivery attempt to it failed from failing_since until disabled_at, 72 hours or more. Its queued deliveries are dropped. Fix the receiver and verify it again with POST /v1/webhooks/{endpoint_id}/test (type endpoint.verification) to resume delivery.
+      class WebhookEndpointDisabled
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The endpoint that was disabled.
+        field(
+          :endpoint_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("endpoint_id"), required: true}}
+        )
+        # The first failed attempt of the unbroken failure streak.
+        field(
+          :failing_since,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("failing_since"), required: true}}
+        )
+        # When the endpoint was disabled; equal to the event's created_at.
+        field(
+          :disabled_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("disabled_at"), required: true}}
+        )
+
+        sig { params(endpoint_id: ::String, failing_since: ::String, disabled_at: ::String).void }
+        def initialize(endpoint_id:, failing_since:, disabled_at:)
+          @endpoint_id = endpoint_id
+          @failing_since = failing_since
+          @disabled_at = disabled_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 @failing_since == other.failing_since
+          return false unless @disabled_at == other.disabled_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::WebhookEndpointDisabled
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::WebhookEndpointDisabled
+  def endpoint_id
+  end
+
+  def endpoint_id=(str_)
+  end
+
+  def failing_since
+  end
+
+  def failing_since=(str_)
+  end
+
+  def disabled_at
+  end
+
+  def disabled_at=(str_)
+  end
+end