surge_api 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ab0d460fe03be9712dc7d4ad68bc64e6ebb931573b9fe9ff91b8f36f2979514
-  data.tar.gz: 20488d8ba034a202671fa5cb1c3e0bde2c863bfa7826ed3ffb718911c34515ee
+  metadata.gz: 21d19ad8088d287a26c0293ecbec97d29a879616d98b219dbcb8c672c699f58d
+  data.tar.gz: eb81ac34997ec986242cdd64006a69d31f7bb76555a8a711644fcc06210c1293
 SHA512:
-  metadata.gz: abd73bd158429ed55c7343a89e85ce56ed40979df1278b20937250787bf360b91e1de84494abd4f1d2e9c2f3dc8f2bbfbedec04f1666b2d9b5798f976cda985f
-  data.tar.gz: bcbd4c0adb4baba0a737a833232f02abb63588f31a8d9ff70c39dee65037db86032efc12f34499c57ff46bd6b6b27c5276d6a9af4600fb290aced6e0014cda80
+  metadata.gz: af5bc8ed33052eb78f9a1bcb9e165e594f2b684891c6a159315903847da918c38ce1a4b8cb60bdb10b5cc4d144eb1a7398f816c90606268189408f9da6de25d0
+  data.tar.gz: 17951922f214b0a5d290fd520658d9964ae51972e5761199272d3193a91bfa3f2b52cc1fa749f4235174d42733472d732b2c20a4dd6767509b5b89b06e86d82b

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.11.0 (2026-02-22)
+
+Full Changelog: [v0.10.0...v0.11.0](https://github.com/surgeapi/ruby-sdk/compare/v0.10.0...v0.11.0)
+
+### Features
+
+* **api:** add list campaigns endpoint ([253f71e](https://github.com/surgeapi/ruby-sdk/commit/253f71e0ac6ba81778c59aeddf33a6a80b898ac3))
+* **api:** add metadata to message webhooks ([6827521](https://github.com/surgeapi/ruby-sdk/commit/68275214c295b5b102ef3c05a62ed08a03794ac6))
+* **api:** delete recording endpoint ([64d7bf2](https://github.com/surgeapi/ruby-sdk/commit/64d7bf2f8730fa7a11a4b38c07ade41a850bf5a8))
+* **api:** make attachment type an enum ([2897de1](https://github.com/surgeapi/ruby-sdk/commit/2897de13cd5eb3c95c30b251b7baf7edf5c0b6d7))
+
+
+### Chores
+
+* **internal:** remove mock server code ([1411557](https://github.com/surgeapi/ruby-sdk/commit/1411557864e6741dc576fe5802cbd2bb2dcaa9e6))
+* **test:** update skip reason message ([cbb9e45](https://github.com/surgeapi/ruby-sdk/commit/cbb9e4564283c9b1e733c443bba93cefe10d0f85))
+* update mock server docs ([cd3da3a](https://github.com/surgeapi/ruby-sdk/commit/cd3da3a27ea9d4d5a511ecf8ea82ca4fbe00eaef))
+
 ## 0.10.0 (2026-02-12)
 
 Full Changelog: [v0.9.0...v0.10.0](https://github.com/surgeapi/ruby-sdk/compare/v0.9.0...v0.10.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.10.0"
+gem "surge_api", "~> 0.11.0"
 ```
 
 <!-- x-release-please-end -->
@@ -44,15 +44,15 @@ List methods in the Surge API are paginated.
 This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```ruby
-page = surge.contacts.list
+page = surge.campaigns.list
 
 # Fetch single item from page.
-contact = page.data[0]
-puts(contact.id)
+campaign = page.data[0]
+puts(campaign.id)
 
 # Automatically fetches more pages as needed.
-page.auto_paging_each do |contact|
-  puts(contact.id)
+page.auto_paging_each do |campaign|
+  puts(campaign.id)
 end
 ```
 

data/lib/surge_api/internal/cursor.rb

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

data/lib/surge_api/models/campaign_list_params.rb

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

data/lib/surge_api/models/message.rb

@@ -68,8 +68,8 @@ module SurgeAPI
         # @!attribute type
         #   The type of attachment.
         #
-        #   @return [String, nil]
-        optional :type, String
+        #   @return [Symbol, SurgeAPI::Models::Message::Attachment::Type, nil]
+        optional :type, enum: -> { SurgeAPI::Message::Attachment::Type }
 
         # @!attribute url
         #   The URL of the attachment.
@@ -82,9 +82,24 @@ module SurgeAPI
         #
         #   @param id [String] Unique identifier for the object.
         #
-        #   @param type [String] The type of attachment.
+        #   @param type [Symbol, SurgeAPI::Models::Message::Attachment::Type] The type of attachment.
         #
         #   @param url [String] The URL of the attachment.
+
+        # The type of attachment.
+        #
+        # @see SurgeAPI::Models::Message::Attachment#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          FILE = :file
+          IMAGE = :image
+          LINK = :link
+          VIDEO = :video
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # @see SurgeAPI::Models::Message#conversation

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -62,6 +62,12 @@ module SurgeAPI
         #   @return [Time]
         required :delivered_at, Time
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute attachments
         #   Attachments included with the message
         #
@@ -76,7 +82,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, delivered_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, delivered_at:, metadata:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageDeliveredWebhookEvent::Data} for more details.
         #
@@ -90,6 +96,8 @@ module SurgeAPI
         #
         #   @param delivered_at [Time] When the message was delivered
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @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

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -68,6 +68,12 @@ module SurgeAPI
         #   @return [String]
         required :failure_reason, String
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute attachments
         #   Attachments included with the message
         #
@@ -82,7 +88,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, metadata:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageFailedWebhookEvent::Data} for more details.
         #
@@ -98,6 +104,8 @@ module SurgeAPI
         #
         #   @param failure_reason [String] The reason the message failed to be delivered
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @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

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -56,6 +56,12 @@ module SurgeAPI
         #   @return [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation]
         required :conversation, -> { SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation }
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute received_at
         #   When the message was received
         #
@@ -76,7 +82,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, received_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, metadata:, received_at:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageReceivedWebhookEvent::Data} for more details.
         #
@@ -88,6 +94,8 @@ module SurgeAPI
         #
         #   @param conversation [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param received_at [Time] When the message was received
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment>] Attachments included with the message

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -56,6 +56,12 @@ module SurgeAPI
         #   @return [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation]
         required :conversation, -> { SurgeAPI::MessageSentWebhookEvent::Data::Conversation }
 
+        # @!attribute metadata
+        #   Set of key-value pairs that will be stored with the object.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
         # @!attribute sent_at
         #   When the message was sent
         #
@@ -76,7 +82,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, sent_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, metadata:, sent_at:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageSentWebhookEvent::Data} for more details.
         #
@@ -88,6 +94,8 @@ module SurgeAPI
         #
         #   @param conversation [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation] The conversation this message belongs to
         #
+        #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+        #
         #   @param sent_at [Time] When the message was sent
         #
         #   @param attachments [Array<SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment>] Attachments included with the message

data/lib/surge_api/models/recording_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#delete
+    class RecordingDeleteParams < 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/recording_delete_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Recordings#delete
+    class RecordingDeleteResponse < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the recording
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute call
+      #   The call that produced this recording
+      #
+      #   @return [SurgeAPI::Models::RecordingDeleteResponse::Call]
+      required :call, -> { SurgeAPI::Models::RecordingDeleteResponse::Call }
+
+      # @!attribute duration
+      #   The duration of the recording in seconds
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!method initialize(id:, call:, duration:)
+      #   A call recording
+      #
+      #   @param id [String] The unique identifier for the recording
+      #
+      #   @param call [SurgeAPI::Models::RecordingDeleteResponse::Call] The call that produced this recording
+      #
+      #   @param duration [Integer] The duration of the recording in seconds
+
+      # @see SurgeAPI::Models::RecordingDeleteResponse#call
+      class Call < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the call
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute contact
+        #   A contact who has consented to receive messages
+        #
+        #   @return [SurgeAPI::Models::Contact]
+        required :contact, -> { SurgeAPI::Contact }
+
+        # @!attribute duration
+        #   The duration of the call in seconds
+        #
+        #   @return [Integer]
+        required :duration, Integer
+
+        # @!attribute initiated_at
+        #   When the call was initiated
+        #
+        #   @return [Time]
+        required :initiated_at, Time
+
+        # @!attribute status
+        #   The status of the call
+        #
+        #   @return [Symbol, SurgeAPI::Models::RecordingDeleteResponse::Call::Status]
+        required :status, enum: -> { SurgeAPI::Models::RecordingDeleteResponse::Call::Status }
+
+        # @!method initialize(id:, contact:, duration:, initiated_at:, status:)
+        #   The call that produced this recording
+        #
+        #   @param id [String] The unique identifier for the call
+        #
+        #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+        #
+        #   @param duration [Integer] The duration of the call in seconds
+        #
+        #   @param initiated_at [Time] When the call was initiated
+        #
+        #   @param status [Symbol, SurgeAPI::Models::RecordingDeleteResponse::Call::Status] The status of the call
+
+        # The status of the call
+        #
+        # @see SurgeAPI::Models::RecordingDeleteResponse::Call#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          BUSY = :busy
+          CANCELED = :canceled
+          COMPLETED = :completed
+          FAILED = :failed
+          IN_PROGRESS = :in_progress
+          MISSED = :missed
+          NO_ANSWER = :no_answer
+          QUEUED = :queued
+          RINGING = :ringing
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -63,6 +63,8 @@ module SurgeAPI
 
   CampaignCreateParams = SurgeAPI::Models::CampaignCreateParams
 
+  CampaignListParams = SurgeAPI::Models::CampaignListParams
+
   CampaignParams = SurgeAPI::Models::CampaignParams
 
   CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
@@ -115,6 +117,8 @@ module SurgeAPI
 
   RecordingCompletedWebhookEvent = SurgeAPI::Models::RecordingCompletedWebhookEvent
 
+  RecordingDeleteParams = SurgeAPI::Models::RecordingDeleteParams
+
   RecordingGetFileParams = SurgeAPI::Models::RecordingGetFileParams
 
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent

data/lib/surge_api/resources/campaigns.rb

@@ -55,6 +55,36 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::CampaignListParams} for more details.
+      #
+      # List all campaigns for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list campaigns for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::Campaign>]
+      #
+      # @see SurgeAPI::Models::CampaignListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::CampaignListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/campaigns", account_id],
+          query: parsed,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::Campaign,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [SurgeAPI::Client]

data/lib/surge_api/resources/recordings.rb

@@ -3,6 +3,27 @@
 module SurgeAPI
   module Resources
     class Recordings
+      # Deletes a recording. The recording file will be removed from storage
+      # asynchronously.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the recording.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::RecordingDeleteResponse]
+      #
+      # @see SurgeAPI::Models::RecordingDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["recordings/%1$s", id],
+          model: SurgeAPI::Models::RecordingDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Redirects to a signed URL where the recording audio file can be downloaded. URL
       # is short-lived, so redirect should be followed immediately.
       #

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -67,6 +67,7 @@ require_relative "surge_api/models/call_ended_webhook_event"
 require_relative "surge_api/models/campaign"
 require_relative "surge_api/models/campaign_approved_webhook_event"
 require_relative "surge_api/models/campaign_create_params"
+require_relative "surge_api/models/campaign_list_params"
 require_relative "surge_api/models/campaign_retrieve_params"
 require_relative "surge_api/models/contact"
 require_relative "surge_api/models/contact_create_params"
@@ -91,6 +92,8 @@ require_relative "surge_api/models/phone_number"
 require_relative "surge_api/models/phone_number_list_params"
 require_relative "surge_api/models/phone_number_purchase_params"
 require_relative "surge_api/models/recording_completed_webhook_event"
+require_relative "surge_api/models/recording_delete_params"
+require_relative "surge_api/models/recording_delete_response"
 require_relative "surge_api/models/recording_get_file_params"
 require_relative "surge_api/models/recording_get_file_response"
 require_relative "surge_api/models/unwrap_webhook_event"

data/rbi/surge_api/models/campaign_list_params.rbi

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

data/rbi/surge_api/models/message.rbi

@@ -102,10 +102,12 @@ module SurgeAPI
         attr_writer :id
 
         # The type of attachment.
-        sig { returns(T.nilable(String)) }
+        sig do
+          returns(T.nilable(SurgeAPI::Message::Attachment::Type::TaggedSymbol))
+        end
         attr_reader :type
 
-        sig { params(type: String).void }
+        sig { params(type: SurgeAPI::Message::Attachment::Type::OrSymbol).void }
         attr_writer :type
 
         # The URL of the attachment.
@@ -117,9 +119,11 @@ module SurgeAPI
 
         # An Attachment is a file that can be sent with a message.
         sig do
-          params(id: String, type: String, url: String).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            type: SurgeAPI::Message::Attachment::Type::OrSymbol,
+            url: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # Unique identifier for the object.
@@ -131,9 +135,41 @@ module SurgeAPI
         )
         end
 
-        sig { override.returns({ id: String, type: String, url: String }) }
+        sig do
+          override.returns(
+            {
+              id: String,
+              type: SurgeAPI::Message::Attachment::Type::TaggedSymbol,
+              url: String
+            }
+          )
+        end
         def to_hash
         end
+
+        # The type of attachment.
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, SurgeAPI::Message::Attachment::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FILE = T.let(:file, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          IMAGE =
+            T.let(:image, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          LINK = T.let(:link, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+          VIDEO =
+            T.let(:video, SurgeAPI::Message::Attachment::Type::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[SurgeAPI::Message::Attachment::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class Conversation < SurgeAPI::Internal::Type::BaseModel

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -100,6 +100,10 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :delivered_at
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # Attachments included with the message
         sig do
           returns(
@@ -136,6 +140,7 @@ module SurgeAPI
             conversation:
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
+            metadata: T::Hash[Symbol, String],
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
@@ -152,6 +157,8 @@ module SurgeAPI
           conversation:,
           # When the message was delivered
           delivered_at:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -168,6 +175,7 @@ module SurgeAPI
               conversation:
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,
+              metadata: T::Hash[Symbol, String],
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment