surge_api 0.1.0

data/rbi/surge_api/models/blast.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class Blast < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(SurgeAPI::Blast, SurgeAPI::Internal::AnyHash) }
+
+      # Unique identifier for the object.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(T::Array[SurgeAPI::Blast::Attachment])) }
+      attr_reader :attachments
+
+      sig do
+        params(attachments: T::Array[SurgeAPI::Blast::Attachment::OrHash]).void
+      end
+      attr_writer :attachments
+
+      # The message body.
+      sig { returns(T.nilable(String)) }
+      attr_reader :body
+
+      sig { params(body: String).void }
+      attr_writer :body
+
+      # Optional name for the blast.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # When the blast will be or was sent.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :send_at
+
+      sig { params(send_at: Time).void }
+      attr_writer :send_at
+
+      # A Blast is a message sent to multiple recipients at once.
+      sig do
+        params(
+          id: String,
+          attachments: T::Array[SurgeAPI::Blast::Attachment::OrHash],
+          body: String,
+          name: String,
+          send_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id: nil,
+        attachments: nil,
+        # The message body.
+        body: nil,
+        # Optional name for the blast.
+        name: nil,
+        # When the blast will be or was sent.
+        send_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            attachments: T::Array[SurgeAPI::Blast::Attachment],
+            body: String,
+            name: String,
+            send_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SurgeAPI::Blast::Attachment, SurgeAPI::Internal::AnyHash)
+          end
+
+        # The URL of the attachment.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig { params(url: String).returns(T.attached_class) }
+        def self.new(
+          # The URL of the attachment.
+          url: nil
+        )
+        end
+
+        sig { override.returns({ url: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/blast_create_params.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class BlastCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::BlastCreateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      sig do
+        returns(T.nilable(T::Array[SurgeAPI::BlastCreateParams::Attachment]))
+      end
+      attr_reader :attachments
+
+      sig do
+        params(
+          attachments: T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash]
+        ).void
+      end
+      attr_writer :attachments
+
+      # The message body.
+      sig { returns(T.nilable(String)) }
+      attr_reader :body
+
+      sig { params(body: String).void }
+      attr_writer :body
+
+      # Deprecated. Use `to` instead.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :contacts
+
+      sig { params(contacts: T::Array[String]).void }
+      attr_writer :contacts
+
+      # Optional name for the blast.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Deprecated. Use `to` instead.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :segments
+
+      sig { params(segments: T::Array[String]).void }
+      attr_writer :segments
+
+      # When to send the blast. If not provided, sends immediately.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :send_at
+
+      sig { params(send_at: Time).void }
+      attr_writer :send_at
+
+      # List of recipients to whom the blast should be sent. This can be a combination
+      # of contact IDs, segment IDs, and phone numbers.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :to
+
+      sig { params(to: T::Array[String]).void }
+      attr_writer :to
+
+      sig do
+        params(
+          attachments:
+            T::Array[SurgeAPI::BlastCreateParams::Attachment::OrHash],
+          body: String,
+          contacts: T::Array[String],
+          name: String,
+          segments: T::Array[String],
+          send_at: Time,
+          to: T::Array[String],
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        attachments: nil,
+        # The message body.
+        body: nil,
+        # Deprecated. Use `to` instead.
+        contacts: nil,
+        # Optional name for the blast.
+        name: nil,
+        # Deprecated. Use `to` instead.
+        segments: nil,
+        # When to send the blast. If not provided, sends immediately.
+        send_at: nil,
+        # List of recipients to whom the blast should be sent. This can be a combination
+        # of contact IDs, segment IDs, and phone numbers.
+        to: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            attachments: T::Array[SurgeAPI::BlastCreateParams::Attachment],
+            body: String,
+            contacts: T::Array[String],
+            name: String,
+            segments: T::Array[String],
+            send_at: Time,
+            to: T::Array[String],
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::BlastCreateParams::Attachment,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The URL of the attachment.
+        sig { returns(String) }
+        attr_accessor :url
+
+        # Params for creating an attachment
+        sig { params(url: String).returns(T.attached_class) }
+        def self.new(
+          # The URL of the attachment.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/call_ended_webhook_event.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class CallEndedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::CallEndedWebhookEvent, 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::CallEndedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig { params(data: SurgeAPI::CallEndedWebhookEvent::Data::OrHash).void }
+      attr_writer :data
+
+      # The timestamp when this event occurred, in ISO8601 format
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The type of the event. Always `call.ended` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::CallEndedWebhookEvent::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 `call.ended` for this event.
+        type: :"call.ended"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::CallEndedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::CallEndedWebhookEvent::Data,
+              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::CallEndedWebhookEvent::Data::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            contact: SurgeAPI::Contact::OrHash,
+            duration: Integer,
+            initiated_at: Time,
+            status: SurgeAPI::CallEndedWebhookEvent::Data::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::CallEndedWebhookEvent::Data::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::CallEndedWebhookEvent::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BUSY =
+            T.let(
+              :busy,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          CANCELED =
+            T.let(
+              :canceled,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          MISSED =
+            T.let(
+              :missed,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          NO_ANSWER =
+            T.let(
+              :no_answer,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          QUEUED =
+            T.let(
+              :queued,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RINGING =
+            T.let(
+              :ringing,
+              SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SurgeAPI::CallEndedWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end