surge_api 0.24.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
@@ -61,6 +65,7 @@ module SurgeAPI
           blast_id: T.nilable(String),
           body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
+          failure_reason: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           status: SurgeAPI::Message::Status::OrSymbol
         ).returns(T.attached_class)
@@ -76,6 +81,8 @@ 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,
         # The current status of the message.
@@ -91,6 +98,7 @@ module SurgeAPI
             blast_id: T.nilable(String),
             body: T.nilable(String),
             conversation: SurgeAPI::Message::Conversation,
+            failure_reason: T.nilable(String),
             metadata: T::Hash[Symbol, String],
             status: SurgeAPI::Message::Status::TaggedSymbol
           }
@@ -256,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
@@ -276,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
@@ -284,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.
@@ -297,6 +312,7 @@ module SurgeAPI
             override.returns(
               {
                 id: String,
+                metadata: T::Hash[Symbol, String],
                 name: T.nilable(String),
                 number: String,
                 type:

data/rbi/surge_api/models/message_delivered_webhook_event.rbi

@@ -100,6 +100,10 @@ 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
@@ -148,6 +152,7 @@ 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,
@@ -167,6 +172,8 @@ 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
@@ -187,6 +194,7 @@ 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,

data/rbi/surge_api/models/message_failed_webhook_event.rbi

@@ -98,8 +98,9 @@ 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.
@@ -150,7 +151,7 @@ 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:
@@ -169,7 +170,8 @@ 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:,
@@ -191,7 +193,7 @@ 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,

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
@@ -147,6 +151,7 @@ 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:
@@ -165,6 +170,8 @@ 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
@@ -186,6 +193,7 @@ 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:

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
@@ -138,6 +142,7 @@ 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,
@@ -155,6 +160,8 @@ 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
@@ -176,6 +183,7 @@ 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:

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:

data/rbi/surge_api/models/phone_number_imported_webhook_event.rbi

@@ -103,6 +103,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
@@ -128,6 +132,7 @@ module SurgeAPI
                 SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign::OrHash
               ),
             campaign_id: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             number: String,
             type:
@@ -142,6 +147,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
@@ -160,6 +167,7 @@ module SurgeAPI
                   SurgeAPI::PhoneNumberImportedWebhookEvent::Data::Campaign
                 ),
               campaign_id: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
               name: T.nilable(String),
               number: String,
               type:

data/rbi/surge_api/models/phone_number_purchase_params.rbi

@@ -42,6 +42,13 @@ module SurgeAPI
       sig { params(longitude: Float).void }
       attr_writer :longitude
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # A human-readable name for the phone number. If not provided, defaults to the
       # formatted phone number.
       sig { returns(T.nilable(String)) }
@@ -76,6 +83,7 @@ module SurgeAPI
           area_code: String,
           latitude: Float,
           longitude: Float,
+          metadata: T::Hash[Symbol, String],
           name: String,
           phone_number: String,
           type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,
@@ -94,6 +102,8 @@ module SurgeAPI
         # Longitude to search for nearby phone numbers. Must be used with latitude. If
         # provided without type, type will be inferred as 'local'.
         longitude: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
         # A human-readable name for the phone number. If not provided, defaults to the
         # formatted phone number.
         name: nil,
@@ -114,6 +124,7 @@ module SurgeAPI
             area_code: String,
             latitude: Float,
             longitude: Float,
+            metadata: T::Hash[Symbol, String],
             name: String,
             phone_number: String,
             type: SurgeAPI::PhoneNumberPurchaseParams::Type::OrSymbol,

data/rbi/surge_api/models/phone_number_update_params.rbi

@@ -22,6 +22,13 @@ module SurgeAPI
       sig { params(campaign_id: String).void }
       attr_writer :campaign_id
 
+      # Set of key-value pairs that will be stored with the object.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       # A human-readable name for the phone number.
       sig { returns(T.nilable(String)) }
       attr_reader :name
@@ -33,6 +40,7 @@ module SurgeAPI
         params(
           id: String,
           campaign_id: String,
+          metadata: T::Hash[Symbol, String],
           name: String,
           request_options: SurgeAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -42,6 +50,8 @@ module SurgeAPI
         id:,
         # Campaign ID to attach this number to (`cpn_...`).
         campaign_id: nil,
+        # Set of key-value pairs that will be stored with the object.
+        metadata: nil,
         # A human-readable name for the phone number.
         name: nil,
         request_options: {}
@@ -53,6 +63,7 @@ module SurgeAPI
           {
             id: String,
             campaign_id: String,
+            metadata: T::Hash[Symbol, String],
             name: String,
             request_options: SurgeAPI::RequestOptions
           }

data/rbi/surge_api/models/toll_free_campaign.rbi

@@ -0,0 +1,230 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class TollFreeCampaign < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::TollFreeCampaign, SurgeAPI::Internal::AnyHash)
+        end
+
+      # The toll-free campaign ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T::Array[SurgeAPI::TollFreeCampaignConsentFlow::Variants]) }
+      attr_accessor :consent_flows
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig do
+        returns(T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol])
+      end
+      attr_accessor :includes
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :message_samples
+
+      # The toll-free phone number ID
+      sig { returns(String) }
+      attr_accessor :phone_number_id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :privacy_policy_url
+
+      # The current status of the toll-free campaign.
+      sig { returns(SurgeAPI::TollFreeCampaign::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :terms_and_conditions_url
+
+      sig do
+        returns(T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol])
+      end
+      attr_accessor :use_cases
+
+      # A toll-free campaign registration for a phone number.
+      sig do
+        params(
+          id: String,
+          consent_flows:
+            T::Array[
+              T.any(
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember0::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember1::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember2::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::UnionMember3::OrHash,
+                SurgeAPI::TollFreeCampaignConsentFlow::Type::OrHash
+              )
+            ],
+          description: T.nilable(String),
+          includes: T::Array[SurgeAPI::TollFreeCampaign::Include::OrSymbol],
+          message_samples: T::Array[String],
+          phone_number_id: String,
+          privacy_policy_url: T.nilable(String),
+          status: SurgeAPI::TollFreeCampaign::Status::OrSymbol,
+          terms_and_conditions_url: T.nilable(String),
+          use_cases: T::Array[SurgeAPI::TollFreeCampaign::UseCase::OrSymbol]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The toll-free campaign ID
+        id:,
+        consent_flows:,
+        description:,
+        includes:,
+        message_samples:,
+        # The toll-free phone number ID
+        phone_number_id:,
+        privacy_policy_url:,
+        # The current status of the toll-free campaign.
+        status:,
+        terms_and_conditions_url:,
+        use_cases:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            consent_flows:
+              T::Array[SurgeAPI::TollFreeCampaignConsentFlow::Variants],
+            description: T.nilable(String),
+            includes:
+              T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol],
+            message_samples: T::Array[String],
+            phone_number_id: String,
+            privacy_policy_url: T.nilable(String),
+            status: SurgeAPI::TollFreeCampaign::Status::TaggedSymbol,
+            terms_and_conditions_url: T.nilable(String),
+            use_cases:
+              T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AGE_GATED =
+          T.let(:age_gated, SurgeAPI::TollFreeCampaign::Include::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The current status of the toll-free campaign.
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        CANCELED =
+          T.let(:canceled, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        CREATED =
+          T.let(:created, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        IN_REVIEW =
+          T.let(:in_review, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+        REJECTED =
+          T.let(:rejected, SurgeAPI::TollFreeCampaign::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::TollFreeCampaign::UseCase) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TWO_FACTOR_AUTHENTICATION =
+          T.let(
+            :two_factor_authentication,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        ACCOUNT_NOTIFICATION =
+          T.let(
+            :account_notification,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        CUSTOMER_CARE =
+          T.let(
+            :customer_care,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        CHARITY =
+          T.let(:charity, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        DELIVERY_NOTIFICATION =
+          T.let(
+            :delivery_notification,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        FRAUD_ALERT =
+          T.let(:fraud_alert, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        EVENT = T.let(:event, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        HIGHER_EDUCATION =
+          T.let(
+            :higher_education,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        K12_EDUCATION =
+          T.let(
+            :k12_education,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        MARKETING =
+          T.let(:marketing, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        POLLING_VOTING =
+          T.let(
+            :polling_voting,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        POLITICAL =
+          T.let(:political, SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol)
+        PUBLIC_SERVICE_ANNOUNCEMENT =
+          T.let(
+            :public_service_announcement,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+        SECURITY_ALERT =
+          T.let(
+            :security_alert,
+            SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[SurgeAPI::TollFreeCampaign::UseCase::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end