surge_api 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2108433baa320b26048ee5f2141841a98866a135e46330a3cee4b4555eb85b67
-  data.tar.gz: 853d2d48b5b8981ba46ab3ab589bca43fd599ed8b6d9aa63cfcbe80eb5be2b7e
+  metadata.gz: 4d974f7f96df8e8e8452c8693d8afe99108691e4765da89ed06670ad635f3a48
+  data.tar.gz: 4f7eedf44e0f6c2b0d076f2c590d07519c666ae2d20fc12a5b0cef4fa2b451dd
 SHA512:
-  metadata.gz: 075d2964cab7711b2edc152d89314b5d323bcf9fd5d645409d9cd7c7ccfccf7c5ddab2c471d828bff6ff61a78ededa51e34bc2bbcd6ab298444c79f5d8ffec50
-  data.tar.gz: 6c171b025eeaa2be398b7315e5280129e198917ca5477aba3d7ca4d570def52c0d3b59a7935057ccb2aa93e35184e13989daa0d5e26461efcbc045aa6c9b36ff
+  metadata.gz: 4b03295d43f70c73f3db451516682c5ff8e5e7c081db91e7ed98628500f3f7cb637952dc60631f76e6d83dbf8a571ca1c90e4fb0dc3ce00ae0b759ca1ed8bfeb
+  data.tar.gz: 44ec0232e66a93b385447ccc5cd6ee433d7f3e944e96b69c2cf7badde81fdf46b630b9501a386067bffc10896de0eb864c2720814fe4e295fcc1a924fd8f2205

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([3eaef18](https://github.com/surgeapi/ruby-sdk/commit/3eaef1827965563c4aba448425c32a7850d8d5ba))
+
 ## 0.6.0 (2026-01-18)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/surgeapi/ruby-sdk/compare/v0.5.0...v0.6.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.6.0"
+gem "surge_api", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/blast_create_params.rb

@@ -26,6 +26,14 @@ module SurgeAPI
       #   @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.
       #
@@ -53,7 +61,7 @@ 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.
       #
@@ -63,6 +71,8 @@ module SurgeAPI
       #
       #   @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/message.rb

@@ -15,6 +15,13 @@ 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.
       #
@@ -27,16 +34,29 @@ module SurgeAPI
       #   @return [SurgeAPI::Models::Message::Conversation, nil]
       optional :conversation, -> { SurgeAPI::Message::Conversation }
 
-      # @!method initialize(id: nil, attachments: nil, body: nil, conversation: nil)
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+      # @!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 blast_id [String] The ID of the blast this message belongs to, if any. This can be used to attribu
+      #
       #   @param body [String] The message body.
       #
       #   @param conversation [SurgeAPI::Models::Message::Conversation] A conversation with a Contact
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
 
       class Attachment < SurgeAPI::Internal::Type::BaseModel
         # @!attribute id

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -69,7 +69,17 @@ 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
@@ -81,6 +91,8 @@ module SurgeAPI
         #   @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

@@ -75,7 +75,17 @@ 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
@@ -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_params.rb

@@ -34,6 +34,12 @@ module SurgeAPI
         #   @return [String, nil]
         optional :body, String
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute send_at
         #   An optional datetime for scheduling message up to a couple of months in the
         #   future.
@@ -41,7 +47,7 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(conversation:, attachments: nil, body: nil, send_at: nil)
+        # @!method initialize(conversation:, attachments: nil, body: nil, metadata: nil, send_at: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::MessageParamsWithConversation} for more
         #   details.
@@ -55,6 +61,8 @@ module SurgeAPI
         #
         #   @param body [String] The message body.
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
 
         # @see SurgeAPI::Models::MessageParams::MessageParamsWithConversation#conversation
@@ -172,6 +180,12 @@ module SurgeAPI
         #   @return [String, nil]
         optional :from, String
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute send_at
         #   An optional datetime for scheduling message up to a couple of months in the
         #   future.
@@ -179,7 +193,7 @@ module SurgeAPI
         #   @return [Time, nil]
         optional :send_at, Time
 
-        # @!method initialize(to:, attachments: nil, body: nil, from: nil, send_at: nil)
+        # @!method initialize(to:, attachments: nil, body: nil, from: nil, metadata: nil, send_at: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageParams::SimpleMessageParams} for more details.
         #
@@ -193,6 +207,8 @@ module SurgeAPI
         #
         #   @param from [String] The sender's phone number in E.164 format or phone number ID. If omitted, uses t
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param send_at [Time] An optional datetime for scheduling message up to a couple of months in the futu
 
         class Attachment < SurgeAPI::Internal::Type::BaseModel

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -69,7 +69,17 @@ 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
@@ -81,6 +91,8 @@ module SurgeAPI
         #   @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

@@ -69,7 +69,17 @@ 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
@@ -81,6 +91,8 @@ module SurgeAPI
         #   @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

@@ -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/resources/blasts.rb

@@ -8,7 +8,7 @@ module SurgeAPI
       #
       # Sends a Blast.
       #
-      # @overload create(account_id, attachments: nil, body: nil, contacts: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
+      # @overload create(account_id, attachments: nil, body: nil, contacts: nil, from: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
       #
       # @param account_id [String] The account for which the blast should be sent.
       #
@@ -18,6 +18,8 @@ module SurgeAPI
       #
       # @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/version.rb

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

data/rbi/surge_api/models/blast_create_params.rbi

@@ -37,6 +37,15 @@ module SurgeAPI
       sig { params(contacts: T::Array[String]).void }
       attr_writer :contacts
 
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from
+
+      sig { params(from: String).void }
+      attr_writer :from
+
       # Optional name for the blast.
       sig { returns(T.nilable(String)) }
       attr_reader :name
@@ -72,6 +81,7 @@ module SurgeAPI
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
           body: String,
           contacts: T::Array[String],
+          from: String,
           name: String,
           segments: T::Array[String],
           send_at: Time,
@@ -85,6 +95,10 @@ module SurgeAPI
         body: nil,
         # Deprecated. Use `to` instead.
         contacts: nil,
+        # 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.
+        from: nil,
         # Optional name for the blast.
         name: nil,
         # Deprecated. Use `to` instead.
@@ -104,6 +118,7 @@ module SurgeAPI
             attachments: T::Array[SurgeAPI::BlastCreateParams::Attachment],
             body: String,
             contacts: T::Array[String],
+            from: String,
             name: String,
             segments: T::Array[String],
             send_at: Time,

data/rbi/surge_api/models/message.rbi

@@ -23,6 +23,14 @@ module SurgeAPI
       end
       attr_writer :attachments
 
+      # The ID of the blast this message belongs to, if any. This can be used to
+      # attribute messages back to a specific blast.
+      sig { returns(T.nilable(String)) }
+      attr_reader :blast_id
+
+      sig { params(blast_id: String).void }
+      attr_writer :blast_id
+
       # The message body.
       sig { returns(T.nilable(String)) }
       attr_reader :body
@@ -37,23 +45,37 @@ module SurgeAPI
       sig { params(conversation: SurgeAPI::Message::Conversation::OrHash).void }
       attr_writer :conversation
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # A Message is a communication sent to a Contact.
       sig do
         params(
           id: String,
           attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
+          blast_id: String,
           body: String,
-          conversation: SurgeAPI::Message::Conversation::OrHash
+          conversation: SurgeAPI::Message::Conversation::OrHash,
+          metadata: T::Hash[Symbol, String]
         ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the object.
         id: nil,
         attachments: nil,
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        blast_id: nil,
         # The message body.
         body: nil,
         # A conversation with a Contact
-        conversation: nil
+        conversation: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil
       )
       end
 
@@ -62,8 +84,10 @@ module SurgeAPI
           {
             id: String,
             attachments: T::Array[SurgeAPI::Message::Attachment],
+            blast_id: String,
             body: String,
-            conversation: SurgeAPI::Message::Conversation
+            conversation: SurgeAPI::Message::Conversation,
+            metadata: T::Hash[Symbol, String]
           }
         )
       end

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -120,6 +120,14 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
@@ -131,7 +139,8 @@ module SurgeAPI
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -144,7 +153,10 @@ module SurgeAPI
           # When the message was delivered
           delivered_at:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -159,7 +171,8 @@ module SurgeAPI
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment
-                ]
+                ],
+              blast_id: String
             }
           )
         end

