moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/models/funnel_step.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class FunnelStep < Moonbase::Internal::Type::BaseModel
+      # @!attribute step
+      #
+      #   @return [Moonbase::Models::FunnelStep::Step]
+      required :step, -> { Moonbase::FunnelStep::Step }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/funnel_step"]
+      required :type, const: :"value/funnel_step"
+
+      # @!method initialize(step:, type: :"value/funnel_step")
+      #   Funnel step value
+      #
+      #   @param step [Moonbase::Models::FunnelStep::Step]
+      #   @param type [Symbol, :"value/funnel_step"]
+
+      # @see Moonbase::Models::FunnelStep#step
+      class Step < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :funnel_step]
+        required :type, const: :funnel_step
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(id:, name: nil, type: :funnel_step)
+        #   @param id [String]
+        #   @param name [String]
+        #   @param type [Symbol, :funnel_step]
+      end
+    end
+  end
+end

data/lib/moonbase/models/geo_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class GeoValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute geo
+      #
+      #   @return [String]
+      required :geo, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/geo"]
+      required :type, const: :"value/geo"
+
+      # @!method initialize(geo:, type: :"value/geo")
+      #   Geographic coordinate value
+      #
+      #   @param geo [String]
+      #   @param type [Symbol, :"value/geo"]
+    end
+  end
+end

data/lib/moonbase/models/inbox.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Inboxes#retrieve
+    class Inbox < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::Inbox::Links]
+      required :links, -> { Moonbase::Inbox::Links }
+
+      # @!attribute name
+      #   The display name of the inbox.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `inbox` for this object.
+      #
+      #   @return [Symbol, :inbox]
+      required :type, const: :inbox
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute tagset
+      #   The `Tagset` associated with this inbox, which defines the tags available for
+      #   its conversations.
+      #
+      #   @return [Moonbase::Models::Tagset, nil]
+      optional :tagset, -> { Moonbase::Tagset }
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!method initialize(id:, links:, name:, created_at: nil, tagset: nil, updated_at: nil, type: :inbox)
+      #   Some parameter documentations has been truncated, see {Moonbase::Models::Inbox}
+      #   for more details.
+      #
+      #   The Inbox object represents a shared inbox for receiving and sending messages.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::Inbox::Links]
+      #
+      #   @param name [String] The display name of the inbox.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param tagset [Moonbase::Models::Tagset] The `Tagset` associated with this inbox, which defines the tags available for it
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :inbox] String representing the object’s type. Always `inbox` for this object.
+
+      # @see Moonbase::Models::Inbox#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!attribute tagset
+        #   A link to the `Tagset` for this inbox.
+        #
+        #   @return [String, nil]
+        optional :tagset, String
+
+        # @!method initialize(self_:, tagset: nil)
+        #   @param self_ [String] The canonical URL for this object.
+        #
+        #   @param tagset [String] A link to the `Tagset` for this inbox.
+      end
+    end
+  end
+end

data/lib/moonbase/models/inbox_conversation.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxConversations#retrieve
+    class InboxConversation < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::InboxConversation::Links]
+      required :links, -> { Moonbase::InboxConversation::Links }
+
+      # @!attribute state
+      #   The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
+      #
+      #   @return [Symbol, Moonbase::Models::InboxConversation::State]
+      required :state, enum: -> { Moonbase::InboxConversation::State }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `inbox_conversation` for this
+      #   object.
+      #
+      #   @return [Symbol, :inbox_conversation]
+      required :type, const: :inbox_conversation
+
+      # @!attribute addresses
+      #   A list of `Address` objects (participants) in this conversation.
+      #
+      #   @return [Array<Moonbase::Models::Address>, nil]
+      optional :addresses, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Address] }
+
+      # @!attribute bulk
+      #   `true` if the conversation appears to be part of a bulk mailing.
+      #
+      #   @return [Boolean, nil]
+      optional :bulk, Moonbase::Internal::Type::Boolean
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute follow_up
+      #   Whether the conversation is marked for follow-up.
+      #
+      #   @return [Boolean, nil]
+      optional :follow_up, Moonbase::Internal::Type::Boolean
+
+      # @!attribute new_draft_conversation
+      #   `true` if a new draft reply to this conversation has been started.
+      #
+      #   @return [Boolean, nil]
+      optional :new_draft_conversation, Moonbase::Internal::Type::Boolean
+
+      # @!attribute spam
+      #   `true` if the conversation is marked as spam.
+      #
+      #   @return [Boolean, nil]
+      optional :spam, Moonbase::Internal::Type::Boolean
+
+      # @!attribute subject
+      #   The subject line of the conversation.
+      #
+      #   @return [String, nil]
+      optional :subject, String
+
+      # @!attribute tags
+      #   A list of `Tag` objects applied to this conversation.
+      #
+      #   @return [Array<Moonbase::Models::InboxConversation::Tag>, nil]
+      optional :tags, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxConversation::Tag] }
+
+      # @!attribute timestamp
+      #   The time of the most recent activity in the conversation, as an RFC 3339
+      #   timestamp.
+      #
+      #   @return [String, nil]
+      optional :timestamp, String
+
+      # @!attribute trash
+      #   `true` if the conversation is in the trash.
+      #
+      #   @return [Boolean, nil]
+      optional :trash, Moonbase::Internal::Type::Boolean
+
+      # @!attribute unread
+      #   `true` if the conversation contains unread messages.
+      #
+      #   @return [Boolean, nil]
+      optional :unread, Moonbase::Internal::Type::Boolean
+
+      # @!attribute unsnooze_at
+      #   If the conversation is snoozed, this is the time it will reappear in the inbox,
+      #   as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :unsnooze_at, Time
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!method initialize(id:, links:, state:, addresses: nil, bulk: nil, created_at: nil, follow_up: nil, new_draft_conversation: nil, spam: nil, subject: nil, tags: nil, timestamp: nil, trash: nil, unread: nil, unsnooze_at: nil, updated_at: nil, type: :inbox_conversation)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxConversation} for more details.
+      #
+      #   The Conversation object represents a thread of related messages.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::InboxConversation::Links]
+      #
+      #   @param state [Symbol, Moonbase::Models::InboxConversation::State] The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
+      #
+      #   @param addresses [Array<Moonbase::Models::Address>] A list of `Address` objects (participants) in this conversation.
+      #
+      #   @param bulk [Boolean] `true` if the conversation appears to be part of a bulk mailing.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param follow_up [Boolean] Whether the conversation is marked for follow-up.
+      #
+      #   @param new_draft_conversation [Boolean] `true` if a new draft reply to this conversation has been started.
+      #
+      #   @param spam [Boolean] `true` if the conversation is marked as spam.
+      #
+      #   @param subject [String] The subject line of the conversation.
+      #
+      #   @param tags [Array<Moonbase::Models::InboxConversation::Tag>] A list of `Tag` objects applied to this conversation.
+      #
+      #   @param timestamp [String] The time of the most recent activity in the conversation, as an RFC 3339 timesta
+      #
+      #   @param trash [Boolean] `true` if the conversation is in the trash.
+      #
+      #   @param unread [Boolean] `true` if the conversation contains unread messages.
+      #
+      #   @param unsnooze_at [Time] If the conversation is snoozed, this is the time it will reappear in the inbox,
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :inbox_conversation] String representing the object’s type. Always `inbox_conversation` for this obje
+
+      # @see Moonbase::Models::InboxConversation#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute inbox
+        #   A link to the `Inbox` this conversation belongs to.
+        #
+        #   @return [String]
+        required :inbox, String
+
+        # @!attribute messages
+        #   A link to the list of `Message` objects in this conversation.
+        #
+        #   @return [String]
+        required :messages, String
+
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(inbox:, messages:, self_:)
+        #   @param inbox [String] A link to the `Inbox` this conversation belongs to.
+        #
+        #   @param messages [String] A link to the list of `Message` objects in this conversation.
+        #
+        #   @param self_ [String] The canonical URL for this object.
+      end
+
+      # The current state, which can be `unassigned`, `active`, `closed`, or `waiting`.
+      #
+      # @see Moonbase::Models::InboxConversation#state
+      module State
+        extend Moonbase::Internal::Type::Enum
+
+        UNASSIGNED = :unassigned
+        ACTIVE = :active
+        CLOSED = :closed
+        WAITING = :waiting
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Tag < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the tag.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   String representing the object’s type. Always `tag` for this object.
+        #
+        #   @return [Symbol, :tag]
+        required :type, const: :tag
+
+        # @!method initialize(id:, name:, type: :tag)
+        #   A Tag is a label that can be applied to `Conversation` objects for organization
+        #   and filtering.
+        #
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param name [String] The name of the tag.
+        #
+        #   @param type [Symbol, :tag] String representing the object’s type. Always `tag` for this object.
+      end
+    end
+  end
+end

data/lib/moonbase/models/inbox_conversation_list_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxConversations#list
+    class InboxConversationListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute inbox
+      #   Filter conversations by one or more inbox IDs.
+      #
+      #   @return [Array<String>, nil]
+      optional :inbox, Moonbase::Internal::Type::ArrayOf[String]
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid options are
+      #   `addresses` and `tags`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::InboxConversationListParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxConversationListParams::Include] }
+
+      # @!attribute limit
+      #   Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #   to 20 if not specified.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, before: nil, inbox: nil, include: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxConversationListParams} for more details.
+      #
+      #   @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      #   @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      #   @param inbox [Array<String>] Filter conversations by one or more inbox IDs.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::InboxConversationListParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      #   @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        ADDRESSES = :addresses
+        TAGS = :tags
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/inbox_conversation_retrieve_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxConversations#retrieve
+    class InboxConversationRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid options are
+      #   `addresses` and `tags`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::InboxConversationRetrieveParams::Include>, nil]
+      optional :include,
+               -> {
+                 Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxConversationRetrieveParams::Include]
+               }
+
+      # @!method initialize(include: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxConversationRetrieveParams} for more details.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::InboxConversationRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        ADDRESSES = :addresses
+        TAGS = :tags
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/inbox_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Inboxes#list
+    class InboxListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute limit
+      #   Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #   to 20 if not specified.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxListParams} for more details.
+      #
+      #   @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      #   @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      #   @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moonbase/models/inbox_message_list_params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxMessages#list
+    class InboxMessageListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute conversation
+      #   Filter messages by one or more conversation IDs.
+      #
+      #   @return [Array<String>, nil]
+      optional :conversation, Moonbase::Internal::Type::ArrayOf[String]
+
+      # @!attribute inbox
+      #   Filter messages by one or more inbox IDs.
+      #
+      #   @return [Array<String>, nil]
+      optional :inbox, Moonbase::Internal::Type::ArrayOf[String]
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid options are
+      #   `addresses`, `attachments`, and `conversation`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::InboxMessageListParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxMessageListParams::Include] }
+
+      # @!attribute limit
+      #   Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #   to 20 if not specified.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, before: nil, conversation: nil, inbox: nil, include: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxMessageListParams} for more details.
+      #
+      #   @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      #   @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      #   @param conversation [Array<String>] Filter messages by one or more conversation IDs.
+      #
+      #   @param inbox [Array<String>] Filter messages by one or more inbox IDs.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::InboxMessageListParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      #   @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        ADDRESSES = :addresses
+        ATTACHMENTS = :attachments
+        CONVERSATION = :conversation
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/inbox_message_retrieve_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxMessages#retrieve
+    class InboxMessageRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid options are
+      #   `addresses`, `attachments`, and `conversation`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::InboxMessageRetrieveParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxMessageRetrieveParams::Include] }
+
+      # @!method initialize(include: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::InboxMessageRetrieveParams} for more details.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::InboxMessageRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        ADDRESSES = :addresses
+        ATTACHMENTS = :attachments
+        CONVERSATION = :conversation
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end