noresponse 8.4.1 → 9.1.0

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Count every retained matching attempt in [from,to). Capture is best effort; missing attempts cannot be inferred. UTC buckets may be partial at the edges. The window is at most 30 days.
+      class WebhookAggregateRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :from, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("from"), required: true}}
+
+        field :to, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("to"), required: true}}
+
+        field(
+          :bucket,
+          Crystalline::Nilable.new(Models::Shared::RequestAggregateRequestBucket),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("bucket"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::RequestAggregateRequestBucket, true)
+            }
+          }
+        )
+
+        field(
+          :status,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("status")}}
+        )
+        # Opaque id of the endpoint registration.
+        field(
+          :endpoint_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("endpoint_id")}}
+        )
+
+        sig {
+          params(
+            from: ::String,
+            to: ::String,
+            bucket: T.nilable(Models::Shared::RequestAggregateRequestBucket),
+            status: T.nilable(::Integer),
+            endpoint_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(from:, to:, bucket: nil, status: nil, endpoint_id: nil)
+          @from = from
+          @to = to
+          @bucket = bucket
+          @status = status
+          @endpoint_id = endpoint_id
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @from == other.from
+          return false unless @to == other.to
+          return false unless @bucket == other.bucket
+          return false unless @status == other.status
+          return false unless @endpoint_id == other.endpoint_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::WebhookAggregateRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::WebhookAggregateRequest
+  def from
+  end
+
+  def from=(str_)
+  end
+
+  def to
+  end
+
+  def to=(str_)
+  end
+
+  def bucket
+  end
+
+  def bucket=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def endpoint_id
+  end
+
+  def endpoint_id=(str_)
+  end
+end

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

@@ -15,7 +15,7 @@ module NoResponse
           ::String,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("event_id"), required: true}}
         )
-        # The event's type, as its body's type: assessment.updated, endpoint.verification, account.deleted, workspace.deleted, webhook_endpoint.disabled, account.risk_changed, or a type added later.
+        # The event's type, as its body's type: assessment.updated, endpoint.verification, account.deleted, workspace.deleted, webhook_endpoint.disabled, account.risk_changed, audit.event, or a type added later.
         field(
           :event_type,
           ::String,

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

@@ -21,7 +21,7 @@ module NoResponse
           ::String,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("event_id"), required: true}}
         )
-        # The event's type, as its body's type: assessment.updated, endpoint.verification, account.deleted, workspace.deleted, webhook_endpoint.disabled, account.risk_changed, or a type added later.
+        # The event's type, as its body's type: assessment.updated, endpoint.verification, account.deleted, workspace.deleted, webhook_endpoint.disabled, account.risk_changed, audit.event, or a type added later.
         field(
           :event_type,
           ::String,

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

@@ -15,15 +15,15 @@ module NoResponse
           ::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,
+          Models::Shared::AuditSettingsEnvironment,
           {
             'format_json': {
               'letter_case': ::NoResponse::Utils.field_name("environment"),
               required: true,
-              'decoder': ::NoResponse::Utils.enum_from_string(Models::Shared::Environment, false)
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AuditSettingsEnvironment, false)
             }
           }
         )