data/rbi/surge_api/models/message_failed_webhook_event.rbi

@@ -122,6 +122,14 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
@@ -134,7 +142,8 @@ module SurgeAPI
             attachments:
               T::Array[
                 SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -149,7 +158,10 @@ module SurgeAPI
           # The reason the message failed to be delivered
           failure_reason:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -163,7 +175,8 @@ module SurgeAPI
               failed_at: Time,
               failure_reason: String,
               attachments:
-                T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
+                T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
+              blast_id: String
             }
           )
         end

data/rbi/surge_api/models/message_params.rbi

@@ -70,6 +70,13 @@ module SurgeAPI
         sig { params(body: String).void }
         attr_writer :body
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, String]).void }
+        attr_writer :metadata
+
         # An optional datetime for scheduling message up to a couple of months in the
         # future.
         sig { returns(T.nilable(Time)) }
@@ -89,6 +96,7 @@ module SurgeAPI
                 SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment::OrHash
               ],
             body: String,
+            metadata: T::Hash[Symbol, String],
             send_at: Time
           ).returns(T.attached_class)
         end
@@ -99,6 +107,8 @@ module SurgeAPI
           attachments: nil,
           # The message body.
           body: nil,
+          # Set of key-value pairs that will be stored with the object.
+          metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
           send_at: nil
