surge_api 0.23.0 → 0.25.0

data/sig/surge_api/models/campaign_submitted_webhook_event.rbs

@@ -0,0 +1,67 @@
+module SurgeAPI
+  module Models
+    type campaign_submitted_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::CampaignSubmittedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.submitted"
+      }
+
+    class CampaignSubmittedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::CampaignSubmittedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"campaign.submitted"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::CampaignSubmittedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"campaign.submitted"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::CampaignSubmittedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.submitted"
+      }
+
+      type data =
+        {
+          id: String,
+          status: SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::status
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor status: SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::status
+
+        def initialize: (
+          id: String,
+          status: SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::status
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          status: SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::status
+        }
+
+        type status = :in_review
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          IN_REVIEW: :in_review
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignSubmittedWebhookEvent::Data::status]
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/campaign_update_params.rbs

@@ -1,7 +1,19 @@
 module SurgeAPI
   module Models
     type campaign_update_params =
-      { id: String } & SurgeAPI::Internal::Type::request_parameters
+      {
+        id: String,
+        consent_flow: String,
+        description: String,
+        includes: ::Array[SurgeAPI::Models::CampaignUpdateParams::include_],
+        link_sample: String?,
+        message_samples: ::Array[String],
+        privacy_policy_url: String,
+        terms_and_conditions_url: String,
+        use_cases: ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case],
+        volume: SurgeAPI::Models::CampaignUpdateParams::volume
+      }
+      & SurgeAPI::Internal::Type::request_parameters
 
     class CampaignUpdateParams < SurgeAPI::Internal::Type::BaseModel
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
@@ -9,12 +21,126 @@ module SurgeAPI
 
       attr_accessor id: String
 
+      attr_reader consent_flow: String?
+
+      def consent_flow=: (String) -> String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader includes: ::Array[SurgeAPI::Models::CampaignUpdateParams::include_]?
+
+      def includes=: (
+        ::Array[SurgeAPI::Models::CampaignUpdateParams::include_]
+      ) -> ::Array[SurgeAPI::Models::CampaignUpdateParams::include_]
+
+      attr_accessor link_sample: String?
+
+      attr_reader message_samples: ::Array[String]?
+
+      def message_samples=: (::Array[String]) -> ::Array[String]
+
+      attr_reader privacy_policy_url: String?
+
+      def privacy_policy_url=: (String) -> String
+
+      attr_reader terms_and_conditions_url: String?
+
+      def terms_and_conditions_url=: (String) -> String
+
+      attr_reader use_cases: ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case]?
+
+      def use_cases=: (
+        ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case]
+      ) -> ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case]
+
+      attr_reader volume: SurgeAPI::Models::CampaignUpdateParams::volume?
+
+      def volume=: (
+        SurgeAPI::Models::CampaignUpdateParams::volume
+      ) -> SurgeAPI::Models::CampaignUpdateParams::volume
+
       def initialize: (
         id: String,
+        ?consent_flow: String,
+        ?description: String,
+        ?includes: ::Array[SurgeAPI::Models::CampaignUpdateParams::include_],
+        ?link_sample: String?,
+        ?message_samples: ::Array[String],
+        ?privacy_policy_url: String,
+        ?terms_and_conditions_url: String,
+        ?use_cases: ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case],
+        ?volume: SurgeAPI::Models::CampaignUpdateParams::volume,
         ?request_options: SurgeAPI::request_opts
       ) -> void
 
