surge_api 0.1.0

data/lib/surge_api/models/message_delivered_webhook_event.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class MessageDeliveredWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::MessageDeliveredWebhookEvent::Data]
+      required :data, -> { SurgeAPI::MessageDeliveredWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `message.delivered` for this event.
+      #
+      #   @return [Symbol, :"message.delivered"]
+      required :type, const: :"message.delivered"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"message.delivered")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::MessageDeliveredWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"message.delivered"] The type of the event. Always `message.delivered` for this event.
+
+      # @see SurgeAPI::Models::MessageDeliveredWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the message
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute body
+        #   The content of the message
+        #
+        #   @return [String]
+        required :body, String
+
+        # @!attribute conversation
+        #   The conversation this message belongs to
+        #
+        #   @return [SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Conversation]
+        required :conversation, -> { SurgeAPI::MessageDeliveredWebhookEvent::Data::Conversation }
+
+        # @!attribute delivered_at
+        #   When the message was delivered
+        #
+        #   @return [Time]
+        required :delivered_at, Time
+
+        # @!attribute attachments
+        #   Attachments included with the message
+        #
+        #   @return [Array<SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment] }
+
+        # @!method initialize(id:, body:, conversation:, delivered_at:, attachments: nil)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the message
+        #
+        #   @param body [String] The content of the message
+        #
+        #   @param conversation [SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Conversation] The conversation this message belongs to
+        #
+        #   @param delivered_at [Time] When the message was delivered
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment>] Attachments included with the message
+
+        # @see SurgeAPI::Models::MessageDeliveredWebhookEvent::Data#conversation
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the conversation
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute contact
+          #   A contact who has consented to receive messages
+          #
+          #   @return [SurgeAPI::Models::Contact]
+          required :contact, -> { SurgeAPI::Contact }
+
+          # @!attribute phone_number
+          #   A phone number that can be used to send and receive messages and calls
+          #
+          #   @return [SurgeAPI::Models::PhoneNumber]
+          required :phone_number, -> { SurgeAPI::PhoneNumber }
+
+          # @!method initialize(id:, contact:, phone_number:)
+          #   The conversation this message belongs to
+          #
+          #   @param id [String] The unique identifier for the conversation
+          #
+          #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+          #
+          #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
+        end
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the attachment
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute type
+          #   The type of attachment
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment::Type]
+          required :type, enum: -> { SurgeAPI::MessageDeliveredWebhookEvent::Data::Attachment::Type }
+
+          # @!attribute url
+          #   The URL where the attachment can be downloaded
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(id:, type:, url:)
+          #   @param id [String] The unique identifier for the attachment
+          #
+          #   @param type [Symbol, SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment::Type] The type of attachment
+          #
+          #   @param url [String] The URL where the attachment can be downloaded
+
+          # The type of attachment
+          #
+          # @see SurgeAPI::Models::MessageDeliveredWebhookEvent::Data::Attachment#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            FILE = :file
+            IMAGE = :image
+            LINK = :link
+            VIDEO = :video
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/message_failed_webhook_event.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class MessageFailedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::MessageFailedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::MessageFailedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `message.failed` for this event.
+      #
+      #   @return [Symbol, :"message.failed"]
+      required :type, const: :"message.failed"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"message.failed")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::MessageFailedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"message.failed"] The type of the event. Always `message.failed` for this event.
+
+      # @see SurgeAPI::Models::MessageFailedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the message
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute body
+        #   The content of the message
+        #
+        #   @return [String]
+        required :body, String
+
+        # @!attribute conversation
+        #   The conversation this message belongs to
+        #
+        #   @return [SurgeAPI::Models::MessageFailedWebhookEvent::Data::Conversation]
+        required :conversation, -> { SurgeAPI::MessageFailedWebhookEvent::Data::Conversation }
+
+        # @!attribute failed_at
+        #   When the message failed
+        #
+        #   @return [Time]
+        required :failed_at, Time
+
+        # @!attribute failure_reason
+        #   The reason the message failed to be delivered
+        #
+        #   @return [String]
+        required :failure_reason, String
+
+        # @!attribute attachments
+        #   Attachments included with the message
+        #
+        #   @return [Array<SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageFailedWebhookEvent::Data::Attachment] }
+
+        # @!method initialize(id:, body:, conversation:, failed_at:, failure_reason:, attachments: nil)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the message
+        #
+        #   @param body [String] The content of the message
+        #
+        #   @param conversation [SurgeAPI::Models::MessageFailedWebhookEvent::Data::Conversation] The conversation this message belongs to
+        #
+        #   @param failed_at [Time] When the message failed
+        #
+        #   @param failure_reason [String] The reason the message failed to be delivered
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment>] Attachments included with the message
+
+        # @see SurgeAPI::Models::MessageFailedWebhookEvent::Data#conversation
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the conversation
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute contact
+          #   A contact who has consented to receive messages
+          #
+          #   @return [SurgeAPI::Models::Contact]
+          required :contact, -> { SurgeAPI::Contact }
+
+          # @!attribute phone_number
+          #   A phone number that can be used to send and receive messages and calls
+          #
+          #   @return [SurgeAPI::Models::PhoneNumber]
+          required :phone_number, -> { SurgeAPI::PhoneNumber }
+
+          # @!method initialize(id:, contact:, phone_number:)
+          #   The conversation this message belongs to
+          #
+          #   @param id [String] The unique identifier for the conversation
+          #
+          #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+          #
+          #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
+        end
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the attachment
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute type
+          #   The type of attachment
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment::Type]
+          required :type, enum: -> { SurgeAPI::MessageFailedWebhookEvent::Data::Attachment::Type }
+
+          # @!attribute url
+          #   The URL to download the attachment
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(id:, type:, url:)
+          #   @param id [String] The unique identifier for the attachment
+          #
+          #   @param type [Symbol, SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment::Type] The type of attachment
+          #
+          #   @param url [String] The URL to download the attachment
+
+          # The type of attachment
+          #
+          # @see SurgeAPI::Models::MessageFailedWebhookEvent::Data::Attachment#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            FILE = :file
+            IMAGE = :image
+            LINK = :link
+            VIDEO = :video
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/message_received_webhook_event.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class MessageReceivedWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::MessageReceivedWebhookEvent::Data]
+      required :data, -> { SurgeAPI::MessageReceivedWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `message.received` for this event.
+      #
+      #   @return [Symbol, :"message.received"]
+      required :type, const: :"message.received"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"message.received")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::MessageReceivedWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"message.received"] The type of the event. Always `message.received` for this event.
+
+      # @see SurgeAPI::Models::MessageReceivedWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the message
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute body
+        #   The content of the message
+        #
+        #   @return [String]
+        required :body, String
+
+        # @!attribute conversation
+        #   The conversation this message belongs to
+        #
+        #   @return [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation]
+        required :conversation, -> { SurgeAPI::MessageReceivedWebhookEvent::Data::Conversation }
+
+        # @!attribute received_at
+        #   When the message was received
+        #
+        #   @return [Time]
+        required :received_at, Time
+
+        # @!attribute attachments
+        #   Attachments included with the message
+        #
+        #   @return [Array<SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment] }
+
+        # @!method initialize(id:, body:, conversation:, received_at:, attachments: nil)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the message
+        #
+        #   @param body [String] The content of the message
+        #
+        #   @param conversation [SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Conversation] The conversation this message belongs to
+        #
+        #   @param received_at [Time] When the message was received
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment>] Attachments included with the message
+
+        # @see SurgeAPI::Models::MessageReceivedWebhookEvent::Data#conversation
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the conversation
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute contact
+          #   A contact who has consented to receive messages
+          #
+          #   @return [SurgeAPI::Models::Contact]
+          required :contact, -> { SurgeAPI::Contact }
+
+          # @!attribute phone_number
+          #   A phone number that can be used to send and receive messages and calls
+          #
+          #   @return [SurgeAPI::Models::PhoneNumber]
+          required :phone_number, -> { SurgeAPI::PhoneNumber }
+
+          # @!method initialize(id:, contact:, phone_number:)
+          #   The conversation this message belongs to
+          #
+          #   @param id [String] The unique identifier for the conversation
+          #
+          #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+          #
+          #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
+        end
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the attachment
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute type
+          #   The type of attachment
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment::Type]
+          required :type, enum: -> { SurgeAPI::MessageReceivedWebhookEvent::Data::Attachment::Type }
+
+          # @!attribute url
+          #   The URL to download the attachment
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(id:, type:, url:)
+          #   @param id [String] The unique identifier for the attachment
+          #
+          #   @param type [Symbol, SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment::Type] The type of attachment
+          #
+          #   @param url [String] The URL to download the attachment
+
+          # The type of attachment
+          #
+          # @see SurgeAPI::Models::MessageReceivedWebhookEvent::Data::Attachment#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            FILE = :file
+            IMAGE = :image
+            LINK = :link
+            VIDEO = :video
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/surge_api/models/message_sent_webhook_event.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class MessageSentWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::MessageSentWebhookEvent::Data]
+      required :data, -> { SurgeAPI::MessageSentWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `message.sent` for this event.
+      #
+      #   @return [Symbol, :"message.sent"]
+      required :type, const: :"message.sent"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"message.sent")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::MessageSentWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"message.sent"] The type of the event. Always `message.sent` for this event.
+
+      # @see SurgeAPI::Models::MessageSentWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the message
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute body
+        #   The content of the message
+        #
+        #   @return [String]
+        required :body, String
+
+        # @!attribute conversation
+        #   The conversation this message belongs to
+        #
+        #   @return [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation]
+        required :conversation, -> { SurgeAPI::MessageSentWebhookEvent::Data::Conversation }
+
+        # @!attribute sent_at
+        #   When the message was sent
+        #
+        #   @return [Time]
+        required :sent_at, Time
+
+        # @!attribute attachments
+        #   Attachments included with the message
+        #
+        #   @return [Array<SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment>, nil]
+        optional :attachments,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[SurgeAPI::MessageSentWebhookEvent::Data::Attachment] }
+
+        # @!method initialize(id:, body:, conversation:, sent_at:, attachments: nil)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the message
+        #
+        #   @param body [String] The content of the message
+        #
+        #   @param conversation [SurgeAPI::Models::MessageSentWebhookEvent::Data::Conversation] The conversation this message belongs to
+        #
+        #   @param sent_at [Time] When the message was sent
+        #
+        #   @param attachments [Array<SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment>] Attachments included with the message
+
+        # @see SurgeAPI::Models::MessageSentWebhookEvent::Data#conversation
+        class Conversation < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the conversation
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute contact
+          #   A contact who has consented to receive messages
+          #
+          #   @return [SurgeAPI::Models::Contact]
+          required :contact, -> { SurgeAPI::Contact }
+
+          # @!attribute phone_number
+          #   A phone number that can be used to send and receive messages and calls
+          #
+          #   @return [SurgeAPI::Models::PhoneNumber]
+          required :phone_number, -> { SurgeAPI::PhoneNumber }
+
+          # @!method initialize(id:, contact:, phone_number:)
+          #   The conversation this message belongs to
+          #
+          #   @param id [String] The unique identifier for the conversation
+          #
+          #   @param contact [SurgeAPI::Models::Contact] A contact who has consented to receive messages
+          #
+          #   @param phone_number [SurgeAPI::Models::PhoneNumber] A phone number that can be used to send and receive messages and calls
+        end
+
+        class Attachment < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique identifier for the attachment
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute type
+          #   The type of attachment
+          #
+          #   @return [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment::Type]
+          required :type, enum: -> { SurgeAPI::MessageSentWebhookEvent::Data::Attachment::Type }
+
+          # @!attribute url
+          #   The URL to download the attachment
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(id:, type:, url:)
+          #   @param id [String] The unique identifier for the attachment
+          #
+          #   @param type [Symbol, SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment::Type] The type of attachment
+          #
+          #   @param url [String] The URL to download the attachment
+
+          # The type of attachment
+          #
+          # @see SurgeAPI::Models::MessageSentWebhookEvent::Data::Attachment#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            FILE = :file
+            IMAGE = :image
+            LINK = :link
+            VIDEO = :video
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end