moonbase-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/lib/moonbase/models/float_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class FloatField < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cardinality
+      #   Specifies whether the field can hold a single value (`one`) or multiple values
+      #   (`many`).
+      #
+      #   @return [Symbol, Moonbase::Models::FloatField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::FloatField::Cardinality }
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   The human-readable name of the field (e.g., "Rating").
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute readonly
+      #   If `true`, the value of this field is system-managed and cannot be updated via
+      #   the API.
+      #
+      #   @return [Boolean]
+      required :readonly, Moonbase::Internal::Type::Boolean
+
+      # @!attribute ref
+      #   A unique, stable, machine-readable identifier for the field within its
+      #   collection (e.g., `rating`).
+      #
+      #   @return [String]
+      required :ref, String
+
+      # @!attribute required
+      #   If `true`, this field must have a value.
+      #
+      #   @return [Boolean]
+      required :required, Moonbase::Internal::Type::Boolean
+
+      # @!attribute type
+      #   The data type of the field. Always `field/number/unitless_float` for this field.
+      #
+      #   @return [Symbol, :"field/number/unitless_float"]
+      required :type, const: :"field/number/unitless_float"
+
+      # @!attribute unique
+      #   If `true`, values for this field must be unique across all items in the
+      #   collection.
+      #
+      #   @return [Boolean]
+      required :unique, Moonbase::Internal::Type::Boolean
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   An optional, longer-form description of the field's purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/unitless_float")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::FloatField} for more details.
+      #
+      #   A field that stores decimal numbers with floating-point precision.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::FloatField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
+      #
+      #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param name [String] The human-readable name of the field (e.g., "Rating").
+      #
+      #   @param readonly [Boolean] If `true`, the value of this field is system-managed and cannot be updated via t
+      #
+      #   @param ref [String] A unique, stable, machine-readable identifier for the field within its collectio
+      #
+      #   @param required [Boolean] If `true`, this field must have a value.
+      #
+      #   @param unique [Boolean] If `true`, values for this field must be unique across all items in the collecti
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param description [String] An optional, longer-form description of the field's purpose.
+      #
+      #   @param type [Symbol, :"field/number/unitless_float"] The data type of the field. Always `field/number/unitless_float` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::FloatField#cardinality
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        ONE = :one
+        MANY = :many
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/float_value.rb

@@ -3,20 +3,20 @@
 module Moonbase
   module Models
     class FloatValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute number
+      # @!attribute data
       #
       #   @return [Float]
-      required :number, Float
+      required :data, Float
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/number/unitless_float"]
       required :type, const: :"value/number/unitless_float"
 
-      # @!method initialize(number:, type: :"value/number/unitless_float")
+      # @!method initialize(data:, type: :"value/number/unitless_float")
       #   Floating point number
       #
-      #   @param number [Float]
+      #   @param data [Float]
       #   @param type [Symbol, :"value/number/unitless_float"]
     end
   end

data/lib/moonbase/models/form.rb

@@ -16,10 +16,11 @@ module Moonbase
       #   @return [Moonbase::Models::Collection]
       required :collection, -> { Moonbase::Collection }
 
-      # @!attribute links
+      # @!attribute created_at
+      #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
       #
-      #   @return [Moonbase::Models::Form::Links]
-      required :links, -> { Moonbase::Form::Links }
+      #   @return [Time]
+      required :created_at, Time
 
       # @!attribute name
       #   The name of the form, used as the title on its public page.
@@ -27,23 +28,23 @@ module Moonbase
       #   @return [String]
       required :name, String
 
+      # @!attribute pages_enabled
+      #   `true` if the form is available at a public URL.
+      #
+      #   @return [Boolean]
+      required :pages_enabled, Moonbase::Internal::Type::Boolean
+
       # @!attribute type
       #   String representing the object’s type. Always `form` for this object.
       #
       #   @return [Symbol, :form]
       required :type, const: :form
 
-      # @!attribute created_at
-      #   Time at which the object was created, as an RFC 3339 timestamp.
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
-      # @!attribute pages_enabled
-      #   `true` if the form is available at a public URL.
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
       #
