surge_api 0.23.0 → 0.25.0

data/rbi/surge_api/models/message.rbi

@@ -39,6 +39,10 @@ module SurgeAPI
       sig { params(conversation: SurgeAPI::Message::Conversation::OrHash).void }
       attr_writer :conversation
 
+      # The reason the message failed, or null if no failure reason is set.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :failure_reason
+
       # Set of key-value pairs that will be stored with the object.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :metadata
@@ -46,6 +50,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 +65,9 @@ module SurgeAPI
           blast_id: T.nilable(String),
           body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
-          metadata: T::Hash[Symbol, String]
+          failure_reason: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          status: SurgeAPI::Message::Status::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -68,8 +81,12 @@ module SurgeAPI
         body: nil,
         # A conversation with a Contact
         conversation: nil,
+        # The reason the message failed, or null if no failure reason is set.
+        failure_reason: 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 +98,9 @@ module SurgeAPI
             blast_id: T.nilable(String),
             body: T.nilable(String),
             conversation: SurgeAPI::Message::Conversation,
-            metadata: T::Hash[Symbol, String]
+            failure_reason: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            status: SurgeAPI::Message::Status::TaggedSymbol
           }
         )
       end
@@ -245,6 +264,10 @@ module SurgeAPI
           sig { returns(String) }
           attr_accessor :id
 
+          # Set of key-value pairs that will be stored with the object.
+          sig { returns(T::Hash[Symbol, String]) }
+          attr_accessor :metadata
+
           # A human-readable name for the phone number
           sig { returns(T.nilable(String)) }
           attr_accessor :name
