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

data/rbi/moonbase/models/inbox_conversation.rbi

@@ -12,172 +12,147 @@ module Moonbase
       sig { returns(String) }
       attr_accessor :id
 
-      sig { returns(Moonbase::InboxConversation::Links) }
-      attr_reader :links
-
-      sig { params(links: Moonbase::InboxConversation::Links::OrHash).void }
-      attr_writer :links
-
-      # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
-      sig { returns(Moonbase::InboxConversation::State::TaggedSymbol) }
-      attr_accessor :state
-
-      # String representing the object’s type. Always `inbox_conversation` for this
-      # object.
-      sig { returns(Symbol) }
-      attr_accessor :type
-
-      # A list of `Address` objects (participants) in this conversation.
-      sig { returns(T.nilable(T::Array[Moonbase::Address])) }
-      attr_reader :addresses
-
-      sig { params(addresses: T::Array[Moonbase::Address::OrHash]).void }
-      attr_writer :addresses
-
       # `true` if the conversation appears to be part of a bulk mailing.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :bulk
+      sig { returns(T::Boolean) }
+      attr_accessor :bulk
 
-      sig { params(bulk: T::Boolean).void }
-      attr_writer :bulk
-
-      # Time at which the object was created, as an RFC 3339 timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :created_at
+      # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
 
-      sig { params(created_at: Time).void }
-      attr_writer :created_at
+      # `true` if a new draft reply to this conversation has been started.
+      sig { returns(T::Boolean) }
+      attr_accessor :draft
 
       # Whether the conversation is marked for follow-up.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :follow_up
-
-      sig { params(follow_up: T::Boolean).void }
-      attr_writer :follow_up
-
-      # `true` if a new draft reply to this conversation has been started.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :new_draft_conversation
+      sig { returns(T::Boolean) }
+      attr_accessor :follow_up
 
-      sig { params(new_draft_conversation: T::Boolean).void }
-      attr_writer :new_draft_conversation
+      # The time of the most recent activity in the conversation, as an ISO 8601
+      # timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :last_message_at
 
       # `true` if the conversation is marked as spam.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :spam
+      sig { returns(T::Boolean) }
+      attr_accessor :spam
 
-      sig { params(spam: T::Boolean).void }
-      attr_writer :spam
+      # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
+      sig { returns(Moonbase::InboxConversation::State::TaggedSymbol) }
+      attr_accessor :state
 
       # The subject line of the conversation.
-      sig { returns(T.nilable(String)) }
-      attr_reader :subject
-
-      sig { params(subject: String).void }
-      attr_writer :subject
+      sig { returns(String) }
+      attr_accessor :subject
 
       # A list of `Tag` objects applied to this conversation.
-      sig { returns(T.nilable(T::Array[Moonbase::InboxConversation::Tag])) }
-      attr_reader :tags
+      sig { returns(T::Array[Moonbase::InboxConversation::Tag]) }
+      attr_accessor :tags
 
-      sig do
-        params(tags: T::Array[Moonbase::InboxConversation::Tag::OrHash]).void
-      end
-      attr_writer :tags
+      # `true` if the conversation is in the trash.
+      sig { returns(T::Boolean) }
+      attr_accessor :trash
 
-      # The time of the most recent activity in the conversation, as an RFC 3339
-      # timestamp.
-      sig { returns(T.nilable(String)) }
-      attr_reader :timestamp
+      # String representing the object’s type. Always `inbox_conversation` for this
+      # object.
+      sig { returns(Symbol) }
+      attr_accessor :type
 
-      sig { params(timestamp: String).void }
-      attr_writer :timestamp
+      # `true` if the conversation contains unread messages.
+      sig { returns(T::Boolean) }
+      attr_accessor :unread
 
-      # `true` if the conversation is in the trash.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :trash
+      # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :updated_at
 
-      sig { params(trash: T::Boolean).void }
-      attr_writer :trash
+      # The `Inbox` that this conversations belongs to.
+      #
+      # **Note:** Only present when requested using the `include` query parameter.
+      sig { returns(T.nilable(Moonbase::Inbox)) }
+      attr_reader :inbox
 
-      # `true` if the conversation contains unread messages.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :unread
+      sig { params(inbox: Moonbase::Inbox::OrHash).void }
+      attr_writer :inbox
 
