moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/models/collection.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Collections#retrieve
+    class Collection < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #   A hash of related links.
+      #
+      #   @return [Moonbase::Models::Collection::Links]
+      required :links, -> { Moonbase::Collection::Links }
+
+      # @!attribute name
+      #   The user-facing name of the collection (e.g., “Organizations”).
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute ref
+      #   A unique, stable, machine-readable identifier for the collection. This reference
+      #   is used in API requests and does not change even if the `name` is updated.
+      #
+      #   @return [String]
+      required :ref, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `collection` for this object.
+      #
+      #   @return [Symbol, :collection]
+      required :type, const: :collection
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   An optional, longer-form description of the collection's purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute fields
+      #   A list of `Field` objects that define the schema for items in this collection.
+      #
+      #   @return [Array<Moonbase::Models::Field>, nil]
+      optional :fields, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Field] }
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!attribute views
+      #   A list of saved `View` objects for presenting the collection's data.
+      #
+      #   @return [Array<Moonbase::Models::View>, nil]
+      optional :views, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::View] }
+
+      # @!method initialize(id:, links:, name:, ref:, created_at: nil, description: nil, fields: nil, updated_at: nil, views: nil, type: :collection)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::Collection} for more details.
+      #
+      #   A Collection is a container for structured data, similar to a database table or
+      #   spreadsheet. It defines a schema using a set of `Fields` and holds the data as a
+      #   list of `Items`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::Collection::Links] A hash of related links.
+      #
+      #   @param name [String] The user-facing name of the collection (e.g., “Organizations”).
+      #
+      #   @param ref [String] A unique, stable, machine-readable identifier for the collection. This reference
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param description [String] An optional, longer-form description of the collection's purpose.
+      #
+      #   @param fields [Array<Moonbase::Models::Field>] A list of `Field` objects that define the schema for items in this collection.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param views [Array<Moonbase::Models::View>] A list of saved `View` objects for presenting the collection's data.
+      #
+      #   @param type [Symbol, :collection] String representing the object’s type. Always `collection` for this object.
+
+      # @see Moonbase::Models::Collection#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(self_:)
+        #   A hash of related links.
+        #
+        #   @param self_ [String] The canonical URL for this object.
+      end
+    end
+  end
+end

data/lib/moonbase/models/collection_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Collections#list
+    class CollectionListParams < 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::CollectionListParams} 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/collection_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Collections#retrieve
+    class CollectionRetrieveParams < 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
+      #   `fields` and `views`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::CollectionRetrieveParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::CollectionRetrieveParams::Include] }
+
+      # @!method initialize(include: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::CollectionRetrieveParams} for more details.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::CollectionRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `f
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        FIELDS = :fields
+        VIEWS = :views
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/collections/field_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    module Collections
+      # @see Moonbase::Resources::Collections::Fields#retrieve
+      class FieldRetrieveParams < Moonbase::Internal::Type::BaseModel
+        extend Moonbase::Internal::Type::RequestParameters::Converter
+        include Moonbase::Internal::Type::RequestParameters
+
+        # @!attribute collection_id
+        #
+        #   @return [String]
+        required :collection_id, String
+
+        # @!method initialize(collection_id:, request_options: {})
+        #   @param collection_id [String]
+        #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/moonbase/models/date_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class DateValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute date
+      #
+      #   @return [Date]
+      required :date, Date
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/date"]
+      required :type, const: :"value/date"
+
+      # @!method initialize(date:, type: :"value/date")
+      #   Date without time
+      #
+      #   @param date [Date]
+      #   @param type [Symbol, :"value/date"]
+    end
+  end
+end

data/lib/moonbase/models/datetime_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class DatetimeValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute datetime
+      #
+      #   @return [Time]
+      required :datetime, Time
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/datetime"]
+      required :type, const: :"value/datetime"
+
+      # @!method initialize(datetime:, type: :"value/datetime")
+      #   Date and time value
+      #
+      #   @param datetime [Time]
+      #   @param type [Symbol, :"value/datetime"]
+    end
+  end
+end

data/lib/moonbase/models/domain_value.rb

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

