surge_api 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e8128de1b743d0dfdea80a3444fe70781bb029f32061761b09b749cd8a1abf7
-  data.tar.gz: 543611ed65fb81164bd534cd91af8a0c6bc2bf96e5efda155aec5204a57c63ce
+  metadata.gz: c8cabbc1ca93255610f86e41e4408ee35552d4755552e0bb63dec43d34e37847
+  data.tar.gz: 94fd6a84dd1d08f71b3fb51125010f75d03f824538078a70103213297391c30b
 SHA512:
-  metadata.gz: 4b124f0da4f0ee63a4e0d418a16059b1f049b26ca9c1361f712e1bd8890fc73d51d9a930818345e753bb22850442085000c293d4a39f9df891582e87b2b31ff3
-  data.tar.gz: b1a17edfc1c13106f82f11cd1732984f20e2ec7c5afa0ae055c5f31e795c77c9f307520ba38b411c9dda6687f11f91dcefa4cf61cd2b26a1c0a433b43ab54970
+  metadata.gz: cce465d2b1f99e690347727f8e987b6afa07a0cd2eadfb0e0832b1bf1100477ae03592e774c9ee8929d9c2eb5903e820fac12ca0d8d28a6ed1207dcdabc33a3c
+  data.tar.gz: 184ca9625b88a0b8366f92f0760e1fd5f53abd52752a4c0284b99429442cc69280b29e9758d94381a0ca4fba98e693f36d083710a17883ad13c4aaae3b83d39b

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 0.9.0 (2026-02-04)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/surgeapi/ruby-sdk/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** add list contacts endpoint ([fb3eaae](https://github.com/surgeapi/ruby-sdk/commit/fb3eaae32fa15b6b7423b4ae485608e03cf027a7))
+* **api:** add list messages endpoint ([ca51f12](https://github.com/surgeapi/ruby-sdk/commit/ca51f12d83bcebdd706701e8fee9a594313bd767))
+* **api:** add list phone numbers endpoint ([47691df](https://github.com/surgeapi/ruby-sdk/commit/47691dfe6f91a9300c02f3f893fe2af5636f8094))
+* **sdk:** add deprecation messages ([f0e959e](https://github.com/surgeapi/ruby-sdk/commit/f0e959e9a96069670284b7ebd9f9a0a28672b5dc))
+* **sdks:** set up pagination ([08b1393](https://github.com/surgeapi/ruby-sdk/commit/08b13930dd2102f1886c616409f213e62b3137e5))
+
+
+### Bug Fixes
+
+* **api:** make message body nullable ([a329e52](https://github.com/surgeapi/ruby-sdk/commit/a329e5203323524beb725f217d0261193df02ebe))
+* **client:** always add content-length to post body, even when empty ([12467d3](https://github.com/surgeapi/ruby-sdk/commit/12467d365020dafafb0474504042a8e39c5ee2fd))
+
+
+### Chores
+
+* **docs:** remove www prefix ([beaff0c](https://github.com/surgeapi/ruby-sdk/commit/beaff0c151d0e31114c490c09fb4c71196e316d8))
+
+## 0.8.0 (2026-01-26)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/surgeapi/ruby-sdk/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** api update ([37c4efa](https://github.com/surgeapi/ruby-sdk/commit/37c4efa6bdcad247f43f50a49b59a7b4426d6fc8))
+* **api:** api update ([0caf848](https://github.com/surgeapi/ruby-sdk/commit/0caf848fba60e7cda89b326c51bb7c168ad95187))
+* **api:** api update ([f3c40f2](https://github.com/surgeapi/ruby-sdk/commit/f3c40f28c70eb38a08e4021a24230564edab8592))
+
 ## 0.7.0 (2026-01-18)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/surgeapi/ruby-sdk/compare/v0.6.0...v0.7.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.7.0"
+gem "surge_api", "~> 0.9.0"
 ```
 
 <!-- x-release-please-end -->
@@ -37,6 +37,34 @@ message = surge.messages.create("acct_01j9a43avnfqzbjfch6pygv1td")
 puts(message.id)
 ```
 
+### Pagination
+
+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.contacts.list
+
+# Fetch single item from page.
+contact = page.data[0]
+puts(contact.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |contact|
+  puts(contact.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
+end
+```
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `SurgeAPI::Errors::APIError` will be thrown:

data/lib/surge_api/internal/cursor.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if cursor.has_next?
+    #     cursor = cursor.next_page
+    #   end
+    #
+    # @example
+    #   cursor.auto_paging_each do |contact|
+    #     puts(contact)
+    #   end
+    class Cursor
+      include SurgeAPI::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [Pagination]
+      attr_accessor :pagination
+
+      # @return [Boolean]
+      def next_page?
+        !data.to_a.empty? && (!pagination&.previous_cursor.to_s.empty? || !pagination&.next_cursor.to_s.empty?)
+      end
+
+      # @raise [SurgeAPI::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = SurgeAPI::Internal::Util.deep_merge(
+          @req,
+          {
+            query: pagination&.previous_cursor.nil? ? {after: pagination&.next_cursor} : {before: pagination&.previous_cursor}
+          }
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Array => data}
+          @data = data.map { SurgeAPI::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {pagination: Hash | nil => pagination}
+          @pagination =
+            SurgeAPI::Internal::Type::Converter.coerce(SurgeAPI::Internal::Cursor::Pagination, pagination)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = SurgeAPI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Pagination < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute next_cursor
+        #
+        #   @return [String, nil]
+        optional :next_cursor, String
+
+        # @!attribute previous_cursor
+        #
+        #   @return [String, nil]
+        optional :previous_cursor, String
+
+        # @!method initialize(next_cursor: nil, previous_cursor: nil)
+        #   @param next_cursor [String]
+        #   @param previous_cursor [String]
+      end
+    end
+  end
+end

data/lib/surge_api/internal/transport/pooled_net_requester.rb

@@ -75,7 +75,7 @@ module SurgeAPI
 
             case body
             in nil
-              nil
+              req["content-length"] ||= 0 unless req["transfer-encoding"]
             in String
               req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"]
               req.body_stream = SurgeAPI::Internal::Util::ReadIOAdapter.new(body, &blk)

data/lib/surge_api/models/blast.rb

@@ -19,7 +19,7 @@ module SurgeAPI
       #   The message body.
       #
       #   @return [String, nil]
-      optional :body, String
+      optional :body, String, nil?: true
 
       # @!attribute name
       #   Optional name for the blast.
@@ -40,7 +40,7 @@ module SurgeAPI
       #
       #   @param attachments [Array<SurgeAPI::Models::Blast::Attachment>]
       #
-      #   @param body [String] The message body.
+      #   @param body [String, nil] The message body.
       #
       #   @param name [String] Optional name for the blast.
       #

data/lib/surge_api/models/blast_create_params.rb

@@ -16,16 +16,24 @@ module SurgeAPI
       #   The message body.
       #
       #   @return [String, nil]
-      optional :body, String
+      optional :body, String, nil?: true
 
       # @!attribute contacts
-      #   @deprecated
+      #   @deprecated Use `to` to specify recipients instead.
       #
       #   Deprecated. Use `to` instead.
       #
       #   @return [Array<String>, nil]
       optional :contacts, SurgeAPI::Internal::Type::ArrayOf[String]
 
+      # @!attribute from
+      #   The phone number from which to send the blast. This can be either the phone
+      #   number in E.164 format or a Surge phone number id. If not provided, the
+      #   account's default phone number is used.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
       # @!attribute name
       #   Optional name for the blast.
       #
@@ -33,7 +41,7 @@ module SurgeAPI
       optional :name, String
 
       # @!attribute segments
-      #   @deprecated
+      #   @deprecated Use `to` to specify recipients instead.
       #
       #   Deprecated. Use `to` instead.
       #
@@ -53,16 +61,18 @@ module SurgeAPI
       #   @return [Array<String>, nil]
       optional :to, SurgeAPI::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(attachments: nil, body: nil, contacts: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
+      # @!method initialize(attachments: nil, body: nil, contacts: nil, from: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::BlastCreateParams} for more details.
       #
       #   @param attachments [Array<SurgeAPI::Models::BlastCreateParams::Attachment>]
       #
-      #   @param body [String] The message body.
+      #   @param body [String, nil] The message body.
       #
       #   @param contacts [Array<String>] Deprecated. Use `to` instead.
       #
+      #   @param from [String] The phone number from which to send the blast. This can be either the phone numb
+      #
       #   @param name [String] Optional name for the blast.
       #
       #   @param segments [Array<String>] Deprecated. Use `to` instead.

data/lib/surge_api/models/contact_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Contacts#list
+    class ContactListParams < 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::ContactListParams} 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/message.rb

@@ -15,11 +15,18 @@ module SurgeAPI
       #   @return [Array<SurgeAPI::Models::Message::Attachment>, nil]
       optional :attachments, -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::Message::Attachment] }
 
+      # @!attribute blast_id
+      #   The ID of the blast this message belongs to, if any. This can be used to
+      #   attribute messages back to a specific blast.
+      #
+      #   @return [String, nil]
+      optional :blast_id, String
+
       # @!attribute body
       #   The message body.
       #
       #   @return [String, nil]
-      optional :body, String
+      optional :body, String, nil?: true
 
       # @!attribute conversation
       #   A conversation with a Contact
@@ -33,14 +40,19 @@ module SurgeAPI
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
 
-      # @!method initialize(id: nil, attachments: nil, body: nil, conversation: nil, metadata: nil)
+      # @!method initialize(id: nil, attachments: nil, blast_id: nil, body: nil, conversation: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::Message} for more details.
+      #
       #   A Message is a communication sent to a Contact.
       #
       #   @param id [String] Unique identifier for the object.
       #
       #   @param attachments [Array<SurgeAPI::Models::Message::Attachment>]
       #
-      #   @param body [String] The message body.
+      #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
+      #
+      #   @param body [String, nil] The message body.
       #
       #   @param conversation [SurgeAPI::Models::Message::Conversation] A conversation with a Contact
       #

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -47,8 +47,8 @@ module SurgeAPI
         # @!attribute body
         #   The content of the message
         #
-        #   @return [String]
-        required :body, String
+        #   @return [String, nil]
+        required :body, String, nil?: true
 
         # @!attribute conversation
         #   The conversation this message belongs to
@@ -69,18 +69,30 @@ module SurgeAPI
         optional :attachments,
                  -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment] }
 
-        # @!method initialize(id:, body:, conversation:, delivered_at:, attachments: nil)
+        # @!attribute blast_id
+        #   The ID of the blast this message belongs to, if any. This can be used to
+        #   attribute messages back to a specific blast.
+        #
+        #   @return [String, nil]
+        optional :blast_id, String
+
+        # @!method initialize(id:, body:, conversation:, delivered_at:, attachments: nil, blast_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageDeliveredWebhookEvent::Data} for more details.
+        #
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the message
         #
-        #   @param body [String] The content of the message
+        #   @param body [String, nil] The content of the message
         #
         #   @param conversation [SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
         #   @param delivered_at [Time] When the message was delivered
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment>] Attachments included with the message
+        #
+        #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
 
         # @see SurgeAPI::Models::MessageDeliveredWebhookEvent::Data#conversation
         class Conversation < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -47,8 +47,8 @@ module SurgeAPI
         # @!attribute body
         #   The content of the message
         #
-        #   @return [String]
-        required :body, String
+        #   @return [String, nil]
+        required :body, String, nil?: true
 
         # @!attribute conversation
         #   The conversation this message belongs to
@@ -75,12 +75,22 @@ module SurgeAPI
         optional :attachments,
                  -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment] }
 
-        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, attachments: nil)
+        # @!attribute blast_id
+        #   The ID of the blast this message belongs to, if any. This can be used to
+        #   attribute messages back to a specific blast.
+        #
+        #   @return [String, nil]
+        optional :blast_id, String
+
+        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, attachments: nil, blast_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageFailedWebhookEvent::Data} for more details.
+        #
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the message
         #
-        #   @param body [String] The content of the message
+        #   @param body [String, nil] The content of the message
         #
         #   @param conversation [SurgeAPI::Models::MessageFailedWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
@@ -89,6 +99,8 @@ module SurgeAPI
         #   @param failure_reason [String] The reason the message failed to be delivered
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment>] Attachments included with the message
+        #
+        #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
 
         # @see SurgeAPI::Models::MessageFailedWebhookEvent::Data#conversation
         class Conversation < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/models/message_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Messages#list
+    class MessageListParams < 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::MessageListParams} 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/message_received_webhook_event.rb

@@ -47,8 +47,8 @@ module SurgeAPI
         # @!attribute body
         #   The content of the message
         #
-        #   @return [String]
-        required :body, String
+        #   @return [String, nil]
+        required :body, String, nil?: true
 
         # @!attribute conversation
         #   The conversation this message belongs to
@@ -69,18 +69,30 @@ module SurgeAPI
         optional :attachments,
                  -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment] }
 
-        # @!method initialize(id:, body:, conversation:, received_at:, attachments: nil)
+        # @!attribute blast_id
+        #   The ID of the blast this message belongs to, if any. This can be used to
+        #   attribute messages back to a specific blast.
+        #
+        #   @return [String, nil]
+        optional :blast_id, String
+
+        # @!method initialize(id:, body:, conversation:, received_at:, attachments: nil, blast_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageReceivedWebhookEvent::Data} for more details.
+        #
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the message
         #
-        #   @param body [String] The content of the message
+        #   @param body [String, nil] The content of the message
         #
         #   @param conversation [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
         #   @param received_at [Time] When the message was received
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment>] Attachments included with the message
+        #
+        #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
 
         # @see SurgeAPI::Models::MessageReceivedWebhookEvent::Data#conversation
         class Conversation < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -47,8 +47,8 @@ module SurgeAPI
         # @!attribute body
         #   The content of the message
         #
-        #   @return [String]
-        required :body, String
+        #   @return [String, nil]
+        required :body, String, nil?: true
 
         # @!attribute conversation
         #   The conversation this message belongs to
@@ -69,18 +69,30 @@ module SurgeAPI
         optional :attachments,
                  -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageSentWebhookEvent::Data::Attachment] }
 
-        # @!method initialize(id:, body:, conversation:, sent_at:, attachments: nil)
+        # @!attribute blast_id
+        #   The ID of the blast this message belongs to, if any. This can be used to
+        #   attribute messages back to a specific blast.
+        #
+        #   @return [String, nil]
+        optional :blast_id, String
+
+        # @!method initialize(id:, body:, conversation:, sent_at:, attachments: nil, blast_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::MessageSentWebhookEvent::Data} for more details.
+        #
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the message
         #
-        #   @param body [String] The content of the message
+        #   @param body [String, nil] The content of the message
         #
         #   @param conversation [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
         #   @param sent_at [Time] When the message was sent
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment>] Attachments included with the message
+        #
+        #   @param blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
 
         # @see SurgeAPI::Models::MessageSentWebhookEvent::Data#conversation
         class Conversation < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/models/phone_number.rb

@@ -2,7 +2,7 @@
 
 module SurgeAPI
   module Models
-    # @see SurgeAPI::Resources::PhoneNumbers#purchase
+    # @see SurgeAPI::Resources::PhoneNumbers#list
     class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
       # @!attribute id
       #   Unique identifier for the phone number
@@ -38,6 +38,7 @@ module SurgeAPI
         extend SurgeAPI::Internal::Type::Enum
 
         LOCAL = :local
+        SHORT_CODE = :short_code
         TOLL_FREE = :toll_free
 
         # @!method self.values

data/lib/surge_api/models/phone_number_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::PhoneNumbers#list
+    class PhoneNumberListParams < 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::PhoneNumberListParams} 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

@@ -69,6 +69,8 @@ module SurgeAPI
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
 
+  ContactListParams = SurgeAPI::Models::ContactListParams
+
   ContactOptedInWebhookEvent = SurgeAPI::Models::ContactOptedInWebhookEvent
 
   ContactOptedOutWebhookEvent = SurgeAPI::Models::ContactOptedOutWebhookEvent
@@ -91,6 +93,8 @@ module SurgeAPI
 
   MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
 
+  MessageListParams = SurgeAPI::Models::MessageListParams
+
   MessageParams = SurgeAPI::Models::MessageParams
 
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
@@ -103,6 +107,8 @@ module SurgeAPI
 
   PhoneNumber = SurgeAPI::Models::PhoneNumber
 
+  PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
+
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
 
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent