moonbase-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/lib/moonbase/models/email_message.rb

@@ -10,16 +10,36 @@ module Moonbase
       #   @return [String]
       required :id, String
 
-      # @!attribute links
+      # @!attribute body
+      #   Structured content that can be rendered in multiple formats, currently
+      #   supporting Markdown.
       #
-      #   @return [Moonbase::Models::EmailMessage::Links]
-      required :links, -> { Moonbase::EmailMessage::Links }
+      #   @return [Moonbase::Models::FormattedText]
+      required :body, -> { Moonbase::FormattedText }
 
-      # @!attribute rfc822_message_id
-      #   The globally unique `Message-ID` header of the email.
+      # @!attribute bulk
+      #   `true` if the message appears to be part of a bulk mailing.
       #
-      #   @return [String]
-      required :rfc822_message_id, String
+      #   @return [Boolean]
+      required :bulk, Moonbase::Internal::Type::Boolean
+
+      # @!attribute created_at
+      #   The time the message was received, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute draft
+      #   `true` if the message is a draft that has not been sent.
+      #
+      #   @return [Boolean]
+      required :draft, Moonbase::Internal::Type::Boolean
+
+      # @!attribute spam
+      #   `true` if the message is classified as spam.
+      #
+      #   @return [Boolean]
+      required :spam, Moonbase::Internal::Type::Boolean
 
       # @!attribute subject
       #   The subject line of the email.
@@ -27,91 +47,55 @@ module Moonbase
       #   @return [String]
       required :subject, String
 
+      # @!attribute trash
+      #   `true` if the message is in the trash.
+      #
+      #   @return [Boolean]
+      required :trash, Moonbase::Internal::Type::Boolean
+
       # @!attribute type
       #   String representing the object’s type. Always `email_message` for this object.
       #
       #   @return [Symbol, :email_message]
       required :type, const: :email_message
 
+      # @!attribute unread
+      #   `true` if the message has not been read.
+      #
+      #   @return [Boolean]
+      required :unread, Moonbase::Internal::Type::Boolean
+
       # @!attribute addresses
       #   A list of `Address` objects associated with the message (sender and recipients).
       #
+      #   **Note:** Only present when requested using the `include` query parameter.
+      #
       #   @return [Array<Moonbase::Models::Address>, nil]
       optional :addresses, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Address] }
 
       # @!attribute attachments
       #   A list of `Attachment` objects on the message.
       #
+      #   **Note:** Only present when requested using the `include` query parameter.
+      #
       #   @return [Array<Moonbase::Models::EmailMessage::Attachment>, nil]
       optional :attachments, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::EmailMessage::Attachment] }
 
-      # @!attribute body_html
-      #   The HTML content of the email body.
-      #
-      #   @return [String, nil]
-      optional :body_html, String
-
-      # @!attribute body_plain
-      #   The plain text content of the email body.
-      #
-      #   @return [String, nil]
-      optional :body_plain, String
-
-      # @!attribute bulk
-      #   `true` if the message appears to be part of a bulk mailing.
-      #
-      #   @return [Boolean, nil]
-      optional :bulk, Moonbase::Internal::Type::Boolean
-
       # @!attribute conversation
       #   The `Conversation` thread this message is part of.
       #
+      #   **Note:** Only present when requested using the `include` query parameter.
+      #
       #   @return [Moonbase::Models::InboxConversation, nil]
       optional :conversation, -> { Moonbase::InboxConversation }
 
-      # @!attribute created_at
-      #   The time the message was received, as an RFC 3339 timestamp.
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
-      # @!attribute draft
-      #   `true` if the message is a draft that has not been sent.
-      #
-      #   @return [Boolean, nil]
-      optional :draft, Moonbase::Internal::Type::Boolean
-
-      # @!attribute in_reply_to_rfc822_message_id
-      #   The `Message-ID` of the email this message is a reply to.
-      #
-      #   @return [String, nil]
-      optional :in_reply_to_rfc822_message_id, String
-
-      # @!attribute spam
-      #   `true` if the message is classified as spam.
-      #
-      #   @return [Boolean, nil]
-      optional :spam, Moonbase::Internal::Type::Boolean
-
       # @!attribute summary
       #   A concise, system-generated summary of the email content.
       #
       #   @return [String, nil]
       optional :summary, String
 
-      # @!attribute trash
-      #   `true` if the message is in the trash.
-      #
-      #   @return [Boolean, nil]
-      optional :trash, Moonbase::Internal::Type::Boolean
-
-      # @!attribute unread
-      #   `true` if the message has not been read.
-      #
-      #   @return [Boolean, nil]
-      optional :unread, Moonbase::Internal::Type::Boolean
-
-      # @!method initialize(id:, links:, rfc822_message_id:, subject:, addresses: nil, attachments: nil, body_html: nil, body_plain: nil, bulk: nil, conversation: nil, created_at: nil, draft: nil, in_reply_to_rfc822_message_id: nil, spam: nil, summary: nil, trash: nil, unread: nil, type: :email_message)
+      # @!method initialize(id:, body:, bulk:, created_at:, draft:, spam:, subject:, trash:, unread:, addresses: nil, attachments: nil, conversation: nil, summary: nil, type: :email_message)
       #   Some parameter documentations has been truncated, see
       #   {Moonbase::Models::EmailMessage} for more details.
       #
@@ -119,66 +103,51 @@ module Moonbase
       #
       #   @param id [String] Unique identifier for the object.
       #
-      #   @param links [Moonbase::Models::EmailMessage::Links]
-      #
-      #   @param rfc822_message_id [String] The globally unique `Message-ID` header of the email.
-      #
-      #   @param subject [String] The subject line of the email.
-      #
-      #   @param addresses [Array<Moonbase::Models::Address>] A list of `Address` objects associated with the message (sender and recipients).
-      #
-      #   @param attachments [Array<Moonbase::Models::EmailMessage::Attachment>] A list of `Attachment` objects on the message.
-      #
-      #   @param body_html [String] The HTML content of the email body.
-      #
-      #   @param body_plain [String] The plain text content of the email body.
+      #   @param body [Moonbase::Models::FormattedText] Structured content that can be rendered in multiple formats, currently supportin
       #
       #   @param bulk [Boolean] `true` if the message appears to be part of a bulk mailing.
       #
-      #   @param conversation [Moonbase::Models::InboxConversation] The `Conversation` thread this message is part of.
-      #
-      #   @param created_at [Time] The time the message was received, as an RFC 3339 timestamp.
+      #   @param created_at [Time] The time the message was received, as an ISO 8601 timestamp in UTC.
       #
       #   @param draft [Boolean] `true` if the message is a draft that has not been sent.
       #
-      #   @param in_reply_to_rfc822_message_id [String] The `Message-ID` of the email this message is a reply to.
-      #
       #   @param spam [Boolean] `true` if the message is classified as spam.
       #
-      #   @param summary [String] A concise, system-generated summary of the email content.
+      #   @param subject [String] The subject line of the email.
       #
       #   @param trash [Boolean] `true` if the message is in the trash.
       #
       #   @param unread [Boolean] `true` if the message has not been read.
       #
+      #   @param addresses [Array<Moonbase::Models::Address>] A list of `Address` objects associated with the message (sender and recipients).
+      #
+      #   @param attachments [Array<Moonbase::Models::EmailMessage::Attachment>] A list of `Attachment` objects on the message.
+      #
+      #   @param conversation [Moonbase::Models::InboxConversation] The `Conversation` thread this message is part of.
+      #
+      #   @param summary [String] A concise, system-generated summary of the email content.
+      #
       #   @param type [Symbol, :email_message] String representing the object’s type. Always `email_message` for this object.
 
-      # @see Moonbase::Models::EmailMessage#links
-      class Links < Moonbase::Internal::Type::BaseModel
-        # @!attribute conversation
-        #   A link to the `Conversation` this message belongs to.
-        #
-        #   @return [String]
-        required :conversation, String
-
-        # @!attribute self_
-        #   The canonical URL for this object.
+      class Attachment < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
         #
         #   @return [String]
-        required :self_, String, api_name: :self
+        required :id, String
 
-        # @!method initialize(conversation:, self_:)
-        #   @param conversation [String] A link to the `Conversation` this message belongs to.
+        # @!attribute created_at
+        #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
         #
-        #   @param self_ [String] The canonical URL for this object.
-      end
+        #   @return [Time]
+        required :created_at, Time
 
-      class Attachment < Moonbase::Internal::Type::BaseModel
-        # @!attribute id
-        #   Unique identifier for the object.
+        # @!attribute download_url
+        #   A temporary, signed URL to download the file content. The URL expires after one
+        #   hour.
         #
         #   @return [String]
-        required :id, String
+        required :download_url, String
 
         # @!attribute filename
         #   The original name of the uploaded file, including its extension.
@@ -186,12 +155,6 @@ module Moonbase
         #   @return [String]
         required :filename, String
 
-        # @!attribute links
-        #   A hash of related links.
-        #
-        #   @return [Moonbase::Models::EmailMessage::Attachment::Links]
-        required :links, -> { Moonbase::EmailMessage::Attachment::Links }
-
         # @!attribute size
         #   The size of the file in bytes.
         #
@@ -199,74 +162,30 @@ module Moonbase
         required :size, Integer
 
         # @!attribute type
-        #   String representing the object’s type. Always `attachment` for this object.
+        #   String representing the object’s type. Always `message_attachment` for this
+        #   object.
         #
-        #   @return [Symbol, :attachment]
-        required :type, const: :attachment
+        #   @return [Symbol, :message_attachment]
+        required :type, const: :message_attachment
 
-        # @!attribute created_at
-        #   Time at which the object was created, as an RFC 3339 timestamp.
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute updated_at
-        #   Time at which the object was last updated, as an RFC 3339 timestamp.
+        # @!method initialize(id:, created_at:, download_url:, filename:, size:, type: :message_attachment)
+        #   Some parameter documentations has been truncated, see
+        #   {Moonbase::Models::EmailMessage::Attachment} for more details.
         #
-        #   @return [String, nil]
-        optional :updated_at, String
-
-        # @!method initialize(id:, filename:, links:, size:, created_at: nil, updated_at: nil, type: :attachment)
         #   The Attachment object represents a file attached to a message. You can download
         #   the file content via the `download_url`.
         #
         #   @param id [String] Unique identifier for the object.
         #
-        #   @param filename [String] The original name of the uploaded file, including its extension.
-        #
-        #   @param links [Moonbase::Models::EmailMessage::Attachment::Links] A hash of related links.
+        #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
         #
-        #   @param size [Integer] The size of the file in bytes.
+        #   @param download_url [String] A temporary, signed URL to download the file content. The URL expires after one
         #
-        #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+        #   @param filename [String] The original name of the uploaded file, including its extension.
         #
-        #   @param updated_at [String] Time at which the object was last updated, as an RFC 3339 timestamp.
+        #   @param size [Integer] The size of the file in bytes.
         #
-        #   @param type [Symbol, :attachment] String representing the object’s type. Always `attachment` for this object.
-
-        # @see Moonbase::Models::EmailMessage::Attachment#links
-        class Links < Moonbase::Internal::Type::BaseModel
-          # @!attribute conversation
-          #   A link to the `Conversation` this attachment belongs to.
-          #
-          #   @return [String]
-          required :conversation, String
-
-          # @!attribute download_url
-          #   A temporary, signed URL to download the file content. The URL expires after one
-          #   hour.
-          #
-          #   @return [String]
-          required :download_url, String
-
-          # @!attribute message
-          #   A link to the `Message` this attachment belongs to.
-          #
-          #   @return [String]
-          required :message, String
-
-          # @!method initialize(conversation:, download_url:, message:)
-          #   Some parameter documentations has been truncated, see
-          #   {Moonbase::Models::EmailMessage::Attachment::Links} for more details.
-          #
-          #   A hash of related links.
-          #
-          #   @param conversation [String] A link to the `Conversation` this attachment belongs to.
-          #
-          #   @param download_url [String] A temporary, signed URL to download the file content. The URL expires after one
-          #
-          #   @param message [String] A link to the `Message` this attachment belongs to.
-        end
+        #   @param type [Symbol, :message_attachment] String representing the object’s type. Always `message_attachment` for this obje
       end
     end
   end

data/lib/moonbase/models/email_value.rb

@@ -3,20 +3,22 @@
 module Moonbase
   module Models
     class EmailValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute email
+      # @!attribute data
+      #   A valid email address.
       #
       #   @return [String]
-      required :email, String
+      required :data, String
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/email"]
       required :type, const: :"value/email"
 
-      # @!method initialize(email:, type: :"value/email")
+      # @!method initialize(data:, type: :"value/email")
       #   Email address value
       #
-      #   @param email [String]
+      #   @param data [String] A valid email address.
+      #
       #   @param type [Symbol, :"value/email"]
     end
   end

data/lib/moonbase/models/endpoint.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::WebhookEndpoints#create
+    class Endpoint < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute status
+      #   Indicates whether the endpoint is enabled.
+      #
+      #   @return [Symbol, Moonbase::Models::Endpoint::Status]
+      required :status, enum: -> { Moonbase::Endpoint::Status }
+
+      # @!attribute subscriptions
+      #   An array of `WebhookSubscription` objects representing the events this endpoint
+      #   will receive.
+      #
+      #   @return [Array<Moonbase::Models::Subscription>]
+      required :subscriptions, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Subscription] }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `webhook_endpoint` for this
+      #   object.
+      #
+      #   @return [Symbol, :webhook_endpoint]
+      required :type, const: :webhook_endpoint
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute url
+      #   The HTTPS URL where webhook events will be sent.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute secret
+      #   The signing secret used to verify webhook authenticity. This value is only shown
+      #   when creating the endpoint and starts with `whsec_`.
+      #
+      #   @return [String, nil]
+      optional :secret, String
+
+      # @!method initialize(id:, created_at:, status:, subscriptions:, updated_at:, url:, secret: nil, type: :webhook_endpoint)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::Endpoint} for more details.
+      #
+      #   A Webhook Endpoint is an HTTP endpoint that receives webhooks. You can configure
+      #   which events are sent to each endpoint by creating `WebhookSubscription`
+      #   objects.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param status [Symbol, Moonbase::Models::Endpoint::Status] Indicates whether the endpoint is enabled.
+      #
+      #   @param subscriptions [Array<Moonbase::Models::Subscription>] An array of `WebhookSubscription` objects representing the events this endpoint
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param url [String] The HTTPS URL where webhook events will be sent.
+      #
+      #   @param secret [String] The signing secret used to verify webhook authenticity. This value is only shown
+      #
+      #   @param type [Symbol, :webhook_endpoint] String representing the object’s type. Always `webhook_endpoint` for this object
+
+      # Indicates whether the endpoint is enabled.
+      #
+      # @see Moonbase::Models::Endpoint#status
+      module Status
+        extend Moonbase::Internal::Type::Enum
+
+        DISABLED = :disabled
+        ENABLED = :enabled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/error.rb

@@ -49,6 +49,11 @@ module Moonbase
       #   Some parameter documentations has been truncated, see {Moonbase::Models::Error}
       #   for more details.
       #
+      #   The Error object represents a single error that occurred during API request
+      #   processing. It provides detailed information about what went wrong, including a
+      #   unique identifier, status code, and human-readable descriptions to help
+      #   developers understand and resolve the issue.
+      #
       #   @param id [String] A unique identifier for this specific error instance.
       #
       #   @param code [String] An application-specific error code string.