surge_api 0.15.0 → 0.17.0

data/rbi/surge_api/models/message.rbi

@@ -243,6 +243,10 @@ module SurgeAPI
           sig { returns(String) }
           attr_accessor :id
 
+          # A human-readable name for the phone number
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
           # The canonical format of the phone number.
           sig { returns(String) }
           attr_accessor :number
@@ -259,6 +263,7 @@ module SurgeAPI
           sig do
             params(
               id: String,
+              name: T.nilable(String),
               number: String,
               type: SurgeAPI::Message::Conversation::PhoneNumber::Type::OrSymbol
             ).returns(T.attached_class)
@@ -266,6 +271,8 @@ module SurgeAPI
           def self.new(
             # Unique identifier for the phone number
             id:,
+            # A human-readable name for the phone number
+            name:,
             # The canonical format of the phone number.
             number:,
             # Whether the phone number is local, toll-free, or short code
@@ -277,6 +284,7 @@ module SurgeAPI
             override.returns(
               {
                 id: String,
+                name: T.nilable(String),
                 number: String,
                 type:
                   SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol

data/rbi/surge_api/models/phone_number.rbi

@@ -16,6 +16,10 @@ module SurgeAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :campaign_id
 
+      # A human-readable name for the phone number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
       # The phone number in E.164 format
       sig { returns(String) }
       attr_accessor :number
@@ -29,6 +33,7 @@ module SurgeAPI
         params(
           id: String,
           campaign_id: T.nilable(String),
+          name: T.nilable(String),
           number: String,
           type: SurgeAPI::PhoneNumber::Type::OrSymbol
         ).returns(T.attached_class)
@@ -38,6 +43,8 @@ module SurgeAPI
         id:,
         # The unique identifier of the campaign this phone number is attached to, if any
         campaign_id:,
+        # A human-readable name for the phone number
+        name:,
         # The phone number in E.164 format
         number:,
         # Whether the phone number is local, toll-free, or short code
@@ -50,6 +57,7 @@ module SurgeAPI
           {
             id: String,
             campaign_id: T.nilable(String),
+            name: T.nilable(String),
             number: String,
             type: SurgeAPI::PhoneNumber::Type::TaggedSymbol
           }

data/rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi

@@ -88,6 +88,10 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :campaign_id
 
+        # A human-readable name for the phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
         # The phone number in E.164 format
         sig { returns(String) }
         attr_accessor :number
@@ -105,6 +109,7 @@ module SurgeAPI
           params(
             id: String,
             campaign_id: String,
+            name: T.nilable(String),
             number: String,
             type:
               SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::OrSymbol
@@ -115,6 +120,8 @@ module SurgeAPI
           id:,
           # The unique identifier of the campaign this phone number is attached to
           campaign_id:,
+          # A human-readable name for the phone number
+          name:,
           # The phone number in E.164 format
           number:,
           # Whether the phone number is local, toll-free, or short code
@@ -127,6 +134,7 @@ module SurgeAPI
             {
               id: String,
               campaign_id: String,
+              name: T.nilable(String),
               number: String,
               type:
                 SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type::TaggedSymbol

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -38,6 +38,14 @@ module SurgeAPI
       sig { params(longitude: Float).void }
       attr_writer :longitude
 
+      # A human-readable name for the phone number. If not provided, defaults to the
+      # formatted phone number.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
       # Whether the phone number is local or toll-free. Can be omitted if area_code or
       # latitude/longitude are provided.
       sig do
@@ -55,6 +63,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          name: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -69,6 +78,9 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # A human-readable name for the phone number. If not provided, defaults to the
+        # formatted phone number.
+        name: nil,
         # Whether the phone number is local or toll-free. Can be omitted if area_code or
         # latitude/longitude are provided.
         type: nil,
@@ -82,6 +94,7 @@ module SurgeAPI
             area_code: String,
             latitude: Float,
             longitude: Float,
+            name: String,
             type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models.rbi

@@ -7,12 +7,16 @@ module SurgeAPI
 
   AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
+  AccountListParams = SurgeAPI::Models::AccountListParams
+
   AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
 
   AccountStatus = SurgeAPI::Models::AccountStatus
 
   AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
 
+  AttachmentGetFileParams = SurgeAPI::Models::AttachmentGetFileParams
+
   AudienceAddContactParams = SurgeAPI::Models::AudienceAddContactParams
 
   AudienceCreateParams = SurgeAPI::Models::AudienceCreateParams

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/rbi/surge_api/resources/attachments.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Attachments
+      # Redirects to a signed URL where the attachment file can be downloaded. URL is
+      # short-lived, so redirect should be followed immediately.
+      sig do
+        params(
+          attachment_id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::AttachmentGetFileResponse)
+      end
+      def get_file(
+        # The ID of the attachment.
+        attachment_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/phone_numbers.rbi

@@ -32,6 +32,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          name: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(SurgeAPI::PhoneNumber)
@@ -48,6 +49,9 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # A human-readable name for the phone number. If not provided, defaults to the
+        # formatted phone number.
+        name: nil,
         # Whether the phone number is local or toll-free. Can be omitted if area_code or
         # latitude/longitude are provided.
         type: nil,

data/sig/surge_api/client.rbs

@@ -12,6 +12,8 @@ module SurgeAPI
 
     attr_reader accounts: SurgeAPI::Resources::Accounts
 
+    attr_reader attachments: SurgeAPI::Resources::Attachments
+
     attr_reader audiences: SurgeAPI::Resources::Audiences
 
     attr_reader blasts: SurgeAPI::Resources::Blasts

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

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

@@ -0,0 +1,13 @@
+module SurgeAPI
+  module Models
+    type attachment_get_file_response = { error: SurgeAPI::Error }
+
+    class AttachmentGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor error: SurgeAPI::Error
+
+      def initialize: (error: SurgeAPI::Error) -> void
+
+      def to_hash: -> { error: SurgeAPI::Error }
+    end
+  end
+end

data/sig/surge_api/models/link_followed_webhook_event.rbs

@@ -31,18 +31,36 @@ module SurgeAPI
         type: :"link.followed"
       }
 
-      type data = { id: String, message_id: String, url: String }
+      type data =
+        {
+          id: String,
+          message: SurgeAPI::Message?,
+          message_id: String?,
+          url: String
+        }
 
       class Data < SurgeAPI::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor message_id: String
+        attr_accessor message: SurgeAPI::Message?
+
+        attr_accessor message_id: String?
 
         attr_accessor url: String
 
-        def initialize: (id: String, message_id: String, url: String) -> void
+        def initialize: (
+          id: String,
+          message: SurgeAPI::Message?,
+          message_id: String?,
+          url: String
+        ) -> void
 
-        def to_hash: -> { id: String, message_id: String, url: String }
+        def to_hash: -> {
+          id: String,
+          message: SurgeAPI::Message?,
+          message_id: String?,
+          url: String
+        }
       end
     end
   end

data/sig/surge_api/models/message.rbs

@@ -134,6 +134,7 @@ module SurgeAPI
         type phone_number =
           {
             id: String,
+            name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
           }
@@ -141,18 +142,22 @@ module SurgeAPI
         class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
           attr_accessor id: String
 
+          attr_accessor name: String?
+
           attr_accessor number: String
 
           attr_accessor type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
 
           def initialize: (
             id: String,
+            name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
           ) -> void
 
           def to_hash: -> {
             id: String,
+            name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
           }

data/sig/surge_api/models/phone_number.rbs

@@ -4,6 +4,7 @@ module SurgeAPI
       {
         id: String,
         campaign_id: String?,
+        name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_
       }
@@ -13,6 +14,8 @@ module SurgeAPI
 
       attr_accessor campaign_id: String?
 
+      attr_accessor name: String?
+
       attr_accessor number: String
 
       attr_accessor type: SurgeAPI::Models::PhoneNumber::type_
@@ -20,6 +23,7 @@ module SurgeAPI
       def initialize: (
         id: String,
         campaign_id: String?,
+        name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_
       ) -> void
@@ -27,6 +31,7 @@ module SurgeAPI
       def to_hash: -> {
         id: String,
         campaign_id: String?,
+        name: String?,
         number: String,
         type: SurgeAPI::Models::PhoneNumber::type_
       }

data/sig/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbs

@@ -35,6 +35,7 @@ module SurgeAPI
         {
           id: String,
           campaign_id: String,
+          name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
         }
@@ -44,6 +45,8 @@ module SurgeAPI
 
         attr_accessor campaign_id: String
 
+        attr_accessor name: String?
+
         attr_accessor number: String
 
         attr_accessor type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
@@ -51,6 +54,7 @@ module SurgeAPI
         def initialize: (
           id: String,
           campaign_id: String,
+          name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
         ) -> void
@@ -58,6 +62,7 @@ module SurgeAPI
         def to_hash: -> {
           id: String,
           campaign_id: String,
+          name: String?,
           number: String,
           type: SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::type_
         }

data/sig/surge_api/models/phone_number_purchase_params.rbs

@@ -5,6 +5,7 @@ module SurgeAPI
         area_code: String,
         latitude: Float,
         longitude: Float,
+        name: String,
         type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_
       }
       & SurgeAPI::Internal::Type::request_parameters
@@ -25,6 +26,10 @@ module SurgeAPI
 
       def longitude=: (Float) -> Float
 
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
       attr_reader type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_?
 
       def type=: (
@@ -35,6 +40,7 @@ module SurgeAPI
         ?area_code: String,
         ?latitude: Float,
         ?longitude: Float,
+        ?name: String,
         ?type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,
         ?request_options: SurgeAPI::request_opts
       ) -> void
@@ -43,6 +49,7 @@ module SurgeAPI
         area_code: String,
         latitude: Float,
         longitude: Float,
+        name: String,
         type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,
         request_options: SurgeAPI::RequestOptions
       }

data/sig/surge_api/models.rbs

@@ -5,12 +5,16 @@ module SurgeAPI
 
   class AccountCreateParams = SurgeAPI::Models::AccountCreateParams
 
+  class AccountListParams = SurgeAPI::Models::AccountListParams
+
   class AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
 
   class AccountStatus = SurgeAPI::Models::AccountStatus
 
   class AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
 
+  class AttachmentGetFileParams = SurgeAPI::Models::AttachmentGetFileParams
+
   class AudienceAddContactParams = SurgeAPI::Models::AudienceAddContactParams
 
   class AudienceCreateParams = SurgeAPI::Models::AudienceCreateParams

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

data/sig/surge_api/resources/attachments.rbs

@@ -0,0 +1,12 @@
+module SurgeAPI
+  module Resources
+    class Attachments
+      def get_file: (
+        String attachment_id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Models::AttachmentGetFileResponse
+
+      def initialize: (client: SurgeAPI::Client) -> void
+    end
+  end
+end

data/sig/surge_api/resources/phone_numbers.rbs

@@ -13,6 +13,7 @@ module SurgeAPI
         ?area_code: String,
         ?latitude: Float,
         ?longitude: Float,
+        ?name: String,
         ?type: SurgeAPI::Models::PhoneNumberPurchaseParams::type_,
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::PhoneNumber

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-06 00:00:00.000000000 Z
+date: 2026-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -73,9 +73,12 @@ 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
+- lib/surge_api/models/attachment_get_file_params.rb
+- lib/surge_api/models/attachment_get_file_response.rb
 - lib/surge_api/models/audience_add_contact_params.rb
 - lib/surge_api/models/audience_create_params.rb
 - lib/surge_api/models/audience_create_response.rb
@@ -140,6 +143,7 @@ files:
 - lib/surge_api/models/webhook_unwrap_params.rb
 - lib/surge_api/request_options.rb
 - lib/surge_api/resources/accounts.rb
+- lib/surge_api/resources/attachments.rb
 - lib/surge_api/resources/audiences.rb
 - lib/surge_api/resources/blasts.rb
 - lib/surge_api/resources/campaigns.rb
@@ -175,9 +179,12 @@ 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
+- rbi/surge_api/models/attachment_get_file_params.rbi
+- rbi/surge_api/models/attachment_get_file_response.rbi
 - rbi/surge_api/models/audience_add_contact_params.rbi
 - rbi/surge_api/models/audience_create_params.rbi
 - rbi/surge_api/models/audience_create_response.rbi
@@ -242,6 +249,7 @@ files:
 - rbi/surge_api/models/webhook_unwrap_params.rbi
 - rbi/surge_api/request_options.rbi
 - rbi/surge_api/resources/accounts.rbi
+- rbi/surge_api/resources/attachments.rbi
 - rbi/surge_api/resources/audiences.rbi
 - rbi/surge_api/resources/blasts.rbi
 - rbi/surge_api/resources/campaigns.rbi
@@ -276,9 +284,12 @@ 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
+- sig/surge_api/models/attachment_get_file_params.rbs
+- sig/surge_api/models/attachment_get_file_response.rbs
 - sig/surge_api/models/audience_add_contact_params.rbs
 - sig/surge_api/models/audience_create_params.rbs
 - sig/surge_api/models/audience_create_response.rbs
@@ -343,6 +354,7 @@ files:
 - sig/surge_api/models/webhook_unwrap_params.rbs
 - sig/surge_api/request_options.rbs
 - sig/surge_api/resources/accounts.rbs
+- sig/surge_api/resources/attachments.rbs
 - sig/surge_api/resources/audiences.rbs
 - sig/surge_api/resources/blasts.rbs
 - sig/surge_api/resources/campaigns.rbs