safetykit 0.5.0

data/rbi/safety_kit/models/data_create_upload_url_params.rbi

@@ -0,0 +1,473 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DataCreateUploadURLParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::DataCreateUploadURLParams,
+            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::DataCreateUploadURLParams::Schema]
+          )
+        )
+      end
+      attr_reader :schema
+
+      sig do
+        params(
+          schema:
+            T::Hash[
+              Symbol,
+              SafetyKit::DataCreateUploadURLParams::Schema::OrHash
+            ]
+        ).void
+      end
+      attr_writer :schema
+
+      sig do
+        params(
+          namespace: String,
+          schema:
+            T::Hash[
+              Symbol,
+              SafetyKit::DataCreateUploadURLParams::Schema::OrHash
+            ],
+          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,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            schema:
+              T::Hash[Symbol, SafetyKit::DataCreateUploadURLParams::Schema],
+            request_options: SafetyKit::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Schema < SafetyKit::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SafetyKit::DataCreateUploadURLParams::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, or card). When specified as a URL type, SafetyKit will process the
+        # URL. Use 'metadata' for fields that should be stored but not indexed.
+        sig do
+          returns(
+            T.nilable(
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol
+            )
+          )
+        end
+        attr_reader :content_type
+
+        sig do
+          params(
+            content_type:
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol
+          ).void
+        end
+        attr_writer :content_type
+
+        # Display hint for UI rendering of this field
+        sig do
+          returns(
+            T.nilable(SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint)
+          )
+        end
+        attr_reader :display_hint
+
+        sig do
+          params(
+            display_hint:
+              SafetyKit::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
+            )
+          )
+        end
+        attr_reader :ingest_as
+
+        sig do
+          params(
+            ingest_as:
+              SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
+          ).void
+        end
+        attr_writer :ingest_as
+
+        # Schema definition for a data field
+        sig do
+          params(
+            belongs_to: String,
+            content_type:
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::OrSymbol,
+            display_hint:
+              SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::OrHash,
+            field_limit: Integer,
+            ingest_as:
+              SafetyKit::DataCreateUploadURLParams::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, or card). When specified as a URL type, SafetyKit will process the
+          # URL. Use 'metadata' for fields that should be stored but not indexed.
+          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::DataCreateUploadURLParams::Schema::ContentType::OrSymbol,
+              display_hint:
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint,
+              field_limit: Integer,
+              ingest_as:
+                SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # 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.
+        module ContentType
+          extend SafetyKit::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SafetyKit::DataCreateUploadURLParams::Schema::ContentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMAGE_URL =
+            T.let(
+              :image_url,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          VIDEO_URL =
+            T.let(
+              :video_url,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          AUDIO_URL =
+            T.let(
+              :audio_url,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          WEBSITE_URL =
+            T.let(
+              :website_url,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          DATETIME =
+            T.let(
+              :datetime,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          METADATA =
+            T.let(
+              :metadata,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+          CARD =
+            T.let(
+              :card,
+              SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SafetyKit::DataCreateUploadURLParams::Schema::ContentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class DisplayHint < SafetyKit::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint,
+                SafetyKit::Internal::AnyHash
+              )
+            end
+
+          # 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
+
+          # Display ordering for this field. Use 0 to hide the field from list views.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :order
+
+          sig { params(order: Float).void }
+          attr_writer :order
+
+          # The display hint type
+          sig do
+            returns(
+              T.nilable(
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
+            ).void
+          end
+          attr_writer :type
+
+          # Display hint for UI rendering of this field
+          sig do
+            params(
+              name: String,
+              order: Float,
+              type:
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Display label to show for this field in the UI
+            name: nil,
+            # Display ordering for this field. Use 0 to hide the field from list views.
+            order: nil,
+            # The display hint type
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                order: Float,
+                type:
+                  SafetyKit::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema::DisplayHint::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TITLE =
+              T.let(
+                :title,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            SUBTITLE =
+              T.let(
+                :subtitle,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            DESCRIPTION =
+              T.let(
+                :description,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            PRIMARY_IMAGE_URL =
+              T.let(
+                :primary_image_url,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            VIDEO_URL =
+              T.let(
+                :video_url,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            AUDIO_URL =
+              T.let(
+                :audio_url,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            LOCATION =
+              T.let(
+                :location,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            DATE =
+              T.let(
+                :date,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            COMPACT_TEXT =
+              T.let(
+                :compact_text,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            MARKDOWN =
+              T.let(
+                :markdown,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            HTML =
+              T.let(
+                :html,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            CARD =
+              T.let(
+                :card,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            CHAT_THREAD =
+              T.let(
+                :chat_thread,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+            TWO_PERSON_CHAT =
+              T.let(
+                :two_person_chat,
+                SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SafetyKit::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema::IngestAs
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FLOAT =
+            T.let(
+              :float,
+              SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SafetyKit::DataCreateUploadURLParams::Schema::IngestAs::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/safety_kit/models/data_create_upload_url_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DataCreateUploadURLResponse < SafetyKit::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::Models::DataCreateUploadURLResponse,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      # ISO timestamp when upload_url expires (12 hours after issuance)
+      sig { returns(String) }
+      attr_accessor :expires_at
+
+      # S3 object key where uploaded JSONL will be processed from
+      sig { returns(String) }
+      attr_accessor :object_key
+
+      # Unique identifier for this upload request
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      # Request is waiting for file upload
+      sig do
+        returns(
+          SafetyKit::Models::DataCreateUploadURLResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # Pre-signed upload URL for PUT-ing JSONL content
+      # (`Content-Type: application/json`)
+      sig { returns(String) }
+      attr_accessor :upload_url
+
+      # Response containing an upload URL and metadata for large-batch file processing.
+      # Use `PUT {upload_url}` to upload JSONL (one JSON object per line). `upload_url`
+      # expires in 12 hours.
+      sig do
+        params(
+          expires_at: String,
+          object_key: String,
+          request_id: String,
+          status:
+            SafetyKit::Models::DataCreateUploadURLResponse::Status::OrSymbol,
+          upload_url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ISO timestamp when upload_url expires (12 hours after issuance)
+        expires_at:,
+        # S3 object key where uploaded JSONL will be processed from
+        object_key:,
+        # Unique identifier for this upload request
+        request_id:,
+        # Request is waiting for file upload
+        status:,
+        # Pre-signed upload URL for PUT-ing JSONL content
+        # (`Content-Type: application/json`)
+        upload_url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            expires_at: String,
+            object_key: String,
+            request_id: String,
+            status:
+              SafetyKit::Models::DataCreateUploadURLResponse::Status::TaggedSymbol,
+            upload_url: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Request is waiting for file upload
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              SafetyKit::Models::DataCreateUploadURLResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING_UPLOAD =
+          T.let(
+            :pending_upload,
+            SafetyKit::Models::DataCreateUploadURLResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SafetyKit::Models::DataCreateUploadURLResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/safety_kit/models/data_get_download_url_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DataGetDownloadURLParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::DataGetDownloadURLParams,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      # The namespace the data was ingested into
+      sig { returns(String) }
+      attr_accessor :namespace
+
+      # The request ID returned when the ingest request was created
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      sig do
+        params(
+          namespace: String,
+          request_id: String,
+          request_options: SafetyKit::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The namespace the data was ingested into
+        namespace:,
+        # The request ID returned when the ingest request was created
+        request_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            request_id: String,
+            request_options: SafetyKit::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end