noresponse 6.0.0 → 6.0.1

data/lib/no_response/models/operations/listaccounts_request.rb

@@ -0,0 +1,52 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ListAccountsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # next_cursor from an earlier page, unchanged. Absent, the list starts from the oldest change.
+        field(
+          :changed_since,
+          Crystalline::Nilable.new(::String),
+          {'query_param': {'field_name': "changed_since", 'style': "form", 'explode': true}}
+        )
+        # Most accounts per page.
+        field(
+          :limit,
+          Crystalline::Nilable.new(::Integer),
+          {'query_param': {'field_name': "limit", 'style': "form", 'explode': true}}
+        )
+        # true lists only accounts with a decision other than allow for some flow and no applied enforcement at their current risk_version.
+        field(
+          :unenforced,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'query_param': {'field_name': "unenforced", 'style': "form", 'explode': true}}
+        )
+
+        sig {
+          params(changed_since: T.nilable(::String), limit: T.nilable(::Integer), unenforced: T.nilable(T::Boolean))
+            .void
+        }
+        def initialize(changed_since: nil, limit: 50, unenforced: false)
+          @changed_since = changed_since
+          @limit = limit
+          @unenforced = unenforced
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @changed_since == other.changed_since
+          return false unless @limit == other.limit
+          return false unless @unenforced == other.unenforced
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/listaccounts_request.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ListAccountsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ListAccountsRequest
+  def changed_since
+  end
+
+  def changed_since=(str_)
+  end
+
+  def limit
+  end
+
+  def limit=(str_)
+  end
+
+  def unenforced
+  end
+
+  def unenforced=(str_)
+  end
+end

data/lib/no_response/models/operations/listaccounts_response.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class ListAccountsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+
+        field :result, Models::Shared::AccountList, {}
+
+        sig { params(headers: T::Hash[Symbol, T::Array[::String]], result: Models::Shared::AccountList).void }
+        def initialize(headers:, result:)
+          @headers = headers
+          @result = result
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @headers == other.headers
+          return false unless @result == other.result
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/listaccounts_response.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::ListAccountsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::ListAccountsResponse
+  def headers
+  end
+
+  def headers=(str_)
+  end
+
+  def result
+  end
+
+  def result=(str_)
+  end
+end

data/lib/no_response/models/operations/recordenforcement_request.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class RecordEnforcementRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The account_id the workspace sends with its assessments, as one path segment (percent-encode '|' and ':' if the client requires it). A value that does not match the account_id shape answers 400 invalid_request.
+        field :account_id, ::String, {'path_param': {'field_name': "account_id", 'style': "simple", 'explode': false}}
+
+        field :body, Models::Shared::EnforcementRequest, {'request': {'media_type': "application/json"}}
+
+        sig { params(account_id: ::String, body: Models::Shared::EnforcementRequest).void }
+        def initialize(account_id:, body:)
+          @account_id = account_id
+          @body = body
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @account_id == other.account_id
+          return false unless @body == other.body
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/recordenforcement_request.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::RecordEnforcementRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::RecordEnforcementRequest
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def body
+  end
+
+  def body=(str_)
+  end
+end

data/lib/no_response/models/operations/recordenforcement_response.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class RecordEnforcementResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+
+        field :result, Models::Shared::Enforcement, {}
+
+        sig { params(headers: T::Hash[Symbol, T::Array[::String]], result: Models::Shared::Enforcement).void }
+        def initialize(headers:, result:)
+          @headers = headers
+          @result = result
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @headers == other.headers
+          return false unless @result == other.result
+          true
+        end
+      end
+    end
+  end
+end

data/lib/no_response/models/operations/recordenforcement_response.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Operations::RecordEnforcementResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Operations::RecordEnforcementResponse
+  def headers
+  end
+
+  def headers=(str_)
+  end
+
+  def result
+  end
+
+  def result=(str_)
+  end
+end

data/lib/no_response/models/operations.rb

@@ -22,6 +22,8 @@ module NoResponse
       autoload :GetAssessmentResponse, "no_response/models/operations/getassessment_response.rb"
       autoload :ListAccountAssessmentsRequest, "no_response/models/operations/listaccountassessments_request.rb"
       autoload :ListAccountAssessmentsResponse, "no_response/models/operations/listaccountassessments_response.rb"
+      autoload :ListAccountsRequest, "no_response/models/operations/listaccounts_request.rb"
+      autoload :ListAccountsResponse, "no_response/models/operations/listaccounts_response.rb"
       autoload :ListIntegrationsResponse, "no_response/models/operations/listintegrations_response.rb"
       autoload :ListWebhookDeliveriesRequest, "no_response/models/operations/listwebhookdeliveries_request.rb"
       autoload :ListWebhookDeliveriesResponse, "no_response/models/operations/listwebhookdeliveries_response.rb"
@@ -29,6 +31,8 @@ module NoResponse
       autoload :QueryAccountAssessmentsResponse, "no_response/models/operations/queryaccountassessments_response.rb"
       autoload :RecordAssessmentOutcomeRequest, "no_response/models/operations/recordassessmentoutcome_request.rb"
       autoload :RecordAssessmentOutcomeResponse, "no_response/models/operations/recordassessmentoutcome_response.rb"
+      autoload :RecordEnforcementRequest, "no_response/models/operations/recordenforcement_request.rb"
+      autoload :RecordEnforcementResponse, "no_response/models/operations/recordenforcement_response.rb"
       autoload :RecordKeyUsageRequest, "no_response/models/operations/recordkeyusage_request.rb"
       autoload :RecordKeyUsageResponse, "no_response/models/operations/recordkeyusage_response.rb"
       autoload :ReplayWebhookDeliveryRequest, "no_response/models/operations/replaywebhookdelivery_request.rb"

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

@@ -0,0 +1,40 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Body of the 200 answer to GET /v1/accounts: the calling workspace's accounts whose risk changed after changed_since, in the environment of the calling key, oldest change first. An account is listed when its risk_version advanced and it has a current risk, and each item is the account exactly as GET /v1/accounts/{account_id} answers it. An account appears once per page, at its latest change; when its risk changes again later, it appears again on a later page with the newer risk_version. next_cursor is always present: pass it back as changed_since to read the changes made after this page.
+      class AccountList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::Account),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+        # Opaque cursor after the last change this page read, bound to the workspace and the environment of the calling key. Pass it back unchanged as changed_since. It is present on every page, the last one included: when nothing changed after changed_since it is the cursor that was sent, so a poller keeps calling with the latest next_cursor. A tampered or foreign cursor answers 400 invalid_cursor. Consumers do not parse it.
+        field(
+          :next_cursor,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("next_cursor"), required: true}}
+        )
+
+        sig { params(items: T::Array[Models::Shared::Account], next_cursor: ::String).void }
+        def initialize(items:, next_cursor:)
+          @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 @items == other.items
+          return false unless @next_cursor == other.next_cursor
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AccountList
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AccountList
+  def items
+  end
+
+  def items=(str_)
+  end
+
+  def next_cursor
+  end
+
+  def next_cursor=(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/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