-      #   @return [Boolean, nil]
-      optional :pages_enabled, Moonbase::Internal::Type::Boolean
+      #   @return [Time]
+      required :updated_at, Time
 
       # @!attribute pages_url
       #   The public URL for the form, if `pages_enabled` is `true`.
@@ -57,13 +58,7 @@ module Moonbase
       #   @return [String, nil]
       optional :redirect_url, String
 
-      # @!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:, collection:, links:, name:, created_at: nil, pages_enabled: nil, pages_url: nil, redirect_url: nil, updated_at: nil, type: :form)
+      # @!method initialize(id:, collection:, created_at:, name:, pages_enabled:, updated_at:, pages_url: nil, redirect_url: nil, type: :form)
       #   A Form provides a way to create `Items` in a `Collection`, often via a public
       #   URL for external users. Each form submission creates a new item.
       #
@@ -71,41 +66,19 @@ module Moonbase
       #
       #   @param collection [Moonbase::Models::Collection] The `Collection` that submissions to this form are saved to.
       #
-      #   @param links [Moonbase::Models::Form::Links]
+      #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
       #
       #   @param name [String] The name of the form, used as the title on its public page.
       #
-      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
-      #
       #   @param pages_enabled [Boolean] `true` if the form is available at a public URL.
       #
+      #   @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
       #   @param pages_url [String] The public URL for the form, if `pages_enabled` is `true`.
       #
       #   @param redirect_url [String] An optional URL to redirect users to after a successful submission.
       #
-      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
-      #
       #   @param type [Symbol, :form] String representing the object’s type. Always `form` for this object.
-
-      # @see Moonbase::Models::Form#links
-      class Links < Moonbase::Internal::Type::BaseModel
-        # @!attribute self_
-        #   The canonical URL for this object.
-        #
-        #   @return [String]
-        required :self_, String, api_name: :self
-
-        # @!attribute collection
-        #   A link to the `Collection` where form submissions are saved.
-        #
-        #   @return [String, nil]
-        optional :collection, String
-
-        # @!method initialize(self_:, collection: nil)
-        #   @param self_ [String] The canonical URL for this object.
-        #
-        #   @param collection [String] A link to the `Collection` where form submissions are saved.
-      end
     end
   end
 end

data/lib/moonbase/models/form_list_params.rb

@@ -23,13 +23,6 @@ module Moonbase
       #   @return [String, nil]
       optional :before, String
 
-      # @!attribute include
-      #   Specifies which related objects to include in the response. Valid option is
-      #   `collection.fields`.
-      #
-      #   @return [Array<Symbol, Moonbase::Models::FormListParams::Include>, nil]
-      optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::FormListParams::Include] }
-
       # @!attribute limit
       #   Maximum number of items to return per page. Must be between 1 and 100. Defaults
       #   to 20 if not specified.
@@ -37,7 +30,7 @@ module Moonbase
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(after: nil, before: nil, include: nil, limit: nil, request_options: {})
+      # @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Moonbase::Models::FormListParams} for more details.
       #
@@ -45,20 +38,9 @@ module Moonbase
       #
       #   @param before [String] When specified, returns results starting immediately before the item identified
       #
-      #   @param include [Array<Symbol, Moonbase::Models::FormListParams::Include>] Specifies which related objects to include in the response. Valid option is `col
-      #
       #   @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
-
-        COLLECTION_FIELDS = :"collection.fields"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/moonbase/models/form_retrieve_params.rb

@@ -7,29 +7,8 @@ module Moonbase
       extend Moonbase::Internal::Type::RequestParameters::Converter
       include Moonbase::Internal::Type::RequestParameters
 
-      # @!attribute include
-      #   Specifies which related objects to include in the response. Valid option is
-      #   `collection.fields`.
-      #
-      #   @return [Array<Symbol, Moonbase::Models::FormRetrieveParams::Include>, nil]
-      optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::FormRetrieveParams::Include] }
-
-      # @!method initialize(include: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Moonbase::Models::FormRetrieveParams} for more details.
-      #
-      #   @param include [Array<Symbol, Moonbase::Models::FormRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `col
-      #
+      # @!method initialize(request_options: {})
       #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
-
-      module Include
-        extend Moonbase::Internal::Type::Enum
-
-        COLLECTION_FIELDS = :"collection.fields"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/moonbase/models/formatted_text.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class FormattedText < Moonbase::Internal::Type::BaseModel
+      # @!attribute markdown
+      #   The content formatted as Markdown text.
+      #
+      #   @return [String, nil]
+      optional :markdown, String
+
+      # @!method initialize(markdown: nil)
+      #   Structured content that can be rendered in multiple formats, currently
+      #   supporting Markdown.
+      #
+      #   @param markdown [String] The content formatted as Markdown text.
+    end
+  end
+end

data/lib/moonbase/models/funnel.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Funnel < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute steps
+      #   An ordered list of `FunnelStep` objects that make up the funnel.
+      #
+      #   @return [Array<Moonbase::Models::FunnelStep>]
+      required :steps, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::FunnelStep] }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `funnel` for this object.
+      #
+      #   @return [Symbol, :funnel]
+      required :type, const: :funnel
+
+      # @!method initialize(id:, steps:, type: :funnel)
+      #   A Funnel represents a series of steps used to track progression.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param steps [Array<Moonbase::Models::FunnelStep>] An ordered list of `FunnelStep` objects that make up the funnel.
+      #
+      #   @param type [Symbol, :funnel] String representing the object’s type. Always `funnel` for this object.
+    end
+  end
+end

data/lib/moonbase/models/funnel_step.rb

@@ -3,43 +3,64 @@
 module Moonbase
   module Models
     class FunnelStep < Moonbase::Internal::Type::BaseModel
-      # @!attribute step
+      # @!attribute id
+      #   Unique identifier for the object.
       #
-      #   @return [Moonbase::Models::FunnelStep::Step]
-      required :step, -> { Moonbase::FunnelStep::Step }
+      #   @return [String]
+      required :id, String
 
-      # @!attribute type
+      # @!attribute name
+      #   The name of the step.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute step_type
+      #   The status of the step in the funnel flow.
       #
-      #   @return [Symbol, :"value/funnel_step"]
-      required :type, const: :"value/funnel_step"
+      #   - `active`: represents an in progress state within the funnel
+      #   - `success`: completed successfully and exited the funnel
+      #   - `failure`: exited the funnel without conversion
+      #
+      #   @return [Symbol, Moonbase::Models::FunnelStep::StepType]
+      required :step_type, enum: -> { Moonbase::FunnelStep::StepType }
 
-      # @!method initialize(step:, type: :"value/funnel_step")
-      #   Funnel step value
+      # @!attribute type
+      #   String representing the object’s type. Always `funnel_step` for this object.
       #
-      #   @param step [Moonbase::Models::FunnelStep::Step]
-      #   @param type [Symbol, :"value/funnel_step"]
+      #   @return [Symbol, :funnel_step]
+      required :type, const: :funnel_step
 
-      # @see Moonbase::Models::FunnelStep#step
-      class Step < Moonbase::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
+      # @!method initialize(id:, name:, step_type:, type: :funnel_step)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::FunnelStep} for more details.
+      #
+      #   Represents a single step within a `Funnel`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param name [String] The name of the step.
+      #
+      #   @param step_type [Symbol, Moonbase::Models::FunnelStep::StepType] The status of the step in the funnel flow.
+      #
+      #   @param type [Symbol, :funnel_step] String representing the object’s type. Always `funnel_step` for this object.
 
-        # @!attribute type
-        #
-        #   @return [Symbol, :funnel_step]
-        required :type, const: :funnel_step
+      # The status of the step in the funnel flow.
+      #
+      # - `active`: represents an in progress state within the funnel
+      # - `success`: completed successfully and exited the funnel
+      # - `failure`: exited the funnel without conversion
+      #
+      # @see Moonbase::Models::FunnelStep#step_type
+      module StepType
+        extend Moonbase::Internal::Type::Enum
 
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String
+        ACTIVE = :active
+        SUCCESS = :success
+        FAILURE = :failure
 
