surge_api 0.22.0 → 0.24.0

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_params.rbi

@@ -261,6 +261,13 @@ module SurgeAPI
             sig { params(metadata: T::Hash[Symbol, String]).void }
             attr_writer :metadata
 
+            # Whether outbound messaging should be manually disabled for the contact.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :outbound_disabled
+
+            sig { params(outbound_disabled: T::Boolean).void }
+            attr_writer :outbound_disabled
+
             # Parameters for creating a contact
             sig do
               params(
@@ -268,7 +275,8 @@ module SurgeAPI
                 email: String,
                 first_name: String,
                 last_name: String,
-                metadata: T::Hash[Symbol, String]
+                metadata: T::Hash[Symbol, String],
+                outbound_disabled: T::Boolean
               ).returns(T.attached_class)
             end
             def self.new(
@@ -281,7 +289,9 @@ module SurgeAPI
               # The contact's last name.
               last_name: nil,
               # Set of key-value pairs that will be stored with the object.
-              metadata: nil
+              metadata: nil,
+              # Whether outbound messaging should be manually disabled for the contact.
+              outbound_disabled: nil
             )
             end
 
@@ -292,7 +302,8 @@ module SurgeAPI
                   email: String,
                   first_name: String,
                   last_name: String,
-                  metadata: T::Hash[Symbol, String]
+                  metadata: T::Hash[Symbol, String],
+                  outbound_disabled: T::Boolean
                 }
               )
             end

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

data/rbi/surge_api/models/organization.rbi

@@ -38,12 +38,14 @@ module SurgeAPI
 
       # The value of the identifier whose type is specified in the identifier_type
       # field. For EIN, can be formatted with or without the hyphen. For CBN, must be
-      # exactly 9 digits.
+      # exactly 9 digits. For VAT, provide only the numeric portion, between 2 and 20
+      # digits.
       sig { returns(T.nilable(String)) }
       attr_accessor :identifier
 
       # The type of identifier being provided for the organization. Use "ein" for US
-      # businesses or "cbn" for Canadian businesses.
+      # organizations, "cbn" for Canadian organizations, or "vat" for supported
+      # international organizations.
       sig do
         returns(T.nilable(SurgeAPI::Organization::IdentifierType::TaggedSymbol))
       end
@@ -136,10 +138,12 @@ module SurgeAPI
         email:,
         # The value of the identifier whose type is specified in the identifier_type
         # field. For EIN, can be formatted with or without the hyphen. For CBN, must be
-        # exactly 9 digits.
+        # exactly 9 digits. For VAT, provide only the numeric portion, between 2 and 20
+        # digits.
         identifier:,
         # The type of identifier being provided for the organization. Use "ein" for US
-        # businesses or "cbn" for Canadian businesses.
+        # organizations, "cbn" for Canadian organizations, or "vat" for supported
+        # international organizations.
         identifier_type:,
         # The industry in which the organization operates.
         industry:,
@@ -409,7 +413,8 @@ module SurgeAPI
       end
 
       # The type of identifier being provided for the organization. Use "ein" for US
-      # businesses or "cbn" for Canadian businesses.
+      # organizations, "cbn" for Canadian organizations, or "vat" for supported
+      # international organizations.
       module IdentifierType
         extend SurgeAPI::Internal::Type::Enum
 
@@ -419,6 +424,7 @@ module SurgeAPI
 
         EIN = T.let(:ein, SurgeAPI::Organization::IdentifierType::TaggedSymbol)
         CBN = T.let(:cbn, SurgeAPI::Organization::IdentifierType::TaggedSymbol)
+        VAT = T.let(:vat, SurgeAPI::Organization::IdentifierType::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/surge_api/models/phone_number_imported_webhook_event.rbi

@@ -0,0 +1,310 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class PhoneNumberImportedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::PhoneNumberImportedWebhookEvent,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the account in which this event occurred
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The data associated with the event
+      sig { returns(SurgeAPI::PhoneNumberImportedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `phone_number.imported` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the account in which this event occurred
+        account_id:,
+        # The data associated with the event
+        data:,
+        # The timestamp when this event occurred, in ISO8601 format
+        timestamp:,
+        # The type of the event. Always `phone_number.imported` for this event.
+        type: :"phone_number.imported"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the phone number
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Campaign attachment details for a domestic local phone number
+        sig do
+          returns(
+            T.nilable(SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign)
+          )
+        end
+        attr_reader :campaign
+
+        sig do
+          params(
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::OrHash
+              )
+          ).void
+        end
+        attr_writer :campaign
+
+        # Deprecated. The unique identifier of the campaign this phone number is attached
+        # to
+        sig { returns(T.nilable(String)) }
+        attr_accessor :campaign_id
+
+        # A human-readable name for the phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The phone number in E.164 format
+        sig { returns(String) }
+        attr_accessor :number
+
+        # Whether the phone number is local, toll-free, or short code
+        sig do
+          returns(
+            SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            campaign:
+              T.nilable(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::OrHash
+              ),
+            campaign_id: T.nilable(String),
+            name: T.nilable(String),
+            number: String,
+            type:
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the phone number
+          id:,
+          # Campaign attachment details for a domestic local phone number
+          campaign:,
+          # Deprecated. The unique identifier of the campaign this phone number is attached
+          # to
+          campaign_id:,
+          # A human-readable name for the phone number
+          name:,
+          # The phone number in E.164 format
+          number:,
+          # Whether the phone number is local, toll-free, or short code
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              campaign:
+                T.nilable(
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign
+                ),
+              campaign_id: T.nilable(String),
+              name: T.nilable(String),
+              number: String,
+              type:
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Campaign < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier of the campaign this phone number is attached to
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The current campaign attachment status for this phone number.
+          sig do
+            returns(
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+            )
+          end
+          attr_accessor :attachment_status
+
+          # Campaign attachment details for a domestic local phone number
+          sig do
+            params(
+              id: String,
+              attachment_status:
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier of the campaign this phone number is attached to
+            id:,
+            # The current campaign attachment status for this phone number.
+            attachment_status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                attachment_status:
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current campaign attachment status for this phone number.
+          module AttachmentStatus
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ATTACHED =
+              T.let(
+                :attached,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            ATTACHMENT_PENDING =
+              T.let(
+                :attachment_pending,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHED =
+              T.let(
+                :detached,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+            DETACHMENT_PENDING =
+              T.let(
+                :detachment_pending,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::AttachmentStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # Whether the phone number is local, toll-free, or short code
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOCAL =
+            T.let(
+              :local,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          SHORT_CODE =
+            T.let(
+              :short_code,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          TOLL_FREE =
+            T.let(
+              :toll_free,
+              SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end