safetykit 0.5.0

data/lib/safety_kit/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < SafetyKit::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in SafetyKit::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, SafetyKit::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, SafetyKit::Internal::Type::HashOf[SafetyKit::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(SafetyKit::RequestOptions, SafetyKit::Internal::AnyHash) }
+    end
+  end
+end

data/lib/safety_kit/resources/agent_decisions.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    # Send human reviewer final verdicts to SafetyKit. This feedback improves the
+    # accuracy of SafetyKit's automated decisions over time.
+    class AgentDecisions
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::AgentDecisionCreateAgentDecisionParams} for more details.
+      #
+      # Record a human reviewer's final verdict for content that SafetyKit has
+      # previously reviewed. This ground truth feedback allows SafetyKit to improve the
+      # accuracy of automated decisions. Each call provides feedback on whether a given
+      # piece of content violates a specific policy category. If content is reviewed for
+      # multiple policies, send one call per policy.
+      #
+      # @overload create_agent_decision(content_type:, decision:, policy_id:, reference_id:, action: nil, comment: nil, request_options: {})
+      #
+      # @param content_type [String] The dataapi namespace of the content being reviewed
+      #
+      # @param decision [String] The human reviewer's verdict on whether the content violates the specified polic
+      #
+      # @param policy_id [String] The SafetyKit policy category ID that was evaluated, as configured for your acco
+      #
+      # @param reference_id [String] The external id for the content being reviewed
+      #
+      # @param action [String] The correct enforcement action for this content (e.g. 'reduce_visibility', 'unpu
+      #
+      # @param comment [String, nil] Additional context or details from the human reviewer
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::AgentDecisionCreateAgentDecisionResponse]
+      #
+      # @see SafetyKit::Models::AgentDecisionCreateAgentDecisionParams
+      def create_agent_decision(params)
+        parsed, options = SafetyKit::AgentDecisionCreateAgentDecisionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/agent_decisions",
+          body: parsed,
+          model: SafetyKit::Models::AgentDecisionCreateAgentDecisionResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SafetyKit::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    class Beta
+      # Beta. Send backend events for account, content, and user interaction 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, and content uploads. 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::UserContact, SafetyKit::Models::Beta::EventCreateParams::Body::ContentUploaded, SafetyKit::Models::Beta::EventCreateParams::Body::CreateAccount, SafetyKit::Models::Beta::EventCreateParams::Body::UpdateAccount] Backend event to send to SafetyKit. Send events from your server after an action
+        #
+        # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [SafetyKit::Models::Beta::EventCreateResponse]
+        #
+        # @see SafetyKit::Models::Beta::EventCreateParams
+        def create(params)
+          parsed, options = SafetyKit::Beta::EventCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/events",
+            body: parsed[:body],
+            model: SafetyKit::Models::Beta::EventCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [SafetyKit::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/safety_kit/resources/beta.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    class Beta
+      # Beta. Send backend events for account, content, and user interaction activity.
+      # @return [SafetyKit::Resources::Beta::Events]
+      attr_reader :events
+
+      # @api private
+      #
+      # @param client [SafetyKit::Client]
+      def initialize(client:)
+        @client = client
+        @events = SafetyKit::Resources::Beta::Events.new(client: client)
+      end
+    end
+  end
+end

data/lib/safety_kit/resources/client_sessions.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    # Create browser-safe webapp SDK session tokens from authenticated server-side
+    # code.
+    class ClientSessions
+      # Create a browser-safe SafetyKit webapp SDK session token from server-side code
+      # before rendering pages that load the browser SDK. The request must be
+      # authenticated with a valid Bearer token.
+      #
+      # @overload create_session(customer_session_hash: nil, customer_user_id: nil, request_options: {})
+      #
+      # @param customer_session_hash [String] Hashed customer browser session value associated with the browser SDK session.
+      #
+      # @param customer_user_id [String] Customer user identifier associated with the browser SDK session.
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::ClientSessionCreateSessionResponse]
+      #
+      # @see SafetyKit::Models::ClientSessionCreateSessionParams
+      def create_session(params = {})
+        parsed, options = SafetyKit::ClientSessionCreateSessionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/sessions",
+          body: parsed,
+          model: SafetyKit::Models::ClientSessionCreateSessionResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SafetyKit::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/safety_kit/resources/data.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    # Ingest data for fraud detection and risk analysis.
+    class Data
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::DataAddParams} for more details.
+      #
+      # Add data to a namespace, returning immediately. Processing happens
+      # asynchronously in the background.
+      #
+      # @overload add(namespace, data:, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest data into
+      #
+      # @param data [SafetyKit::Models::DataObject, Array<SafetyKit::Models::DataObject>] A data object to ingest. It must include an id field. All other fields are flexi
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DataAddResponse]
+      #
+      # @see SafetyKit::Models::DataAddParams
+      def add(namespace, params)
+        parsed, options = SafetyKit::DataAddParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/data/%1$s", namespace],
+          body: parsed,
+          model: SafetyKit::Models::DataAddResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::DataCreateUploadURLParams} for more details.
+      #
+      # Request a pre-signed upload URL for large JSONL batches into a namespace. After
+      # receiving `upload_url`, upload your JSONL file using `PUT {upload_url}` with
+      # header `Content-Type: application/json`; put each JSON object on a new line.
+      #
+      # @overload create_upload_url(namespace, schema: nil, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest data into
+      #
+      # @param schema [Hash{Symbol=>SafetyKit::Models::DataCreateUploadURLParams::Schema}] Schema mapping field names to their definitions. Use content_type to specify whi
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DataCreateUploadURLResponse]
+      #
+      # @see SafetyKit::Models::DataCreateUploadURLParams
+      def create_upload_url(namespace, params = {})
+        parsed, options = SafetyKit::DataCreateUploadURLParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/data/%1$s/requests/upload-url", namespace],
+          body: parsed,
+          model: SafetyKit::Models::DataCreateUploadURLResponse,
+          options: options
+        )
+      end
+
+      # Retrieve the status of a data ingestion request and, once complete, a temporary
+      # S3 URL for the full result file. This endpoint always uses the URL-based
+      # response shape regardless of request size.
+      #
+      # @overload get_download_url(request_id, namespace:, request_options: {})
+      #
+      # @param request_id [String] The request ID returned when the ingest request was created
+      #
+      # @param namespace [String] The namespace the data was ingested into
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DataGetDownloadURLResponse]
+      #
+      # @see SafetyKit::Models::DataGetDownloadURLParams
+      def get_download_url(request_id, params)
+        parsed, options = SafetyKit::DataGetDownloadURLParams.dump_request(params)
+        namespace =
+          parsed.delete(:namespace) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["v1/data/%1$s/requests/%2$s/results/download-url", namespace, request_id],
+          model: SafetyKit::Models::DataGetDownloadURLResponse,
+          options: options
+        )
+      end
+
+      # Retrieve the status of a data ingestion request and, once complete, return
+      # processed objects inline. If the processed output exceeds the 5 MiB inline
+      # response limit, this endpoint returns an error instructing you to use the
+      # download endpoint instead.
+      #
+      # @overload get_status(request_id, namespace:, request_options: {})
+      #
+      # @param request_id [String] The request ID returned when the ingest request was created
+      #
+      # @param namespace [String] The namespace the data was ingested into
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DataGetStatusResponse]
+      #
+      # @see SafetyKit::Models::DataGetStatusParams
+      def get_status(request_id, params)
+        parsed, options = SafetyKit::DataGetStatusParams.dump_request(params)
+        namespace =
+          parsed.delete(:namespace) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["v1/data/%1$s/requests/%2$s", namespace, request_id],
+          model: SafetyKit::Models::DataGetStatusResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::DataUpdateSettingsParams} for more details.
+      #
+      # Create or replace settings for a namespace, primarily used to change the schema
+      # associated with the namespace.
+      #
+      # @overload update_settings(namespace, schema:, 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 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]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/safety_kit/resources/streams.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    # Ingest and monitor livestream content.
+    class Streams
+      # Monitor the livestream at the given stream URL. This method returns immediately.
+      #
+      # @overload add(namespace, id:, stream_url:, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest stream data into
+      #
+      # @param id [String]
+      #
+      # @param stream_url [String]
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::StreamAddResponse]
+      #
+      # @see SafetyKit::Models::StreamAddParams
+      def add(namespace, params)
+        parsed, options = SafetyKit::StreamAddParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/streams/%1$s", namespace],
+          body: parsed,
+          model: SafetyKit::Models::StreamAddResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::StreamAddFrameParams} for more details.
+      #
+      # Ingest a single livestream frame as an image data URI plus relative timestamp in
+      # milliseconds. The stream does not need to be created beforehand. Only
+      # image/jpeg, image/png, and image/webp are accepted. The decoded bytes must match
+      # the declared mime type, decode as a valid image, stay within 5 MB, and stay
+      # within 4096x4096 / 16,000,000 total pixels. Timestamps are relative milliseconds
+      # from stream start and must be unique and strictly increasing within a stream.
+      # Duplicate or out-of-order frame timestamps are accepted at the API boundary but
+      # ignored by downstream processing. This method returns immediately after the
+      # frame has been accepted for processing.
+      #
+      # @overload add_frame(namespace, image_data_uri:, stream_id:, timestamp:, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest stream data into
+      #
+      # @param image_data_uri [String] A data URI containing a base64-encoded frame image. Only image/jpeg, image/png,
+      #
+      # @param stream_id [String]
+      #
+      # @param timestamp [Integer]
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::StreamAddFrameResponse]
+      #
+      # @see SafetyKit::Models::StreamAddFrameParams
+      def add_frame(namespace, params)
+        parsed, options = SafetyKit::StreamAddFrameParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/streams/%1$s/frames", namespace],
+          body: parsed,
+          model: SafetyKit::Models::StreamAddFrameResponse,
+          options: options
+        )
+      end
+
+      # Ingest a single transcript segment for a livestream using a relative timestamp
+      # in milliseconds. The stream does not need to be created beforehand. Transcript
+      # timestamps are relative milliseconds from stream start and should be
+      # monotonically increasing within a stream so transcript context lines up
+      # correctly with later frames. This method returns immediately after the
+      # transcript has been accepted for processing.
+      #
+      # @overload add_transcript(namespace, stream_id:, text:, timestamp:, request_options: {})
+      #
+      # @param namespace [String] The namespace to ingest stream data into
+      #
+      # @param stream_id [String]
+      #
+      # @param text [String]
+      #
+      # @param timestamp [Integer]
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::StreamAddTranscriptResponse]
+      #
+      # @see SafetyKit::Models::StreamAddTranscriptParams
+      def add_transcript(namespace, params)
+        parsed, options = SafetyKit::StreamAddTranscriptParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/streams/%1$s/transcripts", namespace],
+          body: parsed,
+          model: SafetyKit::Models::StreamAddTranscriptResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SafetyKit::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/safety_kit/version.rb

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

