surge_api 0.23.0 → 0.24.0

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

data/rbi/surge_api/models/unwrap_webhook_event.rbi

@@ -19,6 +19,7 @@ module SurgeAPI
             SurgeAPI::MessageReceivedWebhookEvent,
             SurgeAPI::MessageSentWebhookEvent,
             SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent,
+            SurgeAPI::PhoneNumberImportedWebhookEvent,
             SurgeAPI::RecordingCompletedWebhookEvent,
             SurgeAPI::VoicemailReceivedWebhookEvent
           )

data/rbi/surge_api/models.rbi

@@ -94,6 +94,9 @@ module SurgeAPI
   PhoneNumberAttachedToCampaignWebhookEvent =
     SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent
 
+  PhoneNumberImportedWebhookEvent =
+    SurgeAPI::Models::PhoneNumberImportedWebhookEvent
+
   PhoneNumberListAvailableNumbersParams =
     SurgeAPI::Models::PhoneNumberListAvailableNumbersParams
 

data/rbi/surge_api/resources/webhooks.rbi

@@ -21,6 +21,7 @@ module SurgeAPI
             SurgeAPI::MessageReceivedWebhookEvent,
             SurgeAPI::MessageSentWebhookEvent,
             SurgeAPI::PhoneNumberAttachedToCampaignWebhookEvent,
+            SurgeAPI::PhoneNumberImportedWebhookEvent,
             SurgeAPI::RecordingCompletedWebhookEvent,
             SurgeAPI::VoicemailReceivedWebhookEvent
           )

data/sig/surge_api/models/account_retrieve_status_params.rbs

@@ -31,12 +31,13 @@ module SurgeAPI
         request_options: SurgeAPI::RequestOptions
       }
 
-      type capability = :local_messaging
+      type capability = :local_messaging | :toll_free_messaging
 
       module Capability
         extend SurgeAPI::Internal::Type::Enum
 
         LOCAL_MESSAGING: :local_messaging
+        TOLL_FREE_MESSAGING: :toll_free_messaging
 
         def self?.values: -> ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
       end

data/sig/surge_api/models/campaign.rbs

@@ -83,13 +83,15 @@ module SurgeAPI
         def self?.values: -> ::Array[SurgeAPI::Models::Campaign::include_]
       end
 
-      type status = :active | :canceled | :created | :deactivated | :in_review
+      type status =
+        :active | :canceled | :rejected | :created | :deactivated | :in_review
 
       module Status
         extend SurgeAPI::Internal::Type::Enum
 
         ACTIVE: :active
         CANCELED: :canceled
+        REJECTED: :rejected
         CREATED: :created
         DEACTIVATED: :deactivated
         IN_REVIEW: :in_review

data/sig/surge_api/models/message.rbs

@@ -7,7 +7,8 @@ module SurgeAPI
         blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
-        metadata: ::Hash[Symbol, String]
+        metadata: ::Hash[Symbol, String],
+        status: SurgeAPI::Models::Message::status
       }
 
     class Message < SurgeAPI::Internal::Type::BaseModel
@@ -35,13 +36,20 @@ module SurgeAPI
 
       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]
+        ?metadata: ::Hash[Symbol, String],
+        ?status: SurgeAPI::Models::Message::status
       ) -> void
 
       def to_hash: -> {
@@ -50,7 +58,8 @@ module SurgeAPI
         blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
-        metadata: ::Hash[Symbol, String]
+        metadata: ::Hash[Symbol, String],
+        status: SurgeAPI::Models::Message::status
       }
 
       type attachment =
@@ -177,6 +186,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

@@ -38,6 +38,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -53,6 +54,8 @@ module SurgeAPI
 
         attr_accessor metadata: ::Hash[Symbol, String]
 
+        attr_accessor status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -69,6 +72,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -79,6 +83,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
           delivered_at: Time,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +115,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

@@ -39,6 +39,7 @@ module SurgeAPI
           failed_at: Time,
           failure_reason: String,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -56,6 +57,8 @@ module SurgeAPI
 
         attr_accessor metadata: ::Hash[Symbol, String]
 
+        attr_accessor status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -73,6 +76,7 @@ module SurgeAPI
           failed_at: Time,
           failure_reason: String,
           metadata: ::Hash[Symbol, String],
+          status: SurgeAPI::Models::MessageFailedWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -84,6 +88,7 @@ module SurgeAPI
           failed_at: Time,
           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

@@ -38,6 +38,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -53,6 +54,8 @@ module SurgeAPI
 
         attr_accessor received_at: Time
 
+        attr_accessor status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -69,6 +72,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -79,6 +83,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           received_at: Time,
+          status: SurgeAPI::Models::MessageReceivedWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +115,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

@@ -38,6 +38,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -53,6 +54,8 @@ module SurgeAPI
 
         attr_accessor sent_at: Time
 
+        attr_accessor status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status
+
         attr_reader attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment]?
 
         def attachments=: (
@@ -69,6 +72,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           ?attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           ?blast_id: String
         ) -> void
@@ -79,6 +83,7 @@ module SurgeAPI
           conversation: SurgeAPI::MessageSentWebhookEvent::Data::Conversation,
           metadata: ::Hash[Symbol, String],
           sent_at: Time,
+          status: SurgeAPI::Models::MessageSentWebhookEvent::Data::status,
           attachments: ::Array[SurgeAPI::MessageSentWebhookEvent::Data::Attachment],
           blast_id: String
         }
@@ -110,6 +115,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,