safetykit 0.39.0 → 0.41.0

data/lib/safety_kit/models/data_update_settings_params.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#update_settings
+    class DataUpdateSettingsParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #   The namespace to ingest data into
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute schema
+      #   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.
+      #
+      #   @return [Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema}, nil]
+      optional :schema, -> { SafetyKit::Internal::Type::HashOf[SafetyKit::DataUpdateSettingsParams::Schema] }
+
+      # @!attribute settings
+      #   Namespace settings to store, replacing existing settings. Omit to leave existing
+      #   settings unchanged. Configure these values with guidance from SafetyKit.
+      #
+      #   @return [Hash{Symbol=>Object, nil}, nil]
+      optional :settings, SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::Unknown, nil?: true]
+
+      # @!method initialize(namespace:, schema: nil, settings: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataUpdateSettingsParams} for more details.
+      #
+      #   @param namespace [String] The namespace to ingest data into
+      #
+      #   @param schema [Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema}] Schema mapping field names to their definitions. Use content_type to specify whi
+      #
+      #   @param settings [Hash{Symbol=>Object, nil}] Namespace settings to store, replacing existing settings. Omit to leave existing
+      #
+      #   @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+
+      class Schema < SafetyKit::Internal::Type::BaseModel
+        # @!attribute belongs_to
+        #   The parent object namespace this field belongs to, creating a parent-child
+        #   relationship with that namespace.
+        #
+        #   @return [String, nil]
+        optional :belongs_to, String
+
+        # @!attribute content_type
+        #   The type of content (image_url, video_url, audio_url, website_url, datetime,
+        #   metadata, or card). When specified as a URL type, SafetyKit will process the
+        #   URL. Use 'metadata' for fields that should be stored but not indexed.
+        #
+        #   @return [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::ContentType, nil]
+        optional :content_type, enum: -> { SafetyKit::DataUpdateSettingsParams::Schema::ContentType }
+
+        # @!attribute display_hint
+        #   Display hint for UI rendering of this field
+        #
+        #   @return [SafetyKit::Models::DataUpdateSettingsParams::Schema::DisplayHint, nil]
+        optional :display_hint, -> { SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint }
+
+        # @!attribute field_limit
+        #   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.
+        #
+        #   @return [Integer, nil]
+        optional :field_limit, Integer
+
+        # @!attribute ingest_as
+        #   Optional parser to apply before indexing this field.
+        #
+        #   @return [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::IngestAs, nil]
+        optional :ingest_as, enum: -> { SafetyKit::DataUpdateSettingsParams::Schema::IngestAs }
+
+        # @!method initialize(belongs_to: nil, content_type: nil, display_hint: nil, field_limit: nil, ingest_as: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SafetyKit::Models::DataUpdateSettingsParams::Schema} for more details.
+        #
+        #   Schema definition for a data field
+        #
+        #   @param belongs_to [String] The parent object namespace this field belongs to, creating a parent-child relat
+        #
+        #   @param content_type [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::ContentType] The type of content (image_url, video_url, audio_url, website_url, datetime, met
+        #
+        #   @param display_hint [SafetyKit::Models::DataUpdateSettingsParams::Schema::DisplayHint] Display hint for UI rendering of this field
+        #
+        #   @param field_limit [Integer] Maximum amount of this field to include when sending to AI models. For text fiel
+        #
+        #   @param ingest_as [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::IngestAs] Optional parser to apply before indexing this field.
+
+        # The type of content (image_url, video_url, audio_url, website_url, datetime,
+        # metadata, or card). When specified as a URL type, SafetyKit will process the
+        # URL. Use 'metadata' for fields that should be stored but not indexed.
+        #
+        # @see SafetyKit::Models::DataUpdateSettingsParams::Schema#content_type
+        module ContentType
+          extend SafetyKit::Internal::Type::Enum
+
+          IMAGE_URL = :image_url
+          VIDEO_URL = :video_url
+          AUDIO_URL = :audio_url
+          WEBSITE_URL = :website_url
+          DATETIME = :datetime
+          METADATA = :metadata
+          CARD = :card
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see SafetyKit::Models::DataUpdateSettingsParams::Schema#display_hint
+        class DisplayHint < SafetyKit::Internal::Type::BaseModel
+          # @!attribute hidden
+          #   Hide this field from default UI display.
+          #
+          #   @return [Boolean, nil]
+          optional :hidden, SafetyKit::Internal::Type::Boolean
+
+          # @!attribute name
+          #   Display label to show for this field in the UI
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute type
+          #   The display hint type
+          #
+          #   @return [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::DisplayHint::Type, nil]
+          optional :type, enum: -> { SafetyKit::DataUpdateSettingsParams::Schema::DisplayHint::Type }
+
+          # @!method initialize(hidden: nil, name: nil, type: nil)
+          #   Display hint for UI rendering of this field
+          #
+          #   @param hidden [Boolean] Hide this field from default UI display.
+          #
+          #   @param name [String] Display label to show for this field in the UI
+          #
+          #   @param type [Symbol, SafetyKit::Models::DataUpdateSettingsParams::Schema::DisplayHint::Type] The display hint type
+
+          # The display hint type
+          #
+          # @see SafetyKit::Models::DataUpdateSettingsParams::Schema::DisplayHint#type
+          module Type
+            extend SafetyKit::Internal::Type::Enum
+
+            TITLE = :title
+            SUBTITLE = :subtitle
+            CATEGORY = :category
+            IDENTIFIER = :identifier
+            CANONICAL_URL = :canonical_url
+            STATUS = :status
+            PRIMARY_TAG_SET = :primary_tag_set
+            TAG_SET = :tag_set
+            TIMESTAMP = :timestamp
+            RATING = :rating
+            SUMMARY = :summary
+            PROFILE_IMAGE = :profile_image
+            PRIMARY_IMAGE = :primary_image
+            IMAGE_SET = :image_set
+            VIDEO_SET = :video_set
+            AUDIO_SET = :audio_set
+            BODY = :body
+            THREAD = :thread
+            TWO_PERSON_CHAT = :two_person_chat
+            MESSAGE = :message
+            PROFILE = :profile
+            MONEY = :money
+            LOCATION = :location
+            ATTRIBUTE_GROUP = :attribute_group
+            ATTRIBUTE = :attribute
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Optional parser to apply before indexing this field.
+        #
+        # @see SafetyKit::Models::DataUpdateSettingsParams::Schema#ingest_as
+        module IngestAs
+          extend SafetyKit::Internal::Type::Enum
+
+          FLOAT = :float
+          DATETIME = :datetime
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_update_settings_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#update_settings
+    class DataUpdateSettingsResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute namespace
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, SafetyKit::Models::DataUpdateSettingsResponse::Status]
+      required :status, enum: -> { SafetyKit::Models::DataUpdateSettingsResponse::Status }
+
+      # @!method initialize(namespace:, status:)
+      #   Namespace configuration was stored.
+      #
+      #   @param namespace [String]
+      #   @param status [Symbol, SafetyKit::Models::DataUpdateSettingsResponse::Status]
+
+      # @see SafetyKit::Models::DataUpdateSettingsResponse#status
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        UPDATED = :updated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/safety_kit/models.rb

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