-      def to_hash: -> { id: String, request_options: SurgeAPI::RequestOptions }
+      def to_hash: -> {
+        id: String,
+        consent_flow: String,
+        description: String,
+        includes: ::Array[SurgeAPI::Models::CampaignUpdateParams::include_],
+        link_sample: String?,
+        message_samples: ::Array[String],
+        privacy_policy_url: String,
+        terms_and_conditions_url: String,
+        use_cases: ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case],
+        volume: SurgeAPI::Models::CampaignUpdateParams::volume,
+        request_options: SurgeAPI::RequestOptions
+      }
+
+      type include_ = :links | :phone_numbers | :age_gated | :direct_lending
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        LINKS: :links
+        PHONE_NUMBERS: :phone_numbers
+        AGE_GATED: :age_gated
+        DIRECT_LENDING: :direct_lending
+
+        def self?.values: -> ::Array[SurgeAPI::Models::CampaignUpdateParams::include_]
+      end
+
+      type use_case =
+        :account_notification
+        | :customer_care
+        | :delivery_notification
+        | :fraud_alert
+        | :higher_education
+        | :marketing
+        | :polling_voting
+        | :public_service_announcement
+        | :security_alert
+        | :two_factor_authentication
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACCOUNT_NOTIFICATION: :account_notification
+        CUSTOMER_CARE: :customer_care
+        DELIVERY_NOTIFICATION: :delivery_notification
+        FRAUD_ALERT: :fraud_alert
+        HIGHER_EDUCATION: :higher_education
+        MARKETING: :marketing
+        POLLING_VOTING: :polling_voting
+        PUBLIC_SERVICE_ANNOUNCEMENT: :public_service_announcement
+        SECURITY_ALERT: :security_alert
+        TWO_FACTOR_AUTHENTICATION: :two_factor_authentication
+
+        def self?.values: -> ::Array[SurgeAPI::Models::CampaignUpdateParams::use_case]
+      end
+
+      type volume = :high | :low
+
+      module Volume
+        extend SurgeAPI::Internal::Type::Enum
+
+        HIGH: :high
+        LOW: :low
+
+        def self?.values: -> ::Array[SurgeAPI::Models::CampaignUpdateParams::volume]
+      end
     end
   end
 end

data/sig/surge_api/models/campaign_warning_webhook_event.rbs

@@ -0,0 +1,114 @@
+module SurgeAPI
+  module Models
+    type campaign_warning_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::CampaignWarningWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.warning"
+      }
+
+    class CampaignWarningWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::CampaignWarningWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"campaign.warning"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::CampaignWarningWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"campaign.warning"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::CampaignWarningWebhookEvent::Data,
+        timestamp: Time,
+        type: :"campaign.warning"
+      }
+
+      type data =
+        {
+          id: String,
+          feedback: ::Array[SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback],
+          status: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::status
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor feedback: ::Array[SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback]
+
+        attr_accessor status: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::status
+
+        def initialize: (
+          id: String,
+          feedback: ::Array[SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback],
+          status: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::status
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          feedback: ::Array[SurgeAPI::CampaignWarningWebhookEvent::Data::Feedback],
+          status: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::status
+        }
+
+        type feedback =
+          {
+            field: String,
+            message: String,
+            outcome: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::outcome,
+            suggested_value: String?
+          }
+
+        class Feedback < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor field: String
+
+          attr_accessor message: String
+
+          attr_accessor outcome: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::outcome
+
+          attr_accessor suggested_value: String?
+
+          def initialize: (
+            field: String,
+            message: String,
+            outcome: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::outcome,
+            suggested_value: String?
+          ) -> void
+
+          def to_hash: -> {
+            field: String,
+            message: String,
+            outcome: SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::outcome,
+            suggested_value: String?
+          }
+
+          type outcome = :warning
+
+          module Outcome
+            extend SurgeAPI::Internal::Type::Enum
+
+            WARNING: :warning
+
+            def self?.values: -> ::Array[SurgeAPI::Models::CampaignWarningWebhookEvent::Data::Feedback::outcome]
+          end
+        end
+
+        type status = :in_review
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          IN_REVIEW: :in_review
+
+          def self?.values: -> ::Array[SurgeAPI::Models::CampaignWarningWebhookEvent::Data::status]
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/message.rbs

@@ -7,7 +7,9 @@ module SurgeAPI
         blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
-        metadata: ::Hash[Symbol, String]
+        failure_reason: String?,
+        metadata: ::Hash[Symbol, String],
+        status: SurgeAPI::Models::Message::status
       }
 
     class Message < SurgeAPI::Internal::Type::BaseModel
@@ -31,17 +33,27 @@ module SurgeAPI
         SurgeAPI::Message::Conversation
       ) -> SurgeAPI::Message::Conversation
 
+      attr_accessor failure_reason: String?
+
       attr_reader metadata: ::Hash[Symbol, String]?
 
       def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
 
+      attr_reader status: SurgeAPI::Models::Message::status?
+
+      def status=: (
+        SurgeAPI::Models::Message::status
+      ) -> SurgeAPI::Models::Message::status
+
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Message::Attachment],
         ?blast_id: String?,
         ?body: String?,
         ?conversation: SurgeAPI::Message::Conversation,
-        ?metadata: ::Hash[Symbol, String]
+        ?failure_reason: String?,
+        ?metadata: ::Hash[Symbol, String],
+        ?status: SurgeAPI::Models::Message::status
       ) -> void
 
       def to_hash: -> {
@@ -50,7 +62,9 @@ module SurgeAPI
         blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
-        metadata: ::Hash[Symbol, String]
+        failure_reason: String?,
+        metadata: ::Hash[Symbol, String],
+        status: SurgeAPI::Models::Message::status
       }
 
       type attachment =
