surge_api 0.1.0

data/rbi/surge_api/models/message_create_params.rbi

@@ -0,0 +1,281 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class MessageCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::MessageCreateParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      # Params for selecting or creating a new conversation. Either the id or the
+      # Contact must be given.
+      sig { returns(SurgeAPI::MessageCreateParams::Conversation) }
+      attr_reader :conversation
+
+      sig do
+        params(
+          conversation: SurgeAPI::MessageCreateParams::Conversation::OrHash
+        ).void
+      end
+      attr_writer :conversation
+
+      sig do
+        returns(T.nilable(T::Array[SurgeAPI::MessageCreateParams::Attachment]))
+      end
+      attr_reader :attachments
+
+      sig do
+        params(
+          attachments:
+            T::Array[SurgeAPI::MessageCreateParams::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
+
+      # An optional datetime for scheduling message up to a couple of months in the
+      # future.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :send_at
+
+      sig { params(send_at: Time).void }
+      attr_writer :send_at
+
+      # The recipient's phone number in E.164 format. Cannot be used together with
+      # 'conversation'.
+      sig { returns(String) }
+      attr_accessor :to
+
+      # The sender's phone number in E.164 format or phone number ID. If omitted, uses
+      # the account's default phone number. Cannot be used together with 'conversation'.
+      sig { returns(T.nilable(String)) }
+      attr_reader :from
+
+      sig { params(from: String).void }
+      attr_writer :from
+
+      sig do
+        params(
+          conversation: SurgeAPI::MessageCreateParams::Conversation::OrHash,
+          to: String,
+          attachments:
+            T::Array[SurgeAPI::MessageCreateParams::Attachment::OrHash],
+          body: String,
+          send_at: Time,
+          from: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Params for selecting or creating a new conversation. Either the id or the
+        # Contact must be given.
+        conversation:,
+        # The recipient's phone number in E.164 format. Cannot be used together with
+        # 'conversation'.
+        to:,
+        attachments: nil,
+        # The message body.
+        body: nil,
+        # An optional datetime for scheduling message up to a couple of months in the
+        # future.
+        send_at: nil,
+        # The sender's phone number in E.164 format or phone number ID. If omitted, uses
+        # the account's default phone number. Cannot be used together with 'conversation'.
+        from: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            conversation: SurgeAPI::MessageCreateParams::Conversation,
+            attachments: T::Array[SurgeAPI::MessageCreateParams::Attachment],
+            body: String,
+            send_at: Time,
+            to: String,
+            from: String,
+            request_options: SurgeAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Conversation < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::MessageCreateParams::Conversation,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # Parameters for creating a contact
+        sig { returns(SurgeAPI::MessageCreateParams::Conversation::Contact) }
+        attr_reader :contact
+
+        sig do
+          params(
+            contact:
+              SurgeAPI::MessageCreateParams::Conversation::Contact::OrHash
+          ).void
+        end
+        attr_writer :contact
+
+        # The phone number from which to send the message. This can be either the phone
+        # number in E.164 format or a Surge phone number id.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # Params for selecting or creating a new conversation. Either the id or the
+        # Contact must be given.
+        sig do
+          params(
+            contact:
+              SurgeAPI::MessageCreateParams::Conversation::Contact::OrHash,
+            phone_number: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Parameters for creating a contact
+          contact:,
+          # The phone number from which to send the message. This can be either the phone
+          # number in E.164 format or a Surge phone number id.
+          phone_number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              contact: SurgeAPI::MessageCreateParams::Conversation::Contact,
+              phone_number: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Contact < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::MessageCreateParams::Conversation::Contact,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The contact's phone number in E.164 format.
+          sig { returns(String) }
+          attr_accessor :phone_number
+
+          # The contact's email address.
+          sig { returns(T.nilable(String)) }
+          attr_reader :email
+
+          sig { params(email: String).void }
+          attr_writer :email
+
+          # The contact's first name.
+          sig { returns(T.nilable(String)) }
+          attr_reader :first_name
+
+          sig { params(first_name: String).void }
+          attr_writer :first_name
+
+          # The contact's last name.
+          sig { returns(T.nilable(String)) }
+          attr_reader :last_name
+
+          sig { params(last_name: String).void }
+          attr_writer :last_name
+
+          # Set of key-value pairs that will be stored with the object.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :metadata
+
+          sig { params(metadata: T::Hash[Symbol, String]).void }
+          attr_writer :metadata
+
+          # Parameters for creating a contact
+          sig do
+            params(
+              phone_number: String,
+              email: String,
+              first_name: String,
+              last_name: String,
+              metadata: T::Hash[Symbol, String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The contact's phone number in E.164 format.
+            phone_number:,
+            # The contact's email address.
+            email: nil,
+            # The contact's first name.
+            first_name: nil,
+            # The contact's last name.
+            last_name: nil,
+            # Set of key-value pairs that will be stored with the object.
+            metadata: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                phone_number: String,
+                email: String,
+                first_name: String,
+                last_name: String,
+                metadata: T::Hash[Symbol, String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Attachment < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::MessageCreateParams::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/message_delivered_webhook_event.rbi

@@ -0,0 +1,331 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class MessageDeliveredWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SurgeAPI::MessageDeliveredWebhookEvent,
+            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::MessageDeliveredWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: SurgeAPI::MessageDeliveredWebhookEvent::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 `message.delivered` for this event.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          account_id: String,
+          data: SurgeAPI::MessageDeliveredWebhookEvent::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 `message.delivered` for this event.
+        type: :"message.delivered"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            data: SurgeAPI::MessageDeliveredWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SurgeAPI::MessageDeliveredWebhookEvent::Data,
+              SurgeAPI::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the message
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The content of the message
+        sig { returns(String) }
+        attr_accessor :body
+
+        # The conversation this message belongs to
+        sig do
+          returns(SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation)
+        end
+        attr_reader :conversation
+
+        sig do
+          params(
+            conversation:
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash
+          ).void
+        end
+        attr_writer :conversation
+
+        # When the message was delivered
+        sig { returns(Time) }
+        attr_accessor :delivered_at
+
+        # Attachments included with the message
+        sig do
+          returns(
+            T.nilable(
+              T::Array[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment]
+            )
+          )
+        end
+        attr_reader :attachments
+
+        sig do
+          params(
+            attachments:
+              T::Array[
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
+              ]
+          ).void
+        end
+        attr_writer :attachments
+
+        # The data associated with the event
+        sig do
+          params(
+            id: String,
+            body: String,
+            conversation:
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation::OrHash,
+            delivered_at: Time,
+            attachments:
+              T::Array[
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the message
+          id:,
+          # The content of the message
+          body:,
+          # The conversation this message belongs to
+          conversation:,
+          # When the message was delivered
+          delivered_at:,
+          # Attachments included with the message
+          attachments: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              body: String,
+              conversation:
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
+              delivered_at: Time,
+              attachments:
+                T::Array[
+                  SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation,
+                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 conversation this message belongs to
+          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
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment,
+                SurgeAPI::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier for the attachment
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of attachment
+          sig do
+            returns(
+              SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+            )
+          end
+          attr_accessor :type
+
+          # The URL where the attachment can be downloaded
+          sig { returns(String) }
+          attr_accessor :url
+
+          sig do
+            params(
+              id: String,
+              type:
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::OrSymbol,
+              url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier for the attachment
+            id:,
+            # The type of attachment
+            type:,
+            # The URL where the attachment can be downloaded
+            url:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                type:
+                  SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol,
+                url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The type of attachment
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FILE =
+              T.let(
+                :file,
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
+            IMAGE =
+              T.let(
+                :image,
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
+            LINK =
+              T.let(
+                :link,
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
+            VIDEO =
+              T.let(
+                :video,
+                SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end