@@ -115,6 +125,7 @@ module SurgeAPI
                   SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment
                 ],
               body: String,
+              metadata: T::Hash[Symbol, String],
               send_at: Time
             }
           )
@@ -341,6 +352,13 @@ module SurgeAPI
         sig { params(from: String).void }
         attr_writer :from
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, String]).void }
+        attr_writer :metadata
+
         # An optional datetime for scheduling message up to a couple of months in the
         # future.
         sig { returns(T.nilable(Time)) }
@@ -359,6 +377,7 @@ module SurgeAPI
               ],
             body: String,
             from: String,
+            metadata: T::Hash[Symbol, String],
             send_at: Time
           ).returns(T.attached_class)
         end
@@ -372,6 +391,8 @@ module SurgeAPI
           # The sender's phone number in E.164 format or phone number ID. If omitted, uses
           # the account's default phone number. Cannot be used together with 'conversation'.
           from: nil,
+          # Set of key-value pairs that will be stored with the object.
+          metadata: nil,
           # An optional datetime for scheduling message up to a couple of months in the
           # future.
           send_at: nil
@@ -388,6 +409,7 @@ module SurgeAPI
                 ],
               body: String,
               from: String,
+              metadata: T::Hash[Symbol, String],
               send_at: Time
             }
           )

data/rbi/surge_api/models/message_received_webhook_event.rbi

@@ -120,6 +120,14 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
@@ -131,7 +139,8 @@ module SurgeAPI
             attachments:
               T::Array[
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -144,7 +153,10 @@ module SurgeAPI
           # When the message was received
           received_at:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -159,7 +171,8 @@ module SurgeAPI
               attachments:
                 T::Array[
                   SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment
-                ]
+                ],
+              blast_id: String
             }
           )
         end

data/rbi/surge_api/models/message_sent_webhook_event.rbi

@@ -113,6 +113,14 @@ module SurgeAPI
         end
         attr_writer :attachments
 
+        # The ID of the blast this message belongs to, if any. This can be used to
+        # attribute messages back to a specific blast.
+        sig { returns(T.nilable(String)) }
+        attr_reader :blast_id
+
+        sig { params(blast_id: String).void }
+        attr_writer :blast_id
+
         # The data associated with the event
         sig do
           params(
@@ -124,7 +132,8 @@ module SurgeAPI
             attachments:
               T::Array[
                 SurgeAPI::MessageSentWebhookEvent::Data::Attachment::OrHash
-              ]
+              ],
+            blast_id: String
           ).returns(T.attached_class)
         end
         def self.new(
@@ -137,7 +146,10 @@ module SurgeAPI
           # When the message was sent
           sent_at:,
           # Attachments included with the message
-          attachments: nil
+          attachments: nil,
+          # The ID of the blast this message belongs to, if any. This can be used to
+          # attribute messages back to a specific blast.
+          blast_id: nil
         )
         end
 
@@ -150,7 +162,8 @@ module SurgeAPI
                 SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
               sent_at: Time,
               attachments:
-                T::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
+                T::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
+              blast_id: String
             }
           )
         end

data/rbi/surge_api/models/phone_number.rbi

