safetykit 0.40.0 → 0.42.0

data/rbi/safety_kit/models/data_update_settings_params.rbi

@@ -0,0 +1,551 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DataUpdateSettingsParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::DataUpdateSettingsParams,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      # The namespace to ingest data into
+      sig { returns(String) }
+      attr_accessor :namespace
+
+      # Schema mapping field names to their definitions. Use content_type to specify
+      # which fields contain URLs that should be processed (images, videos, or
+      # websites), datetime fields, or 'metadata' for fields that should be stored but
+      # not indexed. Use display_hint to provide UI rendering hints.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[Symbol, SafetyKit::DataUpdateSettingsParams::Schema]
+          )
+        )
+      end
+      attr_reader :schema
+
+      sig do
+        params(
+          schema:
+            T::Hash[Symbol, SafetyKit::DataUpdateSettingsParams::Schema::OrHash]
+        ).void
+      end
+      attr_writer :schema
+
+      # Namespace settings to store, replacing existing settings. Omit to leave existing
+      # settings unchanged. Configure these values with guidance from SafetyKit.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
+      attr_reader :settings
+
+      sig { params(settings: T::Hash[Symbol, T.nilable(T.anything)]).void }
+      attr_writer :settings
+
+      sig do
+        params(
+          namespace: String,
+          schema:
+            T::Hash[
+              Symbol,
+              SafetyKit::DataUpdateSettingsParams::Schema::OrHash
+            ],
+          settings: T::Hash[Symbol, T.nilable(T.anything)],
+          request_options: SafetyKit::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The namespace to ingest data into
+        namespace:,
+        # Schema mapping field names to their definitions. Use content_type to specify
+        # which fields contain URLs that should be processed (images, videos, or
+        # websites), datetime fields, or 'metadata' for fields that should be stored but
+        # not indexed. Use display_hint to provide UI rendering hints.
+        schema: nil,
+        # Namespace settings to store, replacing existing settings. Omit to leave existing
+        # settings unchanged. Configure these values with guidance from SafetyKit.
+        settings: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            schema:
+              T::Hash[Symbol, SafetyKit::DataUpdateSettingsParams::Schema],
+            settings: T::Hash[Symbol, T.nilable(T.anything)],
+            request_options: SafetyKit::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Schema < SafetyKit::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SafetyKit::DataUpdateSettingsParams::Schema,
+              SafetyKit::Internal::AnyHash
+            )
+          end
+
+        # The parent object namespace this field belongs to, creating a parent-child
+        # relationship with that namespace.
+        sig { returns(T.nilable(String)) }
+        attr_reader :belongs_to
+
+        sig { params(belongs_to: String).void }
+        attr_writer :belongs_to
+
+        # The type of content (image_url, video_url, audio_url, website_url, datetime,
+        # metadata, markdown, or html). When specified as a URL type, SafetyKit will
+        # process the URL. Use 'metadata' for fields that should be stored but not
+        # indexed, and 'markdown' or 'html' for rich text.
+        sig do
+          returns(
+            T.nilable(
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol
+            )
+          )
+        end
+        attr_reader :content_type
+
+        sig do
+          params(
+            content_type:
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol
+          ).void
+        end
+        attr_writer :content_type
+
+        # Display hint for UI rendering of this field
+        sig do
+          returns(
+            T.nilable(SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint)
+          )
+        end
+        attr_reader :display_hint
+
+        sig do
+          params(
+            display_hint:
+              SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::OrHash
+          ).void
+        end
+        attr_writer :display_hint
+
+        # Maximum amount of this field to include when sending to AI models. For text
+        # fields, this is the character limit. For array fields (e.g. image URLs), this is
+        # the maximum number of items.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :field_limit
+
+        sig { params(field_limit: Integer).void }
+        attr_writer :field_limit
+
+        # Optional parser to apply before indexing this field.
+        sig do
+          returns(
+            T.nilable(
+              SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
+            )
+          )
+        end
+        attr_reader :ingest_as
+
+        sig do
+          params(
+            ingest_as:
+              SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
+          ).void
+        end
+        attr_writer :ingest_as
+
+        # Schema definition for a data field
+        sig do
+          params(
+            belongs_to: String,
+            content_type:
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol,
+            display_hint:
+              SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::OrHash,
+            field_limit: Integer,
+            ingest_as:
+              SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The parent object namespace this field belongs to, creating a parent-child
+          # relationship with that namespace.
+          belongs_to: nil,
+          # The type of content (image_url, video_url, audio_url, website_url, datetime,
+          # metadata, markdown, or html). When specified as a URL type, SafetyKit will
+          # process the URL. Use 'metadata' for fields that should be stored but not
+          # indexed, and 'markdown' or 'html' for rich text.
+          content_type: nil,
+          # Display hint for UI rendering of this field
+          display_hint: nil,
+          # Maximum amount of this field to include when sending to AI models. For text
+          # fields, this is the character limit. For array fields (e.g. image URLs), this is
+          # the maximum number of items.
+          field_limit: nil,
+          # Optional parser to apply before indexing this field.
+          ingest_as: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              belongs_to: String,
+              content_type:
+                SafetyKit::DataUpdateSettingsParams::Schema::ContentType::OrSymbol,
+              display_hint:
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint,
+              field_limit: Integer,
+              ingest_as:
+                SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of content (image_url, video_url, audio_url, website_url, datetime,
+        # metadata, markdown, or html). When specified as a URL type, SafetyKit will
+        # process the URL. Use 'metadata' for fields that should be stored but not
+        # indexed, and 'markdown' or 'html' for rich text.
+        module ContentType
+          extend SafetyKit::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SafetyKit::DataUpdateSettingsParams::Schema::ContentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMAGE_URL =
+            T.let(
+              :image_url,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          VIDEO_URL =
+            T.let(
+              :video_url,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          AUDIO_URL =
+            T.let(
+              :audio_url,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          WEBSITE_URL =
+            T.let(
+              :website_url,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          DATETIME =
+            T.let(
+              :datetime,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          METADATA =
+            T.let(
+              :metadata,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          MARKDOWN =
+            T.let(
+              :markdown,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+          HTML =
+            T.let(
+              :html,
+              SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SafetyKit::DataUpdateSettingsParams::Schema::ContentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class DisplayHint < SafetyKit::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint,
+                SafetyKit::Internal::AnyHash
+              )
+            end
+
+          # Hide this field from default UI display.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :hidden
+
+          sig { params(hidden: T::Boolean).void }
+          attr_writer :hidden
+
+          # Display label to show for this field in the UI
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # The display hint type
+          sig do
+            returns(
+              T.nilable(
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          # Display hint for UI rendering of this field
+          sig do
+            params(
+              hidden: T::Boolean,
+              name: String,
+              type:
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Hide this field from default UI display.
+            hidden: nil,
+            # Display label to show for this field in the UI
+            name: nil,
+            # The display hint type
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                hidden: T::Boolean,
+                name: String,
+                type:
+                  SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The display hint type
+          module Type
+            extend SafetyKit::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TITLE =
+              T.let(
+                :title,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            SUBTITLE =
+              T.let(
+                :subtitle,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            CATEGORY =
+              T.let(
+                :category,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            IDENTIFIER =
+              T.let(
+                :identifier,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            CANONICAL_URL =
+              T.let(
+                :canonical_url,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            STATUS =
+              T.let(
+                :status,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            PRIMARY_TAG_SET =
+              T.let(
+                :primary_tag_set,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            TAG_SET =
+              T.let(
+                :tag_set,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            TIMESTAMP =
+              T.let(
+                :timestamp,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            RATING =
+              T.let(
+                :rating,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            SUMMARY =
+              T.let(
+                :summary,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            PROFILE_IMAGE =
+              T.let(
+                :profile_image,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            PRIMARY_IMAGE =
+              T.let(
+                :primary_image,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            IMAGE_SET =
+              T.let(
+                :image_set,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            VIDEO_SET =
+              T.let(
+                :video_set,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            AUDIO_SET =
+              T.let(
+                :audio_set,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            BODY =
+              T.let(
+                :body,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            THREAD =
+              T.let(
+                :thread,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            TWO_PERSON_CHAT =
+              T.let(
+                :two_person_chat,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            MESSAGE =
+              T.let(
+                :message,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            PROFILE =
+              T.let(
+                :profile,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            MONEY =
+              T.let(
+                :money,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            LOCATION =
+              T.let(
+                :location,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            ATTRIBUTE_GROUP =
+              T.let(
+                :attribute_group,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            ATTRIBUTE =
+              T.let(
+                :attribute,
+                SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # Optional parser to apply before indexing this field.
+        module IngestAs
+          extend SafetyKit::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SafetyKit::DataUpdateSettingsParams::Schema::IngestAs
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FLOAT =
+            T.let(
+              :float,
+              SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
+            )
+          DATETIME =
+            T.let(
+              :datetime,
+              SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SafetyKit::DataUpdateSettingsParams::Schema::IngestAs::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/safety_kit/models/data_update_settings_response.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DataUpdateSettingsResponse < SafetyKit::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::Models::DataUpdateSettingsResponse,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :namespace
+
+      sig do
+        returns(
+          SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # Namespace configuration was stored.
+      sig do
+        params(
+          namespace: String,
+          status:
+            SafetyKit::Models::DataUpdateSettingsResponse::Status::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(namespace:, status:)
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            status:
+              SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, SafetyKit::Models::DataUpdateSettingsResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UPDATED =
+          T.let(
+            :updated,
+            SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SafetyKit::Models::DataUpdateSettingsResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/safety_kit/models.rbi

@@ -21,6 +21,8 @@ module SafetyKit
 
   DataObject = SafetyKit::Models::DataObject
 
+  DataUpdateSettingsParams = SafetyKit::Models::DataUpdateSettingsParams
+
   DeletionRequestCreateParams = SafetyKit::Models::DeletionRequestCreateParams
 
   StreamAddFrameParams = SafetyKit::Models::StreamAddFrameParams

data/rbi/safety_kit/resources/async.rbi

@@ -8,7 +8,12 @@ module SafetyKit
       # Beta. Queue backend events for asynchronous ingestion. This endpoint accepts the
       # same request body as POST /v1/events, writes one SQS message per event, and
       # returns after the events are queued. SafetyKit later processes the queued events
-      # through the standard event ingestion path.
+      # through the standard event ingestion path. Event strings support tab (U+0009),
+      # line feed (U+000A), carriage return (U+000D), and characters in the ranges
+      # U+0020–U+D7FF, U+E000–U+FFFD, and U+10000–U+10FFFF. The endpoint strips all
+      # other code points before queueing the event; clients should sanitize them before
+      # sending because they are unsupported and can cause errors in other ingestion
+      # paths.
       sig do
         params(
           body:

data/rbi/safety_kit/resources/data.rbi

@@ -82,6 +82,36 @@ module SafetyKit
       )
       end
 
+      # Update the schema and/or settings for a namespace. Only the fields provided are
+      # updated; omitted fields are left unchanged. Namespaces whose configuration is
+      # managed by SafetyKit cannot be updated through this endpoint.
+      sig do
+        params(
+          namespace: String,
+          schema:
+            T::Hash[
+              Symbol,
+              SafetyKit::DataUpdateSettingsParams::Schema::OrHash
+            ],
+          settings: T::Hash[Symbol, T.nilable(T.anything)],
+          request_options: SafetyKit::RequestOptions::OrHash
+        ).returns(SafetyKit::Models::DataUpdateSettingsResponse)
+      end
+      def update_settings(
+        # The namespace to ingest data into
+        namespace,
+        # Schema mapping field names to their definitions. Use content_type to specify
+        # which fields contain URLs that should be processed (images, videos, or
+        # websites), datetime fields, or 'metadata' for fields that should be stored but
+        # not indexed. Use display_hint to provide UI rendering hints.
+        schema: nil,
+        # Namespace settings to store, replacing existing settings. Omit to leave existing
+        # settings unchanged. Configure these values with guidance from SafetyKit.
+        settings: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SafetyKit::Client).returns(T.attached_class) }
       def self.new(client:)