surge_api 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8cabbc1ca93255610f86e41e4408ee35552d4755552e0bb63dec43d34e37847
-  data.tar.gz: 94fd6a84dd1d08f71b3fb51125010f75d03f824538078a70103213297391c30b
+  metadata.gz: 21d19ad8088d287a26c0293ecbec97d29a879616d98b219dbcb8c672c699f58d
+  data.tar.gz: eb81ac34997ec986242cdd64006a69d31f7bb76555a8a711644fcc06210c1293
 SHA512:
-  metadata.gz: cce465d2b1f99e690347727f8e987b6afa07a0cd2eadfb0e0832b1bf1100477ae03592e774c9ee8929d9c2eb5903e820fac12ca0d8d28a6ed1207dcdabc33a3c
-  data.tar.gz: 184ca9625b88a0b8366f92f0760e1fd5f53abd52752a4c0284b99429442cc69280b29e9758d94381a0ca4fba98e693f36d083710a17883ad13c4aaae3b83d39b
+  metadata.gz: af5bc8ed33052eb78f9a1bcb9e165e594f2b684891c6a159315903847da918c38ce1a4b8cb60bdb10b5cc4d144eb1a7398f816c90606268189408f9da6de25d0
+  data.tar.gz: 17951922f214b0a5d290fd520658d9964ae51972e5761199272d3193a91bfa3f2b52cc1fa749f4235174d42733472d732b2c20a4dd6767509b5b89b06e86d82b

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # 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)
+
+### Features
+
+* **api:** add campaign.status field ([f0ab6be](https://github.com/surgeapi/ruby-sdk/commit/f0ab6bef5d1cbca9741b3731189e5a821c6abcb3))
+* **api:** add get campaign endpoint ([511d2b3](https://github.com/surgeapi/ruby-sdk/commit/511d2b3cd36a3e4a1f1737093a02f5c31296c332))
+* **api:** add recording.completed webhook ([9a72a0c](https://github.com/surgeapi/ruby-sdk/commit/9a72a0c754dad51ac7b02e84c3f8ce8e6ba85378))
+* **api:** add voicemail.received webhook ([37edfcd](https://github.com/surgeapi/ruby-sdk/commit/37edfcd3a2d26f42ea5a0fbf5481e046486f4456))
+* **api:** get recording file ([db0184e](https://github.com/surgeapi/ruby-sdk/commit/db0184e171168f74e20d91b65cea452a32aad263))
+
+
+### Bug Fixes
+
+* **api:** make message.blast_id nullable ([9096e75](https://github.com/surgeapi/ruby-sdk/commit/9096e75d5aa6803c4b11aba0fe2c61448abf3f6a))
+* **client:** loosen json header parsing ([51f4092](https://github.com/surgeapi/ruby-sdk/commit/51f409235dc8e2c377411b3f53595df8fea9b4e4))
+
 ## 0.9.0 (2026-02-04)
 
 Full Changelog: [v0.8.0...v0.9.0](https://github.com/surgeapi/ruby-sdk/compare/v0.8.0...v0.9.0)

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.9.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/client.rb

@@ -36,6 +36,9 @@ module SurgeAPI
     # @return [SurgeAPI::Resources::PhoneNumbers]
     attr_reader :phone_numbers
 
+    # @return [SurgeAPI::Resources::Recordings]
+    attr_reader :recordings
+
     # @return [SurgeAPI::Resources::Users]
     attr_reader :users
 
@@ -98,6 +101,7 @@ module SurgeAPI
       @contacts = SurgeAPI::Resources::Contacts.new(client: self)
       @messages = SurgeAPI::Resources::Messages.new(client: self)
       @phone_numbers = SurgeAPI::Resources::PhoneNumbers.new(client: self)
+      @recordings = SurgeAPI::Resources::Recordings.new(client: self)
       @users = SurgeAPI::Resources::Users.new(client: self)
       @verifications = SurgeAPI::Resources::Verifications.new(client: self)
       @webhooks = SurgeAPI::Resources::Webhooks.new(client: self)

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/internal/util.rb

@@ -485,7 +485,7 @@ module SurgeAPI
       end
 
       # @type [Regexp]
-      JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
+      JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
       # @type [Regexp]
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 

data/lib/surge_api/models/campaign.rb

@@ -60,6 +60,12 @@ module SurgeAPI
       #   @return [String]
       required :privacy_policy_url, String
 
+      # @!attribute status
+      #   The current status of the campaign.
+      #
+      #   @return [Symbol, SurgeAPI::Models::Campaign::Status]
+      required :status, enum: -> { SurgeAPI::Campaign::Status }
+
       # @!attribute use_cases
       #   A list containing 1-5 types of messages that will be sent with this campaign.
       #
@@ -125,7 +131,7 @@ module SurgeAPI
       #   @return [String, nil]
       optional :terms_and_conditions_url, String
 
-      # @!method initialize(id:, consent_flow:, description:, includes:, message_samples:, privacy_policy_url:, use_cases:, volume:, link_sample: nil, terms_and_conditions_url: nil)
+      # @!method initialize(id:, consent_flow:, description:, includes:, message_samples:, privacy_policy_url:, status:, use_cases:, volume:, link_sample: nil, terms_and_conditions_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::Campaign} for more details.
       #
@@ -144,6 +150,8 @@ module SurgeAPI
       #
       #   @param privacy_policy_url [String] The URL of the privacy policy for the brand in question. This may be a shared pr
       #
+      #   @param status [Symbol, SurgeAPI::Models::Campaign::Status] The current status of the campaign.
+      #
       #   @param use_cases [Array<Symbol, SurgeAPI::Models::Campaign::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
       #
       #   @param volume [Symbol, SurgeAPI::Models::Campaign::Volume] This will be one of the following:
@@ -164,6 +172,24 @@ module SurgeAPI
         #   @return [Array<Symbol>]
       end
 
+      # The current status of the campaign.
+      #
+      # @see SurgeAPI::Models::Campaign#status
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACTIVE = :active
+        CANCELED = :canceled
+        CREATED = :created
+        DEACTIVATED = :deactivated
+        IN_REVIEW = :in_review
+        PENDING = :pending
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       module UseCase
         extend SurgeAPI::Internal::Type::Enum
 

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/campaign_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Campaigns#retrieve
+    class CampaignRetrieveParams < 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/message.rb

@@ -20,7 +20,7 @@ module SurgeAPI
       #   attribute messages back to a specific blast.
       #
       #   @return [String, nil]
-      optional :blast_id, String
+      optional :blast_id, String, nil?: true
 
       # @!attribute body
       #   The message body.
@@ -50,7 +50,7 @@ module SurgeAPI
       #
       #   @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 blast_id [String, nil] The ID of the blast this message belongs to, if any. This can be used to attribu
       #
       #   @param body [String, nil] The message body.
       #
@@ -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_completed_webhook_event.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class RecordingCompletedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::RecordingCompletedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::RecordingCompletedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `recording.completed` for this event.
+      #
+      #   @return [Symbol, :"recording.completed"]
+      required :type, const: :"recording.completed"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"recording.completed")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::RecordingCompletedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"recording.completed"] The type of the event. Always `recording.completed` for this event.
+
+      # @see SurgeAPI::Models::RecordingCompletedWebhookEvent#data
+      class Data < 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::RecordingCompletedWebhookEvent::Data::Call]
+        required :call, -> { SurgeAPI::RecordingCompletedWebhookEvent::Data::Call }
+
+        # @!attribute duration
+        #   The duration of the recording in seconds
+        #
+        #   @return [Integer]
+        required :duration, Integer
+
+        # @!method initialize(id:, call:, duration:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the recording
+        #
+        #   @param call [SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call] The call that produced this recording
+        #
+        #   @param duration [Integer] The duration of the recording in seconds
+
+        # @see SurgeAPI::Models::RecordingCompletedWebhookEvent::Data#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::RecordingCompletedWebhookEvent::Data::Call::Status]
+          required :status, enum: -> { SurgeAPI::RecordingCompletedWebhookEvent::Data::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::RecordingCompletedWebhookEvent::Data::Call::Status] The status of the call
+
+          # The status of the call
+          #
+          # @see SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::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
+end

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