@@ -59,6 +59,8 @@ module SurgeAPI
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         LOCAL = T.let(:local, SurgeAPI::PhoneNumber::Type::TaggedSymbol)
+        SHORT_CODE =
+          T.let(:short_code, SurgeAPI::PhoneNumber::Type::TaggedSymbol)
         TOLL_FREE = T.let(:toll_free, SurgeAPI::PhoneNumber::Type::TaggedSymbol)
 
         sig do

data/rbi/surge_api/resources/blasts.rbi

@@ -11,6 +11,7 @@ module SurgeAPI
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
           body: String,
           contacts: T::Array[String],
+          from: String,
           name: String,
           segments: T::Array[String],
           send_at: Time,
@@ -26,6 +27,10 @@ module SurgeAPI
         body: nil,
         # Deprecated. Use `to` instead.
         contacts: nil,
+        # 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.
+        from: nil,
         # Optional name for the blast.
         name: nil,
         # Deprecated. Use `to` instead.

data/sig/surge_api/models/blast_create_params.rbs

@@ -5,6 +5,7 @@ module SurgeAPI
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         body: String,
         contacts: ::Array[String],
+        from: String,
         name: String,
         segments: ::Array[String],
         send_at: Time,
@@ -30,6 +31,10 @@ module SurgeAPI
 
       def contacts=: (::Array[String]) -> ::Array[String]
 
+      attr_reader from: String?
+
+      def from=: (String) -> String
+
       attr_reader name: String?
 
       def name=: (String) -> String
@@ -50,6 +55,7 @@ module SurgeAPI
         ?attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         ?body: String,
         ?contacts: ::Array[String],
+        ?from: String,
         ?name: String,
         ?segments: ::Array[String],
         ?send_at: Time,
@@ -61,6 +67,7 @@ module SurgeAPI
         attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         body: String,
         contacts: ::Array[String],
+        from: String,
         name: String,
         segments: ::Array[String],
         send_at: Time,

data/sig/surge_api/models/message.rbs

@@ -4,8 +4,10 @@ module SurgeAPI
       {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
+        blast_id: String,
         body: String,
-        conversation: SurgeAPI::Message::Conversation
+        conversation: SurgeAPI::Message::Conversation,
+        metadata: ::Hash[Symbol, String]
       }
 
     class Message < SurgeAPI::Internal::Type::BaseModel
@@ -19,6 +21,10 @@ module SurgeAPI
         ::Array[SurgeAPI::Message::Attachment]
       ) -> ::Array[SurgeAPI::Message::Attachment]
 
+      attr_reader blast_id: String?
+
+      def blast_id=: (String) -> String
+
       attr_reader body: String?
 
       def body=: (String) -> String
@@ -29,18 +35,26 @@ module SurgeAPI
         SurgeAPI::Message::Conversation
       ) -> SurgeAPI::Message::Conversation
 
+      attr_reader metadata: ::Hash[Symbol, String]?
+
+      def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Message::Attachment],
+        ?blast_id: String,
         ?body: String,
-        ?conversation: SurgeAPI::Message::Conversation
+        ?conversation: SurgeAPI::Message::Conversation,
+        ?metadata: ::Hash[Symbol, String]
       ) -> void
 
       def to_hash: -> {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
+        blast_id: String,
         body: String,
-        conversation: SurgeAPI::Message::Conversation
+        conversation: SurgeAPI::Message::Conversation,
+        metadata: ::Hash[Symbol, String]
       }
 
       type attachment = { id: String, type: String, url: String }

data/sig/surge_api/models/message_delivered_webhook_event.rbs

@@ -37,7 +37,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
-          attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
       class Data < SurgeAPI::Internal::Type::BaseModel
@@ -55,12 +56,17 @@ module SurgeAPI
           ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
         ) -> ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
 
+        attr_reader blast_id: String?
+
+        def blast_id=: (String) -> String
+
         def initialize: (
           id: String,
           body: String,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
-          ?attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
+          ?attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
+          ?blast_id: String
         ) -> void
 
         def to_hash: -> {
@@ -68,7 +74,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
-          attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
         type conversation =

data/sig/surge_api/models/message_failed_webhook_event.rbs

@@ -38,7 +38,8 @@ module SurgeAPI
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,
-          attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
       class Data < SurgeAPI::Internal::Type::BaseModel
@@ -58,13 +59,18 @@ module SurgeAPI
           ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
         ) -> ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
 
+        attr_reader blast_id: String?
+
+        def blast_id=: (String) -> String
+
         def initialize: (
           id: String,
           body: String,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,
-          ?attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
+          ?attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
+          ?blast_id: String
         ) -> void
 
         def to_hash: -> {
@@ -73,7 +79,8 @@ module SurgeAPI
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
           failure_reason: String,
-          attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
         type conversation =

data/sig/surge_api/models/message_params.rbs

@@ -12,6 +12,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           body: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -28,6 +29,10 @@ module SurgeAPI
 
         def body=: (String) -> String
 
+        attr_reader metadata: ::Hash[Symbol, String]?
+
+        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
         attr_reader send_at: Time?
 
         def send_at=: (Time) -> Time
@@ -36,6 +41,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           ?attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           ?body: String,
+          ?metadata: ::Hash[Symbol, String],
           ?send_at: Time
         ) -> void
 
@@ -43,6 +49,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageParams::MessageParamsWithConversation::Conversation,
           attachments: ::Array[SurgeAPI::MessageParams::MessageParamsWithConversation::Attachment],
           body: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -132,6 +139,7 @@ module SurgeAPI
           attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           body: String,
           from: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 
@@ -152,6 +160,10 @@ module SurgeAPI
 
         def from=: (String) -> String
 
+        attr_reader metadata: ::Hash[Symbol, String]?
+
+        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
         attr_reader send_at: Time?
 
         def send_at=: (Time) -> Time
@@ -161,6 +173,7 @@ module SurgeAPI
           ?attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           ?body: String,
           ?from: String,
+          ?metadata: ::Hash[Symbol, String],
           ?send_at: Time
         ) -> void
 
@@ -169,6 +182,7 @@ module SurgeAPI
           attachments: ::Array[SurgeAPI::MessageParams::SimpleMessageParams::Attachment],
           body: String,
           from: String,
+          metadata: ::Hash[Symbol, String],
           send_at: Time
         }
 

data/sig/surge_api/models/message_received_webhook_event.rbs

@@ -37,7 +37,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
-          attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
       class Data < SurgeAPI::Internal::Type::BaseModel
@@ -55,12 +56,17 @@ module SurgeAPI
           ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]
         ) -> ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]
 
+        attr_reader blast_id: String?
+
+        def blast_id=: (String) -> String
+
         def initialize: (
           id: String,
           body: String,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
-          ?attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]
+          ?attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
+          ?blast_id: String
         ) -> void
 
         def to_hash: -> {
@@ -68,7 +74,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           received_at: Time,
-          attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
         type conversation =

data/sig/surge_api/models/message_sent_webhook_event.rbs

@@ -37,7 +37,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
-          attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
       class Data < SurgeAPI::Internal::Type::BaseModel
@@ -55,12 +56,17 @@ module SurgeAPI
           ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
         ) -> ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
 
+        attr_reader blast_id: String?
+
+        def blast_id=: (String) -> String
+
         def initialize: (
           id: String,
           body: String,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
-          ?attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
+          ?attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
+          ?blast_id: String
         ) -> void
 
         def to_hash: -> {
@@ -68,7 +74,8 @@ module SurgeAPI
           body: String,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           sent_at: Time,
-          attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]
+          attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
+          blast_id: String
         }
 
         type conversation =

data/sig/surge_api/models/phone_number.rbs

@@ -22,12 +22,13 @@ module SurgeAPI
         type: SurgeAPI::Models::PhoneNumber::type_
       }
 
-      type type_ = :local | :toll_free
+      type type_ = :local | :short_code | :toll_free
 
       module Type
         extend SurgeAPI::Internal::Type::Enum
 
         LOCAL: :local
+        SHORT_CODE: :short_code
         TOLL_FREE: :toll_free
 
         def self?.values: -> ::Array[SurgeAPI::Models::PhoneNumber::type_]

data/sig/surge_api/resources/blasts.rbs

@@ -6,6 +6,7 @@ module SurgeAPI
         ?attachments: ::Array[SurgeAPI::BlastCreateParams::Attachment],
         ?body: String,
         ?contacts: ::Array[String],
+        ?from: String,
         ?name: String,
         ?segments: ::Array[String],
         ?send_at: Time,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-18 00:00:00.000000000 Z
+date: 2026-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi