noresponse 5.1.0 → 6.0.0

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/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

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

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The body of every webhook delivery: {id, type, created_at, data}, where type chooses the shape of data. Deliveries are at least once and unordered: deduplicate on id, and keep an assessment only when its detail.assessment_version is newer than the one you hold. GET /v1/assessments/{assessment_id} stays authoritative.
+      class WebhookEvent
+        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/webhookevent.rbi

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

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

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The body an endpoint returns, with status 200 and Content-Type application/json within 5 seconds, to an endpoint.verification event. A 2xx without the echoed challenge does not verify the endpoint.
+      class WebhookVerificationResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # 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(challenge: ::String).void }
+        def initialize(challenge:)
+          @challenge = challenge
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @challenge == other.challenge
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,55 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Terminal for the receiving endpoint's environment: its workspace was deleted. Every key of the environment already answers 401, its assessments and accounts are gone, and no further event follows. The workspace id is not reused, so a later event naming it cannot arrive.
+      class WorkspaceDeleted
+        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}}
+        )
+        # The environment whose endpoints receive this event: live, or test for the workspace's test environment.
+        field(
+          :environment,
+          Models::Shared::Environment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.enum_from_string(Models::Shared::Environment, false)
+            }
+          }
+        )
+        # When the deletion took effect, equal to deleted_at in the DELETE answer.
+        field(
+          :deleted_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("deleted_at"), required: true}}
+        )
+
+        sig { params(workspace_id: ::String, environment: Models::Shared::Environment, deleted_at: ::String).void }
+        def initialize(workspace_id:, environment:, deleted_at:)
+          @workspace_id = workspace_id
+          @environment = environment
+          @deleted_at = deleted_at
+        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 @environment == other.environment
+          return false unless @deleted_at == other.deleted_at
+          true
+        end
+      end
+    end
+  end
+end

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

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