surge_api 0.8.0 → 0.10.0

data/rbi/surge_api/models/recording_completed_webhook_event.rbi

@@ -0,0 +1,277 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingCompletedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::RecordingCompletedWebhookEvent,
+            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::RecordingCompletedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: SurgeAPI::RecordingCompletedWebhookEvent::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 `recording.completed` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::RecordingCompletedWebhookEvent::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 `recording.completed` for this event.
+        type: :"recording.completed"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::RecordingCompletedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::RecordingCompletedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the recording
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The call that produced this recording
+        sig { returns(SurgeAPI::RecordingCompletedWebhookEvent::Data::Call) }
+        attr_reader :call
+
+        sig do
+          params(
+            call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::OrHash
+          ).void
+        end
+        attr_writer :call
+
+        # The duration of the recording in seconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::OrHash,
+            duration: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the recording
+          id:,
+          # The call that produced this recording
+          call:,
+          # The duration of the recording in seconds
+          duration:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call,
+              duration: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Call < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier for the call
+          sig { returns(String) }
+          attr_accessor :id
+
+          # A contact who has consented to receive messages
+          sig { returns(SurgeAPI::Contact) }
+          attr_reader :contact
+
+          sig { params(contact: SurgeAPI::Contact::OrHash).void }
+          attr_writer :contact
+
+          # The duration of the call in seconds
+          sig { returns(Integer) }
+          attr_accessor :duration
+
+          # When the call was initiated
+          sig { returns(Time) }
+          attr_accessor :initiated_at
+
+          # The status of the call
+          sig do
+            returns(
+              SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # The call that produced this recording
+          sig do
+            params(
+              id: String,
+              contact: SurgeAPI::Contact::OrHash,
+              duration: Integer,
+              initiated_at: Time,
+              status:
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier for the call
+            id:,
+            # A contact who has consented to receive messages
+            contact:,
+            # The duration of the call in seconds
+            duration:,
+            # When the call was initiated
+            initiated_at:,
+            # The status of the call
+            status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                contact: SurgeAPI::Contact,
+                duration: Integer,
+                initiated_at: Time,
+                status:
+                  SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The status of the call
+          module Status
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            BUSY =
+              T.let(
+                :busy,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            CANCELED =
+              T.let(
+                :canceled,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            MISSED =
+              T.let(
+                :missed,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            NO_ANSWER =
+              T.let(
+                :no_answer,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            QUEUED =
+              T.let(
+                :queued,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            RINGING =
+              T.let(
+                :ringing,
+                SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/recording_get_file_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingGetFileParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::RecordingGetFileParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/recording_get_file_response.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class RecordingGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::Models::RecordingGetFileResponse,
+            SurgeAPI::Internal::AnyHash
+          )
+        end
+
+      # An error response
+      sig { returns(SurgeAPI::Error) }
+      attr_reader :error
+
+      sig { params(error: SurgeAPI::Error::OrHash).void }
+      attr_writer :error
+
+      # An error response
+      sig { params(error: SurgeAPI::Error::OrHash).returns(T.attached_class) }
+      def self.new(
+        # An error response
+        error:
+      )
+      end
+
+      sig { override.returns({ error: SurgeAPI::Error }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/unwrap_webhook_event.rbi

@@ -17,7 +17,9 @@ module SurgeAPI
             SurgeAPI::MessageDeliveredWebhookEvent,
             SurgeAPI::MessageFailedWebhookEvent,
             SurgeAPI::MessageReceivedWebhookEvent,
-            SurgeAPI::MessageSentWebhookEvent
+            SurgeAPI::MessageSentWebhookEvent,
+            SurgeAPI::RecordingCompletedWebhookEvent,
+            SurgeAPI::VoicemailReceivedWebhookEvent
           )
         end
 

data/rbi/surge_api/models/voicemail_received_webhook_event.rbi

@@ -0,0 +1,283 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class VoicemailReceivedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::VoicemailReceivedWebhookEvent,
+            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::VoicemailReceivedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: SurgeAPI::VoicemailReceivedWebhookEvent::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 `voicemail.received` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::VoicemailReceivedWebhookEvent::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 `voicemail.received` for this event.
+        type: :"voicemail.received"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::VoicemailReceivedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::VoicemailReceivedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the voicemail
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The call that resulted in this voicemail
+        sig { returns(SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call) }
+        attr_reader :call
+
+        sig do
+          params(
+            call: SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::OrHash
+          ).void
+        end
+        attr_writer :call
+
+        # The duration of the voicemail in seconds
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # The unique identifier for the recording
+        sig { returns(String) }
+        attr_accessor :recording_id
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            call: SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::OrHash,
+            duration: Integer,
+            recording_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the voicemail
+          id:,
+          # The call that resulted in this voicemail
+          call:,
+          # The duration of the voicemail in seconds
+          duration:,
+          # The unique identifier for the recording
+          recording_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              call: SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call,
+              duration: Integer,
+              recording_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Call < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier for the call
+          sig { returns(String) }
+          attr_accessor :id
+
+          # A contact who has consented to receive messages
+          sig { returns(SurgeAPI::Contact) }
+          attr_reader :contact
+
+          sig { params(contact: SurgeAPI::Contact::OrHash).void }
+          attr_writer :contact
+
+          # The duration of the call in seconds
+          sig { returns(Integer) }
+          attr_accessor :duration
+
+          # When the call was initiated
+          sig { returns(Time) }
+          attr_accessor :initiated_at
+
+          # The status of the call
+          sig do
+            returns(
+              SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
+          # The call that resulted in this voicemail
+          sig do
+            params(
+              id: String,
+              contact: SurgeAPI::Contact::OrHash,
+              duration: Integer,
+              initiated_at: Time,
+              status:
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier for the call
+            id:,
+            # A contact who has consented to receive messages
+            contact:,
+            # The duration of the call in seconds
+            duration:,
+            # When the call was initiated
+            initiated_at:,
+            # The status of the call
+            status:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                contact: SurgeAPI::Contact,
+                duration: Integer,
+                initiated_at: Time,
+                status:
+                  SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The status of the call
+          module Status
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            BUSY =
+              T.let(
+                :busy,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            CANCELED =
+              T.let(
+                :canceled,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            MISSED =
+              T.let(
+                :missed,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            NO_ANSWER =
+              T.let(
+                :no_answer,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            QUEUED =
+              T.let(
+                :queued,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+            RINGING =
+              T.let(
+                :ringing,
+                SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::VoicemailReceivedWebhookEvent::Data::Call::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

@@ -27,10 +27,14 @@ module SurgeAPI
 
   CampaignParams = SurgeAPI::Models::CampaignParams
 
+  CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
 
+  ContactListParams = SurgeAPI::Models::ContactListParams
+
   ContactOptedInWebhookEvent = SurgeAPI::Models::ContactOptedInWebhookEvent
 
   ContactOptedOutWebhookEvent = SurgeAPI::Models::ContactOptedOutWebhookEvent
@@ -54,6 +58,8 @@ module SurgeAPI
 
   MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
 
+  MessageListParams = SurgeAPI::Models::MessageListParams
+
   MessageParams = SurgeAPI::Models::MessageParams
 
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
@@ -66,8 +72,15 @@ module SurgeAPI
 
   PhoneNumber = SurgeAPI::Models::PhoneNumber
 
+  PhoneNumberListParams = SurgeAPI::Models::PhoneNumberListParams
+
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
 
+  RecordingCompletedWebhookEvent =
+    SurgeAPI::Models::RecordingCompletedWebhookEvent
+
+  RecordingGetFileParams = SurgeAPI::Models::RecordingGetFileParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User
@@ -92,5 +105,8 @@ module SurgeAPI
 
   VerificationCreateParams = SurgeAPI::Models::VerificationCreateParams
 
+  VoicemailReceivedWebhookEvent =
+    SurgeAPI::Models::VoicemailReceivedWebhookEvent
+
   WebhookUnwrapParams = SurgeAPI::Models::WebhookUnwrapParams
 end

data/rbi/surge_api/resources/blasts.rbi

@@ -9,7 +9,7 @@ module SurgeAPI
           account_id: String,
           attachments:
             T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
-          body: String,
+          body: T.nilable(String),
           contacts: T::Array[String],
           from: String,
           name: String,

data/rbi/surge_api/resources/campaigns.rbi

@@ -21,6 +21,20 @@ module SurgeAPI
       )
       end
 
+      # Retrieves a Campaign object.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Campaign)
+      end
+      def retrieve(
+        # The ID of the campaign to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
       def self.new(client:)