surge_api 0.9.0 → 0.10.0

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,6 +27,8 @@ module SurgeAPI
 
   CampaignParams = SurgeAPI::Models::CampaignParams
 
+  CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
@@ -74,6 +76,11 @@ module SurgeAPI
 
   PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
 
+  RecordingCompletedWebhookEvent =
+    SurgeAPI::Models::RecordingCompletedWebhookEvent
+
+  RecordingGetFileParams = SurgeAPI::Models::RecordingGetFileParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User
@@ -98,5 +105,8 @@ module SurgeAPI
 
   VerificationCreateParams = SurgeAPI::Models::VerificationCreateParams
 
+  VoicemailReceivedWebhookEvent =
+    SurgeAPI::Models::VoicemailReceivedWebhookEvent
+
   WebhookUnwrapParams = SurgeAPI::Models::WebhookUnwrapParams
 end

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:)

data/rbi/surge_api/resources/recordings.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Resources
+    class Recordings
+      # Redirects to a signed URL where the recording audio file can be downloaded. URL
+      # is short-lived, so redirect should be followed immediately.
+      sig do
+        params(
+          recording_id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Models::RecordingGetFileResponse)
+      end
+      def get_file(
+        # The ID of the recording.
+        recording_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/surge_api/resources/webhooks.rbi

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

data/sig/surge_api/client.rbs

@@ -22,6 +22,8 @@ module SurgeAPI
 
     attr_reader phone_numbers: SurgeAPI::Resources::PhoneNumbers
 
+    attr_reader recordings: SurgeAPI::Resources::Recordings
+
     attr_reader users: SurgeAPI::Resources::Users
 
     attr_reader verifications: SurgeAPI::Resources::Verifications

data/sig/surge_api/models/campaign.rbs

@@ -8,6 +8,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         link_sample: String,
@@ -27,6 +28,8 @@ module SurgeAPI
 
       attr_accessor privacy_policy_url: String
 
+      attr_accessor status: SurgeAPI::Models::Campaign::status
+
       attr_accessor use_cases: ::Array[SurgeAPI::Models::Campaign::use_case]
 
       attr_accessor volume: SurgeAPI::Models::Campaign::volume
@@ -46,6 +49,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         ?link_sample: String,
@@ -59,6 +63,7 @@ module SurgeAPI
         includes: ::Array[SurgeAPI::Models::Campaign::include_],
         message_samples: ::Array[String],
         privacy_policy_url: String,
+        status: SurgeAPI::Models::Campaign::status,
         use_cases: ::Array[SurgeAPI::Models::Campaign::use_case],
         volume: SurgeAPI::Models::Campaign::volume,
         link_sample: String,
@@ -78,6 +83,29 @@ module SurgeAPI
         def self?.values: -> ::Array[SurgeAPI::Models::Campaign::include_]
       end
 
+      type status =
+        :active
+        | :canceled
+        | :created
+        | :deactivated
+        | :in_review
+        | :pending
+        | :rejected
+
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        ACTIVE: :active
+        CANCELED: :canceled
+        CREATED: :created
+        DEACTIVATED: :deactivated
+        IN_REVIEW: :in_review
+        PENDING: :pending
+        REJECTED: :rejected
+
+        def self?.values: -> ::Array[SurgeAPI::Models::Campaign::status]
+      end
+
       type use_case =
         :account_notification
         | :customer_care

data/sig/surge_api/models/campaign_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type campaign_retrieve_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class CampaignRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models/message.rbs

@@ -4,7 +4,7 @@ module SurgeAPI
       {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
-        blast_id: String,
+        blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
         metadata: ::Hash[Symbol, String]
@@ -21,9 +21,7 @@ module SurgeAPI
         ::Array[SurgeAPI::Message::Attachment]
       ) -> ::Array[SurgeAPI::Message::Attachment]
 
-      attr_reader blast_id: String?
-
-      def blast_id=: (String) -> String
+      attr_accessor blast_id: String?
 
       attr_accessor body: String?
 
@@ -40,7 +38,7 @@ module SurgeAPI
       def initialize: (
         ?id: String,
         ?attachments: ::Array[SurgeAPI::Message::Attachment],
-        ?blast_id: String,
+        ?blast_id: String?,
         ?body: String?,
         ?conversation: SurgeAPI::Message::Conversation,
         ?metadata: ::Hash[Symbol, String]
@@ -49,7 +47,7 @@ module SurgeAPI
       def to_hash: -> {
         id: String,
         attachments: ::Array[SurgeAPI::Message::Attachment],
-        blast_id: String,
+        blast_id: String?,
         body: String?,
         conversation: SurgeAPI::Message::Conversation,
         metadata: ::Hash[Symbol, String]

data/sig/surge_api/models/recording_completed_webhook_event.rbs

@@ -0,0 +1,126 @@
+module SurgeAPI
+  module Models
+    type recording_completed_webhook_event =
+      {
+        account_id: String,
+        data: SurgeAPI::RecordingCompletedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"recording.completed"
+      }
+
+    class RecordingCompletedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor account_id: String
+
+      attr_accessor data: SurgeAPI::RecordingCompletedWebhookEvent::Data
+
+      attr_accessor timestamp: Time
+
+      attr_accessor type: :"recording.completed"
+
+      def initialize: (
+        account_id: String,
+        data: SurgeAPI::RecordingCompletedWebhookEvent::Data,
+        timestamp: Time,
+        ?type: :"recording.completed"
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        data: SurgeAPI::RecordingCompletedWebhookEvent::Data,
+        timestamp: Time,
+        type: :"recording.completed"
+      }
+
+      type data =
+        {
+          id: String,
+          call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call,
+          duration: Integer
+        }
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call
+
+        attr_accessor duration: Integer
+
+        def initialize: (
+          id: String,
+          call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call,
+          duration: Integer
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          call: SurgeAPI::RecordingCompletedWebhookEvent::Data::Call,
+          duration: Integer
+        }
+
+        type call =
+          {
+            id: String,
+            contact: SurgeAPI::Contact,
+            duration: Integer,
+            initiated_at: Time,
+            status: SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status
+          }
+
+        class Call < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor contact: SurgeAPI::Contact
+
+          attr_accessor duration: Integer
+
+          attr_accessor initiated_at: Time
+
+          attr_accessor status: SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status
+
+          def initialize: (
+            id: String,
+            contact: SurgeAPI::Contact,
+            duration: Integer,
+            initiated_at: Time,
+            status: SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            contact: SurgeAPI::Contact,
+            duration: Integer,
+            initiated_at: Time,
+            status: SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status
+          }
+
+          type status =
+            :busy
+            | :canceled
+            | :completed
+            | :failed
+            | :in_progress
+            | :missed
+            | :no_answer
+            | :queued
+            | :ringing
+
+          module Status
+            extend SurgeAPI::Internal::Type::Enum
+
+            BUSY: :busy
+            CANCELED: :canceled
+            COMPLETED: :completed
+            FAILED: :failed
+            IN_PROGRESS: :in_progress
+            MISSED: :missed
+            NO_ANSWER: :no_answer
+            QUEUED: :queued
+            RINGING: :ringing
+
+            def self?.values: -> ::Array[SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/recording_get_file_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type recording_get_file_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class RecordingGetFileParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models/recording_get_file_response.rbs

@@ -0,0 +1,13 @@
+module SurgeAPI
+  module Models
+    type recording_get_file_response = { error: SurgeAPI::Error }
+
+    class RecordingGetFileResponse < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor error: SurgeAPI::Error
+
+      def initialize: (error: SurgeAPI::Error) -> void
+
+      def to_hash: -> { error: SurgeAPI::Error }
+    end
+  end
+end

data/sig/surge_api/models/unwrap_webhook_event.rbs

@@ -11,6 +11,8 @@ module SurgeAPI
       | SurgeAPI::MessageFailedWebhookEvent
       | SurgeAPI::MessageReceivedWebhookEvent
       | SurgeAPI::MessageSentWebhookEvent
+      | SurgeAPI::RecordingCompletedWebhookEvent
+      | SurgeAPI::VoicemailReceivedWebhookEvent
 
     module UnwrapWebhookEvent
       extend SurgeAPI::Internal::Type::Union