safetykit 0.5.0

data/lib/safety_kit/models/beta/event_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    module Beta
+      # @see SafetyKit::Resources::Beta::Events#create
+      class EventCreateResponse < SafetyKit::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   SafetyKit identifier for the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute status
+        #   Event was accepted.
+        #
+        #   @return [Symbol, SafetyKit::Models::Beta::EventCreateResponse::Status]
+        required :status, enum: -> { SafetyKit::Models::Beta::EventCreateResponse::Status }
+
+        # @!method initialize(event_id:, status:)
+        #   Response returned after SafetyKit accepts an event.
+        #
+        #   @param event_id [String] SafetyKit identifier for the event.
+        #
+        #   @param status [Symbol, SafetyKit::Models::Beta::EventCreateResponse::Status] Event was accepted.
+
+        # Event was accepted.
+        #
+        # @see SafetyKit::Models::Beta::EventCreateResponse#status
+        module Status
+          extend SafetyKit::Internal::Type::Enum
+
+          OK = :ok
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/safety_kit/models/client_session_create_session_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::ClientSessions#create_session
+    class ClientSessionCreateSessionParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      # @!attribute customer_session_hash
+      #   Hashed customer browser session value associated with the browser SDK session.
+      #
+      #   @return [String, nil]
+      optional :customer_session_hash, String
+
+      # @!attribute customer_user_id
+      #   Customer user identifier associated with the browser SDK session.
+      #
+      #   @return [String, nil]
+      optional :customer_user_id, String
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/safety_kit/models/client_session_create_session_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::ClientSessions#create_session
+    class ClientSessionCreateSessionResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute session_token
+      #   Browser-safe webapp SDK session token to pass to the browser SDK.
+      #
+      #   @return [String]
+      required :session_token, String
+
+      # @!method initialize(session_token:)
+      #   Response containing the browser-safe webapp SDK session token.
+      #
+      #   @param session_token [String] Browser-safe webapp SDK session token to pass to the browser SDK.
+    end
+  end
+end