data/lib/safety_kit/resources/async.rb

@@ -2,8 +2,8 @@
 
 module SafetyKit
   module Resources
-    # Beta. Send backend events for account, content, user interaction, report, and
-    # moderation activity.
+    # Beta. Send backend events for account, content, user interaction, report,
+    # appeal, and moderation activity.
     class Async
       # Some parameter documentations has been truncated, see
       # {SafetyKit::Models::AsyncCreateAsyncParams} for more details.
@@ -15,7 +15,7 @@ module SafetyKit
       #
       # @overload create_async(body:, request_options: {})
       #
-      # @param body [SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ContentUploadedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ProductChangedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::CreateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UpdateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserReportEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UserContact, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::UserReport, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember7::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
+      # @param body [SafetyKit::Models::AsyncCreateAsyncParams::Body::UserContactEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ContentUploadedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ProductChangedEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::CreateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UpdateAccountEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::UserReportEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::AppealEventRequest, SafetyKit::Models::AsyncCreateAsyncParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::UserContact, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::UserReport, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::Appeal, SafetyKit::Models::AsyncCreateAsyncParams::Body::UnionMember8::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
       #
       # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/safety_kit/resources/beta/events.rb

@@ -3,21 +3,21 @@
 module SafetyKit
   module Resources
     class Beta