data/lib/moonbase/models/email_message.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::InboxMessages#retrieve
+    class EmailMessage < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::EmailMessage::Links]
+      required :links, -> { Moonbase::EmailMessage::Links }
+
+      # @!attribute rfc822_message_id
+      #   The globally unique `Message-ID` header of the email.
+      #
+      #   @return [String]
+      required :rfc822_message_id, String
+
+      # @!attribute subject
+      #   The subject line of the email.
+      #
+      #   @return [String]
+      required :subject, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `email_message` for this object.
+      #
+      #   @return [Symbol, :email_message]
+      required :type, const: :email_message
+
+      # @!attribute addresses
+      #   A list of `Address` objects associated with the message (sender and recipients).
+      #
+      #   @return [Array<Moonbase::Models::Address>, nil]
+      optional :addresses, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Address] }
+
+      # @!attribute attachments
+      #   A list of `Attachment` objects on the message.
+      #
+      #   @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.
+      #
+      #   @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)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::EmailMessage} for more details.
+      #
+      #   The Email Message object represents a single email within a `Conversation`.
+      #
+      #   @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 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 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 trash [Boolean] `true` if the message is in the trash.
+      #
+      #   @param unread [Boolean] `true` if the message has not been read.
+      #
+      #   @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.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(conversation:, self_:)
+        #   @param conversation [String] A link to the `Conversation` this message belongs to.
+        #
+        #   @param self_ [String] The canonical URL for this object.
+      end
+
+      class Attachment < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute filename
+        #   The original name of the uploaded file, including its extension.
+        #
+        #   @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.
+        #
+        #   @return [Integer]
+        required :size, Integer
+
+        # @!attribute type
+        #   String representing the object’s type. Always `attachment` for this object.
+        #
+        #   @return [Symbol, :attachment]
+        required :type, const: :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.
+        #
+        #   @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 size [Integer] The size of the file in bytes.
+        #
+        #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+        #
+        #   @param updated_at [String] Time at which the object was last updated, as an RFC 3339 timestamp.
+        #
+        #   @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
+      end
+    end
+  end
+end

data/lib/moonbase/models/email_value.rb

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

data/lib/moonbase/models/error.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Error < Moonbase::Internal::Type::BaseModel
+      # @!attribute type
+      #
+      #   @return [Symbol, :error]
+      required :type, const: :error
+
+      # @!attribute id
+      #   A unique identifier for this specific error instance.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute code
+      #   An application-specific error code string.
+      #
+      #   @return [String, nil]
+      optional :code, String
+
+      # @!attribute detail
+      #   A human-readable explanation of this specific error.
+      #
+      #   @return [String, nil]
+      optional :detail, String
+
+      # @!attribute source
+      #   An object containing more specific information about the part of the request
+      #   that caused the error.
+      #
+      #   @return [Moonbase::Models::Error::Source, nil]
+      optional :source, -> { Moonbase::Error::Source }
+
+      # @!attribute status
+      #   The HTTP status code for this problem, as a string.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute title
+      #   A short, human-readable summary of the problem.
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(id: nil, code: nil, detail: nil, source: nil, status: nil, title: nil, type: :error)
+      #   Some parameter documentations has been truncated, see {Moonbase::Models::Error}
+      #   for more details.
+      #
+      #   @param id [String] A unique identifier for this specific error instance.
+      #
+      #   @param code [String] An application-specific error code string.
+      #
+      #   @param detail [String] A human-readable explanation of this specific error.
+      #
+      #   @param source [Moonbase::Models::Error::Source] An object containing more specific information about the part of the request tha
+      #
+      #   @param status [String] The HTTP status code for this problem, as a string.
+      #
+      #   @param title [String] A short, human-readable summary of the problem.
+      #
+      #   @param type [Symbol, :error]
+
+      # @see Moonbase::Models::Error#source
+      class Source < Moonbase::Internal::Type::BaseModel
+        # @!attribute parameter
+        #   A string indicating which URI query parameter caused the error.
+        #
+        #   @return [String, nil]
+        optional :parameter, String
+
+        # @!attribute pointer
+        #   A JSON Pointer [RFC6901] to the associated entity in the request document.
+        #
+        #   @return [String, nil]
+        optional :pointer, String
+
+        # @!method initialize(parameter: nil, pointer: nil)
+        #   An object containing more specific information about the part of the request
+        #   that caused the error.
+        #
+        #   @param parameter [String] A string indicating which URI query parameter caused the error.
+        #
+        #   @param pointer [String] A JSON Pointer [RFC6901] to the associated entity in the request document.
+      end
+    end
+  end
+end