data/lib/safety_kit.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "safety_kit/version"
+require_relative "safety_kit/internal/util"
+require_relative "safety_kit/internal/type/converter"
+require_relative "safety_kit/internal/type/unknown"
+require_relative "safety_kit/internal/type/boolean"
+require_relative "safety_kit/internal/type/file_input"
+require_relative "safety_kit/internal/type/enum"
+require_relative "safety_kit/internal/type/union"
+require_relative "safety_kit/internal/type/array_of"
+require_relative "safety_kit/internal/type/hash_of"
+require_relative "safety_kit/internal/type/base_model"
+require_relative "safety_kit/internal/type/base_page"
+require_relative "safety_kit/internal/type/request_parameters"
+require_relative "safety_kit/internal"
+require_relative "safety_kit/request_options"
+require_relative "safety_kit/file_part"
+require_relative "safety_kit/errors"
+require_relative "safety_kit/internal/transport/base_client"
+require_relative "safety_kit/internal/transport/pooled_net_requester"
+require_relative "safety_kit/client"
+require_relative "safety_kit/models/agent_decision_create_agent_decision_params"
+require_relative "safety_kit/models/agent_decision_create_agent_decision_response"
+require_relative "safety_kit/models/beta/event_create_params"
+require_relative "safety_kit/models/beta/event_create_response"
+require_relative "safety_kit/models/client_session_create_session_params"
+require_relative "safety_kit/models/client_session_create_session_response"
+require_relative "safety_kit/models/data_add_params"
+require_relative "safety_kit/models/data_add_response"
+require_relative "safety_kit/models/data_create_upload_url_params"
+require_relative "safety_kit/models/data_create_upload_url_response"
+require_relative "safety_kit/models/data_get_download_url_params"
+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/stream_add_frame_params"
+require_relative "safety_kit/models/stream_add_frame_response"
+require_relative "safety_kit/models/stream_add_params"
+require_relative "safety_kit/models/stream_add_response"
+require_relative "safety_kit/models/stream_add_transcript_params"
+require_relative "safety_kit/models/stream_add_transcript_response"
+require_relative "safety_kit/models"
+require_relative "safety_kit/resources/agent_decisions"
+require_relative "safety_kit/resources/beta"
+require_relative "safety_kit/resources/beta/events"
+require_relative "safety_kit/resources/client_sessions"
+require_relative "safety_kit/resources/data"
+require_relative "safety_kit/resources/streams"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri