surge_api 0.1.0

data/rbi/surge_api/models/conversation_created_webhook_event.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class ConversationCreatedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::ConversationCreatedWebhookEvent,
+            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::ConversationCreatedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: SurgeAPI::ConversationCreatedWebhookEvent::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 `conversation.created` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::ConversationCreatedWebhookEvent::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 `conversation.created` for this event.
+        type: :"conversation.created"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::ConversationCreatedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::ConversationCreatedWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the conversation
+        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
+
+        # A phone number that can be used to send and receive messages and calls
+        sig { returns(SurgeAPI::PhoneNumber) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: SurgeAPI::PhoneNumber::OrHash).void }
+        attr_writer :phone_number
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            contact: SurgeAPI::Contact::OrHash,
+            phone_number: SurgeAPI::PhoneNumber::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the conversation
+          id:,
+          # A contact who has consented to receive messages
+          contact:,
+          # A phone number that can be used to send and receive messages and calls
+          phone_number:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              contact: SurgeAPI::Contact,
+              phone_number: SurgeAPI::PhoneNumber
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/surge_api/models/error.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class Error < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(SurgeAPI::Error, SurgeAPI::Internal::AnyHash) }
+
+      # A human-readable error message.
+      sig { returns(String) }
+      attr_accessor :message
+
+      # A unique error code.
+      sig { returns(String) }
+      attr_accessor :type
+
+      # Additional details about the error.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :detail
+
+      sig { params(detail: T::Hash[Symbol, T.anything]).void }
+      attr_writer :detail
+
+      # An error response
+      sig do
+        params(
+          message: String,
+          type: String,
+          detail: T::Hash[Symbol, T.anything]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A human-readable error message.
+        message:,
+        # A unique error code.
+        type:,
+        # Additional details about the error.
+        detail: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { message: String, type: String, detail: T::Hash[Symbol, T.anything] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models/message.rbi

@@ -0,0 +1,283 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class Message < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(SurgeAPI::Message, 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::Message::Attachment])) }
+      attr_reader :attachments
+
+      sig do
+        params(
+          attachments: T::Array[SurgeAPI::Message::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
+
+      # A conversation with a Contact
+      sig { returns(T.nilable(SurgeAPI::Message::Conversation)) }
+      attr_reader :conversation
+
+      sig { params(conversation: SurgeAPI::Message::Conversation::OrHash).void }
+      attr_writer :conversation
+
+      # A Message is a communication sent to a Contact.
+      sig do
+        params(
+          id: String,
+          attachments: T::Array[SurgeAPI::Message::Attachment::OrHash],
+          body: String,
+          conversation: SurgeAPI::Message::Conversation::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id: nil,
+        attachments: nil,
+        # The message body.
+        body: nil,
+        # A conversation with a Contact
+        conversation: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            attachments: T::Array[SurgeAPI::Message::Attachment],
+            body: String,
+            conversation: SurgeAPI::Message::Conversation
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SurgeAPI::Message::Attachment, SurgeAPI::Internal::AnyHash)
+          end
+
+        # Unique identifier for the object.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The type of attachment.
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # The URL of the attachment.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        # An Attachment is a file that can be sent with a message.
+        sig do
+          params(id: String, type: String, url: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for the object.
+          id: nil,
+          # The type of attachment.
+          type: nil,
+          # The URL of the attachment.
+          url: nil
+        )
+        end
+
+        sig { override.returns({ id: String, type: String, url: String }) }
+        def to_hash
+        end
+      end
+
+      class Conversation < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SurgeAPI::Message::Conversation, SurgeAPI::Internal::AnyHash)
+          end
+
+        # Unique identifier for the object.
+        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
+
+        # This is the phone number tied to the Surge account.
+        sig { returns(T.nilable(SurgeAPI::Message::Conversation::PhoneNumber)) }
+        attr_reader :phone_number
+
+        sig do
+          params(
+            phone_number: SurgeAPI::Message::Conversation::PhoneNumber::OrHash
+          ).void
+        end
+        attr_writer :phone_number
+
+        # A conversation with a Contact
+        sig do
+          params(
+            id: String,
+            contact: SurgeAPI::Contact::OrHash,
+            phone_number: SurgeAPI::Message::Conversation::PhoneNumber::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the object.
+          id:,
+          # A contact who has consented to receive messages
+          contact:,
+          # This is the phone number tied to the Surge account.
+          phone_number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              contact: SurgeAPI::Contact,
+              phone_number: SurgeAPI::Message::Conversation::PhoneNumber
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PhoneNumber < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::Message::Conversation::PhoneNumber,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for the phone number
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The canonical format of the phone number.
+          sig { returns(String) }
+          attr_accessor :number
+
+          # Whether the phone number is local, toll-free, or short code
+          sig do
+            returns(
+              SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+            )
+          end
+          attr_accessor :type
+
+          # This is the phone number tied to the Surge account.
+          sig do
+            params(
+              id: String,
+              number: String,
+              type: SurgeAPI::Message::Conversation::PhoneNumber::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for the phone number
+            id:,
+            # The canonical format of the phone number.
+            number:,
+            # Whether the phone number is local, toll-free, or short code
+            type:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                number: String,
+                type:
+                  SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          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::Message::Conversation::PhoneNumber::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOCAL =
+              T.let(
+                :local,
+                SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+              )
+            TOLL_FREE =
+              T.let(
+                :toll_free,
+                SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+              )
+            SHORT_CODE =
+              T.let(
+                :short_code,
+                SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+              )
+            DEMO =
+              T.let(
+                :demo,
+                SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::Message::Conversation::PhoneNumber::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end