noresponse 2.0.17 → 2.0.19

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Operations
+
+      class SendWebhookTestEventResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+
+        field :result, Models::Shared::WebhookTest, {}
+
+        sig { params(headers: T::Hash[Symbol, T::Array[::String]], result: Models::Shared::WebhookTest).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/sendwebhooktestevent_response.rbi

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

data/lib/no_response/models/operations.rb

@@ -6,12 +6,26 @@ module NoResponse
     module Operations
       autoload :CreateAssessmentRequest, "no_response/models/operations/createassessment_request.rb"
       autoload :CreateAssessmentResponse, "no_response/models/operations/createassessment_response.rb"
+      autoload :CreateIntegrationResponse, "no_response/models/operations/createintegration_response.rb"
+      autoload :CreateWebhookEndpointResponse, "no_response/models/operations/createwebhookendpoint_response.rb"
+      autoload :DeleteIntegrationRequest, "no_response/models/operations/deleteintegration_request.rb"
+      autoload :DeleteIntegrationResponse, "no_response/models/operations/deleteintegration_response.rb"
+      autoload :DeleteWebhookEndpointRequest, "no_response/models/operations/deletewebhookendpoint_request.rb"
+      autoload :DeleteWebhookEndpointResponse, "no_response/models/operations/deletewebhookendpoint_response.rb"
       autoload :GetAssessmentRequest, "no_response/models/operations/getassessment_request.rb"
       autoload :GetAssessmentResponse, "no_response/models/operations/getassessment_response.rb"
+      autoload :ListIntegrationsResponse, "no_response/models/operations/listintegrations_response.rb"
+      autoload :ListWebhookEndpointsResponse, "no_response/models/operations/listwebhookendpoints_response.rb"
       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 :RotateApiKeyResponse, "no_response/models/operations/rotateapikey_response.rb"
+      autoload :RotateIntegrationSecretRequest, "no_response/models/operations/rotateintegrationsecret_request.rb"
+      autoload :RotateIntegrationSecretResponse, "no_response/models/operations/rotateintegrationsecret_response.rb"
+      autoload :RotateWebhookSigningKeyRequest, "no_response/models/operations/rotatewebhooksigningkey_request.rb"
+      autoload :RotateWebhookSigningKeyResponse, "no_response/models/operations/rotatewebhooksigningkey_response.rb"
+      autoload :SendWebhookTestEventRequest, "no_response/models/operations/sendwebhooktestevent_request.rb"
+      autoload :SendWebhookTestEventResponse, "no_response/models/operations/sendwebhooktestevent_response.rb"
     end
   end
 end

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

@@ -28,7 +28,7 @@ module NoResponse
           {
             'format_json': {
               'letter_case': ::NoResponse::Utils.field_name("response_mode"),
-              'decoder': ::NoResponse::Utils.enum_from_string(Models::Shared::ResponseMode, true)
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ResponseMode, true)
             }
           }
         )

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

@@ -46,7 +46,7 @@ module NoResponse
           {
             'format_json': {
               'letter_case': ::NoResponse::Utils.field_name("response_mode"),
-              'decoder': ::NoResponse::Utils.enum_from_string(Models::Shared::ResponseMode, true)
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ResponseMode, true)
             }
           }
         )

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

@@ -11,6 +11,7 @@ module NoResponse
           INVALID_REQUEST = new("invalid_request")
           INVALID_IDEMPOTENCY_KEY = new("invalid_idempotency_key")
           INVALID_CURSOR = new("invalid_cursor")
+          WEBHOOK_URL_REFUSED = new("webhook_url_refused")
         end
 
         open!

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

@@ -10,6 +10,9 @@ module NoResponse
         enums do
           IDEMPOTENCY_KEY_REUSED = new("idempotency_key_reused")
           KEY_ROTATION_IN_PROGRESS = new("key_rotation_in_progress")
+          WEBHOOK_ENDPOINT_LIMIT_REACHED = new("webhook_endpoint_limit_reached")
+          WEBHOOK_ENDPOINT_UNVERIFIED = new("webhook_endpoint_unverified")
+          TOO_MANY_INTEGRATIONS = new("too_many_integrations")
         end
 
         open!

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