@@ -34,7 +34,10 @@ module NoResponse
           {'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 }
+        sig {
+          params(workspace_id: ::String, environment: Models::Shared::AuditSettingsEnvironment, deleted_at: ::String)
+            .void
+        }
         def initialize(workspace_id:, environment:, deleted_at:)
           @workspace_id = workspace_id
           @environment = environment

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

@@ -0,0 +1,166 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Three separately defined populations with independent denominators. Interpret each section within its own population; their totals do not form a conversion funnel. All counts and retention come from one snapshot. Requests above the population or query budget are refused without truncation.
+      class WorkspaceOperationsSummary
+        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}}
+        )
+
+        field(
+          :environment,
+          Models::Shared::AuditSettingsEnvironment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AuditSettingsEnvironment, false)
+            }
+          }
+        )
+
+        field :from, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("from"), required: true}}
+
+        field :to, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("to"), required: true}}
+
+        field(
+          :as_of,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("as_of"), required: true}}
+        )
+
+        field(
+          :retained_from,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retained_from"), required: true}}
+        )
+
+        field(
+          :retention_days,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("retention_days"), required: true}}
+        )
+
+        field(
+          :records_read,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("records_read"), required: true}}
+        )
+        # Accounts whose current completed assessment was created in the selected window and remains retained at as_of. The effective account feedback head is observed at as_of, including explicit unknown reports. Customer-reported labels and unlabelled accounts have separate counts. Superseded labels are excluded.
+        field(
+          :outcomes,
+          Models::Shared::Outcomes,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("outcomes"), required: true}}
+        )
+        # Retained customer enforcement report rows created in [from,to), one row per account/risk_version/flow/action. A later applied report can replace failed at the original created_at; retries are not additional attempts here. applied_coverage divides reported_applied by report rows, including explicit action none; it is not independently verified execution, all requested actions, or prevented fraud. Unreported actions are unknown.
+        field(
+          :enforcements,
+          Models::Shared::Enforcements,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("enforcements"), required: true}}
+        )
+        # Reviews created in [from,to) whose review and current account assessment remain retained. Status and assignment are current at as_of, not a transition history. label_coverage numerator is resolved reviews labeled benign or abuse; denominator is resolved reviews. Inconclusive is not a known outcome. Review conclusions do not change account feedback or enforcement.
+        field(
+          :reviews,
+          Models::Shared::Reviews,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("reviews"), required: true}}
+        )
+
+        field(
+          :row_budget,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("row_budget"), required: true}}
+        )
+
+        field(
+          :truncated,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("truncated"), required: true}}
+        )
+
+        sig {
+          params(
+            workspace_id: ::String,
+            environment: Models::Shared::AuditSettingsEnvironment,
+            from: ::String,
+            to: ::String,
+            as_of: ::String,
+            retained_from: ::String,
+            retention_days: ::Integer,
+            records_read: ::Integer,
+            outcomes: Models::Shared::Outcomes,
+            enforcements: Models::Shared::Enforcements,
+            reviews: Models::Shared::Reviews,
+            row_budget: ::Integer,
+            truncated: T::Boolean
+          )
+            .void
+        }
+        def initialize(
+          workspace_id:,
+          environment:,
+          from:,
+          to:,
+          as_of:,
+          retained_from:,
+          retention_days:,
+          records_read:,
+          outcomes:,
+          enforcements:,
+          reviews:,
+          row_budget: 100_000,
+          truncated: false
+        )
+          @workspace_id = workspace_id
+          @environment = environment
+          @from = from
+          @to = to
+          @as_of = as_of
+          @retained_from = retained_from
+          @retention_days = retention_days
+          @records_read = records_read
+          @outcomes = outcomes
+          @enforcements = enforcements
+          @reviews = reviews
+          unless row_budget == 100_000
+            raise ArgumentError, "Invalid value for row_budget"
+          end
+
+          @row_budget = 100_000
+          unless truncated == false
+            raise ArgumentError, "Invalid value for truncated"
+          end
+
+          @truncated = false
+        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 @from == other.from
+          return false unless @to == other.to
+          return false unless @as_of == other.as_of
+          return false unless @retained_from == other.retained_from
+          return false unless @retention_days == other.retention_days
+          return false unless @records_read == other.records_read
+          return false unless @outcomes == other.outcomes
+          return false unless @enforcements == other.enforcements
+          return false unless @reviews == other.reviews
+          return false unless @row_budget == other.row_budget
+          return false unless @truncated == other.truncated
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::WorkspaceOperationsSummary
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::WorkspaceOperationsSummary
+  def workspace_id
+  end
+
+  def workspace_id=(str_)
+  end
+
+  def environment
+  end
+
+  def environment=(str_)
+  end
+
+  def from
+  end
+
+  def from=(str_)
+  end
+
+  def to
+  end
+
+  def to=(str_)
+  end
+
+  def as_of
+  end
+
+  def as_of=(str_)
+  end
+
+  def retained_from
+  end
+
+  def retained_from=(str_)
+  end
+
+  def retention_days
+  end
+
+  def retention_days=(str_)
+  end
+
+  def records_read
+  end
+
+  def records_read=(str_)
+  end
+
+  def outcomes
+  end
+
+  def outcomes=(str_)
+  end
+
+  def enforcements
+  end
+
+  def enforcements=(str_)
+  end
+
+  def reviews
+  end
+
+  def reviews=(str_)
+  end
+
+  def row_budget
+  end
+
+  def row_budget=(str_)
+  end
+
+  def truncated
+  end
+
+  def truncated=(str_)
+  end
+end

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

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Read a past [from,to) interval of at most 31 days. The complete retained populations must fit a combined 100000-row budget and a 1500ms SQL statement budget. No pagination or sampled totals; choose a shorter interval after a row-budget refusal.
+      class WorkspaceOperationsSummaryRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :environment,
+          Models::Shared::AuditSettingsEnvironment,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("environment"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AuditSettingsEnvironment, false)
+            }
+          }
+        )
+
+        field :from, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("from"), required: true}}
+
+        field :to, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("to"), required: true}}
+
+        sig { params(environment: Models::Shared::AuditSettingsEnvironment, from: ::String, to: ::String).void }
+        def initialize(environment:, from:, to:)
+          @environment = environment
+          @from = from
+          @to = to
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @environment == other.environment
+          return false unless @from == other.from
+          return false unless @to == other.to
+          true
+        end
+      end
+    end
+  end
+end

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

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