moonbase-sdk 0.1.0.pre.alpha.1

data/rbi/moonbase/models/inbox_conversation.rbi

@@ -0,0 +1,323 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxConversation < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::InboxConversation, Moonbase::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      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 { 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
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      # 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 { params(new_draft_conversation: T::Boolean).void }
+      attr_writer :new_draft_conversation
+
+      # `true` if the conversation is marked as spam.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :spam
+
+      sig { params(spam: T::Boolean).void }
+      attr_writer :spam
+
+      # The subject line of the conversation.
+      sig { returns(T.nilable(String)) }
+      attr_reader :subject
+
+      sig { params(subject: String).void }
+      attr_writer :subject
+
+      # A list of `Tag` objects applied to this conversation.
+      sig { returns(T.nilable(T::Array[Moonbase::InboxConversation::Tag])) }
+      attr_reader :tags
+
+      sig do
+        params(tags: T::Array[Moonbase::InboxConversation::Tag::OrHash]).void
+      end
+      attr_writer :tags
+
+      # The time of the most recent activity in the conversation, as an RFC 3339
+      # timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # `true` if the conversation is in the trash.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :trash
+
+      sig { params(trash: T::Boolean).void }
+      attr_writer :trash
+
+      # `true` if the conversation contains unread messages.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :unread
+
+      sig { params(unread: T::Boolean).void }
+      attr_writer :unread
+
+      # If the conversation is snoozed, this is the time it will reappear in the inbox,
+      # as an RFC 3339 timestamp.
+      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,
+          follow_up: T::Boolean,
+          new_draft_conversation: T::Boolean,
+          spam: T::Boolean,
+          subject: String,
+          tags: T::Array[Moonbase::InboxConversation::Tag::OrHash],
+          timestamp: String,
+          trash: T::Boolean,
+          unread: T::Boolean,
+          unsnooze_at: Time,
+          updated_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,
+        # `true` if a new draft reply to this conversation has been started.
+        new_draft_conversation: nil,
+        # `true` if the conversation is marked as spam.
+        spam: nil,
+        # The subject line of the conversation.
+        subject: nil,
+        # 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,
+        # `true` if the conversation is in the trash.
+        trash: nil,
+        # `true` if the conversation contains unread messages.
+        unread: nil,
+        # If the conversation is snoozed, this is the time it will reappear in the inbox,
+        # as an RFC 3339 timestamp.
+        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
+      )
+      end
+
+      sig do
+        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,
+            follow_up: T::Boolean,
+            new_draft_conversation: T::Boolean,
+            spam: T::Boolean,
+            subject: String,
+            tags: T::Array[Moonbase::InboxConversation::Tag],
+            timestamp: String,
+            trash: T::Boolean,
+            unread: T::Boolean,
+            unsnooze_at: Time,
+            updated_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
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::InboxConversation::State) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNASSIGNED =
+          T.let(:unassigned, Moonbase::InboxConversation::State::TaggedSymbol)
+        ACTIVE =
+          T.let(:active, Moonbase::InboxConversation::State::TaggedSymbol)
+        CLOSED =
+          T.let(:closed, Moonbase::InboxConversation::State::TaggedSymbol)
+        WAITING =
+          T.let(:waiting, Moonbase::InboxConversation::State::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::InboxConversation::State::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Tag < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::InboxConversation::Tag, Moonbase::Internal::AnyHash)
+          end
+
+        # Unique identifier for the object.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the tag.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # String representing the object’s type. Always `tag` for this object.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A Tag is a label that can be applied to `Conversation` objects for organization
+        # and filtering.
+        sig do
+          params(id: String, name: String, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for the object.
+          id:,
+          # The name of the tag.
+          name:,
+          # String representing the object’s type. Always `tag` for this object.
+          type: :tag
+        )
+        end
+
+        sig { override.returns({ id: String, name: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox_conversation_list_params.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxConversationListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Moonbase::InboxConversationListParams,
+            Moonbase::Internal::AnyHash
+          )
+        end
+
+      # When specified, returns results starting immediately after the item identified
+      # by this cursor. Use the cursor value from the previous response's metadata to
+      # fetch the next page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # When specified, returns results starting immediately before the item identified
+      # by this cursor. Use the cursor value from the response's metadata to fetch the
+      # previous page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      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 { params(inbox: T::Array[String]).void }
+      attr_writer :inbox
+
+      # Specifies which related objects to include in the response. Valid options are
+      # `addresses` and `tags`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Moonbase::InboxConversationListParams::Include::OrSymbol]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include:
+            T::Array[Moonbase::InboxConversationListParams::Include::OrSymbol]
+        ).void
+      end
+      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)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          inbox: T::Array[String],
+          include:
+            T::Array[Moonbase::InboxConversationListParams::Include::OrSymbol],
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # When specified, returns results starting immediately after the item identified
+        # by this cursor. Use the cursor value from the previous response's metadata to
+        # fetch the next page of results.
+        after: nil,
+        # When specified, returns results starting immediately before the item identified
+        # 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,
+        # Specifies which related objects to include in the response. Valid options are
+        # `addresses` and `tags`.
+        include: nil,
+        # Maximum number of items to return per page. Must be between 1 and 100. Defaults
+        # to 20 if not specified.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            inbox: T::Array[String],
+            include:
+              T::Array[
+                Moonbase::InboxConversationListParams::Include::OrSymbol
+              ],
+            limit: Integer,
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Moonbase::InboxConversationListParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ADDRESSES =
+          T.let(
+            :addresses,
+            Moonbase::InboxConversationListParams::Include::TaggedSymbol
+          )
+        TAGS =
+          T.let(
+            :tags,
+            Moonbase::InboxConversationListParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Moonbase::InboxConversationListParams::Include::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox_conversation_retrieve_params.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxConversationRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Moonbase::InboxConversationRetrieveParams,
+            Moonbase::Internal::AnyHash
+          )
+        end
+
+      # Specifies which related objects to include in the response. Valid options are
+      # `addresses` and `tags`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              Moonbase::InboxConversationRetrieveParams::Include::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include:
+            T::Array[
+              Moonbase::InboxConversationRetrieveParams::Include::OrSymbol
+            ]
+        ).void
+      end
+      attr_writer :include
+
+      sig do
+        params(
+          include:
+            T::Array[
+              Moonbase::InboxConversationRetrieveParams::Include::OrSymbol
+            ],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Specifies which related objects to include in the response. Valid options are
+        # `addresses` and `tags`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            include:
+              T::Array[
+                Moonbase::InboxConversationRetrieveParams::Include::OrSymbol
+              ],
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Moonbase::InboxConversationRetrieveParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ADDRESSES =
+          T.let(
+            :addresses,
+            Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
+          )
+        TAGS =
+          T.let(
+            :tags,
+            Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Moonbase::InboxConversationRetrieveParams::Include::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox_list_params.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::InboxListParams, Moonbase::Internal::AnyHash)
+        end
+
+      # When specified, returns results starting immediately after the item identified
+      # by this cursor. Use the cursor value from the previous response's metadata to
+      # fetch the next page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # When specified, returns results starting immediately before the item identified
+      # by this cursor. Use the cursor value from the response's metadata to fetch the
+      # previous page of results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # 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)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # When specified, returns results starting immediately after the item identified
+        # by this cursor. Use the cursor value from the previous response's metadata to
+        # fetch the next page of results.
+        after: nil,
+        # When specified, returns results starting immediately before the item identified
+        # by this cursor. Use the cursor value from the response's metadata to fetch the
+        # previous page of results.
+        before: nil,
+        # Maximum number of items to return per page. Must be between 1 and 100. Defaults
+        # to 20 if not specified.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            limit: Integer,
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end