surge_api 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541f8a85e6dd07ee15cac3b443594f6b23bbf698b378bbc5bc55da6419722a61
-  data.tar.gz: e15984328219753afe1bb9bb52dc9b707242b8e54e167c008c575394f1a75583
+  metadata.gz: b5716cf1bf5c2e7a858c9c7a706c388a3a174518d8d1170c4254b5a813e7bd0d
+  data.tar.gz: 6a184865cd4ac3b7a8498431c2b229b64794624768f7e4782ad7d74b2d7b98e3
 SHA512:
-  metadata.gz: cf1f1c0febccea9dc939c89bf0b42d55ac270c21c1527e99dfbda2455938cffb43c6e331fe69943a804e217236cc0f9604a64a9f2de0e3430946c9f672adbc09
-  data.tar.gz: 1bedab08c1f123a8354f7338c7cfa85726ceec321b68e3f10568ef6b4c9045372d1aedd4c9268a4ddb9e46d385e8637e3ca93f543d78be96470afbb249ceac2b
+  metadata.gz: 4a2f8940ada65f353148d318d9167f83d25a145a766018d83245aa8fece4f6cb27d419f2ecf164e0a4a03b253a443cfcdd543ac0cdaaf55d01459d8ca87e6959
+  data.tar.gz: f65c4af57e2f91a1604c54b119285014d42beb0e070e98cf91610bb4a77b17bf1a7dc8246710d5f970a1c37661eed4e4413bb3caa9b0d505b49807765ed5ba47

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.24.0 (2026-09-04)
+
+Full Changelog: [v0.23.0...v0.24.0](https://github.com/surgeapi/ruby-sdk/compare/v0.23.0...v0.24.0)
+
+### Features
+
+* **api:** add status to messages ([1a1b928](https://github.com/surgeapi/ruby-sdk/commit/1a1b9288784e37ae35e8c01f814eb39e952a24b0))
+* **api:** add toll free messaging capability to accounts ([87fff80](https://github.com/surgeapi/ruby-sdk/commit/87fff8049ea378688bd2ca8df6b4f5e9919ee832))
+* **api:** phone number imported webhook event ([358bf6d](https://github.com/surgeapi/ruby-sdk/commit/358bf6d5128520687260208216f8923a6c37db29))
+
+
+### Documentation
+
+* **api:** add note about links in messages for campaigns ([0b7c72d](https://github.com/surgeapi/ruby-sdk/commit/0b7c72ddf56ff3a92959ff50b484a55f62807e42))
+* **api:** add note about links in messages for campaigns (continued) ([0847773](https://github.com/surgeapi/ruby-sdk/commit/0847773d88887971ec454d1ff89ac3a979ed9e0d))
+
 ## 0.23.0 (2026-08-19)
 
 Full Changelog: [v0.22.0...v0.23.0](https://github.com/surgeapi/ruby-sdk/compare/v0.22.0...v0.23.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.23.0"
+gem "surge_api", "~> 0.24.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/models/account_retrieve_status_params.rb

@@ -31,6 +31,7 @@ module SurgeAPI
         extend SurgeAPI::Internal::Type::Enum
 
         LOCAL_MESSAGING = :local_messaging
+        TOLL_FREE_MESSAGING = :toll_free_messaging
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/surge_api/models/campaign.rb

@@ -113,11 +113,10 @@ module SurgeAPI
       required :volume, enum: -> { SurgeAPI::Campaign::Volume }
 
       # @!attribute link_sample
-      #   A sample link that might be sent by this campaign. If links from other domains
-      #   are sent through this campaign, they are much more likely to be filtered by the
-      #   carriers. If link shortening is enabled for the account, the link shortener URL
-      #   will be used instead of what is provided. Reach out to support if you would like
-      #   to disable automatic link shortening.
+      #   A sample link that might be sent by this campaign. This is required when
+      #   `includes` contains `links`. Provide the same URL or domain that the campaign
+      #   will use in production. If links from other domains are sent through this
+      #   campaign, they are much more likely to be filtered by the carriers.
       #
       #   @return [String, nil]
       optional :link_sample, String
@@ -156,7 +155,7 @@ module SurgeAPI
       #
       #   @param volume [Symbol, SurgeAPI::Models::Campaign::Volume] This will be one of the following:
       #
-      #   @param link_sample [String] A sample link that might be sent by this campaign. If links from other domains a
+      #   @param link_sample [String] A sample link that might be sent by this campaign. This is required when `includ
       #
       #   @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
 
@@ -180,6 +179,7 @@ module SurgeAPI
 
         ACTIVE = :active
         CANCELED = :canceled
+        REJECTED = :rejected
         CREATED = :created
         DEACTIVATED = :deactivated
         IN_REVIEW = :in_review

data/lib/surge_api/models/campaign_params.rb

@@ -122,11 +122,10 @@ module SurgeAPI
                  -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignParams::StandardCampaignParams::Include] }
 
         # @!attribute link_sample
-        #   A sample link that might be sent by this campaign. If links from other domains
-        #   are sent through this campaign, they are much more likely to be filtered by the
-        #   carriers. If link shortening is enabled for the account, the link shortener URL
-        #   will be used instead of what is provided. Reach out to support if you would like
-        #   to disable automatic link shortening.
+        #   A sample link that might be sent by this campaign. This is required when
+        #   `includes` contains `links`. Provide the same URL or domain that the campaign
+        #   will use in production. If links from other domains are sent through this
+        #   campaign, they are much more likely to be filtered by the carriers.
         #
         #   @return [String, nil]
         optional :link_sample, String
@@ -153,7 +152,7 @@ module SurgeAPI
         #
         #   @param includes [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Include>] A list of properties that this campaign should include. These properties can be
         #
-        #   @param link_sample [String] A sample link that might be sent by this campaign. If links from other domains a
+        #   @param link_sample [String] A sample link that might be sent by this campaign. This is required when `includ
 
         module UseCase
           extend SurgeAPI::Internal::Type::Enum

data/lib/surge_api/models/message.rb

@@ -40,7 +40,13 @@ module SurgeAPI
       #   @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)
+      # @!attribute status
+      #   The current status of the message.
+      #
+      #   @return [Symbol, SurgeAPI::Models::Message::Status, nil]
+      optional :status, enum: -> { SurgeAPI::Message::Status }
+
+      # @!method initialize(id: nil, attachments: nil, blast_id: nil, body: nil, conversation: nil, metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::Message} for more details.
       #
@@ -57,6 +63,8 @@ module SurgeAPI
       #   @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.
+      #
+      #   @param status [Symbol, SurgeAPI::Models::Message::Status] The current status of the message.
 
       class Attachment < SurgeAPI::Internal::Type::BaseModel
         # @!attribute id
@@ -185,6 +193,22 @@ module SurgeAPI
           end
         end
       end
+
+      # The current status of the message.
+      #
+      # @see SurgeAPI::Models::Message#status
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        PENDING = :pending
+        RECEIVED = :received
+        SENT = :sent
+        DELIVERED = :delivered
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -68,6 +68,12 @@ module SurgeAPI
         #   @return [Hash{Symbol=>String}]
         required :metadata, SurgeAPI::Internal::Type::HashOf[String]
 
+        # @!attribute status
+        #   The message status represented by this event
+        #
+        #   @return [Symbol, SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::MessageDeliveredWebhookEvent::Data::Status }
+
         # @!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:, delivered_at:, metadata:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, delivered_at:, metadata:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageDeliveredWebhookEvent::Data} for more details.
         #
@@ -98,6 +104,8 @@ module SurgeAPI
         #
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #
+        #   @param status [Symbol, SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Status] The message status represented by this event
+        #
         #   @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
@@ -132,6 +140,18 @@ module SurgeAPI
           #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
         end
 
+        # The message status represented by this event
+        #
+        # @see SurgeAPI::Models::MessageDeliveredWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          DELIVERED = :delivered
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the attachment

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -74,6 +74,12 @@ module SurgeAPI
         #   @return [Hash{Symbol=>String}]
         required :metadata, SurgeAPI::Internal::Type::HashOf[String]
 
+        # @!attribute status
+        #   The message status represented by this event
+        #
+        #   @return [Symbol, SurgeAPI::Models::MessageFailedWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::MessageFailedWebhookEvent::Data::Status }
+
         # @!attribute attachments
         #   Attachments included with the message
         #
@@ -88,7 +94,7 @@ module SurgeAPI
         #   @return [String, nil]
         optional :blast_id, String
 
-        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, metadata:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, metadata:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageFailedWebhookEvent::Data} for more details.
         #
@@ -106,6 +112,8 @@ module SurgeAPI
         #
         #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
         #
+        #   @param status [Symbol, SurgeAPI::Models::MessageFailedWebhookEvent::Data::Status] The message status represented by this event
+        #
         #   @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
@@ -140,6 +148,18 @@ module SurgeAPI
           #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
         end
 
+        # The message status represented by this event
+        #
+        # @see SurgeAPI::Models::MessageFailedWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          FAILED = :failed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the attachment

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -68,6 +68,12 @@ module SurgeAPI
         #   @return [Time]
         required :received_at, Time
 
+        # @!attribute status
+        #   The message status represented by this event
+        #
+        #   @return [Symbol, SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::MessageReceivedWebhookEvent::Data::Status }
+
         # @!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:, metadata:, received_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, metadata:, received_at:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageReceivedWebhookEvent::Data} for more details.
         #
@@ -98,6 +104,8 @@ module SurgeAPI
         #
         #   @param received_at [Time] When the message was received
         #
+        #   @param status [Symbol, SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Status] The message status represented by this event
+        #
         #   @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
@@ -132,6 +140,18 @@ module SurgeAPI
           #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
         end
 
+        # The message status represented by this event
+        #
+        # @see SurgeAPI::Models::MessageReceivedWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          RECEIVED = :received
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the attachment

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -68,6 +68,12 @@ module SurgeAPI
         #   @return [Time]
         required :sent_at, Time
 
+        # @!attribute status
+        #   The message status represented by this event
+        #
+        #   @return [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Status]
+        required :status, enum: -> { SurgeAPI::MessageSentWebhookEvent::Data::Status }
+
         # @!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:, metadata:, sent_at:, attachments: nil, blast_id: nil)
+        # @!method initialize(id:, body:, conversation:, metadata:, sent_at:, status:, attachments: nil, blast_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {SurgeAPI::Models::MessageSentWebhookEvent::Data} for more details.
         #
@@ -98,6 +104,8 @@ module SurgeAPI
         #
         #   @param sent_at [Time] When the message was sent
         #
+        #   @param status [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Status] The message status represented by this event
+        #
         #   @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
@@ -132,6 +140,18 @@ module SurgeAPI
           #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
         end
 
+        # The message status represented by this event
+        #
+        # @see SurgeAPI::Models::MessageSentWebhookEvent::Data#status
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          SENT = :sent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           # @!attribute id
           #   The unique identifier for the attachment

data/lib/surge_api/models/phone_number_imported_webhook_event.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class PhoneNumberImportedWebhookEvent < 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::PhoneNumberImportedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::PhoneNumberImportedWebhookEvent::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 `phone_number.imported` for this event.
+      #
+      #   @return [Symbol, :"phone_number.imported"]
+      required :type, const: :"phone_number.imported"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"phone_number.imported")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"phone_number.imported"] The type of the event. Always `phone_number.imported` for this event.
+
+      # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the phone number
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute campaign
+        #   Campaign attachment details for a domestic local phone number
+        #
+        #   @return [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign, nil]
+        required :campaign, -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign }, nil?: true
+
+        # @!attribute campaign_id
+        #   @deprecated Use `campaign.id` instead.
+        #
+        #   Deprecated. The unique identifier of the campaign this phone number is attached
+        #   to
+        #
+        #   @return [String, nil]
+        required :campaign_id, String, nil?: true
+
+        # @!attribute name
+        #   A human-readable name for the phone number
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute number
+        #   The phone number in E.164 format
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute type
+        #   Whether the phone number is local, toll-free, or short code
+        #
+        #   @return [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Type]
+        required :type, enum: -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type }
+
+        # @!method initialize(id:, campaign:, campaign_id:, name:, number:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data} for more details.
+        #
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the phone number
+        #
+        #   @param campaign [SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign, nil] Campaign attachment details for a domestic local phone number
+        #
+        #   @param campaign_id [String, nil] Deprecated. The unique identifier of the campaign this phone number is attached
+        #
+        #   @param name [String, nil] A human-readable name for the phone number
+        #
+        #   @param number [String] The phone number in E.164 format
+        #
+        #   @param type [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Type] Whether the phone number is local, toll-free, or short code
+
+        # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data#campaign
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier of the campaign this phone number is attached to
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute attachment_status
+          #   The current campaign attachment status for this phone number.
+          #
+          #   @return [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus]
+          required :attachment_status,
+                   enum: -> { SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus }
+
+          # @!method initialize(id:, attachment_status:)
+          #   Campaign attachment details for a domestic local phone number
+          #
+          #   @param id [String] The unique identifier of the campaign this phone number is attached to
+          #
+          #   @param attachment_status [Symbol, SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus] The current campaign attachment status for this phone number.
+
+          # The current campaign attachment status for this phone number.
+          #
+          # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data::Campaign#attachment_status
+          module AttachmentStatus
+            extend SurgeAPI::Internal::Type::Enum
+
+            ATTACHED = :attached
+            ATTACHMENT_PENDING = :attachment_pending
+            DETACHED = :detached
+            DETACHMENT_PENDING = :detachment_pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Whether the phone number is local, toll-free, or short code
+        #
+        # @see SurgeAPI::Models::PhoneNumberImportedWebhookEvent::Data#type
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          LOCAL = :local
+          SHORT_CODE = :short_code
+          TOLL_FREE = :toll_free
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/unwrap_webhook_event.rb

@@ -29,12 +29,14 @@ module SurgeAPI
 
       variant :"phone_number.attached_to_campaign", -> { SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent }
 
+      variant :"phone_number.imported", -> { SurgeAPI::PhoneNumberImportedWebhookEvent }
+
       variant :"recording.completed", -> { SurgeAPI::RecordingCompletedWebhookEvent }
 
       variant :"voicemail.received", -> { SurgeAPI::VoicemailReceivedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent)]
+      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent)]
     end
   end
 end

data/lib/surge_api/models.rb

@@ -130,6 +130,8 @@ module SurgeAPI
 
   PhoneNumberAttachedToCampaignWebhookEvent = SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent
 
+  PhoneNumberImportedWebhookEvent = SurgeAPI::Models::PhoneNumberImportedWebhookEvent
+
   PhoneNumberListAvailableNumbersParams = SurgeAPI::Models::PhoneNumberListAvailableNumbersParams
 
   PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams

data/lib/surge_api/resources/webhooks.rb

@@ -9,7 +9,7 @@ module SurgeAPI
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
+      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
       def unwrap(payload, headers:, key: @client.webhook_signing_secret)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_signing_secret or passed in as an argument")

data/lib/surge_api/version.rb

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

data/lib/surge_api.rb

@@ -102,6 +102,7 @@ require_relative "surge_api/models/message_sent_webhook_event"
 require_relative "surge_api/models/organization"
 require_relative "surge_api/models/phone_number"
 require_relative "surge_api/models/phone_number_attached_to_campaign_webhook_event"
+require_relative "surge_api/models/phone_number_imported_webhook_event"
 require_relative "surge_api/models/phone_number_list_available_numbers_params"
 require_relative "surge_api/models/phone_number_list_available_numbers_response"
 require_relative "surge_api/models/phone_number_list_params"

data/rbi/surge_api/models/account_retrieve_status_params.rbi

@@ -88,6 +88,11 @@ module SurgeAPI
             :local_messaging,
             SurgeAPI::AccountRetrieveStatusParams::Capability::TaggedSymbol
           )
+        TOLL_FREE_MESSAGING =
+          T.let(
+            :toll_free_messaging,
+            SurgeAPI::AccountRetrieveStatusParams::Capability::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/surge_api/models/campaign.rbi

@@ -96,11 +96,10 @@ module SurgeAPI
       sig { returns(SurgeAPI::Campaign::Volume::TaggedSymbol) }
       attr_accessor :volume
 
-      # A sample link that might be sent by this campaign. If links from other domains
-      # are sent through this campaign, they are much more likely to be filtered by the
-      # carriers. If link shortening is enabled for the account, the link shortener URL
-      # will be used instead of what is provided. Reach out to support if you would like
-      # to disable automatic link shortening.
+      # A sample link that might be sent by this campaign. This is required when
+      # `includes` contains `links`. Provide the same URL or domain that the campaign
+      # will use in production. If links from other domains are sent through this
+      # campaign, they are much more likely to be filtered by the carriers.
       sig { returns(T.nilable(String)) }
       attr_reader :link_sample
 
@@ -207,11 +206,10 @@ module SurgeAPI
         #   volume number upon receipt of the API request, and phone numbers will be
         #   charged as high volume numbers going forward.
         volume:,
-        # A sample link that might be sent by this campaign. If links from other domains
-        # are sent through this campaign, they are much more likely to be filtered by the
-        # carriers. If link shortening is enabled for the account, the link shortener URL
-        # will be used instead of what is provided. Reach out to support if you would like
-        # to disable automatic link shortening.
+        # A sample link that might be sent by this campaign. This is required when
+        # `includes` contains `links`. Provide the same URL or domain that the campaign
+        # will use in production. If links from other domains are sent through this
+        # campaign, they are much more likely to be filtered by the carriers.
         link_sample: nil,
         # The URL of the terms and conditions presented to end users when they opt in to
         # messaging. These terms and conditions may be shared among all of a platform's
@@ -272,6 +270,7 @@ module SurgeAPI
 
         ACTIVE = T.let(:active, SurgeAPI::Campaign::Status::TaggedSymbol)
         CANCELED = T.let(:canceled, SurgeAPI::Campaign::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, SurgeAPI::Campaign::Status::TaggedSymbol)
         CREATED = T.let(:created, SurgeAPI::Campaign::Status::TaggedSymbol)
         DEACTIVATED =
           T.let(:deactivated, SurgeAPI::Campaign::Status::TaggedSymbol)