@@ -0,0 +1,112 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # A hosted provider integration. Point the provider at url: a WorkOS user registration or authentication Action, or the NoResponse Auth0 Action, which sends secret as a bearer token. The answer allows or denies the event: deny only when the assessment's risk.block is true, and allow on every failure, so a fault on the NoResponse side lets the user through. secret is present only in the answers of POST /v1/integrations and POST /v1/integrations/{integration_id}/rotate for an Auth0 integration, and is not returned again.
+      class Integration
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Opaque, server-assigned integration id: int_ and a 26-character Crockford base32 ULID. Another tenant's integration id answers 404.
+        field(
+          :integration_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("integration_id"), required: true}}
+        )
+        # The authentication provider that calls the endpoint.
+        field(
+          :platform,
+          Models::Shared::IntegrationPlatform,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("platform"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IntegrationPlatform, false)
+            }
+          }
+        )
+        # Each hook point at most once.
+        field(
+          :hook_points,
+          Crystalline::Array.new(Models::Shared::IntegrationHookPoint),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("hook_points"), required: true}}
+        )
+        # The hosted endpoint, https://api.noresponse.org/hooks/{integration_id} in production.
+        field :url, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("url"), required: true}}
+
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # Auth0 only, and only when it is created or rotated: the shared secret the Auth0 Action sends as Authorization: Bearer <secret>. nri_ and 43 unpadded base64url characters (32 random bytes). Store it as an Auth0 Action secret.
+        field(
+          :secret,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("secret")}}
+        )
+        # When the secret was last rotated; absent until the first rotation.
+        field(
+          :rotated_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("rotated_at")}}
+        )
+        # After a rotation, when the replaced secret stops being accepted; absent when no replaced secret is still accepted.
+        field(
+          :previous_secret_expires_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("previous_secret_expires_at")}}
+        )
+
+        sig {
+          params(
+            integration_id: ::String,
+            platform: Models::Shared::IntegrationPlatform,
+            hook_points: T::Array[Models::Shared::IntegrationHookPoint],
+            url: ::String,
+            created_at: ::String,
+            secret: T.nilable(::String),
+            rotated_at: T.nilable(::String),
+            previous_secret_expires_at: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          integration_id:,
+          platform:,
+          hook_points:,
+          url:,
+          created_at:,
+          secret: nil,
+          rotated_at: nil,
+          previous_secret_expires_at: nil
+        )
+          @integration_id = integration_id
+          @platform = platform
+          @hook_points = hook_points
+          @url = url
+          @created_at = created_at
+          @secret = secret
+          @rotated_at = rotated_at
+          @previous_secret_expires_at = previous_secret_expires_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @integration_id == other.integration_id
+          return false unless @platform == other.platform
+          return false unless @hook_points == other.hook_points
+          return false unless @url == other.url
+          return false unless @created_at == other.created_at
+          return false unless @secret == other.secret
+          return false unless @rotated_at == other.rotated_at
+          return false unless @previous_secret_expires_at == other.previous_secret_expires_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Integration
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Integration
+  def integration_id
+  end
+
+  def integration_id=(str_)
+  end
+
+  def platform
+  end
+
+  def platform=(str_)
+  end
+
+  def hook_points
+  end
+
+  def hook_points=(str_)
+  end
+
+  def url
+  end
+
+  def url=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def secret
+  end
+
+  def secret=(str_)
+  end
+
+  def rotated_at
+  end
+
+  def rotated_at=(str_)
+  end
+
+  def previous_secret_expires_at
+  end
+
+  def previous_secret_expires_at=(str_)
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # IntegrationHookPoint - pre_registration runs before the user exists; post_login runs after a successful sign-in.
+      class IntegrationHookPoint
+        include ::Crystalline::Enum
+        enums do
+          PRE_REGISTRATION = new("pre_registration")
+          POST_LOGIN = new("post_login")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # GET /v1/integrations: every integration of the tenant, oldest first, at most 10. No secret is ever listed.
+      class IntegrationList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::Integration),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+
+        sig { params(items: T::Array[Models::Shared::Integration]).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/integrationlist.rbi

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

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # IntegrationPlatform - The authentication provider that calls the endpoint.
+      class IntegrationPlatform
+        include ::Crystalline::Enum
+        enums do
+          WORKOS = new("workos")
+          AUTH0 = new("auth0")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # POST /v1/integrations body. Registers a hosted endpoint for one authentication provider. The tenant is the API key that signs the request, so the body has no tenant field and refuses one like any other unknown member. A WorkOS integration needs signing_secret, the Actions secret shown in the WorkOS dashboard, which NoResponse uses to verify each Action request and to sign its answer. An Auth0 integration sends no signing_secret: NoResponse generates the shared secret and returns it once.
+      class IntegrationRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The authentication provider that calls the endpoint.
+        field(
+          :platform,
+          Models::Shared::IntegrationPlatform,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("platform"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IntegrationPlatform, false)
+            }
+          }
+        )
+        # The provider events the endpoint scores. Default both: pre_registration (WorkOS user registration Action, Auth0 pre-user-registration trigger) and post_login (WorkOS authentication Action, Auth0 post-login trigger). An event that is not listed is answered allow without an assessment.
+        field(
+          :hook_points,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::IntegrationHookPoint)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("hook_points")}}
+        )
+        # The WorkOS Actions signing secret, as the WorkOS dashboard shows it: 16 to 256 printable ASCII characters with no spaces. It is stored sealed and is not returned.
+        field(
+          :signing_secret,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("signing_secret")}}
+        )
+
+        sig {
+          params(
+            platform: Models::Shared::IntegrationPlatform,
+            hook_points: T.nilable(T::Array[Models::Shared::IntegrationHookPoint]),
+            signing_secret: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(platform:, hook_points: nil, signing_secret: nil)
+          @platform = platform
+          @hook_points = hook_points
+          @signing_secret = signing_secret
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @platform == other.platform
+          return false unless @hook_points == other.hook_points
+          return false unless @signing_secret == other.signing_secret
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IntegrationRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IntegrationRequest
+  def platform
+  end
+
+  def platform=(str_)
+  end
+
+  def hook_points
+  end
+
+  def hook_points=(str_)
+  end
+
+  def signing_secret
+  end
+
+  def signing_secret=(str_)
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # POST /v1/integrations/{integration_id}/rotate body. For an Auth0 integration send {}: NoResponse generates a new shared secret and returns it once. For a WorkOS integration send the new signing_secret after regenerating it in the WorkOS dashboard. Either way the previous secret is still accepted for 24 hours, so the provider can be switched over without a refused call.
+      class IntegrationRotationRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The WorkOS Actions signing secret, as the WorkOS dashboard shows it: 16 to 256 printable ASCII characters with no spaces. It is stored sealed and is not returned.
+        field(
+          :signing_secret,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("signing_secret")}}
+        )
+
+        sig { params(signing_secret: T.nilable(::String)).void }
+        def initialize(signing_secret: nil)
+          @signing_secret = signing_secret
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @signing_secret == other.signing_secret
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -5,11 +5,14 @@ module NoResponse
   module Models
     module Shared
       # ResponseMode - standard returns the consolidated risk response; detailed adds merged provider-neutral facts when the key has detailed scope. There is no raw mode.