-      sig { params(unread: T::Boolean).void }
-      attr_writer :unread
+      # The `EmailMessage` objects that belong to this conversation.
+      #
+      # **Note:** Only present when requested using the `include` query parameter.
+      sig { returns(T.nilable(T::Array[Moonbase::EmailMessage])) }
+      attr_reader :messages
+
+      sig { params(messages: T::Array[Moonbase::EmailMessage]).void }
+      attr_writer :messages
 
       # If the conversation is snoozed, this is the time it will reappear in the inbox,
-      # as an RFC 3339 timestamp.
+      # as an ISO 8601 timestamp in UTC.
       sig { returns(T.nilable(Time)) }
       attr_reader :unsnooze_at
 
       sig { params(unsnooze_at: Time).void }
       attr_writer :unsnooze_at
 
-      # Time at which the object was last updated, as an RFC 3339 timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_reader :updated_at
-
-      sig { params(updated_at: Time).void }
-      attr_writer :updated_at
-
       # The Conversation object represents a thread of related messages.
       sig do
         params(
           id: String,
-          links: Moonbase::InboxConversation::Links::OrHash,
-          state: Moonbase::InboxConversation::State::OrSymbol,
-          addresses: T::Array[Moonbase::Address::OrHash],
           bulk: T::Boolean,
           created_at: Time,
+          draft: T::Boolean,
           follow_up: T::Boolean,
-          new_draft_conversation: T::Boolean,
+          last_message_at: Time,
           spam: T::Boolean,
+          state: Moonbase::InboxConversation::State::OrSymbol,
           subject: String,
           tags: T::Array[Moonbase::InboxConversation::Tag::OrHash],
-          timestamp: String,
           trash: T::Boolean,
           unread: T::Boolean,
-          unsnooze_at: Time,
           updated_at: Time,
+          inbox: Moonbase::Inbox::OrHash,
+          messages: T::Array[Moonbase::EmailMessage],
+          unsnooze_at: Time,
           type: Symbol
         ).returns(T.attached_class)
       end
       def self.new(
         # Unique identifier for the object.
         id:,
-        links:,
-        # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
-        state:,
-        # A list of `Address` objects (participants) in this conversation.
-        addresses: nil,
         # `true` if the conversation appears to be part of a bulk mailing.
-        bulk: nil,
-        # Time at which the object was created, as an RFC 3339 timestamp.
-        created_at: nil,
-        # Whether the conversation is marked for follow-up.
-        follow_up: nil,
+        bulk:,
+        # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+        created_at:,
         # `true` if a new draft reply to this conversation has been started.
-        new_draft_conversation: nil,
+        draft:,
+        # Whether the conversation is marked for follow-up.
+        follow_up:,
+        # The time of the most recent activity in the conversation, as an ISO 8601
+        # timestamp in UTC.
+        last_message_at:,
         # `true` if the conversation is marked as spam.
-        spam: nil,
+        spam:,
+        # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
+        state:,
         # The subject line of the conversation.
-        subject: nil,
+        subject:,
         # A list of `Tag` objects applied to this conversation.
-        tags: nil,
-        # The time of the most recent activity in the conversation, as an RFC 3339
-        # timestamp.
-        timestamp: nil,
+        tags:,
         # `true` if the conversation is in the trash.
-        trash: nil,
+        trash:,
         # `true` if the conversation contains unread messages.
-        unread: nil,
+        unread:,
+        # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+        updated_at:,
+        # The `Inbox` that this conversations belongs to.
+        #
+        # **Note:** Only present when requested using the `include` query parameter.
+        inbox: nil,
+        # The `EmailMessage` objects that belong to this conversation.
+        #
+        # **Note:** Only present when requested using the `include` query parameter.
+        messages: nil,
         # If the conversation is snoozed, this is the time it will reappear in the inbox,
-        # as an RFC 3339 timestamp.
+        # as an ISO 8601 timestamp in UTC.
         unsnooze_at: nil,
-        # Time at which the object was last updated, as an RFC 3339 timestamp.
-        updated_at: nil,
         # String representing the object’s type. Always `inbox_conversation` for this
         # object.
         type: :inbox_conversation
@@ -188,71 +163,28 @@ module Moonbase
         override.returns(
           {
             id: String,
-            links: Moonbase::InboxConversation::Links,
-            state: Moonbase::InboxConversation::State::TaggedSymbol,
-            type: Symbol,
-            addresses: T::Array[Moonbase::Address],
             bulk: T::Boolean,
             created_at: Time,
+            draft: T::Boolean,
             follow_up: T::Boolean,
-            new_draft_conversation: T::Boolean,
+            last_message_at: Time,
             spam: T::Boolean,
+            state: Moonbase::InboxConversation::State::TaggedSymbol,
             subject: String,
             tags: T::Array[Moonbase::InboxConversation::Tag],
-            timestamp: String,
             trash: T::Boolean,
+            type: Symbol,
             unread: T::Boolean,
-            unsnooze_at: Time,
-            updated_at: Time
+            updated_at: Time,
+            inbox: Moonbase::Inbox,
+            messages: T::Array[Moonbase::EmailMessage],
+            unsnooze_at: Time
           }
         )
       end
       def to_hash
       end
 
-      class Links < Moonbase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Moonbase::InboxConversation::Links,
-              Moonbase::Internal::AnyHash
-            )
-          end
-
-        # A link to the `Inbox` this conversation belongs to.
-        sig { returns(String) }
-        attr_accessor :inbox
-
-        # A link to the list of `Message` objects in this conversation.
-        sig { returns(String) }
-        attr_accessor :messages
-
-        # The canonical URL for this object.
-        sig { returns(String) }
-        attr_accessor :self_
-
-        sig do
-          params(inbox: String, messages: String, self_: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # A link to the `Inbox` this conversation belongs to.
-          inbox:,
-          # A link to the list of `Message` objects in this conversation.
-          messages:,
-          # The canonical URL for this object.
-          self_:
-        )
-        end
-
-        sig do
-          override.returns({ inbox: String, messages: String, self_: String })
-        end
-        def to_hash
-        end
-      end
-
       # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
       module State
         extend Moonbase::Internal::Type::Enum

data/rbi/moonbase/models/inbox_conversation_list_params.rbi

@@ -32,15 +32,18 @@ module Moonbase
       sig { params(before: String).void }
       attr_writer :before
 
-      # Filter conversations by one or more inbox IDs.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :inbox
+      sig { returns(T.nilable(Moonbase::InboxConversationListParams::Filter)) }
+      attr_reader :filter
 
-      sig { params(inbox: T::Array[String]).void }
-      attr_writer :inbox
+      sig do
+        params(
+          filter: Moonbase::InboxConversationListParams::Filter::OrHash
+        ).void
+      end
+      attr_writer :filter
 
       # Specifies which related objects to include in the response. Valid options are
-      # `addresses` and `tags`.
+      # `inbox`, `messages`, and `messages.addresses`.
       sig do
         returns(
           T.nilable(
@@ -70,7 +73,7 @@ module Moonbase
         params(
           after: String,
           before: String,
-          inbox: T::Array[String],
+          filter: Moonbase::InboxConversationListParams::Filter::OrHash,
           include:
             T::Array[Moonbase::InboxConversationListParams::Include::OrSymbol],
           limit: Integer,
@@ -86,10 +89,9 @@ module Moonbase
         # by this cursor. Use the cursor value from the response's metadata to fetch the
         # previous page of results.
         before: nil,
-        # Filter conversations by one or more inbox IDs.
-        inbox: nil,
+        filter: nil,
         # Specifies which related objects to include in the response. Valid options are
-        # `addresses` and `tags`.
+        # `inbox`, `messages`, and `messages.addresses`.
         include: nil,
         # Maximum number of items to return per page. Must be between 1 and 100. Defaults
         # to 20 if not specified.
@@ -103,7 +105,7 @@ module Moonbase
           {
             after: String,
             before: String,
-            inbox: T::Array[String],
+            filter: Moonbase::InboxConversationListParams::Filter,
             include:
               T::Array[
                 Moonbase::InboxConversationListParams::Include::OrSymbol
@@ -116,6 +118,119 @@ module Moonbase
       def to_hash
       end
 
+      class Filter < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Moonbase::InboxConversationListParams::Filter,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Moonbase::InboxConversationListParams::Filter::ConversationID
+            )
+          )
+        end
+        attr_reader :conversation_id
+
+        sig do
+          params(
+            conversation_id:
+              Moonbase::InboxConversationListParams::Filter::ConversationID::OrHash
+          ).void
+        end
+        attr_writer :conversation_id
+
+        sig do
+          returns(
+            T.nilable(Moonbase::InboxConversationListParams::Filter::InboxID)
+          )
+        end
+        attr_reader :inbox_id
+
+        sig do
+          params(
+            inbox_id:
+              Moonbase::InboxConversationListParams::Filter::InboxID::OrHash
+          ).void
+        end
+        attr_writer :inbox_id
+
+        sig do
+          params(
+            conversation_id:
+              Moonbase::InboxConversationListParams::Filter::ConversationID::OrHash,
+            inbox_id:
+              Moonbase::InboxConversationListParams::Filter::InboxID::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(conversation_id: nil, inbox_id: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              conversation_id:
+                Moonbase::InboxConversationListParams::Filter::ConversationID,
+              inbox_id: Moonbase::InboxConversationListParams::Filter::InboxID
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ConversationID < Moonbase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Moonbase::InboxConversationListParams::Filter::ConversationID,
+                Moonbase::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :eq
+
+          sig { params(eq: String).void }
+          attr_writer :eq
+
+          sig { params(eq: String).returns(T.attached_class) }
+          def self.new(eq: nil)
+          end
+
+          sig { override.returns({ eq: String }) }
+          def to_hash
+          end
+        end
+
+        class InboxID < Moonbase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Moonbase::InboxConversationListParams::Filter::InboxID,
+                Moonbase::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :eq
+
+          sig { params(eq: String).void }
+          attr_writer :eq
+
+          sig { params(eq: String).returns(T.attached_class) }
+          def self.new(eq: nil)
+          end
+
+          sig { override.returns({ eq: String }) }
+          def to_hash
+          end
+        end
+      end
+
       module Include
         extend Moonbase::Internal::Type::Enum
 
@@ -125,14 +240,19 @@ module Moonbase
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        ADDRESSES =
+        INBOX =
+          T.let(
+            :inbox,
+            Moonbase::InboxConversationListParams::Include::TaggedSymbol
+          )
+        MESSAGES =
           T.let(
-            :addresses,
+            :messages,
             Moonbase::InboxConversationListParams::Include::TaggedSymbol
           )
-        TAGS =
+        MESSAGES_ADDRESSES =
           T.let(
-            :tags,
+            :"messages.addresses",
             Moonbase::InboxConversationListParams::Include::TaggedSymbol
           )
 

data/rbi/moonbase/models/inbox_conversation_retrieve_params.rbi

@@ -15,7 +15,7 @@ module Moonbase
         end
 
       # Specifies which related objects to include in the response. Valid options are
-      # `addresses` and `tags`.
+      # `inbox`, `messages`, and `messages.addresses`.
       sig do
         returns(
           T.nilable(
@@ -48,7 +48,7 @@ module Moonbase
       end
       def self.new(
         # Specifies which related objects to include in the response. Valid options are
-        # `addresses` and `tags`.
+        # `inbox`, `messages`, and `messages.addresses`.
         include: nil,
         request_options: {}
       )
@@ -77,14 +77,19 @@ module Moonbase
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        ADDRESSES =
+        INBOX =
           T.let(
-            :addresses,
+            :inbox,
             Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
           )
-        TAGS =
+        MESSAGES =
           T.let(
-            :tags,
+            :messages,
+            Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
+          )
+        MESSAGES_ADDRESSES =
+          T.let(
+            :"messages.addresses",
             Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
           )
 

data/rbi/moonbase/models/inbox_list_params.rbi

@@ -29,6 +29,12 @@ module Moonbase
       sig { params(before: String).void }
       attr_writer :before
 
+      sig { returns(T.nilable(Moonbase::InboxListParams::Include::OrSymbol)) }
+      attr_reader :include
+
+      sig { params(include: Moonbase::InboxListParams::Include::OrSymbol).void }
+      attr_writer :include
+
       # Maximum number of items to return per page. Must be between 1 and 100. Defaults
       # to 20 if not specified.
       sig { returns(T.nilable(Integer)) }
@@ -41,6 +47,7 @@ module Moonbase
         params(
           after: String,
           before: String,
+          include: Moonbase::InboxListParams::Include::OrSymbol,
           limit: Integer,
           request_options: Moonbase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -54,6 +61,7 @@ module Moonbase
         # by this cursor. Use the cursor value from the response's metadata to fetch the
         # previous page of results.
         before: nil,
+        include: nil,
         # Maximum number of items to return per page. Must be between 1 and 100. Defaults
         # to 20 if not specified.
         limit: nil,
@@ -66,6 +74,7 @@ module Moonbase
           {
             after: String,
             before: String,
+            include: Moonbase::InboxListParams::Include::OrSymbol,
             limit: Integer,
             request_options: Moonbase::RequestOptions
           }
@@ -73,6 +82,25 @@ module Moonbase
       end
       def to_hash
       end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::InboxListParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TAGSET =
+          T.let(:tagset, Moonbase::InboxListParams::Include::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::InboxListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end