-      # Beta. Send backend events for account, content, user interaction, report, and
-      # moderation activity.
+      # Beta. Send backend events for account, content, user interaction, report,
+      # appeal, and moderation activity.
       class Events
         # Some parameter documentations has been truncated, see
         # {SafetyKit::Models::Beta::EventCreateParams} for more details.
         #
         # Beta. Send a backend event after a meaningful product action happens in your
         # system. Use events for durable server-side context such as account creation,
-        # account updates, user-to-user contact, content uploads, user reports, and
-        # moderation decisions. Do not send browser pageviews, button clicks, or other
+        # account updates, user-to-user contact, content uploads, user reports, appeals,
+        # and moderation decisions. Do not send browser pageviews, button clicks, or other
         # client-only telemetry through this endpoint.
         #
         # @overload create(body:, request_options: {})
         #
-        # @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember7::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
+        # @param body [SafetyKit::Models::Beta::EventCreateParams::Body::UserContactEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploadedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ProductChangedEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccountEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::UserReportEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::AppealEventRequest, SafetyKit::Models::Beta::EventCreateParams::Body::ModerationDecisionEventRequest, Array<SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ProductChanged, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UpdateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::UserReport, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::Appeal, SafetyKit::Models::Beta::EventCreateParams::Body::UnionMember8::ModerationDecision>] Backend event or ordered batch of events to send to SafetyKit. Send events from
         #
         # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/safety_kit/resources/beta.rb

@@ -3,8 +3,8 @@
 module SafetyKit
   module Resources
     class Beta
-      # Beta. Send backend events for account, content, user interaction, report, and
-      # moderation activity.
+      # Beta. Send backend events for account, content, user interaction, report,
+      # appeal, and moderation activity.
       # @return [SafetyKit::Resources::Beta::Events]
       attr_reader :events
 

data/lib/safety_kit/resources/data.rb

@@ -113,6 +113,37 @@ module SafetyKit
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::DataUpdateSettingsParams} for more details.
+      #
+      # 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.
+      #
+      # @overload update_settings(namespace, schema: nil, settings: nil, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest data into
+      #
+      # @param schema [Hash{Symbol=>SafetyKit::Models::DataUpdateSettingsParams::Schema}] Schema mapping field names to their definitions. Use content_type to specify whi
+      #
+      # @param settings [Hash{Symbol=>Object, nil}] Namespace settings to store, replacing existing settings. Omit to leave existing
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DataUpdateSettingsResponse]
+      #
+      # @see SafetyKit::Models::DataUpdateSettingsParams
+      def update_settings(namespace, params = {})
+        parsed, options = SafetyKit::DataUpdateSettingsParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["v1/data/%1$s/settings", namespace],
+          body: parsed,
+          model: SafetyKit::Models::DataUpdateSettingsResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [SafetyKit::Client]

data/lib/safety_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafetyKit
-  VERSION = "0.39.0"
+  VERSION = "0.41.0"
 end

data/lib/safety_kit.rb

@@ -69,6 +69,8 @@ require_relative "safety_kit/models/data_get_download_url_response"
 require_relative "safety_kit/models/data_get_status_params"
 require_relative "safety_kit/models/data_get_status_response"
 require_relative "safety_kit/models/data_object"
+require_relative "safety_kit/models/data_update_settings_params"
+require_relative "safety_kit/models/data_update_settings_response"
 require_relative "safety_kit/models/deletion_request_create_params"
 require_relative "safety_kit/models/deletion_request_create_response"
 require_relative "safety_kit/models/stream_add_frame_params"

data/rbi/safety_kit/client.rbi

@@ -27,8 +27,8 @@ module SafetyKit
     sig { returns(SafetyKit::Resources::AgentDecisions) }
     attr_reader :agent_decisions
 
-    # Beta. Send backend events for account, content, user interaction, report, and
-    # moderation activity.
+    # Beta. Send backend events for account, content, user interaction, report,
+    # appeal, and moderation activity.
     sig { returns(SafetyKit::Resources::Async) }
     attr_reader :async