-        # @!method initialize(id:, name: nil, type: :funnel_step)
-        #   @param id [String]
-        #   @param name [String]
-        #   @param type [Symbol, :funnel_step]
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/moonbase/models/funnel_step_value.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class FunnelStepValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute data
+      #   A specific funnel step, as configured on the Funnel
+      #
+      #   @return [Moonbase::Models::FunnelStep]
+      required :data, -> { Moonbase::FunnelStep }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/funnel_step"]
+      required :type, const: :"value/funnel_step"
+
+      # @!method initialize(data:, type: :"value/funnel_step")
+      #   Funnel step value
+      #
+      #   @param data [Moonbase::Models::FunnelStep] A specific funnel step, as configured on the Funnel
+      #
+      #   @param type [Symbol, :"value/funnel_step"]
+    end
+  end
+end

data/lib/moonbase/models/funnel_step_value_param.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class FunnelStepValueParam < Moonbase::Internal::Type::BaseModel
+      # @!attribute data
+      #   A specific funnel step, as configured on the Funnel
+      #
+      #   @return [Moonbase::Models::FunnelStep, Moonbase::Models::Pointer]
+      required :data, union: -> { Moonbase::FunnelStepValueParam::Data }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/funnel_step"]
+      required :type, const: :"value/funnel_step"
+
+      # @!method initialize(data:, type: :"value/funnel_step")
+      #   Funnel step value
+      #
+      #   @param data [Moonbase::Models::FunnelStep, Moonbase::Models::Pointer] A specific funnel step, as configured on the Funnel
+      #
+      #   @param type [Symbol, :"value/funnel_step"]
+
+      # A specific funnel step, as configured on the Funnel
+      #
+      # @see Moonbase::Models::FunnelStepValueParam#data
+      module Data
+        extend Moonbase::Internal::Type::Union
+
+        # Represents a single step within a `Funnel`.
+        variant -> { Moonbase::FunnelStep }
+
+        # A lightweight reference to another resource.
+        variant -> { Moonbase::Pointer }
+
+        # @!method self.variants
+        #   @return [Array(Moonbase::Models::FunnelStep, Moonbase::Models::Pointer)]
+      end
+    end
+  end
+end

data/lib/moonbase/models/geo_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class GeoField < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cardinality
+      #   Specifies whether the field can hold a single value (`one`) or multiple values
+      #   (`many`).
+      #
+      #   @return [Symbol, Moonbase::Models::GeoField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::GeoField::Cardinality }
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   The human-readable name of the field (e.g., "Location").
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute readonly
+      #   If `true`, the value of this field is system-managed and cannot be updated via
+      #   the API.
+      #
+      #   @return [Boolean]
+      required :readonly, Moonbase::Internal::Type::Boolean
+
+      # @!attribute ref
+      #   A unique, stable, machine-readable identifier for the field within its
+      #   collection (e.g., `location`).
+      #
+      #   @return [String]
+      required :ref, String
+
+      # @!attribute required
+      #   If `true`, this field must have a value.
+      #
+      #   @return [Boolean]
+      required :required, Moonbase::Internal::Type::Boolean
+
+      # @!attribute type
+      #   The data type of the field. Always `field/geo` for this field.
+      #
+      #   @return [Symbol, :"field/geo"]
+      required :type, const: :"field/geo"
+
+      # @!attribute unique
+      #   If `true`, values for this field must be unique across all items in the
+      #   collection.
+      #
+      #   @return [Boolean]
+      required :unique, Moonbase::Internal::Type::Boolean
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   An optional, longer-form description of the field's purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/geo")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::GeoField} for more details.
+      #
+      #   A field that stores geographic coordinates or location data.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::GeoField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
+      #
+      #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param name [String] The human-readable name of the field (e.g., "Location").
+      #
+      #   @param readonly [Boolean] If `true`, the value of this field is system-managed and cannot be updated via t
+      #
+      #   @param ref [String] A unique, stable, machine-readable identifier for the field within its collectio
+      #
+      #   @param required [Boolean] If `true`, this field must have a value.
+      #
+      #   @param unique [Boolean] If `true`, values for this field must be unique across all items in the collecti
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param description [String] An optional, longer-form description of the field's purpose.
+      #
+      #   @param type [Symbol, :"field/geo"] The data type of the field. Always `field/geo` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::GeoField#cardinality
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        ONE = :one
+        MANY = :many
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end