surge_api 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46beb8f51bbd1bbf30a337fd8f1bebec392a3e283b06663859e8c6fbc4418806
-  data.tar.gz: dd34d84097ceff18e2b17111d1513fa701d20079d4d90329f816eb3e89d14938
+  metadata.gz: dcd65a3f11b5c187dcefe5f82f90dfef4bb4421e06115246ccda187f459e9202
+  data.tar.gz: c8bac9291bc751a4ddfdb952f70eb32fcb696ef886a5c3521f149e7235f18733
 SHA512:
-  metadata.gz: 6cf4a3222dd600709a14d8e718bb8bf04a9fd15650575914c136d11cb073e0d78724859e182b450ba7550fa46dfa8a2b3345e5e1175365477f9df729b992e385
-  data.tar.gz: ccb9085d52e5c8930568f9a511d6f6fe41e6f12f0aafacf515f201dde5c51d5ad04cb0d8341f4b7074eb7089e4c97dd69d35868ee9349c891abd5b588b522471
+  metadata.gz: '0032493ed7b14b18fc06f216c37ed91814fbd61874e777604013cde0c694859767b177820dc298559024a9a2c7f39d878157e7e6b24035fce20ad07fa1b984e0'
+  data.tar.gz: abe1e0ff490003f4f4376847989c4b0f982abb34ac3eae1bc308b81abf22a03e4078dd08d49c23db58a91e271831d450fe2087938286455fcc381d126602a14c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.17.0 (2026-05-04)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/surgeapi/ruby-sdk/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** list accounts endpoint ([510b3bc](https://github.com/surgeapi/ruby-sdk/commit/510b3bc3d2ab9b8659e5ca0701cef8fc2c5f2a2e))
+
 ## 0.16.0 (2026-04-22)
 
 Full Changelog: [v0.15.0...v0.16.0](https://github.com/surgeapi/ruby-sdk/compare/v0.15.0...v0.16.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.16.0"
+gem "surge_api", "~> 0.17.0"
 ```
 
 <!-- x-release-please-end -->
@@ -44,15 +44,15 @@ List methods in the Surge API are paginated.
 This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```ruby
-page = surge.audiences.list_contacts
+page = surge.accounts.list
 
 # Fetch single item from page.
-audience = page.data[0]
-puts(audience.id)
+account = page.data[0]
+puts(account.id)
 
 # Automatically fetches more pages as needed.
-page.auto_paging_each do |audience|
-  puts(audience.id)
+page.auto_paging_each do |account|
+  puts(account.id)
 end
 ```
 

data/lib/surge_api/internal/cursor.rb

@@ -10,8 +10,8 @@ module SurgeAPI
     #   end
     #
     # @example
-    #   cursor.auto_paging_each do |audience|
-    #     puts(audience)
+    #   cursor.auto_paging_each do |account|
+    #     puts(account)
     #   end
     class Cursor
       include SurgeAPI::Internal::Type::BasePage

data/lib/surge_api/models/account_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Accounts#list
+    class AccountListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for backward pagination. Use the previous_cursor from a previous
+      #   response.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!method initialize(after: nil, before: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::AccountListParams} for more details.
+      #
+      #   @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      #   @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -45,6 +45,8 @@ module SurgeAPI
 
   AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
+  AccountListParams = SurgeAPI::Models::AccountListParams
+
   AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
 
   AccountStatus = SurgeAPI::Models::AccountStatus

data/lib/surge_api/resources/accounts.rb

@@ -67,6 +67,35 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::AccountListParams} for more details.
+      #
+      # List all accounts for the calling platform with cursor-based pagination.
+      #
+      # @overload list(after: nil, before: nil, request_options: {})
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::Account>]
+      #
+      # @see SurgeAPI::Models::AccountListParams
+      def list(params = {})
+        parsed, options = SurgeAPI::AccountListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "accounts",
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Account,
+          options: options
+        )
+      end
+
       # Archives an account and releases all associated resources.
       #
       # **Warning**: This action will:

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -58,6 +58,7 @@ 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_list_params"
 require_relative "surge_api/models/account_retrieve_status_params"
 require_relative "surge_api/models/account_status"
 require_relative "surge_api/models/account_update_params"

data/rbi/surge_api/models/account_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class AccountListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::AccountListParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Cursor for forward pagination. Use the next_cursor from a previous response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for backward pagination. Use the previous_cursor from a previous
+      # response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for forward pagination. Use the next_cursor from a previous response.
+        after: nil,
+        # Cursor for backward pagination. Use the previous_cursor from a previous
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

@@ -7,6 +7,8 @@ module SurgeAPI
 
   AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
+  AccountListParams = SurgeAPI::Models::AccountListParams
+
   AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
 
   AccountStatus = SurgeAPI::Models::AccountStatus

data/rbi/surge_api/resources/accounts.rbi

@@ -65,6 +65,24 @@ module SurgeAPI
       )
       end
 
+      # List all accounts for the calling platform with cursor-based pagination.
+      sig do
+        params(
+          after: String,
+          before: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Internal::Cursor[SurgeAPI::Account])
+      end
+      def list(
+        # Cursor for forward pagination. Use the next_cursor from a previous response.
+        after: nil,
+        # Cursor for backward pagination. Use the previous_cursor from a previous
+        # response.
+        before: nil,
+        request_options: {}
+      )
+      end
+
       # Archives an account and releases all associated resources.
       #
       # **Warning**: This action will:

data/sig/surge_api/models/account_list_params.rbs

@@ -0,0 +1,32 @@
+module SurgeAPI
+  module Models
+    type account_list_params =
+      { after: String, before: String }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class AccountListParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_reader after: String?
+
+      def after=: (String) -> String
+
+      attr_reader before: String?
+
+      def before=: (String) -> String
+
+      def initialize: (
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        after: String,
+        before: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/surge_api/models.rbs

@@ -5,6 +5,8 @@ module SurgeAPI
 
   class AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
+  class AccountListParams = SurgeAPI::Models::AccountListParams
+
   class AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
 
   class AccountStatus = SurgeAPI::Models::AccountStatus

data/sig/surge_api/resources/accounts.rbs

@@ -18,6 +18,12 @@ module SurgeAPI
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::Account
 
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Internal::Cursor[SurgeAPI::Account]
+
       def archive: (
         String id,
         ?request_options: SurgeAPI::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-24 00:00:00.000000000 Z
+date: 2026-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -73,6 +73,7 @@ files:
 - 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_list_params.rb
 - lib/surge_api/models/account_retrieve_status_params.rb
 - lib/surge_api/models/account_status.rb
 - lib/surge_api/models/account_update_params.rb
@@ -178,6 +179,7 @@ files:
 - 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_list_params.rbi
 - rbi/surge_api/models/account_retrieve_status_params.rbi
 - rbi/surge_api/models/account_status.rbi
 - rbi/surge_api/models/account_update_params.rbi
@@ -282,6 +284,7 @@ files:
 - 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_list_params.rbs
 - sig/surge_api/models/account_retrieve_status_params.rbs
 - sig/surge_api/models/account_status.rbs
 - sig/surge_api/models/account_update_params.rbs