@@ -135,6 +149,7 @@ module SurgeAPI
         type phone_number =
           {
             id: String,
+            metadata: ::Hash[Symbol, String],
             name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
@@ -143,6 +158,8 @@ module SurgeAPI
         class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
           attr_accessor id: String
 
+          attr_accessor metadata: ::Hash[Symbol, String]
+
           attr_accessor name: String?
 
           attr_accessor number: String
@@ -151,6 +168,7 @@ module SurgeAPI
 
           def initialize: (
             id: String,
+            metadata: ::Hash[Symbol, String],
             name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
@@ -158,6 +176,7 @@ module SurgeAPI
 
           def to_hash: -> {
             id: String,
+            metadata: ::Hash[Symbol, String],
             name: String?,
             number: String,
             type: SurgeAPI::Models::Message::Conversation::PhoneNumber::type_
@@ -177,6 +196,20 @@ module SurgeAPI
           end
         end
       end
+
+      type status = :pending | :received | :sent | :delivered | :failed
+
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        PENDING: :pending
+        RECEIVED: :received
+        SENT: :sent
+        DELIVERED: :delivered
+        FAILED: :failed
+
+        def self?.values: -> ::Array[SurgeAPI::Models::Message::status]
+      end
     end
   end
 end

data/sig/surge_api/models/message_delivered_webhook_event.rbs

@@ -37,7 +37,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -51,8 +53,12 @@ module SurgeAPI
 
         attr_accessor delivered_at: Time
 
+        attr_accessor failure_reason: String?
+
         attr_accessor metadata: ::Hash[Symbol, String]
 
+        attr_accessor status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -68,7 +74,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -78,7 +86,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +120,16 @@ module SurgeAPI
           }
         end
 
+        type status = :delivered
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          DELIVERED: :delivered
+
+          def self?.values: -> ::Array[SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status]
+        end
+
         type attachment =
           {
             id: String,

data/sig/surge_api/models/message_failed_webhook_event.rbs

@@ -37,8 +37,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
-          failure_reason: String,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -52,10 +53,12 @@ module SurgeAPI
 
         attr_accessor failed_at: Time
 
-        attr_accessor failure_reason: String
+        attr_accessor failure_reason: String?
 
         attr_accessor metadata: ::Hash[Symbol, String]
 
+        attr_accessor status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -71,8 +74,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
-          failure_reason: String,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -82,8 +86,9 @@ module SurgeAPI
           body: String?,
           conversation: SurgeAPI::MessageFailedWebhookEvent::Data::Conversation,
           failed_at: Time,
-          failure_reason: String,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -115,6 +120,16 @@ module SurgeAPI
           }
         end
 
+        type status = :failed
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          FAILED: :failed
+
+          def self?.values: -> ::Array[SurgeAPI::Models::MessageFailedWebhookEvent::Data::status]
+        end
+
         type attachment =
           {
             id: String,

data/sig/surge_api/models/message_received_webhook_event.rbs

@@ -36,8 +36,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -49,10 +51,14 @@ module SurgeAPI
 
         attr_accessor conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation
 
+        attr_accessor failure_reason: String?
+
         attr_accessor metadata: ::Hash[Symbol, String]
 
         attr_accessor received_at: Time
 
+        attr_accessor status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -67,8 +73,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -77,8 +85,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +120,16 @@ module SurgeAPI
           }
         end
 
+        type status = :received
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          RECEIVED: :received
+
+          def self?.values: -> ::Array[SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status]
+        end
+
         type attachment =
           {
             id: String,

data/sig/surge_api/models/message_sent_webhook_event.rbs

@@ -36,8 +36,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -49,10 +51,14 @@ module SurgeAPI
 
         attr_accessor conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation
 
+        attr_accessor failure_reason: String?
+
         attr_accessor metadata: ::Hash[Symbol, String]
 
         attr_accessor sent_at: Time
 
+        attr_accessor status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -67,8 +73,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -77,8 +85,10 @@ module SurgeAPI
           id: String,
           body: String?,
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
+          failure_reason: String?,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +120,16 @@ module SurgeAPI
           }
         end
 
+        type status = :sent
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          SENT: :sent
+
+          def self?.values: -> ::Array[SurgeAPI::Models::MessageSentWebhookEvent::Data::status]
+        end
+
         type attachment =
           {
             id: String,