-      class ResponseMode < T::Enum
+      class ResponseMode
+        include ::Crystalline::Enum
         enums do
           STANDARD = new("standard")
           DETAILED = new("detailed")
         end
+
+        open!
       end
     end
   end

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

@@ -12,6 +12,7 @@ module NoResponse
           HISTORY = new("history")
           WEBHOOKS = new("webhooks")
           DETAILED = new("detailed")
+          INTEGRATIONS = new("integrations")
         end
 
         open!

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

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One signing key, by id. The secret is not included.
+      class SigningKey
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The signing key id, sent as NR-Webhook-Key-Id on every delivery it signs.
+        field(
+          :key_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("key_id"), required: true}}
+        )
+
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # Present on a key a rotation replaced: it stops verifying at this instant, 7 days after the rotation. Absent on the key that signs.
+        field(
+          :expires_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("expires_at")}}
+        )
+
+        sig { params(key_id: ::String, created_at: ::String, expires_at: T.nilable(::String)).void }
+        def initialize(key_id:, created_at:, expires_at: nil)
+          @key_id = key_id
+          @created_at = created_at
+          @expires_at = expires_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @key_id == other.key_id
+          return false unless @created_at == other.created_at
+          return false unless @expires_at == other.expires_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::SigningKey
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::SigningKey
+  def key_id
+  end
+
+  def key_id=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def expires_at
+  end
+
+  def expires_at=(str_)
+  end
+end