moonbase-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/rbi/moonbase/models/collection.rbi

@@ -12,12 +12,13 @@ module Moonbase
       sig { returns(String) }
       attr_accessor :id
 
-      # A hash of related links.
-      sig { returns(Moonbase::Collection::Links) }
-      attr_reader :links
+      # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
 
-      sig { params(links: Moonbase::Collection::Links::OrHash).void }
-      attr_writer :links
+      # A list of `Field` objects that define the schema for items in this collection.
+      sig { returns(T::Array[Moonbase::Field::Variants]) }
+      attr_accessor :fields
 
       # The user-facing name of the collection (e.g., “Organizations”).
       sig { returns(String) }
@@ -32,12 +33,9 @@ module Moonbase
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # 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
+      # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :updated_at
 
       # An optional, longer-form description of the collection's purpose.
       sig { returns(T.nilable(String)) }
@@ -46,21 +44,9 @@ module Moonbase
       sig { params(description: String).void }
       attr_writer :description
 
-      # A list of `Field` objects that define the schema for items in this collection.
-      sig { returns(T.nilable(T::Array[Moonbase::Field])) }
-      attr_reader :fields
-
-      sig { params(fields: T::Array[Moonbase::Field::OrHash]).void }
-      attr_writer :fields
-
-      # 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
-
       # A list of saved `View` objects for presenting the collection's data.
+      #
+      # **Note:** Only present when requested using the `include` query parameter.
       sig { returns(T.nilable(T::Array[Moonbase::View])) }
       attr_reader :views
 
@@ -73,13 +59,35 @@ module Moonbase
       sig do
         params(
           id: String,
-          links: Moonbase::Collection::Links::OrHash,
+          created_at: Time,
+          fields:
+            T::Array[
+              T.any(
+                Moonbase::SingleLineTextField::OrHash,
+                Moonbase::MultiLineTextField::OrHash,
+                Moonbase::IntegerField::OrHash,
+                Moonbase::FloatField::OrHash,
+                Moonbase::MonetaryField::OrHash,
+                Moonbase::PercentageField::OrHash,
+                Moonbase::BooleanField::OrHash,
+                Moonbase::EmailField::OrHash,
+                Moonbase::URLField::OrHash,
+                Moonbase::DomainField::OrHash,
+                Moonbase::SocialXField::OrHash,
+                Moonbase::SocialLinkedInField::OrHash,
+                Moonbase::TelephoneNumberField::OrHash,
+                Moonbase::GeoField::OrHash,
+                Moonbase::DateField::OrHash,
+                Moonbase::DatetimeField::OrHash,
+                Moonbase::ChoiceField::OrHash,
+                Moonbase::StageField::OrHash,
+                Moonbase::RelationField::OrHash
+              )
+            ],
           name: String,
           ref: String,
-          created_at: Time,
-          description: String,
-          fields: T::Array[Moonbase::Field::OrHash],
           updated_at: Time,
+          description: String,
           views: T::Array[Moonbase::View],
           type: Symbol
         ).returns(T.attached_class)
@@ -87,22 +95,22 @@ module Moonbase
       def self.new(
         # Unique identifier for the object.
         id:,
-        # A hash of related links.
-        links:,
+        # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+        created_at:,
+        # A list of `Field` objects that define the schema for items in this collection.
+        fields:,
         # The user-facing name of the collection (e.g., “Organizations”).
         name:,
         # 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.
         ref:,
-        # Time at which the object was created, as an RFC 3339 timestamp.
-        created_at: nil,
+        # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+        updated_at:,
         # An optional, longer-form description of the collection's purpose.
         description: nil,
-        # A list of `Field` objects that define the schema for items in this collection.
-        fields: nil,
-        # Time at which the object was last updated, as an RFC 3339 timestamp.
-        updated_at: nil,
         # A list of saved `View` objects for presenting the collection's data.
+        #
+        # **Note:** Only present when requested using the `include` query parameter.
         views: nil,
         # String representing the object’s type. Always `collection` for this object.
         type: :collection
@@ -113,43 +121,19 @@ module Moonbase
         override.returns(
           {
             id: String,
-            links: Moonbase::Collection::Links,
+            created_at: Time,
+            fields: T::Array[Moonbase::Field::Variants],
             name: String,
             ref: String,
             type: Symbol,
-            created_at: Time,
-            description: String,
-            fields: T::Array[Moonbase::Field],
             updated_at: Time,
+            description: String,
             views: T::Array[Moonbase::View]
           }
         )
       end
       def to_hash
       end
-
-      class Links < Moonbase::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Moonbase::Collection::Links, Moonbase::Internal::AnyHash)
-          end
-
-        # The canonical URL for this object.
-        sig { returns(String) }
-        attr_accessor :self_
-
-        # A hash of related links.
-        sig { params(self_: String).returns(T.attached_class) }
-        def self.new(
-          # The canonical URL for this object.
-          self_:
-        )
-        end
-
-        sig { override.returns({ self_: String }) }
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/moonbase/models/collection_pointer.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class CollectionPointer < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::CollectionPointer, Moonbase::Internal::AnyHash)
+        end
+
+      # Unique identifier of the collection.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The stable, machine-readable reference identifier of the collection.
+      sig { returns(String) }
+      attr_accessor :ref
+
+      # String representing the object’s type. Always `collection` for this object.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # A lightweight reference to a `Collection`, containing the minimal information
+      # needed to identify it.
+      sig do
+        params(id: String, ref: String, type: Symbol).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier of the collection.
+        id:,
+        # The stable, machine-readable reference identifier of the collection.
+        ref:,
+        # String representing the object’s type. Always `collection` for this object.
+        type: :collection
+      )
+      end
+
+      sig { override.returns({ id: String, ref: String, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/collection_retrieve_params.rbi

@@ -11,8 +11,7 @@ module Moonbase
           T.any(Moonbase::CollectionRetrieveParams, Moonbase::Internal::AnyHash)
         end
 
-      # Specifies which related objects to include in the response. Valid options are
-      # `fields` and `views`.
+      # Specifies which related objects to include in the response.
       sig do
         returns(
           T.nilable(
@@ -38,8 +37,7 @@ module Moonbase
         ).returns(T.attached_class)
       end
       def self.new(
-        # Specifies which related objects to include in the response. Valid options are
-        # `fields` and `views`.
+        # Specifies which related objects to include in the response.
         include: nil,
         request_options: {}
       )
@@ -66,11 +64,6 @@ module Moonbase
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        FIELDS =
-          T.let(
-            :fields,
-            Moonbase::CollectionRetrieveParams::Include::TaggedSymbol
-          )
         VIEWS =
           T.let(
             :views,

data/rbi/moonbase/models/collections/item_create_params.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    module Collections
+      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::Collections::ItemCreateParams,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        # 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::FieldValueParam::SocialXValueParam,
+                  Moonbase::FieldValueParam::SocialLinkedInValueParam,
+                  Moonbase::TelephoneNumber,
+                  Moonbase::GeoValue,
+                  Moonbase::DateValue,
+                  Moonbase::DatetimeValue,
+                  Moonbase::ChoiceValueParam,
+                  Moonbase::FunnelStepValueParam,
+                  Moonbase::RelationValueParam,
+                  T::Array[
+                    T.any(
+                      Moonbase::SingleLineTextValue,
+                      Moonbase::MultiLineTextValue,
+                      Moonbase::IntegerValue,
+                      Moonbase::FloatValue,
+                      Moonbase::MonetaryValue,
+                      Moonbase::PercentageValue,
+                      Moonbase::BooleanValue,
+                      Moonbase::EmailValue,
+                      Moonbase::URLValue,
+                      Moonbase::DomainValue,
+                      Moonbase::ValueParam::ValueUriSocialX,
+                      Moonbase::ValueParam::ValueUriSocialLinkedIn,
+                      Moonbase::TelephoneNumber,
+                      Moonbase::GeoValue,
+                      Moonbase::DateValue,
+                      Moonbase::DatetimeValue,
+                      Moonbase::ChoiceValueParam,
+                      Moonbase::FunnelStepValueParam,
+                      Moonbase::RelationValueParam
+                    )
+                  ]
+                )
+              )
+            ]
+          )
+        end
+        attr_accessor :values
+
+        sig do
+          params(
+            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::FieldValueParam::SocialXValueParam::OrHash,
+                    Moonbase::FieldValueParam::SocialLinkedInValueParam::OrHash,
+                    Moonbase::TelephoneNumber::OrHash,
+                    Moonbase::GeoValue::OrHash,
+                    Moonbase::DateValue::OrHash,
+                    Moonbase::DatetimeValue::OrHash,
+                    Moonbase::ChoiceValueParam::OrHash,
+                    Moonbase::FunnelStepValueParam::OrHash,
+                    Moonbase::RelationValueParam::OrHash,
+                    T::Array[
+                      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::ValueParam::ValueUriSocialX::OrHash,
+                        Moonbase::ValueParam::ValueUriSocialLinkedIn::OrHash,
+                        Moonbase::TelephoneNumber::OrHash,
+                        Moonbase::GeoValue::OrHash,
+                        Moonbase::DateValue::OrHash,
+                        Moonbase::DatetimeValue::OrHash,
+                        Moonbase::ChoiceValueParam::OrHash,
+                        Moonbase::FunnelStepValueParam::OrHash,
+                        Moonbase::RelationValueParam::OrHash
+                      )
+                    ]
+                  )
+                )
+              ],
+            request_options: Moonbase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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(
+            {
+              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::FieldValueParam::SocialXValueParam,
+                      Moonbase::FieldValueParam::SocialLinkedInValueParam,
+                      Moonbase::TelephoneNumber,
+                      Moonbase::GeoValue,
+                      Moonbase::DateValue,
+                      Moonbase::DatetimeValue,
+                      Moonbase::ChoiceValueParam,
+                      Moonbase::FunnelStepValueParam,
+                      Moonbase::RelationValueParam,
+                      T::Array[
+                        T.any(
+                          Moonbase::SingleLineTextValue,
+                          Moonbase::MultiLineTextValue,
+                          Moonbase::IntegerValue,
+                          Moonbase::FloatValue,
+                          Moonbase::MonetaryValue,
+                          Moonbase::PercentageValue,
+                          Moonbase::BooleanValue,
+                          Moonbase::EmailValue,
+                          Moonbase::URLValue,
+                          Moonbase::DomainValue,
+                          Moonbase::ValueParam::ValueUriSocialX,
+                          Moonbase::ValueParam::ValueUriSocialLinkedIn,
+                          Moonbase::TelephoneNumber,
+                          Moonbase::GeoValue,
+                          Moonbase::DateValue,
+                          Moonbase::DatetimeValue,
+                          Moonbase::ChoiceValueParam,
+                          Moonbase::FunnelStepValueParam,
+                          Moonbase::RelationValueParam
+                        )
+                      ]
+                    )
+                  )
+                ],
+              request_options: Moonbase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/collections/item_delete_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    module Collections
+      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::Collections::ItemDeleteParams,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :collection_id
+
+        sig do
+          params(
+            collection_id: String,
+            request_options: Moonbase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(collection_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { collection_id: String, request_options: Moonbase::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/collections/item_list_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    module Collections
+      class ItemListParams < Moonbase::Internal::Type::BaseModel
+        extend Moonbase::Internal::Type::RequestParameters::Converter
+        include Moonbase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Moonbase::Collections::ItemListParams,
+              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
+end

data/rbi/moonbase/models/collections/item_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    module Collections
+      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::Collections::ItemRetrieveParams,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :collection_id
+
+        sig do
+          params(
+            collection_id: String,
+            request_options: Moonbase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(collection_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { collection_id: String, request_options: Moonbase::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end