moonbase-sdk 0.1.0.pre.alpha.1

data/rbi/moonbase/models/inbox_message_list_params.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxMessageListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::InboxMessageListParams, 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 messages by one or more conversation IDs.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :conversation
+
+      sig { params(conversation: T::Array[String]).void }
+      attr_writer :conversation
+
+      # Filter messages 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`, `attachments`, and `conversation`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Moonbase::InboxMessageListParams::Include::OrSymbol]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include: T::Array[Moonbase::InboxMessageListParams::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,
+          conversation: T::Array[String],
+          inbox: T::Array[String],
+          include:
+            T::Array[Moonbase::InboxMessageListParams::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 messages by one or more conversation IDs.
+        conversation: nil,
+        # Filter messages by one or more inbox IDs.
+        inbox: nil,
+        # Specifies which related objects to include in the response. Valid options are
+        # `addresses`, `attachments`, and `conversation`.
+        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,
+            conversation: T::Array[String],
+            inbox: T::Array[String],
+            include:
+              T::Array[Moonbase::InboxMessageListParams::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::InboxMessageListParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ADDRESSES =
+          T.let(
+            :addresses,
+            Moonbase::InboxMessageListParams::Include::TaggedSymbol
+          )
+        ATTACHMENTS =
+          T.let(
+            :attachments,
+            Moonbase::InboxMessageListParams::Include::TaggedSymbol
+          )
+        CONVERSATION =
+          T.let(
+            :conversation,
+            Moonbase::InboxMessageListParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::InboxMessageListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox_message_retrieve_params.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxMessageRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Moonbase::InboxMessageRetrieveParams,
+            Moonbase::Internal::AnyHash
+          )
+        end
+
+      # Specifies which related objects to include in the response. Valid options are
+      # `addresses`, `attachments`, and `conversation`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Moonbase::InboxMessageRetrieveParams::Include::OrSymbol]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include:
+            T::Array[Moonbase::InboxMessageRetrieveParams::Include::OrSymbol]
+        ).void
+      end
+      attr_writer :include
+
+      sig do
+        params(
+          include:
+            T::Array[Moonbase::InboxMessageRetrieveParams::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`, `attachments`, and `conversation`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            include:
+              T::Array[Moonbase::InboxMessageRetrieveParams::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::InboxMessageRetrieveParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ADDRESSES =
+          T.let(
+            :addresses,
+            Moonbase::InboxMessageRetrieveParams::Include::TaggedSymbol
+          )
+        ATTACHMENTS =
+          T.let(
+            :attachments,
+            Moonbase::InboxMessageRetrieveParams::Include::TaggedSymbol
+          )
+        CONVERSATION =
+          T.let(
+            :conversation,
+            Moonbase::InboxMessageRetrieveParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Moonbase::InboxMessageRetrieveParams::Include::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox_retrieve_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class InboxRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::InboxRetrieveParams, Moonbase::Internal::AnyHash)
+        end
+
+      # Specifies which related objects to include in the response. Valid option is
+      # `tagset`.
+      sig do
+        returns(T.nilable(Moonbase::InboxRetrieveParams::Include::OrSymbol))
+      end
+      attr_reader :include
+
+      sig do
+        params(include: Moonbase::InboxRetrieveParams::Include::OrSymbol).void
+      end
+      attr_writer :include
+
+      sig do
+        params(
+          include: Moonbase::InboxRetrieveParams::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 option is
+        # `tagset`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            include: Moonbase::InboxRetrieveParams::Include::OrSymbol,
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Specifies which related objects to include in the response. Valid option is
+      # `tagset`.
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::InboxRetrieveParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TAGSET =
+          T.let(:tagset, Moonbase::InboxRetrieveParams::Include::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::InboxRetrieveParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/integer_value.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class IntegerValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::IntegerValue, Moonbase::Internal::AnyHash)
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :number
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Integer value without units
+      sig { params(number: Integer, type: Symbol).returns(T.attached_class) }
+      def self.new(number:, type: :"value/number/unitless_integer")
+      end
+
+      sig { override.returns({ number: Integer, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/item.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class Item < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Moonbase::Item, Moonbase::Internal::AnyHash) }
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # String representing the object’s type. Always `item` for this object.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(Moonbase::Item::Links)) }
+      attr_reader :links
+
+      sig { params(links: Moonbase::Item::Links::OrHash).void }
+      attr_writer :links
+
+      # A hash where keys are the `ref` of a `Field` and values are the data stored for
+      # that field.
+      sig do
+        returns(T.nilable(T::Hash[Symbol, T.nilable(Moonbase::FieldValue)]))
+      end
+      attr_reader :values
+
+      sig do
+        params(values: T::Hash[Symbol, T.nilable(Moonbase::FieldValue)]).void
+      end
+      attr_writer :values
+
+      # An Item represents a single record or row within a Collection. It holds a set of
+      # `values` corresponding to the Collection's `fields`.
+      sig do
+        params(
+          id: String,
+          links: Moonbase::Item::Links::OrHash,
+          values: T::Hash[Symbol, T.nilable(Moonbase::FieldValue)],
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        links: nil,
+        # A hash where keys are the `ref` of a `Field` and values are the data stored for
+        # that field.
+        values: nil,
+        # String representing the object’s type. Always `item` for this object.
+        type: :item
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            type: Symbol,
+            links: Moonbase::Item::Links,
+            values: T::Hash[Symbol, T.nilable(Moonbase::FieldValue)]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Links < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::Item::Links, Moonbase::Internal::AnyHash)
+          end
+
+        # A link to the `Collection` the item belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :collection
+
+        sig { params(collection: String).void }
+        attr_writer :collection
+
+        # The canonical URL for this object.
+        sig { returns(T.nilable(String)) }
+        attr_reader :self_
+
+        sig { params(self_: String).void }
+        attr_writer :self_
+
+        sig do
+          params(collection: String, self_: String).returns(T.attached_class)
+        end
+        def self.new(
+          # A link to the `Collection` the item belongs to.
+          collection: nil,
+          # The canonical URL for this object.
+          self_: nil
+        )
+        end
+
+        sig { override.returns({ collection: String, self_: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/item_create_params.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ItemCreateParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::ItemCreateParams, Moonbase::Internal::AnyHash)
+        end
+
+      # The ID of the `Collection` to create the item in.
+      sig { returns(String) }
+      attr_accessor :collection_id
+
+      # A hash where keys are the `ref` of a `Field` and values are the data to be set.
+      sig do
+        returns(
+          T::Hash[
+            Symbol,
+            T.nilable(
+              T.any(
+                Moonbase::SingleLineTextValue,
+                Moonbase::MultiLineTextValue,
+                Moonbase::IntegerValue,
+                Moonbase::FloatValue,
+                Moonbase::MonetaryValue,
+                Moonbase::PercentageValue,
+                Moonbase::BooleanValue,
+                Moonbase::EmailValue,
+                Moonbase::URLValue,
+                Moonbase::DomainValue,
+                Moonbase::SocialXValue,
+                Moonbase::SocialLinkedInValue,
+                Moonbase::TelephoneNumber,
+                Moonbase::GeoValue,
+                Moonbase::DateValue,
+                Moonbase::DatetimeValue,
+                Moonbase::Choice,
+                Moonbase::FunnelStep,
+                Moonbase::RelationValue,
+                T::Array[Moonbase::Value]
+              )
+            )
+          ]
+        )
+      end
+      attr_accessor :values
+
+      sig do
+        params(
+          collection_id: String,
+          values:
+            T::Hash[
+              Symbol,
+              T.nilable(
+                T.any(
+                  Moonbase::SingleLineTextValue::OrHash,
+                  Moonbase::MultiLineTextValue::OrHash,
+                  Moonbase::IntegerValue::OrHash,
+                  Moonbase::FloatValue::OrHash,
+                  Moonbase::MonetaryValue::OrHash,
+                  Moonbase::PercentageValue::OrHash,
+                  Moonbase::BooleanValue::OrHash,
+                  Moonbase::EmailValue::OrHash,
+                  Moonbase::URLValue::OrHash,
+                  Moonbase::DomainValue::OrHash,
+                  Moonbase::SocialXValue::OrHash,
+                  Moonbase::SocialLinkedInValue::OrHash,
+                  Moonbase::TelephoneNumber::OrHash,
+                  Moonbase::GeoValue::OrHash,
+                  Moonbase::DateValue::OrHash,
+                  Moonbase::DatetimeValue::OrHash,
+                  Moonbase::Choice::OrHash,
+                  Moonbase::FunnelStep::OrHash,
+                  Moonbase::RelationValue,
+                  T::Array[Moonbase::Value]
+                )
+              )
+            ],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the `Collection` to create the item in.
+        collection_id:,
+        # A hash where keys are the `ref` of a `Field` and values are the data to be set.
+        values:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            collection_id: String,
+            values:
+              T::Hash[
+                Symbol,
+                T.nilable(
+                  T.any(
+                    Moonbase::SingleLineTextValue,
+                    Moonbase::MultiLineTextValue,
+                    Moonbase::IntegerValue,
+                    Moonbase::FloatValue,
+                    Moonbase::MonetaryValue,
+                    Moonbase::PercentageValue,
+                    Moonbase::BooleanValue,
+                    Moonbase::EmailValue,
+                    Moonbase::URLValue,
+                    Moonbase::DomainValue,
+                    Moonbase::SocialXValue,
+                    Moonbase::SocialLinkedInValue,
+                    Moonbase::TelephoneNumber,
+                    Moonbase::GeoValue,
+                    Moonbase::DateValue,
+                    Moonbase::DatetimeValue,
+                    Moonbase::Choice,
+                    Moonbase::FunnelStep,
+                    Moonbase::RelationValue,
+                    T::Array[Moonbase::Value]
+                  )
+                )
+              ],
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/item_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ItemDeleteParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::ItemDeleteParams, Moonbase::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Moonbase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Moonbase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/item_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ItemRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::ItemRetrieveParams, Moonbase::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Moonbase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Moonbase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end