surge_api 0.23.0 → 0.24.0

data/rbi/surge_api/models/campaign_params.rbi

@@ -141,11 +141,10 @@ module SurgeAPI
         end
         attr_writer :includes
 
-        # 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
 
@@ -247,11 +246,10 @@ module SurgeAPI
           # - `direct_lending` - whether the campaign contains content related to direct
           #   lending or other loan arrangements
           includes: nil,
-          # 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
         )
         end

data/rbi/surge_api/models/message.rbi

@@ -46,6 +46,13 @@ module SurgeAPI
       sig { params(metadata: T::Hash[Symbol, String]).void }
       attr_writer :metadata
 
+      # The current status of the message.
+      sig { returns(T.nilable(SurgeAPI::Message::Status::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: SurgeAPI::Message::Status::OrSymbol).void }
+      attr_writer :status
+
       # A Message is a communication sent to a Contact.
       sig do
         params(
@@ -54,7 +61,8 @@ module SurgeAPI
           blast_id: T.nilable(String),
           body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
-          metadata: T::Hash[Symbol, String]
+          metadata: T::Hash[Symbol, String],
+          status: SurgeAPI::Message::Status::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -69,7 +77,9 @@ module SurgeAPI
         # A conversation with a Contact
         conversation: nil,
         # Set of key-value pairs that will be stored with the object.
-        metadata: nil
+        metadata: nil,
+        # The current status of the message.
+        status: nil
       )
       end
 
@@ -81,7 +91,8 @@ module SurgeAPI
             blast_id: T.nilable(String),
             body: T.nilable(String),
             conversation: SurgeAPI::Message::Conversation,
-            metadata: T::Hash[Symbol, String]
+            metadata: T::Hash[Symbol, String],
+            status: SurgeAPI::Message::Status::TaggedSymbol
           }
         )
       end
@@ -342,6 +353,26 @@ module SurgeAPI
           end
         end
       end
+
+      # The current status of the message.
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, SurgeAPI::Message::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING = T.let(:pending, SurgeAPI::Message::Status::TaggedSymbol)
+        RECEIVED = T.let(:received, SurgeAPI::Message::Status::TaggedSymbol)
+        SENT = T.let(:sent, SurgeAPI::Message::Status::TaggedSymbol)
+        DELIVERED = T.let(:delivered, SurgeAPI::Message::Status::TaggedSymbol)
+        FAILED = T.let(:failed, SurgeAPI::Message::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[SurgeAPI::Message::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -104,6 +104,14 @@ module SurgeAPI
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :metadata
 
+        # The message status represented by this event
+        sig do
+          returns(
+            SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
         # Attachments included with the message
         sig do
           returns(
@@ -141,6 +149,8 @@ module SurgeAPI
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
             metadata: T::Hash[Symbol, String],
+            status:
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
@@ -159,6 +169,8 @@ module SurgeAPI
           delivered_at:,
           # Set of key-value pairs that will be stored with the object.
           metadata:,
+          # The message status represented by this event
+          status:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -176,6 +188,8 @@ module SurgeAPI
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,
               metadata: T::Hash[Symbol, String],
+              status:
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment
@@ -245,6 +259,36 @@ module SurgeAPI
           end
         end
 
+        # The message status represented by this event
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DELIVERED =
+            T.let(
+              :delivered,
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/surge_api/models/message_failed_webhook_event.rbi

@@ -106,6 +106,14 @@ module SurgeAPI
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :metadata
 
+        # The message status represented by this event
+        sig do
+          returns(
+            SurgeAPI::MessageFailedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
         # Attachments included with the message
         sig do
           returns(
@@ -144,6 +152,7 @@ module SurgeAPI
             failed_at: Time,
             failure_reason: String,
             metadata: T::Hash[Symbol, String],
+            status: SurgeAPI::MessageFailedWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::OrHash
@@ -164,6 +173,8 @@ module SurgeAPI
           failure_reason:,
           # Set of key-value pairs that will be stored with the object.
           metadata:,
+          # The message status represented by this event
+          status:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -182,6 +193,8 @@ module SurgeAPI
               failed_at: Time,
               failure_reason: String,
               metadata: T::Hash[Symbol, String],
+              status:
+                SurgeAPI::MessageFailedWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
               blast_id: String
@@ -249,6 +262,33 @@ module SurgeAPI
           end
         end
 
+        # The message status represented by this event
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, SurgeAPI::MessageFailedWebhookEvent::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAILED =
+            T.let(
+              :failed,
+              SurgeAPI::MessageFailedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::MessageFailedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/surge_api/models/message_received_webhook_event.rbi

@@ -104,6 +104,14 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :received_at
 
+        # The message status represented by this event
+        sig do
+          returns(
+            SurgeAPI::MessageReceivedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
         # Attachments included with the message
         sig do
           returns(
@@ -141,6 +149,8 @@ module SurgeAPI
               SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation::OrHash,
             metadata: T::Hash[Symbol, String],
             received_at: Time,
+            status:
+              SurgeAPI::MessageReceivedWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::OrHash
@@ -159,6 +169,8 @@ module SurgeAPI
           metadata:,
           # When the message was received
           received_at:,
+          # The message status represented by this event
+          status:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -176,6 +188,8 @@ module SurgeAPI
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
               metadata: T::Hash[Symbol, String],
               received_at: Time,
+              status:
+                SurgeAPI::MessageReceivedWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[
                   SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment
@@ -245,6 +259,33 @@ module SurgeAPI
           end
         end
 
+        # The message status represented by this event
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, SurgeAPI::MessageReceivedWebhookEvent::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RECEIVED =
+            T.let(
+              :received,
+              SurgeAPI::MessageReceivedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::MessageReceivedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/surge_api/models/message_sent_webhook_event.rbi

@@ -97,6 +97,12 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :sent_at
 
+        # The message status represented by this event
+        sig do
+          returns(SurgeAPI::MessageSentWebhookEvent::Data::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
         # Attachments included with the message
         sig do
           returns(
@@ -134,6 +140,7 @@ module SurgeAPI
               SurgeAPI::MessageSentWebhookEvent::Data::Conversation::OrHash,
             metadata: T::Hash[Symbol, String],
             sent_at: Time,
+            status: SurgeAPI::MessageSentWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageSentWebhookEvent::Data::Attachment::OrHash
@@ -152,6 +159,8 @@ module SurgeAPI
           metadata:,
           # When the message was sent
           sent_at:,
+          # The message status represented by this event
+          status:,
           # Attachments included with the message
           attachments: nil,
           # The ID of the blast this message belongs to, if any. This can be used to
@@ -169,6 +178,8 @@ module SurgeAPI
                 SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
               metadata: T::Hash[Symbol, String],
               sent_at: Time,
+              status:
+                SurgeAPI::MessageSentWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
               blast_id: String
@@ -236,6 +247,33 @@ module SurgeAPI
           end
         end
 
+        # The message status represented by this event
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, SurgeAPI::MessageSentWebhookEvent::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SENT =
+            T.let(
+              :sent,
+              SurgeAPI::MessageSentWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::MessageSentWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class Attachment < SurgeAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do