surge_api 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614370dfa43aa94b2c07f29576b6e5859d11010ede1baa50269ff5d2d1ceccc9
-  data.tar.gz: a1717cedfe90b25cb8ad1c6fc529bd89ed6bead53039a37c0c1d99883fae1b42
+  metadata.gz: 46beb8f51bbd1bbf30a337fd8f1bebec392a3e283b06663859e8c6fbc4418806
+  data.tar.gz: dd34d84097ceff18e2b17111d1513fa701d20079d4d90329f816eb3e89d14938
 SHA512:
-  metadata.gz: 139587949698301477b68cb7a99f4b3367bc9575369ba153bb318f94dc488120348fb19a0ec2d566fd0407ddada88cddbfbf8ad1ac26640685e052408e29b6c4
-  data.tar.gz: 53b59055a002e7720fe165241c3ef0df906657d900dcb729da9be4a06e93a947a407eb7d73816a4aa76dac178e885f321f9528169e39f9ec719e4ab60fa27da1
+  metadata.gz: 6cf4a3222dd600709a14d8e718bb8bf04a9fd15650575914c136d11cb073e0d78724859e182b450ba7550fa46dfa8a2b3345e5e1175365477f9df729b992e385
+  data.tar.gz: ccb9085d52e5c8930568f9a511d6f6fe41e6f12f0aafacf515f201dde5c51d5ad04cb0d8341f4b7074eb7089e4c97dd69d35868ee9349c891abd5b588b522471

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** add endpoint to get attachment file ([5475d91](https://github.com/surgeapi/ruby-sdk/commit/5475d91e283e6afb974243f11a259e9990471f88))
+* **api:** add message to link.followed events ([1c36d5c](https://github.com/surgeapi/ruby-sdk/commit/1c36d5c6c21eb866aa5489ce0b70b01bfd01a9e4))
+* **api:** add name to phone numbers ([ee71d0d](https://github.com/surgeapi/ruby-sdk/commit/ee71d0dcec71388ed0af4132759072cca94e11f0))
+
 ## 0.15.0 (2026-04-06)
 
 Full Changelog: [v0.14.0...v0.15.0](https://github.com/surgeapi/ruby-sdk/compare/v0.14.0...v0.15.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.15.0"
+gem "surge_api", "~> 0.16.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/client.rb

@@ -21,6 +21,9 @@ module SurgeAPI
     # @return [SurgeAPI::Resources::Accounts]
     attr_reader :accounts
 
+    # @return [SurgeAPI::Resources::Attachments]
+    attr_reader :attachments
+
     # @return [SurgeAPI::Resources::Audiences]
     attr_reader :audiences
 
@@ -99,6 +102,7 @@ module SurgeAPI
       )
 
       @accounts = SurgeAPI::Resources::Accounts.new(client: self)
+      @attachments = SurgeAPI::Resources::Attachments.new(client: self)
       @audiences = SurgeAPI::Resources::Audiences.new(client: self)
       @blasts = SurgeAPI::Resources::Blasts.new(client: self)
       @campaigns = SurgeAPI::Resources::Campaigns.new(client: self)

data/lib/surge_api/models/attachment_get_file_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Attachments#get_file
+    class AttachmentGetFileParams < 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/attachment_get_file_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Attachments#get_file
+    class AttachmentGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute error
+      #   An error response
+      #
+      #   @return [SurgeAPI::Models::Error]
+      required :error, -> { SurgeAPI::Error }
+
+      # @!method initialize(error:)
+      #   An error response
+      #
+      #   @param error [SurgeAPI::Models::Error] An error response
+    end
+  end
+end

data/lib/surge_api/models/link_followed_webhook_event.rb

@@ -44,11 +44,19 @@ module SurgeAPI
         #   @return [String]
         required :id, String
 
+        # @!attribute message
+        #   A Message is a communication sent to a Contact.
+        #
+        #   @return [SurgeAPI::Models::Message, nil]
+        required :message, -> { SurgeAPI::Message }, nil?: true
+
         # @!attribute message_id
-        #   The unique identifier for the message that contained the link
+        #   @deprecated Use `message.id` instead.
         #
-        #   @return [String]
-        required :message_id, String
+        #   Deprecated. The unique identifier for the message that contained the link.
+        #
+        #   @return [String, nil]
+        required :message_id, String, nil?: true
 
         # @!attribute url
         #   The original URL that was shortened
@@ -56,12 +64,14 @@ module SurgeAPI
         #   @return [String]
         required :url, String
 
-        # @!method initialize(id:, message_id:, url:)
+        # @!method initialize(id:, message:, message_id:, url:)
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the link
         #
-        #   @param message_id [String] The unique identifier for the message that contained the link
+        #   @param message [SurgeAPI::Models::Message, nil] A Message is a communication sent to a Contact.
+        #
+        #   @param message_id [String, nil] Deprecated. The unique identifier for the message that contained the link.
         #
         #   @param url [String] The original URL that was shortened
       end

data/lib/surge_api/models/message.rb

@@ -139,6 +139,12 @@ module SurgeAPI
           #   @return [String]
           required :id, String
 
+          # @!attribute name
+          #   A human-readable name for the phone number
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
           # @!attribute number
           #   The canonical format of the phone number.
           #
@@ -151,11 +157,13 @@ module SurgeAPI
           #   @return [Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type]
           required :type, enum: -> { SurgeAPI::Message::Conversation::PhoneNumber::Type }
 
-          # @!method initialize(id:, number:, type:)
+          # @!method initialize(id:, name:, number:, type:)
           #   This is the phone number tied to the Surge account.
           #
           #   @param id [String] Unique identifier for the phone number
           #
+          #   @param name [String, nil] A human-readable name for the phone number
+          #
           #   @param number [String] The canonical format of the phone number.
           #
           #   @param type [Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type] Whether the phone number is local, toll-free, or short code

data/lib/surge_api/models/phone_number.rb

@@ -16,6 +16,12 @@ module SurgeAPI
       #   @return [String, nil]
       required :campaign_id, String, nil?: true
 
+      # @!attribute name
+      #   A human-readable name for the phone number
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
       # @!attribute number
       #   The phone number in E.164 format
       #
@@ -28,13 +34,15 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::PhoneNumber::Type]
       required :type, enum: -> { SurgeAPI::PhoneNumber::Type }
 
-      # @!method initialize(id:, campaign_id:, number:, type:)
+      # @!method initialize(id:, campaign_id:, name:, number:, type:)
       #   A phone number that can be used to send and receive messages and calls
       #
       #   @param id [String] Unique identifier for the phone number
       #
       #   @param campaign_id [String, nil] The unique identifier of the campaign this phone number is attached to, if any
       #
+      #   @param name [String, nil] A human-readable name for the phone number
+      #
       #   @param number [String] The phone number in E.164 format
       #
       #   @param type [Symbol, SurgeAPI::Models::PhoneNumber::Type] Whether the phone number is local, toll-free, or short code

data/lib/surge_api/models/phone_number_attached_to_campaign_webhook_event.rb

@@ -54,6 +54,12 @@ module SurgeAPI
         #   @return [String]
         required :campaign_id, String
 
+        # @!attribute name
+        #   A human-readable name for the phone number
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
         # @!attribute number
         #   The phone number in E.164 format
         #
@@ -66,13 +72,15 @@ module SurgeAPI
         #   @return [Symbol, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type]
         required :type, enum: -> { SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type }
 
-        # @!method initialize(id:, campaign_id:, number:, type:)
+        # @!method initialize(id:, campaign_id:, name:, number:, type:)
         #   The data associated with the event
         #
         #   @param id [String] The unique identifier for the phone number
         #
         #   @param campaign_id [String] The unique identifier of the campaign this phone number is attached to
         #
+        #   @param name [String, nil] A human-readable name for the phone number
+        #
         #   @param number [String] The phone number in E.164 format
         #
         #   @param type [Symbol, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent::Data::Type] Whether the phone number is local, toll-free, or short code

data/lib/surge_api/models/phone_number_purchase_params.rb

@@ -28,6 +28,13 @@ module SurgeAPI
       #   @return [Float, nil]
       optional :longitude, Float
 
+      # @!attribute name
+      #   A human-readable name for the phone number. If not provided, defaults to the
+      #   formatted phone number.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
       # @!attribute type
       #   Whether the phone number is local or toll-free. Can be omitted if area_code or
       #   latitude/longitude are provided.
@@ -35,7 +42,7 @@ module SurgeAPI
       #   @return [Symbol, SurgeAPI::Models::PhoneNumberPurchaseParams::Type, nil]
       optional :type, enum: -> { SurgeAPI::PhoneNumberPurchaseParams::Type }
 
-      # @!method initialize(area_code: nil, latitude: nil, longitude: nil, type: nil, request_options: {})
+      # @!method initialize(area_code: nil, latitude: nil, longitude: nil, name: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::PhoneNumberPurchaseParams} for more details.
       #
@@ -45,6 +52,8 @@ module SurgeAPI
       #
       #   @param longitude [Float] Longitude to search for nearby phone numbers. Must be used with latitude. If pro
       #
+      #   @param name [String] A human-readable name for the phone number. If not provided, defaults to the for
+      #
       #   @param type [Symbol, SurgeAPI::Models::PhoneNumberPurchaseParams::Type] Whether the phone number is local or toll-free. Can be omitted if area_code or l
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/surge_api/models.rb

@@ -51,6 +51,8 @@ module SurgeAPI
 
   AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
 
+  AttachmentGetFileParams = SurgeAPI::Models::AttachmentGetFileParams
+
   AudienceAddContactParams = SurgeAPI::Models::AudienceAddContactParams
 
   AudienceCreateParams = SurgeAPI::Models::AudienceCreateParams

data/lib/surge_api/resources/attachments.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+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.
+      #
+      # @overload get_file(attachment_id, request_options: {})
+      #
+      # @param attachment_id [String] The ID of the attachment.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::AttachmentGetFileResponse]
+      #
+      # @see SurgeAPI::Models::AttachmentGetFileParams
+      def get_file(attachment_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["attachments/%1$s/file", attachment_id],
+          model: SurgeAPI::Models::AttachmentGetFileResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/surge_api/resources/phone_numbers.rb

@@ -40,7 +40,7 @@ module SurgeAPI
       # Purchase a new phone number for the account. You can specify search criteria or
       # let the system select a random number.
       #
-      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, type: nil, request_options: {})
+      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, name: nil, type: nil, request_options: {})
       #
       # @param account_id [String] The account for which the phone number should be created.
       #
@@ -50,6 +50,8 @@ module SurgeAPI
       #
       # @param longitude [Float] Longitude to search for nearby phone numbers. Must be used with latitude. If pro
       #
+      # @param name [String] A human-readable name for the phone number. If not provided, defaults to the for
+      #
       # @param type [Symbol, SurgeAPI::Models::PhoneNumberPurchaseParams::Type] Whether the phone number is local or toll-free. Can be omitted if area_code or l
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -61,6 +61,8 @@ require_relative "surge_api/models/account_create_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"
+require_relative "surge_api/models/attachment_get_file_params"
+require_relative "surge_api/models/attachment_get_file_response"
 require_relative "surge_api/models/audience_add_contact_params"
 require_relative "surge_api/models/audience_create_params"
 require_relative "surge_api/models/audience_create_response"
@@ -123,6 +125,7 @@ require_relative "surge_api/models/voicemail_received_webhook_event"
 require_relative "surge_api/models/webhook_unwrap_params"
 require_relative "surge_api/models"
 require_relative "surge_api/resources/accounts"
+require_relative "surge_api/resources/attachments"
 require_relative "surge_api/resources/audiences"
 require_relative "surge_api/resources/blasts"
 require_relative "surge_api/resources/campaigns"

data/rbi/surge_api/client.rbi

@@ -16,6 +16,9 @@ module SurgeAPI
     sig { returns(SurgeAPI::Resources::Accounts) }
     attr_reader :accounts
 
+    sig { returns(SurgeAPI::Resources::Attachments) }
+    attr_reader :attachments
+
     sig { returns(SurgeAPI::Resources::Audiences) }
     attr_reader :audiences
 

data/rbi/surge_api/models/attachment_get_file_params.rbi

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

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class AttachmentGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::AttachmentGetFileResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # An error response
+      sig { returns(SurgeAPI::Error) }
+      attr_reader :error
+
+      sig { params(error: SurgeAPI::Error::OrHash).void }
+      attr_writer :error
+
+      # An error response
+      sig { params(error: SurgeAPI::Error::OrHash).returns(T.attached_class) }
+      def self.new(
+        # An error response
+        error:
+      )
+      end
+
+      sig { override.returns({ error: SurgeAPI::Error }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/link_followed_webhook_event.rbi

@@ -75,8 +75,15 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :id
 
-        # The unique identifier for the message that contained the link
-        sig { returns(String) }
+        # A Message is a communication sent to a Contact.
+        sig { returns(T.nilable(SurgeAPI::Message)) }
+        attr_reader :message
+
+        sig { params(message: T.nilable(SurgeAPI::Message::OrHash)).void }
+        attr_writer :message
+
+        # Deprecated. The unique identifier for the message that contained the link.
+        sig { returns(T.nilable(String)) }
         attr_accessor :message_id
 
         # The original URL that was shortened
@@ -85,14 +92,19 @@ module SurgeAPI
 
         # The data associated with the event
         sig do
-          params(id: String, message_id: String, url: String).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            message: T.nilable(SurgeAPI::Message::OrHash),
+            message_id: T.nilable(String),
+            url: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the link
           id:,
-          # The unique identifier for the message that contained the link
+          # A Message is a communication sent to a Contact.
+          message:,
+          # Deprecated. The unique identifier for the message that contained the link.
           message_id:,
           # The original URL that was shortened
           url:
@@ -100,7 +112,14 @@ module SurgeAPI
         end
 
         sig do
-          override.returns({ id: String, message_id: String, url: String })
+          override.returns(
+            {
+              id: String,
+              message: T.nilable(SurgeAPI::Message),
+              message_id: T.nilable(String),
+              url: String
+            }
+          )
         end
         def to_hash
         end

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

@@ -13,6 +13,8 @@ module SurgeAPI
 
   AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
 
+  AttachmentGetFileParams = SurgeAPI::Models::AttachmentGetFileParams
+
   AudienceAddContactParams = SurgeAPI::Models::AudienceAddContactParams
 
   AudienceCreateParams = SurgeAPI::Models::AudienceCreateParams

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/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

@@ -11,6 +11,8 @@ module SurgeAPI
 
   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/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.16.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-06 00:00:00.000000000 Z
+date: 2026-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -76,6 +76,8 @@ files:
 - 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 +142,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
@@ -178,6 +181,8 @@ files:
 - 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 +247,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
@@ -279,6 +285,8 @@ files:
 - 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 +351,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