@@ -265,6 +288,7 @@ module SurgeAPI
           sig do
             params(
               id: String,
+              metadata: T::Hash[Symbol, String],
               name: T.nilable(String),
               number: String,
               type: SurgeAPI::Message::Conversation::PhoneNumber::Type::OrSymbol
@@ -273,6 +297,8 @@ module SurgeAPI
           def self.new(
             # Unique identifier for the phone number
             id:,
+            # Set of key-value pairs that will be stored with the object.
+            metadata:,
             # A human-readable name for the phone number
             name:,
             # The canonical format of the phone number.
@@ -286,6 +312,7 @@ module SurgeAPI
             override.returns(
               {
                 id: String,
+                metadata: T::Hash[Symbol, String],
                 name: T.nilable(String),
                 number: String,
                 type:
@@ -342,6 +369,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

@@ -100,10 +100,22 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :delivered_at
 
+        # The reason the message failed, or null if no failure reason is set
+        sig { returns(T.nilable(String)) }
+        attr_accessor :failure_reason
+
         # Set of key-value pairs that will be stored with the object.
         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(
@@ -140,7 +152,10 @@ module SurgeAPI
             conversation:
               SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
             delivered_at: Time,
+            failure_reason: T.nilable(String),
             metadata: T::Hash[Symbol, String],
+            status:
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
@@ -157,8 +172,12 @@ module SurgeAPI
           conversation:,
           # When the message was delivered
           delivered_at:,
+          # The reason the message failed, or null if no failure reason is set
+          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
@@ -175,7 +194,10 @@ module SurgeAPI
               conversation:
                 SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
               delivered_at: Time,
+              failure_reason: T.nilable(String),
               metadata: T::Hash[Symbol, String],
+              status:
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[
                   SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment
@@ -245,6 +267,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

@@ -98,14 +98,23 @@ module SurgeAPI
         sig { returns(Time) }
         attr_accessor :failed_at
 
-        # The reason the message failed to be delivered
-        sig { returns(String) }
+        # The reason the message failed to be delivered, or null if no failure reason is
+        # set
+        sig { returns(T.nilable(String)) }
         attr_accessor :failure_reason
 
         # Set of key-value pairs that will be stored with the object.
         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(
@@ -142,8 +151,9 @@ module SurgeAPI
             conversation:
               SurgeAPI::MessageFailedWebhookEvent::Data::Conversation::OrHash,
             failed_at: Time,
-            failure_reason: String,
+            failure_reason: T.nilable(String),
             metadata: T::Hash[Symbol, String],
+            status: SurgeAPI::MessageFailedWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::OrHash
@@ -160,10 +170,13 @@ module SurgeAPI
           conversation:,
           # When the message failed
           failed_at:,
-          # The reason the message failed to be delivered
+          # The reason the message failed to be delivered, or null if no failure reason is
+          # set
           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
@@ -180,8 +193,10 @@ module SurgeAPI
               conversation:
                 SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
               failed_at: Time,
-              failure_reason: String,
+              failure_reason: T.nilable(String),
               metadata: T::Hash[Symbol, String],
+              status:
+                SurgeAPI::MessageFailedWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
               blast_id: String
@@ -249,6 +264,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

@@ -96,6 +96,10 @@ module SurgeAPI
         end
         attr_writer :conversation
 
+        # The reason the message failed, or null if no failure reason is set
+        sig { returns(T.nilable(String)) }
+        attr_accessor :failure_reason
+
         # Set of key-value pairs that will be stored with the object.
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :metadata
@@ -104,6 +108,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(
@@ -139,8 +151,11 @@ module SurgeAPI
             body: T.nilable(String),
             conversation:
               SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation::OrHash,
+            failure_reason: T.nilable(String),
             metadata: T::Hash[Symbol, String],
             received_at: Time,
+            status:
+              SurgeAPI::MessageReceivedWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::OrHash
@@ -155,10 +170,14 @@ module SurgeAPI
           body:,
           # The conversation this message belongs to
           conversation:,
+          # The reason the message failed, or null if no failure reason is set
+          failure_reason:,
           # Set of key-value pairs that will be stored with the object.
           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
@@ -174,8 +193,11 @@ module SurgeAPI
               body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
+              failure_reason: T.nilable(String),
               metadata: T::Hash[Symbol, String],
               received_at: Time,
+              status:
+                SurgeAPI::MessageReceivedWebhookEvent::Data::Status::TaggedSymbol,
               attachments:
                 T::Array[
                   SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment
@@ -245,6 +267,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

@@ -89,6 +89,10 @@ module SurgeAPI
         end
         attr_writer :conversation
 
+        # The reason the message failed, or null if no failure reason is set
+        sig { returns(T.nilable(String)) }
+        attr_accessor :failure_reason
+
         # Set of key-value pairs that will be stored with the object.
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :metadata
@@ -97,6 +101,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(
@@ -132,8 +142,10 @@ module SurgeAPI
             body: T.nilable(String),
             conversation:
               SurgeAPI::MessageSentWebhookEvent::Data::Conversation::OrHash,
+            failure_reason: T.nilable(String),
             metadata: T::Hash[Symbol, String],
             sent_at: Time,
+            status: SurgeAPI::MessageSentWebhookEvent::Data::Status::OrSymbol,
             attachments:
               T::Array[
                 SurgeAPI::MessageSentWebhookEvent::Data::Attachment::OrHash
@@ -148,10 +160,14 @@ module SurgeAPI
           body:,
           # The conversation this message belongs to
           conversation:,
+          # The reason the message failed, or null if no failure reason is set
+          failure_reason:,
           # Set of key-value pairs that will be stored with the object.
           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
@@ -167,8 +183,11 @@ module SurgeAPI
               body: T.nilable(String),
               conversation:
                 SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
+              failure_reason: T.nilable(String),
               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 +255,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

data/rbi/surge_api/models/phone_number.rbi

@@ -28,6 +28,10 @@ module SurgeAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :campaign_id
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
       # A human-readable name for the phone number
       sig { returns(T.nilable(String)) }
       attr_accessor :name
@@ -46,6 +50,7 @@ module SurgeAPI
           id: String,
           campaign: T.nilable(SurgeAPI::PhoneNumber::Campaign::OrHash),
           campaign_id: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
           number: String,
           type: SurgeAPI::PhoneNumber::Type::OrSymbol
@@ -59,6 +64,8 @@ module SurgeAPI
         # Deprecated. The unique identifier of the campaign this phone number is attached
         # to, if any
         campaign_id:,
+        # Set of key-value pairs that will be stored with the object.
+        metadata:,
         # A human-readable name for the phone number
         name:,
         # The phone number in E.164 format
@@ -74,6 +81,7 @@ module SurgeAPI
             id: String,
             campaign: T.nilable(SurgeAPI::PhoneNumber::Campaign),
             campaign_id: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             number: String,
             type: SurgeAPI::PhoneNumber::Type::TaggedSymbol

data/rbi/surge_api/models/phone_number_attached_to_campaign_webhook_event.rbi

@@ -109,6 +109,10 @@ module SurgeAPI
         sig { returns(String) }
         attr_accessor :campaign_id
 
+        # Set of key-value pairs that will be stored with the object.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
         # A human-readable name for the phone number
         sig { returns(T.nilable(String)) }
         attr_accessor :name
@@ -134,6 +138,7 @@ module SurgeAPI
                 SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign::OrHash
               ),
             campaign_id: String,
+            metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             number: String,
             type:
@@ -148,6 +153,8 @@ module SurgeAPI
           # Deprecated. The unique identifier of the campaign this phone number is attached
           # to
           campaign_id:,
+          # Set of key-value pairs that will be stored with the object.
+          metadata:,
           # A human-readable name for the phone number
           name:,
           # The phone number in E.164 format
@@ -166,6 +173,7 @@ module SurgeAPI
                   SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent::Data::Campaign
                 ),
               campaign_id: String,
+              metadata: T::Hash[Symbol, String],
               name: T.nilable(String),
               number: String,
               type: