safetykit 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f819aca3269f4f1499fd7b10867f686bd8354c5fbf43fbd9a9f7545b27f7b2
-  data.tar.gz: 6fbc567df4638a474141eabf05a660e3f80f2b9158991ab3d215ad3c55435272
+  metadata.gz: 21862bd4f80e389faddc02929382dc62964d79e9daa5699a358dcbd404f469c3
+  data.tar.gz: 4f2349fd9fe14c65f7c086938c2f2f7543fff3ec825028b25414b43bb15e4181
 SHA512:
-  metadata.gz: ec3b45060a879bfebd9f88c8236b93ca3766a60a088ca8e58ae3c5fba39a637df0133d45ba464eceb4214b6f19d885859e568830232a5b7df7418a47a2b2b2df
-  data.tar.gz: 9418ef5b149ab7188a60a840361ae24f4889c6154434d86c54309b56138d4b911d3d6167cee97825283fcdd777b85ffcb271d0b44813a7d2a7c9b61f9d7fbf4b
+  metadata.gz: 1f8e8bde186ea08048cdab9a569329130f39b9ddd05ca0c87ca2a4934159e66e5296167cd999a9ca4e1f74c19df02d7464344b1abf23e74d9f7e377ae74814cd
+  data.tar.gz: c4fe0bbb6998231f45b95eeb1978b151e288eb4031c40846c8df67508840a560217a0c03c2487a6a1fa2aef865c98aba607e76a35e6c7fa7f4a51cd7330ec2e4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.36.0 (2026-06-25)
+
+Full Changelog: [v0.35.0...v0.36.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.35.0...v0.36.0)
+
+### Features
+
+* **api:** api update ([8bc245c](https://github.com/GetSafetyKit/safetykit-ruby/commit/8bc245cb2efc03e09619ebf73746803ad25db4b5))
+
 ## 0.35.0 (2026-06-25)
 
 Full Changelog: [v0.34.0...v0.35.0](https://github.com/GetSafetyKit/safetykit-ruby/compare/v0.34.0...v0.35.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "safetykit", "~> 0.35.0"
+gem "safetykit", "~> 0.36.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/safety_kit/client.rb

@@ -37,6 +37,11 @@ module SafetyKit
     # @return [SafetyKit::Resources::Async]
     attr_reader :async
 
+    # Submit end-user deletion requests for integration testing before deletion
+    # processing is enabled.
+    # @return [SafetyKit::Resources::DeletionRequests]
+    attr_reader :deletion_requests
+
     # Beta. Create browser-safe Webapp SDK session tokens from authenticated
     # server-side code.
     # @return [SafetyKit::Resources::ClientSessions]
@@ -117,6 +122,7 @@ module SafetyKit
       @streams = SafetyKit::Resources::Streams.new(client: self)
       @agent_decisions = SafetyKit::Resources::AgentDecisions.new(client: self)
       @async = SafetyKit::Resources::Async.new(client: self)
+      @deletion_requests = SafetyKit::Resources::DeletionRequests.new(client: self)
       @client_sessions = SafetyKit::Resources::ClientSessions.new(client: self)
       @beta = SafetyKit::Resources::Beta.new(client: self)
     end

data/lib/safety_kit/models/deletion_request_create_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::DeletionRequests#create
+    class DeletionRequestCreateParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      # @!attribute subject_user_id
+      #   Your stable canonical identifier for the user or account whose data should be
+      #   deleted.
+      #
+      #   @return [String]
+      required :subject_user_id, String
+
+      # @!attribute external_request_id
+      #   Optional caller-provided request identifier for correlating the deletion request
+      #   in both systems.
+      #
+      #   @return [String, nil]
+      optional :external_request_id, String
+
+      # @!attribute requested_at
+      #   The time the deletion request was received in your system, as an ISO 8601
+      #   datetime string.
+      #
+      #   @return [Time, nil]
+      optional :requested_at, Time
+
+      # @!method initialize(subject_user_id:, external_request_id: nil, requested_at: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SafetyKit::Models::DeletionRequestCreateParams} for more details.
+      #
+      #   @param subject_user_id [String] Your stable canonical identifier for the user or account whose data should be de
+      #
+      #   @param external_request_id [String] Optional caller-provided request identifier for correlating the deletion request
+      #
+      #   @param requested_at [Time] The time the deletion request was received in your system, as an ISO 8601 dateti
+      #
+      #   @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/safety_kit/models/deletion_request_create_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Models
+    # @see SafetyKit::Resources::DeletionRequests#create
+    class DeletionRequestCreateResponse < SafetyKit::Internal::Type::BaseModel
+      # @!attribute deletion_request_id
+      #   SafetyKit correlation identifier for the logged deletion request.
+      #
+      #   @return [String]
+      required :deletion_request_id, String
+
+      # @!attribute status
+      #   Deletion request was accepted and logged.
+      #
+      #   @return [Symbol, SafetyKit::Models::DeletionRequestCreateResponse::Status]
+      required :status, enum: -> { SafetyKit::Models::DeletionRequestCreateResponse::Status }
+
+      # @!attribute external_request_id
+      #   Caller-provided request identifier, if supplied.
+      #
+      #   @return [String, nil]
+      optional :external_request_id, String
+
+      # @!method initialize(deletion_request_id:, status:, external_request_id: nil)
+      #   Response returned after SafetyKit accepts and logs a deletion request.
+      #
+      #   @param deletion_request_id [String] SafetyKit correlation identifier for the logged deletion request.
+      #
+      #   @param status [Symbol, SafetyKit::Models::DeletionRequestCreateResponse::Status] Deletion request was accepted and logged.
+      #
+      #   @param external_request_id [String] Caller-provided request identifier, if supplied.
+
+      # Deletion request was accepted and logged.
+      #
+      # @see SafetyKit::Models::DeletionRequestCreateResponse#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.rb

@@ -59,6 +59,8 @@ module SafetyKit
 
   DataUpdateSettingsParams = SafetyKit::Models::DataUpdateSettingsParams
 
+  DeletionRequestCreateParams = SafetyKit::Models::DeletionRequestCreateParams
+
   StreamAddFrameParams = SafetyKit::Models::StreamAddFrameParams
 
   StreamAddParams = SafetyKit::Models::StreamAddParams

data/lib/safety_kit/resources/deletion_requests.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SafetyKit
+  module Resources
+    # Submit end-user deletion requests for integration testing before deletion
+    # processing is enabled.
+    class DeletionRequests
+      # Some parameter documentations has been truncated, see
+      # {SafetyKit::Models::DeletionRequestCreateParams} for more details.
+      #
+      # Submit an end-user data deletion request for integration testing. SafetyKit
+      # validates and logs the request, but does not delete stored data yet.
+      #
+      # @overload create(subject_user_id:, external_request_id: nil, requested_at: nil, request_options: {})
+      #
+      # @param subject_user_id [String] Your stable canonical identifier for the user or account whose data should be de
+      #
+      # @param external_request_id [String] Optional caller-provided request identifier for correlating the deletion request
+      #
+      # @param requested_at [Time] The time the deletion request was received in your system, as an ISO 8601 dateti
+      #
+      # @param request_options [SafetyKit::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SafetyKit::Models::DeletionRequestCreateResponse]
+      #
+      # @see SafetyKit::Models::DeletionRequestCreateParams
+      def create(params)
+        parsed, options = SafetyKit::DeletionRequestCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/deletion_requests",
+          body: parsed,
+          model: SafetyKit::Models::DeletionRequestCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SafetyKit::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/safety_kit/version.rb

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

data/lib/safety_kit.rb

@@ -71,6 +71,8 @@ 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"
 require_relative "safety_kit/models/stream_add_frame_response"
 require_relative "safety_kit/models/stream_add_params"
@@ -84,4 +86,5 @@ 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/deletion_requests"
 require_relative "safety_kit/resources/streams"

data/rbi/safety_kit/client.rbi

@@ -32,6 +32,11 @@ module SafetyKit
     sig { returns(SafetyKit::Resources::Async) }
     attr_reader :async
 
+    # Submit end-user deletion requests for integration testing before deletion
+    # processing is enabled.
+    sig { returns(SafetyKit::Resources::DeletionRequests) }
+    attr_reader :deletion_requests
+
     # Beta. Create browser-safe Webapp SDK session tokens from authenticated
     # server-side code.
     sig { returns(SafetyKit::Resources::ClientSessions) }

data/rbi/safety_kit/models/deletion_request_create_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DeletionRequestCreateParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::DeletionRequestCreateParams,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      # Your stable canonical identifier for the user or account whose data should be
+      # deleted.
+      sig { returns(String) }
+      attr_accessor :subject_user_id
+
+      # Optional caller-provided request identifier for correlating the deletion request
+      # in both systems.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_request_id
+
+      sig { params(external_request_id: String).void }
+      attr_writer :external_request_id
+
+      # The time the deletion request was received in your system, as an ISO 8601
+      # datetime string.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :requested_at
+
+      sig { params(requested_at: Time).void }
+      attr_writer :requested_at
+
+      sig do
+        params(
+          subject_user_id: String,
+          external_request_id: String,
+          requested_at: Time,
+          request_options: SafetyKit::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Your stable canonical identifier for the user or account whose data should be
+        # deleted.
+        subject_user_id:,
+        # Optional caller-provided request identifier for correlating the deletion request
+        # in both systems.
+        external_request_id: nil,
+        # The time the deletion request was received in your system, as an ISO 8601
+        # datetime string.
+        requested_at: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            subject_user_id: String,
+            external_request_id: String,
+            requested_at: Time,
+            request_options: SafetyKit::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/safety_kit/models/deletion_request_create_response.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module SafetyKit
+  module Models
+    class DeletionRequestCreateResponse < SafetyKit::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SafetyKit::Models::DeletionRequestCreateResponse,
+            SafetyKit::Internal::AnyHash
+          )
+        end
+
+      # SafetyKit correlation identifier for the logged deletion request.
+      sig { returns(String) }
+      attr_accessor :deletion_request_id
+
+      # Deletion request was accepted and logged.
+      sig do
+        returns(
+          SafetyKit::Models::DeletionRequestCreateResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # Caller-provided request identifier, if supplied.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_request_id
+
+      sig { params(external_request_id: String).void }
+      attr_writer :external_request_id
+
+      # Response returned after SafetyKit accepts and logs a deletion request.
+      sig do
+        params(
+          deletion_request_id: String,
+          status:
+            SafetyKit::Models::DeletionRequestCreateResponse::Status::OrSymbol,
+          external_request_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # SafetyKit correlation identifier for the logged deletion request.
+        deletion_request_id:,
+        # Deletion request was accepted and logged.
+        status:,
+        # Caller-provided request identifier, if supplied.
+        external_request_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            deletion_request_id: String,
+            status:
+              SafetyKit::Models::DeletionRequestCreateResponse::Status::TaggedSymbol,
+            external_request_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Deletion request was accepted and logged.
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              SafetyKit::Models::DeletionRequestCreateResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCEPTED =
+          T.let(
+            :accepted,
+            SafetyKit::Models::DeletionRequestCreateResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              SafetyKit::Models::DeletionRequestCreateResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/safety_kit/models.rbi

@@ -23,6 +23,8 @@ module SafetyKit
 
   DataUpdateSettingsParams = SafetyKit::Models::DataUpdateSettingsParams
 
+  DeletionRequestCreateParams = SafetyKit::Models::DeletionRequestCreateParams
+
   StreamAddFrameParams = SafetyKit::Models::StreamAddFrameParams
 
   StreamAddParams = SafetyKit::Models::StreamAddParams

data/rbi/safety_kit/resources/deletion_requests.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module SafetyKit
+  module Resources
+    # Submit end-user deletion requests for integration testing before deletion
+    # processing is enabled.
+    class DeletionRequests
+      # Submit an end-user data deletion request for integration testing. SafetyKit
+      # validates and logs the request, but does not delete stored data yet.
+      sig do
+        params(
+          subject_user_id: String,
+          external_request_id: String,
+          requested_at: Time,
+          request_options: SafetyKit::RequestOptions::OrHash
+        ).returns(SafetyKit::Models::DeletionRequestCreateResponse)
+      end
+      def create(
+        # Your stable canonical identifier for the user or account whose data should be
+        # deleted.
+        subject_user_id:,
+        # Optional caller-provided request identifier for correlating the deletion request
+        # in both systems.
+        external_request_id: nil,
+        # The time the deletion request was received in your system, as an ISO 8601
+        # datetime string.
+        requested_at: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SafetyKit::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/safety_kit/client.rbs

@@ -18,6 +18,8 @@ module SafetyKit
 
     attr_reader async: SafetyKit::Resources::Async
 
+    attr_reader deletion_requests: SafetyKit::Resources::DeletionRequests
+
     attr_reader client_sessions: SafetyKit::Resources::ClientSessions
 
     attr_reader beta: SafetyKit::Resources::Beta

data/sig/safety_kit/models/deletion_request_create_params.rbs

@@ -0,0 +1,40 @@
+module SafetyKit
+  module Models
+    type deletion_request_create_params =
+      {
+        subject_user_id: String,
+        external_request_id: String,
+        requested_at: Time
+      }
+      & SafetyKit::Internal::Type::request_parameters
+
+    class DeletionRequestCreateParams < SafetyKit::Internal::Type::BaseModel
+      extend SafetyKit::Internal::Type::RequestParameters::Converter
+      include SafetyKit::Internal::Type::RequestParameters
+
+      attr_accessor subject_user_id: String
+
+      attr_reader external_request_id: String?
+
+      def external_request_id=: (String) -> String
+
+      attr_reader requested_at: Time?
+
+      def requested_at=: (Time) -> Time
+
+      def initialize: (
+        subject_user_id: String,
+        ?external_request_id: String,
+        ?requested_at: Time,
+        ?request_options: SafetyKit::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        subject_user_id: String,
+        external_request_id: String,
+        requested_at: Time,
+        request_options: SafetyKit::RequestOptions
+      }
+    end
+  end
+end

data/sig/safety_kit/models/deletion_request_create_response.rbs

@@ -0,0 +1,42 @@
+module SafetyKit
+  module Models
+    type deletion_request_create_response =
+      {
+        deletion_request_id: String,
+        status: SafetyKit::Models::DeletionRequestCreateResponse::status,
+        external_request_id: String
+      }
+
+    class DeletionRequestCreateResponse < SafetyKit::Internal::Type::BaseModel
+      attr_accessor deletion_request_id: String
+
+      attr_accessor status: SafetyKit::Models::DeletionRequestCreateResponse::status
+
+      attr_reader external_request_id: String?
+
+      def external_request_id=: (String) -> String
+
+      def initialize: (
+        deletion_request_id: String,
+        status: SafetyKit::Models::DeletionRequestCreateResponse::status,
+        ?external_request_id: String
+      ) -> void
+
+      def to_hash: -> {
+        deletion_request_id: String,
+        status: SafetyKit::Models::DeletionRequestCreateResponse::status,
+        external_request_id: String
+      }
+
+      type status = :accepted
+
+      module Status
+        extend SafetyKit::Internal::Type::Enum
+
+        ACCEPTED: :accepted
+
+        def self?.values: -> ::Array[SafetyKit::Models::DeletionRequestCreateResponse::status]
+      end
+    end
+  end
+end

data/sig/safety_kit/models.rbs

@@ -19,6 +19,8 @@ module SafetyKit
 
   class DataUpdateSettingsParams = SafetyKit::Models::DataUpdateSettingsParams
 
+  class DeletionRequestCreateParams = SafetyKit::Models::DeletionRequestCreateParams
+
   class StreamAddFrameParams = SafetyKit::Models::StreamAddFrameParams
 
   class StreamAddParams = SafetyKit::Models::StreamAddParams

data/sig/safety_kit/resources/deletion_requests.rbs

@@ -0,0 +1,14 @@
+module SafetyKit
+  module Resources
+    class DeletionRequests
+      def create: (
+        subject_user_id: String,
+        ?external_request_id: String,
+        ?requested_at: Time,
+        ?request_options: SafetyKit::request_opts
+      ) -> SafetyKit::Models::DeletionRequestCreateResponse
+
+      def initialize: (client: SafetyKit::Client) -> void
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safetykit
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Safetykit
@@ -88,6 +88,8 @@ files:
 - lib/safety_kit/models/data_object.rb
 - lib/safety_kit/models/data_update_settings_params.rb
 - lib/safety_kit/models/data_update_settings_response.rb
+- lib/safety_kit/models/deletion_request_create_params.rb
+- lib/safety_kit/models/deletion_request_create_response.rb
 - lib/safety_kit/models/stream_add_frame_params.rb
 - lib/safety_kit/models/stream_add_frame_response.rb
 - lib/safety_kit/models/stream_add_params.rb
@@ -101,6 +103,7 @@ files:
 - lib/safety_kit/resources/beta/events.rb
 - lib/safety_kit/resources/client_sessions.rb
 - lib/safety_kit/resources/data.rb
+- lib/safety_kit/resources/deletion_requests.rb
 - lib/safety_kit/resources/streams.rb
 - lib/safety_kit/version.rb
 - manifest.yaml
@@ -142,6 +145,8 @@ files:
 - rbi/safety_kit/models/data_object.rbi
 - rbi/safety_kit/models/data_update_settings_params.rbi
 - rbi/safety_kit/models/data_update_settings_response.rbi
+- rbi/safety_kit/models/deletion_request_create_params.rbi
+- rbi/safety_kit/models/deletion_request_create_response.rbi
 - rbi/safety_kit/models/stream_add_frame_params.rbi
 - rbi/safety_kit/models/stream_add_frame_response.rbi
 - rbi/safety_kit/models/stream_add_params.rbi
@@ -155,6 +160,7 @@ files:
 - rbi/safety_kit/resources/beta/events.rbi
 - rbi/safety_kit/resources/client_sessions.rbi
 - rbi/safety_kit/resources/data.rbi
+- rbi/safety_kit/resources/deletion_requests.rbi
 - rbi/safety_kit/resources/streams.rbi
 - rbi/safety_kit/version.rbi
 - sig/safety_kit/client.rbs
@@ -195,6 +201,8 @@ files:
 - sig/safety_kit/models/data_object.rbs
 - sig/safety_kit/models/data_update_settings_params.rbs
 - sig/safety_kit/models/data_update_settings_response.rbs
+- sig/safety_kit/models/deletion_request_create_params.rbs
+- sig/safety_kit/models/deletion_request_create_response.rbs
 - sig/safety_kit/models/stream_add_frame_params.rbs
 - sig/safety_kit/models/stream_add_frame_response.rbs
 - sig/safety_kit/models/stream_add_params.rbs
@@ -208,6 +216,7 @@ files:
 - sig/safety_kit/resources/beta/events.rbs
 - sig/safety_kit/resources/client_sessions.rbs
 - sig/safety_kit/resources/data.rbs
+- sig/safety_kit/resources/deletion_requests.rbs
 - sig/safety_kit/resources/streams.rbs
 - sig/safety_kit/version.rbs
 homepage: https://gemdocs.org/gems/safetykit