surge_api 0.9.0 → 0.10.0

data/rbi/surge_api/models/campaign.rbi

@@ -50,6 +50,10 @@ module SurgeAPI
       sig { returns(String) }
       attr_accessor :privacy_policy_url
 
+      # The current status of the campaign.
+      sig { returns(SurgeAPI::Campaign::Status::TaggedSymbol) }
+      attr_accessor :status
+
       # A list containing 1-5 types of messages that will be sent with this campaign.
       #
       # The following use cases are typically available to all brands:
@@ -123,6 +127,7 @@ module SurgeAPI
           includes: T::Array[SurgeAPI::Campaign::Include::OrSymbol],
           message_samples: T::Array[String],
           privacy_policy_url: String,
+          status: SurgeAPI::Campaign::Status::OrSymbol,
           use_cases: T::Array[SurgeAPI::Campaign::UseCase::OrSymbol],
           volume: SurgeAPI::Campaign::Volume::OrSymbol,
           link_sample: String,
@@ -162,6 +167,8 @@ module SurgeAPI
         # privacy policy if it's the policy that is displayed to end users when they opt
         # in to messaging.
         privacy_policy_url:,
+        # The current status of the campaign.
+        status:,
         # A list containing 1-5 types of messages that will be sent with this campaign.
         #
         # The following use cases are typically available to all brands:
@@ -223,6 +230,7 @@ module SurgeAPI
             includes: T::Array[SurgeAPI::Campaign::Include::TaggedSymbol],
             message_samples: T::Array[String],
             privacy_policy_url: String,
+            status: SurgeAPI::Campaign::Status::TaggedSymbol,
             use_cases: T::Array[SurgeAPI::Campaign::UseCase::TaggedSymbol],
             volume: SurgeAPI::Campaign::Volume::TaggedSymbol,
             link_sample: String,
@@ -254,6 +262,30 @@ module SurgeAPI
         end
       end
 
+      # The current status of the campaign.
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, SurgeAPI::Campaign::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE = T.let(:active, SurgeAPI::Campaign::Status::TaggedSymbol)
+        CANCELED = T.let(:canceled, SurgeAPI::Campaign::Status::TaggedSymbol)
+        CREATED = T.let(:created, SurgeAPI::Campaign::Status::TaggedSymbol)
+        DEACTIVATED =
+          T.let(:deactivated, SurgeAPI::Campaign::Status::TaggedSymbol)
+        IN_REVIEW = T.let(:in_review, SurgeAPI::Campaign::Status::TaggedSymbol)
+        PENDING = T.let(:pending, SurgeAPI::Campaign::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, SurgeAPI::Campaign::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[SurgeAPI::Campaign::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
       module UseCase
         extend SurgeAPI::Internal::Type::Enum
 

data/rbi/surge_api/models/campaign_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CampaignRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::CampaignRetrieveParams, 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/message.rbi

@@ -26,10 +26,7 @@ module SurgeAPI
       # The ID of the blast this message belongs to, if any. This can be used to
       # attribute messages back to a specific blast.
       sig { returns(T.nilable(String)) }
-      attr_reader :blast_id
-
-      sig { params(blast_id: String).void }
-      attr_writer :blast_id
+      attr_accessor :blast_id
 
       # The message body.
       sig { returns(T.nilable(String)) }
@@ -54,7 +51,7 @@ module SurgeAPI
         params(
           id: String,
           attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
-          blast_id: String,
+          blast_id: T.nilable(String),
           body: T.nilable(String),
           conversation: SurgeAPI::Message::Conversation::OrHash,
           metadata: T::Hash[Symbol, String]
@@ -81,7 +78,7 @@ module SurgeAPI
           {
             id: String,
             attachments: T::Array[SurgeAPI::Message::Attachment],
-            blast_id: String,
+            blast_id: T.nilable(String),
             body: T.nilable(String),
             conversation: SurgeAPI::Message::Conversation,
             metadata: T::Hash[Symbol, String]

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