data/lib/safety_kit/models/data_add_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#add
+    class DataAddParams < 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 data
+      #   A data object to ingest. It must include an id field. All other fields are
+      #   flexible and can be any JSON type.
+      #
+      #   @return [SafetyKit::Models::DataObject, Array<SafetyKit::Models::DataObject>]
+      required :data, union: -> { SafetyKit::DataAddParams::Data }
+
+      # @!method initialize(namespace:, data:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataAddParams} for more details.
+      #
+      #   @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}]
+
+      # A data object to ingest. It must include an id field. All other fields are
+      # flexible and can be any JSON type.
+      module Data
+        extend SafetyKit::Internal::Type::Union
+
+        # A data object to ingest. It must include an id field. All other fields are flexible and can be any JSON type.
+        variant -> { SafetyKit::DataObject }
+
+        # Array of data objects to ingest.
+        variant -> { SafetyKit::Models::DataAddParams::Data::DataObjectArray }
+
+        # @!method self.variants
+        #   @return [Array(SafetyKit::Models::DataObject, Array<SafetyKit::Models::DataObject>)]
+
+        # @type [SafetyKit::Internal::Type::Converter]
+        DataObjectArray = SafetyKit::Internal::Type::ArrayOf[-> { SafetyKit::DataObject }]
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_add_response.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#add
+    class DataAddResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique identifier for tracking this request. Data processing happens
+      #   asynchronously after this response.
+      #
+      #   @return [String]
+      required :request_id, String, api_name: :requestId
+
+      # @!attribute status
+      #   Request was accepted for processing
+      #
+      #   @return [Symbol, SafetyKit::Models::DataAddResponse::Status]
+      required :status, enum: -> { SafetyKit::Models::DataAddResponse::Status }
+
+      # @!method initialize(request_id:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataAddResponse} for more details.
+      #
+      #   Response confirming data was accepted for asynchronous processing. The requestId
+      #   can be used for debugging and tracking.
+      #
+      #   @param request_id [String] Unique identifier for tracking this request. Data processing happens asynchronou
+      #
+      #   @param status [Symbol, SafetyKit::Models::DataAddResponse::Status] Request was accepted for processing
+
+      # Request was accepted for processing
+      #
+      # @see SafetyKit::Models::DataAddResponse#status
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        ACCEPTED = :accepted
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_create_upload_url_params.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#create_upload_url
+    class DataCreateUploadURLParams < 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::DataCreateUploadURLParams::Schema}, nil]
+      optional :schema, -> { SafetyKit::Internal::Type::HashOf[SafetyKit::DataCreateUploadURLParams::Schema] }
+
+      # @!method initialize(namespace:, schema: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataCreateUploadURLParams} for more details.
+      #
+      #   @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}]
+
+      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::DataCreateUploadURLParams::Schema::ContentType, nil]
+        optional :content_type, enum: -> { SafetyKit::DataCreateUploadURLParams::Schema::ContentType }
+
+        # @!attribute display_hint
+        #   Display hint for UI rendering of this field
+        #
+        #   @return [SafetyKit::Models::DataCreateUploadURLParams::Schema::DisplayHint, nil]
+        optional :display_hint, -> { SafetyKit::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema::IngestAs, nil]
+        optional :ingest_as, enum: -> { SafetyKit::DataCreateUploadURLParams::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::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema::ContentType] The type of content (image_url, video_url, audio_url, website_url, datetime, met
+        #
+        #   @param display_hint [SafetyKit::Models::DataCreateUploadURLParams::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::DataCreateUploadURLParams::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::DataCreateUploadURLParams::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::DataCreateUploadURLParams::Schema#display_hint
+        class DisplayHint < SafetyKit::Internal::Type::BaseModel
+          # @!attribute name
+          #   Display label to show for this field in the UI
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute order
+          #   Display ordering for this field. Use 0 to hide the field from list views.
+          #
+          #   @return [Float, nil]
+          optional :order, Float
+
+          # @!attribute type
+          #   The display hint type
+          #
+          #   @return [Symbol, SafetyKit::Models::DataCreateUploadURLParams::Schema::DisplayHint::Type, nil]
+          optional :type, enum: -> { SafetyKit::DataCreateUploadURLParams::Schema::DisplayHint::Type }
+
+          # @!method initialize(name: nil, order: nil, type: nil)
+          #   Display hint for UI rendering of this field
+          #
+          #   @param name [String] Display label to show for this field in the UI
+          #
+          #   @param order [Float] Display ordering for this field. Use 0 to hide the field from list views.
+          #
+          #   @param type [Symbol, SafetyKit::Models::DataCreateUploadURLParams::Schema::DisplayHint::Type] The display hint type
+
+          # The display hint type
+          #
+          # @see SafetyKit::Models::DataCreateUploadURLParams::Schema::DisplayHint#type
+          module Type
+            extend SafetyKit::Internal::Type::Enum
+
+            TITLE = :title
+            SUBTITLE = :subtitle
+            DESCRIPTION = :description
+            PRIMARY_IMAGE_URL = :primary_image_url
+            VIDEO_URL = :video_url
+            AUDIO_URL = :audio_url
+            LOCATION = :location
+            DATE = :date
+            COMPACT_TEXT = :compact_text
+            MARKDOWN = :markdown
+            HTML = :html
+            CARD = :card
+            CHAT_THREAD = :chat_thread
+            TWO_PERSON_CHAT = :two_person_chat
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Optional parser to apply before indexing this field.
+        #
+        # @see SafetyKit::Models::DataCreateUploadURLParams::Schema#ingest_as
+        module IngestAs
+          extend SafetyKit::Internal::Type::Enum
+
+          FLOAT = :float
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_create_upload_url_response.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#create_upload_url
+    class DataCreateUploadURLResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute expires_at
+      #   ISO timestamp when upload_url expires (12 hours after issuance)
+      #
+      #   @return [String]
+      required :expires_at, String
+
+      # @!attribute object_key
+      #   S3 object key where uploaded JSONL will be processed from
+      #
+      #   @return [String]
+      required :object_key, String, api_name: :objectKey
+
+      # @!attribute request_id
+      #   Unique identifier for this upload request
+      #
+      #   @return [String]
+      required :request_id, String, api_name: :requestId
+
+      # @!attribute status
+      #   Request is waiting for file upload
+      #
+      #   @return [Symbol, SafetyKit::Models::DataCreateUploadURLResponse::Status]
+      required :status, enum: -> { SafetyKit::Models::DataCreateUploadURLResponse::Status }
+
+      # @!attribute upload_url
+      #   Pre-signed upload URL for PUT-ing JSONL content
+      #   (`Content-Type: application/json`)
+      #
+      #   @return [String]
+      required :upload_url, String
+
+      # @!method initialize(expires_at:, object_key:, request_id:, status:, upload_url:)
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataCreateUploadURLResponse} for more details.
+      #
+      #   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.
+      #
+      #   @param expires_at [String] ISO timestamp when upload_url expires (12 hours after issuance)
+      #
+      #   @param object_key [String] S3 object key where uploaded JSONL will be processed from
+      #
+      #   @param request_id [String] Unique identifier for this upload request
+      #
+      #   @param status [Symbol, SafetyKit::Models::DataCreateUploadURLResponse::Status] Request is waiting for file upload
+      #
+      #   @param upload_url [String] Pre-signed upload URL for PUT-ing JSONL content (`Content-Type: application/json
+
+      # Request is waiting for file upload
+      #
+      # @see SafetyKit::Models::DataCreateUploadURLResponse#status
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        PENDING_UPLOAD = :pending_upload
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_get_download_url_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#get_download_url
+    class DataGetDownloadURLParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #   The namespace the data was ingested into
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute request_id
+      #   The request ID returned when the ingest request was created
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!method initialize(namespace:, request_id:, request_options: {})
+      #   @param namespace [String] The namespace the data was ingested into
+      #
+      #   @param request_id [String] The request ID returned when the ingest request was created
+      #
+      #   @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/safety_kit/models/data_get_download_url_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#get_download_url
+    class DataGetDownloadURLResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute data_count
+      #   Number of processed objects in the request. Null until the request has
+      #   succeeded.
+      #
+      #   @return [Integer, nil]
+      required :data_count, Integer, nil?: true
+
+      # @!attribute data_expires_at
+      #   ISO timestamp when `data_url` expires. Null until the request has succeeded.
+      #
+      #   @return [String, nil]
+      required :data_expires_at, String, nil?: true
+
+      # @!attribute data_url
+      #   Temporary S3 URL for the full request result. Null until the request has
+      #   succeeded.
+      #
+      #   @return [String, nil]
+      required :data_url, String, nil?: true
+
+      # @!attribute namespace
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute request_id
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!attribute status
+      #   Current processing status of the request
+      #
+      #   @return [Symbol, SafetyKit::Models::DataGetDownloadURLResponse::Status]
+      required :status, enum: -> { SafetyKit::Models::DataGetDownloadURLResponse::Status }
+
+      # @!method initialize(data_count:, data_expires_at:, data_url:, namespace:, request_id:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DataGetDownloadURLResponse} for more details.
+      #
+      #   Response containing request status and a temporary S3 URL for the full request
+      #   result. The shape is stable across all request sizes; before processing
+      #   completes, the download fields are null.
+      #
+      #   @param data_count [Integer, nil] Number of processed objects in the request. Null until the request has succeeded
+      #
+      #   @param data_expires_at [String, nil] ISO timestamp when `data_url` expires. Null until the request has succeeded.
+      #
+      #   @param data_url [String, nil] Temporary S3 URL for the full request result. Null until the request has succeed
+      #
+      #   @param namespace [String]
+      #
+      #   @param request_id [String]
+      #
+      #   @param status [Symbol, SafetyKit::Models::DataGetDownloadURLResponse::Status] Current processing status of the request
+
+      # Current processing status of the request
+      #
+      # @see SafetyKit::Models::DataGetDownloadURLResponse#status
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        QUEUED = :queued
+        UPLOADING = :uploading
+        INGESTING = :ingesting
+        SUCCEEDED = :succeeded
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/safety_kit/models/data_get_status_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::Data#get_status
+    class DataGetStatusParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #   The namespace the data was ingested into
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute request_id
+      #   The request ID returned when the ingest request was created
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!method initialize(namespace:, request_id:, request_options: {})
+      #   @param namespace [String] The namespace the data was ingested into
+      #
+      #   @param request_id [String] The request ID returned when the ingest request was created
+      #
+      #   @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end