surge_api 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cdf5f24e69c710419d1609ebc934daaafd1be183603d3f364e6a3d4085fa9b9
-  data.tar.gz: 65ecd730b0df9e65ab06bd73a272bbff75e7f3b17c5136173ca26d48e92364bb
+  metadata.gz: 6419099e30ee4893563ecd9e9fd2e4707dedf5af633e5972d25b0848228deef9
+  data.tar.gz: 1c60adc5936f072f87f8b534f26a4cab6bf3a34ea5d48428675c8cfea4da6159
 SHA512:
-  metadata.gz: 40416443213907937c15359db9fd573680ec1c0d6038a727304b632125d1331e765d980e4617afe0d80b98db12a1d7405bb3cd84d9b9be2a416ccda6ec9f7857
-  data.tar.gz: 20d73f3c32f237a86513ed84416b0ac144ff35f7ccd722bf57e79aa3a4fe44ee2525f91d523f67cd8b1b4819dfe3c3a9fe4b0f2c17cc56b280e2fe9f681d5386
+  metadata.gz: 3bcb5e868464704dad067a2a1e5b36a695689c3adf03e7b8e5978b2469dbe69bf2da75d7a4b0d6ad1613357a991e5a0f57e3110a95afc20eae0df4a7cc0ac751
+  data.tar.gz: 95e41f79bf6d869ac3201c21f15c1ceb7514d2d2e35c5172cba0e5db199bd1817300c9eea8d2050ad3493f08b2ecade4288c6c6b8907f53309cff1baf2001f65

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # 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)
+
+### Features
+
+* **api:** add archive account endpoint ([b56a3ac](https://github.com/surgeapi/ruby-sdk/commit/b56a3ac799df5e73cfea5416bb6af32cdeaac64d))
+
+
+### Bug Fixes
+
+* issue where json.parse errors when receiving HTTP 204 with nobody ([a54e6ff](https://github.com/surgeapi/ruby-sdk/commit/a54e6ff310c9d5d146161a33971eb0dc541c9774))
+
+
+### Chores
+
+* **internal:** codegen related update ([6dda266](https://github.com/surgeapi/ruby-sdk/commit/6dda2669de3018139c1ff15a9c23edda513fd899))
+* move `cgi` into dependencies for ruby 4 ([03ce06b](https://github.com/surgeapi/ruby-sdk/commit/03ce06b6a4f4d7f510dee6ece06e89ff93ede89d))
+
 ## 0.3.0 (2025-12-17)
 
 Full Changelog: [v0.2.1...v0.3.0](https://github.com/surgeapi/ruby-sdk/compare/v0.2.1...v0.3.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.3.0"
+gem "surge_api", "~> 0.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/internal/util.rb

@@ -657,7 +657,8 @@ module SurgeAPI
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in SurgeAPI::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module SurgeAPI
           in SurgeAPI::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/surge_api/models/account_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Accounts#archive
+    class AccountArchiveParams < 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/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

@@ -41,6 +41,8 @@ module SurgeAPI
 
   Account = SurgeAPI::Models::Account
 
+  AccountArchiveParams = SurgeAPI::Models::AccountArchiveParams
+
   AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
   AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
@@ -109,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/accounts.rb

@@ -67,6 +67,35 @@ module SurgeAPI
         )
       end
 
+      # Archives an account and releases all associated resources.
+      #
+      # **Warning**: This action will:
+      #
+      # - Release all phone numbers associated with the account
+      # - Deactivate all campaigns
+      # - Make the account unusable for sending messages
+      #
+      # This operation is irreversible. If you need to send SMS in the future, you will
+      # need to re-register new phone numbers and campaigns.
+      #
+      # @overload archive(id, request_options: {})
+      #
+      # @param id [String] The ID of the account to archive.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Account]
+      #
+      # @see SurgeAPI::Models::AccountArchiveParams
+      def archive(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["accounts/%1$s", id],
+          model: SurgeAPI::Account,
+          options: params[:request_options]
+        )
+      end
+
       # Check an account's status and capabilities
       #
       # @overload retrieve_status(account_id, capabilities: nil, request_options: {})

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.3.0"
+  VERSION = "0.5.0"
 end

data/lib/surge_api.rb

@@ -55,6 +55,7 @@ require_relative "surge_api/client"
 require_relative "surge_api/models/campaign_params"
 require_relative "surge_api/models/message_params"
 require_relative "surge_api/models/account"
+require_relative "surge_api/models/account_archive_params"
 require_relative "surge_api/models/account_create_params"
 require_relative "surge_api/models/account_retrieve_status_params"
 require_relative "surge_api/models/account_status"
@@ -87,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/account_archive_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class AccountArchiveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::AccountArchiveParams, 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/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

@@ -3,6 +3,8 @@
 module SurgeAPI
   Account = SurgeAPI::Models::Account
 
+  AccountArchiveParams = SurgeAPI::Models::AccountArchiveParams
+
   AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
   AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
@@ -72,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/accounts.rbi

@@ -65,6 +65,29 @@ module SurgeAPI
       )
       end
 
+      # Archives an account and releases all associated resources.
+      #
+      # **Warning**: This action will:
+      #
+      # - Release all phone numbers associated with the account
+      # - Deactivate all campaigns
+      # - Make the account unusable for sending messages
+      #
+      # This operation is irreversible. If you need to send SMS in the future, you will
+      # need to re-register new phone numbers and campaigns.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Account)
+      end
+      def archive(
+        # The ID of the account to archive.
+        id,
+        request_options: {}
+      )
+      end
+
       # Check an account's status and capabilities
       sig do
         params(

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/account_archive_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type account_archive_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class AccountArchiveParams < 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/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

@@ -1,6 +1,8 @@
 module SurgeAPI
   class Account = SurgeAPI::Models::Account
 
+  class AccountArchiveParams = SurgeAPI::Models::AccountArchiveParams
+
   class AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
   class AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
@@ -69,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/accounts.rbs

@@ -18,6 +18,11 @@ module SurgeAPI
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::Account
 
+      def archive: (
+        String id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Account
+
       def retrieve_status: (
         String account_id,
         ?capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],

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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-17 00:00:00.000000000 Z
+date: 2026-01-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +70,7 @@ files:
 - lib/surge_api/internal/util.rb
 - lib/surge_api/models.rb
 - lib/surge_api/models/account.rb
+- lib/surge_api/models/account_archive_params.rb
 - lib/surge_api/models/account_create_params.rb
 - lib/surge_api/models/account_retrieve_status_params.rb
 - lib/surge_api/models/account_status.rb
@@ -90,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
@@ -130,6 +146,7 @@ files:
 - rbi/surge_api/internal/util.rbi
 - rbi/surge_api/models.rbi
 - rbi/surge_api/models/account.rbi
+- rbi/surge_api/models/account_archive_params.rbi
 - rbi/surge_api/models/account_create_params.rbi
 - rbi/surge_api/models/account_retrieve_status_params.rbi
 - rbi/surge_api/models/account_status.rbi
@@ -164,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
@@ -203,6 +221,7 @@ files:
 - sig/surge_api/internal/util.rbs
 - sig/surge_api/models.rbs
 - sig/surge_api/models/account.rbs
+- sig/surge_api/models/account_archive_params.rbs
 - sig/surge_api/models/account_create_params.rbs
 - sig/surge_api/models/account_retrieve_status_params.rbs
 - sig/surge_api/models/account_status.rbs
@@ -237,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