surge_api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da7c01aaa992d5a9324e6a320821c240261535e5c85ef840624e00e82ff3a722
-  data.tar.gz: 1219ffe72345fb81de26f7f7be3c6a05d11d790de928bb8e3821c59ca837ad86
+  metadata.gz: 6419099e30ee4893563ecd9e9fd2e4707dedf5af633e5972d25b0848228deef9
+  data.tar.gz: 1c60adc5936f072f87f8b534f26a4cab6bf3a34ea5d48428675c8cfea4da6159
 SHA512:
-  metadata.gz: 44b3bd94a28e639bdae0131f72893b3e0fbbccc4ef11eaef833cd4214d167879bbbdb36ab964ce991c07d8cf844b2a59225c1a2e4afd231ac1045472e6c5f2b0
-  data.tar.gz: aeba66370a29d5bc640f998625e6bde7e3a040f9579a24253442d434d9b671fa1f46d42c84afb07913958d696836e89a226ab2a989585ec90fc156150e45bbb2
+  metadata.gz: 3bcb5e868464704dad067a2a1e5b36a695689c3adf03e7b8e5978b2469dbe69bf2da75d7a4b0d6ad1613357a991e5a0f57e3110a95afc20eae0df4a7cc0ac751
+  data.tar.gz: 95e41f79bf6d869ac3201c21f15c1ceb7514d2d2e35c5172cba0e5db199bd1817300c9eea8d2050ad3493f08b2ecade4288c6c6b8907f53309cff1baf2001f65

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.0 (2026-01-15)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/surgeapi/ruby-sdk/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** add delete user endpoint ([424ea71](https://github.com/surgeapi/ruby-sdk/commit/424ea7107c3039b175ccdc6066d04dec9d094dfd))
+
 ## 0.4.0 (2026-01-10)
 
 Full Changelog: [v0.3.0...v0.4.0](https://github.com/surgeapi/ruby-sdk/compare/v0.3.0...v0.4.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 "surge_api", "~> 0.4.0"
+gem "surge_api", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/user_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Users#delete
+    class UserDeleteParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -111,6 +111,8 @@ module SurgeAPI
 
   UserCreateTokenParams = SurgeAPI::Models::UserCreateTokenParams
 
+  UserDeleteParams = SurgeAPI::Models::UserDeleteParams
+
   UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
 
   UserTokenResponse = SurgeAPI::Models::UserTokenResponse

data/lib/surge_api/resources/users.rb

@@ -83,6 +83,30 @@ module SurgeAPI
         )
       end
 
+      # Deletes a user.
+      #
+      # Once a user has been deleted, they will no longer be permitted to access any of
+      # the embedded components. Attempting to access a deleted user will return a 404
+      # Not Found error.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the user to delete.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::User]
+      #
+      # @see SurgeAPI::Models::UserDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["users/%1$s", id],
+          model: SurgeAPI::User,
+          options: params[:request_options]
+        )
+      end
+
       # Provides a mechanism for having Surge create a signed token for embeds instead
       # of signing with your own signing key.
       #

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -88,6 +88,7 @@ require_relative "surge_api/models/unwrap_webhook_event"
 require_relative "surge_api/models/user"
 require_relative "surge_api/models/user_create_params"
 require_relative "surge_api/models/user_create_token_params"
+require_relative "surge_api/models/user_delete_params"
 require_relative "surge_api/models/user_retrieve_params"
 require_relative "surge_api/models/user_token_response"
 require_relative "surge_api/models/user_update_params"

data/rbi/surge_api/models/user_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class UserDeleteParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::UserDeleteParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

@@ -74,6 +74,8 @@ module SurgeAPI
 
   UserCreateTokenParams = SurgeAPI::Models::UserCreateTokenParams
 
+  UserDeleteParams = SurgeAPI::Models::UserDeleteParams
+
   UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
 
   UserTokenResponse = SurgeAPI::Models::UserTokenResponse

data/rbi/surge_api/resources/users.rbi

@@ -69,6 +69,24 @@ module SurgeAPI
       )
       end
 
+      # Deletes a user.
+      #
+      # Once a user has been deleted, they will no longer be permitted to access any of
+      # the embedded components. Attempting to access a deleted user will return a 404
+      # Not Found error.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::User)
+      end
+      def delete(
+        # The ID of the user to delete.
+        id,
+        request_options: {}
+      )
+      end
+
       # Provides a mechanism for having Surge create a signed token for embeds instead
       # of signing with your own signing key.
       sig do

data/sig/surge_api/models/user_delete_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type user_delete_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class UserDeleteParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models.rbs

@@ -71,6 +71,8 @@ module SurgeAPI
 
   class UserCreateTokenParams = SurgeAPI::Models::UserCreateTokenParams
 
+  class UserDeleteParams = SurgeAPI::Models::UserDeleteParams
+
   class UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
 
   class UserTokenResponse = SurgeAPI::Models::UserTokenResponse

data/sig/surge_api/resources/users.rbs

@@ -24,6 +24,11 @@ module SurgeAPI
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::User
 
+      def delete: (
+        String id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::User
+
       def create_token: (
         String user_id,
         ?duration_seconds: Integer,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-11 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -105,6 +105,7 @@ files:
 - lib/surge_api/models/user.rb
 - lib/surge_api/models/user_create_params.rb
 - lib/surge_api/models/user_create_token_params.rb
+- lib/surge_api/models/user_delete_params.rb
 - lib/surge_api/models/user_retrieve_params.rb
 - lib/surge_api/models/user_token_response.rb
 - lib/surge_api/models/user_update_params.rb
@@ -180,6 +181,7 @@ files:
 - rbi/surge_api/models/user.rbi
 - rbi/surge_api/models/user_create_params.rbi
 - rbi/surge_api/models/user_create_token_params.rbi
+- rbi/surge_api/models/user_delete_params.rbi
 - rbi/surge_api/models/user_retrieve_params.rbi
 - rbi/surge_api/models/user_token_response.rbi
 - rbi/surge_api/models/user_update_params.rbi
@@ -254,6 +256,7 @@ files:
 - sig/surge_api/models/user.rbs
 - sig/surge_api/models/user_create_params.rbs
 - sig/surge_api/models/user_create_token_params.rbs
+- sig/surge_api/models/user_delete_params.rbs
 - sig/surge_api/models/user_retrieve_params.rbs
 - sig/surge_api/models/user_token_response.rbs
 - sig/surge_api/models/user_update_params.rbs